@twin.org/document-management-models 0.0.2-next.4 → 0.0.3-next.2

package/dist/esm/index.mjs

@@ -1,186 +0,0 @@
-import { DataTypeHandlerFactory } from '@twin.org/data-core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of document management objects.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-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/"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The types of document management objects.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const DocumentTypes = {
-    /**
-     * Represents a document.
-     */
-    Document: "Document",
-    /**
-     * Represents a document attestation.
-     */
-    DocumentAttestation: "DocumentAttestation"
-};
-
-var $schema = "https://json-schema.org/draft/2020-12/schema";
-var $id = "https://schema.twindev.org/documents/Document";
-var description = "Interface describing a document.";
-var type = "object";
-var properties = {
-	"@context": {
-		type: "array",
-		minItems: 3,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		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"
-			}
-		]
-	},
-	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."
-	},
-	nodeIdentity: {
-		type: "string",
-		description: "The node which added the document to the graph."
-	},
-	userIdentity: {
-		type: "string",
-		description: "The user who added the document to the graph."
-	}
-};
-var required = [
-	"@context",
-	"type",
-	"id",
-	"documentId",
-	"documentCode",
-	"documentRevision",
-	"blobStorageId",
-	"blobHash",
-	"dateCreated",
-	"nodeIdentity",
-	"userIdentity"
-];
-var additionalProperties = false;
-var DocumentSchema = {
-	$schema: $schema,
-	$id: $id,
-	description: description,
-	type: type,
-	properties: properties,
-	required: required,
-	additionalProperties: additionalProperties
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Handle all the data types for document management.
- */
-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
-        }));
-    }
-}
-
-export { DocumentContexts, DocumentManagementDataTypes, DocumentTypes };