@datalayer/core 0.0.11 → 0.0.13

package/lib/sdk/client/base.d.ts

@@ -1,88 +0,0 @@
-/**
- * Configuration options for the Datalayer SDK.
- */
-export interface DatalayerSDKConfig {
-    /** Authentication token for API requests. */
-    token?: string;
-    /** URL for the IAM (Identity and Access Management) service. */
-    iamRunUrl?: string;
-    /** URL for the Runtimes service. */
-    runtimesRunUrl?: string;
-    /** URL for the Spacer (workspaces and collaboration) service. */
-    spacerRunUrl?: string;
-}
-/**
- * Base SDK class that provides core configuration and token management.
- *
- * This class serves as the foundation for the DatalayerSDK, handling
- * authentication tokens, service URL configuration, and other common
- * SDK functionality that all mixins can access.
- */
-export declare class DatalayerSDKBase {
-    /** URL for IAM service */
-    readonly iamRunUrl: string;
-    /** URL for Runtimes service */
-    readonly runtimesRunUrl: string;
-    /** URL for Spacer service */
-    readonly spacerRunUrl: string;
-    /** Authentication token */
-    token?: string;
-    /**
-     * Create a DatalayerSDK base instance.
-     *
-     * @param config - SDK configuration options
-     */
-    constructor(config: DatalayerSDKConfig);
-    /**
-     * Update the authentication token for all API requests.
-     *
-     * This method updates the token that will be used for all subsequent
-     * API calls made through the SDK.
-     *
-     * @param token - New authentication token
-     *
-     * @example
-     * ```typescript
-     * // After login, update the SDK with the new token
-     * const loginResponse = await sdk.login(credentials);
-     * sdk.updateToken(loginResponse.access_token);
-     * ```
-     */
-    updateToken(token: string): void;
-    /**
-     * Get the current configuration including service URLs and token.
-     *
-     * @returns The current configuration
-     */
-    getConfig(): DatalayerSDKConfig;
-    /**
-     * Update the configuration for API requests.
-     *
-     * @param config - Configuration updates
-     */
-    updateConfig(config: Partial<DatalayerSDKConfig>): void;
-    /**
-     * Get the IAM service URL for API requests.
-     *
-     * @returns The IAM service URL
-     */
-    getIamRunUrl(): string;
-    /**
-     * Get the Runtimes service URL for API requests.
-     *
-     * @returns The Runtimes service URL
-     */
-    getRuntimesRunUrl(): string;
-    /**
-     * Get the Spacer service URL for API requests.
-     *
-     * @returns The Spacer service URL
-     */
-    getSpacerRunUrl(): string;
-    /**
-     * Get the current authentication token.
-     *
-     * @returns The authentication token
-     */
-    getToken(): string | undefined;
-}

package/lib/sdk/client/base.js

@@ -1,112 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * @module sdk/client/base
- * @description Base SDK class providing core configuration and token management.
- */
-import { DEFAULT_SERVICE_URLS } from '../../api/constants';
-/**
- * Base SDK class that provides core configuration and token management.
- *
- * This class serves as the foundation for the DatalayerSDK, handling
- * authentication tokens, service URL configuration, and other common
- * SDK functionality that all mixins can access.
- */
-export class DatalayerSDKBase {
-    /** URL for IAM service */
-    iamRunUrl;
-    /** URL for Runtimes service */
-    runtimesRunUrl;
-    /** URL for Spacer service */
-    spacerRunUrl;
-    /** Authentication token */
-    token;
-    /**
-     * Create a DatalayerSDK base instance.
-     *
-     * @param config - SDK configuration options
-     */
-    constructor(config) {
-        this.iamRunUrl = config.iamRunUrl || DEFAULT_SERVICE_URLS.IAM;
-        this.runtimesRunUrl =
-            config.runtimesRunUrl || DEFAULT_SERVICE_URLS.RUNTIMES;
-        this.spacerRunUrl = config.spacerRunUrl || DEFAULT_SERVICE_URLS.SPACER;
-        this.token = config.token;
-    }
-    /**
-     * Update the authentication token for all API requests.
-     *
-     * This method updates the token that will be used for all subsequent
-     * API calls made through the SDK.
-     *
-     * @param token - New authentication token
-     *
-     * @example
-     * ```typescript
-     * // After login, update the SDK with the new token
-     * const loginResponse = await sdk.login(credentials);
-     * sdk.updateToken(loginResponse.access_token);
-     * ```
-     */
-    updateToken(token) {
-        this.token = token;
-    }
-    /**
-     * Get the current configuration including service URLs and token.
-     *
-     * @returns The current configuration
-     */
-    getConfig() {
-        return {
-            iamRunUrl: this.iamRunUrl,
-            runtimesRunUrl: this.runtimesRunUrl,
-            spacerRunUrl: this.spacerRunUrl,
-            token: this.token,
-        };
-    }
-    /**
-     * Update the configuration for API requests.
-     *
-     * @param config - Configuration updates
-     */
-    updateConfig(config) {
-        if (config.token !== undefined) {
-            this.updateToken(config.token);
-        }
-        // Note: service URLs cannot be changed after initialization
-    }
-    /**
-     * Get the IAM service URL for API requests.
-     *
-     * @returns The IAM service URL
-     */
-    getIamRunUrl() {
-        return this.iamRunUrl;
-    }
-    /**
-     * Get the Runtimes service URL for API requests.
-     *
-     * @returns The Runtimes service URL
-     */
-    getRuntimesRunUrl() {
-        return this.runtimesRunUrl;
-    }
-    /**
-     * Get the Spacer service URL for API requests.
-     *
-     * @returns The Spacer service URL
-     */
-    getSpacerRunUrl() {
-        return this.spacerRunUrl;
-    }
-    /**
-     * Get the current authentication token.
-     *
-     * @returns The authentication token
-     */
-    getToken() {
-        return this.token;
-    }
-}

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

