@datalayer/core 0.0.1 → 0.0.2

package/lib/models/Team.js

@@ -0,0 +1,37 @@
+/*
+ * 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";
+export function asTeam(t, organizationId) {
+    let members = new Array();
+    if (t.members) {
+        members = asArray(t.members).map(m => {
+            const member = asUser(m);
+            return member;
+        });
+    }
+    const team = {
+        id: t.uid,
+        handle: t.handle_s,
+        type: 'team',
+        name: t.name_t,
+        description: t.description_t,
+        public: t.public_b,
+        members,
+        organization: {
+            id: organizationId,
+        },
+        creationDate: new Date(t.creation_ts_dt),
+        setMembers(members) {
+            this.members = members;
+        },
+    };
+    return team;
+}

package/lib/models/TeamMember.d.ts

@@ -0,0 +1,6 @@
+import { Member } from "./Member";
+import { ITeam } from "./Team";
+export type TeamMember = Member & {
+    team?: ITeam;
+};
+export default TeamMember;

package/lib/models/TeamMember.js

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

package/lib/models/URN.d.ts

@@ -0,0 +1,63 @@
+export declare class URN implements IURN {
+    private _partition;
+    private _service;
+    private _region;
+    private _account;
+    private _type;
+    private _uid;
+    constructor(urn: string);
+    get partition(): string;
+    get service(): string;
+    get region(): string;
+    get account(): string;
+    get type(): string;
+    get uid(): string;
+}
+/**
+  Datalayer Uniform Resource Name (URN)
+
+  @see https://en.wikipedia.org/wiki/Uniform_Resource_Name
+  @see https://learn.microsoft.com/en-us/linkedin/shared/api-guide/concepts/urns
+  @see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
+
+  urn:partition:service:region:account:type:uid
+  urn:partition:service:region:account:type:uid/path/subpath
+
+  Examples:
+  - Account should be the uid.
+  - We are using in the examples some names to make it easier to read.
+
+  IAM Account
+  - urn:dla:iam:::user:eric
+  - urn:dla:iam:::organization:datalayer
+  - urn:dla:iam:::team:developers
+
+  IAM Providers
+  - urn:dla:iam:ext::github:xyz
+
+  Objects
+  - urn:dla:spacer:::space:space-1
+  - urn:dla:spacer:::notebook:data-analysis/data-analysis.ipynb
+  - urn:dla:spacer:::cell:a-simple-cell
+  - urn:dla:spacer:us-east-1::dataset:cities/cities.csv
+  - urn:dla:edu:::course:course-1
+  - urn:dla:edu:::lesson:advanced-python/advanced-python.ipynb
+  - urn:dla:edu:::exercise:loop-with-python
+  - urn:dla:library:::notebook:notebook-1
+  - urn:dla:app:::panel:new-york-taxis
+
+  Relations
+  - urn:dla:iam::run:relation:CourseInstructor/python-advanced
+  - urn:dla:iam::run:relation:OrganizationMember
+  - urn:dla:iam::run:relation:ReadCourseNotebook/python-advanced
+  - urn:dla:iam::run:relation:SpaceReader/simple-analysis
+  - urn:dla:iam::run:relation:TeamMember/developers
+*/
+export type IURN = {
+    partition: string;
+    service: string;
+    region: string;
+    account: string;
+    type: string;
+    uid: string;
+};

package/lib/models/URN.js

