@fluidframework/routerlicious-driver 0.58.2002 → 0.59.1000

package/dist/documentServiceFactory.d.ts

@@ -18,13 +18,13 @@ export declare class RouterliciousDocumentServiceFactory implements IDocumentSer
     private readonly blobCache;
     private readonly snapshotTreeCache;
     constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
-    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     /**
      * Creates the document service after extracting different endpoints URLs from a resolved URL.
      *
      * @param resolvedUrl - URL containing different endpoint URLs.
      * @returns Routerlicious document service.
      */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 //# sourceMappingURL=documentServiceFactory.d.ts.map

package/dist/documentServiceFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documentServiceFactory.d.ts","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AASpE,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAiB1C;;;GAGG;AACH,qBAAa,mCAAoC,YAAW,uBAAuB;IAO3E,OAAO,CAAC,QAAQ,CAAC,aAAa;IANlC,SAAgB,YAAY,YAAY;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwC;IAClE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6C;gBAG1D,aAAa,EAAE,cAAc,EAC9C,cAAc,GAAE,OAAO,CAAC,4BAA4B,CAAM;IAQjD,eAAe,CACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,gBAAgB,CAAC;IA4D5B;;;;;OAKG;IACU,qBAAqB,CAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,gBAAgB,CAAC;CAkC/B"}
+{"version":3,"file":"documentServiceFactory.d.ts","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AASpE,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAiB1C;;;GAGG;AACH,qBAAa,mCAAoC,YAAW,uBAAuB;IAO3E,OAAO,CAAC,QAAQ,CAAC,aAAa;IANlC,SAAgB,YAAY,YAAY;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwC;IAClE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6C;gBAG1D,aAAa,EAAE,cAAc,EAC9C,cAAc,GAAE,OAAO,CAAC,4BAA4B,CAAM;IAQjD,eAAe,CACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAuF5B;;;;;OAKG;IACU,qBAAqB,CAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;CAkC/B"}

package/dist/documentServiceFactory.js

@@ -34,7 +34,7 @@ class RouterliciousDocumentServiceFactory {
         this.snapshotTreeCache = new cache_1.InMemoryCache();
         this.driverPolicies = Object.assign(Object.assign({}, defaultRouterliciousDriverPolicies), driverPolicies);
     }
-    async createContainer(createNewSummary, resolvedUrl, logger) {
+    async createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer) {
         driver_utils_1.ensureFluidResolvedUrl(resolvedUrl);
         common_utils_1.assert(!!createNewSummary, 0x204 /* "create empty file not supported" */);
         common_utils_1.assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* "Missing orderer URL!" */);
@@ -54,11 +54,30 @@ class RouterliciousDocumentServiceFactory {
         const rateLimiter = new driver_utils_1.RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);
         const ordererRestWrapper = await restWrapper_1.RouterliciousOrdererRestWrapper.load(tenantId, undefined, this.tokenProvider, logger2, rateLimiter, this.driverPolicies.enableRestLess, resolvedUrl.endpoints.ordererUrl);
         // the backend responds with the actual document ID associated with the new container.
