@fluidframework/runtime-utils 0.54.0 → 0.55.0

package/lib/remoteObjectHandle.d.ts

@@ -1,32 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidHandle, IFluidHandleContext, IRequest, IResponse } from "@fluidframework/core-interfaces";
-/**
- * This handle is used to dynamically load a Fluid object on a remote client and is created on parsing a serialized
- * FluidObjectHandle.
- * This class is used to generate an IFluidHandle when de-serializing any all handles (including handles to DDSs, custom
- * objects) that are stored in SharedObjects. The Data Store or SharedObject corresponding to the IFluidHandle can be
- * retrieved by calling `get` on it.
- */
-export declare class RemoteFluidObjectHandle implements IFluidHandle {
-    readonly absolutePath: string;
-    readonly routeContext: IFluidHandleContext;
-    get IFluidRouter(): this;
-    get IFluidHandleContext(): this;
-    get IFluidHandle(): this;
-    readonly isAttached = true;
-    private objectP;
-    /**
-     * Creates a new RemoteFluidObjectHandle when parsing an IFluidHandle.
-     * @param absolutePath - The absolute path to the handle from the container runtime.
-     * @param routeContext - The root IFluidHandleContext that has a route to this handle.
-     */
-    constructor(absolutePath: string, routeContext: IFluidHandleContext);
-    get(): Promise<any>;
-    attachGraph(): void;
-    bind(handle: IFluidHandle): void;
-    request(request: IRequest): Promise<IResponse>;
-}
-//# sourceMappingURL=remoteObjectHandle.d.ts.map

package/lib/remoteObjectHandle.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"remoteObjectHandle.d.ts","sourceRoot":"","sources":["../src/remoteObjectHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EAGZ,MAAM,iCAAiC,CAAC;AAGzC;;;;;;GAMG;AACH,qBAAa,uBAAwB,YAAW,YAAY;aAcpC,YAAY,EAAE,MAAM;aACpB,YAAY,EAAE,mBAAmB;IAdrD,IAAW,YAAY,SAAmB;IAC1C,IAAW,mBAAmB,SAAmB;IACjD,IAAW,YAAY,SAAmB;IAE1C,SAAgB,UAAU,QAAQ;IAClC,OAAO,CAAC,OAAO,CAAmC;IAElD;;;;OAIG;gBAEiB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,mBAAmB;IAKxC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAezB,WAAW,IAAI,IAAI;IAInB,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAI1B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;CAY9D"}

package/lib/remoteObjectHandle.js

@@ -1,62 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert } from "@fluidframework/common-utils";
-import { create404Response, exceptionToResponse, responseToException } from "./dataStoreHelpers";
-/**
- * This handle is used to dynamically load a Fluid object on a remote client and is created on parsing a serialized
- * FluidObjectHandle.
- * This class is used to generate an IFluidHandle when de-serializing any all handles (including handles to DDSs, custom
- * objects) that are stored in SharedObjects. The Data Store or SharedObject corresponding to the IFluidHandle can be
- * retrieved by calling `get` on it.
- */
-export class RemoteFluidObjectHandle {
-    /**
-     * Creates a new RemoteFluidObjectHandle when parsing an IFluidHandle.
-     * @param absolutePath - The absolute path to the handle from the container runtime.
-     * @param routeContext - The root IFluidHandleContext that has a route to this handle.
-     */
-    constructor(absolutePath, routeContext) {
-        this.absolutePath = absolutePath;
-        this.routeContext = routeContext;
-        this.isAttached = true;
-        assert(absolutePath.startsWith("/"), 0x19d /* "Handles should always have absolute paths" */);
-    }
-    get IFluidRouter() { return this; }
-    get IFluidHandleContext() { return this; }
-    get IFluidHandle() { return this; }
-    async get() {
-        if (this.objectP === undefined) {
-            const request = { url: this.absolutePath };
-            this.objectP = this.routeContext.resolveHandle(request)
-                .then((response) => {
-                if (response.mimeType === "fluid/object") {
-                    const fluidObject = response.value;
-                    return fluidObject;
-                }
-                throw responseToException(response, request);
-            });
-        }
-        return this.objectP;
-    }
-    attachGraph() {
-        return;
-    }
-    bind(handle) {
-        handle.attachGraph();
-    }
-    async request(request) {
-        try {
-            const object = await this.get();
-            const router = object.IFluidRouter;
-            return router !== undefined
-                ? router.request(request)
-                : create404Response(request);
-        }
-        catch (error) {
-            return exceptionToResponse(error);
-        }
-    }
-}
-//# sourceMappingURL=remoteObjectHandle.js.map

