@datalayer/core 0.0.2 → 0.0.4

package/lib/api/runtimes/{runtimesApi.js → actions.js}

@@ -2,28 +2,23 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-/*
- * Copyright (c) 2021-2024 Datalayer, Inc.
- *
- * Datalayer License
- */
 /**
- * Datalayer Jupyter API interface.
+ * Runtimes APIs.
  */
 import { URLExt } from '@jupyterlab/coreutils';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { Upload } from 'tus-js-client';
-import { requestRunAPI } from '..';
+import { requestDatalayerAPI, } from '..';
 import { asRuntimeSnapshot } from '../../models';
 import { iamStore, runtimesStore } from '../../state';
 import { sleep } from '../../utils';
 /**
- * Get available environments.
+ * Get available Environments.
  */
 export async function getEnvironments() {
-    const data = await requestRunAPI({
+    const data = await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, 'api/runtimes/v1/environments'),
-        token: iamStore.getState().token
+        token: iamStore.getState().token,
     });
     if (!data.success) {
         console.error('Failed to fetch available environments.', data);
@@ -32,7 +27,7 @@ export async function getEnvironments() {
     return data.environments ?? [];
 }
 /**
- * Create a Kernel.
+ * Create a Runtime.
  */
 export async function createRuntime(options) {
     const { externalToken, token } = iamStore.getState();
@@ -40,7 +35,7 @@ export async function createRuntime(options) {
         environment_name: options.environmentName,
         type: options.type ?? 'notebook',
         given_name: options.givenName,
-        credits_limit: options.creditsLimit
+        credits_limit: options.creditsLimit,
     };
     if (options.capabilities) {
         body['capabilities'] = options.capabilities;
@@ -48,17 +43,17 @@ export async function createRuntime(options) {
     if (options.snapshot) {
         body['from'] = options.snapshot;
     }
-    const data = await requestRunAPI({
+    const data = await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, `api/runtimes/v1/runtimes`),
         method: 'POST',
         body,
         token: token,
         // externalToken may be needed for addons (like credits...).
-        headers: externalToken ?
-            {
-                'X-External-Token': externalToken
+        headers: externalToken
+            ? {
+                'X-External-Token': externalToken,
             }
-            : undefined
+            : undefined,
     });
     if (!data.success || !data.runtime) {
         const msg = `Failed to create a kernel for the environment ${options.environmentName}.`;
@@ -68,12 +63,12 @@ export async function createRuntime(options) {
     return data.runtime;
 }
 /**
- * List Runtimes
+ * Get the Runtimes.
  */
 export async function getRuntimes() {
-    const data = await requestRunAPI({
+    const data = await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, 'api/runtimes/v1/runtimes'),
-        token: iamStore.getState().token
+        token: iamStore.getState().token,
     });
     if (!data.success) {
         const msg = 'Failed to list the running kernels.';
@@ -83,38 +78,37 @@ export async function getRuntimes() {
     return data.runtimes ?? [];
 }
 /**
- * Remove a Kernel
+ * Delete a Runtime
  */
 export async function deleteRuntime(options) {
     const externalToken = iamStore.getState().externalToken;
-    await requestRunAPI({
+    await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, `api/runtimes/v1/runtimes/${options.id}`) +
             URLExt.objectToQueryString(options.reason ? { reason: options.reason } : {}),
         method: 'DELETE',
         token: iamStore.getState().token,
         // externalToken may be needed for addons (like credits...).
-        headers: externalToken ?
-            {
-                'X-External-Token': externalToken
+        headers: externalToken
+            ? {
+                'X-External-Token': externalToken,
             }
-            :
-                undefined
+            : undefined,
     });
 }
 /**
- * Snapshot a Kernel.
+ * Snapshot a Runtime.
  */
 export async function snapshotRuntime(options) {
-    const data = await requestRunAPI({
+    const data = await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, 'api/runtimes/v1/runtime-snapshots'),
         method: 'POST',
         body: {
             pod_name: options.id,
             name: options.name,
             description: options.description,
-            stop: options.stop
+            stop: options.stop,
         },
-        token: iamStore.getState().token
+        token: iamStore.getState().token,
     });
     if (!data.success || !data.snapshot) {
         throw new Error(`Failed to pause the kernel snapshot ${options.id} - ${data}`);
@@ -122,12 +116,12 @@ export async function snapshotRuntime(options) {
     return asRuntimeSnapshot(data.snapshot);
 }
 /**
- * Get Kernel Snapshots.
+ * Get Runtime Snapshots.
  */
 export async function getRuntimeSnapshots() {
-    const data = await requestRunAPI({
+    const data = await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, 'api/runtimes/v1/runtime-snapshots'),
-        token: iamStore.getState().token
+        token: iamStore.getState().token,
     });
     if (!data.success) {
         console.error('Failed to fetch kernel snapshots.', data);
@@ -136,23 +130,23 @@ export async function getRuntimeSnapshots() {
     return (data.snapshots ?? []).map(asRuntimeSnapshot);
 }
 /**
- * Load a kernel snapshot within a kernel.
+ * Load a Runtime Snapshot within a kernel.
  */
 export async function loadRuntimeSnapshot(options) {
-    const data = await requestRunAPI({
+    const data = await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, 'api/runtimes/v1/runtimes', options.id),
         method: 'PUT',
         body: {
-            from: options.from
+            from: options.from,
         },
-        token: iamStore.getState().token
+        token: iamStore.getState().token,
     });
     if (!data.success) {
         throw new Error(`Failed to load the kernel snapshot; ${data.message}`);
     }
 }
 /**
- * Returns the runtime snapshot download URL.
+ * Returns the Runtime Snapshot download URL.
  *
  * @param id Snapshot UID to download
  * @returns The download URL
@@ -161,11 +155,11 @@ export function createRuntimeSnapshotDownloadURL(id) {
     return (URLExt.join(runtimesStore.getState().runtimesRunUrl, `api/runtimes/v1/runtime-snapshots/${id}`) +
         URLExt.objectToQueryString({
             download: '1',
-            token: iamStore.getState().token ?? ''
+            token: iamStore.getState().token ?? '',
         }));
 }
 /**
- * Export runtime snapshot.
+ * Export a Runtime Snapshot.
  *
  * @param id Runtime snapshot UID to download
  */
@@ -179,23 +173,23 @@ export function exportRuntimeSnapshot(id) {
     document.body.removeChild(element);
 }
 /**
- * Delete runtime snapshot.
+ * Delete a Runtime Snapshot.
  */
 export async function deleteRuntimeSnapshot(id) {
-    await requestRunAPI({
+    await requestDatalayerAPI({
         url: URLExt.join(runtimesStore.getState().runtimesRunUrl, `api/runtimes/v1/runtime-snapshots/${id}`),
         method: 'DELETE',
-        token: iamStore.getState().token
+        token: iamStore.getState().token,
     });
-    // Poll runtime snapshot state upto its deletion
+    // Poll Runtime Snapshot state up-to its deletion
     try {
         let sleepTimeout = 1000;
         while (true) {
             await sleep(sleepTimeout);
             sleepTimeout *= 2;
-            const response = await requestRunAPI({
+            const response = await requestDatalayerAPI({
                 url: URLExt.join(runtimesStore.getState().runtimesRunUrl, `api/runtimes/v1/runtime-snapshots/${id}`),
-                token: iamStore.getState().token
+                token: iamStore.getState().token,
             });
             if (response.success === false) {
                 throw new Error(response.message);
@@ -213,26 +207,26 @@ export async function deleteRuntimeSnapshot(id) {
     }
 }
 /**
- * Update runtime snapshot metadata.
+ * Update Runtime Snapshot metadata.
  */
 export async function updateRuntimeSnapshot(id, metadata) {
     if (metadata.name || metadata.description) {
-        await requestRunAPI({
+        await requestDatalayerAPI({
             url: URLExt.join(runtimesStore.getState().runtimesRunUrl, `api/runtimes/v1/runtime-snapshots/${id}`),
             method: 'PATCH',
             body: { ...metadata },
-            token: iamStore.getState().token
+            token: iamStore.getState().token,
         });
     }
 }
 /**
- * Upload a runtime snapshot.
+ * Upload a Runtime Snapshot.
  *
  * Note: The promise will be rejected if the runtime state is empty.
  */
 export async function uploadRuntimeSnapshot(options) {
     if (options.file.size === 0) {
-        return Promise.reject('Empty runtime snapshot');
+        return Promise.reject('Empty Runtime Snapshot.');
     }
     const tracker = new PromiseDelegate();
     // Create a new tus upload.
@@ -255,7 +249,7 @@ export async function uploadRuntimeSnapshot(options) {
         // Callback for once the upload is completed.
         onSuccess: () => {
             tracker.resolve();
-        }
+        },
     });
     // Check if there are any previous uploads to continue then start the upload.
     const previousUploads = await upload.findPreviousUploads();

package/lib/api/runtimes/{runtimesApi.d.ts → apis.d.ts}

@@ -1,15 +1,18 @@
+/**
+ * Runtimes APIs.
+ */
 import { ISessionContext } from '@jupyterlab/apputils';
 import { ServiceManager, Kernel, ServerConnection } from '@jupyterlab/services';
 import { IDisposable } from '@lumino/disposable';
 import { ISignal } from '@lumino/signaling';
-import type { IRuntimeSnapshot, IRuntimeCapabilities } from '../../models';
-import { IDatalayerEnvironment, IRuntimePod, IRuntimeType } from '../../models';
-import type { IRuntimeModel, RuntimeLocation } from './models';
+import type { IRuntimeSnapshot, IRuntimeCapabilities, IRuntimeModel, IDatalayerEnvironment, IRuntimeType, IRuntimeLocation } from '../../models';
 /**
- *
+ * Abstract interface for the Datalayer session context.
+ * It extends the JupyterLab session context
+ * to include the runtime location.
  */
 export interface IDatalayerSessionContext extends ISessionContext {
-    get location(): RuntimeLocation;
+    get location(): IRuntimeLocation;
 }
 /**
  * Runtime creation options
@@ -268,103 +271,3 @@ export interface IMultiServiceManager extends ServiceManager.IManager {
      */
     readonly remoteChanged: ISignal<ServiceManager.IManager, IRemoteServicesManager | undefined>;
 }
-/**
- * Get available environments.
- */
-export declare function getEnvironments(): Promise<IDatalayerEnvironment[]>;
-/**
- * Create a Kernel.
- */
-export declare function createRuntime(options: IRuntimeOptions): Promise<IRuntimePod>;
-/**
- * List Runtimes
- */
-export declare function getRuntimes(): Promise<IRuntimePod[]>;
-/**
- * Remove a Kernel
- */
-export declare function deleteRuntime(options: {
-    /**
-     * Kernel ID
-     */
-    id: string;
-    /**
-     * Deletion reason
-     */
-    reason?: string;
-}): Promise<void>;
-/**
- * Snapshot a Kernel.
- */
-export declare function snapshotRuntime(options: {
-    /**
-     * Kernel ID.
-     */
-    id: string;
-    /**
-     * Snapshot name.
-     */
-    name?: string;
-    /**
-     * Snapshot description.
-     */
-    description?: string;
-    /**
-     * Whether to stop the kernel after the snapshot completion or not.
-     */
-    stop?: boolean;
-}): Promise<IRuntimeSnapshot>;
-/**
- * Get Kernel Snapshots.
- */
-export declare function getRuntimeSnapshots(): Promise<IRuntimeSnapshot[]>;
-/**
- * Load a kernel snapshot within a kernel.
- */
-export declare function loadRuntimeSnapshot(options: {
-    /**
-     * Kernel ID
-     */
-    id: string;
-    /**
-     * Snapshot UID
-     */
-    from: string;
-}): Promise<void>;
-/**
- * Returns the runtime snapshot download URL.
- *
- * @param id Snapshot UID to download
- * @returns The download URL
- */
-export declare function createRuntimeSnapshotDownloadURL(id: string): string;
-/**
- * Export runtime snapshot.
- *
- * @param id Runtime snapshot UID to download
- */
-export declare function exportRuntimeSnapshot(id: string): void;
-/**
- * Delete runtime snapshot.
- */
-export declare function deleteRuntimeSnapshot(id: string): Promise<void>;
-/**
- * Update runtime snapshot metadata.
- */
-export declare function updateRuntimeSnapshot(id: string, metadata: {
-    name?: string;
-    description?: string;
-}): Promise<void>;
-/**
- * Upload a runtime snapshot.
- *
- * Note: The promise will be rejected if the runtime state is empty.
- */
-export declare function uploadRuntimeSnapshot(options: {
-    file: File | Blob;
-    metadata: {
-        filename: string;
-        [key: string]: string;
-    };
-    onProgress?: (bytesUploaded: number, bytesTotal: number) => void;
-}): Promise<void>;

package/lib/api/runtimes/apis.js

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

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

@@ -1,7 +1,5 @@
-export * from './exec';
-export * from './kernelsHandler';
-export * from './models';
-export * from './runtimesApi';
+export * from './actions';
+export * from './apis';
 export * from './settings';
 export * from './snapshots';
 export * from './utils';

package/lib/api/runtimes/index.js

@@ -2,15 +2,8 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-/*
- * Copyright (c) 2021-2024 Datalayer, Inc.
- *
- * Datalayer License
- */
-export * from './exec';
-export * from './kernelsHandler';
-export * from './models';
-export * from './runtimesApi';
+export * from './actions';
+export * from './apis';
 export * from './settings';
 export * from './snapshots';
 export * from './utils';

package/lib/api/runtimes/settings.js

@@ -2,11 +2,6 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-/*
- * Copyright (c) 2021-2024 Datalayer, Inc.
- *
- * Datalayer License
- */
 import { ServerConnection } from '@jupyterlab/services';
 /**
  * Create a settings object given a subset of options.
@@ -26,11 +21,11 @@ export function makeDatalayerSettings(baseUrl, token, wsUrl) {
         init: {
             mode: 'cors',
             credentials: 'include',
-            cache: 'no-store'
-        }
+            cache: 'no-store',
+        },
     });
     return serverSettings;
 }
 export default {
-    makeDatalayerSettings
+    makeDatalayerSettings,
 };

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

@@ -18,7 +18,7 @@ export declare function createRuntimeSnapshot(props: Props): Promise<void>;
  *
  * Note: You should use this only for browser kernels.
  */
-export declare function loadBrowserRuntimeSnapshot({ connection, id }: {
+export declare function loadBrowserRuntimeSnapshot({ connection, id, }: {
     connection: Kernel.IKernelConnection;
     id: string;
 }): Promise<void>;

package/lib/api/runtimes/snapshots.js

@@ -2,11 +2,6 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-/*
- * Copyright (c) 2021-2024 Datalayer, Inc.
- *
- * Datalayer License
- */
 import { KernelExecutor } from '@datalayer/jupyter-react';
 import { createRuntimeSnapshotDownloadURL, uploadRuntimeSnapshot } from '.';
 /**
@@ -16,18 +11,18 @@ import { createRuntimeSnapshotDownloadURL, uploadRuntimeSnapshot } from '.';
  */
 export async function createRuntimeSnapshot(props) {
     const { connection, metadata, onUploadProgress } = props;
-    const dump = await new KernelExecutor({ connection })
-        .execute(GET_RUNTIME_SNAPSHOT_SNIPPET, {
-        storeHistory: false
+    const dump = await new KernelExecutor({ connection }).execute(GET_RUNTIME_SNAPSHOT_SNIPPET, {
+        storeHistory: false,
     });
-    const serializedData = (dump.get(0)?.data['application/vnd.jupyter.stdout'] ?? '');
+    const serializedData = (dump.get(0)?.data['application/vnd.jupyter.stdout'] ??
+        '');
     // Convert the data to blob.
     const bytes = base64ToBytes(serializedData);
     const file = new Blob([bytes.buffer]);
     return uploadRuntimeSnapshot({
         file,
         metadata,
-        onProgress: onUploadProgress
+        onProgress: onUploadProgress,
     });
 }
 function base64ToBytes(base64) {
@@ -41,16 +36,16 @@ function base64ToBytes(base64) {
  *
  * Note: You should use this only for browser kernels.
  */
-export async function loadBrowserRuntimeSnapshot({ connection, id }) {
+export async function loadBrowserRuntimeSnapshot({ connection, id, }) {
     const downloadURL = createRuntimeSnapshotDownloadURL(id);
     const response = await fetch(downloadURL);
     const buffer = await response.arrayBuffer();
     const base64 = bytesToBase64(new Uint8Array(buffer));
     await new KernelExecutor({
-        connection
+        connection,
     }).execute(getLoadRuntimeSnapshotSnippet(base64), {
         storeHistory: false,
-        silent: true
+        silent: true,
     });
 }
 function bytesToBase64(bytes) {

package/lib/api/runtimes/utils.js

@@ -2,15 +2,7 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
-/*
- * Copyright (c) 2021-2024 Datalayer, Inc.
- *
- * Datalayer License
- */
-const NON_REMOTE_LOCATION = [
-    'browser',
-    'local',
-];
+const NON_REMOTE_LOCATION = ['browser', 'local'];
 /**
  * Check whether the location is remote or not.
  *

package/lib/assets/react.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>

package/lib/collaboration/DatalayerCollaboration.d.ts

@@ -0,0 +1,9 @@
+type IFetchSessionId = {
+    url: string;
+    token?: string;
+};
+/**
+ * Fetch the session ID of a collaborative documents from Datalayer.
+ */
+export declare function requestDatalayerCollaborationSessionId({ url, token, }: IFetchSessionId): Promise<string>;
+export {};

package/lib/collaboration/DatalayerCollaboration.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * Fetch the session ID of a collaborative documents from Datalayer.
+ */
+export async function requestDatalayerCollaborationSessionId({ url, token, }) {
+    const headers = {
+        Accept: 'application/json',
+    };
+    if (token) {
+        headers['Authorization'] = `Bearer ${token}`;
+    }
+    const response = await fetch(url, {
+        method: 'GET',
+        headers,
+        credentials: token ? 'include' : 'omit',
+        mode: 'cors',
+        cache: 'no-store',
+    });
+    if (response.ok) {
+        const content = await response.json();
+        return content['sessionId'];
+    }
+    console.error('Failed to fetch session ID.', response);
+    throw new Error('Failed to fetch session ID.');
+}

package/lib/collaboration/DatalayerCollaborationProvider.d.ts

@@ -0,0 +1,54 @@
+import { YNotebook } from '@jupyter/ydoc';
+import { WebsocketProvider } from 'y-websocket';
+import type { ICollaborationProvider, ICollaborationProviderEvents } from '@datalayer/jupyter-react';
+declare enum CollaborationStatus {
+    Disconnected = "disconnected",
+    Connecting = "connecting",
+    Connected = "connected",
+    Error = "error"
+}
+/**
+ * Configuration for Datalayer collaboration provider
+ */
+export interface IDatalayerCollaborationConfig {
+    /**
+     * Base URL for the Datalayer server (optional, uses config from store if not provided)
+     */
+    runUrl?: string;
+    /**
+     * Authentication token (optional, uses config from store if not provided)
+     */
+    token?: string;
+}
+/**
+ * Datalayer collaboration provider
+ *
+ * This provider connects to Datalayer's collaboration service using WebSockets.
+ */
+export declare class DatalayerCollaborationProvider implements ICollaborationProvider {
+    readonly type = "datalayer";
+    private _status;
+    private _provider;
+    private _sharedModel;
+    private _statusChanged;
+    private _errorOccurred;
+    private _syncStateChanged;
+    private _isDisposed;
+    private _config;
+    private _onSync;
+    private _onConnectionClose;
+    constructor(config: IDatalayerCollaborationConfig);
+    get status(): CollaborationStatus;
+    get isConnected(): boolean;
+    get isDisposed(): boolean;
+    get events(): ICollaborationProviderEvents;
+    private setStatus;
+    connect(sharedModel: YNotebook, documentId: string, options?: Record<string, any>): Promise<void>;
+    disconnect(): void;
+    getProvider(): WebsocketProvider | null;
+    getSharedModel(): YNotebook | null;
+    handleConnectionClose(event: CloseEvent): void;
+    handleSync(isSynced: boolean): void;
+    dispose(): void;
+}
+export default DatalayerCollaborationProvider;