@datalayer/core 1.0.25 → 1.1.41

package/lib/models/CodeSandboxSnapshotDTO.js

@@ -1,139 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { snapshots } from '../api/runtimes/index.js';
-import { validateJSON } from '../api/utils/validation.js';
-/**
- * Snapshot domain model that wraps API responses with convenient methods.
- * Provides code sandbox snapshot management with data refresh and lifecycle operations.
- *
- * @example
- * ```typescript
- * const snapshot = await runtime.createSnapshot('my-checkpoint');
- * const runtime = await snapshot.restore();
- * ```
- */
-export class CodeSandboxSnapshotDTO {
-    _data;
-    _client;
-    _deleted = false;
-    /**
-     * Create a Code Sandbox Snapshot instance.
-     *
-     * @param data - Snapshot data from API
-     * @param client - Client instance
-     */
-    constructor(data, client) {
-        this._data = data;
-        this._client = client;
-    }
-    // ========================================================================
-    // Helper Methods
-    // ========================================================================
-    /**
-     * Check if this snapshot has been deleted and throw error if so.
-     * @throws Error if deleted
-     */
-    _checkDeleted() {
-        if (this._deleted) {
-            throw new Error(`Snapshot ${this._data.uid} has been deleted and no longer exists`);
-        }
-    }
-    // ========================================================================
-    // Static Properties (set at creation, never change)
-    // ========================================================================
-    /** Unique identifier for the snapshot. */
-    get uid() {
-        this._checkDeleted();
-        return this._data.uid;
-    }
-    /** Name of the snapshot. */
-    get name() {
-        this._checkDeleted();
-        return this._data.name;
-    }
-    /** Description of the snapshot. */
-    get description() {
-        this._checkDeleted();
-        return this._data.description || '';
-    }
-    /** Name of the environment used by the runtime. */
-    get environment() {
-        this._checkDeleted();
-        return this._data.environment;
-    }
-    /** When the snapshot was last updated. */
-    get updatedAt() {
-        this._checkDeleted();
-        return new Date(this._data.updated_at);
-    }
-    // ========================================================================
-    // Action Methods
-    // ========================================================================
-    /**
-     * Delete this snapshot permanently.
-     * After deletion, subsequent calls to dynamic methods will throw errors.
-     */
-    async delete() {
-        this._checkDeleted();
-        const token = this._client.getToken();
-        const runtimesRunUrl = this._client.getRuntimesRunUrl();
-        await snapshots.deleteSnapshot(token, this.uid, runtimesRunUrl);
-        this._deleted = true;
-    }
-    /**
-     * Create a code sandbox from this snapshot (restore functionality).
-     *
-     * @param minutesLimit - Time limit in minutes for the restored runtime
-     * @returns Created Runtime instance
-     */
-    async restore(minutesLimit) {
-        this._checkDeleted();
-        return await this._client.createRuntime({
-            environmentName: this.environment,
-            type: 'notebook',
-            givenName: `Restored from ${this.name}`,
-            minutesLimit: minutesLimit,
-            fromSnapshotId: this.uid,
-        });
-    }
-    // ========================================================================
-    // Utility Methods
-    // ========================================================================
-    /**
-     * Get code snapshot snapshot data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     * Note: Returns current cached state - call getStatus() first if you need fresh data.
-     *
-     * @returns Core code snapshot snapshot data with camelCase properties
-     */
-    toJSON() {
-        this._checkDeleted();
-        const obj = {
-            uid: this.uid,
-            name: this.name,
-            description: this.description,
-            environment: this.environment,
-            updatedAt: this.updatedAt.toISOString(),
-        };
-        validateJSON(obj, 'Snapshot');
-        return obj;
-    }
-    /**
-     * Get the raw snapshot data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     *
-     * @returns Raw snapshot data from API
-     */
-    rawData() {
-        this._checkDeleted();
-        return this._data;
-    }
-    /** String representation of the snapshot. */
-    toString() {
-        this._checkDeleted();
-        return `Snapshot(${this.uid}, ${this.name})`;
-    }
-}

package/lib/models/CodefeedBlocks.d.ts

@@ -1,7 +0,0 @@
-import { CodeBlock } from './CodeBlock';
-export type ICodefeedBlocks = {
-    id: string;
-    type: 'codefeed';
-    blocks: CodeBlock[];
-};
-export default ICodefeedBlocks;

package/lib/models/CodefeedBlocks.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/Content.d.ts