-        const documentId = await ordererRestWrapper.post(`/documents/${tenantId}`, {
+        // @TODO: Remove returned "string" type when removing back-compat code
+        const res = await ordererRestWrapper.post(`/documents/${tenantId}`, {
             summary: createNewUtils_1.convertSummaryToCreateNewSummary(appSummary),
             sequenceNumber: documentAttributes.sequenceNumber,
             values: quorumValues,
+            generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,
         });
+        // For supporting backward compatibility, when the request has generateToken === true, it will return
+        // an object instead of string
+        // @TODO: Remove the logic when no need to support back-compat
+        let documentId;
+        let token;
+        if (typeof res === "string") {
+            documentId = res;
+        }
+        else {
+            documentId = res.id;
+            token = res.token;
+        }
+        // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined
+        // is sufficient to determine if the token will be undefined or not.
+        if (token && this.tokenProvider.documentPostCreateCallback !== undefined) {
+            await this.tokenProvider.documentPostCreateCallback(documentId, token);
+        }
         parsedUrl.set("pathname", urlUtils_1.replaceDocumentIdInPath(parsedUrl.pathname, documentId));
         const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;
         if (!deltaStorageUrl) {
@@ -66,7 +85,7 @@ class RouterliciousDocumentServiceFactory {
         }
         const parsedDeltaStorageUrl = new URL(deltaStorageUrl);
         parsedDeltaStorageUrl.pathname = urlUtils_1.replaceDocumentIdInPath(parsedDeltaStorageUrl.pathname, documentId);
-        return this.createDocumentService(Object.assign(Object.assign({}, resolvedUrl), { url: parsedUrl.toString(), id: documentId, endpoints: Object.assign(Object.assign({}, resolvedUrl.endpoints), { deltaStorageUrl: parsedDeltaStorageUrl.toString() }) }), logger);
+        return this.createDocumentService(Object.assign(Object.assign({}, resolvedUrl), { url: parsedUrl.toString(), id: documentId, endpoints: Object.assign(Object.assign({}, resolvedUrl.endpoints), { deltaStorageUrl: parsedDeltaStorageUrl.toString() }) }), logger, clientIsSummarizer);
     }
     /**
      * Creates the document service after extracting different endpoints URLs from a resolved URL.
@@ -74,7 +93,7 @@ class RouterliciousDocumentServiceFactory {
      * @param resolvedUrl - URL containing different endpoint URLs.
      * @returns Routerlicious document service.
      */
-    async createDocumentService(resolvedUrl, logger) {
+    async createDocumentService(resolvedUrl, logger, clientIsSummarizer) {
         driver_utils_1.ensureFluidResolvedUrl(resolvedUrl);
         const fluidResolvedUrl = resolvedUrl;
         const storageUrl = fluidResolvedUrl.endpoints.storageUrl;

package/dist/documentServiceFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentServiceFactory.js","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAQtD,+DAKsC;AACtC,qEAA8D;AAC9D,uDAAoD;AAGpD,+CAAgE;AAChE,qDAAoE;AACpE,yCAAoE;AACpE,mCAAwC;AACxC,qDAA+D;AAG/D,MAAM,kCAAkC,GAAiC;IACrE,cAAc,EAAE,IAAI;IACpB,4BAA4B,EAAE,GAAG;IACjC,4BAA4B,EAAE,GAAG;IACjC,8BAA8B,EAAE,SAAS;IACzC,wBAAwB,EAAE,KAAK;IAC/B,cAAc,EAAE,IAAI;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAa,mCAAmC;IAM5C,YACqB,aAA6B,EAC9C,iBAAwD,EAAE;QADzC,kBAAa,GAAb,aAAa,CAAgB;QANlC,iBAAY,GAAG,QAAQ,CAAC;QAEvB,cAAS,GAAG,IAAI,qBAAa,EAAmB,CAAC;QACjD,sBAAiB,GAAG,IAAI,qBAAa,EAAwB,CAAC;QAM3E,IAAI,CAAC,cAAc,mCACZ,kCAAkC,GAClC,cAAc,CACpB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CACxB,gBAA0C,EAC1C,WAAyB,EACzB,MAA6B;QAE7B,qCAAsB,CAAC,WAAW,CAAC,CAAC;QACpC,qBAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1E,qBAAM,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC/E,MAAM,SAAS,GAAG,wBAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SACpE;QACD,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnD,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;QAC3E,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;QACjE,IAAI,CAAC,CAAC,eAAe,IAAI,UAAU,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC5E;QACD,MAAM,kBAAkB,GAAG,kDAAmC,CAAC,eAAe,CAAC,CAAC;QAChF,MAAM,YAAY,GAAG,iDAAkC,CAAC,eAAe,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,0BAAW,CAAC,IAAI,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAC;QACtF,MAAM,kBAAkB,GAAG,MAAM,6CAA+B,CAAC,IAAI,CACjE,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,WAAW,EACX,IAAI,CAAC,cAAc,CAAC,cAAc,EAClC,WAAW,CAAC,SAAS,CAAC,UAAU,CACnC,CAAC;QACF,sFAAsF;QACtF,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAC5C,cAAc,QAAQ,EAAE,EACxB;YACI,OAAO,EAAE,iDAAgC,CAAC,UAAU,CAAC;YACrD,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,MAAM,EAAE,YAAY;SACvB,CACJ,CAAC;QACF,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,kCAAuB,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QACnF,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,eAAe,CAAC;QAC9D,IAAI,CAAC,eAAe,EAAE;YAClB,MAAM,IAAI,KAAK,CACX,yDAAyD,eAAe,GAAG,CAAC,CAAC;SACpF;QACD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;QACvD,qBAAqB,CAAC,QAAQ,GAAG,kCAAuB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAErG,OAAO,IAAI,CAAC,qBAAqB,iCAEtB,WAAW,KACd,GAAG,EAAE,SAAS,CAAC,QAAQ,EAAE,EACzB,EAAE,EAAE,UAAU,EACd,SAAS,kCACF,WAAW,CAAC,SAAS,KACxB,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE,QAGzD,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAC9B,WAAyB,EACzB,MAA6B;QAE7B,qCAAsB,CAAC,WAAW,CAAC,CAAC;QAEpC,MAAM,gBAAgB,GAAG,WAAW,CAAC;QACrC,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,eAAe,GAAG,gBAAgB,CAAC,SAAS,CAAC,eAAe,CAAC;QACnE,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,EAAE;YACjC,MAAM,IAAI,KAAK,CACX,oDAAoD,UAAU,qBAAqB,eAAe,GAAG,CAAC,CAAC;SAC9G;QAED,MAAM,SAAS,GAAG,wBAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CACX,0DAA0D,UAAU,cAAc,QAAQ,GAAG,CAAC,CAAC;SACtG;QAED,MAAM,OAAO,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,EAAE,GAAG,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,EAAC,CAAC,CAAC;QAE7F,OAAO,IAAI,iCAAe,CACtB,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,UAAU,EACV,OAAO,EACP,IAAI,CAAC,aAAa,EAClB,QAAQ,EACR,UAAU,EACV,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC;CACJ;AA3HD,kFA2HC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    ensureFluidResolvedUrl,\n    getDocAttributesFromProtocolSummary,\n    getQuorumValuesFromProtocolSummary,\n    RateLimiter,\n} from \"@fluidframework/driver-utils\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { DocumentService } from \"./documentService\";\nimport { IRouterliciousDriverPolicies } from \"./policies\";\nimport { ITokenProvider } from \"./tokens\";\nimport { RouterliciousOrdererRestWrapper } from \"./restWrapper\";\nimport { convertSummaryToCreateNewSummary } from \"./createNewUtils\";\nimport { parseFluidUrl, replaceDocumentIdInPath } from \"./urlUtils\";\nimport { InMemoryCache } from \"./cache\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\n\nconst defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {\n    enablePrefetch: true,\n    maxConcurrentStorageRequests: 100,\n    maxConcurrentOrdererRequests: 100,\n    aggregateBlobsSmallerThanBytes: undefined,\n    enableWholeSummaryUpload: false,\n    enableRestLess: true,\n};\n\n/**\n * Factory for creating the routerlicious document service. Use this if you want to\n * use the routerlicious implementation.\n */\nexport class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {\n    public readonly protocolName = \"fluid:\";\n    private readonly driverPolicies: IRouterliciousDriverPolicies;\n    private readonly blobCache = new InMemoryCache<ArrayBufferLike>();\n    private readonly snapshotTreeCache = new InMemoryCache<ISnapshotTreeVersion>();\n\n    constructor(\n        private readonly tokenProvider: ITokenProvider,\n        driverPolicies: Partial<IRouterliciousDriverPolicies> = {},\n    ) {\n        this.driverPolicies = {\n            ...defaultRouterliciousDriverPolicies,\n            ...driverPolicies,\n        };\n    }\n\n    public async createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n        assert(!!createNewSummary, 0x204 /* \"create empty file not supported\" */);\n        assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* \"Missing orderer URL!\" */);\n        const parsedUrl = parseFluidUrl(resolvedUrl.url);\n        if (!parsedUrl.pathname) {\n            throw new Error(\"Parsed url should contain tenant and doc Id!!\");\n        }\n        const [, tenantId] = parsedUrl.pathname.split(\"/\");\n\n        const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n        const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n        if (!(protocolSummary && appSummary)) {\n            throw new Error(\"Protocol and App Summary required in the full summary\");\n        }\n        const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n        const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\");\n        const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);\n        const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(\n            tenantId,\n            undefined,\n            this.tokenProvider,\n            logger2,\n            rateLimiter,\n            this.driverPolicies.enableRestLess,\n            resolvedUrl.endpoints.ordererUrl,\n        );\n        // the backend responds with the actual document ID associated with the new container.\n        const documentId = await ordererRestWrapper.post<string>(\n            `/documents/${tenantId}`,\n            {\n                summary: convertSummaryToCreateNewSummary(appSummary),\n                sequenceNumber: documentAttributes.sequenceNumber,\n                values: quorumValues,\n            },\n        );\n        parsedUrl.set(\"pathname\", replaceDocumentIdInPath(parsedUrl.pathname, documentId));\n        const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;\n        if (!deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n        const parsedDeltaStorageUrl = new URL(deltaStorageUrl);\n        parsedDeltaStorageUrl.pathname = replaceDocumentIdInPath(parsedDeltaStorageUrl.pathname, documentId);\n\n        return this.createDocumentService(\n            {\n                ...resolvedUrl,\n                url: parsedUrl.toString(),\n                id: documentId,\n                endpoints: {\n                    ...resolvedUrl.endpoints,\n                    deltaStorageUrl: parsedDeltaStorageUrl.toString(),\n                },\n            },\n            logger);\n    }\n\n    /**\n     * Creates the document service after extracting different endpoints URLs from a resolved URL.\n     *\n     * @param resolvedUrl - URL containing different endpoint URLs.\n     * @returns Routerlicious document service.\n     */\n    public async createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n\n        const fluidResolvedUrl = resolvedUrl;\n        const storageUrl = fluidResolvedUrl.endpoints.storageUrl;\n        const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;\n        const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;\n        if (!ordererUrl || !deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n\n        const parsedUrl = parseFluidUrl(fluidResolvedUrl.url);\n        const [, tenantId, documentId] = parsedUrl.pathname.split(\"/\");\n        if (!documentId || !tenantId) {\n            throw new Error(\n                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);\n        }\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\", { all: { driverVersion }});\n\n        return new DocumentService(\n            fluidResolvedUrl,\n            ordererUrl,\n            deltaStorageUrl,\n            storageUrl,\n            logger2,\n            this.tokenProvider,\n            tenantId,\n            documentId,\n            this.driverPolicies,\n            this.blobCache,\n            this.snapshotTreeCache);\n    }\n}\n"]}
+{"version":3,"file":"documentServiceFactory.js","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAQtD,+DAKsC;AACtC,qEAA8D;AAC9D,uDAAoD;AAGpD,+CAAgE;AAChE,qDAAoE;AACpE,yCAAoE;AACpE,mCAAwC;AACxC,qDAA+D;AAG/D,MAAM,kCAAkC,GAAiC;IACrE,cAAc,EAAE,IAAI;IACpB,4BAA4B,EAAE,GAAG;IACjC,4BAA4B,EAAE,GAAG;IACjC,8BAA8B,EAAE,SAAS;IACzC,wBAAwB,EAAE,KAAK;IAC/B,cAAc,EAAE,IAAI;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAa,mCAAmC;IAM5C,YACqB,aAA6B,EAC9C,iBAAwD,EAAE;QADzC,kBAAa,GAAb,aAAa,CAAgB;QANlC,iBAAY,GAAG,QAAQ,CAAC;QAEvB,cAAS,GAAG,IAAI,qBAAa,EAAmB,CAAC;QACjD,sBAAiB,GAAG,IAAI,qBAAa,EAAwB,CAAC;QAM3E,IAAI,CAAC,cAAc,mCACZ,kCAAkC,GAClC,cAAc,CACpB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CACxB,gBAA0C,EAC1C,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,qCAAsB,CAAC,WAAW,CAAC,CAAC;QACpC,qBAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1E,qBAAM,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC/E,MAAM,SAAS,GAAG,wBAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SACpE;QACD,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnD,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;QAC3E,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;QACjE,IAAI,CAAC,CAAC,eAAe,IAAI,UAAU,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC5E;QACD,MAAM,kBAAkB,GAAG,kDAAmC,CAAC,eAAe,CAAC,CAAC;QAChF,MAAM,YAAY,GAAG,iDAAkC,CAAC,eAAe,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,0BAAW,CAAC,IAAI,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAC;QACtF,MAAM,kBAAkB,GAAG,MAAM,6CAA+B,CAAC,IAAI,CACjE,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,WAAW,EACX,IAAI,CAAC,cAAc,CAAC,cAAc,EAClC,WAAW,CAAC,SAAS,CAAC,UAAU,CACnC,CAAC;QAEF,sFAAsF;QAEtF,sEAAsE;QACtE,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAAC,IAAI,CACrC,cAAc,QAAQ,EAAE,EACxB;YACI,OAAO,EAAE,iDAAgC,CAAC,UAAU,CAAC;YACrD,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,MAAM,EAAE,YAAY;YACpB,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,0BAA0B,KAAK,SAAS;SAC7E,CACJ,CAAC;QAEF,qGAAqG;QACrG,8BAA8B;QAC9B,8DAA8D;QAE9D,IAAI,UAAkB,CAAC;QACvB,IAAI,KAAyB,CAAC;QAE9B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACzB,UAAU,GAAG,GAAG,CAAC;SACpB;aAAM;YACH,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC;YACpB,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;SACrB;QAED,gGAAgG;QAChG,oEAAoE;QACpE,IAAI,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B,KAAK,SAAS,EAAE;YACtE,MAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAE,UAAU,EAAE,KAAK,CAAC,CAAC;SAC3E;QAED,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,kCAAuB,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QACnF,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,eAAe,CAAC;QAC9D,IAAI,CAAC,eAAe,EAAE;YAClB,MAAM,IAAI,KAAK,CACX,yDAAyD,eAAe,GAAG,CAAC,CAAC;SACpF;QACD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;QACvD,qBAAqB,CAAC,QAAQ,GAAG,kCAAuB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAErG,OAAO,IAAI,CAAC,qBAAqB,iCAEtB,WAAW,KACd,GAAG,EAAE,SAAS,CAAC,QAAQ,EAAE,EACzB,EAAE,EAAE,UAAU,EACd,SAAS,kCACF,WAAW,CAAC,SAAS,KACxB,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE,QAGzD,MAAM,EACN,kBAAkB,CACrB,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAC9B,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,qCAAsB,CAAC,WAAW,CAAC,CAAC;QAEpC,MAAM,gBAAgB,GAAG,WAAW,CAAC;QACrC,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,eAAe,GAAG,gBAAgB,CAAC,SAAS,CAAC,eAAe,CAAC;QACnE,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,EAAE;YACjC,MAAM,IAAI,KAAK,CACX,oDAAoD,UAAU,qBAAqB,eAAe,GAAG,CAAC,CAAC;SAC9G;QAED,MAAM,SAAS,GAAG,wBAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CACX,0DAA0D,UAAU,cAAc,QAAQ,GAAG,CAAC,CAAC;SACtG;QAED,MAAM,OAAO,GAAG,6BAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,EAAE,GAAG,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,EAAC,CAAC,CAAC;QAE7F,OAAO,IAAI,iCAAe,CACtB,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,UAAU,EACV,OAAO,EACP,IAAI,CAAC,aAAa,EAClB,QAAQ,EACR,UAAU,EACV,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC;CACJ;AAxJD,kFAwJC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    ensureFluidResolvedUrl,\n    getDocAttributesFromProtocolSummary,\n    getQuorumValuesFromProtocolSummary,\n    RateLimiter,\n} from \"@fluidframework/driver-utils\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { DocumentService } from \"./documentService\";\nimport { IRouterliciousDriverPolicies } from \"./policies\";\nimport { ITokenProvider } from \"./tokens\";\nimport { RouterliciousOrdererRestWrapper } from \"./restWrapper\";\nimport { convertSummaryToCreateNewSummary } from \"./createNewUtils\";\nimport { parseFluidUrl, replaceDocumentIdInPath } from \"./urlUtils\";\nimport { InMemoryCache } from \"./cache\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\n\nconst defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {\n    enablePrefetch: true,\n    maxConcurrentStorageRequests: 100,\n    maxConcurrentOrdererRequests: 100,\n    aggregateBlobsSmallerThanBytes: undefined,\n    enableWholeSummaryUpload: false,\n    enableRestLess: true,\n};\n\n/**\n * Factory for creating the routerlicious document service. Use this if you want to\n * use the routerlicious implementation.\n */\nexport class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {\n    public readonly protocolName = \"fluid:\";\n    private readonly driverPolicies: IRouterliciousDriverPolicies;\n    private readonly blobCache = new InMemoryCache<ArrayBufferLike>();\n    private readonly snapshotTreeCache = new InMemoryCache<ISnapshotTreeVersion>();\n\n    constructor(\n        private readonly tokenProvider: ITokenProvider,\n        driverPolicies: Partial<IRouterliciousDriverPolicies> = {},\n    ) {\n        this.driverPolicies = {\n            ...defaultRouterliciousDriverPolicies,\n            ...driverPolicies,\n        };\n    }\n\n    public async createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n        assert(!!createNewSummary, 0x204 /* \"create empty file not supported\" */);\n        assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* \"Missing orderer URL!\" */);\n        const parsedUrl = parseFluidUrl(resolvedUrl.url);\n        if (!parsedUrl.pathname) {\n            throw new Error(\"Parsed url should contain tenant and doc Id!!\");\n        }\n        const [, tenantId] = parsedUrl.pathname.split(\"/\");\n\n        const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n        const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n        if (!(protocolSummary && appSummary)) {\n            throw new Error(\"Protocol and App Summary required in the full summary\");\n        }\n        const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n        const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\");\n        const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);\n        const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(\n            tenantId,\n            undefined,\n            this.tokenProvider,\n            logger2,\n            rateLimiter,\n            this.driverPolicies.enableRestLess,\n            resolvedUrl.endpoints.ordererUrl,\n        );\n\n        // the backend responds with the actual document ID associated with the new container.\n\n        // @TODO: Remove returned \"string\" type when removing back-compat code\n        const res = await ordererRestWrapper.post<{ id: string, token?: string } | string>(\n            `/documents/${tenantId}`,\n            {\n                summary: convertSummaryToCreateNewSummary(appSummary),\n                sequenceNumber: documentAttributes.sequenceNumber,\n                values: quorumValues,\n                generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,\n            },\n        );\n\n        // For supporting backward compatibility, when the request has generateToken === true, it will return\n        // an object instead of string\n        // @TODO: Remove the logic when no need to support back-compat\n\n        let documentId: string;\n        let token: string | undefined;\n\n        if (typeof res === \"string\") {\n            documentId = res;\n        } else {\n            documentId = res.id;\n            token = res.token;\n        }\n\n        // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined\n        // is sufficient to determine if the token will be undefined or not.\n        if (token && this.tokenProvider.documentPostCreateCallback !== undefined) {\n            await this.tokenProvider.documentPostCreateCallback (documentId, token);\n        }\n\n        parsedUrl.set(\"pathname\", replaceDocumentIdInPath(parsedUrl.pathname, documentId));\n        const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;\n        if (!deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n        const parsedDeltaStorageUrl = new URL(deltaStorageUrl);\n        parsedDeltaStorageUrl.pathname = replaceDocumentIdInPath(parsedDeltaStorageUrl.pathname, documentId);\n\n        return this.createDocumentService(\n            {\n                ...resolvedUrl,\n                url: parsedUrl.toString(),\n                id: documentId,\n                endpoints: {\n                    ...resolvedUrl.endpoints,\n                    deltaStorageUrl: parsedDeltaStorageUrl.toString(),\n                },\n            },\n            logger,\n            clientIsSummarizer,\n        );\n    }\n\n    /**\n     * Creates the document service after extracting different endpoints URLs from a resolved URL.\n     *\n     * @param resolvedUrl - URL containing different endpoint URLs.\n     * @returns Routerlicious document service.\n     */\n    public async createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n\n        const fluidResolvedUrl = resolvedUrl;\n        const storageUrl = fluidResolvedUrl.endpoints.storageUrl;\n        const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;\n        const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;\n        if (!ordererUrl || !deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n\n        const parsedUrl = parseFluidUrl(fluidResolvedUrl.url);\n        const [, tenantId, documentId] = parsedUrl.pathname.split(\"/\");\n        if (!documentId || !tenantId) {\n            throw new Error(\n                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);\n        }\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\", { all: { driverVersion }});\n\n        return new DocumentService(\n            fluidResolvedUrl,\n            ordererUrl,\n            deltaStorageUrl,\n            storageUrl,\n            logger2,\n            this.tokenProvider,\n            tenantId,\n            documentId,\n            this.driverPolicies,\n            this.blobCache,\n            this.snapshotTreeCache);\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/routerlicious-driver";
-export declare const pkgVersion = "0.58.2002";
+export declare const pkgVersion = "0.59.1000";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/routerlicious-driver";
-exports.pkgVersion = "0.58.2002";
+exports.pkgVersion = "0.59.1000";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/routerlicious-driver\";\nexport const pkgVersion = \"0.58.2002\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/routerlicious-driver\";\nexport const pkgVersion = \"0.59.1000\";\n"]}

