@xylabs/buffer 6.0.10 → 6.1.0

package/README.md

@@ -1,3 +1,5 @@
+[![logo][]](https://xylabs.com)
+
 # @xylabs/buffer
 
 [![npm][npm-badge]][npm-link]
@@ -5,6 +7,8 @@
 
 > Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+> Deprecated: use `node:buffer` in Node, native `ArrayBuffer`/`Uint8Array` where possible, or depend on `buffer` directly for browser polyfill needs.
+
 ## Install
 
 Using npm:
@@ -104,8 +108,12 @@ No-op polyfill for Node.js, where Buffer is already available globally.
 
 `void`
 
+## Credits
+
+[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
 
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/buffer.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/buffer
 [license-badge]: https://img.shields.io/npm/l/@xylabs/buffer.svg
 [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
+[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

package/dist/browser/index-browser.d.ts

@@ -1,5 +1,5 @@
-import { Buffer } from './browser/index.ts';
-declare const BrowserBuffer: typeof Buffer;
-declare const BrowserBufferPolyfill: () => void;
-export { BrowserBuffer as Buffer, BrowserBufferPolyfill as bufferPolyfill };
+/** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
+export { Buffer } from './browser/index.ts';
+/** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
+export { bufferPolyfill } from './browser/index.ts';
 //# sourceMappingURL=index-browser.d.ts.map

package/dist/browser/index-browser.d.ts.map

@@ -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"}
+{"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"}

package/dist/browser/index-browser.mjs

@@ -7,12 +7,8 @@ var bufferPolyfill = () => {
 
 // src/browser/index.ts
 import { Buffer as Buffer2 } from "buffer/";
-
-// src/index-browser.ts
-var BrowserBuffer = Buffer2;
-var BrowserBufferPolyfill = bufferPolyfill;
 export {
-  BrowserBuffer as Buffer,
-  BrowserBufferPolyfill as bufferPolyfill
+  Buffer2 as Buffer,
+  bufferPolyfill
 };
 //# sourceMappingURL=index-browser.mjs.map

package/dist/browser/index-browser.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/browser/bufferPolyfill.ts", "../../src/browser/index.ts", "../../src/index-browser.ts"],
-  "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"],
-  "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;",
-  "names": ["Buffer", "Buffer"]
+  "sources": ["../../src/browser/bufferPolyfill.ts", "../../src/browser/index.ts"],
+  "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"],
+  "mappings": ";AAAA,SAAS,cAAc;AAMvB,IAAM,eAAe;AAGd,IAAM,iBAAiB,MAAM;AAClC,eAAa,WAAW;AAC1B;;;ACVA,SAAS,UAAAA,eAAc;",
+  "names": ["Buffer"]
 }

package/dist/browser/index-node.d.ts

@@ -1,4 +1,5 @@
-declare const NodeBuffer: BufferConstructor;
-declare const NodeBufferPolyfill: () => void;
-export { NodeBuffer as Buffer, NodeBufferPolyfill as bufferPolyfill };
+/** @deprecated Use node:buffer directly in Node.js. */
+export { Buffer } from './node/index.ts';
+/** @deprecated Use node:buffer directly in Node.js. */
+export { bufferPolyfill } from './node/index.ts';
 //# sourceMappingURL=index-node.d.ts.map

package/dist/browser/index-node.d.ts.map

@@ -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"}
+{"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"}

package/dist/node/index-browser.d.ts

@@ -1,5 +1,5 @@
-import { Buffer } from './browser/index.ts';
-declare const BrowserBuffer: typeof Buffer;
-declare const BrowserBufferPolyfill: () => void;
-export { BrowserBuffer as Buffer, BrowserBufferPolyfill as bufferPolyfill };
+/** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
+export { Buffer } from './browser/index.ts';
+/** @deprecated Use native ArrayBuffer/Uint8Array when possible, or depend on buffer directly for browser polyfills. */
+export { bufferPolyfill } from './browser/index.ts';
 //# sourceMappingURL=index-browser.d.ts.map

package/dist/node/index-browser.d.ts.map

@@ -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"}
+{"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"}

package/dist/node/index-node.d.ts

@@ -1,4 +1,5 @@
-declare const NodeBuffer: BufferConstructor;
-declare const NodeBufferPolyfill: () => void;
-export { NodeBuffer as Buffer, NodeBufferPolyfill as bufferPolyfill };
+/** @deprecated Use node:buffer directly in Node.js. */
+export { Buffer } from './node/index.ts';
+/** @deprecated Use node:buffer directly in Node.js. */
+export { bufferPolyfill } from './node/index.ts';
 //# sourceMappingURL=index-node.d.ts.map

package/dist/node/index-node.d.ts.map

@@ -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"}
+{"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"}

package/dist/node/index-node.mjs

@@ -5,12 +5,8 @@ var bufferPolyfill = () => {
 
 // src/node/index.ts
 import { Buffer } from "node:buffer";
-
-// src/index-node.ts
-var NodeBuffer = Buffer;
-var NodeBufferPolyfill = bufferPolyfill;
 export {
-  NodeBuffer as Buffer,
-  NodeBufferPolyfill as bufferPolyfill
+  Buffer,
+  bufferPolyfill
 };
 //# sourceMappingURL=index-node.mjs.map

package/dist/node/index-node.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/node/bufferPolyfill.ts", "../../src/node/index.ts", "../../src/index-node.ts"],
-  "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"],
-  "mappings": ";AACO,IAAM,iBAAiB,MAAM;AAClC;AACF;;;ACAA,SAAS,cAAc;;;ACDvB,IAAM,aAAa;AACnB,IAAM,qBAAqB;",
+  "sources": ["../../src/node/bufferPolyfill.ts", "../../src/node/index.ts"],
+  "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"],
+  "mappings": ";AACO,IAAM,iBAAiB,MAAM;AAClC;AACF;;;ACAA,SAAS,cAAc;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/buffer",
-  "version": "6.0.10",
+  "version": "6.1.0",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "buffer",
@@ -46,8 +46,8 @@
   ],
   "devDependencies": {
     "@types/node": "^25.9.2",
-    "@xylabs/toolchain": "^8.1.16",
-    "@xylabs/tsconfig": "^8.1.16",
+    "@xylabs/toolchain": "^8.1.20",
+    "@xylabs/tsconfig": "^8.1.20",
     "buffer": "^6.0.3",
     "eslint": "^10.4.1",
     "typescript": "^6.0.3",
@@ -62,5 +62,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "deprecated": "@xylabs/buffer is deprecated. Use node:buffer in Node, native ArrayBuffer/Uint8Array where possible, or depend on buffer directly for browser polyfills."
 }