@twin.org/document-management-rest-client 0.0.3-next.9 → 0.9.0-next.1

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Document Management REST Client
 
-Document management processing contract implementation which can connect to REST endpoints.
+This package provides a client for invoking document lifecycle endpoints over HTTP with a stable, contract-led API. It is intended for consumers that need to create, update, fetch revisions, remove revisions, and query document records from remote services.
 
 ## Installation
 

package/dist/es/documentManagementRestClient.js

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0.
 import { BaseRestClient } from "@twin.org/api-core";
 import { Coerce, Converter, Guards, Is, Urn } from "@twin.org/core";
-import { UneceDocumentCodeList } from "@twin.org/standards-unece";
 import { HeaderHelper, HeaderTypes } from "@twin.org/web";
 /**
  * Client for performing document management through to REST endpoints.
@@ -30,33 +29,26 @@ export class DocumentManagementRestClient extends BaseRestClient {
      * Store a document as an auditable item graph vertex and add its content to blob storage.
      * If the document id already exists and the blob data is different a new revision will be created.
      * For any other changes the current revision will be updated.
-     * @param documentId The document id to create.
-     * @param documentIdFormat The format of the document identifier.
-     * @param documentCode The code for the document type.
-     * @param blob The data to create the document with.
-     * @param annotationObject Additional information to associate with the document.
+     * @param document The document base properties.
+     * @param blob The data to create the document with as bytes, or an existing blob storage entry id.
      * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
      * @param options Additional options for the set operation.
-     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
-     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.includeAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.includeAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
      * @param options.aliasAnnotationObject Annotation object for the alias.
      * @returns The auditable item graph vertex created for the document including its revision.
      */
-    async create(documentId, documentIdFormat, documentCode, blob, annotationObject, auditableItemGraphEdges, options) {
-        Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
-        Guards.arrayOneOf(DocumentManagementRestClient.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodeList));
-        Guards.uint8Array(DocumentManagementRestClient.CLASS_NAME, "blob", blob);
+    async create(document, blob, auditableItemGraphEdges, options) {
+        Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "document.documentId", document.documentId);
+        if (!Is.uint8Array(blob) && !Is.stringValue(blob)) {
+            Guards.uint8Array(DocumentManagementRestClient.CLASS_NAME, "blob", blob);
+        }
         const response = await this.fetch("/", "POST", {
             body: {
-                documentId,
-                documentIdFormat,
-                documentCode,
-                blob: Converter.bytesToBase64(blob),
-                annotationObject,
+                document,
+                blob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : blob,
                 auditableItemGraphEdges,
-                createAttestation: options?.createAttestation,
-                addAlias: options?.addAlias,
-                aliasAnnotationObject: options?.aliasAnnotationObject
+                options
             }
         });
         return response.headers.location;
