@datalayer/core 0.0.12 → 0.0.14

package/lib/sdk/client/models/Snapshot.js

@@ -1,244 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { snapshots } from '../../../api/runtimes';
-/**
- * Snapshot domain model that wraps API responses with convenient methods.
- *
- * Provides a rich, object-oriented interface for managing runtime snapshots
- * with automatic data refresh and lifecycle operations.
- *
- * @example
- * ```typescript
- * const snapshot = await runtime.createSnapshot('my-checkpoint', 'Before changes');
- *
- * // Static properties - instant access
- * console.log(snapshot.uid);
- * console.log(snapshot.environment);
- *
- * // Dynamic data - always fresh from API
- * const currentStatus = await snapshot.getStatus();
- * const size = await snapshot.getSize();
- *
- * // Delete snapshot
- * await snapshot.delete();
- *
- * // Restore runtime from snapshot
- * const runtime = await snapshot.restore();
- * ```
- */
-export class Snapshot {
-    _data;
-    _sdk;
-    _deleted = false;
-    /**
-     * Create a Snapshot instance.
-     *
-     * @param data - Raw snapshot data from API
-     * @param sdk - DatalayerSDK instance for making API calls
-     */
-    constructor(data, sdk) {
-        this._data = data;
-        this._sdk = sdk;
-    }
-    // ========================================================================
-    // Helper Methods
-    // ========================================================================
-    /**
-     * Check if this snapshot has been deleted and throw error if so.
-     * @throws Error if the snapshot has been deleted
-     */
-    _checkDeleted() {
-        if (this._deleted) {
-            throw new Error(`Snapshot ${this._data.uid} has been deleted and no longer exists`);
-        }
-    }
-    // ========================================================================
-    // Static Properties (set at creation, never change)
-    // ========================================================================
-    /**
-     * Unique identifier for the snapshot.
-     */
-    get uid() {
-        this._checkDeleted();
-        return this._data.uid;
-    }
-    /**
-     * Name of the snapshot.
-     */
-    get name() {
-        this._checkDeleted();
-        return this._data.name;
-    }
-    /**
-     * Description of the snapshot.
-     */
-    get description() {
-        this._checkDeleted();
-        return this._data.description || '';
-    }
-    /**
-     * Name of the environment used by the runtime.
-     */
-    get environment() {
-        this._checkDeleted();
-        return this._data.environment;
-    }
-    /**
-     * Format of the snapshot.
-     */
-    get format() {
-        this._checkDeleted();
-        return this._data.format || '';
-    }
-    /**
-     * Format version of the snapshot.
-     */
-    get formatVersion() {
-        this._checkDeleted();
-        return this._data.format_version || '';
-    }
-    /**
-     * Snapshot metadata.
-     */
-    get metadata() {
-        this._checkDeleted();
-        return this._data.metadata || {};
-    }
-    /**
-     * When the snapshot was last updated.
-     */
-    get updatedAt() {
-        this._checkDeleted();
-        return new Date(this._data.updated_at);
-    }
-    // ========================================================================
-    // Dynamic Methods (always fetch fresh data and update internal state)
-    // ========================================================================
-    /**
-     * Get the current status of the snapshot.
-     *
-     * This method always fetches fresh data from the API and updates
-     * the internal data to keep everything in sync.
-     *
-     * @returns Promise resolving to current snapshot status
-     * @throws Error if the snapshot has been deleted
-     */
-    async getStatus() {
-        this._checkDeleted();
-        const token = this._sdk.getToken();
-        const runtimesRunUrl = this._sdk.getRuntimesRunUrl();
-        const response = await snapshots.getSnapshot(token, this.uid, runtimesRunUrl);
-        if (response.snapshot) {
-            this._data = response.snapshot;
-        }
-        return this._data.status || 'unknown';
-    }
-    /**
-     * Get the current size of the snapshot.
-     *
-     * @returns Promise resolving to snapshot size in bytes
-     */
-    async getSize() {
-        this._checkDeleted();
-        const token = this._sdk.getToken();
-        const runtimesRunUrl = this._sdk.getRuntimesRunUrl();
-        const response = await snapshots.getSnapshot(token, this.uid, runtimesRunUrl);
-        if (response.snapshot) {
-            this._data = response.snapshot;
-        }
-        return this._data.size || 0;
-    }
-    /**
-     * Get the latest metadata of the snapshot.
-     *
-     * @returns Promise resolving to snapshot metadata
-     */
-    async getLatestMetadata() {
-        this._checkDeleted();
-        const token = this._sdk.getToken();
-        const runtimesRunUrl = this._sdk.getRuntimesRunUrl();
-        const response = await snapshots.getSnapshot(token, this.uid, runtimesRunUrl);
-        if (response.snapshot) {
-            this._data = response.snapshot;
-        }
-        return this._data.metadata || {};
-    }
-    // ========================================================================
-    // Action Methods
-    // ========================================================================
-    /**
-     * Delete this snapshot permanently.
-     *
-     * After deletion, this object will be marked as deleted and subsequent
-     * calls to dynamic methods will throw errors.
-     *
-     * @example
-     * ```typescript
-     * await snapshot.delete();
-     * console.log('Snapshot deleted');
-     * // snapshot.getStatus() will now throw an error
-     * ```
-     */
-    async delete() {
-        this._checkDeleted();
-        const token = this._sdk.getToken();
-        const runtimesRunUrl = this._sdk.getRuntimesRunUrl();
-        await snapshots.deleteSnapshot(token, this.uid, runtimesRunUrl);
-        this._deleted = true;
-    }
-    /**
-     * Create a runtime from this snapshot (restore functionality).
-     *
-     * @param config - Optional runtime configuration to override defaults
-     * @returns Promise resolving to created Runtime instance
-     *
-     * @example
-     * ```typescript
-     * const runtime = await snapshot.restore({
-     *   credits_limit: 200
-     * });
-     * await runtime.waitUntilReady();
-     * ```
-     */
-    async restore(config) {
-        this._checkDeleted();
-        return await this._sdk.createRuntime({
-            environment_name: this.environment,
-            from_snapshot: this.uid,
-            ...config,
-        });
-    }
-    // ========================================================================
-    // Utility Methods
-    // ========================================================================
-    /**
-     * Get raw snapshot data object with latest information.
-     *
-     * This method ensures the returned data includes the most recent information
-     * by refreshing from the API before returning.
-     *
-     * @returns Promise resolving to raw snapshot data
-     *
-     * @example
-     * ```typescript
-     * const latestData = await snapshot.toJSON();
-     * console.log('Current status:', latestData.status);
-     * ```
-     */
-    async toJSON() {
-        this._checkDeleted();
-        await this.getStatus(); // This updates internal data
-        return this._data;
-    }
-    /**
-     * String representation of the snapshot.
-     *
-     * @returns String representation for logging/debugging
-     */
-    toString() {
-        this._checkDeleted();
-        return `Snapshot(${this.uid}, ${this.name})`;
-    }
-}

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

