@datalayer/core 0.0.12 → 0.0.13

package/lib/sdk/client/mixins/HealthMixin.js

@@ -1,133 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * @module sdk/client/mixins/HealthMixin
- * @description Health check functionality for the Datalayer SDK.
- *
- * Provides methods to check the health status of all Datalayer services.
- */
-import { iam, runtimes, spacer } from '../../../api';
-/**
- * Mixin that provides health check functionality for the SDK.
- */
-export function HealthMixin(Base) {
-    return class extends Base {
-        /**
-         * Check if the IAM service is healthy.
-         *
-         * @returns True if service is healthy, false otherwise
-         */
-        async isIAMHealthy() {
-            try {
-                await iam.healthz.ping(this.iamRunUrl);
-                return true;
-            }
-            catch {
-                return false;
-            }
-        }
-        /**
-         * Check if the Runtimes service is healthy.
-         *
-         * @returns True if service is healthy, false otherwise
-         */
-        async isRuntimesHealthy() {
-            try {
-                await runtimes.healthz.ping(this.runtimesRunUrl);
-                return true;
-            }
-            catch {
-                return false;
-            }
-        }
-        /**
-         * Check if the Spacer service is healthy.
-         *
-         * @returns True if service is healthy, false otherwise
-         */
-        async isSpacerHealthy() {
-            try {
-                await spacer.healthz.ping(this.spacerRunUrl);
-                return true;
-            }
-            catch {
-                return false;
-            }
-        }
-        /**
-         * Check if all Datalayer services are healthy.
-         *
-         * @returns True if all services are healthy, false otherwise
-         */
-        async areAllServicesHealthy() {
-            const [iamHealthy, runtimesHealthy, spacerHealthy] = await Promise.all([
-                this.isIAMHealthy(),
-                this.isRuntimesHealthy(),
-                this.isSpacerHealthy(),
-            ]);
-            return iamHealthy && runtimesHealthy && spacerHealthy;
-        }
-        /**
-         * Get detailed health status for all services.
-         *
-         * @returns Object containing health status and details for each service
-         */
-        async getHealthStatus() {
-            const [iamStatus, runtimesStatus, spacerStatus] = await Promise.allSettled([
-                iam.healthz.ping(this.iamRunUrl),
-                runtimes.healthz.ping(this.runtimesRunUrl),
-                spacer.healthz.ping(this.spacerRunUrl),
-            ]);
-            const result = {
-                iam: {
-                    healthy: false,
-                    details: undefined,
-                    error: undefined,
-                },
-                runtimes: {
-                    healthy: false,
-                    details: undefined,
-                    error: undefined,
-                },
-                spacer: {
-                    healthy: false,
-                    details: undefined,
-                    error: undefined,
-                },
-            };
-            // Process IAM status
-            if (iamStatus.status === 'fulfilled') {
-                result.iam.healthy = true;
-                result.iam.details = iamStatus.value;
-            }
-            else {
-                result.iam.error = iamStatus.reason?.message || 'Unknown error';
-            }
-            // Process Runtimes status
-            if (runtimesStatus.status === 'fulfilled') {
-                result.runtimes.healthy = true;
-                result.runtimes.details = runtimesStatus.value;
-            }
-            else {
-                result.runtimes.error =
-                    runtimesStatus.reason?.message || 'Unknown error';
-            }
-            // Process Spacer status
-            if (spacerStatus.status === 'fulfilled') {
-                result.spacer.healthy = true;
-                result.spacer.details = spacerStatus.value;
-            }
-            else {
-                result.spacer.error = spacerStatus.reason?.message || 'Unknown error';
-            }
-            return {
-                ...result,
-                allHealthy: result.iam.healthy &&
-                    result.runtimes.healthy &&
-                    result.spacer.healthy,
-            };
-        }
-    };
-}

package/lib/sdk/client/mixins/IAMMixin.d.ts

@@ -1,59 +0,0 @@
-import type { User, LoginRequest, LoginResponse } from '../../../api/types/iam';
-import type { Constructor } from '../utils/mixins';
-/**
- * IAM mixin that provides authentication and user management functionality.
- *
- */
-export declare function IAMMixin<TBase extends Constructor>(Base: TBase): {
-    new (...args: any[]): {
-        /**
-         * Get the current user's profile information.
-         *
-         * @returns Promise resolving to the current user's profile
-         *
-         * @example
-         * ```typescript
-         * const user = await sdk.whoami();
-         * console.log('Current user:', user.username);
-         * ```
-         */
-        whoami(): Promise<User>;
-        /**
-         * Authenticate a user with credentials or token.
-         *
-         * @param data - Login credentials (either handle+password or token)
-         * @returns Promise resolving to login response with tokens
-         *
-         * @example
-         * ```typescript
-         * // Login with handle and password
-         * const loginResponse = await sdk.login({
-         *   handle: 'user@example.com',
-         *   password: 'secure-password'
-         * });
-         *
-         * // Or login with token
-         * const tokenResponse = await sdk.login({
-         *   token: 'existing-auth-token'
-         * });
-         *
-         * // Update SDK with new token
-         * sdk.updateToken(loginResponse.token);
-         * ```
-         */
-        login(data: LoginRequest): Promise<LoginResponse>;
-        /**
-         * Log out the current user.
-         *
-         * This method performs a logout operation on the server and clears
-         * the authentication token from the SDK.
-         *
-         * @example
-         * ```typescript
-         * await sdk.logout();
-         * console.log('User logged out successfully');
-         * ```
-         */
-        logout(): Promise<void>;
-    };
-} & TBase;

