@datalayer/core 1.0.25 → 1.1.43

package/lib/hooks/useProjects.js

@@ -1,190 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-/**
- * Hook for fetching and managing projects.
- *
- * Projects are backed by the Spacer service as spaces with type_s="project".
- * Projects persist forever — only agents can terminate.
- *
- * Free tier limits: max 3 projects per user.
- *
- * @module hooks/useProjects
- */
-import { useMemo, useCallback } from 'react';
-import { useCache } from './useCache.js';
-/** The space type value used to identify project spaces in Solr */
-export const PROJECT_SPACE_VARIANT = 'project';
-const normalizeProjectItems = (items) => {
-    if (Array.isArray(items)) {
-        return items;
-    }
-    if (items && typeof items === 'object') {
-        return [items];
-    }
-    return [];
-};
-const isProjectSpace = (space) => {
-    const variant = space?.variant ?? space?.variant_s;
-    if (variant !== PROJECT_SPACE_VARIANT) {
-        return false;
-    }
-    const items = normalizeProjectItems(space?.items);
-    if (items.length === 0) {
-        return true;
-    }
-    const hasNotebook = items.some(item => (item?.type_s ?? item?.type) === 'notebook');
-    const hasDocument = items.some(item => {
-        const type = item?.type_s ?? item?.type;
-        return type === 'document' || type === 'lexical';
-    });
-    return hasNotebook && hasDocument;
-};
-/**
- * Hook to fetch user's projects (spaces with type "project").
- *
- * Uses the spacer service's spaces endpoint filtered by type.
- */
-export function useProjects() {
-    const { useUserSpaces } = useCache();
-    const { data: allSpaces, ...rest } = useUserSpaces();
-    // Filter to only project-type spaces
-    const projects = useMemo(() => {
-        if (!allSpaces)
-            return [];
-        return allSpaces
-            .filter((space) => isProjectSpace(space))
-            .map((space) => ({
-            uid: space.uid,
-            id: space.id ?? space.uid,
-            handle: space.handle ?? space.handle_s,
-            name: space.name ?? space.name_t,
-            description: space.description ?? space.description_t ?? '',
-            createdAt: space.created_at ? new Date(space.created_at) : new Date(),
-            isPublic: space.public ?? space.public_b ?? false,
-            attachedAgentPodName: space.attached_agent_pod_name_s || undefined,
-            attachedAgentSpecId: space.attached_agent_spec_id_s || undefined,
-        }));
-    }, [allSpaces]);
-    return { data: projects, ...rest };
-}
-/**
- * Hook to fetch a single project by UID.
- */
-export function useProject(uid) {
-    const { useSpace } = useCache();
-    // useSpace requires a string – pass empty string when uid is undefined
-    // (the query is disabled when spaceId is falsy inside useCache)
-    const { data: space, ...rest } = useSpace(uid ?? '');
-    const project = useMemo(() => {
-        if (!space)
-            return undefined;
-        const s = space;
-        return {
-            uid: s.uid,
-            id: s.id ?? s.uid,
-            handle: s.handle ?? s.handle_s,
-            name: s.name ?? s.name_t,
-            description: s.description ?? s.description_t ?? '',
-            createdAt: s.created_at ? new Date(s.created_at) : new Date(),
-            isPublic: s.public ?? s.public_b ?? false,
-            attachedAgentPodName: s.attached_agent_pod_name_s || undefined,
-            attachedAgentSpecId: s.attached_agent_spec_id_s || undefined,
-        };
-    }, [space]);
-    return { data: project, ...rest };
-}
-/**
- * Hook to create a new project.
- * Creates a space with type "project" via the spacer service.
- */
-export function useCreateProject() {
-    const { useCreateSpace } = useCache();
-    const createSpaceMutation = useCreateSpace();
-    const createProject = useCallback(async (request) => {
-        const spaceHandle = request.name
-            .toLowerCase()
-            .replace(/[^a-z0-9]+/g, '-')
-            .replace(/^-|-$/g, '');
-        return createSpaceMutation.mutateAsync({
-            space: {
-                name: request.name,
-                description: request.description || '',
-                handle: spaceHandle || `project-${Date.now()}`,
-                variant: PROJECT_SPACE_VARIANT,
-                public: false,
-            },
-        });
-    }, [createSpaceMutation]);
-    return {
-        ...createSpaceMutation,
-        createProject,
-    };
-}
-/**
- * Hook to update a project (e.g. persist the attached agent pod name).
- * Uses the spacer PUT endpoint via useUpdateSpace.
- */
-export function useUpdateProject() {
-    const { useUpdateSpace } = useCache();
-    const updateSpaceMutation = useUpdateSpace();
-    /** Assign an agent runtime to the project */
-    const assignAgent = useCallback(async (project, agentPodName, agentSpecId) => {
-        return updateSpaceMutation.mutateAsync({
-            id: project.id,
-            name: project.name,
-            description: project.description,
-            attached_agent_pod_name_s: agentPodName,
-            attached_agent_spec_id_s: agentSpecId || '',
-        });
-    }, [updateSpaceMutation]);
-    /** Rename a project */
-    const renameProject = useCallback(async (project, newName) => {
-        return updateSpaceMutation.mutateAsync({
-            id: project.id,
-            name: newName,
-            description: project.description,
-        });
-    }, [updateSpaceMutation]);
-    /** Remove the agent assignment from the project */
-    const unassignAgent = useCallback(async (project) => {
-        return updateSpaceMutation.mutateAsync({
-            id: project.id,
-            name: project.name,
-            description: project.description,
-            attached_agent_pod_name_s: '',
-            attached_agent_spec_id_s: '',
-        });
-    }, [updateSpaceMutation]);
-    return {
-        ...updateSpaceMutation,
-        assignAgent,
-        unassignAgent,
-        renameProject,
-    };
-}
-/**
- * Hook to refresh the projects list.
- */
-export function useRefreshProjects() {
-    const { useRefreshUserSpaces } = useCache();
-    return useRefreshUserSpaces();
-}
-/**
- * Hook to delete a project (space) and all its contents.
- */
-export function useDeleteProject() {
-    const { useDeleteSpace } = useCache();
-    return useDeleteSpace();
-}
-/**
- * Hook to fetch the default notebook and document UIDs for a project.
- *
- * This calls the spacer `GET /spaces/:uid/default-items` endpoint which
- * returns the UID of the first notebook and first document in the space.
- */
-export function useProjectDefaultItems(projectUid) {
-    const { useSpaceDefaultItems } = useCache();
-    return useSpaceDefaultItems(projectUid);
-}

