@datalayer/core 0.0.1 → 0.0.2

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

@@ -0,0 +1,25 @@
+import { Kernel } from '@jupyterlab/services';
+type Props = {
+    connection: Kernel.IKernelConnection;
+    metadata: {
+        filename: string;
+        [key: string]: string;
+    };
+    onUploadProgress?: (bytesUploaded: number, bytesTotal: number) => void;
+};
+/**
+ * Snapshot a runtime through the frontend and upload it to the cloud.
+ *
+ * Note: You should use this only for browser runtimes.
+ */
+export declare function createRuntimeSnapshot(props: Props): Promise<void>;
+/**
+ * Load a snapshot within a browser kernel.
+ *
+ * Note: You should use this only for browser kernels.
+ */
+export declare function loadBrowserRuntimeSnapshot({ connection, id }: {
+    connection: Kernel.IKernelConnection;
+    id: string;
+}): Promise<void>;
+export {};

package/lib/api/runtimes/snapshots.js

@@ -0,0 +1,155 @@
+/*
+ * 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 '.';
+/**
+ * Snapshot a runtime through the frontend and upload it to the cloud.
+ *
+ * Note: You should use this only for browser runtimes.
+ */
+export async function createRuntimeSnapshot(props) {
+    const { connection, metadata, onUploadProgress } = props;
+    const dump = await new KernelExecutor({ connection })
+        .execute(GET_RUNTIME_SNAPSHOT_SNIPPET, {
+        storeHistory: false
+    });
+    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
+    });
+}
+function base64ToBytes(base64) {
+    // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Window/btoa#unicode_strings
+    const binString = atob(base64);
+    // @ts-expect-error TypeScript does not like this
+    return Uint8Array.from(binString, m => m.codePointAt(0));
+}
+/**
+ * Load a snapshot within a browser kernel.
+ *
+ * Note: You should use this only for browser kernels.
+ */
+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
+    }).execute(getLoadRuntimeSnapshotSnippet(base64), {
+        storeHistory: false,
+        silent: true
+    });
+}
+function bytesToBase64(bytes) {
+    // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Window/btoa#unicode_strings
+    const binString = Array.from(bytes, byte => String.fromCodePoint(byte)).join('');
+    return btoa(binString);
+}
+const GET_RUNTIME_SNAPSHOT_SNIPPET = `def _create_snapshot():
+    import logging
+    import os
+    import pickle
+    from base64 import encodebytes
+    from tempfile import TemporaryFile
+    from types import BuiltinFunctionType, BuiltinMethodType, FunctionType, MethodType, MethodWrapperType, ModuleType, TracebackType
+    
+    # print(pickle.DEFAULT_PROTOCOL)
+
+    class NotFound:
+        pass
+
+    missing = NotFound()
+
+    FORBIDDEN_TYPES = [type, BuiltinFunctionType, BuiltinMethodType, FunctionType, MethodType, MethodWrapperType, ModuleType, TracebackType, NotFound]
+    try:
+        from IPython.core.autocall import ExitAutocall
+        from IPython.core.interactiveshell import InteractiveShell
+        FORBIDDEN_TYPES.extend([ExitAutocall, InteractiveShell])
+    except ImportError:
+        pass
+    exclude = tuple(FORBIDDEN_TYPES)
+
+    all = frozenset(filter(lambda n: not n.startswith("_"), globals()))
+
+    line_separator = bytes(os.linesep, "utf-8")
+    with TemporaryFile() as dump:
+        for _n in all:
+            _v = globals().get(_n, missing)
+            
+            if not (
+                isinstance(_v, exclude) or
+                # Special IPython variables
+                (_n == "In" and isinstance(_v, list)) or
+                (_n == "Out" and isinstance(_v, dict))
+            ):
+                try:
+                    dumped_n = _n.encode("utf-8") + line_separator + pickle.dumps(_v) + line_separator + b"\\x00" + line_separator
+                    dump.write(dumped_n)
+                except BaseException as e:
+                    logging.warning("Failed to dump variable [%s ([%s])].", _n, type(_v).__qualname__, exc_info=e)
+                else:
+                    logging.debug("Variable [%s] dumped", _n)
+
+        dump.seek(0)
+        print(encodebytes(dump.read()).decode("ascii"))
+
+_create_snapshot()
+del _create_snapshot
+`;
+function getLoadRuntimeSnapshotSnippet(content) {
+    return `async def _load_snapshot():
+    import os
+    import logging
+    import platform
+    import pickle
+    from base64 import decodebytes
+    is_pyodide = platform.node() == "emscripten"
+
+    snapshot = decodebytes("${content}".encode("ascii"))
+    line_sep = bytes(os.linesep, "utf-8")
+    variable_separator = b"\\x00" + line_sep
+    name = b""
+    value = b""
+    for line in snapshot.splitlines():
+        line += line_sep
+        if line == variable_separator:
+            name_s = name.strip().decode("utf-8")
+            try:
+                try:
+                    globals()[name_s] = pickle.loads(value)
+                except ModuleNotFoundError as m:
+                    if is_pyodide:
+                        import micropip
+                        logging.info(f'Installing %s...', m.name)
+                        await micropip.install(m.name)
+                        globals()[name_s] = pickle.loads(value)
+                    else:
+                        raise m
+            except BaseException as e:
+                logging.warning("Failed to load variable [%s].", name_s, exc_info=e)
+            else:
+                logging.debug("Variable [%s] loaded", name_s)
+
+            name = b""
+            value = b""
+        else:
+            if not name:
+                name = line
+            else:
+                value += line
+await _load_snapshot()
+del _load_snapshot`;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Check whether the location is remote or not.
+ *
+ * @param location The location to test
+ * @returns The result
+ */
+export declare function isRuntimeRemote(location: string): boolean;

package/lib/api/runtimes/utils.js

@@ -0,0 +1,22 @@
+/*
+ * 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',
+];
+/**
+ * Check whether the location is remote or not.
+ *
+ * @param location The location to test
+ * @returns The result
+ */
+export function isRuntimeRemote(location) {
+    return !NON_REMOTE_LOCATION.includes(location);
+}

package/lib/components/avatars/BoringAvatar.d.ts

@@ -0,0 +1,20 @@
+type VariantType = "marble" | "beam" | "pixel" | "sunset" | "ring" | "bauhaus" | undefined;
+type IBoringAvatarProps = {
+    displayName: string;
+    variant: VariantType;
+    size: number;
+    square: boolean;
+    style: object;
+};
+export declare const getRandomBoringAvatarVariant: () => VariantType;
+export declare const BoringAvatar: {
+    (props: IBoringAvatarProps): import("react/jsx-runtime").JSX.Element;
+    defaultProps: {
+        displayName: string;
+        variant: VariantType;
+        size: number;
+        square: boolean;
+        style: {};
+    };
+};
+export default BoringAvatar;

package/lib/components/avatars/BoringAvatar.js

@@ -0,0 +1,39 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import BoringAvatars from 'boring-avatars';
+// export const getRandomBoringAvatarVariant = () => variants[Math.floor(Math.random() * variants.length)] as VariantType;
+export const getRandomBoringAvatarVariant = () => "bauhaus";
+const RANDOM_BORING_AVATOR_VARIANT = getRandomBoringAvatarVariant();
+export const BoringAvatar = (props) => {
+    const { displayName, size, square, style } = props;
+    const variant = props.variant ?? getRandomBoringAvatarVariant();
+    return (_jsx("span", { style: { ...style }, children: _jsx(BoringAvatars, { size: size, name: displayName, variant: variant, square: square, colors: [
+                '#000000',
+                '#146A7C',
+                '#16A085',
+                '#1ABC9C',
+                '#2ECC71',
+                '#59595C',
+                '#92A1C6',
+                '#C20D90',
+                '#C271B4',
+                '#F0AB3D',
+                //      '#FFFFFF',
+            ] }) }));
+};
+BoringAvatar.defaultProps = {
+    displayName: '',
+    variant: RANDOM_BORING_AVATOR_VARIANT,
+    size: 40,
+    square: false,
+    style: {},
+};
+export default BoringAvatar;

package/lib/components/avatars/UserProfileAvatar.d.ts

@@ -0,0 +1,13 @@
+import { IUser } from '../../models';
+type IUserProfileAvatarProps = {
+    user?: IUser;
+    size?: number;
+    onClick?: React.MouseEventHandler<any>;
+};
+export declare const UserProfileAvatar: {
+    (props: IUserProfileAvatarProps): import("react/jsx-runtime").JSX.Element;
+    defaultProps: {
+        size: number;
+    };
+};
+export default UserProfileAvatar;

package/lib/components/avatars/UserProfileAvatar.js

@@ -0,0 +1,37 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { Avatar, Link } from '@primer/react';
+import { Box } from "@datalayer/primer-addons";
+import { AvatarSkeleton } from '../../components/display';
+import { getAvatarURL } from '../../utils';
+const Profile = (props) => {
+    const { user, size, onClick } = props;
+    return (_jsx(Box, { style: { width: size }, children: _jsx(Avatar
+        //      square
+        , { 
+            //      square
+            src: getAvatarURL(user?.avatarUrl), size: size, onClick: onClick }) }));
+};
+export const UserProfileAvatar = (props) => {
+    const { onClick, user, size } = props;
+    return (user ?
+        onClick
+            ?
+                _jsx(Link, { href: "javascript: return false;", onClick: onClick, children: _jsx(Profile, { ...props }) })
+            :
+                _jsx(Profile, { ...props })
+        :
+            _jsx(AvatarSkeleton, { size: size }));
+};
+UserProfileAvatar.defaultProps = {
+    size: 100,
+};
+export default UserProfileAvatar;

package/lib/components/avatars/index.d.ts

@@ -0,0 +1,2 @@
+export * from './BoringAvatar';
+export * from './UserProfileAvatar';

package/lib/components/avatars/index.js

@@ -0,0 +1,11 @@
+/*
+ * 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 './BoringAvatar';
+export * from './UserProfileAvatar';

package/lib/components/banners/NoAutomationBanner.d.ts

@@ -0,0 +1,2 @@
+export declare const NoAutomationBanner: () => import("react/jsx-runtime").JSX.Element;
+export default NoAutomationBanner;

package/lib/components/banners/NoAutomationBanner.js

@@ -0,0 +1,18 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { Link } from "@primer/react";
+import { Banner } from "@primer/react/experimental";
+import { useNavigate } from "../../hooks";
+export const NoAutomationBanner = () => {
+    const navigate = useNavigate();
+    return (_jsx(_Fragment, { children: _jsx(Banner, { title: "Warning", description: _jsxs(_Fragment, { children: ["We don't have bandwidth to automate this feature. ", _jsx(Link, { href: "", onClick: e => navigate('/contact', e), children: "Please reach out" }), " to prioritize this."] }), primaryAction: _jsx(Banner.PrimaryAction, { onClick: e => navigate('/contact', e), children: "Reach out" }), variant: "warning" }) }));
+};
+export default NoAutomationBanner;

package/lib/components/banners/index.d.ts

@@ -0,0 +1 @@
+export * from './NoAutomationBanner';

package/lib/components/banners/index.js

@@ -0,0 +1,10 @@
+/*
+ * 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 './NoAutomationBanner';

package/lib/components/buttons/DownloadCSVButton.d.ts

@@ -0,0 +1,13 @@
+import { VariantType } from './VariantType';
+type IDownloadCSVButtonProps = {
+    data?: {};
+    fileName: string;
+    variant: VariantType;
+};
+export declare const DownloadCSVButton: {
+    (props: IDownloadCSVButtonProps): import("react/jsx-runtime").JSX.Element;
+    defaultProps: {
+        variant: string;
+    };
+};
+export default DownloadCSVButton;

package/lib/components/buttons/DownloadCSVButton.js

@@ -0,0 +1,21 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { Button } from '@primer/react';
+import { DownloadIcon } from '@primer/octicons-react';
+import { downloadCSV } from '../../utils';
+export const DownloadCSVButton = (props) => {
+    const { data, fileName, variant } = props;
+    return (_jsx(Button, { variant: variant, leadingVisual: DownloadIcon, onClick: e => downloadCSV(data, fileName), children: "Download" }));
+};
+DownloadCSVButton.defaultProps = {
+    variant: "default",
+};
+export default DownloadCSVButton;

package/lib/components/buttons/DownloadJsonButton.d.ts

@@ -0,0 +1,16 @@
+import { VariantType } from './VariantType';
+type IDownloadJsonButtonProps = {
+    data?: {};
+    fileName: string;
+    extension: string;
+    variant: VariantType;
+};
+export declare const DownloadJsonButton: {
+    (props: IDownloadJsonButtonProps): import("react/jsx-runtime").JSX.Element;
+    defaultProps: {
+        variant: string;
+        name: string;
+        extension: string;
+    };
+};
+export default DownloadJsonButton;

package/lib/components/buttons/DownloadJsonButton.js

@@ -0,0 +1,23 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { Button } from '@primer/react';
+import { DownloadIcon } from '@primer/octicons-react';
+import { downloadJson } from '../../utils';
+export const DownloadJsonButton = (props) => {
+    const { data, fileName, variant, extension } = props;
+    return (_jsx(Button, { variant: variant, leadingVisual: DownloadIcon, onClick: e => downloadJson(data, fileName, extension), children: "Download" }));
+};
+DownloadJsonButton.defaultProps = {
+    variant: 'default',
+    name: 'data',
+    extension: 'json',
+};
+export default DownloadJsonButton;

package/lib/components/buttons/LongActionButton.d.ts

@@ -0,0 +1,28 @@
+import { type ElementType } from 'react';
+type ILongActionButtonProps = {
+    /**
+     * Button onClick callback
+     */
+    onClick: () => Promise<void>;
+    /**
+     * Button icon
+     */
+    icon: ElementType<any>;
+    /**
+     * Force displaying button as inProgress
+     */
+    inProgress?: boolean;
+    /**
+     * Button label
+     */
+    label: string;
+    /**
+     * Button disabled state
+     */
+    disabled?: boolean;
+};
+/**
+ * Icon button displaying a spinner while its callback is running.
+ */
+export declare function LongActionButton(props: ILongActionButtonProps): JSX.Element;
+export {};

