@fluid-internal/client-utils 2.0.0-dev-rc.1.0.0.224419

package/lib/bufferBrowser.mjs

@@ -0,0 +1,181 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import * as base64js from "base64-js";
+/**
+ * Converts a Uint8Array to a string of the provided encoding
+ * Useful when the array might be an {@link IsoBuffer}.
+ *
+ * @param arr - The array to convert.
+ * @param encoding - Optional target encoding; only "utf8" and "base64" are
+ * supported, with "utf8" being default.
+ * @returns The converted string.
+ *
+ * @internal
+ */
+export function Uint8ArrayToString(arr, 
+// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+encoding) {
+    switch (encoding) {
+        case "base64": {
+            return base64js.fromByteArray(arr);
+        }
+        case "utf8":
+        // eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+        case "utf-8":
+        case undefined: {
+            return new TextDecoder().decode(arr);
+        }
+        default: {
+            throw new Error("invalid/unsupported encoding");
+        }
+    }
+}
+/**
+ * Converts a {@link https://en.wikipedia.org/wiki/Base64 | base64} or
+ * {@link https://en.wikipedia.org/wiki/UTF-8 | utf-8} string to array buffer.
+ *
+ * @param encoding - The input string's encoding.
+ *
+ * @internal
+ */
+export const stringToBuffer = (input, encoding) => IsoBuffer.from(input, encoding).buffer;
+/**
+ * Convert binary blob to string format
+ *
+ * @param blob - the binary blob
+ * @param encoding - output string's encoding
+ * @returns the blob in string format
+ *
+ * @alpha
+ */
+export const bufferToString = (blob, 
+// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+encoding) => IsoBuffer.from(blob).toString(encoding);
+/**
+ * Determines if an object is an array buffer.
+ *
+ * @remarks Will detect and reject TypedArrays, like Uint8Array.
+ * Reason - they can be viewport into Array, they can be accepted, but caller has to deal with
+ * math properly (i.e. Take into account byteOffset at minimum).
+ * For example, construction of new TypedArray can be in the form of new TypedArray(typedArray) or
+ * new TypedArray(buffer, byteOffset, length), but passing TypedArray will result in fist path (and
+ * ignoring byteOffice, length).
+ *
+ * @param obj - The object to determine if it is an ArrayBuffer.
+ *
+ * @internal
+ */
+export function isArrayBuffer(obj) {
+    const maybe = obj;
+    return (obj instanceof ArrayBuffer ||
+        (typeof maybe === "object" &&
+            maybe !== null &&
+            typeof maybe.byteLength === "number" &&
+            typeof maybe.slice === "function" &&
+            maybe.byteOffset === undefined &&
+            maybe.buffer === undefined));
+}
+/**
+ * Minimal implementation of Buffer for our usages in the browser environment.
+ *
+ * @internal
+ */
+export class IsoBuffer extends Uint8Array {
+    /**
+     * Convert the buffer to a string.
+     * Only supports encoding the whole string (unlike the Node Buffer equivalent)
+     * and only utf8 and base64 encodings.
+     *
+     * @param encoding - The encoding to use.
+     */
+    // eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+    toString(encoding) {
+        return Uint8ArrayToString(this, encoding);
+    }
+    /**
+     * Static constructor
+     * @param value - (string | ArrayBuffer)
+     * @param encodingOrOffset - (string | number)
+     * @param length - (number)
+     *
+     * @privateRemarks TODO: Use actual types
+     */
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    static from(value, encodingOrOffset, length) {
+        if (typeof value === "string") {
+            return IsoBuffer.fromString(value, encodingOrOffset);
+            // Capture any typed arrays, including Uint8Array (and thus - IsoBuffer!)
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        }
+        else if (value !== null && typeof value === "object" && isArrayBuffer(value.buffer)) {
+            // The version of the from function for the node buffer, which takes a buffer or typed array
+            // as first parameter, does not have any offset or length parameters. Those are just silently
+            // ignored and not taken into account
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+            return IsoBuffer.fromArrayBuffer(value.buffer, value.byteOffset, value.byteLength);
+        }
+        else if (isArrayBuffer(value)) {
+            return IsoBuffer.fromArrayBuffer(value, encodingOrOffset, length);
+        }
+        else {
+            throw new TypeError("Input value was neither a string nor an ArrayBuffer.");
+        }
+    }
+    static fromArrayBuffer(arrayBuffer, byteOffset, byteLength) {
+        const offset = byteOffset ?? 0;
+        const validLength = byteLength ?? arrayBuffer.byteLength - offset;
+        if (offset < 0 ||
+            offset > arrayBuffer.byteLength ||
+            validLength < 0 ||
+            validLength + offset > arrayBuffer.byteLength) {
+            throw new RangeError("Invalid range specified.");
+        }
+        return new IsoBuffer(arrayBuffer, offset, validLength);
+    }
+    static fromString(str, encoding) {
+        switch (encoding) {
+            case "base64": {
+                const sanitizedString = this.sanitizeBase64(str);
+                const encoded = base64js.toByteArray(sanitizedString);
+                return new IsoBuffer(encoded.buffer);
+            }
+            case "utf8":
+            // eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+            case "utf-8":
+            case undefined: {
+                const encoded = new TextEncoder().encode(str);
+                return new IsoBuffer(encoded.buffer);
+            }
+            default: {
+                throw new Error("invalid/unsupported encoding");
+            }
+        }
+    }
+    static isBuffer(obj) {
+        throw new Error("unimplemented");
+    }
+    /**
+     * Sanitize a base64 string to provide to base64-js library.
+     * {@link https://www.npmjs.com/package/base64-js} is not as tolerant of the same malformed base64 as Node'
+     * Buffer is.
+     */
+    static sanitizeBase64(str) {
+        let sanitizedStr = str;
+        // Remove everything after padding - Node buffer ignores everything
+        // after any padding whereas base64-js does not
+        sanitizedStr = sanitizedStr.split("=")[0];
+        // Remove invalid characters - Node buffer strips invalid characters
+        // whereas base64-js replaces them with "A"
+        sanitizedStr = sanitizedStr.replace(/[^\w+-/]/g, "");
+        // Check for missing padding - Node buffer tolerates missing padding
+        // whereas base64-js does not
+        if (sanitizedStr.length % 4 !== 0) {
+            const paddingArray = ["", "===", "==", "="];
+            sanitizedStr += paddingArray[sanitizedStr.length % 4];
+        }
+        return sanitizedStr;
+    }
+}
+//# sourceMappingURL=bufferBrowser.mjs.map

