@fluidframework/shared-summary-block 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254674

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/dist/alpha.d.ts +14 -0
  2. package/dist/beta.d.ts +9 -0
  3. package/dist/packageVersion.d.ts +1 -1
  4. package/dist/packageVersion.js +1 -1
  5. package/dist/packageVersion.js.map +1 -1
  6. package/dist/public.d.ts +9 -0
  7. package/lib/alpha.d.ts +14 -0
  8. package/lib/beta.d.ts +9 -0
  9. package/lib/packageVersion.d.ts +1 -1
  10. package/lib/packageVersion.js +1 -1
  11. package/lib/packageVersion.js.map +1 -1
  12. package/lib/public.d.ts +9 -0
  13. package/package.json +17 -29
  14. package/src/packageVersion.ts +1 -1
  15. package/api-extractor-cjs.json +0 -8
  16. package/dist/shared-summary-block-alpha.d.ts +0 -100
  17. package/dist/shared-summary-block-beta.d.ts +0 -23
  18. package/dist/shared-summary-block-public.d.ts +0 -23
  19. package/dist/shared-summary-block-untrimmed.d.ts +0 -131
  20. package/dist/tsdoc-metadata.json +0 -11
  21. package/lib/shared-summary-block-alpha.d.ts +0 -100
  22. package/lib/shared-summary-block-beta.d.ts +0 -23
  23. package/lib/shared-summary-block-public.d.ts +0 -23
  24. package/lib/shared-summary-block-untrimmed.d.ts +0 -131
package/dist/alpha.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
10
+ export {
11
+ // alpha APIs
12
+ ISharedSummaryBlock,
13
+ SharedSummaryBlock
14
+ } from "./index.js";
package/dist/beta.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
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.3.0.0.254513";
8
+ export declare const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
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.3.0.0.254513";
11
+ exports.pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
12
12
  //# sourceMappingURL=packageVersion.js.map
package/dist/packageVersion.js.map CHANGED
@@ -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.3.0.0.254513\";\n"]}
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.3.0.0.254674\";\n"]}
package/dist/public.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
package/lib/alpha.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
10
+ export {
11
+ // alpha APIs
12
+ ISharedSummaryBlock,
13
+ SharedSummaryBlock
14
+ } from "./index.js";
package/lib/beta.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
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.3.0.0.254513";
8
+ export declare const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
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.3.0.0.254513";
8
+ export const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
9
9
  //# sourceMappingURL=packageVersion.js.map
package/lib/packageVersion.js.map CHANGED
@@ -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.3.0.0.254513\";\n"]}
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.3.0.0.254674\";\n"]}
package/lib/public.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+
6
+ /*
7
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
9
+ */
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.0.0.254513",
3
+ "version": "2.0.0-dev-rc.3.0.0.254674",
4
4
  "description": "A DDS that does not generate ops but is part of summary",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -15,21 +15,21 @@
15
15
  "exports": {
16
16
  ".": {
17
17
  "import": {
18
- "types": "./lib/shared-summary-block-public.d.ts",
18
+ "types": "./lib/public.d.ts",
19
19
  "default": "./lib/index.js"
20
20
  },
21
21
  "require": {
22
- "types": "./dist/shared-summary-block-public.d.ts",
22
+ "types": "./dist/public.d.ts",
23
23
  "default": "./dist/index.js"
24
24
  }
25
25
  },
26
26
  "./alpha": {
27
27
  "import": {
28
- "types": "./lib/shared-summary-block-alpha.d.ts",
28
+ "types": "./lib/alpha.d.ts",
29
29
  "default": "./lib/index.js"
30
30
  },
31
31
  "require": {
32
- "types": "./dist/shared-summary-block-alpha.d.ts",
32
+ "types": "./dist/alpha.d.ts",
33
33
  "default": "./dist/index.js"
34
34
  }
35
35
  },
@@ -45,7 +45,7 @@
45
45
  }
46
46
  },
47
47
  "main": "dist/index.js",
48
- "types": "./dist/shared-summary-block-public.d.ts",
48
+ "types": "./dist/public.d.ts",
49
49
  "c8": {
50
50
  "all": true,
51
51
  "cache-dir": "nyc/.cache",
@@ -67,24 +67,24 @@
67
67
  "temp-directory": "nyc/.nyc_output"
68
68
  },
