@fluidframework/replay-driver 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

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 (121) hide show
  1. package/.eslintrc.js +5 -7
  2. package/CHANGELOG.md +144 -0
  3. package/README.md +38 -0
  4. package/api-extractor-lint.json +4 -0
  5. package/api-extractor.json +2 -2
  6. package/api-report/replay-driver.api.md +150 -0
  7. package/dist/{emptyDeltaStorageService.js → emptyDeltaStorageService.cjs} +1 -1
  8. package/dist/emptyDeltaStorageService.cjs.map +1 -0
  9. package/dist/emptyDeltaStorageService.d.ts.map +1 -1
  10. package/dist/index.cjs +20 -0
  11. package/dist/index.cjs.map +1 -0
  12. package/dist/index.d.ts +4 -4
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/replay-driver-alpha.d.ts +34 -0
  15. package/dist/replay-driver-beta.d.ts +44 -0
  16. package/dist/replay-driver-public.d.ts +44 -0
  17. package/dist/replay-driver-untrimmed.d.ts +187 -0
  18. package/dist/{replayController.js → replayController.cjs} +6 -4
  19. package/dist/replayController.cjs.map +1 -0
  20. package/dist/replayController.d.ts +4 -2
  21. package/dist/replayController.d.ts.map +1 -1
  22. package/dist/{replayDocumentDeltaConnection.js → replayDocumentDeltaConnection.cjs} +25 -27
  23. package/dist/replayDocumentDeltaConnection.cjs.map +1 -0
  24. package/dist/replayDocumentDeltaConnection.d.ts +2 -2
  25. package/dist/replayDocumentDeltaConnection.d.ts.map +1 -1
  26. package/dist/{replayDocumentService.js → replayDocumentService.cjs} +9 -7
  27. package/dist/replayDocumentService.cjs.map +1 -0
  28. package/dist/replayDocumentService.d.ts +1 -0
  29. package/dist/replayDocumentService.d.ts.map +1 -1
  30. package/dist/{replayDocumentServiceFactory.js → replayDocumentServiceFactory.cjs} +13 -8
  31. package/dist/replayDocumentServiceFactory.cjs.map +1 -0
  32. package/dist/replayDocumentServiceFactory.d.ts +4 -2
  33. package/dist/replayDocumentServiceFactory.d.ts.map +1 -1
  34. package/dist/{storageImplementations.js → storageImplementations.cjs} +21 -12
  35. package/dist/storageImplementations.cjs.map +1 -0
  36. package/dist/storageImplementations.d.ts +18 -6
  37. package/dist/storageImplementations.d.ts.map +1 -1
  38. package/dist/tsdoc-metadata.json +11 -0
  39. package/lib/emptyDeltaStorageService.d.mts.map +1 -0
  40. package/lib/{emptyDeltaStorageService.js → emptyDeltaStorageService.mjs} +1 -1
  41. package/lib/emptyDeltaStorageService.mjs.map +1 -0
  42. package/lib/index.d.mts +9 -0
  43. package/lib/index.d.mts.map +1 -0
  44. package/lib/index.mjs +9 -0
  45. package/lib/index.mjs.map +1 -0
  46. package/lib/replay-driver-alpha.d.mts +34 -0
  47. package/lib/replay-driver-beta.d.mts +44 -0
  48. package/lib/replay-driver-public.d.mts +44 -0
  49. package/lib/replay-driver-untrimmed.d.mts +187 -0
  50. package/lib/{replayController.d.ts → replayController.d.mts} +4 -2
  51. package/lib/replayController.d.mts.map +1 -0
  52. package/lib/{replayController.js → replayController.mjs} +6 -4
  53. package/lib/replayController.mjs.map +1 -0
  54. package/lib/{replayDocumentDeltaConnection.d.ts → replayDocumentDeltaConnection.d.mts} +3 -3
  55. package/lib/replayDocumentDeltaConnection.d.mts.map +1 -0
  56. package/lib/{replayDocumentDeltaConnection.js → replayDocumentDeltaConnection.mjs} +23 -25
  57. package/lib/replayDocumentDeltaConnection.mjs.map +1 -0
  58. package/lib/{replayDocumentService.d.ts → replayDocumentService.d.mts} +2 -1
  59. package/lib/replayDocumentService.d.mts.map +1 -0
  60. package/lib/{replayDocumentService.js → replayDocumentService.mjs} +9 -7
  61. package/lib/replayDocumentService.mjs.map +1 -0
  62. package/lib/{replayDocumentServiceFactory.d.ts → replayDocumentServiceFactory.d.mts} +5 -3
  63. package/lib/replayDocumentServiceFactory.d.mts.map +1 -0
  64. package/lib/{replayDocumentServiceFactory.js → replayDocumentServiceFactory.mjs} +14 -9
  65. package/lib/replayDocumentServiceFactory.mjs.map +1 -0
  66. package/lib/{storageImplementations.d.ts → storageImplementations.d.mts} +19 -7
  67. package/lib/storageImplementations.d.mts.map +1 -0
  68. package/lib/{storageImplementations.js → storageImplementations.mjs} +20 -11
  69. package/lib/storageImplementations.mjs.map +1 -0
  70. package/lib/test/types/validateReplayDriverPrevious.generated.d.mts +2 -0
  71. package/lib/test/types/validateReplayDriverPrevious.generated.d.mts.map +1 -0
  72. package/lib/test/types/{validateReplayDriverPrevious.js → validateReplayDriverPrevious.generated.mjs} +1 -3
  73. package/lib/test/types/validateReplayDriverPrevious.generated.mjs.map +1 -0
  74. package/package.json +79 -47
  75. package/prettier.config.cjs +8 -0
  76. package/src/emptyDeltaStorageService.ts +14 -13
  77. package/src/index.ts +10 -4
  78. package/src/replayController.ts +61 -55
  79. package/src/replayDocumentDeltaConnection.ts +326 -318
  80. package/src/replayDocumentService.ts +48 -44
  81. package/src/replayDocumentServiceFactory.ts +59 -47
  82. package/src/storageImplementations.ts +168 -153
  83. package/tsconfig.json +11 -13
  84. package/dist/emptyDeltaStorageService.js.map +0 -1
  85. package/dist/index.js +0 -21
  86. package/dist/index.js.map +0 -1
  87. package/dist/packageVersion.d.ts +0 -9
  88. package/dist/packageVersion.d.ts.map +0 -1
  89. package/dist/packageVersion.js +0 -12
  90. package/dist/packageVersion.js.map +0 -1
  91. package/dist/replayController.js.map +0 -1
  92. package/dist/replayDocumentDeltaConnection.js.map +0 -1
  93. package/dist/replayDocumentService.js.map +0 -1
  94. package/dist/replayDocumentServiceFactory.js.map +0 -1
  95. package/dist/storageImplementations.js.map +0 -1
  96. package/lib/emptyDeltaStorageService.d.ts.map +0 -1
  97. package/lib/emptyDeltaStorageService.js.map +0 -1
  98. package/lib/index.d.ts +0 -9
  99. package/lib/index.d.ts.map +0 -1
  100. package/lib/index.js +0 -9
  101. package/lib/index.js.map +0 -1
  102. package/lib/packageVersion.d.ts +0 -9
  103. package/lib/packageVersion.d.ts.map +0 -1
  104. package/lib/packageVersion.js +0 -9
  105. package/lib/packageVersion.js.map +0 -1
  106. package/lib/replayController.d.ts.map +0 -1
  107. package/lib/replayController.js.map +0 -1
  108. package/lib/replayDocumentDeltaConnection.d.ts.map +0 -1
  109. package/lib/replayDocumentDeltaConnection.js.map +0 -1
  110. package/lib/replayDocumentService.d.ts.map +0 -1
  111. package/lib/replayDocumentService.js.map +0 -1
  112. package/lib/replayDocumentServiceFactory.d.ts.map +0 -1
  113. package/lib/replayDocumentServiceFactory.js.map +0 -1
  114. package/lib/storageImplementations.d.ts.map +0 -1
  115. package/lib/storageImplementations.js.map +0 -1
  116. package/lib/test/types/validateReplayDriverPrevious.d.ts +0 -2
  117. package/lib/test/types/validateReplayDriverPrevious.d.ts.map +0 -1
  118. package/lib/test/types/validateReplayDriverPrevious.js.map +0 -1
  119. package/src/packageVersion.ts +0 -9
  120. package/tsconfig.esnext.json +0 -7
  121. /package/lib/{emptyDeltaStorageService.d.ts → emptyDeltaStorageService.d.mts} +0 -0
