@thatopen/services 0.1.3 → 0.3.0

package/src/cli/templates/cloud-component/src/main.ts

@@ -1,70 +1,70 @@
-// Cloud Component Entry Point
-//
-// Your component runs on the server as a Node.js process.
-// The execution engine provides these globals — do NOT import them:
-//
-//   thatOpenServices  — pre-authenticated EngineServicesClient
-//   executionParams   — parameters passed by the caller (shape defined in ../declarations.json)
-//   executionContext  — platform-supplied run context: { projectId?, executionId, toolId, toolVersion }
-//                       Use executionContext.projectId to scope uploads/lookups to the launching project.
-//                       Undefined when the component is run outside a project context.
-//   executionReporter — { message(msg), error(msg), progress(pct) } for live feedback
-//
-// Parameters are declared in `declarations.json` at the project root. That
-// file is bundled alongside this code at publish time so the platform (and
-// the CLI's `thatopen run`) knows which parameters the component accepts
-// and their types. Whenever you add, remove, or rename a parameter in this
-// file you MUST update `declarations.json` to match — `thatopen publish`
-// fails if they drift.
-//
-// Return value — must be { type, message }:
-//   type: "SUCCESS" | "FAIL" | "WARNING"
-
-// Globals injected by the execution engine at runtime — keep these for type checking
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-declare const thatOpenServices: import("@thatopen/services").EngineServicesClient;
-declare const executionParams: Record<string, unknown>;
-declare const executionContext: {
-  projectId?: string;
-  executionId: string;
-  toolId: string;
-  toolVersion: string;
-};
-declare const executionReporter: {
-  message(msg: string): void;
-  error(msg: string): void;
-  progress(pct: number): void;
-};
-
-export async function main() {
-  const projectName = executionParams.projectName as string | undefined;
-  const iterations = Number(executionParams.iterations);
-
-  executionReporter.message(
-    `Starting for "${projectName ?? "(unnamed)"}"`,
-  );
-  executionReporter.message(`Will run ${iterations} iteration(s)`);
-  if (executionContext?.projectId) {
-    executionReporter.message(`Scoped to project ${executionContext.projectId}`);
-  }
-
-  if (!projectName) {
-    return { type: "FAIL", message: "projectName parameter is required" };
-  }
-  if (!Number.isFinite(iterations) || iterations <= 0) {
-    return { type: "FAIL", message: "iterations must be a positive number" };
-  }
-
-  for (let i = 1; i <= iterations; i++) {
-    executionReporter.message(`Iteration ${i} of ${iterations}`);
-    executionReporter.progress(Math.round((i / iterations) * 100));
-    await new Promise((resolve) => setTimeout(resolve, 500));
-  }
-
-  executionReporter.message("All iterations completed");
-
-  return {
-    type: "SUCCESS",
-    message: `Processed "${projectName}" across ${iterations} iteration(s)`,
-  };
-}
+// Cloud Component Entry Point
+//
+// Your component runs on the server as a Node.js process.
+// The execution engine provides these globals — do NOT import them:
+//
+//   thatOpenServices  — pre-authenticated EngineServicesClient
+//   executionParams   — parameters passed by the caller (shape defined in ../declarations.json)
+//   executionContext  — platform-supplied run context: { projectId?, executionId, toolId, toolVersion }
+//                       Use executionContext.projectId to scope uploads/lookups to the launching project.
+//                       Undefined when the component is run outside a project context.
+//   executionReporter — { message(msg), error(msg), progress(pct) } for live feedback
+//
+// Parameters are declared in `declarations.json` at the project root. That
+// file is bundled alongside this code at publish time so the platform (and
+// the CLI's `thatopen run`) knows which parameters the component accepts
+// and their types. Whenever you add, remove, or rename a parameter in this
+// file you MUST update `declarations.json` to match — `thatopen publish`
+// fails if they drift.
+//
+// Return value — must be { type, message }:
+//   type: "SUCCESS" | "FAIL" | "WARNING"
+
+// Globals injected by the execution engine at runtime — keep these for type checking
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+declare const thatOpenServices: import("@thatopen/services").EngineServicesClient;
+declare const executionParams: Record<string, unknown>;
+declare const executionContext: {
+  projectId?: string;
+  executionId: string;
+  toolId: string;
+  toolVersion: string;
+};
+declare const executionReporter: {
+  message(msg: string): void;
+  error(msg: string): void;
+  progress(pct: number): void;
+};
+
+export async function main() {
+  const projectName = executionParams.projectName as string | undefined;
+  const iterations = Number(executionParams.iterations);
+
+  executionReporter.message(
+    `Starting for "${projectName ?? "(unnamed)"}"`,
+  );
+  executionReporter.message(`Will run ${iterations} iteration(s)`);
+  if (executionContext?.projectId) {
+    executionReporter.message(`Scoped to project ${executionContext.projectId}`);
+  }
+
+  if (!projectName) {
+    return { type: "FAIL", message: "projectName parameter is required" };
+  }
+  if (!Number.isFinite(iterations) || iterations <= 0) {
+    return { type: "FAIL", message: "iterations must be a positive number" };
+  }
+
+  for (let i = 1; i <= iterations; i++) {
+    executionReporter.message(`Iteration ${i} of ${iterations}`);
+    executionReporter.progress(Math.round((i / iterations) * 100));
+    await new Promise((resolve) => setTimeout(resolve, 500));
+  }
+
+  executionReporter.message("All iterations completed");
+
+  return {
+    type: "SUCCESS",
+    message: `Processed "${projectName}" across ${iterations} iteration(s)`,
+  };
+}