@@ -66,21 +58,32 @@ export class DocumentManagementRestClient extends BaseRestClient {
      * If the blob data is different a new revision will be created.
      * For any other changes the current revision will be updated.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
-     * @param blob The data to update the document with.
-     * @param annotationObject Additional information to associate with the document.
-     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
-     * @returns Nothing.
+     * @param document The document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.
+     * @param blob The data to update the document with as bytes, or an existing blob storage entry id.
+     * @param auditableItemGraphEdges Explicit edge delta to apply. If undefined, existing connections
+     * are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing
+     * ones by their target vertex id. To update alias metadata on an already-connected vertex, include
+     * it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the
+     * alias is updated in place without creating a duplicate back-edge.
+     * @param auditableItemGraphEdges.add Connections to add; each creates a back-edge on the connected vertex.
+     * @param auditableItemGraphEdges.remove Target vertex IDs to disconnect; their back-edges are removed.
+     * @param options Additional options for the update operation.
+     * @param options.includeAttestation Set to true to start attesting the document, or false to remove the existing attestation. Omit to leave unchanged.
+     * @param options.includeAlias Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave unchanged.
+     * @param options.aliasAnnotationObject Annotation object for the alias when adding.
+     * @returns A promise that resolves when the document has been updated.
      */
-    async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
+    async updatePartial(auditableItemGraphDocumentId, document, blob, auditableItemGraphEdges, options) {
         Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        await this.fetch("/:auditableItemGraphDocumentId", "PUT", {
+        await this.fetch("/:auditableItemGraphDocumentId", "PATCH", {
             pathParams: {
                 auditableItemGraphDocumentId
             },
             body: {
-                blob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : undefined,
-                annotationObject,
-                auditableItemGraphEdges
+                document,
+                blob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : blob,
+                auditableItemGraphEdges,
+                options
             }
         });
     }
@@ -92,6 +95,7 @@ export class DocumentManagementRestClient extends BaseRestClient {
      * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * @param options.includeDeletedEdges Flag to include soft-deleted edges in the response, defaults to false.
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
@@ -109,6 +113,7 @@ export class DocumentManagementRestClient extends BaseRestClient {
                 includeBlobStorageData: Coerce.string(options?.includeBlobStorageData),
                 includeAttestation: Coerce.string(options?.includeAttestation),
                 includeRemoved: Coerce.string(options?.includeRemoved),
+                includeDeletedEdges: Coerce.string(options?.includeDeletedEdges),
                 extractRuleGroupId: options?.extractRuleGroupId,
                 extractMimeType: options?.extractMimeType,
                 cursor,
@@ -131,7 +136,7 @@ export class DocumentManagementRestClient extends BaseRestClient {
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
-     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     * @returns The document for the specified revision.
      */
     async getRevision(auditableItemGraphDocumentId, revision, options) {
         Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
@@ -156,11 +161,11 @@ export class DocumentManagementRestClient extends BaseRestClient {
      * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
      * @param revision The revision of the document to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the revision has been removed.
      */
     async removeRevision(auditableItemGraphDocumentId, revision) {
         Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        Guards.number(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
+        Guards.integer(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
         await this.fetch("/:auditableItemGraphDocumentId/:revision", "DELETE", {
             pathParams: {
                 auditableItemGraphDocumentId,

package/dist/es/documentManagementRestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentManagementRestClient.js","sourceRoot":"","sources":["../../src/documentManagementRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAOpD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAiBpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,4BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,kCAAkD;IAEnF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,4BAA4B,CAAC,UAAU,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,4BAA4B,CAAC,UAAU,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,MAAM,CAClB,UAAkB,EAClB,gBAAoC,EACpC,YAAmC,EACnC,IAAgB,EAChB,gBAAoC,EACpC,uBAIG,EACH,OAIC;QAED,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAC5F,MAAM,CAAC,UAAU,CAChB,4BAA4B,CAAC,UAAU,kBAEvC,YAAY,EACZ,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CACpC,CAAC;QACF,MAAM,CAAC,UAAU,CAAC,4BAA4B,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE/E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,MAAM,EACN;YACC,IAAI,EAAE;gBACL,UAAU;gBACV,gBAAgB;gBAChB,YAAY;gBACZ,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC;gBACnC,gBAAgB;gBAChB,uBAAuB;gBACvB,iBAAiB,EAAE,OAAO,EAAE,iBAAiB;gBAC7C,QAAQ,EAAE,OAAO,EAAE,QAAQ;gBAC3B,qBAAqB,EAAE,OAAO,EAAE,qBAAqB;aACrD;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,MAAM,CAClB,4BAAoC,EACpC,IAAiB,EACjB,gBAAoC,EACpC,uBAIG;QAEH,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QAEF,MAAM,IAAI,CAAC,KAAK,CACf,gCAAgC,EAChC,KAAK,EACL;YACC,UAAU,EAAE;gBACX,4BAA4B;aAC5B;YACD,IAAI,EAAE;gBACL,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBACrE,gBAAgB;gBAChB,uBAAuB;aACvB;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,GAAG,CACf,4BAAoC,EACpC,OAOC,EACD,MAAe,EACf,KAAc;QAKd,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,gCAAgC,EAAE,KAAK,EAAE;YAC1C,UAAU,EAAE;gBACX,4BAA4B;aAC5B;YACD,KAAK,EAAE;gBACN,0BAA0B,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC;gBAC9E,sBAAsB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC;gBACtE,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC;gBAC9D,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC;gBACtD,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;gBAC/C,eAAe,EAAE,OAAO,EAAE,eAAe;gBACzC,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QAEH,OAAO;YACN,OAAO,EAAE,QAAQ,CAAC,IAAI;YACtB,MAAM,EAAE,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAC3F,EAAE,cAAc,EAAE,MAAM;SACzB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,WAAW,CACvB,4BAAoC,EACpC,QAAgB,EAChB,OAMC;QAED,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,4BAA4B,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,0CAA0C,EAAE,KAAK,EAAE;YACpD,UAAU,EAAE;gBACX,4BAA4B;gBAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;aAC7B;YACD,KAAK,EAAE;gBACN,0BAA0B,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC;gBAC9E,sBAAsB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC;gBACtE,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC;gBAC9D,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;gBAC/C,eAAe,EAAE,OAAO,EAAE,eAAe;aACzC;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAC1B,4BAAoC,EACpC,QAAgB;QAEhB,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,4BAA4B,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEnF,MAAM,IAAI,CAAC,KAAK,CACf,0CAA0C,EAC1C,QAAQ,EACR;YACC,UAAU,EAAE;gBACX,4BAA4B;gBAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;aAC7B;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CACjB,UAAkB,EAClB,MAAe,EACf,KAAc;QAKd,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAE5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,GAAG,EAAE,KAAK,EAAE;YACb,KAAK,EAAE;gBACN,UAAU;gBACV,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QAEH,OAAO;YACN,OAAO,EAAE,QAAQ,CAAC,IAAI;YACtB,MAAM,EAAE,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAC3F,EAAE,cAAc,EAAE,MAAM;SACzB,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type {\n\tIBaseRestClientConfig,\n\tICreatedResponse,\n\tINoContentResponse\n} from \"@twin.org/api-models\";\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport { Coerce, Converter, Guards, Is, Urn } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type {\n\tIDocument,\n\tIDocumentList,\n\tIDocumentManagementComponent,\n\tIDocumentManagementCreateRequest,\n\tIDocumentManagementGetRequest,\n\tIDocumentManagementGetResponse,\n\tIDocumentManagementGetRevisionRequest,\n\tIDocumentManagementGetRevisionResponse,\n\tIDocumentManagementQueryRequest,\n\tIDocumentManagementQueryResponse,\n\tIDocumentManagementRemoveRequest,\n\tIDocumentManagementUpdateRequest\n} from \"@twin.org/document-management-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport { HeaderHelper, HeaderTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing document management through to REST endpoints.\n */\nexport class DocumentManagementRestClient\n\textends BaseRestClient\n\timplements IDocumentManagementComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DocumentManagementRestClient>();\n\n\t/**\n\t * Create a new instance of DocumentManagementRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(DocumentManagementRestClient.CLASS_NAME, config, \"document-management\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn DocumentManagementRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Store a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the document id already exists and the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param documentId The document id to create.\n\t * @param documentIdFormat The format of the document identifier.\n\t * @param documentCode The code for the document type.\n\t * @param blob The data to create the document with.\n\t * @param annotationObject Additional information to associate with the document.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.\n\t * @param options Additional options for the set operation.\n\t * @param options.createAttestation Flag to create an attestation for the document, defaults to false.\n\t * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t * @param options.aliasAnnotationObject Annotation object for the alias.\n\t * @returns The auditable item graph vertex created for the document including its revision.\n\t */\n\tpublic async create(\n\t\tdocumentId: string,\n\t\tdocumentIdFormat: string | undefined,\n\t\tdocumentCode: UneceDocumentCodeList,\n\t\tblob: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[],\n\t\toptions?: {\n\t\t\tcreateAttestation?: boolean;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}\n\t): Promise<string> {\n\t\tGuards.stringValue(DocumentManagementRestClient.CLASS_NAME, nameof(documentId), documentId);\n\t\tGuards.arrayOneOf(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(documentCode),\n\t\t\tdocumentCode,\n\t\t\tObject.values(UneceDocumentCodeList)\n\t\t);\n\t\tGuards.uint8Array(DocumentManagementRestClient.CLASS_NAME, nameof(blob), blob);\n\n\t\tconst response = await this.fetch<IDocumentManagementCreateRequest, ICreatedResponse>(\n\t\t\t\"/\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\tdocumentId,\n\t\t\t\t\tdocumentIdFormat,\n\t\t\t\t\tdocumentCode,\n\t\t\t\t\tblob: Converter.bytesToBase64(blob),\n\t\t\t\t\tannotationObject,\n\t\t\t\t\tauditableItemGraphEdges,\n\t\t\t\t\tcreateAttestation: options?.createAttestation,\n\t\t\t\t\taddAlias: options?.addAlias,\n\t\t\t\t\taliasAnnotationObject: options?.aliasAnnotationObject\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.headers.location;\n\t}\n\n\t/**\n\t * Update a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param blob The data to update the document with.\n\t * @param annotationObject Additional information to associate with the document.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.\n\t * @returns Nothing.\n\t */\n\tpublic async update(\n\t\tauditableItemGraphDocumentId: string,\n\t\tblob?: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[]\n\t): Promise<void> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\n\t\tawait this.fetch<IDocumentManagementUpdateRequest, INoContentResponse>(\n\t\t\t\"/:auditableItemGraphDocumentId\",\n\t\t\t\"PUT\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tauditableItemGraphDocumentId\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\tblob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : undefined,\n\t\t\t\t\tannotationObject,\n\t\t\t\t\tauditableItemGraphEdges\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Get a document using it's auditable item graph vertex id and optional revision.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.includeRemoved Flag to include deleted documents, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @param cursor The cursor to get the next chunk of revisions.\n\t * @param limit The limit of items to return, defaults to 1 so only most recent is returned.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tpublic async get(\n\t\tauditableItemGraphDocumentId: string,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\tincludeRemoved?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IDocumentList;\n\t\tcursor?: string;\n\t}> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDocumentManagementGetRequest,\n\t\t\tIDocumentManagementGetResponse\n\t\t>(\"/:auditableItemGraphDocumentId\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tauditableItemGraphDocumentId\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tincludeBlobStorageMetadata: Coerce.string(options?.includeBlobStorageMetadata),\n\t\t\t\tincludeBlobStorageData: Coerce.string(options?.includeBlobStorageData),\n\t\t\t\tincludeAttestation: Coerce.string(options?.includeAttestation),\n\t\t\t\tincludeRemoved: Coerce.string(options?.includeRemoved),\n\t\t\t\textractRuleGroupId: options?.extractRuleGroupId,\n\t\t\t\textractMimeType: options?.extractMimeType,\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\n\t\treturn {\n\t\t\tentries: response.body,\n\t\t\tcursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], \"next\")\n\t\t\t\t?.urlQueryParams?.cursor\n\t\t};\n\t}\n\n\t/**\n\t * Get a document revision using it's auditable item graph vertex id.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision id for the document.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tpublic async getRevision(\n\t\tauditableItemGraphDocumentId: string,\n\t\trevision: number,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t}\n\t): Promise<IDocument> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\t\tGuards.integer(DocumentManagementRestClient.CLASS_NAME, nameof(revision), revision);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDocumentManagementGetRevisionRequest,\n\t\t\tIDocumentManagementGetRevisionResponse\n\t\t>(\"/:auditableItemGraphDocumentId/:revision\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tauditableItemGraphDocumentId,\n\t\t\t\trevision: revision.toString()\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tincludeBlobStorageMetadata: Coerce.string(options?.includeBlobStorageMetadata),\n\t\t\t\tincludeBlobStorageData: Coerce.string(options?.includeBlobStorageData),\n\t\t\t\tincludeAttestation: Coerce.string(options?.includeAttestation),\n\t\t\t\textractRuleGroupId: options?.extractRuleGroupId,\n\t\t\t\textractMimeType: options?.extractMimeType\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Remove an auditable item graph vertex using it's id.\n\t * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision of the document to remove.\n\t * @returns Nothing.\n\t */\n\tpublic async removeRevision(\n\t\tauditableItemGraphDocumentId: string,\n\t\trevision: number\n\t): Promise<void> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\t\tGuards.number(DocumentManagementRestClient.CLASS_NAME, nameof(revision), revision);\n\n\t\tawait this.fetch<IDocumentManagementRemoveRequest, INoContentResponse>(\n\t\t\t\"/:auditableItemGraphDocumentId/:revision\",\n\t\t\t\"DELETE\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tauditableItemGraphDocumentId,\n\t\t\t\t\trevision: revision.toString()\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Find all the document with a specific id.\n\t * @param documentId The document id to find in the graph.\n\t * @param cursor The cursor to get the next chunk of documents.\n\t * @param limit The limit to get the next chunk of documents.\n\t * @returns The graph vertices that contain documents referencing the specified document id.\n\t */\n\tpublic async query(\n\t\tdocumentId: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAuditableItemGraphVertexList;\n\t\tcursor?: string;\n\t}> {\n\t\tGuards.stringValue(DocumentManagementRestClient.CLASS_NAME, nameof(documentId), documentId);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDocumentManagementQueryRequest,\n\t\t\tIDocumentManagementQueryResponse\n\t\t>(\"/\", \"GET\", {\n\t\t\tquery: {\n\t\t\t\tdocumentId,\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\n\t\treturn {\n\t\t\tentries: response.body,\n\t\t\tcursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], \"next\")\n\t\t\t\t?.urlQueryParams?.cursor\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"documentManagementRestClient.js","sourceRoot":"","sources":["../../src/documentManagementRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAOpD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAmBpE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,4BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,kCAAkD;IAEnF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,4BAA4B,CAAC,UAAU,EAAE,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,4BAA4B,CAAC,UAAU,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,MAAM,CAClB,QAAuB,EACvB,IAAyB,EACzB,uBAAwD,EACxD,OAIC;QAED,MAAM,CAAC,WAAW,CACjB,4BAA4B,CAAC,UAAU,yBAEvC,QAAQ,CAAC,UAAU,CACnB,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,CAAC,UAAU,CAAC,4BAA4B,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,MAAM,EACN;YACC,IAAI,EAAE;gBACL,QAAQ;gBACR,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;gBAChE,uBAAuB;gBACvB,OAAO;aACP;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,aAAa,CACzB,4BAAoC,EACpC,QAEC,EACD,IAA0B,EAC1B,uBAGC,EACD,OAIC;QAED,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QAEF,MAAM,IAAI,CAAC,KAAK,CACf,gCAAgC,EAChC,OAAO,EACP;YACC,UAAU,EAAE;gBACX,4BAA4B;aAC5B;YACD,IAAI,EAAE;gBACL,QAAQ;gBACR,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;gBAChE,uBAAuB;gBACvB,OAAO;aACP;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,GAAG,CACf,4BAAoC,EACpC,OAQC,EACD,MAAe,EACf,KAAc;QAKd,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,gCAAgC,EAAE,KAAK,EAAE;YAC1C,UAAU,EAAE;gBACX,4BAA4B;aAC5B;YACD,KAAK,EAAE;gBACN,0BAA0B,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC;gBAC9E,sBAAsB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC;gBACtE,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC;gBAC9D,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC;gBACtD,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mBAAmB,CAAC;gBAChE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;gBAC/C,eAAe,EAAE,OAAO,EAAE,eAAe;gBACzC,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QAEH,OAAO;YACN,OAAO,EAAE,QAAQ,CAAC,IAAI;YACtB,MAAM,EAAE,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAC3F,EAAE,cAAc,EAAE,MAAM;SACzB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,WAAW,CACvB,4BAAoC,EACpC,QAAgB,EAChB,OAMC;QAED,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,4BAA4B,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,0CAA0C,EAAE,KAAK,EAAE;YACpD,UAAU,EAAE;gBACX,4BAA4B;gBAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;aAC7B;YACD,KAAK,EAAE;gBACN,0BAA0B,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,0BAA0B,CAAC;gBAC9E,sBAAsB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC;gBACtE,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC;gBAC9D,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;gBAC/C,eAAe,EAAE,OAAO,EAAE,eAAe;aACzC;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAC1B,4BAAoC,EACpC,QAAgB;QAEhB,GAAG,CAAC,KAAK,CACR,4BAA4B,CAAC,UAAU,kCAEvC,4BAA4B,CAC5B,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,4BAA4B,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEpF,MAAM,IAAI,CAAC,KAAK,CACf,0CAA0C,EAC1C,QAAQ,EACR;YACC,UAAU,EAAE;gBACX,4BAA4B;gBAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE;aAC7B;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CACjB,UAAkB,EAClB,MAAe,EACf,KAAc;QAKd,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAE5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,GAAG,EAAE,KAAK,EAAE;YACb,KAAK,EAAE;gBACN,UAAU;gBACV,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QAEH,OAAO;YACN,OAAO,EAAE,QAAQ,CAAC,IAAI;YACtB,MAAM,EAAE,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAC3F,EAAE,cAAc,EAAE,MAAM;SACzB,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type {\n\tIBaseRestClientConfig,\n\tICreatedResponse,\n\tINoContentResponse\n} from \"@twin.org/api-models\";\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport { Coerce, Converter, Guards, Is, Urn } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type {\n\tIDocumentBase,\n\tIDocumentHydrated,\n\tIDocumentList,\n\tIDocumentManagementComponent,\n\tIDocumentManagementCreateRequest,\n\tIDocumentManagementEdgeEntry,\n\tIDocumentManagementGetRequest,\n\tIDocumentManagementGetResponse,\n\tIDocumentManagementGetRevisionRequest,\n\tIDocumentManagementGetRevisionResponse,\n\tIDocumentManagementQueryRequest,\n\tIDocumentManagementQueryResponse,\n\tIDocumentManagementRemoveRequest,\n\tIDocumentManagementUpdatePartialRequest\n} from \"@twin.org/document-management-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HeaderHelper, HeaderTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing document management through to REST endpoints.\n */\nexport class DocumentManagementRestClient\n\textends BaseRestClient\n\timplements IDocumentManagementComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DocumentManagementRestClient>();\n\n\t/**\n\t * Create a new instance of DocumentManagementRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(DocumentManagementRestClient.CLASS_NAME, config, \"document-management\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn DocumentManagementRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Store a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the document id already exists and the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param document The document base properties.\n\t * @param blob The data to create the document with as bytes, or an existing blob storage entry id.\n\t * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.\n\t * @param options Additional options for the set operation.\n\t * @param options.includeAttestation Flag to create an attestation for the document, defaults to false.\n\t * @param options.includeAlias Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t * @param options.aliasAnnotationObject Annotation object for the alias.\n\t * @returns The auditable item graph vertex created for the document including its revision.\n\t */\n\tpublic async create(\n\t\tdocument: IDocumentBase,\n\t\tblob: Uint8Array | string,\n\t\tauditableItemGraphEdges?: IDocumentManagementEdgeEntry[],\n\t\toptions?: {\n\t\t\tincludeAttestation?: boolean;\n\t\t\tincludeAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}\n\t): Promise<string> {\n\t\tGuards.stringValue(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(document.documentId),\n\t\t\tdocument.documentId\n\t\t);\n\t\tif (!Is.uint8Array(blob) && !Is.stringValue(blob)) {\n\t\t\tGuards.uint8Array(DocumentManagementRestClient.CLASS_NAME, nameof(blob), blob);\n\t\t}\n\n\t\tconst response = await this.fetch<IDocumentManagementCreateRequest, ICreatedResponse>(\n\t\t\t\"/\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\tdocument,\n\t\t\t\t\tblob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : blob,\n\t\t\t\t\tauditableItemGraphEdges,\n\t\t\t\t\toptions\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.headers.location;\n\t}\n\n\t/**\n\t * Update a document as an auditable item graph vertex and add its content to blob storage.\n\t * If the blob data is different a new revision will be created.\n\t * For any other changes the current revision will be updated.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param document The document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.\n\t * @param blob The data to update the document with as bytes, or an existing blob storage entry id.\n\t * @param auditableItemGraphEdges Explicit edge delta to apply. If undefined, existing connections\n\t * are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing\n\t * ones by their target vertex id. To update alias metadata on an already-connected vertex, include\n\t * it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the\n\t * alias is updated in place without creating a duplicate back-edge.\n\t * @param auditableItemGraphEdges.add Connections to add; each creates a back-edge on the connected vertex.\n\t * @param auditableItemGraphEdges.remove Target vertex IDs to disconnect; their back-edges are removed.\n\t * @param options Additional options for the update operation.\n\t * @param options.includeAttestation Set to true to start attesting the document, or false to remove the existing attestation. Omit to leave unchanged.\n\t * @param options.includeAlias Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave unchanged.\n\t * @param options.aliasAnnotationObject Annotation object for the alias when adding.\n\t * @returns A promise that resolves when the document has been updated.\n\t */\n\tpublic async updatePartial(\n\t\tauditableItemGraphDocumentId: string,\n\t\tdocument?: Partial<\n\t\t\tPick<IDocumentBase, \"annotationObject\" | \"documentIdFormat\" | \"documentCode\">\n\t\t>,\n\t\tblob?: Uint8Array | string,\n\t\tauditableItemGraphEdges?: {\n\t\t\tadd?: IDocumentManagementEdgeEntry[];\n\t\t\tremove?: string[];\n\t\t},\n\t\toptions?: {\n\t\t\tincludeAttestation?: boolean;\n\t\t\tincludeAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}\n\t): Promise<void> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\n\t\tawait this.fetch<IDocumentManagementUpdatePartialRequest, INoContentResponse>(\n\t\t\t\"/:auditableItemGraphDocumentId\",\n\t\t\t\"PATCH\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tauditableItemGraphDocumentId\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\tdocument,\n\t\t\t\t\tblob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : blob,\n\t\t\t\t\tauditableItemGraphEdges,\n\t\t\t\t\toptions\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Get a document using it's auditable item graph vertex id and optional revision.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.includeRemoved Flag to include deleted documents, defaults to false.\n\t * @param options.includeDeletedEdges Flag to include soft-deleted edges in the response, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @param cursor The cursor to get the next chunk of revisions.\n\t * @param limit The limit of items to return, defaults to 1 so only most recent is returned.\n\t * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.\n\t */\n\tpublic async get(\n\t\tauditableItemGraphDocumentId: string,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\tincludeRemoved?: boolean;\n\t\t\tincludeDeletedEdges?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IDocumentList;\n\t\tcursor?: string;\n\t}> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDocumentManagementGetRequest,\n\t\t\tIDocumentManagementGetResponse\n\t\t>(\"/:auditableItemGraphDocumentId\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tauditableItemGraphDocumentId\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tincludeBlobStorageMetadata: Coerce.string(options?.includeBlobStorageMetadata),\n\t\t\t\tincludeBlobStorageData: Coerce.string(options?.includeBlobStorageData),\n\t\t\t\tincludeAttestation: Coerce.string(options?.includeAttestation),\n\t\t\t\tincludeRemoved: Coerce.string(options?.includeRemoved),\n\t\t\t\tincludeDeletedEdges: Coerce.string(options?.includeDeletedEdges),\n\t\t\t\textractRuleGroupId: options?.extractRuleGroupId,\n\t\t\t\textractMimeType: options?.extractMimeType,\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\n\t\treturn {\n\t\t\tentries: response.body,\n\t\t\tcursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], \"next\")\n\t\t\t\t?.urlQueryParams?.cursor\n\t\t};\n\t}\n\n\t/**\n\t * Get a document revision using it's auditable item graph vertex id.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision id for the document.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.\n\t * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.\n\t * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @returns The document for the specified revision.\n\t */\n\tpublic async getRevision(\n\t\tauditableItemGraphDocumentId: string,\n\t\trevision: number,\n\t\toptions?: {\n\t\t\tincludeBlobStorageMetadata?: boolean;\n\t\t\tincludeBlobStorageData?: boolean;\n\t\t\tincludeAttestation?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t}\n\t): Promise<IDocumentHydrated> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\t\tGuards.integer(DocumentManagementRestClient.CLASS_NAME, nameof(revision), revision);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDocumentManagementGetRevisionRequest,\n\t\t\tIDocumentManagementGetRevisionResponse\n\t\t>(\"/:auditableItemGraphDocumentId/:revision\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tauditableItemGraphDocumentId,\n\t\t\t\trevision: revision.toString()\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tincludeBlobStorageMetadata: Coerce.string(options?.includeBlobStorageMetadata),\n\t\t\t\tincludeBlobStorageData: Coerce.string(options?.includeBlobStorageData),\n\t\t\t\tincludeAttestation: Coerce.string(options?.includeAttestation),\n\t\t\t\textractRuleGroupId: options?.extractRuleGroupId,\n\t\t\t\textractMimeType: options?.extractMimeType\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Remove an auditable item graph vertex using it's id.\n\t * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.\n\t * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.\n\t * @param revision The revision of the document to remove.\n\t * @returns A promise that resolves when the revision has been removed.\n\t */\n\tpublic async removeRevision(\n\t\tauditableItemGraphDocumentId: string,\n\t\trevision: number\n\t): Promise<void> {\n\t\tUrn.guard(\n\t\t\tDocumentManagementRestClient.CLASS_NAME,\n\t\t\tnameof(auditableItemGraphDocumentId),\n\t\t\tauditableItemGraphDocumentId\n\t\t);\n\t\tGuards.integer(DocumentManagementRestClient.CLASS_NAME, nameof(revision), revision);\n\n\t\tawait this.fetch<IDocumentManagementRemoveRequest, INoContentResponse>(\n\t\t\t\"/:auditableItemGraphDocumentId/:revision\",\n\t\t\t\"DELETE\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tauditableItemGraphDocumentId,\n\t\t\t\t\trevision: revision.toString()\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Find all the document with a specific id.\n\t * @param documentId The document id to find in the graph.\n\t * @param cursor The cursor to get the next chunk of documents.\n\t * @param limit The limit to get the next chunk of documents.\n\t * @returns The graph vertices that contain documents referencing the specified document id.\n\t */\n\tpublic async query(\n\t\tdocumentId: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAuditableItemGraphVertexList;\n\t\tcursor?: string;\n\t}> {\n\t\tGuards.stringValue(DocumentManagementRestClient.CLASS_NAME, nameof(documentId), documentId);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDocumentManagementQueryRequest,\n\t\t\tIDocumentManagementQueryResponse\n\t\t>(\"/\", \"GET\", {\n\t\t\tquery: {\n\t\t\t\tdocumentId,\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\n\t\treturn {\n\t\t\tentries: response.body,\n\t\t\tcursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], \"next\")\n\t\t\t\t?.urlQueryParams?.cursor\n\t\t};\n\t}\n}\n"]}

package/dist/types/documentManagementRestClient.d.ts

@@ -2,8 +2,7 @@ import { BaseRestClient } from "@twin.org/api-core";
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
 import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IDocument, IDocumentList, IDocumentManagementComponent } from "@twin.org/document-management-models";
-import { UneceDocumentCodeList } from "@twin.org/standards-unece";
+import type { IDocumentBase, IDocumentHydrated, IDocumentList, IDocumentManagementComponent, IDocumentManagementEdgeEntry } from "@twin.org/document-management-models";
 /**
  * Client for performing document management through to REST endpoints.
  */
@@ -26,25 +25,18 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * Store a document as an auditable item graph vertex and add its content to blob storage.
      * If the document id already exists and the blob data is different a new revision will be created.
      * For any other changes the current revision will be updated.
-     * @param documentId The document id to create.
-     * @param documentIdFormat The format of the document identifier.
-     * @param documentCode The code for the document type.
-     * @param blob The data to create the document with.
-     * @param annotationObject Additional information to associate with the document.
+     * @param document The document base properties.
+     * @param blob The data to create the document with as bytes, or an existing blob storage entry id.
      * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
      * @param options Additional options for the set operation.
-     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
-     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.includeAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.includeAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
      * @param options.aliasAnnotationObject Annotation object for the alias.
      * @returns The auditable item graph vertex created for the document including its revision.
      */
-    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodeList, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
-        targetId: string;
-        addAlias?: boolean;
-        aliasAnnotationObject?: IJsonLdNodeObject;
-    }[], options?: {
-        createAttestation?: boolean;
-        addAlias?: boolean;
+    create(document: IDocumentBase, blob: Uint8Array | string, auditableItemGraphEdges?: IDocumentManagementEdgeEntry[], options?: {
+        includeAttestation?: boolean;
+        includeAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
     }): Promise<string>;
     /**
@@ -52,16 +44,29 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * If the blob data is different a new revision will be created.
      * For any other changes the current revision will be updated.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
-     * @param blob The data to update the document with.
-     * @param annotationObject Additional information to associate with the document.
-     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
-     * @returns Nothing.
+     * @param document The document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.
+     * @param blob The data to update the document with as bytes, or an existing blob storage entry id.
+     * @param auditableItemGraphEdges Explicit edge delta to apply. If undefined, existing connections
+     * are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing
+     * ones by their target vertex id. To update alias metadata on an already-connected vertex, include
+     * it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the
+     * alias is updated in place without creating a duplicate back-edge.
+     * @param auditableItemGraphEdges.add Connections to add; each creates a back-edge on the connected vertex.
+     * @param auditableItemGraphEdges.remove Target vertex IDs to disconnect; their back-edges are removed.
+     * @param options Additional options for the update operation.
+     * @param options.includeAttestation Set to true to start attesting the document, or false to remove the existing attestation. Omit to leave unchanged.
+     * @param options.includeAlias Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave unchanged.
+     * @param options.aliasAnnotationObject Annotation object for the alias when adding.
+     * @returns A promise that resolves when the document has been updated.
      */
-    update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
-        targetId: string;
-        addAlias?: boolean;
+    updatePartial(auditableItemGraphDocumentId: string, document?: Partial<Pick<IDocumentBase, "annotationObject" | "documentIdFormat" | "documentCode">>, blob?: Uint8Array | string, auditableItemGraphEdges?: {
+        add?: IDocumentManagementEdgeEntry[];
+        remove?: string[];
+    }, options?: {
+        includeAttestation?: boolean;
+        includeAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
-    }[]): Promise<void>;
+    }): Promise<void>;
     /**
      * Get a document using it's auditable item graph vertex id and optional revision.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
@@ -70,6 +75,7 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * @param options.includeDeletedEdges Flag to include soft-deleted edges in the response, defaults to false.
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
@@ -81,6 +87,7 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
+        includeDeletedEdges?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
     }, cursor?: string, limit?: number): Promise<{
@@ -97,7 +104,7 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
-     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     * @returns The document for the specified revision.
      */
     getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
         includeBlobStorageMetadata?: boolean;
@@ -105,13 +112,13 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
         includeAttestation?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
-    }): Promise<IDocument>;
+    }): Promise<IDocumentHydrated>;
     /**
      * Remove an auditable item graph vertex using it's id.
      * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
      * @param revision The revision of the document to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the revision has been removed.
      */
     removeRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;
     /**