@datalayer/core 1.0.24 → 1.1.41

package/lib/models/RuntimeDTO.d.ts

@@ -1,191 +0,0 @@
-import type { DatalayerClient } from '../index';
-import { CodeSandboxSnapshotDTO } from './CodeSandboxSnapshotDTO';
-/**
- * Represents a running instance of a computing environment.
- * @interface RuntimeData
- */
-export interface RuntimeData {
-    /** Kubernetes pod name for the runtime instance */
-    pod_name: string;
-    /** Unique identifier for the runtime */
-    uid: string;
-    /** Name of the environment this runtime is based on */
-    environment_name: string;
-    /** Title of the environment for display */
-    environment_title: string;
-    /** Type of runtime - notebook, terminal, or job */
-    type: string;
-    /** Credits consumed per second */
-    burning_rate: number;
-    /** User-friendly name for the runtime */
-    given_name: string;
-    /** Authentication token for accessing the runtime */
-    token: string;
-    /** Ingress URL for accessing the runtime */
-    ingress: string;
-    /** ISO 8601 timestamp of when the runtime started */
-    started_at: string;
-    /** ISO 8601 timestamp of when the runtime will expire */
-    expired_at: string;
-}
-/**
- * Stable public interface for Runtime data.
- * This is the contract that Client consumers can rely on.
- * The raw API may change, but this interface remains stable.
- */
-export interface RuntimeJSON {
-    /** ulid for the runtime */
-    uid: string;
-    /** Kubernetes pod name for the runtime instance */
-    podName: string;
-    /** User-friendly name for the runtime */
-    givenName: string;
-    /** Name of the environment this runtime is based on */
-    environmentName: string;
-    /** Title of the environment for display */
-    environmentTitle: string;
-    /** Type of runtime - notebook, terminal, or job */
-    type: string;
-    /** Credits consumed per second */
-    burningRate: number;
-    /** Credits allocated/available to this runtime */
-    ingress: string;
-    /** Authentication token for accessing the runtime */
-    token: string;
-    /** When the runtime was started */
-    startedAt: string;
-    /** When the runtime will expire */
-    expiredAt: string;
-}
-/**
- * Request payload for creating a new runtime
- * @interface CreateRuntimeRequest
- */
-export interface CreateRuntimeRequest {
-    /** Name of the environment to use */
-    environment_name: string;
-    /** Type of runtime (e.g., 'notebook', 'terminal', 'job') */
-    type?: 'notebook' | 'terminal' | 'job';
-    /** Optional given name for the runtime */
-    given_name?: string;
-    /** Maximum credits this runtime can consume */
-    credits_limit?: number;
-    /** Optional capabilities for the runtime */
-    capabilities?: string[];
-    /** Optional source to create runtime from (e.g., snapshot ID) */
-    from?: string;
-}
-/**
- * Response from creating a new runtime
- * @interface CreateRuntimeResponse
- */
-export interface CreateRuntimeResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** The created runtime instance */
-    runtime: RuntimeData;
-}
-/**
- * Response from listing runtimes
- * @interface ListRuntimesResponse
- */
-export interface ListRuntimesResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of runtime instances */
-    runtimes: RuntimeData[];
-}
-/**
- * Runtime domain model that wraps API responses with convenient methods.
- * Provides state management and lifecycle operations for computational runtimes.
- *
- * @example
- * ```typescript
- * const runtime = await client.createRuntime({ environment_name: 'python-cpu' });
- * await runtime.waitUntilReady();
- * ```
- */
-export declare class RuntimeDTO {
-    /** @internal */
-    _data: RuntimeData;
-    private _client;
-    private _deleted;
-    /**
-     * Create a Runtime instance.
-     *
-     * @param data - Runtime data from API
-     * @param client - Client instance
-     */
-    constructor(data: RuntimeData, client: DatalayerClient);
-    /**
-     * Check if this runtime has been deleted and throw error if so.
-     * @throws Error if deleted
-     */
-    private _checkDeleted;
-    /** Kubernetes pod name for the runtime instance. */
-    get podName(): string;
-    /** Unique identifier for the runtime. */
-    get uid(): string;
-    /** Name of the environment this runtime is based on. */
-    get environmentName(): string;
-    /** Ingress URL for accessing the runtime. */
-    get ingress(): string;
-    /** Authentication token for accessing the runtime. */
-    get token(): string;
-    /** Credits consumed per second. */
-    get burningRate(): number;
-    /** User-friendly name for the runtime. */
-    get givenName(): string;
-    /** Type of runtime (notebook, terminal, or job). */
-    get type(): string;
-    /** When the runtime started. */
-    get startedAt(): Date;
-    /** When the runtime will expire. */
-    get expiredAt(): Date;
-    /** Environment title for display. */
-    get environmentTitle(): string;
-    /**
-     * Delete this runtime permanently.
-     * After deletion, subsequent calls to dynamic methods will throw errors.
-     */
-    delete(): Promise<void>;
-    /**
-     * Update runtime from a snapshot.
-     *
-     * @param from - Snapshot identifier to restore from
-     * @returns Updated Runtime instance
-     */
-    update(from: string): Promise<RuntimeDTO>;
-    /**
-     * Create a snapshot of this runtime.
-     *
-     * @param name - Name for the snapshot
-     * @param description - Optional description
-     * @param stop - Whether to stop runtime after snapshotting
-     * @returns Created Snapshot instance
-     */
-    createSnapshot(name: string, description?: string, stop?: boolean): Promise<CodeSandboxSnapshotDTO>;
-    /**
-     * Get runtime data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     * Returns the current cached state - call getState() first if you need fresh data.
-     *
-     * @returns Core runtime data with camelCase properties
-     */
-    toJSON(): RuntimeJSON;
-    /**
-     * Get the raw runtime data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     * Returns the current cached state - call getState() first if you need fresh data.
-     *
-     * @returns Raw runtime data from API
-     */
-    rawData(): RuntimeData;
-    /** String representation of the runtime. */
-    toString(): string;
-}