@@ -1,192 +0,0 @@
-/**
- * @module sdk/client
- * @description Main Datalayer SDK client with intuitive mixin-based API.
- *
- * The DatalayerSDK class provides a unified, flat API for all Datalayer platform
- * services through TypeScript mixins. This design offers the best discoverability
- * and ease of use compared to nested service objects.
- *
- * @example
- * ```typescript
- * import { DatalayerSDK } from '@datalayer/core/sdk';
- *
- * // Initialize SDK
- * const sdk = new DatalayerSDK({
- *   token: 'your-api-token',
- *   baseUrl: 'https://prod1.datalayer.run'
- * });
- *
- * // Flat, intuitive API
- * const user = await sdk.whoami();
- * const environments = await sdk.listEnvironments();
- * const notebook = await sdk.createNotebook(data);
- * const runtime = await sdk.createRuntime(config);
- * await sdk.startRuntime(podName);
- * ```
- */
-import { DatalayerSDKBase, type DatalayerSDKConfig } from './base';
-declare const DatalayerSDKWithMixins: {
-    new (...args: any[]): {
-        getMySpaces(): Promise<import("./models").Space[]>;
-        createSpace(data: import("../..").CreateSpaceRequest): Promise<import("./models").Space>;
-        _extractNotebookId(notebookIdOrInstance: string | import("./models").Notebook): string;
-        _extractLexicalId(lexicalIdOrInstance: string | import("./models").Lexical): string;
-        createNotebook(data: import("../..").CreateNotebookRequest): Promise<import("./models").Notebook>;
-        getNotebook(idOrNotebook: string | import("./models").Notebook): Promise<import("./models").Notebook>;
-        updateNotebook(idOrNotebook: string | import("./models").Notebook, data: import("../..").UpdateNotebookRequest): Promise<import("./models").Notebook>;
-        createLexical(data: import("../..").CreateLexicalRequest): Promise<import("./models").Lexical>;
-        getLexical(idOrLexical: string | import("./models").Lexical): Promise<import("./models").Lexical>;
-        updateLexical(idOrLexical: string | import("./models").Lexical, data: import("../..").UpdateLexicalRequest): Promise<import("./models").Lexical>;
-        getSpaceItems(spaceId: string): Promise<import("../..").GetSpaceItemsResponse>;
-        deleteSpaceItem(itemId: string): Promise<import("../..").DeleteSpaceItemResponse>;
-    };
-} & {
-    new (...args: any[]): {
-        _extractRuntimePodName(runtimePodNameOrInstance: string | import("./models").Runtime): string;
-        _extractSnapshotId(snapshotIdOrInstance: string | import("./models").Snapshot): string;
-        listEnvironments(): Promise<import("../..").Environment[]>;
-        createRuntime(data: import("../..").CreateRuntimeRequest): Promise<import("./models").Runtime>;
-        listRuntimes(): Promise<import("./models").Runtime[]>;
-        getRuntime(podNameOrRuntime: string | import("./models").Runtime): Promise<import("./models").Runtime>;
-        deleteRuntime(podNameOrRuntime: string | import("./models").Runtime): Promise<void>;
-        createSnapshot(data: import("../..").CreateRuntimeSnapshotRequest): Promise<import("./models").Snapshot>;
-        listSnapshots(): Promise<import("./models").Snapshot[]>;
-        getSnapshot(idOrSnapshot: string | import("./models").Snapshot): Promise<import("./models").Snapshot>;
-        deleteSnapshot(idOrSnapshot: string | import("./models").Snapshot): Promise<void>;
-    };
-} & {
-    new (...args: any[]): {
-        whoami(): Promise<import("../..").User>;
-        login(data: import("../..").LoginRequest): Promise<import("../..").LoginResponse>;
-        logout(): Promise<void>;
-    };
-} & {
-    new (...args: any[]): {
-        isIAMHealthy(): Promise<boolean>;
-        isRuntimesHealthy(): Promise<boolean>;
-        isSpacerHealthy(): Promise<boolean>;
-        areAllServicesHealthy(): Promise<boolean>;
-        getHealthStatus(): Promise<{
-            iam: {
-                healthy: boolean;
-                details?: any;
-                error?: string;
-                version?: string;
-            };
-            runtimes: {
-                healthy: boolean;
-                details?: any;
-                error?: string;
-                version?: string;
-            };
-            spacer: {
-                healthy: boolean;
-                details?: any;
-                error?: string;
-                version?: string;
-            };
-            allHealthy: boolean;
-        }>;
-        readonly iamRunUrl: string;
-        readonly runtimesRunUrl: string;
-        readonly spacerRunUrl: string;
-        token?: string;
-        updateToken(token: string): void;
-        getConfig(): DatalayerSDKConfig;
-        updateConfig(config: Partial<DatalayerSDKConfig>): void;
-        getIamRunUrl(): string;
-        getRuntimesRunUrl(): string;
-        getSpacerRunUrl(): string;
-        getToken(): string | undefined;
-    };
-} & typeof DatalayerSDKBase;
-/**
- * Main Datalayer SDK client providing unified access to all platform services.
- *
- * This class uses TypeScript mixins to provide a flat, discoverable API where
- * all methods are directly accessible on the SDK instance. This design offers
- * superior developer experience compared to nested service objects.
- *
- * **Key Features:**
- * - **Flat API**: All methods directly on `sdk.` (e.g., `sdk.createNotebook()`)
- * - **Intuitive naming**: Descriptive method names (e.g., `whoami()` vs `iam.users.me()`)
- * - **Perfect discoverability**: IDE shows all available methods immediately
- * - **Type safety**: Full TypeScript support with comprehensive interfaces
- *
- * **Authentication Methods:**
- * - `whoami()` - Get current user profile
- * - `login(credentials)` - Authenticate with credentials
- * - `logout()` - Log out current user
- *
- * **Environment Methods:**
- * - `listEnvironments()` - List available compute environments
- *
- * **Runtime Methods:**
- * - `createRuntime(config)` - Create new computational runtime
- * - `listRuntimes()` - List all runtimes
- * - `getRuntime(podName)` - Get runtime details
- * - `deleteRuntime(podName)` - Delete runtime
- *
- * **Workspace Methods:**
- * - `createSpace(data)` - Create new workspace
- * - `listSpaces()` - List all workspaces
- * - `getSpace(spaceId)` - Get workspace details
- * - `deleteSpace(spaceId)` - Delete workspace
- *
- * **Notebook Methods:**
- * - `createNotebook(data)` - Create new notebook
- * - `listNotebooks(spaceId?)` - List notebooks
- * - `getNotebook(notebookId)` - Get notebook details
- * - `getNotebookByUid(uid)` - Get notebook by UID
- * - `updateNotebook(notebookId, data)` - Update notebook
- * - `cloneNotebook(data)` - Clone existing notebook
- * - `getNotebookContent(notebookId)` - Get notebook content
- * - `updateNotebookContent(notebookId, content)` - Update notebook content
- * - `deleteNotebook(notebookId)` - Delete notebook
- *
- * **Cell Methods:**
- * - `createCell(notebookId, cell)` - Create new cell
- * - `getCell(notebookId, cellId)` - Get cell details
- * - `deleteCell(notebookId, cellId)` - Delete cell
- *
- * @example
- * ```typescript
- * // Initialize SDK
- * const sdk = new DatalayerSDK({
- *   token: 'your-token',
- *   baseUrl: 'https://prod1.datalayer.run'
- * });
- *
- * // Authentication
- * const user = await sdk.whoami();
- * console.log('Logged in as:', user.email);
- *
- * // Create workspace and notebook
- * const space = await sdk.createSpace({
- *   name: 'My Project'
- * });
- *
- * const notebook = await sdk.createNotebook({
- *   space_id: space.id,
- *   name: 'Analysis'
- * });
- *
- * // Create and start runtime
- * const runtime = await sdk.createRuntime({
- *   environment_name: 'python-cpu-env',
- *   credits_limit: 100
- * });
- *
- * console.log('Setup complete!');
- * ```
- */
-export declare class DatalayerSDK extends DatalayerSDKWithMixins {
-    /**
-     * Create a DatalayerSDK instance.
-     *
-     * @param config - SDK configuration options
-     */
-    constructor(config: DatalayerSDKConfig);
-}
-export type { DatalayerSDKConfig };
-export { DatalayerSDKBase };