package/src/cli/templates/cloud-component/tsconfig.json

@@ -1,16 +1,16 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "lib": ["ES2020"],
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "strict": true
-  },
-  "include": ["src"]
-}
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "strict": true
+  },
+  "include": ["src"]
+}

package/src/cli/templates/cloud-component/vite.config.js

@@ -1,46 +1,46 @@
-// Production build config — builds dist/bundle.js as IIFE.
-// For local development, use: npm run dev (runs thatopen serve with esbuild).
-// Do NOT run "vite" or "vite build --watch" directly for dev.
-import { defineConfig } from 'vite';
-import { resolve } from 'path';
-import { existsSync, readFileSync } from 'fs';
-
-function getBetaAliases() {
-  if (!existsSync('.thatopen')) return {};
-  try {
-    const config = JSON.parse(readFileSync('.thatopen', 'utf-8'));
-    if (!config.beta) return {};
-    return {
-      '@thatopen/components': '@thatopen-platform/components-beta',
-      '@thatopen/components-front': '@thatopen-platform/components-front-beta',
-      '@thatopen/fragments': '@thatopen-platform/fragments-beta',
-    };
-  } catch {
-    return {};
-  }
-}
-
-export default defineConfig({
-  resolve: {
-    alias: getBetaAliases(),
-  },
-  build: {
-    lib: {
-      entry: resolve(__dirname, 'src/main.ts'),
-      name: 'ThatOpenComponent',
-      formats: ['iife'],
-      fileName: () => 'bundle.js',
-    },
-    outDir: 'dist',
-    rollupOptions: {
-      // Only @thatopen/services is externalized — the execution wrapper
-      // provides it at runtime via require('@thatopen/services'). Every
-      // other dependency (including @thatopen/components, three, web-ifc,
-      // or any npm package you install) must be bundled into bundle.js.
-      external: ['@thatopen/services'],
-      output: {
-        footer: 'var main = ThatOpenComponent.main;',
-      },
-    },
-  },
-});
+// Production build config — builds dist/bundle.js as IIFE.
+// For local development, use: npm run dev (runs thatopen serve with esbuild).
+// Do NOT run "vite" or "vite build --watch" directly for dev.
+import { defineConfig } from 'vite';
+import { resolve } from 'path';
+import { existsSync, readFileSync } from 'fs';
+
+function getBetaAliases() {
+  if (!existsSync('.thatopen')) return {};
+  try {
+    const config = JSON.parse(readFileSync('.thatopen', 'utf-8'));
+    if (!config.beta) return {};
+    return {
+      '@thatopen/components': '@thatopen-platform/components-beta',
+      '@thatopen/components-front': '@thatopen-platform/components-front-beta',
+      '@thatopen/fragments': '@thatopen-platform/fragments-beta',
+    };
+  } catch {
+    return {};
+  }
+}
+
+export default defineConfig({
+  resolve: {
+    alias: getBetaAliases(),
+  },
+  build: {
+    lib: {
+      entry: resolve(__dirname, 'src/main.ts'),
+      name: 'ThatOpenComponent',
+      formats: ['iife'],
+      fileName: () => 'bundle.js',
+    },
+    outDir: 'dist',
+    rollupOptions: {
+      // Only @thatopen/services is externalized — the execution wrapper
+      // provides it at runtime via require('@thatopen/services'). Every
+      // other dependency (including @thatopen/components, three, web-ifc,
+      // or any npm package you install) must be bundled into bundle.js.
+      external: ['@thatopen/services'],
+      output: {
+        footer: 'var main = ThatOpenComponent.main;',
+      },
+    },
+  },
+});

