@datalayer/core 0.0.13 → 0.0.15

package/lib/models/Runtime.d.ts

@@ -21,6 +21,55 @@ export type IRuntimeLocation = 'browser' | 'local' | string;
  */
 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.
  */
@@ -72,52 +121,3 @@ export type IRuntimeType = 'notebook' | 'cell';
  * Runtime optional capabilities.
  */
 export type IRuntimeCapabilities = 'user_storage';
-/**
- * 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;
-}

package/lib/{client/models/Runtime.d.ts → models/RuntimeDTO.d.ts}

@@ -1,6 +1,33 @@
-import type { Runtime as RuntimeData } from '../../api/types/runtimes';
 import type { DatalayerClient } from '../index';
-import { Snapshot } from './Snapshot';
+import { RuntimeSnapshotDTO } from './RuntimeSnapshotDTO';
+/**
+ * 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 SDK consumers can rely on.
@@ -30,6 +57,48 @@ export interface RuntimeJSON {
     /** 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.
@@ -40,7 +109,7 @@ export interface RuntimeJSON {
  * await runtime.waitUntilReady();
  * ```
  */
-export declare class Runtime {
+export declare class RuntimeDTO {
     /** @internal */
     _data: RuntimeData;
     private _sdk;
@@ -90,7 +159,7 @@ export declare class Runtime {
      * @param from - Snapshot identifier to restore from
      * @returns Updated Runtime instance
      */
-    update(from: string): Promise<Runtime>;
+    update(from: string): Promise<RuntimeDTO>;
     /**
      * Create a snapshot of this runtime.
      *
@@ -99,7 +168,7 @@ export declare class Runtime {
      * @param stop - Whether to stop runtime after snapshotting
      * @returns Created Snapshot instance
      */
-    createSnapshot(name: string, description?: string, stop?: boolean): Promise<Snapshot>;
+    createSnapshot(name: string, description?: string, stop?: boolean): Promise<RuntimeSnapshotDTO>;
     /**
      * Get runtime data in camelCase format.
      * Returns only the core fields that consumers need.

package/lib/{client/models/Runtime.js → models/RuntimeDTO.js}

@@ -5,10 +5,10 @@
 /**
  * Runtime domain model for the Datalayer SDK.
  *
- * @module client/models/Runtime
+ * @module models/RuntimeDTO
  */
-import { updateRuntime } from '../../api/runtimes/runtimes';
-import { validateJSON } from '../../api/utils/validation';
+import { updateRuntime } from '../api/runtimes/runtimes';
+import { validateJSON } from '../api/utils/validation';
 /**
  * Runtime domain model that wraps API responses with convenient methods.
  * Provides state management and lifecycle operations for computational runtimes.
@@ -19,7 +19,7 @@ import { validateJSON } from '../../api/utils/validation';
  * await runtime.waitUntilReady();
  * ```
  */
-export class Runtime {
+export class RuntimeDTO {
     /** @internal */
     _data;
     _sdk;
@@ -124,7 +124,7 @@ export class Runtime {
     async update(from) {
         this._checkDeleted();
         const updated = await updateRuntime(this._sdk.getToken(), this.podName, from, this._sdk.getRuntimesRunUrl());
-        return new Runtime(updated, this._sdk);
+        return new RuntimeDTO(updated, this._sdk);
     }
     /**
      * Create a snapshot of this runtime.

package/lib/{client/models/Snapshot.d.ts → models/RuntimeSnapshotDTO.d.ts}

@@ -1,17 +1,48 @@
 /**
  * Snapshot domain model for the Datalayer SDK.
  *
- * @module client/models/Snapshot
+ * @module models/RuntimeSnapshotDTO
  */
-import type { RuntimeSnapshot as RuntimeSnapshotData } from '../../api/types/runtimes';
 import type { DatalayerClient } from '../index';
-import { Runtime } from './Runtime';
+import { RuntimeDTO } from './RuntimeDTO';
+/**
+ * Represents a runthime snapshot of a runtime's state and files.
+ * @interface RuntimeSnapshotData
+ */
+export interface RuntimeSnapshotData {
+    /** Unique identifier for the snapshot */
+    uid: string;
+    /** Name of the snapshot */
+    name: string;
+    /** Optional description of the snapshot */
+    description?: string;
+    /** Name of the environment used by the runtime */
+    environment: string;
+    /** Metadata associated with the snapshot */
+    metadata?: {
+        version?: string;
+        language_info?: any;
+        [key: string]: any;
+    };
+    /** Size of the snapshot in bytes */
+    size?: number;
+    /** Format of the snapshot */
+    format?: string;
+    /** Format version of the snapshot */
+    format_version?: string;
+    /** Status of the snapshot */
+    status?: string;
+    /** ISO 8601 timestamp when the snapshot was last updated */
+    updated_at: string;
+    /** List of files included in the snapshot */
+    files?: any[];
+}
 /**
  * Stable public interface for Snapshot data.
  * This is the contract that SDK consumers can rely on.
  * The raw API may change, but this interface remains stable.
  */
-export interface SnapshotJSON {
+export interface RuntimeSnapshotJSON {
     /** Unique identifier for the snapshot */
     uid: string;
     /** Name of the snapshot */
@@ -23,6 +54,56 @@ export interface SnapshotJSON {
     /** ISO 8601 timestamp when the snapshot was last updated */
     updatedAt: string;
 }
+/**
+ * Request payload for creating a runtime snapshot
+ * @interface CreateRuntimeSnapshotRequest
+ */
+export interface CreateRuntimeSnapshotRequest {
+    /** Pod name of the runtime to snapshot */
+    pod_name: string;
+    /** Name for the snapshot */
+    name: string;
+    /** Description of the snapshot */
+    description: string;
+    /** Whether to stop the runtime after creating snapshot */
+    stop: boolean;
+}
+/**
+ * Response for getting a specific runtime snapshot
+ * @interface GetRuntimeSnapshotResponse
+ */
+export interface GetRuntimeSnapshotResponse {
+    /** Indicates if the request was successful */
+    success: boolean;
+    /** Response message */
+    message: string;
+    /** The snapshot details */
+    snapshot: RuntimeSnapshotData;
+}
+/**
+ * Response for creating a runtime snapshot
+ * @interface CreateRuntimeSnapshotResponse
+ */
+export interface CreateRuntimeSnapshotResponse {
+    /** Indicates if the request was successful */
+    success: boolean;
+    /** Response message */
+    message: string;
+    /** The created snapshot details */
+    snapshot: RuntimeSnapshotData;
+}
+/**
+ * Response from listing runtime snapshots
+ * @interface RuntimeSnapshotsListResponse
+ */
+export interface ListRuntimeSnapshotsResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** Array of runtime snapshots */
+    snapshots: RuntimeSnapshotData[];
+}
 /**
  * Snapshot domain model that wraps API responses with convenient methods.
  * Provides runtime snapshot management with data refresh and lifecycle operations.
@@ -33,12 +114,12 @@ export interface SnapshotJSON {
  * const runtime = await snapshot.restore();
  * ```
  */
-export declare class Snapshot {
+export declare class RuntimeSnapshotDTO {
     protected _data: RuntimeSnapshotData;
     private _sdk;
     private _deleted;
     /**
-     * Create a Snapshot instance.
+     * Create a Runtime Snapshot instance.
      *
      * @param data - Snapshot data from API
      * @param sdk - SDK instance
@@ -70,7 +151,7 @@ export declare class Snapshot {
      * @param config - Optional runtime configuration to override defaults
      * @returns Created Runtime instance
      */
-    restore(minutesLimit: number): Promise<Runtime>;
+    restore(minutesLimit: number): Promise<RuntimeDTO>;
     /**
      * Get snapshot data in camelCase format.
      * Returns only the core fields that consumers need.
@@ -79,7 +160,7 @@ export declare class Snapshot {
      *
      * @returns Core snapshot data with camelCase properties
      */
-    toJSON(): SnapshotJSON;
+    toJSON(): RuntimeSnapshotJSON;
     /**
      * Get the raw snapshot data exactly as received from the API.
      * This preserves the original snake_case naming from the API response.

package/lib/{client/models/Snapshot.js → models/RuntimeSnapshotDTO.js}

@@ -2,8 +2,8 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-import { snapshots } from '../../api/runtimes';
-import { validateJSON } from '../../api/utils/validation';
+import { snapshots } from '../api/runtimes';
+import { validateJSON } from '../api/utils/validation';
 /**
  * Snapshot domain model that wraps API responses with convenient methods.
  * Provides runtime snapshot management with data refresh and lifecycle operations.
@@ -14,12 +14,12 @@ import { validateJSON } from '../../api/utils/validation';
  * const runtime = await snapshot.restore();
  * ```
  */
-export class Snapshot {
+export class RuntimeSnapshotDTO {
     _data;
     _sdk;
     _deleted = false;
     /**
-     * Create a Snapshot instance.
+     * Create a Runtime Snapshot instance.
      *
      * @param data - Snapshot data from API
      * @param sdk - SDK instance

package/lib/models/SpaceDTO.d.ts

@@ -0,0 +1,280 @@
+import type { DatalayerClient } from '../index';
+import { NotebookDTO, type NotebookJSON } from './NotebookDTO';
+import { NotebookData } from './NotebookDTO';
+import { LexicalDTO, type LexicalJSON } from './LexicalDTO';
+/**
+ * Represents a workspace or project space in Datalayer
+ * @interface SpaceData
+ */
+export interface SpaceData {
+    uid: string;
+    name_t: string;
+    handle_s: string;
+    variant_s: string;
+    description_t: string;
+    tags_ss?: string[];
+    members?: any[];
+    items?: any[];
+}
+/**
+ * Stable public interface for Space data.
+ * This is the contract that SDK consumers can rely on.
+ * The raw API may change, but this interface remains stable.
+ */
+export interface SpaceJSON {
+    /** ulid for the space */
+    uid: string;
+    /** Name of the space */
+    name: string;
+    /** Handle for the space */
+    handle: string;
+    /** Variant of the space */
+    variant: string;
+    /** Description of the space */
+    description: string;
+    /** Items contained in the space (as JSON) */
+    items: Array<NotebookJSON | LexicalJSON>;
+}
+/**
+ * Space domain model that wraps API responses with convenient methods.
+ * Provides workspace management with data refresh and content creation operations.
+ *
+ * @example
+ * ```typescript
+ * const space = spaces[0];
+ * const items = await space.getItems();
+ * const notebook = await space.createNotebook({ name: 'Analysis' });
+ * ```
+ */
+export declare class SpaceDTO {
+    protected _data: SpaceData;
+    private _sdk;
+    private _items;
+    private _deleted;
+    /**
+     * Create a Space instance.
+     *
+     * @param data - Space data from API
+     * @param sdk - SDK instance
+     */
+    constructor(data: SpaceData, sdk: DatalayerClient);
+    /**
+     * Check if this space has been deleted and throw error if so.
+     * @throws Error if deleted
+     */
+    private _checkDeleted;
+    /**
+     * Refresh space data from the API by fetching user's spaces.
+     */
+    refresh(): Promise<void>;
+    /** Unique identifier for the space. */
+    get uid(): string;
+    /** URL-friendly handle for the space. */
+    get handle(): string;
+    /** Space variant type. */
+    get variant(): string;
+    /**
+     * The name of the space.
+     */
+    get name(): string;
+    /**
+     * The description of the space.
+     */
+    get description(): string;
+    /**
+     * Helper method to create items in this space.
+     *
+     * @param itemType - Type of item to create
+     * @param data - Creation configuration
+     * @returns Created model instance
+     * @internal
+     */
+    private _createItem;
+    /**
+     * Get all items in this space as model instances.
+     *
+     * @returns Array of Notebook and Lexical model instances
+     */
+    getItems(): Promise<(NotebookDTO | LexicalDTO)[]>;
+    /**
+     * Create a new notebook in this space.
+     *
+     * @param data - Notebook creation configuration
+     * @returns Created Notebook instance
+     */
+    createNotebook(data: {
+        name: string;
+        description: string;
+        file?: File | Blob;
+    }): Promise<NotebookDTO>;
+    /**
+     * Create a new lexical document in this space.
+     *
+     * @param data - Lexical creation configuration
+     * @returns Created Lexical instance
+     */
+    createLexical(data: {
+        name: string;
+        description: string;
+        file?: File | Blob;
+    }): Promise<LexicalDTO>;
+    /**
+     * Get raw space data object.
+     * Returns cached data without refreshing.
+     *
+     * @returns Raw space data object
+     */
+    /**
+     * Get space data in camelCase format.
+     * Returns only the core fields that consumers need.
+     * This provides a stable interface regardless of API changes.
+     *
+     * @returns Core space data with camelCase properties
+     */
+    toJSON(): SpaceJSON;
+    /**
+     * Get the raw space data exactly as received from the API.
+     * This preserves the original snake_case naming from the API response.
+     *
+     * @returns Raw space data from API
+     */
+    rawData(): SpaceData;
+    /** String representation of the space. */
+    toString(): string;
+}
+/**
+ * Request payload for creating a new space
+ * @interface CreateSpaceRequest
+ */
+export interface CreateSpaceRequest {
+    name: string;
+    description: string;
+    variant: string;
+    spaceHandle: string;
+    organizationId: string;
+    seedSpaceId: string;
+    public: boolean;
+}
+/**
+ * Response from getting a collaboration session ID
+ * @interface CollaborationSessionResponse
+ */
+export interface CollaborationSessionResponse {
+    success: boolean;
+    sessionId?: string;
+    error?: string;
+}
+/**
+ * Response from creating a space
+ * @interface CreateSpaceResponse
+ */
+export interface CreateSpaceResponse {
+    success: boolean;
+    message: string;
+    space?: SpaceData;
+}
+/**
+ * Request payload for creating a new notebook (multipart/form-data)
+ * @interface CreateNotebookRequest
+ */
+export interface CreateNotebookRequest {
+    spaceId: string;
+    notebookType: string;
+    name: string;
+    description: string;
+    file?: File | Blob;
+}
+/**
+ * Response from creating a notebook
+ * @interface CreateNotebookResponse
+ */
+export interface CreateNotebookResponse {
+    success: boolean;
+    message: string;
+    notebook?: NotebookData;
+}
+/**
+ * Response from getting a notebook
+ * @interface GetNotebookResponse
+ */
+export interface GetNotebookResponse {
+    success: boolean;
+    message: string;
+    notebook?: NotebookData;
+}
+/**
+ * Request payload for creating a notebook
+ * @interface CreateNotebookRequest
+ */
+export interface CreateNotebookRequest {
+    spaceId: string;
+    notebookType: string;
+    name: string;
+    description: string;
+    file?: File | Blob;
+}
+/**
+ * Request payload for updating a notebook
+ * @interface UpdateNotebookRequest
+ */
+export interface UpdateNotebookRequest {
+    name?: string;
+    description?: string;
+}
+/**
+ * Response from updating a notebook
+ * @interface UpdateNotebookResponse
+ */
+export interface UpdateNotebookResponse {
+    success: boolean;
+    message: string;
+    notebook?: NotebookData;
+}
+/**
+ * Represents an item within a space
+ * @interface SpaceItem
+ */
+export interface SpaceItem {
+    id: string;
+    type_s: 'notebook' | 'lexical';
+    space_id: string;
+    item_id: string;
+    name: string;
+    created_at: string;
+    updated_at?: string;
+}
+/**
+ * Response from getting space items
+ * @interface GetSpaceItemsResponse
+ */
+export interface GetSpaceItemsResponse {
+    success: boolean;
+    message: string;
+    items: SpaceItem[];
+}
+/**
+ * Response from deleting a space item
+ * @interface DeleteSpaceItemResponse
+ */
+export interface DeleteSpaceItemResponse {
+    success: boolean;
+    message: string;
+}
+/**
+ * Response from getting a single space item
+ * @interface GetSpaceItemResponse
+ */
+export interface GetSpaceItemResponse {
+    success: boolean;
+    message: string;
+    item?: any;
+}
+/**
+ * Response from getting spaces for a user
+ * @interface SpacesForUserResponse
+ */
+export interface SpacesForUserResponse {
+    success: boolean;
+    message: string;
+    spaces: SpaceData[];
+}