package/lib/bufferBrowser.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bufferBrowser.mjs","sourceRoot":"","sources":["../src/bufferBrowser.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,KAAK,QAAQ,MAAM,WAAW;AAErC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CACjC,GAAe;AACf,8GAA8G;AAC9G,QAAsC;IAEtC,QAAQ,QAAQ,EAAE;QACjB,KAAK,QAAQ,CAAC,CAAC;YACd,OAAO,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;SACnC;QACD,KAAK,MAAM,CAAC;QACZ,8GAA8G;QAC9G,KAAK,OAAO,CAAC;QACb,KAAK,SAAS,CAAC,CAAC;YACf,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACrC;QACD,OAAO,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SAChD;KACD;AACF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,QAAgB,EAAmB,EAAE,CAClF,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC7B,IAAqB;AACrB,8GAA8G;AAC9G,QAAqC,EAC5B,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAErD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACzC,MAAM,KAAK,GAAG,GAA+D,CAAC;IAC9E,OAAO,CACN,GAAG,YAAY,WAAW;QAC1B,CAAC,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ;YACpC,OAAO,KAAK,CAAC,KAAK,KAAK,UAAU;YACjC,KAAK,CAAC,UAAU,KAAK,SAAS;YAC9B,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAC5B,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,UAAU;IACxC;;;;;;OAMG;IACH,8GAA8G;IACvG,QAAQ,CAAC,QAAsC;QACrD,OAAO,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACH,iHAAiH;IACjH,MAAM,CAAC,IAAI,CAAC,KAAU,EAAE,gBAAsB,EAAE,MAAY;QAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC9B,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,gBAAsC,CAAC,CAAC;YAC3E,yEAAyE;YACzE,sEAAsE;SACtE;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YACtF,4FAA4F;YAC5F,6FAA6F;YAC7F,qCAAqC;YACrC,6GAA6G;YAC7G,OAAO,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;SACnF;aAAM,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;YAChC,OAAO,SAAS,CAAC,eAAe,CAC/B,KAAK,EACL,gBAAsC,EACtC,MAAgB,CAChB,CAAC;SACF;aAAM;YACN,MAAM,IAAI,SAAS,CAAC,sDAAsD,CAAC,CAAC;SAC5E;IACF,CAAC;IAED,MAAM,CAAC,eAAe,CACrB,WAAwB,EACxB,UAAmB,EACnB,UAAmB;QAEnB,MAAM,MAAM,GAAG,UAAU,IAAI,CAAC,CAAC;QAC/B,MAAM,WAAW,GAAG,UAAU,IAAI,WAAW,CAAC,UAAU,GAAG,MAAM,CAAC;QAClE,IACC,MAAM,GAAG,CAAC;YACV,MAAM,GAAG,WAAW,CAAC,UAAU;YAC/B,WAAW,GAAG,CAAC;YACf,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC,UAAU,EAC5C;YACD,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,CAAC;SACjD;QAED,OAAO,IAAI,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,GAAW,EAAE,QAAiB;QAC/C,QAAQ,QAAQ,EAAE;YACjB,KAAK,QAAQ,CAAC,CAAC;gBACd,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;gBACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;gBACtD,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACrC;YACD,KAAK,MAAM,CAAC;YACZ,8GAA8G;YAC9G,KAAK,OAAO,CAAC;YACb,KAAK,SAAS,CAAC,CAAC;gBACf,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC9C,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACrC;YACD,OAAO,CAAC,CAAC;gBACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;aAChD;SACD;IACF,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,GAAY;QAC3B,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,cAAc,CAAC,GAAW;QACxC,IAAI,YAAY,GAAG,GAAG,CAAC;QACvB,mEAAmE;QACnE,+CAA+C;QAC/C,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1C,oEAAoE;QACpE,2CAA2C;QAC3C,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAErD,oEAAoE;QACpE,6BAA6B;QAC7B,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE;YAClC,MAAM,YAAY,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YAC5C,YAAY,IAAI,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACtD;QACD,OAAO,YAAY,CAAC;IACrB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as base64js from \"base64-js\";\n\n/**\n * Converts a Uint8Array to a string of the provided encoding\n * Useful when the array might be an {@link IsoBuffer}.\n *\n * @param arr - The array to convert.\n * @param encoding - Optional target encoding; only \"utf8\" and \"base64\" are\n * supported, with \"utf8\" being default.\n * @returns The converted string.\n *\n * @internal\n */\nexport function Uint8ArrayToString(\n\tarr: Uint8Array,\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\tencoding?: \"utf8\" | \"utf-8\" | \"base64\",\n): string {\n\tswitch (encoding) {\n\t\tcase \"base64\": {\n\t\t\treturn base64js.fromByteArray(arr);\n\t\t}\n\t\tcase \"utf8\":\n\t\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\t\tcase \"utf-8\":\n\t\tcase undefined: {\n\t\t\treturn new TextDecoder().decode(arr);\n\t\t}\n\t\tdefault: {\n\t\t\tthrow new Error(\"invalid/unsupported encoding\");\n\t\t}\n\t}\n}\n\n/**\n * Converts a {@link https://en.wikipedia.org/wiki/Base64 | base64} or\n * {@link https://en.wikipedia.org/wiki/UTF-8 | utf-8} string to array buffer.\n *\n * @param encoding - The input string's encoding.\n *\n * @internal\n */\nexport const stringToBuffer = (input: string, encoding: string): ArrayBufferLike =>\n\tIsoBuffer.from(input, encoding).buffer;\n\n/**\n * Convert binary blob to string format\n *\n * @param blob - the binary blob\n * @param encoding - output string's encoding\n * @returns the blob in string format\n *\n * @alpha\n */\nexport const bufferToString = (\n\tblob: ArrayBufferLike,\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\tencoding: \"utf8\" | \"utf-8\" | \"base64\",\n): string => IsoBuffer.from(blob).toString(encoding);\n\n/**\n * Determines if an object is an array buffer.\n *\n * @remarks Will detect and reject TypedArrays, like Uint8Array.\n * Reason - they can be viewport into Array, they can be accepted, but caller has to deal with\n * math properly (i.e. Take into account byteOffset at minimum).\n * For example, construction of new TypedArray can be in the form of new TypedArray(typedArray) or\n * new TypedArray(buffer, byteOffset, length), but passing TypedArray will result in fist path (and\n * ignoring byteOffice, length).\n *\n * @param obj - The object to determine if it is an ArrayBuffer.\n *\n * @internal\n */\nexport function isArrayBuffer(obj: unknown): obj is ArrayBuffer {\n\tconst maybe = obj as (Partial<ArrayBuffer> & Partial<Uint8Array>) | undefined;\n\treturn (\n\t\tobj instanceof ArrayBuffer ||\n\t\t(typeof maybe === \"object\" &&\n\t\t\tmaybe !== null &&\n\t\t\ttypeof maybe.byteLength === \"number\" &&\n\t\t\ttypeof maybe.slice === \"function\" &&\n\t\t\tmaybe.byteOffset === undefined &&\n\t\t\tmaybe.buffer === undefined)\n\t);\n}\n\n/**\n * Minimal implementation of Buffer for our usages in the browser environment.\n *\n * @internal\n */\nexport class IsoBuffer extends Uint8Array {\n\t/**\n\t * Convert the buffer to a string.\n\t * Only supports encoding the whole string (unlike the Node Buffer equivalent)\n\t * and only utf8 and base64 encodings.\n\t *\n\t * @param encoding - The encoding to use.\n\t */\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\tpublic toString(encoding?: \"utf8\" | \"utf-8\" | \"base64\"): string {\n\t\treturn Uint8ArrayToString(this, encoding);\n\t}\n\n\t/**\n\t * Static constructor\n\t * @param value - (string | ArrayBuffer)\n\t * @param encodingOrOffset - (string | number)\n\t * @param length - (number)\n\t *\n\t * @privateRemarks TODO: Use actual types\n\t */\n\t// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any\n\tstatic from(value: any, encodingOrOffset?: any, length?: any): IsoBuffer {\n\t\tif (typeof value === \"string\") {\n\t\t\treturn IsoBuffer.fromString(value, encodingOrOffset as string | undefined);\n\t\t\t// Capture any typed arrays, including Uint8Array (and thus - IsoBuffer!)\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t} else if (value !== null && typeof value === \"object\" && isArrayBuffer(value.buffer)) {\n\t\t\t// The version of the from function for the node buffer, which takes a buffer or typed array\n\t\t\t// as first parameter, does not have any offset or length parameters. Those are just silently\n\t\t\t// ignored and not taken into account\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access\n\t\t\treturn IsoBuffer.fromArrayBuffer(value.buffer, value.byteOffset, value.byteLength);\n\t\t} else if (isArrayBuffer(value)) {\n\t\t\treturn IsoBuffer.fromArrayBuffer(\n\t\t\t\tvalue,\n\t\t\t\tencodingOrOffset as number | undefined,\n\t\t\t\tlength as number,\n\t\t\t);\n\t\t} else {\n\t\t\tthrow new TypeError(\"Input value was neither a string nor an ArrayBuffer.\");\n\t\t}\n\t}\n\n\tstatic fromArrayBuffer(\n\t\tarrayBuffer: ArrayBuffer,\n\t\tbyteOffset?: number,\n\t\tbyteLength?: number,\n\t): IsoBuffer {\n\t\tconst offset = byteOffset ?? 0;\n\t\tconst validLength = byteLength ?? arrayBuffer.byteLength - offset;\n\t\tif (\n\t\t\toffset < 0 ||\n\t\t\toffset > arrayBuffer.byteLength ||\n\t\t\tvalidLength < 0 ||\n\t\t\tvalidLength + offset > arrayBuffer.byteLength\n\t\t) {\n\t\t\tthrow new RangeError(\"Invalid range specified.\");\n\t\t}\n\n\t\treturn new IsoBuffer(arrayBuffer, offset, validLength);\n\t}\n\n\tstatic fromString(str: string, encoding?: string): IsoBuffer {\n\t\tswitch (encoding) {\n\t\t\tcase \"base64\": {\n\t\t\t\tconst sanitizedString = this.sanitizeBase64(str);\n\t\t\t\tconst encoded = base64js.toByteArray(sanitizedString);\n\t\t\t\treturn new IsoBuffer(encoded.buffer);\n\t\t\t}\n\t\t\tcase \"utf8\":\n\t\t\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\t\t\tcase \"utf-8\":\n\t\t\tcase undefined: {\n\t\t\t\tconst encoded = new TextEncoder().encode(str);\n\t\t\t\treturn new IsoBuffer(encoded.buffer);\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tthrow new Error(\"invalid/unsupported encoding\");\n\t\t\t}\n\t\t}\n\t}\n\n\tstatic isBuffer(obj: unknown): boolean {\n\t\tthrow new Error(\"unimplemented\");\n\t}\n\n\t/**\n\t * Sanitize a base64 string to provide to base64-js library.\n\t * {@link https://www.npmjs.com/package/base64-js} is not as tolerant of the same malformed base64 as Node'\n\t * Buffer is.\n\t */\n\tprivate static sanitizeBase64(str: string): string {\n\t\tlet sanitizedStr = str;\n\t\t// Remove everything after padding - Node buffer ignores everything\n\t\t// after any padding whereas base64-js does not\n\t\tsanitizedStr = sanitizedStr.split(\"=\")[0];\n\n\t\t// Remove invalid characters - Node buffer strips invalid characters\n\t\t// whereas base64-js replaces them with \"A\"\n\t\tsanitizedStr = sanitizedStr.replace(/[^\\w+-/]/g, \"\");\n\n\t\t// Check for missing padding - Node buffer tolerates missing padding\n\t\t// whereas base64-js does not\n\t\tif (sanitizedStr.length % 4 !== 0) {\n\t\t\tconst paddingArray = [\"\", \"===\", \"==\", \"=\"];\n\t\t\tsanitizedStr += paddingArray[sanitizedStr.length % 4];\n\t\t}\n\t\treturn sanitizedStr;\n\t}\n}\n"]}

