@datalayer/core 1.0.24 → 1.1.41

package/lib/models/NotebookDTO.js

@@ -1,153 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import * as notebooks from '../api/spacer/notebooks.js';
-import { ItemDTO } from './ItemDTO.js';
-import { ItemTypes } from '../client/constants.js';
-import { validateJSON } from '../api/utils/validation.js';
-/**
- * Notebook domain model that extends the base Item class.
- * Provides notebook-specific functionality for managing Jupyter notebooks.
- *
- * @example
- * ```typescript
- * const notebook = await client.createNotebook(formData);
- * const kernelSpec = await notebook.getKernelSpec();
- * ```
- */
-export class NotebookDTO extends ItemDTO {
-    /**
-     * Create a Notebook instance.
-     *
-     * @param data - Notebook data from API
-     * @param client - Client instance
-     */
-    constructor(data, client) {
-        super(data, client);
-    }
-    // ========================================================================
-    // Abstract Method Implementations
-    // ========================================================================
-    /** Document type identifier. */
-    get type() {
-        this._checkDeleted();
-        return ItemTypes.NOTEBOOK;
-    }
-    /** The cached name of the notebook. */
-    get name() {
-        this._checkDeleted();
-        return (this._data.name_t ||
-            this._data.notebook_name_s ||
-            this._data.name ||
-            '');
-    }
-    /** The cached content. */
-    get content() {
-        this._checkDeleted();
-        if (!this._data.content && this._data.model_s) {
-            try {
-                return JSON.parse(this._data.model_s);
-            }
-            catch {
-                return this._data.model_s;
-            }
-        }
-        return this._data.content;
-    }
-    /** Get the current name from API. */
-    async getName() {
-        this._checkDeleted();
-        // For now, return cached value - implement API call if needed
-        return this.name;
-    }
-    /** Get when the notebook was last updated from API. */
-    async getUpdatedAt() {
-        this._checkDeleted();
-        const dateStr = this._data.updated_at || this._data.update_ts_dt;
-        if (!dateStr) {
-            throw new Error('No update timestamp available for notebook');
-        }
-        return new Date(dateStr);
-    }
-    /** Update the notebook. */
-    async update(name, description) {
-        // FIXME: check if both are needed, and use the existing values if only one provided
-        this._checkDeleted();
-        const token = this._client.getToken();
-        const spacerRunUrl = this._client.getSpacerRunUrl();
-        const updateData = {};
-        if (name !== undefined)
-            updateData.name = name;
-        if (description !== undefined)
-            updateData.description = description;
-        await notebooks.updateNotebook(token, this.uid, updateData, spacerRunUrl);
-        // FIXME: handle partial updates
-        return this;
-    }
-    // ========================================================================
-    // Notebook-specific Properties
-    // ========================================================================
-    /** File path within the space. */
-    get path() {
-        this._checkDeleted();
-        return this._data.path || '';
-    }
-    /** Version number. */
-    get version() {
-        this._checkDeleted();
-        return this._data.version || 0;
-    }
-    /** Notebook metadata. */
-    get metadata() {
-        this._checkDeleted();
-        return this._data.metadata || {};
-    }
-    /** Kernel specification (cached). */
-    get kernelSpec() {
-        this._checkDeleted();
-        return this._data.kernel_spec;
-    }
-    /** Description of the notebook. */
-    get description() {
-        this._checkDeleted();
-        return this._data.description_t || '';
-    }
-    /** Get the notebook extension. */
-    get extension() {
-        this._checkDeleted();
-        const ext = this._data.notebook_extension_s;
-        return ext ? (ext.startsWith('.') ? ext : `.${ext}`) : '.ipynb';
-    }
-    /**
-     * Get notebook data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     *
-     * @returns Core notebook data with camelCase properties
-     */
-    toJSON() {
-        this._checkDeleted();
-        const obj = {
-            id: this.id,
-            uid: this.uid,
-            name: this.name,
-            description: this.description,
-            type: this.type,
-            extension: this.extension,
-            cdnUrl: this._data.cdn_url_s,
-        };
-        validateJSON(obj, 'Notebook');
-        return obj;
-    }
-    /**
-     * Get the raw notebook data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     *
-     * @returns Raw notebook data from API
-     */
-    rawData() {
-        this._checkDeleted();
-        return this._data;
-    }
-}

