@fluidframework/local-driver 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @fluidframework/local-driver
 
+## 2.0.0-internal.8.0.0
+
+### Major Changes
+
+-   local-driver: LocalDocumentStorageService class property type changes [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The `repositoryUrl` property on the `LocalDocumentStorageService` class has changed from a property getter to a
+    `readonly` field. While this is an API change, there should be no changes required on the consumer side since calling
+    code should remain the same.
+
+## 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,10 +1,10 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "@fluidframework/build-common/api-extractor-base.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json",
 	"messages": {
 		"extractorMessageReporting": {
-			"ae-missing-release-tag": {
-				// TODO: Fix violations and remove this rule override
+			// TODO: Add missing documentation and remove this rule override
+			"ae-undocumented": {
 				"logLevel": "none"
 			}
 		}

package/api-report/local-driver.api.md

@@ -36,20 +36,20 @@ import { IWebSocketServer } from '@fluidframework/server-services-core';
 import { NackErrorType } from '@fluidframework/protocol-definitions';
 import type { Socket } from 'socket.io-client';
 
-// @public
+// @internal
 export function createLocalDocumentService(resolvedUrl: IResolvedUrl, localDeltaConnectionServer: ILocalDeltaConnectionServer, tokenProvider: ITokenProvider, tenantId: string, documentId: string, documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>, policies?: IDocumentServicePolicies, innerDocumentService?: IDocumentService, logger?: ITelemetryBaseLogger): IDocumentService;
 
-// @public (undocumented)
+// @alpha (undocumented)
 export function createLocalResolverCreateNewRequest(documentId: string): IRequest;
 
-// @public
+// @internal
 export class LocalDeltaStorageService implements IDocumentDeltaStorageService {
     constructor(tenantId: string, id: string, databaseManager: IDatabaseManager);
     // (undocumented)
     fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<ISequencedDocumentMessage[]>;
 }
 
-// @public
+// @internal
 export class LocalDocumentDeltaConnection extends DocumentDeltaConnection {
     constructor(socket: Socket, documentId: string, logger?: ITelemetryBaseLogger);
     static create(tenantId: string, id: string, token: string, client: IClient, webSocketServer: IWebSocketServer, timeoutMs?: number, logger?: ITelemetryBaseLogger): Promise<LocalDocumentDeltaConnection>;
@@ -59,7 +59,7 @@ export class LocalDocumentDeltaConnection extends DocumentDeltaConnection {
     submitSignal(message: any): void;
 }
 
-// @public
+// @internal
 export class LocalDocumentService implements IDocumentService {
     constructor(resolvedUrl: IResolvedUrl, localDeltaConnectionServer: ILocalDeltaConnectionServer, tokenProvider: ITokenProvider, tenantId: string, documentId: string, documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>, policies?: IDocumentServicePolicies, innerDocumentService?: IDocumentService | undefined, logger?: ITelemetryBaseLogger | undefined);
     connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
@@ -73,7 +73,7 @@ export class LocalDocumentService implements IDocumentService {
     readonly resolvedUrl: IResolvedUrl;
 }
 
-// @public
+// @alpha
 export class LocalDocumentServiceFactory implements IDocumentServiceFactory {
     constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
     // (undocumented)
@@ -83,7 +83,7 @@ export class LocalDocumentServiceFactory implements IDocumentServiceFactory {
     nackClient(clientId: string, code?: number, type?: NackErrorType, message?: any): void;
 }
 
-// @public (undocumented)
+// @internal (undocumented)
 export class LocalDocumentStorageService implements IDocumentStorageService {
     constructor(id: string, manager: GitManager, policies: IDocumentStorageServicePolicies, localDeltaConnectionServer?: ILocalDeltaConnectionServer | undefined, resolvedUrl?: IResolvedUrl | undefined);
     // (undocumented)
@@ -101,12 +101,12 @@ export class LocalDocumentStorageService implements IDocumentStorageService {
     // (undocumented)
     readBlob(blobId: string): Promise<ArrayBufferLike>;
     // (undocumented)
-    get repositoryUrl(): string;
+    readonly repositoryUrl: string;
     // (undocumented)
     uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
 }
 
-// @public
+// @alpha
 export class LocalResolver implements IUrlResolver {
     constructor();
     // (undocumented)
@@ -116,7 +116,7 @@ export class LocalResolver implements IUrlResolver {
     resolve(request: IRequest): Promise<IResolvedUrl>;
 }
 
-// @public
+// @internal
 export class LocalSessionStorageDbFactory implements ITestDbFactory {
     // (undocumented)
     connect(): Promise<IDb>;

package/dist/local-driver-alpha.d.ts

@@ -0,0 +1,108 @@
+import { DocumentDeltaConnection } from '@fluidframework/driver-base';
+import { GitManager } from '@fluidframework/server-services-client';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
+import { IDatabaseManager } from '@fluidframework/server-services-core';
+import { IDb } from '@fluidframework/server-services-core';
+import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
+import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
+import { IStream } from '@fluidframework/driver-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryHandle } from '@fluidframework/protocol-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITestDbFactory } from '@fluidframework/server-test-utils';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { IWebSocketServer } from '@fluidframework/server-services-core';
+import { NackErrorType } from '@fluidframework/protocol-definitions';
+import type { Socket } from 'socket.io-client';
+
+/* Excluded from this release type: createLocalDocumentService */
+
+/**
+ * @alpha
+ */
+export declare function createLocalResolverCreateNewRequest(documentId: string): IRequest;
+
+/* Excluded from this release type: DocumentDeltaConnection */
+
+/* Excluded from this release type: LocalDeltaStorageService */
+
+/* Excluded from this release type: LocalDocumentDeltaConnection */
+
+/* Excluded from this release type: LocalDocumentService */
+
+/**
+ * Implementation of document service factory for local use.
+ * @alpha
+ */
+export declare class LocalDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly localDeltaConnectionServer;
+    private readonly policies?;
+    private readonly innerDocumentService?;
+    private readonly documentDeltaConnectionsMap;
+    /**
+     * @param localDeltaConnectionServer - delta connection server for ops
+     */
+    constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
+    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    /**
+     * Creates and returns a document service for testing using the given resolved
+     * URL for the tenant ID, document ID, and token.
+     * @param resolvedUrl - resolved URL of document
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    /**
+     * Gets the document delta connection for the clientId and asks it to disconnect the client.
+     * @param clientId - The ID of the client to be disconnected.
+     * @param disconnectReason - The reason of the disconnection.
+     */
+    disconnectClient(clientId: string, disconnectReason: string): void;
+    /**
+     * Gets the document delta connection for the clientId and asks it to nack the client.
+     * @param clientId - The ID of the client to be Nack'd.
+     * @param code - An error code number that represents the error. It will be a valid HTTP error code.
+     * @param type - Type of the Nack.
+     * @param message - A message about the nack for debugging/logging/telemetry purposes.
+     */
+    nackClient(clientId: string, code?: number, type?: NackErrorType, message?: any): void;
+}
+
+/* Excluded from this release type: LocalDocumentStorageService */
+
+/**
+ * Resolves URLs by providing fake URLs which succeed with the other
+ * related local classes.
+ * @alpha
+ */
+export declare class LocalResolver implements IUrlResolver {
+    private readonly tenantId;
+    private readonly tokenKey;
+    constructor();
+    /**
+     * Resolves URL requests by providing fake URLs with an actually generated
+     * token from constant test strings. The root of the URL is fake, but the
+     * remaining relative URL can still be parsed.
+     * @param request - request to handle
+     */
+    resolve(request: IRequest): Promise<IResolvedUrl>;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
+    createCreateNewRequest(documentId: string): IRequest;
+}
+
+/* Excluded from this release type: LocalSessionStorageDbFactory */
+
+export { }

package/dist/local-driver-beta.d.ts

@@ -0,0 +1,81 @@
+import { DocumentDeltaConnection } from '@fluidframework/driver-base';
+import { GitManager } from '@fluidframework/server-services-client';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
+import { IDatabaseManager } from '@fluidframework/server-services-core';
+import { IDb } from '@fluidframework/server-services-core';
+import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
+import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
+import { IStream } from '@fluidframework/driver-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryHandle } from '@fluidframework/protocol-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITestDbFactory } from '@fluidframework/server-test-utils';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { IWebSocketServer } from '@fluidframework/server-services-core';
+import { NackErrorType } from '@fluidframework/protocol-definitions';
+import type { Socket } from 'socket.io-client';
+
+/* Excluded from this release type: createLocalDocumentService */
+
+/* Excluded from this release type: createLocalResolverCreateNewRequest */
+
+/* Excluded from this release type: DocumentDeltaConnection */
+
+/* Excluded from this release type: IDocumentDeltaConnection */
+
+/* Excluded from this release type: IDocumentDeltaStorageService */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentServicePolicies */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IDocumentStorageServicePolicies */
+
+/* Excluded from this release type: IRequest */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IStream */
+
+/* Excluded from this release type: ISummaryContext */
+
+/* Excluded from this release type: ITelemetryBaseLogger */
+
+/* Excluded from this release type: ITokenProvider */
+
+/* Excluded from this release type: IUrlResolver */
+
+/* Excluded from this release type: LocalDeltaStorageService */
+
+/* Excluded from this release type: LocalDocumentDeltaConnection */
+
+/* Excluded from this release type: LocalDocumentService */
+
+/* Excluded from this release type: LocalDocumentServiceFactory */
+
+/* Excluded from this release type: LocalDocumentStorageService */
+
+/* Excluded from this release type: LocalResolver */
+
+/* Excluded from this release type: LocalSessionStorageDbFactory */
+
+export { }

package/dist/local-driver-public.d.ts

@@ -0,0 +1,81 @@
+import { DocumentDeltaConnection } from '@fluidframework/driver-base';
+import { GitManager } from '@fluidframework/server-services-client';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
+import { IDatabaseManager } from '@fluidframework/server-services-core';
+import { IDb } from '@fluidframework/server-services-core';
+import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
+import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
+import { IStream } from '@fluidframework/driver-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryHandle } from '@fluidframework/protocol-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITestDbFactory } from '@fluidframework/server-test-utils';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { IWebSocketServer } from '@fluidframework/server-services-core';
+import { NackErrorType } from '@fluidframework/protocol-definitions';
+import type { Socket } from 'socket.io-client';
+
+/* Excluded from this release type: createLocalDocumentService */
+
+/* Excluded from this release type: createLocalResolverCreateNewRequest */
+
+/* Excluded from this release type: DocumentDeltaConnection */
+
+/* Excluded from this release type: IDocumentDeltaConnection */
+
+/* Excluded from this release type: IDocumentDeltaStorageService */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IDocumentServicePolicies */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IDocumentStorageServicePolicies */
+
+/* Excluded from this release type: IRequest */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IStream */
+
+/* Excluded from this release type: ISummaryContext */
+
+/* Excluded from this release type: ITelemetryBaseLogger */
+
+/* Excluded from this release type: ITokenProvider */
+
+/* Excluded from this release type: IUrlResolver */
+
+/* Excluded from this release type: LocalDeltaStorageService */
+
+/* Excluded from this release type: LocalDocumentDeltaConnection */
+
+/* Excluded from this release type: LocalDocumentService */
+
+/* Excluded from this release type: LocalDocumentServiceFactory */
+
+/* Excluded from this release type: LocalDocumentStorageService */
+
+/* Excluded from this release type: LocalResolver */
+
+/* Excluded from this release type: LocalSessionStorageDbFactory */
+
+export { }

package/dist/local-driver-untrimmed.d.ts

@@ -0,0 +1,224 @@
+import { DocumentDeltaConnection } from '@fluidframework/driver-base';
+import { GitManager } from '@fluidframework/server-services-client';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
+import { IDatabaseManager } from '@fluidframework/server-services-core';
+import { IDb } from '@fluidframework/server-services-core';
+import { IDocumentDeltaConnection } from '@fluidframework/driver-definitions';
+import { IDocumentDeltaStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentServicePolicies } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IDocumentStorageServicePolicies } from '@fluidframework/driver-definitions';
+import { ILocalDeltaConnectionServer } from '@fluidframework/server-local-server';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISnapshotTreeEx } from '@fluidframework/protocol-definitions';
+import { IStream } from '@fluidframework/driver-definitions';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryHandle } from '@fluidframework/protocol-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITestDbFactory } from '@fluidframework/server-test-utils';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { IVersion } from '@fluidframework/protocol-definitions';
+import { IWebSocketServer } from '@fluidframework/server-services-core';
+import { NackErrorType } from '@fluidframework/protocol-definitions';
+import type { Socket } from 'socket.io-client';
+
+/**
+ * Creates and returns a document service for local use.
+ * @param localDeltaConnectionServer - delta connection server for ops
+ * @param tokenProvider - token provider with a single token
+ * @param tenantId - ID of tenant
+ * @param documentId - ID of document
+ * @internal
+ */
+export declare function createLocalDocumentService(resolvedUrl: IResolvedUrl, localDeltaConnectionServer: ILocalDeltaConnectionServer, tokenProvider: ITokenProvider, tenantId: string, documentId: string, documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>, policies?: IDocumentServicePolicies, innerDocumentService?: IDocumentService, logger?: ITelemetryBaseLogger): IDocumentService;
+
+/**
+ * @alpha
+ */
+export declare function createLocalResolverCreateNewRequest(documentId: string): IRequest;
+
+/**
+ * Provides access to the underlying delta storage on the server for local driver.
+ * @internal
+ */
+export declare class LocalDeltaStorageService implements IDocumentDeltaStorageService {
+    private readonly tenantId;
+    private readonly id;
+    private readonly databaseManager;
+    constructor(tenantId: string, id: string, databaseManager: IDatabaseManager);
+    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean): IStream<ISequencedDocumentMessage[]>;
+    private getCore;
+}
+
+/**
+ * Represents a connection to a stream of delta updates
+ * @internal
+ */
+export declare class LocalDocumentDeltaConnection extends DocumentDeltaConnection {
+    /**
+     * Create a LocalDocumentDeltaConnection
+     * Handle initial messages, contents or signals if they were in queue
+     *
+     * @param tenantId - the ID of the tenant
+     * @param id - document ID
+     * @param token - authorization token for storage service
+     * @param client - information about the client
+     * @param webSocketServer - web socket server to create connection
+     */
+    static create(tenantId: string, id: string, token: string, client: IClient, webSocketServer: IWebSocketServer, timeoutMs?: number, logger?: ITelemetryBaseLogger): Promise<LocalDocumentDeltaConnection>;
+    constructor(socket: Socket, documentId: string, logger?: ITelemetryBaseLogger);
+    /**
+     * Submits a new delta operation to the server
+     */
+    submit(messages: IDocumentMessage[]): void;
+    /**
+     * Submits a new signal to the server
+     */
+    submitSignal(message: any): void;
+    /**
+     * Send a "disconnect" message on the socket.
+     * @param disconnectReason - The reason of the disconnection.
+     */
+    disconnectClient(disconnectReason: string): void;
+    /**
+     * * Sends a "nack" message on the socket.
+     * @param code - An error code number that represents the error. It will be a valid HTTP error code.
+     * @param type - Type of the Nack.
+     * @param message - A message about the nack for debugging/logging/telemetry purposes.
+     */
+    nackClient(code: number | undefined, type: NackErrorType | undefined, message: any): void;
+}
+
+/**
+ * Basic implementation of a document service for local use.
+ * @internal
+ */
+export declare class LocalDocumentService implements IDocumentService {
+    readonly resolvedUrl: IResolvedUrl;
+    private readonly localDeltaConnectionServer;
+    private readonly tokenProvider;
+    private readonly tenantId;
+    private readonly documentId;
+    private readonly documentDeltaConnectionsMap;
+    readonly policies: IDocumentServicePolicies;
+    private readonly innerDocumentService?;
+    private readonly logger?;
+    /**
+     * @param localDeltaConnectionServer - delta connection server for ops
+     * @param tokenProvider - token provider
+     * @param tenantId - ID of tenant
+     * @param documentId - ID of document
+     */
+    constructor(resolvedUrl: IResolvedUrl, localDeltaConnectionServer: ILocalDeltaConnectionServer, tokenProvider: ITokenProvider, tenantId: string, documentId: string, documentDeltaConnectionsMap: Map<string, LocalDocumentDeltaConnection>, policies?: IDocumentServicePolicies, innerDocumentService?: IDocumentService | undefined, logger?: ITelemetryBaseLogger | undefined);
+    dispose(): void;
+    /**
+     * Creates and returns a document storage service for local use.
+     */
+    connectToStorage(): Promise<IDocumentStorageService>;
+    /**
+     * Creates and returns a delta storage service for local use.
+     */
+    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
+    /**
+     * Creates and returns a delta stream for local use.
+     * @param client - client data
+     */
+    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
+}
+
+/**
+ * Implementation of document service factory for local use.
+ * @alpha
+ */
+export declare class LocalDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly localDeltaConnectionServer;
+    private readonly policies?;
+    private readonly innerDocumentService?;
+    private readonly documentDeltaConnectionsMap;
+    /**
+     * @param localDeltaConnectionServer - delta connection server for ops
+     */
+    constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
+    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    /**
+     * Creates and returns a document service for testing using the given resolved
+     * URL for the tenant ID, document ID, and token.
+     * @param resolvedUrl - resolved URL of document
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    /**
+     * Gets the document delta connection for the clientId and asks it to disconnect the client.
+     * @param clientId - The ID of the client to be disconnected.
+     * @param disconnectReason - The reason of the disconnection.
+     */
+    disconnectClient(clientId: string, disconnectReason: string): void;
+    /**
+     * Gets the document delta connection for the clientId and asks it to nack the client.
+     * @param clientId - The ID of the client to be Nack'd.
+     * @param code - An error code number that represents the error. It will be a valid HTTP error code.
+     * @param type - Type of the Nack.
+     * @param message - A message about the nack for debugging/logging/telemetry purposes.
+     */
+    nackClient(clientId: string, code?: number, type?: NackErrorType, message?: any): void;
+}
+
+/**
+ * @internal
+ */
+export declare class LocalDocumentStorageService implements IDocumentStorageService {
+    private readonly id;
+    private readonly manager;
+    readonly policies: IDocumentStorageServicePolicies;
+    private readonly localDeltaConnectionServer?;
+    private readonly resolvedUrl?;
+    protected readonly blobsShaCache: Map<string, string>;
+    private readonly summaryTreeUploadManager;
+    readonly repositoryUrl: string;
+    constructor(id: string, manager: GitManager, policies: IDocumentStorageServicePolicies, localDeltaConnectionServer?: ILocalDeltaConnectionServer | undefined, resolvedUrl?: IResolvedUrl | undefined);
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null>;
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
+    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
+    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
+    private getPreviousFullSnapshot;
+}
+
+/**
+ * Resolves URLs by providing fake URLs which succeed with the other
+ * related local classes.
+ * @alpha
+ */
+export declare class LocalResolver implements IUrlResolver {
+    private readonly tenantId;
+    private readonly tokenKey;
+    constructor();
+    /**
+     * Resolves URL requests by providing fake URLs with an actually generated
+     * token from constant test strings. The root of the URL is fake, but the
+     * remaining relative URL can still be parsed.
+     * @param request - request to handle
+     */
+    resolve(request: IRequest): Promise<IResolvedUrl>;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
+    createCreateNewRequest(documentId: string): IRequest;
+}
+
+/**
+ * A database factory for testing that stores data in the browsers session storage
+ * @internal
+ */
+export declare class LocalSessionStorageDbFactory implements ITestDbFactory {
+    readonly testDatabase: IDb;
+    connect(): Promise<IDb>;
+}
+
+export { }

