@fluidframework/shared-summary-block 2.0.0-dev.7.4.0.215747 → 2.0.0-dev.7.4.0.216897

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 (41) hide show
  1. package/api-extractor-lint.json +13 -0
  2. package/api-report/shared-summary-block.api.md +3 -3
  3. package/dist/interfaces.cjs.map +1 -1
  4. package/dist/interfaces.d.ts +1 -2
  5. package/dist/interfaces.d.ts.map +1 -1
  6. package/dist/packageVersion.cjs +1 -1
  7. package/dist/packageVersion.cjs.map +1 -1
  8. package/dist/packageVersion.d.ts +1 -1
  9. package/dist/shared-summary-block-alpha.d.ts +23 -124
  10. package/dist/shared-summary-block-beta.d.ts +23 -124
  11. package/dist/shared-summary-block-public.d.ts +23 -124
  12. package/dist/shared-summary-block-untrimmed.d.ts +3 -5
  13. package/dist/sharedSummaryBlock.cjs +1 -2
  14. package/dist/sharedSummaryBlock.cjs.map +1 -1
  15. package/dist/sharedSummaryBlock.d.ts +1 -2
  16. package/dist/sharedSummaryBlock.d.ts.map +1 -1
  17. package/dist/sharedSummaryBlockFactory.cjs +1 -1
  18. package/dist/sharedSummaryBlockFactory.cjs.map +1 -1
  19. package/dist/sharedSummaryBlockFactory.d.ts +1 -1
  20. package/lib/interfaces.d.ts +1 -2
  21. package/lib/interfaces.d.ts.map +1 -1
  22. package/lib/interfaces.mjs.map +1 -1
  23. package/lib/packageVersion.d.ts +1 -1
  24. package/lib/packageVersion.mjs +1 -1
  25. package/lib/packageVersion.mjs.map +1 -1
  26. package/lib/shared-summary-block-alpha.d.ts +23 -124
  27. package/lib/shared-summary-block-beta.d.ts +23 -124
  28. package/lib/shared-summary-block-public.d.ts +23 -124
  29. package/lib/shared-summary-block-untrimmed.d.ts +3 -5
  30. package/lib/sharedSummaryBlock.d.ts +1 -2
  31. package/lib/sharedSummaryBlock.d.ts.map +1 -1
  32. package/lib/sharedSummaryBlock.mjs +1 -2
  33. package/lib/sharedSummaryBlock.mjs.map +1 -1
  34. package/lib/sharedSummaryBlockFactory.d.ts +1 -1
  35. package/lib/sharedSummaryBlockFactory.mjs +1 -1
  36. package/lib/sharedSummaryBlockFactory.mjs.map +1 -1
  37. package/package.json +10 -9
  38. package/src/interfaces.ts +1 -2
  39. package/src/packageVersion.ts +1 -1
  40. package/src/sharedSummaryBlock.ts +1 -2
  41. package/src/sharedSummaryBlockFactory.ts +1 -1
@@ -8,7 +8,7 @@ import { ISharedObject } from "@fluidframework/shared-object-base";
8
8
  * The factory that defines the shared summary block.
9
9
  *
10
10
  * @sealed
11
- * @public
11
+ * @internal
12
12
  */
13
13
  export declare class SharedSummaryBlockFactory implements IChannelFactory {
14
14
  /**
@@ -8,7 +8,7 @@ import { SharedSummaryBlock } from "./sharedSummaryBlock.mjs";
8
8
  * The factory that defines the shared summary block.
9
9
  *
10
10
  * @sealed
11
- * @public
11
+ * @internal
12
12
  */
13
13
  export class SharedSummaryBlockFactory {
14
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"sharedSummaryBlockFactory.mjs","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OASI,EAAE,UAAU,EAAE;OACd,EAAE,kBAAkB,EAAE;AAE7B;;;;;GAKG;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,kBAAkB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC3E,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,kBAAkB,CAChD,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","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelServices,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { SharedSummaryBlock } from \"./sharedSummaryBlock\";\n\n/**\n * The factory that defines the shared summary block.\n *\n * @sealed\n * @public\n */\nexport class SharedSummaryBlockFactory implements IChannelFactory {\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<ISharedObject> {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlock(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): ISharedObject {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlock(\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"]}
1
+ {"version":3,"file":"sharedSummaryBlockFactory.mjs","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OASI,EAAE,UAAU,EAAE;OACd,EAAE,kBAAkB,EAAE;AAE7B;;;;;GAKG;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,kBAAkB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC3E,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,kBAAkB,CAChD,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","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelServices,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { SharedSummaryBlock } from \"./sharedSummaryBlock\";\n\n/**\n * The factory that defines the shared summary block.\n *\n * @sealed\n * @internal\n */\nexport class SharedSummaryBlockFactory implements IChannelFactory {\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<ISharedObject> {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlock(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): ISharedObject {\n\t\tconst sharedSummaryBlock = new SharedSummaryBlock(\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"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/shared-summary-block",
3
- "version": "2.0.0-dev.7.4.0.215747",
3
+ "version": "2.0.0-dev.7.4.0.216897",
4
4
  "description": "A DDS that does not generate ops but is part of summary",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,21 +47,21 @@
47
47
  "temp-directory": "nyc/.nyc_output"
48
48
  },
