@datalayer/core 0.0.1 → 0.0.3

package/lib/models/Runtime.d.ts

@@ -0,0 +1,123 @@
+import { Kernel } from '@jupyterlab/services';
+export declare const BACKWARDS_COMPATIBLE_KERNEL_TYPES_MAP: {
+    default: IRuntimeType;
+    snippet: IRuntimeType;
+    notebook: IRuntimeType;
+    cell: IRuntimeType;
+};
+/**
+ * Error thrown when a runtime has been created
+ * but it can ont be reached.
+ */
+export declare class RuntimeUnreachable extends Error {
+    name: string;
+}
+/**
+ * Runtime location.
+ */
+export type IRuntimeLocation = 'browser' | 'local' | string;
+/**
+ * Runtime model.
+ */
+export interface IRuntimeModel extends IRuntimePod, Kernel.IModel {
+}
+/**
+ * Runtime description.
+ */
+export interface IRuntimeDesc {
+    /**
+     * Runtime ID.
+     */
+    id?: string;
+    /**
+     * Runtime Kernel ID.
+     */
+    kernelId?: string;
+    /**
+     * Runtime name.
+     */
+    name: string;
+    /**
+     * Runtime language.
+     */
+    language: string;
+    /**
+     * Runtime location.
+     */
+    location: IRuntimeLocation;
+    /**
+     * Runtime display name.
+     */
+    displayName?: string;
+    /**
+     * Runtime parameters.
+     */
+    params?: Record<string, any>;
+    /**
+     * Runtime credits burning rate.
+     */
+    burningRate?: number;
+    /**
+     * Runtime Pod name (if applicable).
+     */
+    podName?: string;
+}
+/**
+ * Runtime type.
+ *
+ * TODO refactor with type { RuntimeLocation }
+ */
+export type IRuntimeType = 'notebook' | 'cell';
+/**
+ * Runtime optional capabilities.
+ */
+export type IRuntimeCapabilities = 'user_storage';
+/**
+ * Runtime pod.
+ */
+export interface IRuntimePod {
+    /**
+     * Environment display name
+     */
+    environment_title: string;
+    /**
+     * Environment name
+     */
+    environment_name: string;
+    /**
+     * Runtime name
+     */
+    pod_name: string;
+    /**
+     * Runtime ingress URL
+     */
+    ingress: string;
+    /**
+     * Runtime user given name
+     */
+    given_name: string;
+    /**
+     * Runtime type
+     */
+    type: IRuntimeType;
+    /**
+     * Server authentication token
+     */
+    token: string;
+    /**
+     * Credits burning rate per second
+     */
+    burning_rate: number;
+    /**
+     * Kernel reservation ID
+     */
+    reservation_id?: string;
+    /**
+     * Runtime usage starting timestamp
+     */
+    started_at: string;
+    /**
+     * Runtime credits reservation expiration timestamp
+     */
+    expired_at?: string;
+}

package/lib/models/Runtime.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export const BACKWARDS_COMPATIBLE_KERNEL_TYPES_MAP = {
+    // Backwards compatible mapping.
+    'default': 'notebook',
+    'snippet': 'cell',
+    'notebook': 'notebook',
+    'cell': 'cell',
+};
+/**
+ * Error thrown when a runtime has been created
+ * but it can ont be reached.
+ */
+export class RuntimeUnreachable extends Error {
+    name = 'RuntimeUnreachable';
+}