@@ -0,0 +1,45 @@
+/*
+ * 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 URN {
+    _partition;
+    _service;
+    _region;
+    _account;
+    _type;
+    _uid;
+    //  private _path: string;
+    constructor(urn) {
+        const parts = urn.split(":");
+        this._partition = parts[1];
+        this._service = parts[2];
+        this._region = parts[3];
+        this._account = parts[4];
+        this._type = parts[5];
+        this._uid = parts[6];
+    }
+    get partition() {
+        return this._partition;
+    }
+    get service() {
+        return this._service;
+    }
+    get region() {
+        return this._region;
+    }
+    get account() {
+        return this._account;
+    }
+    get type() {
+        return this._type;
+    }
+    get uid() {
+        return this._uid;
+    }
+}

package/lib/models/Usage.d.ts

@@ -0,0 +1,46 @@
+import { IResources } from './Environment';
+export interface IRawUsage {
+    account_uid: string;
+    resource_uid: string;
+    resource_type: string;
+    burning_rate: number;
+    credits_limit: number;
+    start_date: string;
+    updated_at: string;
+    credits?: number;
+    end_date?: string | null;
+    resource_given_name?: string;
+    resource_state?: string;
+    pod_resources?: IResources;
+    metadata: Map<string, string>;
+}
+export declare const asUsage: (u: any) => {
+    id: any;
+    accountId: any;
+    type: any;
+    burningRate: any;
+    creditsLimit: any;
+    credits: any;
+    givenName: any;
+    startDate: Date;
+    updatedAt: Date;
+    endDate: Date | undefined;
+    resourceState: any;
+    resources: any;
+    metadata: Map<string, string>;
+};
+export interface IUsage {
+    id: string;
+    accountId?: string;
+    type: string;
+    burningRate: number;
+    credits?: number;
+    creditsLimit: number;
+    startDate: Date;
+    updatedAt: Date;
+    endDate?: Date;
+    givenName: string;
+    resourceState: string;
+    resources?: IResources;
+    metadata: Map<string, string>;
+}

package/lib/models/Usage.js

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export const asUsage = (u) => {
+    return {
+        id: u.resource_uid,
+        accountId: u.account_uid ?? '',
+        type: u.resource_type,
+        burningRate: u.burning_rate,
+        creditsLimit: u.credits_limit,
+        credits: u.credits,
+        givenName: u.resource_given_name ?? u.resource_uid,
+        startDate: new Date(u.start_date),
+        updatedAt: new Date(u.updated_at),
+        endDate: u.end_date ? new Date(u.end_date) : undefined,
+        resourceState: u.resource_state,
+        resources: u.pod_resources,
+        metadata: new Map(Object.entries(u.metadata ?? {})),
+    };
+};

package/lib/models/User.d.ts

@@ -0,0 +1,71 @@
+import { IInvite } from "./Invite";
+import { IIAMProviderLinked } from "./IAMProviderLinked";
+import { IUserOnboarding } from './UserOnboarding';
+import { IUserSettings } from './UserSettings';
+import { IUserEvent } from './UserEvent';
+export declare const ANONYMOUS_USER: undefined;
+export declare const ANONYMOUS_USER_TOKEN: undefined;
+export declare const ANONYMOUS_USER_EXTERNAL_TOKEN: undefined;
+/**
+ * Get a random color from the list of colors.
+ */
+export declare const getUserRandomColor: () => string;
+export declare class User implements IUser {
+    id: string;
+    handle: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    initials: string;
+    displayName: string;
+    joinDate?: Date;
+    roles: string[];
+    credits?: number;
+    creditsCustomerId?: string;
+    avatarUrl?: string;
+    origin?: string;
+    invites?: Array<IInvite>;
+    iamProviders: Array<IIAMProviderLinked>;
+    settings: IUserSettings;
+    unsubscribedFromOutbounds: boolean;
+    mfaUrl?: string;
+    onboarding: IUserOnboarding;
+    linkedContactId?: string;
+    events: Array<IUserEvent>;
+    constructor(u: any);
+    setRoles(roles: string[]): void;
+}
+/**
+ * Convert the raw user object to {@link IUser}.
+ *
+ * @param u Raw user object from DB
+ * @returns IUser
+ */
+export declare function asUser(u: any): IUser;
+export type IBaseUser = {
+    email: string;
+    firstName: string;
+    lastName: string;
+    initials: string;
+    displayName: string;
+    joinDate?: Date;
+    roles: string[];
+    setRoles: (roles: string[]) => void;
+};
+export type IUser = IBaseUser & {
+    id: string;
+    handle: string;
+    credits?: number;
+    creditsCustomerId?: string;
+    avatarUrl?: string;
+    origin?: string;
+    invites?: Array<IInvite>;
+    iamProviders: Array<IIAMProviderLinked>;
+    settings: IUserSettings;
+    unsubscribedFromOutbounds: boolean;
+    mfaUrl?: string;
+    onboarding: IUserOnboarding;
+    linkedContactId?: string;
+    events: Array<IUserEvent>;
+};
+export default IUser;

