@ms-cloudpack/remote-cache 0.1.15 → 0.1.17

package/lib/authentication/KeyRingLocalTokenCache.d.ts

@@ -1,13 +1,14 @@
 import type { LocalTokenCacheProvider } from '../types/LocalTokenCacheProvider.js';
-import type { ConnectionStringOptions } from '../types/ConnectionStringOptions.js';
 /**
  * This class is responsible to read and store tokens in a key ring provided by operating system.
  */
 export declare class KeyRingLocalTokenCache implements LocalTokenCacheProvider {
+    private readonly service;
+    private readonly key;
     private readonly entry;
-    private readonly entryOptions;
-    constructor(options: ConnectionStringOptions);
+    constructor(service: string, key: string);
     get(): string | undefined;
     set(value: string): void;
+    delete(): void;
 }
 //# sourceMappingURL=KeyRingLocalTokenCache.d.ts.map

package/lib/authentication/KeyRingLocalTokenCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyRingLocalTokenCache.d.ts","sourceRoot":"","sources":["../../src/authentication/KeyRingLocalTokenCache.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAGnF;;GAEG;AACH,qBAAa,sBAAuB,YAAW,uBAAuB;IACpE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAwC;gBAEzD,OAAO,EAAE,uBAAuB;IAW5C,GAAG;IAcH,GAAG,CAAC,KAAK,EAAE,MAAM;CAGlB"}
+{"version":3,"file":"KeyRingLocalTokenCache.d.ts","sourceRoot":"","sources":["../../src/authentication/KeyRingLocalTokenCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAGnF;;GAEG;AACH,qBAAa,sBAAuB,YAAW,uBAAuB;IAIlE,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAJtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;gBAGX,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM;IAK9B,GAAG;IAiBH,GAAG,CAAC,KAAK,EAAE,MAAM;IAIjB,MAAM;CAOP"}

package/lib/authentication/KeyRingLocalTokenCache.js

@@ -1,26 +1,37 @@
-import { ContainerSASPermissions } from '@azure/storage-blob';
 import { Entry } from '@napi-rs/keyring';
 /**
  * This class is responsible to read and store tokens in a key ring provided by operating system.
  */
 export class KeyRingLocalTokenCache {
-    constructor(options) {
-        this.entryOptions = {
-            service: `cloudpack-cache-${options.storageAccount}`,
-            username: `container:${options.container};permission:${ContainerSASPermissions.from(options.permissions).toString()}`,
-        };
-        this.entry = new Entry(this.entryOptions.service, this.entryOptions.username);
+    constructor(service, key) {
+        this.service = service;
+        this.key = key;
+        this.entry = new Entry(service, key);
     }
     get() {
-        const result = this.entry.getPassword();
-        console.debug(`KeyRingLocalTokenCache.get service:${this.entryOptions.service} username:${this.entryOptions.username} result:${result}`);
-        if (!result) {
+        try {
+            const result = this.entry.getPassword();
+            console.debug(`KeyRingLocalTokenCache.get service:${this.service} key:${this.key} result:${result}`);
+            if (!result) {
+                return undefined;
+            }
+            return result;
+        }
+        catch {
+            // If the entry does not exist getPassword might throw an error, return undefined.
             return undefined;
         }
-        return result;
     }
     set(value) {
         this.entry.setPassword(value);
     }
+    delete() {
+        try {
+            this.entry.deletePassword();
+        }
+        catch {
+            // If the entry does not exist deletePassword might throw an error, do nothing.
+        }
+    }
 }
 //# sourceMappingURL=KeyRingLocalTokenCache.js.map

package/lib/authentication/KeyRingLocalTokenCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyRingLocalTokenCache.js","sourceRoot":"","sources":["../../src/authentication/KeyRingLocalTokenCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAG9D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAIjC,YAAY,OAAgC;QAC1C,IAAI,CAAC,YAAY,GAAG;YAClB,OAAO,EAAE,mBAAmB,OAAO,CAAC,cAAc,EAAE;YACpD,QAAQ,EAAE,aAAa,OAAO,CAAC,SAAS,eAAe,uBAAuB,CAAC,IAAI,CACjF,OAAO,CAAC,WAAW,CACpB,CAAC,QAAQ,EAAE,EAAE;SACf,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAChF,CAAC;IAED,GAAG;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAExC,OAAO,CAAC,KAAK,CACX,sCAAsC,IAAI,CAAC,YAAY,CAAC,OAAO,aAAa,IAAI,CAAC,YAAY,CAAC,QAAQ,WAAW,MAAM,EAAE,CAC1H,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;CACF","sourcesContent":["import { ContainerSASPermissions } from '@azure/storage-blob';\nimport type { LocalTokenCacheProvider } from '../types/LocalTokenCacheProvider.js';\nimport type { ConnectionStringOptions } from '../types/ConnectionStringOptions.js';\nimport { Entry } from '@napi-rs/keyring';\n\n/**\n * This class is responsible to read and store tokens in a key ring provided by operating system.\n */\nexport class KeyRingLocalTokenCache implements LocalTokenCacheProvider {\n  private readonly entry: Entry;\n  private readonly entryOptions: { service: string; username: string };\n\n  constructor(options: ConnectionStringOptions) {\n    this.entryOptions = {\n      service: `cloudpack-cache-${options.storageAccount}`,\n      username: `container:${options.container};permission:${ContainerSASPermissions.from(\n        options.permissions,\n      ).toString()}`,\n    };\n\n    this.entry = new Entry(this.entryOptions.service, this.entryOptions.username);\n  }\n\n  get() {\n    const result = this.entry.getPassword();\n\n    console.debug(\n      `KeyRingLocalTokenCache.get service:${this.entryOptions.service} username:${this.entryOptions.username} result:${result}`,\n    );\n\n    if (!result) {\n      return undefined;\n    }\n\n    return result;\n  }\n\n  set(value: string) {\n    this.entry.setPassword(value);\n  }\n}\n"]}
+{"version":3,"file":"KeyRingLocalTokenCache.js","sourceRoot":"","sources":["../../src/authentication/KeyRingLocalTokenCache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAGjC,YACmB,OAAe,EACf,GAAW;QADX,YAAO,GAAP,OAAO,CAAQ;QACf,QAAG,GAAH,GAAG,CAAQ;QAE5B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,GAAG;QACD,IAAI;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAExC,OAAO,CAAC,KAAK,CAAC,sCAAsC,IAAI,CAAC,OAAO,QAAQ,IAAI,CAAC,GAAG,WAAW,MAAM,EAAE,CAAC,CAAC;YAErG,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,OAAO,MAAM,CAAC;SACf;QAAC,MAAM;YACN,kFAAkF;YAClF,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,MAAM;QACJ,IAAI;YACF,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;SAC7B;QAAC,MAAM;YACN,+EAA+E;SAChF;IACH,CAAC;CACF","sourcesContent":["import type { LocalTokenCacheProvider } from '../types/LocalTokenCacheProvider.js';\nimport { Entry } from '@napi-rs/keyring';\n\n/**\n * This class is responsible to read and store tokens in a key ring provided by operating system.\n */\nexport class KeyRingLocalTokenCache implements LocalTokenCacheProvider {\n  private readonly entry: Entry;\n\n  constructor(\n    private readonly service: string,\n    private readonly key: string,\n  ) {\n    this.entry = new Entry(service, key);\n  }\n\n  get() {\n    try {\n      const result = this.entry.getPassword();\n\n      console.debug(`KeyRingLocalTokenCache.get service:${this.service} key:${this.key} result:${result}`);\n\n      if (!result) {\n        return undefined;\n      }\n\n      return result;\n    } catch {\n      // If the entry does not exist getPassword might throw an error, return undefined.\n      return undefined;\n    }\n  }\n\n  set(value: string) {\n    this.entry.setPassword(value);\n  }\n\n  delete() {\n    try {\n      this.entry.deletePassword();\n    } catch {\n      // If the entry does not exist deletePassword might throw an error, do nothing.\n    }\n  }\n}\n"]}

package/lib/authentication/getAuthenticatedConnectionString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getAuthenticatedConnectionString.d.ts","sourceRoot":"","sources":["../../src/authentication/getAuthenticatedConnectionString.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAUnF,wBAAsB,gCAAgC,CAAC,uBAAuB,EAAE,uBAAuB,mBAUtG"}
+{"version":3,"file":"getAuthenticatedConnectionString.d.ts","sourceRoot":"","sources":["../../src/authentication/getAuthenticatedConnectionString.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAenF,wBAAsB,gCAAgC,CAAC,uBAAuB,EAAE,uBAAuB,mBAUtG"}

package/lib/authentication/getAuthenticatedConnectionString.js

@@ -2,9 +2,12 @@ import { createBlobStorageUrl } from './createBlobStorageUrl.js';
 import { getSasToken } from './getSasToken.js';
 import { acquireSasToken } from './acquireSasToken.js';
 import { isExpired } from './isExpired.js';
-async function createLocalTokenCacheLazy(connectionStringOptions) {
+import { ContainerSASPermissions } from '@azure/storage-blob';
+async function createLocalTokenCacheLazy({ storageAccount, container, permissions }) {
     const { KeyRingLocalTokenCache } = await import('./KeyRingLocalTokenCache.js');
-    return new KeyRingLocalTokenCache(connectionStringOptions);
+    const service = `cloudpack-cache-${storageAccount}`;
+    const key = `container:${container};permission:${ContainerSASPermissions.from(permissions).toString()}`;
+    return new KeyRingLocalTokenCache(service, key);
 }
 export async function getAuthenticatedConnectionString(connectionStringOptions) {
     // No need to cache tokens if the user is NOT running in interactive mode.

package/lib/authentication/getAuthenticatedConnectionString.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAuthenticatedConnectionString.js","sourceRoot":"","sources":["../../src/authentication/getAuthenticatedConnectionString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,KAAK,UAAU,yBAAyB,CAAC,uBAAgD;IACvF,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAC;IAC/E,OAAO,IAAI,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gCAAgC,CAAC,uBAAgD;IACrG,0EAA0E;IAC1E,MAAM,UAAU,GAAG,uBAAuB,CAAC,kBAAkB;QAC3D,CAAC,CAAC,MAAM,yBAAyB,CAAC,uBAAuB,CAAC;QAC1D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,EAAE,uBAAuB,EAAE,EAAE,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAE5G,MAAM,EAAE,cAAc,EAAE,GAAG,uBAAuB,CAAC;IACnD,OAAO,gBAAgB,oBAAoB,CAAC,cAAc,CAAC,0BAA0B,QAAQ,EAAE,CAAC;AAClG,CAAC","sourcesContent":["import { createBlobStorageUrl } from './createBlobStorageUrl.js';\nimport type { ConnectionStringOptions } from '../types/ConnectionStringOptions.js';\nimport { getSasToken } from './getSasToken.js';\nimport { acquireSasToken } from './acquireSasToken.js';\nimport { isExpired } from './isExpired.js';\n\nasync function createLocalTokenCacheLazy(connectionStringOptions: ConnectionStringOptions) {\n  const { KeyRingLocalTokenCache } = await import('./KeyRingLocalTokenCache.js');\n  return new KeyRingLocalTokenCache(connectionStringOptions);\n}\n\nexport async function getAuthenticatedConnectionString(connectionStringOptions: ConnectionStringOptions) {\n  // No need to cache tokens if the user is NOT running in interactive mode.\n  const tokenCache = connectionStringOptions.isInteractiveLogin\n    ? await createLocalTokenCacheLazy(connectionStringOptions)\n    : undefined;\n\n  const sasToken = await getSasToken({ connectionStringOptions }, { tokenCache, acquireSasToken, isExpired });\n\n  const { storageAccount } = connectionStringOptions;\n  return `BlobEndpoint=${createBlobStorageUrl(storageAccount)};SharedAccessSignature=${sasToken}`;\n}\n"]}
+{"version":3,"file":"getAuthenticatedConnectionString.js","sourceRoot":"","sources":["../../src/authentication/getAuthenticatedConnectionString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,KAAK,UAAU,yBAAyB,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,WAAW,EAA2B;IAC1G,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAC;IAE/E,MAAM,OAAO,GAAG,mBAAmB,cAAc,EAAE,CAAC;IACpD,MAAM,GAAG,GAAG,aAAa,SAAS,eAAe,uBAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;IAExG,OAAO,IAAI,sBAAsB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gCAAgC,CAAC,uBAAgD;IACrG,0EAA0E;IAC1E,MAAM,UAAU,GAAG,uBAAuB,CAAC,kBAAkB;QAC3D,CAAC,CAAC,MAAM,yBAAyB,CAAC,uBAAuB,CAAC;QAC1D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,EAAE,uBAAuB,EAAE,EAAE,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAE5G,MAAM,EAAE,cAAc,EAAE,GAAG,uBAAuB,CAAC;IACnD,OAAO,gBAAgB,oBAAoB,CAAC,cAAc,CAAC,0BAA0B,QAAQ,EAAE,CAAC;AAClG,CAAC","sourcesContent":["import { createBlobStorageUrl } from './createBlobStorageUrl.js';\nimport type { ConnectionStringOptions } from '../types/ConnectionStringOptions.js';\nimport { getSasToken } from './getSasToken.js';\nimport { acquireSasToken } from './acquireSasToken.js';\nimport { isExpired } from './isExpired.js';\nimport { ContainerSASPermissions } from '@azure/storage-blob';\n\nasync function createLocalTokenCacheLazy({ storageAccount, container, permissions }: ConnectionStringOptions) {\n  const { KeyRingLocalTokenCache } = await import('./KeyRingLocalTokenCache.js');\n\n  const service = `cloudpack-cache-${storageAccount}`;\n  const key = `container:${container};permission:${ContainerSASPermissions.from(permissions).toString()}`;\n\n  return new KeyRingLocalTokenCache(service, key);\n}\n\nexport async function getAuthenticatedConnectionString(connectionStringOptions: ConnectionStringOptions) {\n  // No need to cache tokens if the user is NOT running in interactive mode.\n  const tokenCache = connectionStringOptions.isInteractiveLogin\n    ? await createLocalTokenCacheLazy(connectionStringOptions)\n    : undefined;\n\n  const sasToken = await getSasToken({ connectionStringOptions }, { tokenCache, acquireSasToken, isExpired });\n\n  const { storageAccount } = connectionStringOptions;\n  return `BlobEndpoint=${createBlobStorageUrl(storageAccount)};SharedAccessSignature=${sasToken}`;\n}\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.37.1"
+      "packageVersion": "7.38.1"
     }
   ]
 }

package/lib/types/LocalTokenCacheProvider.d.ts

@@ -1,5 +1,6 @@
 export interface LocalTokenCacheProvider {
     get(): string | undefined;
     set(value: string): void;
+    delete(): void;
 }
 //# sourceMappingURL=LocalTokenCacheProvider.d.ts.map

package/lib/types/LocalTokenCacheProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LocalTokenCacheProvider.d.ts","sourceRoot":"","sources":["../../src/types/LocalTokenCacheProvider.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,GAAG,IAAI,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B"}
+{"version":3,"file":"LocalTokenCacheProvider.d.ts","sourceRoot":"","sources":["../../src/types/LocalTokenCacheProvider.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,GAAG,IAAI,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,IAAI,IAAI,CAAC;CAChB"}

package/lib/types/LocalTokenCacheProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"LocalTokenCacheProvider.js","sourceRoot":"","sources":["../../src/types/LocalTokenCacheProvider.ts"],"names":[],"mappings":"","sourcesContent":["export interface LocalTokenCacheProvider {\n  get(): string | undefined;\n  set(value: string): void;\n}\n"]}
+{"version":3,"file":"LocalTokenCacheProvider.js","sourceRoot":"","sources":["../../src/types/LocalTokenCacheProvider.ts"],"names":[],"mappings":"","sourcesContent":["export interface LocalTokenCacheProvider {\n  get(): string | undefined;\n  set(value: string): void;\n  delete(): void;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/remote-cache",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "description": "Manages syncing the local Cloudpack cached assets to/from a remote storage service.",
   "license": "MIT",
   "type": "module",
@@ -15,7 +15,8 @@
   },
   "devDependencies": {
     "@ms-cloudpack/eslint-plugin-internal": "*",
-    "@ms-cloudpack/scripts": "*"
+    "@ms-cloudpack/scripts": "*",
+    "uuid": "^9.0.0"
   },
   "scripts": {
     "api": "cloudpack-scripts api",
@@ -30,8 +31,8 @@
     "lib/**/!(*.test.*)"
   ],
   "dependencies": {
-    "@ms-cloudpack/task-reporter": "^0.10.0",
-    "@azure/identity": "^3.2.3",
+    "@ms-cloudpack/task-reporter": "^0.10.1",
+    "@azure/identity": "^3.4.0",
     "@azure/storage-blob": "^12.15.0",
     "@napi-rs/keyring": "^1.1.3",
     "backfill": "^6.2.1",