@thatopen/services 0.23.0 → 0.25.0

package/docs/ai-quickstart.md

@@ -381,11 +381,19 @@ returns null).
 
 ```ts
 const documents = client.documents(projectId);
-const descriptor = await documents.descriptor(folderId); // null on a plain folder
+const all = await documents.list();                       // every document (folderId + descriptor)
+const descriptor = await documents.descriptor(folderId);  // null on a plain folder
 const view = await documents.view(folderId, ['frag', 'ifc']); // your preference order wins
 await documents.addView(folderId, { fileId, format: 'frag' }); // a processor's last act
+const doc = await documents.fromFile(fileId);             // convert a loose file into a document
 ```
 
+`fromFile` creates the folder next to the file, moves the file in (ids survive
+moves), and writes the descriptor: the file as `native`, and as `views[0]` too
+when its format views itself (`SELF_VIEWING_FORMATS`; `selfView` overrides). A
+file with an old `derivedFileId` link (an IFC's frag) brings the derivative
+into the folder as a view, so the document is born ready to visualize.
+
 ## 5d. History and recipes: versions, change requests
 
 Three sentences hold the whole model. Every connected document (a Revit model,
@@ -415,6 +423,14 @@ await client.recipes.run('my-recipe', {            // only QUEUES a suggestion:
 `docs()` also answers `folderId` — the id the CDE knows that document by, the
 bridge between this section and 5c.
 
+To AUTHOR a suggestion's payload, `OperationBuilder` (same import) writes the
+operation .frag: `new OperationBuilder(target).add(attrs, placement)` /
+`.set(id, attrs)` / `.remove(id)`, then `await builder.build(opId)` gives the
+bytes for `suggest({ payload })`. Attributes go in the TARGET app's own terms
+and units, untranslated. It needs the optional peers `flatbuffers` and
+`@thatopen/fragments` installed (loaded only when `build()` runs — nothing
+else in the package needs them).
+
 This surface is the only supported way in: the storage underneath is private
 and will move. Never list or write the `bimterop` files directly. The full
 walkthrough (manifest fields, StaleHistoryError on concurrent syncs, payloads)

package/package.json

@@ -15,7 +15,7 @@
     "access": "public"
   },
   "private": false,
-  "version": "0.23.0",
+  "version": "0.25.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/index.d.ts",
@@ -82,16 +82,24 @@
   },
   "peerDependencies": {
     "@thatopen/components": "~3.4.0",
+    "@thatopen/fragments": "~3.4.0",
     "@thatopen/ui": "~3.4.0",
+    "flatbuffers": ">=23.0.0",
     "three": ">=0.182.0"
   },
   "peerDependenciesMeta": {
     "@thatopen/components": {
       "optional": true
     },
+    "@thatopen/fragments": {
+      "optional": true
+    },
     "@thatopen/ui": {
       "optional": true
     },
+    "flatbuffers": {
+      "optional": true
+    },
     "three": {
       "optional": true
     }