@xyo-network/shared 2.37.5 → 2.37.7

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 (56) hide show
  1. package/dist/cjs/Job/Job.d.ts +13 -0
  2. package/dist/cjs/Job/Job.d.ts.map +1 -0
  3. package/dist/cjs/Job/Job.js +3 -0
  4. package/dist/cjs/Job/Job.js.map +1 -0
  5. package/dist/cjs/Job/JobProvider.d.ts +5 -0
  6. package/dist/cjs/Job/JobProvider.d.ts.map +1 -0
  7. package/dist/cjs/Job/JobProvider.js +3 -0
  8. package/dist/cjs/Job/JobProvider.js.map +1 -0
  9. package/dist/cjs/Job/Task.d.ts +2 -0
  10. package/dist/cjs/Job/Task.d.ts.map +1 -0
  11. package/dist/cjs/Job/Task.js +3 -0
  12. package/dist/cjs/Job/Task.js.map +1 -0
  13. package/dist/cjs/Job/index.d.ts +4 -0
  14. package/dist/cjs/Job/index.d.ts.map +1 -0
  15. package/dist/cjs/Job/index.js +7 -0
  16. package/dist/cjs/Job/index.js.map +1 -0
  17. package/dist/cjs/Logger.d.ts +13 -0
  18. package/dist/cjs/Logger.d.ts.map +1 -0
  19. package/dist/cjs/Logger.js +3 -0
  20. package/dist/cjs/Logger.js.map +1 -0
  21. package/dist/cjs/index.d.ts +2 -0
  22. package/dist/cjs/index.d.ts.map +1 -1
  23. package/dist/cjs/index.js +2 -0
  24. package/dist/cjs/index.js.map +1 -1
  25. package/dist/docs.json +509 -6
  26. package/dist/esm/Job/Job.d.ts +13 -0
  27. package/dist/esm/Job/Job.d.ts.map +1 -0
  28. package/dist/esm/Job/Job.js +2 -0
  29. package/dist/esm/Job/Job.js.map +1 -0
  30. package/dist/esm/Job/JobProvider.d.ts +5 -0
  31. package/dist/esm/Job/JobProvider.d.ts.map +1 -0
  32. package/dist/esm/Job/JobProvider.js +2 -0
  33. package/dist/esm/Job/JobProvider.js.map +1 -0
  34. package/dist/esm/Job/Task.d.ts +2 -0
  35. package/dist/esm/Job/Task.d.ts.map +1 -0
  36. package/dist/esm/Job/Task.js +2 -0
  37. package/dist/esm/Job/Task.js.map +1 -0
  38. package/dist/esm/Job/index.d.ts +4 -0
  39. package/dist/esm/Job/index.d.ts.map +1 -0
  40. package/dist/esm/Job/index.js +4 -0
  41. package/dist/esm/Job/index.js.map +1 -0
  42. package/dist/esm/Logger.d.ts +13 -0
  43. package/dist/esm/Logger.d.ts.map +1 -0
  44. package/dist/esm/Logger.js +2 -0
  45. package/dist/esm/Logger.js.map +1 -0
  46. package/dist/esm/index.d.ts +2 -0
  47. package/dist/esm/index.d.ts.map +1 -1
  48. package/dist/esm/index.js +2 -0
  49. package/dist/esm/index.js.map +1 -1
  50. package/package.json +1 -1
  51. package/src/Job/Job.ts +14 -0
  52. package/src/Job/JobProvider.ts +5 -0
  53. package/src/Job/Task.ts +1 -0
  54. package/src/Job/index.ts +3 -0
  55. package/src/Logger.ts +14 -0
  56. package/src/index.ts +2 -0
