@datalayer/core 0.0.13 → 0.0.14

package/lib/api/types/index.js

@@ -1,38 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * TypeScript type definitions for all Datalayer API services.
- *
- * This module consolidates all type definitions used by the SDK, providing
- * comprehensive TypeScript support for requests, responses, and data models
- * across all Datalayer services.
- *
- * These types follow the exact backend API format (snake_case naming) to
- * ensure compatibility. For frontend business logic types with camelCase
- * naming, see the models in `/src/models/`.
- *
- * @example
- * ```typescript
- * import type {
- *   Runtime,
- *   Environment,
- *   Space,
- *   Notebook,
- *   User,
- *   LoginRequest
- * } from '@datalayer/core/api/types';
- *
- * // Use types for function parameters and return values
- * function createRuntime(config: CreateRuntimeRequest): Promise<Runtime> {
- *   // Implementation
- * }
- * ```
- *
- * @module types
- */
-export * from './common';
-export * from './runtimes';
-export * from './iam';
-export * from './spacer';

package/lib/api/types/runtimes.d.ts

@@ -1,205 +0,0 @@
-/**
- * Represents a computing environment available in the Datalayer platform
- * @interface Environment
- */
-export interface Environment {
-    /** 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 */
-    kernel?: {
-        /** 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[];
-}
-/**
- * Represents a running instance of a computing environment
- * @interface Runtime
- */
-export interface Runtime {
-    /** 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;
-}
-/**
- * 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;
-}
-/**
- * Represents a snapshot of a runtime's state and files
- * @interface RuntimeSnapshot
- */
-export interface RuntimeSnapshot {
-    /** 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[];
-}
-/**
- * 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 SnapshotGetResponse
- */
-export interface SnapshotGetResponse {
-    /** Indicates if the request was successful */
-    success: boolean;
-    /** Response message */
-    message: string;
-    /** The snapshot details */
-    snapshot: RuntimeSnapshot;
-}
-/**
- * Response for creating a runtime snapshot
- * @interface SnapshotCreateResponse
- */
-export interface SnapshotCreateResponse {
-    /** Indicates if the request was successful */
-    success: boolean;
-    /** Response message */
-    message: string;
-    /** The created snapshot details */
-    snapshot: RuntimeSnapshot;
-}
-/**
- * Response from listing available environments
- * @interface EnvironmentsListResponse
- */
-export interface EnvironmentsListResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of available environments */
-    environments: Environment[];
-}
-/**
- * Response from creating a new runtime
- * @interface RuntimeCreateResponse
- */
-export interface CreateRuntimeResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** The created runtime instance */
-    runtime: Runtime;
-}
-/**
- * Response from listing runtimes
- * @interface RuntimesListResponse
- */
-export interface RuntimesListResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of runtime instances */
-    runtimes: Runtime[];
-}
-/**
- * Response from listing runtime snapshots
- * @interface RuntimeSnapshotsListResponse
- */
-export interface SnapshotsListResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of runtime snapshots */
-    snapshots: RuntimeSnapshot[];
-}

package/lib/api/types/runtimes.js

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

package/lib/api/types/spacer.d.ts

@@ -1,243 +0,0 @@
-/**
- * Represents a workspace or project space in Datalayer
- * @interface Space
- */
-export interface Space {
-    uid: string;
-    name_t: string;
-    handle_s: string;
-    variant_s: string;
-    description_t: string;
-    tags_ss?: string[];
-    members?: any[];
-    items?: any[];
-}
-/**
- * Represents a Jupyter notebook document
- * @interface Notebook
- */
-export interface Notebook {
-    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;
-}
-/**
- * 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?: Space;
-}
-/**
- * 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?: Notebook;
-}
-/**
- * Response from getting a notebook
- * @interface GetNotebookResponse
- */
-export interface GetNotebookResponse {
-    success: boolean;
-    message: string;
-    notebook?: Notebook;
-}
-/**
- * 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?: Notebook;
-}
-/**
- * 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;
-}
-/**
- * Represents a Lexical document (rich text editor)
- * @interface Lexical
- */
-export interface Lexical {
-    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?: Lexical;
-}
-/**
- * Response from getting a Lexical document
- * @interface GetLexicalResponse
- */
-export interface GetLexicalResponse {
-    success: boolean;
-    message: string;
-    document?: Lexical;
-}
-/**
- * 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: Lexical;
-}
-/**
- * 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: Space[];
-}

package/lib/api/types/spacer.js

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

package/lib/client/models/Space.d.ts

@@ -1,135 +0,0 @@
-/**
- * Space domain model for the Datalayer SDK.
- *
- * @module client/models/Space
- */
-import type { Space as SpaceData } from '../../api/types/spacer';
-import type { DatalayerClient } from '../index';
-import { Notebook, type NotebookJSON } from './Notebook';
-import { Lexical, type LexicalJSON } from './Lexical';
-/**
- * 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 Space {
-    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<(Notebook | Lexical)[]>;
-    /**
-     * 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<Notebook>;
-    /**
-     * 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<Lexical>;
-    /**
-     * 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;
-}

package/lib/client/models/index.d.ts

@@ -1,26 +0,0 @@
-/**
- * Domain model classes for the Datalayer SDK.
- * These models wrap API responses with convenient methods and state management.
- *
- * @module client/models
- *
- * @example
- * ```typescript
- * const runtime = await sdk.createRuntime(config);
- * const snapshot = await runtime.createSnapshot('checkpoint');
- * ```
- */
-export { Environment } from './Environment';
-export { Item } from './Item';
-export { Runtime } from './Runtime';
-export { Snapshot } from './Snapshot';
-export { Notebook } from './Notebook';
-export { Lexical } from './Lexical';
-export { Space } from './Space';
-export { Credits } from './Credits';
-export type { EnvironmentJSON } from './Environment';
-export type { RuntimeJSON } from './Runtime';
-export type { SnapshotJSON } from './Snapshot';
-export type { SpaceJSON } from './Space';
-export type { NotebookJSON } from './Notebook';
-export type { LexicalJSON } from './Lexical';

package/lib/client/models/index.js

@@ -1,25 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Domain model classes for the Datalayer SDK.
- * These models wrap API responses with convenient methods and state management.
- *
- * @module client/models
- *
- * @example
- * ```typescript
- * const runtime = await sdk.createRuntime(config);
- * const snapshot = await runtime.createSnapshot('checkpoint');
- * ```
- */
-// Export domain model classes
-export { Environment } from './Environment';
-export { Item } from './Item';
-export { Runtime } from './Runtime';
-export { Snapshot } from './Snapshot';
-export { Notebook } from './Notebook';
-export { Lexical } from './Lexical';
-export { Space } from './Space';
-export { Credits } from './Credits';