69
69
  "dependencies": {
70
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254513",
71
- "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254513",
72
- "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254513",
70
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254674",
71
+ "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254674",
72
+ "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254674",
73
73
  "@fluidframework/protocol-definitions": "^3.2.0",
74
- "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254513",
75
- "@fluidframework/shared-object-base": "2.0.0-dev-rc.3.0.0.254513"
74
+ "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254674",
75
+ "@fluidframework/shared-object-base": "2.0.0-dev-rc.3.0.0.254674"
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.3.0.0.254513",
80
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254674",
81
81
  "@fluid-tools/build-cli": "^0.35.0",
82
82
  "@fluidframework/build-common": "^2.0.3",
83
83
  "@fluidframework/build-tools": "^0.35.0",
84
- "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254513",
84
+ "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254674",
85
85
  "@fluidframework/eslint-config-fluid": "^5.1.0",
86
86
  "@fluidframework/shared-summary-block-previous": "npm:@fluidframework/shared-summary-block@2.0.0-internal.8.0.0",
87
- "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.3.0.0.254513",
87
+ "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.3.0.0.254674",
88
88
  "@microsoft/api-extractor": "^7.42.3",
89
89
  "@types/benchmark": "^2.1.0",
90
90
  "@types/mocha": "^9.1.1",
@@ -103,30 +103,18 @@
103
103
  "rimraf": "^4.4.0",
104
104
  "typescript": "~5.1.6"
105
105
  },
106
- "fluidBuild": {
107
- "tasks": {
108
- "build:docs": {
109
- "dependsOn": [
110
- "...",
111
- "api-extractor:commonjs",
112
- "api-extractor:esnext"
113
- ],
114
- "script": false
115
- }
116
- }
117
- },
118
106
  "typeValidation": {
119
107
  "broken": {}
120
108
  },
