@twin.org/node 0.0.3-next.62 → 0.0.3-next.63

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.63](https://github.com/iotaledger/twin-node/compare/node-v0.0.3-next.62...node-v0.0.3-next.63) (2026-06-22)
4
+
5
+
6
+ ### Features
7
+
8
+ * update document management components ([ed2c065](https://github.com/iotaledger/twin-node/commit/ed2c065a5030a7233f3623818d7325d85654ef0d))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/node-core bumped from 0.0.3-next.62 to 0.0.3-next.63
16
+
3
17
  ## [0.0.3-next.62](https://github.com/iotaledger/twin-node/compare/node-v0.0.3-next.61...node-v0.0.3-next.62) (2026-06-19)
4
18
 
5
19
 
@@ -10542,16 +10542,20 @@
10542
10542
  "examples": {
10543
10543
  "DocumentManagementCreateRequestExample": {
10544
10544
  "value": {
10545
- "documentId": "2721000",
10546
- "documentIdFormat": "bol",
10547
- "documentCode": "unece:DocumentCodeList#705",
10548
- "blob": "SGVsbG8gV29ybGQ=",
10549
- "annotationObject": {
10550
- "@context": "https://schema.org",
10551
- "@type": "DigitalDocument",
10552
- "name": "myfile.pdf"
10545
+ "document": {
10546
+ "documentId": "2721000",
10547
+ "documentIdFormat": "bol",
10548
+ "documentCode": "unece:DocumentCodeList#705",
10549
+ "annotationObject": {
10550
+ "@context": "https://schema.org",
10551
+ "@type": "DigitalDocument",
10552
+ "name": "myfile.pdf"
10553
+ }
10553
10554
  },
10554
- "createAttestation": true
10555
+ "blob": "SGVsbG8gV29ybGQ=",
10556
+ "options": {
10557
+ "includeAttestation": true
10558
+ }
10555
10559
  }
10556
10560
  }
10557
10561
  }
@@ -10811,12 +10815,14 @@
10811
10815
  "examples": {
10812
10816
  "DocumentManagementUpdatePartialRequestExample": {
10813
10817
  "value": {
10814
- "blob": "SGVsbG8gV29ybGQ=",
10815
- "annotationObject": {
10816
- "@context": "https://schema.org",
10817
- "@type": "DigitalDocument",
10818
- "name": "myfile.pdf"
10819
- }
10818
+ "document": {
10819
+ "annotationObject": {
10820
+ "@context": "https://schema.org",
10821
+ "@type": "DigitalDocument",
10822
+ "name": "myfile.pdf"
10823
+ }
10824
+ },
10825
+ "blob": "SGVsbG8gV29ybGQ="
10820
10826
  }
10821
10827
  }
10822
10828
  }
@@ -21717,23 +21723,12 @@
21717
21723
  "DocumentManagementCreateRequest": {
21718
21724
  "type": "object",
21719
21725
  "properties": {
21720
- "documentId": {
21721
- "type": "string",
21722
- "description": "The document id to create."
21723
- },
21724
- "documentIdFormat": {
21725
- "type": "string",
21726
- "description": "The format of the document identifier."
21727
- },
21728
- "documentCode": {
21729
- "$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList"
21726
+ "document": {
21727
+ "$ref": "https://schema.twindev.org/documents/DocumentBase"
21730
21728
  },
21731
21729
  "blob": {
21732
21730
  "type": "string",
21733
- "description": "The data to create the document with, in base64."
21734
- },
21735
- "annotationObject": {
21736
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
21731
+ "description": "The data to create the document with, either as base64-encoded content or an existing blob storage entry id."
21737
21732
  },
21738
21733
  "auditableItemGraphEdges": {
21739
21734
  "type": "array",
@@ -21742,22 +21737,26 @@
21742
21737
  },
21743
21738
  "description": "The auditable item graph vertices to connect the document to."
21744
21739
  },
21745
- "createAttestation": {
21746
- "type": "boolean",
21747
- "description": "Flag to create an attestation for the document, defaults to false."
21748
- },
21749
- "addAlias": {
21750
- "type": "boolean",
21751
- "description": "Flag to add the document id as an alias to the aig vertex, defaults to true."
21752
- },
21753
- "aliasAnnotationObject": {
21754
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
21740
+ "options": {
21741
+ "type": "object",
21742
+ "properties": {
21743
+ "includeAttestation": {
21744
+ "type": "boolean",
21745
+ "description": "Flag to create an attestation for the document, defaults to false."
21746
+ },
21747
+ "includeAlias": {
21748
+ "type": "boolean",
21749
+ "description": "Flag to add the document id as an alias to the aig vertex, defaults to true."
21750
+ },
21751
+ "aliasAnnotationObject": {
21752
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
21753
+ }
21754
+ },
21755
+ "description": "Additional options for the create operation."
21755
21756
  }
21756
21757
  },
21757
21758
  "required": [
21758
- "documentId",
21759
- "documentIdFormat",
21760
- "documentCode",
21759
+ "document",
21761
21760
  "blob"
21762
21761
  ],
21763
21762
  "description": "The body parameters."
@@ -21765,12 +21764,25 @@
21765
21764
  "DocumentManagementUpdatePartialRequest": {
21766
21765
  "type": "object",
21767
21766
  "properties": {
21767
+ "document": {
21768
+ "description": "The document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.",
21769
+ "type": "object",
21770
+ "properties": {
21771
+ "documentIdFormat": {
21772
+ "type": "string",
21773
+ "description": "The format of the document id."
21774
+ },
21775
+ "documentCode": {
21776
+ "$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList"
21777
+ },
21778
+ "annotationObject": {
21779
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
21780
+ }
21781
+ }
21782
+ },
21768
21783
  "blob": {
21769
21784
  "type": "string",
21770
- "description": "The data to update the document with, in base64."
21771
- },
21772
- "annotationObject": {
21773
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
21785
+ "description": "The data to update the document with, either as base64-encoded content or an existing blob storage entry id."
21774
21786
  },
21775
21787
  "auditableItemGraphEdges": {
21776
21788
  "type": "object",
@@ -21791,6 +21803,23 @@
21791
21803
  }
21792
21804
  },
21793
21805
  "description": "Explicit edge delta to apply. Use `add` to create new connections and `remove` to\ndisconnect existing ones by their target vertex id."
21806
+ },
21807
+ "options": {
21808
+ "type": "object",
21809
+ "properties": {
21810
+ "includeAttestation": {
21811
+ "type": "boolean",
21812
+ "description": "Set to true to start attesting the document (even if originally created without attestation), or false to remove the existing attestation. Omit to leave attestation state unchanged."
21813
+ },
21814
+ "includeAlias": {
21815
+ "type": "boolean",
21816
+ "description": "Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave alias state unchanged."
21817
+ },
21818
+ "aliasAnnotationObject": {
21819
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
21820
+ }
21821
+ },
21822
+ "description": "Additional options for the update operation."
21794
21823
  }
21795
21824
  },
21796
21825
  "description": "The body parameters."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/node",
3
- "version": "0.0.3-next.62",
3
+ "version": "0.0.3-next.63",
4
4
  "description": "TWIN Node serving APIs using the specified configuration",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/node-core": "0.0.3-next.62"
17
+ "@twin.org/node-core": "0.0.3-next.63"
18
18
  },
19
19
  "bugs": {
20
20
  "url": "git+https://github.com/iotaledger/twin-node/issues"