@datalayer/core 0.0.9 → 0.0.11

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

@@ -0,0 +1,134 @@
+import type { Environment, CreateRuntimeRequest, CreateRuntimeSnapshotRequest } from '../../../api/types/runtimes';
+import type { Constructor } from '../utils/mixins';
+import { Runtime } from '../models/Runtime';
+import { Snapshot } from '../models/Snapshot';
+/**
+ * Runtimes mixin that provides computational environment and runtime management.
+ *
+ * This mixin is applied to the DatalayerSDK class to provide clean, intuitive
+ * methods for managing environments and runtimes.
+ */
+export declare function RuntimesMixin<TBase extends Constructor>(Base: TBase): {
+    new (...args: any[]): {
+        _extractRuntimePodName(runtimePodNameOrInstance: string | Runtime): string;
+        _extractSnapshotId(snapshotIdOrInstance: string | Snapshot): string;
+        /**
+         * List all available computational environments.
+         *
+         * @returns Promise resolving to array of environments
+         *
+         * @example
+         * ```typescript
+         * const environments = await sdk.listEnvironments();
+         * console.log('Available environments:', environments.length);
+         * ```
+         */
+        listEnvironments(): Promise<Environment[]>;
+        /**
+         * Create a new computational runtime.
+         *
+         * @param data - Runtime creation parameters
+         * @returns Promise resolving to created runtime
+         *
+         * @example
+         * ```typescript
+         * const runtime = await sdk.createRuntime({
+         *   environment_name: 'python-cpu-env',
+         *   credits_limit: 100
+         * });
+         * console.log('Runtime created:', runtime.podName);
+         * ```
+         */
+        createRuntime(data: CreateRuntimeRequest): Promise<Runtime>;
+        /**
+         * List all runtimes.
+         *
+         * @returns Promise resolving to array of runtimes
+         *
+         * @example
+         * ```typescript
+         * const allRuntimes = await sdk.listRuntimes();
+         * console.log('Total runtimes:', allRuntimes.length);
+         * ```
+         */
+        listRuntimes(): Promise<Runtime[]>;
+        /**
+         * Get details for a specific runtime by pod name or Runtime instance.
+         *
+         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
+         * @returns Promise resolving to runtime details
+         *
+         * @example
+         * ```typescript
+         * const runtime = await sdk.getRuntime('runtime-abc123');
+         * const refreshed = await sdk.getRuntime(runtime);
+         * ```
+         */
+        getRuntime(podNameOrRuntime: string | Runtime): Promise<Runtime>;
+        /**
+         * Delete a runtime permanently.
+         *
+         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
+         *
+         * @example
+         * ```typescript
+         * await sdk.deleteRuntime('runtime-abc123');
+         * await sdk.deleteRuntime(runtime);
+         * ```
+         */
+        deleteRuntime(podNameOrRuntime: string | Runtime): Promise<void>;
+        /**
+         * Create a snapshot of a runtime.
+         *
+         * @param data - Snapshot creation parameters
+         * @returns Promise resolving to created snapshot
+         *
+         * @example
+         * ```typescript
+         * const snapshot = await sdk.createSnapshot({
+         *   pod_name: 'runtime-abc123',
+         *   name: 'my-checkpoint',
+         *   description: 'Before major changes'
+         * });
+         * ```
+         */
+        createSnapshot(data: CreateRuntimeSnapshotRequest): Promise<Snapshot>;
+        /**
+         * List all runtime snapshots.
+         *
+         * @returns Promise resolving to array of snapshots
+         *
+         * @example
+         * ```typescript
+         * const allSnapshots = await sdk.listSnapshots();
+         * console.log('Total snapshots:', allSnapshots.length);
+         * ```
+         */
+        listSnapshots(): Promise<Snapshot[]>;
+        /**
+         * Get details for a specific snapshot by ID or Snapshot instance.
+         *
+         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
+         * @returns Promise resolving to snapshot details
+         *
+         * @example
+         * ```typescript
+         * const snapshot = await sdk.getSnapshot('snapshot-abc123');
+         * const refreshed = await sdk.getSnapshot(snapshot);
+         * ```
+         */
+        getSnapshot(idOrSnapshot: string | Snapshot): Promise<Snapshot>;
+        /**
+         * Delete a snapshot permanently.
+         *
+         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
+         *
+         * @example
+         * ```typescript
+         * await sdk.deleteSnapshot('snapshot-abc123');
+         * await sdk.deleteSnapshot(snapshot);
+         * ```
+         */
+        deleteSnapshot(idOrSnapshot: string | Snapshot): Promise<void>;
+    };
+} & TBase;