package/lib/bufferNode.d.mts

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Declare the subset of Buffer functionality we want to make available instead of
+ * exposing the entirely of Node's typings.  This should match the public interface
+ * of the browser implementation, so any changes made in one should be made in both.
+ *
+ * @internal
+ */
+export declare class Buffer extends Uint8Array {
+    toString(encoding?: "utf8" | "utf-8" | "base64"): string;
+    /**
+     * Static constructor
+     *
+     * @param value - (string | ArrayBuffer).
+     * @param encodingOrOffset - (string | number).
+     * @param length - (number).
+     *
+     * @privateRemarks TODO: Use actual types
+     */
+    static from(value: unknown, encodingOrOffset?: unknown, length?: unknown): IsoBuffer;
+    static isBuffer(obj: unknown): obj is Buffer;
+}
+/**
+ * @internal
+ */
+export declare const IsoBuffer: typeof Buffer;
+/**
+ * @internal
+ */
+export type IsoBuffer = Buffer;
+/**
+ * Converts a Uint8Array to a string of the provided encoding.
+ * @remarks Useful when the array might be an IsoBuffer.
+ * @param arr - The array to convert.
+ * @param encoding - Optional target encoding; only "utf8" and "base64" are
+ * supported, with "utf8" being default.
+ * @returns The converted string.
+ *
+ * @internal
+ */
+export declare function Uint8ArrayToString(arr: Uint8Array, encoding?: "utf8" | "utf-8" | "base64"): string;
+/**
+ * Convert base64 or utf8 string to array buffer.
+ * @param encoding - The input string's encoding.
+ *
+ * @internal
+ */
+export declare function stringToBuffer(input: string, encoding: string): ArrayBufferLike;
+/**
+ * Convert binary blob to string format
+ *
+ * @param blob - The binary blob
+ * @param encoding - Output string's encoding
+ * @returns The blob in string format
+ *
+ * @alpha
+ */
+export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
+//# sourceMappingURL=bufferNode.d.ts.map