package/dist/tokens.d.ts

@@ -36,5 +36,18 @@ export interface ITokenProvider {
      * whether token came from cache.
      */
     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.
+     *
+     * Note:
+     * * Using the callback may have performance impact on the document creation process.
+     * * Any exceptions thrown in the callback would fail the creation workflow.
+     * @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>;
 }
 //# sourceMappingURL=tokens.d.ts.map

package/dist/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAE3B,GAAG,EAAE,MAAM,CAAC;IAGZ,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErG;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CACvG"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAE3B,GAAG,EAAE,MAAM,CAAC;IAGZ,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErG;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEpG;;;;;;;;;;;OAWG;IACH,0BAA0B,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzF"}

package/dist/tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * The ITokenService abstracts the discovery of claims contained within a token\n */\nexport interface ITokenService {\n    extractClaims(token: string): ITokenClaims;\n}\n\nexport interface ITokenResponse {\n    // JWT value\n    jwt: string;\n\n    // Flag indicating whether token was obtained from local cache\n    fromCache?: boolean;\n}\n\n/**\n * The ITokenProvider abstracts the token fetching mechanism for a host. Host will be responsible for\n * implementing the interfaces.\n */\nexport interface ITokenProvider {\n    /**\n     * Fetches the orderer token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Optional. Document ID is only required for document-scoped requests.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;\n\n    /**\n     * Fetches the storage token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Document ID.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;\n}\n"]}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * The ITokenService abstracts the discovery of claims contained within a token\n */\nexport interface ITokenService {\n    extractClaims(token: string): ITokenClaims;\n}\n\nexport interface ITokenResponse {\n    // JWT value\n    jwt: string;\n\n    // Flag indicating whether token was obtained from local cache\n    fromCache?: boolean;\n}\n\n/**\n * The ITokenProvider abstracts the token fetching mechanism for a host. Host will be responsible for\n * implementing the interfaces.\n */\nexport interface ITokenProvider {\n    /**\n     * Fetches the orderer token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Optional. Document ID is only required for document-scoped requests.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;\n\n    /**\n     * Fetches the storage token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Document ID.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;\n\n    /**\n     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to\n     * verify against an authorization service, if the user who claims to create the document is the same user who\n     * created it.\n     *\n     * Note:\n     * * Using the callback may have performance impact on the document creation process.\n     * * Any exceptions thrown in the callback would fail the creation workflow.\n     * @param documentId - Document ID.\n     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload\n     * and document id. It can be used to validate the identity of the document creator.\n     */\n    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;\n}\n"]}

package/lib/documentServiceFactory.d.ts

@@ -18,13 +18,13 @@ export declare class RouterliciousDocumentServiceFactory implements IDocumentSer
     private readonly blobCache;
     private readonly snapshotTreeCache;
     constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
-    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
     /**
      * Creates the document service after extracting different endpoints URLs from a resolved URL.
      *
      * @param resolvedUrl - URL containing different endpoint URLs.
      * @returns Routerlicious document service.
      */
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
 }
 //# sourceMappingURL=documentServiceFactory.d.ts.map

