@fluidframework/core-interfaces 0.39.8 → 0.41.0-43885

package/api-extractor.json

@@ -1,4 +1,12 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common.json"
+  "extends": "@fluidframework/build-common/api-extractor-common-report.json",
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/api-report/"
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
+  }
 }

package/api-report/core-interfaces.api.md

@@ -0,0 +1,246 @@
+## API Report File for "@fluidframework/core-interfaces"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// Warning: (ae-incompatible-release-tags) The symbol "FluidObject" is marked as @public, but its signature references "FluidObjectProviderKeys" which is marked as @internal
+//
+// @public
+export type FluidObject<T = unknown> = Partial<Pick<T, FluidObjectProviderKeys<T>>>;
+
+// @public
+export type FluidObjectKeys<T> = keyof FluidObject<T>;
+
+// Warning: (ae-internal-missing-underscore) The name "FluidObjectProviderKeys" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Exclude<T[TProp], undefined> ? TProp : never;
+
+// @public
+export interface IFluidCodeDetails {
+    readonly config?: IFluidCodeDetailsConfig;
+    readonly package: string | Readonly<IFluidPackage>;
+}
+
+// @public (undocumented)
+export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
+
+// @public
+export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
+    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
+    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
+}
+
+// @public
+export interface IFluidCodeDetailsConfig {
+    // (undocumented)
+    readonly [key: string]: string;
+}
+
+// @public (undocumented)
+export const IFluidConfiguration: keyof IProvideFluidConfiguration;
+
+// @public (undocumented)
+export interface IFluidConfiguration extends IProvideFluidConfiguration {
+    // (undocumented)
+    scopes: string[];
+}
+
+// @public (undocumented)
+export const IFluidHandle: keyof IProvideFluidHandle;
+
+// @public
+export interface IFluidHandle<T = IFluidObject & IFluidLoadable> extends IProvideFluidHandle {
+    // @deprecated (undocumented)
+    readonly absolutePath: string;
+    attachGraph(): void;
+    bind(handle: IFluidHandle): void;
+    get(): Promise<T>;
+    readonly isAttached: boolean;
+}
+
+// @public (undocumented)
+export const IFluidHandleContext: keyof IProvideFluidHandleContext;
+
+// @public
+export interface IFluidHandleContext extends IProvideFluidHandleContext {
+    readonly absolutePath: string;
+    attachGraph(): void;
+    readonly isAttached: boolean;
+    // (undocumented)
+    resolveHandle(request: IRequest): Promise<IResponse>;
+    readonly routeContext?: IFluidHandleContext;
+}
+
+// @public (undocumented)
+export const IFluidLoadable: keyof IProvideFluidLoadable;
+
+// @public
+export interface IFluidLoadable extends IProvideFluidLoadable {
+    // (undocumented)
+    handle: IFluidHandle;
+}
+
+// @public @deprecated (undocumented)
+export interface IFluidObject {
+    // @deprecated (undocumented)
+    readonly IFluidConfiguration?: IFluidConfiguration;
+    // @deprecated (undocumented)
+    readonly IFluidHandle?: IFluidHandle;
+    // @deprecated (undocumented)
+    readonly IFluidHandleContext?: IFluidHandleContext;
+    // @deprecated (undocumented)
+    readonly IFluidLoadable?: IFluidLoadable;
+    // @deprecated (undocumented)
+    readonly IFluidRouter?: IFluidRouter;
+    // @deprecated (undocumented)
+    readonly IFluidRunnable?: IFluidRunnable;
+    // @deprecated (undocumented)
+    readonly IFluidSerializer?: IFluidSerializer;
+}
+
+// @public
+export interface IFluidPackage {
+    [key: string]: unknown;
+    fluid: {
+        [environment: string]: undefined | IFluidPackageEnvironment;
+    };
+    name: string;
+}
+
+// @public
+export interface IFluidPackageEnvironment {
+    [target: string]: undefined | {
+        files: string[];
+        [key: string]: unknown;
+    };
+}
+
+// @public (undocumented)
+export const IFluidRouter: keyof IProvideFluidRouter;
+
+// @public (undocumented)
+export interface IFluidRouter extends IProvideFluidRouter {
+    // (undocumented)
+    request(request: IRequest): Promise<IResponse>;
+}
+
+// @public (undocumented)
+export const IFluidRunnable: keyof IProvideFluidRunnable;
+
+// @public (undocumented)
+export interface IFluidRunnable {
+    // (undocumented)
+    run(...args: any[]): Promise<void>;
+    // (undocumented)
+    stop(reason?: string): void;
+}
+
+// @public (undocumented)
+export const IFluidSerializer: keyof IProvideFluidSerializer;
+
+// @public (undocumented)
+export interface IFluidSerializer extends IProvideFluidSerializer {
+    decode?(input: any): any;
+    parse(value: string): any;
+    replaceHandles(value: any, bind: IFluidHandle): any;
+    stringify(value: any, bind: IFluidHandle): string;
+}
+
+// @public (undocumented)
+export interface IProvideFluidCodeDetailsComparer {
+    // (undocumented)
+    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
+}
+
+// @public (undocumented)
+export interface IProvideFluidConfiguration {
+    // (undocumented)
+    readonly IFluidConfiguration: IFluidConfiguration;
+}
+
+// @public (undocumented)
+export interface IProvideFluidHandle {
+    // (undocumented)
+    readonly IFluidHandle: IFluidHandle;
+}
+
+// @public (undocumented)
+export interface IProvideFluidHandleContext {
+    // (undocumented)
+    readonly IFluidHandleContext: IFluidHandleContext;
+}
+
+// @public (undocumented)
+export interface IProvideFluidLoadable {
+    // (undocumented)
+    readonly IFluidLoadable: IFluidLoadable;
+}
+
+// @public
+export interface IProvideFluidRouter {
+    // (undocumented)
+    readonly IFluidRouter: IFluidRouter;
+}
+
+// @public (undocumented)
+export interface IProvideFluidRunnable {
+    // (undocumented)
+    readonly IFluidRunnable: IFluidRunnable;
+}
+
+// @public (undocumented)
+export interface IProvideFluidSerializer {
+    // (undocumented)
+    readonly IFluidSerializer: IFluidSerializer;
+}
+
+// @public (undocumented)
+export interface IRequest {
+    // (undocumented)
+    headers?: IRequestHeader;
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export interface IRequestHeader {
+    // (undocumented)
+    [index: string]: any;
+}
+
+// @public (undocumented)
+export interface IResponse {
+    // (undocumented)
+    headers?: {
+        [key: string]: any;
+    };
+    // (undocumented)
+    mimeType: string;
+    // (undocumented)
+    stack?: string;
+    // (undocumented)
+    status: number;
+    // (undocumented)
+    value: any;
+}
+
+// @public
+export interface ISerializedHandle {
+    // (undocumented)
+    type: "__fluid_handle__";
+    // (undocumented)
+    url: string;
+}
+
+// @public (undocumented)
+export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
+
+// @public
+export const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
+
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/fluidObject.d.ts

@@ -2,10 +2,41 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IProvideFluidConfiguration, IProvideFluidLoadable, IProvideFluidRunnable } from "./fluidLoadable";
-import { IProvideFluidRouter } from "./fluidRouter";
-import { IProvideFluidHandle, IProvideFluidHandleContext } from "./handles";
-import { IProvideFluidSerializer } from "./serializer";
-export interface IFluidObject extends Readonly<Partial<IProvideFluidLoadable & IProvideFluidRunnable & IProvideFluidRouter & IProvideFluidHandleContext & IProvideFluidConfiguration & IProvideFluidHandle & IProvideFluidSerializer>> {
+import { IFluidConfiguration, IFluidLoadable, IFluidRunnable } from "./fluidLoadable";
+import { IFluidRouter } from "./fluidRouter";
+import { IFluidHandle, IFluidHandleContext } from "./handles";
+import { IFluidSerializer } from "./serializer";
+/**
+ * @deprecated Use `FluidObject` or the interface directly instead
+ */
+export interface IFluidObject {
+    /**
+     * @deprecated - use `FluidObject<IFluidLoadable>` instead
+     */
+    readonly IFluidLoadable?: IFluidLoadable;
+    /**
+     * @deprecated - use `FluidObject<IFluidRunnable>` instead
+     */
+    readonly IFluidRunnable?: IFluidRunnable;
+    /**
+     * @deprecated - use `FluidObject<IFluidRouter>` instead
+     */
+    readonly IFluidRouter?: IFluidRouter;
+    /**
+     * @deprecated - use `FluidObject<IFluidHandleContext>` instead
+     */
+    readonly IFluidHandleContext?: IFluidHandleContext;
+    /**
+     * @deprecated - use `FluidObject<IFluidConfiguration>` instead
+     */
+    readonly IFluidConfiguration?: IFluidConfiguration;
+    /**
+     * @deprecated - use `FluidObject<IFluidHandle>` instead
+     */
+    readonly IFluidHandle?: IFluidHandle;
+    /**
+     * @deprecated - use `FluidObject<IFluidSerializer>` instead
+     */
+    readonly IFluidSerializer?: IFluidSerializer;
 }
 //# sourceMappingURL=fluidObject.d.ts.map

package/dist/fluidObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidObject.d.ts","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGvD,MAAM,WAAW,YAAa,SAC1B,QAAQ,CAAC,OAAO,CACZ,qBAAqB,GACnB,qBAAqB,GACrB,mBAAmB,GACnB,0BAA0B,GAC1B,0BAA0B,GAC1B,mBAAmB,GACnB,uBAAuB,CAAC,CAAC;CAClC"}
+{"version":3,"file":"fluidObject.d.ts","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,mBAAmB,EACnB,cAAc,EACd,cAAc,EACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,YAAY;IAEzB;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IACnD;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IACnD;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAChD"}

package/dist/fluidObject.js

@@ -4,5 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-enable @typescript-eslint/no-empty-interface */
 //# sourceMappingURL=fluidObject.js.map

package/dist/fluidObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidObject.js","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAsBH,yDAAyD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IProvideFluidConfiguration,\n    IProvideFluidLoadable,\n    IProvideFluidRunnable,\n} from \"./fluidLoadable\";\nimport { IProvideFluidRouter } from \"./fluidRouter\";\nimport { IProvideFluidHandle, IProvideFluidHandleContext } from \"./handles\";\nimport { IProvideFluidSerializer } from \"./serializer\";\n\n/* eslint-disable @typescript-eslint/no-empty-interface */\nexport interface IFluidObject extends\n    Readonly<Partial<\n        IProvideFluidLoadable\n        & IProvideFluidRunnable\n        & IProvideFluidRouter\n        & IProvideFluidHandleContext\n        & IProvideFluidConfiguration\n        & IProvideFluidHandle\n        & IProvideFluidSerializer>> {\n}\n/* eslint-enable @typescript-eslint/no-empty-interface */\n"]}
+{"version":3,"file":"fluidObject.js","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidConfiguration,\n    IFluidLoadable,\n    IFluidRunnable,\n} from \"./fluidLoadable\";\nimport { IFluidRouter } from \"./fluidRouter\";\nimport { IFluidHandle, IFluidHandleContext } from \"./handles\";\nimport { IFluidSerializer } from \"./serializer\";\n\n/**\n * @deprecated Use `FluidObject` or the interface directly instead\n */\nexport interface IFluidObject {\n\n    /**\n     * @deprecated - use `FluidObject<IFluidLoadable>` instead\n     */\n    readonly IFluidLoadable?: IFluidLoadable;\n    /**\n     * @deprecated - use `FluidObject<IFluidRunnable>` instead\n     */\n    readonly IFluidRunnable?: IFluidRunnable\n    /**\n     * @deprecated - use `FluidObject<IFluidRouter>` instead\n     */\n    readonly IFluidRouter?: IFluidRouter;\n    /**\n     * @deprecated - use `FluidObject<IFluidHandleContext>` instead\n     */\n    readonly IFluidHandleContext?: IFluidHandleContext;\n    /**\n     * @deprecated - use `FluidObject<IFluidConfiguration>` instead\n     */\n    readonly IFluidConfiguration?: IFluidConfiguration;\n    /**\n     * @deprecated - use `FluidObject<IFluidHandle>` instead\n     */\n    readonly IFluidHandle?: IFluidHandle;\n    /**\n     * @deprecated - use `FluidObject<IFluidSerializer>` instead\n     */\n    readonly IFluidSerializer?: IFluidSerializer;\n}\n"]}