package/lib/models/RuntimeSnapshot.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Runtime snapshot from API.
+ */
+export interface IAPIRuntimeSnapshot {
+    /**
+     * Snapshot UID
+     */
+    uid: string;
+    /**
+     * Snapshot name
+     */
+    name: string;
+    /**
+     * Snapshot description
+     */
+    description: string;
+    /**
+     * Snapshot environment
+     */
+    environment: string;
+    /**
+     * Snapshot metadata
+     */
+    metadata: Record<string, any>;
+    /**
+     * Snapshot size in bytes
+     */
+    size: number;
+    /**
+     * Latest update time of the snapshot
+     */
+    updated_at: string;
+    /**
+     * Snapshot format
+     */
+    format: string;
+    /**
+     * Snapshot format version
+     */
+    format_version: string;
+    /**
+     * Snapshot status
+     */
+    status: string;
+}
+/**
+ * Runtime snapshot model.
+ */
+export interface IRuntimeSnapshot {
+    /**
+     * Snapshot UID
+     */
+    id: string;
+    /**
+     * Snapshot name
+     */
+    name: string;
+    /**
+     * Snapshot description
+     */
+    description: string;
+    /**
+     * Snapshot environment
+     */
+    environment: string;
+    /**
+     * Snapshot metadata
+     */
+    metadata: Record<string, any>;
+    /**
+     * Snapshot size in bytes
+     */
+    size: number;
+    /**
+     * Latest update time of the snapshot
+     */
+    updatedAt: Date;
+    /**
+     * Snapshot format
+     */
+    format: string;
+    /**
+     * Snapshot format version
+     */
+    formatVersion: string;
+    /**
+    
+     * Snapshot status
+     */
+    status: string;
+}
+export declare function asRuntimeSnapshot(s: IAPIRuntimeSnapshot): IRuntimeSnapshot;

package/lib/models/RuntimeSnapshot.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export function asRuntimeSnapshot(s) {
+    const { uid, updated_at, format_version, ...others } = s;
+    return {
+        ...others,
+        id: uid,
+        updatedAt: new Date(updated_at),
+        formatVersion: format_version
+    };
+}

package/lib/models/School.d.ts

@@ -0,0 +1,11 @@
+import { IDean } from "./Dean";
+import { IStudent } from "./Student";
+import { ICourse } from "./Course";
+import { IBaseOrganization } from "./Organization";
+export type ISchool = IBaseOrganization & {
+    type: 'school';
+    dean?: IDean;
+    students: Array<IStudent>;
+    courses: Array<ICourse>;
+};
+export default ISchool;

package/lib/models/School.js

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

package/lib/models/Secret.d.ts

@@ -0,0 +1,10 @@
+export declare const asSecret: (s: any) => ISecret;
+export type ISecretVariant = 'generic' | 'password' | 'key' | 'token';
+export type ISecret = {
+    id: string;
+    variant: ISecretVariant;
+    name: string;
+    description: string;
+    value: string;
+};
+export default ISecret;

package/lib/models/Secret.js

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

package/lib/models/Space.d.ts

@@ -0,0 +1,34 @@
+import { SpaceMember } from "./SpaceMember";
+import { ISpaceItem } from "./SpaceItem";
+import { ICourse as ICourse } from "./Course";
+import { IOrganization } from "./Organization";
+import { IUser } from "./User";
+/**
+ * Convert the raw space object to {@link ISpace}.
+ *
+ * @param user Raw space object from DB
+ * @returns Space
+ */
+export declare const asSpace: (raw_space: any) => ISpace;
+export type ISpaceVariant = 'default' | 'course';
+export type IAnySpace = ISpace | ICourse;
+export type IBaseSpace = {
+    id: string;
+    handle: string;
+    type: string;
+    variant: ISpaceVariant;
+    name: string;
+    description: string;
+    creationDate: Date;
+    public: boolean;
+    owner: IUser;
+    organization?: Partial<IOrganization>;
+    members?: SpaceMember[];
+};
+export type ISpace = IBaseSpace & {
+    type: 'space';
+    variant: 'default';
+    items?: Array<ISpaceItem>;
+    itemIds?: Array<string>;
+};
+export default ISpace;

package/lib/models/Space.js

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { asUser } from "./User";
+import { asArray } from "../utils";
+import { newUserMock } from './../mocks/models';
+/**
+ * Convert the raw space object to {@link ISpace}.
+ *
+ * @param user Raw space object from DB
+ * @returns Space
+ */
+export const asSpace = (raw_space) => {
+    const owner = newUserMock();
+    let members = new Array();
+    if (raw_space.members) {
+        members = asArray(raw_space.members).map(m => {
+            const member = asUser(m);
+            return member;
+        });
+    }
+    const space = {
+        id: raw_space.uid,
+        handle: raw_space.handle_s,
+        type: 'space',
+        variant: raw_space.variant_s,
+        name: raw_space.name_t,
+        description: raw_space.description_t,
+        public: raw_space.public_b,
+        members,
+        creationDate: new Date(raw_space.creation_ts_dt),
+        owner,
+        organization: {
+            handle: raw_space.handle_s,
+        }
+    };
+    return space;
+};