package/lib/models/User.js

@@ -0,0 +1,103 @@
+/*
+ * 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, namesAsInitials } from '../utils';
+import { asIAMProviderLinked } from "./IAMProviderLinked";
+import { BOOTSTRAP_USER_ONBOARDING } from './UserOnboarding';
+import { UserSettings } from './UserSettings';
+import { asUserEvent } from './UserEvent';
+export const ANONYMOUS_USER = undefined;
+export const ANONYMOUS_USER_TOKEN = undefined;
+export const ANONYMOUS_USER_EXTERNAL_TOKEN = undefined;
+/**
+ * Predefined colors for users
+ */
+const USER_COLORS = [
+    'var(--jp-collaborator-color1)',
+    'var(--jp-collaborator-color2)',
+    'var(--jp-collaborator-color3)',
+    'var(--jp-collaborator-color4)',
+    'var(--jp-collaborator-color5)',
+    'var(--jp-collaborator-color6)',
+    'var(--jp-collaborator-color7)',
+];
+/**
+ * Get a random color from the list of colors.
+ */
+export const getUserRandomColor = () => USER_COLORS[Math.floor(Math.random() * USER_COLORS.length)];
+export class User {
+    id;
+    handle;
+    email;
+    firstName;
+    lastName;
+    initials;
+    displayName;
+    joinDate;
+    roles;
+    credits;
+    creditsCustomerId;
+    avatarUrl;
+    origin;
+    invites;
+    iamProviders;
+    settings;
+    unsubscribedFromOutbounds;
+    mfaUrl;
+    onboarding;
+    linkedContactId;
+    events;
+    constructor(u) {
+        this.id = u.uid;
+        this.handle = u.handle_s;
+        this.email = u.email_s;
+        this.firstName = u.first_name_t;
+        this.lastName = u.last_name_t;
+        this.initials = namesAsInitials(u.first_name_t, u.last_name_t);
+        const displayName = asDisplayName(u.first_name_t, u.last_name_t);
+        this.displayName = displayName === "" ? u.handle_s : displayName;
+        this.avatarUrl = u.avatar_url_s;
+        this.origin = u.origin_s;
+        this.joinDate = u.join_ts_dt ? new Date(u.join_ts_dt) : undefined,
+            this.credits = u.credits_i ? Number(u.credits_i) : 0;
+        this.creditsCustomerId = u.credits_customer_uid;
+        this.roles = u.roles_ss ?? [];
+        let iamProviders = [];
+        try {
+            iamProviders = (u.iam_providers ?? []).map(iamProvider => asIAMProviderLinked(iamProvider));
+        }
+        catch (e) {
+            // no-op for backwards compatibility.
+        }
+        this.iamProviders = iamProviders;
+        this.settings = new UserSettings(u.settings ?? {});
+        this.unsubscribedFromOutbounds = u.unsubscribed_from_outbounds_b ?? false;
+        this.mfaUrl = u.mfa_url_s;
+        this.onboarding = u.onboarding_s ? JSON.parse(u.onboarding_s) : BOOTSTRAP_USER_ONBOARDING;
+        this.linkedContactId = u.linked_contact_uid;
+        let events = u.events ?? [];
+        if (!Array.isArray(events)) {
+            events = [events];
+        }
+        this.events = events.map(event => asUserEvent(event));
+        this.events.sort((x, y) => (x.eventDate < y.eventDate ? 1 : -1));
+    }
+    setRoles(roles) {
+        this.roles = roles;
+    }
+}
+/**
+ * Convert the raw user object to {@link IUser}.
+ *
+ * @param u Raw user object from DB
+ * @returns IUser
+ */
+export function asUser(u) {
+    return new User(u);
+}