package/lib/remoteObjectHandle.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"remoteObjectHandle.js","sourceRoot":"","sources":["../src/remoteObjectHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAStD,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEjG;;;;;;GAMG;AACH,MAAM,OAAO,uBAAuB;IAQhC;;;;OAIG;IACH,YACoB,YAAoB,EACpB,YAAiC;QADjC,iBAAY,GAAZ,YAAY,CAAQ;QACpB,iBAAY,GAAZ,YAAY,CAAqB;QAVrC,eAAU,GAAG,IAAI,CAAC;QAY9B,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAClG,CAAC;IAjBD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1C,IAAW,mBAAmB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IACjD,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAiBnC,KAAK,CAAC,GAAG;QACZ,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YAC5B,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC;iBAClD,IAAI,CAAc,CAAC,QAAQ,EAAE,EAAE;gBAC5B,IAAI,QAAQ,CAAC,QAAQ,KAAK,cAAc,EAAE;oBACtC,MAAM,WAAW,GAAgB,QAAQ,CAAC,KAAK,CAAC;oBAChD,OAAO,WAAW,CAAC;iBACtB;gBACD,MAAM,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;SACV;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAEM,WAAW;QACd,OAAO;IACX,CAAC;IAEM,IAAI,CAAC,MAAoB;QAC5B,MAAM,CAAC,WAAW,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,IAAI;YACA,MAAM,MAAM,GAA8B,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;YAEnC,OAAO,MAAM,KAAK,SAAS;gBACvB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;gBACzB,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SACpC;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC;SACrC;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IFluidHandle,\n    IFluidHandleContext,\n    IRequest,\n    IResponse,\n    FluidObject,\n    IFluidRouter,\n} from \"@fluidframework/core-interfaces\";\nimport { create404Response, exceptionToResponse, responseToException } from \"./dataStoreHelpers\";\n\n/**\n * This handle is used to dynamically load a Fluid object on a remote client and is created on parsing a serialized\n * FluidObjectHandle.\n * This class is used to generate an IFluidHandle when de-serializing any all handles (including handles to DDSs, custom\n * objects) that are stored in SharedObjects. The Data Store or SharedObject corresponding to the IFluidHandle can be\n * retrieved by calling `get` on it.\n */\nexport class RemoteFluidObjectHandle implements IFluidHandle {\n    public get IFluidRouter() { return this; }\n    public get IFluidHandleContext() { return this; }\n    public get IFluidHandle() { return this; }\n\n    public readonly isAttached = true;\n    private objectP: Promise<FluidObject> | undefined;\n\n    /**\n     * Creates a new RemoteFluidObjectHandle when parsing an IFluidHandle.\n     * @param absolutePath - The absolute path to the handle from the container runtime.\n     * @param routeContext - The root IFluidHandleContext that has a route to this handle.\n     */\n    constructor(\n        public readonly absolutePath: string,\n        public readonly routeContext: IFluidHandleContext,\n    ) {\n        assert(absolutePath.startsWith(\"/\"), 0x19d /* \"Handles should always have absolute paths\" */);\n    }\n\n    public async get(): Promise<any> {\n        if (this.objectP === undefined) {\n            const request = { url: this.absolutePath };\n            this.objectP = this.routeContext.resolveHandle(request)\n                .then<FluidObject>((response) => {\n                    if (response.mimeType === \"fluid/object\") {\n                        const fluidObject: FluidObject = response.value;\n                        return fluidObject;\n                    }\n                    throw responseToException(response, request);\n                });\n        }\n        return this.objectP;\n    }\n\n    public attachGraph(): void {\n        return;\n    }\n\n    public bind(handle: IFluidHandle): void {\n        handle.attachGraph();\n    }\n\n    public async request(request: IRequest): Promise<IResponse> {\n        try {\n            const object: FluidObject<IFluidRouter> = await this.get();\n            const router = object.IFluidRouter;\n\n            return router !== undefined\n                ? router.request(request)\n                : create404Response(request);\n        } catch (error) {\n            return exceptionToResponse(error);\n        }\n    }\n}\n"]}