package/lib/documentServiceFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documentServiceFactory.d.ts","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AASpE,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAiB1C;;;GAGG;AACH,qBAAa,mCAAoC,YAAW,uBAAuB;IAO3E,OAAO,CAAC,QAAQ,CAAC,aAAa;IANlC,SAAgB,YAAY,YAAY;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwC;IAClE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6C;gBAG1D,aAAa,EAAE,cAAc,EAC9C,cAAc,GAAE,OAAO,CAAC,4BAA4B,CAAM;IAQjD,eAAe,CACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,gBAAgB,CAAC;IA4D5B;;;;;OAKG;IACU,qBAAqB,CAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,gBAAgB,CAAC;CAkC/B"}
+{"version":3,"file":"documentServiceFactory.d.ts","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AASpE,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAiB1C;;;GAGG;AACH,qBAAa,mCAAoC,YAAW,uBAAuB;IAO3E,OAAO,CAAC,QAAQ,CAAC,aAAa;IANlC,SAAgB,YAAY,YAAY;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwC;IAClE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6C;gBAG1D,aAAa,EAAE,cAAc,EAC9C,cAAc,GAAE,OAAO,CAAC,4BAA4B,CAAM;IAQjD,eAAe,CACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAuF5B;;;;;OAKG;IACU,qBAAqB,CAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;CAkC/B"}

package/lib/documentServiceFactory.js

@@ -31,7 +31,7 @@ export class RouterliciousDocumentServiceFactory {
         this.snapshotTreeCache = new InMemoryCache();
         this.driverPolicies = Object.assign(Object.assign({}, defaultRouterliciousDriverPolicies), driverPolicies);
     }
-    async createContainer(createNewSummary, resolvedUrl, logger) {
+    async createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer) {
         ensureFluidResolvedUrl(resolvedUrl);
         assert(!!createNewSummary, 0x204 /* "create empty file not supported" */);
         assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* "Missing orderer URL!" */);
