@fluidframework/shared-summary-block 2.0.0-dev-rc.3.0.0.254866 → 2.0.0-dev-rc.5.0.0.263932
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 +27 -0
- package/api-report/shared-summary-block.api.md +4 -31
- package/dist/index.d.ts +1 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -4
- package/dist/index.js.map +1 -1
- package/dist/{alpha.d.ts → legacy.d.ts} +2 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/dist/public.d.ts +3 -0
- package/dist/sharedSummaryBlock.d.ts +2 -16
- package/dist/sharedSummaryBlock.d.ts.map +1 -1
- package/dist/sharedSummaryBlock.js +3 -22
- package/dist/sharedSummaryBlock.js.map +1 -1
- package/dist/sharedSummaryBlockFactory.d.ts +14 -7
- package/dist/sharedSummaryBlockFactory.d.ts.map +1 -1
- package/dist/sharedSummaryBlockFactory.js +9 -6
- package/dist/sharedSummaryBlockFactory.js.map +1 -1
- package/{dist/beta.d.ts → internal.d.ts} +2 -0
- package/{lib/beta.d.ts → legacy.d.ts} +2 -0
- package/lib/index.d.ts +1 -2
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -2
- package/lib/index.js.map +1 -1
- package/lib/{alpha.d.ts → legacy.d.ts} +2 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/lib/public.d.ts +3 -0
- package/lib/sharedSummaryBlock.d.ts +2 -16
- package/lib/sharedSummaryBlock.d.ts.map +1 -1
- package/lib/sharedSummaryBlock.js +1 -20
- package/lib/sharedSummaryBlock.js.map +1 -1
- package/lib/sharedSummaryBlockFactory.d.ts +14 -7
- package/lib/sharedSummaryBlockFactory.d.ts.map +1 -1
- package/lib/sharedSummaryBlockFactory.js +9 -6
- package/lib/sharedSummaryBlockFactory.js.map +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +40 -24
- package/src/index.ts +1 -2
- package/src/packageVersion.ts +1 -1
- package/src/sharedSummaryBlock.ts +1 -23
- package/src/sharedSummaryBlockFactory.ts +20 -10
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,32 @@
|
|
|
1
1
|
# @fluidframework/shared-summary-block
|
|
2
2
|
|
|
3
|
+
## 2.0.0-rc.4.0.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
7
|
+
## 2.0.0-rc.3.0.0
|
|
8
|
+
|
|
9
|
+
### Major Changes
|
|
10
|
+
|
|
11
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
12
|
+
|
|
13
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
14
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
15
|
+
TypeScript types and implementation code.
|
|
16
|
+
|
|
17
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
18
|
+
|
|
19
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
20
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
21
|
+
|
|
22
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
23
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
24
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
25
|
+
regarding the module and moduleResolution options.
|
|
26
|
+
|
|
27
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
28
|
+
to distinguish stable APIs from those that are in development.**
|
|
29
|
+
|
|
3
30
|
## 2.0.0-rc.2.0.0
|
|
4
31
|
|
|
5
32
|
Dependency updates only.
|
|
@@ -4,17 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
|
-
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
8
|
-
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
9
|
-
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
10
|
-
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
11
|
-
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
12
|
-
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
13
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
14
7
|
import { ISharedObject } from '@fluidframework/shared-object-base';
|
|
15
|
-
import {
|
|
8
|
+
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
|
|
16
9
|
import { Jsonable } from '@fluidframework/datastore-definitions/internal';
|
|
17
|
-
import { SharedObject } from '@fluidframework/shared-object-base/internal';
|
|
18
10
|
|
|
19
11
|
// @alpha
|
|
20
12
|
export interface ISharedSummaryBlock extends ISharedObject {
|
|
@@ -23,29 +15,10 @@ export interface ISharedSummaryBlock extends ISharedObject {
|
|
|
23
15
|
}
|
|
24
16
|
|
|
25
17
|
// @alpha
|
|
26
|
-
export
|
|
27
|
-
constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
|
|
28
|
-
// (undocumented)
|
|
29
|
-
protected applyStashedOp(): void;
|
|
30
|
-
static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
|
|
31
|
-
get<T>(key: string): Jsonable<T>;
|
|
32
|
-
static getFactory(): IChannelFactory;
|
|
33
|
-
protected loadCore(storage: IChannelStorageService): Promise<void>;
|
|
34
|
-
protected onDisconnect(): void;
|
|
35
|
-
protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
|
|
36
|
-
set<T>(key: string, value: Jsonable<T>): void;
|
|
37
|
-
protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
|
|
38
|
-
}
|
|
18
|
+
export const SharedSummaryBlock: ISharedObjectKind<ISharedSummaryBlock>;
|
|
39
19
|
|
|
40
|
-
// @
|
|
41
|
-
export
|
|
42
|
-
static readonly Attributes: IChannelAttributes;
|
|
43
|
-
get attributes(): IChannelAttributes;
|
|
44
|
-
create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
|
|
45
|
-
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
|
|
46
|
-
static readonly Type = "https://graph.microsoft.com/types/shared-summary-block";
|
|
47
|
-
get type(): string;
|
|
48
|
-
}
|
|
20
|
+
// @alpha
|
|
21
|
+
export type SharedSummaryBlock = ISharedSummaryBlock;
|
|
49
22
|
|
|
50
23
|
// (No @packageDocumentation comment for this package)
|
|
51
24
|
|
package/dist/index.d.ts
CHANGED
|
@@ -3,6 +3,5 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
export { ISharedSummaryBlock } from "./interfaces.js";
|
|
6
|
-
export { SharedSummaryBlock } from "./
|
|
7
|
-
export { SharedSummaryBlockFactory } from "./sharedSummaryBlockFactory.js";
|
|
6
|
+
export { SharedSummaryBlock } from "./sharedSummaryBlockFactory.js";
|
|
8
7
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4,9 +4,7 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.
|
|
8
|
-
var sharedSummaryBlock_js_1 = require("./sharedSummaryBlock.js");
|
|
9
|
-
Object.defineProperty(exports, "SharedSummaryBlock", { enumerable: true, get: function () { return sharedSummaryBlock_js_1.SharedSummaryBlock; } });
|
|
7
|
+
exports.SharedSummaryBlock = void 0;
|
|
10
8
|
var sharedSummaryBlockFactory_js_1 = require("./sharedSummaryBlockFactory.js");
|
|
11
|
-
Object.defineProperty(exports, "
|
|
9
|
+
Object.defineProperty(exports, "SharedSummaryBlock", { enumerable: true, get: function () { return sharedSummaryBlockFactory_js_1.SharedSummaryBlock; } });
|
|
12
10
|
//# 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;;;AAGH
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+EAAoE;AAA3D,kIAAA,kBAAkB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ISharedSummaryBlock } from \"./interfaces.js\";\nexport { SharedSummaryBlock } from \"./sharedSummaryBlockFactory.js\";\n"]}
|
|
@@ -7,8 +7,9 @@
|
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
8
|
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
9
|
*/
|
|
10
|
+
|
|
10
11
|
export {
|
|
11
|
-
// alpha APIs
|
|
12
|
+
// @alpha APIs
|
|
12
13
|
ISharedSummaryBlock,
|
|
13
14
|
SharedSummaryBlock
|
|
14
15
|
} from "./index.js";
|
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/shared-summary-block";
|
|
8
|
-
export declare const pkgVersion = "2.0.0-dev-rc.
|
|
8
|
+
export declare const pkgVersion = "2.0.0-dev-rc.5.0.0.263932";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
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/shared-summary-block";
|
|
11
|
-
exports.pkgVersion = "2.0.0-dev-rc.
|
|
11
|
+
exports.pkgVersion = "2.0.0-dev-rc.5.0.0.263932";
|
|
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,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,2BAA2B,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/shared-summary-block\";\nexport const pkgVersion = \"2.0.0-dev-rc.
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,2BAA2B,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/shared-summary-block\";\nexport const pkgVersion = \"2.0.0-dev-rc.5.0.0.263932\";\n"]}
|
package/dist/public.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import { IChannelAttributes,
|
|
5
|
+
import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
|
|
6
6
|
import { Jsonable } from "@fluidframework/datastore-definitions/internal";
|
|
7
7
|
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
8
8
|
import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
|
|
@@ -14,21 +14,7 @@ import { ISharedSummaryBlock } from "./interfaces.js";
|
|
|
14
14
|
* Data should be set in this object in response to a remote op.
|
|
15
15
|
* @alpha
|
|
16
16
|
*/
|
|
17
|
-
export declare class
|
|
18
|
-
/**
|
|
19
|
-
* Create a new shared summary block
|
|
20
|
-
*
|
|
21
|
-
* @param runtime - data store runtime the new shared summary block belongs to.
|
|
22
|
-
* @param id - optional name of the shared summary block.
|
|
23
|
-
* @returns newly created shared summary block (but not attached yet).
|
|
24
|
-
*/
|
|
25
|
-
static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
|
|
26
|
-
/**
|
|
27
|
-
* Get a factory for SharedSummaryBlock to register with the data store.
|
|
28
|
-
*
|
|
29
|
-
* @returns a factory that creates and loads SharedSummaryBlock.
|
|
30
|
-
*/
|
|
31
|
-
static getFactory(): IChannelFactory;
|
|
17
|
+
export declare class SharedSummaryBlockClass extends SharedObject implements ISharedSummaryBlock {
|
|
32
18
|
/**
|
|
33
19
|
* The data held by this object.
|
|
34
20
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlock.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlock.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,gDAAgD,CAAC;AAE1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,YAAY,EAA2B,MAAM,6CAA6C,CAAC;AAEpG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAYtD;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,YAAa,YAAW,mBAAmB;IACvF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAwC;IAE7D;;;;;;;OAOG;gBACS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,kBAAkB;IAIvF;;OAEG;IACI,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAIvC;;OAEG;IACI,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI;IAMpD;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAQ5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxE;;OAEG;IACH,SAAS,CAAC,YAAY;IAEtB;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO;IAIxE,SAAS,CAAC,cAAc;CAGxB"}
|
|
@@ -4,35 +4,16 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.
|
|
7
|
+
exports.SharedSummaryBlockClass = void 0;
|
|
8
8
|
const internal_1 = require("@fluidframework/driver-utils/internal");
|
|
9
9
|
const internal_2 = require("@fluidframework/shared-object-base/internal");
|
|
10
|
-
const sharedSummaryBlockFactory_js_1 = require("./sharedSummaryBlockFactory.js");
|
|
11
10
|
const snapshotFileName = "header";
|
|
12
11
|
/**
|
|
13
12
|
* Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
|
|
14
13
|
* Data should be set in this object in response to a remote op.
|
|
15
14
|
* @alpha
|
|
16
15
|
*/
|
|
17
|
-
class
|
|
18
|
-
/**
|
|
19
|
-
* Create a new shared summary block
|
|
20
|
-
*
|
|
21
|
-
* @param runtime - data store runtime the new shared summary block belongs to.
|
|
22
|
-
* @param id - optional name of the shared summary block.
|
|
23
|
-
* @returns newly created shared summary block (but not attached yet).
|
|
24
|
-
*/
|
|
25
|
-
static create(runtime, id) {
|
|
26
|
-
return runtime.createChannel(id, sharedSummaryBlockFactory_js_1.SharedSummaryBlockFactory.Type);
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Get a factory for SharedSummaryBlock to register with the data store.
|
|
30
|
-
*
|
|
31
|
-
* @returns a factory that creates and loads SharedSummaryBlock.
|
|
32
|
-
*/
|
|
33
|
-
static getFactory() {
|
|
34
|
-
return new sharedSummaryBlockFactory_js_1.SharedSummaryBlockFactory();
|
|
35
|
-
}
|
|
16
|
+
class SharedSummaryBlockClass extends internal_2.SharedObject {
|
|
36
17
|
/**
|
|
37
18
|
* Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
|
|
38
19
|
* be provided.
|
|
@@ -95,5 +76,5 @@ class SharedSummaryBlock extends internal_2.SharedObject {
|
|
|
95
76
|
throw new Error("not implemented");
|
|
96
77
|
}
|
|
97
78
|
}
|
|
98
|
-
exports.
|
|
79
|
+
exports.SharedSummaryBlockClass = SharedSummaryBlockClass;
|
|
99
80
|
//# sourceMappingURL=sharedSummaryBlock.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlock.js","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlock.js","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,oEAAqE;AAIrE,0EAAoG;AAIpG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAUlC;;;;GAIG;AACH,MAAa,uBAAwB,SAAQ,uBAAY;IAMxD;;;;;;;OAOG;IACH,YAAY,EAAU,EAAE,OAA+B,EAAE,UAA8B;QACtF,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,2BAA2B,CAAC,CAAC;QAd7D;;WAEG;QACc,SAAI,GAAG,IAAI,GAAG,EAA6B,CAAC;IAY7D,CAAC;IAED;;OAEG;IACI,GAAG,CAAI,GAAW;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,GAAG,CAAI,GAAW,EAAE,KAAkB;QAC5C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1B,mEAAmE;QACnE,IAAI,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAA4B;QACnD,MAAM,YAAY,GAAwC,EAAE,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,OAAO,IAAA,kCAAuB,EAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAY,EAClC,OAAO,EACP,gBAAgB,CAChB,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACpD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAC1B;IACF,CAAC;IAED;;OAEG;IACO,YAAY,KAAI,CAAC;IAE3B;;OAEG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc;QACvE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACtE,CAAC;IAES,cAAc;QACvB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD;AAzED,0DAyEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelStorageService,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions/internal\";\nimport { readAndParse } from \"@fluidframework/driver-utils/internal\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { IFluidSerializer } from \"@fluidframework/shared-object-base\";\nimport { SharedObject, createSingleBlobSummary } from \"@fluidframework/shared-object-base/internal\";\n\nimport { ISharedSummaryBlock } from \"./interfaces.js\";\n\nconst snapshotFileName = \"header\";\n\n/**\n * Defines the in-memory object structure to be used for the conversion to/from serialized.\n * Directly used in JSON.stringify, direct result from JSON.parse.\n */\ninterface ISharedSummaryBlockDataSerializable {\n\t[key: string]: Jsonable<unknown>;\n}\n\n/**\n * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.\n * Data should be set in this object in response to a remote op.\n * @alpha\n */\nexport class SharedSummaryBlockClass extends SharedObject implements ISharedSummaryBlock {\n\t/**\n\t * The data held by this object.\n\t */\n\tprivate readonly data = new Map<string, Jsonable<unknown>>();\n\n\t/**\n\t * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will\n\t * be provided.\n\t *\n\t * @param id - optional name of the shared summary block.\n\t * @param runtime - data store runtime thee object belongs to.\n\t * @param attributes - The attributes for the object.\n\t */\n\tconstructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {\n\t\tsuper(id, runtime, attributes, \"fluid_sharedSummaryBlock_\");\n\t}\n\n\t/**\n\t * {@inheritDoc ISharedSummaryBlock.get}\n\t */\n\tpublic get<T>(key: string): Jsonable<T> {\n\t\treturn this.data.get(key) as Jsonable<T>;\n\t}\n\n\t/**\n\t * {@inheritDoc ISharedSummaryBlock.set}\n\t */\n\tpublic set<T>(key: string, value: Jsonable<T>): void {\n\t\tthis.data.set(key, value);\n\t\t// Set this object as dirty so that it is part of the next summary.\n\t\tthis.dirty();\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}\n\t */\n\tprotected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n\t\tconst contentsBlob: ISharedSummaryBlockDataSerializable = {};\n\t\tthis.data.forEach((value, key) => {\n\t\t\tcontentsBlob[key] = value;\n\t\t});\n\t\treturn createSingleBlobSummary(snapshotFileName, JSON.stringify(contentsBlob));\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n\t */\n\tprotected async loadCore(storage: IChannelStorageService): Promise<void> {\n\t\tconst contents = await readAndParse<ISharedSummaryBlockDataSerializable>(\n\t\t\tstorage,\n\t\t\tsnapshotFileName,\n\t\t);\n\t\tfor (const [key, value] of Object.entries(contents)) {\n\t\t\tthis.data.set(key, value);\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}\n\t */\n\tprotected onDisconnect() {}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}\n\t */\n\tprotected processCore(message: ISequencedDocumentMessage, local: boolean) {\n\t\tthrow new Error(\"shared summary block should not generate any ops.\");\n\t}\n\n\tprotected applyStashedOp() {\n\t\tthrow new Error(\"not implemented\");\n\t}\n}\n"]}
|
|
@@ -3,14 +3,11 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import { IChannelAttributes, IChannelFactory, IChannelServices, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
|
|
6
|
-
import {
|
|
6
|
+
import type { ISharedSummaryBlock } from "./interfaces.js";
|
|
7
7
|
/**
|
|
8
8
|
* The factory that defines the shared summary block.
|
|
9
|
-
*
|
|
10
|
-
* @sealed
|
|
11
|
-
* @internal
|
|
12
9
|
*/
|
|
13
|
-
export declare class SharedSummaryBlockFactory implements IChannelFactory {
|
|
10
|
+
export declare class SharedSummaryBlockFactory implements IChannelFactory<ISharedSummaryBlock> {
|
|
14
11
|
/**
|
|
15
12
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
|
|
16
13
|
*/
|
|
@@ -30,10 +27,20 @@ export declare class SharedSummaryBlockFactory implements IChannelFactory {
|
|
|
30
27
|
/**
|
|
31
28
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
|
|
32
29
|
*/
|
|
33
|
-
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<
|
|
30
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedSummaryBlock>;
|
|
34
31
|
/**
|
|
35
32
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
|
|
36
33
|
*/
|
|
37
|
-
create(runtime: IFluidDataStoreRuntime, id: string):
|
|
34
|
+
create(runtime: IFluidDataStoreRuntime, id: string): ISharedSummaryBlock;
|
|
38
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
38
|
+
* @alpha
|
|
39
|
+
*/
|
|
40
|
+
export declare const SharedSummaryBlock: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedSummaryBlock>;
|
|
41
|
+
/**
|
|
42
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
43
|
+
* @alpha
|
|
44
|
+
*/
|
|
45
|
+
export type SharedSummaryBlock = ISharedSummaryBlock;
|
|
39
46
|
//# sourceMappingURL=sharedSummaryBlockFactory.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlockFactory.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlockFactory.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAK/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE3D;;GAEG;AACH,qBAAa,yBAA0B,YAAW,eAAe,CAAC,mBAAmB,CAAC;IACrF;;OAEG;IACH,gBAAuB,IAAI,4DAA4D;IAEvF;;OAEG;IACH,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;OAEG;IACH,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,mBAAmB;CAU/E;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,8FAAoD,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,CAAC"}
|
|
@@ -4,14 +4,12 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.SharedSummaryBlockFactory = void 0;
|
|
7
|
+
exports.SharedSummaryBlock = exports.SharedSummaryBlockFactory = void 0;
|
|
8
|
+
const internal_1 = require("@fluidframework/shared-object-base/internal");
|
|
8
9
|
const packageVersion_js_1 = require("./packageVersion.js");
|
|
9
10
|
const sharedSummaryBlock_js_1 = require("./sharedSummaryBlock.js");
|
|
10
11
|
/**
|
|
11
12
|
* The factory that defines the shared summary block.
|
|
12
|
-
*
|
|
13
|
-
* @sealed
|
|
14
|
-
* @internal
|
|
15
13
|
*/
|
|
16
14
|
class SharedSummaryBlockFactory {
|
|
17
15
|
/**
|
|
@@ -30,7 +28,7 @@ class SharedSummaryBlockFactory {
|
|
|
30
28
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
|
|
31
29
|
*/
|
|
32
30
|
async load(runtime, id, services, attributes) {
|
|
33
|
-
const sharedSummaryBlock = new sharedSummaryBlock_js_1.
|
|
31
|
+
const sharedSummaryBlock = new sharedSummaryBlock_js_1.SharedSummaryBlockClass(id, runtime, attributes);
|
|
34
32
|
await sharedSummaryBlock.load(services);
|
|
35
33
|
return sharedSummaryBlock;
|
|
36
34
|
}
|
|
@@ -38,7 +36,7 @@ class SharedSummaryBlockFactory {
|
|
|
38
36
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
|
|
39
37
|
*/
|
|
40
38
|
create(runtime, id) {
|
|
41
|
-
const sharedSummaryBlock = new sharedSummaryBlock_js_1.
|
|
39
|
+
const sharedSummaryBlock = new sharedSummaryBlock_js_1.SharedSummaryBlockClass(id, runtime, SharedSummaryBlockFactory.Attributes);
|
|
42
40
|
sharedSummaryBlock.initializeLocal();
|
|
43
41
|
return sharedSummaryBlock;
|
|
44
42
|
}
|
|
@@ -56,4 +54,9 @@ SharedSummaryBlockFactory.Attributes = {
|
|
|
56
54
|
snapshotFormatVersion: "0.1",
|
|
57
55
|
packageVersion: packageVersion_js_1.pkgVersion,
|
|
58
56
|
};
|
|
57
|
+
/**
|
|
58
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
59
|
+
* @alpha
|
|
60
|
+
*/
|
|
61
|
+
exports.SharedSummaryBlock = (0, internal_1.createSharedObjectKind)(SharedSummaryBlockFactory);
|
|
59
62
|
//# sourceMappingURL=sharedSummaryBlockFactory.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlockFactory.js","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlockFactory.js","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,0EAAqF;AAErF,2DAAiD;AACjD,mEAAkE;AAGlE;;GAEG;AACH,MAAa,yBAAyB;IAerC;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,yBAAyB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACpB,OAAO,yBAAyB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,kBAAkB,GAAG,IAAI,+CAAuB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAChF,MAAM,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAA+B,EAAE,EAAU;QACxD,MAAM,kBAAkB,GAAG,IAAI,+CAAuB,CACrD,EAAE,EACF,OAAO,EACP,yBAAyB,CAAC,UAAU,CACpC,CAAC;QACF,kBAAkB,CAAC,eAAe,EAAE,CAAC;QAErC,OAAO,kBAAkB,CAAC;IAC3B,CAAC;;AAxDF,8DAyDC;AAxDA;;GAEG;AACoB,8BAAI,GAAG,wDAAwD,CAAC;AAEvF;;GAEG;AACoB,oCAAU,GAAuB;IACvD,IAAI,EAAE,yBAAyB,CAAC,IAAI;IACpC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,8BAAU;CAC1B,CAAC;AA8CH;;;GAGG;AACU,QAAA,kBAAkB,GAAG,IAAA,iCAAsB,EAAC,yBAAyB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelFactory,\n\tIChannelServices,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { createSharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\nimport { SharedSummaryBlockClass } from \"./sharedSummaryBlock.js\";\nimport type { ISharedSummaryBlock } from \"./interfaces.js\";\n\n/**\n * The factory that defines the shared summary block.\n */\nexport class SharedSummaryBlockFactory implements IChannelFactory<ISharedSummaryBlock> {\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.\"type\"}\n\t */\n\tpublic static readonly Type = \"https://graph.microsoft.com/types/shared-summary-block\";\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}\n\t */\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: SharedSummaryBlockFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.\"type\"}\n\t */\n\tpublic get type() {\n\t\treturn SharedSummaryBlockFactory.Type;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}\n\t */\n\tpublic get attributes() {\n\t\treturn SharedSummaryBlockFactory.Attributes;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<ISharedSummaryBlock> {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlockClass(id, runtime, attributes);\n\t\tawait sharedSummaryBlock.load(services);\n\n\t\treturn sharedSummaryBlock;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}\n\t */\n\tpublic create(runtime: IFluidDataStoreRuntime, id: string): ISharedSummaryBlock {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlockClass(\n\t\t\tid,\n\t\t\truntime,\n\t\t\tSharedSummaryBlockFactory.Attributes,\n\t\t);\n\t\tsharedSummaryBlock.initializeLocal();\n\n\t\treturn sharedSummaryBlock;\n\t}\n}\n\n/**\n * {@inheritDoc ISharedSummaryBlock}\n * @alpha\n */\nexport const SharedSummaryBlock = createSharedObjectKind(SharedSummaryBlockFactory);\n\n/**\n * {@inheritDoc ISharedSummaryBlock}\n * @alpha\n */\nexport type SharedSummaryBlock = ISharedSummaryBlock;\n"]}
|
package/lib/index.d.ts
CHANGED
|
@@ -3,6 +3,5 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
export { ISharedSummaryBlock } from "./interfaces.js";
|
|
6
|
-
export { SharedSummaryBlock } from "./
|
|
7
|
-
export { SharedSummaryBlockFactory } from "./sharedSummaryBlockFactory.js";
|
|
6
|
+
export { SharedSummaryBlock } from "./sharedSummaryBlockFactory.js";
|
|
8
7
|
//# sourceMappingURL=index.d.ts.map
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -2,6 +2,5 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
export { SharedSummaryBlock } from "./
|
|
6
|
-
export { SharedSummaryBlockFactory } from "./sharedSummaryBlockFactory.js";
|
|
5
|
+
export { SharedSummaryBlock } from "./sharedSummaryBlockFactory.js";
|
|
7
6
|
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ISharedSummaryBlock } from \"./interfaces.js\";\nexport { SharedSummaryBlock } from \"./sharedSummaryBlockFactory.js\";\n"]}
|
|
@@ -7,8 +7,9 @@
|
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
8
|
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
9
|
*/
|
|
10
|
+
|
|
10
11
|
export {
|
|
11
|
-
// alpha APIs
|
|
12
|
+
// @alpha APIs
|
|
12
13
|
ISharedSummaryBlock,
|
|
13
14
|
SharedSummaryBlock
|
|
14
15
|
} from "./index.js";
|
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/shared-summary-block";
|
|
8
|
-
export declare const pkgVersion = "2.0.0-dev-rc.
|
|
8
|
+
export declare const pkgVersion = "2.0.0-dev-rc.5.0.0.263932";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
package/lib/packageVersion.js
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export const pkgName = "@fluidframework/shared-summary-block";
|
|
8
|
-
export const pkgVersion = "2.0.0-dev-rc.
|
|
8
|
+
export const pkgVersion = "2.0.0-dev-rc.5.0.0.263932";
|
|
9
9
|
//# sourceMappingURL=packageVersion.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,2BAA2B,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/shared-summary-block\";\nexport const pkgVersion = \"2.0.0-dev-rc.
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,2BAA2B,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/shared-summary-block\";\nexport const pkgVersion = \"2.0.0-dev-rc.5.0.0.263932\";\n"]}
|
package/lib/public.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import { IChannelAttributes,
|
|
5
|
+
import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
|
|
6
6
|
import { Jsonable } from "@fluidframework/datastore-definitions/internal";
|
|
7
7
|
import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
8
8
|
import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
|
|
@@ -14,21 +14,7 @@ import { ISharedSummaryBlock } from "./interfaces.js";
|
|
|
14
14
|
* Data should be set in this object in response to a remote op.
|
|
15
15
|
* @alpha
|
|
16
16
|
*/
|
|
17
|
-
export declare class
|
|
18
|
-
/**
|
|
19
|
-
* Create a new shared summary block
|
|
20
|
-
*
|
|
21
|
-
* @param runtime - data store runtime the new shared summary block belongs to.
|
|
22
|
-
* @param id - optional name of the shared summary block.
|
|
23
|
-
* @returns newly created shared summary block (but not attached yet).
|
|
24
|
-
*/
|
|
25
|
-
static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
|
|
26
|
-
/**
|
|
27
|
-
* Get a factory for SharedSummaryBlock to register with the data store.
|
|
28
|
-
*
|
|
29
|
-
* @returns a factory that creates and loads SharedSummaryBlock.
|
|
30
|
-
*/
|
|
31
|
-
static getFactory(): IChannelFactory;
|
|
17
|
+
export declare class SharedSummaryBlockClass extends SharedObject implements ISharedSummaryBlock {
|
|
32
18
|
/**
|
|
33
19
|
* The data held by this object.
|
|
34
20
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlock.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlock.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,gDAAgD,CAAC;AAE1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,YAAY,EAA2B,MAAM,6CAA6C,CAAC;AAEpG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAYtD;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,YAAa,YAAW,mBAAmB;IACvF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAwC;IAE7D;;;;;;;OAOG;gBACS,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,UAAU,EAAE,kBAAkB;IAIvF;;OAEG;IACI,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAIvC;;OAEG;IACI,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI;IAMpD;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAQ5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxE;;OAEG;IACH,SAAS,CAAC,YAAY;IAEtB;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO;IAIxE,SAAS,CAAC,cAAc;CAGxB"}
|
|
@@ -4,32 +4,13 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import { readAndParse } from "@fluidframework/driver-utils/internal";
|
|
6
6
|
import { SharedObject, createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
|
|
7
|
-
import { SharedSummaryBlockFactory } from "./sharedSummaryBlockFactory.js";
|
|
8
7
|
const snapshotFileName = "header";
|
|
9
8
|
/**
|
|
10
9
|
* Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
|
|
11
10
|
* Data should be set in this object in response to a remote op.
|
|
12
11
|
* @alpha
|
|
13
12
|
*/
|
|
14
|
-
export class
|
|
15
|
-
/**
|
|
16
|
-
* Create a new shared summary block
|
|
17
|
-
*
|
|
18
|
-
* @param runtime - data store runtime the new shared summary block belongs to.
|
|
19
|
-
* @param id - optional name of the shared summary block.
|
|
20
|
-
* @returns newly created shared summary block (but not attached yet).
|
|
21
|
-
*/
|
|
22
|
-
static create(runtime, id) {
|
|
23
|
-
return runtime.createChannel(id, SharedSummaryBlockFactory.Type);
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Get a factory for SharedSummaryBlock to register with the data store.
|
|
27
|
-
*
|
|
28
|
-
* @returns a factory that creates and loads SharedSummaryBlock.
|
|
29
|
-
*/
|
|
30
|
-
static getFactory() {
|
|
31
|
-
return new SharedSummaryBlockFactory();
|
|
32
|
-
}
|
|
13
|
+
export class SharedSummaryBlockClass extends SharedObject {
|
|
33
14
|
/**
|
|
34
15
|
* Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
|
|
35
16
|
* be provided.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlock.js","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlock.js","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAIrE,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AAIpG,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAUlC;;;;GAIG;AACH,MAAM,OAAO,uBAAwB,SAAQ,YAAY;IAMxD;;;;;;;OAOG;IACH,YAAY,EAAU,EAAE,OAA+B,EAAE,UAA8B;QACtF,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,2BAA2B,CAAC,CAAC;QAd7D;;WAEG;QACc,SAAI,GAAG,IAAI,GAAG,EAA6B,CAAC;IAY7D,CAAC;IAED;;OAEG;IACI,GAAG,CAAI,GAAW;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,GAAG,CAAI,GAAW,EAAE,KAAkB;QAC5C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1B,mEAAmE;QACnE,IAAI,CAAC,KAAK,EAAE,CAAC;IACd,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAA4B;QACnD,MAAM,YAAY,GAAwC,EAAE,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACvD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAClC,OAAO,EACP,gBAAgB,CAChB,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACpD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAC1B;IACF,CAAC;IAED;;OAEG;IACO,YAAY,KAAI,CAAC;IAE3B;;OAEG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc;QACvE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACtE,CAAC;IAES,cAAc;QACvB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelStorageService,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions/internal\";\nimport { readAndParse } from \"@fluidframework/driver-utils/internal\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { IFluidSerializer } from \"@fluidframework/shared-object-base\";\nimport { SharedObject, createSingleBlobSummary } from \"@fluidframework/shared-object-base/internal\";\n\nimport { ISharedSummaryBlock } from \"./interfaces.js\";\n\nconst snapshotFileName = \"header\";\n\n/**\n * Defines the in-memory object structure to be used for the conversion to/from serialized.\n * Directly used in JSON.stringify, direct result from JSON.parse.\n */\ninterface ISharedSummaryBlockDataSerializable {\n\t[key: string]: Jsonable<unknown>;\n}\n\n/**\n * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.\n * Data should be set in this object in response to a remote op.\n * @alpha\n */\nexport class SharedSummaryBlockClass extends SharedObject implements ISharedSummaryBlock {\n\t/**\n\t * The data held by this object.\n\t */\n\tprivate readonly data = new Map<string, Jsonable<unknown>>();\n\n\t/**\n\t * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will\n\t * be provided.\n\t *\n\t * @param id - optional name of the shared summary block.\n\t * @param runtime - data store runtime thee object belongs to.\n\t * @param attributes - The attributes for the object.\n\t */\n\tconstructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {\n\t\tsuper(id, runtime, attributes, \"fluid_sharedSummaryBlock_\");\n\t}\n\n\t/**\n\t * {@inheritDoc ISharedSummaryBlock.get}\n\t */\n\tpublic get<T>(key: string): Jsonable<T> {\n\t\treturn this.data.get(key) as Jsonable<T>;\n\t}\n\n\t/**\n\t * {@inheritDoc ISharedSummaryBlock.set}\n\t */\n\tpublic set<T>(key: string, value: Jsonable<T>): void {\n\t\tthis.data.set(key, value);\n\t\t// Set this object as dirty so that it is part of the next summary.\n\t\tthis.dirty();\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}\n\t */\n\tprotected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n\t\tconst contentsBlob: ISharedSummaryBlockDataSerializable = {};\n\t\tthis.data.forEach((value, key) => {\n\t\t\tcontentsBlob[key] = value;\n\t\t});\n\t\treturn createSingleBlobSummary(snapshotFileName, JSON.stringify(contentsBlob));\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n\t */\n\tprotected async loadCore(storage: IChannelStorageService): Promise<void> {\n\t\tconst contents = await readAndParse<ISharedSummaryBlockDataSerializable>(\n\t\t\tstorage,\n\t\t\tsnapshotFileName,\n\t\t);\n\t\tfor (const [key, value] of Object.entries(contents)) {\n\t\t\tthis.data.set(key, value);\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}\n\t */\n\tprotected onDisconnect() {}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}\n\t */\n\tprotected processCore(message: ISequencedDocumentMessage, local: boolean) {\n\t\tthrow new Error(\"shared summary block should not generate any ops.\");\n\t}\n\n\tprotected applyStashedOp() {\n\t\tthrow new Error(\"not implemented\");\n\t}\n}\n"]}
|
|
@@ -3,14 +3,11 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import { IChannelAttributes, IChannelFactory, IChannelServices, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
|
|
6
|
-
import {
|
|
6
|
+
import type { ISharedSummaryBlock } from "./interfaces.js";
|
|
7
7
|
/**
|
|
8
8
|
* The factory that defines the shared summary block.
|
|
9
|
-
*
|
|
10
|
-
* @sealed
|
|
11
|
-
* @internal
|
|
12
9
|
*/
|
|
13
|
-
export declare class SharedSummaryBlockFactory implements IChannelFactory {
|
|
10
|
+
export declare class SharedSummaryBlockFactory implements IChannelFactory<ISharedSummaryBlock> {
|
|
14
11
|
/**
|
|
15
12
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
|
|
16
13
|
*/
|
|
@@ -30,10 +27,20 @@ export declare class SharedSummaryBlockFactory implements IChannelFactory {
|
|
|
30
27
|
/**
|
|
31
28
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
|
|
32
29
|
*/
|
|
33
|
-
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<
|
|
30
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedSummaryBlock>;
|
|
34
31
|
/**
|
|
35
32
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
|
|
36
33
|
*/
|
|
37
|
-
create(runtime: IFluidDataStoreRuntime, id: string):
|
|
34
|
+
create(runtime: IFluidDataStoreRuntime, id: string): ISharedSummaryBlock;
|
|
38
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
38
|
+
* @alpha
|
|
39
|
+
*/
|
|
40
|
+
export declare const SharedSummaryBlock: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedSummaryBlock>;
|
|
41
|
+
/**
|
|
42
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
43
|
+
* @alpha
|
|
44
|
+
*/
|
|
45
|
+
export type SharedSummaryBlock = ISharedSummaryBlock;
|
|
39
46
|
//# sourceMappingURL=sharedSummaryBlockFactory.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlockFactory.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlockFactory.d.ts","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAK/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE3D;;GAEG;AACH,qBAAa,yBAA0B,YAAW,eAAe,CAAC,mBAAmB,CAAC;IACrF;;OAEG;IACH,gBAAuB,IAAI,4DAA4D;IAEvF;;OAEG;IACH,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;OAEG;IACH,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,mBAAmB;CAU/E;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,8FAAoD,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,CAAC"}
|
|
@@ -2,13 +2,11 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
+
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
|
|
5
6
|
import { pkgVersion } from "./packageVersion.js";
|
|
6
|
-
import {
|
|
7
|
+
import { SharedSummaryBlockClass } from "./sharedSummaryBlock.js";
|
|
7
8
|
/**
|
|
8
9
|
* The factory that defines the shared summary block.
|
|
9
|
-
*
|
|
10
|
-
* @sealed
|
|
11
|
-
* @internal
|
|
12
10
|
*/
|
|
13
11
|
export class SharedSummaryBlockFactory {
|
|
14
12
|
/**
|
|
@@ -27,7 +25,7 @@ export class SharedSummaryBlockFactory {
|
|
|
27
25
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
|
|
28
26
|
*/
|
|
29
27
|
async load(runtime, id, services, attributes) {
|
|
30
|
-
const sharedSummaryBlock = new
|
|
28
|
+
const sharedSummaryBlock = new SharedSummaryBlockClass(id, runtime, attributes);
|
|
31
29
|
await sharedSummaryBlock.load(services);
|
|
32
30
|
return sharedSummaryBlock;
|
|
33
31
|
}
|
|
@@ -35,7 +33,7 @@ export class SharedSummaryBlockFactory {
|
|
|
35
33
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
|
|
36
34
|
*/
|
|
37
35
|
create(runtime, id) {
|
|
38
|
-
const sharedSummaryBlock = new
|
|
36
|
+
const sharedSummaryBlock = new SharedSummaryBlockClass(id, runtime, SharedSummaryBlockFactory.Attributes);
|
|
39
37
|
sharedSummaryBlock.initializeLocal();
|
|
40
38
|
return sharedSummaryBlock;
|
|
41
39
|
}
|
|
@@ -52,4 +50,9 @@ SharedSummaryBlockFactory.Attributes = {
|
|
|
52
50
|
snapshotFormatVersion: "0.1",
|
|
53
51
|
packageVersion: pkgVersion,
|
|
54
52
|
};
|
|
53
|
+
/**
|
|
54
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
55
|
+
* @alpha
|
|
56
|
+
*/
|
|
57
|
+
export const SharedSummaryBlock = createSharedObjectKind(SharedSummaryBlockFactory);
|
|
55
58
|
//# sourceMappingURL=sharedSummaryBlockFactory.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharedSummaryBlockFactory.js","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"sharedSummaryBlockFactory.js","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AAErF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAGlE;;GAEG;AACH,MAAM,OAAO,yBAAyB;IAerC;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,yBAAyB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACpB,OAAO,yBAAyB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,kBAAkB,GAAG,IAAI,uBAAuB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAChF,MAAM,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAA+B,EAAE,EAAU;QACxD,MAAM,kBAAkB,GAAG,IAAI,uBAAuB,CACrD,EAAE,EACF,OAAO,EACP,yBAAyB,CAAC,UAAU,CACpC,CAAC;QACF,kBAAkB,CAAC,eAAe,EAAE,CAAC;QAErC,OAAO,kBAAkB,CAAC;IAC3B,CAAC;;AAvDD;;GAEG;AACoB,8BAAI,GAAG,wDAAwD,CAAC;AAEvF;;GAEG;AACoB,oCAAU,GAAuB;IACvD,IAAI,EAAE,yBAAyB,CAAC,IAAI;IACpC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC1B,CAAC;AA8CH;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,yBAAyB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelFactory,\n\tIChannelServices,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { createSharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { pkgVersion } from \"./packageVersion.js\";\nimport { SharedSummaryBlockClass } from \"./sharedSummaryBlock.js\";\nimport type { ISharedSummaryBlock } from \"./interfaces.js\";\n\n/**\n * The factory that defines the shared summary block.\n */\nexport class SharedSummaryBlockFactory implements IChannelFactory<ISharedSummaryBlock> {\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.\"type\"}\n\t */\n\tpublic static readonly Type = \"https://graph.microsoft.com/types/shared-summary-block\";\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}\n\t */\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: SharedSummaryBlockFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.\"type\"}\n\t */\n\tpublic get type() {\n\t\treturn SharedSummaryBlockFactory.Type;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}\n\t */\n\tpublic get attributes() {\n\t\treturn SharedSummaryBlockFactory.Attributes;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<ISharedSummaryBlock> {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlockClass(id, runtime, attributes);\n\t\tawait sharedSummaryBlock.load(services);\n\n\t\treturn sharedSummaryBlock;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}\n\t */\n\tpublic create(runtime: IFluidDataStoreRuntime, id: string): ISharedSummaryBlock {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlockClass(\n\t\t\tid,\n\t\t\truntime,\n\t\t\tSharedSummaryBlockFactory.Attributes,\n\t\t);\n\t\tsharedSummaryBlock.initializeLocal();\n\n\t\treturn sharedSummaryBlock;\n\t}\n}\n\n/**\n * {@inheritDoc ISharedSummaryBlock}\n * @alpha\n */\nexport const SharedSummaryBlock = createSharedObjectKind(SharedSummaryBlockFactory);\n\n/**\n * {@inheritDoc ISharedSummaryBlock}\n * @alpha\n */\nexport type SharedSummaryBlock = ISharedSummaryBlock;\n"]}
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/shared-summary-block",
|
|
3
|
-
"version": "2.0.0-dev-rc.
|
|
3
|
+
"version": "2.0.0-dev-rc.5.0.0.263932",
|
|
4
4
|
"description": "A DDS that does not generate ops but is part of summary",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -23,13 +23,13 @@
|
|
|
23
23
|
"default": "./dist/index.js"
|
|
24
24
|
}
|
|
25
25
|
},
|
|
26
|
-
"./
|
|
26
|
+
"./legacy": {
|
|
27
27
|
"import": {
|
|
28
|
-
"types": "./lib/
|
|
28
|
+
"types": "./lib/legacy.d.ts",
|
|
29
29
|
"default": "./lib/index.js"
|
|
30
30
|
},
|
|
31
31
|
"require": {
|
|
32
|
-
"types": "./dist/
|
|
32
|
+
"types": "./dist/legacy.d.ts",
|
|
33
33
|
"default": "./dist/index.js"
|
|
34
34
|
}
|
|
35
35
|
},
|
|
@@ -44,8 +44,8 @@
|
|
|
44
44
|
}
|
|
45
45
|
}
|
|
46
46
|
},
|
|
47
|
-
"main": "
|
|
48
|
-
"types": "
|
|
47
|
+
"main": "lib/index.js",
|
|
48
|
+
"types": "lib/public.d.ts",
|
|
49
49
|
"c8": {
|
|
50
50
|
"all": true,
|
|
51
51
|
"cache-dir": "nyc/.cache",
|
|
@@ -67,25 +67,25 @@
|
|
|
67
67
|
"temp-directory": "nyc/.nyc_output"
|
|
68
68
|
},
|
|
69
69
|
"dependencies": {
|
|
70
|
-
"@fluidframework/core-interfaces": "2.0.0-dev-rc.
|
|
71
|
-
"@fluidframework/datastore-definitions": "2.0.0-dev-rc.
|
|
72
|
-
"@fluidframework/driver-utils": "2.0.0-dev-rc.
|
|
70
|
+
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.263932",
|
|
71
|
+
"@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.263932",
|
|
72
|
+
"@fluidframework/driver-utils": "2.0.0-dev-rc.5.0.0.263932",
|
|
73
73
|
"@fluidframework/protocol-definitions": "^3.2.0",
|
|
74
|
-
"@fluidframework/runtime-definitions": "2.0.0-dev-rc.
|
|
75
|
-
"@fluidframework/shared-object-base": "2.0.0-dev-rc.
|
|
74
|
+
"@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.263932",
|
|
75
|
+
"@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.263932"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
78
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
79
79
|
"@biomejs/biome": "^1.6.2",
|
|
80
|
-
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.
|
|
81
|
-
"@fluid-tools/build-cli": "^0.
|
|
80
|
+
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.263932",
|
|
81
|
+
"@fluid-tools/build-cli": "^0.38.0",
|
|
82
82
|
"@fluidframework/build-common": "^2.0.3",
|
|
83
|
-
"@fluidframework/build-tools": "^0.
|
|
84
|
-
"@fluidframework/container-definitions": "2.0.0-dev-rc.
|
|
83
|
+
"@fluidframework/build-tools": "^0.38.0",
|
|
84
|
+
"@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.263932",
|
|
85
85
|
"@fluidframework/eslint-config-fluid": "^5.1.0",
|
|
86
|
-
"@fluidframework/shared-summary-block-previous": "npm:@fluidframework/shared-summary-block@2.0.0-
|
|
87
|
-
"@fluidframework/test-runtime-utils": "2.0.0-dev-rc.
|
|
88
|
-
"@microsoft/api-extractor": "^7.
|
|
86
|
+
"@fluidframework/shared-summary-block-previous": "npm:@fluidframework/shared-summary-block@2.0.0-rc.3.0.0",
|
|
87
|
+
"@fluidframework/test-runtime-utils": "2.0.0-dev-rc.5.0.0.263932",
|
|
88
|
+
"@microsoft/api-extractor": "^7.43.1",
|
|
89
89
|
"@types/benchmark": "^2.1.0",
|
|
90
90
|
"@types/mocha": "^9.1.1",
|
|
91
91
|
"@types/node": "^18.19.0",
|
|
@@ -104,12 +104,28 @@
|
|
|
104
104
|
"typescript": "~5.1.6"
|
|
105
105
|
},
|
|
106
106
|
"typeValidation": {
|
|
107
|
-
"broken": {
|
|
107
|
+
"broken": {
|
|
108
|
+
"InterfaceDeclaration_ISharedSummaryBlock": {
|
|
109
|
+
"forwardCompat": false,
|
|
110
|
+
"backCompat": false
|
|
111
|
+
},
|
|
112
|
+
"ClassDeclaration_SharedSummaryBlock": {
|
|
113
|
+
"forwardCompat": false
|
|
114
|
+
},
|
|
115
|
+
"RemovedClassDeclaration_SharedSummaryBlock": {
|
|
116
|
+
"forwardCompat": false,
|
|
117
|
+
"backCompat": false
|
|
118
|
+
},
|
|
119
|
+
"RemovedClassDeclaration_SharedSummaryBlockFactory": {
|
|
120
|
+
"forwardCompat": false,
|
|
121
|
+
"backCompat": false
|
|
122
|
+
}
|
|
123
|
+
}
|
|
108
124
|
},
|
|
109
125
|
"scripts": {
|
|
110
126
|
"api": "fluid-build . --task api",
|
|
111
|
-
"api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
|
|
112
|
-
"api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
|
|
127
|
+
"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
|
|
128
|
+
"api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
|
|
113
129
|
"build": "fluid-build . --task build",
|
|
114
130
|
"build:commonjs": "fluid-build . --task commonjs",
|
|
115
131
|
"build:compile": "fluid-build . --task compile",
|
|
@@ -120,11 +136,11 @@
|
|
|
120
136
|
"build:test": "npm run build:test:esm && npm run build:test:cjs",
|
|
121
137
|
"build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
|
|
122
138
|
"build:test:esm": "tsc --project ./src/test/tsconfig.json",
|
|
123
|
-
"check:are-the-types-wrong": "attw --pack .
|
|
139
|
+
"check:are-the-types-wrong": "attw --pack .",
|
|
124
140
|
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
125
141
|
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
|
|
126
142
|
"ci:build:docs": "api-extractor run",
|
|
127
|
-
"clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
|
|
143
|
+
"clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
|
|
128
144
|
"eslint": "eslint --format stylish src",
|
|
129
145
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
130
146
|
"format": "fluid-build --task format .",
|
|
@@ -138,7 +154,7 @@
|
|
|
138
154
|
"test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit",
|
|
139
155
|
"test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
|
|
140
156
|
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
|
|
141
|
-
"typetests:gen": "
|
|
157
|
+
"typetests:gen": "flub generate typetests --dir . -v --publicFallback",
|
|
142
158
|
"typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
|
|
143
159
|
}
|
|
144
160
|
}
|
package/src/index.ts
CHANGED
|
@@ -4,5 +4,4 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export { ISharedSummaryBlock } from "./interfaces.js";
|
|
7
|
-
export { SharedSummaryBlock } from "./
|
|
8
|
-
export { SharedSummaryBlockFactory } from "./sharedSummaryBlockFactory.js";
|
|
7
|
+
export { SharedSummaryBlock } from "./sharedSummaryBlockFactory.js";
|
package/src/packageVersion.ts
CHANGED
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
|
|
6
6
|
import {
|
|
7
7
|
IChannelAttributes,
|
|
8
|
-
IChannelFactory,
|
|
9
8
|
IChannelStorageService,
|
|
10
9
|
IFluidDataStoreRuntime,
|
|
11
10
|
} from "@fluidframework/datastore-definitions";
|
|
@@ -17,7 +16,6 @@ import { IFluidSerializer } from "@fluidframework/shared-object-base";
|
|
|
17
16
|
import { SharedObject, createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
|
|
18
17
|
|
|
19
18
|
import { ISharedSummaryBlock } from "./interfaces.js";
|
|
20
|
-
import { SharedSummaryBlockFactory } from "./sharedSummaryBlockFactory.js";
|
|
21
19
|
|
|
22
20
|
const snapshotFileName = "header";
|
|
23
21
|
|
|
@@ -34,27 +32,7 @@ interface ISharedSummaryBlockDataSerializable {
|
|
|
34
32
|
* Data should be set in this object in response to a remote op.
|
|
35
33
|
* @alpha
|
|
36
34
|
*/
|
|
37
|
-
export class
|
|
38
|
-
/**
|
|
39
|
-
* Create a new shared summary block
|
|
40
|
-
*
|
|
41
|
-
* @param runtime - data store runtime the new shared summary block belongs to.
|
|
42
|
-
* @param id - optional name of the shared summary block.
|
|
43
|
-
* @returns newly created shared summary block (but not attached yet).
|
|
44
|
-
*/
|
|
45
|
-
public static create(runtime: IFluidDataStoreRuntime, id?: string) {
|
|
46
|
-
return runtime.createChannel(id, SharedSummaryBlockFactory.Type) as SharedSummaryBlock;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
* Get a factory for SharedSummaryBlock to register with the data store.
|
|
51
|
-
*
|
|
52
|
-
* @returns a factory that creates and loads SharedSummaryBlock.
|
|
53
|
-
*/
|
|
54
|
-
public static getFactory(): IChannelFactory {
|
|
55
|
-
return new SharedSummaryBlockFactory();
|
|
56
|
-
}
|
|
57
|
-
|
|
35
|
+
export class SharedSummaryBlockClass extends SharedObject implements ISharedSummaryBlock {
|
|
58
36
|
/**
|
|
59
37
|
* The data held by this object.
|
|
60
38
|
*/
|
|
@@ -9,18 +9,16 @@ import {
|
|
|
9
9
|
IChannelServices,
|
|
10
10
|
IFluidDataStoreRuntime,
|
|
11
11
|
} from "@fluidframework/datastore-definitions";
|
|
12
|
-
import {
|
|
12
|
+
import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
|
|
13
13
|
|
|
14
14
|
import { pkgVersion } from "./packageVersion.js";
|
|
15
|
-
import {
|
|
15
|
+
import { SharedSummaryBlockClass } from "./sharedSummaryBlock.js";
|
|
16
|
+
import type { ISharedSummaryBlock } from "./interfaces.js";
|
|
16
17
|
|
|
17
18
|
/**
|
|
18
19
|
* The factory that defines the shared summary block.
|
|
19
|
-
*
|
|
20
|
-
* @sealed
|
|
21
|
-
* @internal
|
|
22
20
|
*/
|
|
23
|
-
export class SharedSummaryBlockFactory implements IChannelFactory {
|
|
21
|
+
export class SharedSummaryBlockFactory implements IChannelFactory<ISharedSummaryBlock> {
|
|
24
22
|
/**
|
|
25
23
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
|
|
26
24
|
*/
|
|
@@ -57,8 +55,8 @@ export class SharedSummaryBlockFactory implements IChannelFactory {
|
|
|
57
55
|
id: string,
|
|
58
56
|
services: IChannelServices,
|
|
59
57
|
attributes: IChannelAttributes,
|
|
60
|
-
): Promise<
|
|
61
|
-
const sharedSummaryBlock = new
|
|
58
|
+
): Promise<ISharedSummaryBlock> {
|
|
59
|
+
const sharedSummaryBlock = new SharedSummaryBlockClass(id, runtime, attributes);
|
|
62
60
|
await sharedSummaryBlock.load(services);
|
|
63
61
|
|
|
64
62
|
return sharedSummaryBlock;
|
|
@@ -67,8 +65,8 @@ export class SharedSummaryBlockFactory implements IChannelFactory {
|
|
|
67
65
|
/**
|
|
68
66
|
* {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
|
|
69
67
|
*/
|
|
70
|
-
public create(runtime: IFluidDataStoreRuntime, id: string):
|
|
71
|
-
const sharedSummaryBlock = new
|
|
68
|
+
public create(runtime: IFluidDataStoreRuntime, id: string): ISharedSummaryBlock {
|
|
69
|
+
const sharedSummaryBlock = new SharedSummaryBlockClass(
|
|
72
70
|
id,
|
|
73
71
|
runtime,
|
|
74
72
|
SharedSummaryBlockFactory.Attributes,
|
|
@@ -78,3 +76,15 @@ export class SharedSummaryBlockFactory implements IChannelFactory {
|
|
|
78
76
|
return sharedSummaryBlock;
|
|
79
77
|
}
|
|
80
78
|
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
82
|
+
* @alpha
|
|
83
|
+
*/
|
|
84
|
+
export const SharedSummaryBlock = createSharedObjectKind(SharedSummaryBlockFactory);
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* {@inheritDoc ISharedSummaryBlock}
|
|
88
|
+
* @alpha
|
|
89
|
+
*/
|
|
90
|
+
export type SharedSummaryBlock = ISharedSummaryBlock;
|