package/dist/localDeltaStorageService.cjs

@@ -8,6 +8,7 @@ exports.LocalDeltaStorageService = void 0;
 const driver_utils_1 = require("@fluidframework/driver-utils");
 /**
  * Provides access to the underlying delta storage on the server for local driver.
+ * @internal
  */
 class LocalDeltaStorageService {
     constructor(tenantId, id, databaseManager) {

package/dist/localDeltaStorageService.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"localDeltaStorageService.cjs","sourceRoot":"","sources":["../src/localDeltaStorageService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,+DAAkE;AAElE;;GAEG;AACH,MAAa,wBAAwB;IACpC,YACkB,QAAgB,EAChB,EAAU,EACV,eAAiC;QAFjC,aAAQ,GAAR,QAAQ,CAAQ;QAChB,OAAE,GAAF,EAAE,CAAQ;QACV,oBAAe,GAAf,eAAe,CAAkB;IAChD,CAAC;IAEG,aAAa,CACnB,IAAY,EACZ,EAAsB,EACtB,WAAyB,EACzB,UAAoB;QAEpB,OAAO,IAAA,iCAAkB,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,EAAW;QAC9C,MAAM,KAAK,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC/D,KAAK,CAAC,0BAA0B,CAAC,GAAG,EAAE,CAAC;QACvC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,oBAAoB;QAEtE,kFAAkF;QAClF,iBAAiB;QACjB,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,MAAM,CAAC,gBAAgB,CAAC;QAEtE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,0BAA0B,EAAE,CAAC,EAAE,CAAC,CAAC;QAChF,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC;IACjB,CAAC;CACD;AA9BD,4DA8BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentDeltaStorageService, IStream } from \"@fluidframework/driver-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { IDatabaseManager } from \"@fluidframework/server-services-core\";\nimport { streamFromMessages } from \"@fluidframework/driver-utils\";\n\n/**\n * Provides access to the underlying delta storage on the server for local driver.\n */\nexport class LocalDeltaStorageService implements IDocumentDeltaStorageService {\n\tconstructor(\n\t\tprivate readonly tenantId: string,\n\t\tprivate readonly id: string,\n\t\tprivate readonly databaseManager: IDatabaseManager,\n\t) {}\n\n\tpublic fetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t): IStream<ISequencedDocumentMessage[]> {\n\t\treturn streamFromMessages(this.getCore(from, to));\n\t}\n\n\tprivate async getCore(from: number, to?: number) {\n\t\tconst query = { documentId: this.id, tenantId: this.tenantId };\n\t\tquery[\"operation.sequenceNumber\"] = {};\n\t\tquery[\"operation.sequenceNumber\"].$gt = from - 1; // from is inclusive\n\n\t\t// This looks like a bug. It used to work without setting $lt key. Now it does not\n\t\t// Need follow up\n\t\tquery[\"operation.sequenceNumber\"].$lt = to ?? Number.MAX_SAFE_INTEGER;\n\n\t\tconst allDeltas = await this.databaseManager.getDeltaCollection(this.tenantId, this.id);\n\t\tconst dbDeltas = await allDeltas.find(query, { \"operation.sequenceNumber\": 1 });\n\t\tconst messages = dbDeltas.map((delta) => delta.operation);\n\t\treturn messages;\n\t}\n}\n"]}
+{"version":3,"file":"localDeltaStorageService.cjs","sourceRoot":"","sources":["../src/localDeltaStorageService.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,+DAAkE;AAElE;;;GAGG;AACH,MAAa,wBAAwB;IACpC,YACkB,QAAgB,EAChB,EAAU,EACV,eAAiC;QAFjC,aAAQ,GAAR,QAAQ,CAAQ;QAChB,OAAE,GAAF,EAAE,CAAQ;QACV,oBAAe,GAAf,eAAe,CAAkB;IAChD,CAAC;IAEG,aAAa,CACnB,IAAY,EACZ,EAAsB,EACtB,WAAyB,EACzB,UAAoB;QAEpB,OAAO,IAAA,iCAAkB,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,EAAW;QAC9C,MAAM,KAAK,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC/D,KAAK,CAAC,0BAA0B,CAAC,GAAG,EAAE,CAAC;QACvC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,oBAAoB;QAEtE,kFAAkF;QAClF,iBAAiB;QACjB,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,MAAM,CAAC,gBAAgB,CAAC;QAEtE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,0BAA0B,EAAE,CAAC,EAAE,CAAC,CAAC;QAChF,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC;IACjB,CAAC;CACD;AA9BD,4DA8BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentDeltaStorageService, IStream } from \"@fluidframework/driver-definitions\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { IDatabaseManager } from \"@fluidframework/server-services-core\";\nimport { streamFromMessages } from \"@fluidframework/driver-utils\";\n\n/**\n * Provides access to the underlying delta storage on the server for local driver.\n * @internal\n */\nexport class LocalDeltaStorageService implements IDocumentDeltaStorageService {\n\tconstructor(\n\t\tprivate readonly tenantId: string,\n\t\tprivate readonly id: string,\n\t\tprivate readonly databaseManager: IDatabaseManager,\n\t) {}\n\n\tpublic fetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t): IStream<ISequencedDocumentMessage[]> {\n\t\treturn streamFromMessages(this.getCore(from, to));\n\t}\n\n\tprivate async getCore(from: number, to?: number) {\n\t\tconst query = { documentId: this.id, tenantId: this.tenantId };\n\t\tquery[\"operation.sequenceNumber\"] = {};\n\t\tquery[\"operation.sequenceNumber\"].$gt = from - 1; // from is inclusive\n\n\t\t// This looks like a bug. It used to work without setting $lt key. Now it does not\n\t\t// Need follow up\n\t\tquery[\"operation.sequenceNumber\"].$lt = to ?? Number.MAX_SAFE_INTEGER;\n\n\t\tconst allDeltas = await this.databaseManager.getDeltaCollection(this.tenantId, this.id);\n\t\tconst dbDeltas = await allDeltas.find(query, { \"operation.sequenceNumber\": 1 });\n\t\tconst messages = dbDeltas.map((delta) => delta.operation);\n\t\treturn messages;\n\t}\n}\n"]}

package/dist/localDeltaStorageService.d.ts

@@ -7,6 +7,7 @@ import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions"
 import { IDatabaseManager } from "@fluidframework/server-services-core";
 /**
  * Provides access to the underlying delta storage on the server for local driver.
+ * @internal
  */
 export declare class LocalDeltaStorageService implements IDocumentDeltaStorageService {
     private readonly tenantId;