@thatopen/services 0.0.1 → 0.0.3

package/src/cli/templates/bim-beta/src/bim-components/CloudRunner/index.ts

@@ -0,0 +1,91 @@
+import * as OBC from "@thatopen-platform/components-beta";
+import { AppManager } from "@thatopen/services";
+import { CloudRunnerStatus } from "./src";
+
+export class CloudRunner extends OBC.Component {
+  static readonly uuid = "7c4e5d3b-2a1f-4e8d-9b6c-0a3f7e2c5d1b" as const;
+
+  enabled = true;
+
+  readonly onExecutionUpdated = new OBC.Event<CloudRunnerStatus>();
+
+  // TODO: Replace with your actual component ID after publishing.
+  componentId = "your-component-id";
+  localServerUrl = "http://localhost:4001";
+
+  // Reactive state — read by the UI template on each render.
+  status = "Idle";
+  progress = 0;
+  messages: string[] = [];
+
+  constructor(components: OBC.Components) {
+    super(components);
+    components.add(CloudRunner.uuid, this);
+  }
+
+  async run(useLocal: boolean) {
+    // Resolve client at call time via AppManager — never store it as a field.
+    const app = this.components.get(AppManager);
+    const client = app.client;
+
+    client.localServerUrl = useLocal ? this.localServerUrl : null;
+
+    this.status = useLocal ? "Starting (local)..." : "Starting (deployed)...";
+    this.progress = 0;
+    this.messages = [];
+    this._trigger();
+
+    try {
+      const { executionId } = await client.executeComponent(this.componentId, {
+        greeting: "Hello from the BIM app!",
+      });
+
+      this.status = `Running (${executionId.slice(0, 8)}...)`;
+      this._trigger();
+
+      // Subscribe to real-time progress updates via WebSocket.
+      client.onExecutionProgress(executionId, (data) => {
+        if (data.progressUpdate) {
+          this.progress = data.progressUpdate.progress;
+          if (data.progressUpdate.result) {
+            this.status = `${data.progressUpdate.result}: ${data.progressUpdate.resultMessage ?? "Done"}`;
+          }
+        }
+        if (data.messageUpdate) {
+          this.messages.push(data.messageUpdate.content);
+        }
+        this._trigger();
+      });
+
+      // Poll once after a short delay to catch fast executions that complete
+      // before the WebSocket subscription is established.
+      setTimeout(async () => {
+        try {
+          const exec = await client.getExecution(executionId);
+          if (exec.result) {
+            this.progress = exec.progress;
+            this.status = `${exec.result}: ${exec.resultMessage ?? "Done"}`;
+            this._trigger();
+          }
+        } catch {
+          /* WebSocket handles it */
+        }
+      }, 2000);
+    } catch (err) {
+      this.status = `Error: ${err}`;
+      this._trigger();
+    } finally {
+      client.localServerUrl = null;
+    }
+  }
+
+  private _trigger() {
+    this.onExecutionUpdated.trigger({
+      status: this.status,
+      progress: this.progress,
+      messages: [...this.messages],
+    });
+  }
+}
+
+export * from "./src";

package/src/cli/templates/bim-beta/src/bim-components/CloudRunner/src/index.ts

@@ -0,0 +1 @@
+export * from "./types";

package/src/cli/templates/bim-beta/src/bim-components/CloudRunner/src/types.ts

@@ -0,0 +1,5 @@
+export interface CloudRunnerStatus {
+  status: string;
+  progress: number;
+  messages: string[];
+}

package/src/cli/templates/bim-beta/src/bim-components/index.ts

@@ -0,0 +1 @@
+export * from "./CloudRunner";

package/src/cli/templates/bim-beta/src/globals.ts

@@ -0,0 +1 @@
+export const icons = {};

package/src/cli/templates/bim-beta/src/main.ts

