@fluidframework/routerlicious-driver 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/dist/retriableGitManager.cjs

@@ -0,0 +1,40 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetriableGitManager = void 0;
+const driver_utils_1 = require("@fluidframework/driver-utils");
+class RetriableGitManager {
+    constructor(internalGitManager, logger) {
+        this.internalGitManager = internalGitManager;
+        this.logger = logger;
+    }
+    async getCommits(sha, count) {
+        return this.runWithRetry(async () => this.internalGitManager.getCommits(sha, count), "gitManager_getCommits");
+    }
+    async getTree(root, recursive) {
+        return this.runWithRetry(async () => this.internalGitManager.getTree(root, recursive), "gitManager_getTree");
+    }
+    async getBlob(sha) {
+        return this.runWithRetry(async () => this.internalGitManager.getBlob(sha), "gitManager_getBlob");
+    }
+    async createBlob(content, encoding) {
+        return this.runWithRetry(async () => this.internalGitManager.createBlob(content, encoding), "gitManager_createBlob");
+    }
+    async createGitTree(params) {
+        return this.runWithRetry(async () => this.internalGitManager.createGitTree(params), "gitManager_createGitTree");
+    }
+    async createSummary(summary) {
+        return this.runWithRetry(async () => this.internalGitManager.createSummary(summary), "gitManager_createSummary");
+    }
+    async getSnapshot(sha) {
+        return this.runWithRetry(async () => this.internalGitManager.getSnapshot(sha), "gitManager_getSummary");
+    }
+    async runWithRetry(api, callName) {
+        return (0, driver_utils_1.runWithRetry)(api, callName, this.logger, {});
+    }
+}
+exports.RetriableGitManager = RetriableGitManager;
+//# sourceMappingURL=retriableGitManager.cjs.map

package/dist/retriableGitManager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"retriableGitManager.cjs","sourceRoot":"","sources":["../src/retriableGitManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,+DAA4D;AAM5D,MAAa,mBAAmB;IAC/B,YACkB,kBAA+B,EAC/B,MAA2B;QAD3B,uBAAkB,GAAlB,kBAAkB,CAAa;QAC/B,WAAM,GAAN,MAAM,CAAqB;IAC1C,CAAC;IAEG,KAAK,CAAC,UAAU,CACtB,GAAW,EACX,KAAa;QAEb,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,EAC1D,uBAAuB,CACvB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,SAAkB;QACpD,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,EAC5D,oBAAoB,CACpB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC/B,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,EAChD,oBAAoB,CACpB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,UAAU,CACtB,OAAe,EACf,QAAgB;QAEhB,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,EACjE,uBAAuB,CACvB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,MAA6B;QACvD,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,MAAM,CAAC,EACzD,0BAA0B,CAC1B,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,OAA6B;QAE7B,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,OAAO,CAAC,EAC1D,0BAA0B,CAC1B,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW;QACnC,OAAO,IAAI,CAAC,YAAY,CACvB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,EACpD,uBAAuB,CACvB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,GAAqB,EAAE,QAAgB;QACpE,OAAO,IAAA,2BAAY,EAClB,GAAG,EACH,QAAQ,EACR,IAAI,CAAC,MAAM,EACX,EAAE,CACF,CAAC;IACH,CAAC;CACD;AAvED,kDAuEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type * as git from \"@fluidframework/gitresources\";\nimport {\n\tIWholeSummaryPayload,\n\tIWriteSummaryResponse,\n} from \"@fluidframework/server-services-client\";\nimport { runWithRetry } from \"@fluidframework/driver-utils\";\nimport { ITelemetryLoggerExt } from \"@fluidframework/telemetry-utils\";\nimport { IGitManager } from \"./storageContracts\";\nimport { IR11sResponse } from \"./restWrapper\";\nimport { IWholeFlatSnapshot } from \"./contracts\";\n\nexport class RetriableGitManager implements IGitManager {\n\tconstructor(\n\t\tprivate readonly internalGitManager: IGitManager,\n\t\tprivate readonly logger: ITelemetryLoggerExt,\n\t) {}\n\n\tpublic async getCommits(\n\t\tsha: string,\n\t\tcount: number,\n\t): Promise<IR11sResponse<git.ICommitDetails[]>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.getCommits(sha, count),\n\t\t\t\"gitManager_getCommits\",\n\t\t);\n\t}\n\n\tpublic async getTree(root: string, recursive: boolean): Promise<IR11sResponse<git.ITree>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.getTree(root, recursive),\n\t\t\t\"gitManager_getTree\",\n\t\t);\n\t}\n\n\tpublic async getBlob(sha: string): Promise<IR11sResponse<git.IBlob>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.getBlob(sha),\n\t\t\t\"gitManager_getBlob\",\n\t\t);\n\t}\n\n\tpublic async createBlob(\n\t\tcontent: string,\n\t\tencoding: string,\n\t): Promise<IR11sResponse<git.ICreateBlobResponse>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.createBlob(content, encoding),\n\t\t\t\"gitManager_createBlob\",\n\t\t);\n\t}\n\n\tpublic async createGitTree(params: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.createGitTree(params),\n\t\t\t\"gitManager_createGitTree\",\n\t\t);\n\t}\n\n\tpublic async createSummary(\n\t\tsummary: IWholeSummaryPayload,\n\t): Promise<IR11sResponse<IWriteSummaryResponse>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.createSummary(summary),\n\t\t\t\"gitManager_createSummary\",\n\t\t);\n\t}\n\n\tpublic async getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>> {\n\t\treturn this.runWithRetry(\n\t\t\tasync () => this.internalGitManager.getSnapshot(sha),\n\t\t\t\"gitManager_getSummary\",\n\t\t);\n\t}\n\n\tprivate async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {\n\t\treturn runWithRetry(\n\t\t\tapi,\n\t\t\tcallName,\n\t\t\tthis.logger,\n\t\t\t{}, // progress\n\t\t);\n\t}\n}\n"]}