package/dist/fluidPackage.d.ts

@@ -29,7 +29,7 @@ export interface IFluidPackageEnvironment {
  * Fluid-specific properties expected on a package to be loaded by the code loader.
  * While compatible with the npm package format it is not necessary that that package is an
  * npm package:
- * https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid
+ * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
  */
 export interface IFluidPackage {
     /**
@@ -91,7 +91,7 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
      * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.
      *
      * Similar semantics to:
-     *      https://github.com/npm/node-semver#usage
+     * {@link https://github.com/npm/node-semver#usage}
      */
     satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
     /**
@@ -102,7 +102,7 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
      *      `undefined` if `a` is not comparable to `b`.
      *
      * Similar semantics to:
-     *      https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
      */
     compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
 }

package/dist/fluidPackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;GAEG;AACJ,MAAM,WAAW,wBAAwB;IAErC;;;OAGG;IACH,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG;QAC1B;;;;WAIG;QACH,KAAK,EAAE,MAAM,EAAE,CAAC;QAEhB;;;;WAIG;QACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAA;CACJ;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAI,SAAS,GAAG,wBAAwB,CAAC;KAChE,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAC;CAC7C;AAED,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gCAAgC;IAE/E;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,EAAE,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzF;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACpF"}
+{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;GAEG;AACJ,MAAM,WAAW,wBAAwB;IAErC;;;OAGG;IACH,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG;QAC1B;;;;WAIG;QACH,KAAK,EAAE,MAAM,EAAE,CAAC;QAEhB;;;;WAIG;QACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAA;CACJ;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAI,SAAS,GAAG,wBAAwB,CAAC;KAChE,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IAEnD;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAC;CAC7C;AAED,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gCAAgC;IAE/E;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,EAAE,UAAU,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAGzF;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAEpF"}

package/dist/fluidPackage.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAyDH;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAkC,EAAE,CACvE,OAAO,GAAG,KAAK,QAAQ;OACpB,QAAO,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;OAC7B,QAAO,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;AAHzB,QAAA,cAAc,kBAGW;AAyB/B,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAA0C,EAAE;IAC3F,MAAM,gBAAgB,GAAG,OAAiD,CAAC;IAC3E,OAAO,OAAO,gBAAgB,KAAK,QAAQ;WACpC,CAAC,QAAO,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAA,KAAK,QAAQ,IAAI,sBAAc,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC;WAC5F,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,SAAS,IAAI,QAAO,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,CAAC;AACpG,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEW,QAAA,yBAAyB,GAA2C,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n /**\n  * Specifies an environment on Fluid property of a IFluidPackage\n  */\nexport interface IFluidPackageEnvironment {\n\n    /**\n     * The name of the target. For a browser environment, this could be umd for scripts\n     * or css for styles.\n     */\n    [target: string]: undefined | {\n        /**\n         * List of files for the target. These can be relative or absolute.\n         * The code loader should resolve relative paths, and validate all\n         * full urls.\n         */\n        files: string[];\n\n        /**\n         * General access for extended fields as specific usages will\n         * likely have additional infornamation like a definition\n         * of Library, the entrypoint for umd packages\n         */\n        [key: string]: unknown;\n    }\n}\n\n/**\n * Fluid-specific properties expected on a package to be loaded by the code loader.\n * While compatible with the npm package format it is not necessary that that package is an\n * npm package:\n * https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid\n */\nexport interface IFluidPackage {\n    /**\n     * The name of the package that this code represnets\n     */\n    name: string;\n    /**\n     * This object represents the Fluid specific properties of the package\n     */\n    fluid: {\n        /**\n         * The name of the of the environment. This should be something like browser, or node\n         * and contain the necessary targets for loading this code in that environment.\n         */\n        [environment: string]:  undefined | IFluidPackageEnvironment;\n    };\n    /**\n     * General access for extended fields as specific usages will\n     * likely have additional infornamation like a definition of\n     * compatible versions, or deployment information like rings or rollouts.\n     */\n    [key: string]: unknown;\n}\n\n/**\n * Check if the package.json defines a Fluid package\n * @param pkg - the package json data to check if it is a Fluid package.\n */\nexport const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>\n    typeof pkg === \"object\"\n    && typeof pkg?.name === \"string\"\n    && typeof pkg?.fluid === \"object\";\n\n/**\n * Package manager configuration. Provides a key value mapping of config values\n */\nexport interface IFluidCodeDetailsConfig {\n    readonly [key: string]: string;\n}\n\n/**\n * Data structure used to describe the code to load on the Fluid document\n */\nexport interface IFluidCodeDetails {\n    /**\n     * The code package to be used on the Fluid document. This is either the package name which will be loaded\n     * from a package manager. Or the expanded Fluid package.\n     */\n    readonly package: string | Readonly<IFluidPackage>;\n\n    /**\n     * Configuration details. This includes links to the package manager and base CDNs.\n     */\n    readonly config?: IFluidCodeDetailsConfig;\n}\n\nexport const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> =>{\n    const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;\n    return typeof maybeCodeDetails === \"object\"\n        && (typeof maybeCodeDetails?.package === \"string\" || isFluidPackage(maybeCodeDetails?.package))\n        && (maybeCodeDetails?.config === undefined || typeof maybeCodeDetails?.config === \"object\");\n};\n\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\nexport interface IProvideFluidCodeDetailsComparer {\n    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * Provides capability to compare Fluid code details.\n */\nexport interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {\n\n    /**\n     * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.\n     *\n     * Similar semantics to:\n     *      https://github.com/npm/node-semver#usage\n     */\n    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;\n\n    /**\n     * Return a number representing the ascending sort order of the `a` and `b` code details;\n     *      `< 0` if `a < b`.\n     *      `= 0` if `a === b`.\n     *      `> 0` if `a > b`.\n     *      `undefined` if `a` is not comparable to `b`.\n     *\n     * Similar semantics to:\n     *      https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description\n     */\n    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;\n}\n"]}
+{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAyDH;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAkC,EAAE,CACvE,OAAO,GAAG,KAAK,QAAQ;OACpB,QAAO,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;OAC7B,QAAO,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;AAHzB,QAAA,cAAc,kBAGW;AAyB/B,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAA0C,EAAE;IAC3F,MAAM,gBAAgB,GAAG,OAAiD,CAAC;IAC3E,OAAO,OAAO,gBAAgB,KAAK,QAAQ;WACpC,CAAC,QAAO,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAA,KAAK,QAAQ,IAAI,sBAAc,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC;WAC5F,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,SAAS,IAAI,QAAO,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,CAAC;AACpG,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEW,QAAA,yBAAyB,GAA2C,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n /**\n  * Specifies an environment on Fluid property of a IFluidPackage\n  */\nexport interface IFluidPackageEnvironment {\n\n    /**\n     * The name of the target. For a browser environment, this could be umd for scripts\n     * or css for styles.\n     */\n    [target: string]: undefined | {\n        /**\n         * List of files for the target. These can be relative or absolute.\n         * The code loader should resolve relative paths, and validate all\n         * full urls.\n         */\n        files: string[];\n\n        /**\n         * General access for extended fields as specific usages will\n         * likely have additional infornamation like a definition\n         * of Library, the entrypoint for umd packages\n         */\n        [key: string]: unknown;\n    }\n}\n\n/**\n * Fluid-specific properties expected on a package to be loaded by the code loader.\n * While compatible with the npm package format it is not necessary that that package is an\n * npm package:\n * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}\n */\nexport interface IFluidPackage {\n    /**\n     * The name of the package that this code represnets\n     */\n    name: string;\n    /**\n     * This object represents the Fluid specific properties of the package\n     */\n    fluid: {\n        /**\n         * The name of the of the environment. This should be something like browser, or node\n         * and contain the necessary targets for loading this code in that environment.\n         */\n        [environment: string]:  undefined | IFluidPackageEnvironment;\n    };\n    /**\n     * General access for extended fields as specific usages will\n     * likely have additional infornamation like a definition of\n     * compatible versions, or deployment information like rings or rollouts.\n     */\n    [key: string]: unknown;\n}\n\n/**\n * Check if the package.json defines a Fluid package\n * @param pkg - the package json data to check if it is a Fluid package.\n */\nexport const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>\n    typeof pkg === \"object\"\n    && typeof pkg?.name === \"string\"\n    && typeof pkg?.fluid === \"object\";\n\n/**\n * Package manager configuration. Provides a key value mapping of config values\n */\nexport interface IFluidCodeDetailsConfig {\n    readonly [key: string]: string;\n}\n\n/**\n * Data structure used to describe the code to load on the Fluid document\n */\nexport interface IFluidCodeDetails {\n    /**\n     * The code package to be used on the Fluid document. This is either the package name which will be loaded\n     * from a package manager. Or the expanded Fluid package.\n     */\n    readonly package: string | Readonly<IFluidPackage>;\n\n    /**\n     * Configuration details. This includes links to the package manager and base CDNs.\n     */\n    readonly config?: IFluidCodeDetailsConfig;\n}\n\nexport const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> =>{\n    const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;\n    return typeof maybeCodeDetails === \"object\"\n        && (typeof maybeCodeDetails?.package === \"string\" || isFluidPackage(maybeCodeDetails?.package))\n        && (maybeCodeDetails?.config === undefined || typeof maybeCodeDetails?.config === \"object\");\n};\n\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\nexport interface IProvideFluidCodeDetailsComparer {\n    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * Provides capability to compare Fluid code details.\n */\nexport interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {\n\n    /**\n     * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.\n     *\n     * Similar semantics to:\n     * {@link https://github.com/npm/node-semver#usage}\n     */\n    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;\n\n/* eslint-disable max-len */\n    /**\n     * Return a number representing the ascending sort order of the `a` and `b` code details;\n     *      `< 0` if `a < b`.\n     *      `= 0` if `a === b`.\n     *      `> 0` if `a > b`.\n     *      `undefined` if `a` is not comparable to `b`.\n     *\n     * Similar semantics to:\n     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}\n     */\n    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;\n/* eslint-enable max-len */\n}\n"]}