package/lib/sdk/client/index.js

@@ -1,128 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * @module sdk/client
- * @description Main Datalayer SDK client with intuitive mixin-based API.
- *
- * The DatalayerSDK class provides a unified, flat API for all Datalayer platform
- * services through TypeScript mixins. This design offers the best discoverability
- * and ease of use compared to nested service objects.
- *
- * @example
- * ```typescript
- * import { DatalayerSDK } from '@datalayer/core/sdk';
- *
- * // Initialize SDK
- * const sdk = new DatalayerSDK({
- *   token: 'your-api-token',
- *   baseUrl: 'https://prod1.datalayer.run'
- * });
- *
- * // Flat, intuitive API
- * const user = await sdk.whoami();
- * const environments = await sdk.listEnvironments();
- * const notebook = await sdk.createNotebook(data);
- * const runtime = await sdk.createRuntime(config);
- * await sdk.startRuntime(podName);
- * ```
- */
-import { DatalayerSDKBase } from './base';
-import { HealthMixin } from './mixins/HealthMixin';
-import { IAMMixin } from './mixins/IAMMixin';
-import { RuntimesMixin } from './mixins/RuntimesMixin';
-import { SpacerMixin } from './mixins/SpacerMixin';
-// Apply mixins to the base class
-const DatalayerSDKWithMixins = SpacerMixin(RuntimesMixin(IAMMixin(HealthMixin(DatalayerSDKBase))));
-/**
- * Main Datalayer SDK client providing unified access to all platform services.
- *
- * This class uses TypeScript mixins to provide a flat, discoverable API where
- * all methods are directly accessible on the SDK instance. This design offers
- * superior developer experience compared to nested service objects.
- *
- * **Key Features:**
- * - **Flat API**: All methods directly on `sdk.` (e.g., `sdk.createNotebook()`)
- * - **Intuitive naming**: Descriptive method names (e.g., `whoami()` vs `iam.users.me()`)
- * - **Perfect discoverability**: IDE shows all available methods immediately
- * - **Type safety**: Full TypeScript support with comprehensive interfaces
- *
- * **Authentication Methods:**
- * - `whoami()` - Get current user profile
- * - `login(credentials)` - Authenticate with credentials
- * - `logout()` - Log out current user
- *
- * **Environment Methods:**
- * - `listEnvironments()` - List available compute environments
- *
- * **Runtime Methods:**
- * - `createRuntime(config)` - Create new computational runtime
- * - `listRuntimes()` - List all runtimes
- * - `getRuntime(podName)` - Get runtime details
- * - `deleteRuntime(podName)` - Delete runtime
- *
- * **Workspace Methods:**
- * - `createSpace(data)` - Create new workspace
- * - `listSpaces()` - List all workspaces
- * - `getSpace(spaceId)` - Get workspace details
- * - `deleteSpace(spaceId)` - Delete workspace
- *
- * **Notebook Methods:**
- * - `createNotebook(data)` - Create new notebook
- * - `listNotebooks(spaceId?)` - List notebooks
- * - `getNotebook(notebookId)` - Get notebook details
- * - `getNotebookByUid(uid)` - Get notebook by UID
- * - `updateNotebook(notebookId, data)` - Update notebook
- * - `cloneNotebook(data)` - Clone existing notebook
- * - `getNotebookContent(notebookId)` - Get notebook content
- * - `updateNotebookContent(notebookId, content)` - Update notebook content
- * - `deleteNotebook(notebookId)` - Delete notebook
- *
- * **Cell Methods:**
- * - `createCell(notebookId, cell)` - Create new cell
- * - `getCell(notebookId, cellId)` - Get cell details
- * - `deleteCell(notebookId, cellId)` - Delete cell
- *
- * @example
- * ```typescript
- * // Initialize SDK
- * const sdk = new DatalayerSDK({
- *   token: 'your-token',
- *   baseUrl: 'https://prod1.datalayer.run'
- * });
- *
- * // Authentication
- * const user = await sdk.whoami();
- * console.log('Logged in as:', user.email);
- *
- * // Create workspace and notebook
- * const space = await sdk.createSpace({
- *   name: 'My Project'
- * });
- *
- * const notebook = await sdk.createNotebook({
- *   space_id: space.id,
- *   name: 'Analysis'
- * });
- *
- * // Create and start runtime
- * const runtime = await sdk.createRuntime({
- *   environment_name: 'python-cpu-env',
- *   credits_limit: 100
- * });
- *
- * console.log('Setup complete!');
- * ```
- */
-export class DatalayerSDK extends DatalayerSDKWithMixins {
-    /**
-     * Create a DatalayerSDK instance.
-     *
-     * @param config - SDK configuration options
-     */
-    constructor(config) {
-        super(config);
-    }
-}
-export { DatalayerSDKBase };

