@fluidframework/core-interfaces 2.0.0-internal.1.1.2 → 2.0.0-internal.1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/fluidPackage.d.ts +27 -16
- package/dist/fluidPackage.d.ts.map +1 -1
- package/dist/fluidPackage.js +5 -3
- package/dist/fluidPackage.js.map +1 -1
- package/dist/handles.d.ts +1 -1
- package/dist/handles.js.map +1 -1
- package/lib/fluidPackage.d.ts +27 -16
- package/lib/fluidPackage.d.ts.map +1 -1
- package/lib/fluidPackage.js +5 -3
- package/lib/fluidPackage.js.map +1 -1
- package/lib/handles.d.ts +1 -1
- package/lib/handles.js.map +1 -1
- package/package.json +4 -5
- package/src/fluidPackage.ts +27 -16
- package/src/handles.ts +1 -1
package/dist/fluidPackage.d.ts
CHANGED
|
@@ -3,9 +3,10 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Specifies an environment on Fluid property of an {@link IFluidPackage}.
|
|
7
|
+
*
|
|
8
|
+
* @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
|
|
7
9
|
* to have code loading modules in same package.
|
|
8
|
-
* Specifies an environment on Fluid property of a IFluidPackage
|
|
9
10
|
*/
|
|
10
11
|
export interface IFluidPackageEnvironment {
|
|
11
12
|
/**
|
|
@@ -28,12 +29,13 @@ export interface IFluidPackageEnvironment {
|
|
|
28
29
|
};
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
|
-
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackage}
|
|
32
|
-
* to have code loading modules in same package.
|
|
33
32
|
* Fluid-specific properties expected on a package to be loaded by the code loader.
|
|
34
33
|
* While compatible with the npm package format it is not necessary that that package is an
|
|
35
34
|
* npm package:
|
|
36
35
|
* {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
|
|
36
|
+
*
|
|
37
|
+
* @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
|
|
38
|
+
* to have code loading modules in same package.
|
|
37
39
|
*/
|
|
38
40
|
export interface IFluidPackage {
|
|
39
41
|
/**
|
|
@@ -58,24 +60,28 @@ export interface IFluidPackage {
|
|
|
58
60
|
[key: string]: unknown;
|
|
59
61
|
}
|
|
60
62
|
/**
|
|
63
|
+
* Check if the package.json defines a Fluid package.
|
|
64
|
+
*
|
|
61
65
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
|
|
62
66
|
* to have code loading modules in same package.
|
|
63
|
-
*
|
|
64
|
-
* @param pkg -
|
|
67
|
+
*
|
|
68
|
+
* @param pkg - The package json data to check if it is a Fluid package.
|
|
65
69
|
*/
|
|
66
70
|
export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
|
|
67
71
|
/**
|
|
72
|
+
* Package manager configuration. Provides a key value mapping of config values.
|
|
73
|
+
*
|
|
68
74
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
|
|
69
75
|
* to have code loading modules in same package.
|
|
70
|
-
* Package manager configuration. Provides a key value mapping of config values
|
|
71
76
|
*/
|
|
72
77
|
export interface IFluidCodeDetailsConfig {
|
|
73
78
|
readonly [key: string]: string;
|
|
74
79
|
}
|
|
75
80
|
/**
|
|
81
|
+
* Data structure used to describe the code to load on the Fluid document.
|
|
82
|
+
*
|
|
76
83
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
|
|
77
84
|
* to have code loading modules in same package.
|
|
78
|
-
* Data structure used to describe the code to load on the Fluid document
|
|
79
85
|
*/
|
|
80
86
|
export interface IFluidCodeDetails {
|
|
81
87
|
/**
|
|
@@ -90,7 +96,7 @@ export interface IFluidCodeDetails {
|
|
|
90
96
|
}
|
|
91
97
|
/**
|
|
92
98
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
|
|
93
|
-
* to have code loading modules in same package
|
|
99
|
+
* to have code loading modules in same package.
|
|
94
100
|
*/
|
|
95
101
|
export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
|
|
96
102
|
/**
|
|
@@ -106,9 +112,10 @@ export interface IProvideFluidCodeDetailsComparer {
|
|
|
106
112
|
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
107
113
|
}
|
|
108
114
|
/**
|
|
115
|
+
* Provides capability to compare Fluid code details.
|
|
116
|
+
*
|
|
109
117
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
|
|
110
118
|
* to have code loading modules in same package.
|
|
111
|
-
* Provides capability to compare Fluid code details.
|
|
112
119
|
*/
|
|
113
120
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
114
121
|
/**
|
|
@@ -119,14 +126,18 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
|
|
|
119
126
|
*/
|
|
120
127
|
satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
|
|
121
128
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
129
|
+
* Returns a number representing the ascending sort order of the `a` and `b` code details:
|
|
130
|
+
*
|
|
131
|
+
* - `< 0` if `a < b`.
|
|
132
|
+
*
|
|
133
|
+
* - `= 0` if `a === b`.
|
|
134
|
+
*
|
|
135
|
+
* - `> 0` if `a > b`.
|
|
136
|
+
*
|
|
137
|
+
* - `undefined` if `a` is not comparable to `b`.
|
|
127
138
|
*
|
|
128
139
|
* Similar semantics to:
|
|
129
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#
|
|
140
|
+
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
|
|
130
141
|
*/
|
|
131
142
|
compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
|
|
132
143
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF
|
|
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;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAEpF"}
|
package/dist/fluidPackage.js
CHANGED
|
@@ -6,10 +6,12 @@
|
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
7
|
exports.IFluidCodeDetailsComparer = exports.isFluidCodeDetails = exports.isFluidPackage = void 0;
|
|
8
8
|
/**
|
|
9
|
+
* Check if the package.json defines a Fluid package.
|
|
10
|
+
*
|
|
9
11
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
|
|
10
12
|
* to have code loading modules in same package.
|
|
11
|
-
*
|
|
12
|
-
* @param pkg -
|
|
13
|
+
*
|
|
14
|
+
* @param pkg - The package json data to check if it is a Fluid package.
|
|
13
15
|
*/
|
|
14
16
|
const isFluidPackage = (pkg) => typeof pkg === "object"
|
|
15
17
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.name) === "string"
|
|
@@ -17,7 +19,7 @@ const isFluidPackage = (pkg) => typeof pkg === "object"
|
|
|
17
19
|
exports.isFluidPackage = isFluidPackage;
|
|
18
20
|
/**
|
|
19
21
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
|
|
20
|
-
* to have code loading modules in same package
|
|
22
|
+
* to have code loading modules in same package.
|
|
21
23
|
*/
|
|
22
24
|
const isFluidCodeDetails = (details) => {
|
|
23
25
|
const maybeCodeDetails = details;
|
package/dist/fluidPackage.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
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 * 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/dist/handles.d.ts
CHANGED
|
@@ -41,7 +41,7 @@ export interface IProvideFluidHandle {
|
|
|
41
41
|
*/
|
|
42
42
|
export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
|
|
43
43
|
/**
|
|
44
|
-
* @deprecated
|
|
44
|
+
* @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
|
|
45
45
|
*
|
|
46
46
|
* The absolute path to the handle context from the root.
|
|
47
47
|
*/
|
package/dist/handles.js.map
CHANGED
|
@@ -1 +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 { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\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 something? How do we support dds and datastores safely?\n T = FluidObject & IFluidLoadable,\n > extends IProvideFluidHandle {\n\n /**\n * @deprecated
|
|
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 { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\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 something? How do we support dds and datastores safely?\n T = FluidObject & 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/lib/fluidPackage.d.ts
CHANGED
|
@@ -3,9 +3,10 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Specifies an environment on Fluid property of an {@link IFluidPackage}.
|
|
7
|
+
*
|
|
8
|
+
* @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
|
|
7
9
|
* to have code loading modules in same package.
|
|
8
|
-
* Specifies an environment on Fluid property of a IFluidPackage
|
|
9
10
|
*/
|
|
10
11
|
export interface IFluidPackageEnvironment {
|
|
11
12
|
/**
|
|
@@ -28,12 +29,13 @@ export interface IFluidPackageEnvironment {
|
|
|
28
29
|
};
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
|
-
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackage}
|
|
32
|
-
* to have code loading modules in same package.
|
|
33
32
|
* Fluid-specific properties expected on a package to be loaded by the code loader.
|
|
34
33
|
* While compatible with the npm package format it is not necessary that that package is an
|
|
35
34
|
* npm package:
|
|
36
35
|
* {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
|
|
36
|
+
*
|
|
37
|
+
* @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
|
|
38
|
+
* to have code loading modules in same package.
|
|
37
39
|
*/
|
|
38
40
|
export interface IFluidPackage {
|
|
39
41
|
/**
|
|
@@ -58,24 +60,28 @@ export interface IFluidPackage {
|
|
|
58
60
|
[key: string]: unknown;
|
|
59
61
|
}
|
|
60
62
|
/**
|
|
63
|
+
* Check if the package.json defines a Fluid package.
|
|
64
|
+
*
|
|
61
65
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
|
|
62
66
|
* to have code loading modules in same package.
|
|
63
|
-
*
|
|
64
|
-
* @param pkg -
|
|
67
|
+
*
|
|
68
|
+
* @param pkg - The package json data to check if it is a Fluid package.
|
|
65
69
|
*/
|
|
66
70
|
export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
|
|
67
71
|
/**
|
|
72
|
+
* Package manager configuration. Provides a key value mapping of config values.
|
|
73
|
+
*
|
|
68
74
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
|
|
69
75
|
* to have code loading modules in same package.
|
|
70
|
-
* Package manager configuration. Provides a key value mapping of config values
|
|
71
76
|
*/
|
|
72
77
|
export interface IFluidCodeDetailsConfig {
|
|
73
78
|
readonly [key: string]: string;
|
|
74
79
|
}
|
|
75
80
|
/**
|
|
81
|
+
* Data structure used to describe the code to load on the Fluid document.
|
|
82
|
+
*
|
|
76
83
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
|
|
77
84
|
* to have code loading modules in same package.
|
|
78
|
-
* Data structure used to describe the code to load on the Fluid document
|
|
79
85
|
*/
|
|
80
86
|
export interface IFluidCodeDetails {
|
|
81
87
|
/**
|
|
@@ -90,7 +96,7 @@ export interface IFluidCodeDetails {
|
|
|
90
96
|
}
|
|
91
97
|
/**
|
|
92
98
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
|
|
93
|
-
* to have code loading modules in same package
|
|
99
|
+
* to have code loading modules in same package.
|
|
94
100
|
*/
|
|
95
101
|
export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
|
|
96
102
|
/**
|
|
@@ -106,9 +112,10 @@ export interface IProvideFluidCodeDetailsComparer {
|
|
|
106
112
|
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
107
113
|
}
|
|
108
114
|
/**
|
|
115
|
+
* Provides capability to compare Fluid code details.
|
|
116
|
+
*
|
|
109
117
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
|
|
110
118
|
* to have code loading modules in same package.
|
|
111
|
-
* Provides capability to compare Fluid code details.
|
|
112
119
|
*/
|
|
113
120
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
114
121
|
/**
|
|
@@ -119,14 +126,18 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
|
|
|
119
126
|
*/
|
|
120
127
|
satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
|
|
121
128
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
129
|
+
* Returns a number representing the ascending sort order of the `a` and `b` code details:
|
|
130
|
+
*
|
|
131
|
+
* - `< 0` if `a < b`.
|
|
132
|
+
*
|
|
133
|
+
* - `= 0` if `a === b`.
|
|
134
|
+
*
|
|
135
|
+
* - `> 0` if `a > b`.
|
|
136
|
+
*
|
|
137
|
+
* - `undefined` if `a` is not comparable to `b`.
|
|
127
138
|
*
|
|
128
139
|
* Similar semantics to:
|
|
129
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#
|
|
140
|
+
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
|
|
130
141
|
*/
|
|
131
142
|
compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
|
|
132
143
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidPackage.d.ts","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEF
|
|
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;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAEpF"}
|
package/lib/fluidPackage.js
CHANGED
|
@@ -3,17 +3,19 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
+
* Check if the package.json defines a Fluid package.
|
|
7
|
+
*
|
|
6
8
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
|
|
7
9
|
* to have code loading modules in same package.
|
|
8
|
-
*
|
|
9
|
-
* @param pkg -
|
|
10
|
+
*
|
|
11
|
+
* @param pkg - The package json data to check if it is a Fluid package.
|
|
10
12
|
*/
|
|
11
13
|
export const isFluidPackage = (pkg) => typeof pkg === "object"
|
|
12
14
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.name) === "string"
|
|
13
15
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.fluid) === "object";
|
|
14
16
|
/**
|
|
15
17
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
|
|
16
|
-
* to have code loading modules in same package
|
|
18
|
+
* to have code loading modules in same package.
|
|
17
19
|
*/
|
|
18
20
|
export const isFluidCodeDetails = (details) => {
|
|
19
21
|
const maybeCodeDetails = details;
|
package/lib/fluidPackage.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidPackage.js","sourceRoot":"","sources":["../src/fluidPackage.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
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 * 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/handles.d.ts
CHANGED
|
@@ -41,7 +41,7 @@ export interface IProvideFluidHandle {
|
|
|
41
41
|
*/
|
|
42
42
|
export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
|
|
43
43
|
/**
|
|
44
|
-
* @deprecated
|
|
44
|
+
* @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
|
|
45
45
|
*
|
|
46
46
|
* The absolute path to the handle context from the root.
|
|
47
47
|
*/
|
package/lib/handles.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC3F,MAAM,CAAC,MAAM,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 { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\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 something? How do we support dds and datastores safely?\n T = FluidObject & IFluidLoadable,\n > extends IProvideFluidHandle {\n\n /**\n * @deprecated
|
|
1
|
+
{"version":3,"file":"handles.js","sourceRoot":"","sources":["../src/handles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC;AAkC3F,MAAM,CAAC,MAAM,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 { IFluidLoadable } from \"./fluidLoadable\";\nimport { FluidObject } from \"./provider\";\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 something? How do we support dds and datastores safely?\n T = FluidObject & 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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/core-interfaces",
|
|
3
|
-
"version": "2.0.0-internal.1.
|
|
3
|
+
"version": "2.0.0-internal.1.2.0",
|
|
4
4
|
"description": "Fluid object interfaces",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -30,7 +30,6 @@
|
|
|
30
30
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
31
31
|
"lint": "npm run eslint",
|
|
32
32
|
"lint:fix": "npm run eslint:fix",
|
|
33
|
-
"test": "npm run test:types",
|
|
34
33
|
"tsc": "tsc",
|
|
35
34
|
"tsc:watch": "tsc --watch",
|
|
36
35
|
"tsfmt": "tsfmt --verify",
|
|
@@ -38,10 +37,10 @@
|
|
|
38
37
|
"typetests:gen": "fluid-type-validator -g -d ."
|
|
39
38
|
},
|
|
40
39
|
"devDependencies": {
|
|
41
|
-
"@fluidframework/build-common": "^0.
|
|
42
|
-
"@fluidframework/build-tools": "^0.
|
|
40
|
+
"@fluidframework/build-common": "^1.0.0",
|
|
41
|
+
"@fluidframework/build-tools": "^0.4.4000",
|
|
43
42
|
"@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@^1.1.0",
|
|
44
|
-
"@fluidframework/eslint-config-fluid": "^0.
|
|
43
|
+
"@fluidframework/eslint-config-fluid": "^1.0.0",
|
|
45
44
|
"@microsoft/api-extractor": "^7.22.2",
|
|
46
45
|
"@rushstack/eslint-config": "^2.5.1",
|
|
47
46
|
"@types/node": "^14.18.0",
|
package/src/fluidPackage.ts
CHANGED
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Specifies an environment on Fluid property of an {@link IFluidPackage}.
|
|
8
|
+
*
|
|
9
|
+
* @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
|
|
8
10
|
* to have code loading modules in same package.
|
|
9
|
-
* Specifies an environment on Fluid property of a IFluidPackage
|
|
10
11
|
*/
|
|
11
12
|
export interface IFluidPackageEnvironment {
|
|
12
13
|
/**
|
|
@@ -31,12 +32,13 @@ export interface IFluidPackageEnvironment {
|
|
|
31
32
|
}
|
|
32
33
|
|
|
33
34
|
/**
|
|
34
|
-
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackage}
|
|
35
|
-
* to have code loading modules in same package.
|
|
36
35
|
* Fluid-specific properties expected on a package to be loaded by the code loader.
|
|
37
36
|
* While compatible with the npm package format it is not necessary that that package is an
|
|
38
37
|
* npm package:
|
|
39
38
|
* {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
|
|
39
|
+
*
|
|
40
|
+
* @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
|
|
41
|
+
* to have code loading modules in same package.
|
|
40
42
|
*/
|
|
41
43
|
export interface IFluidPackage {
|
|
42
44
|
/**
|
|
@@ -62,10 +64,12 @@ export interface IFluidPackage {
|
|
|
62
64
|
}
|
|
63
65
|
|
|
64
66
|
/**
|
|
67
|
+
* Check if the package.json defines a Fluid package.
|
|
68
|
+
*
|
|
65
69
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
|
|
66
70
|
* to have code loading modules in same package.
|
|
67
|
-
*
|
|
68
|
-
* @param pkg -
|
|
71
|
+
*
|
|
72
|
+
* @param pkg - The package json data to check if it is a Fluid package.
|
|
69
73
|
*/
|
|
70
74
|
export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
|
|
71
75
|
typeof pkg === "object"
|
|
@@ -73,18 +77,20 @@ export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
|
|
|
73
77
|
&& typeof pkg?.fluid === "object";
|
|
74
78
|
|
|
75
79
|
/**
|
|
80
|
+
* Package manager configuration. Provides a key value mapping of config values.
|
|
81
|
+
*
|
|
76
82
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
|
|
77
83
|
* to have code loading modules in same package.
|
|
78
|
-
* Package manager configuration. Provides a key value mapping of config values
|
|
79
84
|
*/
|
|
80
85
|
export interface IFluidCodeDetailsConfig {
|
|
81
86
|
readonly [key: string]: string;
|
|
82
87
|
}
|
|
83
88
|
|
|
84
89
|
/**
|
|
90
|
+
* Data structure used to describe the code to load on the Fluid document.
|
|
91
|
+
*
|
|
85
92
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
|
|
86
93
|
* to have code loading modules in same package.
|
|
87
|
-
* Data structure used to describe the code to load on the Fluid document
|
|
88
94
|
*/
|
|
89
95
|
export interface IFluidCodeDetails {
|
|
90
96
|
/**
|
|
@@ -101,7 +107,7 @@ export interface IFluidCodeDetails {
|
|
|
101
107
|
|
|
102
108
|
/**
|
|
103
109
|
* @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
|
|
104
|
-
* to have code loading modules in same package
|
|
110
|
+
* to have code loading modules in same package.
|
|
105
111
|
*/
|
|
106
112
|
export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> => {
|
|
107
113
|
const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;
|
|
@@ -125,9 +131,10 @@ export interface IProvideFluidCodeDetailsComparer {
|
|
|
125
131
|
}
|
|
126
132
|
|
|
127
133
|
/**
|
|
134
|
+
* Provides capability to compare Fluid code details.
|
|
135
|
+
*
|
|
128
136
|
* @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
|
|
129
137
|
* to have code loading modules in same package.
|
|
130
|
-
* Provides capability to compare Fluid code details.
|
|
131
138
|
*/
|
|
132
139
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
133
140
|
|
|
@@ -141,14 +148,18 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
|
|
|
141
148
|
|
|
142
149
|
/* eslint-disable max-len */
|
|
143
150
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
151
|
+
* Returns a number representing the ascending sort order of the `a` and `b` code details:
|
|
152
|
+
*
|
|
153
|
+
* - `< 0` if `a < b`.
|
|
154
|
+
*
|
|
155
|
+
* - `= 0` if `a === b`.
|
|
156
|
+
*
|
|
157
|
+
* - `> 0` if `a > b`.
|
|
158
|
+
*
|
|
159
|
+
* - `undefined` if `a` is not comparable to `b`.
|
|
149
160
|
*
|
|
150
161
|
* Similar semantics to:
|
|
151
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#
|
|
162
|
+
* {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
|
|
152
163
|
*/
|
|
153
164
|
compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
|
|
154
165
|
/* eslint-enable max-len */
|
package/src/handles.ts
CHANGED
|
@@ -56,7 +56,7 @@ export interface IFluidHandle<
|
|
|
56
56
|
> extends IProvideFluidHandle {
|
|
57
57
|
|
|
58
58
|
/**
|
|
59
|
-
* @deprecated
|
|
59
|
+
* @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
|
|
60
60
|
*
|
|
61
61
|
* The absolute path to the handle context from the root.
|
|
62
62
|
*/
|