@fluidframework/local-driver 2.0.0-rc.1.0.4 → 2.0.0-rc.2.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.
Files changed (113) hide show
  1. package/{.eslintrc.js → .eslintrc.cjs} +5 -5
  2. package/{.mocharc.js → .mocharc.cjs} +1 -1
  3. package/CHANGELOG.md +20 -0
  4. package/{api-extractor-esm.json → api-extractor-cjs.json} +5 -1
  5. package/api-extractor-lint.json +1 -1
  6. package/api-extractor.json +1 -1
  7. package/api-report/local-driver.api.md +7 -3
  8. package/dist/index.d.ts +7 -7
  9. package/dist/index.d.ts.map +1 -1
  10. package/dist/index.js +16 -16
  11. package/dist/index.js.map +1 -1
  12. package/dist/local-driver-alpha.d.ts +4 -2
  13. package/dist/local-driver-beta.d.ts +10 -0
  14. package/dist/local-driver-public.d.ts +10 -0
  15. package/dist/local-driver-untrimmed.d.ts +31 -4
  16. package/dist/localDocumentService.d.ts +4 -3
  17. package/dist/localDocumentService.d.ts.map +1 -1
  18. package/dist/localDocumentService.js +10 -8
  19. package/dist/localDocumentService.js.map +1 -1
  20. package/dist/localDocumentServiceFactory.d.ts +0 -1
  21. package/dist/localDocumentServiceFactory.d.ts.map +1 -1
  22. package/dist/localDocumentServiceFactory.js +6 -8
  23. package/dist/localDocumentServiceFactory.js.map +1 -1
  24. package/dist/localDocumentStorageService.d.ts +27 -2
  25. package/dist/localDocumentStorageService.d.ts.map +1 -1
  26. package/dist/localDocumentStorageService.js +130 -3
  27. package/dist/localDocumentStorageService.js.map +1 -1
  28. package/dist/localResolver.d.ts +0 -1
  29. package/dist/localResolver.d.ts.map +1 -1
  30. package/dist/localResolver.js +4 -6
  31. package/dist/localResolver.js.map +1 -1
  32. package/dist/localSessionStorageDb.js +2 -2
  33. package/dist/localSessionStorageDb.js.map +1 -1
  34. package/dist/package.json +3 -0
  35. package/dist/tsdoc-metadata.json +1 -1
  36. package/lib/{auth.d.mts → auth.d.ts} +1 -1
  37. package/lib/auth.d.ts.map +1 -0
  38. package/lib/{auth.mjs → auth.js} +1 -1
  39. package/lib/auth.js.map +1 -0
  40. package/lib/{index.mjs → index.d.ts} +8 -8
  41. package/lib/index.d.ts.map +1 -0
  42. package/lib/{index.d.mts → index.js} +8 -8
  43. package/lib/index.js.map +1 -0
  44. package/lib/{local-driver-alpha.d.mts → local-driver-alpha.d.ts} +4 -2
  45. package/lib/{local-driver-beta.d.mts → local-driver-beta.d.ts} +10 -0
  46. package/lib/{local-driver-public.d.mts → local-driver-public.d.ts} +10 -0
  47. package/lib/{local-driver-untrimmed.d.mts → local-driver-untrimmed.d.ts} +31 -4
  48. package/lib/{localCreateDocument.d.mts → localCreateDocument.d.ts} +1 -1
  49. package/lib/localCreateDocument.d.ts.map +1 -0
  50. package/lib/{localCreateDocument.mjs → localCreateDocument.js} +1 -1
  51. package/lib/localCreateDocument.js.map +1 -0
  52. package/lib/{localDeltaStorageService.d.mts → localDeltaStorageService.d.ts} +1 -1
  53. package/lib/localDeltaStorageService.d.ts.map +1 -0
  54. package/lib/{localDeltaStorageService.mjs → localDeltaStorageService.js} +1 -1
  55. package/lib/localDeltaStorageService.js.map +1 -0
  56. package/lib/{localDocumentDeltaConnection.d.mts → localDocumentDeltaConnection.d.ts} +1 -1
  57. package/lib/localDocumentDeltaConnection.d.ts.map +1 -0
  58. package/lib/{localDocumentDeltaConnection.mjs → localDocumentDeltaConnection.js} +1 -1
  59. package/lib/localDocumentDeltaConnection.js.map +1 -0
  60. package/lib/{localDocumentService.d.mts → localDocumentService.d.ts} +5 -4
  61. package/lib/localDocumentService.d.ts.map +1 -0
  62. package/lib/{localDocumentService.mjs → localDocumentService.js} +8 -6
  63. package/lib/localDocumentService.js.map +1 -0
  64. package/lib/{localDocumentServiceFactory.d.mts → localDocumentServiceFactory.d.ts} +1 -2
  65. package/lib/localDocumentServiceFactory.d.ts.map +1 -0
  66. package/lib/{localDocumentServiceFactory.mjs → localDocumentServiceFactory.js} +5 -7
  67. package/lib/localDocumentServiceFactory.js.map +1 -0
  68. package/lib/{localDocumentStorageService.d.mts → localDocumentStorageService.d.ts} +28 -3
  69. package/lib/localDocumentStorageService.d.ts.map +1 -0
  70. package/lib/localDocumentStorageService.js +211 -0
  71. package/lib/localDocumentStorageService.js.map +1 -0
  72. package/lib/{localResolver.d.mts → localResolver.d.ts} +1 -2
  73. package/lib/localResolver.d.ts.map +1 -0
  74. package/lib/{localResolver.mjs → localResolver.js} +4 -6
  75. package/lib/localResolver.js.map +1 -0
  76. package/lib/{localSessionStorageDb.d.mts → localSessionStorageDb.d.ts} +1 -1
  77. package/lib/localSessionStorageDb.d.ts.map +1 -0
  78. package/lib/{localSessionStorageDb.mjs → localSessionStorageDb.js} +6 -2
  79. package/lib/localSessionStorageDb.js.map +1 -0
  80. package/lib/test/localResolverTest.spec.js +47 -0
  81. package/lib/test/localResolverTest.spec.js.map +1 -0
  82. package/lib/test/types/validateLocalDriverPrevious.generated.js +26 -0
  83. package/lib/test/types/validateLocalDriverPrevious.generated.js.map +1 -0
  84. package/package.json +56 -57
  85. package/src/index.ts +7 -7
  86. package/src/localDocumentService.ts +13 -6
  87. package/src/localDocumentServiceFactory.ts +5 -7
  88. package/src/localDocumentStorageService.ts +180 -4
  89. package/src/localResolver.ts +3 -5
  90. package/src/localSessionStorageDb.ts +1 -1
  91. package/tsconfig.cjs.json +7 -0
  92. package/tsconfig.json +2 -5
  93. package/lib/auth.d.mts.map +0 -1
  94. package/lib/auth.mjs.map +0 -1
  95. package/lib/index.d.mts.map +0 -1
  96. package/lib/index.mjs.map +0 -1
  97. package/lib/localCreateDocument.d.mts.map +0 -1
  98. package/lib/localCreateDocument.mjs.map +0 -1
  99. package/lib/localDeltaStorageService.d.mts.map +0 -1
  100. package/lib/localDeltaStorageService.mjs.map +0 -1
  101. package/lib/localDocumentDeltaConnection.d.mts.map +0 -1
  102. package/lib/localDocumentDeltaConnection.mjs.map +0 -1
  103. package/lib/localDocumentService.d.mts.map +0 -1
  104. package/lib/localDocumentService.mjs.map +0 -1
  105. package/lib/localDocumentServiceFactory.d.mts.map +0 -1
  106. package/lib/localDocumentServiceFactory.mjs.map +0 -1
  107. package/lib/localDocumentStorageService.d.mts.map +0 -1
  108. package/lib/localDocumentStorageService.mjs +0 -84
  109. package/lib/localDocumentStorageService.mjs.map +0 -1
  110. package/lib/localResolver.d.mts.map +0 -1
  111. package/lib/localResolver.mjs.map +0 -1
  112. package/lib/localSessionStorageDb.d.mts.map +0 -1
  113. package/lib/localSessionStorageDb.mjs.map +0 -1
