@datalayer/core 1.0.25 → 1.1.41

package/lib/api/spacer/spaces.js

@@ -1,170 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Workspace spaces API functions for the Datalayer platform.
- *
- * Provides function for creating workspace spaces.
- *
- * @module api/spacer/spaces
- */
-import { requestDatalayerAPI } from '../DatalayerApi.js';
-import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
-import { validateToken } from '../utils/validation.js';
-/**
- * Create a new workspace space.
- * @param token - Authentication token
- * @param data - Space creation configuration
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the created space response
- */
-export const createSpace = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces`,
-        method: 'POST',
-        token,
-        body: data,
-    });
-};
-/**
- * Get a space by UID.
- * @param token - Authentication token
- * @param uid - Space UID
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the space response
- */
-export const getSpace = async (token, uid, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}`,
-        method: 'GET',
-        token,
-    });
-};
-/**
- * Update a space (owner updating their own space).
- * @param token - Authentication token
- * @param uid - Space UID
- * @param data - Update data (supports arbitrary Solr fields)
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the updated space response
- */
-export const updateSpace = async (token, uid, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}`,
-        method: 'PUT',
-        token,
-        body: data,
-    });
-};
-/**
- * Update a user-specific space (e.g., org admin managing another user's space).
- * @param token - Authentication token
- * @param uid - Space UID
- * @param userId - User ID
- * @param data - Update data (supports arbitrary Solr fields)
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the updated space response
- */
-export const updateUserSpace = async (token, uid, userId, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}/users/${userId}`,
-        method: 'PUT',
-        token,
-        body: data,
-    });
-};
-/**
- * Delete a space and all its contents.
- * @param token - Authentication token
- * @param uid - Space UID
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the delete response
- */
-export const deleteSpace = async (token, uid, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}`,
-        method: 'DELETE',
-        token,
-    });
-};
-/**
- * Get default items (notebook UID and document UID) for a space.
- * @param token - Authentication token
- * @param uid - Space UID
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the default items response
- */
-export const getSpaceDefaultItems = async (token, uid, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}/default-items`,
-        method: 'GET',
-        token,
-    });
-};
-/**
- * Get spaces by type (e.g., 'project', 'workspace', 'course').
- * @param token - Authentication token
- * @param type - Space type to filter by
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the spaces response
- */
-export const getSpacesByType = async (token, type, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/types/${type}`,
-        method: 'GET',
-        token,
-    });
-};
-/**
- * Make a space public.
- * @param token - Authentication token
- * @param uid - Space UID
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the updated space response
- */
-export const makeSpacePublic = async (token, uid, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}/public`,
-        method: 'PUT',
-        token,
-    });
-};
-/**
- * Make a space private.
- * @param token - Authentication token
- * @param uid - Space UID
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the updated space response
- */
-export const makeSpacePrivate = async (token, uid, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}/private`,
-        method: 'PUT',
-        token,
-    });
-};
-/**
- * Export a space and its contents.
- * @param token - Authentication token
- * @param uid - Space UID
- * @param baseUrl - Base URL for the API
- * @returns Promise resolving to the export data
- */
-export const exportSpace = async (token, uid, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${uid}/export`,
-        method: 'GET',
-        token,
-    });
-};

package/lib/api/spacer/users.d.ts

@@ -1,9 +0,0 @@
-import { SpacesForUserResponse } from '../../models/SpaceDTO';
-/**
- * Get all spaces for the current authenticated user.
- * @param token - Authentication token
- * @param baseUrl - Base URL for the API (defaults to production Spacer URL)
- * @returns Promise resolving to the user's spaces
- * @throws {Error} If authentication token is missing or invalid
- */
-export declare const getMySpaces: (token: string, baseUrl?: string) => Promise<SpacesForUserResponse>;

package/lib/api/spacer/users.js