package/lib/sdk/client/mixins/RuntimesMixin.js

@@ -0,0 +1,221 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * @module sdk/client/mixins/RuntimesMixin
+ * @description Runtimes mixin for the Datalayer SDK.
+ *
+ * This mixin provides intuitive methods for managing computational environments,
+ * runtimes, and snapshots that are mixed into the main DatalayerSDK class.
+ */
+import { environments, runtimes, snapshots } from '../../../api/runtimes';
+import { Runtime } from '../models/Runtime';
+import { Snapshot } from '../models/Snapshot';
+/**
+ * Runtimes mixin that provides computational environment and runtime management.
+ *
+ * This mixin is applied to the DatalayerSDK class to provide clean, intuitive
+ * methods for managing environments and runtimes.
+ */
+export function RuntimesMixin(Base) {
+    return class extends Base {
+        // ========================================================================
+        // Helper Functions
+        // ========================================================================
+        _extractRuntimePodName(runtimePodNameOrInstance) {
+            return typeof runtimePodNameOrInstance === 'string'
+                ? runtimePodNameOrInstance
+                : runtimePodNameOrInstance.podName;
+        }
+        _extractSnapshotId(snapshotIdOrInstance) {
+            return typeof snapshotIdOrInstance === 'string'
+                ? snapshotIdOrInstance
+                : snapshotIdOrInstance.uid;
+        }
+        // ========================================================================
+        // Environments
+        // ========================================================================
+        /**
+         * List all available computational environments.
+         *
+         * @returns Promise resolving to array of environments
+         *
+         * @example
+         * ```typescript
+         * const environments = await sdk.listEnvironments();
+         * console.log('Available environments:', environments.length);
+         * ```
+         */
+        async listEnvironments() {
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const response = await environments.listEnvironments(token, runtimesRunUrl);
+            return response.environments;
+        }
+        // ========================================================================
+        // Runtimes
+        // ========================================================================
+        /**
+         * Create a new computational runtime.
+         *
+         * @param data - Runtime creation parameters
+         * @returns Promise resolving to created runtime
+         *
+         * @example
+         * ```typescript
+         * const runtime = await sdk.createRuntime({
+         *   environment_name: 'python-cpu-env',
+         *   credits_limit: 100
+         * });
+         * console.log('Runtime created:', runtime.podName);
+         * ```
+         */
+        async createRuntime(data) {
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const response = await runtimes.createRuntime(token, data, runtimesRunUrl);
+            return new Runtime(response.runtime, this);
+        }
+        /**
+         * List all runtimes.
+         *
+         * @returns Promise resolving to array of runtimes
+         *
+         * @example
+         * ```typescript
+         * const allRuntimes = await sdk.listRuntimes();
+         * console.log('Total runtimes:', allRuntimes.length);
+         * ```
+         */
+        async listRuntimes() {
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const response = await runtimes.listRuntimes(token, runtimesRunUrl);
+            return response.runtimes.map(r => new Runtime(r, this));
+        }
+        /**
+         * Get details for a specific runtime by pod name or Runtime instance.
+         *
+         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
+         * @returns Promise resolving to runtime details
+         *
+         * @example
+         * ```typescript
+         * const runtime = await sdk.getRuntime('runtime-abc123');
+         * const refreshed = await sdk.getRuntime(runtime);
+         * ```
+         */
+        async getRuntime(podNameOrRuntime) {
+            const podName = this._extractRuntimePodName(podNameOrRuntime);
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const runtimeData = await runtimes.getRuntime(token, podName, runtimesRunUrl);
+            return new Runtime(runtimeData, this);
+        }
+        /**
+         * Delete a runtime permanently.
+         *
+         * @param podNameOrRuntime - Runtime pod name (string) or Runtime instance
+         *
+         * @example
+         * ```typescript
+         * await sdk.deleteRuntime('runtime-abc123');
+         * await sdk.deleteRuntime(runtime);
+         * ```
+         */
+        async deleteRuntime(podNameOrRuntime) {
+            const podName = this._extractRuntimePodName(podNameOrRuntime);
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            await runtimes.deleteRuntime(token, podName, runtimesRunUrl);
+            // If a Runtime instance was passed, mark it as deleted
+            if (typeof podNameOrRuntime !== 'string' &&
+                podNameOrRuntime instanceof Runtime) {
+                podNameOrRuntime._deleted = true;
+            }
+        }
+        // ========================================================================
+        // Snapshots
+        // ========================================================================
+        /**
+         * Create a snapshot of a runtime.
+         *
+         * @param data - Snapshot creation parameters
+         * @returns Promise resolving to created snapshot
+         *
+         * @example
+         * ```typescript
+         * const snapshot = await sdk.createSnapshot({
+         *   pod_name: 'runtime-abc123',
+         *   name: 'my-checkpoint',
+         *   description: 'Before major changes'
+         * });
+         * ```
+         */
+        async createSnapshot(data) {
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const response = await snapshots.createSnapshot(token, data, runtimesRunUrl);
+            return new Snapshot(response.snapshot, this);
+        }
+        /**
+         * List all runtime snapshots.
+         *
+         * @returns Promise resolving to array of snapshots
+         *
+         * @example
+         * ```typescript
+         * const allSnapshots = await sdk.listSnapshots();
+         * console.log('Total snapshots:', allSnapshots.length);
+         * ```
+         */
+        async listSnapshots() {
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const response = await snapshots.listSnapshots(token, runtimesRunUrl);
+            return response.snapshots.map(s => new Snapshot(s, this));
+        }
+        /**
+         * Get details for a specific snapshot by ID or Snapshot instance.
+         *
+         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
+         * @returns Promise resolving to snapshot details
+         *
+         * @example
+         * ```typescript
+         * const snapshot = await sdk.getSnapshot('snapshot-abc123');
+         * const refreshed = await sdk.getSnapshot(snapshot);
+         * ```
+         */
+        async getSnapshot(idOrSnapshot) {
+            const snapshotId = this._extractSnapshotId(idOrSnapshot);
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            const response = await snapshots.getSnapshot(token, snapshotId, runtimesRunUrl);
+            return new Snapshot(response.snapshot, this);
+        }
+        /**
+         * Delete a snapshot permanently.
+         *
+         * @param idOrSnapshot - Snapshot ID (string) or Snapshot instance
+         *
+         * @example
+         * ```typescript
+         * await sdk.deleteSnapshot('snapshot-abc123');
+         * await sdk.deleteSnapshot(snapshot);
+         * ```
+         */
+        async deleteSnapshot(idOrSnapshot) {
+            const snapshotId = this._extractSnapshotId(idOrSnapshot);
+            const token = this.getToken();
+            const runtimesRunUrl = this.getRuntimesRunUrl();
+            await snapshots.deleteSnapshot(token, snapshotId, runtimesRunUrl);
+            // If a Snapshot instance was passed, mark it as deleted
+            if (typeof idOrSnapshot !== 'string' &&
+                idOrSnapshot instanceof Snapshot) {
+                idOrSnapshot._deleted = true;
+            }
+        }
+    };
+}

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

