@fluidframework/core-interfaces 0.43.1000 → 1.0.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/api-extractor.json +1 -9
- package/dist/fluidObject.d.ts +0 -28
- package/dist/fluidObject.d.ts.map +1 -1
- package/dist/fluidObject.js.map +1 -1
- package/dist/fluidPackage.d.ts.map +1 -1
- package/dist/fluidPackage.js +1 -1
- package/dist/fluidPackage.js.map +1 -1
- package/dist/fluidRouter.d.ts.map +1 -1
- package/dist/fluidRouter.js.map +1 -1
- package/dist/handles.js.map +1 -1
- package/dist/index.d.ts +0 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -1
- package/dist/index.js.map +1 -1
- package/lib/fluidObject.d.ts +0 -28
- package/lib/fluidObject.d.ts.map +1 -1
- package/lib/fluidObject.js.map +1 -1
- package/lib/fluidPackage.d.ts.map +1 -1
- package/lib/fluidPackage.js.map +1 -1
- package/lib/fluidRouter.d.ts.map +1 -1
- package/lib/fluidRouter.js.map +1 -1
- package/lib/handles.js.map +1 -1
- package/lib/index.d.ts +0 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +0 -1
- package/lib/index.js.map +1 -1
- package/lib/test/types/fluidObjectTypes.js.map +1 -1
- package/lib/test/types/validateCoreInterfacesPrevious.js +0 -14
- package/lib/test/types/validateCoreInterfacesPrevious.js.map +1 -1
- package/package.json +28 -36
- package/src/fluidObject.ts +1 -32
- package/src/fluidPackage.ts +2 -2
- package/src/fluidRouter.ts +1 -1
- package/src/handles.ts +1 -1
- package/src/index.ts +0 -1
- package/api-report/core-interfaces.api.md +0 -231
- package/dist/serializer.d.ts +0 -56
- package/dist/serializer.d.ts.map +0 -1
- package/dist/serializer.js +0 -8
- package/dist/serializer.js.map +0 -1
- package/lib/serializer.d.ts +0 -56
- package/lib/serializer.d.ts.map +0 -1
- package/lib/serializer.js +0 -5
- package/lib/serializer.js.map +0 -1
- package/src/serializer.ts +0 -65
package/dist/serializer.d.ts
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import { IFluidHandle } from "./handles";
|
|
6
|
-
/**
|
|
7
|
-
* JSON serialized form of an IFluidHandle
|
|
8
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
9
|
-
*/
|
|
10
|
-
export interface ISerializedHandle {
|
|
11
|
-
type: "__fluid_handle__";
|
|
12
|
-
url: string;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
16
|
-
*/
|
|
17
|
-
export declare const IFluidSerializer: keyof IProvideFluidSerializer;
|
|
18
|
-
/**
|
|
19
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
20
|
-
*/
|
|
21
|
-
export interface IProvideFluidSerializer {
|
|
22
|
-
readonly IFluidSerializer: IFluidSerializer;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
26
|
-
*/
|
|
27
|
-
export interface IFluidSerializer extends IProvideFluidSerializer {
|
|
28
|
-
/**
|
|
29
|
-
* Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
|
|
30
|
-
* where any embedded IFluidHandles have been replaced with a serializable form.
|
|
31
|
-
*
|
|
32
|
-
* The original `input` object is not mutated. This method will shallowly clones all objects in the path from
|
|
33
|
-
* the root to any replaced handles. (If no handles are found, returns the original object.)
|
|
34
|
-
*/
|
|
35
|
-
replaceHandles(value: any, bind: IFluidHandle): any;
|
|
36
|
-
/**
|
|
37
|
-
* Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
|
|
38
|
-
* equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
|
|
39
|
-
*
|
|
40
|
-
* The original `input` object is not mutated. This method will shallowly clones all objects in the path from
|
|
41
|
-
* the root to any replaced handles. (If no handles are found, returns the original object.)
|
|
42
|
-
*
|
|
43
|
-
* The decoded handles are implicitly bound to the handle context of this serializer.
|
|
44
|
-
*/
|
|
45
|
-
decode?(input: any): any;
|
|
46
|
-
/**
|
|
47
|
-
* Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
|
|
48
|
-
*/
|
|
49
|
-
stringify(value: any, bind: IFluidHandle): string;
|
|
50
|
-
/**
|
|
51
|
-
* Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
|
|
52
|
-
* handles will be realized as part of the parse
|
|
53
|
-
*/
|
|
54
|
-
parse(value: string): any;
|
|
55
|
-
}
|
|
56
|
-
//# sourceMappingURL=serializer.d.ts.map
|
package/dist/serializer.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
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
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.IFluidSerializer = void 0;
|
|
4
|
-
/**
|
|
5
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
6
|
-
*/
|
|
7
|
-
exports.IFluidSerializer = "IFluidSerializer";
|
|
8
|
-
//# sourceMappingURL=serializer.js.map
|
package/dist/serializer.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
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/serializer.d.ts
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import { IFluidHandle } from "./handles";
|
|
6
|
-
/**
|
|
7
|
-
* JSON serialized form of an IFluidHandle
|
|
8
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
9
|
-
*/
|
|
10
|
-
export interface ISerializedHandle {
|
|
11
|
-
type: "__fluid_handle__";
|
|
12
|
-
url: string;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
16
|
-
*/
|
|
17
|
-
export declare const IFluidSerializer: keyof IProvideFluidSerializer;
|
|
18
|
-
/**
|
|
19
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
20
|
-
*/
|
|
21
|
-
export interface IProvideFluidSerializer {
|
|
22
|
-
readonly IFluidSerializer: IFluidSerializer;
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
26
|
-
*/
|
|
27
|
-
export interface IFluidSerializer extends IProvideFluidSerializer {
|
|
28
|
-
/**
|
|
29
|
-
* Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
|
|
30
|
-
* where any embedded IFluidHandles have been replaced with a serializable form.
|
|
31
|
-
*
|
|
32
|
-
* The original `input` object is not mutated. This method will shallowly clones all objects in the path from
|
|
33
|
-
* the root to any replaced handles. (If no handles are found, returns the original object.)
|
|
34
|
-
*/
|
|
35
|
-
replaceHandles(value: any, bind: IFluidHandle): any;
|
|
36
|
-
/**
|
|
37
|
-
* Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
|
|
38
|
-
* equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
|
|
39
|
-
*
|
|
40
|
-
* The original `input` object is not mutated. This method will shallowly clones all objects in the path from
|
|
41
|
-
* the root to any replaced handles. (If no handles are found, returns the original object.)
|
|
42
|
-
*
|
|
43
|
-
* The decoded handles are implicitly bound to the handle context of this serializer.
|
|
44
|
-
*/
|
|
45
|
-
decode?(input: any): any;
|
|
46
|
-
/**
|
|
47
|
-
* Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
|
|
48
|
-
*/
|
|
49
|
-
stringify(value: any, bind: IFluidHandle): string;
|
|
50
|
-
/**
|
|
51
|
-
* Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
|
|
52
|
-
* handles will be realized as part of the parse
|
|
53
|
-
*/
|
|
54
|
-
parse(value: string): any;
|
|
55
|
-
}
|
|
56
|
-
//# sourceMappingURL=serializer.d.ts.map
|
package/lib/serializer.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
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/lib/serializer.js
DELETED
package/lib/serializer.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"serializer.js","sourceRoot":"","sources":["../src/serializer.ts"],"names":[],"mappings":"AAkBA;;GAEG;AACH,MAAM,CAAC,MAAM,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/src/serializer.ts
DELETED
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import { IFluidHandle } from "./handles";
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* JSON serialized form of an IFluidHandle
|
|
9
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
10
|
-
*/
|
|
11
|
-
export interface ISerializedHandle {
|
|
12
|
-
// Marker to indicate to JSON.parse that the object is a Fluid handle
|
|
13
|
-
type: "__fluid_handle__";
|
|
14
|
-
|
|
15
|
-
// URL to the object. Relative URLs are relative to the handle context passed to the stringify.
|
|
16
|
-
url: string;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
21
|
-
*/
|
|
22
|
-
export const IFluidSerializer: keyof IProvideFluidSerializer = "IFluidSerializer";
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
26
|
-
*/
|
|
27
|
-
export interface IProvideFluidSerializer {
|
|
28
|
-
readonly IFluidSerializer: IFluidSerializer;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* @deprecated - Moved to fluidframework/shared-object-base package
|
|
33
|
-
*/
|
|
34
|
-
export interface IFluidSerializer extends IProvideFluidSerializer {
|
|
35
|
-
/**
|
|
36
|
-
* Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
|
|
37
|
-
* where any embedded IFluidHandles have been replaced with a serializable form.
|
|
38
|
-
*
|
|
39
|
-
* The original `input` object is not mutated. This method will shallowly clones all objects in the path from
|
|
40
|
-
* the root to any replaced handles. (If no handles are found, returns the original object.)
|
|
41
|
-
*/
|
|
42
|
-
replaceHandles(value: any, bind: IFluidHandle): any;
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
|
|
46
|
-
* equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
|
|
47
|
-
*
|
|
48
|
-
* The original `input` object is not mutated. This method will shallowly clones all objects in the path from
|
|
49
|
-
* the root to any replaced handles. (If no handles are found, returns the original object.)
|
|
50
|
-
*
|
|
51
|
-
* The decoded handles are implicitly bound to the handle context of this serializer.
|
|
52
|
-
*/
|
|
53
|
-
decode?(input: any): any;
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
|
|
57
|
-
*/
|
|
58
|
-
stringify(value: any, bind: IFluidHandle): string;
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
|
|
62
|
-
* handles will be realized as part of the parse
|
|
63
|
-
*/
|
|
64
|
-
parse(value: string): any;
|
|
65
|
-
}
|