package/lib/models/Page.d.ts

@@ -1,41 +0,0 @@
-import { INotebookContent } from '@jupyterlab/nbformat';
-import { IUser } from './User';
-import { PageTagName } from './PageTag';
-import { ICodeSandboxSnapshot } from './CodeSandboxSnapshot';
-export type PageTheme = 'default';
-export type PageVariant = 'document' | 'cell' | 'notebook';
-/**
- * Page attributes.
- *
- * - Notebook
- * - Screen Capture
- * - Theme
- * - Tags
- * - Video Explainer
- * - Kernel Launcher Button
- * - Kernel Snapshot
- * - Share Button
- * - Stars Counter - 1 ⭐ -> 1 Credit
- */
-export type IPage = {
-    id: string;
-    variant: PageVariant;
-    type: 'page';
-    name: string;
-    description: string;
-    theme: PageTheme;
-    tags: Array<PageTagName>;
-    nbformat: INotebookContent;
-    screenCapture?: string;
-    creator?: IUser;
-    creatorId?: string;
-    selectedPrincipalUid?: string;
-    selectedPrincipalKind?: 'user' | 'organization' | 'team';
-    selectedOrganizationUid?: string;
-    kernelSnapshot?: ICodeSandboxSnapshot;
-    kernelSnapshotId?: string;
-    createdAt?: string;
-    updatedAt?: string;
-};
-export declare const asPage: (s: any) => IPage;
-export default IPage;

package/lib/models/Page.js

@@ -1,25 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { asUser } from './User.js';
-import { asCodeSandboxSnapshot, } from './CodeSandboxSnapshot.js';
-export const asPage = (s) => {
-    return {
-        id: s.uid,
-        type: 'page',
-        variant: s.variant_s,
-        name: s.name_t,
-        description: s.description_t,
-        theme: s.theme_s,
-        nbformat: s.nbformat_s ? JSON.parse(s.nbformat_s) : undefined,
-        screenCapture: s.screen_capture_cdn_url_s || s.screen_capture_s,
-        tags: s.tags_ss ?? [],
-        creator: s.creator ? asUser(s.creator) : undefined,
-        creatorId: s.creator_uid,
-        kernelSnapshot: s.kernel_snapshot
-            ? asCodeSandboxSnapshot(s.kernel_snapshot)
-            : undefined,
-        kernelSnapshotId: s.kernel_snapshot_uid,
-    };
-};

package/lib/models/PageTag.d.ts

@@ -1,19 +0,0 @@
-import { CardIconColors } from '@primer/react-brand';
-import { Icon } from '@primer/octicons-react';
-type CardIconColorsType = (typeof CardIconColors)[number];
-export type PageTagMetadata = {
-    fillColor: React.CSSProperties['backgroundColor'];
-};
-export type PageTagName = 'agent' | 'ai' | 'ai-agent' | 'deep-learning' | 'example' | 'llm' | 'notebook' | 'python' | 'pytorch' | 'spatial' | 'tutorial';
-export type PageTag = {
-    id: string;
-    text?: PageTagName;
-    color: CardIconColorsType;
-    Icon: Icon;
-    metadata?: PageTagMetadata;
-};
-export declare const PAGE_TAGE_NONE: PageTag;
-export declare const PAGE_TAGS: PageTag[];
-export declare const PAGE_TAGS_BY_NAME_MAP: Map<PageTagName | undefined, PageTag>;
-export declare const PAGE_TAGS_BY_COLOR_MAP: Map<"blue" | "coral" | "gray" | "green" | "indigo" | "lime" | "orange" | "pink" | "purple" | "red" | "teal" | "yellow" | "default" | "lemon", PageTag>;
-export {};

package/lib/models/PageTag.js