@@ -51,11 +51,30 @@ export class RouterliciousDocumentServiceFactory {
         const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);
         const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(tenantId, undefined, this.tokenProvider, logger2, rateLimiter, this.driverPolicies.enableRestLess, resolvedUrl.endpoints.ordererUrl);
         // the backend responds with the actual document ID associated with the new container.
-        const documentId = await ordererRestWrapper.post(`/documents/${tenantId}`, {
+        // @TODO: Remove returned "string" type when removing back-compat code
+        const res = await ordererRestWrapper.post(`/documents/${tenantId}`, {
             summary: convertSummaryToCreateNewSummary(appSummary),
             sequenceNumber: documentAttributes.sequenceNumber,
             values: quorumValues,
+            generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,
         });
+        // For supporting backward compatibility, when the request has generateToken === true, it will return
+        // an object instead of string
+        // @TODO: Remove the logic when no need to support back-compat
+        let documentId;
+        let token;
+        if (typeof res === "string") {
+            documentId = res;
+        }
+        else {
+            documentId = res.id;
+            token = res.token;
+        }
+        // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined
+        // is sufficient to determine if the token will be undefined or not.
+        if (token && this.tokenProvider.documentPostCreateCallback !== undefined) {
+            await this.tokenProvider.documentPostCreateCallback(documentId, token);
+        }
         parsedUrl.set("pathname", replaceDocumentIdInPath(parsedUrl.pathname, documentId));
         const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;
         if (!deltaStorageUrl) {
@@ -63,7 +82,7 @@ export class RouterliciousDocumentServiceFactory {
         }
         const parsedDeltaStorageUrl = new URL(deltaStorageUrl);
         parsedDeltaStorageUrl.pathname = replaceDocumentIdInPath(parsedDeltaStorageUrl.pathname, documentId);
-        return this.createDocumentService(Object.assign(Object.assign({}, resolvedUrl), { url: parsedUrl.toString(), id: documentId, endpoints: Object.assign(Object.assign({}, resolvedUrl.endpoints), { deltaStorageUrl: parsedDeltaStorageUrl.toString() }) }), logger);
+        return this.createDocumentService(Object.assign(Object.assign({}, resolvedUrl), { url: parsedUrl.toString(), id: documentId, endpoints: Object.assign(Object.assign({}, resolvedUrl.endpoints), { deltaStorageUrl: parsedDeltaStorageUrl.toString() }) }), logger, clientIsSummarizer);
     }
     /**
      * Creates the document service after extracting different endpoints URLs from a resolved URL.
@@ -71,7 +90,7 @@ export class RouterliciousDocumentServiceFactory {
      * @param resolvedUrl - URL containing different endpoint URLs.
      * @returns Routerlicious document service.
      */
-    async createDocumentService(resolvedUrl, logger) {
+    async createDocumentService(resolvedUrl, logger, clientIsSummarizer) {
         ensureFluidResolvedUrl(resolvedUrl);
         const fluidResolvedUrl = resolvedUrl;
         const storageUrl = fluidResolvedUrl.endpoints.storageUrl;

package/lib/documentServiceFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentServiceFactory.js","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAQtD,OAAO,EACH,sBAAsB,EACtB,mCAAmC,EACnC,kCAAkC,EAClC,WAAW,GACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,gCAAgC,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG/D,MAAM,kCAAkC,GAAiC;IACrE,cAAc,EAAE,IAAI;IACpB,4BAA4B,EAAE,GAAG;IACjC,4BAA4B,EAAE,GAAG;IACjC,8BAA8B,EAAE,SAAS;IACzC,wBAAwB,EAAE,KAAK;IAC/B,cAAc,EAAE,IAAI;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,mCAAmC;IAM5C,YACqB,aAA6B,EAC9C,iBAAwD,EAAE;QADzC,kBAAa,GAAb,aAAa,CAAgB;QANlC,iBAAY,GAAG,QAAQ,CAAC;QAEvB,cAAS,GAAG,IAAI,aAAa,EAAmB,CAAC;QACjD,sBAAiB,GAAG,IAAI,aAAa,EAAwB,CAAC;QAM3E,IAAI,CAAC,cAAc,mCACZ,kCAAkC,GAClC,cAAc,CACpB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CACxB,gBAA0C,EAC1C,WAAyB,EACzB,MAA6B;QAE7B,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACpC,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1E,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC/E,MAAM,SAAS,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SACpE;QACD,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnD,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;QAC3E,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;QACjE,IAAI,CAAC,CAAC,eAAe,IAAI,UAAU,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC5E;QACD,MAAM,kBAAkB,GAAG,mCAAmC,CAAC,eAAe,CAAC,CAAC;QAChF,MAAM,YAAY,GAAG,kCAAkC,CAAC,eAAe,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAC;QACtF,MAAM,kBAAkB,GAAG,MAAM,+BAA+B,CAAC,IAAI,CACjE,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,WAAW,EACX,IAAI,CAAC,cAAc,CAAC,cAAc,EAClC,WAAW,CAAC,SAAS,CAAC,UAAU,CACnC,CAAC;QACF,sFAAsF;QACtF,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAC5C,cAAc,QAAQ,EAAE,EACxB;YACI,OAAO,EAAE,gCAAgC,CAAC,UAAU,CAAC;YACrD,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,MAAM,EAAE,YAAY;SACvB,CACJ,CAAC;QACF,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,uBAAuB,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QACnF,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,eAAe,CAAC;QAC9D,IAAI,CAAC,eAAe,EAAE;YAClB,MAAM,IAAI,KAAK,CACX,yDAAyD,eAAe,GAAG,CAAC,CAAC;SACpF;QACD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;QACvD,qBAAqB,CAAC,QAAQ,GAAG,uBAAuB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAErG,OAAO,IAAI,CAAC,qBAAqB,iCAEtB,WAAW,KACd,GAAG,EAAE,SAAS,CAAC,QAAQ,EAAE,EACzB,EAAE,EAAE,UAAU,EACd,SAAS,kCACF,WAAW,CAAC,SAAS,KACxB,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE,QAGzD,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAC9B,WAAyB,EACzB,MAA6B;QAE7B,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAEpC,MAAM,gBAAgB,GAAG,WAAW,CAAC;QACrC,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,eAAe,GAAG,gBAAgB,CAAC,SAAS,CAAC,eAAe,CAAC;QACnE,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,EAAE;YACjC,MAAM,IAAI,KAAK,CACX,oDAAoD,UAAU,qBAAqB,eAAe,GAAG,CAAC,CAAC;SAC9G;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CACX,0DAA0D,UAAU,cAAc,QAAQ,GAAG,CAAC,CAAC;SACtG;QAED,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,EAAE,GAAG,EAAE,EAAE,aAAa,EAAE,EAAC,CAAC,CAAC;QAE7F,OAAO,IAAI,eAAe,CACtB,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,UAAU,EACV,OAAO,EACP,IAAI,CAAC,aAAa,EAClB,QAAQ,EACR,UAAU,EACV,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    ensureFluidResolvedUrl,\n    getDocAttributesFromProtocolSummary,\n    getQuorumValuesFromProtocolSummary,\n    RateLimiter,\n} from \"@fluidframework/driver-utils\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { DocumentService } from \"./documentService\";\nimport { IRouterliciousDriverPolicies } from \"./policies\";\nimport { ITokenProvider } from \"./tokens\";\nimport { RouterliciousOrdererRestWrapper } from \"./restWrapper\";\nimport { convertSummaryToCreateNewSummary } from \"./createNewUtils\";\nimport { parseFluidUrl, replaceDocumentIdInPath } from \"./urlUtils\";\nimport { InMemoryCache } from \"./cache\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\n\nconst defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {\n    enablePrefetch: true,\n    maxConcurrentStorageRequests: 100,\n    maxConcurrentOrdererRequests: 100,\n    aggregateBlobsSmallerThanBytes: undefined,\n    enableWholeSummaryUpload: false,\n    enableRestLess: true,\n};\n\n/**\n * Factory for creating the routerlicious document service. Use this if you want to\n * use the routerlicious implementation.\n */\nexport class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {\n    public readonly protocolName = \"fluid:\";\n    private readonly driverPolicies: IRouterliciousDriverPolicies;\n    private readonly blobCache = new InMemoryCache<ArrayBufferLike>();\n    private readonly snapshotTreeCache = new InMemoryCache<ISnapshotTreeVersion>();\n\n    constructor(\n        private readonly tokenProvider: ITokenProvider,\n        driverPolicies: Partial<IRouterliciousDriverPolicies> = {},\n    ) {\n        this.driverPolicies = {\n            ...defaultRouterliciousDriverPolicies,\n            ...driverPolicies,\n        };\n    }\n\n    public async createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n        assert(!!createNewSummary, 0x204 /* \"create empty file not supported\" */);\n        assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* \"Missing orderer URL!\" */);\n        const parsedUrl = parseFluidUrl(resolvedUrl.url);\n        if (!parsedUrl.pathname) {\n            throw new Error(\"Parsed url should contain tenant and doc Id!!\");\n        }\n        const [, tenantId] = parsedUrl.pathname.split(\"/\");\n\n        const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n        const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n        if (!(protocolSummary && appSummary)) {\n            throw new Error(\"Protocol and App Summary required in the full summary\");\n        }\n        const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n        const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\");\n        const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);\n        const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(\n            tenantId,\n            undefined,\n            this.tokenProvider,\n            logger2,\n            rateLimiter,\n            this.driverPolicies.enableRestLess,\n            resolvedUrl.endpoints.ordererUrl,\n        );\n        // the backend responds with the actual document ID associated with the new container.\n        const documentId = await ordererRestWrapper.post<string>(\n            `/documents/${tenantId}`,\n            {\n                summary: convertSummaryToCreateNewSummary(appSummary),\n                sequenceNumber: documentAttributes.sequenceNumber,\n                values: quorumValues,\n            },\n        );\n        parsedUrl.set(\"pathname\", replaceDocumentIdInPath(parsedUrl.pathname, documentId));\n        const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;\n        if (!deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n        const parsedDeltaStorageUrl = new URL(deltaStorageUrl);\n        parsedDeltaStorageUrl.pathname = replaceDocumentIdInPath(parsedDeltaStorageUrl.pathname, documentId);\n\n        return this.createDocumentService(\n            {\n                ...resolvedUrl,\n                url: parsedUrl.toString(),\n                id: documentId,\n                endpoints: {\n                    ...resolvedUrl.endpoints,\n                    deltaStorageUrl: parsedDeltaStorageUrl.toString(),\n                },\n            },\n            logger);\n    }\n\n    /**\n     * Creates the document service after extracting different endpoints URLs from a resolved URL.\n     *\n     * @param resolvedUrl - URL containing different endpoint URLs.\n     * @returns Routerlicious document service.\n     */\n    public async createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n\n        const fluidResolvedUrl = resolvedUrl;\n        const storageUrl = fluidResolvedUrl.endpoints.storageUrl;\n        const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;\n        const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;\n        if (!ordererUrl || !deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n\n        const parsedUrl = parseFluidUrl(fluidResolvedUrl.url);\n        const [, tenantId, documentId] = parsedUrl.pathname.split(\"/\");\n        if (!documentId || !tenantId) {\n            throw new Error(\n                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);\n        }\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\", { all: { driverVersion }});\n\n        return new DocumentService(\n            fluidResolvedUrl,\n            ordererUrl,\n            deltaStorageUrl,\n            storageUrl,\n            logger2,\n            this.tokenProvider,\n            tenantId,\n            documentId,\n            this.driverPolicies,\n            this.blobCache,\n            this.snapshotTreeCache);\n    }\n}\n"]}
+{"version":3,"file":"documentServiceFactory.js","sourceRoot":"","sources":["../src/documentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAQtD,OAAO,EACH,sBAAsB,EACtB,mCAAmC,EACnC,kCAAkC,EAClC,WAAW,GACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,gCAAgC,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG/D,MAAM,kCAAkC,GAAiC;IACrE,cAAc,EAAE,IAAI;IACpB,4BAA4B,EAAE,GAAG;IACjC,4BAA4B,EAAE,GAAG;IACjC,8BAA8B,EAAE,SAAS;IACzC,wBAAwB,EAAE,KAAK;IAC/B,cAAc,EAAE,IAAI;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,mCAAmC;IAM5C,YACqB,aAA6B,EAC9C,iBAAwD,EAAE;QADzC,kBAAa,GAAb,aAAa,CAAgB;QANlC,iBAAY,GAAG,QAAQ,CAAC;QAEvB,cAAS,GAAG,IAAI,aAAa,EAAmB,CAAC;QACjD,sBAAiB,GAAG,IAAI,aAAa,EAAwB,CAAC;QAM3E,IAAI,CAAC,cAAc,mCACZ,kCAAkC,GAClC,cAAc,CACpB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,eAAe,CACxB,gBAA0C,EAC1C,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACpC,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1E,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC/E,MAAM,SAAS,GAAG,aAAa,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SACpE;QACD,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnD,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;QAC3E,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;QACjE,IAAI,CAAC,CAAC,eAAe,IAAI,UAAU,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC5E;QACD,MAAM,kBAAkB,GAAG,mCAAmC,CAAC,eAAe,CAAC,CAAC;QAChF,MAAM,YAAY,GAAG,kCAAkC,CAAC,eAAe,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,4BAA4B,CAAC,CAAC;QACtF,MAAM,kBAAkB,GAAG,MAAM,+BAA+B,CAAC,IAAI,CACjE,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,WAAW,EACX,IAAI,CAAC,cAAc,CAAC,cAAc,EAClC,WAAW,CAAC,SAAS,CAAC,UAAU,CACnC,CAAC;QAEF,sFAAsF;QAEtF,sEAAsE;QACtE,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAAC,IAAI,CACrC,cAAc,QAAQ,EAAE,EACxB;YACI,OAAO,EAAE,gCAAgC,CAAC,UAAU,CAAC;YACrD,cAAc,EAAE,kBAAkB,CAAC,cAAc;YACjD,MAAM,EAAE,YAAY;YACpB,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,0BAA0B,KAAK,SAAS;SAC7E,CACJ,CAAC;QAEF,qGAAqG;QACrG,8BAA8B;QAC9B,8DAA8D;QAE9D,IAAI,UAAkB,CAAC;QACvB,IAAI,KAAyB,CAAC;QAE9B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACzB,UAAU,GAAG,GAAG,CAAC;SACpB;aAAM;YACH,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC;YACpB,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;SACrB;QAED,gGAAgG;QAChG,oEAAoE;QACpE,IAAI,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B,KAAK,SAAS,EAAE;YACtE,MAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAAE,UAAU,EAAE,KAAK,CAAC,CAAC;SAC3E;QAED,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,uBAAuB,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QACnF,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,eAAe,CAAC;QAC9D,IAAI,CAAC,eAAe,EAAE;YAClB,MAAM,IAAI,KAAK,CACX,yDAAyD,eAAe,GAAG,CAAC,CAAC;SACpF;QACD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;QACvD,qBAAqB,CAAC,QAAQ,GAAG,uBAAuB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAErG,OAAO,IAAI,CAAC,qBAAqB,iCAEtB,WAAW,KACd,GAAG,EAAE,SAAS,CAAC,QAAQ,EAAE,EACzB,EAAE,EAAE,UAAU,EACd,SAAS,kCACF,WAAW,CAAC,SAAS,KACxB,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE,QAGzD,MAAM,EACN,kBAAkB,CACrB,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAC9B,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAEpC,MAAM,gBAAgB,GAAG,WAAW,CAAC;QACrC,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC;QACzD,MAAM,eAAe,GAAG,gBAAgB,CAAC,SAAS,CAAC,eAAe,CAAC;QACnE,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,EAAE;YACjC,MAAM,IAAI,KAAK,CACX,oDAAoD,UAAU,qBAAqB,eAAe,GAAG,CAAC,CAAC;SAC9G;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE;YAC1B,MAAM,IAAI,KAAK,CACX,0DAA0D,UAAU,cAAc,QAAQ,GAAG,CAAC,CAAC;SACtG;QAED,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,EAAE,EAAE,GAAG,EAAE,EAAE,aAAa,EAAE,EAAC,CAAC,CAAC;QAE7F,OAAO,IAAI,eAAe,CACtB,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,UAAU,EACV,OAAO,EACP,IAAI,CAAC,aAAa,EAClB,QAAQ,EACR,UAAU,EACV,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    ensureFluidResolvedUrl,\n    getDocAttributesFromProtocolSummary,\n    getQuorumValuesFromProtocolSummary,\n    RateLimiter,\n} from \"@fluidframework/driver-utils\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { DocumentService } from \"./documentService\";\nimport { IRouterliciousDriverPolicies } from \"./policies\";\nimport { ITokenProvider } from \"./tokens\";\nimport { RouterliciousOrdererRestWrapper } from \"./restWrapper\";\nimport { convertSummaryToCreateNewSummary } from \"./createNewUtils\";\nimport { parseFluidUrl, replaceDocumentIdInPath } from \"./urlUtils\";\nimport { InMemoryCache } from \"./cache\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\n\nconst defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {\n    enablePrefetch: true,\n    maxConcurrentStorageRequests: 100,\n    maxConcurrentOrdererRequests: 100,\n    aggregateBlobsSmallerThanBytes: undefined,\n    enableWholeSummaryUpload: false,\n    enableRestLess: true,\n};\n\n/**\n * Factory for creating the routerlicious document service. Use this if you want to\n * use the routerlicious implementation.\n */\nexport class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {\n    public readonly protocolName = \"fluid:\";\n    private readonly driverPolicies: IRouterliciousDriverPolicies;\n    private readonly blobCache = new InMemoryCache<ArrayBufferLike>();\n    private readonly snapshotTreeCache = new InMemoryCache<ISnapshotTreeVersion>();\n\n    constructor(\n        private readonly tokenProvider: ITokenProvider,\n        driverPolicies: Partial<IRouterliciousDriverPolicies> = {},\n    ) {\n        this.driverPolicies = {\n            ...defaultRouterliciousDriverPolicies,\n            ...driverPolicies,\n        };\n    }\n\n    public async createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n        assert(!!createNewSummary, 0x204 /* \"create empty file not supported\" */);\n        assert(!!resolvedUrl.endpoints.ordererUrl, 0x0b2 /* \"Missing orderer URL!\" */);\n        const parsedUrl = parseFluidUrl(resolvedUrl.url);\n        if (!parsedUrl.pathname) {\n            throw new Error(\"Parsed url should contain tenant and doc Id!!\");\n        }\n        const [, tenantId] = parsedUrl.pathname.split(\"/\");\n\n        const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n        const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n        if (!(protocolSummary && appSummary)) {\n            throw new Error(\"Protocol and App Summary required in the full summary\");\n        }\n        const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n        const quorumValues = getQuorumValuesFromProtocolSummary(protocolSummary);\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\");\n        const rateLimiter = new RateLimiter(this.driverPolicies.maxConcurrentOrdererRequests);\n        const ordererRestWrapper = await RouterliciousOrdererRestWrapper.load(\n            tenantId,\n            undefined,\n            this.tokenProvider,\n            logger2,\n            rateLimiter,\n            this.driverPolicies.enableRestLess,\n            resolvedUrl.endpoints.ordererUrl,\n        );\n\n        // the backend responds with the actual document ID associated with the new container.\n\n        // @TODO: Remove returned \"string\" type when removing back-compat code\n        const res = await ordererRestWrapper.post<{ id: string, token?: string } | string>(\n            `/documents/${tenantId}`,\n            {\n                summary: convertSummaryToCreateNewSummary(appSummary),\n                sequenceNumber: documentAttributes.sequenceNumber,\n                values: quorumValues,\n                generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,\n            },\n        );\n\n        // For supporting backward compatibility, when the request has generateToken === true, it will return\n        // an object instead of string\n        // @TODO: Remove the logic when no need to support back-compat\n\n        let documentId: string;\n        let token: string | undefined;\n\n        if (typeof res === \"string\") {\n            documentId = res;\n        } else {\n            documentId = res.id;\n            token = res.token;\n        }\n\n        // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined\n        // is sufficient to determine if the token will be undefined or not.\n        if (token && this.tokenProvider.documentPostCreateCallback !== undefined) {\n            await this.tokenProvider.documentPostCreateCallback (documentId, token);\n        }\n\n        parsedUrl.set(\"pathname\", replaceDocumentIdInPath(parsedUrl.pathname, documentId));\n        const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;\n        if (!deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n        const parsedDeltaStorageUrl = new URL(deltaStorageUrl);\n        parsedDeltaStorageUrl.pathname = replaceDocumentIdInPath(parsedDeltaStorageUrl.pathname, documentId);\n\n        return this.createDocumentService(\n            {\n                ...resolvedUrl,\n                url: parsedUrl.toString(),\n                id: documentId,\n                endpoints: {\n                    ...resolvedUrl.endpoints,\n                    deltaStorageUrl: parsedDeltaStorageUrl.toString(),\n                },\n            },\n            logger,\n            clientIsSummarizer,\n        );\n    }\n\n    /**\n     * Creates the document service after extracting different endpoints URLs from a resolved URL.\n     *\n     * @param resolvedUrl - URL containing different endpoint URLs.\n     * @returns Routerlicious document service.\n     */\n    public async createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(resolvedUrl);\n\n        const fluidResolvedUrl = resolvedUrl;\n        const storageUrl = fluidResolvedUrl.endpoints.storageUrl;\n        const ordererUrl = fluidResolvedUrl.endpoints.ordererUrl;\n        const deltaStorageUrl = fluidResolvedUrl.endpoints.deltaStorageUrl;\n        if (!ordererUrl || !deltaStorageUrl) {\n            throw new Error(\n                `All endpoints urls must be provided. [ordererUrl:${ordererUrl}][deltaStorageUrl:${deltaStorageUrl}]`);\n        }\n\n        const parsedUrl = parseFluidUrl(fluidResolvedUrl.url);\n        const [, tenantId, documentId] = parsedUrl.pathname.split(\"/\");\n        if (!documentId || !tenantId) {\n            throw new Error(\n                `Couldn't parse documentId and/or tenantId. [documentId:${documentId}][tenantId:${tenantId}]`);\n        }\n\n        const logger2 = ChildLogger.create(logger, \"RouterliciousDriver\", { all: { driverVersion }});\n\n        return new DocumentService(\n            fluidResolvedUrl,\n            ordererUrl,\n            deltaStorageUrl,\n            storageUrl,\n            logger2,\n            this.tokenProvider,\n            tenantId,\n            documentId,\n            this.driverPolicies,\n            this.blobCache,\n            this.snapshotTreeCache);\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/routerlicious-driver";
-export declare const pkgVersion = "0.58.2002";
+export declare const pkgVersion = "0.59.1000";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "0.58.2002";
+export const pkgVersion = "0.59.1000";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/routerlicious-driver\";\nexport const pkgVersion = \"0.58.2002\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/routerlicious-driver\";\nexport const pkgVersion = \"0.59.1000\";\n"]}

package/lib/tokens.d.ts

@@ -36,5 +36,18 @@ export interface ITokenProvider {
      * whether token came from cache.
      */
     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.
+     *
+     * Note:
+     * * Using the callback may have performance impact on the document creation process.
+     * * Any exceptions thrown in the callback would fail the creation workflow.
+     * @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>;
 }
 //# sourceMappingURL=tokens.d.ts.map

package/lib/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAE3B,GAAG,EAAE,MAAM,CAAC;IAGZ,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErG;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CACvG"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAE3B,GAAG,EAAE,MAAM,CAAC;IAGZ,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAErG;;;;;;;OAOG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEpG;;;;;;;;;;;OAWG;IACH,0BAA0B,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzF"}