package/lib/components/buttons/LongActionButton.js

@@ -0,0 +1,29 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { useCallback, useState } from 'react';
+import { IconButton, Spinner } from '@primer/react';
+/**
+ * Icon button displaying a spinner while its callback is running.
+ */
+export function LongActionButton(props) {
+    const { label, disabled, onClick, icon, inProgress } = props;
+    const [internalInProgress, setInternalInProgress] = useState(false);
+    const handleClick = useCallback(async () => {
+        setInternalInProgress(true);
+        try {
+            await onClick();
+        }
+        finally {
+            setInternalInProgress(false);
+        }
+    }, [onClick, setInternalInProgress]);
+    return (_jsx(IconButton, { "aria-label": label, title: label, disabled: disabled || internalInProgress || inProgress, icon: internalInProgress || inProgress ? () => _jsx(Spinner, { size: "small" }) : icon, size: "small", variant: "invisible", onClick: handleClick }));
+}

package/lib/components/buttons/UploadButton.d.ts

@@ -0,0 +1,37 @@
+import type { VariantType } from './VariantType';
+interface IUploadBaseButtonProps {
+    /**
+     * Button component factory
+     */
+    buttonFactory: (onClick: () => void) => JSX.Element;
+    /**
+     * Whether the upload support one or more files
+     */
+    multiple?: boolean;
+    /**
+     * Upload callback
+     */
+    upload: (file: File) => Promise<unknown>;
+}
+export interface IUploadIconButtonProps extends Omit<IUploadBaseButtonProps, 'buttonFactory'> {
+    /**
+     * Button aria-label
+     */
+    label: string;
+}
+export declare function UploadIconButton(props: IUploadIconButtonProps): JSX.Element;
+export interface IUploadButtonProps extends Omit<IUploadBaseButtonProps, 'buttonFactory'> {
+    /**
+     * Button aria-label
+     */
+    label: string;
+    /**
+     * Button variant
+     */
+    variant?: VariantType;
+}
+export declare function UploadButton(props: IUploadButtonProps): JSX.Element;
+export declare namespace UploadButton {
+    var defaultProps: Partial<IUploadButtonProps>;
+}
+export default UploadButton;