package/lib/models/SpaceItem.d.ts

@@ -0,0 +1,10 @@
+import { INotebook } from "./Notebook";
+import { IDocument } from "./Document";
+import { ICell } from "./Cell";
+import { IDataset } from "./Dataset";
+import { IEnvironment } from "./Environment";
+import { ILesson } from "./Lesson";
+import { IExercise } from "./Exercise";
+import { IAssignment } from "./Assignment";
+export type ISpaceItem = IDataset | INotebook | ICell | IEnvironment | ILesson | IExercise | IAssignment | IDocument;
+export default ISpaceItem;

package/lib/models/SpaceItem.js

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

package/lib/models/SpaceMember.d.ts

@@ -0,0 +1,6 @@
+import { Member } from "./Member";
+import { ISpace } from "./Space";
+export type SpaceMember = Member & {
+    space?: ISpace;
+};
+export default SpaceMember;

package/lib/models/SpaceMember.js

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

package/lib/models/Student.d.ts

@@ -0,0 +1,6 @@
+import { IUser } from "./User";
+import { IStudentItem } from "./StudentItem";
+export type IStudent = IUser & {
+    studentItems?: Map<string, IStudentItem>;
+};
+export default IStudent;

package/lib/models/Student.js

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

package/lib/models/StudentItem.d.ts

@@ -0,0 +1,21 @@
+import { IItemType } from "./ItemType";
+import { IStudent } from "./Student";
+import { ISpaceItem } from "./SpaceItem";
+export type IStudentItem = {
+    id: string;
+    type: 'student_item';
+    student?: IStudent;
+    item?: ISpaceItem;
+    itemId: string;
+    itemType: IItemType;
+    points?: number;
+    nbgrades?: any;
+    nbgradesTotalPoints?: number;
+    nbgradesTotalScore?: number;
+    completed?: boolean;
+    codeStudent?: string;
+    pass?: boolean;
+    invalid?: boolean;
+    invalidReason?: string;
+};
+export default IStudentItem;

package/lib/models/StudentItem.js

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

package/lib/models/Survey.d.ts

@@ -0,0 +1,20 @@
+export declare const asSurvey: (s: any) => ISurvey;
+export type ICreateSurveyResponseType = {
+    success: boolean;
+    message: string;
+    survey: ISurvey;
+};
+export type IGetSurveysResponseType = {
+    success: boolean;
+    message: string;
+    surveys: Array<ISurvey>;
+};
+export type ISurvey = {
+    id: string;
+    name: string;
+    userId: string;
+    form: any;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export default ISurvey;

package/lib/models/Survey.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD License.
+ */
+export const asSurvey = (s) => {
+    return {
+        id: s.uid,
+        name: s.name_s,
+        userId: s.user_id,
+        form: s.form,
+        createdAt: new Date(s.creation_ts_dt),
+        updatedAt: new Date(s.last_update_ts_dt),
+    };
+};

package/lib/models/Team.d.ts

@@ -0,0 +1,22 @@
+import { TeamMember } from "./TeamMember";
+import IOrganization from "./Organization";
+export type IAnyTeam = ITeam;
+export declare function asTeam(t: any, organizationId: string): ITeam;
+export type IBaseTeam = {
+    id: string;
+    type: string;
+    handle: string;
+    name: string;
+    description: string;
+    public: boolean;
+    creationDate: Date;
+    lastUpdateDate?: Date;
+    lastPublicationDate?: Date;
+    setMembers: (members: TeamMember[]) => void;
+};
+export type ITeam = IBaseTeam & {
+    type: 'team';
+    organization: Pick<IOrganization, "id">;
+    members: TeamMember[];
+};
+export default ITeam;

package/lib/models/Team.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD 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,40 @@
+/*
+ * Copyright (c) 2023-2025 Datalayer, Inc.
+ * Distributed under the terms of the Modified BSD 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;
+    }
+}