@ms-cloudpack/remote-cache 0.10.6 → 0.10.7

package/dist/{AzureRemoteCacheClient-XD7JMDG2.js → AzureRemoteCacheClient-GTJWKYFP.js}

@@ -47422,13 +47422,6 @@ var _AzureRemoteCacheClient = class _AzureRemoteCacheClient {
       cacheStorageConfig: createCacheStorageConfig(containerClient)
     };
   }
-  /**
-   * Uploads the folder to the remote cache.
-   * @param id - The unique identifier of the asset to upload.
-   * @param path - The path to the folder to upload.
-   * @param globMatches - The glob pattern to use when uploading the folder.
-   * @returns - A promise that resolves when the folder has been uploaded.
-   */
   async uploadFolder(options) {
     const { id, path, globMatches } = options;
     if (!fs.existsSync(path)) {
@@ -47437,12 +47430,6 @@ var _AzureRemoteCacheClient = class _AzureRemoteCacheClient {
     await (0, import_api.put)(path, id, this.logger, { ...this.config, outputGlob: globMatches });
     return "success";
   }
-  /**
-   * Downloads the folder from the remote cache.
-   * @param id - The unique identifier of the asset to download.
-   * @param path - The path to download the folder to.
-   * @returns - A promise that resolves when the folder has been downloaded.
-   */
   async downloadFolder(options) {
     const { id, path } = options;
     if (fs.existsSync(path)) {

package/dist/index.js

@@ -112,7 +112,7 @@ async function createRemoteCacheClient(params) {
   const { context, options } = params;
   const { container, loginMethod, storageAccount, cachePath, tenantId } = options;
   const { getCredential } = await import("./getCredential-GVAO2BWN.js");
-  const { AzureRemoteCacheClient } = await import("./AzureRemoteCacheClient-XD7JMDG2.js");
+  const { AzureRemoteCacheClient } = await import("./AzureRemoteCacheClient-GTJWKYFP.js");
   const { ReporterDecorator } = await import("./ReporterDecorator-VYNWC6CL.js");
   const { getListOfBlobs } = await import("./getListOfBlobs-EY2E5AZT.js");
   const credential = await getCredential(

package/lib/AzureRemoteCacheClient.d.ts

@@ -1,23 +1,10 @@
-import type { RemoteCacheClient, RemoteCacheClientOperationOptions, RemoteCacheClientUploadOperationOptions } from './types/RemoteCacheClient.js';
+import type { RemoteCacheClient, RemoteCacheClientOperationOptions, RemoteCacheClientOperationResult, RemoteCacheClientUploadOperationOptions } from './types/RemoteCacheClient.js';
 import type { ContainerClient } from '@azure/storage-blob';
 export declare class AzureRemoteCacheClient implements RemoteCacheClient {
     private readonly logger;
     private readonly config;
     constructor(containerClient: ContainerClient);
-    /**
-     * Uploads the folder to the remote cache.
-     * @param id - The unique identifier of the asset to upload.
-     * @param path - The path to the folder to upload.
-     * @param globMatches - The glob pattern to use when uploading the folder.
-     * @returns - A promise that resolves when the folder has been uploaded.
-     */
-    uploadFolder(options: RemoteCacheClientUploadOperationOptions): Promise<'success' | 'not-found'>;
-    /**
-     * Downloads the folder from the remote cache.
-     * @param id - The unique identifier of the asset to download.
-     * @param path - The path to download the folder to.
-     * @returns - A promise that resolves when the folder has been downloaded.
-     */
-    downloadFolder(options: RemoteCacheClientOperationOptions): Promise<'success' | 'not-found' | 'already-exist'>;
+    uploadFolder(options: RemoteCacheClientUploadOperationOptions): Promise<RemoteCacheClientOperationResult>;
+    downloadFolder(options: RemoteCacheClientOperationOptions): Promise<RemoteCacheClientOperationResult>;
 }
 //# sourceMappingURL=AzureRemoteCacheClient.d.ts.map

package/lib/types/RemoteCacheClient.d.ts

@@ -14,10 +14,25 @@ export interface RemoteCacheClientOperationOptions {
     friendlyName: string;
 }
 export interface RemoteCacheClientUploadOperationOptions extends RemoteCacheClientOperationOptions {
+    /** The glob pattern to use when uploading the folder. */
     globMatches: string[];
 }
 export interface RemoteCacheClient {
+    /**
+     * Uploads the folder to the remote cache.
+     * @returns
+     * - `'not-found'` if the path does not exist locally
+     * - `'already-exist'` if a resource with the same id already exists in the remote cache
+     * - `'success'` if the upload was successful
+     */
     uploadFolder(options: RemoteCacheClientUploadOperationOptions): Promise<RemoteCacheClientOperationResult>;
+    /**
+     * Downloads the folder from the remote cache.
+     * @returns
+     * - `'already-exist'` if the specified path already exists locally
+     * - `'not-found'` if the asset is not found in the remote cache
+     * - `'success'` if the download was successful
+     */
     downloadFolder(options: RemoteCacheClientOperationOptions): Promise<RemoteCacheClientOperationResult>;
 }
 //# sourceMappingURL=RemoteCacheClient.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/remote-cache",
-  "version": "0.10.6",
+  "version": "0.10.7",
   "description": "Manages syncing the local Cloudpack cached assets to/from a remote storage service.",
   "license": "MIT",
   "type": "module",
@@ -27,11 +27,11 @@
     "lib/**/*.d.ts"
   ],
   "dependencies": {
-    "@ms-cloudpack/common-types": "^0.24.3",
+    "@ms-cloudpack/common-types": "^0.24.4",
     "@ms-cloudpack/environment": "^0.1.1",
     "@ms-cloudpack/retry": "^0.1.3",
-    "@ms-cloudpack/task-reporter": "^0.14.8",
-    "@ms-cloudpack/telemetry": "^0.10.10",
+    "@ms-cloudpack/task-reporter": "^0.15.0",
+    "@ms-cloudpack/telemetry": "^0.10.11",
     "@napi-rs/keyring": "^1.0.0",
     "mime-types": "^2.0.0",
     "node-dpapi-prebuilt": "^1.0.3"