@fluidframework/tinylicious-driver 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

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

@@ -0,0 +1,22 @@
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: createTinyliciousCreateNewRequest */
+
+/* Excluded from this release type: defaultTinyliciousEndpoint */
+
+/* Excluded from this release type: defaultTinyliciousPort */
+
+/* Excluded from this release type: InsecureTinyliciousTokenProvider */
+
+/* Excluded from this release type: InsecureTinyliciousUrlResolver */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IUrlResolver */
+
+export { }

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

@@ -0,0 +1,71 @@
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/protocol-definitions';
+
+/**
+ * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.
+ * @internal
+ */
+export declare const createTinyliciousCreateNewRequest: (documentId?: string) => IRequest;
+
+/**
+ * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.
+ * @internal
+ */
+export declare const defaultTinyliciousEndpoint = "http://localhost";
+
+/**
+ * Default endpoint port. Will be used by the service if the consumer does not specify a port.
+ * @internal
+ */
+export declare const defaultTinyliciousPort = 7070;
+
+/**
+ * As the name implies this is not secure and should not be used in production. It simply makes the example easier
+ * to get up and running.
+ * @internal
+ */
+export declare class InsecureTinyliciousTokenProvider implements ITokenProvider {
+    /**
+     * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
+     * will use the default scopes which are document read, write and summarizer write.
+     *
+     * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
+     *
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     */
+    private readonly scopes?;
+    constructor(
+    /**
+     * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
+     * will use the default scopes which are document read, write and summarizer write.
+     *
+     * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
+     *
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     */
+    scopes?: ScopeType[] | undefined);
+    fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
+    fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
+    private getSignedToken;
+}
+
+/**
+ * InsecureTinyliciousUrlResolver knows how to get the URLs to the service (in this case Tinylicious) to use
+ * for a given request.  This particular implementation has a goal to avoid imposing requirements on the app's
+ * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):
+ * documentId/containerRelativePathing
+ * @internal
+ */
+export declare class InsecureTinyliciousUrlResolver implements IUrlResolver {
+    private readonly fluidProtocolEndpoint;
+    private readonly tinyliciousEndpoint;
+    constructor(port?: number, endpoint?: string);
+    resolve(request: IRequest): Promise<IResolvedUrl>;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
+}
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

package/lib/index.d.mts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { InsecureTinyliciousTokenProvider } from "./insecureTinyliciousTokenProvider.mjs";
+export { createTinyliciousCreateNewRequest, defaultTinyliciousEndpoint, defaultTinyliciousPort, InsecureTinyliciousUrlResolver, } from "./insecureTinyliciousUrlResolver.mjs";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,gCAAgC,EAAE;OACpC,EACN,iCAAiC,EACjC,0BAA0B,EAC1B,sBAAsB,EACtB,8BAA8B,GAC9B"}

package/lib/index.mjs

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { InsecureTinyliciousTokenProvider } from "./insecureTinyliciousTokenProvider.mjs";
+export { createTinyliciousCreateNewRequest, defaultTinyliciousEndpoint, defaultTinyliciousPort, InsecureTinyliciousUrlResolver, } from "./insecureTinyliciousUrlResolver.mjs";
+//# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,gCAAgC,EAAE;OACpC,EACN,iCAAiC,EACjC,0BAA0B,EAC1B,sBAAsB,EACtB,8BAA8B,GAC9B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { InsecureTinyliciousTokenProvider } from \"./insecureTinyliciousTokenProvider\";\nexport {\n\tcreateTinyliciousCreateNewRequest,\n\tdefaultTinyliciousEndpoint,\n\tdefaultTinyliciousPort,\n\tInsecureTinyliciousUrlResolver,\n} from \"./insecureTinyliciousUrlResolver\";\n"]}

package/lib/{insecureTinyliciousTokenProvider.d.ts → insecureTinyliciousTokenProvider.d.mts}