package/lib/tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * The ITokenService abstracts the discovery of claims contained within a token\n */\nexport interface ITokenService {\n    extractClaims(token: string): ITokenClaims;\n}\n\nexport interface ITokenResponse {\n    // JWT value\n    jwt: string;\n\n    // Flag indicating whether token was obtained from local cache\n    fromCache?: boolean;\n}\n\n/**\n * The ITokenProvider abstracts the token fetching mechanism for a host. Host will be responsible for\n * implementing the interfaces.\n */\nexport interface ITokenProvider {\n    /**\n     * Fetches the orderer token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Optional. Document ID is only required for document-scoped requests.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;\n\n    /**\n     * Fetches the storage token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Document ID.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;\n}\n"]}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITokenClaims } from \"@fluidframework/protocol-definitions\";\n\n/**\n * The ITokenService abstracts the discovery of claims contained within a token\n */\nexport interface ITokenService {\n    extractClaims(token: string): ITokenClaims;\n}\n\nexport interface ITokenResponse {\n    // JWT value\n    jwt: string;\n\n    // Flag indicating whether token was obtained from local cache\n    fromCache?: boolean;\n}\n\n/**\n * The ITokenProvider abstracts the token fetching mechanism for a host. Host will be responsible for\n * implementing the interfaces.\n */\nexport interface ITokenProvider {\n    /**\n     * Fetches the orderer token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Optional. Document ID is only required for document-scoped requests.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;\n\n    /**\n     * Fetches the storage token from host.\n     * @param tenantId - Tenant ID.\n     * @param documentId - Document ID.\n     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.\n     * @returns TokenResponse object representing token value along with flag indicating\n     * whether token came from cache.\n     */\n    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;\n\n    /**\n     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to\n     * verify against an authorization service, if the user who claims to create the document is the same user who\n     * created it.\n     *\n     * Note:\n     * * Using the callback may have performance impact on the document creation process.\n     * * Any exceptions thrown in the callback would fail the creation workflow.\n     * @param documentId - Document ID.\n     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload\n     * and document id. It can be used to validate the identity of the document creator.\n     */\n    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "0.58.2002",
+  "version": "0.59.1000",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -32,7 +32,7 @@
     "lint:fix": "npm run eslint:fix",
     "test": "npm run test:mocha",
     "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
+    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
@@ -61,14 +61,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/driver-base": "^0.58.2002",
-    "@fluidframework/driver-definitions": "^0.45.1000",
-    "@fluidframework/driver-utils": "^0.58.2002",
-    "@fluidframework/gitresources": "^0.1035.1000",
-    "@fluidframework/protocol-base": "^0.1035.1000",
-    "@fluidframework/protocol-definitions": "^0.1027.1000",
-    "@fluidframework/server-services-client": "^0.1035.1000",
-    "@fluidframework/telemetry-utils": "^0.58.2002",
+    "@fluidframework/driver-base": "^0.59.1000",
+    "@fluidframework/driver-definitions": "^0.46.1000",
+    "@fluidframework/driver-utils": "^0.59.1000",
+    "@fluidframework/gitresources": "^0.1036.1000",
+    "@fluidframework/protocol-base": "^0.1036.1000",
+    "@fluidframework/protocol-definitions": "^0.1028.1000",
+    "@fluidframework/server-services-client": "^0.1036.1000",
+    "@fluidframework/telemetry-utils": "^0.59.1000",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
     "socket.io-client": "^4.4.1",
@@ -77,8 +77,9 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.27.0",
-    "@fluidframework/mocha-test-setup": "^0.58.2002",
+    "@fluidframework/eslint-config-fluid": "^0.28.1000",
+    "@fluidframework/mocha-test-setup": "^0.59.1000",
+    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@^0.58.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
@@ -104,5 +105,9 @@
     "rimraf": "^2.6.2",
     "typescript": "~4.1.3",
     "typescript-formatter": "7.1.0"
+  },
+  "typeValidation": {
+    "version": "0.59.1000",
+    "broken": {}
   }
 }

