@qaecy/cue-sdk 0.0.28 → 0.0.30

package/README.md

@@ -238,16 +238,15 @@ Entity data for a project is accessed via a `CueProjectView`. Create a view with
 
 Fetch all canonical entities that belong to at least one of the given category IRIs. Accepts both full HTTP IRIs and prefixed forms.
 
-By default returns only `{ iri, uuid }` — suitable for feeding directly into `requestEntityData()` for lazy detail loading. Pass `true` to also receive `value` and `categories`.
+By default returns `{ iri, uuid }[]` — the IRI is built locally from the project base URL so no extra data is fetched from the endpoint. Pass `true` to also receive `value` and `categories`.
 
 ```typescript
-// Lean — just IRIs + UUIDs (default)
+// Lean — iri + uuid, no extra SPARQL traffic (default)
 const entities = await view.entities.entitiesByCategory([
   'qcy:Building',
   'qcy:BuildingStorey',
 ]);
-const uuids = entities.map((e) => e.uuid);
-view.entities.requestEntityData(uuids); // lazy-loads labels + categories
+view.entities.requestEntityData(entities.map((e) => e.uuid));
 
 // With metadata
 const entities = await view.entities.entitiesByCategory(
@@ -303,10 +302,10 @@ Document data for a project is accessed via `view.documents` (`CueProjectDocumen
 
 Fetch all documents whose file extension matches one of the given suffixes. The leading dot is optional — both `'ifc'` and `'.ifc'` are accepted.
 
-By default returns only `{ iri, uuid }` for pairing with `requestDocumentData()`. Pass `true` to also receive `path`, `suffix`, and `size`.
+By default returns `{ iri, uuid }[]` — the IRI is built locally from the project base URL, no extra data fetched. Pass `true` to also receive `path`, `suffix`, and `size`.
 
 ```typescript
-// Lean — just IRIs + UUIDs (default)
+// Lean — iri + uuid, no extra SPARQL traffic (default)
 const docs = await view.documents.documentsBySuffix(['.ifc', '.rvt']);
 view.documents.requestDocumentData(docs.map((d) => d.uuid));
 
@@ -322,7 +321,7 @@ Fetch documents by semantic `FileType` category. Resolves all matching suffixes
 ```typescript
 import { FileType } from 'js/models';
 
-// All BIM and CAD files
+// All BIM and CAD files — iri + uuid
 const docs = await view.documents.documentsByFileType([
   FileType.BIM,
   FileType.CAD,
@@ -337,6 +336,7 @@ const docs = await view.documents.documentsByFileType([FileType.IMAGE], true);
 Fetch documents whose MIME type matches one of the given strings:
 
 ```typescript
+// Just iri + uuid
 const docs = await view.documents.documentsByMime([
   'application/x-step',  // .ifc
   'application/pdf',
@@ -349,13 +349,11 @@ const docs = await view.documents.documentsByMime(
 );
 ```
 
-| Method | Filters by | Extra metadata (`true`) |
-|---|---|---|
-| `documentsBySuffix` | File extension string(s) | `path`, `suffix`, `size` |
-| `documentsByFileType` | `FileType` enum value(s) | `path`, `suffix`, `size` |
-| `documentsByMime` | MIME type string(s) | `path`, `suffix`, `size` |
-
-All three exclude alternative representations (e.g. derived `.fragments` tiles) from results.
+| Method | Filters by | Default return | With `true` |
+|---|---|---|---|
+| `documentsBySuffix` | File extension string(s) | `{ iri, uuid }[]` | adds `path`, `suffix`, `size` |
+| `documentsByFileType` | `FileType` enum value(s) | `{ iri, uuid }[]` | adds `path`, `suffix`, `size` |
+| `documentsByMime` | MIME type string(s) | `{ iri, uuid }[]` | adds `path`, `suffix`, `size` |
 
 ## Node.js — file sync