@fluidframework/local-driver 2.0.0-internal.7.0.0 → 2.0.0-internal.7.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/local-driver
 
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.0.0
 
 ### Major Changes

package/api-extractor.json

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

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

@@ -0,0 +1,129 @@
+## API Report File for "@fluidframework/local-driver"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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';
+
+// @public
+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)
+export function createLocalResolverCreateNewRequest(documentId: string): IRequest;
+
+// @public
+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
+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>;
+    disconnectClient(disconnectReason: string): void;
+    nackClient(code: number | undefined, type: NackErrorType | undefined, message: any): void;
+    submit(messages: IDocumentMessage[]): void;
+    submitSignal(message: any): void;
+}
+
+// @public
+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>;
+    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
+    connectToStorage(): Promise<IDocumentStorageService>;
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    readonly policies: IDocumentServicePolicies;
+    // (undocumented)
+    readonly resolvedUrl: IResolvedUrl;
+}
+
+// @public
+export class LocalDocumentServiceFactory implements IDocumentServiceFactory {
+    constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
+    // (undocumented)
+    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    disconnectClient(clientId: string, disconnectReason: string): void;
+    nackClient(clientId: string, code?: number, type?: NackErrorType, message?: any): void;
+}
+
+// @public (undocumented)
+export class LocalDocumentStorageService implements IDocumentStorageService {
+    constructor(id: string, manager: GitManager, policies: IDocumentStorageServicePolicies, localDeltaConnectionServer?: ILocalDeltaConnectionServer | undefined, resolvedUrl?: IResolvedUrl | undefined);
+    // (undocumented)
+    protected readonly blobsShaCache: Map<string, string>;
+    // (undocumented)
+    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
+    // (undocumented)
+    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
+    // (undocumented)
+    getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null>;
+    // (undocumented)
+    getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
+    // (undocumented)
+    readonly policies: IDocumentStorageServicePolicies;
+    // (undocumented)
+    readBlob(blobId: string): Promise<ArrayBufferLike>;
+    // (undocumented)
+    get repositoryUrl(): string;
+    // (undocumented)
+    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
+}
+
+// @public
+export class LocalResolver implements IUrlResolver {
+    constructor();
+    // (undocumented)
+    createCreateNewRequest(documentId: string): IRequest;
+    // (undocumented)
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
+    resolve(request: IRequest): Promise<IResolvedUrl>;
+}
+
+// @public
+export class LocalSessionStorageDbFactory implements ITestDbFactory {
+    // (undocumented)
+    connect(): Promise<IDb>;
+    // (undocumented)
+    readonly testDatabase: IDb;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAgB,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAKtF;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,EAAE,EACnB,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,GAAE,MAAgB,EAC1B,GAAG,GAAE,MAAc,GACjB,MAAM,CA0BR;AAED,wBAAgB,YAAY,IAAI,KAAK,CAOpC"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAgB,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAItF;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,EAAE,EACnB,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,GAAE,MAAgB,EAC1B,GAAG,GAAE,MAAc,GACjB,MAAM,CA0BR;AAED,wBAAgB,YAAY,IAAI,KAAK,CAWpC"}

package/dist/auth.js

@@ -7,7 +7,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateUser = exports.generateToken = void 0;
 const jsrsasign_1 = require("jsrsasign");
 const uuid_1 = require("uuid");