package/src/documentServiceFactory.ts

@@ -61,6 +61,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
         createNewSummary: ISummaryTree | undefined,
         resolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService> {
         ensureFluidResolvedUrl(resolvedUrl);
         assert(!!createNewSummary, 0x204 /* "create empty file not supported" */);
@@ -90,15 +91,40 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
             this.driverPolicies.enableRestLess,
             resolvedUrl.endpoints.ordererUrl,
         );
+
         // the backend responds with the actual document ID associated with the new container.
-        const documentId = await ordererRestWrapper.post<string>(
+
+        // @TODO: Remove returned "string" type when removing back-compat code
+        const res = await ordererRestWrapper.post<{ id: string, token?: string } | string>(
             `/documents/${tenantId}`,
             {
                 summary: convertSummaryToCreateNewSummary(appSummary),
                 sequenceNumber: documentAttributes.sequenceNumber,
                 values: quorumValues,
+                generateToken: this.tokenProvider.documentPostCreateCallback !== undefined,
             },
         );
+
+        // For supporting backward compatibility, when the request has generateToken === true, it will return
+        // an object instead of string
+        // @TODO: Remove the logic when no need to support back-compat
+
+        let documentId: string;
+        let token: string | undefined;
+
+        if (typeof res === "string") {
+            documentId = res;
+        } else {
+            documentId = res.id;
+            token = res.token;
+        }
+
+        // @TODO: Remove token from the condition, checking the documentPostCreateCallback !== undefined
+        // is sufficient to determine if the token will be undefined or not.
+        if (token && this.tokenProvider.documentPostCreateCallback !== undefined) {
+            await this.tokenProvider.documentPostCreateCallback (documentId, token);
+        }
+
         parsedUrl.set("pathname", replaceDocumentIdInPath(parsedUrl.pathname, documentId));
         const deltaStorageUrl = resolvedUrl.endpoints.deltaStorageUrl;
         if (!deltaStorageUrl) {
@@ -118,7 +144,9 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
                     deltaStorageUrl: parsedDeltaStorageUrl.toString(),
                 },
             },
-            logger);
+            logger,
+            clientIsSummarizer,
+        );
     }
 
     /**
@@ -130,6 +158,7 @@ export class RouterliciousDocumentServiceFactory implements IDocumentServiceFact
     public async createDocumentService(
         resolvedUrl: IResolvedUrl,
         logger?: ITelemetryBaseLogger,
+        clientIsSummarizer?: boolean,
     ): Promise<IDocumentService> {
         ensureFluidResolvedUrl(resolvedUrl);
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "0.58.2002";
+export const pkgVersion = "0.59.1000";

package/src/tokens.ts

@@ -44,4 +44,18 @@ export interface ITokenProvider {
      * whether token came from cache.
      */
     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.
+     *
+     * Note:
+     * * Using the callback may have performance impact on the document creation process.
+     * * Any exceptions thrown in the callback would fail the creation workflow.
+     * @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>;
 }