@@ -1,94 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { CopilotIcon, ZapIcon } from '@primer/octicons-react';
-export const PAGE_TAGE_NONE = {
-    id: '0',
-    text: undefined,
-    Icon: CopilotIcon,
-    color: 'pink',
-};
-const PAGE_TAGE_AGENT = {
-    id: '9',
-    text: 'agent',
-    Icon: CopilotIcon,
-    color: 'teal',
-};
-const PAGE_TAGE_AI = {
-    id: '1',
-    text: 'ai',
-    Icon: CopilotIcon,
-    color: 'pink',
-};
-const PAGE_TAGE_AI_AGENT = {
-    id: '10',
-    text: 'ai-agent',
-    Icon: CopilotIcon,
-    color: 'purple',
-};
-const PAGE_TAGE_DEEP_LEARNING = {
-    id: '2',
-    text: 'deep-learning',
-    Icon: ZapIcon,
-    color: 'blue',
-};
-const PAGE_TAGE_EXAMPLE = {
-    id: '3',
-    text: 'example',
-    Icon: CopilotIcon,
-    color: 'lime',
-};
-const PAGE_TAGE_LLM = {
-    id: '4',
-    text: 'llm',
-    Icon: CopilotIcon,
-    color: 'coral',
-};
-const PAGE_TAGE_NOTEBOOK = {
-    id: '11',
-    text: 'notebook',
-    Icon: CopilotIcon,
-    color: 'blue',
-};
-const PAGE_TAGE_PYTHON = {
-    id: '5',
-    text: 'python',
-    Icon: CopilotIcon,
-    color: 'gray',
-    metadata: { fillColor: 'var(--base-color-green-0)' },
-};
-const PAGE_TAGE_PYTORCH = {
-    id: '6',
-    text: 'pytorch',
-    Icon: CopilotIcon,
-    color: 'green',
-};
-const PAGE_TAGE_SPATIAL = {
-    id: '7',
-    text: 'spatial',
-    Icon: CopilotIcon,
-    color: 'lemon',
-};
-const PAGE_TAGE_TUTORIAL = {
-    id: '8',
-    text: 'tutorial',
-    Icon: CopilotIcon,
-    color: 'orange',
-    metadata: { fillColor: 'yellow' },
-};
-export const PAGE_TAGS = [
-    PAGE_TAGE_AGENT,
-    PAGE_TAGE_AI,
-    PAGE_TAGE_AI_AGENT,
-    PAGE_TAGE_DEEP_LEARNING,
-    PAGE_TAGE_EXAMPLE,
-    PAGE_TAGE_LLM,
-    PAGE_TAGE_NOTEBOOK,
-    PAGE_TAGE_PYTHON,
-    PAGE_TAGE_PYTORCH,
-    PAGE_TAGE_SPATIAL,
-    PAGE_TAGE_TUTORIAL,
-];
-export const PAGE_TAGS_BY_NAME_MAP = new Map(PAGE_TAGS.map(t => [t.text, t]));
-export const PAGE_TAGS_BY_COLOR_MAP = new Map(PAGE_TAGS.map(t => [t.color, t]));

package/lib/models/ProjectDTO.d.ts

@@ -1,89 +0,0 @@
-/**
- * Project domain model for the Datalayer Client.
- *
- * Projects are spaces with variant='project' that can have attached agents.
- * This is a standalone model (no inheritance from SpaceDTO) to avoid
- * circular dependency issues in the module graph.
- *
- * @module models/ProjectDTO
- */
-import type { SpaceData } from './SpaceDTO';
-/**
- * Stable public interface for Project data.
- */
-export interface ProjectJSON {
-    uid: string;
-    id: string;
-    handle: string;
-    name: string;
-    description: string;
-    variant: string;
-    isPublic: boolean;
-    createdAt: string;
-    attachedAgentPodName: string | null;
-    attachedAgentSpecId: string | null;
-    attachedAgentGivenName: string | null;
-    hasAgent: boolean;
-}
-/**
- * Default items (notebook UID and document UID) for a project.
- */
-export interface ProjectDefaultItems {
-    defaultNotebookUid: string | null;
-    defaultDocumentUid: string | null;
-}
-/**
- * Project domain model wrapping raw space data with project-specific accessors.
- *
- * @example
- * ```typescript
- * const projects = await client.getProjects();
- * const project = projects[0];
- * console.log(project.hasAgent); // false
- * await client.assignAgent(project.uid, 'my-agent-pod');
- * ```
- */
-export declare class ProjectDTO {
-    private _data;
-    private _deleted;
-    private _createdAt;
-    constructor(data: SpaceData);
-    /** Unique identifier for the project. */
-    get uid(): string;
-    /** Internal numeric/string ID from the backend. Falls back to UID when not present. SDK client methods accept `uid` directly. */
-    get id(): string;
-    /** URL-friendly handle. */
-    get handle(): string;
-    /** Project name. */
-    get name(): string;
-    /** Project description. */
-    get description(): string;
-    /** Space variant (should be 'project'). */
-    get variant(): string;
-    /** Whether the project is public. */
-    get isPublic(): boolean;
-    /** Creation date (stable across calls). */
-    get createdAt(): Date;
-    /** Attached agent runtime pod name, if any. */
-    get attachedAgentPodName(): string | undefined;
-    /** Attached agent spec ID (e.g., 'data-acquisition'), if any. */
-    get attachedAgentSpecId(): string | undefined;
-    /** Human-readable name of the attached agent runtime, if any. */
-    get attachedAgentGivenName(): string | undefined;
-    /** Whether an agent is currently attached to this project. */
-    get hasAgent(): boolean;
-    /** Mark this project as deleted. */
-    markDeleted(): void;
-    /** Whether this project has been deleted. */
-    get isDeleted(): boolean;
-    /**
-     * Get project data in camelCase format.
-     * @returns Project data with camelCase properties
-     */
-    toJSON(): ProjectJSON;
-    /** Get raw space data as received from the API. */
-    rawData(): SpaceData;
-    /** String representation of the project. */
-    toString(): string;
-    private _checkDeleted;
-}

