@thatopen/services 0.0.5 → 0.1.3

package/package.json

@@ -1,100 +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.5",
-  "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",
-    "docs",
-    "resources"
-  ],
-  "scripts": {
-    "dev": "vite",
-    "lint": "eslint src/",
-    "build": "eslint src/ && tsc && vite build && vite build --config vite.config.cli.mts && node scripts/generate-cli-docs-paths.mjs && node scripts/generate-client-examples-paths.mjs",
-    "build:lib": "tsc && vite build",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "build:cli": "vite build --config vite.config.cli.mts",
-    "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",
-    "template:app": "cd src/cli/templates/app && npm install && cd ../../../.. && node scripts/generate-template-tsconfig.mjs",
-    "template:app:dev": "cd src/cli/templates/app && npm run dev",
-    "changeset": "changeset",
-    "version": "changeset version",
-    "prepublishOnly": "npm run build"
-  },
-  "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
-    }
-  }
+{
+  "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.1.3",
+  "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",
+    "docs",
+    "resources"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "lint": "eslint src/",
+    "build": "eslint src/ && tsc && vite build && vite build --config vite.config.cli.mts && node scripts/generate-cli-docs-paths.mjs && node scripts/generate-client-examples-paths.mjs",
+    "build:lib": "tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "build:cli": "vite build --config vite.config.cli.mts",
+    "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",
+    "template:app": "cd src/cli/templates/app && npm install && cd ../../../.. && node scripts/generate-template-tsconfig.mjs",
+    "template:app:dev": "cd src/cli/templates/app && npm run dev",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "prepublishOnly": "npm run build"
+  },
+  "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
+    }
+  }
 }

package/resources/AGENTS.md

@@ -3,37 +3,39 @@
 You are an AI assistant helping a user build a **BIM app** or **cloud component** on the
 That Open Platform using **`@thatopen/services`** (the `thatopen` CLI + client library).
 
-**Read this file first.** It states the rules you must follow, then routes you to the right docs.
-Open only the doc you need — don't load everything.
+**Read this file first, then immediately load all indexes listed below before doing anything else.**
 
-> This guide is tool-agnostic: it works with any AI (Claude, Codex, your own). All docs it
+> This guide is tool-agnostic: it works with any AI (Claude, Codex, your own). All local docs it
 > references ship inside the `@thatopen/services` package under `docs/`.
 
 ---
 
-## How to work
+## Session start — load all indexes in parallel
 
-- **The scaffold is already a complete, working viewer** (model loading, spatial tree, properties).
-  **Run it first** (`npm run dev`) to see it work, *then* extend it — don't rebuild a viewer from scratch.
-- **Propose a short plan and get the user's OK** before changing files. If scope is unclear, ask.
-- Prefer existing That Open functionality over custom code (see rules 1 and 2).
+Do this before answering any question or writing any code. These are compact description indexes:
 
-## Hard rules (always apply)
+| What | Where |
+|---|---|
+| Platform built-ins | `node_modules/@thatopen/services/docs/builtin/paths.json` |
+| Platform client API | `node_modules/@thatopen/services/docs/client/paths.json` |
+| CLI commands | `node_modules/@thatopen/services/docs/cli/paths.json` |
+| Engine components (`OBC`, `OBF`) | `https://raw.githubusercontent.com/ThatOpen/engine_components/refs/heads/main/examples/paths.json` |
+| Fragments (`FRAGS`) | `https://raw.githubusercontent.com/ThatOpen/engine_fragment/refs/heads/main/examples/paths.json` |
+| UI components (`BUI`) | `https://raw.githubusercontent.com/ThatOpen/engine_ui-components/refs/heads/main/examples/paths.json` — **skip** entries whose path contains `packages/obc` or `bim-grid` |
+
+Once you have these, you know everything available on the platform. Only then fetch a specific example file when you need implementation details.
 