@@ -7,6 +7,7 @@ import { ITokenProvider, ITokenResponse } from "@fluidframework/routerlicious-dr
 /**
  * As the name implies this is not secure and should not be used in production. It simply makes the example easier
  * to get up and running.
+ * @internal
  */
 export declare class InsecureTinyliciousTokenProvider implements ITokenProvider {
     /**
@@ -15,7 +16,7 @@ export declare class InsecureTinyliciousTokenProvider implements ITokenProvider
      *
      * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
      *
-     * @defaultValue - [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
      */
     private readonly scopes?;
     constructor(
@@ -25,7 +26,7 @@ export declare class InsecureTinyliciousTokenProvider implements ITokenProvider
      *
      * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
      *
-     * @defaultValue - [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
      */
     scopes?: ScopeType[] | undefined);
     fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;

package/lib/insecureTinyliciousTokenProvider.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insecureTinyliciousTokenProvider.d.ts","sourceRoot":"","sources":["../src/insecureTinyliciousTokenProvider.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,SAAS,EAAgB,MAAM,sCAAsC;OACvE,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sCAAsC;AAIrF;;;;GAIG;AACH,qBAAa,gCAAiC,YAAW,cAAc;IAErE;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;;IARxB;;;;;;;OAOG;IACc,MAAM,CAAC,yBAAa;IAGzB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAOjF,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAO7F,OAAO,CAAC,cAAc;CAkCtB"}

package/lib/{insecureTinyliciousTokenProvider.js → insecureTinyliciousTokenProvider.mjs}

@@ -3,12 +3,12 @@
  * Licensed under the MIT License.
  */
 import { ScopeType } from "@fluidframework/protocol-definitions";
-import { getRandomName } from "@fluidframework/server-services-client";
 import { KJUR as jsrsasign } from "jsrsasign";
 import { v4 as uuid } from "uuid";
 /**
  * As the name implies this is not secure and should not be used in production. It simply makes the example easier
  * to get up and running.
+ * @internal
  */
 export class InsecureTinyliciousTokenProvider {
     constructor(
@@ -18,7 +18,7 @@ export class InsecureTinyliciousTokenProvider {
      *
      * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
      *
-     * @defaultValue - [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
      */
     scopes) {
         this.scopes = scopes;
@@ -36,17 +36,15 @@ export class InsecureTinyliciousTokenProvider {
         };
     }
     getSignedToken(tenantId, documentId, lifetime = 60 * 60, ver = "1.0") {
-        var _a;
+        const userId = uuid();
+        const match = userId.match(/^([\da-f]{8})-([\da-f]{4})/);
+        const userName = match === null ? userId : match[0]; // Just use the first two segments of the (fake) userId as a fake name.
         // Current time in seconds
-        const now = Math.round(new Date().getTime() / 1000);
-        const user = { id: uuid(), name: getRandomName() };
+        const now = Math.round(Date.now() / 1000);
+        const user = { id: userId, name: userName };
         const claims = {
-            documentId: documentId !== null && documentId !== void 0 ? documentId : "",
-            scopes: (_a = this.scopes) !== null && _a !== void 0 ? _a : [
-                ScopeType.DocRead,
-                ScopeType.DocWrite,
-                ScopeType.SummaryWrite,
-            ],
+            documentId: documentId ?? "",
+            scopes: this.scopes ?? [ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite],
             tenantId,
             user,
             iat: now,
@@ -54,7 +52,10 @@ export class InsecureTinyliciousTokenProvider {
             ver,
         };
         const utf8Key = { utf8: "12345" };
-        return jsrsasign.jws.JWS.sign(null, JSON.stringify({ alg: "HS256", typ: "JWT" }), claims, utf8Key);
+        return jsrsasign.jws.JWS.sign(
+        // External API uses `null`
+        // eslint-disable-next-line unicorn/no-null
+        null, JSON.stringify({ alg: "HS256", typ: "JWT" }), claims, utf8Key);
     }
 }
-//# sourceMappingURL=insecureTinyliciousTokenProvider.js.map
+//# sourceMappingURL=insecureTinyliciousTokenProvider.mjs.map

package/lib/insecureTinyliciousTokenProvider.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"insecureTinyliciousTokenProvider.mjs","sourceRoot":"","sources":["../src/insecureTinyliciousTokenProvider.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,SAAS,EAAgB,MAAM,sCAAsC;OAEvE,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,WAAW;OACtC,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM;AAEjC;;;;GAIG;AACH,MAAM,OAAO,gCAAgC;IAC5C;IACC;;;;;;;OAOG;IACc,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;IACnC,CAAC;IAEG,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,UAAmB;QACnE,OAAO;YACN,SAAS,EAAE,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC;SAC9C,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,UAAkB;QAClE,OAAO;YACN,SAAS,EAAE,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC;SAC9C,CAAC;IACH,CAAC;IAEO,cAAc,CACrB,QAAgB,EAChB,UAA8B,EAC9B,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;QAEnB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,uEAAuE;QAE5H,0BAA0B;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAE5C,MAAM,MAAM,GAAiB;YAC5B,UAAU,EAAE,UAAU,IAAI,EAAE;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC;YACtF,QAAQ;YACR,IAAI;YACJ,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,GAAG,GAAG,QAAQ;YACnB,GAAG;SACH,CAAC;QAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI;QAC5B,2BAA2B;QAC3B,2CAA2C;QAC3C,IAAI,EACJ,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAC5C,MAAM,EACN,OAAO,CACP,CAAC;IACH,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ScopeType, ITokenClaims } from \"@fluidframework/protocol-definitions\";\nimport { ITokenProvider, ITokenResponse } from \"@fluidframework/routerlicious-driver\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * As the name implies this is not secure and should not be used in production. It simply makes the example easier\n * to get up and running.\n * @internal\n */\nexport class InsecureTinyliciousTokenProvider implements ITokenProvider {\n\tconstructor(\n\t\t/**\n\t\t * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider\n\t\t * will use the default scopes which are document read, write and summarizer write.\n\t\t *\n\t\t * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}\n\t\t *\n\t\t * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]\n\t\t */\n\t\tprivate readonly scopes?: ScopeType[],\n\t) {}\n\n\tpublic async fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse> {\n\t\treturn {\n\t\t\tfromCache: true,\n\t\t\tjwt: this.getSignedToken(tenantId, documentId),\n\t\t};\n\t}\n\n\tpublic async fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse> {\n\t\treturn {\n\t\t\tfromCache: true,\n\t\t\tjwt: this.getSignedToken(tenantId, documentId),\n\t\t};\n\t}\n\n\tprivate getSignedToken(\n\t\ttenantId: string,\n\t\tdocumentId: string | undefined,\n\t\tlifetime: number = 60 * 60,\n\t\tver: string = \"1.0\",\n\t): string {\n\t\tconst userId = uuid();\n\t\tconst match = userId.match(/^([\\da-f]{8})-([\\da-f]{4})/);\n\t\tconst userName = match === null ? userId : match[0]; // Just use the first two segments of the (fake) userId as a fake name.\n\n\t\t// Current time in seconds\n\t\tconst now = Math.round(Date.now() / 1000);\n\t\tconst user = { id: userId, name: userName };\n\n\t\tconst claims: ITokenClaims = {\n\t\t\tdocumentId: documentId ?? \"\",\n\t\t\tscopes: this.scopes ?? [ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite],\n\t\t\ttenantId,\n\t\t\tuser,\n\t\t\tiat: now,\n\t\t\texp: now + lifetime,\n\t\t\tver,\n\t\t};\n\n\t\tconst utf8Key = { utf8: \"12345\" };\n\t\treturn jsrsasign.jws.JWS.sign(\n\t\t\t// External API uses `null`\n\t\t\t// eslint-disable-next-line unicorn/no-null\n\t\t\tnull,\n\t\t\tJSON.stringify({ alg: \"HS256\", typ: \"JWT\" }),\n\t\t\tclaims,\n\t\t\tutf8Key,\n\t\t);\n\t}\n}\n"]}

package/lib/{insecureTinyliciousUrlResolver.d.ts → insecureTinyliciousUrlResolver.d.mts}

@@ -3,13 +3,15 @@
  * Licensed under the MIT License.
  */
 import { IRequest } from "@fluidframework/core-interfaces";
-import { IFluidResolvedUrl, IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
+import { IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
 /**
  * Default endpoint port. Will be used by the service if the consumer does not specify a port.
+ * @internal
  */
 export declare const defaultTinyliciousPort = 7070;
 /**
  * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.
+ * @internal
  */
 export declare const defaultTinyliciousEndpoint = "http://localhost";
 /**
@@ -17,13 +19,18 @@ export declare const defaultTinyliciousEndpoint = "http://localhost";
  * for a given request.  This particular implementation has a goal to avoid imposing requirements on the app's
  * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):
  * documentId/containerRelativePathing
+ * @internal
  */
 export declare class InsecureTinyliciousUrlResolver implements IUrlResolver {
     private readonly fluidProtocolEndpoint;
     private readonly tinyliciousEndpoint;
     constructor(port?: number, endpoint?: string);
     resolve(request: IRequest): Promise<IResolvedUrl>;
-    getAbsoluteUrl(resolvedUrl: IFluidResolvedUrl, relativeUrl: string): Promise<string>;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
 }
-export declare const createTinyliciousCreateNewRequest: (documentId?: string | undefined) => IRequest;
+/**
+ * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.
+ * @internal
+ */
+export declare const createTinyliciousCreateNewRequest: (documentId?: string) => IRequest;
 //# sourceMappingURL=insecureTinyliciousUrlResolver.d.ts.map

package/lib/insecureTinyliciousUrlResolver.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insecureTinyliciousUrlResolver.d.ts","sourceRoot":"","sources":["../src/insecureTinyliciousUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,QAAQ,EAAE,MAAM,iCAAiC;OACnD,EAAgB,YAAY,EAAE,YAAY,EAAE,MAAM,oCAAoC;AAE7F;;;GAGG;AACH,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,0BAA0B,qBAAqB,CAAC;AAE7D;;;;;;GAMG;AACH,qBAAa,8BAA+B,YAAW,YAAY;IAClE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;gBAC1B,IAAI,SAAyB,EAAE,QAAQ,SAA6B;IAK1E,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAuCjD,cAAc,CAAC,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAY5F;AAED;;;GAGG;AACH,eAAO,MAAM,iCAAiC,gBAAiB,MAAM,KAAG,QAKtE,CAAC"}

package/lib/{insecureTinyliciousUrlResolver.js → insecureTinyliciousUrlResolver.mjs}

@@ -2,13 +2,15 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { DriverHeader, } from "@fluidframework/driver-definitions";
+import { DriverHeader } from "@fluidframework/driver-definitions";
 /**
  * Default endpoint port. Will be used by the service if the consumer does not specify a port.
+ * @internal
  */
 export const defaultTinyliciousPort = 7070;
 /**
  * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.
+ * @internal
  */
 export const defaultTinyliciousEndpoint = "http://localhost";
 /**
@@ -16,6 +18,7 @@ export const defaultTinyliciousEndpoint = "http://localhost";
  * for a given request.  This particular implementation has a goal to avoid imposing requirements on the app's
  * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):
  * documentId/containerRelativePathing
+ * @internal
  */
 export class InsecureTinyliciousUrlResolver {
     constructor(port = defaultTinyliciousPort, endpoint = defaultTinyliciousEndpoint) {
@@ -23,49 +26,40 @@ export class InsecureTinyliciousUrlResolver {
         this.fluidProtocolEndpoint = this.tinyliciousEndpoint.replace(/(^\w+:|^)\/\//, "fluid://");
     }
     async resolve(request) {
-        var _a;
-        // determine whether the request is for creating of a new container.
-        // such request has the `createNew` header set to true and doesn't have a container ID.
+        const relativeUrl = request.url.replace(`${this.tinyliciousEndpoint}/`, "");
+        const documentIdFromRequest = relativeUrl.split("/")[0];
+        let deltaStorageUrl;
+        let documentUrl;
+        let finalDocumentId = documentIdFromRequest;
+        // Special handling if the request is to create a new container
         if (request.headers && request.headers[DriverHeader.createNew] === true) {
-            // honor the document ID passed by the application via the create request
-            // otherwise use the reserved keyword to let the driver generate the ID.
+            // Use the document ID passed by the application via the create request;
+            // if none was passed, use the reserved keyword to let the driver generate the ID.
             // TODO: deprecate this capability for tinylicious as the r11s driver will stop using the document ID
             // in create requests.
-            const newDocumentId = (_a = request.url) !== null && _a !== void 0 ? _a : "new";
-            return {
-                endpoints: {
-                    deltaStorageUrl: `${this.tinyliciousEndpoint}/deltas/tinylicious/${newDocumentId}`,
-                    ordererUrl: this.tinyliciousEndpoint,
-                    storageUrl: `${this.tinyliciousEndpoint}/repos/tinylicious`,
-                },
-                // id is a mandatory attribute, but it's ignored by the driver for new container requests.
-                id: request.url,
-                // tokens attribute is redundant as all tokens are generated via ITokenProvider
-                tokens: {},
-                type: "fluid",
-                url: `${this.fluidProtocolEndpoint}/tinylicious/${newDocumentId}`,
-            };
+            if (finalDocumentId === "") {
+                finalDocumentId = "new";
+            }
+            deltaStorageUrl = `${this.tinyliciousEndpoint}/deltas/tinylicious/${finalDocumentId}`;
+            documentUrl = `${this.fluidProtocolEndpoint}/tinylicious/${finalDocumentId}`;
         }
-        // for an existing container we'll parse the request URL to determine the document ID.
-        const url = request.url.replace(`${this.tinyliciousEndpoint}/`, "");
-        const documentId = url.split("/")[0];
-        const encodedDocId = encodeURIComponent(documentId);
-        const documentRelativePath = url.slice(documentId.length);
-        const documentUrl = `${this.fluidProtocolEndpoint}/tinylicious/${encodedDocId}${documentRelativePath}`;
-        const deltaStorageUrl = `${this.tinyliciousEndpoint}/deltas/tinylicious/${encodedDocId}`;
-        const storageUrl = `${this.tinyliciousEndpoint}/repos/tinylicious`;
-        const response = {
+        else {
+            const encodedDocId = encodeURIComponent(finalDocumentId);
+            const documentRelativePath = relativeUrl.slice(documentIdFromRequest.length);
+            documentUrl = `${this.fluidProtocolEndpoint}/tinylicious/${encodedDocId}${documentRelativePath}`;
+            deltaStorageUrl = `${this.tinyliciousEndpoint}/deltas/tinylicious/${encodedDocId}`;
+        }
+        return {
             endpoints: {
                 deltaStorageUrl,
                 ordererUrl: this.tinyliciousEndpoint,
-                storageUrl,
+                storageUrl: `${this.tinyliciousEndpoint}/repos/tinylicious`,
             },
-            id: documentId,
+            id: finalDocumentId,
             tokens: {},
             type: "fluid",
             url: documentUrl,
         };
-        return response;
     }
     async getAbsoluteUrl(resolvedUrl, relativeUrl) {
         const documentId = decodeURIComponent(resolvedUrl.url.replace(`${this.fluidProtocolEndpoint}/tinylicious/`, ""));
@@ -78,10 +72,14 @@ export class InsecureTinyliciousUrlResolver {
         return `${documentId}/${relativeUrl}`;
     }
 }
+/**
+ * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.
+ * @internal
+ */
 export const createTinyliciousCreateNewRequest = (documentId) => ({
-    url: documentId !== null && documentId !== void 0 ? documentId : "",
+    url: documentId ?? "",
     headers: {
         [DriverHeader.createNew]: true,
     },
 });
-//# sourceMappingURL=insecureTinyliciousUrlResolver.js.map
+//# sourceMappingURL=insecureTinyliciousUrlResolver.mjs.map

package/lib/insecureTinyliciousUrlResolver.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"insecureTinyliciousUrlResolver.mjs","sourceRoot":"","sources":["../src/insecureTinyliciousUrlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAGI,EAAE,YAAY,EAA8B,MAAM,oCAAoC;AAE7F;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,OAAO,8BAA8B;IAG1C,YAAmB,IAAI,GAAG,sBAAsB,EAAE,QAAQ,GAAG,0BAA0B;QACtF,IAAI,CAAC,mBAAmB,GAAG,GAAG,QAAQ,IAAI,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IAC5F,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,OAAiB;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,mBAAmB,GAAG,EAAE,EAAE,CAAC,CAAC;QAC5E,MAAM,qBAAqB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAExD,IAAI,eAAuB,CAAC;QAC5B,IAAI,WAAmB,CAAC;QACxB,IAAI,eAAe,GAAW,qBAAqB,CAAC;QAEpD,+DAA+D;QAC/D,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;YACxE,wEAAwE;YACxE,kFAAkF;YAClF,qGAAqG;YACrG,sBAAsB;YACtB,IAAI,eAAe,KAAK,EAAE,EAAE;gBAC3B,eAAe,GAAG,KAAK,CAAC;aACxB;YACD,eAAe,GAAG,GAAG,IAAI,CAAC,mBAAmB,uBAAuB,eAAe,EAAE,CAAC;YACtF,WAAW,GAAG,GAAG,IAAI,CAAC,qBAAqB,gBAAgB,eAAe,EAAE,CAAC;SAC7E;aAAM;YACN,MAAM,YAAY,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;YACzD,MAAM,oBAAoB,GAAG,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;YAC7E,WAAW,GAAG,GAAG,IAAI,CAAC,qBAAqB,gBAAgB,YAAY,GAAG,oBAAoB,EAAE,CAAC;YACjG,eAAe,GAAG,GAAG,IAAI,CAAC,mBAAmB,uBAAuB,YAAY,EAAE,CAAC;SACnF;QAED,OAAO;YACN,SAAS,EAAE;gBACV,eAAe;gBACf,UAAU,EAAE,IAAI,CAAC,mBAAmB;gBACpC,UAAU,EAAE,GAAG,IAAI,CAAC,mBAAmB,oBAAoB;aAC3D;YACD,EAAE,EAAE,eAAe;YACnB,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,OAAO;YACb,GAAG,EAAE,WAAW;SAChB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,WAAyB,EAAE,WAAmB;QACzE,MAAM,UAAU,GAAG,kBAAkB,CACpC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,qBAAqB,eAAe,EAAE,EAAE,CAAC,CACzE,CAAC;QACF;;;;;WAKG;QACH,OAAO,GAAG,UAAU,IAAI,WAAW,EAAE,CAAC;IACvC,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,UAAmB,EAAY,EAAE,CAAC,CAAC;IACpF,GAAG,EAAE,UAAU,IAAI,EAAE;IACrB,OAAO,EAAE;QACR,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,IAAI;KAC9B;CACD,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport { DriverHeader, IResolvedUrl, IUrlResolver } from \"@fluidframework/driver-definitions\";\n\n/**\n * Default endpoint port. Will be used by the service if the consumer does not specify a port.\n * @internal\n */\nexport const defaultTinyliciousPort = 7070;\n\n/**\n * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.\n * @internal\n */\nexport const defaultTinyliciousEndpoint = \"http://localhost\";\n\n/**\n * InsecureTinyliciousUrlResolver knows how to get the URLs to the service (in this case Tinylicious) to use\n * for a given request.  This particular implementation has a goal to avoid imposing requirements on the app's\n * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):\n * documentId/containerRelativePathing\n * @internal\n */\nexport class InsecureTinyliciousUrlResolver implements IUrlResolver {\n\tprivate readonly fluidProtocolEndpoint: string;\n\tprivate readonly tinyliciousEndpoint: string;\n\tpublic constructor(port = defaultTinyliciousPort, endpoint = defaultTinyliciousEndpoint) {\n\t\tthis.tinyliciousEndpoint = `${endpoint}:${port}`;\n\t\tthis.fluidProtocolEndpoint = this.tinyliciousEndpoint.replace(/(^\\w+:|^)\\/\\//, \"fluid://\");\n\t}\n\n\tpublic async resolve(request: IRequest): Promise<IResolvedUrl> {\n\t\tconst relativeUrl = request.url.replace(`${this.tinyliciousEndpoint}/`, \"\");\n\t\tconst documentIdFromRequest = relativeUrl.split(\"/\")[0];\n\n\t\tlet deltaStorageUrl: string;\n\t\tlet documentUrl: string;\n\t\tlet finalDocumentId: string = documentIdFromRequest;\n\n\t\t// Special handling if the request is to create a new container\n\t\tif (request.headers && request.headers[DriverHeader.createNew] === true) {\n\t\t\t// Use the document ID passed by the application via the create request;\n\t\t\t// if none was passed, use the reserved keyword to let the driver generate the ID.\n\t\t\t// TODO: deprecate this capability for tinylicious as the r11s driver will stop using the document ID\n\t\t\t// in create requests.\n\t\t\tif (finalDocumentId === \"\") {\n\t\t\t\tfinalDocumentId = \"new\";\n\t\t\t}\n\t\t\tdeltaStorageUrl = `${this.tinyliciousEndpoint}/deltas/tinylicious/${finalDocumentId}`;\n\t\t\tdocumentUrl = `${this.fluidProtocolEndpoint}/tinylicious/${finalDocumentId}`;\n\t\t} else {\n\t\t\tconst encodedDocId = encodeURIComponent(finalDocumentId);\n\t\t\tconst documentRelativePath = relativeUrl.slice(documentIdFromRequest.length);\n\t\t\tdocumentUrl = `${this.fluidProtocolEndpoint}/tinylicious/${encodedDocId}${documentRelativePath}`;\n\t\t\tdeltaStorageUrl = `${this.tinyliciousEndpoint}/deltas/tinylicious/${encodedDocId}`;\n\t\t}\n\n\t\treturn {\n\t\t\tendpoints: {\n\t\t\t\tdeltaStorageUrl,\n\t\t\t\tordererUrl: this.tinyliciousEndpoint,\n\t\t\t\tstorageUrl: `${this.tinyliciousEndpoint}/repos/tinylicious`,\n\t\t\t},\n\t\t\tid: finalDocumentId,\n\t\t\ttokens: {},\n\t\t\ttype: \"fluid\",\n\t\t\turl: documentUrl,\n\t\t};\n\t}\n\n\tpublic async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {\n\t\tconst documentId = decodeURIComponent(\n\t\t\tresolvedUrl.url.replace(`${this.fluidProtocolEndpoint}/tinylicious/`, \"\"),\n\t\t);\n\t\t/*\n\t\t * The detached container flow will ultimately call getAbsoluteUrl() with the resolved.url produced by\n\t\t * resolve().  The container expects getAbsoluteUrl's return value to be a URL that can then be roundtripped\n\t\t * back through resolve() again, and get the same result again.  So we'll return a \"URL\" with the same format\n\t\t * described above.\n\t\t */\n\t\treturn `${documentId}/${relativeUrl}`;\n\t}\n}\n\n/**\n * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.\n * @internal\n */\nexport const createTinyliciousCreateNewRequest = (documentId?: string): IRequest => ({\n\turl: documentId ?? \"\",\n\theaders: {\n\t\t[DriverHeader.createNew]: true,\n\t},\n});\n"]}

package/lib/tinylicious-driver-alpha.d.mts

@@ -0,0 +1,18 @@
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: createTinyliciousCreateNewRequest */
+
+/* Excluded from this release type: defaultTinyliciousEndpoint */
+
+/* Excluded from this release type: defaultTinyliciousPort */
+
+/* Excluded from this release type: InsecureTinyliciousTokenProvider */
+
+/* Excluded from this release type: InsecureTinyliciousUrlResolver */
+
+export { }

package/lib/tinylicious-driver-beta.d.mts

@@ -0,0 +1,22 @@
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: createTinyliciousCreateNewRequest */
+
+/* Excluded from this release type: defaultTinyliciousEndpoint */
+
+/* Excluded from this release type: defaultTinyliciousPort */
+
+/* Excluded from this release type: InsecureTinyliciousTokenProvider */
+
+/* Excluded from this release type: InsecureTinyliciousUrlResolver */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IUrlResolver */
+
+export { }

package/lib/tinylicious-driver-public.d.mts

@@ -0,0 +1,22 @@
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: createTinyliciousCreateNewRequest */
+
+/* Excluded from this release type: defaultTinyliciousEndpoint */
+
+/* Excluded from this release type: defaultTinyliciousPort */
+
+/* Excluded from this release type: InsecureTinyliciousTokenProvider */
+
+/* Excluded from this release type: InsecureTinyliciousUrlResolver */
+
+/* Excluded from this release type: IResolvedUrl */
+
+/* Excluded from this release type: IUrlResolver */
+
+export { }

package/lib/tinylicious-driver-untrimmed.d.mts

@@ -0,0 +1,71 @@
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/protocol-definitions';
+
+/**
+ * Creates a Routerlicious {@link @fluidframework/core-interfaces#IRequest}.
+ * @internal
+ */
+export declare const createTinyliciousCreateNewRequest: (documentId?: string) => IRequest;
+
+/**
+ * Default endpoint URL base. Will be used by the service if the consumer does not specify an endpoint.
+ * @internal
+ */
+export declare const defaultTinyliciousEndpoint = "http://localhost";
+
+/**
+ * Default endpoint port. Will be used by the service if the consumer does not specify a port.
+ * @internal
+ */
+export declare const defaultTinyliciousPort = 7070;
+
+/**
+ * As the name implies this is not secure and should not be used in production. It simply makes the example easier
+ * to get up and running.
+ * @internal
+ */
+export declare class InsecureTinyliciousTokenProvider implements ITokenProvider {
+    /**
+     * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
+     * will use the default scopes which are document read, write and summarizer write.
+     *
+     * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
+     *
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     */
+    private readonly scopes?;
+    constructor(
+    /**
+     * Optional. Override of scopes. If a param is not provided, InsecureTinyliciousTokenProvider
+     * will use the default scopes which are document read, write and summarizer write.
+     *
+     * @param scopes - See {@link @fluidframework/protocol-definitions#ITokenClaims.scopes}
+     *
+     * @defaultValue [ ScopeType.DocRead, ScopeType.DocWrite, ScopeType.SummaryWrite ]
+     */
+    scopes?: ScopeType[] | undefined);
+    fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
+    fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
+    private getSignedToken;
+}
+
+/**
+ * InsecureTinyliciousUrlResolver knows how to get the URLs to the service (in this case Tinylicious) to use
+ * for a given request.  This particular implementation has a goal to avoid imposing requirements on the app's
+ * URL shape, so it expects the request url to have this format (as opposed to a more traditional URL):
+ * documentId/containerRelativePathing
+ * @internal
+ */
+export declare class InsecureTinyliciousUrlResolver implements IUrlResolver {
+    private readonly fluidProtocolEndpoint;
+    private readonly tinyliciousEndpoint;
+    constructor(port?: number, endpoint?: string);
+    resolve(request: IRequest): Promise<IResolvedUrl>;
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string>;
+}
+
+export { }