@@ -1,5 +0,0 @@
-export interface IContent {
-    name: string;
-    mount: string;
-}
-export default IContent;

package/lib/models/Content.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/Course.d.ts

@@ -1,17 +0,0 @@
-import { IBaseSpace } from './Space';
-import { Instructor } from './Instructor';
-import { IStudent } from './Student';
-import { ISchool } from './School';
-import { ISpace } from './Space';
-import { ISpaceItem } from './SpaceItem';
-export type ICourse = IBaseSpace & {
-    type: 'space';
-    variant: 'course';
-    seedSpace?: ISpace;
-    school?: ISchool;
-    instructor?: Instructor;
-    students?: Map<string, IStudent>;
-    items: Array<ISpaceItem>;
-    itemIds: Array<string>;
-};
-export default ICourse;

package/lib/models/Course.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/Dataset.d.ts

@@ -1,16 +0,0 @@
-import { IItem } from './Item';
-export type IDataset = IItem & {
-    type: 'dataset';
-    fileName: string;
-    datasetExtension: string;
-    contentLength: number;
-    contentType: string;
-    mimeType: string;
-    mimeTypeParams?: object;
-    bucketName?: string;
-    path?: string;
-    creationDate: Date;
-    lastPublicationDate?: Date;
-    cdnUrl: string;
-};
-export default IDataset;

package/lib/models/Dataset.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/Document.d.ts

@@ -1,8 +0,0 @@
-import { IItem } from './Item';
-export type IBaseDocument = IItem & {
-    model?: any;
-};
-export type IDocument = IBaseDocument & {
-    type: 'document';
-};
-export default IDocument;

package/lib/models/Document.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/Environment.d.ts

@@ -1,86 +0,0 @@
-import { IContent } from './Content';
-import { IItem } from './Item';
-export type IEnvironment = IItem & {
-    type: 'environment';
-};
-export interface IResources {
-    cpu: string;
-    memory: string;
-    'nvidia.com/gpu'?: string;
-}
-/**
- * Code snippet
- */
-export interface ISnippet {
-    /**
-     * Snippet summary
-     */
-    title: string;
-    /**
-     * Snippet long description
-     */
-    description?: string;
-    /**
-     * Code snippet
-     */
-    code: string;
-}
-/**
- * Datalayer environment
- */
-export interface IDatalayerEnvironment {
-    /**
-     * Name
-     */
-    name: string;
-    /**
-     * Title
-     */
-    title: string;
-    /**
-     * Description
-     */
-    description: string;
-    /**
-     * Icon key (e.g. ai-agent -> AiAgentIcon)
-     */
-    icon?: string;
-    /**
-     * Execution language
-     */
-    language: string;
-    /**
-     * Docker image
-     */
-    dockerImage: string;
-    /**
-     * Example notebook URL
-     */
-    example?: string;
-    /**
-     * Example code snippets
-     */
-    snippets?: ISnippet[];
-    /**
-     * Associate kernel attributes
-     */
-    runtime?: {
-        /**
-         * Proposed display name
-         */
-        givenNameTemplate?: string;
-    };
-    /**
-     * Environment credits burning rate
-     */
-    burning_rate: number;
-    /**
-     * Environment server resources
-     */
-    resources?: IResources;
-    /**
-     * Environment contents.
-     */
-    contents?: IContent[];
-}
-export default IEnvironment;

package/lib/models/Environment.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/EnvironmentDTO.d.ts

