@datalayer/core 0.0.1 → 0.0.2

package/lib/models/Content.d.ts

@@ -0,0 +1,5 @@
+export interface IContent {
+    name: string;
+    mount: string;
+}
+export default IContent;

package/lib/models/Content.js

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

package/lib/models/Course.d.ts

@@ -0,0 +1,17 @@
+import { IBaseSpace } from "./Space";
+import { Instructor } from "./Instructor";
+import { IStudent } from "./Student";
+import { ISchool } from "./School";
+import { ISpace } from "./Space";
+import { ISpaceItem } from "./SpaceItem";
+export type ICourse = IBaseSpace & {
+    type: 'space';
+    variant: "course";
+    seedSpace?: ISpace;
+    school?: ISchool;
+    instructor?: Instructor;
+    students?: Map<string, IStudent>;
+    items: Array<ISpaceItem>;
+    itemIds: Array<string>;
+};
+export default ICourse;

package/lib/models/Course.js

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

package/lib/models/Credits.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Credits level below which we refused to start a remote kernel
+ * without explicit reservation.
+ *
+ * TODO what is a good LOW_CREDITS bar? - A better way would be to set it from a server settings or a cloud config.
+ */
+export declare const LOW_CREDITS = 3;
+/**
+ * User credits
+ */
+export interface ICredits {
+    /**
+     * User credits
+     *
+     * They are the remaining credits if {@link quota} is `null`
+     * otherwise they are the credit consumed (remaining credits is `quota - credits`).
+     */
+    credits: number;
+    /**
+     * User credits quota
+     */
+    quota: number | null;
+    /**
+     * User credits last update as date ISO-formatted string.
+     */
+    last_update: string;
+}
+export interface ICheckoutPortal {
+    /**
+     * External checkout portal URL to open in a new tab.
+     */
+    url?: string;
+    /**
+     * Checkout portal route.
+     */
+    route?: string;
+    /**
+     * Whether the route will open a modal (true) or a page (false)
+     */
+    is_modal: boolean;
+    /**
+     * Portal metadata - content depends on the credits addon
+     */
+    metadata?: {
+        [k: string]: any;
+    };
+}
+/**
+ * Single resource credits reservation
+ */
+export interface ICreditsReservation {
+    /**
+     * Reservation ID
+     */
+    id: string;
+    /**
+     * Credits reserved
+     */
+    credits: number;
+    /**
+     * ID of the resource reserved
+     */
+    resource: string;
+    /**
+     * Last update for the reservation as date ISO-formatted string
+     */
+    last_update: string;
+    /**
+     * Credits burning rate
+     */
+    burning_rate: number;
+    /**
+     * Reservation start date as date ISO-formatted string
+     */
+    start_date?: string;
+}

package/lib/models/Credits.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+/**
+ * Credits level below which we refused to start a remote kernel
+ * without explicit reservation.
+ *
+ * TODO what is a good LOW_CREDITS bar? - A better way would be to set it from a server settings or a cloud config.
+ */
+export const LOW_CREDITS = 3;

package/lib/models/Dataset.d.ts

@@ -0,0 +1,16 @@
+import { IItem } from "./Item";
+export type IDataset = IItem & {
+    type: 'dataset';
+    fileName: string;
+    datasetExtension: string;
+    contentLength: number;
+    contentType: string;
+    mimeType: string;
+    mimeTypeParams?: {};
+    bucketName?: string;
+    path?: string;
+    creationDate: Date;
+    lastPublicationDate?: Date;
+    cdnUrl: string;
+};
+export default IDataset;

package/lib/models/Dataset.js

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

package/lib/models/Datasource.d.ts

@@ -0,0 +1,11 @@
+export declare const asDatasource: (s: any) => IDatasource;
+export type IDatasourceVariant = 'athena' | 'bigquery' | 'mssentinel' | 'splunk';
+export type IDatasource = {
+    id: string;
+    variant: IDatasourceVariant;
+    name: string;
+    description: string;
+    database: string;
+    outputBucket: string;
+};
+export default IDatasource;

package/lib/models/Datasource.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+export const asDatasource = (s) => {
+    return {
+        id: s.uid,
+        variant: s.variant_s,
+        name: s.name_s,
+        description: s.description_t,
+        database: s.database_s,
+        outputBucket: s.output_bucket_s,
+    };
+};

package/lib/models/Dean.d.ts

