@datalayer/core 0.0.12 → 0.0.14

package/lib/models/SpaceDTO.js

@@ -0,0 +1,239 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * Space domain model for the Datalayer SDK.
+ *
+ * @module models/SpaceDTO
+ */
+import * as users from '../api/spacer/users';
+import * as items from '../api/spacer/items';
+import * as notebooks from '../api/spacer/notebooks';
+import * as lexicals from '../api/spacer/lexicals';
+import { NotebookDTO } from './NotebookDTO';
+import { LexicalDTO } from './LexicalDTO';
+import { ItemTypes } from '../client/constants';
+import { convertSpaceItemsToModels } from '../client/utils/spacerUtils';
+import { validateJSON } from '../api/utils/validation';
+/**
+ * Space domain model that wraps API responses with convenient methods.
+ * Provides workspace management with data refresh and content creation operations.
+ *
+ * @example
+ * ```typescript
+ * const space = spaces[0];
+ * const items = await space.getItems();
+ * const notebook = await space.createNotebook({ name: 'Analysis' });
+ * ```
+ */
+export class SpaceDTO {
+    _data;
+    _sdk;
+    _items = null;
+    _deleted = false;
+    /**
+     * Create a Space instance.
+     *
+     * @param data - Space data from API
+     * @param sdk - SDK instance
+     */
+    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 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.
+     */
+    async refresh() {
+        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;
+    }
+    /** 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;
+    }
+    /**
+     * The name of the space.
+     */
+    get name() {
+        return this._data.name_t;
+    }
+    /**
+     * The description of the space.
+     */
+    get description() {
+        return this._data.description_t;
+    }
+    // ========================================================================
+    // Space-specific Methods
+    // ========================================================================
+    /**
+     * Helper method to create items in this space.
+     *
+     * @param itemType - Type of item to create
+     * @param data - Creation configuration
+     * @returns Created model instance
+     * @internal
+     */
+    async _createItem(data) {
+        this._checkDeleted();
+        // Get necessary configuration from SDK
+        const token = this._sdk.getToken();
+        const spacerRunUrl = this._sdk.getSpacerRunUrl();
+        if (data.type === ItemTypes.NOTEBOOK) {
+            const requestData = {
+                spaceId: this.uid,
+                name: data.name,
+                description: data.description,
+                notebookType: data.type,
+                file: data.file,
+            };
+            const response = await notebooks.createNotebook(token, requestData, spacerRunUrl);
+            if (!response.notebook) {
+                throw new Error('Failed to create notebook: No notebook returned');
+            }
+            else {
+                return new NotebookDTO(response.notebook, this._sdk);
+            }
+        }
+        else if (data.type === ItemTypes.LEXICAL) {
+            const requestData = {
+                spaceId: this.uid,
+                name: data.name,
+                description: data.description,
+                documentType: data.type,
+                file: data.file,
+            };
+            const response = await lexicals.createLexical(token, requestData, spacerRunUrl);
+            if (!response.document) {
+                throw new Error('Failed to create lexical document: No document returned');
+            }
+            else {
+                return new LexicalDTO(response.document, this._sdk);
+            }
+        }
+        else {
+            throw new Error(`Unsupported item type: ${data.type}`);
+        }
+    }
+    /**
+     * Get all items in this space as model instances.
+     *
+     * @returns Array of Notebook and Lexical model instances
+     */
+    async getItems() {
+        this._checkDeleted();
+        const token = this._sdk.getToken();
+        const spacerRunUrl = this._sdk.getSpacerRunUrl();
+        const response = await items.getSpaceItems(token, this.uid, spacerRunUrl);
+        // Use shared utility function to convert items to model instances
+        this._items = convertSpaceItemsToModels(response.items || [], this._sdk);
+        return this._items;
+    }
+    /**
+     * Create a new notebook in this space.
+     *
+     * @param data - Notebook creation configuration
+     * @returns Created Notebook instance
+     */
+    async createNotebook(data) {
+        return this._createItem({
+            name: data.name,
+            type: ItemTypes.NOTEBOOK,
+            description: data.description,
+            file: data.file,
+        });
+    }
+    /**
+     * Create a new lexical document in this space.
+     *
+     * @param data - Lexical creation configuration
+     * @returns Created Lexical instance
+     */
+    async createLexical(data) {
+        return this._createItem({
+            name: data.name,
+            type: ItemTypes.LEXICAL,
+            description: data.description,
+            file: data.file,
+        });
+    }
+    // ========================================================================
+    // Utility Methods
+    // ========================================================================
+    /**
+     * Get raw space data object.
+     * Returns cached data without refreshing.
+     *
+     * @returns Raw space data object
+     */
+    /**
+     * Get space data in camelCase format.
+     * Returns only the core fields that consumers need.
+     * This provides a stable interface regardless of API changes.
+     *
+     * @returns Core space data with camelCase properties
+     */
+    toJSON() {
+        this._checkDeleted();
+        const obj = {
+            uid: this.uid,
+            name: this.name,
+            description: this.description,
+            variant: this.variant,
+            handle: this.handle,
+            items: this._data.items
+                ? convertSpaceItemsToModels(this._data.items, this._sdk).map(item => item.toJSON())
+                : [],
+        };
+        validateJSON(obj, 'Space');
+        return obj;
+    }
+    /**
+     * Get the raw space data exactly as received from the API.
+     * This preserves the original snake_case naming from the API response.
+     *
+     * @returns Raw space data from API
+     */
+    rawData() {
+        this._checkDeleted();
+        return this._data;
+    }
+    /** String representation of the space. */
+    toString() {
+        this._checkDeleted();
+        return `Space(${this.uid}, ${this.name})`;
+    }
+}