@@ -0,0 +1,13 @@
1
+ import { Task } from './Task';
2
+ declare type VoidFunction = (...args: any[]) => void;
3
+ export interface Job {
4
+ name: string;
5
+ onComplete?: VoidFunction;
6
+ onFail?: VoidFunction;
7
+ onStart?: VoidFunction;
8
+ onSuccess?: VoidFunction;
9
+ schedule: string;
10
+ task: Task;
11
+ }
12
+ export {};
13
+ //# sourceMappingURL=Job.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Job.d.ts","sourceRoot":"","sources":["../../../src/Job/Job.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,aAAK,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;AAE5C,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,YAAY,CAAA;IACzB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,IAAI,CAAA;CACX"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=Job.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Job.js","sourceRoot":"","sources":["../../../src/Job/Job.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ import { Job } from './Job';
2
+ export interface JobProvider {
3
+ get jobs(): Job[];
4
+ }
5
+ //# sourceMappingURL=JobProvider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JobProvider.d.ts","sourceRoot":"","sources":["../../../src/Job/JobProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAE3B,MAAM,WAAW,WAAW;IAC1B,IAAI,IAAI,IAAI,GAAG,EAAE,CAAA;CAClB"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=JobProvider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JobProvider.js","sourceRoot":"","sources":["../../../src/Job/JobProvider.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export declare type Task = () => Promise<void>;
2
+ //# sourceMappingURL=Task.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/Job/Task.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=Task.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Task.js","sourceRoot":"","sources":["../../../src/Job/Task.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export * from './Job';
2
+ export * from './JobProvider';
3
+ export * from './Task';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Job/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA"}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./Job"), exports);
5
+ tslib_1.__exportStar(require("./JobProvider"), exports);
6
+ tslib_1.__exportStar(require("./Task"), exports);
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Job/index.ts"],"names":[],"mappings":";;;AAAA,gDAAqB;AACrB,wDAA6B;AAC7B,iDAAsB"}
@@ -0,0 +1,13 @@
1
+ export declare type LogFunction = (message?: unknown) => void;
2
+ /**
3
+ * Interface to handle overlap between Winston &
4
+ * `console` with as much congruency as possible.
5
+ */
6
+ export interface Logger {
7
+ debug: LogFunction;
8
+ error: LogFunction;
9
+ info: LogFunction;
10
+ log: LogFunction;
11
+ warn: LogFunction;
12
+ }
13
+ //# sourceMappingURL=Logger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;AAErD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,WAAW,CAAA;IAEhB,IAAI,EAAE,WAAW,CAAA;CAClB"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=Logger.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":""}
@@ -1,3 +1,5 @@
1
1
  export * from './dump';
2
2
  export * from './is-ip';
3
+ export * from './Job';
4
+ export * from './Logger';
3
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA"}
package/dist/cjs/index.js CHANGED
@@ -3,4 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
4
  tslib_1.__exportStar(require("./dump"), exports);
5
5
  tslib_1.__exportStar(require("./is-ip"), exports);
6
+ tslib_1.__exportStar(require("./Job"), exports);
7
+ tslib_1.__exportStar(require("./Logger"), exports);
6
8
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAsB;AACtB,kDAAuB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAsB;AACtB,kDAAuB;AACvB,gDAAqB;AACrB,mDAAwB"}
package/dist/docs.json CHANGED
@@ -6,6 +6,494 @@
6
6
  "flags": {},
7
7
  "originalName": "",