@@ -0,0 +1,3 @@
+import { IUser } from "./User";
+export type IDean = IUser & {};
+export default IDean;

package/lib/models/Dean.js

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

package/lib/models/Document.d.ts

@@ -0,0 +1,8 @@
+import { IItem } from "./Item";
+export type IBaseDocument = IItem & {
+    model?: any;
+};
+export type IDocument = IBaseDocument & {
+    type: 'document';
+};
+export default IDocument;

package/lib/models/Document.js

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

package/lib/models/Environment.d.ts

@@ -0,0 +1,82 @@
+import { IContent } from "./Content";
+import { IItem } from "./Item";
+export type IEnvironment = IItem & {
+    type: 'environment';
+};
+export interface IResources {
+    cpu: string;
+    memory: string;
+    'nvidia.com/gpu'?: string;
+}
+/**
+ * Code snippet
+ */
+export interface ISnippet {
+    /**
+     * Snippet summary
+     */
+    title: string;
+    /**
+     * Snippet long description
+     */
+    description?: string;
+    /**
+     * Code snippet
+     */
+    code: string;
+}
+/**
+ * Datalayer environment
+ */
+export interface IDatalayerEnvironment {
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Title
+     */
+    title: string;
+    /**
+     * Description
+     */
+    description: string;
+    /**
+     * Execution language
+     */
+    language: string;
+    /**
+     * Docker image
+     */
+    dockerImage: string;
+    /**
+     * Example notebook URL
+     */
+    example?: string;
+    /**
+     * Example code snippets
+     */
+    snippets?: ISnippet[];
+    /**
+     * Associate kernel attributes
+     */
+    kernel?: {
+        /**
+         * Proposed display name
+         */
+        givenNameTemplate?: string;
+    };
+    /**
+     * Environment credits burning rate
+     */
+    burning_rate: number;
+    /**
+     * Environment server resources
+     */
+    resources?: IResources;
+    /**
+     * Environment contents.
+     */
+    contents?: IContent[];
+}
+export default IEnvironment;

package/lib/models/Environment.js

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

package/lib/models/Errors.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Error emitted when the user tries to create more runtimes than allowed.
+ */
+export declare class MaxRuntimesExceededError extends Error {
+    constructor(message?: string, options?: ErrorOptions);
+}

package/lib/models/Errors.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+/**
+ * Error emitted when the user tries to create more runtimes than allowed.
+ */
+export class MaxRuntimesExceededError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = 'MaxRuntimesExceededError';
+    }
+}

package/lib/models/Exercise.d.ts

@@ -0,0 +1,16 @@
+import { IDataset } from './Dataset';
+import { IItem } from "./Item";
+export type ICode = string;
+export type IHelp = string;
+export type IExercise = IItem & {
+    type: 'exercise';
+    help: IHelp;
+    codePre: ICode;
+    codeSolution: ICode;
+    codeQuestion: ICode;
+    codeTest: ICode;
+    datasets: Array<IDataset>;
+    lastUpdateDate?: Date;
+    lastPublicationDate?: Date;
+};
+export default IExercise;

package/lib/models/Exercise.js

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

package/lib/models/GrowthKPI.d.ts

@@ -0,0 +1,5 @@
+export declare const asGrowthKPIs: (k: any) => IGrowthKPIs;
+export type IGrowthKPIs = {
+    usersCount: number;
+};
+export default IGrowthKPIs;

package/lib/models/GrowthKPI.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 const asGrowthKPIs = (k) => {
+    return {
+        usersCount: k.users_count,
+    };
+};

package/lib/models/IAMProviderLinked.d.ts

@@ -0,0 +1,9 @@
+import { JSONObject } from '@lumino/coreutils';
+import { IIAMProviderName } from './IAMProvidersSpecs';
+export declare function asIAMProviderLinked(iamProvider: any): IIAMProviderLinked;
+export type IIAMProviderLinked = {
+    iamProviderName: IIAMProviderName;
+    linkedAccount: JSONObject;
+    linkedAccountUrl: string;
+    linkedAccountId: string;
+};

package/lib/models/IAMProviderLinked.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export function asIAMProviderLinked(iamProvider) {
+    const info = iamProvider.linkedAccount.replaceAll("'", '"');
+    return {
+        iamProviderName: iamProvider.iam_ProviderName,
+        linkedAccount: JSON.parse(info === "" ? "{}" : info),
+        linkedAccountUrl: iamProvider.linkedAccountUrl,
+        linkedAccountId: iamProvider.linkedAccountId,
+    };
+}