package/lib/components/buttons/UploadButton.js

@@ -0,0 +1,48 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { useCallback, useMemo, useRef } from 'react';
+import { Button, IconButton } from '@primer/react';
+import { UploadIcon } from '@primer/octicons-react';
+function UploadBaseButton(props) {
+    const { buttonFactory, multiple, upload } = props;
+    const inputRef = useRef(null);
+    const onInputChanged = useCallback(() => {
+        if (inputRef.current && inputRef.current.files) {
+            const files = Array.from(inputRef.current.files);
+            Promise.all(files.map(file => upload(file))).catch(reason => {
+                const msg = 'Failed to upload files.';
+                console.error(msg, reason);
+            });
+        }
+    }, [inputRef.current, upload]);
+    const onInputClick = useCallback(() => {
+        if (inputRef.current) {
+            inputRef.current.value = '';
+        }
+    }, [inputRef.current]);
+    return (_jsxs(_Fragment, { children: [buttonFactory(() => {
+                inputRef.current?.click();
+            }), _jsx("input", { ref: inputRef, style: { display: 'none' }, type: "file", multiple: multiple, onClick: onInputClick, onChange: onInputChanged })] }));
+}
+export function UploadIconButton(props) {
+    const { label, ...others } = props;
+    const factory = useMemo(() => (onClick) => (_jsx(IconButton, { "aria-label": label, icon: UploadIcon, size: "small", variant: "invisible", onClick: onClick })), []);
+    return _jsx(UploadBaseButton, { buttonFactory: factory, ...others });
+}
+export function UploadButton(props) {
+    const { label, variant, ...others } = props;
+    const factory = useMemo(() => (onClick) => (_jsx(Button, { "aria-label": label, leadingVisual: () => _jsx(UploadIcon, { fill: "white" }), size: "small", variant: variant, onClick: onClick, children: label })), []);
+    return _jsx(UploadBaseButton, { buttonFactory: factory, ...others });
+}
+UploadButton.defaultProps = {
+    variant: "primary",
+};
+export default UploadButton;

