@datalayer/core 0.0.1 → 0.0.2

package/lib/models/Inbound.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
+ */
+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,32 @@
+/*
+ * 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 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 {};

package/lib/models/Notebook.d.ts

@@ -0,0 +1,11 @@
+import { INotebookContent } from '@jupyterlab/nbformat';
+import { IItem } from "./Item";
+import { IDataset } from './Dataset';
+export type IBaseNotebook = IItem & {
+    nbformat?: INotebookContent;
+    datasets: Array<IDataset>;
+};
+export type INotebook = IBaseNotebook & {
+    type: 'notebook';
+};
+export default INotebook;

package/lib/models/Notebook.js

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

package/lib/models/Organization.d.ts

@@ -0,0 +1,27 @@
+import { ITeam } from "./Team";
+import { ISchool } from "./School";
+import { IOrganizationMember } from "./OrganizationMember";
+/**
+ * Convert the raw user object to {@link IOrganization}.
+ *
+ * @param org Raw user object from DB
+ * @returns Organizatin
+ */
+export declare function asOrganization(org: any): IOrganization;
+export type IAnyOrganization = IOrganization | ISchool;
+export type IBaseOrganization = {
+    id: string;
+    handle: string;
+    type: string;
+    name: string;
+    description: string;
+    public: boolean;
+    creationDate: Date;
+    members: IOrganizationMember[];
+    setMembers: (members: IOrganizationMember[]) => void;
+};
+export type IOrganization = IBaseOrganization & {
+    type: "organization";
+    teams: ITeam[];
+};
+export default IOrganization;

package/lib/models/Organization.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { asArray } from "../utils";
+import { asUser } from "./User";
+/**
+ * Convert the raw user object to {@link IOrganization}.
+ *
+ * @param org Raw user object from DB
+ * @returns Organizatin
+ */
+export function asOrganization(org) {
+    let members = new Array();
+    if (org.members) {
+        members = asArray(org.members).map(m => {
+            const member = asUser(m);
+            return member;
+        });
+    }
+    const organization = {
+        id: org.uid,
+        handle: org.handle_s,
+        type: 'organization',
+        name: org.name_t,
+        description: org.description_t,
+        public: org.public_b,
+        members,
+        teams: [],
+        creationDate: new Date(org.creation_ts_dt),
+        setMembers(members) {
+            this.members = members;
+        },
+    };
+    return organization;
+}

package/lib/models/OrganizationMember.d.ts

@@ -0,0 +1,6 @@
+import { Member } from "./Member";
+import { IOrganization } from "./Organization";
+export type IOrganizationMember = Member & {
+    organization?: IOrganization;
+};
+export default IOrganizationMember;

package/lib/models/OrganizationMember.js

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

package/lib/models/Outbound.d.ts

@@ -0,0 +1,41 @@
+export declare class Outbound implements IOutbound {
+    id: string;
+    subType: string;
+    name: string;
+    description: string;
+    tags: Array<string>;
+    status: string;
+    emailSubject: string;
+    emailContent: string;
+    senderUid: string;
+    senderDisplayName: string;
+    recipients: Array<string>;
+    creationDate?: Date;
+    lastUpdateDate?: Date;
+    launchedDate?: Date;
+    constructor(u: any);
+}
+/**
+ * Convert the raw user object to {@link IOutbound}.
+ *
+ * @param u Raw user object from DB
+ * @returns Outbound
+ */
+export declare function asOutbound(u: any): IOutbound;
+export type IOutbound = {
+    id: string;
+    subType: string;
+    name: string;
+    description: string;
+    tags: Array<string>;
+    status: string;
+    emailSubject: string;
+    emailContent: string;
+    senderUid: string;
+    senderDisplayName: string;
+    recipients: Array<string>;
+    creationDate?: Date;
+    lastUpdateDate?: Date;
+    launchedDate?: Date;
+};
+export default IOutbound;

package/lib/models/Outbound.js

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+export class Outbound {
+    id;
+    subType;
+    name;
+    description;
+    tags;
+    status;
+    emailSubject;
+    emailContent;
+    senderUid;
+    senderDisplayName;
+    recipients;
+    creationDate;
+    lastUpdateDate;
+    launchedDate;
+    constructor(u) {
+        this.id = u.uid;
+        this.subType = u.subType;
+        this.name = u.name,
+            this.description = u.description,
+            this.tags = u.tags ?? [],
+            this.status = u.status,
+            this.emailSubject = u.emailSubject,
+            this.emailContent = u.emailContent,
+            this.senderUid = u.senderUid;
+        this.senderDisplayName = u.senderDisplayName;
+        this.recipients = u.recipients;
+        this.creationDate = new Date(u.creationDate);
+        this.lastUpdateDate = new Date(u.lastUpdateDate);
+        this.launchedDate = u.launchedDate ? new Date(u.launchedDate) : undefined;
+    }
+}
+/**
+ * Convert the raw user object to {@link IOutbound}.
+ *
+ * @param u Raw user object from DB
+ * @returns Outbound
+ */
+export function asOutbound(u) {
+    return new Outbound(u);
+}

