@twin.org/document-management-rest-client 0.0.2-next.4 → 0.0.3-next.10

package/dist/{esm/index.mjs → es/documentManagementRestClient.js}

@@ -1,13 +1,13 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, Converter, Urn, Is, Coerce } from '@twin.org/core';
-import { UneceDocumentCodes } from '@twin.org/standards-unece';
-
 // Copyright 2024 IOTA Stiftung.
 // 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.
  */
-class DocumentManagementRestClient extends BaseRestClient {
+export class DocumentManagementRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
@@ -19,6 +19,13 @@ class DocumentManagementRestClient extends BaseRestClient {
     constructor(config) {
         super(DocumentManagementRestClient.CLASS_NAME, config, "document-management");
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return DocumentManagementRestClient.CLASS_NAME;
+    }
     /**
      * 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.
@@ -37,7 +44,7 @@ class DocumentManagementRestClient extends BaseRestClient {
      */
     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(UneceDocumentCodes));
+        Guards.arrayOneOf(DocumentManagementRestClient.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodeList));
         Guards.uint8Array(DocumentManagementRestClient.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
@@ -98,17 +105,21 @@ class DocumentManagementRestClient extends BaseRestClient {
                 auditableItemGraphDocumentId
             },
             query: {
-                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
-                includeBlobStorageData: options?.includeBlobStorageData,
-                includeAttestation: options?.includeAttestation,
-                includeRemoved: options?.includeRemoved,
+                includeBlobStorageMetadata: Coerce.string(options?.includeBlobStorageMetadata),
+                includeBlobStorageData: Coerce.string(options?.includeBlobStorageData),
+                includeAttestation: Coerce.string(options?.includeAttestation),
+                includeRemoved: Coerce.string(options?.includeRemoved),
                 extractRuleGroupId: options?.extractRuleGroupId,
                 extractMimeType: options?.extractMimeType,
                 cursor,
                 limit: Coerce.string(limit)
             }
         });
-        return response.body;
+        return {
+            entries: response.body,
+            cursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], "next")
+                ?.urlQueryParams?.cursor
+        };
     }
     /**
      * Get a document revision using it's auditable item graph vertex id.
@@ -131,9 +142,9 @@ class DocumentManagementRestClient extends BaseRestClient {
                 revision: revision.toString()
             },
             query: {
-                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
-                includeBlobStorageData: options?.includeBlobStorageData,
-                includeAttestation: options?.includeAttestation,
+                includeBlobStorageMetadata: Coerce.string(options?.includeBlobStorageMetadata),
+                includeBlobStorageData: Coerce.string(options?.includeBlobStorageData),
+                includeAttestation: Coerce.string(options?.includeAttestation),
                 extractRuleGroupId: options?.extractRuleGroupId,
                 extractMimeType: options?.extractMimeType
             }
@@ -173,8 +184,11 @@ class DocumentManagementRestClient extends BaseRestClient {
                 limit: Coerce.string(limit)
             }
         });
-        return response.body;
+        return {
+            entries: response.body,
+            cursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], "next")
+                ?.urlQueryParams?.cursor
+        };
     }
 }
-
-export { DocumentManagementRestClient };
+//# sourceMappingURL=documentManagementRestClient.js.map

package/dist/es/documentManagementRestClient.js.map

@@ -0,0 +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"]}

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./documentManagementRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,mCAAmC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./documentManagementRestClient.js\";\n"]}

package/dist/types/documentManagementRestClient.d.ts

@@ -3,7 +3,7 @@ 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 { UneceDocumentCodes } from "@twin.org/standards-unece";
+import { UneceDocumentCodeList } from "@twin.org/standards-unece";
 /**
  * Client for performing document management through to REST endpoints.
  */
@@ -17,6 +17,11 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * 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.
@@ -33,7 +38,7 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * @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: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodeList, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
         targetId: string;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
@@ -78,7 +83,10 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
         includeRemoved?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