package/lib/components/buttons/VariantType.d.ts

@@ -0,0 +1 @@
+export type VariantType = 'default' | 'primary' | 'invisible' | 'danger' | 'link';

package/lib/components/buttons/VariantType.js

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

package/lib/components/buttons/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DownloadCSVButton';
+export * from './DownloadJsonButton';
+export * from './LongActionButton';
+export * from './UploadButton';
+export * from './VariantType';

package/lib/components/buttons/index.js

@@ -0,0 +1,14 @@
+/*
+ * 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 './DownloadCSVButton';
+export * from './DownloadJsonButton';
+export * from './LongActionButton';
+export * from './UploadButton';
+export * from './VariantType';

package/lib/components/checkout/StripeCheckout.d.ts

@@ -0,0 +1,32 @@
+import type { ICheckoutPortal } from '../../models';
+/**
+ * Price item interface
+ */
+export interface IPrice {
+    /**
+     * Price ID
+     */
+    id: string;
+    /**
+     * Price user readable name
+     */
+    name: string;
+    /**
+     * Cost in cents
+     */
+    amount: number;
+    /**
+     * Cost currency
+     */
+    currency: string;
+    /**
+     * Computational credits to receive
+     */
+    credits: number;
+}
+/**
+ * Stripe checkout.
+ */
+export declare function StripeCheckout({ checkoutPortal }: {
+    checkoutPortal: ICheckoutPortal | null;
+}): import("react/jsx-runtime").JSX.Element;