8
8
  "children": [
9
+ {
10
+ "id": 16,
11
+ "name": "Job",
12
+ "kind": 256,
13
+ "kindString": "Interface",
14
+ "flags": {},
15
+ "children": [
16
+ {
17
+ "id": 17,
18
+ "name": "name",
19
+ "kind": 1024,
20
+ "kindString": "Property",
21
+ "flags": {},
22
+ "sources": [
23
+ {
24
+ "fileName": "Job/Job.ts",
25
+ "line": 7,
26
+ "character": 2,
27
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L7"
28
+ }
29
+ ],
30
+ "type": {
31
+ "type": "intrinsic",
32
+ "name": "string"
33
+ }
34
+ },
35
+ {
36
+ "id": 18,
37
+ "name": "onComplete",
38
+ "kind": 1024,
39
+ "kindString": "Property",
40
+ "flags": {
41
+ "isOptional": true
42
+ },
43
+ "sources": [
44
+ {
45
+ "fileName": "Job/Job.ts",
46
+ "line": 8,
47
+ "character": 2,
48
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L8"
49
+ }
50
+ ],
51
+ "type": {
52
+ "type": "reference",
53
+ "name": "VoidFunction"
54
+ }
55
+ },
56
+ {
57
+ "id": 19,
58
+ "name": "onFail",
59
+ "kind": 1024,
60
+ "kindString": "Property",
61
+ "flags": {
62
+ "isOptional": true
63
+ },
64
+ "sources": [
65
+ {
66
+ "fileName": "Job/Job.ts",
67
+ "line": 9,
68
+ "character": 2,
69
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L9"
70
+ }
71
+ ],
72
+ "type": {
73
+ "type": "reference",
74
+ "name": "VoidFunction"
75
+ }
76
+ },
77
+ {
78
+ "id": 20,
79
+ "name": "onStart",
80
+ "kind": 1024,
81
+ "kindString": "Property",
82
+ "flags": {
83
+ "isOptional": true
84
+ },
85
+ "sources": [
86
+ {
87
+ "fileName": "Job/Job.ts",
88
+ "line": 10,
89
+ "character": 2,
90
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L10"
91
+ }
92
+ ],
93
+ "type": {
94
+ "type": "reference",
95
+ "name": "VoidFunction"
96
+ }
97
+ },
98
+ {
99
+ "id": 21,
100
+ "name": "onSuccess",
101
+ "kind": 1024,
102
+ "kindString": "Property",
103
+ "flags": {
104
+ "isOptional": true
105
+ },
106
+ "sources": [
107
+ {
108
+ "fileName": "Job/Job.ts",
109
+ "line": 11,
110
+ "character": 2,
111
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L11"
112
+ }
113
+ ],
114
+ "type": {
115
+ "type": "reference",
116
+ "name": "VoidFunction"
117
+ }
118
+ },
119
+ {
120
+ "id": 22,
121
+ "name": "schedule",
122
+ "kind": 1024,
123
+ "kindString": "Property",
124
+ "flags": {},
125
+ "sources": [
126
+ {
127
+ "fileName": "Job/Job.ts",
128
+ "line": 12,
129
+ "character": 2,
130
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L12"
131
+ }
132
+ ],
133
+ "type": {
134
+ "type": "intrinsic",
135
+ "name": "string"
136
+ }
137
+ },
138
+ {
139
+ "id": 23,
140
+ "name": "task",
141
+ "kind": 1024,
142
+ "kindString": "Property",
143
+ "flags": {},
144
+ "sources": [
145
+ {
146
+ "fileName": "Job/Job.ts",
147
+ "line": 13,
148
+ "character": 2,
149
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L13"
150
+ }
151
+ ],
152
+ "type": {
153
+ "type": "reference",
154
+ "id": 27,
155
+ "name": "Task"
156
+ }
157
+ }
158
+ ],
159
+ "groups": [
160
+ {
161
+ "title": "Properties",
162
+ "children": [
163
+ 17,
164
+ 18,
165
+ 19,
166
+ 20,
167
+ 21,
168
+ 22,
169
+ 23
170
+ ]
171
+ }
172
+ ],
173
+ "sources": [
174
+ {
175
+ "fileName": "Job/Job.ts",
176
+ "line": 6,
177
+ "character": 17,
178
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Job.ts#L6"
179
+ }
180
+ ]
181
+ },
182
+ {
183
+ "id": 24,
184
+ "name": "JobProvider",
185
+ "kind": 256,
186
+ "kindString": "Interface",
187
+ "flags": {},
188
+ "children": [
189
+ {
190
+ "id": 25,
191
+ "name": "jobs",
192
+ "kind": 262144,
193
+ "kindString": "Accessor",
194
+ "flags": {},
195
+ "sources": [
196
+ {
197
+ "fileName": "Job/JobProvider.ts",
198
+ "line": 4,
199
+ "character": 6,
200
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/JobProvider.ts#L4"
201
+ }
202
+ ],
203
+ "getSignature": {
204
+ "id": 26,
205
+ "name": "jobs",
206
+ "kind": 524288,
207
+ "kindString": "Get signature",
208
+ "flags": {},
209
+ "type": {
210
+ "type": "array",
211
+ "elementType": {
212
+ "type": "reference",
213
+ "id": 16,
214
+ "name": "Job"
215
+ }
216
+ }
217
+ }
218
+ }
219
+ ],
220
+ "groups": [
221
+ {
222
+ "title": "Accessors",
223
+ "children": [
224
+ 25
225
+ ]
226
+ }
227
+ ],
228
+ "sources": [
229
+ {
230
+ "fileName": "Job/JobProvider.ts",
231
+ "line": 3,
232
+ "character": 17,
233
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/JobProvider.ts#L3"
234
+ }
235
+ ]
236
+ },
237
+ {
238
+ "id": 34,
239
+ "name": "Logger",
240
+ "kind": 256,
241
+ "kindString": "Interface",
242
+ "flags": {},
243
+ "comment": {
244
+ "summary": [
245
+ {
246
+ "kind": "text",
247
+ "text": "Interface to handle overlap between Winston &\n"
248
+ },
249
+ {
250
+ "kind": "code",
251
+ "text": "`console`"
252
+ },
253
+ {
254
+ "kind": "text",
255
+ "text": " with as much congruency as possible."
256
+ }
257
+ ]
258
+ },
259
+ "children": [
260
+ {
261
+ "id": 35,
262
+ "name": "debug",
263
+ "kind": 1024,
264
+ "kindString": "Property",
265
+ "flags": {},
266
+ "sources": [
267
+ {
268
+ "fileName": "Logger.ts",
269
+ "line": 8,
270
+ "character": 2,
271
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L8"
272
+ }
273
+ ],
274
+ "type": {
275
+ "type": "reference",
276
+ "id": 30,
277
+ "name": "LogFunction"
278
+ }
279
+ },
280
+ {
281
+ "id": 36,
282
+ "name": "error",
283
+ "kind": 1024,
284
+ "kindString": "Property",
285
+ "flags": {},
286
+ "sources": [
287
+ {
288
+ "fileName": "Logger.ts",
289
+ "line": 9,
290
+ "character": 2,
291
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L9"
292
+ }
293
+ ],
294
+ "type": {
295
+ "type": "reference",
296
+ "id": 30,
297
+ "name": "LogFunction"
298
+ }
299
+ },
300
+ {
301
+ "id": 37,
302
+ "name": "info",
303
+ "kind": 1024,
304
+ "kindString": "Property",
305
+ "flags": {},
306
+ "sources": [
307
+ {
308
+ "fileName": "Logger.ts",
309
+ "line": 10,
310
+ "character": 2,
311
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L10"
312
+ }
313
+ ],
314
+ "type": {
315
+ "type": "reference",
316
+ "id": 30,
317
+ "name": "LogFunction"
318
+ }
319
+ },
320
+ {
321
+ "id": 38,
322
+ "name": "log",
323
+ "kind": 1024,
324
+ "kindString": "Property",
325
+ "flags": {},
326
+ "sources": [
327
+ {
328
+ "fileName": "Logger.ts",
329
+ "line": 11,
330
+ "character": 2,
331
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L11"
332
+ }
333
+ ],
334
+ "type": {
335
+ "type": "reference",
336
+ "id": 30,
337
+ "name": "LogFunction"
338
+ }
339
+ },
340
+ {
341
+ "id": 39,
342
+ "name": "warn",
343
+ "kind": 1024,
344
+ "kindString": "Property",
345
+ "flags": {},
346
+ "sources": [
347
+ {
348
+ "fileName": "Logger.ts",
349
+ "line": 13,
350
+ "character": 2,
351
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L13"
352
+ }
353
+ ],
354
+ "type": {
355
+ "type": "reference",
356
+ "id": 30,
357
+ "name": "LogFunction"
358
+ }
359
+ }
360
+ ],
361
+ "groups": [
362
+ {
363
+ "title": "Properties",
364
+ "children": [
365
+ 35,
366
+ 36,
367
+ 37,
368
+ 38,
369
+ 39
370
+ ]
371
+ }
372
+ ],
373
+ "sources": [
374
+ {
375
+ "fileName": "Logger.ts",
376
+ "line": 7,
377
+ "character": 17,
378
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L7"
379
+ }
380
+ ]
381
+ },
382
+ {
383
+ "id": 30,
384
+ "name": "LogFunction",
385
+ "kind": 4194304,
386
+ "kindString": "Type alias",
387
+ "flags": {},
388
+ "sources": [
389
+ {
390
+ "fileName": "Logger.ts",
391
+ "line": 1,
392
+ "character": 12,
393
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L1"
394
+ }
395
+ ],
396
+ "type": {
397
+ "type": "reflection",
398
+ "declaration": {
399
+ "id": 31,
400
+ "name": "__type",
401
+ "kind": 65536,
402
+ "kindString": "Type literal",
403
+ "flags": {},
404
+ "sources": [
405
+ {
406
+ "fileName": "Logger.ts",
407
+ "line": 1,
408
+ "character": 26,
409
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Logger.ts#L1"
410
+ }
411
+ ],
412
+ "signatures": [
413
+ {
414
+ "id": 32,
415
+ "name": "__type",
416
+ "kind": 4096,
417
+ "kindString": "Call signature",
418
+ "flags": {},
419
+ "parameters": [
420
+ {
421
+ "id": 33,
422
+ "name": "message",
423
+ "kind": 32768,
424
+ "kindString": "Parameter",
425
+ "flags": {
426
+ "isOptional": true
427
+ },
428
+ "type": {
429
+ "type": "intrinsic",
430
+ "name": "unknown"
431
+ }
432
+ }
433
+ ],
434
+ "type": {
435
+ "type": "intrinsic",
436
+ "name": "void"
437
+ }
438
+ }
439
+ ]
440
+ }
441
+ }
442
+ },
443
+ {
444
+ "id": 27,
445
+ "name": "Task",
446
+ "kind": 4194304,
447
+ "kindString": "Type alias",
448
+ "flags": {},
449
+ "sources": [
450
+ {
451
+ "fileName": "Job/Task.ts",
452
+ "line": 1,
453
+ "character": 12,
454
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Task.ts#L1"
455
+ }
456
+ ],
457
+ "type": {
458
+ "type": "reflection",
459
+ "declaration": {
460
+ "id": 28,
461
+ "name": "__type",
462
+ "kind": 65536,
463
+ "kindString": "Type literal",
464
+ "flags": {},
465
+ "sources": [
466
+ {
467
+ "fileName": "Job/Task.ts",
468
+ "line": 1,
469
+ "character": 19,
470
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/Job/Task.ts#L1"
471
+ }
472
+ ],
473
+ "signatures": [
474
+ {
475
+ "id": 29,
476
+ "name": "__type",
477
+ "kind": 4096,
478
+ "kindString": "Call signature",
479
+ "flags": {},
480
+ "type": {
481
+ "type": "reference",
482
+ "typeArguments": [
483
+ {
484
+ "type": "intrinsic",
485
+ "name": "void"
486
+ }
487
+ ],
488
+ "name": "Promise",
489
+ "qualifiedName": "Promise",
490
+ "package": "typescript"
491
+ }
492
+ }
493
+ ]
494
+ }
495
+ }
496
+ },
9
497
  {
10
498
  "id": 1,
11
499
  "name": "dump",
@@ -17,7 +505,7 @@
17
505
  "fileName": "dump.ts",
18
506
  "line": 1,
19
507
  "character": 13,
20
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/4899aaf/packages/sdk/packages/shared/src/dump.ts#L1"
508
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/dump.ts#L1"
21
509
  }
22
510
  ],
