@xylabs/buffer 6.0.10 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ [![logo][]](https://xylabs.com)
2
+
1
3
  # @xylabs/buffer
2
4
 
3
5
  [![npm][npm-badge]][npm-link]
@@ -5,6 +7,8 @@
5
7
 
6
8
  > Base functionality used throughout XY Labs TypeScript/JavaScript libraries
7
9
 
10
+ > Deprecated: use `node:buffer` in Node, native `ArrayBuffer`/`Uint8Array` where possible, or depend on `buffer` directly for browser polyfill needs.
11
+
8
12
  ## Install
9
13
 
10
14
  Using npm:
@@ -104,8 +108,12 @@ No-op polyfill for Node.js, where Buffer is already available globally.
104
108
 
105
109
  `void`
106
110
 
111
+ ## Credits
112
+
113
+ [Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
107
114
 
108
115
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/buffer.svg
109
116
  [npm-link]: https://www.npmjs.com/package/@xylabs/buffer
110
117
  [license-badge]: https://img.shields.io/npm/l/@xylabs/buffer.svg
111
118
  [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
119
+ [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
@@ -1,5 +1,5 @@
1
- import { Buffer } from './browser/index.ts';
2
- declare const BrowserBuffer: typeof Buffer;
3
- declare const BrowserBufferPolyfill: () => void;
4
- export { BrowserBuffer as Buffer, BrowserBufferPolyfill as bufferPolyfill };
1
+ /** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
2
+ export { Buffer } from './browser/index.ts';
3
+ /** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
4
+ export { bufferPolyfill } from './browser/index.ts';
5
5
  //# sourceMappingURL=index-browser.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAkB,MAAM,oBAAoB,CAAA;AAE3D,QAAA,MAAM,aAAa,eAAS,CAAA;AAC5B,QAAA,MAAM,qBAAqB,YAAiB,CAAA;AAC5C,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,qBAAqB,IAAI,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,uHAAuH;AACvH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA"}
@@ -7,12 +7,8 @@ var bufferPolyfill = () => {
7
7
 
8
8
  // src/browser/index.ts
9
9
  import { Buffer as Buffer2 } from "buffer/";
10
-
11
- // src/index-browser.ts
12
- var BrowserBuffer = Buffer2;
13
- var BrowserBufferPolyfill = bufferPolyfill;
14
10
  export {
15
- BrowserBuffer as Buffer,
16
- BrowserBufferPolyfill as bufferPolyfill
11
+ Buffer2 as Buffer,
12
+ bufferPolyfill
17
13
  };
18
14
  //# sourceMappingURL=index-browser.mjs.map
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../../src/browser/bufferPolyfill.ts", "../../src/browser/index.ts", "../../src/index-browser.ts"],
4
- "sourcesContent": ["import { Buffer } from 'buffer/'\n\ninterface BufferGlobal {\n Buffer?: typeof Buffer\n}\n\nconst bufferGlobal = globalThis as unknown as BufferGlobal\n\n/** Polyfills `globalThis.Buffer` with the browser-compatible Buffer implementation if not already defined. */\nexport const bufferPolyfill = () => {\n bufferGlobal.Buffer ??= Buffer\n}\n", "export { bufferPolyfill } from './bufferPolyfill.ts'\nexport { Buffer } from 'buffer/'\n", "import { Buffer, bufferPolyfill } from './browser/index.ts'\n\nconst BrowserBuffer = Buffer\nconst BrowserBufferPolyfill = bufferPolyfill\nexport { BrowserBuffer as Buffer, BrowserBufferPolyfill as bufferPolyfill }\n"],
5
- "mappings": ";AAAA,SAAS,cAAc;AAMvB,IAAM,eAAe;AAGd,IAAM,iBAAiB,MAAM;AAClC,eAAa,WAAW;AAC1B;;;ACVA,SAAS,UAAAA,eAAc;;;ACCvB,IAAM,gBAAgBC;AACtB,IAAM,wBAAwB;",
6
- "names": ["Buffer", "Buffer"]
3
+ "sources": ["../../src/browser/bufferPolyfill.ts", "../../src/browser/index.ts"],
4
+ "sourcesContent": ["import { Buffer } from 'buffer/'\n\ninterface BufferGlobal {\n Buffer?: typeof Buffer\n}\n\nconst bufferGlobal = globalThis as unknown as BufferGlobal\n\n/** Polyfills `globalThis.Buffer` with the browser-compatible Buffer implementation if not already defined. */\nexport const bufferPolyfill = () => {\n bufferGlobal.Buffer ??= Buffer\n}\n", "export { bufferPolyfill } from './bufferPolyfill.ts'\nexport { Buffer } from 'buffer/'\n"],
5
+ "mappings": ";AAAA,SAAS,cAAc;AAMvB,IAAM,eAAe;AAGd,IAAM,iBAAiB,MAAM;AAClC,eAAa,WAAW;AAC1B;;;ACVA,SAAS,UAAAA,eAAc;",
6
+ "names": ["Buffer"]
7
7
  }
@@ -1,4 +1,5 @@
1
- declare const NodeBuffer: BufferConstructor;
2
- declare const NodeBufferPolyfill: () => void;
3
- export { NodeBuffer as Buffer, NodeBufferPolyfill as bufferPolyfill };
1
+ /** @deprecated Use node:buffer directly in Node.js. */
2
+ export { Buffer } from './node/index.ts';
3
+ /** @deprecated Use node:buffer directly in Node.js. */
4
+ export { bufferPolyfill } from './node/index.ts';
4
5
  //# sourceMappingURL=index-node.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,mBAAS,CAAA;AACzB,QAAA,MAAM,kBAAkB,YAAiB,CAAA;AACzC,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,kBAAkB,IAAI,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,uDAAuD;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA"}
@@ -1,5 +1,5 @@
1
- import { Buffer } from './browser/index.ts';
2
- declare const BrowserBuffer: typeof Buffer;
3
- declare const BrowserBufferPolyfill: () => void;
4
- export { BrowserBuffer as Buffer, BrowserBufferPolyfill as bufferPolyfill };
1
+ /** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
2
+ export { Buffer } from './browser/index.ts';
3
+ /** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
4
+ export { bufferPolyfill } from './browser/index.ts';
5
5
  //# sourceMappingURL=index-browser.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAkB,MAAM,oBAAoB,CAAA;AAE3D,QAAA,MAAM,aAAa,eAAS,CAAA;AAC5B,QAAA,MAAM,qBAAqB,YAAiB,CAAA;AAC5C,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,qBAAqB,IAAI,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index-browser.d.ts","sourceRoot":"","sources":["../../src/index-browser.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,uHAAuH;AACvH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA"}
@@ -1,4 +1,5 @@
1
- declare const NodeBuffer: BufferConstructor;
2
- declare const NodeBufferPolyfill: () => void;
3
- export { NodeBuffer as Buffer, NodeBufferPolyfill as bufferPolyfill };
1
+ /** @deprecated Use node:buffer directly in Node.js. */
2
+ export { Buffer } from './node/index.ts';
3
+ /** @deprecated Use node:buffer directly in Node.js. */
4
+ export { bufferPolyfill } from './node/index.ts';
4
5
  //# sourceMappingURL=index-node.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,mBAAS,CAAA;AACzB,QAAA,MAAM,kBAAkB,YAAiB,CAAA;AACzC,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,kBAAkB,IAAI,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,uDAAuD;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA"}
@@ -5,12 +5,8 @@ var bufferPolyfill = () => {
5
5
 
6
6
  // src/node/index.ts
7
7
  import { Buffer } from "node:buffer";
8
-
9
- // src/index-node.ts
10
- var NodeBuffer = Buffer;
11
- var NodeBufferPolyfill = bufferPolyfill;
12
8
  export {
13
- NodeBuffer as Buffer,
14
- NodeBufferPolyfill as bufferPolyfill
9
+ Buffer,
10
+ bufferPolyfill
15
11
  };
16
12
  //# sourceMappingURL=index-node.mjs.map
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../../src/node/bufferPolyfill.ts", "../../src/node/index.ts", "../../src/index-node.ts"],
4
- "sourcesContent": ["/** No-op polyfill for Node.js, where Buffer is already available globally. */\nexport const bufferPolyfill = () => {\n return\n}\n", "/// <reference types=\"node\" />\n\nexport * from './bufferPolyfill.ts'\nexport { Buffer } from 'node:buffer'\n", "import { Buffer, bufferPolyfill } from './node/index.ts'\n\nconst NodeBuffer = Buffer\nconst NodeBufferPolyfill = bufferPolyfill\nexport { NodeBuffer as Buffer, NodeBufferPolyfill as bufferPolyfill }\n"],
5
- "mappings": ";AACO,IAAM,iBAAiB,MAAM;AAClC;AACF;;;ACAA,SAAS,cAAc;;;ACDvB,IAAM,aAAa;AACnB,IAAM,qBAAqB;",
3
+ "sources": ["../../src/node/bufferPolyfill.ts", "../../src/node/index.ts"],
4
+ "sourcesContent": ["/** No-op polyfill for Node.js, where Buffer is already available globally. */\nexport const bufferPolyfill = () => {\n return\n}\n", "/// <reference types=\"node\" />\n\nexport * from './bufferPolyfill.ts'\nexport { Buffer } from 'node:buffer'\n"],
5
+ "mappings": ";AACO,IAAM,iBAAiB,MAAM;AAClC;AACF;;;ACAA,SAAS,cAAc;",
6
6
  "names": []
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/buffer",
3
- "version": "6.0.10",
3
+ "version": "6.1.1",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "buffer",
@@ -46,8 +46,8 @@
46
46
  ],
47
47
  "devDependencies": {
48
48
  "@types/node": "^25.9.2",
49
- "@xylabs/toolchain": "^8.1.16",
50
- "@xylabs/tsconfig": "^8.1.16",
49
+ "@xylabs/toolchain": "^8.1.20",
50
+ "@xylabs/tsconfig": "^8.1.20",
51
51
  "buffer": "^6.0.3",
52
52
  "eslint": "^10.4.1",
53
53
  "typescript": "^6.0.3",
@@ -62,5 +62,6 @@
62
62
  },
63
63
  "publishConfig": {
64
64
  "access": "public"
65
- }
65
+ },
66
+ "deprecated": "@xylabs/buffer is deprecated. Use node:buffer in Node, native ArrayBuffer/Uint8Array where possible, or depend on buffer directly for browser polyfills."
66
67
  }