@3sixty/document-management-models 0.0.0-stage → 0.20.0-next.1

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

@@ -0,0 +1,42 @@
+import type { IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { IDocumentBase } from "../IDocumentBase.js";
+import type { IDocumentManagementEdgeEntry } from "../IDocumentManagementEdgeEntry.js";
+/**
+ * Request to create a document as an auditable item graph vertex.
+ */
+export interface IDocumentManagementCreateRequest {
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The document base properties.
+         */
+        document: IDocumentBase;
+        /**
+         * The data to create the document with, either as base64-encoded content or an existing blob storage entry id.
+         */
+        blob: string;
+        /**
+         * The auditable item graph vertices to connect the document to.
+         */
+        auditableItemGraphEdges?: IDocumentManagementEdgeEntry[];
+        /**
+         * Additional options for the create operation.
+         */
+        options?: {
+            /**
+             * Flag to create an attestation for the document, defaults to false.
+             */
+            includeAttestation?: boolean;
+            /**
+             * Flag to add the document id as an alias to the aig vertex, defaults to true.
+             */
+            includeAlias?: boolean;
+            /**
+             * Annotation object for the alias.
+             */
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        };
+    };
+}

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

@@ -0,0 +1,68 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+/**
+ * Request to get a document from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to get.
+         */
+        auditableItemGraphDocumentId: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Include the blob storage metadata in the response.
+         * @default false
+         */
+        includeBlobStorageMetadata?: string;
+        /**
+         * Include the blob storage data in the response.
+         * @default false
+         */
+        includeBlobStorageData?: string;
+        /**
+         * Include the attestation information in the response.
+         * @default false
+         */
+        includeAttestation?: string;
+        /**
+         * Include deleted documents in the response.
+         * @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.
+         */
+        extractRuleGroupId?: string;
+        /**
+         * By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+         */
+        extractMimeType?: string;
+        /**
+         * Limit the number of items to return, defaults to 1 so only most recent is returned.
+         * @default 1
+         */
+        limit?: string;
+        /**
+         * The cursor to get the next chunk of revisions.
+         */
+        cursor?: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IDocumentList } from "../IDocumentList.js";
+/**
+ * Response to get a document and optionally revisions from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The body parameters.
+     */
+    body: IDocumentList;
+}

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

@@ -0,0 +1,53 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+/**
+ * Request to get a document revision from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRevisionRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to get.
+         */
+        auditableItemGraphDocumentId: string;
+        /**
+         * The revision of the document to get.
+         */
+        revision: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Include the blob storage metadata in the response.
+         * @default false
+         */
+        includeBlobStorageMetadata?: string;
+        /**
+         * Include the blob storage data in the response.
+         * @default false
+         */
+        includeBlobStorageData?: string;
+        /**
+         * Include the attestation information in the response.
+         * @default false
+         */
+        includeAttestation?: string;
+        /**
+         * If provided will extract data from the document using the specified rule group id.
+         */
+        extractRuleGroupId?: string;
+        /**
+         * By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+         */
+        extractMimeType?: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+import type { IDocument } from "../IDocument.js";
+/**
+ * Response to get a document revision from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRevisionResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The body parameters.
+     */
+    body: IDocument;
+}

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

@@ -0,0 +1,29 @@
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+/**
+ * Request to query a list of documents from an auditable item graph vertex.
+ */
+export interface IDocumentManagementQueryRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The id of the document id we are trying to find.
+         */
+        documentId: string;
+        /**
+         * The cursor to get the next chunk of documents.
+         */
+        cursor?: string;
+        /**
+         * The number of documents to return.
+         */
+        limit?: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+import type { IAuditableItemGraphVertexList } from "@3sixty/auditable-item-graph-models";
+import type { HeaderTypes, MimeTypes } from "@3sixty/web";
+/**
+ * Response to query the documents from an auditable item graph vertex.
+ */
+export interface IDocumentManagementQueryResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The body parameters.
+     */
+    body: IAuditableItemGraphVertexList;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to remove a document revision from an auditable item graph.
+ */
+export interface IDocumentManagementRemoveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the auditable item graph vertex to remove the revision from.
+         */
+        auditableItemGraphDocumentId: string;
+        /**
+         * The revision of the document to remove.
+         */
+        revision: string;
+    };
+}

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