23
511
  "signatures": [
@@ -58,7 +546,7 @@
58
546
  "fileName": "is-ip/is-ip.ts",
59
547
  "line": 15,
60
548
  "character": 16,
61
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/4899aaf/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L15"
549
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L15"
62
550
  }
63
551
  ],
64
552
  "signatures": [
@@ -112,7 +600,7 @@
112
600
  "fileName": "is-ip/is-ip.ts",
113
601
  "line": 3,
114
602
  "character": 16,
115
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/4899aaf/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L3"
603
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L3"
116
604
  }
117
605
  ],
118
606
  "signatures": [
@@ -153,7 +641,7 @@
153
641
  "fileName": "is-ip/is-ip.ts",
154
642
  "line": 11,
155
643
  "character": 16,
156
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/4899aaf/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L11"
644
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L11"
157
645
  }
158
646
  ],
159
647
  "signatures": [
@@ -194,7 +682,7 @@
194
682
  "fileName": "is-ip/is-ip.ts",
195
683
  "line": 7,
196
684
  "character": 16,
197
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/4899aaf/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L7"
685
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/is-ip/is-ip.ts#L7"
198
686
  }
199
687
  ],
200
688
  "signatures": [
@@ -226,6 +714,21 @@
226
714
  }
227
715
  ],