package/lib/models/UserDTO.d.ts

@@ -0,0 +1,86 @@
+/**
+ * User model for the Datalayer SDK with rich functionality.
+ *
+ * @module models/UserDTO
+ */
+import type { DatalayerClient } from '../index';
+/**
+ * Represents a user in the Datalayer platform
+ * @interface UserData
+ */
+export interface UserData {
+    /** uuid for the user */
+    id: string;
+    /** ulid for the user */
+    uid: string;
+    /** User's handle or nickname */
+    handle_s: string;
+    /** User's email address */
+    email_s: string;
+    /** User's first name */
+    first_name_t: string;
+    /** User's last name */
+    last_name_t: string;
+    /** Display name shown in the UI */
+    avatar_url_s: string;
+    /** Additional fields that may be present in the response */
+    [key: string]: any;
+}
+export interface UserJSON {
+    /** uuid for the user */
+    id: string;
+    /** ulid for the user */
+    uid: string;
+    /** First name of the user */
+    firstName: string;
+    /** Last name of the user */
+    lastName: string;
+    /** Display name of the user */
+    displayName: string;
+    /** Email address of the user */
+    email: string;
+    /** Description of the user */
+    handle: string;
+    /** URL to the user's avatar image */
+    avatarUrl: string;
+}
+/**
+ * User model representing a Datalayer platform user.
+ * Provides rich functionality for accessing user data and authentication providers.
+ */
+export declare class UserDTO {
+    protected _data: UserData;
+    /**
+     * Create a User instance.
+     *
+     * @param data - User data from API
+     * @param sdk - SDK instance (currently unused but kept for compatibility)
+     */
+    constructor(data: UserData, sdk?: DatalayerClient);
+    get id(): string;
+    get uid(): string;
+    get email(): string;
+    get handle(): string;
+    get firstName(): string;
+    get lastName(): string;
+    get displayName(): string;
+    get avatarUrl(): string;
+    /**
+     * Get user data in camelCase format.
+     * Returns only the core fields that consumers need.
+     * This provides a stable interface regardless of API changes.
+     *
+     * @returns Core user data with camelCase properties
+     */
+    toJSON(): UserJSON;
+    /**
+     * Get the raw user data exactly as received from the API.
+     * This preserves the original snake_case naming from the API response.
+     *
+     * @returns Raw user data from API
+     */
+    rawData(): UserData;
+    /** String representation of the user. */
+    toString(): string;
+}
+export default UserDTO;