package/.eslintrc.js CHANGED
@@ -4,10 +4,8 @@
4
4
  */
5
5
 
6
6
  module.exports = {
7
- "extends": [
8
- require.resolve("@fluidframework/eslint-config-fluid")
9
- ],
10
- "rules": {
11
- "@typescript-eslint/strict-boolean-expressions": "off",
12
- }
13
- }
7
+ extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
8
+ rules: {
9
+ "@typescript-eslint/strict-boolean-expressions": "off",
10
+ },
11
+ };
package/CHANGELOG.md ADDED
@@ -0,0 +1,144 @@
1
+ # @fluidframework/replay-driver
2
+
3
+ ## 2.0.0-internal.8.0.0
4
+
5
+ Dependency updates only.
6
+
7
+ ## 2.0.0-internal.7.4.0
8
+
9
+ Dependency updates only.
10
+
11
+ ## 2.0.0-internal.7.3.0
12
+
13
+ Dependency updates only.
14
+
15
+ ## 2.0.0-internal.7.2.0
16
+
17
+ Dependency updates only.
18
+
19
+ ## 2.0.0-internal.7.1.0
20
+
21
+ Dependency updates only.
22
+
23
+ ## 2.0.0-internal.7.0.0
24
+
25
+ ### Major Changes
26
+
27
+ - Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
28
+
29
+ This included the following changes from the protocol-definitions release:
30
+
31
+ - Updating signal interfaces for some planned improvements. The intention is split the interface between signals
32
+ submitted by clients to the server and the resulting signals sent from the server to clients.
33
+ - A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
34
+ been added, which will be the typing for signals sent from the client to the server. Both extend a new
35
+ ISignalMessageBase interface that contains common members.
36
+ - The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
37
+
38
+ - Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
39
+
40
+ Dependencies on the following Fluid server package have been updated to version 2.0.1:
41
+
42
+ - @fluidframework/gitresources: 2.0.1
43
+ - @fluidframework/server-kafka-orderer: 2.0.1
44
+ - @fluidframework/server-lambdas: 2.0.1
45
+ - @fluidframework/server-lambdas-driver: 2.0.1
46
+ - @fluidframework/server-local-server: 2.0.1
47
+ - @fluidframework/server-memory-orderer: 2.0.1
48
+ - @fluidframework/protocol-base: 2.0.1
49
+ - @fluidframework/server-routerlicious: 2.0.1
50
+ - @fluidframework/server-routerlicious-base: 2.0.1
51
+ - @fluidframework/server-services: 2.0.1
52
+ - @fluidframework/server-services-client: 2.0.1
53
+ - @fluidframework/server-services-core: 2.0.1
54
+ - @fluidframework/server-services-ordering-kafkanode: 2.0.1
55
+ - @fluidframework/server-services-ordering-rdkafka: 2.0.1
56
+ - @fluidframework/server-services-ordering-zookeeper: 2.0.1
57
+ - @fluidframework/server-services-shared: 2.0.1
58
+ - @fluidframework/server-services-telemetry: 2.0.1
59
+ - @fluidframework/server-services-utils: 2.0.1
60
+ - @fluidframework/server-test-utils: 2.0.1
61
+ - tinylicious: 2.0.1
62
+
63
+ - Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
64
+
65
+ The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
66
+
67
+ ## 2.0.0-internal.6.4.0
68
+
69
+ Dependency updates only.
70
+
71
+ ## 2.0.0-internal.6.3.0
72
+
73
+ Dependency updates only.
74
+
75
+ ## 2.0.0-internal.6.2.0
76
+
77
+ ### Minor Changes
78
+
79
+ - Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
80
+
81
+ The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
82
+ imported from the **@fluidframework/core-interfaces** package:
83
+
84
+ - interface IDisposable
85
+ - interface IErrorEvent
86
+ - interface IErrorEvent
87
+ - interface IEvent
88
+ - interface IEventProvider
89
+ - interface ILoggingError
90
+ - interface ITaggedTelemetryPropertyType
91
+ - interface ITelemetryBaseEvent
92
+ - interface ITelemetryBaseLogger
93
+ - interface ITelemetryErrorEvent
94
+ - interface ITelemetryGenericEvent
95
+ - interface ITelemetryLogger
96
+ - interface ITelemetryPerformanceEvent
97
+ - interface ITelemetryProperties
98
+ - type ExtendEventProvider
99
+ - type IEventThisPlaceHolder
100
+ - type IEventTransformer
101
+ - type ReplaceIEventThisPlaceHolder
102
+ - type ReplaceIEventThisPlaceHolder
103
+ - type TelemetryEventCategory
104
+ - type TelemetryEventPropertyType
105
+
106
+ ## 2.0.0-internal.6.1.0
107
+
108
+ Dependency updates only.
109
+
110
+ ## 2.0.0-internal.6.0.0
111
+
112
+ ### Major Changes
113
+
114
+ - Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
115
+
116
+ Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
117
+
118
+ ## 2.0.0-internal.5.4.0
119
+
120
+ Dependency updates only.
121
+
122
+ ## 2.0.0-internal.5.3.0
123
+
124
+ Dependency updates only.
125
+
126
+ ## 2.0.0-internal.5.2.0
127
+
128
+ Dependency updates only.
129
+
130
+ ## 2.0.0-internal.5.1.0
131
+
132
+ Dependency updates only.
133
+
134
+ ## 2.0.0-internal.5.0.0
135
+
136
+ Dependency updates only.
137
+
138
+ ## 2.0.0-internal.4.4.0
139
+
140
+ Dependency updates only.
141
+
142
+ ## 2.0.0-internal.4.1.0
143
+
144
+ Dependency updates only.
package/README.md CHANGED
@@ -2,3 +2,41 @@
2
2
 