package/lib/hooks/useRuntimes.d.ts

@@ -1,5 +0,0 @@
-export declare const useRuntimes: () => {
-    mountLocalFolder: (kernelId: string) => void;
-    unmountLocalFolder: (kernelId: string) => void;
-};
-export default useRuntimes;

package/lib/hooks/useRuntimes.js

@@ -1,34 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { requestJupyterKernelsExtension } from '../stateful/jupyter/kernelsHandler.js';
-export const useRuntimes = () => {
-    // Folder Mounting ----------------------------------------------------------
-    const mountLocalFolder = (kernelId) => {
-        requestJupyterKernelsExtension(`jump/${kernelId}`)
-            .then(data => {
-            //        console.log('--- Mount Local Folder', data);
-        })
-            .catch(reason => {
-            console.error(`Error while accessing the jupyter server jupyter_kernels extension.\n${reason}`);
-        });
-    };
-    const unmountLocalFolder = (kernelId) => {
-        requestJupyterKernelsExtension(`jump/${kernelId}`, {
-            method: 'DELETE',
-        })
-            .then(data => {
-            //        console.log('--- Unmount Local Folder', data);
-        })
-            .catch(reason => {
-            console.error(`Error while accessing the jupyter server jupyter_kernels extension.\n${reason}`);
-        });
-    };
-    // --------------------------------------------------------------------------
-    return {
-        mountLocalFolder,
-        unmountLocalFolder,
-    };
-};
-export default useRuntimes;

package/lib/mocks/jupyter/index.js

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

package/lib/mocks/models/CourseMock.d.ts

@@ -1,6 +0,0 @@
-import { ICourse } from '../../models/Course';
-export declare const newCourseMock: (name: string) => ICourse;
-export declare const COURSE_1_MOCK: ICourse;
-export declare const COURSE_2_MOCK: ICourse;
-export declare const COURSE_3_MOCK: ICourse;
-export declare const COURSES_MOCK: ICourse[];

package/lib/mocks/models/CourseMock.js

@@ -1,29 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { uniqueNamesGenerator, names } from 'unique-names-generator';
-import { newUlid } from '../../utils/index.js';
-import { newSpaceMock } from './SpaceMock.js';
-import { newUserMock } from './UserMock.js';
-export const newCourseMock = (name) => {
-    const course = {
-        id: newUlid(),
-        owner: newUserMock(uniqueNamesGenerator({ dictionaries: [names] }), uniqueNamesGenerator({ dictionaries: [names] })),
-        handle: newUlid(),
-        type: 'space',
-        variant: 'course',
-        name: name,
-        description: name + ' description.',
-        public: false,
-        creationDate: new Date(),
-        items: [],
-        itemIds: [],
-        seedSpace: newSpaceMock('space content'),
-    };
-    return course;
-};
-export const COURSE_1_MOCK = newCourseMock('Course 1');
-export const COURSE_2_MOCK = newCourseMock('Course 2');
-export const COURSE_3_MOCK = newCourseMock('Course 3');
-export const COURSES_MOCK = [COURSE_1_MOCK, COURSE_2_MOCK, COURSE_3_MOCK];