package/lib/models/ProjectDTO.js

@@ -1,131 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Project domain model wrapping raw space data with project-specific accessors.
- *
- * @example
- * ```typescript
- * const projects = await client.getProjects();
- * const project = projects[0];
- * console.log(project.hasAgent); // false
- * await client.assignAgent(project.uid, 'my-agent-pod');
- * ```
- */
-export class ProjectDTO {
-    _data;
-    _deleted = false;
-    _createdAt;
-    constructor(data) {
-        this._data = data;
-        // Cache creation date at construction to ensure stable value
-        this._createdAt = data.creation_ts_dt
-            ? new Date(data.creation_ts_dt)
-            : new Date();
-    }
-    /** Unique identifier for the project. */
-    get uid() {
-        this._checkDeleted();
-        return this._data.uid;
-    }
-    /** Internal numeric/string ID from the backend. Falls back to UID when not present. SDK client methods accept `uid` directly. */
-    get id() {
-        this._checkDeleted();
-        return this._data.id ?? this._data.uid;
-    }
-    /** URL-friendly handle. */
-    get handle() {
-        this._checkDeleted();
-        return this._data.handle_s;
-    }
-    /** Project name. */
-    get name() {
-        this._checkDeleted();
-        return this._data.name_t;
-    }
-    /** Project description. */
-    get description() {
-        this._checkDeleted();
-        return this._data.description_t ?? '';
-    }
-    /** Space variant (should be 'project'). */
-    get variant() {
-        this._checkDeleted();
-        return this._data.variant_s;
-    }
-    /** Whether the project is public. */
-    get isPublic() {
-        this._checkDeleted();
-        return this._data.public_b ?? false;
-    }
-    /** Creation date (stable across calls). */
-    get createdAt() {
-        this._checkDeleted();
-        return this._createdAt;
-    }
-    /** Attached agent runtime pod name, if any. */
-    get attachedAgentPodName() {
-        this._checkDeleted();
-        return this._data.attached_agent_pod_name_s || undefined;
-    }
-    /** Attached agent spec ID (e.g., 'data-acquisition'), if any. */
-    get attachedAgentSpecId() {
-        this._checkDeleted();
-        return this._data.attached_agent_spec_id_s || undefined;
-    }
-    /** Human-readable name of the attached agent runtime, if any. */
-    get attachedAgentGivenName() {
-        this._checkDeleted();
-        return this._data.attached_agent_given_name_s || undefined;
-    }
-    /** Whether an agent is currently attached to this project. */
-    get hasAgent() {
-        this._checkDeleted();
-        return !!this._data.attached_agent_pod_name_s;
-    }
-    /** Mark this project as deleted. */
-    markDeleted() {
-        this._deleted = true;
-    }
-    /** Whether this project has been deleted. */
-    get isDeleted() {
-        return this._deleted;
-    }
-    /**
-     * Get project data in camelCase format.
-     * @returns Project data with camelCase properties
-     */
-    toJSON() {
-        this._checkDeleted();
-        return {
-            uid: this.uid,
-            id: this.id,
-            handle: this.handle,
-            name: this.name,
-            description: this.description,
-            variant: this.variant,
-            isPublic: this.isPublic,
-            createdAt: this.createdAt.toISOString(),
-            attachedAgentPodName: this.attachedAgentPodName ?? null,
-            attachedAgentSpecId: this.attachedAgentSpecId ?? null,
-            attachedAgentGivenName: this.attachedAgentGivenName ?? null,
-            hasAgent: this.hasAgent,
-        };
-    }
-    /** Get raw space data as received from the API. */
-    rawData() {
-        this._checkDeleted();
-        return this._data;
-    }
-    /** String representation of the project. */
-    toString() {
-        this._checkDeleted();
-        return `Project(${this._data.uid}, ${this._data.name_t})`;
-    }
-    _checkDeleted() {
-        if (this._deleted) {
-            throw new Error(`Project ${this._data.uid} has been deleted and no longer exists`);
-        }
-    }
-}

