@datalayer/core 0.0.13 → 0.0.15

package/lib/{client/models/Space.js → models/SpaceDTO.js}

@@ -2,15 +2,20 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-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 { Notebook } from './Notebook';
-import { Lexical } from './Lexical';
-import { ItemTypes } from '../constants';
-import { convertSpaceItemsToModels } from '../utils/spacerUtils';
-import { validateJSON } from '../../api/utils/validation';
+/**
+ * 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.
@@ -22,7 +27,7 @@ import { validateJSON } from '../../api/utils/validation';
  * const notebook = await space.createNotebook({ name: 'Analysis' });
  * ```
  */
-export class Space {
+export class SpaceDTO {
     _data;
     _sdk;
     _items = null;
@@ -120,7 +125,7 @@ export class Space {
                 throw new Error('Failed to create notebook: No notebook returned');
             }
             else {
-                return new Notebook(response.notebook, this._sdk);
+                return new NotebookDTO(response.notebook, this._sdk);
             }
         }
         else if (data.type === ItemTypes.LEXICAL) {
@@ -136,7 +141,7 @@ export class Space {
                 throw new Error('Failed to create lexical document: No document returned');
             }
             else {
-                return new Lexical(response.document, this._sdk);
+                return new LexicalDTO(response.document, this._sdk);
             }
         }
         else {

package/lib/{client/models/User.d.ts → models/UserDTO.d.ts}

@@ -1,10 +1,31 @@
 /**
  * User model for the Datalayer SDK with rich functionality.
  *
- * @module client/models/User
+ * @module models/UserDTO
  */
-import type { User as UserData } from '../../api/types/iam';
 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;
@@ -27,7 +48,7 @@ export interface UserJSON {
  * User model representing a Datalayer platform user.
  * Provides rich functionality for accessing user data and authentication providers.
  */
-export declare class User {
+export declare class UserDTO {
     protected _data: UserData;
     /**
      * Create a User instance.
@@ -62,3 +83,4 @@ export declare class User {
     /** String representation of the user. */
     toString(): string;
 }
+export default UserDTO;

package/lib/{client/models/User.js → models/UserDTO.js}

@@ -2,12 +2,12 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-import { validateJSON } from '../../api/utils/validation';
+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 User {
+export class UserDTO {
     _data;
     /**
      * Create a User instance.
@@ -81,3 +81,4 @@ export class User {
         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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datalayer/core",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "type": "module",
   "workspaces": [
     ".",
@@ -103,6 +103,7 @@
     "@primer/react": "^37.19.0",
     "@primer/react-brand": "^0.58.0",
     "@stripe/react-stripe-js": "^2.7.1",
+    "@tanstack/react-query": "^5.90.6",
     "axios": "^1.7.7",
     "boring-avatars": "^2.0.1",
     "buffer": "^6.0.3",

package/lib/api/types/index.d.ts

@@ -1,34 +0,0 @@
-/**
- * TypeScript type 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 types
- */
-export * from './common';
-export * from './runtimes';
-export * from './iam';
-export * from './spacer';

package/lib/api/types/index.js

@@ -1,38 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * TypeScript type 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 types
- */
-export * from './common';
-export * from './runtimes';
-export * from './iam';
-export * from './spacer';

package/lib/api/types/runtimes.d.ts

@@ -1,205 +0,0 @@
-/**
- * Represents a computing environment available in the Datalayer platform
- * @interface Environment
- */
-export interface Environment {
-    /** 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 */
-    kernel?: {
-        /** 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[];
-}
-/**
- * Represents a running instance of a computing environment
- * @interface Runtime
- */
-export interface Runtime {
-    /** Kubernetes pod name for the runtime instance */
-    pod_name: string;
-    /** Unique identifier for the runtime */
-    uid: string;
-    /** Name of the environment this runtime is based on */
-    environment_name: string;
-    /** Title of the environment for display */
-    environment_title: string;
-    /** Type of runtime - notebook, terminal, or job */
-    type: string;
-    /** Credits consumed per second */
-    burning_rate: number;
-    /** User-friendly name for the runtime */
-    given_name: string;
-    /** Authentication token for accessing the runtime */
-    token: string;
-    /** Ingress URL for accessing the runtime */
-    ingress: string;
-    /** ISO 8601 timestamp of when the runtime started */
-    started_at: string;
-    /** ISO 8601 timestamp of when the runtime will expire */
-    expired_at: string;
-}
-/**
- * Request payload for creating a new runtime
- * @interface CreateRuntimeRequest
- */
-export interface CreateRuntimeRequest {
-    /** Name of the environment to use */
-    environment_name: string;
-    /** Type of runtime (e.g., 'notebook', 'terminal', 'job') */
-    type?: 'notebook' | 'terminal' | 'job';
-    /** Optional given name for the runtime */
-    given_name?: string;
-    /** Maximum credits this runtime can consume */
-    credits_limit?: number;
-    /** Optional capabilities for the runtime */
-    capabilities?: string[];
-    /** Optional source to create runtime from (e.g., snapshot ID) */
-    from?: string;
-}
-/**
- * Represents a snapshot of a runtime's state and files
- * @interface RuntimeSnapshot
- */
-export interface RuntimeSnapshot {
-    /** Unique identifier for the snapshot */
-    uid: string;
-    /** Name of the snapshot */
-    name: string;
-    /** Optional description of the snapshot */
-    description?: string;
-    /** Name of the environment used by the runtime */
-    environment: string;
-    /** Metadata associated with the snapshot */
-    metadata?: {
-        version?: string;
-        language_info?: any;
-        [key: string]: any;
-    };
-    /** Size of the snapshot in bytes */
-    size?: number;
-    /** Format of the snapshot */
-    format?: string;
-    /** Format version of the snapshot */
-    format_version?: string;
-    /** Status of the snapshot */
-    status?: string;
-    /** ISO 8601 timestamp when the snapshot was last updated */
-    updated_at: string;
-    /** List of files included in the snapshot */
-    files?: any[];
-}
-/**
- * Request payload for creating a runtime snapshot
- * @interface CreateRuntimeSnapshotRequest
- */
-export interface CreateRuntimeSnapshotRequest {
-    /** Pod name of the runtime to snapshot */
-    pod_name: string;
-    /** Name for the snapshot */
-    name: string;
-    /** Description of the snapshot */
-    description: string;
-    /** Whether to stop the runtime after creating snapshot */
-    stop: boolean;
-}
-/**
- * Response for getting a specific runtime snapshot
- * @interface SnapshotGetResponse
- */
-export interface SnapshotGetResponse {
-    /** Indicates if the request was successful */
-    success: boolean;
-    /** Response message */
-    message: string;
-    /** The snapshot details */
-    snapshot: RuntimeSnapshot;
-}
-/**
- * Response for creating a runtime snapshot
- * @interface SnapshotCreateResponse
- */
-export interface SnapshotCreateResponse {
-    /** Indicates if the request was successful */
-    success: boolean;
-    /** Response message */
-    message: string;
-    /** The created snapshot details */
-    snapshot: RuntimeSnapshot;
-}
-/**
- * Response from listing available environments
- * @interface EnvironmentsListResponse
- */
-export interface EnvironmentsListResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of available environments */
-    environments: Environment[];
-}
-/**
- * Response from creating a new runtime
- * @interface RuntimeCreateResponse
- */
-export interface CreateRuntimeResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** The created runtime instance */
-    runtime: Runtime;
-}
-/**
- * Response from listing runtimes
- * @interface RuntimesListResponse
- */
-export interface RuntimesListResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of runtime instances */
-    runtimes: Runtime[];
-}
-/**
- * Response from listing runtime snapshots
- * @interface RuntimeSnapshotsListResponse
- */
-export interface SnapshotsListResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of runtime snapshots */
-    snapshots: RuntimeSnapshot[];
-}

package/lib/api/types/runtimes.js

@@ -1,5 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export {};