@thatopen/services 0.0.5 → 0.0.6

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/resources/AGENTS.md +21 -21
package/package.json CHANGED
@@ -15,7 +15,7 @@
15
15
  "access": "public"
16
16
  },
17
17
  "private": false,
18
- "version": "0.0.5",
18
+ "version": "0.0.6",
19
19
  "main": "dist/index.cjs.js",
20
20
  "module": "dist/index.es.js",
21
21
  "types": "dist/index.d.ts",
package/resources/AGENTS.md CHANGED
@@ -3,37 +3,37 @@
3
3
  You are an AI assistant helping a user build a **BIM app** or **cloud component** on the
4
4
  That Open Platform using **`@thatopen/services`** (the `thatopen` CLI + client library).
5
5
 
6
- **Read this file first.** It states the rules you must follow, then routes you to the right docs.
7
- Open only the doc you need — don't load everything.
6
+ **Read this file first, then immediately load all indexes listed below before doing anything else.**
8
7
 
9
- > This guide is tool-agnostic: it works with any AI (Claude, Codex, your own). All docs it
8
+ > This guide is tool-agnostic: it works with any AI (Claude, Codex, your own). All local docs it
10
9
  > references ship inside the `@thatopen/services` package under `docs/`.
11
10
 
12
11
  ---
13
12
 
14
- ## How to work
13
+ ## Session start — load all indexes in parallel
15
14
 
16
- - **The scaffold is already a complete, working viewer** (model loading, spatial tree, properties).
17
- **Run it first** (`npm run dev`) to see it work, *then* extend it — don't rebuild a viewer from scratch.
18
- - **Propose a short plan and get the user's OK** before changing files. If scope is unclear, ask.
19
- - Prefer existing That Open functionality over custom code (see rules 1 and 2).
15
+ Do this before answering any question or writing any code. These are compact description indexes:
20
16
 
21
- ## Hard rules (always apply)
17
+ | What | Where |
18
+ |---|---|
19
+ | Platform built-ins | `docs/builtin/paths.json` |
20
+ | Platform client API | `docs/client/paths.json` |
21
+ | CLI commands | `docs/cli/paths.json` |
22
+ | Engine components (`OBC`, `OBF`) | `https://raw.githubusercontent.com/ThatOpen/engine_components/refs/heads/main/examples/paths.json` |
23
+ | Fragments (`FRAGS`) | `https://raw.githubusercontent.com/ThatOpen/engine_fragment/refs/heads/main/examples/paths.json` |
24
+ | 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` |
22
25
 
23
- 1. **Check the That Open ecosystem before building anything custom.** Fetch these indexes and read the descriptions — if something already exists, use it:
24
- - Engine components (`OBC`, `OBF`): `https://raw.githubusercontent.com/ThatOpen/engine_components/refs/heads/main/examples/paths.json`
25
- - Fragments (`FRAGS`): `https://raw.githubusercontent.com/ThatOpen/engine_fragment/refs/heads/main/examples/paths.json`
26
- - UI components (`BUI`): `https://raw.githubusercontent.com/ThatOpen/engine_ui-components/refs/heads/main/examples/paths.json`
27
- — **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`.
28
- 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`.
29
- 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.
26
+ Once you have these, you know everything available on the platform. Only then fetch a specific example file when you need implementation details.
30
27
 
31
28
  ---
32
29
 
33
- ## What are you doing? → open the right doc
30
+ ## How to work
34
31
 
35
- ### CLI commands
36
- For all CLI commands read `docs/cli/paths.json`.
32
+ - **The scaffold is already a complete, working viewer** (model loading, spatial tree, properties).
33
+ **Run it first** (`npm run dev`) to see it work, *then* extend it — don't rebuild a viewer from scratch.
34
+ - **Propose a short plan and get the user's OK** before changing files. If scope is unclear, ask.
35
+ - If something already exists in the indexes, use it — don't reimplement it.
36
+
37
+ ## Hard rules (always apply)
37
38
 
38
- ### Platform client API
39
- For all platform related operations read `docs/client/paths.json`.
39
+ 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`.