-    }, cursor?: string, limit?: number): Promise<IDocumentList>;
+    }, cursor?: string, limit?: number): Promise<{
+        entries: IDocumentList;
+        cursor?: string;
+    }>;
     /**
      * Get a document revision using it's auditable item graph vertex id.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
@@ -113,5 +121,8 @@ export declare class DocumentManagementRestClient extends BaseRestClient impleme
      * @param limit The limit to get the next chunk of documents.
      * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    query(documentId: string, cursor?: string, limit?: number): Promise<IAuditableItemGraphVertexList>;
+    query(documentId: string, cursor?: string, limit?: number): Promise<{
+        entries: IAuditableItemGraphVertexList;
+        cursor?: string;
+    }>;
 }

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./documentManagementRestClient";
+export * from "./documentManagementRestClient.js";

package/docs/changelog.md

@@ -1,5 +1,158 @@
 # @twin.org/document-management-rest-client - Changelog
 
+## [0.0.3-next.10](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.9...document-management-rest-client-v0.0.3-next.10) (2026-02-11)
+
+
+### Miscellaneous Chores
+
+* **document-management-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.8...document-management-rest-client-v0.0.3-next.9) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **document-management-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.7...document-management-rest-client-v0.0.3-next.8) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **document-management-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.6...document-management-rest-client-v0.0.3-next.7) (2026-01-23)
+
+
+### Features
+
+* replace nextItem property with Link header ([#34](https://github.com/twinfoundation/document-management/issues/34)) ([3f04c3f](https://github.com/twinfoundation/document-management/commit/3f04c3fb5c9ec0c56f213089a15cc247fbfbd59c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.5...document-management-rest-client-v0.0.3-next.6) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **document-management-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.4...document-management-rest-client-v0.0.3-next.5) (2026-01-14)
+
+
+### Miscellaneous Chores
+
+* **document-management-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.3...document-management-rest-client-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* update unece dependencies ([a27548c](https://github.com/twinfoundation/document-management/commit/a27548cdebbe1d9577fc8341166538c2f07348a3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.2...document-management-rest-client-v0.0.3-next.3) (2025-12-03)
+
+
+### Features
+
+* use updated unece types ([c141a89](https://github.com/twinfoundation/document-management/commit/c141a895138cb45fa0b1e95c42f56e31708c846c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.1...document-management-rest-client-v0.0.3-next.2) (2025-11-28)
+
+
+### Features
+
+* update background task service ([5c380dc](https://github.com/twinfoundation/document-management/commit/5c380dca3114254201768f184f9486828501ff66))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.0...document-management-rest-client-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#24](https://github.com/twinfoundation/document-management/issues/24)) ([83f65f1](https://github.com/twinfoundation/document-management/commit/83f65f15e55f2293f5ca0d9d1e4679ba67c4ec8d))
+* add validate-locales ([b6b6f9e](https://github.com/twinfoundation/document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
+* document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
+* eslint migration to flat config ([98635aa](https://github.com/twinfoundation/document-management/commit/98635aa24ebafba265e989e461fe98104f683191))
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+* store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
+* update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
+* update framework core ([f991a59](https://github.com/twinfoundation/document-management/commit/f991a59d25ec228bcdd7a5b6bd55578985b55a84))
+* use targetId in AIG for edges ([82dec81](https://github.com/twinfoundation/document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
+
+
+### Bug Fixes
+
+* adding missing route for the document management ([#4](https://github.com/twinfoundation/document-management/issues/4)) ([fd3292e](https://github.com/twinfoundation/document-management/commit/fd3292ede5014847ae2f2bcadb174b6552486154))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.2-next.3...document-management-rest-client-v0.0.2-next.4) (2025-10-09)
 
 

package/docs/reference/classes/DocumentManagementRestClient.md

@@ -44,6 +44,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDocumentManagementComponent.className`
+
+***
+
 ### create()
 
 > **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
@@ -64,11 +82,11 @@ The document id to create.
 
 The format of the document identifier.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### documentCode
 
-`string`
+`UneceDocumentCodeList`
 
 The code for the document type.
 
@@ -172,7 +190,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<`IDocumentList`\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -238,7 +256,7 @@ The limit of items to return, defaults to 1 so only most recent is returned.
 
 #### Returns
 
-`Promise`\<`IDocumentList`\>
+`Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
@@ -349,7 +367,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 Find all the document with a specific id.
 
@@ -375,7 +393,7 @@ The limit to get the next chunk of documents.
 
 #### Returns
 
-`Promise`\<`IAuditableItemGraphVertexList`\>
+`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 The graph vertices that contain documents referencing the specified document id.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-rest-client",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.10",
 	"description": "Document management contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -19,26 +19,24 @@
 		"@twin.org/auditable-item-graph-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.2-next.4",
+		"@twin.org/document-management-models": "0.0.3-next.10",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-unece": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,182 +0,0 @@
-'use strict';
-
-var apiCore = require('@twin.org/api-core');
-var core = require('@twin.org/core');
-var standardsUnece = require('@twin.org/standards-unece');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing document management through to REST endpoints.
- */
-class DocumentManagementRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "DocumentManagementRestClient";
-    /**
-     * Create a new instance of DocumentManagementRestClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super(DocumentManagementRestClient.CLASS_NAME, config, "document-management");
-    }
-    /**
-     * 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 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.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) {
-        core.Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
-        core.Guards.arrayOneOf(DocumentManagementRestClient.CLASS_NAME, "documentCode", documentCode, Object.values(standardsUnece.UneceDocumentCodes));
-        core.Guards.uint8Array(DocumentManagementRestClient.CLASS_NAME, "blob", blob);
-        const response = await this.fetch("/", "POST", {
-            body: {
-                documentId,
-                documentIdFormat,
-                documentCode,
-                blob: core.Converter.bytesToBase64(blob),
-                annotationObject,
-                auditableItemGraphEdges,
-                createAttestation: options?.createAttestation,
-                addAlias: options?.addAlias,
-                aliasAnnotationObject: options?.aliasAnnotationObject
-            }
-        });
-        return response.headers.location;
-    }
-    /**
-     * Update a document as an auditable item graph vertex and add its content to blob storage.
-     * 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.
-     */
-    async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
-        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        await this.fetch("/:auditableItemGraphDocumentId", "PUT", {
-            pathParams: {
-                auditableItemGraphDocumentId
-            },
-            body: {
-                blob: core.Is.uint8Array(blob) ? core.Converter.bytesToBase64(blob) : undefined,
-                annotationObject,
-                auditableItemGraphEdges
-            }
-        });
-    }
-    /**
-     * 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.
-     * @param options Additional options for the get operation.
-     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
-     * @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.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.
-     * @param limit The limit of items to return, defaults to 1 so only most recent is returned.
-     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
-     */
-    async get(auditableItemGraphDocumentId, options, cursor, limit) {
-        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
-            pathParams: {
-                auditableItemGraphDocumentId
-            },
-            query: {
-                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
-                includeBlobStorageData: options?.includeBlobStorageData,
-                includeAttestation: options?.includeAttestation,
-                includeRemoved: options?.includeRemoved,
-                extractRuleGroupId: options?.extractRuleGroupId,
-                extractMimeType: options?.extractMimeType,
-                cursor,
-                limit: core.Coerce.string(limit)
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Get a document revision using it's auditable item graph vertex id.
-     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
-     * @param revision The revision id for the document.
-     * @param options Additional options for the get operation.
-     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
-     * @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.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.
-     */
-    async getRevision(auditableItemGraphDocumentId, revision, options) {
-        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        core.Guards.integer(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
-        const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
-            pathParams: {
-                auditableItemGraphDocumentId,
-                revision: revision.toString()
-            },
-            query: {
-                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
-                includeBlobStorageData: options?.includeBlobStorageData,
-                includeAttestation: options?.includeAttestation,
-                extractRuleGroupId: options?.extractRuleGroupId,
-                extractMimeType: options?.extractMimeType
-            }
-        });
-        return response.body;
-    }
-    /**
-     * 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.
-     */
-    async removeRevision(auditableItemGraphDocumentId, revision) {
-        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        core.Guards.number(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
-        await this.fetch("/:auditableItemGraphDocumentId/:revision", "DELETE", {
-            pathParams: {
-                auditableItemGraphDocumentId,
-                revision: revision.toString()
-            }
-        });
-    }
-    /**
-     * Find all the document with a specific id.
-     * @param documentId The document id to find in the graph.
-     * @param cursor The cursor to get the next chunk of documents.
-     * @param limit The limit to get the next chunk of documents.
-     * @returns The graph vertices that contain documents referencing the specified document id.
-     */
-    async query(documentId, cursor, limit) {
-        core.Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
-        const response = await this.fetch("/", "GET", {
-            query: {
-                documentId,
-                cursor,
-                limit: core.Coerce.string(limit)
-            }
-        });
-        return response.body;
-    }
-}
-
-exports.DocumentManagementRestClient = DocumentManagementRestClient;