@fluidframework/azure-service-utils 0.59.2003 → 0.59.3000

package/api-extractor.json

@@ -1,4 +1,12 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+  "extends": "@fluidframework/build-common/api-extractor-common-report.json",
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/../../../api-report/"
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/../../_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
+  }
 }

package/dist/generateToken.d.ts

@@ -4,11 +4,24 @@
  */
 import type { IUser, ScopeType } from "@fluidframework/protocol-definitions";
 /**
- * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)
- * and should only be used in client context.
- * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on
- * the service side,  please use the copy available in the server-services-client package in order to avoid
- * interdependencies between service and client packages
+ * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no
+ * need for different implementations, so they should be kept in sync if changes are needed.
+ *
+ * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries
+ * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which
+ * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function
+ * exported, so it needs to be sourced from either the package itself or a non-dev dependency.
+ *
+ * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that
+ * no longer works because the azure packages are in a separate release group.
+ *
+ * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token
+ * generation, you should use the function available in the server-services-client package in order to avoid
+ * interdependencies between service and client packages.
+ */
+/**
+ * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser
+ * friendly auth library (jsrsasign) and should only be used in client (browser) context.
  */
 export declare function generateToken(tenantId: string, key: string, scopes: ScopeType[], documentId?: string, user?: IUser, lifetime?: number, ver?: string): string;
 export declare function generateUser(): IUser;

package/dist/generateToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateToken.d.ts","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAgB,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAI3F;;;;;;GAMG;AACH,wBAAgB,aAAa,CACzB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,EAAE,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,GAAE,MAAgB,EAC1B,GAAG,GAAE,MAAc,GAAG,MAAM,CAuB/B;AAED,wBAAgB,YAAY,IAAI,KAAK,CAOpC"}
+{"version":3,"file":"generateToken.d.ts","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAgB,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAI3F;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AACH,wBAAgB,aAAa,CACzB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,EAAE,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,GAAE,MAAgB,EAC1B,GAAG,GAAE,MAAc,GAAG,MAAM,CAuB/B;AAED,wBAAgB,YAAY,IAAI,KAAK,CAOpC"}

package/dist/generateToken.js