@@ -1,182 +0,0 @@
-/**
- * @module sdk/client/models/Space
- * @description Space domain model for the Datalayer SDK.
- *
- * This model provides a rich, object-oriented interface for working with
- * workspace spaces, including item management and content creation.
- */
-import type { Space as SpaceData, SpaceItem } from '../../../api/types/spacer';
-import type { DatalayerSDK } from '../index';
-import { Notebook } from './Notebook';
-import { Lexical } from './Lexical';
-/**
- * Space domain model that wraps API responses with convenient methods.
- *
- * Provides a rich, object-oriented interface for managing workspace spaces
- * with automatic data refresh and content creation operations.
- *
- * @example
- * ```typescript
- * const spaces = await sdk.getMySpaces();
- * const space = spaces[0];
- *
- * // Static properties - instant access
- * console.log(space.uid);
- * console.log(space.visibility);
- *
- * // Dynamic data - always fresh from API
- * const currentName = await space.getName();
- * const items = await space.getItems();
- *
- * // Create content in this space
- * const notebook = await space.createNotebook(formData);
- * const lexical = await space.createLexical(formData);
- * ```
- */
-export declare class Space {
-    protected _data: SpaceData;
-    private _sdk;
-    private _deleted;
-    /**
-     * Create a Space instance.
-     *
-     * @param data - Raw space data from API
-     * @param sdk - DatalayerSDK instance for making API calls
-     */
-    constructor(data: SpaceData, sdk: DatalayerSDK);
-    /**
-     * Check if this space has been deleted and throw error if so.
-     * @throws Error if the space has been deleted
-     */
-    private _checkDeleted;
-    /**
-     * Refresh space data from the API by fetching user's spaces.
-     * Since there's no individual GET endpoint, we fetch from the list.
-     */
-    private _refreshData;
-    /**
-     * Unique identifier for the space.
-     */
-    get uid(): string;
-    /**
-     * Space ID (optional for backward compatibility).
-     */
-    get id(): string;
-    /**
-     * Owner user ID.
-     */
-    get ownerId(): string;
-    /**
-     * Organization ID.
-     */
-    get organizationId(): string;
-    /**
-     * When the space was created.
-     * Note: May not be available for all spaces depending on API response.
-     */
-    get createdAt(): Date | null;
-    /**
-     * Space visibility setting.
-     */
-    get visibility(): string;
-    /**
-     * URL-friendly handle for the space.
-     */
-    get handle(): string;
-    /**
-     * Space variant type.
-     */
-    get variant(): string;
-    /**
-     * Get the current name of the space.
-     *
-     * This method always fetches fresh data from the API and updates
-     * the internal data to keep everything in sync.
-     *
-     * @returns Promise resolving to current space name
-     * @throws Error if the space has been deleted
-     */
-    getName(): Promise<string>;
-    /**
-     * Get the current description of the space.
-     *
-     * @returns Promise resolving to space description
-     */
-    getDescription(): Promise<string>;
-    /**
-     * Get when the space was last updated.
-     *
-     * @returns Promise resolving to last update time
-     */
-    getUpdatedAt(): Promise<Date | null>;
-    /**
-     * Get all items in this space.
-     *
-     * @returns Promise resolving to array of space items
-     *
-     * @example
-     * ```typescript
-     * const items = await space.getItems();
-     * items.forEach(item => {
-     *   console.log(`${item.name} (${item.type})`);
-     * });
-     * ```
-     */
-    getItems(): Promise<SpaceItem[]>;
-    /**
-     * Create a new notebook in this space.
-     *
-     * @param formData - Notebook creation form data
-     * @returns Promise resolving to created Notebook instance
-     *
-     * @example
-     * ```typescript
-     * const formData = new FormData();
-     * formData.append('name', 'Analysis Notebook');
-     * formData.append('notebookType', 'jupyter');
-     *
-     * const notebook = await space.createNotebook(formData);
-     * console.log('Created:', notebook.name);
-     * ```
-     */
-    createNotebook(formData: FormData): Promise<Notebook>;
-    /**
-     * Create a new lexical document in this space.
-     *
-     * @param formData - Lexical creation form data
-     * @returns Promise resolving to created Lexical instance
-     *
-     * @example
-     * ```typescript
-     * const formData = new FormData();
-     * formData.append('name', 'Project Documentation');
-     * formData.append('documentType', 'lexical');
-     *
-     * const lexical = await space.createLexical(formData);
-     * console.log('Created:', lexical.name);
-     * ```
-     */
-    createLexical(formData: FormData): Promise<Lexical>;
-    /**
-     * Get raw space data object with latest information.
-     *
-     * This method ensures the returned data includes the most recent information
-     * by refreshing from the API before returning.
-     *
-     * @returns Promise resolving to raw space data
-     *
-     * @example
-     * ```typescript
-     * const latestData = await space.toJSON();
-     * console.log('Current name:', latestData.name);
-     * ```
-     */
-    toJSON(): Promise<SpaceData>;
-    /**
-     * String representation of the space.
-     *
-     * @returns String representation for logging/debugging
-     */
-    toString(): string;
-}
-export type { SpaceData };

