@thatopen/services 0.24.0 → 0.26.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,
@@ -419,9 +427,20 @@ 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).
+and units, untranslated. To READ a .frag's data without rendering anything,
+`readFrag(bytes)` answers its metadata and items (guids, categories,
+attributes). Both need the optional peers `flatbuffers` and
+`@thatopen/fragments` resolvable (loaded only when they run — nothing else in
+the package needs them; in plain Node, fragments also pulls `web-ifc`).
+
+BUILT-IN RECIPES ship with the SDK — proof that interoperability works
+without writing anything, and the templates to copy:
+`registerBuiltinRecipes(client)` registers `rhino-to-revit` (a Rhino layer's
+placed objects become instances of a chosen Revit type, reconciled on re-run),
+`ifc-to-revit` and `frag-to-revit` (the platform's own records — columns and
+free-standing instances today, more as the Revit applier grows; walls and
+slabs are read and tallied, proposing nothing yet). Every proposal is a
+suggestion: nothing changes in the native app until its owner accepts there.
 
 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

package/package.json

@@ -15,7 +15,7 @@
     "access": "public"
   },
   "private": false,
-  "version": "0.24.0",
+  "version": "0.26.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/index.d.ts",
@@ -72,6 +72,7 @@
     "vite-plugin-dts": "^3.9.1",
     "vite-plugin-eslint": "^1.8.1",
     "vitest": "^4.1.4",
+    "web-ifc": "^0.0.78",
     "zod": "^3.25.76"
   },
   "dependencies": {