@fluid-experimental/property-dds 2.0.0-dev.6.4.0.192049 → 2.0.0-dev.7.2.0.204906

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @fluid-experimental/property-dds
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.6.3.0
 
 Dependency updates only.

package/api-extractor.json

@@ -1,4 +1,13 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-common.json"
+	"extends": "@fluidframework/build-common/api-extractor-base.json",
+
+	// TODO: Fix violations and remove these rule overrides
+	"messages": {
+		"extractorMessageReporting": {
+			"ae-missing-release-tag": {
+				"logLevel": "none"
+			}
+		}
+	}
 }

package/api-report/property-dds.api.md

@@ -0,0 +1,276 @@
+## API Report File for "@fluid-experimental/property-dds"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="node" />
+
+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 { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { NodeProperty } from '@fluid-experimental/property-properties';
+import { SharedObject } from '@fluidframework/shared-object-base';
+
+// @public (undocumented)
+export abstract class CompressedPropertyTreeFactory implements IChannelFactory {
+    // (undocumented)
+    abstract get attributes(): any;
+    // (undocumented)
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
+    // (undocumented)
+    abstract getDecodeFce(): any;
+    // (undocumented)
+    getEncDec(): ISharedPropertyTreeEncDec;
+    // (undocumented)
+    abstract getEncodeFce(): any;
+    // (undocumented)
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
+    // (undocumented)
+    abstract newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+    // (undocumented)
+    abstract get type(): any;
+}
+
+// @public
+export class DeflatedPropertyTree extends SharedPropertyTree {
+    // (undocumented)
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): DeflatedPropertyTree;
+    // (undocumented)
+    static getFactory(): IChannelFactory;
+}
+
+// @public (undocumented)
+export class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
+    // (undocumented)
+    static readonly Attributes: IChannelAttributes;
+    // (undocumented)
+    get attributes(): IChannelAttributes;
+    // (undocumented)
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree;
+    // (undocumented)
+    getDecodeFce(): any;
+    // (undocumented)
+    getEncodeFce(): any;
+    // (undocumented)
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<DeflatedPropertyTree>;
+    // (undocumented)
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+    // (undocumented)
+    static readonly Type = "DeflatedPropertyTree:84534a0fe613522101f6";
+    // (undocumented)
+    get type(): string;
+}
+
+// @public (undocumented)
+export interface IPropertyTreeConfig {
+    // (undocumented)
+    encDec: ISharedPropertyTreeEncDec;
+}
+
+// @public (undocumented)
+export interface IPropertyTreeMessage {
+    // (undocumented)
+    changeSet: SerializedChangeSet;
+    // (undocumented)
+    guid: string;
+    // (undocumented)
+    localBranchStart: string | undefined;
+    // (undocumented)
+    metadata: Metadata;
+    // (undocumented)
+    op: OpKind;
+    // (undocumented)
+    rebaseMetaInformation?: Map<any, any>;
+    // (undocumented)
+    referenceGuid: string;
+    // (undocumented)
+    remoteHeadGuid: string;
+    // (undocumented)
+    useMH?: boolean;
+}
+
+// @public (undocumented)
+export interface IRemotePropertyTreeMessage extends IPropertyTreeMessage {
+    // (undocumented)
+    sequenceNumber: number;
+}
+
+// @public (undocumented)
+export interface ISharedPropertyTreeEncDec {
+    // (undocumented)
+    messageEncoder: {
+        encode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
+        decode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
+    };
+    // (undocumented)
+    summaryEncoder: {
+        encode: (ISnapshotSummary: any) => Buffer;
+        decode: (Buffer: any) => ISnapshotSummary;
+    };
+}
+
+// @public (undocumented)
+export interface ISnapshotSummary {
+    // (undocumented)
+    remoteChanges?: IPropertyTreeMessage[];
+    // (undocumented)
+    remoteHeadGuid: string;
+    // (undocumented)
+    remoteTipView?: SerializedChangeSet;
+    // (undocumented)
+    unrebasedRemoteChanges?: Record<string, IRemotePropertyTreeMessage>;
+}
+
+// @public (undocumented)
+export class LZ4PropertyTree extends SharedPropertyTree {
+    // (undocumented)
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): LZ4PropertyTree;
+    // (undocumented)
+    static getFactory(): IChannelFactory;
+}
+
+// @public (undocumented)
+export class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    // (undocumented)
+    static readonly Attributes: IChannelAttributes;
+    // (undocumented)
+    get attributes(): IChannelAttributes;
+    // (undocumented)
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree;
+    // (undocumented)
+    getDecodeFce(): any;
+    // (undocumented)
+    getEncodeFce(): any;
+    // (undocumented)
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<LZ4PropertyTree>;
+    // (undocumented)
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+    // (undocumented)
+    static readonly Type = "LZ4PropertyTree:84534a0fe613522101f6";
+    // (undocumented)
+    get type(): string;
+}
+
+// @public (undocumented)
+export type Metadata = any;
+
+// @public (undocumented)
+export const enum OpKind {
+    // (undocumented)
+    ChangeSet = 0
+}
+
+// @public
+export class PropertyTreeFactory implements IChannelFactory {
+    // (undocumented)
+    static readonly Attributes: IChannelAttributes;
+    // (undocumented)
+    get attributes(): IChannelAttributes;
+    // (undocumented)
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
+    // (undocumented)
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
+    // (undocumented)
+    static readonly Type = "PropertyTree:01EP5J4Y6C284JR6ATVPPHRJ4E";
+    // (undocumented)
+    get type(): string;
+}
+
+// @public (undocumented)
+export type SerializedChangeSet = any;
+
+// @public
+export class SharedPropertyTree extends SharedObject {
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig?: IPropertyTreeConfig);
+    // (undocumented)
+    get activeCommit(): IPropertyTreeMessage;
+    // (undocumented)
+    protected applyStashedOp(): void;
+    // (undocumented)
+    get changeSet(): SerializedChangeSet;
+    // (undocumented)
+    commit(metadata?: Metadata, submitEmptyChange?: boolean): void;
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): SharedPropertyTree;
+    // (undocumented)
+    enqueuedMessages: IPropertyTreeMessage[];
+    static getFactory(): IChannelFactory;
+    // (undocumented)
+    getRebasedChanges(startGuid: string, endGuid?: string): IPropertyTreeMessage[];
+    // (undocumented)
+    getUnrebasedChange(guid: string): IRemotePropertyTreeMessage;
+    // (undocumented)
+    headCommitGuid: string;
+    // (undocumented)
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    // (undocumented)
+    localChanges: IPropertyTreeMessage[];
+    protected logIfEnabled(message: any): void;
+    // (undocumented)
+    notificationDelayScope: number;
+    protected onConnect(): void;
+    // (undocumented)
+    protected onDisconnect(): void;
+    // (undocumented)
+    options: SharedPropertyTreeOptions;
+    popNotificationDelayScope(): void;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    // (undocumented)
+    propertyTreeConfig: IPropertyTreeConfig;
+    // (undocumented)
+    static prune(minimumSequenceNumber: number, remoteChanges: IPropertyTreeMessage[], unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>): {
+        remoteChanges: IPropertyTreeMessage[];
+        unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
+        prunedCount: number;
+    };
+    // (undocumented)
+    pruneHistory(): void;
+    pushNotificationDelayScope(): void;
+    // (undocumented)
+    remoteChanges: IPropertyTreeMessage[];
+    // (undocumented)
+    remoteTipView: SerializedChangeSet;
+    // (undocumented)
+    _reportDirtinessToView(): void;
+    // (undocumented)
+    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
+    // (undocumented)
+    get root(): NodeProperty;
+    // (undocumented)
+    _root: any;
+    // (undocumented)
+    skipSequenceNumber: number;
+    // (undocumented)
+    stopTransmission(stop: boolean): void;
+    // (undocumented)
+    summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    // (undocumented)
+    tipView: SerializedChangeSet;
+    // (undocumented)
+    transmissionsHaveBeenStopped: boolean;
+    // (undocumented)
+    unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
+    // (undocumented)
+    useMH: boolean;
+}
+
+// @public (undocumented)
+export interface SharedPropertyTreeOptions {
+    // (undocumented)
+    clientFiltering?: boolean;
+    // (undocumented)
+    disablePartialCheckout?: boolean;
+    // (undocumented)
+    paths?: string[];
+    // (undocumented)
+    useMH?: boolean;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/property-dds-alpha.d.ts

@@ -0,0 +1,264 @@
+/// <reference types="node" />
+
+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 { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { NodeProperty } from '@fluid-experimental/property-properties';
+import { SharedObject } from '@fluidframework/shared-object-base';
+
+export declare abstract class CompressedPropertyTreeFactory implements IChannelFactory {
+    abstract get attributes(): any;
+    abstract get type(): any;
+    abstract getEncodeFce(): any;
+    abstract getDecodeFce(): any;
+    private createCompressionMethods;
+    getEncDec(): ISharedPropertyTreeEncDec;
+    abstract newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
+}
+
+/**
+ * This class is the extension of SharedPropertyTree which compresses
+ * the deltas and summaries communicated to the server by Deflate.
+ */
+export declare class DeflatedPropertyTree extends SharedPropertyTree {
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): DeflatedPropertyTree;
+    static getFactory(): IChannelFactory;
+}
+
+export declare class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
+    static readonly Type = "DeflatedPropertyTree:84534a0fe613522101f6";
+    static readonly Attributes: IChannelAttributes;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<DeflatedPropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    getEncodeFce(): any;
+    getDecodeFce(): any;
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+}
+
+export declare interface IPropertyTreeConfig {
+    encDec: ISharedPropertyTreeEncDec;
+}
+
+export declare interface IPropertyTreeMessage {
+    op: OpKind;
+    changeSet: SerializedChangeSet;
+    metadata: Metadata;
+    guid: string;
+    referenceGuid: string;
+    remoteHeadGuid: string;
+    localBranchStart: string | undefined;
+    rebaseMetaInformation?: Map<any, any>;
+    useMH?: boolean;
+}
+
+export declare interface IRemotePropertyTreeMessage extends IPropertyTreeMessage {
+    sequenceNumber: number;
+}
+
+export declare interface ISharedPropertyTreeEncDec {
+    messageEncoder: {
+        encode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
+        decode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
+    };
+    summaryEncoder: {
+        encode: (ISnapshotSummary: any) => Buffer;
+        decode: (Buffer: any) => ISnapshotSummary;
+    };
+}
+
+export declare interface ISnapshotSummary {
+    remoteTipView?: SerializedChangeSet;
+    remoteChanges?: IPropertyTreeMessage[];
+    unrebasedRemoteChanges?: Record<string, IRemotePropertyTreeMessage>;
+    remoteHeadGuid: string;
+}
+
+export declare class LZ4PropertyTree extends SharedPropertyTree {
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): LZ4PropertyTree;
+    static getFactory(): IChannelFactory;
+}
+
+export declare class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    static readonly Type = "LZ4PropertyTree:84534a0fe613522101f6";
+    static readonly Attributes: IChannelAttributes;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<LZ4PropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    getEncodeFce(): any;
+    getDecodeFce(): any;
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+}
+
+export declare type Metadata = any;
+
+export declare const enum OpKind {
+    ChangeSet = 0
+}
+
+/**
+ * The factory that defines the map
+ */
+export declare class PropertyTreeFactory implements IChannelFactory {
+    static readonly Type = "PropertyTree:01EP5J4Y6C284JR6ATVPPHRJ4E";
+    static readonly Attributes: IChannelAttributes;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
+}
+
+export declare type SerializedChangeSet = any;
+
+/**
+ * Silly DDS example that models a six sided die.
+ *
+ * Unlike the typical 'Dice Roller' example where clients clobber each other's last roll in a
+ * SharedMap, this 'SharedDie' DDS works by advancing an internal PRNG each time it sees a 'roll'
+ * operation.
+ *
+ * Because all clients are using the same PRNG starting in the same state, they arrive at
+ * consensus by simply applying the same number of rolls.  (A fun addition would be logging
+ * who received which roll, which would need to change as clients learn how races are resolved
+ * in the total order)
+ */
+export declare class SharedPropertyTree extends SharedObject {
+    tipView: SerializedChangeSet;
+    remoteTipView: SerializedChangeSet;
+    localChanges: IPropertyTreeMessage[];
+    remoteChanges: IPropertyTreeMessage[];
+    unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
+    transmissionsHaveBeenStopped: boolean;
+    enqueuedMessages: IPropertyTreeMessage[];
+    notificationDelayScope: number;
+    _root: any;
+    options: SharedPropertyTreeOptions;
+    skipSequenceNumber: number;
+    headCommitGuid: string;
+    useMH: boolean;
+    propertyTreeConfig: IPropertyTreeConfig;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig?: IPropertyTreeConfig);
+    /**
+     * Create a new shared cell
+     *
+     * @param runtime - data store runtime the new shared map belongs to
+     * @param id - optional name of the shared map
+     * @returns newly create shared map (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): SharedPropertyTree;
+    /**
+     * Get a factory for SharedDie to register with the data store.
+     *
+     * @returns a factory that creates and load SharedDie
+     */
+    static getFactory(): IChannelFactory;
+    /**
+     * in case of partial checkout we want to send the paths we are interested in once we are connected
+     */
+    protected onConnect(): void;
+    private scopeFutureDeltasToPaths;
+    _reportDirtinessToView(): void;
+    get changeSet(): SerializedChangeSet;
+    get activeCommit(): IPropertyTreeMessage;
+    get root(): NodeProperty;
+    commit(metadata?: Metadata, submitEmptyChange?: boolean): void;
+    /**
+     * This method encodes the given message to the transfer form
+     * @param change - The message to be encoded.
+     */
+    private encodeMessage;
+    /**
+     * This method decodes message from the transfer form.
+     * @param transferChange - The message to be decoded.
+     */
+    private decodeMessage;
+    private applyChangeSet;
+    stopTransmission(stop: boolean): void;
+    /**
+     * Delays notifications until popNotificationDelayScope has been called the same number of times as
+     * pushNotificationDelayScope.
+     */
+    pushNotificationDelayScope(): void;
+    /**
+     * Re-enables notifications when popNotificationDelayScope has been called the same number of times as
+     * pushNotificationDelayScope.
+     */
+    popNotificationDelayScope(): void;
+    /**
+     * Process an operation
+     *
+     * @param message - the message to prepare
+     * @param local - whether the message was sent by the local client
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be undefined.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private addRemoteChange;
+    private updateRemoteHeadGuid;
+    static prune(minimumSequenceNumber: number, remoteChanges: IPropertyTreeMessage[], unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>): {
+        remoteChanges: IPropertyTreeMessage[];
+        unrebasedRemoteChanges: Record<string, IRemotePropertyTreeMessage>;
+        prunedCount: number;
+    };
+    pruneHistory(): void;
+    /**
+     * This method encodes the local summary (snapshot) object into the serialized form.
+     * @param summary - The local summary (snapshot)representation.
+     * @returns The serialized summary representation.
+     */
+    private encodeSummary;
+    /**
+     * This method decodes the serialized form of the summary into the local summary (snapshot) object.
+     * @param serializedSummary - The serialized summary representation.
+     * @returns The local summary (snapshot)representation.
+     */
+    private decodeSummary;
+    /**
+     * This method writes the log message if the logging is enabled in the extended DDS.
+     * The logging is not enabled in the default Property DDS
+     * @param message - The message to be logged.
+     */
+    protected logIfEnabled(message: any): void;
+    /**
+     * This method encodes the binary representation of the
+     * blob.
+     * @param blob - The binary representation of the blob.
+     * @returns The encoded representation of the blob.
+     */
+    private encodeSummaryBlob;
+    /**
+     * This method decodes the encoded representation of the
+     * blob.
+     * @param blob - The encoded representation of the blob.
+     * @returns The binary representation of the blob.
+     */
+    private decodeSummaryBlob;
+    summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected onDisconnect(): void;
+    private _applyLocalChangeSet;
+    private _applyRemoteChangeSet;
+    getUnrebasedChange(guid: string): IRemotePropertyTreeMessage;
+    getRebasedChanges(startGuid: string, endGuid?: string): IPropertyTreeMessage[];
+    private rebaseLocalChanges;
+    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
+    protected applyStashedOp(): void;
+}
+
+export declare interface SharedPropertyTreeOptions {
+    paths?: string[];
+    clientFiltering?: boolean;
+    useMH?: boolean;
+    disablePartialCheckout?: boolean;
+}
+
+export { }