package/lib/models/UserEvent.d.ts

@@ -0,0 +1,10 @@
+export declare const asUserEvent: (u: any) => IUserEvent;
+export type IUserEvent = {
+    id: string;
+    subType: string;
+    token: string;
+    detailsJson: string;
+    message: string;
+    eventDate: string;
+};
+export default IUserEvent;

package/lib/models/UserEvent.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 asUserEvent = (u) => {
+    return {
+        id: u.uid,
+        message: u.message_t ?? '',
+        subType: u.sub_type_s,
+        detailsJson: u.details_json_t ?? '',
+        token: u.token_s,
+        eventDate: u.event_ts_dt,
+    };
+};

package/lib/models/UserOnboarding.d.ts

@@ -0,0 +1,14 @@
+export declare const WELCOME_RUNTIME_TOUR_NAME = "welcome-runtime";
+export declare const BOOTSTRAP_USER_ONBOARDING: IUserOnboarding;
+export type IOnboardingPosition = 'top' | 'bottom' | 'invisible' | 'sidebar';
+export type ITourStatus = "idle" | "ready" | "waiting" | "running" | "paused" | "skipped" | "finished" | "error";
+export type ITour = {
+    status: ITourStatus;
+};
+export type IOnboardingTours = Record<string, ITour>;
+export type IClient = 'Platform' | 'JupyterLab' | 'CLI' | 'VSCode';
+export type IUserOnboarding = {
+    clients: Record<IClient, number>;
+    position: IOnboardingPosition;
+    tours: IOnboardingTours;
+};

package/lib/models/UserOnboarding.js