package/lib/mocks/models/SpaceMock.d.ts

@@ -1,6 +0,0 @@
-import { ISpace } from '../../models/Space';
-export declare const newSpaceMock: (name: string) => ISpace;
-export declare const SPACE_1_MOCK: ISpace;
-export declare const SPACE_2_MOCK: ISpace;
-export declare const SPACE_3: ISpace;
-export declare const SPACES_MOCK: ISpace[];

package/lib/mocks/models/SpaceMock.js

@@ -1,25 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-import { uniqueNamesGenerator, names } from 'unique-names-generator';
-import { newUlid } from '../../utils/index.js';
-import { newUserMock } from './UserMock.js';
-export const newSpaceMock = (name) => {
-    const space = {
-        id: newUlid(),
-        owner: newUserMock(uniqueNamesGenerator({ dictionaries: [names] }), uniqueNamesGenerator({ dictionaries: [names] })),
-        handle: newUlid(),
-        type: 'space',
-        variant: 'default',
-        name: name,
-        description: name + ' description.',
-        public: false,
-        creationDate: new Date(),
-    };
-    return space;
-};
-export const SPACE_1_MOCK = newSpaceMock('Space 1');
-export const SPACE_2_MOCK = newSpaceMock('Space 2');
-export const SPACE_3 = newSpaceMock('Space 3');
-export const SPACES_MOCK = [SPACE_1_MOCK, SPACE_2_MOCK, SPACE_3];

package/lib/models/Assignment.d.ts

@@ -1,7 +0,0 @@
-import { IBaseNotebook } from './Notebook';
-import { IStudentItem } from './StudentItem';
-export type IAssignment = IBaseNotebook & {
-    type: 'assignment';
-    studentItem?: IStudentItem;
-};
-export default IAssignment;

package/lib/models/Assignment.js

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

package/lib/models/Cell.d.ts

@@ -1,8 +0,0 @@
-import { IItem } from './Item';
-export type ICell = IItem & {
-    type: 'cell';
-    source: string;
-    outputshotUrl?: string;
-    outputshotData?: string;
-};
-export default ICell;

package/lib/models/Cell.js

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

package/lib/models/CodeBlock.d.ts

@@ -1,10 +0,0 @@
-import { IUser } from './User';
-export type CodeBlock = {
-    id: string;
-    type: 'codeblock';
-    code: string;
-    author: IUser;
-    ancestor: CodeBlock;
-    descendants: CodeBlock[];
-};
-export default CodeBlock;

package/lib/models/CodeBlock.js

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

package/lib/models/CodeSandboxSnapshot.d.ts

@@ -1,92 +0,0 @@
-/**
- * Code Sandbox snapshot from API.
- */
-export interface IAPICodeSandboxSnapshot {
-    /**
-     * Snapshot UID
-     */
-    uid: string;
-    /**
-     * Snapshot name
-     */
-    name: string;
-    /**
-     * Snapshot description
-     */
-    description: string;
-    /**
-     * Snapshot environment
-     */
-    environment: string;
-    /**
-     * Snapshot metadata
-     */
-    metadata: Record<string, any>;
-    /**
-     * Snapshot size in bytes
-     */
-    size: number;
-    /**
-     * Latest update time of the snapshot
-     */
-    updated_at: string;
-    /**
-     * Snapshot format
-     */
-    format: string;
-    /**
-     * Snapshot format version
-     */
-    format_version: string;
-    /**
-     * Snapshot status
-     */
-    status: string;
-}
-/**
- * Code Sandbox snapshot model.
- */
-export interface ICodeSandboxSnapshot {
-    /**
-     * Snapshot UID
-     */
-    id: string;
-    /**
-     * Snapshot name
-     */
-    name: string;
-    /**
-     * Snapshot description
-     */
-    description: string;
-    /**
-     * Snapshot environment
-     */
-    environment: string;
-    /**
-     * Snapshot metadata
-     */
-    metadata: Record<string, any>;
-    /**
-     * Snapshot size in bytes
-     */
-    size: number;
-    /**
-     * Latest update time of the snapshot
-     */
-    updatedAt: Date;
-    /**
-     * Snapshot format
-     */
-    format: string;
-    /**
-     * Snapshot format version
-     */
-    formatVersion: string;
-    /**
-    
-     * Snapshot status
-     */
-    status: string;
-}
-export declare function asCodeSandboxSnapshot(s: IAPICodeSandboxSnapshot): ICodeSandboxSnapshot;

package/lib/models/CodeSandboxSnapshot.js

