@thatopen/services 0.0.1

package/dist/types/base.d.ts

@@ -0,0 +1,9 @@
+export interface Base {
+    _id: ObjectId;
+    createdAt: Date;
+    updatedAt?: Date;
+    creatingUser: ObjectId;
+    creatingToken?: ObjectId;
+    archived?: boolean;
+}
+export type ObjectId = string;

package/dist/types/context.d.ts

@@ -0,0 +1,20 @@
+/** Callbacks the platform can pass to embedded apps via the context object. */
+export interface AppEventOrchestrator {
+    /** Called when the app has finished loading (components initialised). */
+    appLoaded?: () => void;
+    /** Called when the app reports an error to the platform. */
+    appError?: (code: number, data: Record<string, string>) => void;
+}
+/** Auth context injected by the That Open Platform into `window.__THATOPEN_CONTEXT__`. */
+export interface ThatOpenContext {
+    /** This app's unique identifier. */
+    appId: string;
+    /** The project this app belongs to. */
+    projectId: string;
+    /** Auth0 JWT for API calls. */
+    accessToken: string;
+    /** Base URL for the That Open API. */
+    apiUrl: string;
+    /** Platform-to-app event callbacks. */
+    appEventOrchestrator?: AppEventOrchestrator;
+}

package/dist/types/execution.d.ts

@@ -0,0 +1,19 @@
+import { ObjectId, Base } from './base';
+
+export type ExecutionEntity = Base & {
+    toolId: ObjectId;
+    toolVersion: string;
+    progress: number;
+    result?: ExecutionResultType;
+    resultMessage?: string;
+    messages?: ExecutionMessageEntity[];
+};
+export type ExecutionMessageEntity = Base & {
+    executionId: ObjectId;
+    content: string;
+};
+export type ExecutionResultType = 'SUCCESS' | 'ERROR' | 'WARNING';
+export type ExecutionSuscriptionReturnType = {
+    progressUpdate?: ExecutionEntity;
+    messageUpdate?: ExecutionMessageEntity;
+};

package/dist/types/files.d.ts

@@ -0,0 +1,19 @@
+import { Readable } from 'stream';
+import { ObjectId } from './base';
+
+export type FileType = string | Uint8Array | Buffer | Readable;
+export type HiddenFileEntity = {
+    fileId: string;
+    _id: ObjectId;
+    parentItemId: ObjectId;
+};
+export type CreateHiddenItemResult = {
+    hiddenFileId: string;
+};
+export type MetadataValue = string | number | boolean | null;
+export type Metadata = Record<string, MetadataValue>;
+export declare const METADATA_LIMITS: {
+    readonly MAX_FIELDS: 200;
+    readonly MAX_KEY_LENGTH: 50;
+    readonly MAX_VALUE_LENGTH: 50;
+};

package/dist/types/item.dto.d.ts

@@ -0,0 +1,24 @@
+import { ItemType } from './items';
+
+export type CreateItemDto = {
+    name?: string;
+    fileExtension?: string;
+    versionTag?: string;
+    folderId?: string;
+    file: File;
+    itemType?: ItemType;
+};
+export type UpdateItemDto = {
+    name?: string;
+    folderId?: string;
+};
+export type CreateItemVersionDto = {
+    versionTag: string;
+    file: File;
+};
+export type CreateItemFolderDto = {
+    name: string;
+};
+export type UpdateItemFolderDto = {
+    name: string;
+};

package/dist/types/items.d.ts

@@ -0,0 +1,57 @@
+import { Base, ObjectId } from './base';
+
+export interface Item extends Base {
+    fileExtension?: string;
+    name: string;
+    itemType: ItemType;
+    folderId?: ObjectId;
+    internalId: string;
+}
+export type ItemType = 'APP' | 'TOOL' | 'HIDDEN' | 'FILE';
+export interface ItemVersion extends Base {
+    itemId: ObjectId;
+    tag: string;
+    fileVersionId: string;
+    fileId: string;
+    fileSize: number;
+    extraProps?: AppVersionProps | ComponentVersionProps;
+    isDraft?: boolean;
+}
+export interface ItemFolder extends Base {
+    name: string;
+    parentId?: ObjectId;
+}
+export type ItemWithVersions<T = Item> = T & {
+    versions: ItemVersion[];
+};
+export type AppVersionProps = {
+    isOnline?: boolean;
+    url?: string;
+    /** When set, the app viewer loads the bundle from this URL instead of the API (for local development). */
+    devUrl?: string;
+};
+export type AppItem = Item & {
+    itemType: 'APP';
+};
+export type AppItemVersion = ItemVersion & {
+    extraProps: AppVersionProps;
+};
+export type ComponentType = 'FRONTEND' | 'CLOUD';
+export type ComponentTier = 'FREE' | 'PREMIUM';
+export type ComponentItemProps = {
+    generatedId: string;
+};
+export type ComponentVersionProps = {
+    isPublic?: boolean;
+    isOpenSource?: boolean;
+    type: ComponentType;
+    tier: ComponentTier;
+    executionEngineVersion?: string;
+};
+export type ComponentItem = Item & {
+    itemType: 'TOOL';
+};
+export type ComponentItemVersion = ItemVersion & {
+    extraProps: ComponentVersionProps;
+};
+export type ItemEntity = Item | AppItem | ComponentItem;

package/dist/types/projects.d.ts