package/lib/bufferNode.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bufferNode.d.ts","sourceRoot":"","sources":["../src/bufferNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,UAAU;IAE7C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM;IAExD;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS;IACpF,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;CAC5C;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,eAAS,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CACjC,GAAG,EAAE,UAAU,EAEf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GACpC,MAAM,CAIR;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,eAAe,CAQ/E;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,SACpB,eAAe,YAEX,MAAM,GAAG,OAAO,GAAG,QAAQ,KACnC,MAAiD,CAAC"}

package/lib/bufferNode.mjs

@@ -0,0 +1,53 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * @internal
+ */
+export const IsoBuffer = Buffer;
+/**
+ * Converts a Uint8Array to a string of the provided encoding.
+ * @remarks Useful when the array might be an IsoBuffer.
+ * @param arr - The array to convert.
+ * @param encoding - Optional target encoding; only "utf8" and "base64" are
+ * supported, with "utf8" being default.
+ * @returns The converted string.
+ *
+ * @internal
+ */
+export function Uint8ArrayToString(arr, 
+// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+encoding) {
+    // Buffer extends Uint8Array.  Therefore, 'arr' may already be a Buffer, in
+    // which case we can avoid copying the Uint8Array into a new Buffer instance.
+    return (Buffer.isBuffer(arr) ? arr : Buffer.from(arr)).toString(encoding);
+}
+/**
+ * Convert base64 or utf8 string to array buffer.
+ * @param encoding - The input string's encoding.
+ *
+ * @internal
+ */
+export function stringToBuffer(input, encoding) {
+    const iso = IsoBuffer.from(input, encoding);
+    // In a Node environment, IsoBuffer may be a Node.js Buffer.  Node.js will
+    // pool multiple small Buffer instances into a single ArrayBuffer, in which
+    // case we need to slice the appropriate span of bytes.
+    return iso.byteLength === iso.buffer.byteLength
+        ? iso.buffer
+        : iso.buffer.slice(iso.byteOffset, iso.byteOffset + iso.byteLength);
+}
+/**
+ * Convert binary blob to string format
+ *
+ * @param blob - The binary blob
+ * @param encoding - Output string's encoding
+ * @returns The blob in string format
+ *
+ * @alpha
+ */
+export const bufferToString = (blob, 
+// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged
+encoding) => IsoBuffer.from(blob).toString(encoding);
+//# sourceMappingURL=bufferNode.mjs.map