package/lib/sdk/client/mixins/IAMMixin.js

@@ -1,83 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * @module sdk/client/mixins/IAMMixin
- * @description IAM (Identity and Access Management) mixin for the Datalayer SDK.
- *
- * This mixin provides intuitive authentication and user management methods
- * that are mixed into the main DatalayerSDK class.
- */
-import { authentication, profile } from '../../../api/iam';
-/**
- * IAM mixin that provides authentication and user management functionality.
- *
- */
-export function IAMMixin(Base) {
-    return class extends Base {
-        /**
-         * Get the current user's profile information.
-         *
-         * @returns Promise resolving to the current user's profile
-         *
-         * @example
-         * ```typescript
-         * const user = await sdk.whoami();
-         * console.log('Current user:', user.username);
-         * ```
-         */
-        async whoami() {
-            const token = this.getToken();
-            const iamRunUrl = this.getIamRunUrl();
-            const response = await profile.me(token, iamRunUrl);
-            return response.me;
-        }
-        /**
-         * Authenticate a user with credentials or token.
-         *
-         * @param data - Login credentials (either handle+password or token)
-         * @returns Promise resolving to login response with tokens
-         *
-         * @example
-         * ```typescript
-         * // Login with handle and password
-         * const loginResponse = await sdk.login({
-         *   handle: 'user@example.com',
-         *   password: 'secure-password'
-         * });
-         *
-         * // Or login with token
-         * const tokenResponse = await sdk.login({
-         *   token: 'existing-auth-token'
-         * });
-         *
-         * // Update SDK with new token
-         * sdk.updateToken(loginResponse.token);
-         * ```
-         */
-        async login(data) {
-            const iamRunUrl = this.getIamRunUrl();
-            return await authentication.login(data, iamRunUrl);
-        }
-        /**
-         * Log out the current user.
-         *
-         * This method performs a logout operation on the server and clears
-         * the authentication token from the SDK.
-         *
-         * @example
-         * ```typescript
-         * await sdk.logout();
-         * console.log('User logged out successfully');
-         * ```
-         */
-        async logout() {
-            const token = this.getToken();
-            const iamRunUrl = this.getIamRunUrl();
-            await authentication.logout(token, iamRunUrl);
-            // Clear the token from the SDK
-            this.updateToken('');
-        }
-    };
-}

package/lib/sdk/client/mixins/RuntimesMixin.d.ts

