@qaecy/cue-sdk 0.0.29 → 0.0.31

package/README.md

@@ -238,15 +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 a `string[]` of UUIDs — suitable for feeding directly into `requestEntityData()` for lazy detail loading. Pass `true` to also receive `iri`, `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 UUIDs (default)
-const uuids = await view.entities.entitiesByCategory([
+// Lean — iri + uuid, no extra SPARQL traffic (default)
+const entities = await view.entities.entitiesByCategory([
   'qcy:Building',
   'qcy:BuildingStorey',
 ]);
-view.entities.requestEntityData(uuids); // lazy-loads labels + categories
+view.entities.requestEntityData(entities.map((e) => e.uuid));
 
 // With metadata
 const entities = await view.entities.entitiesByCategory(
@@ -259,7 +259,7 @@ entities.forEach((e) => console.log(e.uuid, e.value, e.categories));
 | Parameter | Type | Description |
 |---|---|---|
 | `categoryIris` | `string[]` | Full IRIs (`https://…`) or prefixed forms (`qcy:…`) |
-| `includeMetadata` | `boolean` | `false` (default) → `string[]` UUIDs; `true` → adds `iri`, `value`, and `categories` |
+| `includeMetadata` | `boolean` | `false` (default) → `{ iri, uuid }[]`; `true` → adds `value` and `categories` |
 
 ### `view.entities.contentCategoriesInProject(orderByOccurrences?)`
 
@@ -302,12 +302,12 @@ 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 a `string[]` of UUIDs — suitable for feeding directly into `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 UUIDs (default)
-const uuids = await view.documents.documentsBySuffix(['.ifc', '.rvt']);
-view.documents.requestDocumentData(uuids);
+// Lean — iri + uuid, no extra SPARQL traffic (default)
+const docs = await view.documents.documentsBySuffix(['.ifc', '.rvt']);
+view.documents.requestDocumentData(docs.map((d) => d.uuid));
 
 // With file metadata
 const docs = await view.documents.documentsBySuffix(['pdf', 'docx'], true);
@@ -321,8 +321,8 @@ Fetch documents by semantic `FileType` category. Resolves all matching suffixes
 ```typescript
 import { FileType } from 'js/models';
 
-// All BIM and CAD files — just UUIDs
-const uuids = await view.documents.documentsByFileType([
+// All BIM and CAD files — iri + uuid
+const docs = await view.documents.documentsByFileType([
   FileType.BIM,
   FileType.CAD,
 ]);
@@ -336,8 +336,8 @@ const docs = await view.documents.documentsByFileType([FileType.IMAGE], true);
 Fetch documents whose MIME type matches one of the given strings:
 
 ```typescript
-// Just UUIDs
-const uuids = await view.documents.documentsByMime([
+// Just iri + uuid
+const docs = await view.documents.documentsByMime([
   'application/x-step',  // .ifc
   'application/pdf',
 ]);
@@ -351,9 +351,9 @@ const docs = await view.documents.documentsByMime(
 
 | Method | Filters by | Default return | With `true` |
 |---|---|---|---|
-| `documentsBySuffix` | File extension string(s) | `string[]` UUIDs | adds `iri`, `path`, `suffix`, `size` |
-| `documentsByFileType` | `FileType` enum value(s) | `string[]` UUIDs | adds `iri`, `path`, `suffix`, `size` |
-| `documentsByMime` | MIME type string(s) | `string[]` UUIDs | adds `iri`, `path`, `suffix`, `size` |
+| `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