@ms-cloudpack/remote-cache 0.10.10 → 0.10.12

package/lib/AzureAppRegistryClient.d.ts

@@ -0,0 +1,19 @@
+import type { AppRegistration, AppRegistrationVersion } from './types/AppRegistration.js';
+import type { AppRegistryClient } from './types/AppRegistryClient.js';
+import type { PageSettings } from '@azure/core-paging';
+import type { TokenCredential } from '@azure/identity';
+import type { PagedResult } from './types/PagedResult.js';
+export declare class AzureAppRegistryClient implements AppRegistryClient {
+    readonly storageUrl: string;
+    readonly credential: TokenCredential;
+    private readonly appsTableClient;
+    private readonly appVersionsTableClient;
+    constructor(storageUrl: string, credential: TokenCredential);
+    /**
+     * Registers an application and its version details in the table storage.
+     */
+    registerApp({ name, version, description, ...rest }: AppRegistrationVersion & Pick<AppRegistration, 'description'>): Promise<void>;
+    getApps(appName?: string, pageSettings?: PageSettings): Promise<PagedResult<AppRegistration>>;
+    getVersions(appName: string, pageSettings: PageSettings): Promise<PagedResult<AppRegistrationVersion>>;
+}
+//# sourceMappingURL=AzureAppRegistryClient.d.ts.map

package/lib/createAppRegistryClient.d.ts

@@ -0,0 +1,24 @@
+import type { TaskReporter } from '@ms-cloudpack/task-reporter';
+import type { TelemetryClient } from '@ms-cloudpack/telemetry';
+import type { LoginMethod } from './types/LoginMethod.js';
+import type { RemoteCacheConfig } from '@ms-cloudpack/common-types';
+import type { AppRegistryClient } from './index.js';
+/**
+ * Parameters to create an instance of the AppRegistryClient.
+ */
+export interface CreateAppRegistryClientParams {
+    options: Partial<Pick<RemoteCacheConfig, 'storageAccount' | 'tenantId'>> & {
+        loginMethod: LoginMethod;
+        cachePath: string;
+    };
+    context: {
+        reporter: TaskReporter;
+        telemetryClient: TelemetryClient;
+    };
+}
+/**
+ * Creates an instance of the AppRegistryClient. This client is used to interact with the Azure Table Storage
+ * that holds the application registration and version details.
+ */
+export declare function createAppRegistryClient(params: CreateAppRegistryClientParams): Promise<AppRegistryClient>;
+//# sourceMappingURL=createAppRegistryClient.d.ts.map

package/lib/createStorageUrl.d.ts

@@ -0,0 +1,3 @@
+export declare function createBlobStorageUrl(storageAccount: string): string;
+export declare function createTableStorageUrl(storageAccount: string): string;
+//# sourceMappingURL=createStorageUrl.d.ts.map

package/lib/index.d.ts

@@ -1,4 +1,9 @@
 export { createRemoteCacheClient, type CreateRemoteCacheClientParams } from './createRemoteCacheClient.js';
+export { createAppRegistryClient, type CreateAppRegistryClientParams } from './createAppRegistryClient.js';
 export type { RemoteCacheClient, RemoteCacheClientUploadOperationOptions, RemoteCacheClientOperationOptions, RemoteCacheClientOperationResult, } from './types/RemoteCacheClient.js';
 export type { LoginMethod } from './types/LoginMethod.js';
+export type { AppRegistration, AppRegistrationVersion } from './types/AppRegistration.js';
+export type { AppRegistryClient } from './types/AppRegistryClient.js';
+export type { PagedResult } from './types/PagedResult.js';
+export type { PageSettings } from '@azure/core-paging';
 //# sourceMappingURL=index.d.ts.map

package/lib/types/AppRegistration.d.ts

@@ -0,0 +1,46 @@
+import type { TableEntity } from '@azure/data-tables';
+/**
+ * Represents an application registration entry.
+ */
+export type AppRegistration = {
+    /** The name of the registered application. */
+    name: string;
+    /** The latest version of the registered application. */
+    latestVersion: string;
+    /** (Optional) Description of the application version. */
+    description?: string;
+};
+/**
+ * Represents a specific version of an application registration.
+ */
+export type AppRegistrationVersion = {
+    /** The name of the registered application. */
+    name: string;
+    /** Unique resource identifier associated with the application version. */
+    resourceId: string;
+    /** Name of the Azure Storage account where the application version is stored. */
+    storageAccount: string;
+    /** Name of the container holding the application version. */
+    container: string;
+    /** (Optional) Tenant Id associated with the application version. */
+    tenantId?: string;
+    /** Name of the local bundle folder for the application version. */
+    localBundleFolderName: string;
+    /** The version of the application */
+    version: string;
+};
+/**
+ * Represents an application registration entry in the table storage.
+ *
+ * - `partitionKey`: Fixed value `'apps'`, categorizing all application registrations under a single partition.
+ * - `rowKey`: Encoded application name, ensuring uniqueness within the partition.
+ */
+export type AppRegistrationTableEntity = TableEntity<Omit<AppRegistration, 'name'>>;
+/**
+ * Represents a specific version entry of an application in the table storage.
+ *
+ * - `partitionKey`: Encoded application name, grouping all versions of an application under the same partition.
+ * - `rowKey`: Encoded identifier
+ */
+export type AppRegistrationVersionTableEntity = TableEntity<Omit<AppRegistrationVersion, 'name'>>;
+//# sourceMappingURL=AppRegistration.d.ts.map

