@datalayer/core 0.0.12 → 0.0.13

package/lib/api/spacer/documents.d.ts

@@ -0,0 +1,12 @@
+import { CollaborationSessionResponse } from '../types/spacer';
+/**
+ * Get collaboration session ID for a document.
+ *
+ * This function attempts to retrieve the collaboration session ID from the document API.
+ *
+ * @param token - Authentication token
+ * @param documentId - Document UID
+ * @param baseUrl - Base URL for the API (defaults to production)
+ * @returns Promise resolving to collaboration session response
+ */
+export declare const getCollaborationSessionId: (token: string, documentId: string, baseUrl?: string) => Promise<CollaborationSessionResponse>;

package/lib/api/spacer/documents.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * Documents API functions for the Datalayer platform.
+ *
+ * Provides functions for document operations including collaboration session management.
+ *
+ * @module api/spacer/documents
+ */
+import { requestDatalayerAPI } from '../DatalayerApi';
+import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';
+/**
+ * Get collaboration session ID for a document.
+ *
+ * This function attempts to retrieve the collaboration session ID from the document API.
+ *
+ * @param token - Authentication token
+ * @param documentId - Document UID
+ * @param baseUrl - Base URL for the API (defaults to production)
+ * @returns Promise resolving to collaboration session response
+ */
+export const getCollaborationSessionId = async (token, documentId, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
+    try {
+        const response = await requestDatalayerAPI({
+            url: `${baseUrl}${API_BASE_PATHS.SPACER}/documents/${documentId}`,
+            method: 'GET',
+            token,
+        });
+        return {
+            success: true,
+            sessionId: response.sessionId || documentId, // FIXME: is this ok?
+        };
+    }
+    catch (error) {
+        // FIXME: is this ok?
+        return {
+            success: true,
+            sessionId: documentId,
+        };
+    }
+};

package/lib/api/spacer/healthz.d.ts

@@ -1,25 +1,15 @@
-/**
- * Health check response from the Spacer service
- */
-export interface SpacerHealthzPingResponse {
-    success: boolean;
-    message: string;
-    status?: {
-        status: string;
-    };
-    version?: string;
-}
+import type { HealthzPingResponse } from '../types/common';
 /**
  * Health check ping endpoint for Spacer service
  * @param baseUrl - Base URL for the API (defaults to production Spacer URL)
  * @returns Health check response
  * @throws {Error} If the health check fails
  *
- * @description
+ * @remarks
  * This endpoint provides a basic health check for the Spacer service.
  * It returns the current status of the service.
  *
  * Expected status codes:
  * - 200: Service is healthy
  */
-export declare const ping: (baseUrl?: string) => Promise<SpacerHealthzPingResponse>;
+export declare const ping: (baseUrl?: string) => Promise<HealthzPingResponse>;

package/lib/api/spacer/healthz.js

@@ -3,10 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer/healthz
- * @description Health check API functions for the Datalayer Spacer service.
+ * Health check API functions for the Datalayer Spacer service.
  *
  * Provides functions for checking the health status of the Spacer service.
+ *
+ * @module api/spacer/healthz
  */
 import { requestDatalayerAPI } from '../DatalayerApi';
 import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';
@@ -16,7 +17,7 @@ import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';
  * @returns Health check response
  * @throws {Error} If the health check fails
  *
- * @description
+ * @remarks
  * This endpoint provides a basic health check for the Spacer service.
  * It returns the current status of the service.
  *

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

@@ -1,10 +1,12 @@
 /**
- * @module api/spacer
- * @description Spacer API exports.
+ * Spacer API exports.
  *
  * Provides organized access to spacer functionality including
  * spaces, notebooks, cells, and lexical documents.
+ *
+ * @module api/spacer
  */
+export * as documents from './documents';
 export * as healthz from './healthz';
 export * as items from './items';
 export * as lexicals from './lexicals';

package/lib/api/spacer/index.js

@@ -3,12 +3,14 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer
- * @description Spacer API exports.
+ * Spacer API exports.
  *
  * Provides organized access to spacer functionality including
  * spaces, notebooks, cells, and lexical documents.
+ *
+ * @module api/spacer
  */
+export * as documents from './documents';
 export * as healthz from './healthz';
 export * as items from './items';
 export * as lexicals from './lexicals';

package/lib/api/spacer/items.d.ts

@@ -1,4 +1,4 @@
-import { DeleteSpaceItemResponse, GetSpaceItemsResponse } from '../types/spacer';
+import { DeleteSpaceItemResponse, GetSpaceItemResponse, GetSpaceItemsResponse } from '../types/spacer';
 /**
  * Get the items of a space.
  * @param token - Authentication token
@@ -7,6 +7,14 @@ import { DeleteSpaceItemResponse, GetSpaceItemsResponse } from '../types/spacer'
  * @returns Promise resolving to the items response
  */
 export declare const getSpaceItems: (token: string, spaceId: string, baseUrl?: string) => Promise<GetSpaceItemsResponse>;