package/lib/models/RuntimeDTO.js

@@ -1,204 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Runtime domain model for the Datalayer Client.
- *
- * @module models/RuntimeDTO
- */
-import { updateRuntime } from '../api/runtimes/runtimes.js';
-import { validateJSON } from '../api/utils/validation.js';
-/**
- * Runtime domain model that wraps API responses with convenient methods.
- * Provides state management and lifecycle operations for computational runtimes.
- *
- * @example
- * ```typescript
- * const runtime = await client.createRuntime({ environment_name: 'python-cpu' });
- * await runtime.waitUntilReady();
- * ```
- */
-export class RuntimeDTO {
-    /** @internal */
-    _data;
-    _client;
-    _deleted = false;
-    /**
-     * Create a Runtime instance.
-     *
-     * @param data - Runtime data from API
-     * @param client - Client instance
-     */
-    constructor(data, client) {
-        this._data = data;
-        this._client = client;
-    }
-    // ========================================================================
-    // Helper Methods
-    // ========================================================================
-    /**
-     * Check if this runtime has been deleted and throw error if so.
-     * @throws Error if deleted
-     */
-    _checkDeleted() {
-        if (this._deleted) {
-            throw new Error(`Runtime ${this._data.pod_name} has been deleted and no longer exists`);
-        }
-    }
-    // ========================================================================
-    // Static Properties (set at creation, never change)
-    // ========================================================================
-    /** Kubernetes pod name for the runtime instance. */
-    get podName() {
-        this._checkDeleted();
-        return this._data.pod_name;
-    }
-    /** Unique identifier for the runtime. */
-    get uid() {
-        this._checkDeleted();
-        return this._data.uid;
-    }
-    /** Name of the environment this runtime is based on. */
-    get environmentName() {
-        this._checkDeleted();
-        return this._data.environment_name;
-    }
-    /** Ingress URL for accessing the runtime. */
-    get ingress() {
-        this._checkDeleted();
-        return this._data.ingress;
-    }
-    /** Authentication token for accessing the runtime. */
-    get token() {
-        this._checkDeleted();
-        return this._data.token;
-    }
-    /** Credits consumed per second. */
-    get burningRate() {
-        this._checkDeleted();
-        return this._data.burning_rate;
-    }
-    /** User-friendly name for the runtime. */
-    get givenName() {
-        this._checkDeleted();
-        return this._data.given_name;
-    }
-    /** Type of runtime (notebook, terminal, or job). */
-    get type() {
-        this._checkDeleted();
-        return this._data.type;
-    }
-    /** When the runtime started. */
-    get startedAt() {
-        this._checkDeleted();
-        return new Date(Number(this._data.started_at) * 1000);
-    }
-    /** When the runtime will expire. */
-    get expiredAt() {
-        this._checkDeleted();
-        return new Date(Number(this._data.expired_at) * 1000);
-    }
-    /** Environment title for display. */
-    get environmentTitle() {
-        this._checkDeleted();
-        return this._data.environment_title || '';
-    }
-    // ========================================================================
-    // Action Methods
-    // ========================================================================
-    /**
-     * Delete this runtime permanently.
-     * After deletion, subsequent calls to dynamic methods will throw errors.
-     */
-    async delete() {
-        await this._client.deleteRuntime(this.podName);
-        this._deleted = true;
-    }
-    /**
-     * Update runtime from a snapshot.
-     *
-     * @param from - Snapshot identifier to restore from
-     * @returns Updated Runtime instance
-     */
-    async update(from) {
-        this._checkDeleted();
-        const updated = await updateRuntime(this._client.getToken(), this.podName, from, this._client.getRuntimesRunUrl());
-        return new RuntimeDTO(updated, this._client);
-    }
-    /**
-     * Create a snapshot of this runtime.
-     *
-     * @param name - Name for the snapshot
-     * @param description - Optional description
-     * @param stop - Whether to stop runtime after snapshotting
-     * @returns Created Snapshot instance
-     */
-    async createSnapshot(name, description, stop) {
-        this._checkDeleted();
-        return await this._client.createSnapshot(this.podName, name, description, stop);
-    }
-    // ========================================================================
-    // Utility Methods
-    // ========================================================================
-    /**
-     * Get runtime data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     * Returns the current cached state - call getState() first if you need fresh data.
-     *
-     * @returns Core runtime data with camelCase properties
-     */
-    toJSON() {
-        this._checkDeleted();
-        // Safely convert dates to ISO strings, handling invalid dates
-        const safeToISO = (date) => {
-            try {
-                const iso = date.toISOString();
-                return iso;
-            }
-            catch {
-                // If date is invalid, return empty string or current time
-                return new Date().toISOString();
-            }
-        };
-        const obj = {
-            // Core identifiers
-            uid: this.uid,
-            podName: this.podName,
-            givenName: this.givenName,
-            // Environment info
-            environmentName: this.environmentName,
-            environmentTitle: this.environmentTitle,
-            // State and type
-            type: this.type,
-            // Burning
-            burningRate: this.burningRate,
-            // URLs and tokens
-            // FIXME: Consider renaming? jupyterServerUrl and jupyterServerToken
-            ingress: this.ingress,
-            token: this.token,
-            // Timing
-            startedAt: safeToISO(this.startedAt),
-            expiredAt: safeToISO(this.expiredAt),
-        };
-        validateJSON(obj, 'Runtime');
-        return obj;
-    }
-    /**
-     * Get the raw runtime data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     * Returns the current cached state - call getState() first if you need fresh data.
-     *
-     * @returns Raw runtime data from API
-     */
-    rawData() {
-        this._checkDeleted();
-        return this._data;
-    }
-    /** String representation of the runtime. */
-    toString() {
-        this._checkDeleted();
-        return `Runtime(${this.podName}, ${this.environmentName})`;
-    }
-}

