@fluidframework/datastore-definitions 2.0.0-internal.2.0.3 → 2.0.0-internal.2.1.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.
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from "@fluidframework/common-definitions";
6
- import { IFluidHandleContext, IFluidRouter, IFluidHandle } from "@fluidframework/core-interfaces";
6
+ import { IFluidHandleContext, IFluidRouter, IFluidHandle, FluidObject } from "@fluidframework/core-interfaces";
7
7
  import { IAudience, IDeltaManager, AttachState, ILoaderOptions } from "@fluidframework/container-definitions";
8
8
  import { IDocumentMessage, IQuorumClients, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
9
9
  import { IInboundSignalMessage, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions";
@@ -70,5 +70,15 @@ export interface IFluidDataStoreRuntime extends IFluidRouter, IEventProvider<IFl
70
70
  * Resolves when a local data store is attached.
71
71
  */
72
72
  waitAttached(): Promise<void>;
73
+ /**
74
+ * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
75
+ * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
76
+ * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
77
+ *
78
+ * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
79
+ * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
80
+ * the data store's entryPoint.
81
+ */
82
+ readonly entryPoint?: IFluidHandle<FluidObject>;
73
83
  }
74
84
  //# sourceMappingURL=dataStoreRuntime.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3G,OAAO,EACH,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAC5G,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;AAE7B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,CAEI,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,EAC5D,QAAQ,EAAE,MAAM,IAAI,OACtB;IACF,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SACpC,YAAY,EACZ,cAAc,CAAC,4BAA4B,CAAC,EAC5C,WAAW,EACX,OAAO,CAAC,8BAA8B,CAAC;IAEvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAElF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC"}
1
+ {"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3G,OAAO,EACH,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACZ,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,qBAAqB,EACrB,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;AAE7B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,CAEI,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,EAC5D,QAAQ,EAAE,MAAM,IAAI,OACtB;IACF,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SACpC,YAAY,EACZ,cAAc,CAAC,4BAA4B,CAAC,EAC5C,WAAW,EACX,OAAO,CAAC,8BAA8B,CAAC;IAEvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAElF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CACnD"}
@@ -1 +1 @@
1
- {"version":3,"file":"dataStoreRuntime.js","sourceRoot":"","sources":["../src/dataStoreRuntime.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 { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n IFluidHandleContext,\n IFluidRouter,\n IFluidHandle,\n} from \"@fluidframework/core-interfaces\";\nimport {\n IAudience,\n IDeltaManager,\n AttachState,\n ILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport {\n IDocumentMessage,\n IQuorumClients,\n ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IInboundSignalMessage, IProvideFluidDataStoreRegistry } from \"@fluidframework/runtime-definitions\";\nimport { IChannel } from \".\";\n\nexport interface IFluidDataStoreRuntimeEvents extends IEvent {\n (\n // eslint-disable-next-line @typescript-eslint/unified-signatures\n event: \"disconnected\" | \"dispose\" | \"attaching\" | \"attached\",\n listener: () => void,\n );\n (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n (event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n (event: \"connected\", listener: (clientId: string) => void);\n}\n\n/**\n * Represents the runtime for the data store. Contains helper functions/state of the data store.\n */\nexport interface IFluidDataStoreRuntime extends\n IFluidRouter,\n IEventProvider<IFluidDataStoreRuntimeEvents>,\n IDisposable,\n Partial<IProvideFluidDataStoreRegistry> {\n\n readonly id: string;\n\n readonly IFluidHandleContext: IFluidHandleContext;\n\n readonly rootRoutingContext: IFluidHandleContext;\n readonly channelsRoutingContext: IFluidHandleContext;\n readonly objectsRoutingContext: IFluidHandleContext;\n\n readonly options: ILoaderOptions;\n\n readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n readonly clientId: string | undefined;\n\n readonly connected: boolean;\n\n readonly logger: ITelemetryLogger;\n\n /**\n * Indicates the attachment state of the data store to a host service.\n */\n readonly attachState: AttachState;\n\n /**\n * Returns the channel with the given id\n */\n getChannel(id: string): Promise<IChannel>;\n\n /**\n * Creates a new channel of the given type.\n * @param id - ID of the channel to be created. A unique ID will be generated if left undefined.\n * @param type - Type of the channel.\n */\n createChannel(id: string | undefined, type: string): IChannel;\n\n /**\n * Bind the channel with the data store runtime. If the runtime\n * is attached then we attach the channel to make it live.\n */\n bindChannel(channel: IChannel): void;\n\n // Blob related calls\n /**\n * Api to upload a blob of data.\n * @param blob - blob to be uploaded.\n */\n uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n /**\n * Submits the signal to be sent to other clients.\n * @param type - Type of the signal.\n * @param content - Content of the signal.\n */\n submitSignal(type: string, content: any): void;\n\n /**\n * Returns the current quorum.\n */\n getQuorum(): IQuorumClients;\n\n /**\n * Returns the current audience.\n */\n getAudience(): IAudience;\n\n /**\n * Resolves when a local data store is attached.\n */\n waitAttached(): Promise<void>;\n}\n"]}
1
+ {"version":3,"file":"dataStoreRuntime.js","sourceRoot":"","sources":["../src/dataStoreRuntime.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 { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n IFluidHandleContext,\n IFluidRouter,\n IFluidHandle,\n FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport {\n IAudience,\n IDeltaManager,\n AttachState,\n ILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport {\n IDocumentMessage,\n IQuorumClients,\n ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n IInboundSignalMessage,\n IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannel } from \".\";\n\nexport interface IFluidDataStoreRuntimeEvents extends IEvent {\n (\n // eslint-disable-next-line @typescript-eslint/unified-signatures\n event: \"disconnected\" | \"dispose\" | \"attaching\" | \"attached\",\n listener: () => void,\n );\n (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n (event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n (event: \"connected\", listener: (clientId: string) => void);\n}\n\n/**\n * Represents the runtime for the data store. Contains helper functions/state of the data store.\n */\nexport interface IFluidDataStoreRuntime extends\n IFluidRouter,\n IEventProvider<IFluidDataStoreRuntimeEvents>,\n IDisposable,\n Partial<IProvideFluidDataStoreRegistry> {\n\n readonly id: string;\n\n readonly IFluidHandleContext: IFluidHandleContext;\n\n readonly rootRoutingContext: IFluidHandleContext;\n readonly channelsRoutingContext: IFluidHandleContext;\n readonly objectsRoutingContext: IFluidHandleContext;\n\n readonly options: ILoaderOptions;\n\n readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n readonly clientId: string | undefined;\n\n readonly connected: boolean;\n\n readonly logger: ITelemetryLogger;\n\n /**\n * Indicates the attachment state of the data store to a host service.\n */\n readonly attachState: AttachState;\n\n /**\n * Returns the channel with the given id\n */\n getChannel(id: string): Promise<IChannel>;\n\n /**\n * Creates a new channel of the given type.\n * @param id - ID of the channel to be created. A unique ID will be generated if left undefined.\n * @param type - Type of the channel.\n */\n createChannel(id: string | undefined, type: string): IChannel;\n\n /**\n * Bind the channel with the data store runtime. If the runtime\n * is attached then we attach the channel to make it live.\n */\n bindChannel(channel: IChannel): void;\n\n // Blob related calls\n /**\n * Api to upload a blob of data.\n * @param blob - blob to be uploaded.\n */\n uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n /**\n * Submits the signal to be sent to other clients.\n * @param type - Type of the signal.\n * @param content - Content of the signal.\n */\n submitSignal(type: string, content: any): void;\n\n /**\n * Returns the current quorum.\n */\n getQuorum(): IQuorumClients;\n\n /**\n * Returns the current audience.\n */\n getAudience(): IAudience;\n\n /**\n * Resolves when a local data store is attached.\n */\n waitAttached(): Promise<void>;\n\n /**\n * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting\n * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a\n * particular scenario) fall back to the current approach of requesting the root object through the request pattern.\n *\n * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property\n * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access\n * the data store's entryPoint.\n */\n readonly entryPoint?: IFluidHandle<FluidObject>;\n}\n"]}
package/dist/index.d.ts CHANGED
@@ -8,9 +8,9 @@
8
8
  *
9
9
  * @packageDocumentation
10
10
  */
11
- export * from "./channel";
12
- export * from "./dataStoreRuntime";
13
- export * from "./jsonable";
14
- export * from "./serializable";
15
- export * from "./storage";
11
+ export { IChannel, IChannelFactory, IChannelServices, IChannelStorageService, IDeltaConnection, IDeltaHandler, } from "./channel";
12
+ export { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from "./dataStoreRuntime";
13
+ export { Jsonable } from "./jsonable";
14
+ export { Serializable } from "./serializable";
15
+ export { IChannelAttributes } from "./storage";
16
16
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;EAKE;AAEF,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;EAKE;AAEF,OAAO,EACN,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC"}
package/dist/index.js CHANGED
@@ -3,26 +3,5 @@
3
3
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
4
  * Licensed under the MIT License.
5
5
  */
6
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
7
- if (k2 === undefined) k2 = k;
8
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
6
  Object.defineProperty(exports, "__esModule", { value: true });
17
- /**
18
- * This library defines the interfaces required to implement and/or communicate
19
- * with a data store.
20
- *
21
- * @packageDocumentation
22
- */
23
- __exportStar(require("./channel"), exports);
24
- __exportStar(require("./dataStoreRuntime"), exports);
25
- __exportStar(require("./jsonable"), exports);
26
- __exportStar(require("./serializable"), exports);
27
- __exportStar(require("./storage"), exports);
28
7
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH;;;;;EAKE;AAEF,4CAA0B;AAC1B,qDAAmC;AACnC,6CAA2B;AAC3B,iDAA+B;AAC/B,4CAA0B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n* This library defines the interfaces required to implement and/or communicate\n* with a data store.\n*\n* @packageDocumentation\n*/\n\nexport * from \"./channel\";\nexport * from \"./dataStoreRuntime\";\nexport * from \"./jsonable\";\nexport * from \"./serializable\";\nexport * from \"./storage\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n* This library defines the interfaces required to implement and/or communicate\n* with a data store.\n*\n* @packageDocumentation\n*/\n\nexport {\n\tIChannel,\n\tIChannelFactory,\n\tIChannelServices,\n\tIChannelStorageService,\n\tIDeltaConnection,\n\tIDeltaHandler,\n} from \"./channel\";\nexport { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from \"./dataStoreRuntime\";\nexport { Jsonable } from \"./jsonable\";\nexport { Serializable } from \"./serializable\";\nexport { IChannelAttributes } from \"./storage\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/datastore-definitions",
3
- "version": "2.0.0-internal.2.0.3",
3
+ "version": "2.0.0-internal.2.1.0",
4
4
  "description": "Fluid data store definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -27,35 +27,33 @@
27
27
  "lint": "npm run eslint",
28
28
  "lint:fix": "npm run eslint:fix",
29
29
  "tsc": "tsc",
30
- "tsfmt": "tsfmt --verify",
31
- "tsfmt:fix": "tsfmt --replace",
32
30
  "typetests:gen": "fluid-type-validator -g -d ."
33
31
  },
34
32
  "dependencies": {
35
33
  "@fluidframework/common-definitions": "^0.20.1",
36
34
  "@fluidframework/common-utils": "^1.0.0",
37
- "@fluidframework/container-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
38
- "@fluidframework/core-interfaces": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
35
+ "@fluidframework/container-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
36
+ "@fluidframework/core-interfaces": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
39
37
  "@fluidframework/protocol-definitions": "^1.1.0",
40
- "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
38
+ "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
41
39
  "@types/node": "^14.18.0"
42
40
  },
43
41
  "devDependencies": {
44
- "@fluidframework/build-common": "^1.0.0",
45
- "@fluidframework/build-tools": "^0.4.6000",
42
+ "@fluid-tools/build-cli": "^0.5.0",
43
+ "@fluidframework/build-common": "^1.1.0",
44
+ "@fluidframework/build-tools": "^0.5.0",
46
45
  "@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0-internal.2.0.0",
47
- "@fluidframework/eslint-config-fluid": "^1.0.0",
46
+ "@fluidframework/eslint-config-fluid": "^1.1.0",
48
47
  "@microsoft/api-extractor": "^7.22.2",
49
48
  "@rushstack/eslint-config": "^2.5.1",
50
49
  "concurrently": "^6.2.0",
51
50
  "copyfiles": "^2.4.1",
52
51
  "eslint": "~8.6.0",
53
52
  "rimraf": "^2.6.2",
54
- "typescript": "~4.5.5",
55
- "typescript-formatter": "7.1.0"
53
+ "typescript": "~4.5.5"
56
54
  },
57
55
  "typeValidation": {
58
- "version": "2.0.0-internal.2.0.1",
56
+ "version": "2.0.0-internal.2.1.0",
59
57
  "broken": {}
60
58
  }
61
59
  }