package/lib/bufferNode.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bufferNode.mjs","sourceRoot":"","sources":["../src/bufferNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA0BH;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC;AAOhC;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CACjC,GAAe;AACf,8GAA8G;AAC9G,QAAsC;IAEtC,2EAA2E;IAC3E,6EAA6E;IAC7E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa,EAAE,QAAgB;IAC7D,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5C,0EAA0E;IAC1E,2EAA2E;IAC3E,uDAAuD;IACvD,OAAO,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,MAAM,CAAC,UAAU;QAC9C,CAAC,CAAC,GAAG,CAAC,MAAM;QACZ,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;AACtE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC7B,IAAqB;AACrB,8GAA8G;AAC9G,QAAqC,EAC5B,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Declare the subset of Buffer functionality we want to make available instead of\n * exposing the entirely of Node's typings.  This should match the public interface\n * of the browser implementation, so any changes made in one should be made in both.\n *\n * @internal\n */\nexport declare class Buffer extends Uint8Array {\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\ttoString(encoding?: \"utf8\" | \"utf-8\" | \"base64\"): string;\n\n\t/**\n\t * Static constructor\n\t *\n\t * @param value - (string | ArrayBuffer).\n\t * @param encodingOrOffset - (string | number).\n\t * @param length - (number).\n\t *\n\t * @privateRemarks TODO: Use actual types\n\t */\n\tstatic from(value: unknown, encodingOrOffset?: unknown, length?: unknown): IsoBuffer;\n\tstatic isBuffer(obj: unknown): obj is Buffer;\n}\n\n/**\n * @internal\n */\nexport const IsoBuffer = Buffer;\n\n/**\n * @internal\n */\nexport type IsoBuffer = Buffer;\n\n/**\n * Converts a Uint8Array to a string of the provided encoding.\n * @remarks Useful when the array might be an IsoBuffer.\n * @param arr - The array to convert.\n * @param encoding - Optional target encoding; only \"utf8\" and \"base64\" are\n * supported, with \"utf8\" being default.\n * @returns The converted string.\n *\n * @internal\n */\nexport function Uint8ArrayToString(\n\tarr: Uint8Array,\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\tencoding?: \"utf8\" | \"utf-8\" | \"base64\",\n): string {\n\t// Buffer extends Uint8Array.  Therefore, 'arr' may already be a Buffer, in\n\t// which case we can avoid copying the Uint8Array into a new Buffer instance.\n\treturn (Buffer.isBuffer(arr) ? arr : Buffer.from(arr)).toString(encoding);\n}\n\n/**\n * Convert base64 or utf8 string to array buffer.\n * @param encoding - The input string's encoding.\n *\n * @internal\n */\nexport function stringToBuffer(input: string, encoding: string): ArrayBufferLike {\n\tconst iso = IsoBuffer.from(input, encoding);\n\t// In a Node environment, IsoBuffer may be a Node.js Buffer.  Node.js will\n\t// pool multiple small Buffer instances into a single ArrayBuffer, in which\n\t// case we need to slice the appropriate span of bytes.\n\treturn iso.byteLength === iso.buffer.byteLength\n\t\t? iso.buffer\n\t\t: iso.buffer.slice(iso.byteOffset, iso.byteOffset + iso.byteLength);\n}\n\n/**\n * Convert binary blob to string format\n *\n * @param blob - The binary blob\n * @param encoding - Output string's encoding\n * @returns The blob in string format\n *\n * @alpha\n */\nexport const bufferToString = (\n\tblob: ArrayBufferLike,\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case -- this value is supported, just discouraged\n\tencoding: \"utf8\" | \"utf-8\" | \"base64\",\n): string => IsoBuffer.from(blob).toString(encoding);\n"]}

package/lib/bufferShared.d.mts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Converts a Uint8Array array to an ArrayBuffer.
+ * @param array - Array to convert to ArrayBuffer.
+ *
+ * @internal
+ */
+export declare function Uint8ArrayToArrayBuffer(array: Uint8Array): ArrayBuffer;
+//# sourceMappingURL=bufferShared.d.ts.map

package/lib/bufferShared.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bufferShared.d.ts","sourceRoot":"","sources":["../src/bufferShared.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,CAKtE"}

package/lib/bufferShared.mjs

@@ -0,0 +1,17 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Converts a Uint8Array array to an ArrayBuffer.
+ * @param array - Array to convert to ArrayBuffer.
+ *
+ * @internal
+ */
+export function Uint8ArrayToArrayBuffer(array) {
+    if (array.byteOffset === 0 && array.byteLength === array.buffer.byteLength) {
+        return array.buffer;
+    }
+    return array.buffer.slice(array.byteOffset, array.byteOffset + array.byteLength);
+}
+//# sourceMappingURL=bufferShared.mjs.map

package/lib/bufferShared.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bufferShared.mjs","sourceRoot":"","sources":["../src/bufferShared.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAiB;IACxD,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE;QAC3E,OAAO,KAAK,CAAC,MAAM,CAAC;KACpB;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;AAClF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Converts a Uint8Array array to an ArrayBuffer.\n * @param array - Array to convert to ArrayBuffer.\n *\n * @internal\n */\nexport function Uint8ArrayToArrayBuffer(array: Uint8Array): ArrayBuffer {\n\tif (array.byteOffset === 0 && array.byteLength === array.buffer.byteLength) {\n\t\treturn array.buffer;\n\t}\n\treturn array.buffer.slice(array.byteOffset, array.byteOffset + array.byteLength);\n}\n"]}

package/lib/client-utils-alpha.d.mts

@@ -0,0 +1,82 @@
+/// <reference types="node" />
+
+import { EventEmitter } from 'events';
+import { IDisposable } from '@fluidframework/core-interfaces';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IEventTransformer } from '@fluidframework/core-interfaces';
+import { TransformedEvent } from '@fluidframework/core-interfaces';
+
+/* Excluded from this release type: Buffer_2 */
+
+/**
+ * Convert binary blob to string format
+ *
+ * @param blob - The binary blob
+ * @param encoding - Output string's encoding
+ * @returns The blob in string format
+ *
+ * @alpha
+ */
+export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
+
+/**
+ * The event emitter polyfill and the node event emitter have different event types:
+ * string | symbol vs. string | number
+ *
+ * This type allow us to correctly handle either type
+ * @public
+ */
+export declare type EventEmitterEventType = EventEmitter extends {
+    on(event: infer E, listener: any): any;
+} ? E : never;
+
+/* Excluded from this release type: EventForwarder */
+
+/* Excluded from this release type: fromBase64ToUtf8 */
+
+/* Excluded from this release type: fromUtf8ToBase64 */
+
+/* Excluded from this release type: gitHashFile */
+
+/* Excluded from this release type: hashFile */
+
+/* Excluded from this release type: IsoBuffer */
+
+/* Excluded from this release type: IsomorphicPerformance */
+
+/* Excluded from this release type: ITraceEvent */
+
+/* Excluded from this release type: performance_2 */
+
+/* Excluded from this release type: stringToBuffer */
+
+/* Excluded from this release type: toUtf8 */
+
+/* Excluded from this release type: Trace */
+
+/**
+ * Event Emitter helper class the supports emitting typed events
+ * @public
+ */
+export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
+    constructor();
+    readonly addListener: TypedEventTransform<this, TEvent>;
+    readonly on: TypedEventTransform<this, TEvent>;
+    readonly once: TypedEventTransform<this, TEvent>;
+    readonly prependListener: TypedEventTransform<this, TEvent>;
+    readonly prependOnceListener: TypedEventTransform<this, TEvent>;
+    readonly removeListener: TypedEventTransform<this, TEvent>;
+    readonly off: TypedEventTransform<this, TEvent>;
+}
+
+/**
+ * @public
+ */
+export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
+
+/* Excluded from this release type: Uint8ArrayToArrayBuffer */
+
+/* Excluded from this release type: Uint8ArrayToString */
+
+export { }

