@companion-module/base 1.14.0-0-nightly-main-20251113-203236-30c5c0c → 1.99.0-0-nightly-feat-split-api-20251221-153951-fa12995

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 (122) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +12 -11
  3. package/dist/__mocks__/net.d.ts +30 -0
  4. package/dist/__mocks__/net.js +108 -0
  5. package/dist/__mocks__/net.js.map +1 -0
  6. package/dist/__mocks__/util.d.ts +8 -0
  7. package/dist/__mocks__/util.js +44 -0
  8. package/dist/__mocks__/util.js.map +1 -0
  9. package/dist/common/json-value.d.ts +0 -1
  10. package/dist/common/osc.d.ts +0 -1
  11. package/dist/entrypoint.d.ts +9 -1
  12. package/dist/entrypoint.js +4 -122
  13. package/dist/entrypoint.js.map +1 -1
  14. package/dist/helpers/__tests__/tcp.spec.d.ts +1 -0
  15. package/dist/helpers/__tests__/tcp.spec.js +210 -0
  16. package/dist/helpers/__tests__/tcp.spec.js.map +1 -0
  17. package/dist/helpers/__tests__/udp.spec.d.ts +1 -0
  18. package/dist/helpers/__tests__/udp.spec.js +200 -0
  19. package/dist/helpers/__tests__/udp.spec.js.map +1 -0
  20. package/dist/helpers/index.d.ts +3 -4
  21. package/dist/helpers/index.js +4 -7
  22. package/dist/helpers/index.js.map +1 -1
  23. package/dist/helpers/tcp.d.ts +1 -3
  24. package/dist/helpers/telnet.d.ts +0 -1
  25. package/dist/helpers/udp.d.ts +1 -3
  26. package/dist/host-api/context.d.ts +59 -0
  27. package/dist/host-api/{api.js → context.js} +6 -1
  28. package/dist/host-api/context.js.map +1 -0
  29. package/dist/instance-base.d.ts +0 -1
  30. package/dist/logging.d.ts +20 -0
  31. package/dist/logging.js +25 -0
  32. package/dist/logging.js.map +1 -0
  33. package/dist/main.d.ts +8 -0
  34. package/dist/main.js +14 -0
  35. package/dist/main.js.map +1 -0
  36. package/dist/manifest.d.ts +2 -3
  37. package/dist/manifest.js.map +1 -1
  38. package/dist/module-api/__tests__/shared-udp-socket.spec.d.ts +1 -0
  39. package/dist/module-api/__tests__/shared-udp-socket.spec.js +272 -0
  40. package/dist/module-api/__tests__/shared-udp-socket.spec.js.map +1 -0
  41. package/dist/module-api/action.d.ts +0 -1
  42. package/dist/module-api/base.d.ts +3 -17
  43. package/dist/module-api/base.js +47 -320
  44. package/dist/module-api/base.js.map +1 -1
  45. package/dist/module-api/common.d.ts +0 -1
  46. package/dist/module-api/config.d.ts +0 -1
  47. package/dist/module-api/enums.d.ts +0 -2
  48. package/dist/module-api/enums.js.map +1 -1
  49. package/dist/module-api/feedback.d.ts +0 -1
  50. package/dist/module-api/http.d.ts +0 -1
  51. package/dist/module-api/index.d.ts +2 -2
  52. package/dist/module-api/index.js +1 -0
  53. package/dist/module-api/index.js.map +1 -1
  54. package/dist/module-api/input.d.ts +0 -1
  55. package/dist/module-api/preset.d.ts +0 -1
  56. package/dist/module-api/shared-udp-socket.d.ts +3 -5
  57. package/dist/module-api/shared-udp-socket.js +13 -15
  58. package/dist/module-api/shared-udp-socket.js.map +1 -1
  59. package/dist/module-api/style.d.ts +0 -1
  60. package/dist/module-api/upgrade.d.ts +0 -1
  61. package/dist/module-api/variable.d.ts +0 -1
  62. package/dist/util.d.ts +0 -1
  63. package/package.json +7 -36
  64. package/dist/common/json-value.d.ts.map +0 -1
  65. package/dist/common/osc.d.ts.map +0 -1
  66. package/dist/entrypoint.d.ts.map +0 -1
  67. package/dist/helpers/index.d.ts.map +0 -1
  68. package/dist/helpers/tcp.d.ts.map +0 -1
  69. package/dist/helpers/telnet.d.ts.map +0 -1
  70. package/dist/helpers/udp.d.ts.map +0 -1
  71. package/dist/host-api/api.d.ts +0 -389
  72. package/dist/host-api/api.d.ts.map +0 -1
  73. package/dist/host-api/api.js.map +0 -1
  74. package/dist/host-api/ipc-wrapper.d.ts +0 -37
  75. package/dist/host-api/ipc-wrapper.d.ts.map +0 -1
  76. package/dist/host-api/ipc-wrapper.js +0 -129
  77. package/dist/host-api/ipc-wrapper.js.map +0 -1
  78. package/dist/host-api/versions.d.ts +0 -12
  79. package/dist/host-api/versions.d.ts.map +0 -1
  80. package/dist/host-api/versions.js +0 -5
  81. package/dist/host-api/versions.js.map +0 -1
  82. package/dist/index.d.ts +0 -8
  83. package/dist/index.d.ts.map +0 -1
  84. package/dist/index.js +0 -22
  85. package/dist/index.js.map +0 -1
  86. package/dist/instance-base.d.ts.map +0 -1
  87. package/dist/internal/actions.d.ts +0 -16
  88. package/dist/internal/actions.d.ts.map +0 -1
  89. package/dist/internal/actions.js +0 -223
  90. package/dist/internal/actions.js.map +0 -1
  91. package/dist/internal/base.d.ts +0 -11
  92. package/dist/internal/base.d.ts.map +0 -1
  93. package/dist/internal/base.js +0 -39
  94. package/dist/internal/base.js.map +0 -1
  95. package/dist/internal/feedback.d.ts +0 -20
  96. package/dist/internal/feedback.d.ts.map +0 -1
  97. package/dist/internal/feedback.js +0 -307
  98. package/dist/internal/feedback.js.map +0 -1
  99. package/dist/internal/upgrade.d.ts +0 -15
  100. package/dist/internal/upgrade.d.ts.map +0 -1
  101. package/dist/internal/upgrade.js +0 -174
  102. package/dist/internal/upgrade.js.map +0 -1
  103. package/dist/manifest.d.ts.map +0 -1
  104. package/dist/module-api/action.d.ts.map +0 -1
  105. package/dist/module-api/base.d.ts.map +0 -1
  106. package/dist/module-api/common.d.ts.map +0 -1
  107. package/dist/module-api/config.d.ts.map +0 -1
  108. package/dist/module-api/enums.d.ts.map +0 -1
  109. package/dist/module-api/feedback.d.ts.map +0 -1
  110. package/dist/module-api/http.d.ts.map +0 -1
  111. package/dist/module-api/index.d.ts.map +0 -1
  112. package/dist/module-api/input.d.ts.map +0 -1
  113. package/dist/module-api/preset.d.ts.map +0 -1
  114. package/dist/module-api/shared-udp-socket.d.ts.map +0 -1
  115. package/dist/module-api/style.d.ts.map +0 -1
  116. package/dist/module-api/upgrade.d.ts.map +0 -1
  117. package/dist/module-api/variable.d.ts.map +0 -1
  118. package/dist/util.d.ts.map +0 -1
  119. package/lib/debounce-fn/index.d.ts +0 -83
  120. package/lib/debounce-fn/index.js +0 -78
  121. package/lib/debounce-fn/license +0 -9
  122. package/lib/debounce-fn/readme.md +0 -64
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tcp.spec.js","sourceRoot":"","sources":["../../../src/helpers/__tests__/tcp.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA4D;AAC5D,sCAAqC;AAErC,6BAA4B;AAE5B,MAAM,UAAU,GAAG,YAAuC,CAAA;AAE1D,WAAE,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE,mDAAQ,wBAAwB,GAAC,CAAC,CAAA;AAE5D,oCAAoC;AACpC,0DAA0D;AAC1D,IAAI;AAEJ,IAAA,iBAAQ,EAAC,KAAK,EAAE,GAAG,EAAE;IACpB,qBAAqB;IACrB,gCAAgC;IAChC,KAAK;IAEL,IAAA,kBAAS,EAAC,GAAG,EAAE;QACd,UAAU,CAAC,gBAAgB,EAAE,CAAA;IAC9B,CAAC,CAAC,CAAA;IAEF,sCAAsC;IACtC,6DAA6D;IAC7D,oFAAoF;IAEpF,gEAAgE;IAChE,uEAAuE;IACvE,KAAK;IAEL,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAC1B,IAAA,WAAE,EAAC,IAAI,EAAE,GAAG,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC5C,IAAI,CAAC;gBACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;gBAE3B,IAAA,eAAM,EAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;gBAChD,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAA;gBAE7C,IAAA,eAAM,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;gBAC3C,IAAA,eAAM,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;oBACnC,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC;oBACjC,CAAC,YAAY,EAAE,IAAI,CAAC;iBACpB,CAAC,CAAA;YACH,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,OAAO,EAAE,CAAA;YACjB,CAAC;QACF,CAAC,CAAC,CAAA;QAEF,+BAA+B;QAC/B,yCAAyC;QACzC,0DAA0D;QAE1D,yEAAyE;QACzE,qDAAqD;QAErD,mDAAmD;QACnD,6DAA6D;QAC7D,KAAK;QAEL,yBAAyB;QACzB,yCAAyC;QACzC,0DAA0D;QAE1D,iDAAiD;QACjD,aAAa;QACb,4BAA4B;QAC5B,MAAM;QAEN,gDAAgD;QAChD,SAAS;QACT,gCAAgC;QAChC,sDAAsD;QAEtD,oDAAoD;QACpD,8DAA8D;QAC9D,eAAe;QACf,qBAAqB;QACrB,KAAK;QACL,KAAK;QAEL,iBAAiB;IAClB,CAAC,CAAC,CAAA;IAEF,wCAAwC;IACxC,yCAAyC;IACzC,0DAA0D;IAE1D,iEAAiE;IAEjE,gDAAgD;IAChD,SAAS;IACT,gCAAgC;IAEhC,yCAAyC;IACzC,0CAA0C;IAC1C,qCAAqC;IACrC,8CAA8C;IAE9C,sDAAsD;IAEtD,wDAAwD;IAExD,kDAAkD;IAClD,0EAA0E;IAC1E,mDAAmD;IACnD,6FAA6F;IAC7F,eAAe;IACf,qBAAqB;IACrB,KAAK;IACL,KAAK;IAEL,gCAAgC;IAChC,0BAA0B;IAC1B,0CAA0C;IAC1C,2DAA2D;IAE3D,kEAAkE;IAElE,iDAAiD;IACjD,UAAU;IACV,iCAAiC;IAEjC,8CAA8C;IAC9C,2CAA2C;IAC3C,4CAA4C;IAC5C,+CAA+C;IAE/C,uDAAuD;IAEvD,iCAAiC;IAEjC,uDAAuD;IACvD,oDAAoD;IACpD,8EAA8E;IAC9E,gBAAgB;IAChB,sBAAsB;IACtB,MAAM;IACN,MAAM;IAEN,qBAAqB;IACrB,KAAK;IAEL,yCAAyC;IACzC,yCAAyC;IACzC,0DAA0D;IAE1D,iEAAiE;IAEjE,sCAAsC;IACtC,KAAK;IAEL,2BAA2B;IAC3B,yCAAyC;IACzC,6DAA6D;IAC7D,yBAAyB;IAEzB,qBAAqB;IACrB,2DAA2D;IAE3D,2CAA2C;IAC3C,gCAAgC;IAChC,MAAM;IAEN,sBAAsB;IACtB,gCAAgC;IAChC,+BAA+B;IAC/B,MAAM;IAEN,oBAAoB;IACpB,iCAAiC;IACjC,MAAM;IAEN,iCAAiC;IACjC,2DAA2D;IAE3D,mDAAmD;IACnD,kCAAkC;IAElC,uBAAuB;IACvB,qDAAqD;IAErD,4FAA4F;IAC5F,MAAM;IAEN,kCAAkC;IAClC,sFAAsF;IAEtF,oDAAoD;IACpD,MAAM;IAEN,kCAAkC;IAClC,qEAAqE;IACrE,qBAAqB;IAErB,sBAAsB;IACtB,OAAO;IAEP,mEAAmE;IAEnE,oDAAoD;IACpD,kGAAkG;IAClG,MAAM;IAEN,kCAAkC;IAClC,qEAAqE;IACrE,qBAAqB;IAErB,sBAAsB;IACtB,OAAO;IAEP,wCAAwC;IACxC,4DAA4D;IAE5D,oDAAoD;IACpD,2FAA2F;IAC3F,MAAM;IAEN,kCAAkC;IAClC,qEAAqE;IACrE,qBAAqB;IAErB,yCAAyC;IACzC,OAAO;IAEP,wCAAwC;IACxC,sEAAsE;IAEtE,oDAAoD;IACpD,2FAA2F;IAC3F,MAAM;IACN,KAAK;AACN,CAAC,CAAC,CAAA"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,200 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ const vitest_1 = require("vitest");
5
+ const udp_js_1 = require("../udp.js");
6
+ const events_1 = tslib_1.__importDefault(require("events"));
7
+ const enums_js_1 = require("../../module-api/enums.js");
8
+ const createSocketMock = vitest_1.vi.fn(() => {
9
+ throw new Error('Not implemented');
10
+ });
11
+ vitest_1.vi.mock('dgram', () => {
12
+ return {
13
+ default: {
14
+ createSocket: (...args) => createSocketMock(...args),
15
+ },
16
+ };
17
+ });
18
+ class MinimalSocket extends events_1.default {
19
+ isOpen = false;
20
+ constructor() {
21
+ super();
22
+ }
23
+ async emitMessage(address, port, msg) {
24
+ const rinfo = {
25
+ address: address,
26
+ port: port,
27
+ family: 'IPv4',
28
+ size: msg.length,
29
+ };
30
+ this.emit('message', msg, rinfo);
31
+ await vitest_1.vi.runAllTimersAsync();
32
+ }
33
+ bind = vitest_1.vi.fn(() => {
34
+ throw new Error('Not implemented');
35
+ });
36
+ send = vitest_1.vi.fn(() => {
37
+ throw new Error('Not implemented');
38
+ });
39
+ close = vitest_1.vi.fn(() => {
40
+ return this;
41
+ });
42
+ }
43
+ (0, vitest_1.describe)('UDP', () => {
44
+ (0, vitest_1.beforeEach)(() => {
45
+ createSocketMock.mockClear();
46
+ });
47
+ (0, vitest_1.describe)('construct', () => {
48
+ // beforeEach(() => {
49
+ // vi.useFakeTimers()
50
+ // })
51
+ (0, vitest_1.it)('no socket', () => {
52
+ createSocketMock.mockImplementationOnce(() => {
53
+ throw new Error('No sockets!');
54
+ });
55
+ (0, vitest_1.expect)(() => new udp_js_1.UDPHelper('1.2.3.4', 852)).toThrow('No sockets!');
56
+ });
57
+ (0, vitest_1.it)('bad bind', async () => {
58
+ const rawSocket = new MinimalSocket();
59
+ createSocketMock.mockReturnValueOnce(rawSocket);
60
+ (0, vitest_1.expect)(() => new udp_js_1.UDPHelper('1.2.3.4', 852)).toThrow('Unable to bind');
61
+ (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
62
+ (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledTimes(1);
63
+ (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledWith(0, undefined);
64
+ });
65
+ (0, vitest_1.it)('ok', async () => {
66
+ const rawSocket = new MinimalSocket();
67
+ createSocketMock.mockReturnValueOnce(rawSocket);
68
+ rawSocket.bind.mockImplementationOnce(() => {
69
+ // No op
70
+ return rawSocket;
71
+ });
72
+ const socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
73
+ try {
74
+ (0, vitest_1.expect)(socket).toBeTruthy();
75
+ (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
76
+ (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledTimes(1);
77
+ (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledWith(0, undefined);
78
+ }
79
+ finally {
80
+ socket.destroy();
81
+ }
82
+ });
83
+ // TODO - options
84
+ });
85
+ (0, vitest_1.it)('error propogation', async () => {
86
+ const rawSocket = new MinimalSocket();
87
+ createSocketMock.mockReturnValueOnce(rawSocket);
88
+ rawSocket.bind.mockImplementationOnce(() => rawSocket);
89
+ const socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
90
+ try {
91
+ (0, vitest_1.expect)(socket).toBeTruthy();
92
+ const errorHandler = vitest_1.vi.fn(() => null);
93
+ const statusHandler = vitest_1.vi.fn(() => null);
94
+ socket.on('error', errorHandler);
95
+ socket.on('status_change', statusHandler);
96
+ (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
97
+ rawSocket.emit('error', new Error('My fake error'));
98
+ (0, vitest_1.expect)(errorHandler).toHaveBeenCalledTimes(1);
99
+ (0, vitest_1.expect)(errorHandler).toHaveBeenCalledWith(new Error('My fake error'));
100
+ (0, vitest_1.expect)(statusHandler).toHaveBeenCalledTimes(1);
101
+ (0, vitest_1.expect)(statusHandler).toHaveBeenCalledWith(enums_js_1.InstanceStatus.UnknownError, 'My fake error');
102
+ }
103
+ finally {
104
+ socket.destroy();
105
+ }
106
+ });
107
+ (0, vitest_1.describe)('listening', () => {
108
+ (0, vitest_1.it)('ok', async () => {
109
+ const rawSocket = new MinimalSocket();
110
+ createSocketMock.mockReturnValueOnce(rawSocket);
111
+ rawSocket.bind.mockImplementationOnce(() => rawSocket);
112
+ const socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
113
+ try {
114
+ (0, vitest_1.expect)(socket).toBeTruthy();
115
+ const listeningHandler = vitest_1.vi.fn(() => null);
116
+ const statusHandler = vitest_1.vi.fn(() => null);
117
+ socket.on('listening', listeningHandler);
118
+ socket.on('status_change', statusHandler);
119
+ (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
120
+ rawSocket.emit('listening');
121
+ (0, vitest_1.expect)(listeningHandler).toHaveBeenCalledTimes(1);
122
+ (0, vitest_1.expect)(statusHandler).toHaveBeenCalledTimes(1);
123
+ (0, vitest_1.expect)(statusHandler).toHaveBeenCalledWith(enums_js_1.InstanceStatus.Ok, undefined);
124
+ }
125
+ finally {
126
+ socket.destroy();
127
+ }
128
+ });
129
+ // TODO - options
130
+ });
131
+ // it('no error handler timeout', () => {
132
+ // const rawSocket = new MinimalSocket()
133
+ // createSocketMock.mockReturnValueOnce(rawSocket as any)
134
+ // rawSocket.bind.mockImplementationOnce(() => rawSocket as any)
135
+ // vi.advanceTimersByTimeAsync(10000)
136
+ // })
137
+ (0, vitest_1.describe)('send', () => {
138
+ const rawSocket = new MinimalSocket();
139
+ rawSocket.bind.mockImplementation(() => rawSocket);
140
+ let socket;
141
+ (0, vitest_1.beforeAll)(() => {
142
+ createSocketMock.mockReturnValueOnce(rawSocket);
143
+ socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
144
+ (0, vitest_1.expect)(socket).toBeTruthy();
145
+ });
146
+ (0, vitest_1.beforeEach)(() => {
147
+ rawSocket.close.mockClear();
148
+ rawSocket.send.mockClear();
149
+ });
150
+ (0, vitest_1.afterAll)(() => {
151
+ if (socket)
152
+ socket.destroy();
153
+ });
154
+ (0, vitest_1.it)('destroyed', async () => {
155
+ createSocketMock.mockReturnValueOnce(rawSocket);
156
+ const mySocket = new udp_js_1.UDPHelper('1.2.3.4', 852);
157
+ (0, vitest_1.expect)(mySocket).toBeTruthy();
158
+ mySocket.destroy();
159
+ (0, vitest_1.expect)(rawSocket.close).toHaveBeenCalledTimes(1);
160
+ await (0, vitest_1.expect)(mySocket.send('test')).rejects.toThrow('Cannot write to destroyed socket');
161
+ });
162
+ (0, vitest_1.it)('no message', async () => {
163
+ await (0, vitest_1.expect)(socket.send(undefined)).rejects.toThrow('No message to send');
164
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(0);
165
+ });
166
+ (0, vitest_1.it)('ok: string', async () => {
167
+ rawSocket.send.mockImplementation((msg, offset, length, cb) => {
168
+ if (!cb)
169
+ return;
170
+ cb(null, length);
171
+ });
172
+ await (0, vitest_1.expect)(socket.send('test 123')).resolves.toBeUndefined();
173
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(1);
174
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledWith('test 123', 852, '1.2.3.4', vitest_1.expect.any(Function));
175
+ });
176
+ (0, vitest_1.it)('ok: buffer', async () => {
177
+ rawSocket.send.mockImplementation((msg, offset, length, cb) => {
178
+ if (!cb)
179
+ return;
180
+ cb(null, length);
181
+ });
182
+ const msg = Buffer.from('test 123');
183
+ await (0, vitest_1.expect)(socket.send(msg)).resolves.toBeUndefined();
184
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(1);
185
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledWith(msg, 852, '1.2.3.4', vitest_1.expect.any(Function));
186
+ });
187
+ (0, vitest_1.it)('send error', async () => {
188
+ rawSocket.send.mockImplementation((msg, offset, length, cb) => {
189
+ if (!cb)
190
+ return;
191
+ cb(new Error('buffer overflow'), 0);
192
+ });
193
+ const msg = Buffer.from('test 123');
194
+ await (0, vitest_1.expect)(socket.send(msg)).rejects.toThrow('buffer overflow');
195
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(1);
196
+ (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledWith(msg, 852, '1.2.3.4', vitest_1.expect.any(Function));
197
+ });
198
+ });
199
+ });
200
+ //# sourceMappingURL=udp.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"udp.spec.js","sourceRoot":"","sources":["../../../src/helpers/__tests__/udp.spec.ts"],"names":[],"mappings":";;;AAAA,mCAAkF;AAElF,sCAAqC;AACrC,4DAAiC;AAEjC,wDAA0D;AAE1D,MAAM,gBAAgB,GAAG,WAAE,CAAC,EAAE,CAAsB,GAAG,EAAE;IACxD,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AACF,WAAE,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,OAAO;QACN,OAAO,EAAE;YACR,YAAY,EAAE,CAAC,GAAG,IAAqC,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;SACrF;KACD,CAAA;AACF,CAAC,CAAC,CAAA;AAEF,MAAM,aAAc,SAAQ,gBAAY;IAChC,MAAM,GAAG,KAAK,CAAA;IAErB;QACC,KAAK,EAAE,CAAA;IACR,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,IAAY,EAAE,GAAW;QAClE,MAAM,KAAK,GAAe;YACzB,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,GAAG,CAAC,MAAM;SAChB,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;QAEhC,MAAM,WAAE,CAAC,iBAAiB,EAAE,CAAA;IAC7B,CAAC;IAEM,IAAI,GAAG,WAAE,CAAC,EAAE,CAAiB,GAAG,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEK,IAAI,GAAG,WAAE,CAAC,EAAE,CAAiB,GAAG,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEK,KAAK,GAAG,WAAE,CAAC,EAAE,CAAkB,GAAG,EAAE;QAC1C,OAAO,IAAW,CAAA;IACnB,CAAC,CAAC,CAAA;CACF;AAED,IAAA,iBAAQ,EAAC,KAAK,EAAE,GAAG,EAAE;IACpB,IAAA,mBAAU,EAAC,GAAG,EAAE;QACf,gBAAgB,CAAC,SAAS,EAAE,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAC1B,qBAAqB;QACrB,sBAAsB;QACtB,KAAK;QACL,IAAA,WAAE,EAAC,WAAW,EAAE,GAAG,EAAE;YACpB,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,EAAE;gBAC5C,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAA;YAEF,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACnE,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,UAAU,EAAE,KAAK,IAAI,EAAE;YACzB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;YACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YACrE,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEjD,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;QAC1D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;YACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE;gBAC1C,QAAQ;gBACR,OAAO,SAAgB,CAAA;YACxB,CAAC,CAAC,CAAA;YAEF,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC5C,IAAI,CAAC;gBACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;gBAC3B,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAEjD,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;YAC1D,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,OAAO,EAAE,CAAA;YACjB,CAAC;QACF,CAAC,CAAC,CAAA;QAEF,iBAAiB;IAClB,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;QACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;QAEtD,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,SAAgB,CAAC,CAAA;QAE7D,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;QAC5C,IAAI,CAAC;YACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;YAE3B,MAAM,YAAY,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;YACtC,MAAM,aAAa,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;YACvC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YAChC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;YAEzC,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEjD,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;YAEnD,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC7C,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;YACrE,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,yBAAc,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;QACzF,CAAC;gBAAS,CAAC;YACV,MAAM,CAAC,OAAO,EAAE,CAAA;QACjB,CAAC;IACF,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAC1B,IAAA,WAAE,EAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;YACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,SAAgB,CAAC,CAAA;YAE7D,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC5C,IAAI,CAAC;gBACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;gBAE3B,MAAM,gBAAgB,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;gBAC1C,MAAM,aAAa,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;gBACvC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;gBACxC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;gBAEzC,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAEjD,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAE3B,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBACjD,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAC9C,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,yBAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;YACzE,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,OAAO,EAAE,CAAA;YACjB,CAAC;QACF,CAAC,CAAC,CAAA;QAEF,iBAAiB;IAClB,CAAC,CAAC,CAAA;IAEF,yCAAyC;IACzC,yCAAyC;IACzC,0DAA0D;IAE1D,iEAAiE;IAEjE,sCAAsC;IACtC,KAAK;IAEL,IAAA,iBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE;QACrB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;QACrC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,SAAgB,CAAC,CAAA;QACzD,IAAI,MAAiB,CAAA;QAErB,IAAA,kBAAS,EAAC,GAAG,EAAE;YACd,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YACtC,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,IAAA,mBAAU,EAAC,GAAG,EAAE;YACf,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,CAAA;YAC3B,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA;QAC3B,CAAC,CAAC,CAAA;QAEF,IAAA,iBAAQ,EAAC,GAAG,EAAE;YACb,IAAI,MAAM;gBAAE,MAAM,CAAC,OAAO,EAAE,CAAA;QAC7B,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC1B,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,MAAM,QAAQ,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC9C,IAAA,eAAM,EAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAA;YAE7B,QAAQ,CAAC,OAAO,EAAE,CAAA;YAClB,IAAA,eAAM,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEhD,MAAM,IAAA,eAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAA;QACxF,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,SAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;YAEjF,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAChD,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;gBAC7D,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEf,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;YAEF,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAA;YAE9D,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC9F,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;gBAC7D,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEf,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;YAEF,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACnC,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAA;YAEvD,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;QACvF,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;gBAC7D,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEf,EAAE,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAA;YACpC,CAAC,CAAC,CAAA;YAEF,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACnC,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;YAEjE,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;QACvF,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}
@@ -1,4 +1,3 @@
1
- export { TCPHelper, TCPHelperEvents, TCPHelperOptions } from './tcp.js';
2
- export { TelnetHelper, TelnetHelperEvents, TelnetHelperOptions } from './telnet.js';
3
- export { UDPHelper, UDPHelperEvents, UDPHelperOptions } from './udp.js';
4
- //# sourceMappingURL=index.d.ts.map
1
+ export * from './tcp.js';
2
+ export * from './telnet.js';
3
+ export * from './udp.js';
@@ -1,10 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.UDPHelper = exports.TelnetHelper = exports.TCPHelper = void 0;
4
- var tcp_js_1 = require("./tcp.js");
5
- Object.defineProperty(exports, "TCPHelper", { enumerable: true, get: function () { return tcp_js_1.TCPHelper; } });
6
- var telnet_js_1 = require("./telnet.js");
7
- Object.defineProperty(exports, "TelnetHelper", { enumerable: true, get: function () { return telnet_js_1.TelnetHelper; } });
8
- var udp_js_1 = require("./udp.js");
9
- Object.defineProperty(exports, "UDPHelper", { enumerable: true, get: function () { return udp_js_1.UDPHelper; } });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./tcp.js"), exports);
5
+ tslib_1.__exportStar(require("./telnet.js"), exports);
6
+ tslib_1.__exportStar(require("./udp.js"), exports);
10
7
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,mCAAuE;AAA9D,mGAAA,SAAS,OAAA;AAClB,yCAAmF;AAA1E,yGAAA,YAAY,OAAA;AACrB,mCAAuE;AAA9D,mGAAA,SAAS,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB;AACxB,sDAA2B;AAC3B,mDAAwB"}
@@ -1,7 +1,7 @@
1
1
  import net from 'net';
2
2
  import { EventEmitter } from 'eventemitter3';
3
3
  import { InstanceStatus } from '../module-api/enums.js';
4
- type TCPStatuses = InstanceStatus.Ok | InstanceStatus.Connecting | InstanceStatus.Disconnected | InstanceStatus.UnknownError;
4
+ export type TCPStatuses = InstanceStatus.Ok | InstanceStatus.Connecting | InstanceStatus.Disconnected | InstanceStatus.UnknownError;
5
5
  export interface TCPHelperEvents {
6
6
  error: [err: Error];
7
7
  data: [msg: Buffer];
@@ -27,5 +27,3 @@ export declare class TCPHelper extends EventEmitter<TCPHelperEvents> {
27
27
  send(message: string | Buffer): Promise<boolean>;
28
28
  destroy(): void;
29
29
  }
30
- export {};
31
- //# sourceMappingURL=tcp.d.ts.map
@@ -15,4 +15,3 @@ export declare class TelnetHelper extends EventEmitter<TelnetHelperEvents> {
15
15
  send(message: string | Buffer): Promise<boolean>;
16
16
  destroy(): void;
17
17
  }
18
- //# sourceMappingURL=telnet.d.ts.map
@@ -1,7 +1,7 @@
1
1
  import dgram from 'dgram';
2
2
  import { EventEmitter } from 'eventemitter3';
3
3
  import { InstanceStatus } from '../module-api/enums.js';
4
- type UDPStatuses = InstanceStatus.Ok | InstanceStatus.UnknownError;
4
+ export type UDPStatuses = InstanceStatus.Ok | InstanceStatus.UnknownError;
5
5
  export interface UDPHelperEvents {
6
6
  error: [err: Error];
7
7
  listening: [];
@@ -29,5 +29,3 @@ export declare class UDPHelper extends EventEmitter<UDPHelperEvents> {
29
29
  send(message: string | Buffer): Promise<void>;
30
30
  destroy(): void;
31
31
  }
32
- export {};
33
- //# sourceMappingURL=udp.d.ts.map
@@ -0,0 +1,59 @@
1
+ /**
2
+ * Warning: these types are intentionally semi-isolated from the module-api folder.
3
+ * While it causes a lot of duplicate typings and requires us to do translation of types,
4
+ * it allows for us to be selective as to whether a change impacts the module api or the host api.
5
+ * This will allow for cleaner and more stable apis which can both evolve at different rates
6
+ */
7
+ import type { RemoteInfo } from 'dgram';
8
+ import type { CompanionActionDefinitions, CompanionFeedbackDefinitions, CompanionPresetDefinitions, CompanionRecordedAction, CompanionStaticUpgradeScript, CompanionVariableDefinition, CompanionVariableValue, CompanionVariableValues, InstanceStatus } from '../module-api/index.js';
9
+ import type { OSCSomeArguments } from '../common/osc.js';
10
+ import type { SharedUdpSocketImpl } from '../module-api/shared-udp-socket.js';
11
+ export declare function isInstanceContext<TConfig, TSecrets>(obj: unknown): obj is InstanceContext<TConfig, TSecrets>;
12
+ export interface InstanceContext<TConfig, TSecrets> extends InstanceSharedUdpSocketContext {
13
+ readonly _isInstanceContext: true;
14
+ readonly id: string;
15
+ label: string;
16
+ readonly upgradeScripts: CompanionStaticUpgradeScript<TConfig, TSecrets>[];
17
+ saveConfig: (config: TConfig | undefined, secrets: TSecrets | undefined) => void;
18
+ updateStatus(status: InstanceStatus, message: string | null): void;
19
+ oscSend(host: string, port: number, path: string, args: OSCSomeArguments): void;
20
+ parseVariablesInString(text: string): Promise<string>;
21
+ recordAction(action: CompanionRecordedAction, uniquenessId?: string): void;
22
+ setActionDefinitions: (actions: CompanionActionDefinitions) => void;
23
+ subscribeActions: (actionIds: string[]) => void;
24
+ unsubscribeActions: (actionIds: string[]) => void;
25
+ setFeedbackDefinitions: (feedbacks: CompanionFeedbackDefinitions) => void;
26
+ subscribeFeedbacks: (feedbackIds: string[]) => void;
27
+ unsubscribeFeedbacks: (feedbackIds: string[]) => void;
28
+ checkFeedbacks: (feedbackTypes: string[]) => void;
29
+ checkFeedbacksById: (feedbackIds: string[]) => void;
30
+ setPresetDefinitions: (presets: CompanionPresetDefinitions) => void;
31
+ setVariableDefinitions: (variables: CompanionVariableDefinition[]) => void;
32
+ setVariableValues: (values: CompanionVariableValues) => void;
33
+ getVariableValue: (variableId: string) => CompanionVariableValue | undefined;
34
+ }
35
+ export interface InstanceSharedUdpSocketContext {
36
+ readonly sharedUdpSocketHandlers: Map<string, SharedUdpSocketImpl>;
37
+ sharedUdpSocketJoin: (msg: SharedUdpSocketMessageJoin) => Promise<string>;
38
+ sharedUdpSocketLeave: (msg: SharedUdpSocketMessageLeave) => Promise<void>;
39
+ sharedUdpSocketSend: (msg: SharedUdpSocketMessageSend) => Promise<void>;
40
+ }
41
+ export interface SharedUdpSocketMessageJoin {
42
+ family: 'udp4' | 'udp6';
43
+ portNumber: number;
44
+ }
45
+ export interface SharedUdpSocketMessageLeave {
46
+ handleId: string;
47
+ }
48
+ export interface SharedUdpSocketMessageSend {
49
+ handleId: string;
50
+ message: Buffer;
51
+ address: string;
52
+ port: number;
53
+ }
54
+ export interface SharedUdpSocketMessage {
55
+ handleId: string;
56
+ portNumber: number;
57
+ message: Buffer;
58
+ source: RemoteInfo;
59
+ }
@@ -6,4 +6,9 @@
6
6
  * This will allow for cleaner and more stable apis which can both evolve at different rates
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
- //# sourceMappingURL=api.js.map
9
+ exports.isInstanceContext = isInstanceContext;
10
+ function isInstanceContext(obj) {
11
+ const obj2 = obj;
12
+ return typeof obj2 === 'object' && typeof obj2.id === 'string' && obj2._isInstanceContext === true;
13
+ }
14
+ //# sourceMappingURL=context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/host-api/context.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAiBH,8CAGC;AAHD,SAAgB,iBAAiB,CAAoB,GAAY;IAChE,MAAM,IAAI,GAAG,GAAyC,CAAA;IACtD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,kBAAkB,KAAK,IAAI,CAAA;AACnG,CAAC"}
@@ -9,4 +9,3 @@ export interface InstanceBaseShared<TConfig, TSecrets = undefined> {
9
9
  */
10
10
  destroy(): void | Promise<void>;
11
11
  }
12
- //# sourceMappingURL=instance-base.d.ts.map
@@ -0,0 +1,20 @@
1
+ declare global {
2
+ /**
3
+ * INTERNAL USE ONLY
4
+ */
5
+ var SURFACE_LOGGER: LoggingSink | undefined;
6
+ }
7
+ export type LogLevel = 'info' | 'warn' | 'error' | 'debug';
8
+ export interface ModuleLogger {
9
+ debug: (message: string) => void;
10
+ info: (message: string) => void;
11
+ warn: (message: string) => void;
12
+ error: (message: string) => void;
13
+ }
14
+ export type LoggingSink = (source: string | undefined, level: LogLevel, message: string) => void;
15
+ /**
16
+ * Create a logger instance
17
+ * @param source The source path to use for the logger
18
+ * @returns A logger instance
19
+ */
20
+ export declare function createModuleLogger(source?: string): ModuleLogger;
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.createModuleLogger = createModuleLogger;
4
+ const defaultLoggingSink = (source, level, message) => {
5
+ // Default logging implementation for unit testing purposes, this should be replaced by the host application
6
+ console.log(`[${level.toUpperCase()}]${source ? ` [${source}]` : ''} ${message}`);
7
+ };
8
+ function logToSink(source, level, message) {
9
+ const sink = typeof global.SURFACE_LOGGER === 'function' ? global.SURFACE_LOGGER : defaultLoggingSink;
10
+ sink(source, level, message);
11
+ }
12
+ /**
13
+ * Create a logger instance
14
+ * @param source The source path to use for the logger
15
+ * @returns A logger instance
16
+ */
17
+ function createModuleLogger(source) {
18
+ return {
19
+ debug: (message) => logToSink(source, 'debug', message),
20
+ info: (message) => logToSink(source, 'info', message),
21
+ warn: (message) => logToSink(source, 'warn', message),
22
+ error: (message) => logToSink(source, 'error', message),
23
+ };
24
+ }
25
+ //# sourceMappingURL=logging.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;AAiCA,gDAOC;AAtBD,MAAM,kBAAkB,GAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAClE,4GAA4G;IAC5G,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;AAClF,CAAC,CAAA;AAED,SAAS,SAAS,CAAC,MAA0B,EAAE,KAAe,EAAE,OAAe;IAC9E,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,kBAAkB,CAAA;IACrG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,MAAe;IACjD,OAAO;QACN,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/D,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC7D,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC7D,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;KAC/D,CAAA;AACF,CAAC"}
package/dist/main.d.ts ADDED
@@ -0,0 +1,8 @@
1
+ export * from './logging.js';
2
+ export * from './manifest.js';
3
+ export * from './module-api/index.js';
4
+ export * from './common/osc.js';
5
+ export * from './common/json-value.js';
6
+ export * from './util.js';
7
+ export * from './helpers/index.js';
8
+ export { runEntrypoint, InstanceConstructor } from './entrypoint.js';
package/dist/main.js ADDED
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.runEntrypoint = void 0;
4
+ const tslib_1 = require("tslib");
5
+ tslib_1.__exportStar(require("./logging.js"), exports);
6
+ tslib_1.__exportStar(require("./manifest.js"), exports);
7
+ tslib_1.__exportStar(require("./module-api/index.js"), exports);
8
+ tslib_1.__exportStar(require("./common/osc.js"), exports);
9
+ tslib_1.__exportStar(require("./common/json-value.js"), exports);
10
+ tslib_1.__exportStar(require("./util.js"), exports);
11
+ tslib_1.__exportStar(require("./helpers/index.js"), exports);
12
+ var entrypoint_js_1 = require("./entrypoint.js");
13
+ Object.defineProperty(exports, "runEntrypoint", { enumerable: true, get: function () { return entrypoint_js_1.runEntrypoint; } });
14
+ //# sourceMappingURL=main.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;AAAA,uDAA4B;AAC5B,wDAA6B;AAC7B,gEAAqC;AACrC,0DAA+B;AAC/B,iEAAsC;AACtC,oDAAyB;AACzB,6DAAkC;AAElC,iDAAoE;AAA3D,8GAAA,aAAa,OAAA"}
@@ -1,5 +1,4 @@
1
- import type { ModuleManifest, ModuleManifestMaintainer, ModuleManifestRuntime } from '../generated/manifest.d.ts';
2
- export { ModuleManifest, ModuleManifestMaintainer, ModuleManifestRuntime };
1
+ import type { ModuleManifest, ModuleManifestMaintainer, ModuleManifestRuntime, ModuleBonjourQuery } from '../generated/manifest.d.ts';
2
+ export { ModuleManifest, ModuleManifestMaintainer, ModuleManifestRuntime, ModuleBonjourQuery };
3
3
  /** Validate that a manifest looks correctly populated */
4
4
  export declare function validateManifest(manifest: ModuleManifest, looseChecks: boolean): void;
5
- //# sourceMappingURL=manifest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":";;AAQA,4CAmCC;;AA1CD,8BAA8B;AAC9B,+CAA+C;AAC/C,qGAAsE;AAItE,yDAAyD;AACzD,SAAgB,gBAAgB,CAAC,QAAwB,EAAE,WAAoB;IAC9E,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;QAEvG,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAEtF,IAAI,WAAW,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAA;QAEjH,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAE/E,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;QAEhF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAElF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IACnF,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,EAAE,gBAAgB,CAAC,CAAA;IAC1E,CAAC;IAED,IAAI,CAAC,IAAA,8BAAsB,EAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,8BAAsB,CAAC,MAAM,CAAA;QAC5C,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAE9E,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACzE,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":";;AAaA,4CAmCC;;AA1CD,8BAA8B;AAC9B,+CAA+C;AAC/C,qGAAsE;AAItE,yDAAyD;AACzD,SAAgB,gBAAgB,CAAC,QAAwB,EAAE,WAAoB;IAC9E,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;QAEvG,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAEtF,IAAI,WAAW,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAA;QAEjH,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAE/E,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;QAEhF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAElF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IACnF,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,EAAE,gBAAgB,CAAC,CAAA;IAC1E,CAAC;IAED,IAAI,CAAC,IAAA,8BAAsB,EAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,8BAAsB,CAAC,MAAM,CAAA;QAC5C,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAE9E,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACzE,CAAC;AACF,CAAC"}