@@ -8,6 +8,7 @@ import {
8
8
  IFluidHandleContext,
9
9
  IFluidRouter,
10
10
  IFluidHandle,
11
+ FluidObject,
11
12
  } from "@fluidframework/core-interfaces";
12
13
  import {
13
14
  IAudience,
@@ -20,7 +21,10 @@ import {
20
21
  IQuorumClients,
21
22
  ISequencedDocumentMessage,
22
23
  } from "@fluidframework/protocol-definitions";
23
- import { IInboundSignalMessage, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions";
24
+ import {
25
+ IInboundSignalMessage,
26
+ IProvideFluidDataStoreRegistry,
27
+ } from "@fluidframework/runtime-definitions";
24
28
  import { IChannel } from ".";
25
29
 
26
30
  export interface IFluidDataStoreRuntimeEvents extends IEvent {
@@ -112,4 +116,15 @@ export interface IFluidDataStoreRuntime extends
112
116
  * Resolves when a local data store is attached.
113
117
  */
114
118
  waitAttached(): Promise<void>;
119
+
120
+ /**
121
+ * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
122
+ * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
123
+ * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
124
+ *
125
+ * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
126
+ * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
127
+ * the data store's entryPoint.
128
+ */
129
+ readonly entryPoint?: IFluidHandle<FluidObject>;
115
130
  }
package/src/index.ts CHANGED
@@ -10,8 +10,15 @@
10
10
  * @packageDocumentation
11
11
  */
12
12
 
13
- export * from "./channel";
14
- export * from "./dataStoreRuntime";
15
- export * from "./jsonable";
16
- export * from "./serializable";
17
- export * from "./storage";
13
+ export {
14
+ IChannel,
15
+ IChannelFactory,
16
+ IChannelServices,
17
+ IChannelStorageService,
18
+ IDeltaConnection,
19
+ IDeltaHandler,
20
+ } from "./channel";
21
+ export { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from "./dataStoreRuntime";
22
+ export { Jsonable } from "./jsonable";
23
+ export { Serializable } from "./serializable";
24
+ export { IChannelAttributes } from "./storage";