package/dist/retriableGitManager.d.ts

@@ -3,32 +3,22 @@
  * Licensed under the MIT License.
  */
 import type * as git from "@fluidframework/gitresources";
-import type * as protocol from "@fluidframework/protocol-definitions";
-import { IGitManager, IWholeFlatSummary, IWholeSummaryPayload, IWriteSummaryResponse } from "@fluidframework/server-services-client";
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IWholeSummaryPayload, IWriteSummaryResponse } from "@fluidframework/server-services-client";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { IGitManager } from "./storageContracts";
+import { IR11sResponse } from "./restWrapper";
+import { IWholeFlatSnapshot } from "./contracts";
 export declare class RetriableGitManager implements IGitManager {
     private readonly internalGitManager;
     private readonly logger;
-    constructor(internalGitManager: IGitManager, logger: ITelemetryLogger);
-    getHeader(id: string, sha: string): Promise<protocol.ISnapshotTree>;
-    getFullTree(sha: string): Promise<any>;
-    getCommit(sha: string): Promise<git.ICommit>;
-    getCommits(sha: string, count: number): Promise<git.ICommitDetails[]>;
-    getTree(root: string, recursive: boolean): Promise<git.ITree>;
-    getBlob(sha: string): Promise<git.IBlob>;
-    getRawUrl(sha: string): string;
-    getContent(commit: string, path: string): Promise<git.IBlob>;
-    createBlob(content: string, encoding: string): Promise<git.ICreateBlobResponse>;
-    createGitTree(params: git.ICreateTreeParams): Promise<git.ITree>;
-    createTree(files: protocol.ITree): Promise<git.ITree>;
-    createCommit(commit: git.ICreateCommitParams): Promise<git.ICommit>;
-    getRef(ref: string): Promise<git.IRef>;
-    createRef(branch: string, sha: string): Promise<git.IRef>;
-    upsertRef(branch: string, commitSha: string): Promise<git.IRef>;
-    write(branch: string, inputTree: protocol.ITree, parents: string[], message: string): Promise<git.ICommit>;
-    createSummary(summary: IWholeSummaryPayload): Promise<IWriteSummaryResponse>;
-    deleteSummary(softDelete: boolean): Promise<void>;
-    getSummary(sha: string): Promise<IWholeFlatSummary>;
+    constructor(internalGitManager: IGitManager, logger: ITelemetryLoggerExt);
+    getCommits(sha: string, count: number): Promise<IR11sResponse<git.ICommitDetails[]>>;
+    getTree(root: string, recursive: boolean): Promise<IR11sResponse<git.ITree>>;
+    getBlob(sha: string): Promise<IR11sResponse<git.IBlob>>;
+    createBlob(content: string, encoding: string): Promise<IR11sResponse<git.ICreateBlobResponse>>;
+    createGitTree(params: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>>;
+    createSummary(summary: IWholeSummaryPayload): Promise<IR11sResponse<IWriteSummaryResponse>>;
+    getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;
     private runWithRetry;
 }
 //# sourceMappingURL=retriableGitManager.d.ts.map

package/dist/retriableGitManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retriableGitManager.d.ts","sourceRoot":"","sources":["../src/retriableGitManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,GAAG,MAAM,8BAA8B,CAAC;AACzD,OAAO,KAAK,KAAK,QAAQ,MAAM,sCAAsC,CAAC;AACtE,OAAO,EACH,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACxB,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,qBAAa,mBAAoB,YAAW,WAAW;IAE/C,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM;gBADN,kBAAkB,EAAE,WAAW,EAC/B,MAAM,EAAE,gBAAgB;IAIhC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAOnE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAOtC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAO5C,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;IAOrE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;IAO7D,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;IAO9C,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIxB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;IAO5D,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAO/E,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;IAOhE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;IAOrD,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAOnE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;IAOtC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;IAOzD,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;IAO/D,KAAK,CAAC,MAAM,EAAE,MAAM,EAC7B,SAAS,EAAE,QAAQ,CAAC,KAAK,EACzB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAO7B,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAO5E,aAAa,CAAC,UAAU,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAOlD,YAAY;CAQ7B"}
+{"version":3,"file":"retriableGitManager.d.ts","sourceRoot":"","sources":["../src/retriableGitManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,KAAK,GAAG,MAAM,8BAA8B,CAAC;AACzD,OAAO,EACN,oBAAoB,EACpB,qBAAqB,EACrB,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,qBAAa,mBAAoB,YAAW,WAAW;IAErD,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM;gBADN,kBAAkB,EAAE,WAAW,EAC/B,MAAM,EAAE,mBAAmB;IAGhC,UAAU,CACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GACX,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;IAOlC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAO5E,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAOvD,UAAU,CACtB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAOrC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAO/E,aAAa,CACzB,OAAO,EAAE,oBAAoB,GAC3B,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAOnC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;YAOnE,YAAY;CAQ1B"}

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

@@ -0,0 +1,92 @@
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISession } from '@fluidframework/server-services-client';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: DefaultTokenProvider */
+
+/* Excluded from this release type: DocumentPostCreateError */
+
+/* Excluded from this release type: IRouterliciousDriverPolicies */
+
+/**
+ * Abstracts the token fetching mechanism for a hosting application.
+ * The hosting application is responsible for providing an implementation.
+ * @public
+ */
+export declare interface ITokenProvider {
+    /**
+     * Fetches the orderer token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Optional. Document ID is only required for document-scoped requests.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * Fetches the storage token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Document ID.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
+     * verify against an authorization service, if the user who claims to create the document is the same user who
+     * created it.
+     *
+     * @remarks Notes:
+     *
+     * * Using the callback may have performance impact on the document creation process.
+     *
+     * * Any exceptions thrown in the callback would fail the creation workflow
+     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
+     *
+     * @param documentId - Document ID.
+     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
+     * and document id. It can be used to validate the identity of the document creator.
+     */
+    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
+}
+
+/**
+ * @public
+ */
+export declare interface ITokenResponse {
+    /**
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
+     */
+    jwt: string;
+    /**
+     * A flag indicating whether token was obtained from local cache.
+     *
+     * @remarks `undefined` indicates that the source of the token could not be determined.
+     */
+    fromCache?: boolean;
+}
+
+/* Excluded from this release type: ITokenService */
+
+/* Excluded from this release type: RouterliciousDocumentServiceFactory */
+
+/* Excluded from this release type: RouterliciousErrorType */
+
+/* Excluded from this release type: RouterliciousErrorTypes */
+
+export { }

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

@@ -0,0 +1,98 @@
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISession } from '@fluidframework/server-services-client';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: DefaultTokenProvider */
+
+/* Excluded from this release type: DocumentPostCreateError */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IRouterliciousDriverPolicies */
+
+/**
+ * Abstracts the token fetching mechanism for a hosting application.
+ * The hosting application is responsible for providing an implementation.
+ * @public
+ */
+export declare interface ITokenProvider {
+    /**
+     * Fetches the orderer token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Optional. Document ID is only required for document-scoped requests.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * Fetches the storage token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Document ID.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
+     * verify against an authorization service, if the user who claims to create the document is the same user who
+     * created it.
+     *
+     * @remarks Notes:
+     *
+     * * Using the callback may have performance impact on the document creation process.
+     *
+     * * Any exceptions thrown in the callback would fail the creation workflow
+     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
+     *
+     * @param documentId - Document ID.
+     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
+     * and document id. It can be used to validate the identity of the document creator.
+     */
+    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
+}
+
+/**
+ * @public
+ */
+export declare interface ITokenResponse {
+    /**
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
+     */
+    jwt: string;
+    /**
+     * A flag indicating whether token was obtained from local cache.
+     *
+     * @remarks `undefined` indicates that the source of the token could not be determined.
+     */
+    fromCache?: boolean;
+}
+
+/* Excluded from this release type: ITokenService */
+
+/* Excluded from this release type: RouterliciousDocumentServiceFactory */
+
+/* Excluded from this release type: RouterliciousErrorType */
+
+/* Excluded from this release type: RouterliciousErrorTypes */
+
+export { }

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

