@twin.org/document-management-models 0.0.2-next.3 → 0.0.3-next.1

package/dist/es/dataTypes/documentManagementDataTypes.js

@@ -0,0 +1,29 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { DataTypeHandlerFactory } from "@twin.org/data-core";
+import { DocumentContexts } from "../models/documentContexts.js";
+import { DocumentTypes } from "../models/documentTypes.js";
+import DocumentSchema from "../schemas/Document.json" with { type: "json" };
+/**
+ * Handle all the data types for document management.
+ */
+export class DocumentManagementDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes() {
+        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.Document,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.DocumentAttestation,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+    }
+}
+//# sourceMappingURL=documentManagementDataTypes.js.map

package/dist/es/dataTypes/documentManagementDataTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentManagementDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/documentManagementDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAoB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,cAAc,MAAM,0BAA0B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE5E;;GAEG;AACH,MAAM,OAAO,2BAA2B;IACvC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC,QAAQ,EAAE,EAC1D,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,gBAAgB,CAAC,WAAW;YACrC,IAAI,EAAE,aAAa,CAAC,QAAQ;YAC5B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAA6B;SACrD,CAAC,CACF,CAAC;QAEF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC,mBAAmB,EAAE,EACrE,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,gBAAgB,CAAC,WAAW;YACrC,IAAI,EAAE,aAAa,CAAC,mBAAmB;YACvC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAA6B;SACrD,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory, type IJsonSchema } from \"@twin.org/data-core\";\nimport { DocumentContexts } from \"../models/documentContexts.js\";\nimport { DocumentTypes } from \"../models/documentTypes.js\";\nimport DocumentSchema from \"../schemas/Document.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for document management.\n */\nexport class DocumentManagementDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`,\n\t\t\t() => ({\n\t\t\t\tcontext: DocumentContexts.ContextRoot,\n\t\t\t\ttype: DocumentTypes.Document,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => DocumentSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`,\n\t\t\t() => ({\n\t\t\t\tcontext: DocumentContexts.ContextRoot,\n\t\t\t\ttype: DocumentTypes.DocumentAttestation,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => DocumentSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,19 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./dataTypes/documentManagementDataTypes.js";
+export * from "./models/api/IDocumentManagementCreateRequest.js";
+export * from "./models/api/IDocumentManagementGetRequest.js";
+export * from "./models/api/IDocumentManagementGetResponse.js";
+export * from "./models/api/IDocumentManagementGetRevisionRequest.js";
+export * from "./models/api/IDocumentManagementGetRevisionResponse.js";
+export * from "./models/api/IDocumentManagementQueryRequest.js";
+export * from "./models/api/IDocumentManagementQueryResponse.js";
+export * from "./models/api/IDocumentManagementRemoveRequest.js";
+export * from "./models/api/IDocumentManagementUpdateRequest.js";
+export * from "./models/documentContexts.js";
+export * from "./models/documentTypes.js";
+export * from "./models/IDocument.js";
+export * from "./models/IDocumentAttestation.js";
+export * from "./models/IDocumentList.js";
+export * from "./models/IDocumentManagementComponent.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,4CAA4C,CAAC;AAC3D,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0CAA0C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/documentManagementDataTypes.js\";\nexport * from \"./models/api/IDocumentManagementCreateRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetResponse.js\";\nexport * from \"./models/api/IDocumentManagementGetRevisionRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetRevisionResponse.js\";\nexport * from \"./models/api/IDocumentManagementQueryRequest.js\";\nexport * from \"./models/api/IDocumentManagementQueryResponse.js\";\nexport * from \"./models/api/IDocumentManagementRemoveRequest.js\";\nexport * from \"./models/api/IDocumentManagementUpdateRequest.js\";\nexport * from \"./models/documentContexts.js\";\nexport * from \"./models/documentTypes.js\";\nexport * from \"./models/IDocument.js\";\nexport * from \"./models/IDocumentAttestation.js\";\nexport * from \"./models/IDocumentList.js\";\nexport * from \"./models/IDocumentManagementComponent.js\";\n"]}

package/dist/es/models/IDocument.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocument.js.map