package/lib/models/IAMProviderPost.d.ts

@@ -0,0 +1,8 @@
+import { IIAMProviderName } from './IAMProvidersSpecs';
+export declare class LinkedInPost {
+    iamProvider: IIAMProviderName;
+    urn: string;
+    id: string;
+    constructor(urn: string);
+    getURL(): string;
+}

package/lib/models/IAMProviderPost.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export class LinkedInPost {
+    iamProvider = 'linkedin';
+    urn;
+    id;
+    /*
+    How does LinkedIn URN urn:li:share:7264291213959204866 translate to URL https://www.linkedin.com/feed/update/urn:li:activity:7264291214332456960 ?
+    @see Documentation: A successful response will return 201 Created, and the newly created post will be identified by the X-RestLi-Id response header.
+    */
+    constructor(urn) {
+        this.urn = urn;
+        const splits = urn.split(':');
+        this.id = splits[3];
+    }
+    getURL() {
+        //    return `https://www.linkedin.com/feed/update/urn:li:activity:${this.id}`
+        return `https://www.linkedin.com/feed/update/${this.urn}`;
+    }
+}

package/lib/models/IAMProviderUsers.d.ts

@@ -0,0 +1,49 @@
+import { IIAMProviderName } from './IAMProvidersSpecs';
+export type IGitHubUser = {
+    iamProvider: IIAMProviderName;
+    login: string;
+    avatar_url: string;
+    gravatar_id: string;
+    url: string;
+    name: string;
+    company: string;
+    blog: string;
+    location: string;
+    email: string;
+    bio: string;
+};
+export type ILinkedInUser = {
+    iamProvider: IIAMProviderName;
+    sub: string;
+    email_verified: boolean;
+    name: string;
+    given_name: string;
+    family_name: string;
+    displayName: string;
+    email: string;
+    picture: string;
+    getUrn(): string;
+};
+export type IXUser = {
+    iamProvider: IIAMProviderName;
+    sub: string;
+    email_verified: boolean;
+    name: string;
+    given_name: string;
+    family_name: string;
+    email: string;
+    picture: string;
+};
+export declare class LinkedInUser implements ILinkedInUser {
+    iamProvider: IIAMProviderName;
+    sub: string;
+    email_verified: boolean;
+    name: string;
+    given_name: string;
+    displayName: string;
+    family_name: string;
+    email: string;
+    picture: string;
+    constructor(u: any);
+    getUrn(): string;
+}

package/lib/models/IAMProviderUsers.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { asDisplayName } from '../utils';
+export class LinkedInUser {
+    iamProvider = 'linkedin';
+    sub;
+    email_verified;
+    name;
+    given_name;
+    displayName;
+    family_name;
+    email;
+    picture;
+    constructor(u) {
+        this.sub = u.sub;
+        this.email_verified = u.email_verified;
+        this.name = u.sub;
+        this.given_name = u.given_name;
+        this.family_name = u.family_name;
+        this.email = u.email;
+        this.picture = u.picture;
+        this.displayName = asDisplayName(this.given_name, this.family_name);
+    }
+    getUrn() {
+        return `urn:li:person:${this.sub}`;
+    }
+}

package/lib/models/IAMProvidersSpecs.d.ts

@@ -0,0 +1,22 @@
+import { IUser } from './User';
+export type IIAMProviderName = 'bluesky' | 'discord' | 'github' | 'linkedin' | 'okta' | 'x';
+export type IIAMProviderSpec = {
+    name: IIAMProviderName;
+    oauth2CallbackServerRoute: string;
+    oauth2CallbackUIRoute: string;
+    accessTokenCookieName: (user: IUser) => string;
+    refreshTokenCookieName: string;
+    userInfoURL: string;
+    tokenRefreshURL: string;
+    postShareURL: string;
+    registerUploadURL: string;
+};
+export declare class IAMProvidersSpecs {
+    private constructor();
+    static getProvider(providerIAMProvidersType: any): IIAMProviderSpec;
+    static readonly Bluesky: IIAMProviderSpec;
+    static readonly GitHub: IIAMProviderSpec;
+    static readonly LinkedIn: IIAMProviderSpec;
+    static readonly Okta: IIAMProviderSpec;
+}
+export default IAMProvidersSpecs;