-1. **Check the That Open ecosystem before building anything custom.** Fetch these indexes and read the descriptions — if something already exists, use it:
-   - Engine components (`OBC`, `OBF`): `https://raw.githubusercontent.com/ThatOpen/engine_components/refs/heads/main/examples/paths.json`
-   - Fragments (`FRAGS`): `https://raw.githubusercontent.com/ThatOpen/engine_fragment/refs/heads/main/examples/paths.json`
-   - UI components (`BUI`): `https://raw.githubusercontent.com/ThatOpen/engine_ui-components/refs/heads/main/examples/paths.json`
-     — **Filter this list**: skip every entry whose path contains `packages/obc` (forbidden — those are `@thatopen/ui-obc`, not used on this platform) and skip `bim-grid` (managed exclusively by the platform). Only use entries from `packages/core`.
-2. **All UI must be built with Lit**, using the web components from `@thatopen/ui` (`BUI`) — `bim-button`, `bim-panel`, `bim-panel-section`, `bim-toolbar`, `bim-dropdown`, `bim-input`, and the rest of `packages/core`. Always consult the design system before writing any UI: `https://raw.githubusercontent.com/ThatOpen/engine_ui-components/refs/heads/main/DESIGN.md`.
-3. **Platform built-ins** come from `@thatopen/services` and are available after `client.setup()`. Check `docs/builtin/paths.json` before reinventing something the platform already provides.
+> **Path resolution:** all `path` entries inside the local indexes (`docs/`, `src/`) are relative to the `@thatopen/services` package root — prepend `node_modules/@thatopen/services/` when reading any of those files.
 
 ---
 
-## What are you doing? → open the right doc
+## How to work
+
+- **The scaffold is already a complete, working viewer** (model loading, spatial tree, properties).
+  **Run it first** (`npm run dev`) to see it work, *then* extend it — don't rebuild a viewer from scratch.
+- **Propose a short plan and get the user's OK** before changing files. If scope is unclear, ask.
+- If something already exists in the indexes, use it — don't reimplement it.
 
-### CLI commands
-For all CLI commands read `docs/cli/paths.json`.
+## Hard rules (always apply)
 
-### Platform client API
-For all platform related operations read `docs/client/paths.json`.
+1. **All UI must be built with Lit**, using the web components from `@thatopen/ui` (`BUI`) — `bim-button`, `bim-panel`, `bim-panel-section`, `bim-toolbar`, `bim-dropdown`, `bim-input`, and the rest of `packages/core`. Always consult the design system before writing any UI: `https://raw.githubusercontent.com/ThatOpen/engine_ui-components/refs/heads/main/DESIGN.md`.

package/src/built-in/AppManager/example.ts

