sabcom 0.0.2 → 0.0.4

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.
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
1
  # SABCOM
2
2
 
3
- [![Coverage Status][codecov-image]][codecov-url]
4
3
  [![Github Build Status][github-image]][github-url]
5
4
  [![NPM version][npm-image]][npm-url]
6
5
  [![Downloads][downloads-image]][npm-url]
6
+ [![Coverage Status][codecov-image]][codecov-url]
7
7
  [![Snyk][snyk-image]][snyk-url]
8
8
 
9
9
  A TypeScript/Node.js library for inter-thread communication using SharedArrayBuffer with atomic operations and V8 serialization.
package/build/index.cjs CHANGED
@@ -55,7 +55,7 @@ var Header = /*#__PURE__*/ function(Header) {
55
55
  }({});
56
56
  const HEADER_VALUES = 1 + Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;
57
57
  const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;
58
- const write = (data, buffer, timeout = 5000)=>{
58
+ const write = (data, buffer, { timeout = 5000 } = {})=>{
59
59
  const serialized = (0, _nodev8.serialize)(data);
60
60
  const chunkSize = buffer.byteLength - HEADER_SIZE;
61
61
  const totalSize = serialized.length;
@@ -88,7 +88,7 @@ const write = (data, buffer, timeout = 5000)=>{
88
88
  Atomics.store(header, SEMAPHORE, 0);
89
89
  }
90
90
  };
91
- const read = (buffer, timeout = 5000)=>{
91
+ const read = (buffer, { timeout = 5000 } = {})=>{
92
92
  const header = new Int32Array(buffer);
93
93
  if (Atomics.wait(header, SEMAPHORE, 0, timeout) === "timed-out") {
94
94
  throw new Error("Handshake timeout");
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n timeout = 5000,\n) => {\n const serialized = serialize(data);\n const chunkSize = buffer.byteLength - HEADER_SIZE;\n const totalSize = serialized.length;\n const totalChunks = Math.ceil(totalSize / chunkSize);\n\n const header = new Int32Array(buffer);\n header[Handshake.TOTAL_SIZE] = totalSize;\n header[Handshake.TOTAL_CHUNKS] = totalChunks;\n\n Atomics.store(header, SEMAPHORE, Semaphore.HANDSHAKE);\n Atomics.notify(header, SEMAPHORE);\n\n try {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.HANDSHAKE, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(\"Reader handshake timeout\");\n }\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n\n for (let i = 0; i < totalChunks; i++) {\n const start = i * chunkSize;\n const end = Math.min(start + chunkSize, totalSize);\n const size = end - start;\n\n payload.set(serialized.subarray(start, end), 0);\n\n header[Header.CHUNK_INDEX] = i;\n header[Header.CHUNK_OFFSET] = start;\n header[Header.CHUNK_SIZE] = size;\n\n Atomics.store(header, SEMAPHORE, Semaphore.PAYLOAD);\n Atomics.notify(header, SEMAPHORE);\n\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.PAYLOAD, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(`Reader timeout on chunk ${i}/${totalChunks - 1}`);\n }\n }\n } finally {\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n }\n};\n\nexport const read = (buffer: SharedArrayBuffer, timeout = 5000): unknown => {\n const header = new Int32Array(buffer);\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(\"Handshake timeout\");\n }\n if (header[SEMAPHORE] !== Semaphore.HANDSHAKE) {\n throw new Error(\"Invalid handshake state\");\n }\n\n const totalSize = header[Handshake.TOTAL_SIZE];\n const totalChunks = header[Handshake.TOTAL_CHUNKS];\n const data = new Uint8Array(totalSize);\n\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n for (let i = 0; i < totalChunks; i++) {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(`Writer timeout waiting for chunk ${i}`);\n }\n // @ts-expect-error does not infer number\n if (header[SEMAPHORE] !== Semaphore.PAYLOAD) {\n throw new Error(\n `Expected payload header, received ${Semaphore[header[SEMAPHORE]]}`,\n );\n }\n const chunkIndex = header[Header.CHUNK_INDEX];\n if (i !== chunkIndex) {\n throw new Error(\n `Reader integrity failure for chunk ${chunkIndex} expected ${i}`,\n );\n }\n const offset = header[Header.CHUNK_OFFSET];\n const size = header[Header.CHUNK_SIZE];\n data.set(payload.subarray(0, size), offset);\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n }\n return deserialize(data);\n};\n"],"names":["HEADER_SIZE","HEADER_VALUES","Handshake","Header","SEMAPHORE","Semaphore","read","write","Math","max","Object","values","length","Uint32Array","BYTES_PER_ELEMENT","data","buffer","timeout","serialized","serialize","chunkSize","byteLength","totalSize","totalChunks","ceil","header","Int32Array","Atomics","store","notify","wait","Error","payload","Uint8Array","i","start","end","min","size","set","subarray","chunkIndex","offset","deserialize"],"mappings":";;;;;;;;;;;QAwBaA;eAAAA;;QAHAC;eAAAA;;QAXDC;eAAAA;;QAKAC;eAAAA;;QAbCC;eAAAA;;QAEDC;eAAAA;;QA2ECC;eAAAA;;QArDAC;eAAAA;;;wBA1B0B;AAEhC,MAAMH,YAAY;AAElB,IAAA,AAAKC,mCAAAA;;;;WAAAA;;AAML,IAAA,AAAKH,mCAAAA;;;WAAAA;;AAKL,IAAA,AAAKC,gCAAAA;;;;WAAAA;;AAML,MAAMF,gBACX,IACAO,KAAKC,GAAG,CAACC,OAAOC,MAAM,CAACT,WAAWU,MAAM,EAAEF,OAAOC,MAAM,CAACR,QAAQS,MAAM,IAAI;AACrE,MAAMZ,cAAca,YAAYC,iBAAiB,GAAGb;AAEpD,MAAMM,QAAQ,CACnBQ,MACAC,QACAC,UAAU,IAAI;IAEd,MAAMC,aAAaC,IAAAA,iBAAS,EAACJ;IAC7B,MAAMK,YAAYJ,OAAOK,UAAU,GAAGrB;IACtC,MAAMsB,YAAYJ,WAAWN,MAAM;IACnC,MAAMW,cAAcf,KAAKgB,IAAI,CAACF,YAAYF;IAE1C,MAAMK,SAAS,IAAIC,WAAWV;IAC9BS,MAAM,GAAsB,GAAGH;IAC/BG,MAAM,GAAwB,GAAGF;IAEjCI,QAAQC,KAAK,CAACH,QAAQrB;IACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IAEvB,IAAI;QACF,IACEuB,QAAQG,IAAI,CAACL,QAAQrB,cAAgCa,aACrD,aACA;YACA,MAAM,IAAIc,MAAM;QAClB;QAEA,MAAMC,UAAU,IAAIC,WAAWjB,QAAQhB;QAEvC,IAAK,IAAIkC,IAAI,GAAGA,IAAIX,aAAaW,IAAK;YACpC,MAAMC,QAAQD,IAAId;YAClB,MAAMgB,MAAM5B,KAAK6B,GAAG,CAACF,QAAQf,WAAWE;YACxC,MAAMgB,OAAOF,MAAMD;YAEnBH,QAAQO,GAAG,CAACrB,WAAWsB,QAAQ,CAACL,OAAOC,MAAM;YAE7CX,MAAM,GAAoB,GAAGS;YAC7BT,MAAM,GAAqB,GAAGU;YAC9BV,MAAM,GAAmB,GAAGa;YAE5BX,QAAQC,KAAK,CAACH,QAAQrB;YACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;YAEvB,IACEuB,QAAQG,IAAI,CAACL,QAAQrB,cAA8Ba,aACnD,aACA;gBACA,MAAM,IAAIc,MAAM,CAAC,wBAAwB,EAAEG,EAAE,CAAC,EAAEX,cAAc,GAAG;YACnE;QACF;IACF,SAAU;QACRI,QAAQC,KAAK,CAACH,QAAQrB;IACxB;AACF;AAEO,MAAME,OAAO,CAACU,QAA2BC,UAAU,IAAI;IAC5D,MAAMQ,SAAS,IAAIC,WAAWV;IAC9B,IACEW,QAAQG,IAAI,CAACL,QAAQrB,cAA4Ba,aAAa,aAC9D;QACA,MAAM,IAAIc,MAAM;IAClB;IACA,IAAIN,MAAM,CAACrB,UAAU,QAA0B;QAC7C,MAAM,IAAI2B,MAAM;IAClB;IAEA,MAAMT,YAAYG,MAAM,GAAsB;IAC9C,MAAMF,cAAcE,MAAM,GAAwB;IAClD,MAAMV,OAAO,IAAIkB,WAAWX;IAE5BK,QAAQC,KAAK,CAACH,QAAQrB;IACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IAEvB,MAAM4B,UAAU,IAAIC,WAAWjB,QAAQhB;IACvC,IAAK,IAAIkC,IAAI,GAAGA,IAAIX,aAAaW,IAAK;QACpC,IACEP,QAAQG,IAAI,CAACL,QAAQrB,cAA4Ba,aAAa,aAC9D;YACA,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEG,GAAG;QACzD;QAEA,IAAIT,MAAM,CAACrB,UAAU,QAAwB;YAC3C,MAAM,IAAI2B,MACR,CAAC,kCAAkC,EAAE1B,SAAS,CAACoB,MAAM,CAACrB,UAAU,CAAC,EAAE;QAEvE;QACA,MAAMqC,aAAahB,MAAM,GAAoB;QAC7C,IAAIS,MAAMO,YAAY;YACpB,MAAM,IAAIV,MACR,CAAC,mCAAmC,EAAEU,WAAW,UAAU,EAAEP,GAAG;QAEpE;QACA,MAAMQ,SAASjB,MAAM,GAAqB;QAC1C,MAAMa,OAAOb,MAAM,GAAmB;QACtCV,KAAKwB,GAAG,CAACP,QAAQQ,QAAQ,CAAC,GAAGF,OAAOI;QACpCf,QAAQC,KAAK,CAACH,QAAQrB;QACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IACzB;IACA,OAAOuC,IAAAA,mBAAW,EAAC5B;AACrB"}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport interface Options {\n timeout?: number;\n}\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n) => {\n const serialized = serialize(data);\n const chunkSize = buffer.byteLength - HEADER_SIZE;\n const totalSize = serialized.length;\n const totalChunks = Math.ceil(totalSize / chunkSize);\n\n const header = new Int32Array(buffer);\n header[Handshake.TOTAL_SIZE] = totalSize;\n header[Handshake.TOTAL_CHUNKS] = totalChunks;\n\n Atomics.store(header, SEMAPHORE, Semaphore.HANDSHAKE);\n Atomics.notify(header, SEMAPHORE);\n\n try {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.HANDSHAKE, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(\"Reader handshake timeout\");\n }\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n\n for (let i = 0; i < totalChunks; i++) {\n const start = i * chunkSize;\n const end = Math.min(start + chunkSize, totalSize);\n const size = end - start;\n\n payload.set(serialized.subarray(start, end), 0);\n\n header[Header.CHUNK_INDEX] = i;\n header[Header.CHUNK_OFFSET] = start;\n header[Header.CHUNK_SIZE] = size;\n\n Atomics.store(header, SEMAPHORE, Semaphore.PAYLOAD);\n Atomics.notify(header, SEMAPHORE);\n\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.PAYLOAD, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(`Reader timeout on chunk ${i}/${totalChunks - 1}`);\n }\n }\n } finally {\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n }\n};\n\nexport const read = (buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n): unknown => {\n const header = new Int32Array(buffer);\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(\"Handshake timeout\");\n }\n if (header[SEMAPHORE] !== Semaphore.HANDSHAKE) {\n throw new Error(\"Invalid handshake state\");\n }\n\n const totalSize = header[Handshake.TOTAL_SIZE];\n const totalChunks = header[Handshake.TOTAL_CHUNKS];\n const data = new Uint8Array(totalSize);\n\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n for (let i = 0; i < totalChunks; i++) {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(`Writer timeout waiting for chunk ${i}`);\n }\n // @ts-expect-error does not infer number\n if (header[SEMAPHORE] !== Semaphore.PAYLOAD) {\n throw new Error(\n `Expected payload header, received ${Semaphore[header[SEMAPHORE]]}`,\n );\n }\n const chunkIndex = header[Header.CHUNK_INDEX];\n if (i !== chunkIndex) {\n throw new Error(\n `Reader integrity failure for chunk ${chunkIndex} expected ${i}`,\n );\n }\n const offset = header[Header.CHUNK_OFFSET];\n const size = header[Header.CHUNK_SIZE];\n data.set(payload.subarray(0, size), offset);\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n }\n return deserialize(data);\n};\n"],"names":["HEADER_SIZE","HEADER_VALUES","Handshake","Header","SEMAPHORE","Semaphore","read","write","Math","max","Object","values","length","Uint32Array","BYTES_PER_ELEMENT","data","buffer","timeout","serialized","serialize","chunkSize","byteLength","totalSize","totalChunks","ceil","header","Int32Array","Atomics","store","notify","wait","Error","payload","Uint8Array","i","start","end","min","size","set","subarray","chunkIndex","offset","deserialize"],"mappings":";;;;;;;;;;;QAwBaA;eAAAA;;QAHAC;eAAAA;;QAXDC;eAAAA;;QAKAC;eAAAA;;QAbCC;eAAAA;;QAEDC;eAAAA;;QA+ECC;eAAAA;;QArDAC;eAAAA;;;wBA9B0B;AAEhC,MAAMH,YAAY;AAElB,IAAA,AAAKC,mCAAAA;;;;WAAAA;;AAML,IAAA,AAAKH,mCAAAA;;;WAAAA;;AAKL,IAAA,AAAKC,gCAAAA;;;;WAAAA;;AAML,MAAMF,gBACX,IACAO,KAAKC,GAAG,CAACC,OAAOC,MAAM,CAACT,WAAWU,MAAM,EAAEF,OAAOC,MAAM,CAACR,QAAQS,MAAM,IAAI;AACrE,MAAMZ,cAAca,YAAYC,iBAAiB,GAAGb;AAMpD,MAAMM,QAAQ,CACnBQ,MACAC,QACA,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMC,aAAaC,IAAAA,iBAAS,EAACJ;IAC7B,MAAMK,YAAYJ,OAAOK,UAAU,GAAGrB;IACtC,MAAMsB,YAAYJ,WAAWN,MAAM;IACnC,MAAMW,cAAcf,KAAKgB,IAAI,CAACF,YAAYF;IAE1C,MAAMK,SAAS,IAAIC,WAAWV;IAC9BS,MAAM,GAAsB,GAAGH;IAC/BG,MAAM,GAAwB,GAAGF;IAEjCI,QAAQC,KAAK,CAACH,QAAQrB;IACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IAEvB,IAAI;QACF,IACEuB,QAAQG,IAAI,CAACL,QAAQrB,cAAgCa,aACrD,aACA;YACA,MAAM,IAAIc,MAAM;QAClB;QAEA,MAAMC,UAAU,IAAIC,WAAWjB,QAAQhB;QAEvC,IAAK,IAAIkC,IAAI,GAAGA,IAAIX,aAAaW,IAAK;YACpC,MAAMC,QAAQD,IAAId;YAClB,MAAMgB,MAAM5B,KAAK6B,GAAG,CAACF,QAAQf,WAAWE;YACxC,MAAMgB,OAAOF,MAAMD;YAEnBH,QAAQO,GAAG,CAACrB,WAAWsB,QAAQ,CAACL,OAAOC,MAAM;YAE7CX,MAAM,GAAoB,GAAGS;YAC7BT,MAAM,GAAqB,GAAGU;YAC9BV,MAAM,GAAmB,GAAGa;YAE5BX,QAAQC,KAAK,CAACH,QAAQrB;YACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;YAEvB,IACEuB,QAAQG,IAAI,CAACL,QAAQrB,cAA8Ba,aACnD,aACA;gBACA,MAAM,IAAIc,MAAM,CAAC,wBAAwB,EAAEG,EAAE,CAAC,EAAEX,cAAc,GAAG;YACnE;QACF;IACF,SAAU;QACRI,QAAQC,KAAK,CAACH,QAAQrB;IACxB;AACF;AAEO,MAAME,OAAO,CAACU,QACnB,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMQ,SAAS,IAAIC,WAAWV;IAC9B,IACEW,QAAQG,IAAI,CAACL,QAAQrB,cAA4Ba,aAAa,aAC9D;QACA,MAAM,IAAIc,MAAM;IAClB;IACA,IAAIN,MAAM,CAACrB,UAAU,QAA0B;QAC7C,MAAM,IAAI2B,MAAM;IAClB;IAEA,MAAMT,YAAYG,MAAM,GAAsB;IAC9C,MAAMF,cAAcE,MAAM,GAAwB;IAClD,MAAMV,OAAO,IAAIkB,WAAWX;IAE5BK,QAAQC,KAAK,CAACH,QAAQrB;IACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IAEvB,MAAM4B,UAAU,IAAIC,WAAWjB,QAAQhB;IACvC,IAAK,IAAIkC,IAAI,GAAGA,IAAIX,aAAaW,IAAK;QACpC,IACEP,QAAQG,IAAI,CAACL,QAAQrB,cAA4Ba,aAAa,aAC9D;YACA,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEG,GAAG;QACzD;QAEA,IAAIT,MAAM,CAACrB,UAAU,QAAwB;YAC3C,MAAM,IAAI2B,MACR,CAAC,kCAAkC,EAAE1B,SAAS,CAACoB,MAAM,CAACrB,UAAU,CAAC,EAAE;QAEvE;QACA,MAAMqC,aAAahB,MAAM,GAAoB;QAC7C,IAAIS,MAAMO,YAAY;YACpB,MAAM,IAAIV,MACR,CAAC,mCAAmC,EAAEU,WAAW,UAAU,EAAEP,GAAG;QAEpE;QACA,MAAMQ,SAASjB,MAAM,GAAqB;QAC1C,MAAMa,OAAOb,MAAM,GAAmB;QACtCV,KAAKwB,GAAG,CAACP,QAAQQ,QAAQ,CAAC,GAAGF,OAAOI;QACpCf,QAAQC,KAAK,CAACH,QAAQrB;QACtBuB,QAAQE,MAAM,CAACJ,QAAQrB;IACzB;IACA,OAAOuC,IAAAA,mBAAW,EAAC5B;AACrB"}
package/build/index.d.ts CHANGED
@@ -15,5 +15,8 @@ export declare enum Header {
15
15
  }
16
16
  export declare const HEADER_VALUES: number;
17
17
  export declare const HEADER_SIZE: number;
18
- export declare const write: (data: unknown, buffer: SharedArrayBuffer, timeout?: number) => void;
19
- export declare const read: (buffer: SharedArrayBuffer, timeout?: number) => unknown;
18
+ export interface Options {
19
+ timeout?: number;
20
+ }
21
+ export declare const write: (data: unknown, buffer: SharedArrayBuffer, { timeout }?: Options) => void;
22
+ export declare const read: (buffer: SharedArrayBuffer, { timeout }?: Options) => unknown;
package/build/index.js CHANGED
@@ -19,7 +19,7 @@ export var Header = /*#__PURE__*/ function(Header) {
19
19
  }({});
20
20
  export const HEADER_VALUES = 1 + Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;
21
21
  export const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;
22
- export const write = (data, buffer, timeout = 5000)=>{
22
+ export const write = (data, buffer, { timeout = 5000 } = {})=>{
23
23
  const serialized = serialize(data);
24
24
  const chunkSize = buffer.byteLength - HEADER_SIZE;
25
25
  const totalSize = serialized.length;
@@ -52,7 +52,7 @@ export const write = (data, buffer, timeout = 5000)=>{
52
52
  Atomics.store(header, SEMAPHORE, 0);
53
53
  }
54
54
  };
55
- export const read = (buffer, timeout = 5000)=>{
55
+ export const read = (buffer, { timeout = 5000 } = {})=>{
56
56
  const header = new Int32Array(buffer);
57
57
  if (Atomics.wait(header, SEMAPHORE, 0, timeout) === "timed-out") {
58
58
  throw new Error("Handshake timeout");
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n timeout = 5000,\n) => {\n const serialized = serialize(data);\n const chunkSize = buffer.byteLength - HEADER_SIZE;\n const totalSize = serialized.length;\n const totalChunks = Math.ceil(totalSize / chunkSize);\n\n const header = new Int32Array(buffer);\n header[Handshake.TOTAL_SIZE] = totalSize;\n header[Handshake.TOTAL_CHUNKS] = totalChunks;\n\n Atomics.store(header, SEMAPHORE, Semaphore.HANDSHAKE);\n Atomics.notify(header, SEMAPHORE);\n\n try {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.HANDSHAKE, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(\"Reader handshake timeout\");\n }\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n\n for (let i = 0; i < totalChunks; i++) {\n const start = i * chunkSize;\n const end = Math.min(start + chunkSize, totalSize);\n const size = end - start;\n\n payload.set(serialized.subarray(start, end), 0);\n\n header[Header.CHUNK_INDEX] = i;\n header[Header.CHUNK_OFFSET] = start;\n header[Header.CHUNK_SIZE] = size;\n\n Atomics.store(header, SEMAPHORE, Semaphore.PAYLOAD);\n Atomics.notify(header, SEMAPHORE);\n\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.PAYLOAD, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(`Reader timeout on chunk ${i}/${totalChunks - 1}`);\n }\n }\n } finally {\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n }\n};\n\nexport const read = (buffer: SharedArrayBuffer, timeout = 5000): unknown => {\n const header = new Int32Array(buffer);\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(\"Handshake timeout\");\n }\n if (header[SEMAPHORE] !== Semaphore.HANDSHAKE) {\n throw new Error(\"Invalid handshake state\");\n }\n\n const totalSize = header[Handshake.TOTAL_SIZE];\n const totalChunks = header[Handshake.TOTAL_CHUNKS];\n const data = new Uint8Array(totalSize);\n\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n for (let i = 0; i < totalChunks; i++) {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(`Writer timeout waiting for chunk ${i}`);\n }\n // @ts-expect-error does not infer number\n if (header[SEMAPHORE] !== Semaphore.PAYLOAD) {\n throw new Error(\n `Expected payload header, received ${Semaphore[header[SEMAPHORE]]}`,\n );\n }\n const chunkIndex = header[Header.CHUNK_INDEX];\n if (i !== chunkIndex) {\n throw new Error(\n `Reader integrity failure for chunk ${chunkIndex} expected ${i}`,\n );\n }\n const offset = header[Header.CHUNK_OFFSET];\n const size = header[Header.CHUNK_SIZE];\n data.set(payload.subarray(0, size), offset);\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n }\n return deserialize(data);\n};\n"],"names":["serialize","deserialize","SEMAPHORE","Semaphore","Handshake","Header","HEADER_VALUES","Math","max","Object","values","length","HEADER_SIZE","Uint32Array","BYTES_PER_ELEMENT","write","data","buffer","timeout","serialized","chunkSize","byteLength","totalSize","totalChunks","ceil","header","Int32Array","Atomics","store","notify","wait","Error","payload","Uint8Array","i","start","end","min","size","set","subarray","read","chunkIndex","offset"],"mappings":"AAAA,SAASA,SAAS,EAAEC,WAAW,QAAQ,UAAU;AAEjD,OAAO,MAAMC,YAAY,EAAE;AAE3B,OAAO,IAAA,AAAKC,mCAAAA;;;;WAAAA;MAIX;AAED,OAAO,IAAA,AAAKC,mCAAAA;;;WAAAA;MAGX;AAED,OAAO,IAAA,AAAKC,gCAAAA;;;;WAAAA;MAIX;AAED,OAAO,MAAMC,gBACX,IACAC,KAAKC,GAAG,CAACC,OAAOC,MAAM,CAACN,WAAWO,MAAM,EAAEF,OAAOC,MAAM,CAACL,QAAQM,MAAM,IAAI,EAAE;AAC9E,OAAO,MAAMC,cAAcC,YAAYC,iBAAiB,GAAGR,cAAc;AAEzE,OAAO,MAAMS,QAAQ,CACnBC,MACAC,QACAC,UAAU,IAAI;IAEd,MAAMC,aAAanB,UAAUgB;IAC7B,MAAMI,YAAYH,OAAOI,UAAU,GAAGT;IACtC,MAAMU,YAAYH,WAAWR,MAAM;IACnC,MAAMY,cAAchB,KAAKiB,IAAI,CAACF,YAAYF;IAE1C,MAAMK,SAAS,IAAIC,WAAWT;IAC9BQ,MAAM,GAAsB,GAAGH;IAC/BG,MAAM,GAAwB,GAAGF;IAEjCI,QAAQC,KAAK,CAACH,QAAQvB;IACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IAEvB,IAAI;QACF,IACEyB,QAAQG,IAAI,CAACL,QAAQvB,cAAgCgB,aACrD,aACA;YACA,MAAM,IAAIa,MAAM;QAClB;QAEA,MAAMC,UAAU,IAAIC,WAAWhB,QAAQL;QAEvC,IAAK,IAAIsB,IAAI,GAAGA,IAAIX,aAAaW,IAAK;YACpC,MAAMC,QAAQD,IAAId;YAClB,MAAMgB,MAAM7B,KAAK8B,GAAG,CAACF,QAAQf,WAAWE;YACxC,MAAMgB,OAAOF,MAAMD;YAEnBH,QAAQO,GAAG,CAACpB,WAAWqB,QAAQ,CAACL,OAAOC,MAAM;YAE7CX,MAAM,GAAoB,GAAGS;YAC7BT,MAAM,GAAqB,GAAGU;YAC9BV,MAAM,GAAmB,GAAGa;YAE5BX,QAAQC,KAAK,CAACH,QAAQvB;YACtByB,QAAQE,MAAM,CAACJ,QAAQvB;YAEvB,IACEyB,QAAQG,IAAI,CAACL,QAAQvB,cAA8BgB,aACnD,aACA;gBACA,MAAM,IAAIa,MAAM,CAAC,wBAAwB,EAAEG,EAAE,CAAC,EAAEX,cAAc,GAAG;YACnE;QACF;IACF,SAAU;QACRI,QAAQC,KAAK,CAACH,QAAQvB;IACxB;AACF,EAAE;AAEF,OAAO,MAAMuC,OAAO,CAACxB,QAA2BC,UAAU,IAAI;IAC5D,MAAMO,SAAS,IAAIC,WAAWT;IAC9B,IACEU,QAAQG,IAAI,CAACL,QAAQvB,cAA4BgB,aAAa,aAC9D;QACA,MAAM,IAAIa,MAAM;IAClB;IACA,IAAIN,MAAM,CAACvB,UAAU,QAA0B;QAC7C,MAAM,IAAI6B,MAAM;IAClB;IAEA,MAAMT,YAAYG,MAAM,GAAsB;IAC9C,MAAMF,cAAcE,MAAM,GAAwB;IAClD,MAAMT,OAAO,IAAIiB,WAAWX;IAE5BK,QAAQC,KAAK,CAACH,QAAQvB;IACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IAEvB,MAAM8B,UAAU,IAAIC,WAAWhB,QAAQL;IACvC,IAAK,IAAIsB,IAAI,GAAGA,IAAIX,aAAaW,IAAK;QACpC,IACEP,QAAQG,IAAI,CAACL,QAAQvB,cAA4BgB,aAAa,aAC9D;YACA,MAAM,IAAIa,MAAM,CAAC,iCAAiC,EAAEG,GAAG;QACzD;QAEA,IAAIT,MAAM,CAACvB,UAAU,QAAwB;YAC3C,MAAM,IAAI6B,MACR,CAAC,kCAAkC,EAAE5B,SAAS,CAACsB,MAAM,CAACvB,UAAU,CAAC,EAAE;QAEvE;QACA,MAAMwC,aAAajB,MAAM,GAAoB;QAC7C,IAAIS,MAAMQ,YAAY;YACpB,MAAM,IAAIX,MACR,CAAC,mCAAmC,EAAEW,WAAW,UAAU,EAAER,GAAG;QAEpE;QACA,MAAMS,SAASlB,MAAM,GAAqB;QAC1C,MAAMa,OAAOb,MAAM,GAAmB;QACtCT,KAAKuB,GAAG,CAACP,QAAQQ,QAAQ,CAAC,GAAGF,OAAOK;QACpChB,QAAQC,KAAK,CAACH,QAAQvB;QACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IACzB;IACA,OAAOD,YAAYe;AACrB,EAAE"}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { serialize, deserialize } from \"node:v8\";\n\nexport const SEMAPHORE = 0;\n\nexport enum Semaphore {\n READY,\n HANDSHAKE,\n PAYLOAD,\n}\n\nexport enum Handshake {\n TOTAL_SIZE = 1,\n TOTAL_CHUNKS,\n}\n\nexport enum Header {\n CHUNK_INDEX = 1,\n CHUNK_OFFSET,\n CHUNK_SIZE,\n}\n\nexport const HEADER_VALUES =\n 1 +\n Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;\nexport const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;\n\nexport interface Options {\n timeout?: number;\n}\n\nexport const write = (\n data: unknown,\n buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n) => {\n const serialized = serialize(data);\n const chunkSize = buffer.byteLength - HEADER_SIZE;\n const totalSize = serialized.length;\n const totalChunks = Math.ceil(totalSize / chunkSize);\n\n const header = new Int32Array(buffer);\n header[Handshake.TOTAL_SIZE] = totalSize;\n header[Handshake.TOTAL_CHUNKS] = totalChunks;\n\n Atomics.store(header, SEMAPHORE, Semaphore.HANDSHAKE);\n Atomics.notify(header, SEMAPHORE);\n\n try {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.HANDSHAKE, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(\"Reader handshake timeout\");\n }\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n\n for (let i = 0; i < totalChunks; i++) {\n const start = i * chunkSize;\n const end = Math.min(start + chunkSize, totalSize);\n const size = end - start;\n\n payload.set(serialized.subarray(start, end), 0);\n\n header[Header.CHUNK_INDEX] = i;\n header[Header.CHUNK_OFFSET] = start;\n header[Header.CHUNK_SIZE] = size;\n\n Atomics.store(header, SEMAPHORE, Semaphore.PAYLOAD);\n Atomics.notify(header, SEMAPHORE);\n\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.PAYLOAD, timeout) ===\n \"timed-out\"\n ) {\n throw new Error(`Reader timeout on chunk ${i}/${totalChunks - 1}`);\n }\n }\n } finally {\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n }\n};\n\nexport const read = (buffer: SharedArrayBuffer,\n { timeout = 5000 }: Options = {}\n): unknown => {\n const header = new Int32Array(buffer);\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(\"Handshake timeout\");\n }\n if (header[SEMAPHORE] !== Semaphore.HANDSHAKE) {\n throw new Error(\"Invalid handshake state\");\n }\n\n const totalSize = header[Handshake.TOTAL_SIZE];\n const totalChunks = header[Handshake.TOTAL_CHUNKS];\n const data = new Uint8Array(totalSize);\n\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n\n const payload = new Uint8Array(buffer, HEADER_SIZE);\n for (let i = 0; i < totalChunks; i++) {\n if (\n Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === \"timed-out\"\n ) {\n throw new Error(`Writer timeout waiting for chunk ${i}`);\n }\n // @ts-expect-error does not infer number\n if (header[SEMAPHORE] !== Semaphore.PAYLOAD) {\n throw new Error(\n `Expected payload header, received ${Semaphore[header[SEMAPHORE]]}`,\n );\n }\n const chunkIndex = header[Header.CHUNK_INDEX];\n if (i !== chunkIndex) {\n throw new Error(\n `Reader integrity failure for chunk ${chunkIndex} expected ${i}`,\n );\n }\n const offset = header[Header.CHUNK_OFFSET];\n const size = header[Header.CHUNK_SIZE];\n data.set(payload.subarray(0, size), offset);\n Atomics.store(header, SEMAPHORE, Semaphore.READY);\n Atomics.notify(header, SEMAPHORE);\n }\n return deserialize(data);\n};\n"],"names":["serialize","deserialize","SEMAPHORE","Semaphore","Handshake","Header","HEADER_VALUES","Math","max","Object","values","length","HEADER_SIZE","Uint32Array","BYTES_PER_ELEMENT","write","data","buffer","timeout","serialized","chunkSize","byteLength","totalSize","totalChunks","ceil","header","Int32Array","Atomics","store","notify","wait","Error","payload","Uint8Array","i","start","end","min","size","set","subarray","read","chunkIndex","offset"],"mappings":"AAAA,SAASA,SAAS,EAAEC,WAAW,QAAQ,UAAU;AAEjD,OAAO,MAAMC,YAAY,EAAE;AAE3B,OAAO,IAAA,AAAKC,mCAAAA;;;;WAAAA;MAIX;AAED,OAAO,IAAA,AAAKC,mCAAAA;;;WAAAA;MAGX;AAED,OAAO,IAAA,AAAKC,gCAAAA;;;;WAAAA;MAIX;AAED,OAAO,MAAMC,gBACX,IACAC,KAAKC,GAAG,CAACC,OAAOC,MAAM,CAACN,WAAWO,MAAM,EAAEF,OAAOC,MAAM,CAACL,QAAQM,MAAM,IAAI,EAAE;AAC9E,OAAO,MAAMC,cAAcC,YAAYC,iBAAiB,GAAGR,cAAc;AAMzE,OAAO,MAAMS,QAAQ,CACnBC,MACAC,QACA,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMC,aAAanB,UAAUgB;IAC7B,MAAMI,YAAYH,OAAOI,UAAU,GAAGT;IACtC,MAAMU,YAAYH,WAAWR,MAAM;IACnC,MAAMY,cAAchB,KAAKiB,IAAI,CAACF,YAAYF;IAE1C,MAAMK,SAAS,IAAIC,WAAWT;IAC9BQ,MAAM,GAAsB,GAAGH;IAC/BG,MAAM,GAAwB,GAAGF;IAEjCI,QAAQC,KAAK,CAACH,QAAQvB;IACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IAEvB,IAAI;QACF,IACEyB,QAAQG,IAAI,CAACL,QAAQvB,cAAgCgB,aACrD,aACA;YACA,MAAM,IAAIa,MAAM;QAClB;QAEA,MAAMC,UAAU,IAAIC,WAAWhB,QAAQL;QAEvC,IAAK,IAAIsB,IAAI,GAAGA,IAAIX,aAAaW,IAAK;YACpC,MAAMC,QAAQD,IAAId;YAClB,MAAMgB,MAAM7B,KAAK8B,GAAG,CAACF,QAAQf,WAAWE;YACxC,MAAMgB,OAAOF,MAAMD;YAEnBH,QAAQO,GAAG,CAACpB,WAAWqB,QAAQ,CAACL,OAAOC,MAAM;YAE7CX,MAAM,GAAoB,GAAGS;YAC7BT,MAAM,GAAqB,GAAGU;YAC9BV,MAAM,GAAmB,GAAGa;YAE5BX,QAAQC,KAAK,CAACH,QAAQvB;YACtByB,QAAQE,MAAM,CAACJ,QAAQvB;YAEvB,IACEyB,QAAQG,IAAI,CAACL,QAAQvB,cAA8BgB,aACnD,aACA;gBACA,MAAM,IAAIa,MAAM,CAAC,wBAAwB,EAAEG,EAAE,CAAC,EAAEX,cAAc,GAAG;YACnE;QACF;IACF,SAAU;QACRI,QAAQC,KAAK,CAACH,QAAQvB;IACxB;AACF,EAAE;AAEF,OAAO,MAAMuC,OAAO,CAACxB,QACnB,EAAEC,UAAU,IAAI,EAAW,GAAG,CAAC,CAAC;IAEhC,MAAMO,SAAS,IAAIC,WAAWT;IAC9B,IACEU,QAAQG,IAAI,CAACL,QAAQvB,cAA4BgB,aAAa,aAC9D;QACA,MAAM,IAAIa,MAAM;IAClB;IACA,IAAIN,MAAM,CAACvB,UAAU,QAA0B;QAC7C,MAAM,IAAI6B,MAAM;IAClB;IAEA,MAAMT,YAAYG,MAAM,GAAsB;IAC9C,MAAMF,cAAcE,MAAM,GAAwB;IAClD,MAAMT,OAAO,IAAIiB,WAAWX;IAE5BK,QAAQC,KAAK,CAACH,QAAQvB;IACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IAEvB,MAAM8B,UAAU,IAAIC,WAAWhB,QAAQL;IACvC,IAAK,IAAIsB,IAAI,GAAGA,IAAIX,aAAaW,IAAK;QACpC,IACEP,QAAQG,IAAI,CAACL,QAAQvB,cAA4BgB,aAAa,aAC9D;YACA,MAAM,IAAIa,MAAM,CAAC,iCAAiC,EAAEG,GAAG;QACzD;QAEA,IAAIT,MAAM,CAACvB,UAAU,QAAwB;YAC3C,MAAM,IAAI6B,MACR,CAAC,kCAAkC,EAAE5B,SAAS,CAACsB,MAAM,CAACvB,UAAU,CAAC,EAAE;QAEvE;QACA,MAAMwC,aAAajB,MAAM,GAAoB;QAC7C,IAAIS,MAAMQ,YAAY;YACpB,MAAM,IAAIX,MACR,CAAC,mCAAmC,EAAEW,WAAW,UAAU,EAAER,GAAG;QAEpE;QACA,MAAMS,SAASlB,MAAM,GAAqB;QAC1C,MAAMa,OAAOb,MAAM,GAAmB;QACtCT,KAAKuB,GAAG,CAACP,QAAQQ,QAAQ,CAAC,GAAGF,OAAOK;QACpChB,QAAQC,KAAK,CAACH,QAAQvB;QACtByB,QAAQE,MAAM,CAACJ,QAAQvB;IACzB;IACA,OAAOD,YAAYe;AACrB,EAAE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sabcom",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "A TypeScript/Node.js library for inter-thread communication using SharedArrayBuffer with atomic operations and V8 serialization",
5
5
  "type": "module",
6
6
  "types": "build/index.d.ts",
@@ -36,19 +36,19 @@
36
36
  "devDependencies": {
37
37
  "@eslint/js": "^9.29.0",
38
38
  "@swc/jest": "^0.2.38",
39
- "@types/jest": "^29.5.14",
40
- "@types/node": "^24.0.1",
41
- "@typescript-eslint/eslint-plugin": "^8.34.0",
42
- "@typescript-eslint/parser": "^8.34.0",
39
+ "@types/jest": "^30.0.0",
40
+ "@types/node": "^24.0.4",
41
+ "@typescript-eslint/eslint-plugin": "^8.35.0",
42
+ "@typescript-eslint/parser": "^8.35.0",
43
43
  "eslint": "^9.29.0",
44
44
  "eslint-config-prettier": "^10.1.5",
45
- "eslint-plugin-prettier": "^5.4.1",
45
+ "eslint-plugin-prettier": "^5.5.1",
46
46
  "husky": "^9.1.7",
47
47
  "inop": "^0.7.8",
48
- "jest": "^30.0.0",
49
- "prettier": "^3.5.3",
48
+ "jest": "^30.0.3",
49
+ "prettier": "^3.6.1",
50
50
  "typescript": "^5.8.3",
51
- "typescript-eslint": "^8.34.0"
51
+ "typescript-eslint": "^8.35.0"
52
52
  },
53
53
  "scripts": {
54
54
  "build": "rm -rf build && inop src build -i __tests__ -i *.tmp.ts && tsc --declaration --emitDeclarationOnly",
package/src/index.ts CHANGED
@@ -24,10 +24,14 @@ export const HEADER_VALUES =
24
24
  Math.max(Object.values(Handshake).length, Object.values(Header).length) / 2;
25
25
  export const HEADER_SIZE = Uint32Array.BYTES_PER_ELEMENT * HEADER_VALUES;
26
26
 
27
+ export interface Options {
28
+ timeout?: number;
29
+ }
30
+
27
31
  export const write = (
28
32
  data: unknown,
29
33
  buffer: SharedArrayBuffer,
30
- timeout = 5000,
34
+ { timeout = 5000 }: Options = {}
31
35
  ) => {
32
36
  const serialized = serialize(data);
33
37
  const chunkSize = buffer.byteLength - HEADER_SIZE;
@@ -77,7 +81,9 @@ export const write = (
77
81
  }
78
82
  };
79
83
 
80
- export const read = (buffer: SharedArrayBuffer, timeout = 5000): unknown => {
84
+ export const read = (buffer: SharedArrayBuffer,
85
+ { timeout = 5000 }: Options = {}
86
+ ): unknown => {
81
87
  const header = new Int32Array(buffer);
82
88
  if (
83
89
  Atomics.wait(header, SEMAPHORE, Semaphore.READY, timeout) === "timed-out"