3
3
  This is an implementation of a driver which provides a DocumentService which uses the DocumentService provided to it to fetch ops and then replay those ops
4
4
  to mimic the web socket connection.
5
+
6
+ <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
7
+
8
+ <!-- prettier-ignore-start -->
9
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
10
+
11
+ ## Using Fluid Framework libraries
12
+
13
+ When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
14
+ While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
15
+ library consumers should always prefer `^`.
16
+
17
+ Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
18
+ you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
19
+ Standard `^` and `~` ranges will not work as expected.
20
+ See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
21
+ package for more information including tools to convert between version schemes.
22
+
23
+ <!-- prettier-ignore-end -->
24
+
25
+ <!-- AUTO-GENERATED-CONTENT:END -->
26
+
27
+ <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
28
+
29
+ <!-- prettier-ignore-start -->
30
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
31
+
32
+ ## Trademark
33
+
34
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
35
+
36
+ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
37
+
38
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
39
+
40
+ <!-- prettier-ignore-end -->
41
+
42
+ <!-- AUTO-GENERATED-CONTENT:END -->
@@ -0,0 +1,4 @@
1
+ {
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"
4
+ }
@@ -1,4 +1,4 @@
1
1
  {
2
- "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "@fluidframework/build-common/api-extractor-common-report.json"
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"
4
4
  }