@@ -1,125 +0,0 @@
-/**
- * Environment domain model for the Datalayer Client.
- *
- * @module models/EnvironmentDTO
- */
-import type { DatalayerClient } from '../index';
-/**
- * Represents a computing environment available in the Datalayer platform.
- * @interface EnvironmentData
- */
-export interface EnvironmentData {
-    /** Human-readable title for the environment */
-    title: string;
-    /** Detailed description of the environment */
-    description: string;
-    /** Docker image used for this environment */
-    dockerImage: string;
-    /** Example usage or description */
-    example?: string;
-    /** Code snippets for this environment */
-    snippets?: any[];
-    /** Content mounts for this environment */
-    contents?: any[];
-    /** Kernel configuration */
-    runtime?: {
-        /** Template for kernel naming */
-        givenNameTemplate?: string;
-    };
-    /** Programming language (e.g., "python", "r") */
-    language: string;
-    /** Resource ranges configuration */
-    resourcesRanges?: any;
-    /** Credits consumed per hour when running */
-    burning_rate: number;
-    /** Simple resource specification */
-    resources?: any;
-    /** Name identifier for the environment */
-    name: string;
-    /** Docker registry for the image */
-    dockerRegistry?: string;
-    /** Icon or avatar URL for the environment */
-    icon?: string;
-    /** Whether the environment is enabled */
-    enabled?: boolean;
-    /** Tags associated with the environment */
-    tags?: string[];
-}
-/**
- * Stable public interface for Environment data.
- * This is the contract that Client consumers can rely on.
- * The raw API may change, but this interface remains stable.
- */
-export interface EnvironmentJSON {
-    /** Human-readable title for the environment */
-    title: string;
-    /** Unique name identifier for the environment */
-    name: string;
-    /** Credits consumed per hour for this environment */
-    burningRate: number;
-    /** Description of the environment (contains HTML markup) */
-    description: string;
-    /** Rich description of the environment (contains HTML markup) */
-    richDescription: string;
-}
-/**
- * Response from listing available environments
- * @interface ListEnvironmentsResponse
- */
-export interface ListEnvironmentsResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of available environments */
-    environments: EnvironmentData[];
-}
-/**
- * Environment domain model that wraps API responses with convenient methods.
- * Provides information about available computational environments.
- *
- * @example
- * ```typescript
- * const environments = await client.listEnvironments();
- * const aiEnv = environments.find(env => env.name === 'ai-env');
- * console.log(aiEnv.title); // "AI Environment"
- * ```
- */
-export declare class EnvironmentDTO {
-    /** @internal */
-    _data: EnvironmentData;
-    /**
-     * Create an Environment instance.
-     *
-     * @param data - Environment data from API
-     * @param _client - Client instance (not currently used but kept for consistency)
-     */
-    constructor(data: EnvironmentData, _client: DatalayerClient);
-    /** Human-readable title for the environment (e.g., 'AI Environment', 'Python CPU Environment'). */
-    get title(): string;
-    /** Unique name identifier for the environment (e.g., 'ai-env', 'ai-agents-env'). */
-    get name(): string;
-    /** Credits consumed per hour for this environment. */
-    get burningRate(): number;
-    /** Rich description of the environment (contains HTML markup). */
-    get richDescription(): string;
-    /** Clean description without HTML tags. */
-    get description(): string;
-    /**
-     * Get environment data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     *
-     * @returns Core environment data with camelCase properties
-     */
-    toJSON(): EnvironmentJSON;
-    /**
-     * Get the raw environment data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     *
-     * @returns Raw environment data from API
-     */
-    rawData(): EnvironmentData;
-    /** String representation of the environment. */
-    toString(): string;
-}

package/lib/models/EnvironmentDTO.js

@@ -1,88 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { validateJSON } from '../api/utils/validation.js';
-/**
- * Environment domain model that wraps API responses with convenient methods.
- * Provides information about available computational environments.
- *
- * @example
- * ```typescript
- * const environments = await client.listEnvironments();
- * const aiEnv = environments.find(env => env.name === 'ai-env');
- * console.log(aiEnv.title); // "AI Environment"
- * ```
- */
-export class EnvironmentDTO {
-    /** @internal */
-    _data;
-    /**
-     * Create an Environment instance.
-     *
-     * @param data - Environment data from API
-     * @param _client - Client instance (not currently used but kept for consistency)
-     */
-    constructor(data, _client) {
-        this._data = data;
-        // Client instance not currently used but kept for future extensibility
-    }
-    // ========================================================================
-    // Properties
-    // ========================================================================
-    /** Human-readable title for the environment (e.g., 'AI Environment', 'Python CPU Environment'). */
-    get title() {
-        return this._data.title;
-    }
-    /** Unique name identifier for the environment (e.g., 'ai-env', 'ai-agents-env'). */
-    get name() {
-        return this._data.name;
-    }
-    /** Credits consumed per hour for this environment. */
-    get burningRate() {
-        return this._data.burning_rate;
-    }
-    /** Rich description of the environment (contains HTML markup). */
-    get richDescription() {
-        return this._data.description;
-    }
-    /** Clean description without HTML tags. */
-    get description() {
-        // Simple HTML tag removal
-        return this._data.description.replace(/<[^>]*>/g, '').trim();
-    }
-    // ========================================================================
-    // Utility Methods
-    // ========================================================================
-    /**
-     * Get environment data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     *
-     * @returns Core environment data with camelCase properties
-     */
-    toJSON() {
-        const obj = {
-            title: this.title,
-            name: this.name,
-            burningRate: this.burningRate,
-            description: this.description,
-            richDescription: this.richDescription,
-        };
-        validateJSON(obj, 'Environment');
-        return obj;
-    }
-    /**
-     * Get the raw environment data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     *
-     * @returns Raw environment data from API
-     */
-    rawData() {
-        return this._data;
-    }
-    /** String representation of the environment. */
-    toString() {
-        return `Environment(${this.name}, ${this.title})`;
-    }
-}

