@datalayer/core 1.0.25 → 1.1.43

package/lib/api/spacer/notebooks.js

@@ -1,89 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Jupyter notebooks API functions for the Datalayer platform.
- *
- * Provides functions for creating and retrieving Jupyter notebooks within workspaces.
- *
- * @module api/spacer/notebooks
- */
-import { requestDatalayerAPI } from '../DatalayerApi.js';
-import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
-/**
- * Create a new Jupyter notebook.
- * @param token - Authentication token
- * @param data - Notebook creation configuration
- * @param baseUrl - Base URL for the API (defaults to production)
- * @returns Promise resolving to the created notebook response
- */
-export const createNotebook = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    // Create FormData for multipart/form-data request (like the working example)
-    const formData = new FormData();
-    formData.append('spaceId', data.spaceId);
-    formData.append('name', data.name);
-    formData.append('notebookType', data.notebookType || 'jupyter'); // Required field
-    formData.append('description', data.description || ''); // Required field - can be empty
-    // Add file if provided
-    if (data.file) {
-        if (data.file instanceof File) {
-            formData.append('file', data.file, data.file.name);
-        }
-        else {
-            // Handle Blob case
-            formData.append('file', data.file, `${data.name}.ipynb`);
-        }
-    }
-    const url = `${baseUrl}${API_BASE_PATHS.SPACER}/notebooks`;
-    return requestDatalayerAPI({
-        url,
-        method: 'POST',
-        token,
-        body: formData,
-    });
-};
-/**
- * Get a notebook by ID.
- * @param token - Authentication token
- * @param id - The notebook ID
- * @param baseUrl - Base URL for the API (defaults to production)
- * @returns Promise resolving to the notebook response
- */
-export const getNotebook = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/notebooks/${id}`,
-        method: 'GET',
-        token,
-    });
-};
-/**
- * Update a notebook.
- * @param token - Authentication token
- * @param id - The notebook ID
- * @param data - Update data containing name and/or description
- * @param baseUrl - Base URL for the API (defaults to production)
- * @returns Promise resolving to the updated notebook response
- */
-export const updateNotebook = async (token, id, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/notebooks/${id}`,
-        method: 'PUT',
-        token,
-        body: data,
-    });
-};
-/**
- * Clone a notebook.
- * @param token - Authentication token
- * @param id - The notebook ID to clone
- * @param baseUrl - Base URL for the API (defaults to production)
- * @returns Promise resolving to the cloned notebook response
- */
-export const cloneNotebook = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
-    return requestDatalayerAPI({
-        url: `${baseUrl}${API_BASE_PATHS.SPACER}/notebooks/${id}/clone`,
-        method: 'POST',
-        token,
-    });
-};

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

@@ -1,84 +0,0 @@
-import { CreateSpaceRequest, CreateSpaceResponse, GetSpaceResponse, UpdateSpaceRequest, UpdateSpaceResponse, DeleteSpaceResponse, GetSpaceDefaultItemsResponse, GetSpacesByTypeResponse } from '../../models/SpaceDTO';
-/**
- * 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 declare const createSpace: (token: string, data: CreateSpaceRequest, baseUrl?: string) => Promise<CreateSpaceResponse>;
-/**
- * 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 declare const getSpace: (token: string, uid: string, baseUrl?: string) => Promise<GetSpaceResponse>;
-/**
- * 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 declare const updateSpace: (token: string, uid: string, data: UpdateSpaceRequest, baseUrl?: string) => Promise<UpdateSpaceResponse>;
-/**
- * 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 declare const updateUserSpace: (token: string, uid: string, userId: string, data: UpdateSpaceRequest, baseUrl?: string) => Promise<UpdateSpaceResponse>;
-/**
- * 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 declare const deleteSpace: (token: string, uid: string, baseUrl?: string) => Promise<DeleteSpaceResponse>;
-/**
- * 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 declare const getSpaceDefaultItems: (token: string, uid: string, baseUrl?: string) => Promise<GetSpaceDefaultItemsResponse>;
-/**
- * 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 declare const getSpacesByType: (token: string, type: string, baseUrl?: string) => Promise<GetSpacesByTypeResponse>;
-/**
- * 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 declare const makeSpacePublic: (token: string, uid: string, baseUrl?: string) => Promise<UpdateSpaceResponse>;
-/**
- * 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 declare const makeSpacePrivate: (token: string, uid: string, baseUrl?: string) => Promise<UpdateSpaceResponse>;
-/**
- * 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 declare const exportSpace: (token: string, uid: string, baseUrl?: string) => Promise<any>;

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;