@twin.org/auditable-item-graph-models 0.0.2-next.7 → 0.0.3-next.0

package/dist/cjs/index.cjs

@@ -1,716 +0,0 @@
-'use strict';
-
-var dataCore = require('@twin.org/data-core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of auditable item graph data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const AuditableItemGraphContexts = {
-    /**
-     * The context root for the auditable item graph types.
-     */
-    ContextRoot: "https://schema.twindev.org/aig/",
-    /**
-     * 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 auditable item graph data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const AuditableItemGraphTypes = {
-    /**
-     * Represents auditable item graph vertex.
-     */
-    Vertex: "AuditableItemGraphVertex",
-    /**
-     * Represents auditable item graph vertex list.
-     */
-    VertexList: "AuditableItemGraphVertexList",
-    /**
-     * Represents auditable item graph alias.
-     */
-    Alias: "AuditableItemGraphAlias",
-    /**
-     * Represents auditable item graph resource.
-     */
-    Resource: "AuditableItemGraphResource",
-    /**
-     * Represents auditable item graph edge.
-     */
-    Edge: "AuditableItemGraphEdge",
-    /**
-     * Represents auditable item graph  changeset.
-     */
-    Changeset: "AuditableItemGraphChangeset",
-    /**
-     * Represents patch operation.
-     */
-    PatchOperation: "AuditableItemGraphPatchOperation"
-};
-
-var $schema$6 = "https://json-schema.org/draft/2020-12/schema";
-var $id$6 = "https://schema.twindev.org/aig/AuditableItemGraphAlias";
-var description$6 = "Interface describing an alias for a vertex.";
-var type$6 = "object";
-var properties$6 = {
-	id: {
-		type: "string",
-		description: "The id of the element."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of when the element was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time of when the element was modified."
-	},
-	dateDeleted: {
-		type: "string",
-		description: "The date/time of when the element was deleted, as we never actually remove items."
-	},
-	"@context": {
-		anyOf: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "array",
-				minItems: 1,
-				items: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-				},
-				prefixItems: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				]
-			}
-		],
-		description: "JSON-LD Context."
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphAlias",
-		description: "JSON-LD Type."
-	},
-	annotationObject: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD annotation object for the alias."
-	},
-	aliasFormat: {
-		type: "string",
-		description: "The format of the id in the alias."
-	}
-};
-var required$6 = [
-	"@context",
-	"id",
-	"type"
-];
-var additionalProperties$6 = false;
-var AuditableItemGraphAliasSchema = {
-	$schema: $schema$6,
-	$id: $id$6,
-	description: description$6,
-	type: type$6,
-	properties: properties$6,
-	required: required$6,
-	additionalProperties: additionalProperties$6
-};
-
-var $schema$5 = "https://json-schema.org/draft/2020-12/schema";
-var $id$5 = "https://schema.twindev.org/aig/AuditableItemGraphChangeset";
-var description$5 = "Interface describing a set of changes to the vertex.";
-var type$5 = "object";
-var properties$5 = {
-	"@context": {
-		type: "array",
-		minItems: 2,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/common/"
-			}
-		]
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphChangeset",
-		description: "JSON-LD Type."
-	},
-	id: {
-		type: "string",
-		description: "The id of the changeset."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of when the changeset was created."
-	},
-	userIdentity: {
-		type: "string",
-		description: "The user identity that created the changes."
-	},
-	patches: {
-		type: "array",
-		items: false,
-		description: "The patches in the changeset.",
-		prefixItems: [
-			{
-				$ref: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"
-			}
-		]
-	},
-	proofId: {
-		type: "string",
-		description: "The immutable proof id which contains the signature for this changeset."
-	},
-	verification: {
-		$ref: "https://schema.twindev.org/immutable-proof/ImmutableProofVerification",
-		description: "The verification for the changeset."
-	}
-};
-var required$5 = [
-	"@context",
-	"type",
-	"id",
-	"dateCreated",
-	"userIdentity",
-	"patches"
-];
-var additionalProperties$5 = false;
-var AuditableItemGraphChangesetSchema = {
-	$schema: $schema$5,
-	$id: $id$5,
-	description: description$5,
-	type: type$5,
-	properties: properties$5,
-	required: required$5,
-	additionalProperties: additionalProperties$5
-};
-
-var $schema$4 = "https://json-schema.org/draft/2020-12/schema";
-var $id$4 = "https://schema.twindev.org/aig/AuditableItemGraphEdge";
-var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
-var type$4 = "object";
-var properties$4 = {
-	id: {
-		type: "string",
-		description: "The id of the element."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of when the element was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time of when the element was modified."
-	},
-	dateDeleted: {
-		type: "string",
-		description: "The date/time of when the element was deleted, as we never actually remove items."
-	},
-	"@context": {
-		anyOf: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "array",
-				minItems: 1,
-				items: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-				},
-				prefixItems: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				]
-			}
-		],
-		description: "JSON-LD Context."
-	},
-	targetId: {
-		type: "string",
-		description: "The target vertex id the edge connects to."
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphEdge",
-		description: "JSON-LD Type."
-	},
-	annotationObject: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD annotation object for the edge."
-	},
-	edgeRelationships: {
-		type: "array",
-		items: false,
-		description: "The relationships between the two vertices.",
-		prefixItems: [
-			{
-				type: "string"
-			}
-		]
-	}
-};
-var required$4 = [
-	"@context",
-	"targetId",
-	"type",
-	"edgeRelationships"
-];
-var additionalProperties$4 = false;
-var AuditableItemGraphEdgeSchema = {
-	$schema: $schema$4,
-	$id: $id$4,
-	description: description$4,
-	type: type$4,
-	properties: properties$4,
-	required: required$4,
-	additionalProperties: additionalProperties$4
-};
-
-var $schema$3 = "https://json-schema.org/draft/2020-12/schema";
-var $id$3 = "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation";
-var description$3 = "The patch operation for JSON diffs.";
-var type$3 = "object";
-var properties$3 = {
-	"@context": {
-		anyOf: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "array",
-				minItems: 1,
-				items: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-				},
-				prefixItems: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				]
-			}
-		],
-		description: "JSON-LD Context."
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphPatchOperation",
-		description: "JSON-LD Type."
-	},
-	patchOperation: {
-		type: "string",
-		"enum": [
-			"add",
-			"remove",
-			"replace",
-			"move",
-			"copy",
-			"test"
-		],
-		description: "The operation that was performed on the item."
-	},
-	patchPath: {
-		type: "string",
-		description: "The path to the object that was changed."
-	},
-	patchFrom: {
-		type: "string",
-		description: "The path the value was copied or moved from."
-	},
-	patchValue: {
-		description: "The value to add."
-	}
-};
-var required$3 = [
-	"@context",
-	"type",
-	"patchOperation",
-	"patchPath"
-];
-var additionalProperties$3 = false;
-var AuditableItemGraphPatchOperationSchema = {
-	$schema: $schema$3,
-	$id: $id$3,
-	description: description$3,
-	type: type$3,
-	properties: properties$3,
-	required: required$3,
-	additionalProperties: additionalProperties$3
-};
-
-var $schema$2 = "https://json-schema.org/draft/2020-12/schema";
-var $id$2 = "https://schema.twindev.org/aig/AuditableItemGraphResource";
-var description$2 = "Interface describing an auditable item graph vertex resource.";
-var type$2 = "object";
-var properties$2 = {
-	id: {
-		type: "string",
-		description: "The id of the element."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of when the element was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time of when the element was modified."
-	},
-	dateDeleted: {
-		type: "string",
-		description: "The date/time of when the element was deleted, as we never actually remove items."
-	},
-	"@context": {
-		anyOf: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "array",
-				minItems: 1,
-				items: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-				},
-				prefixItems: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/aig/"
-					}
-				]
-			}
-		],
-		description: "JSON-LD Context."
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphResource",
-		description: "JSON-LD Type."
-	},
-	resourceObject: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the resource."
-	}
-};
-var required$2 = [
-	"@context",
-	"type"
-];
-var additionalProperties$2 = false;
-var AuditableItemGraphResourceSchema = {
-	$schema: $schema$2,
-	$id: $id$2,
-	description: description$2,
-	type: type$2,
-	properties: properties$2,
-	required: required$2,
-	additionalProperties: additionalProperties$2
-};
-
-var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
-var $id$1 = "https://schema.twindev.org/aig/AuditableItemGraphVertex";
-var description$1 = "Interface describing an auditable item graph vertex.";
-var type$1 = "object";
-var properties$1 = {
-	id: {
-		type: "string",
-		description: "The id of the element."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of when the element was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time of when the element was modified."
-	},
-	dateDeleted: {
-		type: "string",
-		description: "The date/time of when the element was deleted, as we never actually remove items."
-	},
-	"@context": {
-		type: "array",
-		minItems: 2,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/common/"
-			}
-		]
-	},
-	type: {
-		type: "string",
-		"const": "AuditableItemGraphVertex",
-		description: "JSON-LD Type."
-	},
-	nodeIdentity: {
-		type: "string",
-		description: "The identity of the node which controls the vertex."
-	},
-	annotationObject: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD annotation object for the vertex."
-	},
-	aliases: {
-		type: "array",
-		items: false,
-		description: "Alternative aliases that can be used to identify the vertex.",
-		prefixItems: [
-			{
-				$ref: "https://schema.twindev.org/aig/AuditableItemGraphAlias"
-			}
-		]
-	},
-	resources: {
-		type: "array",
-		items: false,
-		description: "The resources attached to the vertex.",
-		prefixItems: [
-			{
-				$ref: "https://schema.twindev.org/aig/AuditableItemGraphResource"
-			}
-		]
-	},
-	edges: {
-		type: "array",
-		items: false,
-		description: "Edges connected to the vertex.",
-		prefixItems: [
-			{
-				$ref: "https://schema.twindev.org/aig/AuditableItemGraphEdge"
-			}
-		]
-	},
-	changesets: {
-		type: "array",
-		items: false,
-		description: "Changesets for the vertex.",
-		prefixItems: [
-			{
-				$ref: "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
-			}
-		]
-	},
-	verified: {
-		type: "boolean",
-		description: "Is the vertex verified, will only be populated when verification is requested."
-	}
-};
-var required$1 = [
-	"@context",
-	"id",
-	"type"
-];
-var additionalProperties$1 = false;
-var AuditableItemGraphVertexSchema = {
-	$schema: $schema$1,
-	$id: $id$1,
-	description: description$1,
-	type: type$1,
-	properties: properties$1,
-	required: required$1,
-	additionalProperties: additionalProperties$1
-};
-
-var $schema = "https://json-schema.org/draft/2020-12/schema";
-var $id = "https://schema.twindev.org/aig/AuditableItemGraphVertexList";
-var description = "Interface describing an auditable item graph vertex list.";
-var type = "object";
-var properties = {
-	"@context": {
-		type: "array",
-		minItems: 2,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.org"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/aig/"
-			}
-		]
-	},
-	type: {
-		type: "array",
-		minItems: 2,
-		items: false,
-		maxItems: 2,
-		description: "JSON-LD Type.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "ItemList"
-			},
-			{
-				type: "string",
-				"const": "AuditableItemGraphVertexList"
-			}
-		]
-	},
-	itemListElement: {
-		type: "array",
-		items: false,
-		description: "The list of vertices.",
-		prefixItems: [
-			{
-				$ref: "https://schema.twindev.org/aig/AuditableItemGraphVertex"
-			}
-		]
-	},
-	nextItem: {
-		type: "string",
-		description: "The cursor to get the next chunk of vertices."
-	}
-};
-var required = [
-	"@context",
-	"type",
-	"itemListElement"
-];
-var additionalProperties = false;
-var AuditableItemGraphVertexListSchema = {
-	$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 auditable item graph.
- */
-class AuditableItemGraphDataTypes {
-    /**
-     * Register all the data types.
-     */
-    static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Vertex}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.Vertex,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphVertexSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.VertexList}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.VertexList,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphVertexListSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Alias}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.Alias,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphAliasSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Resource}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.Resource,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphResourceSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Edge}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.Edge,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphEdgeSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.Changeset}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.Changeset,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphChangesetSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${AuditableItemGraphContexts.ContextRoot}${AuditableItemGraphTypes.PatchOperation}`, () => ({
-            context: AuditableItemGraphContexts.ContextRoot,
-            type: AuditableItemGraphTypes.PatchOperation,
-            defaultValue: {},
-            jsonSchema: async () => AuditableItemGraphPatchOperationSchema
-        }));
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The topics for auditable item graph event bus notifications.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const AuditableItemGraphTopics = {
-    /**
-     * A vertex was created.
-     */
-    VertexCreated: "auditable-item-graph:vertex-created",
-    /**
-     * A vertex was updated.
-     */
-    VertexUpdated: "auditable-item-graph:vertex-updated"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * How deep to verify the signatures.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const VerifyDepth = {
-    /**
-     * Do not verify any signatures.
-     */
-    None: "none",
-    /**
-     * Verify only the most recent signature.
-     */
-    Current: "current",
-    /**
-     * Verify all the signatures.
-     */
-    All: "all"
-};
-
-exports.AuditableItemGraphContexts = AuditableItemGraphContexts;
-exports.AuditableItemGraphDataTypes = AuditableItemGraphDataTypes;
-exports.AuditableItemGraphTopics = AuditableItemGraphTopics;
-exports.AuditableItemGraphTypes = AuditableItemGraphTypes;
-exports.VerifyDepth = VerifyDepth;