49
49
  "dependencies": {
50
- "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.215747",
51
- "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.215747",
52
- "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.215747",
50
+ "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.216897",
51
+ "@fluidframework/datastore-definitions": "2.0.0-dev.7.4.0.216897",
52
+ "@fluidframework/driver-utils": "2.0.0-dev.7.4.0.216897",
53
53
  "@fluidframework/protocol-definitions": "^3.0.0",
54
- "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.215747",
55
- "@fluidframework/shared-object-base": "2.0.0-dev.7.4.0.215747"
54
+ "@fluidframework/runtime-definitions": "2.0.0-dev.7.4.0.216897",
55
+ "@fluidframework/shared-object-base": "2.0.0-dev.7.4.0.216897"
56
56
  },
57
57
  "devDependencies": {
58
58
  "@fluid-tools/build-cli": "^0.28.0",
59
59
  "@fluidframework/build-common": "^2.0.3",
60
60
  "@fluidframework/build-tools": "^0.28.0",
61
61
  "@fluidframework/eslint-config-fluid": "^3.1.0",
62
- "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.215747",
62
+ "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.216897",
63
63
  "@fluidframework/shared-summary-block-previous": "npm:@fluidframework/shared-summary-block@2.0.0-internal.7.2.0",
64
- "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.215747",
64
+ "@fluidframework/test-runtime-utils": "2.0.0-dev.7.4.0.216897",
65
65
  "@microsoft/api-extractor": "^7.38.3",
66
66
  "@types/benchmark": "^2.1.0",
67
67
  "@types/mocha": "^9.1.1",
@@ -107,12 +107,13 @@
107
107
  "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
108
108
  "build:genver": "gen-version",
109
109
  "build:test": "tsc-multi --config ./tsc-multi.test.json",
110
+ "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
110
111
  "ci:build:docs": "api-extractor run",
111
112
  "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
112
113
  "eslint": "eslint --format stylish src",
113
114
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
114
115
  "format": "npm run prettier:fix",
115
- "lint": "npm run prettier && npm run eslint",
116
+ "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
116
117
  "lint:fix": "npm run prettier:fix && npm run eslint:fix",
117
118
  "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
118
119
  "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
package/src/interfaces.ts CHANGED
@@ -11,8 +11,7 @@ import { ISharedObject } from "@fluidframework/shared-object-base";
11
11
  * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
12
12
  * the set of calls on this interface to set data should be the same. This is critical because the object does not
13
13
  * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
14
- *
15
- * @public
14
+ * @internal
16
15
  */
17
16
  export interface ISharedSummaryBlock extends ISharedObject {
18
17
  /**
@@ -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.7.4.0.215747";
9
+ export const pkgVersion = "2.0.0-dev.7.4.0.216897";
@@ -34,8 +34,7 @@ interface ISharedSummaryBlockDataSerializable {
34
34
  /**
35
35
  * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
36
36
  * Data should be set in this object in response to a remote op.
37
- *
38
- * @public
37
+ * @internal
39
38
  */
40
39
  export class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
41
40
  /**
@@ -17,7 +17,7 @@ import { SharedSummaryBlock } from "./sharedSummaryBlock";
17
17
  * The factory that defines the shared summary block.
18
18
  *
19
19
  * @sealed
20
- * @public
20
+ * @internal
21
21
  */
22
22
  export class SharedSummaryBlockFactory implements IChannelFactory {
23
23
  /**