@thatopen/services 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +86 -0
- package/CONTEXT.md +4 -4
- package/README.md +4 -4
- package/dist/cli.js +17 -6
- package/dist/core/client.d.ts +1 -1
- package/docs/access-backend-data.md +19 -0
- package/docs/app-architecture.md +94 -0
- package/docs/app-layout.md +139 -0
- package/docs/app-wiring.md +123 -0
- package/docs/bim-components/coding-conventions.md +128 -0
- package/docs/bim-components/element-collections.md +69 -0
- package/docs/bim-components/expose-events.md +84 -0
- package/docs/bim-components/library-examples.md +28 -0
- package/docs/bim-components/observable-collections.md +83 -0
- package/docs/bim-components/overview.md +160 -0
- package/docs/bim-components/per-frame-updates.md +20 -0
- package/docs/bim-components/save-and-restore-state.md +21 -0
- package/docs/bim-components/setup-and-cleanup.md +64 -0
- package/docs/bim-components/type-conventions.md +49 -0
- package/docs/bim-components/user-driven-object-creation.md +56 -0
- package/docs/cli-setup.md +54 -0
- package/docs/cloud-components.md +74 -0
- package/docs/connect-logic-to-ui.md +113 -0
- package/docs/previewing.md +45 -0
- package/docs/publishing.md +35 -0
- package/docs/scaffolding.md +71 -0
- package/docs/ui-components/async-actions.md +18 -0
- package/docs/ui-components/confirmation-dialog.md +39 -0
- package/docs/ui-components/data-table.md +185 -0
- package/docs/ui-components/display-text.md +39 -0
- package/docs/ui-components/inline-form.md +44 -0
- package/docs/ui-components/library-examples.md +24 -0
- package/docs/ui-components/overview.md +194 -0
- package/docs/ui-components/rendering-patterns.md +129 -0
- package/docs/ui-components/sections-layout.md +123 -0
- package/docs/update-grid-elements.md +46 -0
- package/docs/using-colors.md +32 -0
- package/docs/using-icons.md +37 -0
- package/package.json +4 -2
- package/src/cli/templates/bim/CONTEXT.md +4 -7
- package/src/cli/templates/bim/package.json +1 -2
- package/src/cli/templates/bim/src/app.ts +1 -1
- package/src/cli/templates/bim/src/bim-components/CloudRunner/index.ts +1 -1
- package/src/cli/templates/bim/src/main.ts +2 -3
- package/src/cli/templates/bim/src/setups/ui-manager.ts +1 -1
- package/src/cli/templates/bim/src/setups/viewports-manager.ts +1 -1
- package/src/cli/templates/bim-beta/CONTEXT.md +241 -0
- package/src/cli/templates/bim-beta/package.json +25 -0
- package/src/cli/templates/bim-beta/src/app.ts +16 -0
- package/src/cli/templates/bim-beta/src/bim-components/CloudRunner/index.ts +91 -0
- package/src/cli/templates/bim-beta/src/bim-components/CloudRunner/src/index.ts +1 -0
- package/src/cli/templates/bim-beta/src/bim-components/CloudRunner/src/types.ts +5 -0
- package/src/cli/templates/bim-beta/src/bim-components/index.ts +1 -0
- package/src/cli/templates/bim-beta/src/globals.ts +1 -0
- package/src/cli/templates/bim-beta/src/main.ts +89 -0
- package/src/cli/templates/bim-beta/src/setups/cloud-runner.ts +13 -0
- package/src/cli/templates/bim-beta/src/setups/index.ts +3 -0
- package/src/cli/templates/bim-beta/src/setups/ui-manager.ts +27 -0
- package/src/cli/templates/bim-beta/src/setups/viewports-manager.ts +22 -0
- package/src/cli/templates/bim-beta/src/ui-components/app-info-section/index.ts +26 -0
- package/src/cli/templates/bim-beta/src/ui-components/app-info-section/src/index.ts +1 -0
- package/src/cli/templates/bim-beta/src/ui-components/app-info-section/src/types.ts +15 -0
- package/src/cli/templates/bim-beta/src/ui-components/cloud-runner-section/index.ts +37 -0
- package/src/cli/templates/bim-beta/src/ui-components/cloud-runner-section/src/index.ts +1 -0
- package/src/cli/templates/bim-beta/src/ui-components/cloud-runner-section/src/types.ts +14 -0
- package/src/cli/templates/bim-beta/src/ui-components/index.ts +2 -0
- package/src/cli/templates/cloud/CONTEXT.md +205 -205
- package/src/cli/templates/cloud/package.json +1 -1
- package/src/cli/templates/cloud/src/main.ts +70 -70
- package/src/cli/templates/cloud-test/package.json +1 -1
- package/src/cli/templates/cloud-test/src/main.ts +1 -1
- package/src/cli/templates/default/CONTEXT.md +4 -4
- package/src/cli/templates/default/package.json +3 -0
- package/src/cli/templates/default/src/main.ts +3 -3
- package/src/cli/templates/shared/AGENTS.md +30 -0
- package/src/cli/templates/shared/CLAUDE.md +1 -0
- package/src/cli/templates/shared/cloud/vite.config.js +3 -3
- package/src/cli/templates/test/package.json +1 -1
- package/src/cli/templates/test/src/main.ts +2 -2
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Working on this That Open Platform project — Agent Guide
|
|
2
|
+
|
|
3
|
+
You're an AI assistant helping build/extend this project (a BIM app or cloud component) on the
|
|
4
|
+
That Open Platform. Read this first.
|
|
5
|
+
|
|
6
|
+
## Rules (always apply)
|
|
7
|
+
1. **All business logic lives in a BIM component** (`src/bim-components/`). `setups/` only wire;
|
|
8
|
+
`ui-components/` only render; `main.ts` only boots. New logic → a new (or existing) component.
|
|
9
|
+
2. **Check engine components first** — `@thatopen/components` (`OBC`) / `@thatopen/components-front`
|
|
10
|
+
(`OBF`) — before building anything custom.
|
|
11
|
+
3. **Propose a short plan and get the user's OK** before changing files.
|
|
12
|
+
|
|
13
|
+
## Where the full build guides live
|
|
14
|
+
The complete, up-to-date guides ship with the library. Read them from the installed package:
|
|
15
|
+
- `node_modules/@thatopen/services/AGENTS.md` — the router; **start here**
|
|
16
|
+
- `node_modules/@thatopen/services/docs/` — detailed guides (app wiring, layout, connecting logic
|
|
17
|
+
to UI, building BIM/UI components, cloud components, publishing, icons, colors, …)
|
|
18
|
+
- `node_modules/@thatopen/services/CONTEXT.md` — library API reference (`PlatformClient` vs
|
|
19
|
+
`EngineServicesClient`, permissions)
|
|
20
|
+
|
|
21
|
+
## Beta libraries
|
|
22
|
+
If you scaffold **another** app, first ask the user whether they have **beta access** and want the
|
|
23
|
+
latest features/progress. If yes, use `thatopen create <name> -t bim-beta` — it scaffolds on the
|
|
24
|
+
private `@thatopen-platform/*-beta` packages (the line the platform runs). Founding members have
|
|
25
|
+
permanent beta access; the beta packages are private, so the user's beta token must be configured
|
|
26
|
+
for `npm install`.
|
|
27
|
+
|
|
28
|
+
## This project
|
|
29
|
+
- `CONTEXT.md` (this folder) — the context for *this specific* project.
|
|
30
|
+
- `package.json` scripts — `npm run dev` (preview), `npm run login`, `npm run publish`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
See [AGENTS.md](./AGENTS.md) for how to work on this project, the rules to follow, and where the full That Open Platform build guides live.
|
|
@@ -14,11 +14,11 @@ export default defineConfig({
|
|
|
14
14
|
},
|
|
15
15
|
outDir: 'dist',
|
|
16
16
|
rollupOptions: {
|
|
17
|
-
// Only thatopen
|
|
18
|
-
// provides it at runtime via require('thatopen
|
|
17
|
+
// Only @thatopen/services is externalized — the execution wrapper
|
|
18
|
+
// provides it at runtime via require('@thatopen/services'). Every
|
|
19
19
|
// other dependency (including @thatopen/components, three, web-ifc,
|
|
20
20
|
// or any npm package you install) must be bundled into bundle.js.
|
|
21
|
-
external: ['thatopen
|
|
21
|
+
external: ['@thatopen/services'],
|
|
22
22
|
output: {
|
|
23
23
|
footer: 'var main = ThatOpenComponent.main;',
|
|
24
24
|
},
|
|
@@ -12,8 +12,8 @@ import {
|
|
|
12
12
|
PlatformClient,
|
|
13
13
|
AppManager,
|
|
14
14
|
ViewportManager,
|
|
15
|
-
} from "thatopen
|
|
16
|
-
import type { ThatOpenContext } from "thatopen
|
|
15
|
+
} from "@thatopen/services";
|
|
16
|
+
import type { ThatOpenContext } from "@thatopen/services";
|
|
17
17
|
|
|
18
18
|
declare global {
|
|
19
19
|
interface Window {
|