package/lib/models/UserDTO.js

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { validateJSON } from '../api/utils/validation';
+/**
+ * User model representing a Datalayer platform user.
+ * Provides rich functionality for accessing user data and authentication providers.
+ */
+export class UserDTO {
+    _data;
+    /**
+     * Create a User instance.
+     *
+     * @param data - User data from API
+     * @param sdk - SDK instance (currently unused but kept for compatibility)
+     */
+    constructor(data, sdk) {
+        this._data = data;
+    }
+    // Basic properties
+    get id() {
+        return this._data.id;
+    }
+    get uid() {
+        return this._data.uid;
+    }
+    get email() {
+        return this._data.email_s;
+    }
+    get handle() {
+        return this._data.handle_s;
+    }
+    get firstName() {
+        return this._data.first_name_t;
+    }
+    get lastName() {
+        return this._data.last_name_t;
+    }
+    get displayName() {
+        return `${this.firstName} ${this.lastName}`.trim();
+    }
+    get avatarUrl() {
+        return this._data.avatar_url_s;
+    }
+    // ========================================================================
+    // Utility Methods
+    // ========================================================================
+    /**
+     * Get user data in camelCase format.
+     * Returns only the core fields that consumers need.
+     * This provides a stable interface regardless of API changes.
+     *
+     * @returns Core user data with camelCase properties
+     */
+    toJSON() {
+        const obj = {
+            id: this.id,
+            uid: this.uid,
+            firstName: this.firstName,
+            lastName: this.lastName,
+            displayName: this.displayName,
+            email: this.email,
+            handle: this.handle,
+            avatarUrl: this.avatarUrl,
+        };
+        validateJSON(obj, 'User');
+        return obj;
+    }
+    /**
+     * Get the raw user data exactly as received from the API.
+     * This preserves the original snake_case naming from the API response.
+     *
+     * @returns Raw user data from API
+     */
+    rawData() {
+        return this._data;
+    }
+    /** String representation of the user. */
+    toString() {
+        return `User(${this.uid}, ${this.displayName})`;
+    }
+}
+export default UserDTO;

package/lib/models/index.d.ts

@@ -1,9 +1,40 @@
+/**
+ * Models 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
+ * }
+ * ```
+ *
+ * @module models
+ */
 export * from './AIAgent';
-export * from './Base';
 export * from './Assignment';
+export * from './Base';
 export * from './Cell';
 export * from './CodeBlock';
 export * from './CodefeedBlocks';
+export * from './Common';
 export * from './Contact';
 export * from './ContactEvent';
 export * from './ContactIAMProvider';
@@ -11,29 +42,35 @@ export * from './ContactTags';
 export * from './Content';
 export * from './Course';
 export * from './Credits';
-export * from './Datasource';
+export * from './CreditsDTO';
 export * from './Dataset';
+export * from './Datasource';
 export * from './Dean';
 export * from './Document';
 export * from './Environment';
+export * from './EnvironmentDTO';
 export * from './Errors';
 export * from './Exercise';
 export * from './GrowthKPI';
+export * from './IAM';
 export * from './IAMProviderLinked';
 export * from './IAMProviderPost';
-export * from './IAMProvidersSpecs';
 export * from './IAMProviderUsers';
-export * from './Instructor';
+export * from './IAMProvidersSpecs';
 export * from './IAMToken';
 export * from './Inbound';
+export * from './Instructor';
 export * from './Invite';
 export * from './Item';
+export * from './ItemDTO';
 export * from './ItemType';
 export * from './LandingRoles';
 export * from './Lesson';
+export * from './LexicalDTO';
 export * from './Library';
 export * from './Member';
 export * from './Notebook';
+export * from './NotebookDTO';
 export * from './Organization';
 export * from './OrganizationMember';
 export * from './Outbound';
@@ -45,10 +82,13 @@ export * from './RolesOrganization';
 export * from './RolesPlatform';
 export * from './RolesTeam';
 export * from './Runtime';
+export * from './RuntimeDTO';
 export * from './RuntimeSnapshot';
+export * from './RuntimeSnapshotDTO';
 export * from './School';
 export * from './Secret';
 export * from './Space';
+export * from './SpaceDTO';
 export * from './SpaceItem';
 export * from './SpaceMember';
 export * from './Student';
@@ -59,6 +99,7 @@ export * from './TeamMember';
 export * from './URN';
 export * from './Usage';
 export * from './User';
+export * from './UserDTO';
 export * from './UserEvent';
 export * from './UserOnboarding';
 export * from './UserSettings';

package/lib/models/index.js

@@ -2,12 +2,43 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
+/**
+ * Models 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
+ * }
+ * ```
+ *
+ * @module models
+ */
 export * from './AIAgent';
-export * from './Base';
 export * from './Assignment';
+export * from './Base';
 export * from './Cell';
 export * from './CodeBlock';
 export * from './CodefeedBlocks';
+export * from './Common';
 export * from './Contact';
 export * from './ContactEvent';
 export * from './ContactIAMProvider';
@@ -15,29 +46,35 @@ export * from './ContactTags';
 export * from './Content';
 export * from './Course';
 export * from './Credits';
-export * from './Datasource';
+export * from './CreditsDTO';
 export * from './Dataset';
+export * from './Datasource';
 export * from './Dean';
 export * from './Document';
 export * from './Environment';
+export * from './EnvironmentDTO';
 export * from './Errors';
 export * from './Exercise';
 export * from './GrowthKPI';
+export * from './IAM';
 export * from './IAMProviderLinked';
 export * from './IAMProviderPost';
