@datalayer/core 0.0.9 → 0.0.11

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

@@ -0,0 +1,180 @@
+/**
+ * Represents a user in the Datalayer platform
+ * @interface User
+ */
+export interface User {
+    /** Unique identifier for the user */
+    id: string;
+    /** Alternative unique identifier (UUID format) */
+    uid?: string;
+    /** User ID in the authentication system */
+    user_id?: string;
+    /** Username for login */
+    username?: string;
+    /** User's handle or nickname */
+    handle?: string;
+    /** User's email address */
+    email: string;
+    /** User's first name */
+    first_name?: string;
+    /** User's last name */
+    last_name?: string;
+    /** Display name shown in the UI */
+    display_name?: string;
+    /** URL to the user's avatar image */
+    avatar_url?: string;
+    /** Alternative property name for avatar URL (for backwards compatibility) */
+    avatarUrl?: string;
+    /** ISO 8601 timestamp of when the user was created */
+    created_at?: string;
+    /** ISO 8601 timestamp of when the user was last updated */
+    updated_at?: string;
+    /** Whether the user account is active */
+    is_active?: boolean;
+    /** Whether the user's email has been verified */
+    is_verified?: boolean;
+    /** Whether multi-factor authentication is enabled */
+    mfa_enabled?: boolean;
+}
+/**
+ * Request payload for user login
+ * @interface LoginRequest
+ *
+ * Must provide either:
+ * - handle + password for credential-based authentication
+ * - token for token-based authentication
+ *
+ * Both methods cannot be used simultaneously.
+ */
+export interface LoginRequest {
+    /** User handle (username/email) for credential-based authentication */
+    handle?: string;
+    /** User's password for credential-based authentication */
+    password?: string;
+    /** Authentication token for token-based authentication */
+    token?: string;
+}
+/**
+ * Response from a successful login request
+ * @interface LoginResponse
+ */
+export interface LoginResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** User information for the authenticated user */
+    user: {
+        /** 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;
+        /** ISO 8601 timestamp of when the user joined */
+        join_ts_dt: string;
+        /** ISO 8601 timestamp of when the user was last updated */
+        last_update_ts_dt: string;
+        /** Origin of the user account */
+        origin_s: string;
+        /** Type of the entity */
+        type_s: string;
+        /** Alternative unique identifier (UUID format) */
+        uid: string;
+        /** User's email address */
+        email_s: string;
+        /** User's first name */
+        first_name_t: string;
+        /** User's handle or identifier */
+        handle_s: string;
+        /** User's last name */
+        last_name_t: string;
+        /** Additional fields that may be present in the response */
+        [key: string]: any;
+    };
+    /** JWT token for API authentication */
+    token: string;
+}
+/**
+ * Response from the /me endpoint containing current user information
+ * @interface UserMeResponse
+ */
+export interface UserMeResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** Current user's profile information */
+    me: {
+        /** Unique identifier (full ID) for the user */
+        id: string;
+        /** Unique identifier (UID) for the user */
+        uid: string;
+        /** User handle (username) */
+        handle: string;
+        /** Email address of the user */
+        email: string;
+        /** First name of the user */
+        firstName: string;
+        /** Last name of the user */
+        lastName: string;
+        /** Avatar URL for the user */
+        avatarUrl: string;
+        /** Array of roles assigned to the user */
+        roles: string[];
+    };
+}
+/**
+ * Response from the /whoami endpoint
+ * @interface WhoAmIResponse
+ */
+export interface WhoAmIResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** User profile information */
+    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;
+    };
+}
+/**
+ * Response from the health check ping endpoint
+ * @interface HealthzPingResponse
+ */
+export interface HealthzPingResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** Service status information */
+    status: {
+        /** Status indicator (e.g., "OK") */
+        status: string;
+    };
+    /** API version */
+    version: string;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * @module types
+ * @description 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
+ * }
+ * ```
+ */
+export * from './runtimes';
+export * from './iam';
+export * from './spacer';

package/lib/api/types/index.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * @module types
+ * @description 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
+ * }
+ * ```
+ */
+export * from './runtimes';
+export * from './iam';
+export * from './spacer';

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

@@ -0,0 +1,235 @@
+/**
+ * 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;
+    /** Credits allocated to this runtime */
+    credits?: number;
+    /** Current state of the runtime */
+    state?: 'starting' | 'running' | 'stopping' | 'stopped' | 'error';
+    /** Type of runtime - notebook, terminal, or job */
+    type?: 'notebook' | 'terminal' | 'job';
+    /** Type of runtime (deprecated, use type) */
+    runtime_type?: 'notebook' | 'cell';
+    /** Credits consumed per hour */
+    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;
+    /** Reservation ID if runtime is reserved */
+    reservation_id?: string;
+    /** ISO 8601 timestamp of when the runtime started */
+    started_at?: string;
+    /** ISO 8601 timestamp of when the runtime will expire */
+    expired_at?: string;
+    /** ISO 8601 timestamp of when the runtime was created */
+    created_at?: string;
+    /** ISO 8601 timestamp of last update */
+    updated_at?: string;
+    /** Jupyter kernel ID if applicable */
+    kernel_id?: string;
+    /** Path to the notebook file if runtime is for a notebook */
+    notebook_path?: string;
+    /** Cell ID if runtime is for a specific cell */
+    cell_id?: string;
+    /** URL for accessing Jupyter server */
+    jupyter_url?: string;
+    /** Token for Jupyter server authentication */
+    jupyter_token?: string;
+    /** Detailed status information */
+    status?: any;
+    /** Alternative naming from API responses */
+    podName?: string;
+    /** Alternative naming from API responses */
+    createdAt?: string;
+    /** Alternative naming from API responses */
+    environment?: 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

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