+/**
+ * Get a single item from a space.
+ * @param token - Authentication token
+ * @param id - The item ID to retrieve
+ * @param baseUrl - Base URL for the API (defaults to production)
+ * @returns Promise resolving to the item response
+ */
+export declare const getItem: (token: string, id: string, baseUrl?: string) => Promise<GetSpaceItemResponse>;
 /**
  * Delete an item from a space.
  * @param token - Authentication token

package/lib/api/spacer/items.js

@@ -3,10 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer/items
- * @description Items API functions for the Datalayer platform.
+ * Items API functions for the Datalayer platform.
  *
  * Provides functions for managing items in spaces.
+ *
+ * @module api/spacer/items
  */
 import { requestDatalayerAPI } from '../DatalayerApi';
 import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';
@@ -24,6 +25,20 @@ export const getSpaceItems = async (token, spaceId, baseUrl = DEFAULT_SERVICE_UR
         token,
     });
 };
+/**
+ * Get a single item from a space.
+ * @param token - Authentication token
+ * @param id - The item ID to retrieve
+ * @param baseUrl - Base URL for the API (defaults to production)
+ * @returns Promise resolving to the item response
+ */
+export const getItem = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
+    return requestDatalayerAPI({
+        url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/items/${id}`,
+        method: 'GET',
+        token,
+    });
+};
 /**
  * Delete an item from a space.
  * @param token - Authentication token

package/lib/api/spacer/lexicals.js

@@ -3,10 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer/lexicals
- * @description Lexical documents API functions for the Datalayer platform.
+ * Lexical documents API functions for the Datalayer platform.
  *
  * Provides functions for creating, retrieving, and updating lexical (rich text) documents.
+ *
+ * @module api/spacer/lexicals
  */
 import { requestDatalayerAPI } from '../DatalayerApi';
 import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';

package/lib/api/spacer/notebooks.js

@@ -3,10 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer/notebooks
- * @description Jupyter notebooks API functions for the Datalayer platform.
+ * Jupyter notebooks API functions for the Datalayer platform.
  *
  * Provides functions for creating and retrieving Jupyter notebooks within workspaces.
+ *
+ * @module api/spacer/notebooks
  */
 import { requestDatalayerAPI } from '../DatalayerApi';
 import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';

package/lib/api/spacer/spaces.js

@@ -3,10 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer/spaces
- * @description Workspace spaces API functions for the Datalayer platform.
+ * Workspace spaces API functions for the Datalayer platform.
  *
  * Provides function for creating workspace spaces.
+ *
+ * @module api/spacer/spaces
  */
 import { requestDatalayerAPI } from '../DatalayerApi';
 import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';

package/lib/api/spacer/users.js

@@ -3,10 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module api/spacer/users
- * @description User-related Spacer API functions for the Datalayer platform.
+ * User-related Spacer API functions for the Datalayer platform.
  *
  * Provides functions for user-specific operations in the Spacer service.
+ *
+ * @module api/spacer/users
  */
 import { requestDatalayerAPI } from '../DatalayerApi';
 import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants';

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

@@ -0,0 +1,64 @@
+/**
+ * Common types shared across all Datalayer API services.
+ *
+ * @module api/types/common
+ */
+/**
+ * Standard health check response used by all services.
+ * @interface HealthzPingResponse
+ */
+export interface HealthzPingResponse {
+    /** Whether the request was successful */
+    success: boolean;
+    /** Response message from the server */
+    message: string;
+    /** Service status information */
+    status?: {
+        /** Status indicator (e.g., "OK") */
+        status: string;
+    };
+    /** API version */
+    version?: string;
+}
+/**
+ * Standard error response structure.
+ * @interface ErrorResponse
+ */
+export interface ErrorResponse {
+    /** Whether the request was successful (always false for errors) */
+    success: false;
+    /** Error message */
+    message: string;
+    /** Optional error code */
+    code?: string;
+    /** Optional additional error details */
+    details?: any;
+}
+/**
+ * Standard pagination parameters.
+ * @interface PaginationParams
+ */
+export interface PaginationParams {
+    /** Page number (1-based) */
+    page?: number;
+    /** Items per page */
+    limit?: number;
+    /** Sort field */
+    sort?: string;
+    /** Sort order */
+    order?: 'asc' | 'desc';
+}
+/**
+ * Standard pagination response metadata.
+ * @interface PaginationMeta
+ */
+export interface PaginationMeta {
+    /** Current page */
+    page: number;
+    /** Items per page */
+    limit: number;
+    /** Total number of items */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}

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

@@ -3,38 +3,86 @@
  * @interface User
  */
 export interface User {
-    /** Unique identifier for the user */
+    /** uuid for the user */
     id: string;
-    /** Alternative unique identifier (UUID format) */
-    uid?: string;
-    /** User ID in the authentication system */
-    user_id?: string;
-    /** Username for login */
-    username?: string;
+    /** ulid for the user */
+    uid: string;
     /** User's handle or nickname */
-    handle?: string;
+    handle_s: string;
     /** User's email address */
-    email: string;
+    email_s: string;
     /** User's first name */
-    first_name?: string;
+    first_name_t: string;
     /** User's last name */
-    last_name?: string;
+    last_name_t: string;
     /** Display name shown in the UI */
-    display_name?: string;
-    /** URL to the user's avatar image */
-    avatar_url?: string;
-    /** Alternative property name for avatar URL (for backwards compatibility) */
-    avatarUrl?: string;
+    avatar_url_s: string;
+    /** Additional fields that may be present in the response */
+    [key: string]: any;
+}
+/**
+ * Represents a user profile in the Datalayer platform
+ * @interface Profile
+ */
+interface Profile {
     /** ISO 8601 timestamp of when the user was created */
-    created_at?: string;
-    /** ISO 8601 timestamp of when the user was last updated */
-    updated_at?: string;
-    /** Whether the user account is active */
-    is_active?: boolean;
-    /** Whether the user's email has been verified */
-    is_verified?: boolean;
-    /** Whether multi-factor authentication is enabled */
-    mfa_enabled?: boolean;
+    creation_ts_dt: string;
+    /** Unique identifier for the user */
+    id: string;
+    /** ISO 8601 timestamp of when the user requested to join */
+    join_request_ts_dt: string | null;
+    /** ISO 8601 timestamp of when the user joined */
+    join_ts_dt: string;
+    /** ISO 8601 timestamp of last update */
+    last_update_ts_dt: string;
+    /** Origin of the user account */
+    origin_s: string;
+    /** Type of the record */
+    type_s: string;
+    /** User ID */
+    uid: string;
+    /** Email address */
+    email_s: string;
+    /** First name */
+    first_name_t: string;
+    /** User handle */
+    handle_s: string;
+    /** Last name */
+    last_name_t: string;
+    /** User roles array */
+    roles_ss?: string[];
+    /** Avatar URL */
+    avatar_url_s?: string;
+    /** Onboarding state as JSON string */
+    onboarding_s?: string;
+    /** New password request timestamp */
+    new_password_request_ts_dt?: string | null;
+    /** New password confirmation timestamp */
+    new_password_confirmation_ts_dt?: string | null;
+    /** Customer UID */
+    customer_uid?: string | null;
+    /** Credits customer UID for billing */
+    credits_customer_uid?: string | null;
+    /** Email unsubscription status */
+    unsubscribed_from_outbounds_b?: boolean;
+    /** Linked contact UID */
+    linked_contact_uid?: string | null;
+    /** MFA URL */
+    mfa_url_s?: string | null;
+    /** MFA secret */
+    mfa_secret_s?: string | null;
+    /** Email verification token */
+    email_token_s?: string | null;
+    /** Pending email update */
+    email_update_s?: string | null;
+    /** IAM providers (nested structure - not typed in detail) */
+    iam_providers?: any[];
+    /** User settings (nested structure - not typed in detail) */
+    settings?: any;
+    /** User events (nested structure - not typed in detail) */
+    events?: any[];
+    /** Allow additional fields that may come from the server */
+    [key: string]: any;
 }
 /**
  * Request payload for user login
@@ -112,16 +160,18 @@ export interface UserMeResponse {
         uid: string;
         /** User handle (username) */
         handle: string;
-        /** Email address of the user */
+        /** Email address of the user (may be empty string) */
         email: string;
-        /** First name of the user */
+        /** First name of the user (may be empty string) */
         firstName: string;
-        /** Last name of the user */
+        /** Last name of the user (may be empty string) */
         lastName: string;
-        /** Avatar URL for the user */
+        /** Avatar URL for the user (may be empty string) */
         avatarUrl: string;
         /** Array of roles assigned to the user */
         roles: string[];
+        /** Allow additional fields that may come from the server */
+        [key: string]: any;
     };
 }
 /**
@@ -134,47 +184,20 @@ export interface WhoAmIResponse {
     /** Response message from the server */
     message: string;
     /** User profile information */
-    profile: {
-        /** ISO 8601 timestamp of when the user was created */
-        creation_ts_dt: string;
-        /** Unique identifier for the user */
-        id: string;
-        /** ISO 8601 timestamp of when the user requested to join */
-        join_request_ts_dt: string | null;
-        /** ISO 8601 timestamp of when the user joined */
-        join_ts_dt: string;
-        /** ISO 8601 timestamp of last update */
-        last_update_ts_dt: string;
-        /** Origin of the user account */
-        origin_s: string;
-        /** Type of the record */
-        type_s: string;
-        /** User ID */
-        uid: string;
-        /** Email address */
-        email_s: string;
-        /** First name */
-        first_name_t: string;
-        /** User handle */
-        handle_s: string;
-        /** Last name */
-        last_name_t: string;
-    };
+    profile: Profile;
 }
 /**
- * Response from the health check ping endpoint
- * @interface HealthzPingResponse
+ * Response from the /memberships endpoint
+ * @interface MembershipsResponse
  */
-export interface HealthzPingResponse {
+export interface MembershipsResponse {
     /** Whether the request was successful */
     success: boolean;
     /** Response message from the server */
     message: string;
-    /** Service status information */
-    status: {
-        /** Status indicator (e.g., "OK") */
-        status: string;
-    };
-    /** API version */
-    version: string;
+    /** User profile information */
+    profile: Profile;
+    /** Memberships information */
+    memberships: any[];
 }
+export {};

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

@@ -1,6 +1,5 @@
 /**
- * @module types
- * @description TypeScript type definitions for all Datalayer API services.
+ * 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
@@ -26,7 +25,10 @@
  *   // Implementation
  * }
  * ```
+ *
+ * @module types
  */
+export * from './common';
 export * from './runtimes';
 export * from './iam';
 export * from './spacer';

package/lib/api/types/index.js

@@ -3,8 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 /**
- * @module types
- * @description TypeScript type definitions for all Datalayer API services.
+ * 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
@@ -30,7 +29,10 @@
  *   // Implementation
  * }
  * ```
+ *
+ * @module types
  */
+export * from './common';
 export * from './runtimes';
 export * from './iam';
 export * from './spacer';

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

@@ -29,7 +29,7 @@ export interface Environment {
     /** Simple resource specification */
     resources?: any;
     /** Name identifier for the environment */
-    name?: string;
+    name: string;
     /** Docker registry for the image */
     dockerRegistry?: string;
     /** Icon or avatar URL for the environment */
@@ -51,51 +51,21 @@ export interface Runtime {
     /** Name of the environment this runtime is based on */
     environment_name: string;
     /** Title of the environment for display */
-    environment_title?: string;
-    /** Credits allocated to this runtime */
-    credits?: number;
-    /** Current state of the runtime */
-    state?: 'starting' | 'running' | 'stopping' | 'stopped' | 'error';
+    environment_title: string;
     /** Type of runtime - notebook, terminal, or job */
-    type?: 'notebook' | 'terminal' | 'job';
-    /** Type of runtime (deprecated, use type) */
-    runtime_type?: 'notebook' | 'cell';
-    /** Credits consumed per hour */
+    type: string;
+    /** Credits consumed per second */
     burning_rate: number;
     /** User-friendly name for the runtime */
-    given_name?: string;
+    given_name: string;
     /** Authentication token for accessing the runtime */
-    token?: string;
+    token: string;
     /** Ingress URL for accessing the runtime */
-    ingress?: string;
-    /** Reservation ID if runtime is reserved */
-    reservation_id?: string;
+    ingress: string;
     /** ISO 8601 timestamp of when the runtime started */
-    started_at?: string;
+    started_at: string;
     /** ISO 8601 timestamp of when the runtime will expire */
-    expired_at?: string;
-    /** ISO 8601 timestamp of when the runtime was created */
-    created_at?: string;
-    /** ISO 8601 timestamp of last update */
-    updated_at?: string;
-    /** Jupyter kernel ID if applicable */
-    kernel_id?: string;
-    /** Path to the notebook file if runtime is for a notebook */
-    notebook_path?: string;
-    /** Cell ID if runtime is for a specific cell */
-    cell_id?: string;
-    /** URL for accessing Jupyter server */
-    jupyter_url?: string;
-    /** Token for Jupyter server authentication */
-    jupyter_token?: string;
-    /** Detailed status information */
-    status?: any;
-    /** Alternative naming from API responses */
-    podName?: string;
-    /** Alternative naming from API responses */
-    createdAt?: string;
-    /** Alternative naming from API responses */
-    environment?: string;
+    expired_at: string;
 }
 /**
  * Request payload for creating a new runtime