@fluidframework/container-loader 2.116.0-416006 → 2.116.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/README.md +5 -3
- package/api-report/container-loader.legacy.alpha.api.md +2 -2
- package/api-report/container-loader.legacy.beta.api.md +10 -0
- package/dist/legacy.d.ts +2 -0
- package/dist/legacyAlpha.d.ts +2 -2
- package/dist/loadContainerToSequenceNumber.d.ts +2 -2
- package/dist/loadContainerToSequenceNumber.js +1 -1
- package/dist/loadContainerToSequenceNumber.js.map +1 -1
- package/dist/loaderLayerCompatState.d.ts +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.d.ts.map +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/lib/legacy.d.ts +2 -0
- package/lib/legacyAlpha.d.ts +2 -2
- package/lib/loadContainerToSequenceNumber.d.ts +2 -2
- package/lib/loadContainerToSequenceNumber.js +1 -1
- package/lib/loadContainerToSequenceNumber.js.map +1 -1
- package/lib/loaderLayerCompatState.d.ts +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.d.ts.map +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/package.json +16 -16
- package/src/loadContainerToSequenceNumber.ts +2 -2
- package/src/packageVersion.ts +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -354,7 +354,7 @@ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/
|
|
|
354
354
|
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
355
355
|
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
356
356
|
|
|
357
|
-
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/
|
|
357
|
+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
358
358
|
|
|
359
359
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
360
360
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
|
@@ -365,9 +365,11 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
|
|
|
365
365
|
|
|
366
366
|
## Help
|
|
367
367
|
|
|
368
|
-
Not finding what you're looking for in this README?
|
|
368
|
+
Not finding what you're looking for in this README?
|
|
369
|
+
Check out [fluidframework.com](https://fluidframework.com/docs/).
|
|
369
370
|
|
|
370
|
-
Still not finding what you're looking for?
|
|
371
|
+
Still not finding what you're looking for?
|
|
372
|
+
Please [file an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md).
|
|
371
373
|
|
|
372
374
|
Thank you!
|
|
373
375
|
|
|
@@ -98,7 +98,7 @@ export interface IFluidModuleWithDetails {
|
|
|
98
98
|
module: IFluidModule;
|
|
99
99
|
}
|
|
100
100
|
|
|
101
|
-
// @
|
|
101
|
+
// @beta @legacy
|
|
102
102
|
export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps, IContainerDriverServices {
|
|
103
103
|
readonly loadToSequenceNumber: number;
|
|
104
104
|
readonly request: IRequest;
|
|
@@ -188,7 +188,7 @@ export interface IScribeProtocolState {
|
|
|
188
188
|
values: [string, ICommittedProposal][];
|
|
189
189
|
}
|
|
190
190
|
|
|
191
|
-
// @
|
|
191
|
+
// @beta @legacy
|
|
192
192
|
export function loadContainerToSequenceNumber(props: ILoadContainerToSequenceNumberProps): Promise<IContainer>;
|
|
193
193
|
|
|
194
194
|
// @beta @legacy
|
|
@@ -76,6 +76,13 @@ export interface IFluidModuleWithDetails {
|
|
|
76
76
|
module: IFluidModule;
|
|
77
77
|
}
|
|
78
78
|
|
|
79
|
+
// @beta @legacy
|
|
80
|
+
export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps, IContainerDriverServices {
|
|
81
|
+
readonly loadToSequenceNumber: number;
|
|
82
|
+
readonly request: IRequest;
|
|
83
|
+
readonly signal?: AbortSignal | undefined;
|
|
84
|
+
}
|
|
85
|
+
|
|
79
86
|
// @beta @legacy
|
|
80
87
|
export interface ILoaderProps {
|
|
81
88
|
readonly codeLoader: ICodeDetailsLoader;
|
|
@@ -150,6 +157,9 @@ export interface IScribeProtocolState {
|
|
|
150
157
|
values: [string, ICommittedProposal][];
|
|
151
158
|
}
|
|
152
159
|
|
|
160
|
+
// @beta @legacy
|
|
161
|
+
export function loadContainerToSequenceNumber(props: ILoadContainerToSequenceNumberProps): Promise<IContainer>;
|
|
162
|
+
|
|
153
163
|
// @beta @legacy
|
|
154
164
|
export class Loader implements IHostLoader {
|
|
155
165
|
constructor(loaderProps: ILoaderProps);
|
package/dist/legacy.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export {
|
|
|
22
22
|
ICreateAndLoadContainerProps,
|
|
23
23
|
ICreateDetachedContainerProps,
|
|
24
24
|
IFluidModuleWithDetails,
|
|
25
|
+
ILoadContainerToSequenceNumberProps,
|
|
25
26
|
ILoadExistingContainerProps,
|
|
26
27
|
ILoaderProps,
|
|
27
28
|
ILoaderServices,
|
|
@@ -35,6 +36,7 @@ export {
|
|
|
35
36
|
QuorumClientsSnapshot,
|
|
36
37
|
QuorumProposalsSnapshot,
|
|
37
38
|
createDetachedContainer,
|
|
39
|
+
loadContainerToSequenceNumber,
|
|
38
40
|
loadExistingContainer,
|
|
39
41
|
rehydrateDetachedContainer,
|
|
40
42
|
resolveWithLocationRedirectionHandling,
|
package/dist/legacyAlpha.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export {
|
|
|
22
22
|
ICreateAndLoadContainerProps,
|
|
23
23
|
ICreateDetachedContainerProps,
|
|
24
24
|
IFluidModuleWithDetails,
|
|
25
|
+
ILoadContainerToSequenceNumberProps,
|
|
25
26
|
ILoadExistingContainerProps,
|
|
26
27
|
ILoaderProps,
|
|
27
28
|
ILoaderServices,
|
|
@@ -35,6 +36,7 @@ export {
|
|
|
35
36
|
QuorumClientsSnapshot,
|
|
36
37
|
QuorumProposalsSnapshot,
|
|
37
38
|
createDetachedContainer,
|
|
39
|
+
loadContainerToSequenceNumber,
|
|
38
40
|
loadExistingContainer,
|
|
39
41
|
rehydrateDetachedContainer,
|
|
40
42
|
resolveWithLocationRedirectionHandling,
|
|
@@ -45,7 +47,6 @@ export {
|
|
|
45
47
|
// #region @legacyAlpha APIs
|
|
46
48
|
ContainerAlpha,
|
|
47
49
|
ICaptureFullContainerStateProps,
|
|
48
|
-
ILoadContainerToSequenceNumberProps,
|
|
49
50
|
ILoadFrozenContainerFromPendingStateProps,
|
|
50
51
|
ILoadSummarizerContainerProps,
|
|
51
52
|
LoadSummarizerSummaryResult,
|
|
@@ -55,7 +56,6 @@ export {
|
|
|
55
56
|
asLegacyAlpha,
|
|
56
57
|
captureFullContainerState,
|
|
57
58
|
createFrozenDocumentServiceFactory,
|
|
58
|
-
loadContainerToSequenceNumber,
|
|
59
59
|
loadFrozenContainerFromPendingState,
|
|
60
60
|
loadSummarizerContainerAndMakeSummary
|
|
61
61
|
// #endregion
|
|
@@ -15,7 +15,7 @@ import type { IContainerDriverServices, IContainerHostProps } from "./createAndL
|
|
|
15
15
|
* point-in-time capability the loader detects. For ODSP, pass an
|
|
16
16
|
* `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.
|
|
17
17
|
*
|
|
18
|
-
* @legacy @
|
|
18
|
+
* @legacy @beta
|
|
19
19
|
*/
|
|
20
20
|
export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps, IContainerDriverServices {
|
|
21
21
|
/**
|
|
@@ -49,7 +49,7 @@ export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps
|
|
|
49
49
|
* optional cancellation signal.
|
|
50
50
|
* @returns A disconnected, read-only container materialized at the requested sequence number.
|
|
51
51
|
*
|
|
52
|
-
* @legacy @
|
|
52
|
+
* @legacy @beta
|
|
53
53
|
*/
|
|
54
54
|
export declare function loadContainerToSequenceNumber(props: ILoadContainerToSequenceNumberProps): Promise<IContainer>;
|
|
55
55
|
//# sourceMappingURL=loadContainerToSequenceNumber.d.ts.map
|
|
@@ -26,7 +26,7 @@ const pointInTimeServices_js_1 = require("./pointInTimeServices.js");
|
|
|
26
26
|
* optional cancellation signal.
|
|
27
27
|
* @returns A disconnected, read-only container materialized at the requested sequence number.
|
|
28
28
|
*
|
|
29
|
-
* @legacy @
|
|
29
|
+
* @legacy @beta
|
|
30
30
|
*/
|
|
31
31
|
async function loadContainerToSequenceNumber(props) {
|
|
32
32
|
const { loadToSequenceNumber, documentServiceFactory } = props;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"loadContainerToSequenceNumber.js","sourceRoot":"","sources":["../src/loadContainerToSequenceNumber.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,oEAAmE;AAMnE,mDAAsD;AACtD,qEAGkC;AAiClC;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,6BAA6B,CAClD,KAA0C;IAE1C,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,GAAG,KAAK,CAAC;IAC/D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,qBAAU,CACnB,4DAA4D,oBAAoB,GAAG,CACnF,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,IAAA,oDAA2B,EAAC,sBAAsB,CAAC,CAAC;IAC3E,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,qBAAU,CACnB,oJAAoJ,CACpJ,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,kFAAkF;IAClF,MAAM,kBAAkB,GAAG,IAAI,0DAAiC,CAC/D,cAAc,EACd,oBAAoB,CACpB,CAAC;IAEF,OAAO,IAAA,mCAAmB,EACzB,EAAE,GAAG,KAAK,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,EACxD,KAAK,CAAC,OAAO,EACb,oBAAoB,EACpB,KAAK,CAAC,MAAM,CACZ,CAAC;AACH,CAAC;AA9BD,sEA8BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\nimport { UsageError } from \"@fluidframework/driver-utils/internal\";\n\nimport type {\n\tIContainerDriverServices,\n\tIContainerHostProps,\n} from \"./createAndLoadContainerUtils.js\";\nimport { loadContainerPaused } from \"./loadPaused.js\";\nimport {\n\tasPointInTimeCapableFactory,\n\tPointInTimeDocumentServiceFactory,\n} from \"./pointInTimeServices.js\";\n\n/**\n * Properties used to materialize a container at a point in document history.\n *\n * @remarks\n * This is distinct from normal container loading. The supplied\n * {@link IContainerDriverServices.documentServiceFactory} must be able to materialize the document\n * at {@link ILoadContainerToSequenceNumberProps.loadToSequenceNumber} - i.e. it must implement the\n * point-in-time capability the loader detects. For ODSP, pass an\n * `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.\n *\n * @legacy @
|
|
1
|
+
{"version":3,"file":"loadContainerToSequenceNumber.js","sourceRoot":"","sources":["../src/loadContainerToSequenceNumber.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,oEAAmE;AAMnE,mDAAsD;AACtD,qEAGkC;AAiClC;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,6BAA6B,CAClD,KAA0C;IAE1C,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,GAAG,KAAK,CAAC;IAC/D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,qBAAU,CACnB,4DAA4D,oBAAoB,GAAG,CACnF,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,IAAA,oDAA2B,EAAC,sBAAsB,CAAC,CAAC;IAC3E,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,qBAAU,CACnB,oJAAoJ,CACpJ,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,kFAAkF;IAClF,MAAM,kBAAkB,GAAG,IAAI,0DAAiC,CAC/D,cAAc,EACd,oBAAoB,CACpB,CAAC;IAEF,OAAO,IAAA,mCAAmB,EACzB,EAAE,GAAG,KAAK,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,EACxD,KAAK,CAAC,OAAO,EACb,oBAAoB,EACpB,KAAK,CAAC,MAAM,CACZ,CAAC;AACH,CAAC;AA9BD,sEA8BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\nimport { UsageError } from \"@fluidframework/driver-utils/internal\";\n\nimport type {\n\tIContainerDriverServices,\n\tIContainerHostProps,\n} from \"./createAndLoadContainerUtils.js\";\nimport { loadContainerPaused } from \"./loadPaused.js\";\nimport {\n\tasPointInTimeCapableFactory,\n\tPointInTimeDocumentServiceFactory,\n} from \"./pointInTimeServices.js\";\n\n/**\n * Properties used to materialize a container at a point in document history.\n *\n * @remarks\n * This is distinct from normal container loading. The supplied\n * {@link IContainerDriverServices.documentServiceFactory} must be able to materialize the document\n * at {@link ILoadContainerToSequenceNumberProps.loadToSequenceNumber} - i.e. it must implement the\n * point-in-time capability the loader detects. For ODSP, pass an\n * `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.\n *\n * @legacy @beta\n */\nexport interface ILoadContainerToSequenceNumberProps\n\textends IContainerHostProps,\n\t\tIContainerDriverServices {\n\t/**\n\t * The request identifying the container instance.\n\t */\n\treadonly request: IRequest;\n\n\t/**\n\t * The sequence number at which to materialize the container.\n\t */\n\treadonly loadToSequenceNumber: number;\n\n\t/**\n\t * Cancels replay while waiting for the target sequence number.\n\t */\n\treadonly signal?: AbortSignal | undefined;\n}\n\n/**\n * Loads a read-only container at a target sequence number.\n *\n * @remarks\n * The returned container is disconnected with inbound and outbound processing paused. It is a\n * historical view and must not be used as a normal collaborative container.\n *\n * The supplied {@link IContainerDriverServices.documentServiceFactory} must support point-in-time\n * loading: it must be able to serve a snapshot at or before\n * {@link ILoadContainerToSequenceNumberProps.loadToSequenceNumber} and replay the document forward\n * through that sequence number. For ODSP, pass the result of\n * `getOdspPointInTimeDocumentServiceFactory` (from `@fluidframework/odsp-driver`) directly - the\n * loader materializes the point-in-time view itself, so no wrapping or decoration is required.\n *\n * @param props - The load options, point-in-time-capable driver services, target sequence number, and\n * optional cancellation signal.\n * @returns A disconnected, read-only container materialized at the requested sequence number.\n *\n * @legacy @beta\n */\nexport async function loadContainerToSequenceNumber(\n\tprops: ILoadContainerToSequenceNumberProps,\n): Promise<IContainer> {\n\tconst { loadToSequenceNumber, documentServiceFactory } = props;\n\tif (!Number.isInteger(loadToSequenceNumber) || loadToSequenceNumber < 0) {\n\t\tthrow new UsageError(\n\t\t\t`loadToSequenceNumber must be a non-negative integer, got ${loadToSequenceNumber}.`,\n\t\t);\n\t}\n\n\tconst capableFactory = asPointInTimeCapableFactory(documentServiceFactory);\n\tif (capableFactory === undefined) {\n\t\tthrow new UsageError(\n\t\t\t\"The provided documentServiceFactory does not support point-in-time loading. For ODSP, pass the result of getOdspPointInTimeDocumentServiceFactory.\",\n\t\t);\n\t}\n\n\t// The loader owns materializing the target: it routes the container's createDocumentService call\n\t// to the driver's point-in-time service, so the caller never wraps their factory.\n\tconst pointInTimeFactory = new PointInTimeDocumentServiceFactory(\n\t\tcapableFactory,\n\t\tloadToSequenceNumber,\n\t);\n\n\treturn loadContainerPaused(\n\t\t{ ...props, documentServiceFactory: pointInTimeFactory },\n\t\tprops.request,\n\t\tloadToSequenceNumber,\n\t\tprops.signal,\n\t);\n}\n"]}
|
package/dist/packageVersion.d.ts
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export declare const pkgName = "@fluidframework/container-loader";
|
|
8
|
-
export declare const pkgVersion = "2.116.
|
|
8
|
+
export declare const pkgVersion = "2.116.1";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,
|
|
1
|
+
{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,YAAY,CAAC"}
|
package/dist/packageVersion.js
CHANGED
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.pkgVersion = exports.pkgName = void 0;
|
|
10
10
|
exports.pkgName = "@fluidframework/container-loader";
|
|
11
|
-
exports.pkgVersion = "2.116.
|
|
11
|
+
exports.pkgVersion = "2.116.1";
|
|
12
12
|
//# sourceMappingURL=packageVersion.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-loader\";\nexport const pkgVersion = \"2.116.1\";\n"]}
|
package/lib/legacy.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export {
|
|
|
22
22
|
ICreateAndLoadContainerProps,
|
|
23
23
|
ICreateDetachedContainerProps,
|
|
24
24
|
IFluidModuleWithDetails,
|
|
25
|
+
ILoadContainerToSequenceNumberProps,
|
|
25
26
|
ILoadExistingContainerProps,
|
|
26
27
|
ILoaderProps,
|
|
27
28
|
ILoaderServices,
|
|
@@ -35,6 +36,7 @@ export {
|
|
|
35
36
|
QuorumClientsSnapshot,
|
|
36
37
|
QuorumProposalsSnapshot,
|
|
37
38
|
createDetachedContainer,
|
|
39
|
+
loadContainerToSequenceNumber,
|
|
38
40
|
loadExistingContainer,
|
|
39
41
|
rehydrateDetachedContainer,
|
|
40
42
|
resolveWithLocationRedirectionHandling,
|
package/lib/legacyAlpha.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ export {
|
|
|
22
22
|
ICreateAndLoadContainerProps,
|
|
23
23
|
ICreateDetachedContainerProps,
|
|
24
24
|
IFluidModuleWithDetails,
|
|
25
|
+
ILoadContainerToSequenceNumberProps,
|
|
25
26
|
ILoadExistingContainerProps,
|
|
26
27
|
ILoaderProps,
|
|
27
28
|
ILoaderServices,
|
|
@@ -35,6 +36,7 @@ export {
|
|
|
35
36
|
QuorumClientsSnapshot,
|
|
36
37
|
QuorumProposalsSnapshot,
|
|
37
38
|
createDetachedContainer,
|
|
39
|
+
loadContainerToSequenceNumber,
|
|
38
40
|
loadExistingContainer,
|
|
39
41
|
rehydrateDetachedContainer,
|
|
40
42
|
resolveWithLocationRedirectionHandling,
|
|
@@ -45,7 +47,6 @@ export {
|
|
|
45
47
|
// #region @legacyAlpha APIs
|
|
46
48
|
ContainerAlpha,
|
|
47
49
|
ICaptureFullContainerStateProps,
|
|
48
|
-
ILoadContainerToSequenceNumberProps,
|
|
49
50
|
ILoadFrozenContainerFromPendingStateProps,
|
|
50
51
|
ILoadSummarizerContainerProps,
|
|
51
52
|
LoadSummarizerSummaryResult,
|
|
@@ -55,7 +56,6 @@ export {
|
|
|
55
56
|
asLegacyAlpha,
|
|
56
57
|
captureFullContainerState,
|
|
57
58
|
createFrozenDocumentServiceFactory,
|
|
58
|
-
loadContainerToSequenceNumber,
|
|
59
59
|
loadFrozenContainerFromPendingState,
|
|
60
60
|
loadSummarizerContainerAndMakeSummary
|
|
61
61
|
// #endregion
|
|
@@ -15,7 +15,7 @@ import type { IContainerDriverServices, IContainerHostProps } from "./createAndL
|
|
|
15
15
|
* point-in-time capability the loader detects. For ODSP, pass an
|
|
16
16
|
* `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.
|
|
17
17
|
*
|
|
18
|
-
* @legacy @
|
|
18
|
+
* @legacy @beta
|
|
19
19
|
*/
|
|
20
20
|
export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps, IContainerDriverServices {
|
|
21
21
|
/**
|
|
@@ -49,7 +49,7 @@ export interface ILoadContainerToSequenceNumberProps extends IContainerHostProps
|
|
|
49
49
|
* optional cancellation signal.
|
|
50
50
|
* @returns A disconnected, read-only container materialized at the requested sequence number.
|
|
51
51
|
*
|
|
52
|
-
* @legacy @
|
|
52
|
+
* @legacy @beta
|
|
53
53
|
*/
|
|
54
54
|
export declare function loadContainerToSequenceNumber(props: ILoadContainerToSequenceNumberProps): Promise<IContainer>;
|
|
55
55
|
//# sourceMappingURL=loadContainerToSequenceNumber.d.ts.map
|
|
@@ -23,7 +23,7 @@ import { asPointInTimeCapableFactory, PointInTimeDocumentServiceFactory, } from
|
|
|
23
23
|
* optional cancellation signal.
|
|
24
24
|
* @returns A disconnected, read-only container materialized at the requested sequence number.
|
|
25
25
|
*
|
|
26
|
-
* @legacy @
|
|
26
|
+
* @legacy @beta
|
|
27
27
|
*/
|
|
28
28
|
export async function loadContainerToSequenceNumber(props) {
|
|
29
29
|
const { loadToSequenceNumber, documentServiceFactory } = props;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"loadContainerToSequenceNumber.js","sourceRoot":"","sources":["../src/loadContainerToSequenceNumber.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAMnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EACN,2BAA2B,EAC3B,iCAAiC,GACjC,MAAM,0BAA0B,CAAC;AAiClC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAClD,KAA0C;IAE1C,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,GAAG,KAAK,CAAC;IAC/D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,UAAU,CACnB,4DAA4D,oBAAoB,GAAG,CACnF,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;IAC3E,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,UAAU,CACnB,oJAAoJ,CACpJ,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,kFAAkF;IAClF,MAAM,kBAAkB,GAAG,IAAI,iCAAiC,CAC/D,cAAc,EACd,oBAAoB,CACpB,CAAC;IAEF,OAAO,mBAAmB,CACzB,EAAE,GAAG,KAAK,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,EACxD,KAAK,CAAC,OAAO,EACb,oBAAoB,EACpB,KAAK,CAAC,MAAM,CACZ,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\nimport { UsageError } from \"@fluidframework/driver-utils/internal\";\n\nimport type {\n\tIContainerDriverServices,\n\tIContainerHostProps,\n} from \"./createAndLoadContainerUtils.js\";\nimport { loadContainerPaused } from \"./loadPaused.js\";\nimport {\n\tasPointInTimeCapableFactory,\n\tPointInTimeDocumentServiceFactory,\n} from \"./pointInTimeServices.js\";\n\n/**\n * Properties used to materialize a container at a point in document history.\n *\n * @remarks\n * This is distinct from normal container loading. The supplied\n * {@link IContainerDriverServices.documentServiceFactory} must be able to materialize the document\n * at {@link ILoadContainerToSequenceNumberProps.loadToSequenceNumber} - i.e. it must implement the\n * point-in-time capability the loader detects. For ODSP, pass an\n * `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.\n *\n * @legacy @
|
|
1
|
+
{"version":3,"file":"loadContainerToSequenceNumber.js","sourceRoot":"","sources":["../src/loadContainerToSequenceNumber.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAMnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EACN,2BAA2B,EAC3B,iCAAiC,GACjC,MAAM,0BAA0B,CAAC;AAiClC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAClD,KAA0C;IAE1C,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,GAAG,KAAK,CAAC;IAC/D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,oBAAoB,GAAG,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,UAAU,CACnB,4DAA4D,oBAAoB,GAAG,CACnF,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;IAC3E,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,IAAI,UAAU,CACnB,oJAAoJ,CACpJ,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,kFAAkF;IAClF,MAAM,kBAAkB,GAAG,IAAI,iCAAiC,CAC/D,cAAc,EACd,oBAAoB,CACpB,CAAC;IAEF,OAAO,mBAAmB,CACzB,EAAE,GAAG,KAAK,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,EACxD,KAAK,CAAC,OAAO,EACb,oBAAoB,EACpB,KAAK,CAAC,MAAM,CACZ,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainer } from \"@fluidframework/container-definitions/internal\";\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\nimport { UsageError } from \"@fluidframework/driver-utils/internal\";\n\nimport type {\n\tIContainerDriverServices,\n\tIContainerHostProps,\n} from \"./createAndLoadContainerUtils.js\";\nimport { loadContainerPaused } from \"./loadPaused.js\";\nimport {\n\tasPointInTimeCapableFactory,\n\tPointInTimeDocumentServiceFactory,\n} from \"./pointInTimeServices.js\";\n\n/**\n * Properties used to materialize a container at a point in document history.\n *\n * @remarks\n * This is distinct from normal container loading. The supplied\n * {@link IContainerDriverServices.documentServiceFactory} must be able to materialize the document\n * at {@link ILoadContainerToSequenceNumberProps.loadToSequenceNumber} - i.e. it must implement the\n * point-in-time capability the loader detects. For ODSP, pass an\n * `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.\n *\n * @legacy @beta\n */\nexport interface ILoadContainerToSequenceNumberProps\n\textends IContainerHostProps,\n\t\tIContainerDriverServices {\n\t/**\n\t * The request identifying the container instance.\n\t */\n\treadonly request: IRequest;\n\n\t/**\n\t * The sequence number at which to materialize the container.\n\t */\n\treadonly loadToSequenceNumber: number;\n\n\t/**\n\t * Cancels replay while waiting for the target sequence number.\n\t */\n\treadonly signal?: AbortSignal | undefined;\n}\n\n/**\n * Loads a read-only container at a target sequence number.\n *\n * @remarks\n * The returned container is disconnected with inbound and outbound processing paused. It is a\n * historical view and must not be used as a normal collaborative container.\n *\n * The supplied {@link IContainerDriverServices.documentServiceFactory} must support point-in-time\n * loading: it must be able to serve a snapshot at or before\n * {@link ILoadContainerToSequenceNumberProps.loadToSequenceNumber} and replay the document forward\n * through that sequence number. For ODSP, pass the result of\n * `getOdspPointInTimeDocumentServiceFactory` (from `@fluidframework/odsp-driver`) directly - the\n * loader materializes the point-in-time view itself, so no wrapping or decoration is required.\n *\n * @param props - The load options, point-in-time-capable driver services, target sequence number, and\n * optional cancellation signal.\n * @returns A disconnected, read-only container materialized at the requested sequence number.\n *\n * @legacy @beta\n */\nexport async function loadContainerToSequenceNumber(\n\tprops: ILoadContainerToSequenceNumberProps,\n): Promise<IContainer> {\n\tconst { loadToSequenceNumber, documentServiceFactory } = props;\n\tif (!Number.isInteger(loadToSequenceNumber) || loadToSequenceNumber < 0) {\n\t\tthrow new UsageError(\n\t\t\t`loadToSequenceNumber must be a non-negative integer, got ${loadToSequenceNumber}.`,\n\t\t);\n\t}\n\n\tconst capableFactory = asPointInTimeCapableFactory(documentServiceFactory);\n\tif (capableFactory === undefined) {\n\t\tthrow new UsageError(\n\t\t\t\"The provided documentServiceFactory does not support point-in-time loading. For ODSP, pass the result of getOdspPointInTimeDocumentServiceFactory.\",\n\t\t);\n\t}\n\n\t// The loader owns materializing the target: it routes the container's createDocumentService call\n\t// to the driver's point-in-time service, so the caller never wraps their factory.\n\tconst pointInTimeFactory = new PointInTimeDocumentServiceFactory(\n\t\tcapableFactory,\n\t\tloadToSequenceNumber,\n\t);\n\n\treturn loadContainerPaused(\n\t\t{ ...props, documentServiceFactory: pointInTimeFactory },\n\t\tprops.request,\n\t\tloadToSequenceNumber,\n\t\tprops.signal,\n\t);\n}\n"]}
|
package/lib/packageVersion.d.ts
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export declare const pkgName = "@fluidframework/container-loader";
|
|
8
|
-
export declare const pkgVersion = "2.116.
|
|
8
|
+
export declare const pkgVersion = "2.116.1";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,
|
|
1
|
+
{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,YAAY,CAAC"}
|
package/lib/packageVersion.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-loader\";\nexport const pkgVersion = \"2.116.1\";\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-loader",
|
|
3
|
-
"version": "2.116.
|
|
3
|
+
"version": "2.116.1",
|
|
4
4
|
"description": "Fluid container loader",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -129,29 +129,29 @@
|
|
|
129
129
|
"temp-directory": "nyc/.nyc_output"
|
|
130
130
|
},
|
|
131
131
|
"dependencies": {
|
|
132
|
-
"@fluid-internal/client-utils": "2.116.
|
|
133
|
-
"@fluidframework/container-definitions": "2.116.
|
|
134
|
-
"@fluidframework/core-interfaces": "2.116.
|
|
135
|
-
"@fluidframework/core-utils": "2.116.
|
|
136
|
-
"@fluidframework/driver-definitions": "2.116.
|
|
137
|
-
"@fluidframework/driver-utils": "2.116.
|
|
138
|
-
"@fluidframework/telemetry-utils": "2.116.
|
|
132
|
+
"@fluid-internal/client-utils": "~2.116.1",
|
|
133
|
+
"@fluidframework/container-definitions": "~2.116.1",
|
|
134
|
+
"@fluidframework/core-interfaces": "~2.116.1",
|
|
135
|
+
"@fluidframework/core-utils": "~2.116.1",
|
|
136
|
+
"@fluidframework/driver-definitions": "~2.116.1",
|
|
137
|
+
"@fluidframework/driver-utils": "~2.116.1",
|
|
138
|
+
"@fluidframework/telemetry-utils": "~2.116.1",
|
|
139
139
|
"debug": "^4.3.4",
|
|
140
140
|
"double-ended-queue": "^2.1.0-0",
|
|
141
141
|
"events_pkg": "npm:events@^3.1.0",
|
|
142
142
|
"uuid": "^11.1.0"
|
|
143
143
|
},
|
|
144
144
|
"devDependencies": {
|
|
145
|
-
"@arethetypeswrong/cli": "^0.18.
|
|
145
|
+
"@arethetypeswrong/cli": "^0.18.5",
|
|
146
146
|
"@biomejs/biome": "~2.4.5",
|
|
147
|
-
"@fluid-internal/client-utils": "2.116.
|
|
148
|
-
"@fluid-internal/mocha-test-setup": "2.116.
|
|
149
|
-
"@fluid-private/test-loader-utils": "2.116.
|
|
150
|
-
"@fluid-tools/build-cli": "^0.
|
|
147
|
+
"@fluid-internal/client-utils": "~2.116.1",
|
|
148
|
+
"@fluid-internal/mocha-test-setup": "~2.116.1",
|
|
149
|
+
"@fluid-private/test-loader-utils": "~2.116.1",
|
|
150
|
+
"@fluid-tools/build-cli": "^0.67.0",
|
|
151
151
|
"@fluidframework/build-common": "^2.0.3",
|
|
152
|
-
"@fluidframework/build-tools": "^0.
|
|
153
|
-
"@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.
|
|
154
|
-
"@fluidframework/eslint-config-fluid": "^
|
|
152
|
+
"@fluidframework/build-tools": "^0.67.0",
|
|
153
|
+
"@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.116.0",
|
|
154
|
+
"@fluidframework/eslint-config-fluid": "^14.0.0",
|
|
155
155
|
"@microsoft/api-extractor": "7.58.1",
|
|
156
156
|
"@types/debug": "^4.1.5",
|
|
157
157
|
"@types/double-ended-queue": "^2.1.0",
|
|
@@ -27,7 +27,7 @@ import {
|
|
|
27
27
|
* point-in-time capability the loader detects. For ODSP, pass an
|
|
28
28
|
* `IPointInTimeDocumentServiceFactory` created by `getOdspPointInTimeDocumentServiceFactory`.
|
|
29
29
|
*
|
|
30
|
-
* @legacy @
|
|
30
|
+
* @legacy @beta
|
|
31
31
|
*/
|
|
32
32
|
export interface ILoadContainerToSequenceNumberProps
|
|
33
33
|
extends IContainerHostProps,
|
|
@@ -66,7 +66,7 @@ export interface ILoadContainerToSequenceNumberProps
|
|
|
66
66
|
* optional cancellation signal.
|
|
67
67
|
* @returns A disconnected, read-only container materialized at the requested sequence number.
|
|
68
68
|
*
|
|
69
|
-
* @legacy @
|
|
69
|
+
* @legacy @beta
|
|
70
70
|
*/
|
|
71
71
|
export async function loadContainerToSequenceNumber(
|
|
72
72
|
props: ILoadContainerToSequenceNumberProps,
|
package/src/packageVersion.ts
CHANGED