@fluidframework/core-interfaces 2.0.0-internal.1.2.0.93071 → 2.0.0-internal.1.2.1

package/dist/fluidPackage.d.ts

@@ -126,11 +126,15 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
      */
     satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
     /**
-     * Return a number representing the ascending sort order of the `a` and `b` code details;
-     *      `< 0` if `a < b`.
-     *      `= 0` if `a === b`.
-     *      `> 0` if `a > b`.
-     *      `undefined` if `a` is not comparable to `b`.
+     * Returns a number representing the ascending sort order of the `a` and `b` code details:
+     *
+     * - `< 0` if `a < b`.
+     *
+     * - `= 0` if `a === b`.
+     *
+     * - `> 0` if `a > b`.
+     *
+     * - `undefined` if `a` is not comparable to `b`.
      *
      * Similar semantics to:
      * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}

package/dist/fluidPackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;;;;GAKG;AACJ,MAAM,WAAW,wBAAwB;IACrC;;;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,CAAC;CACL;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,wBAAwB,CAAC;KAC/D,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;;;;GAKG;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;;;EAGE;AACF,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF;;;EAGE;AACF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G;;;EAGE;AACF,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;;;;GAKG;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"}
+{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;;;;GAKG;AACJ,MAAM,WAAW,wBAAwB;IACrC;;;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,CAAC;CACL;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,wBAAwB,CAAC;KAC/D,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;;;;GAKG;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;;;EAGE;AACF,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF;;;EAGE;AACF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G;;;EAGE;AACF,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;;;;GAKG;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;;;;;;;;;;;;;OAaG;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;;;AA8DH;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAkC,EAAE,CACvE,OAAO,GAAG,KAAK,QAAQ;OACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;OAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;AAHzB,QAAA,cAAc,kBAGW;AA+BtC;;;EAGE;AACK,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAA0C,EAAE;IAC3F,MAAM,gBAAgB,GAAG,OAAiD,CAAC;IAC3E,OAAO,OAAO,gBAAgB,KAAK,QAAQ;WACpC,CAAC,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAA,KAAK,QAAQ,IAAI,IAAA,sBAAc,EAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC;WAC5F,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,SAAS,IAAI,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,CAAC;AACpG,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEF;;;EAGE;AACW,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 an {@link IFluidPackage}.\n  *\n  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}\n  * to have code loading modules in same package.\n  */\nexport interface IFluidPackageEnvironment {\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 *\n * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}\n * to have code loading modules in same package.\n *\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport interface IProvideFluidCodeDetailsComparer {\n    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * Provides capability to compare Fluid code details.\n *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\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"]}
+{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA8DH;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAkC,EAAE,CACvE,OAAO,GAAG,KAAK,QAAQ;OACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;OAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;AAHzB,QAAA,cAAc,kBAGW;AA+BtC;;;EAGE;AACK,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAA0C,EAAE;IAC3F,MAAM,gBAAgB,GAAG,OAAiD,CAAC;IAC3E,OAAO,OAAO,gBAAgB,KAAK,QAAQ;WACpC,CAAC,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAA,KAAK,QAAQ,IAAI,IAAA,sBAAc,EAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC;WAC5F,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,SAAS,IAAI,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,CAAC;AACpG,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEF;;;EAGE;AACW,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 an {@link IFluidPackage}.\n  *\n  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}\n  * to have code loading modules in same package.\n  */\nexport interface IFluidPackageEnvironment {\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 *\n * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}\n * to have code loading modules in same package.\n *\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport interface IProvideFluidCodeDetailsComparer {\n    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * Provides capability to compare Fluid code details.\n *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\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     * Returns a number representing the ascending sort order of the `a` and `b` code details:\n     *\n     * - `< 0` if `a < b`.\n     *\n     * - `= 0` if `a === b`.\n     *\n     * - `> 0` if `a > b`.\n     *\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/lib/fluidPackage.d.ts

@@ -126,11 +126,15 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
      */
     satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
     /**
-     * Return a number representing the ascending sort order of the `a` and `b` code details;
-     *      `< 0` if `a < b`.
-     *      `= 0` if `a === b`.
-     *      `> 0` if `a > b`.
-     *      `undefined` if `a` is not comparable to `b`.
+     * Returns a number representing the ascending sort order of the `a` and `b` code details:
+     *
+     * - `< 0` if `a < b`.
+     *
+     * - `= 0` if `a === b`.
+     *
+     * - `> 0` if `a > b`.
+     *
+     * - `undefined` if `a` is not comparable to `b`.
      *
      * Similar semantics to:
      * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}

package/lib/fluidPackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;;;;GAKG;AACJ,MAAM,WAAW,wBAAwB;IACrC;;;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,CAAC;CACL;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,wBAAwB,CAAC;KAC/D,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;;;;GAKG;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;;;EAGE;AACF,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF;;;EAGE;AACF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G;;;EAGE;AACF,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;;;;GAKG;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"}
+{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF;;;;;GAKG;AACJ,MAAM,WAAW,wBAAwB;IACrC;;;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,CAAC;CACL;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE;QACH;;;WAGG;QACH,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,wBAAwB,CAAC;KAC/D,CAAC;IACF;;;;OAIG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;;;;GAKG;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;;;EAGE;AACF,eAAO,MAAM,kBAAkB,YAAa,OAAO,2CAKlD,CAAC;AAEF;;;EAGE;AACF,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCAA8D,CAAC;AAE7G;;;EAGE;AACF,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;;;;GAKG;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;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAEpF"}

package/lib/fluidPackage.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8DH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAkC,EAAE,CACvE,OAAO,GAAG,KAAK,QAAQ;OACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;OAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;AA+BtC;;;EAGE;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAA0C,EAAE;IAC3F,MAAM,gBAAgB,GAAG,OAAiD,CAAC;IAC3E,OAAO,OAAO,gBAAgB,KAAK,QAAQ;WACpC,CAAC,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAA,KAAK,QAAQ,IAAI,cAAc,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC;WAC5F,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,SAAS,IAAI,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,CAAC;AACpG,CAAC,CAAC;AAEF;;;EAGE;AACF,MAAM,CAAC,MAAM,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 an {@link IFluidPackage}.\n  *\n  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}\n  * to have code loading modules in same package.\n  */\nexport interface IFluidPackageEnvironment {\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 *\n * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}\n * to have code loading modules in same package.\n *\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport interface IProvideFluidCodeDetailsComparer {\n    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * Provides capability to compare Fluid code details.\n *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\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"]}
+{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8DH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAkC,EAAE,CACvE,OAAO,GAAG,KAAK,QAAQ;OACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;OAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;AA+BtC;;;EAGE;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAA0C,EAAE;IAC3F,MAAM,gBAAgB,GAAG,OAAiD,CAAC;IAC3E,OAAO,OAAO,gBAAgB,KAAK,QAAQ;WACpC,CAAC,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAA,KAAK,QAAQ,IAAI,cAAc,CAAC,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC;WAC5F,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,SAAS,IAAI,OAAO,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,CAAC;AACpG,CAAC,CAAC;AAEF;;;EAGE;AACF,MAAM,CAAC,MAAM,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 an {@link IFluidPackage}.\n  *\n  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}\n  * to have code loading modules in same package.\n  */\nexport interface IFluidPackageEnvironment {\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 *\n * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}\n * to have code loading modules in same package.\n *\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}\n * to have code loading modules in same package.\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 *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport interface IProvideFluidCodeDetailsComparer {\n    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * Provides capability to compare Fluid code details.\n *\n * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\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     * Returns a number representing the ascending sort order of the `a` and `b` code details:\n     *\n     * - `< 0` if `a < b`.\n     *\n     * - `= 0` if `a === b`.\n     *\n     * - `> 0` if `a > b`.\n     *\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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-internal.1.2.0.93071",
+  "version": "2.0.0-internal.1.2.1",
   "description": "Fluid object interfaces",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -40,7 +40,7 @@
     "@fluidframework/build-common": "^1.0.0",
     "@fluidframework/build-tools": "^0.4.4000",
     "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@^1.1.0",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",

package/src/fluidPackage.ts

@@ -148,11 +148,15 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
 
 /* eslint-disable max-len */
     /**
-     * Return a number representing the ascending sort order of the `a` and `b` code details;
-     *      `< 0` if `a < b`.
-     *      `= 0` if `a === b`.
-     *      `> 0` if `a > b`.
-     *      `undefined` if `a` is not comparable to `b`.
+     * Returns a number representing the ascending sort order of the `a` and `b` code details:
+     *
+     * - `< 0` if `a < b`.
+     *
+     * - `= 0` if `a === b`.
+     *
+     * - `> 0` if `a > b`.
+     *
+     * - `undefined` if `a` is not comparable to `b`.
      *
      * Similar semantics to:
      * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}