@fluidframework/core-interfaces 0.41.0 → 0.43.1000-60265
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/.eslintrc.js +1 -1
- package/api-report/core-interfaces.api.md +13 -30
- package/dist/fluidLoadable.d.ts +0 -7
- package/dist/fluidLoadable.d.ts.map +1 -1
- package/dist/fluidLoadable.js +1 -2
- package/dist/fluidLoadable.js.map +1 -1
- package/dist/fluidObject.d.ts +1 -5
- package/dist/fluidObject.d.ts.map +1 -1
- package/dist/fluidObject.js.map +1 -1
- package/dist/fluidPackage.d.ts +25 -0
- package/dist/fluidPackage.d.ts.map +1 -1
- package/dist/fluidPackage.js +10 -0
- package/dist/fluidPackage.js.map +1 -1
- package/dist/serializer.d.ts +10 -0
- package/dist/serializer.d.ts.map +1 -1
- package/dist/serializer.js +3 -0
- package/dist/serializer.js.map +1 -1
- package/lib/fluidLoadable.d.ts +0 -7
- package/lib/fluidLoadable.d.ts.map +1 -1
- package/lib/fluidLoadable.js +0 -1
- package/lib/fluidLoadable.js.map +1 -1
- package/lib/fluidObject.d.ts +1 -5
- package/lib/fluidObject.d.ts.map +1 -1
- package/lib/fluidObject.js.map +1 -1
- package/lib/fluidPackage.d.ts +25 -0
- package/lib/fluidPackage.d.ts.map +1 -1
- package/lib/fluidPackage.js +10 -0
- package/lib/fluidPackage.js.map +1 -1
- package/lib/serializer.d.ts +10 -0
- package/lib/serializer.d.ts.map +1 -1
- package/lib/serializer.js +3 -0
- package/lib/serializer.js.map +1 -1
- package/lib/test/types/fluidObjectTypes.d.ts +2 -0
- package/lib/test/types/fluidObjectTypes.d.ts.map +1 -0
- package/lib/test/types/fluidObjectTypes.js +80 -0
- package/lib/test/types/fluidObjectTypes.js.map +1 -0
- package/lib/test/types/validate0.39.8.js +6 -6
- package/lib/test/types/validate0.39.8.js.map +1 -1
- package/lib/test/types/validate0.40.0.js +6 -6
- package/lib/test/types/validate0.40.0.js.map +1 -1
- package/lib/test/types/validate0.41.0.d.ts +2 -0
- package/lib/test/types/validate0.41.0.d.ts.map +1 -0
- package/lib/test/types/validate0.41.0.js +78 -0
- package/lib/test/types/validate0.41.0.js.map +1 -0
- package/lib/test/types/validate0.42.0.d.ts +2 -0
- package/lib/test/types/validate0.42.0.d.ts.map +1 -0
- package/lib/test/types/validate0.42.0.js +78 -0
- package/lib/test/types/validate0.42.0.js.map +1 -0
- package/package.json +79 -20
- package/src/fluidLoadable.ts +0 -10
- package/src/fluidObject.ts +0 -5
- package/src/fluidPackage.ts +26 -2
- package/src/serializer.ts +10 -0
- package/test-d/index.test-d.ts +0 -103
package/.eslintrc.js
CHANGED
|
@@ -17,36 +17,27 @@ export type FluidObjectKeys<T> = keyof FluidObject<T>;
|
|
|
17
17
|
// @internal
|
|
18
18
|
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;
|
|
19
19
|
|
|
20
|
-
// @public
|
|
20
|
+
// @public @deprecated (undocumented)
|
|
21
21
|
export interface IFluidCodeDetails {
|
|
22
22
|
readonly config?: IFluidCodeDetailsConfig;
|
|
23
23
|
readonly package: string | Readonly<IFluidPackage>;
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
// @public (undocumented)
|
|
26
|
+
// @public @deprecated (undocumented)
|
|
27
27
|
export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
|
|
28
28
|
|
|
29
|
-
// @public
|
|
29
|
+
// @public @deprecated (undocumented)
|
|
30
30
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
31
31
|
compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
|
|
32
32
|
satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
|
|
33
33
|
}
|
|
34
34
|
|
|
35
|
-
// @public
|
|
35
|
+
// @public @deprecated (undocumented)
|
|
36
36
|
export interface IFluidCodeDetailsConfig {
|
|
37
37
|
// (undocumented)
|
|
38
38
|
readonly [key: string]: string;
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
-
// @public (undocumented)
|
|
42
|
-
export const IFluidConfiguration: keyof IProvideFluidConfiguration;
|
|
43
|
-
|
|
44
|
-
// @public (undocumented)
|
|
45
|
-
export interface IFluidConfiguration extends IProvideFluidConfiguration {
|
|
46
|
-
// (undocumented)
|
|
47
|
-
scopes: string[];
|
|
48
|
-
}
|
|
49
|
-
|
|
50
41
|
// @public (undocumented)
|
|
51
42
|
export const IFluidHandle: keyof IProvideFluidHandle;
|
|
52
43
|
|
|
@@ -84,8 +75,6 @@ export interface IFluidLoadable extends IProvideFluidLoadable {
|
|
|
84
75
|
|
|
85
76
|
// @public @deprecated (undocumented)
|
|
86
77
|
export interface IFluidObject {
|
|
87
|
-
// @deprecated (undocumented)
|
|
88
|
-
readonly IFluidConfiguration?: IFluidConfiguration;
|
|
89
78
|
// @deprecated (undocumented)
|
|
90
79
|
readonly IFluidHandle?: IFluidHandle;
|
|
91
80
|
// @deprecated (undocumented)
|
|
@@ -100,7 +89,7 @@ export interface IFluidObject {
|
|
|
100
89
|
readonly IFluidSerializer?: IFluidSerializer;
|
|
101
90
|
}
|
|
102
91
|
|
|
103
|
-
// @public
|
|
92
|
+
// @public @deprecated (undocumented)
|
|
104
93
|
export interface IFluidPackage {
|
|
105
94
|
[key: string]: unknown;
|
|
106
95
|
fluid: {
|
|
@@ -109,7 +98,7 @@ export interface IFluidPackage {
|
|
|
109
98
|
name: string;
|
|
110
99
|
}
|
|
111
100
|
|
|
112
|
-
// @public
|
|
101
|
+
// @public @deprecated (undocumented)
|
|
113
102
|
export interface IFluidPackageEnvironment {
|
|
114
103
|
[target: string]: undefined | {
|
|
115
104
|
files: string[];
|
|
@@ -137,10 +126,10 @@ export interface IFluidRunnable {
|
|
|
137
126
|
stop(reason?: string): void;
|
|
138
127
|
}
|
|
139
128
|
|
|
140
|
-
// @public (undocumented)
|
|
129
|
+
// @public @deprecated (undocumented)
|
|
141
130
|
export const IFluidSerializer: keyof IProvideFluidSerializer;
|
|
142
131
|
|
|
143
|
-
// @public (undocumented)
|
|
132
|
+
// @public @deprecated (undocumented)
|
|
144
133
|
export interface IFluidSerializer extends IProvideFluidSerializer {
|
|
145
134
|
decode?(input: any): any;
|
|
146
135
|
parse(value: string): any;
|
|
@@ -148,18 +137,12 @@ export interface IFluidSerializer extends IProvideFluidSerializer {
|
|
|
148
137
|
stringify(value: any, bind: IFluidHandle): string;
|
|
149
138
|
}
|
|
150
139
|
|
|
151
|
-
// @public (undocumented)
|
|
140
|
+
// @public @deprecated (undocumented)
|
|
152
141
|
export interface IProvideFluidCodeDetailsComparer {
|
|
153
142
|
// (undocumented)
|
|
154
143
|
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
155
144
|
}
|
|
156
145
|
|
|
157
|
-
// @public (undocumented)
|
|
158
|
-
export interface IProvideFluidConfiguration {
|
|
159
|
-
// (undocumented)
|
|
160
|
-
readonly IFluidConfiguration: IFluidConfiguration;
|
|
161
|
-
}
|
|
162
|
-
|
|
163
146
|
// @public (undocumented)
|
|
164
147
|
export interface IProvideFluidHandle {
|
|
165
148
|
// (undocumented)
|
|
@@ -190,7 +173,7 @@ export interface IProvideFluidRunnable {
|
|
|
190
173
|
readonly IFluidRunnable: IFluidRunnable;
|
|
191
174
|
}
|
|
192
175
|
|
|
193
|
-
// @public (undocumented)
|
|
176
|
+
// @public @deprecated (undocumented)
|
|
194
177
|
export interface IProvideFluidSerializer {
|
|
195
178
|
// (undocumented)
|
|
196
179
|
readonly IFluidSerializer: IFluidSerializer;
|
|
@@ -226,7 +209,7 @@ export interface IResponse {
|
|
|
226
209
|
value: any;
|
|
227
210
|
}
|
|
228
211
|
|
|
229
|
-
// @public
|
|
212
|
+
// @public @deprecated
|
|
230
213
|
export interface ISerializedHandle {
|
|
231
214
|
// (undocumented)
|
|
232
215
|
type: "__fluid_handle__";
|
|
@@ -234,10 +217,10 @@ export interface ISerializedHandle {
|
|
|
234
217
|
url: string;
|
|
235
218
|
}
|
|
236
219
|
|
|
237
|
-
// @public (undocumented)
|
|
220
|
+
// @public @deprecated (undocumented)
|
|
238
221
|
export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
|
|
239
222
|
|
|
240
|
-
// @public
|
|
223
|
+
// @public @deprecated (undocumented)
|
|
241
224
|
export const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
|
|
242
225
|
|
|
243
226
|
|
package/dist/fluidLoadable.d.ts
CHANGED
|
@@ -21,11 +21,4 @@ export interface IFluidRunnable {
|
|
|
21
21
|
run(...args: any[]): Promise<void>;
|
|
22
22
|
stop(reason?: string): void;
|
|
23
23
|
}
|
|
24
|
-
export declare const IFluidConfiguration: keyof IProvideFluidConfiguration;
|
|
25
|
-
export interface IProvideFluidConfiguration {
|
|
26
|
-
readonly IFluidConfiguration: IFluidConfiguration;
|
|
27
|
-
}
|
|
28
|
-
export interface IFluidConfiguration extends IProvideFluidConfiguration {
|
|
29
|
-
scopes: string[];
|
|
30
|
-
}
|
|
31
24
|
//# sourceMappingURL=fluidLoadable.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAEzD,MAAM,EAAE,YAAY,CAAC;CACxB;AAED,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD,MAAM,WAAW,cAAc;IAC3B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B
|
|
1
|
+
{"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAEzD,MAAM,EAAE,YAAY,CAAC;CACxB;AAED,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD,MAAM,WAAW,cAAc;IAC3B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B"}
|
package/dist/fluidLoadable.js
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.
|
|
7
|
+
exports.IFluidRunnable = exports.IFluidLoadable = void 0;
|
|
8
8
|
exports.IFluidLoadable = "IFluidLoadable";
|
|
9
9
|
exports.IFluidRunnable = "IFluidRunnable";
|
|
10
|
-
exports.IFluidConfiguration = "IFluidConfiguration";
|
|
11
10
|
//# sourceMappingURL=fluidLoadable.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIU,QAAA,cAAc,GAAgC,gBAAgB,CAAC;AAa/D,QAAA,cAAc,GAAgC,gBAAgB,CAAC
|
|
1
|
+
{"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIU,QAAA,cAAc,GAAgC,gBAAgB,CAAC;AAa/D,QAAA,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"./handles\";\n\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\nexport interface IProvideFluidLoadable {\n readonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared FluidObject has a URL from which it can be referenced\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n // Handle to the loadable FluidObject\n handle: IFluidHandle;\n}\n\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\nexport interface IProvideFluidRunnable {\n readonly IFluidRunnable: IFluidRunnable;\n}\nexport interface IFluidRunnable {\n run(...args: any[]): Promise<void>;\n stop(reason?: string): void;\n}\n"]}
|
package/dist/fluidObject.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import {
|
|
5
|
+
import { IFluidLoadable, IFluidRunnable } from "./fluidLoadable";
|
|
6
6
|
import { IFluidRouter } from "./fluidRouter";
|
|
7
7
|
import { IFluidHandle, IFluidHandleContext } from "./handles";
|
|
8
8
|
import { IFluidSerializer } from "./serializer";
|
|
@@ -26,10 +26,6 @@ export interface IFluidObject {
|
|
|
26
26
|
* @deprecated - use `FluidObject<IFluidHandleContext>` instead
|
|
27
27
|
*/
|
|
28
28
|
readonly IFluidHandleContext?: IFluidHandleContext;
|
|
29
|
-
/**
|
|
30
|
-
* @deprecated - use `FluidObject<IFluidConfiguration>` instead
|
|
31
|
-
*/
|
|
32
|
-
readonly IFluidConfiguration?: IFluidConfiguration;
|
|
33
29
|
/**
|
|
34
30
|
* @deprecated - use `FluidObject<IFluidHandle>` instead
|
|
35
31
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidObject.d.ts","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,
|
|
1
|
+
{"version":3,"file":"fluidObject.d.ts","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,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,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAChD"}
|
package/dist/fluidObject.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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
|
|
1
|
+
{"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 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<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
CHANGED
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackageEnvironment}
|
|
7
|
+
* to have code loading modules in same package.
|
|
6
8
|
* Specifies an environment on Fluid property of a IFluidPackage
|
|
7
9
|
*/
|
|
8
10
|
export interface IFluidPackageEnvironment {
|
|
@@ -26,6 +28,8 @@ export interface IFluidPackageEnvironment {
|
|
|
26
28
|
};
|
|
27
29
|
}
|
|
28
30
|
/**
|
|
31
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackage}
|
|
32
|
+
* to have code loading modules in same package.
|
|
29
33
|
* Fluid-specific properties expected on a package to be loaded by the code loader.
|
|
30
34
|
* While compatible with the npm package format it is not necessary that that package is an
|
|
31
35
|
* npm package:
|
|
@@ -54,17 +58,23 @@ export interface IFluidPackage {
|
|
|
54
58
|
[key: string]: unknown;
|
|
55
59
|
}
|
|
56
60
|
/**
|
|
61
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage}
|
|
62
|
+
* to have code loading modules in same package.
|
|
57
63
|
* Check if the package.json defines a Fluid package
|
|
58
64
|
* @param pkg - the package json data to check if it is a Fluid package.
|
|
59
65
|
*/
|
|
60
66
|
export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
|
|
61
67
|
/**
|
|
68
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsConfig}
|
|
69
|
+
* to have code loading modules in same package.
|
|
62
70
|
* Package manager configuration. Provides a key value mapping of config values
|
|
63
71
|
*/
|
|
64
72
|
export interface IFluidCodeDetailsConfig {
|
|
65
73
|
readonly [key: string]: string;
|
|
66
74
|
}
|
|
67
75
|
/**
|
|
76
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetails}
|
|
77
|
+
* to have code loading modules in same package.
|
|
68
78
|
* Data structure used to describe the code to load on the Fluid document
|
|
69
79
|
*/
|
|
70
80
|
export interface IFluidCodeDetails {
|
|
@@ -78,12 +88,27 @@ export interface IFluidCodeDetails {
|
|
|
78
88
|
*/
|
|
79
89
|
readonly config?: IFluidCodeDetailsConfig;
|
|
80
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidCodeDetails}
|
|
93
|
+
* to have code loading modules in same package
|
|
94
|
+
*/
|
|
81
95
|
export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
|
|
96
|
+
/**
|
|
97
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
|
|
98
|
+
* to have code loading modules in same package.
|
|
99
|
+
*/
|
|
82
100
|
export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
|
|
101
|
+
/**
|
|
102
|
+
* @deprecated in favor of
|
|
103
|
+
* {@link @fluidframework/container-definitions/fluidPackage.ts#IProvideFluidCodeDetailsComparer}
|
|
104
|
+
* to have code loading modules in same package.
|
|
105
|
+
*/
|
|
83
106
|
export interface IProvideFluidCodeDetailsComparer {
|
|
84
107
|
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
85
108
|
}
|
|
86
109
|
/**
|
|
110
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
|
|
111
|
+
* to have code loading modules in same package.
|
|
87
112
|
* Provides capability to compare Fluid code details.
|
|
88
113
|
*/
|
|
89
114
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
@@ -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;;;;GAIG;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,CAAA;CACJ;AAED;;;;;;;GAOG;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;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;;;GAIG;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;;;;EAIE;AACF,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;;;GAIG;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
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
7
|
exports.IFluidCodeDetailsComparer = exports.isFluidCodeDetails = exports.isFluidPackage = void 0;
|
|
8
8
|
/**
|
|
9
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage}
|
|
10
|
+
* to have code loading modules in same package.
|
|
9
11
|
* Check if the package.json defines a Fluid package
|
|
10
12
|
* @param pkg - the package json data to check if it is a Fluid package.
|
|
11
13
|
*/
|
|
@@ -13,6 +15,10 @@ const isFluidPackage = (pkg) => typeof pkg === "object"
|
|
|
13
15
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.name) === "string"
|
|
14
16
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.fluid) === "object";
|
|
15
17
|
exports.isFluidPackage = isFluidPackage;
|
|
18
|
+
/**
|
|
19
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidCodeDetails}
|
|
20
|
+
* to have code loading modules in same package
|
|
21
|
+
*/
|
|
16
22
|
const isFluidCodeDetails = (details) => {
|
|
17
23
|
const maybeCodeDetails = details;
|
|
18
24
|
return typeof maybeCodeDetails === "object"
|
|
@@ -20,5 +26,9 @@ const isFluidCodeDetails = (details) => {
|
|
|
20
26
|
&& ((maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.config) === undefined || typeof (maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.config) === "object");
|
|
21
27
|
};
|
|
22
28
|
exports.isFluidCodeDetails = isFluidCodeDetails;
|
|
29
|
+
/**
|
|
30
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
|
|
31
|
+
* to have code loading modules in same package.
|
|
32
|
+
*/
|
|
23
33
|
exports.IFluidCodeDetailsComparer = "IFluidCodeDetailsComparer";
|
|
24
34
|
//# sourceMappingURL=fluidPackage.js.map
|
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;;;AA4DH;;;;;GAKG;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;AA6BtC;;;EAGE;AACK,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;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 * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackageEnvironment}\n * to have code loading modules in same package.\n * Specifies an environment on Fluid property of a IFluidPackage\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 * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackage}\n * to have code loading modules in same package.\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 * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage}\n * to have code loading modules in same package.\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 * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsConfig}\n * to have code loading modules in same package.\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 * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetails}\n * to have code loading modules in same package.\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\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#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/fluidPackage.ts#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = \"IFluidCodeDetailsComparer\";\n\n/**\n * @deprecated in favor of\n * {@link @fluidframework/container-definitions/fluidPackage.ts#IProvideFluidCodeDetailsComparer}\n * to have code loading modules in same package.\n*/\nexport interface IProvideFluidCodeDetailsComparer {\n readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;\n}\n\n/**\n * @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}\n * to have code loading modules in same package.\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/serializer.d.ts
CHANGED
|
@@ -5,15 +5,25 @@
|
|
|
5
5
|
import { IFluidHandle } from "./handles";
|
|
6
6
|
/**
|
|
7
7
|
* JSON serialized form of an IFluidHandle
|
|
8
|
+
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
8
9
|
*/
|
|
9
10
|
export interface ISerializedHandle {
|
|
10
11
|
type: "__fluid_handle__";
|
|
11
12
|
url: string;
|
|
12
13
|
}
|
|
14
|
+
/**
|
|
15
|
+
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
16
|
+
*/
|
|
13
17
|
export declare const IFluidSerializer: keyof IProvideFluidSerializer;
|
|
18
|
+
/**
|
|
19
|
+
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
20
|
+
*/
|
|
14
21
|
export interface IProvideFluidSerializer {
|
|
15
22
|
readonly IFluidSerializer: IFluidSerializer;
|
|
16
23
|
}
|
|
24
|
+
/**
|
|
25
|
+
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
26
|
+
*/
|
|
17
27
|
export interface IFluidSerializer extends IProvideFluidSerializer {
|
|
18
28
|
/**
|
|
19
29
|
* Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
|
package/dist/serializer.d.ts.map
CHANGED
|
@@ -1 +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
|
|
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;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAE9B,IAAI,EAAE,kBAAkB,CAAC;IAGzB,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,uBAA4C,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CAC/C;AAED;;GAEG;AACH,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
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.IFluidSerializer = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
6
|
+
*/
|
|
4
7
|
exports.IFluidSerializer = "IFluidSerializer";
|
|
5
8
|
//# sourceMappingURL=serializer.js.map
|
package/dist/serializer.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":";;;AAkBA;;GAEG;AACU,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 * @deprecated - Moved to fluidframework/shared-object-base package\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\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport const IFluidSerializer: keyof IProvideFluidSerializer = \"IFluidSerializer\";\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\n */\nexport interface IProvideFluidSerializer {\n readonly IFluidSerializer: IFluidSerializer;\n}\n\n/**\n * @deprecated - Moved to fluidframework/shared-object-base package\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"]}
|
package/lib/fluidLoadable.d.ts
CHANGED
|
@@ -21,11 +21,4 @@ export interface IFluidRunnable {
|
|
|
21
21
|
run(...args: any[]): Promise<void>;
|
|
22
22
|
stop(reason?: string): void;
|
|
23
23
|
}
|
|
24
|
-
export declare const IFluidConfiguration: keyof IProvideFluidConfiguration;
|
|
25
|
-
export interface IProvideFluidConfiguration {
|
|
26
|
-
readonly IFluidConfiguration: IFluidConfiguration;
|
|
27
|
-
}
|
|
28
|
-
export interface IFluidConfiguration extends IProvideFluidConfiguration {
|
|
29
|
-
scopes: string[];
|
|
30
|
-
}
|
|
31
24
|
//# sourceMappingURL=fluidLoadable.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAEzD,MAAM,EAAE,YAAY,CAAC;CACxB;AAED,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD,MAAM,WAAW,cAAc;IAC3B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B
|
|
1
|
+
{"version":3,"file":"fluidLoadable.d.ts","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAEzD,MAAM,EAAE,YAAY,CAAC;CACxB;AAED,eAAO,MAAM,cAAc,EAAE,MAAM,qBAAwC,CAAC;AAE5E,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CAC3C;AACD,MAAM,WAAW,cAAc;IAC3B,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B"}
|
package/lib/fluidLoadable.js
CHANGED
package/lib/fluidLoadable.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC;AAa5E,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC
|
|
1
|
+
{"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC;AAa5E,MAAM,CAAC,MAAM,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"./handles\";\n\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\nexport interface IProvideFluidLoadable {\n readonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared FluidObject has a URL from which it can be referenced\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n // Handle to the loadable FluidObject\n handle: IFluidHandle;\n}\n\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\nexport interface IProvideFluidRunnable {\n readonly IFluidRunnable: IFluidRunnable;\n}\nexport interface IFluidRunnable {\n run(...args: any[]): Promise<void>;\n stop(reason?: string): void;\n}\n"]}
|
package/lib/fluidObject.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import {
|
|
5
|
+
import { IFluidLoadable, IFluidRunnable } from "./fluidLoadable";
|
|
6
6
|
import { IFluidRouter } from "./fluidRouter";
|
|
7
7
|
import { IFluidHandle, IFluidHandleContext } from "./handles";
|
|
8
8
|
import { IFluidSerializer } from "./serializer";
|
|
@@ -26,10 +26,6 @@ export interface IFluidObject {
|
|
|
26
26
|
* @deprecated - use `FluidObject<IFluidHandleContext>` instead
|
|
27
27
|
*/
|
|
28
28
|
readonly IFluidHandleContext?: IFluidHandleContext;
|
|
29
|
-
/**
|
|
30
|
-
* @deprecated - use `FluidObject<IFluidConfiguration>` instead
|
|
31
|
-
*/
|
|
32
|
-
readonly IFluidConfiguration?: IFluidConfiguration;
|
|
33
29
|
/**
|
|
34
30
|
* @deprecated - use `FluidObject<IFluidHandle>` instead
|
|
35
31
|
*/
|
package/lib/fluidObject.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidObject.d.ts","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,
|
|
1
|
+
{"version":3,"file":"fluidObject.d.ts","sourceRoot":"","sources":["../src/fluidObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,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,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAChD"}
|
package/lib/fluidObject.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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
|
|
1
|
+
{"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 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<IFluidHandle>` instead\n */\n readonly IFluidHandle?: IFluidHandle;\n /**\n * @deprecated - use `FluidObject<IFluidSerializer>` instead\n */\n readonly IFluidSerializer?: IFluidSerializer;\n}\n"]}
|
package/lib/fluidPackage.d.ts
CHANGED
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackageEnvironment}
|
|
7
|
+
* to have code loading modules in same package.
|
|
6
8
|
* Specifies an environment on Fluid property of a IFluidPackage
|
|
7
9
|
*/
|
|
8
10
|
export interface IFluidPackageEnvironment {
|
|
@@ -26,6 +28,8 @@ export interface IFluidPackageEnvironment {
|
|
|
26
28
|
};
|
|
27
29
|
}
|
|
28
30
|
/**
|
|
31
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidPackage}
|
|
32
|
+
* to have code loading modules in same package.
|
|
29
33
|
* Fluid-specific properties expected on a package to be loaded by the code loader.
|
|
30
34
|
* While compatible with the npm package format it is not necessary that that package is an
|
|
31
35
|
* npm package:
|
|
@@ -54,17 +58,23 @@ export interface IFluidPackage {
|
|
|
54
58
|
[key: string]: unknown;
|
|
55
59
|
}
|
|
56
60
|
/**
|
|
61
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage}
|
|
62
|
+
* to have code loading modules in same package.
|
|
57
63
|
* Check if the package.json defines a Fluid package
|
|
58
64
|
* @param pkg - the package json data to check if it is a Fluid package.
|
|
59
65
|
*/
|
|
60
66
|
export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
|
|
61
67
|
/**
|
|
68
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsConfig}
|
|
69
|
+
* to have code loading modules in same package.
|
|
62
70
|
* Package manager configuration. Provides a key value mapping of config values
|
|
63
71
|
*/
|
|
64
72
|
export interface IFluidCodeDetailsConfig {
|
|
65
73
|
readonly [key: string]: string;
|
|
66
74
|
}
|
|
67
75
|
/**
|
|
76
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetails}
|
|
77
|
+
* to have code loading modules in same package.
|
|
68
78
|
* Data structure used to describe the code to load on the Fluid document
|
|
69
79
|
*/
|
|
70
80
|
export interface IFluidCodeDetails {
|
|
@@ -78,12 +88,27 @@ export interface IFluidCodeDetails {
|
|
|
78
88
|
*/
|
|
79
89
|
readonly config?: IFluidCodeDetailsConfig;
|
|
80
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidCodeDetails}
|
|
93
|
+
* to have code loading modules in same package
|
|
94
|
+
*/
|
|
81
95
|
export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
|
|
96
|
+
/**
|
|
97
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
|
|
98
|
+
* to have code loading modules in same package.
|
|
99
|
+
*/
|
|
82
100
|
export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
|
|
101
|
+
/**
|
|
102
|
+
* @deprecated in favor of
|
|
103
|
+
* {@link @fluidframework/container-definitions/fluidPackage.ts#IProvideFluidCodeDetailsComparer}
|
|
104
|
+
* to have code loading modules in same package.
|
|
105
|
+
*/
|
|
83
106
|
export interface IProvideFluidCodeDetailsComparer {
|
|
84
107
|
readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
|
|
85
108
|
}
|
|
86
109
|
/**
|
|
110
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
|
|
111
|
+
* to have code loading modules in same package.
|
|
87
112
|
* Provides capability to compare Fluid code details.
|
|
88
113
|
*/
|
|
89
114
|
export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
|
|
@@ -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;;;;GAIG;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,CAAA;CACJ;AAED;;;;;;;GAOG;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;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAAS,GAAG,mCAGF,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC;AAED;;;;GAIG;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;;;;EAIE;AACF,MAAM,WAAW,gCAAgC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAE;CAClE;AAED;;;;GAIG;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/lib/fluidPackage.js
CHANGED
|
@@ -3,17 +3,27 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage}
|
|
7
|
+
* to have code loading modules in same package.
|
|
6
8
|
* Check if the package.json defines a Fluid package
|
|
7
9
|
* @param pkg - the package json data to check if it is a Fluid package.
|
|
8
10
|
*/
|
|
9
11
|
export const isFluidPackage = (pkg) => typeof pkg === "object"
|
|
10
12
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.name) === "string"
|
|
11
13
|
&& typeof (pkg === null || pkg === void 0 ? void 0 : pkg.fluid) === "object";
|
|
14
|
+
/**
|
|
15
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#isFluidCodeDetails}
|
|
16
|
+
* to have code loading modules in same package
|
|
17
|
+
*/
|
|
12
18
|
export const isFluidCodeDetails = (details) => {
|
|
13
19
|
const maybeCodeDetails = details;
|
|
14
20
|
return typeof maybeCodeDetails === "object"
|
|
15
21
|
&& (typeof (maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.package) === "string" || isFluidPackage(maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.package))
|
|
16
22
|
&& ((maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.config) === undefined || typeof (maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.config) === "object");
|
|
17
23
|
};
|
|
24
|
+
/**
|
|
25
|
+
* @deprecated in favor of {@link @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer}
|
|
26
|
+
* to have code loading modules in same package.
|
|
27
|
+
*/
|
|
18
28
|
export const IFluidCodeDetailsComparer = "IFluidCodeDetailsComparer";
|
|
19
29
|
//# sourceMappingURL=fluidPackage.js.map
|