@@ -1,134 +0,0 @@
-import type { Environment, CreateRuntimeRequest, CreateRuntimeSnapshotRequest } from '../../../api/types/runtimes';
-import type { Constructor } from '../utils/mixins';
-import { Runtime } from '../models/Runtime';
-import { Snapshot } from '../models/Snapshot';
-/**
- * Runtimes mixin that provides computational environment and runtime management.
- *
- * This mixin is applied to the DatalayerSDK class to provide clean, intuitive
- * methods for managing environments and runtimes.
- */
-export declare function RuntimesMixin<TBase extends Constructor>(Base: TBase): {
-    new (...args: any[]): {
-        _extractRuntimePodName(runtimePodNameOrInstance: string | Runtime): string;
-        _extractSnapshotId(snapshotIdOrInstance: string | Snapshot): string;
-        /**
-         * List all available computational environments.
-         *
-         * @returns Promise resolving to array of environments
-         *
-         * @example
-         * ```typescript
-         * const environments = await sdk.listEnvironments();
-         * console.log('Available environments:', environments.length);
-         * ```
-         */
-        listEnvironments(): Promise<Environment[]>;
-        /**
-         * Create a new computational runtime.
-         *
-         * @param data - Runtime creation parameters
-         * @returns Promise resolving to created runtime
-         *
-         * @example
-         * ```typescript
-         * const runtime = await sdk.createRuntime({
-         *   environment_name: 'python-cpu-env',
-         *   credits_limit: 100
-         * });
-         * console.log('Runtime created:', runtime.podName);
-         * ```
-         */
-        createRuntime(data: CreateRuntimeRequest): Promise<Runtime>;
-        /**
-         * List all runtimes.
-         *
-         * @returns Promise resolving to array of runtimes
-         *
-         * @example
-         * ```typescript
-         * const allRuntimes = await sdk.listRuntimes();
-         * console.log('Total runtimes:', allRuntimes.length);
-         * ```
-         */
-        listRuntimes(): Promise<Runtime[]>;
-        /**
-         * Get details for a specific runtime by pod name or Runtime instance.
-         *
-         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
-         * @returns Promise resolving to runtime details
-         *
-         * @example
-         * ```typescript
-         * const runtime = await sdk.getRuntime('runtime-abc123');
-         * const refreshed = await sdk.getRuntime(runtime);
-         * ```
-         */
-        getRuntime(podNameOrRuntime: string | Runtime): Promise<Runtime>;
-        /**
-         * Delete a runtime permanently.
-         *
-         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
-         *
-         * @example
-         * ```typescript
-         * await sdk.deleteRuntime('runtime-abc123');
-         * await sdk.deleteRuntime(runtime);
-         * ```
-         */
-        deleteRuntime(podNameOrRuntime: string | Runtime): Promise<void>;
-        /**
-         * Create a snapshot of a runtime.
-         *
-         * @param data - Snapshot creation parameters
-         * @returns Promise resolving to created snapshot
-         *
-         * @example
-         * ```typescript
-         * const snapshot = await sdk.createSnapshot({
-         *   pod_name: 'runtime-abc123',
-         *   name: 'my-checkpoint',
-         *   description: 'Before major changes'
-         * });
-         * ```
-         */
-        createSnapshot(data: CreateRuntimeSnapshotRequest): Promise<Snapshot>;
-        /**
-         * List all runtime snapshots.
-         *
-         * @returns Promise resolving to array of snapshots
-         *
-         * @example
-         * ```typescript
-         * const allSnapshots = await sdk.listSnapshots();
-         * console.log('Total snapshots:', allSnapshots.length);
-         * ```
-         */
-        listSnapshots(): Promise<Snapshot[]>;
-        /**
-         * Get details for a specific snapshot by ID or Snapshot instance.
-         *
-         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
-         * @returns Promise resolving to snapshot details
-         *
-         * @example
-         * ```typescript
-         * const snapshot = await sdk.getSnapshot('snapshot-abc123');
-         * const refreshed = await sdk.getSnapshot(snapshot);
-         * ```
-         */
-        getSnapshot(idOrSnapshot: string | Snapshot): Promise<Snapshot>;
-        /**
-         * Delete a snapshot permanently.
-         *
-         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
-         *
-         * @example
-         * ```typescript
-         * await sdk.deleteSnapshot('snapshot-abc123');
-         * await sdk.deleteSnapshot(snapshot);
-         * ```
-         */
-        deleteSnapshot(idOrSnapshot: string | Snapshot): Promise<void>;
-    };
-} & TBase;

package/lib/sdk/client/mixins/RuntimesMixin.js