@@ -0,0 +1,24 @@
+/*
+ * 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 WELCOME_RUNTIME_TOUR_NAME = "welcome-runtime";
+export const BOOTSTRAP_USER_ONBOARDING = {
+    clients: {
+        "Platform": 0,
+        "JupyterLab": 0,
+        "CLI": 0,
+        "VSCode": 0,
+    },
+    position: 'top',
+    tours: {
+        "welcome-runtime": {
+            status: "ready",
+        },
+    },
+};

package/lib/models/UserSettings.d.ts

@@ -0,0 +1,16 @@
+export declare const AI_AGENTS_URL_KEY = "aiagents_url_s";
+export declare const CAN_INVITE_URL_KEY = "can_invite_b";
+export type IUserSettings = {
+    aiAgentsUrl?: string;
+    canInvite?: boolean;
+};
+export declare class UserSettings implements IUserSettings {
+    private _aiAgentsUrl?;
+    private _canInvite?;
+    constructor(s: any);
+    get aiAgentsUrl(): string | undefined;
+    set aiAgentsUrl(value: string | undefined);
+    get canInvite(): boolean | undefined;
+    set canInvite(value: boolean | undefined);
+}
+export default UserSettings;

package/lib/models/UserSettings.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 AI_AGENTS_URL_KEY = "aiagents_url_s";
+export const CAN_INVITE_URL_KEY = "can_invite_b";
+export class UserSettings {
+    _aiAgentsUrl;
+    _canInvite;
+    constructor(s) {
+        this._aiAgentsUrl = s[AI_AGENTS_URL_KEY] ?? undefined;
+        this._canInvite = s[CAN_INVITE_URL_KEY] ?? undefined;
+    }
+    get aiAgentsUrl() {
+        return this._aiAgentsUrl;
+    }
+    set aiAgentsUrl(value) {
+        this._aiAgentsUrl = value;
+    }
+    get canInvite() {
+        return this._canInvite;
+    }
+    set canInvite(value) {
+        this._canInvite = value;
+    }
+}
+export default UserSettings;

package/lib/models/WaitingListFormData.d.ts

@@ -0,0 +1,6 @@
+export interface WaitingListFormData {
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    affiliation?: string;
+}

package/lib/models/WaitingListFormData.js

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

package/lib/models/index.d.ts

@@ -0,0 +1,65 @@
+export * from './AIAgent';
+export * from './Base';
+export * from './Assignment';
+export * from './Cell';
+export * from './CodeBlock';
+export * from './CodefeedBlocks';
+export * from './Contact';
+export * from "./ContactEvent";
+export * from "./ContactIAMProvider";
+export * from './ContactTags';
+export * from './Content';
+export * from './Course';
+export * from './Credits';
+export * from './Datasource';
+export * from './Dataset';
+export * from './Dean';
+export * from './Document';
+export * from './Environment';
+export * from './Errors';
+export * from './Exercise';
+export * from './GrowthKPI';
+export * from './IAMProviderLinked';
+export * from './IAMProviderPost';
+export * from './IAMProvidersSpecs';
+export * from './IAMProviderUsers';
+export * from './Instructor';
+export * from './IAMToken';
+export * from './Inbound';
+export * from './Invite';
+export * from './Item';
+export * from './ItemType';
+export * from './LandingRoles';
+export * from './Lesson';
+export * from './Library';
+export * from './Member';
+export * from './Notebook';
+export * from './Organization';
+export * from './OrganizationMember';
+export * from './Outbound';
+export * from './Page';
+export * from './PageTag';
+export * from './Profile';
+export * from './Role';
+export * from './RolesOrganization';
+export * from './RolesPlatform';
+export * from './RolesTeam';
+export * from './Runtime';
+export * from './RuntimeSnapshot';
+export * from './School';
+export * from './Secret';
+export * from './Space';
+export * from './SpaceItem';
+export * from './SpaceMember';
+export * from './Student';
+export * from './StudentItem';
+export * from './Survey';
+export * from './Team';
+export * from './TeamMember';
+export * from './URN';
+export * from './Usage';
+export * from './User';
+export * from './UserEvent';
+export * from './UserOnboarding';
+export * from './UserSettings';
+export * from './WaitingListFormData';

package/lib/models/index.js

@@ -0,0 +1,74 @@
+/*
+ * 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 './AIAgent';
+export * from './Base';
+export * from './Assignment';
+export * from './Cell';
+export * from './CodeBlock';
+export * from './CodefeedBlocks';
+export * from './Contact';
+export * from "./ContactEvent";
+export * from "./ContactIAMProvider";
+export * from './ContactTags';
+export * from './Content';
+export * from './Course';
+export * from './Credits';
+export * from './Datasource';
+export * from './Dataset';
+export * from './Dean';
+export * from './Document';
+export * from './Environment';
+export * from './Errors';
+export * from './Exercise';
+export * from './GrowthKPI';
+export * from './IAMProviderLinked';
+export * from './IAMProviderPost';
+export * from './IAMProvidersSpecs';
+export * from './IAMProviderUsers';
+export * from './Instructor';
+export * from './IAMToken';
+export * from './Inbound';
+export * from './Invite';
+export * from './Item';
+export * from './ItemType';
+export * from './LandingRoles';
+export * from './Lesson';
+export * from './Library';
+export * from './Member';
+export * from './Notebook';
+export * from './Organization';
+export * from './OrganizationMember';
+export * from './Outbound';
+export * from './Page';
+export * from './PageTag';
+export * from './Profile';
+export * from './Role';
+export * from './RolesOrganization';
+export * from './RolesPlatform';
+export * from './RolesTeam';
+export * from './Runtime';
+export * from './RuntimeSnapshot';
+export * from './School';
+export * from './Secret';
+export * from './Space';
+export * from './SpaceItem';
+export * from './SpaceMember';
+export * from './Student';
+export * from './StudentItem';
+export * from './Survey';
+export * from './Team';
+export * from './TeamMember';
+export * from './URN';
+export * from './Usage';
+export * from './User';
+export * from './UserEvent';
+export * from './UserOnboarding';
+export * from './UserSettings';
+export * from './WaitingListFormData';

package/lib/routes/Routes.d.ts

@@ -0,0 +1,3 @@
+export declare const CONTACT_ROUTE = "contact";
+export declare const SUPPORT_ROUTE = "support";
+export declare const USAGE_ROUTE = "usage";