@@ -1,86 +1,86 @@
-import * as OBC from "@thatopen/components";
-import * as BUI from "@thatopen/ui";
-import appManagerDef from "./index";
-
-// ── State types ───────────────────────────────────────────────────────
-
-type Panel1State = { label: string; components: OBC.Components };
-type Panel2State = { label: string; components: OBC.Components };
-
-// ── App type ──────────────────────────────────────────────────────────
-
-interface MyApp {
-  icons: ["LOAD", "TREE", "VIEW"];
-  grid: BUI.Grid<
-    ["Split", "Viewer"],
-    [{ name: "panel1"; state: Panel1State }, { name: "panel2"; state: Panel2State }]
-  >;
-}
-
-// ── Initialise OBC & BUI ──────────────────────────────────────────────
-
-BUI.Manager.init();
-const components = new OBC.Components();
-
-const AppManager = appManagerDef.componentDefinition;
-const app = components.get(AppManager<MyApp>);
-
-// ── Define element templates ──────────────────────────────────────────
-
-const panel1Template: BUI.StatefullComponent<Panel1State> = ({ label, components }) => {
-  const app = components.get(AppManager<MyApp>);
-  return BUI.html`
-    <bim-panel active label=${label} style="min-width: 14rem;">
-      <bim-panel-section label="Actions">
-        <bim-button icon=${app.icons.LOAD} label="Load School Model"></bim-button>
-      </bim-panel-section>
-      <bim-panel-section label="Info">
-        <bim-label>Use the sidebar to switch layouts.</bim-label>
-      </bim-panel-section>
-    </bim-panel>
-  `;
-};
-
-const panel2Template: BUI.StatefullComponent<Panel2State> = ({ label, components }) => {
-  const app = components.get(AppManager<MyApp>);
-  return BUI.html`
-    <bim-panel active label=${label} style="min-width: 14rem;">
-      <bim-panel-section label="Settings">
-        <bim-button icon=${app.icons.VIEW} label="View"></bim-button>
-      </bim-panel-section>
-    </bim-panel>
-  `;
-};
-
-// ── Init ──────────────────────────────────────────────────────────────
-
-app.init({
-  icons: {
-    LOAD: "solar:upload-bold",
-    TREE: "mdi:file-tree",
-    VIEW: "mdi:monitor",
-  },
-  grid: (grid) => {
-    grid.elements = {
-      panel1: { template: panel1Template, initialState: { label: "Models", components } },
-      panel2: { template: panel2Template, initialState: { label: "Settings", components } },
-    };
-    grid.layouts = {
-      Split: {
-        template: `
-          "panel1" 1fr
-          "panel2" 1fr
-          / 25rem 1fr`,
-        icon: app.icons.TREE,
-      },
-      Viewer: {
-        template: `"panel1" 1fr / 1fr`,
-        icon: app.icons.VIEW,
-      },
-    };
-    grid.layout = "Split";
-  },
-  container: document.getElementById("container")!,
-});
-
-app.showSidebar = true;
+import * as OBC from "@thatopen/components";
+import * as BUI from "@thatopen/ui";
+import appManagerDef from "./index";
+
+// ── State types ───────────────────────────────────────────────────────
+
+type Panel1State = { label: string; components: OBC.Components };
+type Panel2State = { label: string; components: OBC.Components };
+
+// ── App type ──────────────────────────────────────────────────────────
+
+interface MyApp {
+  icons: ["LOAD", "TREE", "VIEW"];
+  grid: BUI.Grid<
+    ["Split", "Viewer"],
+    [{ name: "panel1"; state: Panel1State }, { name: "panel2"; state: Panel2State }]
+  >;
+}
+
+// ── Initialise OBC & BUI ──────────────────────────────────────────────
+
+BUI.Manager.init();
+const components = new OBC.Components();
+
+const AppManager = appManagerDef.componentDefinition;
+const app = components.get(AppManager<MyApp>);
+
+// ── Define element templates ──────────────────────────────────────────
+
+const panel1Template: BUI.StatefullComponent<Panel1State> = ({ label, components }) => {
+  const app = components.get(AppManager<MyApp>);
+  return BUI.html`
+    <bim-panel active label=${label} style="min-width: 14rem;">
+      <bim-panel-section label="Actions">
+        <bim-button icon=${app.icons.LOAD} label="Load School Model"></bim-button>
+      </bim-panel-section>
+      <bim-panel-section label="Info">
+        <bim-label>Use the sidebar to switch layouts.</bim-label>
+      </bim-panel-section>
+    </bim-panel>
+  `;
+};
+
+const panel2Template: BUI.StatefullComponent<Panel2State> = ({ label, components }) => {
+  const app = components.get(AppManager<MyApp>);
+  return BUI.html`
+    <bim-panel active label=${label} style="min-width: 14rem;">
+      <bim-panel-section label="Settings">
+        <bim-button icon=${app.icons.VIEW} label="View"></bim-button>
+      </bim-panel-section>
+    </bim-panel>
+  `;
+};
+
+// ── Init ──────────────────────────────────────────────────────────────
+
+app.init({
+  icons: {
+    LOAD: "solar:upload-bold",
+    TREE: "mdi:file-tree",
+    VIEW: "mdi:monitor",
+  },
+  grid: (grid) => {
+    grid.elements = {
+      panel1: { template: panel1Template, initialState: { label: "Models", components } },
+      panel2: { template: panel2Template, initialState: { label: "Settings", components } },
+    };
+    grid.layouts = {
+      Split: {
+        template: `
+          "panel1" 1fr
+          "panel2" 1fr
+          / 25rem 1fr`,
+        icon: app.icons.TREE,
+      },
+      Viewer: {
+        template: `"panel1" 1fr / 1fr`,
+        icon: app.icons.VIEW,
+      },
+    };
+    grid.layout = "Split";
+  },
+  container: document.getElementById("container")!,
+});
+
+app.showSidebar = true;