@fluidframework/shared-summary-block 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @fluidframework/shared-summary-block
 
+## 2.0.0-internal.8.0.0
+
+### Major Changes
+
+-   datastore-definitions: Jsonable and Serializable now require a generic parameter [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The `Jsonable` and `Serializable` types from @fluidframework/datastore-definitions now require a generic parameter and
+    if that type is `any` or `unknown`will return a new result `JsonableTypeWith<>` that more accurately represents the
+    limitation of serialization.
+
+    Additional modifications:
+
+    -   `Jsonable`'s `TReplacement` parameter default has also been changed from `void` to `never`, which now disallows
+        `void`.
+    -   Unrecognized primitive types like `symbol` are now filtered to `never` instead of `{}`.
+    -   Recursive types with arrays (`[]`) are now supported.
+
+    `Serializable` is commonly used for DDS values and now requires more precision when using them. For example SharedMatrix
+    (unqualified) has an `any` default that meant values were `Serializable<any>` (i.e. `any`), but now `Serializable<any>`
+    is `JsonableTypeWith<IFluidHandle>` which may be problematic for reading or writing. Preferred correction is to specify
+    the value type but casting through `any` may provide a quick fix.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.3.0
 
 Dependency updates only.

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-extractor.json

@@ -1,7 +1,12 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-base.json",
-	"dtsRollup": {
-		"enabled": true
+	"extends": "../../../common/build/build-common/api-extractor-base.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: Add missing documentation and remove this rule override
+			"ae-undocumented": {
+				"logLevel": "none"
+			}
+		}
 	}
 }

package/api-report/shared-summary-block.api.md

@@ -16,13 +16,13 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
 import { Jsonable } from '@fluidframework/datastore-definitions';
 import { SharedObject } from '@fluidframework/shared-object-base';
 
-// @public
+// @internal
 export interface ISharedSummaryBlock extends ISharedObject {
     get<T>(key: string): Jsonable<T>;
     set<T>(key: string, value: Jsonable<T>): void;
 }
 
-// @public
+// @internal
 export class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
     constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
     // (undocumented)
@@ -41,7 +41,7 @@ export class SharedSummaryBlock extends SharedObject implements ISharedSummaryBl
     protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
 }
 
-// @public @sealed
+// @internal @sealed
 export class SharedSummaryBlockFactory implements IChannelFactory {
     // (undocumented)
     static readonly Attributes: IChannelAttributes;

package/dist/interfaces.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.cjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\n\n/**\n * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.\n * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,\n * the set of calls on this interface to set data should be the same. This is critical because the object does not\n * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.\n *\n * @public\n */\nexport interface ISharedSummaryBlock extends ISharedObject {\n\t/**\n\t * Retrieves the given key from the map.\n\t * @param key - Key to retrieve from.\n\t * @returns The stored value, or undefined if the key is not set.\n\t */\n\tget<T>(key: string): Jsonable<T>;\n\n\t/**\n\t * Sets the value stored at key to the provided value.\n\t * @param key - Key to set at.\n\t * @param value - Jsonable type value to set.\n\t */\n\tset<T>(key: string, value: Jsonable<T>): void;\n}\n"]}
+{"version":3,"file":"interfaces.cjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\n\n/**\n * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.\n * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,\n * the set of calls on this interface to set data should be the same. This is critical because the object does not\n * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.\n * @internal\n */\nexport interface ISharedSummaryBlock extends ISharedObject {\n\t/**\n\t * Retrieves the given key from the map.\n\t * @param key - Key to retrieve from.\n\t * @returns The stored value, or undefined if the key is not set.\n\t *\n\t * @privateRemarks\n\t * The return type is underspecified to allow for the possibility of objects with function or undefined values.\n\t */\n\tget<T>(key: string): Jsonable<T>;\n\n\t/**\n\t * Sets the value stored at key to the provided value.\n\t * @param key - Key to set at.\n\t * @param value - Jsonable type value to set.\n\t */\n\tset<T>(key: string, value: Jsonable<T>): void;\n}\n"]}

