@datalayer/core 0.0.1 → 0.0.3

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,13 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD 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,9 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD 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,29 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD 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,14 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD 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;

package/lib/models/Inbound.js

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export class Inbound {
+    id;
+    subType;
+    handle;
+    payloadJson;
+    creationDate;
+    lastUpdateDate;
+    constructor(u) {
+        this.id = u.uid;
+        this.subType = u.subType;
+        this.handle = u.handle;
+        this.payloadJson = u.payloadJson;
+        this.creationDate = new Date(u.creationDate);
+        this.lastUpdateDate = new Date(u.lastUpdateDate);
+    }
+}
+/**
+ * Convert the raw user object to {@link IInbound}.
+ *
+ * @param u Raw user object from DB
+ * @returns Inbound
+ */
+export function asInbound(u) {
+    return new Inbound(u);
+}

package/lib/models/Instructor.d.ts

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

package/lib/models/Instructor.js

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

package/lib/models/Invite.d.ts

@@ -0,0 +1,14 @@
+import { IUser } from "./User";
+import { IContact } from "./Contact";
+export declare const asInvite: (i: any) => IInvite;
+export type IInvite = {
+    id: string;
+    token?: string;
+    from?: IUser;
+    to: Partial<IContact>;
+    sentDate: Date;
+    joinDate?: Date;
+    message: string;
+    brand: string;
+};
+export default IInvite;

package/lib/models/Invite.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { asDisplayName, namesAsInitials } from "../utils";
+export const asInvite = (i) => {
+    const to = {
+        id: i.to_contact_uid,
+        email: i.to_email_s,
+        firstName: i.to_first_name_t,
+        lastName: i.to_last_name_t,
+        initials: namesAsInitials(i.to_first_name_t, i.to_last_name_t),
+        displayName: asDisplayName(i.to_first_name_t, i.to_last_name_t),
+    };
+    return {
+        id: '',
+        token: i.token_s,
+        to,
+        message: i.message_t,
+        sentDate: new Date(i.sent_ts_dt),
+        joinDate: i.join_ts_dt ? new Date(i.join_ts_dt) : undefined,
+        brand: i.brand_s ?? 'datalayer',
+    };
+};

package/lib/models/Item.d.ts

@@ -0,0 +1,20 @@
+import { ISpaceItem } from "./SpaceItem";
+import { IUser } from "./User";
+import { IAnyOrganization } from "./Organization";
+import { IAnySpace } from "./Space";
+import { IItemType } from "./ItemType";
+export type IAnyItem = ISpaceItem;
+export type IItem = {
+    id: string;
+    type: IItemType;
+    name: string;
+    description: string;
+    public: boolean;
+    creationDate: Date;
+    lastUpdateDate?: Date;
+    lastPublicationDate?: Date;
+    owner: IUser;
+    space: Partial<IAnySpace>;
+    organization: Partial<IAnyOrganization>;
+};
+export default IItem;

package/lib/models/Item.js

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

package/lib/models/ItemType.d.ts

@@ -0,0 +1,2 @@
+export type IItemType = 'assignment' | 'authoring' | 'cell' | 'content' | 'credits' | 'dataset' | 'datasource' | 'document' | 'documentation' | 'environment' | 'exercise' | 'growth' | 'home' | 'invite' | 'lesson' | 'library' | 'mail' | 'management' | 'notebook' | 'onboarding' | 'organization' | 'page' | 'runtime' | 'runtime-snapshot' | 'settings' | 'share' | 'space' | 'storage' | 'success' | 'support' | 'tag' | 'team' | 'usage' | 'user' | 'undefined';
+export default IItemType;

package/lib/models/ItemType.js

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

package/lib/models/LandingRoles.d.ts

@@ -0,0 +1,3 @@
+export declare const LANDING_ANIMATION_DELAY_SEC = 3;
+export declare const LANDING_ROLES: string[];
+export declare const LANDING_STUDIO_EASES: string[];

package/lib/models/LandingRoles.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export const LANDING_ANIMATION_DELAY_SEC = 3;
+export const LANDING_ROLES = [
+    "✨ AI Engineers",
+    "🧑‍💻 Data Scientists",
+    "🤖 ML Developers",
+    "🌎 Earth Scientists",
+    "⚗️ Biochemists",
+    "📊 Data Analysts",
+    "🗺️ GIS Specialists",
+    "🧪 Biophysicists",
+    "🛰️ EO Researchers",
+    "🚀 Geospatial Engineers",
+    "🧬 Computational Biologists",
+    "🌐 Geospatial Scientists",
+];
+export const LANDING_STUDIO_EASES = [
+    "🧑‍💻 real-time editing",
+    "✨ AI-powered content",
+    "🤖 version control efficiency",
+    "🌎 real-time synchronisation",
+    "⚗️ amazing content experience",
+    "📊 whiteboard collaboration",
+];

package/lib/models/Lesson.d.ts

@@ -0,0 +1,5 @@
+import { IBaseNotebook } from "./Notebook";
+export type ILesson = IBaseNotebook & {
+    type: 'lesson';
+};
+export default ILesson;

package/lib/models/Lesson.js

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

package/lib/models/Library.d.ts

@@ -0,0 +1,10 @@
+import { IExercise } from './Exercise';
+import { IDataset } from './Dataset';
+export type LibraryType = 'public' | 'private';
+export type Library = {
+    id: string;
+    type: LibraryType;
+    exercises: Array<IExercise>;
+    datasets: Array<IDataset>;
+};
+export default Library;

package/lib/models/Library.js

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

package/lib/models/Member.d.ts

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

package/lib/models/Member.js

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