package/dist/es/models/IDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocument.js","sourceRoot":"","sources":["../../../src/models/IDocument.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAttestationInformation } from \"@twin.org/attestation-models\";\nimport type { IBlobStorageEntry } from \"@twin.org/blob-storage-models\";\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { UneceDocumentCodes } from \"@twin.org/standards-unece\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { DocumentTypes } from \"./documentTypes.js\";\n\n/**\n * Interface describing a document.\n */\nexport interface IDocument {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof DocumentContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRootCommon,\n\t\ttypeof SchemaOrgContexts.ContextRoot,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof DocumentTypes.Document;\n\n\t/**\n\t * The full id of the document.\n\t */\n\tid: string;\n\n\t/**\n\t * The id of the document.\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * The format of the document id.\n\t */\n\tdocumentIdFormat?: string;\n\n\t/**\n\t * The code for the document type.\n\t */\n\tdocumentCode: UneceDocumentCodes;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * Additional annotation information for the document.\n\t */\n\tannotationObject?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob storage id for the document.\n\t */\n\tblobStorageId: string;\n\n\t/**\n\t * The hash of the blob data.\n\t */\n\tblobHash: string;\n\n\t/**\n\t * The additional JSON-LD for blob storage if it was requested.\n\t */\n\tblobStorageEntry?: IBlobStorageEntry;\n\n\t/**\n\t * The data extracted from the document using data extraction services.\n\t */\n\textractedData?: unknown;\n\n\t/**\n\t * The attestation for the document if one was created.\n\t */\n\tattestationId?: string;\n\n\t/**\n\t * The additional JSON-LD for attestation storage if it was requested.\n\t */\n\tattestationInformation?: IAttestationInformation;\n\n\t/**\n\t * The date/time of when the document was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time of when the document was modified.\n\t */\n\tdateModified?: string;\n\n\t/**\n\t * The date/time of when the document was deleted, as we never actually remove items.\n\t */\n\tdateDeleted?: string;\n\n\t/**\n\t * The organization which added the document to the graph.\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The user who added the document to the graph.\n\t */\n\tuserIdentity?: string;\n}\n"]}

package/dist/es/models/IDocumentAttestation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentAttestation.js.map

package/dist/es/models/IDocumentAttestation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentAttestation.js","sourceRoot":"","sources":["../../../src/models/IDocumentAttestation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { UneceDocumentCodes } from \"@twin.org/standards-unece\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { DocumentTypes } from \"./documentTypes.js\";\n\n/**\n * Interface describing a document attestation.\n */\nexport interface IDocumentAttestation {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof DocumentContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRootCommon,\n\t\ttypeof SchemaOrgContexts.ContextRoot\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof DocumentTypes.DocumentAttestation;\n\n\t/**\n\t * The id of the document.\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * The code for the document type.\n\t */\n\tdocumentCode: UneceDocumentCodes;\n\n\t/**\n\t * The revision of the document as a 0 based index.\n\t */\n\tdocumentRevision: number;\n\n\t/**\n\t * The date/time of when the document was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The hash of the document being attested.\n\t */\n\tblobHash: string;\n}\n"]}

package/dist/es/models/IDocumentList.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentList.js.map

package/dist/es/models/IDocumentList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentList.js","sourceRoot":"","sources":["../../../src/models/IDocumentList.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts, SchemaOrgTypes } from \"@twin.org/standards-schema-org\";\nimport type { DocumentContexts } from \"./documentContexts.js\";\nimport type { IDocument } from \"./IDocument.js\";\n\n/**\n * Interface describing a list of document entries.\n */\nexport interface IDocumentList {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRoot,\n\t\ttypeof DocumentContexts.ContextRootCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof SchemaOrgTypes.ItemList;\n\n\t/**\n\t * The list of documents.\n\t */\n\t[SchemaOrgTypes.ItemListElement]: IDocument[];\n\n\t/**\n\t * The ids of the other vertices which are connected to the document.\n\t */\n\tedges?: string[];\n\n\t/**\n\t * The cursor to get the next chunk of documents.\n\t */\n\t[SchemaOrgTypes.NextItem]?: string;\n}\n"]}

package/dist/es/models/IDocumentManagementComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementComponent.js.map