package/lib/serializer.d.ts

@@ -1,45 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidHandle, IFluidHandleContext, IFluidSerializer } from "@fluidframework/core-interfaces";
-/**
- * Data Store serializer implementation
- */
-export declare class FluidSerializer implements IFluidSerializer {
-    private readonly context;
-    private readonly handleParsedCb;
-    private readonly root;
-    constructor(context: IFluidHandleContext, handleParsedCb: (handle: IFluidHandle) => void);
-    get IFluidSerializer(): this;
-    /**
-     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a
-     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * Any unbound handles encountered are bound to the provided IFluidHandle.
-     */
-    replaceHandles(input: any, bind: IFluidHandle): any;
-    /**
-     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
-     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * The decoded handles are implicitly bound to the handle context of this serializer.
-     */
-    decode(input: any): any;
-    stringify(input: any, bind: IFluidHandle): string;
-    parse(input: string): any;
-    private readonly encodeValue;
-    private readonly decodeValue;
-    private recursivelyReplace;
-    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle): {
-        type: string;
-        url: string;
-    };
-}
-//# sourceMappingURL=serializer.d.ts.map

package/lib/serializer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACH,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,EACnB,MAAM,iCAAiC,CAAC;AAKzC;;GAEG;AACH,qBAAa,eAAgB,YAAW,gBAAgB;IAIhD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAExB,OAAO,CAAC,QAAQ,CAAC,cAAc;IALnC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAsB;gBAGtB,OAAO,EAAE,mBAAmB,EAE5B,cAAc,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI;IAQnE,IAAW,gBAAgB,SAAmB;IAE9C;;;;;;;;OAQG;IACK,cAAc,CAClB,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,YAAY;IAUtB;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAK,EAAE,GAAG;IASlB,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY;IAKxC,KAAK,CAAC,KAAK,EAAE,MAAM;IAM1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAQ1B;IAIF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAe1B;IAKF,OAAO,CAAC,kBAAkB;IAgD1B,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY;;;;CAOrE"}

package/lib/serializer.js

