@datalayer/core 0.0.12 → 0.0.14

package/lib/models/EnvironmentDTO.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Environment domain model for the Datalayer SDK.
+ *
+ * @module models/EnvironmentDTO
+ */
+import type { DatalayerClient } from '../index';
+/**
+ * Represents a computing environment available in the Datalayer platform.
+ * @interface EnvironmentData
+ */
+export interface EnvironmentData {
+    /** 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 */
+    runtime?: {
+        /** 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[];
+}
+/**
+ * Stable public interface for Environment data.
+ * This is the contract that SDK consumers can rely on.
+ * The raw API may change, but this interface remains stable.
+ */
+export interface EnvironmentJSON {
+    /** Human-readable title for the environment */
+    title: string;
+    /** Unique name identifier for the environment */
+    name: string;
+    /** Credits consumed per hour for this environment */
+    burningRate: number;
+    /** Description of the environment (contains HTML markup) */
+    description: string;
+    /** Rich description of the environment (contains HTML markup) */
+    richDescription: string;
+}
+/**
+ * Response from listing available environments
+ * @interface ListEnvironmentsResponse
+ */
+export interface ListEnvironmentsResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** Array of available environments */
+    environments: EnvironmentData[];
+}
+/**
+ * Environment domain model that wraps API responses with convenient methods.
+ * Provides information about available computational environments.
+ *
+ * @example
+ * ```typescript
+ * const environments = await sdk.listEnvironments();
+ * const aiEnv = environments.find(env => env.name === 'ai-env');
+ * console.log(aiEnv.title); // "AI Environment"
+ * ```
+ */
+export declare class EnvironmentDTO {
+    /** @internal */
+    _data: EnvironmentData;
+    /**
+     * Create an Environment instance.
+     *
+     * @param data - Environment data from API
+     * @param _sdk - SDK instance (not currently used but kept for consistency)
+     */
+    constructor(data: EnvironmentData, _sdk: DatalayerClient);
+    /** Human-readable title for the environment (e.g., 'AI Environment', 'Python CPU Environment'). */
+    get title(): string;
+    /** Unique name identifier for the environment (e.g., 'ai-env', 'python-cpu-env'). */
+    get name(): string;
+    /** Credits consumed per hour for this environment. */
+    get burningRate(): number;
+    /** Rich description of the environment (contains HTML markup). */
+    get richDescription(): string;
+    /** Clean description without HTML tags. */
+    get description(): string;
+    /**
+     * Get environment data in camelCase format.
+     * Returns only the core fields that consumers need.
+     * This provides a stable interface regardless of API changes.
+     *
+     * @returns Core environment data with camelCase properties
+     */
+    toJSON(): EnvironmentJSON;
+    /**
+     * Get the raw environment data exactly as received from the API.
+     * This preserves the original snake_case naming from the API response.
+     *
+     * @returns Raw environment data from API
+     */
+    rawData(): EnvironmentData;
+    /** String representation of the environment. */
+    toString(): string;
+}

package/lib/models/EnvironmentDTO.js

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { validateJSON } from '../api/utils/validation';
+/**
+ * Environment domain model that wraps API responses with convenient methods.
+ * Provides information about available computational environments.
+ *
+ * @example
+ * ```typescript
+ * const environments = await sdk.listEnvironments();
+ * const aiEnv = environments.find(env => env.name === 'ai-env');
+ * console.log(aiEnv.title); // "AI Environment"
+ * ```
+ */
+export class EnvironmentDTO {
+    /** @internal */
+    _data;
+    /**
+     * Create an Environment instance.
+     *
+     * @param data - Environment data from API
+     * @param _sdk - SDK instance (not currently used but kept for consistency)
+     */
+    constructor(data, _sdk) {
+        this._data = data;
+        // SDK instance not currently used but kept for future extensibility
+    }
+    // ========================================================================
+    // Properties
+    // ========================================================================
+    /** Human-readable title for the environment (e.g., 'AI Environment', 'Python CPU Environment'). */
+    get title() {
+        return this._data.title;
+    }
+    /** Unique name identifier for the environment (e.g., 'ai-env', 'python-cpu-env'). */
+    get name() {
+        return this._data.name;
+    }
+    /** Credits consumed per hour for this environment. */
+    get burningRate() {
+        return this._data.burning_rate;
+    }
+    /** Rich description of the environment (contains HTML markup). */
+    get richDescription() {
+        return this._data.description;
+    }
+    /** Clean description without HTML tags. */
+    get description() {
+        // Simple HTML tag removal
+        return this._data.description.replace(/<[^>]*>/g, '').trim();
+    }
+    // ========================================================================
+    // Utility Methods
+    // ========================================================================
+    /**
+     * Get environment data in camelCase format.
+     * Returns only the core fields that consumers need.
+     * This provides a stable interface regardless of API changes.
+     *
+     * @returns Core environment data with camelCase properties
+     */
+    toJSON() {
+        const obj = {
+            title: this.title,
+            name: this.name,
+            burningRate: this.burningRate,
+            description: this.description,
+            richDescription: this.richDescription,
+        };
+        validateJSON(obj, 'Environment');
+        return obj;
+    }
+    /**
+     * Get the raw environment data exactly as received from the API.
+     * This preserves the original snake_case naming from the API response.
+     *
+     * @returns Raw environment data from API
+     */
+    rawData() {
+        return this._data;
+    }
+    /** String representation of the environment. */
+    toString() {
+        return `Environment(${this.name}, ${this.title})`;
+    }
+}

package/lib/models/HealthCheck.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Represents a health check response from a Datalayer service.
+ * Provides standardized health status information across all services.
+ */
+export declare class HealthCheck {
+    healthy: boolean;
+    status: string;
+    responseTime: number;
+    errors: string[];
+    timestamp: Date;
+    /**
+     * Create a HealthCheck instance.
+     * @param data - The health check data
+     * @param sdk - Reference to the SDK instance (unused but kept for consistency)
+     */
+    constructor(data: any, sdk: any);
+    /**
+     * Check if the service is healthy.
+     * @returns True if the service is healthy
+     */
+    isHealthy(): boolean;
+    /**
+     * Get the service status.
+     * @returns The status string
+     */
+    getStatus(): string;
+    /**
+     * Get the response time in milliseconds.
+     * @returns The response time
+     */
+    getResponseTime(): number;
+    /**
+     * Get any errors reported during the health check.
+     * @returns Array of error messages
+     */
+    getErrors(): string[];
+    /**
+     * Get the timestamp of the health check.
+     * @returns The timestamp
+     */
+    getTimestamp(): Date;
+    /**
+     * Check if there are any errors.
+     * @returns True if there are errors
+     */
+    hasErrors(): boolean;
+    /**
+     * Get a human-readable summary of the health check.
+     * @returns Summary string
+     */
+    getSummary(): string;
+    /**
+     * Convert to a plain object.
+     * @returns Plain object representation
+     */
+    toJSON(): Promise<HealthCheckJSON>;
+    /**
+     * Get a string representation.
+     * @returns String representation
+     */
+    toString(): string;
+}
+/**
+ * JSON representation of a HealthCheck.
+ */
+export interface HealthCheckJSON {
+    healthy: boolean;
+    status: string;
+    responseTime: number;
+    errors: string[];
+    timestamp: string;
+}

package/lib/models/HealthCheck.js

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { validateJSON } from '../api/utils/validation';
+/**
+ * Represents a health check response from a Datalayer service.
+ * Provides standardized health status information across all services.
+ */
+export class HealthCheck {
+    // Properties
+    healthy;
+    status;
+    responseTime;
+    errors;
+    timestamp;
+    /**
+     * Create a HealthCheck instance.
+     * @param data - The health check data
+     * @param sdk - Reference to the SDK instance (unused but kept for consistency)
+     */
+    constructor(data, sdk) {
+        // Initialize properties
+        this.healthy = data.healthy || false;
+        this.status = data.status || 'unknown';
+        this.responseTime = data.responseTime || 0;
+        this.errors = data.errors || [];
+        this.timestamp = data.timestamp ? new Date(data.timestamp) : new Date();
+    }
+    /**
+     * Check if the service is healthy.
+     * @returns True if the service is healthy
+     */
+    isHealthy() {
+        return this.healthy;
+    }
+    /**
+     * Get the service status.
+     * @returns The status string
+     */
+    getStatus() {
+        return this.status;
+    }
+    /**
+     * Get the response time in milliseconds.
+     * @returns The response time
+     */
+    getResponseTime() {
+        return this.responseTime;
+    }
+    /**
+     * Get any errors reported during the health check.
+     * @returns Array of error messages
+     */
+    getErrors() {
+        return this.errors;
+    }
+    /**
+     * Get the timestamp of the health check.
+     * @returns The timestamp
+     */
+    getTimestamp() {
+        return this.timestamp;
+    }
+    /**
+     * Check if there are any errors.
+     * @returns True if there are errors
+     */
+    hasErrors() {
+        return this.errors.length > 0;
+    }
+    /**
+     * Get a human-readable summary of the health check.
+     * @returns Summary string
+     */
+    getSummary() {
+        if (this.healthy) {
+            return `Service is healthy (${this.responseTime}ms response time)`;
+        }
+        else {
+            const errorCount = this.errors.length;
+            return `Service is unhealthy: ${this.status} (${errorCount} error${errorCount !== 1 ? 's' : ''})`;
+        }
+    }
+    /**
+     * Convert to a plain object.
+     * @returns Plain object representation
+     */
+    async toJSON() {
+        const obj = {
+            healthy: this.healthy,
+            status: this.status,
+            responseTime: this.responseTime,
+            errors: this.errors,
+            timestamp: this.timestamp.toISOString(),
+        };
+        validateJSON(obj, 'HealthCheck');
+        return obj;
+    }
+    /**
+     * Get a string representation.
+     * @returns String representation
+     */
+    toString() {
+        return `HealthCheck(${this.status}, healthy=${this.healthy}, responseTime=${this.responseTime}ms)`;
+    }
+}

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

@@ -1,41 +1,4 @@
-/**
- * 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;
-}
+import { Profile } from './Profile';
 /**
  * Request payload for user login
  * @interface LoginRequest
@@ -112,16 +75,18 @@ export interface UserMeResponse {
         uid: string;
         /** User handle (username) */
         handle: string;
-        /** Email address of the user */
+        /** Email address of the user (may be empty string) */
         email: string;
-        /** First name of the user */
+        /** First name of the user (may be empty string) */
         firstName: string;
-        /** Last name of the user */
+        /** Last name of the user (may be empty string) */
         lastName: string;
-        /** Avatar URL for the user */
+        /** Avatar URL for the user (may be empty string) */
         avatarUrl: string;
         /** Array of roles assigned to the user */
         roles: string[];
+        /** Allow additional fields that may come from the server */
+        [key: string]: any;
     };
 }
 /**
@@ -134,47 +99,19 @@ export interface WhoAmIResponse {
     /** 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;
-    };
+    profile: Profile;
 }
 /**
- * Response from the health check ping endpoint
- * @interface HealthzPingResponse
+ * Response from the /memberships endpoint
+ * @interface MembershipsResponse
  */