@@ -1,29 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * User-related Spacer API functions for the Datalayer platform.
- *
- * Provides functions for user-specific operations in the Spacer service.
- *
- * @module api/spacer/users
- */
-import { requestDatalayerAPI } from '../DatalayerApi.js';
-import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
-import { validateToken } from '../utils/validation.js';
-/**
- * Get all spaces for the current authenticated user.
- * @param token - Authentication token
- * @param baseUrl - Base URL for the API (defaults to production Spacer URL)
- * @returns Promise resolving to the user's spaces
- * @throws {Error} If authentication token is missing or invalid
- */
-export const getMySpaces = async (token, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    validateToken(token);
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/users/me`,
-        method: 'GET',
-        token,
-    });
-};

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

@@ -1,93 +0,0 @@
-import type { Constructor } from '../utils/mixins';
-import { EnvironmentDTO } from '../../models/EnvironmentDTO';
-import { RuntimeDTO } from '../../models/RuntimeDTO';
-import { CodeSandboxSnapshotDTO } from '../../models/CodeSandboxSnapshotDTO';
-import { HealthCheck } from '../../models/HealthCheck';
-/** Options for ensuring a runtime is available. */
-export interface EnsureRuntimeOptions {
-    /** Name of the environment to use */
-    environmentName?: string;
-    /** Maximum credits to allocate */
-    creditsLimit?: number;
-    /** Whether to wait for runtime to be ready */
-    waitForReady?: boolean;
-    /** Maximum time to wait for ready state (ms) */
-    maxWaitTime?: number;
-    /** Whether to reuse existing suitable runtime */
-    reuseExisting?: boolean;
-    /** Snapshot ID to create runtime from */
-    snapshotId?: string;
-}
-/** Runtimes mixin providing computational environment and runtime management. */
-export declare function RuntimesMixin<TBase extends Constructor>(Base: TBase): {
-    new (...args: any[]): {
-        _extractRuntimePodName(runtimePodNameOrInstance: string | RuntimeDTO): string;
-        _extractSnapshotId(snapshotIdOrInstance: string | CodeSandboxSnapshotDTO): string;
-        /**
-         * List all available computational environments.
-         * @returns Array of Environment model instances
-         */
-        listEnvironments(): Promise<EnvironmentDTO[]>;
-        /**
-         * Create a new computational runtime.
-         * @param environmentName - Name of the environment to use
-         * @param type - Type of runtime
-         * @param givenName - User-friendly name for the runtime
-         * @param creditsLimit - Credits limit
-         * @returns Created runtime
-         */
-        createRuntime(environmentName: string, type: "notebook" | "terminal" | "job", givenName: string, minutesLimit: number, fromSnapshotId?: string): Promise<RuntimeDTO>;
-        /**
-         * List all runtimes.
-         * @returns Array of runtimes
-         */
-        listRuntimes(): Promise<RuntimeDTO[]>;
-        /**
-         * Get details for a specific runtime by pod name.
-         * @param podName - Runtime pod name
-         * @returns Runtime details
-         */
-        getRuntime(podName: string): Promise<RuntimeDTO>;
-        /**
-         * Delete a runtime permanently.
-         * @param podName - Runtime pod name
-         */
-        deleteRuntime(podName: string): Promise<void>;
-        /**
-         * Terminate all runtimes.
-         * Lists all runtimes and deletes them in parallel.
-         * @returns Array of results for each deletion (fulfilled or rejected)
-         */
-        terminateAllRuntimes(): Promise<PromiseSettledResult<void>[]>;
-        /**
-         * Create a snapshot of a runtime.
-         * @param podName - Pod name of the runtime to snapshot
-         * @param name - Name for the snapshot
-         * @param description - Description of the snapshot
-         * @param stop - Whether to stop the runtime after creating snapshot (defaults to false)
-         * @returns Created snapshot
-         */
-        createSnapshot(podName: string, name: string, description: string, stop?: boolean): Promise<CodeSandboxSnapshotDTO>;
-        /**
-         * List all code sandbox snapshots.
-         * @returns Array of snapshots
-         */
-        listSnapshots(): Promise<CodeSandboxSnapshotDTO[]>;
-        /**
-         * Get details for a specific snapshot by ID.
-         * @param id - Snapshot ID
-         * @returns Snapshot details
-         */
-        getSnapshot(id: string): Promise<CodeSandboxSnapshotDTO>;
-        /**
-         * Delete a snapshot permanently.
-         * @param id - Snapshot ID
-         */
-        deleteSnapshot(id: string): Promise<void>;
-        /**
-         * Check the health status of the Runtimes service.
-         * @returns Health check result with status and response time
-         */
-        checkRuntimesHealth(): Promise<HealthCheck>;
-    };
-} & TBase;

package/lib/client/mixins/RuntimesMixin.js

@@ -1,229 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Runtimes mixin for managing computational environments and runtime instances.
- * @module client/mixins/RuntimesMixin
- */
-import * as environments from '../../api/runtimes/environments.js';
-import * as runtimes from '../../api/runtimes/runtimes.js';
-import * as snapshots from '../../api/runtimes/snapshots.js';
-import { EnvironmentDTO } from '../../models/EnvironmentDTO.js';
-import { RuntimeDTO } from '../../models/RuntimeDTO.js';
-import { CodeSandboxSnapshotDTO } from '../../models/CodeSandboxSnapshotDTO.js';
-import { HealthCheck } from '../../models/HealthCheck.js';
-/** Runtimes mixin providing computational environment and runtime management. */
-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 Array of Environment model instances
-         */
-        async listEnvironments() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await environments.listEnvironments(token, runtimesRunUrl);
-            // Save for later use after first call
-            this.environments = response.environments.map(env => new EnvironmentDTO(env, this));
-            return this.environments;
-        }
-        // ========================================================================
-        // Runtimes
-        // ========================================================================
-        /**
-         * Create a new computational runtime.
-         * @param environmentName - Name of the environment to use
-         * @param type - Type of runtime
-         * @param givenName - User-friendly name for the runtime
-         * @param creditsLimit - Credits limit
-         * @returns Created runtime
-         */
-        async createRuntime(environmentName, type, givenName, minutesLimit, fromSnapshotId) {
-            if (!this.environments) {
-                await this.listEnvironments();
-            }
-            if (this.environments) {
-                const env = this.environments.find((e) => e.name === environmentName);
-                if (!env) {
-                    throw new Error(`Environment "${environmentName}" not found. Available environments: ${this.environments.map((e) => e.name).join(', ')}`);
-                }
-                else {
-                    const token = this.getToken();
-                    const runtimesRunUrl = this.getRuntimesRunUrl();
-                    const creditsLimit = this.calculateCreditsFromMinutes(minutesLimit, env.burningRate);
-                    const data = {
-                        environment_name: environmentName,
-                        type,
-                        given_name: givenName,
-                        credits_limit: creditsLimit,
-                        from: fromSnapshotId,
-                    };
-                    const response = await runtimes.createRuntime(token, data, runtimesRunUrl);
-                    return new RuntimeDTO(response.runtime, this);
-                }
-            }
-            else {
-                throw new Error('Environments not loaded');
-            }
-        }
-        /**
-         * List all runtimes.
-         * @returns Array of runtimes
-         */
-        async listRuntimes() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await runtimes.listRuntimes(token, runtimesRunUrl);
-            return response.runtimes.map(r => new RuntimeDTO(r, this));
-        }
-        /**
-         * Get details for a specific runtime by pod name.
-         * @param podName - Runtime pod name
-         * @returns Runtime details
-         */
-        async getRuntime(podName) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const runtimeData = await runtimes.getRuntime(token, podName, runtimesRunUrl);
-            return new RuntimeDTO(runtimeData, this);
-        }
-        /**
-         * Delete a runtime permanently.
-         * @param podName - Runtime pod name
-         */
-        async deleteRuntime(podName) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            await runtimes.deleteRuntime(token, podName, runtimesRunUrl);
-        }
-        /**
-         * Terminate all runtimes.
-         * Lists all runtimes and deletes them in parallel.
-         * @returns Array of results for each deletion (fulfilled or rejected)
-         */
-        async terminateAllRuntimes() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            // List all runtimes
-            const response = await runtimes.listRuntimes(token, runtimesRunUrl);
-            // Delete all runtimes in parallel
-            const deletePromises = response.runtimes.map(runtime => runtimes.deleteRuntime(token, runtime.pod_name, runtimesRunUrl));
-            return Promise.allSettled(deletePromises);
-        }
-        // ========================================================================
-        // Snapshots
-        // ========================================================================
-        /**
-         * Create a snapshot of a runtime.
-         * @param podName - Pod name of the runtime to snapshot
-         * @param name - Name for the snapshot
-         * @param description - Description of the snapshot
-         * @param stop - Whether to stop the runtime after creating snapshot (defaults to false)
-         * @returns Created snapshot
-         */
-        async createSnapshot(podName, name, description, stop = false) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const data = {
-                pod_name: podName,
-                name,
-                description,
-                stop,
-            };
-            const response = await snapshots.createSnapshot(token, data, runtimesRunUrl);
-            return new CodeSandboxSnapshotDTO(response.snapshot, this);
-        }
-        /**
-         * List all code sandbox snapshots.
-         * @returns Array of snapshots
-         */
-        async listSnapshots() {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await snapshots.listSnapshots(token, runtimesRunUrl);
-            return response.snapshots.map(s => new CodeSandboxSnapshotDTO(s, this));
-        }
-        /**
-         * Get details for a specific snapshot by ID.
-         * @param id - Snapshot ID
-         * @returns Snapshot details
-         */
-        async getSnapshot(id) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            const response = await snapshots.getSnapshot(token, id, runtimesRunUrl);
-            return new CodeSandboxSnapshotDTO(response.snapshot, this);
-        }
-        /**
-         * Delete a snapshot permanently.
-         * @param id - Snapshot ID
-         */
-        async deleteSnapshot(id) {
-            const token = this.getToken();
-            const runtimesRunUrl = this.getRuntimesRunUrl();
-            await snapshots.deleteSnapshot(token, id, runtimesRunUrl);
-        }
-        // ========================================================================
-        // Service Health Checks
-        // ========================================================================
-        /**
-         * Check the health status of the Runtimes service.
-         * @returns Health check result with status and response time
-         */
-        async checkRuntimesHealth() {
-            const startTime = Date.now();
-            const errors = [];
-            let status = 'unknown';
-            let healthy = false;
-            try {
-                // Test basic connectivity by listing environments (lightweight operation)
-                const environments = await this.listEnvironments();
-                const responseTime = Date.now() - startTime;
-                if (Array.isArray(environments)) {
-                    healthy = true;
-                    status = 'operational';
-                }
-                else {
-                    status = 'degraded';
-                    errors.push('Unexpected response format from environments endpoint');
-                }
-                return new HealthCheck({
-                    healthy,
-                    status,
-                    responseTime,
-                    errors,
-                    timestamp: new Date(),
-                }, this);
-            }
-            catch (error) {
-                const responseTime = Date.now() - startTime;
-                status = 'down';
-                errors.push(`Service unreachable: ${error}`);
-                return new HealthCheck({
-                    healthy: false,
-                    status,
-                    responseTime,
-                    errors,
-                    timestamp: new Date(),
-                }, this);
-            }
-        }
-    };
-}