@@ -1,13 +0,0 @@
-/*
- * Copyright (c) 2023-2025 Datalayer, Inc.
- * Distributed under the terms of the Modified BSD License.
- */
-export function asCodeSandboxSnapshot(s) {
-    const { uid, updated_at, format_version, ...others } = s;
-    return {
-        ...others,
-        id: uid,
-        updatedAt: new Date(updated_at),
-        formatVersion: format_version,
-    };
-}

package/lib/models/CodeSandboxSnapshotDTO.d.ts

@@ -1,173 +0,0 @@
-/**
- * Snapshot domain model for the Datalayer Client.
- *
- * @module models/CodeSandboxSnapshotDTO
- */
-import type { DatalayerClient } from '../index';
-import { RuntimeDTO } from './RuntimeDTO';
-/**
- * Represents a runthime snapshot of a runtime's state and files.
- * @interface CodeSandboxSnapshotData
- */
-export interface CodeSandboxSnapshotData {
-    /** 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[];
-}
-/**
- * Stable public interface for Snapshot data.
- * This is the contract that Client consumers can rely on.
- * The raw API may change, but this interface remains stable.
- */
-export interface CodeSandboxSnapshotJSON {
-    /** 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;
-    /** ISO 8601 timestamp when the snapshot was last updated */
-    updatedAt: string;
-}
-/**
- * Request payload for creating a code sandbox snapshot
- * @interface CreateCodeSandboxSnapshotRequest
- */
-export interface CreateCodeSandboxSnapshotRequest {
-    /** 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 code snapshot snapshot
- * @interface GetCodeSandboxSnapshotResponse
- */
-export interface GetCodeSandboxSnapshotResponse {
-    /** Indicates if the request was successful */
-    success: boolean;
-    /** Response message */
-    message: string;
-    /** The snapshot details */
-    snapshot: CodeSandboxSnapshotData;
-}
-/**
- * Response for creating a code sandbox snapshot
- * @interface CreateCodeSandboxSnapshotResponse
- */
-export interface CreateCodeSandboxSnapshotResponse {
-    /** Indicates if the request was successful */
-    success: boolean;
-    /** Response message */
-    message: string;
-    /** The created snapshot details */
-    snapshot: CodeSandboxSnapshotData;
-}
-/**
- * Response from listing code sandbox snapshots
- * @interface ListCodeSandboxSnapshotsResponse
- */
-export interface ListCodeSandboxSnapshotsResponse {
-    /** Whether the request was successful */
-    success: boolean;
-    /** Response message from the server */
-    message: string;
-    /** Array of code sandbox snapshots */
-    snapshots: CodeSandboxSnapshotData[];
-}
-/**
- * Snapshot domain model that wraps API responses with convenient methods.
- * Provides code sandbox snapshot management with data refresh and lifecycle operations.
- *
- * @example
- * ```typescript
- * const snapshot = await runtime.createSnapshot('my-checkpoint');
- * const runtime = await snapshot.restore();
- * ```
- */
-export declare class CodeSandboxSnapshotDTO {
-    protected _data: CodeSandboxSnapshotData;
-    private _client;
-    private _deleted;
-    /**
-     * Create a Code Sandbox Snapshot instance.
-     *
-     * @param data - Snapshot data from API
-     * @param client - Client instance
-     */
-    constructor(data: CodeSandboxSnapshotData, client: DatalayerClient);
-    /**
-     * Check if this snapshot has been deleted and throw error if so.
-     * @throws Error if deleted
-     */
-    private _checkDeleted;
-    /** Unique identifier for the snapshot. */
-    get uid(): string;
-    /** Name of the snapshot. */
-    get name(): string;
-    /** Description of the snapshot. */
-    get description(): string;
-    /** Name of the environment used by the runtime. */
-    get environment(): string;
-    /** When the snapshot was last updated. */
-    get updatedAt(): Date;
-    /**
-     * Delete this snapshot permanently.
-     * After deletion, subsequent calls to dynamic methods will throw errors.
-     */
-    delete(): Promise<void>;
-    /**
-     * Create a code sandbox from this snapshot (restore functionality).
-     *
-     * @param minutesLimit - Time limit in minutes for the restored runtime
-     * @returns Created Runtime instance
-     */
-    restore(minutesLimit: number): Promise<RuntimeDTO>;
-    /**
-     * Get code snapshot snapshot data in camelCase format.
-     * Returns only the core fields that consumers need.
-     * This provides a stable interface regardless of API changes.
-     * Note: Returns current cached state - call getStatus() first if you need fresh data.
-     *
-     * @returns Core code snapshot snapshot data with camelCase properties
-     */
-    toJSON(): CodeSandboxSnapshotJSON;
-    /**
-     * Get the raw snapshot data exactly as received from the API.
-     * This preserves the original snake_case naming from the API response.
-     *
-     * @returns Raw snapshot data from API
-     */
-    rawData(): CodeSandboxSnapshotData;
-    /** String representation of the snapshot. */
-    toString(): string;
-}