@datalayer/core 0.0.13 → 0.0.14

package/lib/{api/types/iam.d.ts → models/IAM.d.ts}

@@ -1,89 +1,4 @@
-/**
- * Represents a user in the Datalayer platform
- * @interface User
- */
-export interface User {
-    /** uuid for the user */
-    id: string;
-    /** ulid for the user */
-    uid: string;
-    /** User's handle or nickname */
-    handle_s: string;
-    /** User's email address */
-    email_s: string;
-    /** User's first name */
-    first_name_t: string;
-    /** User's last name */
-    last_name_t: string;
-    /** Display name shown in the UI */
-    avatar_url_s: string;
-    /** Additional fields that may be present in the response */
-    [key: string]: any;
-}
-/**
- * Represents a user profile in the Datalayer platform
- * @interface Profile
- */
-interface Profile {
-    /** ISO 8601 timestamp of when the user was created */
-    creation_ts_dt: string;
-    /** Unique identifier for the user */
-    id: string;
-    /** ISO 8601 timestamp of when the user requested to join */
-    join_request_ts_dt: string | null;
-    /** ISO 8601 timestamp of when the user joined */
-    join_ts_dt: string;
-    /** ISO 8601 timestamp of last update */
-    last_update_ts_dt: string;
-    /** Origin of the user account */
-    origin_s: string;
-    /** Type of the record */
-    type_s: string;
-    /** User ID */
-    uid: string;
-    /** Email address */
-    email_s: string;
-    /** First name */
-    first_name_t: string;
-    /** User handle */
-    handle_s: string;
-    /** Last name */
-    last_name_t: string;
-    /** User roles array */
-    roles_ss?: string[];
-    /** Avatar URL */
-    avatar_url_s?: string;
-    /** Onboarding state as JSON string */
-    onboarding_s?: string;
-    /** New password request timestamp */
-    new_password_request_ts_dt?: string | null;
-    /** New password confirmation timestamp */
-    new_password_confirmation_ts_dt?: string | null;
-    /** Customer UID */
-    customer_uid?: string | null;
-    /** Credits customer UID for billing */
-    credits_customer_uid?: string | null;
-    /** Email unsubscription status */
-    unsubscribed_from_outbounds_b?: boolean;
-    /** Linked contact UID */
-    linked_contact_uid?: string | null;
-    /** MFA URL */
-    mfa_url_s?: string | null;
-    /** MFA secret */
-    mfa_secret_s?: string | null;
-    /** Email verification token */
-    email_token_s?: string | null;
-    /** Pending email update */
-    email_update_s?: string | null;
-    /** IAM providers (nested structure - not typed in detail) */
-    iam_providers?: any[];
-    /** User settings (nested structure - not typed in detail) */
-    settings?: any;
-    /** User events (nested structure - not typed in detail) */
-    events?: any[];
-    /** Allow additional fields that may come from the server */
-    [key: string]: any;
-}
+import { Profile } from './Profile';
 /**
  * Request payload for user login
  * @interface LoginRequest
@@ -200,4 +115,3 @@ export interface MembershipsResponse {
     /** Memberships information */
     memberships: any[];
 }
-export {};

package/lib/{client/models/Item.d.ts → models/ItemDTO.d.ts}

@@ -1,3 +1,8 @@
+/**
+ * Abstract base class for all Datalayer content items.
+ *
+ * @module models/ItemDTO
+ */
 import type { DatalayerClient } from '../index';
 /**
  * Abstract base class for all Datalayer content items.
@@ -6,7 +11,7 @@ import type { DatalayerClient } from '../index';
  * @template TData - Raw data type from API
  * @template TUpdateRequest - Update request type for API
  */