package/lib/sdk/client/mixins/HealthMixin.d.ts

@@ -1,100 +0,0 @@
-import type { DatalayerSDKBase } from '../base';
-/**
- * Interface for health check methods.
- */
-export interface HealthMixinInterface {
-    /** Check if IAM service is healthy */
-    isIAMHealthy(): Promise<boolean>;
-    /** Check if Runtimes service is healthy */
-    isRuntimesHealthy(): Promise<boolean>;
-    /** Check if Spacer service is healthy */
-    isSpacerHealthy(): Promise<boolean>;
-    /** Check if all services are healthy */
-    areAllServicesHealthy(): Promise<boolean>;
-    /** Get detailed health status for all services */
-    getHealthStatus(): Promise<{
-        iam: {
-            healthy: boolean;
-            details?: any;
-            error?: string;
-        };
-        runtimes: {
-            healthy: boolean;
-            details?: any;
-            error?: string;
-        };
-        spacer: {
-            healthy: boolean;
-            details?: any;
-            error?: string;
-        };
-    }>;
-}
-/**
- * Mixin that provides health check functionality for the SDK.
- */
-export declare function HealthMixin<T extends new (...args: any[]) => DatalayerSDKBase>(Base: T): {
-    new (...args: any[]): {
-        /**
-         * Check if the IAM service is healthy.
-         *
-         * @returns True if service is healthy, false otherwise
-         */
-        isIAMHealthy(): Promise<boolean>;
-        /**
-         * Check if the Runtimes service is healthy.
-         *
-         * @returns True if service is healthy, false otherwise
-         */
-        isRuntimesHealthy(): Promise<boolean>;
-        /**
-         * Check if the Spacer service is healthy.
-         *
-         * @returns True if service is healthy, false otherwise
-         */
-        isSpacerHealthy(): Promise<boolean>;
-        /**
-         * Check if all Datalayer services are healthy.
-         *
-         * @returns True if all services are healthy, false otherwise
-         */
-        areAllServicesHealthy(): Promise<boolean>;
-        /**
-         * Get detailed health status for all services.
-         *
-         * @returns Object containing health status and details for each service
-         */
-        getHealthStatus(): Promise<{
-            iam: {
-                healthy: boolean;
-                details?: any;
-                error?: string;
-                version?: string;
-            };
-            runtimes: {
-                healthy: boolean;
-                details?: any;
-                error?: string;
-                version?: string;
-            };
-            spacer: {
-                healthy: boolean;
-                details?: any;
-                error?: string;
-                version?: string;
-            };
-            allHealthy: boolean;
-        }>;
-        readonly iamRunUrl: string;
-        readonly runtimesRunUrl: string;
-        readonly spacerRunUrl: string;
-        token?: string;
-        updateToken(token: string): void;
-        getConfig(): import("..").DatalayerSDKConfig;
-        updateConfig(config: Partial<import("..").DatalayerSDKConfig>): void;
-        getIamRunUrl(): string;
-        getRuntimesRunUrl(): string;
-        getSpacerRunUrl(): string;
-        getToken(): string | undefined;
-    };
-} & T;