package/lib/sdk/client/models/Space.js

@@ -1,276 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { users, items } from '../../../api/spacer';
-/**
- * Space domain model that wraps API responses with convenient methods.
- *
- * Provides a rich, object-oriented interface for managing workspace spaces
- * with automatic data refresh and content creation operations.
- *
- * @example
- * ```typescript
- * const spaces = await sdk.getMySpaces();
- * const space = spaces[0];
- *
- * // Static properties - instant access
- * console.log(space.uid);
- * console.log(space.visibility);
- *
- * // Dynamic data - always fresh from API
- * const currentName = await space.getName();
- * const items = await space.getItems();
- *
- * // Create content in this space
- * const notebook = await space.createNotebook(formData);
- * const lexical = await space.createLexical(formData);
- * ```
- */
-export class Space {
-    _data;
-    _sdk;
-    _deleted = false;
-    /**
-     * Create a Space instance.
-     *
-     * @param data - Raw space data from API
-     * @param sdk - DatalayerSDK instance for making API calls
-     */
-    constructor(data, sdk) {
-        this._data = data;
-        this._sdk = sdk;
-    }
-    // ========================================================================
-    // Helper Methods
-    // ========================================================================
-    /**
-     * Check if this space has been deleted and throw error if so.
-     * @throws Error if the space has been deleted
-     */
-    _checkDeleted() {
-        if (this._deleted) {
-            throw new Error(`Space ${this._data.uid} has been deleted and no longer exists`);
-        }
-    }
-    /**
-     * Refresh space data from the API by fetching user's spaces.
-     * Since there's no individual GET endpoint, we fetch from the list.
-     */
-    async _refreshData() {
-        const token = this._sdk.getToken();
-        const spacerRunUrl = this._sdk.getSpacerRunUrl();
-        const response = await users.getMySpaces(token, spacerRunUrl);
-        const freshSpace = response.spaces.find(s => s.uid === this.uid);
-        if (freshSpace) {
-            this._data = freshSpace;
-        }
-    }
-    // ========================================================================
-    // Static Properties (set at creation, never change)
-    // ========================================================================
-    /**
-     * Unique identifier for the space.
-     */
-    get uid() {
-        this._checkDeleted();
-        return this._data.uid;
-    }
-    /**
-     * Space ID (optional for backward compatibility).
-     */
-    get id() {
-        this._checkDeleted();
-        return this._data.id || this._data.uid;
-    }
-    /**
-     * Owner user ID.
-     */
-    get ownerId() {
-        this._checkDeleted();
-        return this._data.owner_id || '';
-    }
-    /**
-     * Organization ID.
-     */
-    get organizationId() {
-        this._checkDeleted();
-        return this._data.organization_id || '';
-    }
-    /**
-     * When the space was created.
-     * Note: May not be available for all spaces depending on API response.
-     */
-    get createdAt() {
-        this._checkDeleted();
-        const dateStr = this._data.creation_ts_dt || this._data.created_at;
-        if (!dateStr) {
-            return null; // Some spaces don't have timestamps
-        }
-        return new Date(dateStr);
-    }
-    /**
-     * Space visibility setting.
-     */
-    get visibility() {
-        this._checkDeleted();
-        return this._data.visibility || 'private';
-    }
-    /**
-     * URL-friendly handle for the space.
-     */
-    get handle() {
-        this._checkDeleted();
-        return this._data.handle_s || '';
-    }
-    /**
-     * Space variant type.
-     */
-    get variant() {
-        this._checkDeleted();
-        return this._data.variant_s || '';
-    }
-    // ========================================================================
-    // Dynamic Methods (always fetch fresh data and update internal state)
-    // ========================================================================
-    /**
-     * Get the current name of the space.
-     *
-     * This method always fetches fresh data from the API and updates
-     * the internal data to keep everything in sync.
-     *
-     * @returns Promise resolving to current space name
-     * @throws Error if the space has been deleted
-     */
-    async getName() {
-        this._checkDeleted();
-        await this._refreshData();
-        return this._data.name || this._data.name_t || '';
-    }
-    /**
-     * Get the current description of the space.
-     *
-     * @returns Promise resolving to space description
-     */
-    async getDescription() {
-        this._checkDeleted();
-        await this._refreshData();
-        return this._data.description || this._data.description_t || '';
-    }
-    /**
-     * Get when the space was last updated.
-     *
-     * @returns Promise resolving to last update time
-     */
-    async getUpdatedAt() {
-        this._checkDeleted();
-        await this._refreshData();
-        const dateStr = this._data.last_update_ts_dt ||
-            this._data.updated_at ||
-            this._data.creation_ts_dt ||
-            this._data.created_at;
-        if (!dateStr) {
-            return null; // Some spaces don't have timestamps
-        }
-        return new Date(dateStr);
-    }
-    // ========================================================================
-    // Space-specific Methods
-    // ========================================================================
-    /**
-     * Get all items in this space.
-     *
-     * @returns Promise resolving to array of space items
-     *
-     * @example
-     * ```typescript
-     * const items = await space.getItems();
-     * items.forEach(item => {
-     *   console.log(`${item.name} (${item.type})`);
-     * });
-     * ```
-     */
-    async getItems() {
-        this._checkDeleted();
-        const token = this._sdk.getToken();
-        const spacerRunUrl = this._sdk.getSpacerRunUrl();
-        const response = await items.getSpaceItems(token, this.uid, spacerRunUrl);
-        return response.items;
-    }
-    /**
-     * Create a new notebook in this space.
-     *
-     * @param formData - Notebook creation form data
-     * @returns Promise resolving to created Notebook instance
-     *
-     * @example
-     * ```typescript
-     * const formData = new FormData();
-     * formData.append('name', 'Analysis Notebook');
-     * formData.append('notebookType', 'jupyter');
-     *
-     * const notebook = await space.createNotebook(formData);
-     * console.log('Created:', notebook.name);
-     * ```
-     */
-    async createNotebook(formData) {
-        this._checkDeleted();
-        // Ensure spaceId is set in the form data
-        formData.set('spaceId', this.uid);
-        return await this._sdk.createNotebook(formData);
-    }
-    /**
-     * Create a new lexical document in this space.
-     *
-     * @param formData - Lexical creation form data
-     * @returns Promise resolving to created Lexical instance
-     *
-     * @example
-     * ```typescript
-     * const formData = new FormData();
-     * formData.append('name', 'Project Documentation');
-     * formData.append('documentType', 'lexical');
-     *
-     * const lexical = await space.createLexical(formData);
-     * console.log('Created:', lexical.name);
-     * ```
-     */
-    async createLexical(formData) {
-        this._checkDeleted();
-        // Ensure spaceId is set in the form data
-        formData.set('spaceId', this.uid);
-        return await this._sdk.createLexical(formData);
-    }
-    // ========================================================================
-    // Utility Methods
-    // ========================================================================
-    /**
-     * Get raw space data object with latest information.
-     *
-     * This method ensures the returned data includes the most recent information
-     * by refreshing from the API before returning.
-     *
-     * @returns Promise resolving to raw space data
-     *
-     * @example
-     * ```typescript
-     * const latestData = await space.toJSON();
-     * console.log('Current name:', latestData.name);
-     * ```
-     */
-    async toJSON() {
-        this._checkDeleted();
-        await this._refreshData();
-        return this._data;
-    }
-    /**
-     * String representation of the space.
-     *
-     * @returns String representation for logging/debugging
-     */
-    toString() {
-        this._checkDeleted();
-        const name = this._data.name || this._data.name_t || 'Unnamed';
-        return `Space(${this.uid}, ${name})`;
-    }
-}

package/lib/sdk/client/models/__tests__/Lexical.test.d.ts

@@ -1 +0,0 @@
-export {};