package/lib/models/Page.d.ts

@@ -0,0 +1,36 @@
+import { INotebookContent } from '@jupyterlab/nbformat';
+import { IUser } from './User';
+import { PageTagName } from './PageTag';
+import { IRuntimeSnapshot } from './RuntimeSnapshot';
+export type PageTheme = 'default';
+export type PageVariant = 'document' | 'cell' | 'notebook';
+/**
+ * Page attributes.
+ *
+ * - Notebook
+ * - Screen Capture
+ * - Theme
+ * - Tags
+ * - Video Explainer
+ * - Kernel Launcher Button
+ * - Kernel Snapshot
+ * - Share Button
+ * - Stars Counter - 1 ⭐ -> 1 Credit
+ */
+export type IPage = {
+    id: string;
+    variant: PageVariant;
+    type: 'page';
+    name: string;
+    description: string;
+    theme: PageTheme;
+    tags: Array<PageTagName>;
+    nbformat: INotebookContent;
+    screenCapture?: string;
+    creator?: IUser;
+    creatorId?: string;
+    kernelSnapshot?: IRuntimeSnapshot;
+    kernelSnapshotId?: string;
+};
+export declare const asPage: (s: any) => IPage;
+export default IPage;

package/lib/models/Page.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { asUser } from './User';
+import { asRuntimeSnapshot } from './RuntimeSnapshot';
+export const asPage = (s) => {
+    return {
+        id: s.uid,
+        type: 'page',
+        variant: s.variant_s,
+        name: s.name_t,
+        description: s.description_t,
+        theme: s.theme_s,
+        nbformat: s.nbformat_s ? JSON.parse(s.nbformat_s) : undefined,
+        screenCapture: s.screen_capture_s,
+        tags: (s.tags_ss ?? []),
+        creator: s.creator ? asUser(s.creator) : undefined,
+        creatorId: s.creator_uid,
+        kernelSnapshot: s.kernel_snapshot ? asRuntimeSnapshot(s.kernel_snapshot) : undefined,
+        kernelSnapshotId: s.kernel_snapshot_uid,
+    };
+};

package/lib/models/PageTag.d.ts

@@ -0,0 +1,19 @@
+import { CardIconColors } from '@primer/react-brand';
+import { Icon } from '@primer/octicons-react';
+type CardIconColorsType = typeof CardIconColors[number];
+export type PageTagMetadata = {
+    fillColor: React.CSSProperties['backgroundColor'];
+};
+export type PageTagName = 'ai' | 'deep-learning' | 'example' | 'llm' | 'python' | 'pytorch' | 'spatial' | 'tutorial';
+export type PageTag = {
+    id: string;
+    text?: PageTagName;
+    color: CardIconColorsType;
+    Icon: Icon;
+    metadata?: PageTagMetadata;
+};
+export declare const PAGE_TAGE_NONE: PageTag;
+export declare const PAGE_TAGS: PageTag[];
+export declare const PAGE_TAGS_BY_NAME_MAP: Map<PageTagName | undefined, PageTag>;
+export declare const PAGE_TAGS_BY_COLOR_MAP: Map<"default" | "yellow" | "blue" | "coral" | "green" | "gray" | "indigo" | "lemon" | "lime" | "orange" | "pink" | "purple" | "red" | "teal", PageTag>;
+export {};

package/lib/models/PageTag.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { CopilotIcon, ZapIcon } from '@primer/octicons-react';
+export const PAGE_TAGE_NONE = { id: '0', text: undefined, Icon: CopilotIcon, color: 'pink' };
+const PAGE_TAGE_AI = { id: '1', text: 'ai', Icon: CopilotIcon, color: 'pink' };
+const PAGE_TAGE_DEEP_LEARNING = { id: '2', text: 'deep-learning', Icon: ZapIcon, color: 'blue' };
+const PAGE_TAGE_EXAMPLE = { id: '3', text: 'example', Icon: CopilotIcon, color: 'lime' };
+const PAGE_TAGE_LLM = { id: '4', text: 'llm', Icon: CopilotIcon, color: 'coral' };
+const PAGE_TAGE_PYTHON = { id: '5', text: 'python', Icon: CopilotIcon, color: 'gray', metadata: { fillColor: 'var(--base-color-green-0)' } };
+const PAGE_TAGE_PYTORCH = { id: '6', text: 'pytorch', Icon: CopilotIcon, color: 'green' };
+const PAGE_TAGE_SPATIAL = { id: '7', text: 'spatial', Icon: CopilotIcon, color: 'lemon' };
+const PAGE_TAGE_TUTORIAL = { id: '8', text: 'tutorial', Icon: CopilotIcon, color: 'orange', metadata: { fillColor: 'yellow' } };
+export const PAGE_TAGS = [
+    PAGE_TAGE_AI,
+    PAGE_TAGE_DEEP_LEARNING,
+    PAGE_TAGE_EXAMPLE,
+    PAGE_TAGE_LLM,
+    PAGE_TAGE_PYTHON,
+    PAGE_TAGE_PYTORCH,
+    PAGE_TAGE_SPATIAL,
+    PAGE_TAGE_TUTORIAL,
+];
+export const PAGE_TAGS_BY_NAME_MAP = new Map(PAGE_TAGS.map(t => [t.text, t]));
+export const PAGE_TAGS_BY_COLOR_MAP = new Map(PAGE_TAGS.map(t => [t.color, t]));

