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

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/shared-summary-block
 
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.2.0
 
 Dependency updates only.

package/api-extractor.json

@@ -1,4 +1,7 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-base.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json",
+	"dtsRollup": {
+		"enabled": true
+	}
 }

package/dist/{index.js → index.cjs}

@@ -5,8 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedSummaryBlockFactory = exports.SharedSummaryBlock = void 0;
-var sharedSummaryBlock_1 = require("./sharedSummaryBlock");
+var sharedSummaryBlock_1 = require("./sharedSummaryBlock.cjs");
 Object.defineProperty(exports, "SharedSummaryBlock", { enumerable: true, get: function () { return sharedSummaryBlock_1.SharedSummaryBlock; } });
-var sharedSummaryBlockFactory_1 = require("./sharedSummaryBlockFactory");
+var sharedSummaryBlockFactory_1 = require("./sharedSummaryBlockFactory.cjs");
 Object.defineProperty(exports, "SharedSummaryBlockFactory", { enumerable: true, get: function () { return sharedSummaryBlockFactory_1.SharedSummaryBlockFactory; } });
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAA0D;AAAjD,wHAAA,kBAAkB,OAAA;AAC3B,6EAAwE;AAA/D,sIAAA,yBAAyB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ISharedSummaryBlock } from \"./interfaces\";\nexport { SharedSummaryBlock } from \"./sharedSummaryBlock\";\nexport { SharedSummaryBlockFactory } from \"./sharedSummaryBlockFactory\";\n"]}

package/dist/{interfaces.js → interfaces.cjs}

@@ -4,4 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=interfaces.js.map
+//# sourceMappingURL=interfaces.cjs.map

package/dist/interfaces.cjs.map

@@ -0,0 +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"]}

package/dist/{packageVersion.js → 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.2.1";
-//# sourceMappingURL=packageVersion.js.map
+exports.pkgVersion = "2.0.0-internal.7.3.0";
+//# sourceMappingURL=packageVersion.cjs.map

package/dist/packageVersion.cjs.map

@@ -0,0 +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"]}

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.2.1";
+export declare const pkgVersion = "2.0.0-internal.7.3.0";
 //# sourceMappingURL=packageVersion.d.ts.map

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

@@ -0,0 +1,130 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 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;
+}
+
+export { }

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

@@ -0,0 +1,130 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 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;
+}
+
+export { }

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

@@ -0,0 +1,130 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 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;
+}
+
+export { }

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

@@ -0,0 +1,130 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidSerializer } from '@fluidframework/shared-object-base';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISharedObject } from '@fluidframework/shared-object-base';
+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;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * 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;
+}
+
+export { }

package/dist/{sharedSummaryBlock.js → sharedSummaryBlock.cjs}

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedSummaryBlock = void 0;
 const driver_utils_1 = require("@fluidframework/driver-utils");
 const shared_object_base_1 = require("@fluidframework/shared-object-base");
-const sharedSummaryBlockFactory_1 = require("./sharedSummaryBlockFactory");
+const sharedSummaryBlockFactory_1 = require("./sharedSummaryBlockFactory.cjs");
 const snapshotFileName = "header";
 /**
  * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary.
@@ -97,4 +97,4 @@ class SharedSummaryBlock extends shared_object_base_1.SharedObject {
     }
 }
 exports.SharedSummaryBlock = SharedSummaryBlock;
-//# sourceMappingURL=sharedSummaryBlock.js.map
+//# sourceMappingURL=sharedSummaryBlock.cjs.map

package/dist/sharedSummaryBlock.cjs.map

@@ -0,0 +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"]}

package/dist/{sharedSummaryBlockFactory.js → sharedSummaryBlockFactory.cjs}

@@ -5,8 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedSummaryBlockFactory = void 0;
-const packageVersion_1 = require("./packageVersion");
-const sharedSummaryBlock_1 = require("./sharedSummaryBlock");
+const packageVersion_1 = require("./packageVersion.cjs");
+const sharedSummaryBlock_1 = require("./sharedSummaryBlock.cjs");
 /**
  * The factory that defines the shared summary block.
  *
@@ -56,4 +56,4 @@ SharedSummaryBlockFactory.Attributes = {
     snapshotFormatVersion: "0.1",
     packageVersion: packageVersion_1.pkgVersion,
 };
-//# sourceMappingURL=sharedSummaryBlockFactory.js.map
+//# sourceMappingURL=sharedSummaryBlockFactory.cjs.map

package/dist/sharedSummaryBlockFactory.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedSummaryBlockFactory.cjs","sourceRoot":"","sources":["../src/sharedSummaryBlockFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,yDAA8C;AAC9C,iEAA0D;AAE1D;;;;;GAKG;AACH,MAAa,yBAAyB;IAerC;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,yBAAyB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACpB,OAAO,yBAAyB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,kBAAkB,GAAG,IAAI,uCAAkB,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,uCAAkB,CAChD,EAAE,EACF,OAAO,EACP,yBAAyB,CAAC,UAAU,CACpC,CAAC;QACF,kBAAkB,CAAC,eAAe,EAAE,CAAC;QAErC,OAAO,kBAAkB,CAAC;IAC3B,CAAC;;AAxDF,8DAyDC;AAxDA;;GAEG;AACoB,8BAAI,GAAG,wDAAwD,CAAC;AAEvF;;GAEG;AACoB,oCAAU,GAAuB;IACvD,IAAI,EAAE,yBAAyB,CAAC,IAAI;IACpC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,2BAAU;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"]}

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.0"
+      "packageVersion": "7.38.3"
     }
   ]
 }