@twin.org/document-management-models 0.0.3-next.15 → 0.0.3-next.17

package/dist/es/index.js

@@ -9,13 +9,14 @@ 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/api/IDocumentManagementUpdatePartialRequest.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";
+export * from "./models/IDocumentManagementEdgeEntry.js";
 export * from "./models/documentManagementMetricIds.js";
 export * from "./models/documentManagementMetrics.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +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;AACzD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,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\";\nexport * from \"./models/documentManagementMetricIds.js\";\nexport * from \"./models/documentManagementMetrics.js\";\n"]}
+{"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,yDAAyD,CAAC;AACxE,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0CAA0C,CAAC;AACzD,cAAc,0CAA0C,CAAC;AACzD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,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/IDocumentManagementUpdatePartialRequest.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\";\nexport * from \"./models/IDocumentManagementEdgeEntry.js\";\nexport * from \"./models/documentManagementMetricIds.js\";\nexport * from \"./models/documentManagementMetrics.js\";\n"]}

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

@@ -1 +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 { UneceDocumentCodeList } 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: 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\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<{\n\t\tentries: IDocumentList;\n\t\tcursor?: string;\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 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<{\n\t\tentries: IAuditableItemGraphVertexList;\n\t\tcursor?: string;\n\t}>;\n}\n"]}
+{"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 { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { IDocument } from \"./IDocument.js\";\nimport type { IDocumentList } from \"./IDocumentList.js\";\nimport type { IDocumentManagementEdgeEntry } from \"./IDocumentManagementEdgeEntry.js\";\n\n/**\n * Interface describing a 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: UneceDocumentCodeList,\n\t\tblob: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: IDocumentManagementEdgeEntry[],\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 Explicit edge delta to apply. If undefined, existing connections\n\t * are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing\n\t * ones by their target vertex id. To update alias metadata on an already-connected vertex, include\n\t * it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the\n\t * alias is updated in place without creating a duplicate back-edge.\n\t * @param auditableItemGraphEdges.add Connections to add; each creates a back-edge on the connected vertex.\n\t * @param auditableItemGraphEdges.remove Target vertex IDs to disconnect; their back-edges are removed.\n\t * @returns A promise that resolves when the document has been updated.\n\t */\n\tupdatePartial(\n\t\tauditableItemGraphDocumentId: string,\n\t\tblob?: Uint8Array,\n\t\tannotationObject?: IJsonLdNodeObject,\n\t\tauditableItemGraphEdges?: {\n\t\t\tadd?: IDocumentManagementEdgeEntry[];\n\t\t\tremove?: string[];\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.includeDeletedEdges Flag to include soft-deleted edges in the response, defaults to false.\n\t * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.\n\t * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t * @param cursor The cursor to get the next chunk of revisions.\n\t * @param limit 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\tincludeDeletedEdges?: boolean;\n\t\t\textractRuleGroupId?: string;\n\t\t\textractMimeType?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IDocumentList;\n\t\tcursor?: string;\n\t}>;\n\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 document for the specified revision.\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 A promise that resolves when the revision has been removed.\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<{\n\t\tentries: IAuditableItemGraphVertexList;\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/IDocumentManagementEdgeEntry.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementEdgeEntry.js","sourceRoot":"","sources":["../../../src/models/IDocumentManagementEdgeEntry.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 * A single edge entry used when connecting a document to an AIG vertex.\n */\nexport interface IDocumentManagementEdgeEntry {\n\t/**\n\t * The target AIG vertex id to connect to.\n\t */\n\ttargetId: string;\n\n\t/**\n\t * Whether to add the document id as an alias on the connected vertex, defaults to false.\n\t */\n\taddAlias?: boolean;\n\n\t/**\n\t * Annotation object for the alias, if addAlias is true.\n\t */\n\taliasAnnotationObject?: IJsonLdNodeObject;\n}\n"]}

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