package/dist/interfaces.d.ts

@@ -9,14 +9,16 @@ import { ISharedObject } from "@fluidframework/shared-object-base";
  * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
  * the set of calls on this interface to set data should be the same. This is critical because the object does not
  * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
- *
- * @public
+ * @internal
  */
 export interface ISharedSummaryBlock extends ISharedObject {
     /**
      * Retrieves the given key from the map.
      * @param key - Key to retrieve from.
      * @returns The stored value, or undefined if the key is not set.
+     *
+     * @privateRemarks
+     * The return type is underspecified to allow for the possibility of objects with function or undefined values.
      */
     get<T>(key: string): Jsonable<T>;
     /**

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACzD;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEjC;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC9C"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACzD;;;;;;;OAOG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEjC;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC9C"}

package/dist/packageVersion.cjs

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/shared-summary-block";
-exports.pkgVersion = "2.0.0-internal.7.3.0";
+exports.pkgVersion = "2.0.0-internal.8.0.0";
 //# sourceMappingURL=packageVersion.cjs.map

package/dist/packageVersion.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,sBAAsB,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-internal.7.3.0\";\n"]}
+{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,sBAAsB,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-internal.8.0.0\";\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/shared-summary-block";
-export declare const pkgVersion = "2.0.0-internal.7.3.0";
+export declare const pkgVersion = "2.0.0-internal.8.0.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/shared-summary-block-alpha.d.ts

@@ -10,121 +10,10 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
 import { Jsonable } from '@fluidframework/datastore-definitions';
 import { SharedObject } from '@fluidframework/shared-object-base';
 
-/**
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
- *
- * @public
- */
-export declare interface ISharedSummaryBlock extends ISharedObject {
-    /**
-     * Retrieves the given key from the map.
-     * @param key - Key to retrieve from.
-     * @returns The stored value, or undefined if the key is not set.
-     */
-    get<T>(key: string): Jsonable<T>;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set at.
-     * @param value - Jsonable type value to set.
-     */
-    set<T>(key: string, value: Jsonable<T>): void;
-}
+/* Excluded from this release type: ISharedSummaryBlock */
 
-/**
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
- * Data should be set in this object in response to a remote op.
- *
- * @public
- */
-export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
-    /**
-     * Create a new shared summary block
-     *
-     * @param runtime - data store runtime the new shared summary block belongs to.
-     * @param id - optional name of the shared summary block.
-     * @returns newly created shared summary block (but not attached yet).
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
-    /**
-     * Get a factory for SharedSummaryBlock to register with the data store.
-     *
-     * @returns a factory that creates and loads SharedSummaryBlock.
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * The data held by this object.
-     */
-    private readonly data;
-    /**
-     * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
-     * be provided.
-     *
-     * @param id - optional name of the shared summary block.
-     * @param runtime - data store runtime thee object belongs to.
-     * @param attributes - The attributes for the object.
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * {@inheritDoc ISharedSummaryBlock.get}
-     */
-    get<T>(key: string): Jsonable<T>;
-    /**
-     * {@inheritDoc ISharedSummaryBlock.set}
-     */
-    set<T>(key: string, value: Jsonable<T>): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
-    protected applyStashedOp(): void;
-}
+/* Excluded from this release type: SharedSummaryBlock */
 
-/**
- * The factory that defines the shared summary block.
- *
- * @sealed
- * @public
- */
-export declare class SharedSummaryBlockFactory implements IChannelFactory {
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    static readonly Type = "https://graph.microsoft.com/types/shared-summary-block";
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    static readonly Attributes: IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    get type(): string;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    get attributes(): IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
-     */
-    create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
-}
+/* Excluded from this release type: SharedSummaryBlockFactory */
 
 export { }

package/dist/shared-summary-block-beta.d.ts