@@ -0,0 +1,150 @@
1
+ ## API Report File for "@fluidframework/replay-driver"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import * as api from '@fluidframework/protocol-definitions';
8
+ import * as api_2 from '@fluidframework/driver-definitions';
9
+ import { IClient } from '@fluidframework/protocol-definitions';
10
+ import { IDocumentService } from '@fluidframework/driver-definitions';
11
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
12
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
13
+ import { IResolvedUrl } from '@fluidframework/driver-definitions';
14
+ import { ISnapshotTree } from '@fluidframework/protocol-definitions';
15
+ import { ISummaryContext } from '@fluidframework/driver-definitions';
16
+ import { ISummaryTree } from '@fluidframework/protocol-definitions';
17
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
18
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
19
+ import { ITree } from '@fluidframework/protocol-definitions';
20
+ import { IVersion } from '@fluidframework/protocol-definitions';
21
+
22
+ // @internal (undocumented)
23
+ export class FileSnapshotReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
24
+ constructor(json: IFileSnapshot);
25
+ // (undocumented)
26
+ protected blobs: Map<string, ArrayBufferLike>;
27
+ // (undocumented)
28
+ protected readonly commits: {
29
+ [key: string]: ITree;
30
+ };
31
+ // (undocumented)
32
+ protected docId?: string;
33
+ // (undocumented)
34
+ protected docTree: ISnapshotTree;
35
+ // (undocumented)
36
+ protected static readonly FileStorageVersionTreeId = "FileStorageTreeId";
37
+ // (undocumented)
38
+ getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
39
+ // (undocumented)
40
+ getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
41
+ // (undocumented)
42
+ readBlob(blobId: string): Promise<ArrayBufferLike>;
43
+ // (undocumented)
44
+ protected readonly trees: {
45
+ [key: string]: ISnapshotTree;
46
+ };
47
+ }
48
+
49
+ // @internal
50
+ export interface IFileSnapshot {
51
+ // (undocumented)
52
+ commits: {
53
+ [key: string]: ITree;
54
+ };
55
+ // (undocumented)
56
+ tree: ITree;
57
+ }
58
+
59
+ // @internal (undocumented)
60
+ export class OpStorage extends ReadDocumentStorageServiceBase {
61
+ // (undocumented)
62
+ getSnapshotTree(version?: IVersion): Promise<ISnapshotTree | null>;
63
+ // (undocumented)
64
+ getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
65
+ // (undocumented)
66
+ readBlob(blobId: string): Promise<ArrayBufferLike>;
67
+ }
68
+
69
+ // @internal
70
+ export abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
71
+ // (undocumented)
72
+ createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
73
+ // (undocumented)
74
+ downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
75
+ // (undocumented)
76
+ abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
77
+ // (undocumented)
78
+ abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
79
+ // (undocumented)
80
+ abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
81
+ // (undocumented)
82
+ get repositoryUrl(): string;
83
+ // (undocumented)
84
+ uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
85
+ }
86
+
87
+ // @internal
88
+ export abstract class ReplayController extends ReadDocumentStorageServiceBase {
89
+ abstract fetchTo(currentOp: number): number | undefined;
90
+ abstract getStartingOpSequence(): Promise<number>;
91
+ abstract initStorage(documentService: IDocumentService): Promise<boolean>;
92
+ abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
93
+ abstract replay(emitter: (op: api.ISequencedDocumentMessage[]) => void, fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
94
+ }
95
+
96
+ // @internal
97
+ export class ReplayDocumentService implements api_2.IDocumentService {
98
+ constructor(controller: api_2.IDocumentStorageService, deltaStorage: api_2.IDocumentDeltaConnection);
99
+ connectToDeltaStorage(): Promise<api_2.IDocumentDeltaStorageService>;
100
+ connectToDeltaStream(client: IClient): Promise<api_2.IDocumentDeltaConnection>;
101
+ connectToStorage(): Promise<api_2.IDocumentStorageService>;
102
+ // (undocumented)
103
+ static create(documentService: api_2.IDocumentService, controller: ReplayController): Promise<api_2.IDocumentService>;
104
+ // (undocumented)
105
+ dispose(): void;
106
+ // (undocumented)
107
+ get resolvedUrl(): api_2.IResolvedUrl;
108
+ }
109
+
110
+ // @internal (undocumented)
111
+ export class ReplayDocumentServiceFactory implements IDocumentServiceFactory {
112
+ constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);
113
+ // (undocumented)
114
+ static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;
115
+ // (undocumented)
116
+ createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
117
+ createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
118
+ }
119
+
120
+ // @internal (undocumented)
121
+ export class SnapshotStorage extends ReadDocumentStorageServiceBase {
122
+ constructor(storage: IDocumentStorageService, docTree: ISnapshotTree | null);
123
+ // (undocumented)
124
+ protected docId?: string;
125
+ // (undocumented)
126
+ protected readonly docTree: ISnapshotTree | null;
127
+ // (undocumented)
128
+ getSnapshotTree(versionRequested?: IVersion): Promise<ISnapshotTree | null>;
129
+ // (undocumented)
130
+ getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
131
+ // (undocumented)
132
+ readBlob(blobId: string): Promise<ArrayBufferLike>;
133
+ // (undocumented)
134
+ protected readonly storage: IDocumentStorageService;
135
+ }
136
+
137
+ // @internal (undocumented)
138
+ export class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory {
139
+ constructor(storage: IDocumentStorageService);
140
+ // (undocumented)
141
+ createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
142
+ // (undocumented)
143
+ createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLoggerExt, clientIsSummarizer?: boolean): Promise<IDocumentService>;
144
+ // (undocumented)
145
+ protected readonly storage: IDocumentStorageService;
146
+ }
147
+
148
+ // (No @packageDocumentation comment for this package)
149
+
150
+ ```
@@ -18,4 +18,4 @@ class EmptyDeltaStorageService {
18
18
  }
19
19
  }
20
20
  exports.EmptyDeltaStorageService = EmptyDeltaStorageService;
21
- //# sourceMappingURL=emptyDeltaStorageService.js.map
21
+ //# sourceMappingURL=emptyDeltaStorageService.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"emptyDeltaStorageService.cjs","sourceRoot":"","sources":["../src/emptyDeltaStorageService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,+DAAkE;AAElE,MAAa,wBAAwB;IACpC;;;;;OAKG;IACI,aAAa,CACnB,IAAY,EACZ,EAAsB,EACtB,WAAyB,EACzB,UAAoB;QAEpB,OAAO,iCAAkB,CAAC;IAC3B,CAAC;CACD;AAfD,4DAeC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentDeltaStorageService, IStream } from \"@fluidframework/driver-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { emptyMessageStream } from \"@fluidframework/driver-utils\";\n\nexport class EmptyDeltaStorageService implements IDocumentDeltaStorageService {\n\t/**\n\t * Returns ops from the list of ops generated till now.\n\t * @param from - Ops are returned from + 1.\n\t * @param to - Op are returned from to - 1.\n\t * @returns Array of ops requested by the user.\n\t */\n\tpublic fetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t): IStream<ISequencedDocumentMessage[]> {\n\t\treturn emptyMessageStream;\n\t}\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"emptyDeltaStorageService.d.ts","sourceRoot":"","sources":["../src/emptyDeltaStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAGjF,qBAAa,wBAAyB,YAAW,4BAA4B;IACzE;;;;;OAKG;IACI,aAAa,CAChB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;CAGlE"}
1
+ {"version":3,"file":"emptyDeltaStorageService.d.ts","sourceRoot":"","sources":["../src/emptyDeltaStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAGjF,qBAAa,wBAAyB,YAAW,4BAA4B;IAC5E;;;;;OAKG;IACI,aAAa,CACnB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC,yBAAyB,EAAE,CAAC;CAGvC"}
package/dist/index.cjs ADDED
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ /*!
3
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
+ * Licensed under the MIT License.
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.StaticStorageDocumentServiceFactory = exports.SnapshotStorage = exports.OpStorage = exports.FileSnapshotReader = exports.ReplayDocumentServiceFactory = exports.ReplayDocumentService = exports.ReplayController = exports.ReadDocumentStorageServiceBase = void 0;
8
+ var replayController_1 = require("./replayController.cjs");
9
+ Object.defineProperty(exports, "ReadDocumentStorageServiceBase", { enumerable: true, get: function () { return replayController_1.ReadDocumentStorageServiceBase; } });
10
+ Object.defineProperty(exports, "ReplayController", { enumerable: true, get: function () { return replayController_1.ReplayController; } });
11
+ var replayDocumentService_1 = require("./replayDocumentService.cjs");
12
+ Object.defineProperty(exports, "ReplayDocumentService", { enumerable: true, get: function () { return replayDocumentService_1.ReplayDocumentService; } });
13
+ var replayDocumentServiceFactory_1 = require("./replayDocumentServiceFactory.cjs");
14
+ Object.defineProperty(exports, "ReplayDocumentServiceFactory", { enumerable: true, get: function () { return replayDocumentServiceFactory_1.ReplayDocumentServiceFactory; } });
15
+ var storageImplementations_1 = require("./storageImplementations.cjs");
16
+ Object.defineProperty(exports, "FileSnapshotReader", { enumerable: true, get: function () { return storageImplementations_1.FileSnapshotReader; } });
17
+ Object.defineProperty(exports, "OpStorage", { enumerable: true, get: function () { return storageImplementations_1.OpStorage; } });
18
+ Object.defineProperty(exports, "SnapshotStorage", { enumerable: true, get: function () { return storageImplementations_1.SnapshotStorage; } });
19
+ Object.defineProperty(exports, "StaticStorageDocumentServiceFactory", { enumerable: true, get: function () { return storageImplementations_1.StaticStorageDocumentServiceFactory; } });
20
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAsF;AAA7E,kIAAA,8BAA8B,OAAA;AAAE,oHAAA,gBAAgB,OAAA;AACzD,qEAAgE;AAAvD,8HAAA,qBAAqB,OAAA;AAC9B,mFAA8E;AAArE,4IAAA,4BAA4B,OAAA;AACrC,uEAMkC;AALjC,4HAAA,kBAAkB,OAAA;AAElB,mHAAA,SAAS,OAAA;AACT,yHAAA,eAAe,OAAA;AACf,6IAAA,mCAAmC,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ReadDocumentStorageServiceBase, ReplayController } from \"./replayController\";\nexport { ReplayDocumentService } from \"./replayDocumentService\";\nexport { ReplayDocumentServiceFactory } from \"./replayDocumentServiceFactory\";\nexport {\n\tFileSnapshotReader,\n\tIFileSnapshot,\n\tOpStorage,\n\tSnapshotStorage,\n\tStaticStorageDocumentServiceFactory,\n} from \"./storageImplementations\";\n"]}
package/dist/index.d.ts CHANGED
@@ -2,8 +2,8 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export * from "./replayController";
6
- export * from "./replayDocumentService";
7
- export * from "./replayDocumentServiceFactory";
8
- export * from "./storageImplementations";
5
+ export { ReadDocumentStorageServiceBase, ReplayController } from "./replayController";
6
+ export { ReplayDocumentService } from "./replayDocumentService";
7
+ export { ReplayDocumentServiceFactory } from "./replayDocumentServiceFactory";
8
+ export { FileSnapshotReader, IFileSnapshot, OpStorage, SnapshotStorage, StaticStorageDocumentServiceFactory, } from "./storageImplementations";
9
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,8BAA8B,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtF,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EACN,kBAAkB,EAClB,aAAa,EACb,SAAS,EACT,eAAe,EACf,mCAAmC,GACnC,MAAM,0BAA0B,CAAC"}
@@ -0,0 +1,34 @@
1
+ import * as api from '@fluidframework/protocol-definitions';
2
+ import * as api_2 from '@fluidframework/driver-definitions';
3
+ import { IClient } from '@fluidframework/protocol-definitions';
4
+ import { IDocumentService } from '@fluidframework/driver-definitions';
5
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
6
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
7
+ import { IResolvedUrl } from '@fluidframework/driver-definitions';
8
+ import { ISnapshotTree } from '@fluidframework/protocol-definitions';
9
+ import { ISummaryContext } from '@fluidframework/driver-definitions';
10
+ import { ISummaryTree } from '@fluidframework/protocol-definitions';
11
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
12
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
13
+ import { ITree } from '@fluidframework/protocol-definitions';
14
+ import { IVersion } from '@fluidframework/protocol-definitions';
15
+
16
+ /* Excluded from this release type: FileSnapshotReader */
17
+
18
+ /* Excluded from this release type: IFileSnapshot */
19
+
20
+ /* Excluded from this release type: OpStorage */
21
+
22
+ /* Excluded from this release type: ReadDocumentStorageServiceBase */
23
+
24
+ /* Excluded from this release type: ReplayController */
25
+
26
+ /* Excluded from this release type: ReplayDocumentService */
27
+
28
+ /* Excluded from this release type: ReplayDocumentServiceFactory */
29
+
30
+ /* Excluded from this release type: SnapshotStorage */
31
+
32
+ /* Excluded from this release type: StaticStorageDocumentServiceFactory */
33
+
34
+ export { }
@@ -0,0 +1,44 @@
1
+ import * as api from '@fluidframework/protocol-definitions';
2
+ import * as api_2 from '@fluidframework/driver-definitions';
3
+ import { IClient } from '@fluidframework/protocol-definitions';
4
+ import { IDocumentService } from '@fluidframework/driver-definitions';
5
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
6
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
7
+ import { IResolvedUrl } from '@fluidframework/driver-definitions';
8
+ import { ISnapshotTree } from '@fluidframework/protocol-definitions';
9
+ import { ISummaryContext } from '@fluidframework/driver-definitions';
10
+ import { ISummaryTree } from '@fluidframework/protocol-definitions';
11
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
12
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
13
+ import { ITree } from '@fluidframework/protocol-definitions';
14
+ import { IVersion } from '@fluidframework/protocol-definitions';
15
+
16
+ /* Excluded from this release type: FileSnapshotReader */
17
+
18
+ /* Excluded from this release type: IDocumentService */
19
+
20
+ /* Excluded from this release type: IDocumentServiceFactory */
21
+
22
+ /* Excluded from this release type: IDocumentStorageService */
23
+
24
+ /* Excluded from this release type: IFileSnapshot */
25
+
26
+ /* Excluded from this release type: IResolvedUrl */
27
+
28
+ /* Excluded from this release type: ISummaryContext */
29
+
30
+ /* Excluded from this release type: OpStorage */
31
+
32
+ /* Excluded from this release type: ReadDocumentStorageServiceBase */
33
+
34
+ /* Excluded from this release type: ReplayController */
35
+
36
+ /* Excluded from this release type: ReplayDocumentService */
37
+
38
+ /* Excluded from this release type: ReplayDocumentServiceFactory */
39
+
40
+ /* Excluded from this release type: SnapshotStorage */
41
+
42
+ /* Excluded from this release type: StaticStorageDocumentServiceFactory */
43
+
44
+ export { }
@@ -0,0 +1,44 @@
1
+ import * as api from '@fluidframework/protocol-definitions';
2
+ import * as api_2 from '@fluidframework/driver-definitions';
3
+ import { IClient } from '@fluidframework/protocol-definitions';
4
+ import { IDocumentService } from '@fluidframework/driver-definitions';
5
+ import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
6
+ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
7
+ import { IResolvedUrl } from '@fluidframework/driver-definitions';
8
+ import { ISnapshotTree } from '@fluidframework/protocol-definitions';
9
+ import { ISummaryContext } from '@fluidframework/driver-definitions';
10
+ import { ISummaryTree } from '@fluidframework/protocol-definitions';
11
+ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
12
+ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
13
+ import { ITree } from '@fluidframework/protocol-definitions';
14
+ import { IVersion } from '@fluidframework/protocol-definitions';
15
+
16
+ /* Excluded from this release type: FileSnapshotReader */
17
+
18
+ /* Excluded from this release type: IDocumentService */
19
+
20
+ /* Excluded from this release type: IDocumentServiceFactory */
21
+
22
+ /* Excluded from this release type: IDocumentStorageService */
23
+
24
+ /* Excluded from this release type: IFileSnapshot */
25
+
26
+ /* Excluded from this release type: IResolvedUrl */
27
+
28
+ /* Excluded from this release type: ISummaryContext */
29
+
30
+ /* Excluded from this release type: OpStorage */
31
+
32
+ /* Excluded from this release type: ReadDocumentStorageServiceBase */
33
+
34
+ /* Excluded from this release type: ReplayController */
35
+
36
+ /* Excluded from this release type: ReplayDocumentService */
37
+
38
+ /* Excluded from this release type: ReplayDocumentServiceFactory */
39
+
40
+ /* Excluded from this release type: SnapshotStorage */
41
+
42
+ /* Excluded from this release type: StaticStorageDocumentServiceFactory */
43
+
44
+ export { }