package/dist/handles.d.ts

@@ -16,16 +16,16 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
     /**
      * The absolute path to the handle context from the root.
      */
-    absolutePath: string;
+    readonly absolutePath: string;
     /**
      * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
      * at the root.
      */
-    routeContext?: IFluidHandleContext;
+    readonly routeContext?: IFluidHandleContext;
     /**
      * Flag indicating whether or not the entity has services attached.
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
     /**
      * Runs through the graph and attach the bounded handles.
      */
@@ -45,11 +45,11 @@ export interface IFluidHandle<T = IFluidObject & IFluidLoadable> extends IProvid
      *
      * The absolute path to the handle context from the root.
      */
-    absolutePath: string;
+    readonly absolutePath: string;
     /**
      * Flag indicating whether or not the entity has services attached.
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
     /**
      * Runs through the graph and attach the bounded handles.
      */

package/dist/handles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handles.d.ts","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACxD;AAED,eAAO,MAAM,YAAY,EAAE,MAAM,mBAAoC,CAAC;AAEtE,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAEzB,CAAC,GAAG,YAAY,GAAG,cAAc,CAC/B,SAAQ,mBAAmB;IAE7B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;OAEG;IACH,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;CACpC"}
+{"version":3,"file":"handles.d.ts","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,mBAAmB,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACxD;AAED,eAAO,MAAM,YAAY,EAAE,MAAM,mBAAoC,CAAC;AAEtE,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAEzB,CAAC,GAAG,YAAY,GAAG,cAAc,CAC/B,SAAQ,mBAAmB;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;OAEG;IACH,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;CACpC"}