228
716
  "groups": [
717
+ {
718
+ "title": "Interfaces",
719
+ "children": [
720
+ 16,
721
+ 24,
722
+ 34
723
+ ]
724
+ },
725
+ {
726
+ "title": "Type Aliases",
727
+ "children": [
728
+ 30,
729
+ 27
730
+ ]
731
+ },
229
732
  {
230
733
  "title": "Functions",
231
734
  "children": [
@@ -242,7 +745,7 @@
242
745
  "fileName": "index.ts",
243
746
  "line": 1,
244
747
  "character": 0,
245
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/4899aaf/packages/sdk/packages/shared/src/index.ts#L1"
748
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/08fc5f41/packages/sdk/packages/shared/src/index.ts#L1"
246
749
  }
247
750
  ]
248
751
  }
@@ -0,0 +1,13 @@
1
+ import { Task } from './Task';
2
+ declare type VoidFunction = (...args: any[]) => void;
3
+ export interface Job {
4
+ name: string;
5
+ onComplete?: VoidFunction;
6
+ onFail?: VoidFunction;
7
+ onStart?: VoidFunction;
8
+ onSuccess?: VoidFunction;
9
+ schedule: string;
10
+ task: Task;
11
+ }
12
+ export {};
13
+ //# sourceMappingURL=Job.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Job.d.ts","sourceRoot":"","sources":["../../../src/Job/Job.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAG7B,aAAK,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;AAE5C,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,YAAY,CAAA;IACzB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,IAAI,CAAA;CACX"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=Job.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Job.js","sourceRoot":"","sources":["../../../src/Job/Job.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ import { Job } from './Job';
2
+ export interface JobProvider {
3
+ get jobs(): Job[];
4
+ }
5
+ //# sourceMappingURL=JobProvider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JobProvider.d.ts","sourceRoot":"","sources":["../../../src/Job/JobProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAE3B,MAAM,WAAW,WAAW;IAC1B,IAAI,IAAI,IAAI,GAAG,EAAE,CAAA;CAClB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=JobProvider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JobProvider.js","sourceRoot":"","sources":["../../../src/Job/JobProvider.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export declare type Task = () => Promise<void>;
2
+ //# sourceMappingURL=Task.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/Job/Task.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=Task.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Task.js","sourceRoot":"","sources":["../../../src/Job/Task.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export * from './Job';
2
+ export * from './JobProvider';
3
+ export * from './Task';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Job/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './Job';
2
+ export * from './JobProvider';
3
+ export * from './Task';
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Job/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA"}
@@ -0,0 +1,13 @@
1
+ export declare type LogFunction = (message?: unknown) => void;
2
+ /**
3
+ * Interface to handle overlap between Winston &
4
+ * `console` with as much congruency as possible.
5
+ */
6
+ export interface Logger {
7
+ debug: LogFunction;
8
+ error: LogFunction;
9
+ info: LogFunction;
10
+ log: LogFunction;
11
+ warn: LogFunction;
12
+ }
13
+ //# sourceMappingURL=Logger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;AAErD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,WAAW,CAAA;IAEhB,IAAI,EAAE,WAAW,CAAA;CAClB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=Logger.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":""}
@@ -1,3 +1,5 @@
1
1
  export * from './dump';