121
109
  "scripts": {
122
110
  "api": "fluid-build . --task api",
123
- "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
124
- "api-extractor:esnext": "api-extractor run --local",
111
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
112
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
125
113
  "build": "fluid-build . --task build",
126
114
  "build:commonjs": "fluid-build . --task commonjs",
127
115
  "build:compile": "fluid-build . --task compile",
128
116
  "build:compile:min": "npm run build:compile",
129
- "build:docs": "fluid-build . --task api",
117
+ "build:docs": "api-extractor run --local",
130
118
  "build:esnext": "tsc --project ./tsconfig.json",
131
119
  "build:genver": "gen-version",
132
120
  "build:test": "npm run build:test:esm && npm run build:test:cjs",
package/src/packageVersion.ts CHANGED
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/shared-summary-block";
9
- export const pkgVersion = "2.0.0-dev-rc.3.0.0.254513";
9
+ export const pkgVersion = "2.0.0-dev-rc.3.0.0.254674";
package/api-extractor-cjs.json DELETED
@@ -1,8 +0,0 @@
1
- {
2
- "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
4
- // CJS is actually secondary; so, no report.
5
- "apiReport": {
6
- "enabled": false
7
- }
8
- }
package/dist/shared-summary-block-alpha.d.ts DELETED
@@ -1,100 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /**
14
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
15
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
16
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
17
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
18
- * @alpha
19
- */
20
- export declare interface ISharedSummaryBlock extends ISharedObject {
21
- /**
22
- * Retrieves the given key from the map.
23
- * @param key - Key to retrieve from.
24
- * @returns The stored value, or undefined if the key is not set.
25
- *
26
- * @privateRemarks
27
- * The return type is underspecified to allow for the possibility of objects with function or undefined values.
28
- */
29
- get<T>(key: string): Jsonable<T>;
30
- /**
31
- * Sets the value stored at key to the provided value.
32
- * @param key - Key to set at.
33
- * @param value - Jsonable type value to set.
34
- */
35
- set<T>(key: string, value: Jsonable<T>): void;
36
- }
37
-
38
- /**
39
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
40
- * Data should be set in this object in response to a remote op.
41
- * @alpha
42
- */
43
- export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
44
- /**
45
- * Create a new shared summary block
46
- *
47
- * @param runtime - data store runtime the new shared summary block belongs to.
48
- * @param id - optional name of the shared summary block.
49
- * @returns newly created shared summary block (but not attached yet).
50
- */
51
- static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
52
- /**
53
- * Get a factory for SharedSummaryBlock to register with the data store.
54
- *
55
- * @returns a factory that creates and loads SharedSummaryBlock.
56
- */
57
- static getFactory(): IChannelFactory;
58
- /**
59
- * The data held by this object.
60
- */
61
- private readonly data;
62
- /**
63
- * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
64
- * be provided.
65
- *
66
- * @param id - optional name of the shared summary block.
67
- * @param runtime - data store runtime thee object belongs to.
68
- * @param attributes - The attributes for the object.
69
- */
70
- constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
71
- /**
72
- * {@inheritDoc ISharedSummaryBlock.get}
73
- */
74
- get<T>(key: string): Jsonable<T>;
75
- /**
76
- * {@inheritDoc ISharedSummaryBlock.set}
77
- */
78
- set<T>(key: string, value: Jsonable<T>): void;
79
- /**
80
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
81
- */
82
- protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
83
- /**
84
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
85
- */
86
- protected loadCore(storage: IChannelStorageService): Promise<void>;
87
- /**
88
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
89
- */
90
- protected onDisconnect(): void;
91
- /**
92
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
93
- */
94
- protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
95
- protected applyStashedOp(): void;
96
- }
97
-
98
- /* Excluded from this release type: SharedSummaryBlockFactory */
99
-
100
- export { }
package/dist/shared-summary-block-beta.d.ts DELETED
@@ -1,23 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /* Excluded from this release type: ISharedSummaryBlock */
14
-
15
- /* Excluded from this release type: Jsonable */
16
-
17
- /* Excluded from this release type: SharedObject */
18
-
19
- /* Excluded from this release type: SharedSummaryBlock */
20
-
21
- /* Excluded from this release type: SharedSummaryBlockFactory */
22
-
23
- export { }
package/dist/shared-summary-block-public.d.ts DELETED
@@ -1,23 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /* Excluded from this release type: ISharedSummaryBlock */
14
-
15
- /* Excluded from this release type: Jsonable */
16
-
17
- /* Excluded from this release type: SharedObject */
18
-
19
- /* Excluded from this release type: SharedSummaryBlock */
20
-
21
- /* Excluded from this release type: SharedSummaryBlockFactory */
22
-
23
- export { }
package/dist/shared-summary-block-untrimmed.d.ts DELETED
@@ -1,131 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /**
14
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
15
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
16
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
17
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
18
- * @alpha
19
- */
20
- export declare interface ISharedSummaryBlock extends ISharedObject {
21
- /**
22
- * Retrieves the given key from the map.
23
- * @param key - Key to retrieve from.
24
- * @returns The stored value, or undefined if the key is not set.
25
- *
26
- * @privateRemarks
27
- * The return type is underspecified to allow for the possibility of objects with function or undefined values.
28
- */
29
- get<T>(key: string): Jsonable<T>;
30
- /**
31
- * Sets the value stored at key to the provided value.
32
- * @param key - Key to set at.
33
- * @param value - Jsonable type value to set.
34
- */
35
- set<T>(key: string, value: Jsonable<T>): void;
36
- }
37
-
38
- /**
39
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
40
- * Data should be set in this object in response to a remote op.
41
- * @alpha
42
- */
43
- export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
44
- /**
45
- * Create a new shared summary block
46
- *
47
- * @param runtime - data store runtime the new shared summary block belongs to.
48
- * @param id - optional name of the shared summary block.
49
- * @returns newly created shared summary block (but not attached yet).
50
- */
51
- static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
52
- /**
53
- * Get a factory for SharedSummaryBlock to register with the data store.
54
- *
55
- * @returns a factory that creates and loads SharedSummaryBlock.
56
- */
57
- static getFactory(): IChannelFactory;
58
- /**
59
- * The data held by this object.
60
- */
61
- private readonly data;
62
- /**
63
- * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
64
- * be provided.
65
- *
66
- * @param id - optional name of the shared summary block.
67
- * @param runtime - data store runtime thee object belongs to.
68
- * @param attributes - The attributes for the object.
69
- */
70
- constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
71
- /**
72
- * {@inheritDoc ISharedSummaryBlock.get}
73
- */
74
- get<T>(key: string): Jsonable<T>;
75
- /**
76
- * {@inheritDoc ISharedSummaryBlock.set}
77
- */
78
- set<T>(key: string, value: Jsonable<T>): void;
79
- /**
80
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
81
- */
82
- protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
83
- /**
84
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
85
- */
86
- protected loadCore(storage: IChannelStorageService): Promise<void>;
87
- /**
88
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
89
- */
90
- protected onDisconnect(): void;
91
- /**
92
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
93
- */
94
- protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
95
- protected applyStashedOp(): void;
96
- }
97
-
98
- /**
99
- * The factory that defines the shared summary block.
100
- *
101
- * @sealed
102
- * @internal
103
- */
104
- export declare class SharedSummaryBlockFactory implements IChannelFactory {
105
- /**
106
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
107
- */
108
- static readonly Type = "https://graph.microsoft.com/types/shared-summary-block";
109
- /**
110
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
111
- */
112
- static readonly Attributes: IChannelAttributes;
113
- /**
114
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
115
- */
116
- get type(): string;
117
- /**
118
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
119
- */
120
- get attributes(): IChannelAttributes;
121
- /**
122
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
123
- */
124
- load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
125
- /**
126
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
127
- */
128
- create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
129
- }
130
-
131
- export { }
package/dist/tsdoc-metadata.json DELETED
@@ -1,11 +0,0 @@
1
- // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
- // It should be published with your NPM package. It should not be tracked by Git.
3
- {
4
- "tsdocVersion": "0.12",
5
- "toolPackages": [
6
- {
7
- "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.42.3"
9
- }
10
- ]
11
- }
package/lib/shared-summary-block-alpha.d.ts DELETED
@@ -1,100 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /**
14
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
15
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
16
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
17
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
18
- * @alpha
19
- */
20
- export declare interface ISharedSummaryBlock extends ISharedObject {
21
- /**
22
- * Retrieves the given key from the map.
23
- * @param key - Key to retrieve from.
24
- * @returns The stored value, or undefined if the key is not set.
25
- *
26
- * @privateRemarks
27
- * The return type is underspecified to allow for the possibility of objects with function or undefined values.
28
- */
29
- get<T>(key: string): Jsonable<T>;
30
- /**
31
- * Sets the value stored at key to the provided value.
32
- * @param key - Key to set at.
33
- * @param value - Jsonable type value to set.
34
- */
35
- set<T>(key: string, value: Jsonable<T>): void;
36
- }
37
-
38
- /**
39
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
40
- * Data should be set in this object in response to a remote op.
41
- * @alpha
42
- */
43
- export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
44
- /**
45
- * Create a new shared summary block
46
- *
47
- * @param runtime - data store runtime the new shared summary block belongs to.
48
- * @param id - optional name of the shared summary block.
49
- * @returns newly created shared summary block (but not attached yet).
50
- */
51
- static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
52
- /**
53
- * Get a factory for SharedSummaryBlock to register with the data store.
54
- *
55
- * @returns a factory that creates and loads SharedSummaryBlock.
56
- */
57
- static getFactory(): IChannelFactory;
58
- /**
59
- * The data held by this object.
60
- */
61
- private readonly data;
62
- /**
63
- * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
64
- * be provided.
65
- *
66
- * @param id - optional name of the shared summary block.
67
- * @param runtime - data store runtime thee object belongs to.
68
- * @param attributes - The attributes for the object.
69
- */
70
- constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
71
- /**
72
- * {@inheritDoc ISharedSummaryBlock.get}
73
- */
74
- get<T>(key: string): Jsonable<T>;
75
- /**
76
- * {@inheritDoc ISharedSummaryBlock.set}
77
- */
78
- set<T>(key: string, value: Jsonable<T>): void;
79
- /**
80
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
81
- */
82
- protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
83
- /**
84
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
85
- */
86
- protected loadCore(storage: IChannelStorageService): Promise<void>;
87
- /**
88
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
89
- */
90
- protected onDisconnect(): void;
91
- /**
92
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
93
- */
94
- protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
95
- protected applyStashedOp(): void;
96
- }
97
-
98
- /* Excluded from this release type: SharedSummaryBlockFactory */
99
-
100
- export { }
package/lib/shared-summary-block-beta.d.ts DELETED
@@ -1,23 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /* Excluded from this release type: ISharedSummaryBlock */
14
-
15
- /* Excluded from this release type: Jsonable */
16
-
17
- /* Excluded from this release type: SharedObject */
18
-
19
- /* Excluded from this release type: SharedSummaryBlock */
20
-
21
- /* Excluded from this release type: SharedSummaryBlockFactory */
22
-
23
- export { }
package/lib/shared-summary-block-public.d.ts DELETED
@@ -1,23 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /* Excluded from this release type: ISharedSummaryBlock */
14
-
15
- /* Excluded from this release type: Jsonable */
16
-
17
- /* Excluded from this release type: SharedObject */
18
-
19
- /* Excluded from this release type: SharedSummaryBlock */
20
-
21
- /* Excluded from this release type: SharedSummaryBlockFactory */
22
-
23
- export { }
package/lib/shared-summary-block-untrimmed.d.ts DELETED
@@ -1,131 +0,0 @@
1
- import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
- import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
- import { IChannelServices } from '@fluidframework/datastore-definitions';
4
- import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
- import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
- import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { ISharedObject } from '@fluidframework/shared-object-base';
9
- import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
10
- import { Jsonable } from '@fluidframework/datastore-definitions/internal';
11
- import { SharedObject } from '@fluidframework/shared-object-base/internal';
12
-
13
- /**
14
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
15
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
16
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
17
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
18
- * @alpha
19
- */
20
- export declare interface ISharedSummaryBlock extends ISharedObject {
21
- /**
22
- * Retrieves the given key from the map.
23
- * @param key - Key to retrieve from.
24
- * @returns The stored value, or undefined if the key is not set.
25
- *
26
- * @privateRemarks
27
- * The return type is underspecified to allow for the possibility of objects with function or undefined values.
28
- */
29
- get<T>(key: string): Jsonable<T>;
30
- /**
31
- * Sets the value stored at key to the provided value.
32
- * @param key - Key to set at.
33
- * @param value - Jsonable type value to set.
34
- */
35
- set<T>(key: string, value: Jsonable<T>): void;
36
- }
37
-
38
- /**
39
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
40
- * Data should be set in this object in response to a remote op.
41
- * @alpha
42
- */
43
- export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
44
- /**
45
- * Create a new shared summary block
46
- *
47
- * @param runtime - data store runtime the new shared summary block belongs to.
48
- * @param id - optional name of the shared summary block.
49
- * @returns newly created shared summary block (but not attached yet).
50
- */
51
- static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
52
- /**
53
- * Get a factory for SharedSummaryBlock to register with the data store.
54
- *
55
- * @returns a factory that creates and loads SharedSummaryBlock.
56
- */
57
- static getFactory(): IChannelFactory;
58
- /**
59
- * The data held by this object.
60
- */
61
- private readonly data;
62
- /**
63
- * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
64
- * be provided.
65
- *
66
- * @param id - optional name of the shared summary block.
67
- * @param runtime - data store runtime thee object belongs to.
68
- * @param attributes - The attributes for the object.
69
- */
70
- constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
71
- /**
72
- * {@inheritDoc ISharedSummaryBlock.get}
73
- */
74
- get<T>(key: string): Jsonable<T>;
75
- /**
76
- * {@inheritDoc ISharedSummaryBlock.set}
77
- */
78
- set<T>(key: string, value: Jsonable<T>): void;
79
- /**
80
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
81
- */
82
- protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
83
- /**
84
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
85
- */
86
- protected loadCore(storage: IChannelStorageService): Promise<void>;
87
- /**
88
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
89
- */
90
- protected onDisconnect(): void;
91
- /**
92
- * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
93
- */
94
- protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
95
- protected applyStashedOp(): void;
96
- }
97
-
98
- /**
99
- * The factory that defines the shared summary block.
100
- *
101
- * @sealed
102
- * @internal
103
- */
104
- export declare class SharedSummaryBlockFactory implements IChannelFactory {
105
- /**
106
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
107
- */
108
- static readonly Type = "https://graph.microsoft.com/types/shared-summary-block";
109
- /**
110
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
111
- */
112
- static readonly Attributes: IChannelAttributes;
113
- /**
114
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
115
- */
116
- get type(): string;
117
- /**
118
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
119
- */
120
- get attributes(): IChannelAttributes;
121
- /**
122
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
123
- */
124
- load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
125
- /**
126
- * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
127
- */
128
- create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
129
- }
130
-
131
- export { }