@@ -0,0 +1,59 @@
+import { Base, ObjectId } from './base';
+
+export type PermissionSubject = 'PROJECT' | 'MEMBERS' | 'ROLES' | 'APP' | 'STORAGE' | 'EVENTS' | 'ALL';
+export type PermissionAction = 'CREATE' | 'READ' | 'UPDATE' | 'DELETE' | 'MANAGE';
+export interface Permission {
+    action: PermissionAction;
+    subject?: PermissionSubject;
+}
+export interface Project extends Base {
+    title: string;
+    description?: string;
+}
+export interface ProjectRole extends Base {
+    projectId: ObjectId;
+    name: string;
+    description?: string;
+    permissions: Permission[];
+    fixed?: boolean;
+}
+export interface ProjectWithRole {
+    project: Project;
+    role: ProjectRole | null;
+}
+/** Stripped-down user info safe for app consumption. */
+export interface ProjectDataUser {
+    _id: string;
+    fullName: string;
+    email: string;
+}
+/** A project member with their role info. */
+export interface ProjectDataMember {
+    projectUserId: string;
+    user: ProjectDataUser;
+    role: ProjectRole;
+}
+/** Minimal file info for the project data. */
+export interface ProjectDataFile {
+    _id: string;
+    name: string;
+    fileExtension?: string;
+    folderId?: string;
+    itemType: string;
+    createdAt: string;
+}
+/** Minimal folder info for the project data. */
+export interface ProjectDataFolder {
+    _id: string;
+    name: string;
+    parentId?: string;
+}
+/** Aggregated project data returned by `getProjectData()`. */
+export interface ProjectData {
+    project: Project;
+    currentUser: ProjectDataMember | null;
+    users: ProjectDataMember[];
+    roles: ProjectRole[];
+    files: ProjectDataFile[];
+    folders: ProjectDataFolder[];
+}

package/dist/types/response.d.ts

@@ -0,0 +1,10 @@
+import { Item, ItemVersion } from './items';
+
+export type CreateItemResponse<T = Item> = {
+    item: T;
+    version: ItemVersion;
+};
+export type UpdateItemResponse<T = Item> = {
+    item?: T;
+    version?: ItemVersion;
+};

package/dist/types/storage.d.ts

@@ -0,0 +1,11 @@
+import { Base, ObjectId } from './base';
+import { ItemVersion } from './items';
+
+export type StorageData = Base & {
+    name: string;
+    versions?: ItemVersion[];
+    size: number;
+    type: StorageDataType;
+    parentId?: ObjectId;
+};
+export type StorageDataType = 'folder' | 'file';

package/dist/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@thatopen/services",
+  "description": "Client library and CLI for building BIM apps and cloud components on the That Open Platform",
+  "author": "That Open Company",
+  "license": "MIT",
+  "homepage": "https://github.com/ThatOpen/engine_services#readme",
+  "bugs": {
+    "url": "https://github.com/ThatOpen/engine_services/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ThatOpen/engine_services.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "private": false,
+  "version": "0.0.1",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "thatopen": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "src/cli/templates",
+    "src/built-in",
+    "CONTEXT.md"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "lint": "eslint src/",
+    "build": "eslint src/ && tsc && vite build && vite build --config vite.config.cli.mts",
+    "build:lib": "tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "build:cli": "vite build --config vite.config.cli.mts && node scripts/copy-templates.mjs",
+    "preview": "vite preview",
+    "test:ui": "vite --config test/vite.config.mts",
+    "test:cli-build-app": "npm run build:cli && node test/setup-test-app.mjs",
+    "test:cli-serve-app": "cd temp/test-app && thatopen serve",
+    "test:cli-build-component": "npm run build:cli && node test/setup-test-component.mjs",
+    "test:cli-run-component": "cd temp/test-component && thatopen run --skip-build",
+    "test:cli-serve-component": "cd temp/test-component && thatopen local-server",
+    "test:cli-build-tests": "npm run build:cli && thatopen create-tests temp",
+    "test:cli-serve-tests": "thatopen serve-tests temp",
+    "template:bim": "cd src/cli/templates/bim && npm install && cd ../../../.. && node scripts/generate-template-tsconfig.mjs",
+    "template:bim:dev": "cd src/cli/templates/bim && npm run dev",
+    "changeset": "changeset",
+    "version": "changeset version"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.7",
+    "@thatopen/components": "~3.4.0",
+    "@thatopen/components-front": "~3.4.0",
+    "@thatopen/fragments": "~3.4.0",
+    "@thatopen/ui": "~3.4.0",
+    "@thatopen/ui-obc": "~3.4.0",
+    "@types/node": "^20.12.12",
+    "@types/three": "^0.182.0",
+    "commander": "^14.0.3",
+    "esbuild": "^0.27.3",
+    "eslint": "9.x",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^15.3.0",
+    "jszip": "^3.10.1",
+    "prettier": "^3.2.5",
+    "three": "^0.182.0",
+    "tsx": "^4.16.2",
+    "typescript": "^5.2.2",
+    "typescript-eslint": "^7.10.0",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1",
+    "vite-plugin-eslint": "^1.8.1",
+    "vitest": "^4.1.4"
+  },
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "socket.io": "^4.8.0",
+    "socket.io-client": "^4.8.0"
+  },
+  "peerDependencies": {
+    "@thatopen/components": "~3.4.0",
+    "@thatopen/ui": "~3.4.0",
+    "three": "^0.182.0"
+  },
+  "peerDependenciesMeta": {
+    "@thatopen/components": {
+      "optional": true
+    },
+    "@thatopen/ui": {
+      "optional": true
+    },
+    "three": {
+      "optional": true
+    }
+  }
+}