2
2
  export * from './is-ip';
3
+ export * from './Job';
4
+ export * from './Logger';
3
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA"}
package/dist/esm/index.js CHANGED
@@ -1,3 +1,5 @@
1
1
  export * from './dump';
2
2
  export * from './is-ip';
3
+ export * from './Job';
4
+ export * from './Logger';
3
5
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA"}
package/package.json CHANGED
@@ -45,5 +45,5 @@
45
45
  },
46
46
  "sideEffects": false,
47
47
  "types": "dist/esm/index.d.ts",
48
- "version": "2.37.5"
48
+ "version": "2.37.7"
49
49
  }
package/src/Job/Job.ts ADDED
@@ -0,0 +1,14 @@
1
+ import { Task } from './Task'
2
+
3
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
4
+ type VoidFunction = (...args: any[]) => void
5
+
6
+ export interface Job {
7
+ name: string
8
+ onComplete?: VoidFunction
9
+ onFail?: VoidFunction
10
+ onStart?: VoidFunction
11
+ onSuccess?: VoidFunction
12
+ schedule: string
13
+ task: Task
14
+ }
@@ -0,0 +1,5 @@
1
+ import { Job } from './Job'
2
+
3
+ export interface JobProvider {
4
+ get jobs(): Job[]
5
+ }
@@ -0,0 +1 @@
1
+ export type Task = () => Promise<void>
@@ -0,0 +1,3 @@
1
+ export * from './Job'
2
+ export * from './JobProvider'
3
+ export * from './Task'
package/src/Logger.ts ADDED
@@ -0,0 +1,14 @@
1
+ export type LogFunction = (message?: unknown) => void
2
+
3
+ /**
4
+ * Interface to handle overlap between Winston &
5
+ * `console` with as much congruency as possible.
6
+ */
7
+ export interface Logger {
8
+ debug: LogFunction
9
+ error: LogFunction
10
+ info: LogFunction
11
+ log: LogFunction
12
+ // trace: LogFunction
13
+ warn: LogFunction
14
+ }
package/src/index.ts CHANGED
@@ -1,2 +1,4 @@
1
1
  export * from './dump'
2
2
  export * from './is-ip'
3
+ export * from './Job'
4
+ export * from './Logger'