package/lib/client-utils-beta.d.mts

@@ -0,0 +1,73 @@
+/// <reference types="node" />
+
+import { EventEmitter } from 'events';
+import { IDisposable } from '@fluidframework/core-interfaces';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IEventTransformer } from '@fluidframework/core-interfaces';
+import { TransformedEvent } from '@fluidframework/core-interfaces';
+
+/* Excluded from this release type: Buffer_2 */
+
+/* Excluded from this release type: bufferToString */
+
+/**
+ * The event emitter polyfill and the node event emitter have different event types:
+ * string | symbol vs. string | number
+ *
+ * This type allow us to correctly handle either type
+ * @public
+ */
+export declare type EventEmitterEventType = EventEmitter extends {
+    on(event: infer E, listener: any): any;
+} ? E : never;
+
+/* Excluded from this release type: EventForwarder */
+
+/* Excluded from this release type: fromBase64ToUtf8 */
+
+/* Excluded from this release type: fromUtf8ToBase64 */
+
+/* Excluded from this release type: gitHashFile */
+
+/* Excluded from this release type: hashFile */
+
+/* Excluded from this release type: IsoBuffer */
+
+/* Excluded from this release type: IsomorphicPerformance */
+
+/* Excluded from this release type: ITraceEvent */
+
+/* Excluded from this release type: performance_2 */
+
+/* Excluded from this release type: stringToBuffer */
+
+/* Excluded from this release type: toUtf8 */
+
+/* Excluded from this release type: Trace */
+
+/**
+ * Event Emitter helper class the supports emitting typed events
+ * @public
+ */
+export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
+    constructor();
+    readonly addListener: TypedEventTransform<this, TEvent>;
+    readonly on: TypedEventTransform<this, TEvent>;
+    readonly once: TypedEventTransform<this, TEvent>;
+    readonly prependListener: TypedEventTransform<this, TEvent>;
+    readonly prependOnceListener: TypedEventTransform<this, TEvent>;
+    readonly removeListener: TypedEventTransform<this, TEvent>;
+    readonly off: TypedEventTransform<this, TEvent>;
+}
+
+/**
+ * @public
+ */
+export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
+
+/* Excluded from this release type: Uint8ArrayToArrayBuffer */
+
+/* Excluded from this release type: Uint8ArrayToString */
+
+export { }