@@ -1 +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 { UneceDocumentCodeList } 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: UneceDocumentCodeList;\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"]}
+{"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 { UneceDocumentCodeList } from \"@twin.org/standards-unece\";\nimport type { IDocumentManagementEdgeEntry } from \"../IDocumentManagementEdgeEntry.js\";\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: UneceDocumentCodeList;\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?: IDocumentManagementEdgeEntry[];\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.map

@@ -1 +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?: 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?: 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?: 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?: 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"]}
+{"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?: 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?: 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?: 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?: string;\n\n\t\t/**\n\t\t * Include soft-deleted edges in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeDeletedEdges?: 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 * Limit 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/IDocumentManagementQueryRequest.js.map

@@ -1 +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"]}
+{"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 query a list of documents 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/IDocumentManagementUpdatePartialRequest.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDocumentManagementUpdatePartialRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementUpdatePartialRequest.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 { IDocumentManagementEdgeEntry } from \"../IDocumentManagementEdgeEntry.js\";\n\n/**\n * Request to partially update a document as an auditable item graph vertex.\n */\nexport interface IDocumentManagementUpdatePartialRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to update.\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 update 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 * Explicit edge delta to apply. Use `add` to create new connections and `remove` to\n\t\t * disconnect existing ones by their target vertex id.\n\t\t */\n\t\tauditableItemGraphEdges?: {\n\t\t\t/**\n\t\t\t * Connections to add; each entry creates a back-edge on the connected vertex.\n\t\t\t */\n\t\t\tadd?: IDocumentManagementEdgeEntry[];\n\n\t\t\t/**\n\t\t\t * Target vertex IDs to disconnect; their back-edges are removed.\n\t\t\t */\n\t\t\tremove?: string[];\n\t\t};\n\t};\n}\n"]}

package/dist/types/index.d.ts

@@ -7,12 +7,13 @@ 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/api/IDocumentManagementUpdatePartialRequest.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";
+export * from "./models/IDocumentManagementEdgeEntry.js";
 export * from "./models/documentManagementMetricIds.js";
 export * from "./models/documentManagementMetrics.js";

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

@@ -4,8 +4,9 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodeList } from "@twin.org/standards-unece";
 import type { IDocument } from "./IDocument.js";
 import type { IDocumentList } from "./IDocumentList.js";