package/src/cli/templates/shared/AGENTS.md

@@ -1,8 +1,8 @@
-# That Open Platform — Agent Guide
-
-Read these two files before doing anything else:
-
-1. `node_modules/@thatopen/services/resources/AGENTS.md` — rules, hard constraints, and the full navigation table for the That Open Platform. Always current for the installed library version.
-2. `README.md` (this folder) — what this specific project is, its commands, architecture, and patterns.
-
-If `node_modules/` doesn't exist yet, run `npm install` first or ask the user to do it.
+# That Open Platform — Agent Guide
+
+Read these two files before doing anything else:
+
+1. `node_modules/@thatopen/services/resources/AGENTS.md` — rules, hard constraints, and the full navigation table for the That Open Platform. Always current for the installed library version.
+2. `README.md` (this folder) — what this specific project is, its commands, architecture, and patterns.
+
+If `node_modules/` doesn't exist yet, run `npm install` first or ask the user to do it.

package/src/cli/templates/shared/CLAUDE.md

@@ -1 +1 @@
-See [AGENTS.md](./AGENTS.md).
+See [AGENTS.md](./AGENTS.md).

package/src/cli/templates/shared/_gitignore

@@ -1,4 +1,5 @@
-node_modules
-dist
-*.zip
-.thatopen
+node_modules
+dist
+*.zip
+.thatopen
+.npmrc

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

@@ -1,86 +0,0 @@
-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;

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

@@ -1,107 +0,0 @@
-import * as OBC from "@thatopen/components";
-import * as BUI from "@thatopen/ui";
-import type { EngineServicesClient, Item } from "thatopen-services";
-
-import appManagerDef from "../AppManager/index";
-import fileListDef from "./index";
-
-const AppManager = appManagerDef.componentDefinition;
-const FileList = fileListDef.componentDefinition;
-
-// ── A tiny in-memory fake client for the example ──────────────────────
-// Real apps should pass their `EngineServicesClient` instance here — this
-// stub just implements the subset of the API the FileList component uses.
-
-let nextId = 1;
-const mkFile = (name: string, ext?: string): Item => ({
-  _id: `file-${nextId++}`,
-  name,
-  fileExtension: ext,
-  itemType: "FILE",
-  internalId: `internal-${nextId}`,
-  createdAt: new Date(),
-  creatingUser: "demo-user",
-});
-
-const files: Item[] = [
-  mkFile("site-plan", "pdf"),
-  mkFile("structural-model", "ifc"),
-  mkFile("mep-coordination", "ifc"),
-  mkFile("bcf-issues", "bcf"),
-];
-
-const fakeClient = {
-  async listFiles() {
-    // Small delay to show the loading state.
-    await new Promise((r) => setTimeout(r, 150));
-    return files.filter((f) => !f.archived);
-  },
-  async downloadFile(id: string) {
-    const file = files.find((f) => f._id === id)!;
-    const body = `Pretend contents of ${file.name}`;
-    return new Response(body, { headers: { "Content-Type": "text/plain" } });
-  },
-  async updateFile(id: string, data: { name?: string }) {
-    const file = files.find((f) => f._id === id)!;
-    if (data.name) file.name = data.name;
-    return { item: file };
-  },
-  async archiveFile(id: string) {
-    const file = files.find((f) => f._id === id)!;
-    file.archived = true;
-    return file;
-  },
-} as unknown as EngineServicesClient;
-
-// ── App type ──────────────────────────────────────────────────────────
-
-type FilesState = { components: OBC.Components };
-
-interface FileListApp {
-  icons: ["FILES"];
-  grid: BUI.Grid<
-    ["Files"],
-    [{ name: "files"; state: FilesState }]
-  >;
-}
-
-// ── Initialise OBC & BUI ──────────────────────────────────────────────
-
-BUI.Manager.init();
-const components = new OBC.Components();
-
-const app = components.get(AppManager<FileListApp>);
-const fileList = components.get(FileList);
-
-// ── Create a file list instance ───────────────────────────────────────
-
-const { element: fileListElement } = fileList.create({ client: fakeClient });
-
-const filesPanel: BUI.StatefullComponent<FilesState> = (_state) => BUI.html`
-  <bim-panel active label="Files" style="display: flex; flex-direction: column;">
-    <bim-panel-section label="Project files" style="flex: 1; min-height: 0;">
-      ${fileListElement}
-    </bim-panel-section>
-  </bim-panel>
-`;
-
-// ── Init ──────────────────────────────────────────────────────────────
-
-app.init({
-  icons: { FILES: "mdi:file-multiple" },
-  grid: (grid) => {
-    grid.elements = {
-      files: { template: filesPanel, initialState: { components } },
-    };
-    grid.layouts = {
-      Files: {
-        template: `"files" 1fr / 1fr`,
-        icon: app.icons.FILES,
-      },
-    };
-    grid.layout = "Files";
-  },
-  container: document.getElementById("container")!,
-});
-
-components.init();

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