@@ -8,11 +8,24 @@ exports.generateUser = exports.generateToken = void 0;
 const jsrsasign_1 = require("jsrsasign");
 const uuid_1 = require("uuid");
 /**
- * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)
- * and should only be used in client context.
- * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on
- * the service side,  please use the copy available in the server-services-client package in order to avoid
- * interdependencies between service and client packages
+ * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no
+ * need for different implementations, so they should be kept in sync if changes are needed.
+ *
+ * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries
+ * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which
+ * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function
+ * exported, so it needs to be sourced from either the package itself or a non-dev dependency.
+ *
+ * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that
+ * no longer works because the azure packages are in a separate release group.
+ *
+ * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token
+ * generation, you should use the function available in the server-services-client package in order to avoid
+ * interdependencies between service and client packages.
+ */
+/**
+ * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser
+ * friendly auth library (jsrsasign) and should only be used in client (browser) context.
  */
 function generateToken(tenantId, key, scopes, documentId, user, lifetime = 60 * 60, ver = "1.0") {
     let userClaim = (user) ? user : generateUser();
@@ -30,7 +43,7 @@ function generateToken(tenantId, key, scopes, documentId, user, lifetime = 60 *
         iat: now,
         exp: now + lifetime,
         ver,
-        jti: uuid_1.v4(),
+        jti: (0, uuid_1.v4)(),
     };
     const utf8Key = { utf8: key };
     return jsrsasign_1.KJUR.jws.JWS.sign(null, JSON.stringify({ alg: "HS256", typ: "JWT" }), claims, utf8Key);
@@ -38,8 +51,8 @@ function generateToken(tenantId, key, scopes, documentId, user, lifetime = 60 *
 exports.generateToken = generateToken;
 function generateUser() {
     const randomUser = {
-        id: uuid_1.v4(),
-        name: uuid_1.v4(),
+        id: (0, uuid_1.v4)(),
+        name: (0, uuid_1.v4)(),
     };
     return randomUser;
 }

package/dist/generateToken.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateToken.js","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yCAA8C;AAC9C,+BAAkC;AAElC;;;;;;GAMG;AACH,SAAgB,aAAa,CACzB,QAAgB,EAChB,GAAW,EACX,MAAmB,EACnB,UAAmB,EACnB,IAAY,EACZ,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;IACnB,IAAI,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC/C,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS,EAAE;QACnD,SAAS,GAAG,YAAY,EAAE,CAAC;KAC9B;IAED,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;IAE/B,MAAM,MAAM,GAAmC;QAC3C,UAAU,EAAE,KAAK;QACjB,MAAM;QACN,QAAQ;QACR,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG,GAAG,QAAQ;QACnB,GAAG;QACH,GAAG,EAAE,SAAI,EAAE;KACd,CAAC;IAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,gBAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACvG,CAAC;AA9BD,sCA8BC;AAED,SAAgB,YAAY;IACxB,MAAM,UAAU,GAAG;QACf,EAAE,EAAE,SAAI,EAAE;QACV,IAAI,EAAE,SAAI,EAAE;KACf,CAAC;IAEF,OAAO,UAAU,CAAC;AACtB,CAAC;AAPD,oCAOC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITokenClaims, IUser, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)\n * and should only be used in client context.\n * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on\n * the service side,  please use the copy available in the server-services-client package in order to avoid\n * interdependencies between service and client packages\n */\nexport function generateToken(\n    tenantId: string,\n    key: string,\n    scopes: ScopeType[],\n    documentId?: string,\n    user?: IUser,\n    lifetime: number = 60 * 60,\n    ver: string = \"1.0\"): string {\n    let userClaim = (user) ? user : generateUser();\n    if (userClaim.id === \"\" || userClaim.id === undefined) {\n        userClaim = generateUser();\n    }\n\n    // Current time in seconds\n    const now = Math.round(Date.now() / 1000);\n    const docId = documentId ?? \"\";\n\n    const claims: ITokenClaims & { jti: string } = {\n        documentId: docId,\n        scopes,\n        tenantId,\n        user: userClaim,\n        iat: now,\n        exp: now + lifetime,\n        ver,\n        jti: uuid(),\n    };\n\n    const utf8Key = { utf8: key };\n    return jsrsasign.jws.JWS.sign(null, JSON.stringify({ alg: \"HS256\", typ: \"JWT\" }), claims, utf8Key);\n}\n\nexport function generateUser(): IUser {\n    const randomUser = {\n        id: uuid(),\n        name: uuid(),\n    };\n\n    return randomUser;\n}\n"]}
+{"version":3,"file":"generateToken.js","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yCAA8C;AAC9C,+BAAkC;AAElC;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AACH,SAAgB,aAAa,CACzB,QAAgB,EAChB,GAAW,EACX,MAAmB,EACnB,UAAmB,EACnB,IAAY,EACZ,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;IACnB,IAAI,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC/C,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS,EAAE;QACnD,SAAS,GAAG,YAAY,EAAE,CAAC;KAC9B;IAED,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;IAE/B,MAAM,MAAM,GAAoC;QAC5C,UAAU,EAAE,KAAK;QACjB,MAAM;QACN,QAAQ;QACR,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG,GAAG,QAAQ;QACnB,GAAG;QACH,GAAG,EAAE,IAAA,SAAI,GAAE;KACd,CAAC;IAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,gBAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACvG,CAAC;AA9BD,sCA8BC;AAED,SAAgB,YAAY;IACxB,MAAM,UAAU,GAAG;QACf,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,IAAI,EAAE,IAAA,SAAI,GAAE;KACf,CAAC;IAEF,OAAO,UAAU,CAAC;AACtB,CAAC;AAPD,oCAOC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITokenClaims, IUser, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no\n * need for different implementations, so they should be kept in sync if changes are needed.\n *\n * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries\n * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which\n * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function\n * exported, so it needs to be sourced from either the package itself or a non-dev dependency.\n *\n * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that\n * no longer works because the azure packages are in a separate release group.\n *\n * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token\n * generation, you should use the function available in the server-services-client package in order to avoid\n * interdependencies between service and client packages.\n */\n\n/**\n * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser\n * friendly auth library (jsrsasign) and should only be used in client (browser) context.\n */\nexport function generateToken(\n    tenantId: string,\n    key: string,\n    scopes: ScopeType[],\n    documentId?: string,\n    user?: IUser,\n    lifetime: number = 60 * 60,\n    ver: string = \"1.0\"): string {\n    let userClaim = (user) ? user : generateUser();\n    if (userClaim.id === \"\" || userClaim.id === undefined) {\n        userClaim = generateUser();\n    }\n\n    // Current time in seconds\n    const now = Math.round(Date.now() / 1000);\n    const docId = documentId ?? \"\";\n\n    const claims: ITokenClaims & { jti: string; } = {\n        documentId: docId,\n        scopes,\n        tenantId,\n        user: userClaim,\n        iat: now,\n        exp: now + lifetime,\n        ver,\n        jti: uuid(),\n    };\n\n    const utf8Key = { utf8: key };\n    return jsrsasign.jws.JWS.sign(null, JSON.stringify({ alg: \"HS256\", typ: \"JWT\" }), claims, utf8Key);\n}\n\nexport function generateUser(): IUser {\n    const randomUser = {\n        id: uuid(),\n        name: uuid(),\n    };\n\n    return randomUser;\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/azure-service-utils";
-export declare const pkgVersion = "0.59.2003";
+export declare const pkgVersion = "0.59.3000";
 //# 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/azure-service-utils";
-exports.pkgVersion = "0.59.2003";
+exports.pkgVersion = "0.59.3000";
 //# 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,qCAAqC,CAAC;AAChD,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/azure-service-utils\";\nexport const pkgVersion = \"0.59.2003\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,qCAAqC,CAAC;AAChD,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/azure-service-utils\";\nexport const pkgVersion = \"0.59.3000\";\n"]}

package/lib/generateToken.d.ts

@@ -4,11 +4,24 @@
  */
 import type { IUser, ScopeType } from "@fluidframework/protocol-definitions";
 /**
- * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)
- * and should only be used in client context.
- * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on
- * the service side,  please use the copy available in the server-services-client package in order to avoid
- * interdependencies between service and client packages
+ * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no
+ * need for different implementations, so they should be kept in sync if changes are needed.
+ *
+ * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries
+ * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which
+ * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function
+ * exported, so it needs to be sourced from either the package itself or a non-dev dependency.
+ *
+ * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that
+ * no longer works because the azure packages are in a separate release group.
+ *
+ * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token
+ * generation, you should use the function available in the server-services-client package in order to avoid
+ * interdependencies between service and client packages.
+ */
+/**
+ * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser
+ * friendly auth library (jsrsasign) and should only be used in client (browser) context.
  */
 export declare function generateToken(tenantId: string, key: string, scopes: ScopeType[], documentId?: string, user?: IUser, lifetime?: number, ver?: string): string;
 export declare function generateUser(): IUser;

package/lib/generateToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateToken.d.ts","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAgB,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAI3F;;;;;;GAMG;AACH,wBAAgB,aAAa,CACzB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,EAAE,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,GAAE,MAAgB,EAC1B,GAAG,GAAE,MAAc,GAAG,MAAM,CAuB/B;AAED,wBAAgB,YAAY,IAAI,KAAK,CAOpC"}
+{"version":3,"file":"generateToken.d.ts","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAgB,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAI3F;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AACH,wBAAgB,aAAa,CACzB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,EAAE,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,KAAK,EACZ,QAAQ,GAAE,MAAgB,EAC1B,GAAG,GAAE,MAAc,GAAG,MAAM,CAuB/B;AAED,wBAAgB,YAAY,IAAI,KAAK,CAOpC"}

package/lib/generateToken.js

@@ -5,11 +5,24 @@
 import { KJUR as jsrsasign } from "jsrsasign";
 import { v4 as uuid } from "uuid";
 /**
- * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)
- * and should only be used in client context.
- * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on
- * the service side,  please use the copy available in the server-services-client package in order to avoid
- * interdependencies between service and client packages
+ * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no
+ * need for different implementations, so they should be kept in sync if changes are needed.
+ *
+ * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries
+ * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which
+ * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function
+ * exported, so it needs to be sourced from either the package itself or a non-dev dependency.
+ *
+ * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that
+ * no longer works because the azure packages are in a separate release group.
+ *
+ * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token
+ * generation, you should use the function available in the server-services-client package in order to avoid
+ * interdependencies between service and client packages.
+ */
+/**
+ * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser
+ * friendly auth library (jsrsasign) and should only be used in client (browser) context.
  */
 export function generateToken(tenantId, key, scopes, documentId, user, lifetime = 60 * 60, ver = "1.0") {
     let userClaim = (user) ? user : generateUser();

package/lib/generateToken.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateToken.js","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CACzB,QAAgB,EAChB,GAAW,EACX,MAAmB,EACnB,UAAmB,EACnB,IAAY,EACZ,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;IACnB,IAAI,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC/C,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS,EAAE;QACnD,SAAS,GAAG,YAAY,EAAE,CAAC;KAC9B;IAED,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;IAE/B,MAAM,MAAM,GAAmC;QAC3C,UAAU,EAAE,KAAK;QACjB,MAAM;QACN,QAAQ;QACR,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG,GAAG,QAAQ;QACnB,GAAG;QACH,GAAG,EAAE,IAAI,EAAE;KACd,CAAC;IAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACvG,CAAC;AAED,MAAM,UAAU,YAAY;IACxB,MAAM,UAAU,GAAG;QACf,EAAE,EAAE,IAAI,EAAE;QACV,IAAI,EAAE,IAAI,EAAE;KACf,CAAC;IAEF,OAAO,UAAU,CAAC;AACtB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITokenClaims, IUser, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)\n * and should only be used in client context.\n * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on\n * the service side,  please use the copy available in the server-services-client package in order to avoid\n * interdependencies between service and client packages\n */\nexport function generateToken(\n    tenantId: string,\n    key: string,\n    scopes: ScopeType[],\n    documentId?: string,\n    user?: IUser,\n    lifetime: number = 60 * 60,\n    ver: string = \"1.0\"): string {\n    let userClaim = (user) ? user : generateUser();\n    if (userClaim.id === \"\" || userClaim.id === undefined) {\n        userClaim = generateUser();\n    }\n\n    // Current time in seconds\n    const now = Math.round(Date.now() / 1000);\n    const docId = documentId ?? \"\";\n\n    const claims: ITokenClaims & { jti: string } = {\n        documentId: docId,\n        scopes,\n        tenantId,\n        user: userClaim,\n        iat: now,\n        exp: now + lifetime,\n        ver,\n        jti: uuid(),\n    };\n\n    const utf8Key = { utf8: key };\n    return jsrsasign.jws.JWS.sign(null, JSON.stringify({ alg: \"HS256\", typ: \"JWT\" }), claims, utf8Key);\n}\n\nexport function generateUser(): IUser {\n    const randomUser = {\n        id: uuid(),\n        name: uuid(),\n    };\n\n    return randomUser;\n}\n"]}
+{"version":3,"file":"generateToken.js","sourceRoot":"","sources":["../src/generateToken.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AACH,MAAM,UAAU,aAAa,CACzB,QAAgB,EAChB,GAAW,EACX,MAAmB,EACnB,UAAmB,EACnB,IAAY,EACZ,WAAmB,EAAE,GAAG,EAAE,EAC1B,MAAc,KAAK;IACnB,IAAI,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC/C,IAAI,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,EAAE,KAAK,SAAS,EAAE;QACnD,SAAS,GAAG,YAAY,EAAE,CAAC;KAC9B;IAED,0BAA0B;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC;IAE/B,MAAM,MAAM,GAAoC;QAC5C,UAAU,EAAE,KAAK;QACjB,MAAM;QACN,QAAQ;QACR,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG,GAAG,QAAQ;QACnB,GAAG;QACH,GAAG,EAAE,IAAI,EAAE;KACd,CAAC;IAEF,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACvG,CAAC;AAED,MAAM,UAAU,YAAY;IACxB,MAAM,UAAU,GAAG;QACf,EAAE,EAAE,IAAI,EAAE;QACV,IAAI,EAAE,IAAI,EAAE;KACf,CAAC;IAEF,OAAO,UAAU,CAAC;AACtB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITokenClaims, IUser, ScopeType } from \"@fluidframework/protocol-definitions\";\nimport { KJUR as jsrsasign } from \"jsrsasign\";\nimport { v4 as uuid } from \"uuid\";\n\n/**\n * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no\n * need for different implementations, so they should be kept in sync if changes are needed.\n *\n * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries\n * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which\n * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function\n * exported, so it needs to be sourced from either the package itself or a non-dev dependency.\n *\n * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that\n * no longer works because the azure packages are in a separate release group.\n *\n * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token\n * generation, you should use the function available in the server-services-client package in order to avoid\n * interdependencies between service and client packages.\n */\n\n/**\n * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser\n * friendly auth library (jsrsasign) and should only be used in client (browser) context.\n */\nexport function generateToken(\n    tenantId: string,\n    key: string,\n    scopes: ScopeType[],\n    documentId?: string,\n    user?: IUser,\n    lifetime: number = 60 * 60,\n    ver: string = \"1.0\"): string {\n    let userClaim = (user) ? user : generateUser();\n    if (userClaim.id === \"\" || userClaim.id === undefined) {\n        userClaim = generateUser();\n    }\n\n    // Current time in seconds\n    const now = Math.round(Date.now() / 1000);\n    const docId = documentId ?? \"\";\n\n    const claims: ITokenClaims & { jti: string; } = {\n        documentId: docId,\n        scopes,\n        tenantId,\n        user: userClaim,\n        iat: now,\n        exp: now + lifetime,\n        ver,\n        jti: uuid(),\n    };\n\n    const utf8Key = { utf8: key };\n    return jsrsasign.jws.JWS.sign(null, JSON.stringify({ alg: \"HS256\", typ: \"JWT\" }), claims, utf8Key);\n}\n\nexport function generateUser(): IUser {\n    const randomUser = {\n        id: uuid(),\n        name: uuid(),\n    };\n\n    return randomUser;\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/azure-service-utils";
-export declare const pkgVersion = "0.59.2003";
+export declare const pkgVersion = "0.59.3000";
 //# 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/azure-service-utils";
-export const pkgVersion = "0.59.2003";
+export const pkgVersion = "0.59.3000";
 //# 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,qCAAqC,CAAC;AAC7D,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/azure-service-utils\";\nexport const pkgVersion = \"0.59.2003\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,qCAAqC,CAAC;AAC7D,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/azure-service-utils\";\nexport const pkgVersion = \"0.59.3000\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/azure-service-utils",
-  "version": "0.59.2003",
+  "version": "0.59.3000",
   "description": "Helper service-side utilities for connecting to Azure Fluid Relay service",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -18,13 +18,13 @@
     "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
     "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
     "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf dist *.tsbuildinfo *.build.log",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -42,9 +42,10 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluidframework/azure-service-utils-previous": "npm:@fluidframework/azure-service-utils@0.59.1000",
+    "@fluidframework/azure-service-utils-previous": "npm:@fluidframework/azure-service-utils@0.59.2000",
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.28.1000",
+    "@fluidframework/build-tools": "^0.2.70857",
+    "@fluidframework/eslint-config-fluid": "^0.28.2000",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/jsrsasign": "^8.0.8",
@@ -57,17 +58,19 @@
     "eslint-plugin-eslint-comments": "~3.2.0",
     "eslint-plugin-import": "~2.25.4",
     "eslint-plugin-jest": "~26.1.3",
+    "eslint-plugin-jsdoc": "~39.3.0",
     "eslint-plugin-mocha": "~10.0.3",
     "eslint-plugin-promise": "~6.0.0",
     "eslint-plugin-react": "~7.28.0",
     "eslint-plugin-tsdoc": "~0.2.14",
     "eslint-plugin-unicorn": "~40.0.0",
+    "eslint-plugin-unused-imports": "~2.0.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.1.3",
+    "typescript": "~4.5.5",
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.2000",
+    "version": "0.59.3000",
     "broken": {}
   }
 }