@@ -1,141 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { RemoteFluidObjectHandle } from "./remoteObjectHandle";
-import { generateHandleContextPath } from "./dataStoreHandleContextUtils";
-import { isSerializedHandle } from "./utils";
-/**
- * Data Store serializer implementation
- */
-export class FluidSerializer {
-    constructor(context, 
-    // To be called whenever a handle is parsed by this serializer.
-    handleParsedCb) {
-        this.context = context;
-        this.handleParsedCb = handleParsedCb;
-        // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.
-        // Otherwise returns the original 'value'.  Used by 'replaceHandles()' and 'stringify()'.
-        this.encodeValue = (value, bind) => {
-            // Detect if 'value' is an IFluidHandle.
-            const handle = value === null || value === void 0 ? void 0 : value.IFluidHandle;
-            // If 'value' is an IFluidHandle return its encoded form.
-            return handle !== undefined
-                ? this.serializeHandle(handle, bind)
-                : value;
-        };
-        // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.
-        // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.
-        this.decodeValue = (value) => {
-            // If 'value' is a serialized IFluidHandle return the deserialized result.
-            if (isSerializedHandle(value)) {
-                // Old documents may have handles with relative path in their summaries. Convert these to absolute
-                // paths. This will ensure that future summaries will have absolute paths for these handles.
-                const absolutePath = value.url.startsWith("/")
-                    ? value.url
-                    : generateHandleContextPath(value.url, this.context);
-                const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);
-                this.handleParsedCb(parsedHandle);
-                return parsedHandle;
-            }
-            else {
-                return value;
-            }
-        };
-        this.root = this.context;
-        while (this.root.routeContext !== undefined) {
-            this.root = this.root.routeContext;
-        }
-    }
-    get IFluidSerializer() { return this; }
-    /**
-     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a
-     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * Any unbound handles encountered are bound to the provided IFluidHandle.
-     */
-    replaceHandles(input, bind) {
-        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,
-        // return the result of 'recursivelyReplace()'.
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        return !!input && typeof input === "object"
-            ? this.recursivelyReplace(input, this.encodeValue, bind)
-            : input;
-    }
-    /**
-     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
-     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * The decoded handles are implicitly bound to the handle context of this serializer.
-     */
-    decode(input) {
-        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,
-        // return the result of 'recursivelyReplace()'.
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        return !!input && typeof input === "object"
-            ? this.recursivelyReplace(input, this.decodeValue)
-            : input;
-    }
-    stringify(input, bind) {
-        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));
-    }
-    // Parses the serialized data - context must match the context with which the JSON was stringified
-    parse(input) {
-        return JSON.parse(input, (key, value) => this.decodeValue(value));
-    }
-    // Invoked for non-null objects to recursively replace references to IFluidHandles.
-    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,
-    // returns the original `input`.
-    recursivelyReplace(input, replacer, context) {
-        // Note: Caller is responsible for ensuring that `input` is defined / non-null.
-        //       (Required for Object.keys() below.)
-        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`
-        // is a non-null object.
-        const maybeReplaced = replacer(input, context);
-        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always
-        // leaves in the object graph.
-        if (maybeReplaced !== input) {
-            return maybeReplaced;
-        }
-        // Otherwise descend into the object graph looking for IFluidHandle instances.
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        let clone;
-        for (const key of Object.keys(input)) {
-            const value = input[key];
-            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-            if (!!value && typeof value === "object") {
-                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must
-                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only
-                //       lead to a later error when attempting to stringify().
-                const replaced = this.recursivelyReplace(value, replacer, context);
-                // If the `replaced` object is different than the original `value` then the subgraph contained one
-                // or more handles.  If this happens, we need to return a clone of the `input` object where the
-                // current property is replaced by the `replaced` value.
-                if (replaced !== value) {
-                    // Lazily create a shallow clone of the `input` object if we haven't done so already.
-                    clone = clone !== null && clone !== void 0 ? clone : (Array.isArray(input)
-                        ? [...input]
-                        : Object.assign({}, input));
-                    // Overwrite the current property `key` in the clone with the `replaced` value.
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    clone[key] = replaced;
-                }
-            }
-        }
-        return clone !== null && clone !== void 0 ? clone : input;
-    }
-    serializeHandle(handle, bind) {
-        bind.bind(handle);
-        return {
-            type: "__fluid_handle__",
-            url: handle.absolutePath,
-        };
-    }
-}
-//# sourceMappingURL=serializer.js.map

package/lib/serializer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,eAAe;IAGxB,YACqB,OAA4B;IAC7C,+DAA+D;IAC9C,cAA8C;QAF9C,YAAO,GAAP,OAAO,CAAqB;QAE5B,mBAAc,GAAd,cAAc,CAAgC;QA0DnE,6EAA6E;QAC7E,yFAAyF;QACxE,gBAAW,GAAG,CAAC,KAAU,EAAE,IAAkB,EAAE,EAAE;YAC9D,wCAAwC;YACxC,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAC;YAEnC,yDAAyD;YACzD,OAAO,MAAM,KAAK,SAAS;gBACvB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;gBACpC,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC;QAEF,qFAAqF;QACrF,6EAA6E;QAC5D,gBAAW,GAAG,CAAC,KAAU,EAAE,EAAE;YAC1C,0EAA0E;YAC1E,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;gBAC3B,kGAAkG;gBAClG,4FAA4F;gBAC5F,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;oBAC1C,CAAC,CAAC,KAAK,CAAC,GAAG;oBACX,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEzD,MAAM,YAAY,GAAG,IAAI,uBAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1E,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;gBAClC,OAAO,YAAY,CAAC;aACvB;iBAAM;gBACH,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC;QArFE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;SACtC;IACL,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAE9C;;;;;;;;OAQG;IACK,cAAc,CAClB,KAAU,EACV,IAAkB;QAElB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC;YACxD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAU;QACrB,kFAAkF;QAClF,+CAA+C;QAC/C,yEAAyE;QACzE,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YACvC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;YAClD,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,KAAU,EAAE,IAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,kGAAkG;IAC3F,KAAK,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAiCD,mFAAmF;IACnF,0FAA0F;IAC1F,gCAAgC;IACxB,kBAAkB,CACtB,KAAU,EACV,QAA2C,EAC3C,OAAa;QAEb,+EAA+E;QAC/E,4CAA4C;QAE5C,yGAAyG;QACzG,wBAAwB;QACxB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE/C,qGAAqG;QACrG,8BAA8B;QAC9B,IAAI,aAAa,KAAK,KAAK,EAAE;YACzB,OAAO,aAAa,CAAC;SACxB;QAED,8EAA8E;QAC9E,wDAAwD;QACxD,IAAI,KAAyB,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,yEAAyE;YACzE,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACtC,8FAA8F;gBAC9F,+FAA+F;gBAC/F,8DAA8D;gBAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAEnE,kGAAkG;gBAClG,+FAA+F;gBAC/F,wDAAwD;gBACxD,IAAI,QAAQ,KAAK,KAAK,EAAE;oBACpB,qFAAqF;oBACrF,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBAClC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;wBACZ,CAAC,mBAAM,KAAK,CAAE,CAAC,CAAC;oBAEpB,+EAA+E;oBAC/E,oEAAoE;oBACpE,KAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBAC1B;aACJ;SACJ;QACD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC;IAC1B,CAAC;IAES,eAAe,CAAC,MAAoB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,OAAO;YACH,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,MAAM,CAAC,YAAY;SAC3B,CAAC;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// RATIONALE: Many methods consume and return 'any' by necessity.\n/* eslint-disable @typescript-eslint/no-unsafe-return */\n\nimport {\n    IFluidHandle,\n    IFluidHandleContext,\n    IFluidSerializer,\n} from \"@fluidframework/core-interfaces\";\nimport { RemoteFluidObjectHandle } from \"./remoteObjectHandle\";\nimport { generateHandleContextPath } from \"./dataStoreHandleContextUtils\";\nimport { isSerializedHandle } from \"./utils\";\n\n/**\n * Data Store serializer implementation\n */\nexport class FluidSerializer implements IFluidSerializer {\n    private readonly root: IFluidHandleContext;\n\n    public constructor(\n        private readonly context: IFluidHandleContext,\n        // To be called whenever a handle is parsed by this serializer.\n        private readonly handleParsedCb: (handle: IFluidHandle) => void,\n    ) {\n        this.root = this.context;\n        while (this.root.routeContext !== undefined) {\n            this.root = this.root.routeContext;\n        }\n    }\n\n    public get IFluidSerializer() { return this; }\n\n    /**\n     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a\n     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * Any unbound handles encountered are bound to the provided IFluidHandle.\n     */\n     public replaceHandles(\n        input: any,\n        bind: IFluidHandle,\n    ) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.encodeValue, bind)\n            : input;\n    }\n\n    /**\n     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an\n     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.\n     *\n     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from\n     * the root to any replaced handles.  (If no handles are found, returns the original object.)\n     *\n     * The decoded handles are implicitly bound to the handle context of this serializer.\n     */\n     public decode(input: any) {\n        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,\n        // return the result of 'recursivelyReplace()'.\n        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n        return !!input && typeof input === \"object\"\n            ? this.recursivelyReplace(input, this.decodeValue)\n            : input;\n    }\n\n    public stringify(input: any, bind: IFluidHandle) {\n        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));\n    }\n\n    // Parses the serialized data - context must match the context with which the JSON was stringified\n    public parse(input: string) {\n        return JSON.parse(input, (key, value) => this.decodeValue(value));\n    }\n\n    // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'replaceHandles()' and 'stringify()'.\n    private readonly encodeValue = (value: any, bind: IFluidHandle) => {\n        // Detect if 'value' is an IFluidHandle.\n        const handle = value?.IFluidHandle;\n\n        // If 'value' is an IFluidHandle return its encoded form.\n        return handle !== undefined\n            ? this.serializeHandle(handle, bind)\n            : value;\n    };\n\n    // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.\n    // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.\n    private readonly decodeValue = (value: any) => {\n        // If 'value' is a serialized IFluidHandle return the deserialized result.\n        if (isSerializedHandle(value)) {\n            // Old documents may have handles with relative path in their summaries. Convert these to absolute\n            // paths. This will ensure that future summaries will have absolute paths for these handles.\n            const absolutePath = value.url.startsWith(\"/\")\n                ? value.url\n                : generateHandleContextPath(value.url, this.context);\n\n            const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);\n            this.handleParsedCb(parsedHandle);\n            return parsedHandle;\n        } else {\n            return value;\n        }\n    };\n\n    // Invoked for non-null objects to recursively replace references to IFluidHandles.\n    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,\n    // returns the original `input`.\n    private recursivelyReplace(\n        input: any,\n        replacer: (input: any, context: any) => any,\n        context?: any,\n    ) {\n        // Note: Caller is responsible for ensuring that `input` is defined / non-null.\n        //       (Required for Object.keys() below.)\n\n        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`\n        // is a non-null object.\n        const maybeReplaced = replacer(input, context);\n\n        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always\n        // leaves in the object graph.\n        if (maybeReplaced !== input) {\n            return maybeReplaced;\n        }\n\n        // Otherwise descend into the object graph looking for IFluidHandle instances.\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        let clone: object | undefined;\n        for (const key of Object.keys(input)) {\n            const value = input[key];\n            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n            if (!!value && typeof value === \"object\") {\n                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must\n                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only\n                //       lead to a later error when attempting to stringify().\n                const replaced = this.recursivelyReplace(value, replacer, context);\n\n                // If the `replaced` object is different than the original `value` then the subgraph contained one\n                // or more handles.  If this happens, we need to return a clone of the `input` object where the\n                // current property is replaced by the `replaced` value.\n                if (replaced !== value) {\n                    // Lazily create a shallow clone of the `input` object if we haven't done so already.\n                    clone = clone ?? (Array.isArray(input)\n                        ? [...input]\n                        : { ...input });\n\n                    // Overwrite the current property `key` in the clone with the `replaced` value.\n                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                    clone![key] = replaced;\n                }\n            }\n        }\n        return clone ?? input;\n    }\n\n    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {\n        bind.bind(handle);\n        return {\n            type: \"__fluid_handle__\",\n            url: handle.absolutePath,\n        };\n    }\n}\n"]}

package/src/remoteObjectHandle.ts

@@ -1,79 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { assert } from "@fluidframework/common-utils";
-import {
-    IFluidHandle,
-    IFluidHandleContext,
-    IRequest,
-    IResponse,
-    FluidObject,
-    IFluidRouter,
-} from "@fluidframework/core-interfaces";
-import { create404Response, exceptionToResponse, responseToException } from "./dataStoreHelpers";
-
-/**
- * This handle is used to dynamically load a Fluid object on a remote client and is created on parsing a serialized
- * FluidObjectHandle.
- * This class is used to generate an IFluidHandle when de-serializing any all handles (including handles to DDSs, custom
- * objects) that are stored in SharedObjects. The Data Store or SharedObject corresponding to the IFluidHandle can be
- * retrieved by calling `get` on it.
- */
-export class RemoteFluidObjectHandle implements IFluidHandle {
-    public get IFluidRouter() { return this; }
-    public get IFluidHandleContext() { return this; }
-    public get IFluidHandle() { return this; }
-
-    public readonly isAttached = true;
-    private objectP: Promise<FluidObject> | undefined;
-
-    /**
-     * Creates a new RemoteFluidObjectHandle when parsing an IFluidHandle.
-     * @param absolutePath - The absolute path to the handle from the container runtime.
-     * @param routeContext - The root IFluidHandleContext that has a route to this handle.
-     */
-    constructor(
-        public readonly absolutePath: string,
-        public readonly routeContext: IFluidHandleContext,
-    ) {
-        assert(absolutePath.startsWith("/"), 0x19d /* "Handles should always have absolute paths" */);
-    }
-
-    public async get(): Promise<any> {
-        if (this.objectP === undefined) {
-            const request = { url: this.absolutePath };
-            this.objectP = this.routeContext.resolveHandle(request)
-                .then<FluidObject>((response) => {
-                    if (response.mimeType === "fluid/object") {
-                        const fluidObject: FluidObject = response.value;
-                        return fluidObject;
-                    }
-                    throw responseToException(response, request);
-                });
-        }
-        return this.objectP;
-    }
-
-    public attachGraph(): void {
-        return;
-    }
-
-    public bind(handle: IFluidHandle): void {
-        handle.attachGraph();
-    }
-
-    public async request(request: IRequest): Promise<IResponse> {
-        try {
-            const object: FluidObject<IFluidRouter> = await this.get();
-            const router = object.IFluidRouter;
-
-            return router !== undefined
-                ? router.request(request)
-                : create404Response(request);
-        } catch (error) {
-            return exceptionToResponse(error);
-        }
-    }
-}

package/src/serializer.ts

@@ -1,174 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-// RATIONALE: Many methods consume and return 'any' by necessity.
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-
-import {
-    IFluidHandle,
-    IFluidHandleContext,
-    IFluidSerializer,
-} from "@fluidframework/core-interfaces";
-import { RemoteFluidObjectHandle } from "./remoteObjectHandle";
-import { generateHandleContextPath } from "./dataStoreHandleContextUtils";
-import { isSerializedHandle } from "./utils";
-
-/**
- * Data Store serializer implementation
- */
-export class FluidSerializer implements IFluidSerializer {
-    private readonly root: IFluidHandleContext;
-
-    public constructor(
-        private readonly context: IFluidHandleContext,
-        // To be called whenever a handle is parsed by this serializer.
-        private readonly handleParsedCb: (handle: IFluidHandle) => void,
-    ) {
-        this.root = this.context;
-        while (this.root.routeContext !== undefined) {
-            this.root = this.root.routeContext;
-        }
-    }
-
-    public get IFluidSerializer() { return this; }
-
-    /**
-     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a
-     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * Any unbound handles encountered are bound to the provided IFluidHandle.
-     */
-     public replaceHandles(
-        input: any,
-        bind: IFluidHandle,
-    ) {
-        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,
-        // return the result of 'recursivelyReplace()'.
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        return !!input && typeof input === "object"
-            ? this.recursivelyReplace(input, this.encodeValue, bind)
-            : input;
-    }
-
-    /**
-     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
-     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
-     *
-     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
-     * the root to any replaced handles.  (If no handles are found, returns the original object.)
-     *
-     * The decoded handles are implicitly bound to the handle context of this serializer.
-     */
-     public decode(input: any) {
-        // If the given 'input' cannot contain handles, return it immediately.  Otherwise,
-        // return the result of 'recursivelyReplace()'.
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        return !!input && typeof input === "object"
-            ? this.recursivelyReplace(input, this.decodeValue)
-            : input;
-    }
-
-    public stringify(input: any, bind: IFluidHandle) {
-        return JSON.stringify(input, (key, value) => this.encodeValue(value, bind));
-    }
-
-    // Parses the serialized data - context must match the context with which the JSON was stringified
-    public parse(input: string) {
-        return JSON.parse(input, (key, value) => this.decodeValue(value));
-    }
-
-    // If the given 'value' is an IFluidHandle, returns the encoded IFluidHandle.
-    // Otherwise returns the original 'value'.  Used by 'replaceHandles()' and 'stringify()'.
-    private readonly encodeValue = (value: any, bind: IFluidHandle) => {
-        // Detect if 'value' is an IFluidHandle.
-        const handle = value?.IFluidHandle;
-
-        // If 'value' is an IFluidHandle return its encoded form.
-        return handle !== undefined
-            ? this.serializeHandle(handle, bind)
-            : value;
-    };
-
-    // If the given 'value' is an encoded IFluidHandle, returns the decoded IFluidHandle.
-    // Otherwise returns the original 'value'.  Used by 'decode()' and 'parse()'.
-    private readonly decodeValue = (value: any) => {
-        // If 'value' is a serialized IFluidHandle return the deserialized result.
-        if (isSerializedHandle(value)) {
-            // Old documents may have handles with relative path in their summaries. Convert these to absolute
-            // paths. This will ensure that future summaries will have absolute paths for these handles.
-            const absolutePath = value.url.startsWith("/")
-                ? value.url
-                : generateHandleContextPath(value.url, this.context);
-
-            const parsedHandle = new RemoteFluidObjectHandle(absolutePath, this.root);
-            this.handleParsedCb(parsedHandle);
-            return parsedHandle;
-        } else {
-            return value;
-        }
-    };
-
-    // Invoked for non-null objects to recursively replace references to IFluidHandles.
-    // Clones as-needed to avoid mutating the `input` object.  If no IFluidHandes are present,
-    // returns the original `input`.
-    private recursivelyReplace(
-        input: any,
-        replacer: (input: any, context: any) => any,
-        context?: any,
-    ) {
-        // Note: Caller is responsible for ensuring that `input` is defined / non-null.
-        //       (Required for Object.keys() below.)
-
-        // Execute the `replace` on the current input.  Note that Caller is responsible for ensuring that `input`
-        // is a non-null object.
-        const maybeReplaced = replacer(input, context);
-
-        // If the replacer made a substitution there is no need to decscend further. IFluidHandles are always
-        // leaves in the object graph.
-        if (maybeReplaced !== input) {
-            return maybeReplaced;
-        }
-
-        // Otherwise descend into the object graph looking for IFluidHandle instances.
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        let clone: object | undefined;
-        for (const key of Object.keys(input)) {
-            const value = input[key];
-            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-            if (!!value && typeof value === "object") {
-                // Note: Except for IFluidHandle, `input` must not contain circular references (as object must
-                //       be JSON serializable.)  Therefore, guarding against infinite recursion here would only
-                //       lead to a later error when attempting to stringify().
-                const replaced = this.recursivelyReplace(value, replacer, context);
-
-                // If the `replaced` object is different than the original `value` then the subgraph contained one
-                // or more handles.  If this happens, we need to return a clone of the `input` object where the
-                // current property is replaced by the `replaced` value.
-                if (replaced !== value) {
-                    // Lazily create a shallow clone of the `input` object if we haven't done so already.
-                    clone = clone ?? (Array.isArray(input)
-                        ? [...input]
-                        : { ...input });
-
-                    // Overwrite the current property `key` in the clone with the `replaced` value.
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    clone![key] = replaced;
-                }
-            }
-        }
-        return clone ?? input;
-    }
-
-    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle) {
-        bind.bind(handle);
-        return {
-            type: "__fluid_handle__",
-            url: handle.absolutePath,
-        };
-    }
-}