@@ -1,115 +0,0 @@
-import * as OBC from "@thatopen/components";
-import * as BUI from "@thatopen/ui";
-
-import appManagerDef from "../AppManager/index";
-import tabbedNavDef from "./index";
-
-const AppManager = appManagerDef.componentDefinition;
-const TabbedNavigation = tabbedNavDef.componentDefinition;
-
-// ── App type ──────────────────────────────────────────────────────────
-
-type PanelState = { label: string };
-
-interface NavApp {
-  icons: ["DASHBOARD", "FILES", "SETTINGS"];
-  grid: BUI.Grid<
-    ["Dashboard", "Files", "Settings"],
-    [
-      { name: "tabs"; state: null },
-      { name: "dashboard"; state: PanelState },
-      { name: "files"; state: PanelState },
-      { name: "settings"; state: PanelState }
-    ]
-  >;
-}
-
-// ── Initialise OBC & BUI ──────────────────────────────────────────────
-
-BUI.Manager.init();
-const components = new OBC.Components();
-
-const app = components.get(AppManager<NavApp>);
-const tabs = components.get(TabbedNavigation);
-
-// ── Templates ─────────────────────────────────────────────────────────
-
-const makePanel = (): BUI.StatefullComponent<PanelState> =>
-  ({ label }) => BUI.html`
-    <bim-panel active label=${label}>
-      <bim-panel-section label="Content">
-        <bim-label>Current screen: ${label}</bim-label>
-      </bim-panel-section>
-    </bim-panel>
-  `;
-
-// The grid caches elements by template-function identity, so each tab area
-// needs its own function reference — otherwise the grid reuses the same
-// panel element across layouts.
-const dashboardPanel = makePanel();
-const filesPanel = makePanel();
-const settingsPanel = makePanel();
-
-// We'll fill the tabs element after init.
-let tabsElement: HTMLElement | null = null;
-
-// ── Init ──────────────────────────────────────────────────────────────
-
-app.init({
-  icons: {
-    DASHBOARD: "mdi:view-dashboard",
-    FILES: "mdi:file-multiple",
-    SETTINGS: "mdi:cog",
-  },
-  grid: (grid) => {
-    grid.elements = {
-      tabs: (() => {
-        // Lazy placeholder — TabbedNavigation attaches here after app.init().
-        const slot = document.createElement("div");
-        slot.style.cssText = "display: flex; padding: 0.5rem;";
-        tabsElement = slot;
-        return slot;
-      })(),
-      dashboard: { template: dashboardPanel, initialState: { label: "Dashboard" } },
-      files: { template: filesPanel, initialState: { label: "Files" } },
-      settings: { template: settingsPanel, initialState: { label: "Settings" } },
-    };
-    grid.layouts = {
-      Dashboard: {
-        template: `
-          "tabs" auto
-          "dashboard" 1fr
-          / 1fr
-        `,
-        icon: app.icons.DASHBOARD,
-      },
-      Files: {
-        template: `
-          "tabs" auto
-          "files" 1fr
-          / 1fr
-        `,
-        icon: app.icons.FILES,
-      },
-      Settings: {
-        template: `
-          "tabs" auto
-          "settings" 1fr
-          / 1fr
-        `,
-        icon: app.icons.SETTINGS,
-      },
-    };
-    grid.layout = "Dashboard";
-  },
-  container: document.getElementById("container")!,
-});
-
-// Create the tab bar now that the grid exists.
-const { element: tabBar } = tabs.create();
-tabsElement?.appendChild(tabBar);
-
-// Hide the default sidebar — tabs replace it.
-app.showSidebar = false;
-
-components.init();