@ms-cloudpack/remote-cache 0.6.3 → 0.6.5

package/dist/{chunk-KFSFZYG6.js → chunk-YAIY33BG.js}

@@ -1,21 +1,19 @@
 import {
+  __commonJS,
+  __esm,
+  __export,
+  __name,
+  __require,
+  __toCommonJS,
   esm_node_exports,
+  init_esbuildCjsShims,
   init_esm_node,
   init_tslib_es6,
   require_dist,
   require_dist2,
   require_dist3,
   tslib_es6_exports
-} from "./chunk-4P62L7ZZ.js";
-import {
-  __commonJS,
-  __esm,
-  __export,
-  __name,
-  __require,
-  __toCommonJS,
-  init_esbuildCjsShims
-} from "./chunk-TQLTL4XO.js";
+} from "./chunk-OPD65OLQ.js";
 
 // ../../node_modules/.store/xml2js-npm-0.5.0-06e57a2771/package/lib/defaults.js
 var require_defaults = __commonJS({
@@ -6069,7 +6067,7 @@ var require_dist4 = __commonJS({
     "use strict";
     init_esbuildCjsShims();
     Object.defineProperty(exports, "__esModule", { value: true });
-    var coreUtil = require_dist3();
+    var coreUtil = require_dist2();
     var _AzureKeyCredential = class _AzureKeyCredential {
       /**
        * The value of the key to be used in authentication
@@ -20927,13 +20925,13 @@ var require_dist6 = __commonJS({
     var util = __require("util");
     var tslib = (init_tslib_es6(), __toCommonJS(tslib_es6_exports));
     var xml2js = require_xml2js();
-    var coreUtil = require_dist3();
-    var logger$1 = require_dist();
+    var coreUtil = require_dist2();
+    var logger$1 = require_dist3();
     var coreAuth = require_dist4();
     var os = __require("os");
     var http = __require("http");
     var https = __require("https");
-    var abortController = require_dist2();
+    var abortController = require_dist();
     var tunnel = require_package();
     var stream = __require("stream");
     var FormData = require_form_data();
@@ -25487,9 +25485,9 @@ var require_dist8 = __commonJS({
     "use strict";
     init_esbuildCjsShims();
     Object.defineProperty(exports, "__esModule", { value: true });
-    var logger$1 = require_dist();
-    var abortController = require_dist2();
-    var coreUtil = require_dist3();
+    var logger$1 = require_dist3();
+    var abortController = require_dist();
+    var coreUtil = require_dist2();
     var logger = logger$1.createClientLogger("core-lro");
     var POLL_INTERVAL_IN_MS = 2e3;
     var terminalStates = ["succeeded", "canceled", "failed"];
@@ -26538,8 +26536,8 @@ var require_dist9 = __commonJS({
     var coreHttp = require_dist6();
     var tslib = (init_tslib_es6(), __toCommonJS(tslib_es6_exports));
     var coreTracing = require_dist5();
-    var logger$1 = require_dist();
-    var abortController = require_dist2();
+    var logger$1 = require_dist3();
+    var abortController = require_dist();
     var os = __require("os");
     var crypto = __require("crypto");
     var stream = __require("stream");

package/dist/{getCredential-QMMPE77Q.js → getCredential-FIEDCLGJ.js}

@@ -1,12 +1,3 @@
-import {
-  init_esm_node,
-  init_tslib_es6,
-  require_dist,
-  require_dist2,
-  require_dist3,
-  tslib_es6_exports,
-  v4_default
-} from "./chunk-4P62L7ZZ.js";
 import {
   __commonJS,
   __esm,
@@ -15,8 +6,15 @@ import {
   __require,
   __toCommonJS,
   __toESM,
-  init_esbuildCjsShims
-} from "./chunk-TQLTL4XO.js";
+  init_esbuildCjsShims,
+  init_esm_node,
+  init_tslib_es6,
+  require_dist,
+  require_dist2,
+  require_dist3,
+  tslib_es6_exports,
+  v4_default
+} from "./chunk-OPD65OLQ.js";
 
 // ../../node_modules/.store/@azure-msal-node-npm-2.6.2-9183813942/package/dist/cache/serializer/Serializer.mjs
 var _Serializer, Serializer;
@@ -16524,10 +16522,10 @@ var require_dist8 = __commonJS({
     "use strict";
     init_esbuildCjsShims();
     Object.defineProperty(exports, "__esModule", { value: true });
-    var logger$1 = require_dist();
-    var coreUtil = require_dist3();
+    var logger$1 = require_dist3();
+    var coreUtil = require_dist2();
     var os = __require("os");
-    var abortController = require_dist2();
+    var abortController = require_dist();
     var httpsProxyAgent = require_dist4();
     var httpProxyAgent = require_dist6();
     var coreTracing = require_dist7();
@@ -18555,7 +18553,7 @@ var require_dist9 = __commonJS({
     init_esbuildCjsShims();
     Object.defineProperty(exports, "__esModule", { value: true });
     var coreRestPipeline = require_dist8();
-    var logger$1 = require_dist();
+    var logger$1 = require_dist3();
     function encodeByteArray(value) {
       const bufferValue = value instanceof Buffer ? value : Buffer.from(value.buffer);
       return bufferValue.toString("base64");
@@ -20641,9 +20639,9 @@ var require_dist10 = __commonJS({
     init_esbuildCjsShims();
     Object.defineProperty(exports, "__esModule", { value: true });
     var msalCommon = (init_dist2(), __toCommonJS(dist_exports));
-    var logger$o = require_dist();
-    var abortController = require_dist2();
-    var coreUtil = require_dist3();
+    var logger$o = require_dist3();
+    var abortController = require_dist();
+    var coreUtil = require_dist2();
     var coreClient = require_dist9();
     var coreRestPipeline = require_dist8();
     var coreTracing = require_dist7();
@@ -24221,52 +24219,47 @@ var tokenCachePersistenceOptions = {
   enabled: true,
   name: "cloudpack"
 };
-function getCredentialInternal(loginMethod, authenticationRecord) {
+function getCredentialInternal(loginMethod, authenticationRecord, tenantId) {
   switch (loginMethod) {
     case "interactive":
       return new import_identity3.InteractiveBrowserCredential({
         redirectUri: "http://localhost:1337",
         authenticationRecord,
-        tokenCachePersistenceOptions
+        tokenCachePersistenceOptions,
+        tenantId
       });
     case "device-code":
       return new import_identity3.DeviceCodeCredential({
         authenticationRecord,
-        tokenCachePersistenceOptions
+        tokenCachePersistenceOptions,
+        tenantId
       });
     default:
       throw new Error(`Invalid login method: ${loginMethod}`);
   }
 }
 __name(getCredentialInternal, "getCredentialInternal");
-async function getCredential(loginMethod, cachePath) {
+async function getCredential(loginMethod, cachePath, tenantId) {
   if (loginMethod == "azure-cli") {
     return new import_identity3.AzureCliCredential();
   }
   (0, import_identity3.useIdentityPlugin)(import_identity_cache_persistence.cachePersistencePlugin);
-  let authenticationRecord = getAuthenticationRecord(cachePath);
-  const credential = getCredentialInternal(loginMethod, authenticationRecord);
-  if (!authenticationRecord) {
-    console.warn("Cloudpack requires authentication to access Azure resources.");
-    if (loginMethod == "interactive") {
-      console.warn(
-        "Prepare to sign in \u2013 we're launching a browser page for you. Simply follow the instructions on the login page to seamlessly complete the authentication process."
-      );
-    }
-    const storageScope = "https://storage.azure.com/.default";
-    authenticationRecord = await credential.authenticate(storageScope);
-    const token = await credential.getToken(storageScope);
-    const storageCustomCredential = {
-      getToken: async () => {
-        return Promise.resolve(token);
-      }
-    };
-    if (authenticationRecord) {
-      saveAuthenticationRecord(cachePath, authenticationRecord);
-    }
-    return storageCustomCredential;
+  const credential = getCredentialInternal(loginMethod, getAuthenticationRecord(cachePath), tenantId);
+  if (loginMethod == "interactive") {
+    console.warn(
+      "Prepare to sign in \u2013 we may launch a browser page for you. Simply follow the instructions on the login page to seamlessly complete the authentication process."
+    );
+  }
+  const storageScope = "https://storage.azure.com/.default";
+  const authenticationRecord = await credential.authenticate(storageScope);
+  const token = await credential.getToken(storageScope);
+  const storageCustomCredential = {
+    getToken: () => Promise.resolve(token)
+  };
+  if (authenticationRecord) {
+    saveAuthenticationRecord(cachePath, authenticationRecord);
   }
-  return credential;
+  return storageCustomCredential;
 }
 __name(getCredential, "getCredential");
 export {

package/dist/{getListOfBlobs-E5OFG2MF.js → getListOfBlobs-VRDJ4A5S.js}

@@ -1,15 +1,14 @@
 import {
   createBlobStorageUrl
-} from "./chunk-R2VDVRDZ.js";
+} from "./chunk-5BUSQ7SW.js";
 import {
   require_dist
-} from "./chunk-KFSFZYG6.js";
-import "./chunk-4P62L7ZZ.js";
+} from "./chunk-YAIY33BG.js";
 import {
   __name,
   __toESM,
   init_esbuildCjsShims
-} from "./chunk-TQLTL4XO.js";
+} from "./chunk-OPD65OLQ.js";
 
 // src/getListOfBlobs.ts
 init_esbuildCjsShims();

package/dist/index.js

@@ -1,7 +1,11 @@
+import {
+  require_dist
+} from "./chunk-YAIY33BG.js";
 import {
   __name,
+  __toESM,
   init_esbuildCjsShims
-} from "./chunk-TQLTL4XO.js";
+} from "./chunk-OPD65OLQ.js";
 
 // src/index.ts
 init_esbuildCjsShims();
@@ -78,32 +82,77 @@ var blockListIsInvalidRetryPolicy = {
 
 // src/createRemoteCacheClient.ts
 import { RetryManager } from "@ms-cloudpack/retry";
+
+// src/error/transformError.ts
+init_esbuildCjsShims();
+
+// src/error/RemoteCacheError.ts
+init_esbuildCjsShims();
+var _RemoteCacheError = class _RemoteCacheError extends Error {
+  constructor(code, message) {
+    super(message);
+    this._code = code;
+  }
+  get code() {
+    return this._code;
+  }
+};
+__name(_RemoteCacheError, "RemoteCacheError");
+var RemoteCacheError = _RemoteCacheError;
+
+// src/error/isRestError.ts
+init_esbuildCjsShims();
+var import_storage_blob = __toESM(require_dist(), 1);
+function isRestError(error) {
+  return error instanceof import_storage_blob.RestError;
+}
+__name(isRestError, "isRestError");
+
+// src/error/transformError.ts
+function transformError(error) {
+  if (isRestError(error) && error.statusCode === 401 || error instanceof Error && error.name === "AuthenticationRequiredError") {
+    return new RemoteCacheError("AUTH_ERROR", "Authentication failed. Please check your credentials and try again.");
+  }
+  if (isRestError(error) && error.code === "REQUEST_SEND_ERROR") {
+    return new RemoteCacheError("CONNECTION_ERROR", "Connection failed. Please check your connection.");
+  }
+  return error;
+}
+__name(transformError, "transformError");
+
+// src/createRemoteCacheClient.ts
 async function createRemoteCacheClient(params) {
   const { context, options } = params;
-  const { container, loginMethod, storageAccount, cachePath } = options;
-  const { getCredential } = await import("./getCredential-QMMPE77Q.js");
-  const { AzureRemoteCacheClient } = await import("./AzureRemoteCacheClient-NEV2XCF7.js");
-  const { ReporterDecorator } = await import("./ReporterDecorator-SNBYNGOT.js");
-  const { getListOfBlobs } = await import("./getListOfBlobs-E5OFG2MF.js");
-  const credential = await getCredential(loginMethod, cachePath);
-  const remoteCacheClientOptions = {
-    storageAccount,
-    container,
-    credential
-  };
-  const client = new ReporterDecorator(
-    new RetryDecorator({
-      retryManager: new RetryManager([blockListIsInvalidRetryPolicy]),
-      cacheClient: new InMemoryDecorator({
-        cacheClient: new AzureRemoteCacheClient(remoteCacheClientOptions),
-        getList: () => getListOfBlobs(remoteCacheClientOptions)
-      })
-    }),
-    context
-  );
-  return client;
+  const { container, loginMethod, storageAccount, cachePath, tenantId } = options;
+  const { getCredential } = await import("./getCredential-FIEDCLGJ.js");
+  const { AzureRemoteCacheClient } = await import("./AzureRemoteCacheClient-NBBUAAXL.js");
+  const { ReporterDecorator } = await import("./ReporterDecorator-YCOIU5LI.js");
+  const { getListOfBlobs } = await import("./getListOfBlobs-VRDJ4A5S.js");
+  try {
+    const credential = await getCredential(loginMethod, cachePath, tenantId);
+    const remoteCacheClientOptions = {
+      storageAccount,
+      container,
+      credential
+    };
+    const listOfBlobs = await getListOfBlobs(remoteCacheClientOptions);
+    const client = new ReporterDecorator(
+      new RetryDecorator({
+        retryManager: new RetryManager([blockListIsInvalidRetryPolicy]),
+        cacheClient: new InMemoryDecorator({
+          cacheClient: new AzureRemoteCacheClient(remoteCacheClientOptions),
+          getList: () => Promise.resolve(listOfBlobs)
+        })
+      }),
+      context
+    );
+    return client;
+  } catch (error) {
+    throw transformError(error);
+  }
 }
 __name(createRemoteCacheClient, "createRemoteCacheClient");
 export {
+  RemoteCacheError,
   createRemoteCacheClient
 };

package/lib/authentication/getCredential.d.ts

@@ -6,5 +6,5 @@ import type { LoginMethod } from '../types/LoginMethod.js';
  * Otherwise, it will return an InteractiveBrowserCredential or a DeviceCodeCredential with persistent token settings.
  * If an authentication record has never been saved before, it will authenticate the credential and save the authentication record.
  */
-export declare function getCredential(loginMethod: LoginMethod, cachePath: string): Promise<TokenCredential>;
+export declare function getCredential(loginMethod: LoginMethod, cachePath: string, tenantId?: string): Promise<TokenCredential>;
 //# sourceMappingURL=getCredential.d.ts.map

package/lib/createRemoteCacheClient.d.ts

@@ -8,6 +8,7 @@ export interface CreateRemoteCacheClientParams {
         container: string;
         loginMethod: LoginMethod;
         cachePath: string;
+        tenantId?: string;
     };
     context: {
         reporter: TaskReporter;

package/lib/error/RemoteCacheError.d.ts

@@ -0,0 +1,10 @@
+export type RemoteCacheErrorType = 'CONNECTION_ERROR' | 'AUTH_ERROR';
+/**
+ * An error thrown by a remote cache client.
+ */
+export declare class RemoteCacheError extends Error {
+    private _code;
+    constructor(code: RemoteCacheErrorType, message: string);
+    get code(): RemoteCacheErrorType;
+}
+//# sourceMappingURL=RemoteCacheError.d.ts.map

package/lib/error/isRestError.d.ts

@@ -0,0 +1,3 @@
+import { RestError } from '@azure/storage-blob';
+export declare function isRestError(error: unknown): error is RestError;
+//# sourceMappingURL=isRestError.d.ts.map

package/lib/error/transformError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Transforms an error into a RemoteCacheError if it is a known error type.
+ * @param error - The error to transform.
+ * @returns - The transformed error or the original error if it is not a known error type.
+ */
+export declare function transformError(error: unknown): unknown;
+//# sourceMappingURL=transformError.d.ts.map

package/lib/index.d.ts

@@ -2,4 +2,6 @@ export { createRemoteCacheClient, type CreateRemoteCacheClientParams } from './c
 export type { RemoteCacheClient, RemoteCacheClientUploadOperationOptions as RemoteCacheClientDownloadOperationOptions, RemoteCacheClientOperationOptions, RemoteCacheClientOperationResult, } from './types/RemoteCacheClient.js';
 export type { LoginMethod } from './types/LoginMethod.js';
 export type { RemoteCacheClientOptions } from './types/RemoteCacheClientOptions.js';
+export { RemoteCacheError } from './error/RemoteCacheError.js';
+export type { RemoteCacheErrorType } from './error/RemoteCacheError.js';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/remote-cache",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "Manages syncing the local Cloudpack cached assets to/from a remote storage service.",
   "license": "MIT",
   "type": "module",
@@ -29,7 +29,7 @@
   "dependencies": {
     "@azure/msal-node-extensions": "^1.0.10",
     "@ms-cloudpack/retry": "^0.1.1",
-    "@ms-cloudpack/task-reporter": "^0.12.0",
+    "@ms-cloudpack/task-reporter": "^0.13.1",
     "@ms-cloudpack/telemetry": "^0.5.1"
   },
   "devDependencies": {

package/dist/chunk-TQLTL4XO.js

@@ -1,65 +0,0 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-var __esm = (fn, res) => function __init() {
-  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
-};
-var __commonJS = (cb, mod) => function __require2() {
-  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-};
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// ../../scripts/esbuildCjsShims.js
-import { createRequire } from "node:module";
-import path from "node:path";
-import url from "node:url";
-var init_esbuildCjsShims = __esm({
-  "../../scripts/esbuildCjsShims.js"() {
-    "use strict";
-    globalThis.require = createRequire(import.meta.url);
-    globalThis.__filename = url.fileURLToPath(import.meta.url);
-    globalThis.__dirname = path.dirname(__filename);
-  }
-});
-
-export {
-  __name,
-  __require,
-  __esm,
-  __commonJS,
-  __export,
-  __toESM,
-  __toCommonJS,
-  init_esbuildCjsShims
-};