package/lib/models/Space.d.ts

@@ -1,35 +0,0 @@
-import { SpaceMember } from './SpaceMember';
-import { ISpaceItem } from './SpaceItem';
-import { ICourse as ICourse } from './Course';
-import { IOrganization } from './Organization';
-import { IUser } from './User';
-/**
- * Convert the raw space object to {@link ISpace}.
- *
- * @param user Raw space object from DB
- * @returns Space
- */
-export declare const asSpace: (raw_space: any) => ISpace;
-export type ISpaceVariant = 'default' | 'course' | 'project';
-export type IAnySpace = ISpace | ICourse;
-export type IBaseSpace = {
-    id: string;
-    handle: string;
-    type: string;
-    variant: ISpaceVariant;
-    name: string;
-    description: string;
-    creationDate: Date;
-    public: boolean;
-    owner: IUser;
-    organization?: Partial<IOrganization>;
-    members?: SpaceMember[];
-    sharedOwnerUserUids?: string[];
-};
-export type ISpace = IBaseSpace & {
-    type: 'space';
-    variant: 'default';
-    items?: Array<ISpaceItem>;
-    itemIds?: Array<string>;
-};
-export default ISpace;

package/lib/models/Space.js

@@ -1,66 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { asUser } from './User.js';
-import { asArray } from '../utils/index.js';
-/**
- * Convert the raw space object to {@link ISpace}.
- *
- * @param user Raw space object from DB
- * @returns Space
- */
-export const asSpace = (raw_space) => {
-    const sharedOwnerUserUids = asArray(raw_space?.shared_owner_user_uids_ss ||
-        raw_space?.shared_ower_user_uids_ss ||
-        []).filter((uid) => typeof uid === 'string' && uid.length > 0);
-    // The backend resolves the canonical (friendly) account handles and exposes
-    // them as `space.owner` and `space.organization`. Trust those single sources
-    // of truth; do not invent fallbacks here.
-    const organizationHandle = raw_space?.organization?.handle;
-    const owner = raw_space?.owner
-        ? asUser(raw_space.owner)
-        : {
-            id: '',
-            handle: '',
-            email: '',
-            firstName: '',
-            lastName: '',
-            initials: '',
-            displayName: '',
-            roles: [],
-            iamProviders: [],
-            setRoles: () => { },
-            unsubscribedFromOutbounds: false,
-            onboarding: {},
-            events: [],
-            settings: {},
-        };
-    let members = new Array();
-    if (raw_space.members) {
-        members = asArray(raw_space.members).map(m => {
-            const member = asUser(m);
-            return member;
-        });
-    }
-    const space = {
-        id: raw_space.uid,
-        handle: raw_space.handle_s,
-        type: 'space',
-        variant: raw_space.variant_s,
-        name: raw_space.name_t,
-        description: raw_space.description_t,
-        public: raw_space.public_b,
-        members,
-        creationDate: new Date(raw_space.creation_ts_dt),
-        owner,
-        organization: organizationHandle
-            ? { handle: organizationHandle }
-            : undefined,
-        sharedOwnerUserUids,
-        // Preserve raw Solr fields so consumers can access dynamic fields
-        // (e.g. attached_agent_pod_name_s for project-agent assignment)
-        ...raw_space,
-    };
-    return space;
-};