@@ -1,221 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * @module sdk/client/mixins/RuntimesMixin
- * @description Runtimes mixin for the Datalayer SDK.
- *
- * This mixin provides intuitive methods for managing computational environments,
- * runtimes, and snapshots that are mixed into the main DatalayerSDK class.
- */
-import { environments, runtimes, snapshots } from '../../../api/runtimes';
-import { Runtime } from '../models/Runtime';
-import { Snapshot } from '../models/Snapshot';
-/**
- * Runtimes mixin that provides computational environment and runtime management.
- *
- * This mixin is applied to the DatalayerSDK class to provide clean, intuitive
- * methods for managing environments and runtimes.
- */
-export function RuntimesMixin(Base) {
-    return class extends Base {
-        // ========================================================================
-        // Helper Functions
-        // ========================================================================
-        _extractRuntimePodName(runtimePodNameOrInstance) {
-            return typeof runtimePodNameOrInstance === 'string'
-                ? runtimePodNameOrInstance
-                : runtimePodNameOrInstance.podName;
-        }
-        _extractSnapshotId(snapshotIdOrInstance) {
-            return typeof snapshotIdOrInstance === 'string'
-                ? snapshotIdOrInstance
-                : snapshotIdOrInstance.uid;
-        }
-        // ========================================================================
-        // Environments
-        // ========================================================================
-        /**
-         * List all available computational environments.
-         *
-         * @returns Promise resolving to array of environments
-         *
-         * @example
-         * ```typescript
-         * const environments = await sdk.listEnvironments();
-         * console.log('Available environments:', environments.length);
-         * ```
-         */
-        async listEnvironments() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await environments.listEnvironments(token, runtimesRunUrl);
-            return response.environments;
-        }
-        // ========================================================================
-        // Runtimes
-        // ========================================================================
-        /**
-         * Create a new computational runtime.
-         *
-         * @param data - Runtime creation parameters
-         * @returns Promise resolving to created runtime
-         *
-         * @example
-         * ```typescript
-         * const runtime = await sdk.createRuntime({
-         *   environment_name: 'python-cpu-env',
-         *   credits_limit: 100
-         * });
-         * console.log('Runtime created:', runtime.podName);
-         * ```
-         */
-        async createRuntime(data) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await runtimes.createRuntime(token, data, runtimesRunUrl);
-            return new Runtime(response.runtime, this);
-        }
-        /**
-         * List all runtimes.
-         *
-         * @returns Promise resolving to array of runtimes
-         *
-         * @example
-         * ```typescript
-         * const allRuntimes = await sdk.listRuntimes();
-         * console.log('Total runtimes:', allRuntimes.length);
-         * ```
-         */
-        async listRuntimes() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await runtimes.listRuntimes(token, runtimesRunUrl);
-            return response.runtimes.map(r => new Runtime(r, this));
-        }
-        /**
-         * Get details for a specific runtime by pod name or Runtime instance.
-         *
-         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
-         * @returns Promise resolving to runtime details
-         *
-         * @example
-         * ```typescript
-         * const runtime = await sdk.getRuntime('runtime-abc123');
-         * const refreshed = await sdk.getRuntime(runtime);
-         * ```
-         */
-        async getRuntime(podNameOrRuntime) {
-            const podName = this._extractRuntimePodName(podNameOrRuntime);
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const runtimeData = await runtimes.getRuntime(token, podName, runtimesRunUrl);
-            return new Runtime(runtimeData, this);
-        }
-        /**
-         * Delete a runtime permanently.
-         *
-         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
-         *
-         * @example
-         * ```typescript
-         * await sdk.deleteRuntime('runtime-abc123');
-         * await sdk.deleteRuntime(runtime);
-         * ```
-         */
-        async deleteRuntime(podNameOrRuntime) {
-            const podName = this._extractRuntimePodName(podNameOrRuntime);
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            await runtimes.deleteRuntime(token, podName, runtimesRunUrl);
-            // If a Runtime instance was passed, mark it as deleted
-            if (typeof podNameOrRuntime !== 'string' &&
-                podNameOrRuntime instanceof Runtime) {
-                podNameOrRuntime._deleted = true;
-            }
-        }
-        // ========================================================================
-        // Snapshots
-        // ========================================================================
-        /**
-         * Create a snapshot of a runtime.
-         *
-         * @param data - Snapshot creation parameters
-         * @returns Promise resolving to created snapshot
-         *
-         * @example
-         * ```typescript
-         * const snapshot = await sdk.createSnapshot({
-         *   pod_name: 'runtime-abc123',
-         *   name: 'my-checkpoint',
-         *   description: 'Before major changes'
-         * });
-         * ```
-         */
-        async createSnapshot(data) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await snapshots.createSnapshot(token, data, runtimesRunUrl);
-            return new Snapshot(response.snapshot, this);
-        }
-        /**
-         * List all runtime snapshots.
-         *
-         * @returns Promise resolving to array of snapshots
-         *
-         * @example
-         * ```typescript
-         * const allSnapshots = await sdk.listSnapshots();
-         * console.log('Total snapshots:', allSnapshots.length);
-         * ```
-         */
-        async listSnapshots() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await snapshots.listSnapshots(token, runtimesRunUrl);
-            return response.snapshots.map(s => new Snapshot(s, this));
-        }
-        /**
-         * Get details for a specific snapshot by ID or Snapshot instance.
-         *
-         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
-         * @returns Promise resolving to snapshot details
-         *
-         * @example
-         * ```typescript
-         * const snapshot = await sdk.getSnapshot('snapshot-abc123');
-         * const refreshed = await sdk.getSnapshot(snapshot);
-         * ```
-         */
-        async getSnapshot(idOrSnapshot) {
-            const snapshotId = this._extractSnapshotId(idOrSnapshot);
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await snapshots.getSnapshot(token, snapshotId, runtimesRunUrl);
-            return new Snapshot(response.snapshot, this);
-        }
-        /**
-         * Delete a snapshot permanently.
-         *
-         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
-         *
-         * @example
-         * ```typescript
-         * await sdk.deleteSnapshot('snapshot-abc123');
-         * await sdk.deleteSnapshot(snapshot);
-         * ```
-         */
-        async deleteSnapshot(idOrSnapshot) {
-            const snapshotId = this._extractSnapshotId(idOrSnapshot);
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            await snapshots.deleteSnapshot(token, snapshotId, runtimesRunUrl);
-            // If a Snapshot instance was passed, mark it as deleted
-            if (typeof idOrSnapshot !== 'string' &&
-                idOrSnapshot instanceof Snapshot) {
-                idOrSnapshot._deleted = true;
-            }
-        }
-    };
-}