package/lib/models/Exercise.d.ts

@@ -1,16 +0,0 @@
-import { IDataset } from './Dataset';
-import { IItem } from './Item';
-export type ICode = string;
-export type IHelp = string;
-export type IExercise = IItem & {
-    type: 'exercise';
-    help: IHelp;
-    codePre: ICode;
-    codeSolution: ICode;
-    codeQuestion: ICode;
-    codeTest: ICode;
-    datasets: Array<IDataset>;
-    lastUpdateDate?: Date;
-    lastPublicationDate?: Date;
-};
-export default IExercise;

package/lib/models/Exercise.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/Item.d.ts

@@ -1,20 +0,0 @@
-import { ISpaceItem } from './SpaceItem';
-import { IUser } from './User';
-import { IAnyOrganization } from './Organization';
-import { IAnySpace } from './Space';
-import { IItemType } from './ItemType';
-export type IAnyItem = ISpaceItem;
-export type IItem = {
-    id: string;
-    type: IItemType;
-    name: string;
-    description: string;
-    public: boolean;
-    creationDate: Date;
-    lastUpdateDate?: Date;
-    lastPublicationDate?: Date;
-    owner: IUser;
-    space: Partial<IAnySpace>;
-    organization: Partial<IAnyOrganization>;
-};
-export default IItem;

package/lib/models/Item.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};

package/lib/models/ItemDTO.d.ts

@@ -1,74 +0,0 @@
-/**
- * Abstract base class for all Datalayer content items.
- *
- * @module models/ItemDTO
- */
-import type { DatalayerClient } from '../index';
-/**
- * Abstract base class for all Datalayer content items.
- * Provides common functionality for content management including lifecycle tracking.
- *
- * @template TData - Raw data type from API
- * @template TUpdateRequest - Update request type for API
- */
-export declare abstract class ItemDTO<TData> {
-    protected _data: TData;
-    private _client;
-    private _deleted;
-    /**
-     * Create an Item instance.
-     * @param data - Item data from API
-     * @param client - Client instance
-     */
-    constructor(data: TData, client: DatalayerClient);
-    /** Check if this item has been deleted. */
-    get isDeleted(): boolean;
-    /**
-     * Check if this item has been deleted and throw error if so.
-     * @throws Error if deleted
-     */
-    protected _checkDeleted(): void;
-    /** Item ID. */
-    get id(): string;
-    /** Unique identifier for the item. */
-    get uid(): string;
-    /** Parent space ID. */
-    get spaceId(): string;
-    /** Owner user ID. */
-    get ownerId(): string;
-    /** When the item was created. */
-    get createdAt(): Date;
-    /** The cached update time. */
-    get updatedAt(): Date;
-    /** Get the item type identifier. */
-    abstract get type(): string;
-    /** The cached name. */
-    abstract get name(): string;
-    /** Get the current name from API. */
-    abstract getName(): Promise<string>;
-    /** The cached content. */
-    abstract get content(): any;
-    /** Get when the item was last updated from API. */
-    abstract getUpdatedAt(): Promise<Date>;
-    /** Update the item. */
-    abstract update(...args: any[]): Promise<this>;
-    /**
-     * Delete this item permanently.
-     * After deletion, all subsequent method calls will throw errors.
-     */
-    delete(): Promise<void>;
-    /** Get the document content from API. */
-    getContent(): Promise<any>;
-    /** Get raw item data object. */
-    rawData(): TData;
-    /** Convert to JSON representation - must be implemented by subclasses. */
-    abstract toJSON(): any;
-    /** String representation of the item. */
-    toString(): string;
-    /** Get Client token for API calls. */
-    protected _getToken(): string;
-    /** Get spacer API URL for API calls. */
-    protected _getSpacerRunUrl(): string;
-    /** Update internal data after API call. */
-    protected _updateData(newData: TData): void;
-}