@@ -0,0 +1,98 @@
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISession } from '@fluidframework/server-services-client';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: DefaultTokenProvider */
+
+/* Excluded from this release type: DocumentPostCreateError */
+
+/* Excluded from this release type: IDocumentService */
+
+/* Excluded from this release type: IDocumentServiceFactory */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IRouterliciousDriverPolicies */
+
+/**
+ * Abstracts the token fetching mechanism for a hosting application.
+ * The hosting application is responsible for providing an implementation.
+ * @public
+ */
+export declare interface ITokenProvider {
+    /**
+     * Fetches the orderer token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Optional. Document ID is only required for document-scoped requests.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * Fetches the storage token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Document ID.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
+     * verify against an authorization service, if the user who claims to create the document is the same user who
+     * created it.
+     *
+     * @remarks Notes:
+     *
+     * * Using the callback may have performance impact on the document creation process.
+     *
+     * * Any exceptions thrown in the callback would fail the creation workflow
+     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
+     *
+     * @param documentId - Document ID.
+     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
+     * and document id. It can be used to validate the identity of the document creator.
+     */
+    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
+}
+
+/**
+ * @public
+ */
+export declare interface ITokenResponse {
+    /**
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
+     */
+    jwt: string;
+    /**
+     * A flag indicating whether token was obtained from local cache.
+     *
+     * @remarks `undefined` indicates that the source of the token could not be determined.
+     */
+    fromCache?: boolean;
+}
+
+/* Excluded from this release type: ITokenService */
+
+/* Excluded from this release type: RouterliciousDocumentServiceFactory */
+
+/* Excluded from this release type: RouterliciousErrorType */
+
+/* Excluded from this release type: RouterliciousErrorTypes */
+
+export { }

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