-const server_services_client_1 = require("@fluidframework/server-services-client");
 /**
  * Generates a JWT token to authorize against. We do not use the implementation in
  * services-client since it cannot run in the browser without polyfills.
@@ -33,9 +32,12 @@ function generateToken(tenantId, documentId, key, scopes, user, lifetime = 60 *
 }
 exports.generateToken = generateToken;
 function generateUser() {
+    const userId = (0, uuid_1.v4)();
+    const match = userId.match(/^([\da-f]{8})-([\da-f]{4})/);
+    const userName = match !== null ? match[0] : userId; // Just use the first two segments of the (fake) userId as a fake name.
     const randomUser = {
-        id: (0, uuid_1.v4)(),
-        name: (0, server_services_client_1.getRandomName)(" ", true),
+        id: userId,
+        name: userName,
     };
     return randomUser;
 }

package/dist/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yCAA8C;AAC9C,+BAAkC;AAClC,mFAAuE;AAEvE;;;GAGG;AACH,SAAgB,aAAa,CAC5B,QAAgB,EAChB,UAAkB,EAClB,GAAW,EACX,MAAmB,EACnB,IAAY,EACZ,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;IAEnB,IAAI,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC7C,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS,EAAE;QACtD,SAAS,GAAG,YAAY,EAAE,CAAC;KAC3B;IAED,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAiB;QAC5B,UAAU;QACV,MAAM;QACN,QAAQ;QACR,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG,GAAG,QAAQ;QACnB,GAAG;KACH,CAAC;IAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,gBAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAC5B,IAAI,EACJ,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAC5C,MAAM,EACN,OAAO,CACP,CAAC;AACH,CAAC;AAlCD,sCAkCC;AAED,SAAgB,YAAY;IAC3B,MAAM,UAAU,GAAG;QAClB,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,IAAI,EAAE,IAAA,sCAAa,EAAC,GAAG,EAAE,IAAI,CAAC;KAC9B,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC;AAPD,oCAOC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims, IUser, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\nimport { getRandomName } from \"@fluidframework/server-services-client\";\n\n/**\n * Generates a JWT token to authorize against. We do not use the implementation in\n * services-client since it cannot run in the browser without polyfills.\n */\nexport function generateToken(\n\ttenantId: string,\n\tdocumentId: string,\n\tkey: string,\n\tscopes: ScopeType[],\n\tuser?: IUser,\n\tlifetime: number = 60 * 60,\n\tver: string = \"1.0\",\n): string {\n\tlet userClaim = user ? user : generateUser();\n\tif (userClaim.id === \"\" || userClaim.id === undefined) {\n\t\tuserClaim = generateUser();\n\t}\n\n\t// Current time in seconds\n\tconst now = Math.round(new Date().getTime() / 1000);\n\n\tconst claims: ITokenClaims = {\n\t\tdocumentId,\n\t\tscopes,\n\t\ttenantId,\n\t\tuser: userClaim,\n\t\tiat: now,\n\t\texp: now + lifetime,\n\t\tver,\n\t};\n\n\tconst utf8Key = { utf8: key };\n\treturn jsrsasign.jws.JWS.sign(\n\t\tnull,\n\t\tJSON.stringify({ alg: \"HS256\", typ: \"JWT\" }),\n\t\tclaims,\n\t\tutf8Key,\n\t);\n}\n\nexport function generateUser(): IUser {\n\tconst randomUser = {\n\t\tid: uuid(),\n\t\tname: getRandomName(\" \", true),\n\t};\n\n\treturn randomUser;\n}\n"]}
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yCAA8C;AAC9C,+BAAkC;AAElC;;;GAGG;AACH,SAAgB,aAAa,CAC5B,QAAgB,EAChB,UAAkB,EAClB,GAAW,EACX,MAAmB,EACnB,IAAY,EACZ,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;IAEnB,IAAI,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC7C,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS,EAAE;QACtD,SAAS,GAAG,YAAY,EAAE,CAAC;KAC3B;IAED,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAiB;QAC5B,UAAU;QACV,MAAM;QACN,QAAQ;QACR,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG,GAAG,QAAQ;QACnB,GAAG;KACH,CAAC;IAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,gBAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAC5B,IAAI,EACJ,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAC5C,MAAM,EACN,OAAO,CACP,CAAC;AACH,CAAC;AAlCD,sCAkCC;AAED,SAAgB,YAAY;IAC3B,MAAM,MAAM,GAAG,IAAA,SAAI,GAAE,CAAC;IACtB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACzD,MAAM,QAAQ,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,uEAAuE;IAE5H,MAAM,UAAU,GAAG;QAClB,EAAE,EAAE,MAAM;QACV,IAAI,EAAE,QAAQ;KACd,CAAC;IAEF,OAAO,UAAU,CAAC;AACnB,CAAC;AAXD,oCAWC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims, IUser, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * Generates a JWT token to authorize against. We do not use the implementation in\n * services-client since it cannot run in the browser without polyfills.\n */\nexport function generateToken(\n\ttenantId: string,\n\tdocumentId: string,\n\tkey: string,\n\tscopes: ScopeType[],\n\tuser?: IUser,\n\tlifetime: number = 60 * 60,\n\tver: string = \"1.0\",\n): string {\n\tlet userClaim = user ? user : generateUser();\n\tif (userClaim.id === \"\" || userClaim.id === undefined) {\n\t\tuserClaim = generateUser();\n\t}\n\n\t// Current time in seconds\n\tconst now = Math.round(new Date().getTime() / 1000);\n\n\tconst claims: ITokenClaims = {\n\t\tdocumentId,\n\t\tscopes,\n\t\ttenantId,\n\t\tuser: userClaim,\n\t\tiat: now,\n\t\texp: now + lifetime,\n\t\tver,\n\t};\n\n\tconst utf8Key = { utf8: key };\n\treturn jsrsasign.jws.JWS.sign(\n\t\tnull,\n\t\tJSON.stringify({ alg: \"HS256\", typ: \"JWT\" }),\n\t\tclaims,\n\t\tutf8Key,\n\t);\n}\n\nexport function generateUser(): IUser {\n\tconst userId = uuid();\n\tconst match = userId.match(/^([\\da-f]{8})-([\\da-f]{4})/);\n\tconst userName = match !== null ? match[0] : userId; // Just use the first two segments of the (fake) userId as a fake name.\n\n\tconst randomUser = {\n\t\tid: userId,\n\t\tname: userName,\n\t};\n\n\treturn randomUser;\n}\n"]}

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

@@ -0,0 +1,211 @@
+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
+ */
+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;
+
+export declare function createLocalResolverCreateNewRequest(documentId: string): IRequest;
+
+/**
+ * Provides access to the underlying delta storage on the server for local driver.
+ */
+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
+ */
+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.
+ */
+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.
+ */
+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;
+}
+
+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;
+    get 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.
+ */
+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
+ */
+export declare class LocalSessionStorageDbFactory implements ITestDbFactory {
+    readonly testDatabase: IDb;
+    connect(): Promise<IDb>;
+}
+
+export { }

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

@@ -0,0 +1,211 @@
+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
+ */
+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;
+
+export declare function createLocalResolverCreateNewRequest(documentId: string): IRequest;
+
+/**
+ * Provides access to the underlying delta storage on the server for local driver.
+ */
+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
+ */
+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.
+ */
+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.
+ */
+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;
+}
+
+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;
+    get 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.
+ */
+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
+ */
+export declare class LocalSessionStorageDbFactory implements ITestDbFactory {
+    readonly testDatabase: IDb;
+    connect(): Promise<IDb>;
+}
+
+export { }