-export interface HealthzPingResponse {
+export interface MembershipsResponse {
     /** 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;
+    /** User profile information */
+    profile: Profile;
+    /** Memberships information */
+    memberships: any[];
 }

package/lib/models/ItemDTO.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Abstract base class for all Datalayer content items.
+ *
+ * @module models/ItemDTO
+ */
+import type { DatalayerClient } from '../index';
+/**
+ * Abstract base class for all Datalayer content items.
+ * Provides common functionality for content management including lifecycle tracking.
+ *
+ * @template TData - Raw data type from API
+ * @template TUpdateRequest - Update request type for API
+ */
+export declare abstract class ItemDTO<TData> {
+    protected _data: TData;
+    private _sdk;
+    private _deleted;
+    /**
+     * Create an Item instance.
+     * @param data - Item data from API
+     * @param sdk - SDK instance
+     */
+    constructor(data: TData, sdk: DatalayerClient);
+    /** Check if this item has been deleted. */
+    get isDeleted(): boolean;
+    /**
+     * Check if this item has been deleted and throw error if so.
+     * @throws Error if deleted
+     */
+    protected _checkDeleted(): void;
+    /** Item ID. */
+    get id(): string;
+    /** Unique identifier for the item. */
+    get uid(): string;
+    /** Parent space ID. */
+    get spaceId(): string;
+    /** Owner user ID. */
+    get ownerId(): string;
+    /** When the item was created. */
+    get createdAt(): Date;
+    /** The cached update time. */
+    get updatedAt(): Date;
+    /** Get the item type identifier. */
+    abstract get type(): string;
+    /** The cached name. */
+    abstract get name(): string;
+    /** Get the current name from API. */
+    abstract getName(): Promise<string>;
+    /** The cached content. */
+    abstract get content(): any;
+    /** Get when the item was last updated from API. */
+    abstract getUpdatedAt(): Promise<Date>;
+    /** Update the item. */
+    abstract update(...args: any[]): Promise<this>;
+    /**
+     * Delete this item permanently.
+     * After deletion, all subsequent method calls will throw errors.
+     */
+    delete(): Promise<void>;
+    /** Get the document content from API. */
+    getContent(): Promise<any>;
+    /** Get raw item data object. */
+    rawData(): TData;
+    /** Convert to JSON representation - must be implemented by subclasses. */
+    abstract toJSON(): any;
+    /** String representation of the item. */
+    toString(): string;
+    /** Get SDK token for API calls. */
+    protected _getToken(): string;
+    /** Get spacer API URL for API calls. */
+    protected _getSpacerRunUrl(): string;
+    /** Update internal data after API call. */
+    protected _updateData(newData: TData): void;
+}