@@ -0,0 +1,61 @@
+import type { IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { IDocumentBase } from "../IDocumentBase.js";
+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 document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.
+         */
+        document?: Partial<Pick<IDocumentBase, "annotationObject" | "documentIdFormat" | "documentCode">>;
+        /**
+         * The data to update the document with, either as base64-encoded content or an existing blob storage entry id.
+         */
+        blob?: string;
+        /**
+         * 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[];
+        };
+        /**
+         * Additional options for the update operation.
+         */
+        options?: {
+            /**
+             * 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.
+             */
+            includeAttestation?: boolean;
+            /**
+             * 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.
+             */
+            includeAlias?: boolean;
+            /**
+             * Annotation object for the alias when adding.
+             */
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        };
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * The contexts of document management objects.
+ */
+export declare const DocumentContexts: {
+    /**
+     * The canonical RDF namespace URI for Document Management.
+     */
+    readonly Namespace: "https://schema.3sixty.global/documents/";
+    /**
+     * The value to use in context for Document Management.
+     */
+    readonly Context: "https://schema.3sixty.global/documents/";
+    /**
+     * The JSON-LD Context URL for Document Management.
+     */
+    readonly JsonLdContext: "https://schema.3sixty.global/documents/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    readonly NamespaceCommon: "https://schema.3sixty.global/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.3sixty.global/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.3sixty.global/common/types.jsonld";
+};
+/**
+ * The contexts of document management objects.
+ */
+export type DocumentContexts = (typeof DocumentContexts)[keyof typeof DocumentContexts];

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

@@ -0,0 +1,29 @@
+/**
+ * Metric IDs for the document management service.
+ */
+export declare const DocumentManagementMetricIds: {
+    /**
+     * Number of documents created.
+     */
+    readonly DocumentsCreated: "dm_documents_created";
+    /**
+     * Number of documents updated.
+     */
+    readonly DocumentsUpdated: "dm_documents_updated";
+    /**
+     * Number of document revisions created.
+     */
+    readonly RevisionsCreated: "dm_revisions_created";
+    /**
+     * Number of document revisions removed.
+     */
+    readonly RevisionsRemoved: "dm_revisions_removed";
+    /**
+     * Number of document attestations created.
+     */
+    readonly AttestationsCreated: "dm_attestations_created";
+};
+/**
+ * Metric IDs for the document management service.
+ */
+export type DocumentManagementMetricIds = (typeof DocumentManagementMetricIds)[keyof typeof DocumentManagementMetricIds];

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

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@3sixty/telemetry-models";
+/**
+ * Metrics registered by the document management service.
+ */
+export declare const DocumentManagementMetrics: ITelemetryMetric[];

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

@@ -0,0 +1,25 @@
+/**
+ * The types of document management objects.
+ */
+export declare const DocumentTypes: {
+    /**
+     * Represents a document.
+     */
+    readonly Document: "Document";
+    /**
+     * Represents a document hydrated.
+     */
+    readonly DocumentHydrated: "DocumentHydrated";
+    /**
+     * Represents a document attestation.
+     */
+    readonly DocumentAttestation: "DocumentAttestation";
+    /**
+     * Represents a document list.
+     */
+    readonly DocumentList: "DocumentList";
+};
+/**
+ * The types of document management objects.
+ */
+export type DocumentTypes = (typeof DocumentTypes)[keyof typeof DocumentTypes];

package/docs/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/document-management/compare/document-management-models-v0.20.0-next.0...document-management-models-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([43b64db](https://github.com/3sixtyglobal/document-management/commit/43b64db2a8397c4dfae45c435ce9c14b5c1a6618))
+* updated ts compile ([9c2594e](https://github.com/3sixtyglobal/document-management/commit/9c2594ef363773f154286845bca15e69d380dc07))

package/docs/examples.md

@@ -0,0 +1,23 @@
+# Document Management Models Examples
+
+These snippets show typical setup steps for registering data types and creating document-shaped data that can be validated and exchanged consistently.
+
+## DocumentManagementDataTypes
+
+```typescript
+import { DataTypeHandlerFactory } from '@3sixty/data-core';
+import {
+  DocumentContexts,
+  DocumentManagementDataTypes,
+  DocumentTypes
+} from '@3sixty/document-management-models';
+
+DocumentManagementDataTypes.registerTypes();
+
+const handler = DataTypeHandlerFactory.get(
+  `${DocumentContexts.Namespace}${DocumentTypes.Document}`
+);
+
+console.log(handler.namespace); // https://schema.3sixty.global/document-management/
+console.log(handler.type); // Document
+```

package/docs/reference/classes/DocumentManagementDataTypes.md

@@ -0,0 +1,25 @@
+# Class: DocumentManagementDataTypes
+
+Handle all the data types for document management.
+
+## Constructors
+
+### Constructor
+
+> **new DocumentManagementDataTypes**(): `DocumentManagementDataTypes`
+
+#### Returns
+
+`DocumentManagementDataTypes`
+
+## Methods
+
+### registerTypes() {#registertypes}
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,42 @@
+# @3sixty/document-management-models
+
+## Classes
+
+- [DocumentManagementDataTypes](classes/DocumentManagementDataTypes.md)
+
+## Interfaces
+
+- [IDocument](interfaces/IDocument.md)
+- [IDocumentAttestation](interfaces/IDocumentAttestation.md)
+- [IDocumentBase](interfaces/IDocumentBase.md)
+- [IDocumentHydrated](interfaces/IDocumentHydrated.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)
+- [IDocumentManagementGetRevisionRequest](interfaces/IDocumentManagementGetRevisionRequest.md)
+- [IDocumentManagementGetRevisionResponse](interfaces/IDocumentManagementGetRevisionResponse.md)
+- [IDocumentManagementQueryRequest](interfaces/IDocumentManagementQueryRequest.md)
+- [IDocumentManagementQueryResponse](interfaces/IDocumentManagementQueryResponse.md)
+- [IDocumentManagementRemoveRequest](interfaces/IDocumentManagementRemoveRequest.md)
+- [IDocumentManagementUpdatePartialRequest](interfaces/IDocumentManagementUpdatePartialRequest.md)
+
+## Type Aliases
+
+- [DocumentContexts](type-aliases/DocumentContexts.md)
+- [DocumentManagementMetricIds](type-aliases/DocumentManagementMetricIds.md)
+- [DocumentTypes](type-aliases/DocumentTypes.md)
+
+## Variables
+
+- [CompiledDocument](variables/CompiledDocument.md)
+- [CompiledDocumentAttestation](variables/CompiledDocumentAttestation.md)
+- [CompiledDocumentBase](variables/CompiledDocumentBase.md)
+- [CompiledDocumentHydrated](variables/CompiledDocumentHydrated.md)
+- [CompiledDocumentList](variables/CompiledDocumentList.md)
+- [DocumentContexts](variables/DocumentContexts.md)
+- [DocumentManagementMetricIds](variables/DocumentManagementMetricIds.md)
+- [DocumentManagementMetrics](variables/DocumentManagementMetrics.md)
+- [DocumentTypes](variables/DocumentTypes.md)

package/docs/reference/interfaces/IDocument.md

@@ -0,0 +1,155 @@
+# Interface: IDocument
+
+Interface describing a document.
+
+## Extends
+
+- [`IDocumentBase`](IDocumentBase.md)
+
+## Extended by
+
+- [`IDocumentHydrated`](IDocumentHydrated.md)
+
+## Properties
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.3sixty.global/documents/"`, `"https://schema.3sixty.global/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: `"Document"`
+
+JSON-LD Type.
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+The full id of the document.
+
+***
+
+### documentRevision {#documentrevision}
+
+> **documentRevision**: `number`
+
+The revision of the document as a 0 based index.
+
+***
+
+### blobStorageId {#blobstorageid}
+
+> **blobStorageId**: `string`
+
+The blob storage id for the document.
+
+***
+
+### integrity {#integrity}
+
+> **integrity**: `string`
+
+The integrity of the blob data.
+
+***
+
+### attestationId? {#attestationid}
+
+> `optional` **attestationId?**: `string`
+
+The attestation for the document if one was created.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date/time of when the document was created.
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the document was modified.
+
+***
+
+### dateDeleted? {#datedeleted}
+
+> `optional` **dateDeleted?**: `string`
+
+The date/time of when the document was deleted, as we never actually remove items.
+
+***
+
+### organizationIdentity? {#organizationidentity}
+
+> `optional` **organizationIdentity?**: `string`
+
+The organization which added the document to the graph.
+
+***
+
+### userIdentity? {#useridentity}
+
+> `optional` **userIdentity?**: `string`
+
+The user who added the document to the graph.
+
+***
+
+### documentId {#documentid}
+
+> **documentId**: `string`
+
+The id of the document.
+
+#### Inherited from
+
+[`IDocumentBase`](IDocumentBase.md).[`documentId`](IDocumentBase.md#documentid)
+
+***
+
+### documentIdFormat? {#documentidformat}
+
+> `optional` **documentIdFormat?**: `string`
+
+The format of the document id.
+
+#### Inherited from
+
+[`IDocumentBase`](IDocumentBase.md).[`documentIdFormat`](IDocumentBase.md#documentidformat)
+
+***
+
+### documentCode {#documentcode}
+
+> **documentCode**: `UneceDocumentCodeList`
+
+The code for the document type.
+
+#### Inherited from
+
+[`IDocumentBase`](IDocumentBase.md).[`documentCode`](IDocumentBase.md#documentcode)
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+Additional annotation information for the document.
+
+#### Inherited from
+
+[`IDocumentBase`](IDocumentBase.md).[`annotationObject`](IDocumentBase.md#annotationobject)