package/dist/es/models/IDocumentManagementComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementComponent.js","sourceRoot":"","sources":["../../../src/models/IDocumentManagementComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { UneceDocumentCodes } from \"@twin.org/standards-unece\";\nimport type { IDocument } from \"./IDocument.js\";\nimport type { IDocumentList } from \"./IDocumentList.js\";\n\n/**\n * Interface describing an document management contract.\n */\nexport interface IDocumentManagementComponent extends IComponent {\n\t/**\n\t * Create 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\tcreate(\n\t\tdocumentId: string,\n\t\tdocumentIdFormat: string | undefined,\n\t\tdocumentCode: UneceDocumentCodes,\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\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\tupdate(\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\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 Limit the number 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\tget(\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<IDocumentList>;\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 of the document to get.\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\tgetRevision(\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\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\tremoveRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;\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\tquery(\n\t\tdocumentId: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IAuditableItemGraphVertexList>;\n}\n"]}

package/dist/es/models/api/IDocumentManagementCreateRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementCreateRequest.js.map

package/dist/es/models/api/IDocumentManagementCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { UneceDocumentCodes } from \"@twin.org/standards-unece\";\n\n/**\n * Request to create a document as an auditable item graph vertex.\n */\nexport interface IDocumentManagementCreateRequest {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The document id to create.\n\t\t */\n\t\tdocumentId: string;\n\n\t\t/**\n\t\t * The format of the document identifier.\n\t\t */\n\t\tdocumentIdFormat: string | undefined;\n\n\t\t/**\n\t\t * The code for the document type.\n\t\t */\n\t\tdocumentCode: UneceDocumentCodes;\n\n\t\t/**\n\t\t * The data to create the document with, in base64.\n\t\t */\n\t\tblob: string;\n\n\t\t/**\n\t\t * Additional information to associate with the document.\n\t\t */\n\t\tannotationObject?: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The auditable item graph vertices to connect the document to.\n\t\t */\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[];\n\n\t\t/**\n\t\t * Flag to create an attestation for the document, defaults to false.\n\t\t */\n\t\tcreateAttestation?: boolean;\n\n\t\t/**\n\t\t * Flag to add the document id as an alias to the aig vertex, defaults to true.\n\t\t */\n\t\taddAlias?: boolean;\n\n\t\t/**\n\t\t * Annotation object for the alias.\n\t\t */\n\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementGetRequest.js.map

package/dist/es/models/api/IDocumentManagementGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: boolean | string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: boolean | string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: boolean | string;\n\n\t\t/**\n\t\t * Include deleted documents in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeRemoved?: boolean | string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\n\t\t/**\n\t\t * PLimit the number of items to return, defaults to 1 so only most recent is returned.\n\t\t * @default 1\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get the next chunk of revisions.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementGetResponse.js.map

package/dist/es/models/api/IDocumentManagementGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IDocumentList } from \"../IDocumentList.js\";\n\n/**\n * Response to get a document and optionally revisions from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IDocumentList;\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementGetRevisionRequest.js.map

package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementGetRevisionRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRevisionRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document revision from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRevisionRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\n\t\t/**\n\t\t * The revision of the document to get.\n\t\t */\n\t\trevision: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: boolean | string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: boolean | string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: boolean | string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementGetRevisionResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementGetRevisionResponse.js.map

package/dist/es/models/api/IDocumentManagementGetRevisionResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementGetRevisionResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRevisionResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IDocument } from \"../IDocument.js\";\n\n/**\n * Response to get a document revision from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRevisionResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IDocument;\n}\n"]}

package/dist/es/models/api/IDocumentManagementQueryRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementQueryRequest.js.map

package/dist/es/models/api/IDocumentManagementQueryRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementQueryRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementQueryRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a list of document from an auditable item graph vertex.\n */\nexport interface IDocumentManagementQueryRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery: {\n\t\t/**\n\t\t * The id of the document id we are trying to find.\n\t\t */\n\t\tdocumentId: string;\n\n\t\t/**\n\t\t * The cursor to get the next chunk of documents.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * The number of documents to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementQueryResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementQueryResponse.js.map

package/dist/es/models/api/IDocumentManagementQueryResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementQueryResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuditableItemGraphVertexList } from \"@twin.org/auditable-item-graph-models\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Response to query the documents from an auditable item graph vertex.\n */\nexport interface IDocumentManagementQueryResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IAuditableItemGraphVertexList;\n}\n"]}