@@ -0,0 +1,89 @@
+import * as THREE from "three";
+import * as OBC from "@thatopen-platform/components-beta";
+import * as OBF from "@thatopen-platform/components-front-beta";
+import * as FRAGS from "@thatopen-platform/fragments-beta";
+import * as BUI from "@thatopen/ui";
+import * as MARKERJS from "@markerjs/markerjs3"
+import {
+  PlatformClient,
+  AppManager,
+  ViewportsManager,
+  UIManager,
+} from "@thatopen/services";
+
+import { getAppManager } from "./app";
+import { uiManager, cloudRunner, viewportsManager, getUIManager } from "./setups";
+
+// Wrap in async function since IIFE format does not support top-level await.
+async function main() {
+  // ─── Platform Client ──────────────────────────────────────────
+  // Reads auth context from window.__THATOPEN_CONTEXT__ (injected by the
+  // platform) and creates a client with Bearer auth.
+  const client = PlatformClient.fromPlatformContext();
+
+  // ─── Built-in Components ──────────────────────────────────────
+  // First argument: library globals used by the engine.
+  // Subsequent arguments: platform built-in components to initialise.
+  const { components } = await client.setup<OBC.Components>(
+    { OBC, OBF, BUI, THREE, FRAGS, MARKERJS },
+    { uuid: ViewportsManager.uuid },
+    { uuid: AppManager.uuid },
+    { uuid: UIManager.uuid },
+  );
+
+  // ─── Viewport ─────────────────────────────────────────────────
+  // Must run before app.init() so the element is ready for the grid.
+  const viewerElement = await viewportsManager(components);
+
+  // ─── App Init ─────────────────────────────────────────────────
+  const app = getAppManager(components);
+
+  await app.init({
+    client,
+    icons: [],
+    componentSetups: {
+      // core: runs in parallel before the grid mounts.
+      core: [uiManager, cloudRunner],
+    },
+    grid: (grid) => {
+      const uis = getUIManager(components);
+
+      grid.elements = {
+        viewer: viewerElement,
+        appInfoSection: {
+          template: uis.custom.get("appInfoSection").template,
+          initialState: { components },
+          label: "App Info",
+          icon: "solar:info-circle-bold",
+        },
+        cloudRunnerSection: {
+          template: uis.custom.get("cloudRunnerSection").template,
+          initialState: { components },
+          label: "Cloud Component",
+          icon: "solar:code-bold",
+        },
+      };
+
+      grid.layouts = {
+        Viewer: {
+          template: `"viewer" 1fr / 1fr`,
+        },
+        Split: {
+          template: `
+            "tabs:left(appInfoSection, cloudRunnerSection) viewer" 1fr
+            / 24rem 1fr
+          `,
+          icon: "solar:info-circle-bold",
+        },
+      };
+
+      grid.areaGroups = {
+        left: { switchersFull: true },
+      };
+
+      grid.layout = "Split";
+    },
+  });
+}
+
+main().catch(console.error);

package/src/cli/templates/bim-beta/src/setups/cloud-runner.ts

@@ -0,0 +1,13 @@
+import * as OBC from "@thatopen-platform/components-beta";
+import { CloudRunner } from "../bim-components";
+import { getUIManager } from "./ui-manager";
+
+export const cloudRunner = (components: OBC.Components) => {
+  const runner = components.get(CloudRunner);
+  const uis = getUIManager(components);
+
+  // Re-render all appInfoSection instances whenever execution state changes.
+  runner.onExecutionUpdated.add(() => {
+    uis.custom.get("cloudRunnerSection").updateInstances();
+  });
+};

package/src/cli/templates/bim-beta/src/setups/index.ts

@@ -0,0 +1,3 @@
+export * from "./ui-manager";
+export * from "./viewports-manager";
+export * from "./cloud-runner";

package/src/cli/templates/bim-beta/src/setups/ui-manager.ts

@@ -0,0 +1,27 @@
+import * as OBC from "@thatopen-platform/components-beta";
+import * as BUI from "@thatopen/ui";
+import { UIManager } from "@thatopen/services";
+import {
+  appInfoSectionTemplate,
+  AppInfoSectionState,
+  cloudRunnerSectionTemplate,
+  CloudRunnerSectionState,
+} from "../ui-components";
+
+export type CustomUIs = {
+  appInfoSection: { type: BUI.PanelSection; state: AppInfoSectionState };
+  cloudRunnerSection: { type: BUI.PanelSection; state: CloudRunnerSectionState };
+};
+
+export const getUIManager = (components: OBC.Components) =>
+  components.get(UIManager<CustomUIs>);
+
+export const uiManager = (components: OBC.Components) => {
+  const uis = getUIManager(components);
+  uis.registerTemplate("appInfoSection", {
+    template: appInfoSectionTemplate,
+  });
+  uis.registerTemplate("cloudRunnerSection", {
+    template: cloudRunnerSectionTemplate,
+  });
+};

package/src/cli/templates/bim-beta/src/setups/viewports-manager.ts

@@ -0,0 +1,22 @@
+import * as OBC from "@thatopen-platform/components-beta";
+import { ViewportsManager } from "@thatopen/services";
+
+export const viewportsManager = async (components: OBC.Components) => {
+  const viewports = components.get(ViewportsManager);
+  const { element, world } = await viewports.create();
+
+  // Load a sample model. Replace with client.downloadFile(fileId) to load
+  // a model from the platform:
+  //   const response = await client.downloadFile(fileId);
+  //   const buffer = await response.arrayBuffer();
+  const fragments = components.get(OBC.FragmentsManager);
+  const file = await fetch(
+    "https://thatopen.github.io/engine_components/resources/frags/school_arq.frag",
+  );
+  const buffer = await file.arrayBuffer();
+  await fragments.core.load(buffer, { modelId: "school_arq" });
+  await world.camera.controls.setLookAt(68, 23, -8.5, 21.5, -5.5, 23);
+  await fragments.core.update(true);
+
+  return element;
+};