@@ -4,15 +4,15 @@
4
4
  */
5
5
 
6
6
  module.exports = {
7
- extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
7
+ extends: [
8
+ require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
9
+ "prettier",
10
+ ],
8
11
  parserOptions: {
9
12
  project: ["./tsconfig.json", "./src/test/tsconfig.json"],
10
13
  },
11
14
  rules: {
12
15
  "@typescript-eslint/strict-boolean-expressions": "off",
13
-
14
- // This library is used in the browser, so we don't want dependencies on most node libraries.
15
- "import/no-nodejs-modules": ["error", { allow: ["url", "events"] }],
16
16
  },
17
17
  overrides: [
18
18
  {
@@ -20,7 +20,7 @@ module.exports = {
20
20
  files: ["*.spec.ts", "src/test/**"],
21
21
  rules: {
22
22
  // Test files are run in node only so additional node libraries can be used.
23
- "import/no-nodejs-modules": ["error", { allow: ["assert", "url", "events"] }],
23
+ "import/no-nodejs-modules": ["error", { allow: ["assert"] }],
24
24
  },
25
25
  },
26
26
  ],
@@ -5,7 +5,7 @@
5
5
 
6
6
  "use strict";
7
7
 
8
- const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
8
+ const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
9
9
 
10
10
  const packageDir = __dirname;
11
11
  const config = getFluidTestMochaConfig(packageDir);
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # @fluidframework/local-driver
2
2
 
3
+ ## 2.0.0-rc.2.0.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Resolved URLs no longer use non-standard protocols ([#19840](https://github.com/microsoft/FluidFramework/issues/19840)) [9d3d185183](https://github.com/microsoft/FluidFramework/commits/9d3d1851830d953792a6dfad60dde6f1c59480de)
8
+
9
+ Previously, `IResolvedUrl.url` could use a non-standard protocol like `fluid://`, `fluid-odsp://`, or `fluid-test://`. These have been replaced with `https://` to permit standards-compliant URL parsing.
10
+
11
+ - driver-definitions: repositoryUrl removed from IDocumentStorageService ([#19522](https://github.com/microsoft/FluidFramework/issues/19522)) [90eb3c9d33](https://github.com/microsoft/FluidFramework/commits/90eb3c9d33d80e24caa1393a50f414c5602f6aa3)
12
+
13
+ The `repositoryUrl` member of `IDocumentStorageService` was unused and always equal to the empty string. It has been removed.
14
+
15
+ - container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
16
+
17
+ Added `containerMetadata` prop on IContainer interface.
18
+
19
+ - runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
20
+
21
+ The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
22
+
3
23
  ## 2.0.0-rc.1.0.0
4
24
 
5
25
  ### Minor Changes
@@ -1,4 +1,8 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base-esm.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
4
+ // CJS is actually secondary; so, no report.
5
+ "apiReport": {
6
+ "enabled": false
7
+ }
4
8
  }
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-lint.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
4
4
  }
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
4
4
  }
@@ -14,6 +14,7 @@ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
14
14
  import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
15
15
  import { IDocumentMessage } from '@fluidframework/protocol-definitions';
16
16
  import { IDocumentService } from '@fluidframework/driver-definitions';
17
+ import { IDocumentServiceEvents } from '@fluidframework/driver-definitions';
17
18
  import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
18
19
  import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
19
20
  import { IDocumentStorageService } from '@fluidframework/driver-definitions';
@@ -22,6 +23,8 @@ import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server
22
23
  import { IRequest } from '@fluidframework/core-interfaces';
23
24
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
24
25
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
26
+ import { ISnapshot } from '@fluidframework/driver-definitions';
27
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
25
28
  import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
26
29
  import { IStream } from '@fluidframework/driver-definitions';
27
30
  import { ISummaryContext } from '@fluidframework/driver-definitions';
@@ -35,6 +38,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
35
38
  import { IWebSocketServer } from '@fluidframework/server-services-core';
36
39
  import { NackErrorType } from '@fluidframework/protocol-definitions';
37
40
  import type { Socket } from 'socket.io-client';
41
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
38
42
 
39
43
  // @internal
40
44
  export function createLocalDocumentService(resolvedUrl: IResolvedUrl, localDeltaConnectionServer: ILocalDeltaConnectionServer, tokenProvider: ITokenProvider, tenantId: string, documentId: string, documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>, policies?: IDocumentServicePolicies, innerDocumentService?: IDocumentService, logger?: ITelemetryBaseLogger): IDocumentService;
@@ -60,7 +64,7 @@ export class LocalDocumentDeltaConnection extends DocumentDeltaConnection {
60
64
  }
61
65
 
62
66
  // @internal
63
- export class LocalDocumentService implements IDocumentService {
67
+ export class LocalDocumentService extends TypedEventEmitter<IDocumentServiceEvents> implements IDocumentService {
64
68
  constructor(resolvedUrl: IResolvedUrl, localDeltaConnectionServer: ILocalDeltaConnectionServer, tokenProvider: ITokenProvider, tenantId: string, documentId: string, documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>, policies?: IDocumentServicePolicies, innerDocumentService?: IDocumentService | undefined, logger?: ITelemetryBaseLogger | undefined);
65
69
  connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
66
70
  connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
@@ -93,6 +97,8 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
93
97
  // (undocumented)
94
98
  downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
95
99
  // (undocumented)
100
+ getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
101
+ // (undocumented)
96
102
  getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null>;
97
103
  // (undocumented)
98
104
  getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
@@ -101,8 +107,6 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
101
107
  // (undocumented)
102
108
  readBlob(blobId: string): Promise<ArrayBufferLike>;
103
109
  // (undocumented)
104
- readonly repositoryUrl: string;
105
- // (undocumented)
106
110
  uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
107
111
  }
108
112
 
package/dist/index.d.ts CHANGED
@@ -2,11 +2,11 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { LocalDeltaStorageService } from "./localDeltaStorageService";
6
- export { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection";
7
- export { createLocalDocumentService, LocalDocumentService } from "./localDocumentService";
8
- export { LocalDocumentServiceFactory } from "./localDocumentServiceFactory";
9
- export { LocalDocumentStorageService } from "./localDocumentStorageService";
10
- export { createLocalResolverCreateNewRequest, LocalResolver } from "./localResolver";
11
- export { LocalSessionStorageDbFactory } from "./localSessionStorageDb";
5
+ export { LocalDeltaStorageService } from "./localDeltaStorageService.js";
6
+ export { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection.js";
7
+ export { createLocalDocumentService, LocalDocumentService } from "./localDocumentService.js";
8
+ export { LocalDocumentServiceFactory } from "./localDocumentServiceFactory.js";
9
+ export { LocalDocumentStorageService } from "./localDocumentStorageService.js";
10
+ export { createLocalResolverCreateNewRequest, LocalResolver } from "./localResolver.js";
11
+ export { LocalSessionStorageDbFactory } from "./localSessionStorageDb.js";
12
12
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC1F,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,mCAAmC,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAC7F,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,mCAAmC,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,4BAA4B,CAAC"}
package/dist/index.js CHANGED
@@ -5,20 +5,20 @@
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.LocalSessionStorageDbFactory = exports.LocalResolver = exports.createLocalResolverCreateNewRequest = exports.LocalDocumentStorageService = exports.LocalDocumentServiceFactory = exports.LocalDocumentService = exports.createLocalDocumentService = exports.LocalDocumentDeltaConnection = exports.LocalDeltaStorageService = void 0;
8
- var localDeltaStorageService_1 = require("./localDeltaStorageService");
9
- Object.defineProperty(exports, "LocalDeltaStorageService", { enumerable: true, get: function () { return localDeltaStorageService_1.LocalDeltaStorageService; } });
10
- var localDocumentDeltaConnection_1 = require("./localDocumentDeltaConnection");
11
- Object.defineProperty(exports, "LocalDocumentDeltaConnection", { enumerable: true, get: function () { return localDocumentDeltaConnection_1.LocalDocumentDeltaConnection; } });
12
- var localDocumentService_1 = require("./localDocumentService");
13
- Object.defineProperty(exports, "createLocalDocumentService", { enumerable: true, get: function () { return localDocumentService_1.createLocalDocumentService; } });
14
- Object.defineProperty(exports, "LocalDocumentService", { enumerable: true, get: function () { return localDocumentService_1.LocalDocumentService; } });
15
- var localDocumentServiceFactory_1 = require("./localDocumentServiceFactory");
16
- Object.defineProperty(exports, "LocalDocumentServiceFactory", { enumerable: true, get: function () { return localDocumentServiceFactory_1.LocalDocumentServiceFactory; } });
17
- var localDocumentStorageService_1 = require("./localDocumentStorageService");
18
- Object.defineProperty(exports, "LocalDocumentStorageService", { enumerable: true, get: function () { return localDocumentStorageService_1.LocalDocumentStorageService; } });
19
- var localResolver_1 = require("./localResolver");
20
- Object.defineProperty(exports, "createLocalResolverCreateNewRequest", { enumerable: true, get: function () { return localResolver_1.createLocalResolverCreateNewRequest; } });
21
- Object.defineProperty(exports, "LocalResolver", { enumerable: true, get: function () { return localResolver_1.LocalResolver; } });
22
- var localSessionStorageDb_1 = require("./localSessionStorageDb");
23
- Object.defineProperty(exports, "LocalSessionStorageDbFactory", { enumerable: true, get: function () { return localSessionStorageDb_1.LocalSessionStorageDbFactory; } });
8
+ var localDeltaStorageService_js_1 = require("./localDeltaStorageService.js");
9
+ Object.defineProperty(exports, "LocalDeltaStorageService", { enumerable: true, get: function () { return localDeltaStorageService_js_1.LocalDeltaStorageService; } });
10
+ var localDocumentDeltaConnection_js_1 = require("./localDocumentDeltaConnection.js");
11
+ Object.defineProperty(exports, "LocalDocumentDeltaConnection", { enumerable: true, get: function () { return localDocumentDeltaConnection_js_1.LocalDocumentDeltaConnection; } });
12
+ var localDocumentService_js_1 = require("./localDocumentService.js");
13
+ Object.defineProperty(exports, "createLocalDocumentService", { enumerable: true, get: function () { return localDocumentService_js_1.createLocalDocumentService; } });
14
+ Object.defineProperty(exports, "LocalDocumentService", { enumerable: true, get: function () { return localDocumentService_js_1.LocalDocumentService; } });
15
+ var localDocumentServiceFactory_js_1 = require("./localDocumentServiceFactory.js");
16
+ Object.defineProperty(exports, "LocalDocumentServiceFactory", { enumerable: true, get: function () { return localDocumentServiceFactory_js_1.LocalDocumentServiceFactory; } });
17
+ var localDocumentStorageService_js_1 = require("./localDocumentStorageService.js");
18
+ Object.defineProperty(exports, "LocalDocumentStorageService", { enumerable: true, get: function () { return localDocumentStorageService_js_1.LocalDocumentStorageService; } });
19
+ var localResolver_js_1 = require("./localResolver.js");
20
+ Object.defineProperty(exports, "createLocalResolverCreateNewRequest", { enumerable: true, get: function () { return localResolver_js_1.createLocalResolverCreateNewRequest; } });
21
+ Object.defineProperty(exports, "LocalResolver", { enumerable: true, get: function () { return localResolver_js_1.LocalResolver; } });
22
+ var localSessionStorageDb_js_1 = require("./localSessionStorageDb.js");
23
+ Object.defineProperty(exports, "LocalSessionStorageDbFactory", { enumerable: true, get: function () { return localSessionStorageDb_js_1.LocalSessionStorageDbFactory; } });
24
24
  //# 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,uEAAsE;AAA7D,oIAAA,wBAAwB,OAAA;AACjC,+EAA8E;AAArE,4IAAA,4BAA4B,OAAA;AACrC,+DAA0F;AAAjF,kIAAA,0BAA0B,OAAA;AAAE,4HAAA,oBAAoB,OAAA;AACzD,6EAA4E;AAAnE,0IAAA,2BAA2B,OAAA;AACpC,6EAA4E;AAAnE,0IAAA,2BAA2B,OAAA;AACpC,iDAAqF;AAA5E,oIAAA,mCAAmC,OAAA;AAAE,8GAAA,aAAa,OAAA;AAC3D,iEAAuE;AAA9D,qIAAA,4BAA4B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { LocalDeltaStorageService } from \"./localDeltaStorageService\";\nexport { LocalDocumentDeltaConnection } from \"./localDocumentDeltaConnection\";\nexport { createLocalDocumentService, LocalDocumentService } from \"./localDocumentService\";\nexport { LocalDocumentServiceFactory } from \"./localDocumentServiceFactory\";\nexport { LocalDocumentStorageService } from \"./localDocumentStorageService\";\nexport { createLocalResolverCreateNewRequest, LocalResolver } from \"./localResolver\";\nexport { LocalSessionStorageDbFactory } from \"./localSessionStorageDb\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6EAAyE;AAAhE,uIAAA,wBAAwB,OAAA;AACjC,qFAAiF;AAAxE,+IAAA,4BAA4B,OAAA;AACrC,qEAA6F;AAApF,qIAAA,0BAA0B,OAAA;AAAE,+HAAA,oBAAoB,OAAA;AACzD,mFAA+E;AAAtE,6IAAA,2BAA2B,OAAA;AACpC,mFAA+E;AAAtE,6IAAA,2BAA2B,OAAA;AACpC,uDAAwF;AAA/E,uIAAA,mCAAmC,OAAA;AAAE,iHAAA,aAAa,OAAA;AAC3D,uEAA0E;AAAjE,wIAAA,4BAA4B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { LocalDeltaStorageService } from \"./localDeltaStorageService.js\";\nexport { LocalDocumentDeltaConnection } from \"./localDocumentDeltaConnection.js\";\nexport { createLocalDocumentService, LocalDocumentService } from \"./localDocumentService.js\";\nexport { LocalDocumentServiceFactory } from \"./localDocumentServiceFactory.js\";\nexport { LocalDocumentStorageService } from \"./localDocumentStorageService.js\";\nexport { createLocalResolverCreateNewRequest, LocalResolver } from \"./localResolver.js\";\nexport { LocalSessionStorageDbFactory } from \"./localSessionStorageDb.js\";\n"]}
@@ -8,6 +8,7 @@ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
8
8
  import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
9
  import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
10
  import { IDocumentService } from '@fluidframework/driver-definitions';
11
+ import { IDocumentServiceEvents } from '@fluidframework/driver-definitions';
11
12
  import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
13
  import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
13
14
  import { IDocumentStorageService } from '@fluidframework/driver-definitions';
@@ -16,6 +17,8 @@ import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server
16
17
  import { IRequest } from '@fluidframework/core-interfaces';
17
18
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
18
19
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
20
+ import { ISnapshot } from '@fluidframework/driver-definitions';
21
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
19
22
  import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
20
23
  import { IStream } from '@fluidframework/driver-definitions';
21
24
  import { ISummaryContext } from '@fluidframework/driver-definitions';
@@ -29,6 +32,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
29
32
  import { IWebSocketServer } from '@fluidframework/server-services-core';
30
33
  import { NackErrorType } from '@fluidframework/protocol-definitions';
31
34
  import type { Socket } from 'socket.io-client';
35
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
32
36
 
33
37
  /* Excluded from this release type: createLocalDocumentService */
34
38
 
@@ -56,7 +60,6 @@ export declare class LocalDocumentServiceFactory implements IDocumentServiceFact
56
60
  private readonly documentDeltaConnectionsMap;
57
61
  /**
58
62
  * @param localDeltaConnectionServer - delta connection server for ops
59
- * @alpha
60
63
  */
61
64
  constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
62
65
  createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
@@ -98,7 +101,6 @@ export declare class LocalResolver implements IUrlResolver {
98
101
  * token from constant test strings. The root of the URL is fake, but the
99
102
  * remaining relative URL can still be parsed.
100
103
  * @param request - request to handle
101
- * @alpha
102
104
  */
103
105
  resolve(request: IRequest): Promise<IResolvedUrl>;
104
106
  getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
@@ -8,6 +8,7 @@ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
8
8
  import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
9
  import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
10
  import { IDocumentService } from '@fluidframework/driver-definitions';
11
+ import { IDocumentServiceEvents } from '@fluidframework/driver-definitions';
11
12
  import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
13
  import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
13
14
  import { IDocumentStorageService } from '@fluidframework/driver-definitions';
@@ -16,6 +17,8 @@ import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server
16
17
  import { IRequest } from '@fluidframework/core-interfaces';
17
18
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
18
19
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
20
+ import { ISnapshot } from '@fluidframework/driver-definitions';
21
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
19
22
  import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
20
23
  import { IStream } from '@fluidframework/driver-definitions';
21
24
  import { ISummaryContext } from '@fluidframework/driver-definitions';
@@ -29,6 +32,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
29
32
  import { IWebSocketServer } from '@fluidframework/server-services-core';
30
33
  import { NackErrorType } from '@fluidframework/protocol-definitions';
31
34
  import type { Socket } from 'socket.io-client';
35
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
32
36
 
33
37
  /* Excluded from this release type: createLocalDocumentService */
34
38
 
@@ -42,6 +46,8 @@ import type { Socket } from 'socket.io-client';
42
46
 
43
47
  /* Excluded from this release type: IDocumentService */
44
48
 
49
+ /* Excluded from this release type: IDocumentServiceEvents */
50
+
45
51
  /* Excluded from this release type: IDocumentServiceFactory */
46
52
 
47
53
  /* Excluded from this release type: IDocumentServicePolicies */
@@ -52,6 +58,10 @@ import type { Socket } from 'socket.io-client';
52
58
 
53
59
  /* Excluded from this release type: IResolvedUrl */
54
60
 
61
+ /* Excluded from this release type: ISnapshot */
62
+
63
+ /* Excluded from this release type: ISnapshotFetchOptions */
64
+
55
65
  /* Excluded from this release type: IStream */
56
66
 
57
67
  /* Excluded from this release type: ISummaryContext */
@@ -8,6 +8,7 @@ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
8
8
  import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
9
  import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
10
  import { IDocumentService } from '@fluidframework/driver-definitions';
11
+ import { IDocumentServiceEvents } from '@fluidframework/driver-definitions';
11
12
  import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
13
  import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
13
14
  import { IDocumentStorageService } from '@fluidframework/driver-definitions';
@@ -16,6 +17,8 @@ import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server
16
17
  import { IRequest } from '@fluidframework/core-interfaces';
17
18
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
18
19
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
20
+ import { ISnapshot } from '@fluidframework/driver-definitions';
21
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
19
22
  import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
20
23
  import { IStream } from '@fluidframework/driver-definitions';
21
24
  import { ISummaryContext } from '@fluidframework/driver-definitions';
@@ -29,6 +32,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
29
32
  import { IWebSocketServer } from '@fluidframework/server-services-core';
30
33
  import { NackErrorType } from '@fluidframework/protocol-definitions';
31
34
  import type { Socket } from 'socket.io-client';
35
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
32
36
 
33
37
  /* Excluded from this release type: createLocalDocumentService */
34
38
 
@@ -42,6 +46,8 @@ import type { Socket } from 'socket.io-client';
42
46
 
43
47
  /* Excluded from this release type: IDocumentService */
44
48
 
49
+ /* Excluded from this release type: IDocumentServiceEvents */
50
+
45
51
  /* Excluded from this release type: IDocumentServiceFactory */
46
52
 
47
53
  /* Excluded from this release type: IDocumentServicePolicies */
@@ -52,6 +58,10 @@ import type { Socket } from 'socket.io-client';
52
58
 
53
59
  /* Excluded from this release type: IResolvedUrl */
54
60
 
61
+ /* Excluded from this release type: ISnapshot */
62
+
63
+ /* Excluded from this release type: ISnapshotFetchOptions */
64
+
55
65
  /* Excluded from this release type: IStream */
56
66
 
57
67
  /* Excluded from this release type: ISummaryContext */
@@ -8,6 +8,7 @@ import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
8
8
  import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
9
9
  import { IDocumentMessage } from '@fluidframework/protocol-definitions';
10
10
  import { IDocumentService } from '@fluidframework/driver-definitions';
11
+ import { IDocumentServiceEvents } from '@fluidframework/driver-definitions';
11
12
  import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
13
  import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
13
14
  import { IDocumentStorageService } from '@fluidframework/driver-definitions';
@@ -16,6 +17,8 @@ import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server
16
17
  import { IRequest } from '@fluidframework/core-interfaces';
17
18
  import { IResolvedUrl } from '@fluidframework/driver-definitions';
18
19
  import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
20
+ import { ISnapshot } from '@fluidframework/driver-definitions';
21
+ import { ISnapshotFetchOptions } from '@fluidframework/driver-definitions';
19
22
  import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
20
23
  import { IStream } from '@fluidframework/driver-definitions';
21
24
  import { ISummaryContext } from '@fluidframework/driver-definitions';
@@ -29,6 +32,7 @@ import { IVersion } from '@fluidframework/protocol-definitions';
29
32
  import { IWebSocketServer } from '@fluidframework/server-services-core';
30
33
  import { NackErrorType } from '@fluidframework/protocol-definitions';
31
34
  import type { Socket } from 'socket.io-client';
35
+ import { TypedEventEmitter } from '@fluid-internal/client-utils';
32
36
 
33
37
  /**
34
38
  * Creates and returns a document service for local use.
@@ -101,7 +105,7 @@ export declare class LocalDocumentDeltaConnection extends DocumentDeltaConnectio
101
105
  * Basic implementation of a document service for local use.
102
106
  * @internal
103
107
  */
104
- export declare class LocalDocumentService implements IDocumentService {
108
+ export declare class LocalDocumentService extends TypedEventEmitter<IDocumentServiceEvents> implements IDocumentService {
105
109
  readonly resolvedUrl: IResolvedUrl;
106
110
  private readonly localDeltaConnectionServer;
107
111
  private readonly tokenProvider;
@@ -145,7 +149,6 @@ export declare class LocalDocumentServiceFactory implements IDocumentServiceFact
145
149
  private readonly documentDeltaConnectionsMap;
146
150
  /**
147
151
  * @param localDeltaConnectionServer - delta connection server for ops
148
- * @alpha
149
152
  */
150
153
  constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
151
154
  createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
@@ -182,10 +185,35 @@ export declare class LocalDocumentStorageService implements IDocumentStorageServ
182
185
  private readonly resolvedUrl?;
183
186
  protected readonly blobsShaCache: Map<string, string>;
184
187
  private readonly summaryTreeUploadManager;
185
- readonly repositoryUrl: string;
186
188
  constructor(id: string, manager: GitManager, policies: IDocumentStorageServicePolicies, localDeltaConnectionServer?: ILocalDeltaConnectionServer | undefined, resolvedUrl?: IResolvedUrl | undefined);
187
189
  getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
188
190
  getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null>;
191
+ getSnapshot(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
192
+ /**
193
+ * Strips the tree or any subtree of data if it has a groupId.
194
+ *
195
+ * @param tree - The tree to strip of loading groupIds
196
+ * @returns a tree that has trees with groupIds that are empty
197
+ */
198
+ private stripTreeOfLoadingGroupIds;
199
+ /**
200
+ * Named differently as the algorithm is a little more involved.
201
+ *
202
+ * We want to strip the tree if it has a groupId that is not in the loadingGroupIds or if it doesn't have a descendent or ancestor
203
+ * that has a groupId that is in the loadingGroupIds.
204
+ *
205
+ * We keep the tree in the opposite case.
206
+ *
207
+ * @param tree - the tree to strip of any data that is not in the loadingGroupIds
208
+ * @param loadingGroupIds - the set of groupIds that are being loaded
209
+ * @param ancestorGroupIdInLoadingGroup - whether the ancestor of the tree has a groupId that is in the loadingGroupIds
210
+ * @returns whether or not it or descendant has a groupId that is in the loadingGroupIds
211
+ */
212
+ private filterTreeByLoadingGroupIds;
213
+ private populateBlobContents;
214
+ private populateGroupId;
215
+ private stripTree;
216
+ private readGroupId;
189
217
  readBlob(blobId: string): Promise<ArrayBufferLike>;
190
218
  uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
191
219
  createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
@@ -207,7 +235,6 @@ export declare class LocalResolver implements IUrlResolver {
207
235
  * token from constant test strings. The root of the URL is fake, but the
208
236
  * remaining relative URL can still be parsed.
209
237
  * @param request - request to handle
210
- * @alpha
211
238
  */
212
239
  resolve(request: IRequest): Promise<IResolvedUrl>;
213
240
  getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
@@ -2,17 +2,18 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { IDocumentDeltaConnection, IDocumentDeltaStorageService, IDocumentService, IDocumentServicePolicies, IDocumentStorageService, IResolvedUrl } from "@fluidframework/driver-definitions";
5
+ import { TypedEventEmitter } from "@fluid-internal/client-utils";
6
+ import { IDocumentDeltaConnection, IDocumentDeltaStorageService, IDocumentService, IDocumentServiceEvents, IDocumentServicePolicies, IDocumentStorageService, IResolvedUrl } from "@fluidframework/driver-definitions";
6
7
  import { IClient } from "@fluidframework/protocol-definitions";
7
8
  import { ITokenProvider } from "@fluidframework/routerlicious-driver";
8
9
  import { ILocalDeltaConnectionServer } from "@fluidframework/server-local-server";
9
10
  import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
10
- import { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection";
11
+ import { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection.js";
11
12
  /**
12
13
  * Basic implementation of a document service for local use.
13
14
  * @internal
14
15
  */
15
- export declare class LocalDocumentService implements IDocumentService {
16
+ export declare class LocalDocumentService extends TypedEventEmitter<IDocumentServiceEvents> implements IDocumentService {
16
17
  readonly resolvedUrl: IResolvedUrl;
17
18
  private readonly localDeltaConnectionServer;
18
19
  private readonly tokenProvider;
@@ -1 +1 @@
1
- {"version":3,"file":"localDocumentService.d.ts","sourceRoot":"","sources":["../src/localDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,wBAAwB,EACxB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAGtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAG9E;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,gBAAgB;aAQ3C,WAAW,EAAE,YAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,0BAA0B;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,2BAA2B;aAC5B,QAAQ,EAAE,wBAAwB;IAClD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAfzB;;;;;OAKG;gBAEc,WAAW,EAAE,YAAY,EACxB,0BAA0B,EAAE,2BAA2B,EACvD,aAAa,EAAE,cAAc,EAC7B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,4BAA4B,CAAC,EACvE,QAAQ,GAAE,wBAA6B,EACtC,oBAAoB,CAAC,8BAAkB,EACvC,MAAM,CAAC,kCAAsB;IAGxC,OAAO;IAEd;;OAEG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAcjE;;OAEG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAW3E;;;OAGG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAgCrF;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACzC,WAAW,EAAE,YAAY,EACzB,0BAA0B,EAAE,2BAA2B,EACvD,aAAa,EAAE,cAAc,EAC7B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,4BAA4B,CAAC,EACtE,QAAQ,CAAC,EAAE,wBAAwB,EACnC,oBAAoB,CAAC,EAAE,gBAAgB,EACvC,MAAM,CAAC,EAAE,oBAAoB,GAC3B,gBAAgB,CAYlB"}
1
+ {"version":3,"file":"localDocumentService.d.ts","sourceRoot":"","sources":["../src/localDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EACN,wBAAwB,EACxB,4BAA4B,EAC5B,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,EACxB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAGtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAGjF;;;GAGG;AACH,qBAAa,oBACZ,SAAQ,iBAAiB,CAAC,sBAAsB,CAChD,YAAW,gBAAgB;aASV,WAAW,EAAE,YAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,0BAA0B;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,2BAA2B;aAC5B,QAAQ,EAAE,wBAAwB;IAClD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAfzB;;;;;OAKG;gBAEc,WAAW,EAAE,YAAY,EACxB,0BAA0B,EAAE,2BAA2B,EACvD,aAAa,EAAE,cAAc,EAC7B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,4BAA4B,CAAC,EACvE,QAAQ,GAAE,wBAA0D,EACnE,oBAAoB,CAAC,8BAAkB,EACvC,MAAM,CAAC,kCAAsB;IAKxC,OAAO;IAEd;;OAEG;IACU,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAcjE;;OAEG;IACU,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAW3E;;;OAGG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAgCrF;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACzC,WAAW,EAAE,YAAY,EACzB,0BAA0B,EAAE,2BAA2B,EACvD,aAAa,EAAE,cAAc,EAC7B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,4BAA4B,CAAC,EACtE,QAAQ,CAAC,EAAE,wBAAwB,EACnC,oBAAoB,CAAC,EAAE,gBAAgB,EACvC,MAAM,CAAC,EAAE,oBAAoB,GAC3B,gBAAgB,CAYlB"}
@@ -5,23 +5,25 @@
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.createLocalDocumentService = exports.LocalDocumentService = void 0;
8
+ const client_utils_1 = require("@fluid-internal/client-utils");
8
9
  const server_services_client_1 = require("@fluidframework/server-services-client");
9
10
  const server_test_utils_1 = require("@fluidframework/server-test-utils");
10
- const localDocumentStorageService_1 = require("./localDocumentStorageService");
11
- const localDocumentDeltaConnection_1 = require("./localDocumentDeltaConnection");
12
- const localDeltaStorageService_1 = require("./localDeltaStorageService");
11
+ const localDocumentStorageService_js_1 = require("./localDocumentStorageService.js");
12
+ const localDocumentDeltaConnection_js_1 = require("./localDocumentDeltaConnection.js");
13
+ const localDeltaStorageService_js_1 = require("./localDeltaStorageService.js");
13
14
  /**
14
15
  * Basic implementation of a document service for local use.
15
16
  * @internal
16
17
  */
17
- class LocalDocumentService {
18
+ class LocalDocumentService extends client_utils_1.TypedEventEmitter {
18
19
  /**
19
20
  * @param localDeltaConnectionServer - delta connection server for ops
20
21
  * @param tokenProvider - token provider
21
22
  * @param tenantId - ID of tenant
22
23
  * @param documentId - ID of document
23
24
  */
24
- constructor(resolvedUrl, localDeltaConnectionServer, tokenProvider, tenantId, documentId, documentDeltaConnectionsMap, policies = {}, innerDocumentService, logger) {
25
+ constructor(resolvedUrl, localDeltaConnectionServer, tokenProvider, tenantId, documentId, documentDeltaConnectionsMap, policies = { supportGetSnapshotApi: true }, innerDocumentService, logger) {
26
+ super();
25
27
  this.resolvedUrl = resolvedUrl;
26
28
  this.localDeltaConnectionServer = localDeltaConnectionServer;
27
29
  this.tokenProvider = tokenProvider;
@@ -37,7 +39,7 @@ class LocalDocumentService {
37
39
  * Creates and returns a document storage service for local use.
38
40
  */
39
41
  async connectToStorage() {
40
- return new localDocumentStorageService_1.LocalDocumentStorageService(this.documentId, new server_services_client_1.GitManager(new server_test_utils_1.TestHistorian(this.localDeltaConnectionServer.testDbFactory.testDatabase)), {
42
+ return new localDocumentStorageService_js_1.LocalDocumentStorageService(this.documentId, new server_services_client_1.GitManager(new server_test_utils_1.TestHistorian(this.localDeltaConnectionServer.testDbFactory.testDatabase)), {
41
43
  maximumCacheDurationMs: 432000000, // 5 days in ms. Not actually enforced but shouldn't matter for any local driver scenario
42
44
  }, this.localDeltaConnectionServer, this.resolvedUrl);
43
45
  }
@@ -48,7 +50,7 @@ class LocalDocumentService {
48
50
  if (this.innerDocumentService) {
49
51
  return this.innerDocumentService.connectToDeltaStorage();
50
52
  }
51
- return new localDeltaStorageService_1.LocalDeltaStorageService(this.tenantId, this.documentId, this.localDeltaConnectionServer.databaseManager);
53
+ return new localDeltaStorageService_js_1.LocalDeltaStorageService(this.tenantId, this.documentId, this.localDeltaConnectionServer.databaseManager);
52
54
  }
53
55
  /**
54
56
  * Creates and returns a delta stream for local use.
@@ -62,7 +64,7 @@ class LocalDocumentService {
62
64
  return this.innerDocumentService.connectToDeltaStream(client);
63
65
  }
64
66
  const ordererToken = await this.tokenProvider.fetchOrdererToken(this.tenantId, this.documentId);
65
- const documentDeltaConnection = await localDocumentDeltaConnection_1.LocalDocumentDeltaConnection.create(this.tenantId, this.documentId, ordererToken.jwt, client, this.localDeltaConnectionServer.webSocketServer, undefined, this.logger);
67
+ const documentDeltaConnection = await localDocumentDeltaConnection_js_1.LocalDocumentDeltaConnection.create(this.tenantId, this.documentId, ordererToken.jwt, client, this.localDeltaConnectionServer.webSocketServer, undefined, this.logger);
66
68
  const clientId = documentDeltaConnection.clientId;
67
69
  // Add this document service for the clientId in the document service factory.
68
70
  this.documentDeltaConnectionsMap.set(clientId, documentDeltaConnection);
@@ -1 +1 @@
1
- {"version":3,"file":"localDocumentService.js","sourceRoot":"","sources":["../src/localDocumentService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH,mFAAoE;AACpE,yEAAkE;AAGlE,+EAA4E;AAC5E,iFAA8E;AAC9E,yEAAsE;AAEtE;;;GAGG;AACH,MAAa,oBAAoB;IAChC;;;;;OAKG;IACH,YACiB,WAAyB,EACxB,0BAAuD,EACvD,aAA6B,EAC7B,QAAgB,EAChB,UAAkB,EAClB,2BAAsE,EACvE,WAAqC,EAAE,EACtC,oBAAuC,EACvC,MAA6B;QAR9B,gBAAW,GAAX,WAAW,CAAc;QACxB,+BAA0B,GAA1B,0BAA0B,CAA6B;QACvD,kBAAa,GAAb,aAAa,CAAgB;QAC7B,aAAQ,GAAR,QAAQ,CAAQ;QAChB,eAAU,GAAV,UAAU,CAAQ;QAClB,gCAA2B,GAA3B,2BAA2B,CAA2C;QACvE,aAAQ,GAAR,QAAQ,CAA+B;QACtC,yBAAoB,GAApB,oBAAoB,CAAmB;QACvC,WAAM,GAAN,MAAM,CAAuB;IAC5C,CAAC;IAEG,OAAO,KAAI,CAAC;IAEnB;;OAEG;IACI,KAAK,CAAC,gBAAgB;QAC5B,OAAO,IAAI,yDAA2B,CACrC,IAAI,CAAC,UAAU,EACf,IAAI,mCAAU,CACb,IAAI,iCAAa,CAAC,IAAI,CAAC,0BAA0B,CAAC,aAAa,CAAC,YAAY,CAAC,CAC7E,EACD;YACC,sBAAsB,EAAE,SAAW,EAAE,yFAAyF;SAC9H,EACD,IAAI,CAAC,0BAA0B,EAC/B,IAAI,CAAC,WAAW,CAChB,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,qBAAqB;QACjC,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC9B,OAAO,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC;SACzD;QACD,OAAO,IAAI,mDAAwB,CAClC,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,0BAA0B,CAAC,eAAe,CAC/C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAChD,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACtE;QACD,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC9B,OAAO,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;SAC9D;QACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAC9D,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,CACf,CAAC;QACF,MAAM,uBAAuB,GAAG,MAAM,2DAA4B,CAAC,MAAM,CACxE,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,EACf,YAAY,CAAC,GAAG,EAChB,MAAM,EACN,IAAI,CAAC,0BAA0B,CAAC,eAAe,EAC/C,SAAS,EACT,IAAI,CAAC,MAAM,CACX,CAAC;QACF,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC;QAElD,8EAA8E;QAC9E,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC;QAExE,kFAAkF;QAClF,uBAAuB,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YAC7C,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,OAAO,uBAAuB,CAAC;IAChC,CAAC;CACD;AAxFD,oDAwFC;AAED;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CACzC,WAAyB,EACzB,0BAAuD,EACvD,aAA6B,EAC7B,QAAgB,EAChB,UAAkB,EAClB,2BAAsE,EACtE,QAAmC,EACnC,oBAAuC,EACvC,MAA6B;IAE7B,OAAO,IAAI,oBAAoB,CAC9B,WAAW,EACX,0BAA0B,EAC1B,aAAa,EACb,QAAQ,EACR,UAAU,EACV,2BAA2B,EAC3B,QAAQ,EACR,oBAAoB,EACpB,MAAM,CACN,CAAC;AACH,CAAC;AAtBD,gEAsBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { ITokenProvider } from \"@fluidframework/routerlicious-driver\";\nimport { GitManager } from \"@fluidframework/server-services-client\";\nimport { TestHistorian } from \"@fluidframework/server-test-utils\";\nimport { ILocalDeltaConnectionServer } from \"@fluidframework/server-local-server\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport { LocalDocumentStorageService } from \"./localDocumentStorageService\";\nimport { LocalDocumentDeltaConnection } from \"./localDocumentDeltaConnection\";\nimport { LocalDeltaStorageService } from \"./localDeltaStorageService\";\n\n/**\n * Basic implementation of a document service for local use.\n * @internal\n */\nexport class LocalDocumentService implements IDocumentService {\n\t/**\n\t * @param localDeltaConnectionServer - delta connection server for ops\n\t * @param tokenProvider - token provider\n\t * @param tenantId - ID of tenant\n\t * @param documentId - ID of document\n\t */\n\tconstructor(\n\t\tpublic readonly resolvedUrl: IResolvedUrl,\n\t\tprivate readonly localDeltaConnectionServer: ILocalDeltaConnectionServer,\n\t\tprivate readonly tokenProvider: ITokenProvider,\n\t\tprivate readonly tenantId: string,\n\t\tprivate readonly documentId: string,\n\t\tprivate readonly documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>,\n\t\tpublic readonly policies: IDocumentServicePolicies = {},\n\t\tprivate readonly innerDocumentService?: IDocumentService,\n\t\tprivate readonly logger?: ITelemetryBaseLogger,\n\t) {}\n\n\tpublic dispose() {}\n\n\t/**\n\t * Creates and returns a document storage service for local use.\n\t */\n\tpublic async connectToStorage(): Promise<IDocumentStorageService> {\n\t\treturn new LocalDocumentStorageService(\n\t\t\tthis.documentId,\n\t\t\tnew GitManager(\n\t\t\t\tnew TestHistorian(this.localDeltaConnectionServer.testDbFactory.testDatabase),\n\t\t\t),\n\t\t\t{\n\t\t\t\tmaximumCacheDurationMs: 432_000_000, // 5 days in ms. Not actually enforced but shouldn't matter for any local driver scenario\n\t\t\t},\n\t\t\tthis.localDeltaConnectionServer,\n\t\t\tthis.resolvedUrl,\n\t\t);\n\t}\n\n\t/**\n\t * Creates and returns a delta storage service for local use.\n\t */\n\tpublic async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n\t\tif (this.innerDocumentService) {\n\t\t\treturn this.innerDocumentService.connectToDeltaStorage();\n\t\t}\n\t\treturn new LocalDeltaStorageService(\n\t\t\tthis.tenantId,\n\t\t\tthis.documentId,\n\t\t\tthis.localDeltaConnectionServer.databaseManager,\n\t\t);\n\t}\n\n\t/**\n\t * Creates and returns a delta stream for local use.\n\t * @param client - client data\n\t */\n\tpublic async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n\t\tif (this.policies.storageOnly === true) {\n\t\t\tthrow new Error(\"can't connect to delta stream in storage-only mode\");\n\t\t}\n\t\tif (this.innerDocumentService) {\n\t\t\treturn this.innerDocumentService.connectToDeltaStream(client);\n\t\t}\n\t\tconst ordererToken = await this.tokenProvider.fetchOrdererToken(\n\t\t\tthis.tenantId,\n\t\t\tthis.documentId,\n\t\t);\n\t\tconst documentDeltaConnection = await LocalDocumentDeltaConnection.create(\n\t\t\tthis.tenantId,\n\t\t\tthis.documentId,\n\t\t\tordererToken.jwt,\n\t\t\tclient,\n\t\t\tthis.localDeltaConnectionServer.webSocketServer,\n\t\t\tundefined,\n\t\t\tthis.logger,\n\t\t);\n\t\tconst clientId = documentDeltaConnection.clientId;\n\n\t\t// Add this document service for the clientId in the document service factory.\n\t\tthis.documentDeltaConnectionsMap.set(clientId, documentDeltaConnection);\n\n\t\t// Add a listener to remove this document service when the client is disconnected.\n\t\tdocumentDeltaConnection.on(\"disconnect\", () => {\n\t\t\tthis.documentDeltaConnectionsMap.delete(clientId);\n\t\t});\n\n\t\treturn documentDeltaConnection;\n\t}\n}\n\n/**\n * Creates and returns a document service for local use.\n * @param localDeltaConnectionServer - delta connection server for ops\n * @param tokenProvider - token provider with a single token\n * @param tenantId - ID of tenant\n * @param documentId - ID of document\n * @internal\n */\nexport function createLocalDocumentService(\n\tresolvedUrl: IResolvedUrl,\n\tlocalDeltaConnectionServer: ILocalDeltaConnectionServer,\n\ttokenProvider: ITokenProvider,\n\ttenantId: string,\n\tdocumentId: string,\n\tdocumentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>,\n\tpolicies?: IDocumentServicePolicies,\n\tinnerDocumentService?: IDocumentService,\n\tlogger?: ITelemetryBaseLogger,\n): IDocumentService {\n\treturn new LocalDocumentService(\n\t\tresolvedUrl,\n\t\tlocalDeltaConnectionServer,\n\t\ttokenProvider,\n\t\ttenantId,\n\t\tdocumentId,\n\t\tdocumentDeltaConnectionsMap,\n\t\tpolicies,\n\t\tinnerDocumentService,\n\t\tlogger,\n\t);\n}\n"]}
1
+ {"version":3,"file":"localDocumentService.js","sourceRoot":"","sources":["../src/localDocumentService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAiE;AAYjE,mFAAoE;AACpE,yEAAkE;AAGlE,qFAA+E;AAC/E,uFAAiF;AACjF,+EAAyE;AAEzE;;;GAGG;AACH,MAAa,oBACZ,SAAQ,gCAAyC;IAGjD;;;;;OAKG;IACH,YACiB,WAAyB,EACxB,0BAAuD,EACvD,aAA6B,EAC7B,QAAgB,EAChB,UAAkB,EAClB,2BAAsE,EACvE,WAAqC,EAAE,qBAAqB,EAAE,IAAI,EAAE,EACnE,oBAAuC,EACvC,MAA6B;QAE9C,KAAK,EAAE,CAAC;QAVQ,gBAAW,GAAX,WAAW,CAAc;QACxB,+BAA0B,GAA1B,0BAA0B,CAA6B;QACvD,kBAAa,GAAb,aAAa,CAAgB;QAC7B,aAAQ,GAAR,QAAQ,CAAQ;QAChB,eAAU,GAAV,UAAU,CAAQ;QAClB,gCAA2B,GAA3B,2BAA2B,CAA2C;QACvE,aAAQ,GAAR,QAAQ,CAA4D;QACnE,yBAAoB,GAApB,oBAAoB,CAAmB;QACvC,WAAM,GAAN,MAAM,CAAuB;IAG/C,CAAC;IAEM,OAAO,KAAI,CAAC;IAEnB;;OAEG;IACI,KAAK,CAAC,gBAAgB;QAC5B,OAAO,IAAI,4DAA2B,CACrC,IAAI,CAAC,UAAU,EACf,IAAI,mCAAU,CACb,IAAI,iCAAa,CAAC,IAAI,CAAC,0BAA0B,CAAC,aAAa,CAAC,YAAY,CAAC,CAC7E,EACD;YACC,sBAAsB,EAAE,SAAW,EAAE,yFAAyF;SAC9H,EACD,IAAI,CAAC,0BAA0B,EAC/B,IAAI,CAAC,WAAW,CAChB,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,qBAAqB;QACjC,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC9B,OAAO,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC;SACzD;QACD,OAAO,IAAI,sDAAwB,CAClC,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,0BAA0B,CAAC,eAAe,CAC/C,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAChD,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACtE;QACD,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC9B,OAAO,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;SAC9D;QACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAC9D,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,CACf,CAAC;QACF,MAAM,uBAAuB,GAAG,MAAM,8DAA4B,CAAC,MAAM,CACxE,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,EACf,YAAY,CAAC,GAAG,EAChB,MAAM,EACN,IAAI,CAAC,0BAA0B,CAAC,eAAe,EAC/C,SAAS,EACT,IAAI,CAAC,MAAM,CACX,CAAC;QACF,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC;QAElD,8EAA8E;QAC9E,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC;QAExE,kFAAkF;QAClF,uBAAuB,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YAC7C,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,OAAO,uBAAuB,CAAC;IAChC,CAAC;CACD;AA7FD,oDA6FC;AAED;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CACzC,WAAyB,EACzB,0BAAuD,EACvD,aAA6B,EAC7B,QAAgB,EAChB,UAAkB,EAClB,2BAAsE,EACtE,QAAmC,EACnC,oBAAuC,EACvC,MAA6B;IAE7B,OAAO,IAAI,oBAAoB,CAC9B,WAAW,EACX,0BAA0B,EAC1B,aAAa,EACb,QAAQ,EACR,UAAU,EACV,2BAA2B,EAC3B,QAAQ,EACR,oBAAoB,EACpB,MAAM,CACN,CAAC;AACH,CAAC;AAtBD,gEAsBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport {\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIDocumentServiceEvents,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { ITokenProvider } from \"@fluidframework/routerlicious-driver\";\nimport { GitManager } from \"@fluidframework/server-services-client\";\nimport { TestHistorian } from \"@fluidframework/server-test-utils\";\nimport { ILocalDeltaConnectionServer } from \"@fluidframework/server-local-server\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport { LocalDocumentStorageService } from \"./localDocumentStorageService.js\";\nimport { LocalDocumentDeltaConnection } from \"./localDocumentDeltaConnection.js\";\nimport { LocalDeltaStorageService } from \"./localDeltaStorageService.js\";\n\n/**\n * Basic implementation of a document service for local use.\n * @internal\n */\nexport class LocalDocumentService\n\textends TypedEventEmitter<IDocumentServiceEvents>\n\timplements IDocumentService\n{\n\t/**\n\t * @param localDeltaConnectionServer - delta connection server for ops\n\t * @param tokenProvider - token provider\n\t * @param tenantId - ID of tenant\n\t * @param documentId - ID of document\n\t */\n\tconstructor(\n\t\tpublic readonly resolvedUrl: IResolvedUrl,\n\t\tprivate readonly localDeltaConnectionServer: ILocalDeltaConnectionServer,\n\t\tprivate readonly tokenProvider: ITokenProvider,\n\t\tprivate readonly tenantId: string,\n\t\tprivate readonly documentId: string,\n\t\tprivate readonly documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>,\n\t\tpublic readonly policies: IDocumentServicePolicies = { supportGetSnapshotApi: true },\n\t\tprivate readonly innerDocumentService?: IDocumentService,\n\t\tprivate readonly logger?: ITelemetryBaseLogger,\n\t) {\n\t\tsuper();\n\t}\n\n\tpublic dispose() {}\n\n\t/**\n\t * Creates and returns a document storage service for local use.\n\t */\n\tpublic async connectToStorage(): Promise<IDocumentStorageService> {\n\t\treturn new LocalDocumentStorageService(\n\t\t\tthis.documentId,\n\t\t\tnew GitManager(\n\t\t\t\tnew TestHistorian(this.localDeltaConnectionServer.testDbFactory.testDatabase),\n\t\t\t),\n\t\t\t{\n\t\t\t\tmaximumCacheDurationMs: 432_000_000, // 5 days in ms. Not actually enforced but shouldn't matter for any local driver scenario\n\t\t\t},\n\t\t\tthis.localDeltaConnectionServer,\n\t\t\tthis.resolvedUrl,\n\t\t);\n\t}\n\n\t/**\n\t * Creates and returns a delta storage service for local use.\n\t */\n\tpublic async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n\t\tif (this.innerDocumentService) {\n\t\t\treturn this.innerDocumentService.connectToDeltaStorage();\n\t\t}\n\t\treturn new LocalDeltaStorageService(\n\t\t\tthis.tenantId,\n\t\t\tthis.documentId,\n\t\t\tthis.localDeltaConnectionServer.databaseManager,\n\t\t);\n\t}\n\n\t/**\n\t * Creates and returns a delta stream for local use.\n\t * @param client - client data\n\t */\n\tpublic async connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection> {\n\t\tif (this.policies.storageOnly === true) {\n\t\t\tthrow new Error(\"can't connect to delta stream in storage-only mode\");\n\t\t}\n\t\tif (this.innerDocumentService) {\n\t\t\treturn this.innerDocumentService.connectToDeltaStream(client);\n\t\t}\n\t\tconst ordererToken = await this.tokenProvider.fetchOrdererToken(\n\t\t\tthis.tenantId,\n\t\t\tthis.documentId,\n\t\t);\n\t\tconst documentDeltaConnection = await LocalDocumentDeltaConnection.create(\n\t\t\tthis.tenantId,\n\t\t\tthis.documentId,\n\t\t\tordererToken.jwt,\n\t\t\tclient,\n\t\t\tthis.localDeltaConnectionServer.webSocketServer,\n\t\t\tundefined,\n\t\t\tthis.logger,\n\t\t);\n\t\tconst clientId = documentDeltaConnection.clientId;\n\n\t\t// Add this document service for the clientId in the document service factory.\n\t\tthis.documentDeltaConnectionsMap.set(clientId, documentDeltaConnection);\n\n\t\t// Add a listener to remove this document service when the client is disconnected.\n\t\tdocumentDeltaConnection.on(\"disconnect\", () => {\n\t\t\tthis.documentDeltaConnectionsMap.delete(clientId);\n\t\t});\n\n\t\treturn documentDeltaConnection;\n\t}\n}\n\n/**\n * Creates and returns a document service for local use.\n * @param localDeltaConnectionServer - delta connection server for ops\n * @param tokenProvider - token provider with a single token\n * @param tenantId - ID of tenant\n * @param documentId - ID of document\n * @internal\n */\nexport function createLocalDocumentService(\n\tresolvedUrl: IResolvedUrl,\n\tlocalDeltaConnectionServer: ILocalDeltaConnectionServer,\n\ttokenProvider: ITokenProvider,\n\ttenantId: string,\n\tdocumentId: string,\n\tdocumentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>,\n\tpolicies?: IDocumentServicePolicies,\n\tinnerDocumentService?: IDocumentService,\n\tlogger?: ITelemetryBaseLogger,\n): IDocumentService {\n\treturn new LocalDocumentService(\n\t\tresolvedUrl,\n\t\tlocalDeltaConnectionServer,\n\t\ttokenProvider,\n\t\ttenantId,\n\t\tdocumentId,\n\t\tdocumentDeltaConnectionsMap,\n\t\tpolicies,\n\t\tinnerDocumentService,\n\t\tlogger,\n\t);\n}\n"]}
@@ -17,7 +17,6 @@ export declare class LocalDocumentServiceFactory implements IDocumentServiceFact
17
17
  private readonly documentDeltaConnectionsMap;
18
18
  /**
19
19
  * @param localDeltaConnectionServer - delta connection server for ops
20
- * @alpha
21
20
  */
22
21
  constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
23
22
  createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
@@ -1 +1 @@
1
- {"version":3,"file":"localDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../src/localDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAKnF;;;GAGG;AACH,qBAAa,2BAA4B,YAAW,uBAAuB;IAUzE,OAAO,CAAC,QAAQ,CAAC,0BAA0B;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAVvC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CACjC;IAEX;;;OAGG;gBAEe,0BAA0B,EAAE,2BAA2B,EACvD,QAAQ,CAAC,sCAA0B,EACnC,oBAAoB,CAAC,8BAAkB;IAG5C,eAAe,CAC3B,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAU5B;;;;OAIG;IACU,qBAAqB,CACjC,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IA8B5B;;;;OAIG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM;IAQlE;;;;;;OAMG;IACI,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,GAAG;CAOtF"}
1
+ {"version":3,"file":"localDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../src/localDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAKnF;;;GAGG;AACH,qBAAa,2BAA4B,YAAW,uBAAuB;IASzE,OAAO,CAAC,QAAQ,CAAC,0BAA0B;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IATvC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CACjC;IAEX;;OAEG;gBAEe,0BAA0B,EAAE,2BAA2B,EACvD,QAAQ,CAAC,sCAA0B,EACnC,oBAAoB,CAAC,8BAAkB;IAG5C,eAAe,CAC3B,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAU5B;;;;OAIG;IACU,qBAAqB,CACjC,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IA8B5B;;;;OAIG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM;IAQlE;;;;;;OAMG;IACI,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,GAAG;CAOtF"}