@3sixty/document-management-service 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IDocumentManagementServiceConfig.md

@@ -0,0 +1,11 @@
+# Interface: IDocumentManagementServiceConfig
+
+Configuration for the document management service.
+
+## Properties
+
+### mutexTimeoutMs? {#mutextimeoutms}
+
+> `optional` **mutexTimeoutMs?**: `number`
+
+The timeout in milliseconds for acquiring a mutex lock.

package/docs/reference/interfaces/IDocumentManagementServiceConstructorOptions.md

@@ -0,0 +1,75 @@
+# Interface: IDocumentManagementServiceConstructorOptions
+
+Options for the document management Service constructor.
+
+## Properties
+
+### auditableItemGraphComponentType? {#auditableitemgraphcomponenttype}
+
+> `optional` **auditableItemGraphComponentType?**: `string`
+
+The type of the auditable item graph component.
+
+#### Default
+
+```ts
+auditable-item-graph
+```
+
+***
+
+### blobStorageComponentType? {#blobstoragecomponenttype}
+
+> `optional` **blobStorageComponentType?**: `string`
+
+The type of the blob storage component.
+
+#### Default
+
+```ts
+blob-storage
+```
+
+***
+
+### attestationComponentType? {#attestationcomponenttype}
+
+> `optional` **attestationComponentType?**: `string`
+
+The type of the attestation component.
+
+#### Default
+
+```ts
+attestation
+```
+
+***
+
+### dataProcessingComponentType? {#dataprocessingcomponenttype}
+
+> `optional` **dataProcessingComponentType?**: `string`
+
+The type of the data processing component.
+
+#### Default
+
+```ts
+data-processing
+```
+
+***
+
+### telemetryComponentType? {#telemetrycomponenttype}
+
+> `optional` **telemetryComponentType?**: `string`
+
+The type of the telemetry component used for event metrics.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IDocumentManagementServiceConfig`](IDocumentManagementServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,5 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+REST entry points for the document management service.

package/docs/reference/variables/tagsDocumentManagement.md

@@ -0,0 +1,5 @@
+# Variable: tagsDocumentManagement
+
+> `const` **tagsDocumentManagement**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,22 @@
+{
+	"error": {
+		"documentManagementService": {
+			"createFailed": "Failed to create document",
+			"connectedVertexNotFound": "The connected vertex \"{notFoundId}\" does not exist",
+			"updateFailed": "Failed to update document",
+			"getFailed": "Failed to get document",
+			"getRevisionFailed": "Failed to get document revision",
+			"queryFailed": "Failed to query document",
+			"documentRevisionNone": "There are no revisions in the document",
+			"documentRevisionNotFound": "There is no revision number \"{notFoundId}\" in the document",
+			"documentRevisionMissingId": "Revision {revision} was found but has no resolvable resource id — possible data integrity issue",
+			"removeRevisionFailed": "Failed to remove document revision"
+		}
+	},
+	"health": {
+		"documentManagementService": {
+			"healthDescription": "Document management service application health check",
+			"getBlobFailed": "Failed to retrieve the health check blob"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,69 @@
 {
-  "name": "@3sixty/document-management-service",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/document-management-service",
+	"version": "0.20.0-next.0",
+	"description": "Service-side document lifecycle operations and REST route generation for server integrations.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/document-management.git",
+		"directory": "packages/document-management-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "next",
+		"@3sixty/attestation-models": "next",
+		"@3sixty/auditable-item-graph-models": "next",
+		"@3sixty/blob-storage-models": "next",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/crypto": "next",
+		"@3sixty/data-json-ld": "next",
+		"@3sixty/data-processing-models": "next",
+		"@3sixty/document-management-models": "0.20.0-next.0",
+		"@3sixty/entity": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/standards-schema-org": "next",
+		"@3sixty/standards-unece": "next",
+		"@3sixty/telemetry-models": "next",
+		"@3sixty/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"document-management",
+		"documents",
+		"management",
+		"storage",
+		"rest-api",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/document-management/issues"
+	},
+	"homepage": "https://3sixty.global"
+}