package/lib/models/Runtime.d.ts

@@ -1,123 +0,0 @@
-import { Kernel } from '@jupyterlab/services';
-export declare const BACKWARDS_COMPATIBLE_KERNEL_TYPES_MAP: {
-    default: IRuntimeType;
-    snippet: IRuntimeType;
-    notebook: IRuntimeType;
-    cell: IRuntimeType;
-};
-/**
- * Error thrown when a runtime has been created
- * but it can ont be reached.
- */
-export declare class RuntimeUnreachable extends Error {
-    name: string;
-}
-/**
- * Runtime location.
- */
-export type IRuntimeLocation = 'browser' | 'local' | string;
-/**
- * Runtime model.
- */
-export interface IRuntimeModel extends IRuntimePod, Kernel.IModel {
-}
-/**
- * Runtime pod.
- */
-export interface IRuntimePod {
-    /**
-     * Environment display name
-     */
-    environment_title: string;
-    /**
-     * Environment name
-     */
-    environment_name: string;
-    /**
-     * Runtime name
-     */
-    pod_name: string;
-    /**
-     * Runtime ingress URL
-     */
-    ingress: string;
-    /**
-     * Runtime user given name
-     */
-    given_name: string;
-    /**
-     * Runtime type
-     */
-    type: IRuntimeType;
-    /**
-     * Server authentication token
-     */
-    token: string;
-    /**
-     * Credits burning rate per second
-     */
-    burning_rate: number;
-    /**
-     * Kernel reservation ID
-     */
-    reservation_id?: string;
-    /**
-     * Runtime usage starting timestamp
-     */
-    started_at: string;
-    /**
-     * Runtime credits reservation expiration timestamp
-     */
-    expired_at?: string;
-}
-/**
- * Runtime description.
- */
-export interface IRuntimeDesc {
-    /**
-     * Runtime ID.
-     */
-    id?: string;
-    /**
-     * Runtime Kernel ID.
-     */
-    kernelId?: string;
-    /**
-     * Runtime name.
-     */
-    name: string;
-    /**
-     * Runtime language.
-     */
-    language: string;
-    /**
-     * Runtime location.
-     */
-    location: IRuntimeLocation;
-    /**
-     * Runtime display name.
-     */
-    displayName?: string;
-    /**
-     * Runtime parameters.
-     */
-    params?: Record<string, any>;
-    /**
-     * Runtime credits burning rate.
-     */
-    burningRate?: number;
-    /**
-     * Runtime Pod name (if applicable).
-     */
-    podName?: string;
-}
-/**
- * Runtime type.
- *
- * TODO refactor with type `IRuntimeLocation`
- */
-export type IRuntimeType = 'notebook' | 'cell';
-/**
- * Runtime optional capabilities.
- */
-export type IRuntimeCapabilities = 'user_storage';

package/lib/models/Runtime.js

@@ -1,18 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export const BACKWARDS_COMPATIBLE_KERNEL_TYPES_MAP = {
-    // Backwards compatible mapping.
-    default: 'notebook',
-    snippet: 'cell',
-    notebook: 'notebook',
-    cell: 'cell',
-};
-/**
- * Error thrown when a runtime has been created
- * but it can ont be reached.
- */
-export class RuntimeUnreachable extends Error {
-    name = 'RuntimeUnreachable';
-}