package/dist/es/models/api/IDocumentManagementRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IDocumentManagementRemoveRequest.js.map

package/dist/es/models/api/IDocumentManagementRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to remove a document revision from an auditable item graph.\n */\nexport interface IDocumentManagementRemoveRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the auditable item graph vertex to remove the revision from.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\n\t\t/**\n\t\t * The revision of the document to remove.\n\t\t */\n\t\trevision: string;\n\t};\n}\n"]}

package/dist/es/models/api/IDocumentManagementUpdateRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDocumentManagementUpdateRequest.js.map

package/dist/es/models/api/IDocumentManagementUpdateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Request to update a document as an auditable item graph vertex.\n */\nexport interface IDocumentManagementUpdateRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The data to create the document with, in base64.\n\t\t */\n\t\tblob?: string;\n\n\t\t/**\n\t\t * Additional information to associate with the document.\n\t\t */\n\t\tannotationObject?: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The auditable item graph vertices to connect the document to.\n\t\t */\n\t\tauditableItemGraphEdges?: {\n\t\t\ttargetId: string;\n\t\t\taddAlias?: boolean;\n\t\t\taliasAnnotationObject?: IJsonLdNodeObject;\n\t\t}[];\n\t};\n}\n"]}

package/dist/es/models/documentContexts.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of document management objects.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DocumentContexts = {
+    /**
+     * The context root for the document types.
+     */
+    ContextRoot: "https://schema.twindev.org/documents/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+//# sourceMappingURL=documentContexts.js.map

package/dist/es/models/documentContexts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentContexts.js","sourceRoot":"","sources":["../../../src/models/documentContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B;;OAEG;IACH,WAAW,EAAE,uCAAuC;IAEpD;;OAEG;IACH,iBAAiB,EAAE,oCAAoC;CAC9C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of document management objects.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DocumentContexts = {\n\t/**\n\t * The context root for the document types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/documents/\",\n\n\t/**\n\t * The context root for the common types.\n\t */\n\tContextRootCommon: \"https://schema.twindev.org/common/\"\n} as const;\n\n/**\n * The contexts of document management objects.\n */\nexport type DocumentContexts = (typeof DocumentContexts)[keyof typeof DocumentContexts];\n"]}

package/dist/es/models/documentTypes.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of document management objects.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DocumentTypes = {
+    /**
+     * Represents a document.
+     */
+    Document: "Document",
+    /**
+     * Represents a document attestation.
+     */
+    DocumentAttestation: "DocumentAttestation"
+};
+//# sourceMappingURL=documentTypes.js.map

package/dist/es/models/documentTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentTypes.js","sourceRoot":"","sources":["../../../src/models/documentTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;CACjC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of document management objects.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DocumentTypes = {\n\t/**\n\t * Represents a document.\n\t */\n\tDocument: \"Document\",\n\n\t/**\n\t * Represents a document attestation.\n\t */\n\tDocumentAttestation: \"DocumentAttestation\"\n} as const;\n\n/**\n * The types of document management objects.\n */\nexport type DocumentTypes = (typeof DocumentTypes)[keyof typeof DocumentTypes];\n"]}

package/dist/es/schemas/Document.json