package/lib/client-utils-public.d.mts

@@ -0,0 +1,73 @@
+/// <reference types="node" />
+
+import { EventEmitter } from 'events';
+import { IDisposable } from '@fluidframework/core-interfaces';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IEventTransformer } from '@fluidframework/core-interfaces';
+import { TransformedEvent } from '@fluidframework/core-interfaces';
+
+/* Excluded from this release type: Buffer_2 */
+
+/* Excluded from this release type: bufferToString */
+
+/**
+ * The event emitter polyfill and the node event emitter have different event types:
+ * string | symbol vs. string | number
+ *
+ * This type allow us to correctly handle either type
+ * @public
+ */
+export declare type EventEmitterEventType = EventEmitter extends {
+    on(event: infer E, listener: any): any;
+} ? E : never;
+
+/* Excluded from this release type: EventForwarder */
+
+/* Excluded from this release type: fromBase64ToUtf8 */
+
+/* Excluded from this release type: fromUtf8ToBase64 */
+
+/* Excluded from this release type: gitHashFile */
+
+/* Excluded from this release type: hashFile */
+
+/* Excluded from this release type: IsoBuffer */
+
+/* Excluded from this release type: IsomorphicPerformance */
+
+/* Excluded from this release type: ITraceEvent */
+
+/* Excluded from this release type: performance_2 */
+
+/* Excluded from this release type: stringToBuffer */
+
+/* Excluded from this release type: toUtf8 */
+
+/* Excluded from this release type: Trace */
+
+/**
+ * Event Emitter helper class the supports emitting typed events
+ * @public
+ */
+export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
+    constructor();
+    readonly addListener: TypedEventTransform<this, TEvent>;
+    readonly on: TypedEventTransform<this, TEvent>;
+    readonly once: TypedEventTransform<this, TEvent>;
+    readonly prependListener: TypedEventTransform<this, TEvent>;
+    readonly prependOnceListener: TypedEventTransform<this, TEvent>;
+    readonly removeListener: TypedEventTransform<this, TEvent>;
+    readonly off: TypedEventTransform<this, TEvent>;
+}
+
+/**
+ * @public
+ */
+export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
+
+/* Excluded from this release type: Uint8ArrayToArrayBuffer */
+
+/* Excluded from this release type: Uint8ArrayToString */
+
+export { }