package/lib/types/AppRegistryClient.d.ts

@@ -0,0 +1,28 @@
+import type { PageSettings } from '@azure/core-paging';
+import type { AppRegistrationVersion, AppRegistration } from './AppRegistration.js';
+import type { PagedResult } from './PagedResult.js';
+/**
+ * Client interface for managing application registrations and their versions.
+ */
+export interface AppRegistryClient {
+    /**
+     * Registers a new application version in the registry.
+     */
+    registerApp(app: AppRegistrationVersion & Pick<AppRegistration, 'description'>): Promise<void>;
+    /**
+     * Retrieves a paginated list of registered applications.
+     *
+     * @param {string} appName - The name of the application to retrieve.
+     * @param {PageSettings} paginationOptions - The pagination options.
+     * that provides access to all registered applications.
+     */
+    getApps(appName?: string, paginationOptions?: PageSettings): Promise<PagedResult<AppRegistration>>;
+    /**
+     * Retrieves a paginated list of all versions for a specific application.
+     *
+     * @param {string} appName - The name of the application.
+     * @param {PageSettings} paginationOptions - The pagination options.
+     */
+    getVersions(appName: string, paginationOptions?: PageSettings): Promise<PagedResult<AppRegistrationVersion>>;
+}
+//# sourceMappingURL=AppRegistryClient.d.ts.map

package/lib/types/PagedResult.d.ts

@@ -0,0 +1,5 @@
+export interface PagedResult<T> {
+    items: T[];
+    continuationToken?: string;
+}
+//# sourceMappingURL=PagedResult.d.ts.map

package/lib/utils/getReverseSortedTimestamp.d.ts

@@ -0,0 +1,2 @@
+export declare function getReverseSortedTimestamp(): string;
+//# sourceMappingURL=getReverseSortedTimestamp.d.ts.map

package/lib/utils/safeDecodeURIComponent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Safely decodes a string using decodeURIComponent, ensuring it is not decoded multiple times.
+ *
+ * - If the input is already decoded, it returns the original value.
+ * - If the input is encoded, it decodes it.
+ * - Handles malformed input gracefully by returning the original value if decoding fails.
+
+ * @param value - The input string to be decoded.
+ * @returns - A safely decoded string.
+ */
+export declare function safeDecodeURIComponent(value: string): string;
+//# sourceMappingURL=safeDecodeURIComponent.d.ts.map

package/lib/utils/safeEncodeURIComponent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Safely encodes a string using encodeURIComponent, ensuring it is not encoded multiple times.
+ *
+ * - If the input is already encoded, it returns the original value.
+ * - If the input is not encoded, it encodes it.
+ * - Handles malformed input gracefully by encoding it if decoding fails.
+ *
+ * @param value - The input string to be encoded.
+ * @returns - A safely encoded string.
+ */
+export declare function safeEncodeURIComponent(value: string): string;
+//# sourceMappingURL=safeEncodeURIComponent.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/remote-cache",
-  "version": "0.10.10",
+  "version": "0.10.12",
   "description": "Manages syncing the local Cloudpack cached assets to/from a remote storage service.",
   "license": "MIT",
   "type": "module",
@@ -27,16 +27,18 @@
     "lib/**/*.d.ts"
   ],
   "dependencies": {
-    "@ms-cloudpack/common-types": "^0.24.7",
+    "@ms-cloudpack/common-types": "^0.24.8",
     "@ms-cloudpack/environment": "^0.1.1",
     "@ms-cloudpack/retry": "^0.1.3",
     "@ms-cloudpack/task-reporter": "^0.15.1",
-    "@ms-cloudpack/telemetry": "^0.10.14",
+    "@ms-cloudpack/telemetry": "^0.10.15",
     "@napi-rs/keyring": "^1.0.0",
     "mime-types": "^2.0.0",
     "node-dpapi-prebuilt": "^1.0.3"
   },
   "devDependencies": {
+    "@azure/core-paging": "^1.0.0",
+    "@azure/data-tables": "^13.0.0",
     "@azure/identity": "4.3.0",
     "@azure/logger": "^1.0.0",
     "@azure/msal-common": "14.13.0",

package/lib/createBlobStorageUrl.d.ts

@@ -1,2 +0,0 @@
-export declare function createBlobStorageUrl(storageAccount: string): string;
-//# sourceMappingURL=createBlobStorageUrl.d.ts.map