@@ -0,0 +1,114 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/documents/Document",
+    "description": "Interface describing a document.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "minItems": 3,
+            "description": "JSON-LD Context.",
+            "prefixItems": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/documents/"
+                },
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/common/"
+                },
+                {
+                    "type": "string",
+                    "const": "https://schema.org"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+            }
+        },
+        "type": {
+            "type": "string",
+            "const": "Document",
+            "description": "JSON-LD Type."
+        },
+        "id": {
+            "type": "string",
+            "description": "The full id of the document."
+        },
+        "documentId": {
+            "type": "string",
+            "description": "The id of the document."
+        },
+        "documentIdFormat": {
+            "type": "string",
+            "description": "The format of the document id."
+        },
+        "documentCode": {
+            "$ref": "https://vocabulary.uncefact.org/DocumentCodeList",
+            "description": "The code for the document type."
+        },
+        "documentRevision": {
+            "type": "number",
+            "description": "The revision of the document as a 0 based index."
+        },
+        "annotationObject": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "Additional annotation information for the document."
+        },
+        "blobStorageId": {
+            "type": "string",
+            "description": "The blob storage id for the document."
+        },
+        "blobHash": {
+            "type": "string",
+            "description": "The hash of the blob data."
+        },
+        "blobStorageEntry": {
+            "$ref": "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+            "description": "The additional JSON-LD for blob storage if it was requested."
+        },
+        "extractedData": {
+            "description": "The data extracted from the document using data extraction services."
+        },
+        "attestationId": {
+            "type": "string",
+            "description": "The attestation for the document if one was created."
+        },
+        "attestationInformation": {
+            "$ref": "https://schema.twindev.org/attestation/AttestationInformation",
+            "description": "The additional JSON-LD for attestation storage if it was requested."
+        },
+        "dateCreated": {
+            "type": "string",
+            "description": "The date/time of when the document was created."
+        },
+        "dateModified": {
+            "type": "string",
+            "description": "The date/time of when the document was modified."
+        },
+        "dateDeleted": {
+            "type": "string",
+            "description": "The date/time of when the document was deleted, as we never actually remove items."
+        },
+        "organizationIdentity": {
+            "type": "string",
+            "description": "The organization which added the document to the graph."
+        },
+        "userIdentity": {
+            "type": "string",
+            "description": "The user who added the document to the graph."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "id",
+        "documentId",
+        "documentCode",
+        "documentRevision",
+        "blobStorageId",
+        "blobHash",
+        "dateCreated"
+    ],
+    "additionalProperties": false
+}

package/dist/types/index.d.ts

@@ -1,16 +1,16 @@
-export * from "./dataTypes/documentManagementDataTypes";
-export * from "./models/api/IDocumentManagementCreateRequest";
-export * from "./models/api/IDocumentManagementGetRequest";
-export * from "./models/api/IDocumentManagementGetResponse";
-export * from "./models/api/IDocumentManagementGetRevisionRequest";
-export * from "./models/api/IDocumentManagementGetRevisionResponse";
-export * from "./models/api/IDocumentManagementQueryRequest";
-export * from "./models/api/IDocumentManagementQueryResponse";
-export * from "./models/api/IDocumentManagementRemoveRequest";
-export * from "./models/api/IDocumentManagementUpdateRequest";
-export * from "./models/documentContexts";
-export * from "./models/documentTypes";
-export * from "./models/IDocument";
-export * from "./models/IDocumentAttestation";
-export * from "./models/IDocumentList";
-export * from "./models/IDocumentManagementComponent";
+export * from "./dataTypes/documentManagementDataTypes.js";
+export * from "./models/api/IDocumentManagementCreateRequest.js";
+export * from "./models/api/IDocumentManagementGetRequest.js";
+export * from "./models/api/IDocumentManagementGetResponse.js";
+export * from "./models/api/IDocumentManagementGetRevisionRequest.js";
+export * from "./models/api/IDocumentManagementGetRevisionResponse.js";
+export * from "./models/api/IDocumentManagementQueryRequest.js";
+export * from "./models/api/IDocumentManagementQueryResponse.js";
+export * from "./models/api/IDocumentManagementRemoveRequest.js";
+export * from "./models/api/IDocumentManagementUpdateRequest.js";
+export * from "./models/documentContexts.js";
+export * from "./models/documentTypes.js";
+export * from "./models/IDocument.js";
+export * from "./models/IDocumentAttestation.js";
+export * from "./models/IDocumentList.js";
+export * from "./models/IDocumentManagementComponent.js";

package/dist/types/models/IDocument.d.ts

@@ -3,8 +3,8 @@ import type { IBlobStorageEntry } from "@twin.org/blob-storage-models";
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
-import type { DocumentContexts } from "./documentContexts";
-import type { DocumentTypes } from "./documentTypes";
+import type { DocumentContexts } from "./documentContexts.js";
+import type { DocumentTypes } from "./documentTypes.js";
 /**
  * Interface describing a document.
  */
@@ -83,11 +83,11 @@ export interface IDocument {
      */
     dateDeleted?: string;
     /**
-     * The node which added the document to the graph.
+     * The organization which added the document to the graph.
      */
-    nodeIdentity: string;
+    organizationIdentity?: string;
     /**
      * The user who added the document to the graph.
      */
-    userIdentity: string;
+    userIdentity?: string;
 }