@@ -10,121 +10,30 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
 import { Jsonable } from '@fluidframework/datastore-definitions';
 import { SharedObject } from '@fluidframework/shared-object-base';
 
-/**
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
- *
- * @public
- */
-export declare interface ISharedSummaryBlock extends ISharedObject {
-    /**
-     * Retrieves the given key from the map.
-     * @param key - Key to retrieve from.
-     * @returns The stored value, or undefined if the key is not set.
-     */
-    get<T>(key: string): Jsonable<T>;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set at.
-     * @param value - Jsonable type value to set.
-     */
-    set<T>(key: string, value: Jsonable<T>): void;
-}
+/* Excluded from this release type: IChannelAttributes */
 
-/**
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
- * Data should be set in this object in response to a remote op.
- *
- * @public
- */
-export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
-    /**
-     * Create a new shared summary block
-     *
-     * @param runtime - data store runtime the new shared summary block belongs to.
-     * @param id - optional name of the shared summary block.
-     * @returns newly created shared summary block (but not attached yet).
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
-    /**
-     * Get a factory for SharedSummaryBlock to register with the data store.
-     *
-     * @returns a factory that creates and loads SharedSummaryBlock.
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * The data held by this object.
-     */
-    private readonly data;
-    /**
-     * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
-     * be provided.
-     *
-     * @param id - optional name of the shared summary block.
-     * @param runtime - data store runtime thee object belongs to.
-     * @param attributes - The attributes for the object.
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * {@inheritDoc ISharedSummaryBlock.get}
-     */
-    get<T>(key: string): Jsonable<T>;
-    /**
-     * {@inheritDoc ISharedSummaryBlock.set}
-     */
-    set<T>(key: string, value: Jsonable<T>): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
-    protected applyStashedOp(): void;
-}
+/* Excluded from this release type: IChannelFactory */
 
-/**
- * The factory that defines the shared summary block.
- *
- * @sealed
- * @public
- */
-export declare class SharedSummaryBlockFactory implements IChannelFactory {
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    static readonly Type = "https://graph.microsoft.com/types/shared-summary-block";
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    static readonly Attributes: IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    get type(): string;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    get attributes(): IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
-     */
-    create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
-}
+/* Excluded from this release type: IChannelServices */
+
+/* Excluded from this release type: IChannelStorageService */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidSerializer */
+
+/* Excluded from this release type: ISharedObject */
+
+/* Excluded from this release type: ISharedSummaryBlock */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: Jsonable */
+
+/* Excluded from this release type: SharedObject */
+
+/* Excluded from this release type: SharedSummaryBlock */
+
+/* Excluded from this release type: SharedSummaryBlockFactory */
 
 export { }

package/dist/shared-summary-block-public.d.ts

@@ -10,121 +10,30 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
 import { Jsonable } from '@fluidframework/datastore-definitions';
 import { SharedObject } from '@fluidframework/shared-object-base';
 
-/**
- * Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops.
- * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
- * the set of calls on this interface to set data should be the same. This is critical because the object does not
- * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
- *
- * @public
- */
-export declare interface ISharedSummaryBlock extends ISharedObject {
-    /**
-     * Retrieves the given key from the map.
-     * @param key - Key to retrieve from.
-     * @returns The stored value, or undefined if the key is not set.
-     */
-    get<T>(key: string): Jsonable<T>;
-    /**
-     * Sets the value stored at key to the provided value.
-     * @param key - Key to set at.
-     * @param value - Jsonable type value to set.
-     */
-    set<T>(key: string, value: Jsonable<T>): void;
-}
+/* Excluded from this release type: IChannelAttributes */
 