@@ -0,0 +1,184 @@
+import type { CreateSpaceRequest, CreateNotebookRequest, UpdateNotebookRequest, CreateLexicalRequest, UpdateLexicalRequest, GetSpaceItemsResponse, DeleteSpaceItemResponse } from '../../../api/types/spacer';
+import type { Constructor } from '../utils/mixins';
+import { Notebook } from '../models/Notebook';
+import { Lexical } from '../models/Lexical';
+import { Space } from '../models/Space';
+/**
+ * Spacer mixin that provides workspace and content management.
+ *
+ * This mixin is applied to the DatalayerSDK class to provide clean, intuitive
+ * methods for managing spaces, notebooks, and cells.
+ */
+export declare function SpacerMixin<TBase extends Constructor>(Base: TBase): {
+    new (...args: any[]): {
+        /**
+         * Get all workspaces for the authenticated user.
+         *
+         * @returns Promise resolving to array of Space instances
+         *
+         * @example
+         * ```typescript
+         * const mySpaces = await sdk.getMySpaces();
+         * console.log('My spaces:', mySpaces.length);
+         * for (const space of mySpaces) {
+         *   const name = await space.getName();
+         *   console.log(`- ${name} (${space.visibility})`);
+         * }
+         * ```
+         */
+        getMySpaces(): Promise<Space[]>;
+        /**
+         * Create a new workspace.
+         *
+         * @param data - Space creation parameters
+         * @returns Promise resolving to created Space instance
+         *
+         * @example
+         * ```typescript
+         * const space = await sdk.createSpace({
+         *   name: 'My Research Project',
+         *   description: 'Data analysis workspace',
+         *   variant: 'default',
+         *   spaceHandle: 'research-project',
+         *   organizationId: 'org-123',
+         *   seedSpaceId: 'seed-456',
+         *   public: false
+         * });
+         * const name = await space.getName();
+         * console.log('Space created:', name);
+         * ```
+         */
+        createSpace(data: CreateSpaceRequest): Promise<Space>;
+        _extractNotebookId(notebookIdOrInstance: string | Notebook): string;
+        _extractLexicalId(lexicalIdOrInstance: string | Lexical): string;
+        /**
+         * Create a new notebook.
+         *
+         * @param data - Notebook creation parameters
+         * @returns Promise resolving to created Notebook instance
+         *
+         * @example
+         * ```typescript
+         * const notebook = await sdk.createNotebook({
+         *   spaceId: 'space-123',
+         *   name: 'Data Analysis',
+         *   description: 'Analysis notebook',
+         *   notebookType: 'jupyter',
+         * });
+         * ```
+         */
+        createNotebook(data: CreateNotebookRequest): Promise<Notebook>;
+        /**
+         * Get a notebook by ID or Notebook instance.
+         *
+         * @param idOrNotebook - Notebook ID (string) or Notebook instance
+         * @returns Promise resolving to Notebook instance
+         *
+         * @example
+         * ```typescript
+         * const notebook = await sdk.getNotebook('notebook-123');
+         * const refreshed = await sdk.getNotebook(notebook);
+         * ```
+         */
+        getNotebook(idOrNotebook: string | Notebook): Promise<Notebook>;
+        /**
+         * Update a notebook.
+         *
+         * @param idOrNotebook - Notebook ID (string) or Notebook instance
+         * @param data - Update data with optional name and/or description
+         * @returns Promise resolving to updated Notebook instance
+         *
+         * @example
+         * ```typescript
+         * const updated = await sdk.updateNotebook('notebook-123', {
+         *   name: 'Updated Analysis',
+         *   description: 'Updated description'
+         * });
+         * const updated2 = await sdk.updateNotebook(notebook, {
+         *   name: 'Updated Analysis',
+         *   description: 'Updated description'
+         * });
+         * ```
+         */
+        updateNotebook(idOrNotebook: string | Notebook, data: UpdateNotebookRequest): Promise<Notebook>;
+        /**
+         * Create a new lexical document.
+         *
+         * @param data - Document creation parameters
+         * @returns Promise resolving to created Lexical instance
+         *
+         * @example
+         * ```typescript
+         * const lexical = await sdk.createLexical({
+         *   spaceId: 'space-123',
+         *   name: 'Project Documentation',
+         *   description: 'Main project docs',
+         *   documentType: 'document',
+         * });
+         * ```
+         */
+        createLexical(data: CreateLexicalRequest): Promise<Lexical>;
+        /**
+         * Get a lexical document by ID or Lexical instance.
+         *
+         * @param idOrLexical - Document ID (string) or Lexical instance
+         * @returns Promise resolving to Lexical instance
+         *
+         * @example
+         * ```typescript
+         * const lexical = await sdk.getLexical('lexical-123');
+         * const refreshed = await sdk.getLexical(lexical);
+         * ```
+         */
+        getLexical(idOrLexical: string | Lexical): Promise<Lexical>;
+        /**
+         * Update a lexical document.
+         *
+         * @param idOrLexical - Document ID (string) or Lexical instance
+         * @param data - Update data with optional name and/or description
+         * @returns Promise resolving to updated Lexical instance
+         *
+         * @example
+         * ```typescript
+         * const updated = await sdk.updateLexical('lexical-123', {
+         *   name: 'Updated Documentation',
+         *   description: 'Updated description'
+         * });
+         * const updated2 = await sdk.updateLexical(lexical, {
+         *   name: 'Updated Documentation',
+         *   description: 'Updated description'
+         * });
+         * ```
+         */
+        updateLexical(idOrLexical: string | Lexical, data: UpdateLexicalRequest): Promise<Lexical>;
+        /**
+         * Get the items of a space.
+         *
+         * @param spaceId - Space ID
+         * @returns Promise resolving to space items
+         *
+         * @example
+         * ```typescript
+         * const response = await sdk.getSpaceItems('space-123');
+         * console.log('Space items:', response.items.length);
+         * response.items.forEach(item => {
+         *   console.log(`- ${item.name} (${item.type})`);
+         * });
+         * ```
+         */
+        getSpaceItems(spaceId: string): Promise<GetSpaceItemsResponse>;
+        /**
+         * Delete an item from a space.
+         *
+         * @param itemId - Item ID to delete
+         * @returns Promise resolving when deletion is complete
+         *
+         * @example
+         * ```typescript
+         * const response = await sdk.deleteSpaceItem('item-123');
+         * console.log('Item deleted:', response.message);
+         * ```
+         */
+        deleteSpaceItem(itemId: string): Promise<DeleteSpaceItemResponse>;
+    };
+} & TBase;