package/lib/models/Profile.d.ts

@@ -0,0 +1 @@
+export type IProfileType = "user" | "organization" | undefined;

package/lib/models/Profile.js

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

package/lib/models/Role.d.ts

@@ -0,0 +1,9 @@
+export type IRole = {
+    id: string;
+    handle: string;
+    displayName: string;
+    description: string;
+    permissions: Array<any>;
+    icon: React.ElementType;
+};
+export default IRole;

package/lib/models/Role.js

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

package/lib/models/RolesOrganization.d.ts

@@ -0,0 +1,9 @@
+import { IRole } from "./Role";
+export declare class OrganizationRoles {
+    private constructor();
+    static readonly Member: IRole;
+    static readonly SecurityAuditor: IRole;
+    static readonly UsageReviewer: IRole;
+    static readonly Owner: IRole;
+    static readonly ALL_ROLES: IRole[];
+}

package/lib/models/RolesOrganization.js

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/*
+ * Copyright (c) 2021-2024 Datalayer, Inc.
+ *
+ * Datalayer License
+ */
+import { AlienIcon } from '@datalayer/icons-react';
+const ORGANIZATION_MEMBER_PERMSSIONS = [
+    "invite_users",
+];
+const ORGANIZATION_SECURITY_AUDITOR_PERMSSIONS = [
+    "view_landings",
+];
+const ORGANIZATION_USAGE_REVIEWER_PERMSSIONS = [
+    "view_users",
+];
+const ORGANIZATION_ADMIN_PERMSSIONS = ORGANIZATION_MEMBER_PERMSSIONS.concat(...[
+    "manage_users",
+]);
+export class OrganizationRoles {
+    constructor() { }
+    static Member = {
+        id: 'organization_member',
+        handle: 'organization_member',
+        displayName: 'Organization Member',
+        description: 'A Organization Member is the role given to any member of the organization.',
+        permissions: ORGANIZATION_MEMBER_PERMSSIONS,
+        icon: AlienIcon,
+    };
+    static SecurityAuditor = {
+        id: 'organization_security_auditor',
+        handle: 'organization_security_auditor',
+        displayName: 'Organization Security Auditor',
+        description: 'A Organization Security Auditor is given to ...',
+        permissions: ORGANIZATION_SECURITY_AUDITOR_PERMSSIONS,
+        icon: AlienIcon,
+    };
+    static UsageReviewer = {
+        id: 'organization_usage_reviewer',
+        handle: 'organization_usage_reviewer',
+        displayName: 'Organization Usage Reviewer',
+        description: 'A Organization Usage Reviewer can review the platform usage.',
+        permissions: ORGANIZATION_USAGE_REVIEWER_PERMSSIONS,
+        icon: AlienIcon,
+    };
+    static Owner = {
+        id: 'organization_owner',
+        handle: 'organization_owner',
+        displayName: 'Organization Owner',
+        description: 'A Organization Owner is the owner of the organization.',
+        permissions: ORGANIZATION_ADMIN_PERMSSIONS,
+        icon: AlienIcon,
+    };
+    static ALL_ROLES = [
+        OrganizationRoles.Member,
+        OrganizationRoles.Owner,
+        OrganizationRoles.SecurityAuditor,
+        OrganizationRoles.UsageReviewer,
+    ];
+}

package/lib/models/RolesPlatform.d.ts

@@ -0,0 +1,16 @@
+import { IRole } from "./Role";
+export declare class PlatformRoles {
+    private constructor();
+    static readonly Anonymous: IRole;
+    static readonly Guest: IRole;
+    static readonly Member: IRole;
+    static readonly IAMToken: IRole;
+    static readonly SupportManager: IRole;
+    static readonly GrowthManager: IRole;
+    static readonly SuccessManager: IRole;
+    static readonly SecurityAuditor: IRole;
+    static readonly FeaturesPreviewer: IRole;
+    static readonly UsageReviewer: IRole;
+    static readonly Admin: IRole;
+    static readonly ALL_ROLES: IRole[];
+}