package/dist/types/models/IDocumentAttestation.d.ts

@@ -1,7 +1,7 @@
 import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
-import type { DocumentContexts } from "./documentContexts";
-import type { DocumentTypes } from "./documentTypes";
+import type { DocumentContexts } from "./documentContexts.js";
+import type { DocumentTypes } from "./documentTypes.js";
 /**
  * Interface describing a document attestation.
  */

package/dist/types/models/IDocumentList.d.ts

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
-import type { DocumentContexts } from "./documentContexts";
-import type { IDocument } from "./IDocument";
+import type { DocumentContexts } from "./documentContexts.js";
+import type { IDocument } from "./IDocument.js";
 /**
  * Interface describing a list of document entries.
  */

package/dist/types/models/IDocumentManagementComponent.d.ts

@@ -2,8 +2,8 @@ import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-gra
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
-import type { IDocument } from "./IDocument";
-import type { IDocumentList } from "./IDocumentList";
+import type { IDocument } from "./IDocument.js";
+import type { IDocumentList } from "./IDocumentList.js";
 /**
  * Interface describing an document management contract.
  */
@@ -22,8 +22,6 @@ export interface IDocumentManagementComponent extends IComponent {
      * @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.
-     * @param userIdentity The identity to perform the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @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?: {
@@ -34,7 +32,7 @@ export interface IDocumentManagementComponent extends IComponent {
         createAttestation?: boolean;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    }): Promise<string>;
     /**
      * 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.
@@ -43,15 +41,13 @@ export interface IDocumentManagementComponent extends IComponent {
      * @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.
-     * @param userIdentity The identity to perform the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
     update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
         targetId: string;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
-    }[], userIdentity?: string, nodeIdentity?: string): 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.
@@ -63,9 +59,7 @@ export interface IDocumentManagementComponent extends IComponent {
      * @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 pageSize Page size of items to return, defaults to 1 so only most recent is returned.
-     * @param userIdentity The identity to perform the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
+     * @param limit Limit the number 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.
      */
     get(auditableItemGraphDocumentId: string, options?: {
@@ -75,7 +69,7 @@ export interface IDocumentManagementComponent extends IComponent {
         includeRemoved?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
-    }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    }, cursor?: string, limit?: number): Promise<IDocumentList>;
     /**
      * Get a document revision using it's auditable item graph vertex id.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
@@ -86,8 +80,6 @@ export interface IDocumentManagementComponent extends IComponent {
      * @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.
-     * @param userIdentity The identity to perform the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
     getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
@@ -96,25 +88,21 @@ export interface IDocumentManagementComponent extends IComponent {
         includeAttestation?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+    }): Promise<IDocument>;
     /**
      * 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.
-     * @param userIdentity The identity to perform the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
-    removeRevision(auditableItemGraphDocumentId: string, revision: number, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    removeRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;
     /**
      * 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 pageSize The page size to get the next chunk of documents.
-     * @param userIdentity The identity to perform the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
+     * @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, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IAuditableItemGraphVertexList>;
+    query(documentId: string, cursor?: string, limit?: number): Promise<IAuditableItemGraphVertexList>;
 }

package/dist/types/models/api/IDocumentManagementGetRequest.d.ts

@@ -51,10 +51,10 @@ export interface IDocumentManagementGetRequest {
          */
         extractMimeType?: string;
         /**
-         * Page size of items to return, defaults to 1 so only most recent is returned.
+         * PLimit the number of items to return, defaults to 1 so only most recent is returned.
          * @default 1
          */
-        pageSize?: number | string;
+        limit?: string;
         /**
          * The cursor to get the next chunk of revisions.
          */

package/dist/types/models/api/IDocumentManagementGetResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocumentList } from "../IDocumentList";
+import type { IDocumentList } from "../IDocumentList.js";
 /**
  * Response to get a document and optionally revisions from an auditable item graph vertex.
  */

package/dist/types/models/api/IDocumentManagementGetRevisionResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocument } from "../IDocument";
+import type { IDocument } from "../IDocument.js";
 /**
  * Response to get a document revision from an auditable item graph vertex.
  */

package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts

@@ -24,6 +24,6 @@ export interface IDocumentManagementQueryRequest {
         /**
          * The number of documents to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }