@datalayer/core 1.0.24 → 1.1.41

package/lib/models/SpaceDTO.d.ts

@@ -1,334 +0,0 @@
-import type { DatalayerClient } from '../index';
-import { NotebookDTO, type NotebookJSON } from './NotebookDTO';
-import { NotebookData } from './NotebookDTO';
-import { LexicalDTO, type LexicalJSON } from './LexicalDTO';
-/**
- * Represents a workspace or project space in Datalayer
- * @interface SpaceData
- */
-export interface SpaceData {
-    uid: string;
-    id?: string;
-    name_t: string;
-    handle_s: string;
-    variant_s: string;
-    description_t: string;
-    tags_ss?: string[];
-    members?: any[];
-    items?: any[];
-    public_b?: boolean;
-    creation_ts_dt?: string;
-    attached_agent_pod_name_s?: string;
-    attached_agent_spec_id_s?: string;
-    attached_agent_given_name_s?: string;
-    shared_owner_user_uids_ss?: string[];
-    shared_ower_user_uids_ss?: string[];
-}
-/**
- * Stable public interface for Space data.
- * This is the contract that Client consumers can rely on.
- * The raw API may change, but this interface remains stable.
- */
-export interface SpaceJSON {
-    /** ulid for the space */
-    uid: string;
-    /** Name of the space */
-    name: string;
-    /** Handle for the space */
-    handle: string;
-    /** Variant of the space */
-    variant: string;
-    /** Description of the space */
-    description: string;
-    /** Items contained in the space (as JSON) */
-    items: Array<NotebookJSON | LexicalJSON>;
-    /** Owner user UIDs for this space */
-    ownerUserUids?: string[];
-}
-/**
- * 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 declare class SpaceDTO {
-    protected _data: SpaceData;
-    private _client;
-    private _items;
-    private _deleted;
-    /**
-     * Create a Space instance.
-     *
-     * @param data - Space data from API
-     * @param client - Client instance
-     */
-    constructor(data: SpaceData, client: DatalayerClient);
-    /**
-     * Check if this space has been deleted and throw error if so.
-     * @throws Error if deleted
-     */
-    private _checkDeleted;
-    /**
-     * Refresh space data from the API by fetching user's spaces.
-     */
-    refresh(): Promise<void>;
-    /** Unique identifier for the space. */
-    get uid(): string;
-    /** URL-friendly handle for the space. */
-    get handle(): string;
-    /** Space variant type. */
-    get variant(): string;
-    /**
-     * The name of the space.
-     */
-    get name(): string;
-    /**
-     * The description of the space.
-     */
-    get description(): string;
-    /**
-     * Helper method to create items in this space.
-     *
-     * @param itemType - Type of item to create
-     * @param data - Creation configuration
-     * @returns Created model instance
-     * @internal
-     */
-    private _createItem;
-    /**
-     * Get all items in this space as model instances.
-     *
-     * @returns Array of Notebook and Lexical model instances
-     */
-    getItems(): Promise<(NotebookDTO | LexicalDTO)[]>;
-    /**
-     * Create a new notebook in this space.
-     *
-     * @param data - Notebook creation configuration
-     * @returns Created Notebook instance
-     */
-    createNotebook(data: {
-        name: string;
-        description: string;
-        file?: File | Blob;
-    }): Promise<NotebookDTO>;
-    /**
-     * Create a new lexical document in this space.
-     *
-     * @param data - Lexical creation configuration
-     * @returns Created Lexical instance
-     */
-    createLexical(data: {
-        name: string;
-        description: string;
-        file?: File | Blob;
-    }): Promise<LexicalDTO>;
-    /**
-     * 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(): SpaceJSON;
-    /**
-     * 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(): SpaceData;
-    /** String representation of the space. */
-    toString(): string;
-}
-/**
- * Request payload for creating a new space
- * @interface CreateSpaceRequest
- */
-export interface CreateSpaceRequest {
-    name: string;
-    description: string;
-    variant: string;
-    spaceHandle: string;
-    organizationId: string;
-    seedSpaceId: string;
-    public: boolean;
-}
-/**
- * Response from getting a collaboration session ID
- * @interface CollaborationSessionResponse
- */
-export interface CollaborationSessionResponse {
-    success: boolean;
-    sessionId?: string;
-    error?: string;
-}
-/**
- * Response from creating a space
- * @interface CreateSpaceResponse
- */
-export interface CreateSpaceResponse {
-    success: boolean;
-    message: string;
-    space?: SpaceData;
-}
-/**
- * Request payload for creating a new notebook (multipart/form-data)
- * @interface CreateNotebookRequest
- */
-export interface CreateNotebookRequest {
-    spaceId: string;
-    notebookType: string;
-    name: string;
-    description: string;
-    file?: File | Blob;
-}
-/**
- * Response from creating a notebook
- * @interface CreateNotebookResponse
- */
-export interface CreateNotebookResponse {
-    success: boolean;
-    message: string;
-    notebook?: NotebookData;
-}
-/**
- * Response from getting a notebook
- * @interface GetNotebookResponse
- */
-export interface GetNotebookResponse {
-    success: boolean;
-    message: string;
-    notebook?: NotebookData;
-}
-/**
- * Request payload for updating a notebook
- * @interface UpdateNotebookRequest
- */
-export interface UpdateNotebookRequest {
-    name?: string;
-    description?: string;
-}
-/**
- * Response from updating a notebook
- * @interface UpdateNotebookResponse
- */
-export interface UpdateNotebookResponse {
-    success: boolean;
-    message: string;
-    notebook?: NotebookData;
-}
-/**
- * Represents an item within a space
- * @interface SpaceItem
- */
-export interface SpaceItem {
-    id: string;
-    type_s: 'notebook' | 'lexical';
-    space_id: string;
-    item_id: string;
-    name: string;
-    created_at: string;
-    updated_at?: string;
-}
-/**
- * Response from getting space items
- * @interface GetSpaceItemsResponse
- */
-export interface GetSpaceItemsResponse {
-    success: boolean;
-    message: string;
-    items: SpaceItem[];
-}
-/**
- * Response from deleting a space item
- * @interface DeleteSpaceItemResponse
- */
-export interface DeleteSpaceItemResponse {
-    success: boolean;
-    message: string;
-}
-/**
- * Response from getting a single space item
- * @interface GetSpaceItemResponse
- */
-export interface GetSpaceItemResponse {
-    success: boolean;
-    message: string;
-    item?: any;
-}
-/**
- * Response from getting spaces for a user
- * @interface SpacesForUserResponse
- */
-export interface SpacesForUserResponse {
-    success: boolean;
-    message: string;
-    spaces: SpaceData[];
-}
-/**
- * Request payload for updating a space.
- * Supports arbitrary Solr fields via index signature.
- * @interface UpdateSpaceRequest
- */
-export interface UpdateSpaceRequest {
-    name?: string;
-    description?: string;
-    [key: string]: unknown;
-}
-/**
- * Response from getting a space by ID
- * @interface GetSpaceResponse
- */
-export interface GetSpaceResponse {
-    success: boolean;
-    message: string;
-    space?: SpaceData;
-}
-/**
- * Response from updating a space
- * @interface UpdateSpaceResponse
- */
-export interface UpdateSpaceResponse {
-    success: boolean;
-    message: string;
-    space?: SpaceData;
-}
-/**
- * Response from deleting a space
- * @interface DeleteSpaceResponse
- */
-export interface DeleteSpaceResponse {
-    success: boolean;
-    message: string;
-}
-/**
- * Response from getting default items for a space
- * @interface GetSpaceDefaultItemsResponse
- */
-export interface GetSpaceDefaultItemsResponse {
-    success: boolean;
-    message: string;
-    default_notebook_uid: string | null;
-    default_document_uid: string | null;
-}
-/**
- * Response from getting spaces by type
- * @interface GetSpacesByTypeResponse
- */
-export interface GetSpacesByTypeResponse {
-    success: boolean;
-    message: string;
-    spaces: SpaceData[];
-}

package/lib/models/SpaceDTO.js

@@ -1,244 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Space domain model for the Datalayer Client.
- *
- * @module models/SpaceDTO
- */
-import * as users from '../api/spacer/users.js';
-import * as items from '../api/spacer/items.js';
-import * as notebooks from '../api/spacer/notebooks.js';
-import * as lexicals from '../api/spacer/lexicals.js';
-import { NotebookDTO } from './NotebookDTO.js';
-import { LexicalDTO } from './LexicalDTO.js';
-import { ItemTypes } from '../client/constants.js';
-import { convertSpaceItemsToModels } from '../client/utils/spacerUtils.js';
-import { validateJSON } from '../api/utils/validation.js';
-/**
- * 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;
-    _client;
-    _items = null;
-    _deleted = false;
-    /**
-     * Create a Space instance.
-     *
-     * @param data - Space data from API
-     * @param client - Client instance
-     */
-    constructor(data, client) {
-        this._data = data;
-        this._client = client;
-    }
-    // ========================================================================
-    // 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._client.getToken();
-        const spacerRunUrl = this._client.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 Client
-        const token = this._client.getToken();
-        const spacerRunUrl = this._client.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._client);
-            }
-        }
-        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._client);
-            }
-        }
-        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._client.getToken();
-        const spacerRunUrl = this._client.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._client);
-        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 ownerUserUids = Array.from(new Set([
-            ...(this._data.shared_owner_user_uids_ss || []),
-            ...(this._data.shared_ower_user_uids_ss || []),
-        ].filter(uid => typeof uid === 'string' && uid.length > 0)));
-        const obj = {
-            uid: this.uid,
-            name: this.name,
-            description: this.description,
-            variant: this.variant,
-            handle: this.handle,
-            ownerUserUids,
-            items: this._data.items
-                ? convertSpaceItemsToModels(this._data.items, this._client).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/SpaceItem.d.ts

@@ -1,10 +0,0 @@
-import { INotebook } from './Notebook';
-import { IDocument } from './Document';
-import { ICell } from './Cell';
-import { IDataset } from './Dataset';
-import { IEnvironment } from './Environment';
-import { ILesson } from './Lesson';
-import { IExercise } from './Exercise';
-import { IAssignment } from './Assignment';
-export type ISpaceItem = IDataset | INotebook | ICell | IEnvironment | ILesson | IExercise | IAssignment | IDocument;
-export default ISpaceItem;

package/lib/models/SpaceItem.js

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

package/lib/models/SpaceMember.d.ts

@@ -1,6 +0,0 @@
-import { Member } from './Member';
-import { ISpace } from './Space';
-export type SpaceMember = Member & {
-    space?: ISpace;
-};
-export default SpaceMember;

package/lib/models/SpaceMember.js

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

package/lib/models/StudentItem.d.ts

@@ -1,21 +0,0 @@
-import { IItemType } from './ItemType';
-import { IStudent } from './Student';
-import { ISpaceItem } from './SpaceItem';
-export type IStudentItem = {
-    id: string;
-    type: 'student_item';
-    student?: IStudent;
-    item?: ISpaceItem;
-    itemId: string;
-    itemType: IItemType;
-    points?: number;
-    nbgrades?: any;
-    nbgradesTotalPoints?: number;
-    nbgradesTotalScore?: number;
-    completed?: boolean;
-    codeStudent?: string;
-    pass?: boolean;
-    invalid?: boolean;
-    invalidReason?: string;
-};
-export default IStudentItem;

package/lib/models/StudentItem.js

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

package/lib/services/DatalayerServiceManager.d.ts

@@ -1,22 +0,0 @@
-import { ServiceManager } from '@jupyterlab/services';
-/**
- * Creates a ServiceManager configured for Datalayer.
- *
- * This function requests a new kernel from Datalayer's platform and
- * returns a configured ServiceManager that connects to the allocated
- * Jupyter server instance.
- *
- * @param environmentName - The name of the Datalayer environment to use
- * @param credits - The credit limit for this kernel session
- * @returns A configured ServiceManager instance
- * @throws Error if the kernel request fails or configuration is missing
- *
- * @example
- * ```typescript
- * const serviceManager = await createDatalayerServiceManager('ai-agents-env', 100);
- * await serviceManager.ready;
- * // Use the service manager with notebooks
- * ```
- */
-export declare const createDatalayerServiceManager: (environmentName?: string, credits?: number) => Promise<ServiceManager.IManager>;
-export default createDatalayerServiceManager;