@fluidframework/fluid-static 1.2.7 → 2.0.0-dev.1.3.0.96595
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/.mocharc.js +12 -0
- package/dist/fluidContainer.d.ts +63 -66
- package/dist/fluidContainer.d.ts.map +1 -1
- package/dist/fluidContainer.js +7 -2
- package/dist/fluidContainer.js.map +1 -1
- package/dist/rootDataObject.d.ts +18 -10
- package/dist/rootDataObject.d.ts.map +1 -1
- package/dist/rootDataObject.js +15 -8
- package/dist/rootDataObject.js.map +1 -1
- package/dist/serviceAudience.d.ts +25 -13
- package/dist/serviceAudience.d.ts.map +1 -1
- package/dist/serviceAudience.js +23 -12
- package/dist/serviceAudience.js.map +1 -1
- package/dist/types.d.ts +75 -69
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/lib/fluidContainer.d.ts +63 -66
- package/lib/fluidContainer.d.ts.map +1 -1
- package/lib/fluidContainer.js +7 -2
- package/lib/fluidContainer.js.map +1 -1
- package/lib/rootDataObject.d.ts +18 -10
- package/lib/rootDataObject.d.ts.map +1 -1
- package/lib/rootDataObject.js +15 -8
- package/lib/rootDataObject.js.map +1 -1
- package/lib/serviceAudience.d.ts +25 -13
- package/lib/serviceAudience.d.ts.map +1 -1
- package/lib/serviceAudience.js +23 -12
- package/lib/serviceAudience.js.map +1 -1
- package/lib/types.d.ts +75 -69
- package/lib/types.d.ts.map +1 -1
- package/lib/types.js.map +1 -1
- package/package.json +43 -22
- package/src/fluidContainer.ts +70 -66
- package/src/rootDataObject.ts +18 -10
- package/src/serviceAudience.ts +25 -13
- package/src/types.ts +80 -69
package/dist/serviceAudience.js
CHANGED
|
@@ -7,10 +7,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
7
7
|
exports.ServiceAudience = void 0;
|
|
8
8
|
const common_utils_1 = require("@fluidframework/common-utils");
|
|
9
9
|
/**
|
|
10
|
-
* Base class for providing audience information for sessions interacting with
|
|
10
|
+
* Base class for providing audience information for sessions interacting with {@link IFluidContainer}
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
*
|
|
11
14
|
* This can be extended by different service-specific client packages to additional parameters to
|
|
12
|
-
* the user and client details returned in IMember
|
|
13
|
-
*
|
|
15
|
+
* the user and client details returned in {@link IMember}.
|
|
16
|
+
*
|
|
17
|
+
* @typeParam M - A service-specific {@link IMember} implementation.
|
|
14
18
|
*/
|
|
15
19
|
class ServiceAudience extends common_utils_1.TypedEventEmitter {
|
|
16
20
|
constructor(
|
|
@@ -21,15 +25,21 @@ class ServiceAudience extends common_utils_1.TypedEventEmitter {
|
|
|
21
25
|
super();
|
|
22
26
|
this.container = container;
|
|
23
27
|
/**
|
|
24
|
-
* Retain the most recent member list.
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
28
|
+
* Retain the most recent member list.
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
*
|
|
32
|
+
* This is so we have more information about a member leaving the audience in the `removeMember` event.
|
|
33
|
+
*
|
|
34
|
+
* It allows us to match the behavior of the `addMember` event where it only fires on a change to the members this
|
|
35
|
+
* class exposes (and would actually produce a change in what `getMembers` returns).
|
|
36
|
+
*
|
|
37
|
+
* It also allows us to provide the client details in the event which makes it easier to find that client connection
|
|
38
|
+
* in a map keyed on the `userId` and not `clientId`.
|
|
39
|
+
*
|
|
40
|
+
* This map will always be up-to-date in a `removeMember` event because it is set once at construction and in
|
|
41
|
+
* every `addMember` event. It is mapped `clientId` to `M` to be better work with what the {@link IServiceAudience}
|
|
42
|
+
* events provide.
|
|
33
43
|
*/
|
|
34
44
|
this.lastMembers = new Map();
|
|
35
45
|
this.audience = container.audience;
|
|
@@ -102,6 +112,7 @@ class ServiceAudience extends common_utils_1.TypedEventEmitter {
|
|
|
102
112
|
/**
|
|
103
113
|
* Provides ability for the inheriting class to include/omit specific members.
|
|
104
114
|
* An example use case is omitting the summarizer client.
|
|
115
|
+
*
|
|
105
116
|
* @param member - Member to be included/omitted.
|
|
106
117
|
*/
|
|
107
118
|
shouldIncludeAsMember(member) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serviceAudience.js","sourceRoot":"","sources":["../src/serviceAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AAKjE
|
|
1
|
+
{"version":3,"file":"serviceAudience.js","sourceRoot":"","sources":["../src/serviceAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AAKjE;;;;;;;;;GASG;AACH,MAAsB,eACpB,SAAQ,gCAA4C;IA0BpD;IACE;;OAEG;IACgB,SAAqB;QAExC,KAAK,EAAE,CAAC;QAFW,cAAS,GAAT,SAAS,CAAY;QAvB1C;;;;;;;;;;;;;;;;WAgBG;QACO,gBAAW,GAAmB,IAAI,GAAG,EAAE,CAAC;QAShD,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAEnC,iFAAiF;QACjF,+EAA+E;QAC/E,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,QAAgB,EAAE,OAAgB,EAAE,EAAE;YACnE,IAAI,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAClC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACrE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACpE,CAAC;IASD;;OAEG;IACI,UAAU;QACf,MAAM,KAAK,GAAG,IAAI,GAAG,EAAa,CAAC;QACnC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAa,CAAC;QAC7C,0DAA0D;QAC1D,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,MAAe,EAAE,QAAgB,EAAE,EAAE;YACvE,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE;gBACtC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,iCAAiC;gBACjC,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBACxC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;iBACzB;gBAED,0CAA0C;gBAC1C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3D,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAEO,SAAS,CAAC,QAAgB;QAChC,oEAAoE;QACpE,MAAM,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,sBAAsB,KAAK,SAAS,EAAE;YACxC,OAAO,SAAS,CAAC;SAClB;QACD,2EAA2E;QAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/D,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,KAAK,CAAC,6BAA6B,QAAQ,8CAA8C,CAAC,CAAC;SAClG;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACO,qBAAqB,CAAC,MAAe;QAC7C,6BAA6B;QAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC;IACjD,CAAC;CACF;AA/HD,0CA+HC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IAudience, IContainer } from \"@fluidframework/container-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { IServiceAudience, IServiceAudienceEvents, IMember } from \"./types\";\n\n/**\n * Base class for providing audience information for sessions interacting with {@link IFluidContainer}\n *\n * @remarks\n *\n * This can be extended by different service-specific client packages to additional parameters to\n * the user and client details returned in {@link IMember}.\n *\n * @typeParam M - A service-specific {@link IMember} implementation.\n */\nexport abstract class ServiceAudience<M extends IMember = IMember>\n extends TypedEventEmitter<IServiceAudienceEvents<M>>\n implements IServiceAudience<M> {\n /**\n * Audience object which includes all the existing members of the {@link IFluidContainer | container}.\n */\n protected readonly audience: IAudience;\n\n /**\n * Retain the most recent member list.\n *\n * @remarks\n *\n * This is so we have more information about a member leaving the audience in the `removeMember` event.\n *\n * It allows us to match the behavior of the `addMember` event where it only fires on a change to the members this\n * class exposes (and would actually produce a change in what `getMembers` returns).\n *\n * It also allows us to provide the client details in the event which makes it easier to find that client connection\n * in a map keyed on the `userId` and not `clientId`.\n *\n * This map will always be up-to-date in a `removeMember` event because it is set once at construction and in\n * every `addMember` event. It is mapped `clientId` to `M` to be better work with what the {@link IServiceAudience}\n * events provide.\n */\n protected lastMembers: Map<string, M> = new Map();\n\n constructor(\n /**\n * Fluid Container to read the audience from.\n */\n protected readonly container: IContainer,\n ) {\n super();\n this.audience = container.audience;\n\n // getMembers will assign lastMembers so the removeMember event has what it needs\n // in case it would fire before getMembers otherwise gets called the first time\n this.getMembers();\n\n this.audience.on(\"addMember\", (clientId: string, details: IClient) => {\n if (this.shouldIncludeAsMember(details)) {\n const member = this.getMember(clientId);\n this.emit(\"memberAdded\", clientId, member);\n this.emit(\"membersChanged\");\n }\n });\n\n this.audience.on(\"removeMember\", (clientId: string) => {\n if (this.lastMembers.has(clientId)) {\n this.emit(\"memberRemoved\", clientId, this.lastMembers.get(clientId));\n this.emit(\"membersChanged\");\n }\n });\n\n this.container.on(\"connected\", () => this.emit(\"membersChanged\"));\n }\n\n /**\n * Provides ability for inheriting class to modify/extend the audience object.\n *\n * @param audienceMember - Record of a specific audience member.\n */\n protected abstract createServiceMember(audienceMember: IClient): M;\n\n /**\n * {@inheritDoc IServiceAudience.getMembers}\n */\n public getMembers(): Map<string, M> {\n const users = new Map<string, M>();\n const clientMemberMap = new Map<string, M>();\n // Iterate through the members and get the user specifics.\n this.audience.getMembers().forEach((member: IClient, clientId: string) => {\n if (this.shouldIncludeAsMember(member)) {\n const userId = member.user.id;\n // Ensure we're tracking the user\n let user = users.get(userId);\n if (user === undefined) {\n user = this.createServiceMember(member);\n users.set(userId, user);\n }\n\n // Add this connection to their collection\n user.connections.push({ id: clientId, mode: member.mode });\n clientMemberMap.set(clientId, user);\n }\n });\n this.lastMembers = clientMemberMap;\n return users;\n }\n\n /**\n * {@inheritDoc IServiceAudience.getMyself}\n */\n public getMyself(): M | undefined {\n const clientId = this.container.clientId;\n if (clientId === undefined) {\n return undefined;\n }\n return this.getMember(clientId);\n }\n\n private getMember(clientId: string): M | undefined {\n // Fetch the user ID assoicated with this client ID from the runtime\n const internalAudienceMember = this.audience.getMember(clientId);\n if (internalAudienceMember === undefined) {\n return undefined;\n }\n // Return the member object with any other clients associated for this user\n const allMembers = this.getMembers();\n const member = allMembers.get(internalAudienceMember?.user.id);\n if (member === undefined) {\n throw Error(`Attempted to fetch client ${clientId} that is not part of the current member list`);\n }\n return member;\n }\n\n /**\n * Provides ability for the inheriting class to include/omit specific members.\n * An example use case is omitting the summarizer client.\n *\n * @param member - Member to be included/omitted.\n */\n protected shouldIncludeAsMember(member: IClient): boolean {\n // Include only human members\n return member.details.capabilities.interactive;\n }\n}\n"]}
|
package/dist/types.d.ts
CHANGED
|
@@ -7,56 +7,65 @@ import { IFluidLoadable } from "@fluidframework/core-interfaces";
|
|
|
7
7
|
import { IChannelFactory } from "@fluidframework/datastore-definitions";
|
|
8
8
|
import { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions";
|
|
9
9
|
/**
|
|
10
|
-
* A mapping of string identifiers to instantiated
|
|
10
|
+
* A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
|
|
11
11
|
*/
|
|
12
12
|
export declare type LoadableObjectRecord = Record<string, IFluidLoadable>;
|
|
13
13
|
/**
|
|
14
|
-
* A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject
|
|
15
|
-
* or SharedObject in a LoadableObjectRecord.
|
|
14
|
+
* A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`
|
|
15
|
+
* or `SharedObject` in a {@link LoadableObjectRecord}.
|
|
16
16
|
*/
|
|
17
17
|
export declare type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
|
|
18
18
|
/**
|
|
19
|
-
* A
|
|
20
|
-
*
|
|
19
|
+
* A class object of `DataObject` or `SharedObject`.
|
|
20
|
+
*
|
|
21
|
+
* @typeParam T - The class of the `DataObject` or `SharedObject`.
|
|
21
22
|
*/
|
|
22
23
|
export declare type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
|
|
23
24
|
/**
|
|
24
|
-
* A
|
|
25
|
-
* constructor that will return the type of the DataObject
|
|
26
|
-
*
|
|
25
|
+
* A class that has a factory that can create a `DataObject` and a
|
|
26
|
+
* constructor that will return the type of the `DataObject`.
|
|
27
|
+
*
|
|
28
|
+
* @typeParam T - The class of the `DataObject`.
|
|
27
29
|
*/
|
|
28
30
|
export declare type DataObjectClass<T extends IFluidLoadable> = {
|
|
29
31
|
readonly factory: IFluidDataStoreFactory;
|
|
30
32
|
} & LoadableObjectCtor<T>;
|
|
31
33
|
/**
|
|
32
|
-
* A
|
|
33
|
-
* constructor that will return the type of the DataObject
|
|
34
|
-
*
|
|
34
|
+
* A class that has a factory that can create a DDSes (`SharedObject`s) and a
|
|
35
|
+
* constructor that will return the type of the `DataObject`.
|
|
36
|
+
*
|
|
37
|
+
* @typeParam T - The class of the `SharedObject`.
|
|
35
38
|
*/
|
|
36
39
|
export declare type SharedObjectClass<T extends IFluidLoadable> = {
|
|
37
40
|
readonly getFactory: () => IChannelFactory;
|
|
38
41
|
} & LoadableObjectCtor<T>;
|
|
39
42
|
/**
|
|
40
|
-
* An object with a constructor that will return an
|
|
41
|
-
*
|
|
43
|
+
* An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.
|
|
44
|
+
*
|
|
45
|
+
* @typeParam T - The class of the loadable object.
|
|
42
46
|
*/
|
|
43
47
|
export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
|
|
44
48
|
/**
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
49
|
+
* Declares the Fluid objects that will be available in the {@link IFluidContainer | Container}.
|
|
50
|
+
*
|
|
51
|
+
* @remarks
|
|
52
|
+
*
|
|
53
|
+
* It includes both the instances of objects that are initially available upon `Container` creation, as well
|
|
54
|
+
* as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
|
|
48
55
|
*/
|
|
49
56
|
export interface ContainerSchema {
|
|
50
57
|
/**
|
|
51
|
-
* Defines loadable objects that will be created when the
|
|
52
|
-
*
|
|
58
|
+
* Defines loadable objects that will be created when the {@link IFluidContainer | Container} is first created.
|
|
59
|
+
*
|
|
60
|
+
* @remarks It uses the key as the id and the value as the loadable object to create.
|
|
53
61
|
*
|
|
54
62
|
* @example
|
|
55
|
-
*
|
|
63
|
+
*
|
|
64
|
+
* In the example below two objects will be created when the `Container` is first
|
|
56
65
|
* created. One with id "map1" that will return a `SharedMap` and the other with
|
|
57
66
|
* id "pair1" that will return a `KeyValueDataObject`.
|
|
58
67
|
*
|
|
59
|
-
* ```
|
|
68
|
+
* ```typescript
|
|
60
69
|
* {
|
|
61
70
|
* map1: SharedMap,
|
|
62
71
|
* pair1: KeyValueDataObject,
|
|
@@ -65,7 +74,9 @@ export interface ContainerSchema {
|
|
|
65
74
|
*/
|
|
66
75
|
initialObjects: LoadableObjectClassRecord;
|
|
67
76
|
/**
|
|
68
|
-
*
|
|
77
|
+
* Loadable objects that can be created after the initial {@link IFluidContainer | Container} creation.
|
|
78
|
+
*
|
|
79
|
+
* @remarks
|
|
69
80
|
*
|
|
70
81
|
* Types defined in `initialObjects` will always be available and are not required to be provided here.
|
|
71
82
|
*
|
|
@@ -75,60 +86,53 @@ export interface ContainerSchema {
|
|
|
75
86
|
dynamicObjectTypes?: LoadableObjectClass<any>[];
|
|
76
87
|
}
|
|
77
88
|
/**
|
|
78
|
-
*
|
|
79
|
-
* Only changes that would be reflected in the returned map of {@link IServiceAudience}'s
|
|
80
|
-
* {@link IServiceAudience.getMembers} method will emit events.
|
|
81
|
-
*
|
|
82
|
-
* @remarks
|
|
83
|
-
*
|
|
84
|
-
* The following is the list of events emitted.
|
|
85
|
-
*
|
|
86
|
-
* ### "membersChanged"
|
|
87
|
-
*
|
|
88
|
-
* The "membersChanged" event is emitted when a member is either added or removed.
|
|
89
|
-
*
|
|
90
|
-
* #### Listener signature
|
|
91
|
-
*
|
|
92
|
-
* ```typescript
|
|
93
|
-
* () => void;
|
|
94
|
-
* ```
|
|
95
|
-
*
|
|
96
|
-
* ### "memberAdded"
|
|
97
|
-
*
|
|
98
|
-
* The "memberAdded" event is emitted when a member joins the audience.
|
|
99
|
-
*
|
|
100
|
-
* #### Listener signature
|
|
89
|
+
* Signature for {@link IMember} change events.
|
|
101
90
|
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* ```
|
|
105
|
-
* - `clientId` - A unique identifier for the client
|
|
91
|
+
* @param clientId - A unique identifier for the client.
|
|
92
|
+
* @param member - The service-specific member object for the client.
|
|
106
93
|
*
|
|
107
|
-
*
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
*
|
|
94
|
+
* @see See {@link IServiceAudienceEvents} for usage details.
|
|
95
|
+
*/
|
|
96
|
+
export declare type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
|
|
97
|
+
/**
|
|
98
|
+
* Events that trigger when the roster of members in the Fluid session change.
|
|
112
99
|
*
|
|
113
|
-
*
|
|
100
|
+
* @remarks
|
|
114
101
|
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* ```
|
|
118
|
-
* - `clientId` - A unique identifier for the client
|
|
102
|
+
* Only changes that would be reflected in the returned map of {@link IServiceAudience}'s
|
|
103
|
+
* {@link IServiceAudience.getMembers} method will emit events.
|
|
119
104
|
*
|
|
120
|
-
*
|
|
121
|
-
* @typeParam M - A service-specific member type.
|
|
105
|
+
* @typeParam M - A service-specific {@link IMember} implementation.
|
|
122
106
|
*/
|
|
123
107
|
export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
108
|
+
/**
|
|
109
|
+
* Emitted when a {@link IMember | member}(s) are either added or removed.
|
|
110
|
+
*
|
|
111
|
+
* @eventProperty
|
|
112
|
+
*/
|
|
124
113
|
(event: "membersChanged", listener: () => void): void;
|
|
125
|
-
|
|
114
|
+
/**
|
|
115
|
+
* Emitted when a {@link IMember | member} joins the audience.
|
|
116
|
+
*
|
|
117
|
+
* @eventProperty
|
|
118
|
+
*/
|
|
119
|
+
(event: "memberAdded", listener: MemberChangedListener<M>): void;
|
|
120
|
+
/**
|
|
121
|
+
* Emitted when a {@link IMember | member} leaves the audience.
|
|
122
|
+
*
|
|
123
|
+
* @eventProperty
|
|
124
|
+
*/
|
|
125
|
+
(event: "memberRemoved", listener: MemberChangedListener<M>): void;
|
|
126
126
|
}
|
|
127
127
|
/**
|
|
128
|
-
* Base interface to be implemented to fetch each service's audience.
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
128
|
+
* Base interface to be implemented to fetch each service's audience.
|
|
129
|
+
*
|
|
130
|
+
* @remarks
|
|
131
|
+
*
|
|
132
|
+
* The type parameter `M` allows consumers to further extend the client object with service-specific
|
|
133
|
+
* details about the connecting client, such as device information, environment, or a username.
|
|
134
|
+
*
|
|
135
|
+
* @typeParam M - A service-specific {@link IMember} type.
|
|
132
136
|
*/
|
|
133
137
|
export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
|
|
134
138
|
/**
|
|
@@ -143,8 +147,9 @@ export interface IServiceAudience<M extends IMember> extends IEventProvider<ISer
|
|
|
143
147
|
getMyself(): M | undefined;
|
|
144
148
|
}
|
|
145
149
|
/**
|
|
146
|
-
* Base interface for information for each connection made to the Fluid session.
|
|
147
|
-
*
|
|
150
|
+
* Base interface for information for each connection made to the Fluid session.
|
|
151
|
+
*
|
|
152
|
+
* @remarks This interface can be extended to provide additional information specific to each service.
|
|
148
153
|
*/
|
|
149
154
|
export interface IConnection {
|
|
150
155
|
/**
|
|
@@ -157,8 +162,9 @@ export interface IConnection {
|
|
|
157
162
|
mode: "write" | "read";
|
|
158
163
|
}
|
|
159
164
|
/**
|
|
160
|
-
* Base interface to be implemented to fetch each service's member.
|
|
161
|
-
*
|
|
165
|
+
* Base interface to be implemented to fetch each service's member.
|
|
166
|
+
*
|
|
167
|
+
* @remarks This interface can be extended by each service to provide additional service-specific user metadata.
|
|
162
168
|
*/
|
|
163
169
|
export interface IMember {
|
|
164
170
|
/**
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E;;GAEG;AACH,oBAAY,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAElE;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjF
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E;;GAEG;AACH,oBAAY,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAElE;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjF;;;;GAIG;AACH,oBAAY,mBAAmB,CAAC,CAAC,SAAS,cAAc,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEtG;;;;;GAKG;AACH,oBAAY,eAAe,CAAC,CAAC,SAAS,cAAc,IAC9C;IAAE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE5E;;;;;GAKG;AACH,oBAAY,iBAAiB,CAAC,CAAC,SAAS,cAAc,IAChD;IAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,eAAe,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,oBAAY,kBAAkB,CAAC,CAAC,SAAS,cAAc,IAAI,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAEpF;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,EAAE,yBAAyB,CAAC;IAE1C;;;;;;;;;OASG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;CACnD;AAED;;;;;;;GAOG;AACH,oBAAY,qBAAqB,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;AAE7F;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,MAAM;IAErE;;;;OAIG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAEjE;;;;OAIG;IACH,CAAC,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAEtE;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAClG;;;;OAIG;IACH,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,WAAW,EAAE,CAAC;CAC9B"}
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.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 { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport { IFluidDataStoreFactory } from \"@fluidframework/runtime-definitions\";\n\n/**\n * A mapping of string identifiers to instantiated
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.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 { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport { IFluidDataStoreFactory } from \"@fluidframework/runtime-definitions\";\n\n/**\n * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.\n */\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/**\n * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`\n * or `SharedObject` in a {@link LoadableObjectRecord}.\n */\nexport type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;\n\n/**\n * A class object of `DataObject` or `SharedObject`.\n *\n * @typeParam T - The class of the `DataObject` or `SharedObject`.\n */\nexport type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;\n\n/**\n * A class that has a factory that can create a `DataObject` and a\n * constructor that will return the type of the `DataObject`.\n *\n * @typeParam T - The class of the `DataObject`.\n */\nexport type DataObjectClass<T extends IFluidLoadable>\n = { readonly factory: IFluidDataStoreFactory; } & LoadableObjectCtor<T>;\n\n/**\n * A class that has a factory that can create a DDSes (`SharedObject`s) and a\n * constructor that will return the type of the `DataObject`.\n *\n * @typeParam T - The class of the `SharedObject`.\n */\nexport type SharedObjectClass<T extends IFluidLoadable>\n = { readonly getFactory: () => IChannelFactory; } & LoadableObjectCtor<T>;\n\n/**\n * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.\n *\n * @typeParam T - The class of the loadable object.\n */\nexport type LoadableObjectCtor<T extends IFluidLoadable> = new(...args: any[]) => T;\n\n/**\n * Declares the Fluid objects that will be available in the {@link IFluidContainer | Container}.\n *\n * @remarks\n *\n * It includes both the instances of objects that are initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n */\nexport interface ContainerSchema {\n /**\n * Defines loadable objects that will be created when the {@link IFluidContainer | Container} is first created.\n *\n * @remarks It uses the key as the id and the value as the loadable object to create.\n *\n * @example\n *\n * In the example below two objects will be created when the `Container` is first\n * created. One with id \"map1\" that will return a `SharedMap` and the other with\n * id \"pair1\" that will return a `KeyValueDataObject`.\n *\n * ```typescript\n * {\n * map1: SharedMap,\n * pair1: KeyValueDataObject,\n * }\n * ```\n */\n initialObjects: LoadableObjectClassRecord;\n\n /**\n * Loadable objects that can be created after the initial {@link IFluidContainer | Container} creation.\n *\n * @remarks\n *\n * Types defined in `initialObjects` will always be available and are not required to be provided here.\n *\n * For best practice it's recommended to define all the dynamic types you create even if they are\n * included via initialObjects.\n */\n dynamicObjectTypes?: LoadableObjectClass<any>[];\n}\n\n/**\n * Signature for {@link IMember} change events.\n *\n * @param clientId - A unique identifier for the client.\n * @param member - The service-specific member object for the client.\n *\n * @see See {@link IServiceAudienceEvents} for usage details.\n */\nexport type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;\n\n/**\n * Events that trigger when the roster of members in the Fluid session change.\n *\n * @remarks\n *\n * Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n *\n * @typeParam M - A service-specific {@link IMember} implementation.\n */\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n /* eslint-disable @typescript-eslint/unified-signatures */\n /**\n * Emitted when a {@link IMember | member}(s) are either added or removed.\n *\n * @eventProperty\n */\n (event: \"membersChanged\", listener: () => void): void;\n\n /**\n * Emitted when a {@link IMember | member} joins the audience.\n *\n * @eventProperty\n */\n (event: \"memberAdded\", listener: MemberChangedListener<M>): void;\n\n /**\n * Emitted when a {@link IMember | member} leaves the audience.\n *\n * @eventProperty\n */\n (event: \"memberRemoved\", listener: MemberChangedListener<M>): void;\n /* eslint-enable @typescript-eslint/unified-signatures */\n}\n\n/**\n * Base interface to be implemented to fetch each service's audience.\n *\n * @remarks\n *\n * The type parameter `M` allows consumers to further extend the client object with service-specific\n * details about the connecting client, such as device information, environment, or a username.\n *\n * @typeParam M - A service-specific {@link IMember} type.\n */\nexport interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {\n /**\n * Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n * member object. The implementation may choose to exclude certain connections from the returned map.\n * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n */\n getMembers(): Map<string, M>;\n\n /**\n * Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n */\n getMyself(): M | undefined;\n}\n\n/**\n * Base interface for information for each connection made to the Fluid session.\n *\n * @remarks This interface can be extended to provide additional information specific to each service.\n */\nexport interface IConnection {\n /**\n * A unique ID for the connection. A single user may have multiple connections, each with a different ID.\n */\n id: string;\n\n /**\n * Whether the connection is in read or read/write mode.\n */\n mode: \"write\" | \"read\";\n}\n\n/**\n * Base interface to be implemented to fetch each service's member.\n *\n * @remarks This interface can be extended by each service to provide additional service-specific user metadata.\n */\nexport interface IMember {\n /**\n * An ID for the user, unique among each individual user connecting to the session.\n */\n userId: string;\n\n /**\n * The set of connections the user has made, e.g. from multiple tabs or devices.\n */\n connections: IConnection[];\n}\n"]}
|
package/lib/fluidContainer.d.ts
CHANGED
|
@@ -10,64 +10,38 @@ import { LoadableObjectClass, LoadableObjectRecord } from "./types";
|
|
|
10
10
|
import { RootDataObject } from "./rootDataObject";
|
|
11
11
|
/**
|
|
12
12
|
* Events emitted from {@link IFluidContainer}.
|
|
13
|
-
*
|
|
14
|
-
* @remarks
|
|
15
|
-
*
|
|
16
|
-
* The following is the list of events emitted.
|
|
17
|
-
*
|
|
18
|
-
* ### "connected"
|
|
19
|
-
*
|
|
20
|
-
* The "connected" event is emitted when the `IFluidContainer` completes connecting to the Fluid service.
|
|
21
|
-
*
|
|
22
|
-
* #### Listener signature
|
|
23
|
-
*
|
|
24
|
-
* ```typescript
|
|
25
|
-
* () => void;
|
|
26
|
-
* ```
|
|
27
|
-
*
|
|
28
|
-
* ### "dispose"
|
|
29
|
-
*
|
|
30
|
-
* The "dispose" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
|
|
31
|
-
*
|
|
32
|
-
* #### Listener signature
|
|
33
|
-
*
|
|
34
|
-
* ```typescript
|
|
35
|
-
* () => void;
|
|
36
|
-
* ```
|
|
37
|
-
*
|
|
38
|
-
* ### "disconnected"
|
|
39
|
-
*
|
|
40
|
-
* The "disconnected" event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service.
|
|
41
|
-
*
|
|
42
|
-
* #### Listener signature
|
|
43
|
-
*
|
|
44
|
-
* ```typescript
|
|
45
|
-
* () => void;
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* ### "saved"
|
|
49
|
-
*
|
|
50
|
-
* The "saved" event is emitted when the `IFluidContainer` has local changes acknowledged by the service.
|
|
51
|
-
*
|
|
52
|
-
* #### Listener signature
|
|
53
|
-
*
|
|
54
|
-
* ```typescript
|
|
55
|
-
* () => void
|
|
56
|
-
* ```
|
|
57
|
-
*
|
|
58
|
-
* ### "dirty"
|
|
59
|
-
*
|
|
60
|
-
* The "dirty" event is emitted when the `IFluidContainer` has local changes that have not yet
|
|
61
|
-
* been acknowledged by the service.
|
|
62
|
-
*
|
|
63
|
-
* #### Listener signature
|
|
64
|
-
*
|
|
65
|
-
* ```typescript
|
|
66
|
-
* () => void
|
|
67
|
-
* ```
|
|
68
13
|
*/
|
|
69
14
|
export interface IFluidContainerEvents extends IEvent {
|
|
70
|
-
|
|
15
|
+
/**
|
|
16
|
+
* Emitted when the {@link IFluidContainer} completes connecting to the Fluid service.
|
|
17
|
+
*
|
|
18
|
+
* @eventProperty
|
|
19
|
+
*/
|
|
20
|
+
(event: "connected", listener: () => void): void;
|
|
21
|
+
/**
|
|
22
|
+
* Emitted when the {@link IFluidContainer} is disposed, which permanently disables it.
|
|
23
|
+
*
|
|
24
|
+
* @eventProperty
|
|
25
|
+
*/
|
|
26
|
+
(event: "dispose", listener: () => void): void;
|
|
27
|
+
/**
|
|
28
|
+
* Emitted when the {@link IFluidContainer} becomes disconnected from the Fluid service.
|
|
29
|
+
*
|
|
30
|
+
* @eventProperty
|
|
31
|
+
*/
|
|
32
|
+
(event: "disconnected", listener: () => void): void;
|
|
33
|
+
/**
|
|
34
|
+
* Emitted when all of the {@link IFluidContainer}'s local changes have been acknowledged by the service.
|
|
35
|
+
*
|
|
36
|
+
* @eventProperty
|
|
37
|
+
*/
|
|
38
|
+
(event: "saved", listener: () => void): void;
|
|
39
|
+
/**
|
|
40
|
+
* Emitted when the {@link IFluidContainer} has local changes that have not yet been acknowledged by the service.
|
|
41
|
+
*
|
|
42
|
+
* @eventProperty
|
|
43
|
+
*/
|
|
44
|
+
(event: "dirty", listener: () => void): void;
|
|
71
45
|
}
|
|
72
46
|
/**
|
|
73
47
|
* Provides an entrypoint into the client side of collaborative Fluid data.
|
|
@@ -80,6 +54,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
80
54
|
readonly connectionState: ConnectionState;
|
|
81
55
|
/**
|
|
82
56
|
* A container is considered **dirty** if it has local changes that have not yet been acknowledged by the service.
|
|
57
|
+
*
|
|
58
|
+
* @remarks
|
|
59
|
+
*
|
|
83
60
|
* You should always check the `isDirty` flag before closing the container or navigating away from the page.
|
|
84
61
|
* Closing the container while `isDirty === true` may result in the loss of operations that have not yet been
|
|
85
62
|
* acknowledged by the service.
|
|
@@ -97,16 +74,21 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
97
74
|
*/
|
|
98
75
|
readonly isDirty: boolean;
|
|
99
76
|
/**
|
|
100
|
-
* Whether the container is disposed, which permanently disables it.
|
|
77
|
+
* Whether or not the container is disposed, which permanently disables it.
|
|
101
78
|
*/
|
|
102
79
|
readonly disposed: boolean;
|
|
103
80
|
/**
|
|
104
81
|
* The collection of data objects and Distributed Data Stores (DDSes) that were specified by the schema.
|
|
105
|
-
*
|
|
82
|
+
*
|
|
83
|
+
* @remarks These data objects and DDSes exist for the lifetime of the container.
|
|
106
84
|
*/
|
|
107
85
|
readonly initialObjects: LoadableObjectRecord;
|
|
108
86
|
/**
|
|
109
|
-
* The current attachment state of the container.
|
|
87
|
+
* The current attachment state of the container.
|
|
88
|
+
*
|
|
89
|
+
* @remarks
|
|
90
|
+
*
|
|
91
|
+
* Once a container has been attached, it remains attached.
|
|
110
92
|
* When loading an existing container, it will already be attached.
|
|
111
93
|
*/
|
|
112
94
|
readonly attachState: AttachState;
|
|
@@ -114,7 +96,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
114
96
|
* A newly created container starts detached from the collaborative service.
|
|
115
97
|
* Calling `attach()` uploads the new container to the service and connects to the collaborative service.
|
|
116
98
|
*
|
|
117
|
-
* @remarks
|
|
99
|
+
* @remarks
|
|
100
|
+
*
|
|
101
|
+
* This should only be called when the container is in the
|
|
118
102
|
* {@link @fluidframework/container-definitions#AttachState.Detatched} state.
|
|
119
103
|
*
|
|
120
104
|
* This can be determined by observing {@link IFluidContainer.attachState}.
|
|
@@ -126,7 +110,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
126
110
|
* Attempts to connect the container to the delta stream and process operations.
|
|
127
111
|
* Will throw an error if unsuccessful.
|
|
128
112
|
*
|
|
129
|
-
* @remarks
|
|
113
|
+
* @remarks
|
|
114
|
+
*
|
|
115
|
+
* This should only be called when the container is in the
|
|
130
116
|
* {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.
|
|
131
117
|
*
|
|
132
118
|
* This can be determined by observing {@link IFluidContainer.connectionState}.
|
|
@@ -135,7 +121,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
135
121
|
/**
|
|
136
122
|
* Disconnects the container from the delta stream and stops processing operations.
|
|
137
123
|
*
|
|
138
|
-
* @remarks
|
|
124
|
+
* @remarks
|
|
125
|
+
*
|
|
126
|
+
* This should only be called when the container is in the
|
|
139
127
|
* {@link @fluidframework/container-definitions#ConnectionState.Connected} state.
|
|
140
128
|
*
|
|
141
129
|
* This can be determined by observing {@link IFluidContainer.connectionState}.
|
|
@@ -144,11 +132,15 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
144
132
|
/**
|
|
145
133
|
* Create a new data object or Distributed Data Store (DDS) of the specified type.
|
|
146
134
|
*
|
|
147
|
-
* @remarks
|
|
135
|
+
* @remarks
|
|
136
|
+
*
|
|
137
|
+
* In order to share the data object or DDS with other
|
|
148
138
|
* collaborators and retrieve it later, store its handle in a collection like a SharedDirectory from your
|
|
149
139
|
* initialObjects.
|
|
150
140
|
*
|
|
151
|
-
* @param objectClass - The class of
|
|
141
|
+
* @param objectClass - The class of the `DataObject` or `SharedObject` to create.
|
|
142
|
+
*
|
|
143
|
+
* @typeParam T - The class of the `DataObject` or `SharedObject`.
|
|
152
144
|
*/
|
|
153
145
|
create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
|
|
154
146
|
/**
|
|
@@ -159,7 +151,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
|
159
151
|
/**
|
|
160
152
|
* Base {@link IFluidContainer} implementation.
|
|
161
153
|
*
|
|
162
|
-
* @remarks
|
|
154
|
+
* @remarks
|
|
155
|
+
*
|
|
156
|
+
* Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}
|
|
163
157
|
* will need to utilize or provide a service-specific implementation of this type that implements that method.
|
|
164
158
|
*/
|
|
165
159
|
export declare class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {
|
|
@@ -193,7 +187,10 @@ export declare class FluidContainer extends TypedEventEmitter<IFluidContainerEve
|
|
|
193
187
|
get initialObjects(): LoadableObjectRecord;
|
|
194
188
|
/**
|
|
195
189
|
* Incomplete base implementation of {@link IFluidContainer.attach}.
|
|
196
|
-
*
|
|
190
|
+
*
|
|
191
|
+
* @remarks
|
|
192
|
+
*
|
|
193
|
+
* Note: this implementation will unconditionally throw.
|
|
197
194
|
* Consumers who rely on this will need to utilize or provide a service specific implementation of this base type
|
|
198
195
|
* that provides an implementation of this method.
|
|
199
196
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fluidContainer.d.ts","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD
|
|
1
|
+
{"version":3,"file":"fluidContainer.d.ts","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IAEjD;;;;OAIG;IACH,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAEjD;;;;OAIG;IACF,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAEhD;;;;OAIG;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAEpD;;;;OAIG;IACF,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAGhD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC1E;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAE1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,oBAAoB,CAAC;IAE9C;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;;;;;;;;OAYG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;;;;;OASG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAElF;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,iBAAiB,CAAC,qBAAqB,CAAE,YAAW,eAAe;IAQ/F,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,cAAc;IARnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgC;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA+B;IAC/D,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IACzD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;gBAGpC,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,cAAc;IAUnD;;OAEG;IACF,IAAW,OAAO,IAAI,OAAO,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED;;OAEG;IACH,IAAW,QAAQ,YAElB;IAED;;OAEG;IACF,IAAW,eAAe,IAAI,eAAe,CAE7C;IAED;;OAEG;IACH,IAAW,cAAc,yBAExB;IAED;;;;;;;;;;;OAWG;IACU,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC;;OAEG;IACU,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI9F;;OAEG;IACI,OAAO;CAQjB"}
|
package/lib/fluidContainer.js
CHANGED
|
@@ -6,7 +6,9 @@ import { TypedEventEmitter } from "@fluidframework/common-utils";
|
|
|
6
6
|
/**
|
|
7
7
|
* Base {@link IFluidContainer} implementation.
|
|
8
8
|
*
|
|
9
|
-
* @remarks
|
|
9
|
+
* @remarks
|
|
10
|
+
*
|
|
11
|
+
* Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}
|
|
10
12
|
* will need to utilize or provide a service-specific implementation of this type that implements that method.
|
|
11
13
|
*/
|
|
12
14
|
export class FluidContainer extends TypedEventEmitter {
|
|
@@ -57,7 +59,10 @@ export class FluidContainer extends TypedEventEmitter {
|
|
|
57
59
|
}
|
|
58
60
|
/**
|
|
59
61
|
* Incomplete base implementation of {@link IFluidContainer.attach}.
|
|
60
|
-
*
|
|
62
|
+
*
|
|
63
|
+
* @remarks
|
|
64
|
+
*
|
|
65
|
+
* Note: this implementation will unconditionally throw.
|
|
61
66
|
* Consumers who rely on this will need to utilize or provide a service specific implementation of this base type
|
|
62
67
|
* that provides an implementation of this method.
|
|
63
68
|
*
|