-export declare abstract class Item<TData> {
+export declare abstract class ItemDTO<TData> {
     protected _data: TData;
     private _sdk;
     private _deleted;

package/lib/{client/models/Item.js → models/ItemDTO.js}

@@ -2,12 +2,7 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-/**
- * Abstract base class for all Datalayer content items.
- *
- * @module client/models/Item
- */
-import * as items from '../../api/spacer/items';
+import * as items from '../api/spacer/items';
 /**
  * Abstract base class for all Datalayer content items.
  * Provides common functionality for content management including lifecycle tracking.
@@ -15,7 +10,7 @@ import * as items from '../../api/spacer/items';
  * @template TData - Raw data type from API
  * @template TUpdateRequest - Update request type for API
  */
-export class Item {
+export class ItemDTO {
     _data;
     _sdk;
     _deleted = false;

package/lib/{client/models/Lexical.d.ts → models/LexicalDTO.d.ts}

@@ -1,11 +1,83 @@
+import type { DatalayerClient } from '../index';
+import { ItemDTO } from './ItemDTO';
 /**
- * Lexical domain model for the Datalayer SDK.
- *
- * @module client/models/Lexical
+ * Represents a Lexical document (rich text editor)
+ * @interface Lexical
  */
-import type { Lexical as LexicalData } from '../../api/types/spacer';
-import type { DatalayerClient } from '../index';
-import { Item } from './Item';
+export interface LexicalData {
+    id: string;
+    uid: string;
+    name?: string;
+    name_t?: string;
+    content?: any;
+    space_id?: string;
+    owner_id?: string;
+    creator_uid?: string;
+    creator_handle_s?: string;
+    created_at?: string;
+    creation_ts_dt?: string;
+    updated_at?: string;
+    last_update_ts_dt?: string;
+    cdn_url_s: string;
+    type_s?: string;
+    public_b?: boolean;
+    description_t?: string;
+    document_name_s?: string;
+    document_extension_s: string;
+    document_format_s?: string;
+    content_length_i?: number;
+    content_type_s?: string;
+    mime_type_s?: string;
+    s3_path_s?: string;
+    s3_url_s?: string;
+    model_s?: string;
+}
+/**
+ * Request payload for creating a Lexical document
+ * @interface CreateLexicalRequest
+ */
+export interface CreateLexicalRequest {
+    spaceId: string;
+    documentType: string;
+    name: string;
+    description: string;
+    file?: File | Blob;
+}
+/**
+ * Response from creating a Lexical document
+ * @interface CreateLexicalResponse
+ */
+export interface CreateLexicalResponse {
+    success: boolean;
+    message: string;
+    document?: LexicalData;
+}
+/**
+ * Response from getting a Lexical document
+ * @interface GetLexicalResponse
+ */
+export interface GetLexicalResponse {
+    success: boolean;
+    message: string;
+    document?: LexicalData;
+}
+/**
+ * Request payload for updating a Lexical document
+ * @interface UpdateLexicalRequest
+ */
+export interface UpdateLexicalRequest {
+    name?: string;
+    description?: string;
+}
+/**
+ * Response from updating a Lexical document
+ * @interface UpdateLexicalResponse
+ */
+export interface UpdateLexicalResponse {
+    success: boolean;
+    message: string;
+    document: LexicalData;
+}
 /**
  * Stable public interface for Lexical data.
  * This is the contract that SDK consumers can rely on.
@@ -41,7 +113,7 @@ export interface LexicalJSON {
  * await lexical.update({ name: 'Updated Documentation' });
  * ```
  */
-export declare class Lexical extends Item<LexicalData> {
+export declare class LexicalDTO extends ItemDTO<LexicalData> {
     /**
      * Create a Lexical instance.
      *

package/lib/{client/models/Lexical.js → models/LexicalDTO.js}

@@ -2,10 +2,15 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-import * as lexicals from '../../api/spacer/lexicals';
-import { Item } from './Item';
-import { ItemTypes } from '../constants';
-import { validateJSON } from '../../api/utils/validation';
+/**
+ * Lexical domain model for the Datalayer SDK.
+ *
+ * @module models/LexicalDTO
+ */
+import * as lexicals from '../api/spacer/lexicals';
+import { ItemTypes } from '../client';
+import { ItemDTO } from './ItemDTO';
+import { validateJSON } from '../api/utils/validation';
 /**
  * Lexical domain model that extends the base Item class.
  * Provides lexical document functionality for managing rich text documents.
@@ -16,7 +21,7 @@ import { validateJSON } from '../../api/utils/validation';
  * await lexical.update({ name: 'Updated Documentation' });
  * ```
  */
-export class Lexical extends Item {
+export class LexicalDTO extends ItemDTO {
     /**
      * Create a Lexical instance.
      *

package/lib/{client/models/Notebook.d.ts → models/NotebookDTO.d.ts}

@@ -1,11 +1,20 @@
+import type { DatalayerClient } from '../index';
+import { ItemDTO } from './ItemDTO';
 /**
- * Notebook domain model for the Datalayer SDK.
- *
- * @module client/models/Notebook
+ * Represents a Jupyter notebook document
+ * @interface NotebookData
  */
-import type { Notebook as NotebookData } from '../../api/types/spacer';
-import type { DatalayerClient } from '../index';
-import { Item } from './Item';
+export interface NotebookData {
+    id: string;
+    uid: string;
+    name_t: string;
+    description_t: string;
+    type_s: string;
+    notebook_extension_s: string;
+    s3_path_s: string;
+    s3_url_s: string;
+    cdn_url_s: string;
+}
 /**
  * Stable public interface for Notebook data.
  * This is the contract that SDK consumers can rely on.
@@ -37,7 +46,7 @@ export interface NotebookJSON {
  * const kernelSpec = await notebook.getKernelSpec();
  * ```
  */
-export declare class Notebook extends Item<NotebookData> {
+export declare class NotebookDTO extends ItemDTO<NotebookData> {
     /**
      * Create a Notebook instance.
      *

package/lib/{client/models/Notebook.js → models/NotebookDTO.js}

@@ -2,10 +2,10 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-import * as notebooks from '../../api/spacer/notebooks';
-import { Item } from './Item';
-import { ItemTypes } from '../constants';
-import { validateJSON } from '../../api/utils/validation';
+import * as notebooks from '../api/spacer/notebooks';
+import { ItemDTO } from './ItemDTO';
+import { ItemTypes } from '../client/constants';
+import { validateJSON } from '../api/utils/validation';
 /**
  * Notebook domain model that extends the base Item class.
  * Provides notebook-specific functionality for managing Jupyter notebooks.
@@ -16,7 +16,7 @@ import { validateJSON } from '../../api/utils/validation';
  * const kernelSpec = await notebook.getKernelSpec();
  * ```
  */
-export class Notebook extends Item {
+export class NotebookDTO extends ItemDTO {
     /**
      * Create a Notebook instance.
      *

package/lib/models/Profile.d.ts

@@ -1 +1,66 @@
 export type IProfileType = 'user' | 'organization' | undefined;
+/**
+ * Represents a user profile in the Datalayer platform
+ * @interface Profile
+ */
+export interface Profile {
+    /** ISO 8601 timestamp of when the user was created */
+    creation_ts_dt: string;
+    /** Unique identifier for the user */
+    id: string;
+    /** ISO 8601 timestamp of when the user requested to join */
+    join_request_ts_dt: string | null;
+    /** ISO 8601 timestamp of when the user joined */
+    join_ts_dt: string;
+    /** ISO 8601 timestamp of last update */
+    last_update_ts_dt: string;
+    /** Origin of the user account */
+    origin_s: string;
+    /** Type of the record */
+    type_s: string;
+    /** User ID */
+    uid: string;
+    /** Email address */
+    email_s: string;
+    /** First name */
+    first_name_t: string;
+    /** User handle */
+    handle_s: string;
+    /** Last name */
+    last_name_t: string;
+    /** User roles array */
+    roles_ss?: string[];
+    /** Avatar URL */
+    avatar_url_s?: string;
+    /** Onboarding state as JSON string */
+    onboarding_s?: string;
+    /** New password request timestamp */
+    new_password_request_ts_dt?: string | null;
+    /** New password confirmation timestamp */
+    new_password_confirmation_ts_dt?: string | null;
+    /** Customer UID */
+    customer_uid?: string | null;
+    /** Credits customer UID for billing */
+    credits_customer_uid?: string | null;
+    /** Email unsubscription status */
+    unsubscribed_from_outbounds_b?: boolean;
+    /** Linked contact UID */
+    linked_contact_uid?: string | null;
+    /** MFA URL */
+    mfa_url_s?: string | null;
+    /** MFA secret */
+    mfa_secret_s?: string | null;
+    /** Email verification token */
+    email_token_s?: string | null;
+    /** Pending email update */
+    email_update_s?: string | null;
+    /** IAM providers (nested structure - not typed in detail) */
+    iam_providers?: any[];
+    /** User settings (nested structure - not typed in detail) */
+    settings?: any;
+    /** User events (nested structure - not typed in detail) */
+    events?: any[];
+    /** Allow additional fields that may come from the server */
+    [key: string]: any;
+}
+export default Profile;

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.