package/dist/handles.js.map

@@ -1 +1 @@
-{"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC9E,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IResponse } from \"./fluidRouter\";\nimport { IFluidObject } from \"./fluidObject\";\nimport { IFluidLoadable } from \"./fluidLoadable\";\n\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\nexport interface IProvideFluidHandleContext {\n    readonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n    /**\n     * The absolute path to the handle context from the root.\n     */\n    absolutePath: string;\n\n    /**\n     * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n     * at the root.\n     */\n    routeContext?: IFluidHandleContext;\n\n    /**\n     * Flag indicating whether or not the entity has services attached.\n     */\n    isAttached: boolean;\n\n    /**\n     * Runs through the graph and attach the bounded handles.\n     */\n    attachGraph(): void;\n\n    resolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\nexport interface IProvideFluidHandle {\n    readonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared FluidObject\n */\nexport interface IFluidHandle<\n    // REVIEW: Constrain `T` to `IFluidObject & IFluidLoadable`?\n    T = IFluidObject & IFluidLoadable\n    > extends IProvideFluidHandle {\n\n    /**\n     * @deprecated - Do not use handle's path for routing. Use `get` to get the underlying object.\n     *\n     * The absolute path to the handle context from the root.\n     */\n    absolutePath: string;\n\n    /**\n     * Flag indicating whether or not the entity has services attached.\n     */\n    isAttached: boolean;\n\n    /**\n     * Runs through the graph and attach the bounded handles.\n     */\n    attachGraph(): void;\n\n    /**\n     * Returns a promise to the Fluid Object referenced by the handle.\n     */\n    get(): Promise<T>;\n\n    /**\n     * Binds the given handle to this one or attach the given handle if this handle is attached.\n     * A bound handle will also be attached once this handle is attached.\n     */\n    bind(handle: IFluidHandle): void;\n}\n"]}
+{"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC9E,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IResponse } from \"./fluidRouter\";\nimport { IFluidObject } from \"./fluidObject\";\nimport { IFluidLoadable } from \"./fluidLoadable\";\n\nexport const IFluidHandleContext: keyof IProvideFluidHandleContext = \"IFluidHandleContext\";\n\nexport interface IProvideFluidHandleContext {\n    readonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined\n */\nexport interface IFluidHandleContext extends IProvideFluidHandleContext {\n    /**\n     * The absolute path to the handle context from the root.\n     */\n    readonly absolutePath: string;\n\n    /**\n     * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined\n     * at the root.\n     */\n    readonly routeContext?: IFluidHandleContext;\n\n    /**\n     * Flag indicating whether or not the entity has services attached.\n     */\n    readonly isAttached: boolean;\n\n    /**\n     * Runs through the graph and attach the bounded handles.\n     */\n    attachGraph(): void;\n\n    resolveHandle(request: IRequest): Promise<IResponse>;\n}\n\nexport const IFluidHandle: keyof IProvideFluidHandle = \"IFluidHandle\";\n\nexport interface IProvideFluidHandle {\n    readonly IFluidHandle: IFluidHandle;\n}\n\n/**\n * Handle to a shared FluidObject\n */\nexport interface IFluidHandle<\n    // REVIEW: Constrain `T` to `IFluidObject & IFluidLoadable`?\n    T = IFluidObject & IFluidLoadable\n    > extends IProvideFluidHandle {\n\n    /**\n     * @deprecated - Do not use handle's path for routing. Use `get` to get the underlying object.\n     *\n     * The absolute path to the handle context from the root.\n     */\n    readonly absolutePath: string;\n\n    /**\n     * Flag indicating whether or not the entity has services attached.\n     */\n    readonly isAttached: boolean;\n\n    /**\n     * Runs through the graph and attach the bounded handles.\n     */\n    attachGraph(): void;\n\n    /**\n     * Returns a promise to the Fluid Object referenced by the handle.\n     */\n    get(): Promise<T>;\n\n    /**\n     * Binds the given handle to this one or attach the given handle if this handle is attached.\n     * A bound handle will also be attached once this handle is attached.\n     */\n    bind(handle: IFluidHandle): void;\n}\n"]}

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export { IRequest, IRequestHeader, IResponse, IProvideFluidRouter, IFluidRouter,
 export * from "./handles";
 export * from "./serializer";
 export * from "./fluidPackage";
+export * from "./provider";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,cAAc,iBAAiB,CAAC;AAIhC,OAAO,EACH,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACf,MAAM,eAAe,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,cAAc,iBAAiB,CAAC;AAIhC,OAAO,EACH,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACf,MAAM,eAAe,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -24,4 +24,5 @@ Object.defineProperty(exports, "IFluidRouter", { enumerable: true, get: function
 __exportStar(require("./handles"), exports);
 __exportStar(require("./serializer"), exports);
 __exportStar(require("./fluidPackage"), exports);
+__exportStar(require("./provider"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAMH,kDAAgC;AAChC,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,6CAMuB;AADnB,2GAAA,YAAY,OAAA;AAEhB,4CAA0B;AAC1B,+CAA6B;AAC7B,iDAA+B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// when merging declarations the module path must match exactly. Because of this we need to explicitly export\n// IFluidObject as opposed to an export *\nexport { IFluidObject } from \"./fluidObject\";\n\nexport * from \"./fluidLoadable\";\n// Typescript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n    IRequest,\n    IRequestHeader,\n    IResponse,\n    IProvideFluidRouter,\n    IFluidRouter,\n} from \"./fluidRouter\";\nexport * from \"./handles\";\nexport * from \"./serializer\";\nexport * from \"./fluidPackage\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAMH,kDAAgC;AAChC,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,6CAMuB;AADnB,2GAAA,YAAY,OAAA;AAEhB,4CAA0B;AAC1B,+CAA6B;AAC7B,iDAA+B;AAC/B,6CAA2B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// when merging declarations the module path must match exactly. Because of this we need to explicitly export\n// IFluidObject as opposed to an export *\nexport { IFluidObject } from \"./fluidObject\";\n\nexport * from \"./fluidLoadable\";\n// Typescript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n    IRequest,\n    IRequestHeader,\n    IResponse,\n    IProvideFluidRouter,\n    IFluidRouter,\n} from \"./fluidRouter\";\nexport * from \"./handles\";\nexport * from \"./serializer\";\nexport * from \"./fluidPackage\";\nexport * from \"./provider\";\n"]}

package/dist/provider.d.ts

@@ -0,0 +1,64 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * @internal
+ * This utility type is meant for internal use by @see FluidObject
+ * Produces a valid FluidObject key given a type and a property.
+ * A valid FluidObject key is a property that exists on the incoming type
+ * as well as on the type of the property itself. For example, IProvideFoo.IFoo.IFoo
+ * This aligns with the FluidObject pattern expected to be used with all FluidObjects.
+ * For example:
+ * ```
+ * interface IProvideFoo{
+ *  IFoo: IFoo
+ * }
+ * interface IFoo extends IProvideFoo{
+ *  foobar();
+ * }
+ * ```
+ * This pattern enables discovery, and delegation in a standard way which is central
+ * to FluidObject pattern
+ */
+export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Exclude<T[TProp], undefined> ? TProp : never;
+/**
+ * This utility type take interface(s) that follow the FluidObject pattern, and produces
+ * a new type that can be used for inspection and discovery of those interfaces.
+ *
+ * It is meant to be used with types that are known to implement the FluidObject pattern.
+ * A common way to specify a type implements the FluidObject pattern is to expose it as a
+ * FluidObject without a generic argument.
+ *
+ * For example, if we have an interface like below
+ * ```
+ * interface IProvideFoo{
+ *  IFoo: IFoo
+ * }
+ * interface IFoo extends IProvideFoo{
+ *  foobar();
+ * }
+ * ```
+ *
+ * and a function that returns a FluidObject. You would do the following
+ *
+ * `const maybeFoo: FluidObject<IFoo> = getFluidObject()`;
+ *
+ * Either IFoo or IProvideFoo are valid generic arguments. In both case
+ * maybeFoo will be of type `{IFoo?: IFoo}`. If IFoo is not undefined,
+ * then the FluidObject provides IFoo, and it can be used.
+ *
+ * You can inspect multiple types via a intersection. For example:
+ * `FluidObject<IFoo & IBar>`
+ *
+ */
+export declare type FluidObject<T = unknown> = Partial<Pick<T, FluidObjectProviderKeys<T>>>;
+/**
+ * This utility type creates a type that is the union of all keys on the generic type
+ * which implement the FluidObject pattern. @see FluidObject
+ *
+ * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
+ *
+ */
+export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACF,oBAAY,uBAAuB,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IACnE,MAAM,SAAS,KAAK,GAAG,KAAK,GAAG,MAAM,SAAS,KAAK,GAAE,KAAK,GAC1D,KAAK,SAAS,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,GAC1C,KAAK,GACN,KAAK,CAAC;AAEf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACF,oBAAY,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAErF;;;;;;GAMG;AACH,oBAAY,eAAe,CAAC,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC"}

package/dist/provider.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @internal\n * This utility type is meant for internal use by @see FluidObject\n * Produces a valid FluidObject key given a type and a property.\n * A valid FluidObject key is a property that exists on the incoming type\n * as well as on the type of the property itself. For example, IProvideFoo.IFoo.IFoo\n * This aligns with the FluidObject pattern expected to be used with all FluidObjects.\n * For example:\n * ```\n * interface IProvideFoo{\n *  IFoo: IFoo\n * }\n * interface IFoo extends IProvideFoo{\n *  foobar();\n * }\n * ```\n * This pattern enables discovery, and delegation in a standard way which is central\n * to FluidObject pattern\n */\n export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> =\n    string extends TProp ? never : number extends TProp? never : // exclude indexers [key:string |number]: any\n    TProp extends keyof Exclude<T[TProp], undefined> // TProp is a property of T, and T[TProp]\n        ? TProp\n        :never;\n\n/**\n * This utility type take interface(s) that follow the FluidObject pattern, and produces\n * a new type that can be used for inspection and discovery of those interfaces.\n *\n * It is meant to be used with types that are known to implement the FluidObject pattern.\n * A common way to specify a type implements the FluidObject pattern is to expose it as a\n * FluidObject without a generic argument.\n *\n * For example, if we have an interface like below\n * ```\n * interface IProvideFoo{\n *  IFoo: IFoo\n * }\n * interface IFoo extends IProvideFoo{\n *  foobar();\n * }\n * ```\n *\n * and a function that returns a FluidObject. You would do the following\n *\n * `const maybeFoo: FluidObject<IFoo> = getFluidObject()`;\n *\n * Either IFoo or IProvideFoo are valid generic arguments. In both case\n * maybeFoo will be of type `{IFoo?: IFoo}`. If IFoo is not undefined,\n * then the FluidObject provides IFoo, and it can be used.\n *\n * You can inspect multiple types via a intersection. For example:\n * `FluidObject<IFoo & IBar>`\n *\n */\n export type FluidObject<T = unknown> = Partial<Pick<T, FluidObjectProviderKeys<T>>>;\n\n/**\n * This utility type creates a type that is the union of all keys on the generic type\n * which implement the FluidObject pattern. @see FluidObject\n *\n * For example `FluidObjectKeys<IFoo & IBar>` would result in `\"IFoo\" | \"IBar\"`\n *\n */\nexport type FluidObjectKeys<T> = keyof FluidObject<T>;\n"]}

package/dist/serializer.d.ts

@@ -23,6 +23,16 @@ export interface IFluidSerializer extends IProvideFluidSerializer {
      * the root to any replaced handles.  (If no handles are found, returns the original object.)
      */
     replaceHandles(value: 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;
     /**
      * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
      */

package/dist/serializer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAE9B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,gBAAgB,EAAE,MAAM,uBAA4C,CAAC;AAElF,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CAC/C;AAED,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC7D;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAEpD;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B"}
+{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAE9B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,gBAAgB,EAAE,MAAM,uBAA4C,CAAC;AAElF,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CAC/C;AAED,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC7D;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,GAAG,CAAC;IAEpD;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B"}

package/dist/serializer.js.map

@@ -1 +1 @@
-{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";;;AAiBa,QAAA,gBAAgB,GAAkC,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IFluidHandle } from \"./handles\";\n\n/**\n * JSON serialized form of an IFluidHandle\n */\nexport interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\nexport const IFluidSerializer: keyof IProvideFluidSerializer = \"IFluidSerializer\";\n\nexport interface IProvideFluidSerializer {\n    readonly IFluidSerializer: IFluidSerializer;\n}\n\nexport interface IFluidSerializer extends IProvideFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * 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    replaceHandles(value: any, bind: IFluidHandle): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n"]}
+{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";;;AAiBa,QAAA,gBAAgB,GAAkC,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IFluidHandle } from \"./handles\";\n\n/**\n * JSON serialized form of an IFluidHandle\n */\nexport interface ISerializedHandle {\n    // Marker to indicate to JSON.parse that the object is a Fluid handle\n    type: \"__fluid_handle__\";\n\n    // URL to the object. Relative URLs are relative to the handle context passed to the stringify.\n    url: string;\n}\n\nexport const IFluidSerializer: keyof IProvideFluidSerializer = \"IFluidSerializer\";\n\nexport interface IProvideFluidSerializer {\n    readonly IFluidSerializer: IFluidSerializer;\n}\n\nexport interface IFluidSerializer extends IProvideFluidSerializer {\n    /**\n     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object\n     * 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    replaceHandles(value: any, bind: IFluidHandle): any;\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    decode?(input: any): any;\n\n    /**\n     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.\n     */\n    stringify(value: any, bind: IFluidHandle): string;\n\n    /**\n     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid\n     * handles will be realized as part of the parse\n     */\n    parse(value: string): any;\n}\n"]}