-/**
- * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
- * Data should be set in this object in response to a remote op.
- *
- * @public
- */
-export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
-    /**
-     * Create a new shared summary block
-     *
-     * @param runtime - data store runtime the new shared summary block belongs to.
-     * @param id - optional name of the shared summary block.
-     * @returns newly created shared summary block (but not attached yet).
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedSummaryBlock;
-    /**
-     * Get a factory for SharedSummaryBlock to register with the data store.
-     *
-     * @returns a factory that creates and loads SharedSummaryBlock.
-     */
-    static getFactory(): IChannelFactory;
-    /**
-     * The data held by this object.
-     */
-    private readonly data;
-    /**
-     * Constructs a new SharedSummaryBlock. If the object is non-local, an id and service interfaces will
-     * be provided.
-     *
-     * @param id - optional name of the shared summary block.
-     * @param runtime - data store runtime thee object belongs to.
-     * @param attributes - The attributes for the object.
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * {@inheritDoc ISharedSummaryBlock.get}
-     */
-    get<T>(key: string): Jsonable<T>;
-    /**
-     * {@inheritDoc ISharedSummaryBlock.set}
-     */
-    set<T>(key: string, value: Jsonable<T>): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-     */
-    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-     */
-    protected loadCore(storage: IChannelStorageService): Promise<void>;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-     */
-    protected onDisconnect(): void;
-    /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-     */
-    protected processCore(message: ISequencedDocumentMessage, local: boolean): void;
-    protected applyStashedOp(): void;
-}
+/* Excluded from this release type: IChannelFactory */
 
-/**
- * The factory that defines the shared summary block.
- *
- * @sealed
- * @public
- */
-export declare class SharedSummaryBlockFactory implements IChannelFactory {
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    static readonly Type = "https://graph.microsoft.com/types/shared-summary-block";
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    static readonly Attributes: IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory."type"}
-     */
-    get type(): string;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}
-     */
-    get attributes(): IChannelAttributes;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-     */
-    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
-    /**
-     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
-     */
-    create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
-}
+/* Excluded from this release type: IChannelServices */
+
+/* Excluded from this release type: IChannelStorageService */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidSerializer */
+
+/* Excluded from this release type: ISharedObject */
+
+/* Excluded from this release type: ISharedSummaryBlock */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: Jsonable */
+
+/* Excluded from this release type: SharedObject */
+
+/* Excluded from this release type: SharedSummaryBlock */
+
+/* Excluded from this release type: SharedSummaryBlockFactory */
 
 export { }

package/dist/shared-summary-block-untrimmed.d.ts

@@ -15,14 +15,16 @@ import { SharedObject } from '@fluidframework/shared-object-base';
  * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops,
  * the set of calls on this interface to set data should be the same. This is critical because the object does not
  * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