package/lib/models/IAMProvidersSpecs.js

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export class IAMProvidersSpecs {
+    constructor() { }
+    static getProvider(providerIAMProvidersType) {
+        switch (providerIAMProvidersType) {
+            case 'bluesky': {
+                return this.Bluesky;
+            }
+            case 'github': {
+                return this.GitHub;
+            }
+            case 'linkedin': {
+                return this.LinkedIn;
+            }
+            case 'okta': {
+                return this.Okta;
+            }
+            default: {
+                // TODO revisit this...
+                return this.GitHub;
+            }
+        }
+    }
+    static Bluesky = {
+        name: 'bluesky',
+        oauth2CallbackServerRoute: 'jupyter_iam/oauth2/callback',
+        oauth2CallbackUIRoute: '/iam/oauth2/bluesky/callback',
+        accessTokenCookieName: (user) => `__datalayer__bluesky_access_token_${user.id}`,
+        refreshTokenCookieName: '__datalayer__bluesky_refresh_token',
+        userInfoURL: '',
+        tokenRefreshURL: '',
+        postShareURL: '',
+        registerUploadURL: '',
+    };
+    static GitHub = {
+        name: 'github',
+        oauth2CallbackServerRoute: 'jupyter_iam/oauth2/callback',
+        oauth2CallbackUIRoute: '/iam/oauth2/github/callback',
+        accessTokenCookieName: (user) => `__datalayer__github_access_token_${user.id}`,
+        refreshTokenCookieName: '__datalayer__github_refresh_token',
+        userInfoURL: 'https://api.github.com/user',
+        tokenRefreshURL: 'https://github.com/login/oauth/access_token',
+        postShareURL: '',
+        registerUploadURL: '',
+    };
+    static LinkedIn = {
+        name: 'linkedin',
+        oauth2CallbackServerRoute: 'jupyter_iam/oauth2/callback',
+        oauth2CallbackUIRoute: '/iam/oauth2/linkedin/callback',
+        accessTokenCookieName: (user) => `__datalayer__linkedin_access_token_${user.id}`,
+        refreshTokenCookieName: '__datalayer__linkedin_refresh_token',
+        userInfoURL: 'https://api.linkedin.com/v2/userinfo',
+        tokenRefreshURL: '',
+        postShareURL: 'https://api.linkedin.com/v2/ugcPosts',
+        registerUploadURL: 'https://api.linkedin.com/v2/assets?action=registerUpload',
+    };
+    static Okta = {
+        name: 'okta',
+        oauth2CallbackServerRoute: 'jupyter_iam/oauth2/callback',
+        oauth2CallbackUIRoute: '/iam/oauth2/linkedin/callback',
+        accessTokenCookieName: (user) => `__datalayer__okta_access_token_${user.id}`,
+        refreshTokenCookieName: '__datalayer__okta_refresh_token',
+        userInfoURL: 'https://trial-4368308.okta.com/oauth2/default/v1/userinfo',
+        tokenRefreshURL: '',
+        postShareURL: '',
+        registerUploadURL: '',
+    };
+}
+export default IAMProvidersSpecs;

package/lib/models/IAMToken.d.ts

@@ -0,0 +1,11 @@
+export declare const asToken: (s: any) => IIAMToken;
+export type IIAMTokenVariant = 'user_token';
+export type IIAMToken = {
+    id: string;
+    variant: IIAMTokenVariant;
+    name: string;
+    description: string;
+    value: string;
+    expirationDate: Date;
+};
+export default IIAMToken;

package/lib/models/IAMToken.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+export const asToken = (s) => {
+    return {
+        id: s.uid,
+        variant: s.variant_s,
+        name: s.name_s,
+        expirationDate: new Date(s.expiration_ts_dt),
+        description: s.description_t,
+        value: s.value_s,
+    };
+};

package/lib/models/Inbound.d.ts

@@ -0,0 +1,25 @@
+export declare class Inbound implements IInbound {
+    id: string;
+    subType: string;
+    handle: string;
+    payloadJson: string;
+    creationDate?: Date;
+    lastUpdateDate?: Date;
+    constructor(u: any);
+}
+/**
+ * Convert the raw user object to {@link IInbound}.
+ *
+ * @param u Raw user object from DB
+ * @returns Inbound
+ */
+export declare function asInbound(u: any): IInbound;
+export type IInbound = {
+    id: string;
+    subType: string;
+    handle: string;
+    payloadJson: string;
+    creationDate?: Date;
+    lastUpdateDate?: Date;
+};
+export default IInbound;