All files mqtt-plus-options.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
9x
9x
9x
9x
9x
9x
9x
9x
9x
9x
9x
404x
404x
9x
1099x
1099x
1099x
1099x
1099x
1099x
1099x
9x
9x
9x
 
 
/*
**  MQTT+ -- MQTT Communication Patterns
**  Copyright (c) 2018-2026 Dr. Ralf S. Engelschall <rse@engelschall.com>
**
**  Permission is hereby granted, free of charge, to any person obtaining
**  a copy of this software and associated documentation files (the
**  "Software"), to deal in the Software without restriction, including
**  without limitation the rights to use, copy, modify, merge, publish,
**  distribute, sublicense, and/or sell copies of the Software, and to
**  permit persons to whom the Software is furnished to do so, subject to
**  the following conditions:
**
**  The above copyright notice and this permission notice shall be included
**  in all copies or substantial portions of the Software.
**
**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
**  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
**  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
**  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
**  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
**  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
**  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
 
/*  external requirements  */
import { nanoid }           from "nanoid"
 
/*  internal requirements  */
import type { APISchema }   from "./mqtt-plus-api"
 
/*  MQTT topic matching  */
type TopicMatching        = { name: string, operation: string, peerId?: string }
export type TopicMake     = (name: string, operation: string, peerId?: string) => string
export type TopicMatch    = (topic: string) => TopicMatching | null
 
/*  API option type  */
export interface APIOptions {
    id:          string
    codec:       "cbor" | "json"
    timeout:     number
    share:       string
    chunkSize:   number
    chunkCredit: number
    topicMake:   TopicMake
    topicMatch:  TopicMatch
}
 
/*  Options trait  */
export class OptionsTrait<T extends APISchema = APISchema> {
    protected options: APIOptions
 
    /*  construct API class  */
    constructor (
        options: Partial<APIOptions> = {}
    ) {
        /*  determine options and provide defaults  */
        this.options = {
            id:          nanoid(),
            codec:       "cbor",
            timeout:     10 * 1000,
            share:       "",
            chunkSize:   16 * 1024,
            chunkCredit: 4,
            topicMake: (name, operation, peerId) => {
                return `${name}/${operation}/${peerId ?? "any"}`
            },
            topicMatch: (topic) => {
                const m = topic.match(/^(.+)\/([^/]+)\/([^/]+)$/)
                return m ? {
                    name:      m[1],
                    operation: m[2],
                    peerId:    m[3] === "any" ? undefined : m[3]
                } : null
            },
            ...options
        }
    }
}