- *
- * @public
+ * @internal
  */
 export declare interface ISharedSummaryBlock extends ISharedObject {
     /**
      * Retrieves the given key from the map.
      * @param key - Key to retrieve from.
      * @returns The stored value, or undefined if the key is not set.
+     *
+     * @privateRemarks
+     * The return type is underspecified to allow for the possibility of objects with function or undefined values.
      */
     get<T>(key: string): Jsonable<T>;
     /**
@@ -36,8 +38,7 @@ export declare interface ISharedSummaryBlock extends ISharedObject {
 /**
  * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
  * Data should be set in this object in response to a remote op.
- *
- * @public
+ * @internal
  */
 export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
     /**
@@ -98,7 +99,7 @@ export declare class SharedSummaryBlock extends SharedObject implements ISharedS
  * The factory that defines the shared summary block.
  *
  * @sealed
- * @public
+ * @internal
  */
 export declare class SharedSummaryBlockFactory implements IChannelFactory {
     /**

package/dist/sharedSummaryBlock.cjs

@@ -12,8 +12,7 @@ const snapshotFileName = "header";
 /**
  * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
  * Data should be set in this object in response to a remote op.
- *
- * @public
+ * @internal
  */
 class SharedSummaryBlock extends shared_object_base_1.SharedObject {
     /**

package/dist/sharedSummaryBlock.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"sharedSummaryBlock.cjs","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAWH,+DAA4D;AAC5D,2EAI4C;AAC5C,+EAAwE;AAGxE,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAUlC;;;;;GAKG;AACH,MAAa,kBAAmB,SAAQ,iCAAY;IACnD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,qDAAyB,CAAC,IAAI,CAAuB,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACvB,OAAO,IAAI,qDAAyB,EAAE,CAAC;IACxC,CAAC;IAOD;;;;;;;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,EAAoB,CAAC;IAYpD,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,4CAAuB,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,2BAAY,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;AA7FD,gDA6FC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelStorageService,\n\tJsonable,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport {\n\tcreateSingleBlobSummary,\n\tIFluidSerializer,\n\tSharedObject,\n} from \"@fluidframework/shared-object-base\";\nimport { SharedSummaryBlockFactory } from \"./sharedSummaryBlockFactory\";\nimport { ISharedSummaryBlock } from \"./interfaces\";\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;\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 *\n * @public\n */\nexport class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {\n\t/**\n\t * Create a new shared summary block\n\t *\n\t * @param runtime - data store runtime the new shared summary block belongs to.\n\t * @param id - optional name of the shared summary block.\n\t * @returns newly created shared summary block (but not attached yet).\n\t */\n\tpublic static create(runtime: IFluidDataStoreRuntime, id?: string) {\n\t\treturn runtime.createChannel(id, SharedSummaryBlockFactory.Type) as SharedSummaryBlock;\n\t}\n\n\t/**\n\t * Get a factory for SharedSummaryBlock to register with the data store.\n\t *\n\t * @returns a factory that creates and loads SharedSummaryBlock.\n\t */\n\tpublic static getFactory(): IChannelFactory {\n\t\treturn new SharedSummaryBlockFactory();\n\t}\n\n\t/**\n\t * The data held by this object.\n\t */\n\tprivate readonly data = new Map<string, Jsonable>();\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"]}
+{"version":3,"file":"sharedSummaryBlock.cjs","sourceRoot":"","sources":["../src/sharedSummaryBlock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAWH,+DAA4D;AAC5D,2EAI4C;AAC5C,+EAAwE;AAGxE,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAUlC;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,iCAAY;IACnD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,qDAAyB,CAAC,IAAI,CAAuB,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACvB,OAAO,IAAI,qDAAyB,EAAE,CAAC;IACxC,CAAC;IAOD;;;;;;;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,4CAAuB,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,2BAAY,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;AA7FD,gDA6FC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelStorageService,\n\tJsonable,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport {\n\tcreateSingleBlobSummary,\n\tIFluidSerializer,\n\tSharedObject,\n} from \"@fluidframework/shared-object-base\";\nimport { SharedSummaryBlockFactory } from \"./sharedSummaryBlockFactory\";\nimport { ISharedSummaryBlock } from \"./interfaces\";\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 * @internal\n */\nexport class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {\n\t/**\n\t * Create a new shared summary block\n\t *\n\t * @param runtime - data store runtime the new shared summary block belongs to.\n\t * @param id - optional name of the shared summary block.\n\t * @returns newly created shared summary block (but not attached yet).\n\t */\n\tpublic static create(runtime: IFluidDataStoreRuntime, id?: string) {\n\t\treturn runtime.createChannel(id, SharedSummaryBlockFactory.Type) as SharedSummaryBlock;\n\t}\n\n\t/**\n\t * Get a factory for SharedSummaryBlock to register with the data store.\n\t *\n\t * @returns a factory that creates and loads SharedSummaryBlock.\n\t */\n\tpublic static getFactory(): IChannelFactory {\n\t\treturn new SharedSummaryBlockFactory();\n\t}\n\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"]}

package/dist/sharedSummaryBlock.d.ts

@@ -10,8 +10,7 @@ import { ISharedSummaryBlock } from "./interfaces";
 /**
  * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
  * Data should be set in this object in response to a remote op.
- *
- * @public
+ * @internal
  */
 export declare class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock {
     /**