package/src/generateToken.ts

@@ -8,11 +8,25 @@ import { KJUR as jsrsasign } from "jsrsasign";
 import { v4 as uuid } from "uuid";
 
 /**
- * Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign)
- * and should only be used in client context.
- * If a token ever needs to be generated on the client side, it should re-use this function. If it needs to be used on
- * the service side,  please use the copy available in the server-services-client package in order to avoid
- * interdependencies between service and client packages
+ * IMPORTANT: This function is duplicated in ./packages/runtime/test-runtime-utils/src/generateToken.ts. There is no
+ * need for different implementations, so they should be kept in sync if changes are needed.
+ *
+ * The reason they are duplicated is because we don't want the core Fluid libraries depending on the Azure libraries
+ * (enforced by layer-check), but both need to expose this function. The test-runtime-utils library is a test lib, which
+ * layer-check (correctly) reuires only be used as a dev dependency. But in the azure case, we want the function
+ * exported, so it needs to be sourced from either the package itself or a non-dev dependency.
+ *
+ * The previous solution to this was to import the function from azure-service-utils into test-runtime-utils, but that
+ * no longer works because the azure packages are in a separate release group.
+ *
+ * If a token needs to be generated on the client side, you should re-use this function. If you need service-side token
+ * generation, you should use the function available in the server-services-client package in order to avoid
+ * interdependencies between service and client packages.
+ */
+
+/**
+ * Generates a JWT token to authorize access to a Routerlicious-based Fluid service. This function uses a browser
+ * friendly auth library (jsrsasign) and should only be used in client (browser) context.
  */
 export function generateToken(
     tenantId: string,
@@ -31,7 +45,7 @@ export function generateToken(
     const now = Math.round(Date.now() / 1000);
     const docId = documentId ?? "";
 
-    const claims: ITokenClaims & { jti: string } = {
+    const claims: ITokenClaims & { jti: string; } = {
         documentId: docId,
         scopes,
         tenantId,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/azure-service-utils";
-export const pkgVersion = "0.59.2003";
+export const pkgVersion = "0.59.3000";