+import type { IDocumentManagementEdgeEntry } from "./IDocumentManagementEdgeEntry.js";
 /**
- * Interface describing an document management contract.
+ * Interface describing a document management contract.
  */
 export interface IDocumentManagementComponent extends IComponent {
     /**
@@ -24,11 +25,7 @@ export interface IDocumentManagementComponent extends IComponent {
      * @param options.aliasAnnotationObject Annotation object for the alias.
      * @returns The auditable item graph vertex created for the document including its revision.
      */
-    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodeList, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
-        targetId: string;
-        addAlias?: boolean;
-        aliasAnnotationObject?: IJsonLdNodeObject;
-    }[], options?: {
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodeList, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: IDocumentManagementEdgeEntry[], options?: {
         createAttestation?: boolean;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
@@ -40,14 +37,19 @@ export interface IDocumentManagementComponent extends IComponent {
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
      * @param blob The data to update the document with.
      * @param annotationObject Additional information to associate with the document.
-     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
-     * @returns Nothing.
+     * @param auditableItemGraphEdges Explicit edge delta to apply. If undefined, existing connections
+     * are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing
+     * ones by their target vertex id. To update alias metadata on an already-connected vertex, include
+     * it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the
+     * alias is updated in place without creating a duplicate back-edge.
+     * @param auditableItemGraphEdges.add Connections to add; each creates a back-edge on the connected vertex.
+     * @param auditableItemGraphEdges.remove Target vertex IDs to disconnect; their back-edges are removed.
+     * @returns A promise that resolves when the document has been updated.
      */
-    update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
-        targetId: string;
-        addAlias?: boolean;
-        aliasAnnotationObject?: IJsonLdNodeObject;
-    }[]): Promise<void>;
+    updatePartial(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        add?: IDocumentManagementEdgeEntry[];
+        remove?: string[];
+    }): 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.
@@ -56,6 +58,7 @@ export interface IDocumentManagementComponent extends IComponent {
      * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * @param options.includeDeletedEdges Flag to include soft-deleted edges in the response, defaults to false.
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
@@ -67,6 +70,7 @@ export interface IDocumentManagementComponent extends IComponent {
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
+        includeDeletedEdges?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
     }, cursor?: string, limit?: number): Promise<{
@@ -83,7 +87,7 @@ 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.
-     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     * @returns The document for the specified revision.
      */
     getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
         includeBlobStorageMetadata?: boolean;
@@ -97,7 +101,7 @@ export interface IDocumentManagementComponent extends IComponent {
      * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
      * @param revision The revision of the document to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the revision has been removed.
      */
     removeRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;
     /**

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

@@ -0,0 +1,18 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * A single edge entry used when connecting a document to an AIG vertex.
+ */
+export interface IDocumentManagementEdgeEntry {
+    /**
+     * The target AIG vertex id to connect to.
+     */
+    targetId: string;
+    /**
+     * Whether to add the document id as an alias on the connected vertex, defaults to false.
+     */
+    addAlias?: boolean;
+    /**
+     * Annotation object for the alias, if addAlias is true.
+     */
+    aliasAnnotationObject?: IJsonLdNodeObject;
+}

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

@@ -1,5 +1,6 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodeList } from "@twin.org/standards-unece";
+import type { IDocumentManagementEdgeEntry } from "../IDocumentManagementEdgeEntry.js";
 /**
  * Request to create a document as an auditable item graph vertex.
  */
@@ -31,11 +32,7 @@ export interface IDocumentManagementCreateRequest {
         /**
          * The auditable item graph vertices to connect the document to.
          */
-        auditableItemGraphEdges?: {
-            targetId: string;
-            addAlias?: boolean;
-            aliasAnnotationObject?: IJsonLdNodeObject;
-        }[];
+        auditableItemGraphEdges?: IDocumentManagementEdgeEntry[];
         /**
          * Flag to create an attestation for the document, defaults to false.
          */

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

@@ -42,6 +42,11 @@ export interface IDocumentManagementGetRequest {
          * @default false
          */
         includeRemoved?: string;
+        /**
+         * Include soft-deleted edges in the response.
+         * @default false
+         */
+        includeDeletedEdges?: string;
         /**
          * If provided will extract data from the document using the specified rule group id.
          */
@@ -51,7 +56,7 @@ export interface IDocumentManagementGetRequest {
          */
         extractMimeType?: string;
         /**
-         * PLimit the number of items to return, defaults to 1 so only most recent is returned.
+         * Limit the number of items to return, defaults to 1 so only most recent is returned.
          * @default 1
          */
         limit?: string;

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

@@ -1,6 +1,6 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
- * Request to get a list of document from an auditable item graph vertex.
+ * Request to query a list of documents from an auditable item graph vertex.
  */
 export interface IDocumentManagementQueryRequest {
     /**

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

@@ -0,0 +1,43 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IDocumentManagementEdgeEntry } from "../IDocumentManagementEdgeEntry.js";
+/**
+ * Request to partially update a document as an auditable item graph vertex.
+ */
+export interface IDocumentManagementUpdatePartialRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to update.
+         */
+        auditableItemGraphDocumentId: string;
+    };
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The data to update the document with, in base64.
+         */
+        blob?: string;
+        /**
+         * Additional information to associate with the document.
+         */
+        annotationObject?: IJsonLdNodeObject;
+        /**
+         * Explicit edge delta to apply. Use `add` to create new connections and `remove` to
+         * disconnect existing ones by their target vertex id.
+         */
+        auditableItemGraphEdges?: {
+            /**
+             * Connections to add; each entry creates a back-edge on the connected vertex.
+             */
+            add?: IDocumentManagementEdgeEntry[];
+            /**
+             * Target vertex IDs to disconnect; their back-edges are removed.
+             */
+            remove?: string[];
+        };
+    };
+}

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.17](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.16...document-management-models-v0.0.3-next.17) (2026-06-18)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.15...document-management-models-v0.0.3-next.16) (2026-06-04)
+
+
+### Bug Fixes
+
+* replace destructive update() with updatePartial() for edge linking ([#50](https://github.com/iotaledger/twin-document-management/issues/50)) ([c1d2c33](https://github.com/iotaledger/twin-document-management/commit/c1d2c337c371bdcc1f23cac482393468ef84f0d7))
+
 ## [0.0.3-next.15](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.14...document-management-models-v0.0.3-next.15) (2026-05-22)
 
 

package/docs/reference/index.md

@@ -10,6 +10,7 @@
 - [IDocumentAttestation](interfaces/IDocumentAttestation.md)
 - [IDocumentList](interfaces/IDocumentList.md)
 - [IDocumentManagementComponent](interfaces/IDocumentManagementComponent.md)
+- [IDocumentManagementEdgeEntry](interfaces/IDocumentManagementEdgeEntry.md)
 - [IDocumentManagementCreateRequest](interfaces/IDocumentManagementCreateRequest.md)
 - [IDocumentManagementGetRequest](interfaces/IDocumentManagementGetRequest.md)
 - [IDocumentManagementGetResponse](interfaces/IDocumentManagementGetResponse.md)
@@ -18,7 +19,7 @@
 - [IDocumentManagementQueryRequest](interfaces/IDocumentManagementQueryRequest.md)
 - [IDocumentManagementQueryResponse](interfaces/IDocumentManagementQueryResponse.md)
 - [IDocumentManagementRemoveRequest](interfaces/IDocumentManagementRemoveRequest.md)
-- [IDocumentManagementUpdateRequest](interfaces/IDocumentManagementUpdateRequest.md)
+- [IDocumentManagementUpdatePartialRequest](interfaces/IDocumentManagementUpdatePartialRequest.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -1,6 +1,6 @@
 # Interface: IDocumentManagementComponent
 
-Interface describing an document management contract.
+Interface describing a document management contract.
 
 ## Extends
 
@@ -50,7 +50,7 @@ Additional information to associate with the document.
 
 ##### auditableItemGraphEdges?
 
-`object`[]
+[`IDocumentManagementEdgeEntry`](IDocumentManagementEdgeEntry.md)[]
 
 The auditable item graph vertices to connect the document to.
 
@@ -84,9 +84,9 @@ The auditable item graph vertex created for the document including its revision.
 
 ***
 
-### update() {#update}
+### updatePartial() {#updatepartial}
 
-> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
+> **updatePartial**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
 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.
@@ -114,15 +114,29 @@ Additional information to associate with the document.
 
 ##### auditableItemGraphEdges?
 
-`object`[]
+Explicit edge delta to apply. If undefined, existing connections
+are retained unchanged. Use `add` to create new connections and `remove` to disconnect existing
+ones by their target vertex id. To update alias metadata on an already-connected vertex, include
+it in `add` with the updated `aliasAnnotationObject` — AIG's alias patch is an upsert, so the
+alias is updated in place without creating a duplicate back-edge.
 
-The auditable item graph vertices to connect the document to, if undefined retains current connections.
+###### add?
+
+[`IDocumentManagementEdgeEntry`](IDocumentManagementEdgeEntry.md)[]
+
+Connections to add; each creates a back-edge on the connected vertex.
+
+###### remove?
+
+`string`[]
+
+Target vertex IDs to disconnect; their back-edges are removed.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the document has been updated.
 
 ***
 
@@ -168,6 +182,12 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, defaults to false.
 
+###### includeDeletedEdges?
+
+`boolean`
+
+Flag to include soft-deleted edges in the response, defaults to false.
+
 ###### extractRuleGroupId?
 
 `string`
@@ -258,7 +278,7 @@ By default extraction will auto detect the mime type of the document, this can b
 
 `Promise`\<[`IDocument`](IDocument.md)\>
 
-The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+The document for the specified revision.
 
 ***
 
@@ -287,7 +307,7 @@ The revision of the document to remove.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the revision has been removed.
 
 ***
 

package/docs/reference/interfaces/IDocumentManagementCreateRequest.md

@@ -42,7 +42,7 @@ Additional information to associate with the document.
 
 #### auditableItemGraphEdges?
 
-> `optional` **auditableItemGraphEdges?**: `object`[]
+> `optional` **auditableItemGraphEdges?**: [`IDocumentManagementEdgeEntry`](IDocumentManagementEdgeEntry.md)[]
 
 The auditable item graph vertices to connect the document to.
 

package/docs/reference/interfaces/IDocumentManagementEdgeEntry.md

@@ -0,0 +1,27 @@
+# Interface: IDocumentManagementEdgeEntry
+
+A single edge entry used when connecting a document to an AIG vertex.
+
+## Properties
+
+### targetId {#targetid}
+
+> **targetId**: `string`
+
+The target AIG vertex id to connect to.
+
+***
+
+### addAlias? {#addalias}
+
+> `optional` **addAlias?**: `boolean`
+
+Whether to add the document id as an alias on the connected vertex, defaults to false.
+
+***
+
+### aliasAnnotationObject? {#aliasannotationobject}
+
+> `optional` **aliasAnnotationObject?**: `IJsonLdNodeObject`
+
+Annotation object for the alias, if addAlias is true.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -84,6 +84,18 @@ Include deleted documents in the response.
 false
 ```
 
+#### includeDeletedEdges?
+
+> `optional` **includeDeletedEdges?**: `string`
+
+Include soft-deleted edges in the response.
+
+##### Default
+
+```ts
+false
+```
+
 #### extractRuleGroupId?
 
 > `optional` **extractRuleGroupId?**: `string`
@@ -100,7 +112,7 @@ By default extraction will auto detect the mime type of the document, this can b
 
 > `optional` **limit?**: `string`
 
-PLimit the number of items to return, defaults to 1 so only most recent is returned.
+Limit the number of items to return, defaults to 1 so only most recent is returned.
 
 ##### Default
 

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -1,6 +1,6 @@
 # Interface: IDocumentManagementQueryRequest
 
-Request to get a list of document from an auditable item graph vertex.
+Request to query a list of documents from an auditable item graph vertex.
 
 ## Properties
 

package/docs/reference/interfaces/IDocumentManagementUpdatePartialRequest.md

@@ -0,0 +1,56 @@
+# Interface: IDocumentManagementUpdatePartialRequest
+
+Request to partially update a document as an auditable item graph vertex.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to update.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The body parameters.
+
+#### blob?
+
+> `optional` **blob?**: `string`
+
+The data to update the document with, in base64.
+
+#### annotationObject?
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges?**: `object`
+
+Explicit edge delta to apply. Use `add` to create new connections and `remove` to
+disconnect existing ones by their target vertex id.
+
+##### auditableItemGraphEdges.add?
+
+> `optional` **add?**: [`IDocumentManagementEdgeEntry`](IDocumentManagementEdgeEntry.md)[]
+
+Connections to add; each entry creates a back-edge on the connected vertex.
+
+##### auditableItemGraphEdges.remove?
+
+> `optional` **remove?**: `string`[]
+
+Target vertex IDs to disconnect; their back-edges are removed.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.3-next.15",
+	"version": "0.0.3-next.17",
 	"description": "Shared data models, schemas, and context definitions for document lifecycle records.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/iotaledger/document-management.git",
+		"url": "git+https://github.com/iotaledger/twin-document-management.git",
 		"directory": "packages/document-management-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -57,7 +57,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/iotaledger/document-management/issues"
+		"url": "git+https://github.com/iotaledger/twin-document-management/issues"
 	},
 	"homepage": "https://twindev.org"
 }

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

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

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

@@ -1 +0,0 @@
-{"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/types/models/api/IDocumentManagementUpdateRequest.d.ts

@@ -1,36 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-/**
- * Request to update a document as an auditable item graph vertex.
- */
-export interface IDocumentManagementUpdateRequest {
-    /**
-     * The path parameters.
-     */
-    pathParams: {
-        /**
-         * The full id of the document to get.
-         */
-        auditableItemGraphDocumentId: string;
-    };
-    /**
-     * The body parameters.
-     */
-    body: {
-        /**
-         * The data to create the document with, in base64.
-         */
-        blob?: string;
-        /**
-         * Additional information to associate with the document.
-         */
-        annotationObject?: IJsonLdNodeObject;
-        /**
-         * The auditable item graph vertices to connect the document to.
-         */
-        auditableItemGraphEdges?: {
-            targetId: string;
-            addAlias?: boolean;
-            aliasAnnotationObject?: IJsonLdNodeObject;
-        }[];
-    };
-}

package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md

@@ -1,43 +0,0 @@
-# Interface: IDocumentManagementUpdateRequest
-
-Request to update a document as an auditable item graph vertex.
-
-## Properties
-
-### pathParams {#pathparams}
-
-> **pathParams**: `object`
-
-The path parameters.
-
-#### auditableItemGraphDocumentId
-
-> **auditableItemGraphDocumentId**: `string`
-
-The full id of the document to get.
-
-***
-
-### body {#body}
-
-> **body**: `object`
-
-The body parameters.
-
-#### blob?
-
-> `optional` **blob?**: `string`
-
-The data to create the document with, in base64.
-
-#### annotationObject?
-
-> `optional` **annotationObject?**: `IJsonLdNodeObject`
-
-Additional information to associate with the document.
-
-#### auditableItemGraphEdges?
-
-> `optional` **auditableItemGraphEdges?**: `object`[]
-
-The auditable item graph vertices to connect the document to.