@@ -0,0 +1,261 @@
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISession } from '@fluidframework/server-services-client';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+
+/**
+ * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
+ * @internal
+ */
+export declare class DefaultTokenProvider implements ITokenProvider {
+    private readonly jwt;
+    constructor(jwt: string);
+    fetchOrdererToken(): Promise<ITokenResponse>;
+    fetchStorageToken(): Promise<ITokenResponse>;
+}
+
+/**
+ * Error returned by {@link RouterliciousDocumentServiceFactory.createContainer} when an error is thrown
+ * in {@link ITokenProvider.documentPostCreateCallback}.
+ * It is the consumer's responsibility to ensure that any state related to container creation is appropriately
+ * cleaned up in the event of failure.
+ * This includes the document itself, which will have been created by the time this error was thrown.
+ *
+ * @remarks TODO: examples of suggested actions for recovery.
+ * - How would a user delete the created document?
+ * - What would a retry pattern look like here?
+ * @internal
+ */
+export declare class DocumentPostCreateError extends Error {
+    /**
+     * Inner error being wrapped.
+     */
+    private readonly innerError;
+    constructor(
+    /**
+     * Inner error being wrapped.
+     */
+    innerError: Error);
+    readonly name = "DocumentPostCreateError";
+    get stack(): string | undefined;
+}
+
+/**
+ * @internal
+ */
+export declare interface IRouterliciousDriverPolicies {
+    /**
+     * Enable prefetching entire snapshot tree into memory before it is loaded by the runtime.
+     * Default: true
+     */
+    enablePrefetch: boolean;
+    /**
+     * Rate limit concurrent storage requests.
+     * Default: 100
+     */
+    maxConcurrentStorageRequests: number;
+    /**
+     * Rate limit concurrent orderer requests.
+     * Default: 100
+     */
+    maxConcurrentOrdererRequests: number;
+    /**
+     * Enable uploading entire summary tree as a IWholeSummaryPayload to storage.
+     * Default: false
+     */
+    enableWholeSummaryUpload: boolean;
+    /**
+     * Enable service endpoint discovery when creating or joining a session.
+     * Default: false
+     */
+    enableDiscovery: boolean;
+    /**
+     * Enable using RestLess which avoids CORS preflight requests.
+     * Default: true
+     */
+    enableRestLess: boolean;
+    /**
+     * Enable internal cache of summaries/snapshots.
+     * Reduces Summarizer boot time and reduces server load in E2E tests.
+     * Default: true
+     */
+    enableInternalSummaryCaching: boolean;
+    /**
+     * Enable downgrading socket connection to long-polling
+     * when websocket connection cannot be established.
+     * Default: true
+     */
+    enableLongPollingDowngrade: boolean;
+    /**
+     * Indicates that the container is ephemeral.
+     * Artifacts relates to the container are limited to container lifetime.
+     * Default: false
+     */
+    isEphemeralContainer: boolean;
+}
+
+/**
+ * Abstracts the token fetching mechanism for a hosting application.
+ * The hosting application is responsible for providing an implementation.
+ * @public
+ */
+export declare interface ITokenProvider {
+    /**
+     * Fetches the orderer token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Optional. Document ID is only required for document-scoped requests.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * Fetches the storage token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Document ID.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
+     * verify against an authorization service, if the user who claims to create the document is the same user who
+     * created it.
+     *
+     * @remarks Notes:
+     *
+     * * Using the callback may have performance impact on the document creation process.
+     *
+     * * Any exceptions thrown in the callback would fail the creation workflow
+     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
+     *
+     * @param documentId - Document ID.
+     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
+     * and document id. It can be used to validate the identity of the document creator.
+     */
+    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
+}
+
+/**
+ * @public
+ */
+export declare interface ITokenResponse {
+    /**
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
+     */
+    jwt: string;
+    /**
+     * A flag indicating whether token was obtained from local cache.
+     *
+     * @remarks `undefined` indicates that the source of the token could not be determined.
+     */
+    fromCache?: boolean;
+}
+
+/**
+ * Abstracts the discovery of claims contained within a token.
+ * @internal
+ */
+export declare interface ITokenService {
+    /**
+     * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.
+     */
+    extractClaims(token: string): ITokenClaims;
+}
+
+/**
+ * Factory for creating the routerlicious document service. Use this if you want to
+ * use the routerlicious implementation.
+ * @internal
+ */
+export declare class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly tokenProvider;
+    private readonly driverPolicies;
+    private readonly blobCache;
+    private readonly wholeSnapshotTreeCache;
+    private readonly shreddedSummaryTreeCache;
+    constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
+    /**
+     * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
+     *
+     * @throws {@link DocumentPostCreateError}
+         * If an exception is thrown while invoking the provided {@link ITokenProvider.documentPostCreateCallback}.
+         */
+     createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+     /**
+      * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createDocumentService}
+      *
+      * @returns Routerlicious document service.
+      */
+     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean, session?: ISession): Promise<IDocumentService>;
+    }
+
+    /**
+     * Routerlicious Error types
+     * Different error types that may be thrown by the routerlicious driver
+     *
+     * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
+     * @internal
+     */
+    export declare enum RouterliciousErrorType {
+        /**
+         * File not found, or file deleted during session
+         */
+        fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
+        /**
+         * SSL Certificate Error.
+         */
+        sslCertError = "sslCertError"
+    }
+
+    /**
+     * Routerlicious Error types
+     * Different error types that may be thrown by the routerlicious driver
+     * @internal
+     */
+    export declare const RouterliciousErrorTypes: {
+        /**
+         * SSL Certificate Error.
+         */
+        readonly sslCertError: "sslCertError";
+        readonly genericNetworkError: "genericNetworkError";
+        readonly authorizationError: "authorizationError";
+        readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+        readonly offlineError: "offlineError";
+        readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
+        readonly writeError: "writeError";
+        readonly fetchFailure: "fetchFailure";
+        readonly fetchTokenError: "fetchTokenError";
+        readonly incorrectServerResponse: "incorrectServerResponse";
+        readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+        readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
+        readonly locationRedirection: "locationRedirection";
+        readonly fluidInvalidSchema: "fluidInvalidSchema";
+        readonly fileIsLocked: "fileIsLocked";
+        readonly outOfStorageError: "outOfStorageError";
+        readonly genericError: "genericError";
+        readonly throttlingError: "throttlingError";
+        readonly usageError: "usageError";
+    };
+
+    /**
+     * @internal
+     */
+    export declare type RouterliciousErrorTypes = (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
+
+    export { }