-export * from './IAMProvidersSpecs';
 export * from './IAMProviderUsers';
-export * from './Instructor';
+export * from './IAMProvidersSpecs';
 export * from './IAMToken';
 export * from './Inbound';
+export * from './Instructor';
 export * from './Invite';
 export * from './Item';
+export * from './ItemDTO';
 export * from './ItemType';
 export * from './LandingRoles';
 export * from './Lesson';
+export * from './LexicalDTO';
 export * from './Library';
 export * from './Member';
 export * from './Notebook';
+export * from './NotebookDTO';
 export * from './Organization';
 export * from './OrganizationMember';
 export * from './Outbound';
@@ -49,10 +86,13 @@ export * from './RolesOrganization';
 export * from './RolesPlatform';
 export * from './RolesTeam';
 export * from './Runtime';
+export * from './RuntimeDTO';
 export * from './RuntimeSnapshot';
+export * from './RuntimeSnapshotDTO';
 export * from './School';
 export * from './Secret';
 export * from './Space';
+export * from './SpaceDTO';
 export * from './SpaceItem';
 export * from './SpaceMember';
 export * from './Student';
@@ -63,6 +103,7 @@ export * from './TeamMember';
 export * from './URN';
 export * from './Usage';
 export * from './User';
+export * from './UserDTO';
 export * from './UserEvent';
 export * from './UserOnboarding';
 export * from './UserSettings';

package/lib/sdk/index.d.ts

@@ -1,6 +1,5 @@
 /**
- * @module sdk
- * @description Main SDK entry point for the Datalayer platform.
+ * Main SDK entry point for the Datalayer platform.
  *
  * This module provides the unified DatalayerSDK class with a flat, intuitive API
  * for all Datalayer platform services. The SDK uses TypeScript mixins to provide
@@ -21,6 +20,8 @@
  * const runtime = await sdk.createRuntime(config);
  * const notebook = await sdk.createNotebook(data);
  * ```
+ *
+ * @module sdk
  */
-export { DatalayerSDK, type DatalayerSDKConfig } from './client';
-export * from './stateful';
+export { DatalayerClient, type DatalayerClientConfig } from '../client';
+export * from '../stateful';

package/lib/sdk/index.js

@@ -3,8 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module sdk
- * @description Main SDK entry point for the Datalayer platform.
+ * Main SDK entry point for the Datalayer platform.
  *
  * This module provides the unified DatalayerSDK class with a flat, intuitive API
  * for all Datalayer platform services. The SDK uses TypeScript mixins to provide
@@ -25,8 +24,10 @@
  * const runtime = await sdk.createRuntime(config);
  * const notebook = await sdk.createNotebook(data);
  * ```
+ *
+ * @module sdk
  */
-// Export the main SDK class with flat API
-export { DatalayerSDK } from './client';
+// Export the main Client class with flat API
+export { DatalayerClient } from '../client';
 // Export stateful modules for advanced use cases
-export * from './stateful';
+export * from '../stateful';

package/lib/services/DatalayerServiceManager.js

@@ -5,7 +5,7 @@
 import { ServerConnection, ServiceManager } from '@jupyterlab/services';
 import { coreStore } from '../state/substates/CoreState';
 import { DEFAULT_DATALAYER_CONFIG } from '../config/Configuration';
-import { createRuntime } from '../sdk/stateful/runtimes/actions';
+import { createRuntime } from '../stateful/runtimes/actions';
 /**
  * Creates a ServiceManager configured for Datalayer.
  *

package/lib/state/substates/CoreState.js

@@ -21,6 +21,8 @@ let initialConfiguration = {
     libraryRunUrl: 'https://prod1.datalayer.run',
     spacerRunUrl: 'https://prod1.datalayer.run',
     aiagentsRunUrl: 'https://prod1.datalayer.run',
+    aiinferenceRunUrl: 'https://prod1.datalayer.run',
+    mcpserversRunUrl: 'https://prod1.datalayer.run',
     growthRunUrl: 'https://prod1.datalayer.run',
     inboundsRunUrl: 'https://prod1.datalayer.run',
     successRunUrl: 'https://prod1.datalayer.run',

package/lib/state/substates/RuntimesState.d.ts

@@ -1,4 +1,4 @@
-import type { IMultiServiceManager } from '../../sdk/stateful/runtimes';
+import type { IMultiServiceManager } from '../../stateful/runtimes';
 import type { IRuntimesConfiguration } from '../../config';
 import type { IRuntimePod, IRuntimeSnapshot, IRuntimeModel } from '../../models';
 /**