pmcf 3.15.5 → 3.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +108 -45
  2. package/package.json +4 -4
  3. package/src/service-types.mjs +6 -0
  4. package/types/service-types.d.mts +8 -0
package/README.md CHANGED
@@ -18,54 +18,61 @@ Generates system packages from config blueprint.
18
18
 
19
19
  supported linux derivates:
20
20
 
21
- - arch linux
22
- - debian
23
- - rpm based systems
21
+ * arch linux
22
+ * debian
23
+ * rpm based systems
24
24
 
25
25
  generates config packages for:
26
26
 
27
- - systemd
28
- - networkd
29
- - timesyncd
30
- - resolverd
31
- - kea
32
- - bind
33
- - mosquitto
34
- - influxdb
35
- - iwd
36
- - chrony
37
-
27
+ * systemd
28
+ * networkd
29
+ * timesyncd
30
+ * resolverd
31
+ * kea
32
+ * bind
33
+ * mosquitto
34
+ * influxdb
35
+ * iwd
36
+ * chrony
37
+
38
38
  # API
39
39
 
40
40
  <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
41
41
 
42
42
  ### Table of Contents
43
43
 
44
- - [pmcf](#pmcf)
45
- - [Poor mans configuration management](#poor-mans-configuration-management)
46
- - [API](#api)
47
- - [Table of Contents](#table-of-contents)
48
- - [Base](#base)
49
- - [Parameters](#parameters)
50
- - [extends](#extends)
51
- - [findService](#findservice)
52
- - [Parameters](#parameters-1)
53
- - [port](#port)
54
- - [socketAddress](#socketaddress)
55
- - [port](#port-1)
56
- - [SkeletonNetworkInterface](#skeletonnetworkinterface)
57
- - [networkAddresses](#networkaddresses)
58
- - [Parameters](#parameters-2)
59
- - [NetworkAddress](#networkaddress)
60
- - [Parameters](#parameters-3)
61
- - [subnet](#subnet)
62
- - [networkInterface](#networkinterface)
63
- - [address](#address)
64
- - [addresses](#addresses)
65
- - [Parameters](#parameters-4)
66
- - [serviceEndpoints](#serviceendpoints)
67
- - [Parameters](#parameters-5)
68
- - [install](#install)
44
+ * [Base](#base)
45
+ * [Parameters](#parameters)
46
+ * [extends](#extends)
47
+ * [findService](#findservice)
48
+ * [Parameters](#parameters-1)
49
+ * [PortEndpoint](#portendpoint)
50
+ * [Parameters](#parameters-2)
51
+ * [port](#port)
52
+ * [socketAddress](#socketaddress)
53
+ * [HTTPEndpoint](#httpendpoint)
54
+ * [Parameters](#parameters-3)
55
+ * [port](#port-1)
56
+ * [SkeletonNetworkInterface](#skeletonnetworkinterface)
57
+ * [networkAddresses](#networkaddresses)
58
+ * [Parameters](#parameters-4)
59
+ * [NetworkAddress](#networkaddress)
60
+ * [Parameters](#parameters-5)
61
+ * [subnet](#subnet)
62
+ * [networkInterface](#networkinterface)
63
+ * [address](#address)
64
+ * [addresses](#addresses)
65
+ * [Parameters](#parameters-6)
66
+ * [cidrAddresses](#cidraddresses)
67
+ * [Parameters](#parameters-7)
68
+ * [serviceEndpoints](#serviceendpoints)
69
+ * [Parameters](#parameters-8)
70
+ * [sectionLines](#sectionlines)
71
+ * [Parameters](#parameters-9)
72
+ * [asArray](#asarray)
73
+ * [Parameters](#parameters-10)
74
+ * [asIterator](#asiterator)
75
+ * [Parameters](#parameters-11)
69
76
 
70
77
  ## Base
71
78
 
@@ -86,15 +93,38 @@ Returns **Iterable<[Base](#base)>**&#x20;
86
93
 
87
94
  Returns **any** service with the highest priority
88
95
 
89
- ## port
96
+ ## PortEndpoint
97
+
98
+ **Extends BaseEndpoint**
99
+
100
+ Endpoint with an ip port
101
+
102
+ ### Parameters
103
+
104
+ * `service` &#x20;
105
+ * `data` &#x20;
106
+
107
+ ### port
90
108
 
91
109
  Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
92
110
 
93
- ## socketAddress
111
+ ### socketAddress
94
112
 
95
113
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
96
114
 
97
- ## port
115
+ ## HTTPEndpoint
116
+
117
+ **Extends BaseEndpoint**
118
+
119
+ Endpoint based on http
120
+
121
+ ### Parameters
122
+
123
+ * `service` &#x20;
124
+ * `address` &#x20;
125
+ * `data` &#x20;
126
+
127
+ ### port
98
128
 
99
129
  Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
100
130
 
@@ -114,9 +144,9 @@ Returns **Iterable<[NetworkAddress](#networkaddress)>**&#x20;
114
144
 
115
145
  ### Parameters
116
146
 
117
- * `networkInterface` &#x20;
118
- * `address` &#x20;
119
- * `subnet` &#x20;
147
+ * `networkInterface` **NetworkInterface**&#x20;
148
+ * `address` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [Uint16Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array))**&#x20;
149
+ * `subnet` **Subnet**&#x20;
120
150
 
121
151
  ### subnet
122
152
 
@@ -142,6 +172,14 @@ Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
142
172
 
143
173
  Returns **Iterable<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** addresses
144
174
 
175
+ ## cidrAddresses
176
+
177
+ ### Parameters
178
+
179
+ * `networkAddresses` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[NetworkAddress](#networkaddress)>**&#x20;
180
+
181
+ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**&#x20;
182
+
145
183
  ## serviceEndpoints
146
184
 
147
185
  ### Parameters
@@ -157,6 +195,31 @@ Returns **Iterable<[string](https://developer.mozilla.org/docs/Web/JavaScript/Re
157
195
 
158
196
  Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | any)**&#x20;
159
197
 
198
+ ## sectionLines
199
+
200
+ ### Parameters
201
+
202
+ * `sectionName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
203
+ * `values` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
204
+
205
+ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**&#x20;
206
+
207
+ ## asArray
208
+
209
+ ### Parameters
210
+
211
+ * `value` **any**&#x20;
212
+
213
+ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<any>**&#x20;
214
+
215
+ ## asIterator
216
+
217
+ ### Parameters
218
+
219
+ * `value` **any**&#x20;
220
+
221
+ Returns **Iterable\<any>**&#x20;
222
+
160
223
  # install
161
224
 
162
225
  With [npm](http://npmjs.org) do:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pmcf",
3
- "version": "3.15.5",
3
+ "version": "3.16.1",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -53,9 +53,9 @@
53
53
  "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
54
54
  },
55
55
  "dependencies": {
56
- "ip-utilties": "^1.4.14",
57
- "npm-pkgbuild": "^19.0.5",
58
- "pacc": "^4.41.5",
56
+ "ip-utilties": "^2.0.0",
57
+ "npm-pkgbuild": "^19.0.6",
58
+ "pacc": "^4.42.0",
59
59
  "package-directory": "^8.1.0"
60
60
  },
61
61
  "devDependencies": {
package/src/service-types.mjs CHANGED
@@ -42,6 +42,12 @@ export const ServiceTypes = {
42
42
  { family: "IPv6", protocol: "udp", port: 53, tls: false }
43
43
  ]
44
44
  },
45
+ mdns: {
46
+ endpoints: [
47
+ { family: "IPv4", protocol: "udp", port: 5353, tls: false },
48
+ { family: "IPv6", protocol: "udp", port: 5353, tls: false }
49
+ ]
50
+ },
45
51
  ldap: {
46
52
  endpoints: [
47
53
  { family: "IPv4", protocol: "tcp", port: 389, tls: false },
package/types/service-types.d.mts CHANGED
@@ -45,6 +45,14 @@ export const ServiceTypes: {
45
45
  tls: boolean;
46
46
  }[];
47
47
  };
48
+ mdns: {
49
+ endpoints: {
50
+ family: string;
51
+ protocol: string;
52
+ port: number;
53
+ tls: boolean;
54
+ }[];
55
+ };
48
56
  ldap: {
49
57
  endpoints: {
50
58
  family: string;