package/src/cli/templates/bim-beta/src/ui-components/app-info-section/index.ts

@@ -0,0 +1,26 @@
+import * as BUI from "@thatopen/ui";
+import { AppInfoSectionComponent } from "./src";
+import { getAppManager } from "../../app";
+
+export const appInfoSectionTemplate: AppInfoSectionComponent = ({
+  components,
+}) => {
+  const app = getAppManager(components);
+
+  const fileItems =
+    app.projectData?.files.map(
+      (f: { name: string }) => BUI.html`<bim-label>${f.name}</bim-label>`,
+    ) ?? [];
+
+  return BUI.html`
+    <bim-panel-section label="App Info" icon="solar:info-circle-bold">
+      <bim-label>App ID: ${app.client?.context.appId}</bim-label>
+      <bim-label>Project ID: ${app.client?.context.projectId}</bim-label>
+      <bim-label>API URL: ${app.client?.context.apiUrl}</bim-label>
+      <bim-label>Files: ${fileItems.length}</bim-label>
+      ${fileItems}
+    </bim-panel-section>
+  `;
+};
+
+export * from "./src";

package/src/cli/templates/bim-beta/src/ui-components/app-info-section/src/index.ts

@@ -0,0 +1 @@
+export * from "./types";

package/src/cli/templates/bim-beta/src/ui-components/app-info-section/src/types.ts

@@ -0,0 +1,15 @@
+import * as BUI from "@thatopen/ui";
+import * as OBC from "@thatopen-platform/components-beta";
+
+export interface AppInfoSectionState {
+  components: OBC.Components;
+}
+
+export type AppInfoSectionComponent =
+  BUI.StatefullComponent<AppInfoSectionState>;
+
+// Used in App type (app.ts) to type this element slot in the grid.
+export type AppInfoSectionGridElement = {
+  name: "appInfoSection";
+  state: AppInfoSectionState;
+};

package/src/cli/templates/bim-beta/src/ui-components/cloud-runner-section/index.ts

@@ -0,0 +1,37 @@
+import * as BUI from "@thatopen/ui";
+import { CloudRunner } from "../../bim-components";
+import { CloudRunnerSectionComponent } from "./src";
+
+export const cloudRunnerSectionTemplate: CloudRunnerSectionComponent = ({
+  components,
+}) => {
+  const runner = components.get(CloudRunner);
+
+  const messageItems = runner.messages.map(
+    (m) => BUI.html`<bim-label>${m}</bim-label>`,
+  );
+
+  return BUI.html`
+    <bim-panel-section label="Cloud Component" icon="solar:code-bold">
+      <bim-label>Component ID: ${runner.componentId}</bim-label>
+      <bim-label>Local server: ${runner.localServerUrl}</bim-label>
+      <div style="display:flex;gap:0.5rem;">
+        <bim-button
+          label="Run Local"
+          icon="solar:play-bold"
+          @click=${() => runner.run(true)}
+        ></bim-button>
+        <bim-button
+          label="Run Deployed"
+          icon="solar:cloud-bold-duotone"
+          @click=${() => runner.run(false)}
+        ></bim-button>
+      </div>
+      <bim-label>${runner.status}</bim-label>
+      <bim-label>Progress: ${runner.progress}%</bim-label>
+      ${messageItems}
+    </bim-panel-section>
+  `;
+};
+
+export * from "./src";

package/src/cli/templates/bim-beta/src/ui-components/cloud-runner-section/src/index.ts

@@ -0,0 +1 @@
+export * from "./types";

package/src/cli/templates/bim-beta/src/ui-components/cloud-runner-section/src/types.ts

@@ -0,0 +1,14 @@
+import * as OBC from "@thatopen-platform/components-beta";
+import * as BUI from "@thatopen/ui";
+
+export interface CloudRunnerSectionState {
+  components: OBC.Components;
+}
+
+export type CloudRunnerSectionComponent =
+  BUI.StatefullComponent<CloudRunnerSectionState>;
+
+export type CloudRunnerSectionGridElement = {
+  name: "cloudRunnerSection";
+  state: CloudRunnerSectionState;
+};

package/src/cli/templates/bim-beta/src/ui-components/index.ts

@@ -0,0 +1,2 @@
+export * from "./app-info-section";
+export * from "./cloud-runner-section";