@twin.org/standards-gaia-x 0.0.1 → 0.0.2-next.2

package/dist/esm/index.mjs

@@ -10,7 +10,11 @@ const GaiaXContexts = {
     /**
      * The Gaia-X LD Context
      */
-    ContextRoot: "https://w3id.org/gaia-x/development"
+    ContextRoot: "https://w3id.org/gaia-x/development",
+    /**
+     * The Gaia-X custom context.
+     */
+    TwinContext: "https://schema.twindev.org/gaia-x"
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -29,9 +33,9 @@ const GaiaXTypes = {
      */
     ServiceOffering: "ServiceOffering",
     /**
-     * Participant
+     * Legal Person
      */
-    Participant: "LegalPerson",
+    LegalPerson: "LegalPerson",
     /**
      * Data Exchange Component
      */
@@ -74,9 +78,9 @@ const GaiaXTypes = {
     TaxID: "TaxID"
 };
 
-var $schema$6 = "https://json-schema.org/draft/2020-12/schema";
-var $id$6 = "https://schema.twindev.org/gaia-x/Address";
-var description$6 = "Address as defined by Gaia-X https://docs.gaia-x.eu/ontology/development/classes/Address/";
+var $schema$7 = "https://json-schema.org/draft/2020-12/schema";
+var $id$7 = "https://schema.twindev.org/gaia-x/Address";
+var description$7 = "Address as defined by Gaia-X https://docs.gaia-x.eu/ontology/development/classes/Address/";
 var type$6 = "object";
 var properties$6 = {
 	"@context": {
@@ -200,18 +204,18 @@ var additionalProperties$6 = {
 	]
 };
 var AddressSchema = {
-	$schema: $schema$6,
-	$id: $id$6,
-	description: description$6,
+	$schema: $schema$7,
+	$id: $id$7,
+	description: description$7,
 	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/gaia-x/DataExchangeComponent";
-var description$5 = "Data Exchange component as defined by Gaia-X https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent";
+var $schema$6 = "https://json-schema.org/draft/2020-12/schema";
+var $id$6 = "https://schema.twindev.org/gaia-x/DataExchangeComponent";
+var description$6 = "Data Exchange component as defined by Gaia-X https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent";
 var type$5 = "object";
 var properties$5 = {
 	"@context": {
@@ -347,18 +351,18 @@ var additionalProperties$5 = {
 	]
 };
 var DataExchangeComponentSchema = {
-	$schema: $schema$5,
-	$id: $id$5,
-	description: description$5,
+	$schema: $schema$6,
+	$id: $id$6,
+	description: description$6,
 	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/gaia-x/DataResource";
-var description$4 = "A Data Resource as defined by Gaia-X. See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.";
+var $schema$5 = "https://json-schema.org/draft/2020-12/schema";
+var $id$5 = "https://schema.twindev.org/gaia-x/DataResource";
+var description$5 = "A Data Resource as defined by Gaia-X. See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.";
 var type$4 = "object";
 var properties$4 = {
 	"@context": {
@@ -445,18 +449,18 @@ var properties$4 = {
 		type: "string",
 		description: "Subject Id"
 	},
-	type: {
+	name: {
 		type: "string",
-		"const": "DataResource",
-		description: "Subject type"
+		description: "The Resource Name"
 	},
 	description: {
 		type: "string",
-		description: "Description"
+		description: "Description of the Gaia-X entity."
 	},
-	name: {
+	type: {
 		type: "string",
-		description: "The Resource Name"
+		"const": "DataResource",
+		description: "Subject type"
 	},
 	exposedThrough: {
 		anyOf: [
@@ -592,7 +596,7 @@ var properties$4 = {
 	producedBy: {
 		anyOf: [
 			{
-				$ref: "https://schema.twindev.org/gaia-x/Participant"
+				$ref: "https://schema.twindev.org/gaia-x/LegalPerson"
 			},
 			{
 				type: "string"
@@ -607,7 +611,7 @@ var properties$4 = {
 	copyrightOwnedBy: {
 		anyOf: [
 			{
-				$ref: "https://schema.twindev.org/gaia-x/Participant"
+				$ref: "https://schema.twindev.org/gaia-x/LegalPerson"
 			},
 			{
 				type: "string"
@@ -616,20 +620,33 @@ var properties$4 = {
 		description: "Copyright owner"
 	},
 	resourcePolicy: {
-		$ref: "https://schema.twindev.org/gaia-x/ObjectOrArray%3CIJsonLdNodeObject%3E",
-		description: "ODRL Policy"
+		description: "Object or array data type",
+		anyOf: [
+			{
+				$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+			},
+			{
+				type: "array",
+				items: false,
+				prefixItems: [
+					{
+						$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					}
+				]
+			}
+		]
 	}
 };
 var required$4 = [
 	"@context",
+	"copyrightOwnedBy",
+	"exposedThrough",
 	"id",
-	"type",
+	"license",
 	"name",
-	"exposedThrough",
 	"producedBy",
-	"license",
-	"copyrightOwnedBy",
-	"resourcePolicy"
+	"resourcePolicy",
+	"type"
 ];
 var additionalProperties$4 = {
 	anyOf: [
@@ -657,18 +674,18 @@ var additionalProperties$4 = {
 	]
 };
 var DataResourceSchema = {
-	$schema: $schema$4,
-	$id: $id$4,
-	description: description$4,
+	$schema: $schema$5,
+	$id: $id$5,
+	description: description$5,
 	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/gaia-x/Endpoint";
-var description$3 = "Endpoint as defined by the Gaia-X ontology. https://docs.gaia-x.eu/ontology/development/classes/Endpoint";
+var $schema$4 = "https://json-schema.org/draft/2020-12/schema";
+var $id$4 = "https://schema.twindev.org/gaia-x/Endpoint";
+var description$4 = "Endpoint as defined by the Gaia-X ontology. https://docs.gaia-x.eu/ontology/development/classes/Endpoint";
 var type$3 = "object";
 var properties$3 = {
 	"@context": {
@@ -797,23 +814,71 @@ var additionalProperties$3 = {
 	]
 };
 var EndpointSchema = {
-	$schema: $schema$3,
-	$id: $id$3,
-	description: description$3,
+	$schema: $schema$4,
+	$id: $id$4,
+	description: description$4,
 	type: type$3,
 	properties: properties$3,
 	required: required$3,
 	additionalProperties: additionalProperties$3
 };
 
+var $schema$3 = "https://json-schema.org/draft/2020-12/schema";
+var $id$3 = "https://schema.twindev.org/gaia-x/GaiaXContextType";
+var description$3 = "The Gaia-X JSON-LD context type.";
+var anyOf = [
+	{
+		type: "string",
+		"const": "https://w3id.org/gaia-x/development"
+	},
+	{
+		type: "array",
+		minItems: 2,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		prefixItems: [
+			{
+				type: "string",
+				"const": "https://w3id.org/gaia-x/development"
+			},
+			{
+				$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+			}
+		]
+	},
+	{
+		type: "array",
+		minItems: 2,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		prefixItems: [
+			{
+				$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+			},
+			{
+				type: "string",
+				"const": "https://w3id.org/gaia-x/development"
+			}
+		]
+	}
+];
+var GaiaXContextTypeSchema = {
+	$schema: $schema$3,
+	$id: $id$3,
+	description: description$3,
+	anyOf: anyOf
+};
+
 var $schema$2 = "https://json-schema.org/draft/2020-12/schema";
-var $id$2 = "https://schema.twindev.org/gaia-x/Participant";
-var description$2 = "A Legal Person participating in the ecosystem";
+var $id$2 = "https://schema.twindev.org/gaia-x/LegalPerson";
+var description$2 = "A Legal Person as defined by Gaia-X.";
 var type$2 = "object";
 var properties$2 = {
 	"@context": {
 		$ref: "https://schema.twindev.org/gaia-x/GaiaXContextType",
-		description: "The LD context"
+		description: "The LD context."
 	},
 	"@id": {
 		anyOf: [
@@ -893,7 +958,15 @@ var properties$2 = {
 	},
 	id: {
 		type: "string",
-		description: "The participant Id."
+		description: "The Id."
+	},
+	name: {
+		type: "string",
+		description: "Human readable Name."
+	},
+	description: {
+		type: "string",
+		description: "Description of the Gaia-X entity."
 	},
 	type: {
 		type: "string",
@@ -911,15 +984,249 @@ var properties$2 = {
 	legalAddress: {
 		$ref: "https://schema.twindev.org/gaia-x/Address",
 		description: "Legal Address"
+	},
+	headquartersAddress: {
+		$ref: "https://schema.twindev.org/gaia-x/Address",
+		description: "Headquarters address."
+	},
+	parentOrganizationOf: {
+		type: "array",
+		items: false,
+		description: "Parent organization.",
+		prefixItems: [
+			{
+				type: "object",
+				additionalProperties: {
+					anyOf: [
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdIdMap"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+						},
+						{
+							type: "array"
+						}
+					]
+				},
+				properties: {
+					id: {
+						type: "string"
+					},
+					type: {
+						type: "string",
+						"const": "LegalPerson"
+					},
+					"@context": {
+						$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+					},
+					"@id": {
+						anyOf: [
+							{
+								type: "string"
+							},
+							{
+								type: "array",
+								items: {
+									type: "string"
+								}
+							}
+						]
+					},
+					"@included": {
+						$ref: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+					},
+					"@graph": {
+						anyOf: [
+							{
+								$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+							},
+							{
+								type: "array",
+								items: {
+									$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							}
+						]
+					},
+					"@nest": {
+						anyOf: [
+							{
+								$ref: "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+							},
+							{
+								type: "array",
+								items: {
+									$ref: "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+								}
+							}
+						]
+					},
+					"@type": {
+						anyOf: [
+							{
+								type: "string"
+							},
+							{
+								type: "array",
+								items: {
+									type: "string"
+								}
+							}
+						]
+					},
+					"@reverse": {
+						type: "object",
+						additionalProperties: {
+							type: "string"
+						}
+					},
+					"@index": {
+						type: "string"
+					}
+				},
+				required: [
+					"id",
+					"type"
+				]
+			}
+		]
+	},
+	subOrganizationOf: {
+		type: "array",
+		items: false,
+		description: "Sub organization of.",
+		prefixItems: [
+			{
+				type: "object",
+				additionalProperties: {
+					anyOf: [
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdIdMap"
+						},
+						{
+							$ref: "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+						},
+						{
+							type: "array"
+						}
+					]
+				},
+				properties: {
+					id: {
+						type: "string"
+					},
+					type: {
+						type: "string",
+						"const": "LegalPerson"
+					},
+					"@context": {
+						$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+					},
+					"@id": {
+						anyOf: [
+							{
+								type: "string"
+							},
+							{
+								type: "array",
+								items: {
+									type: "string"
+								}
+							}
+						]
+					},
+					"@included": {
+						$ref: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+					},
+					"@graph": {
+						anyOf: [
+							{
+								$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+							},
+							{
+								type: "array",
+								items: {
+									$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							}
+						]
+					},
+					"@nest": {
+						anyOf: [
+							{
+								$ref: "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+							},
+							{
+								type: "array",
+								items: {
+									$ref: "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+								}
+							}
+						]
+					},
+					"@type": {
+						anyOf: [
+							{
+								type: "string"
+							},
+							{
+								type: "array",
+								items: {
+									type: "string"
+								}
+							}
+						]
+					},
+					"@reverse": {
+						type: "object",
+						additionalProperties: {
+							type: "string"
+						}
+					},
+					"@index": {
+						type: "string"
+					}
+				},
+				required: [
+					"id",
+					"type"
+				]
+			}
+		]
 	}
 };
 var required$2 = [
 	"@context",
 	"id",
-	"type",
-	"registrationNumber",
+	"legalAddress",
 	"legalName",
-	"legalAddress"
+	"registrationNumber",
+	"type"
 ];
 var additionalProperties$2 = {
 	anyOf: [
@@ -946,7 +1253,7 @@ var additionalProperties$2 = {
 		}
 	]
 };
-var ParticipantSchema = {
+var LegalPersonSchema = {
 	$schema: $schema$2,
 	$id: $id$2,
 	description: description$2,
@@ -1135,7 +1442,7 @@ var type = "object";
 var properties = {
 	"@context": {
 		$ref: "https://schema.twindev.org/gaia-x/GaiaXContextType",
-		description: "The LD context"
+		description: "The LD context."
 	},
 	"@id": {
 		anyOf: [
@@ -1215,20 +1522,20 @@ var properties = {
 	},
 	id: {
 		type: "string",
-		description: "Id"
+		description: "The Id."
 	},
-	type: {
+	name: {
 		type: "string",
-		"const": "ServiceOffering",
-		description: "Type"
+		description: "Name of the Service Offering."
 	},
 	description: {
 		type: "string",
-		description: "Description"
+		description: "Description of the Gaia-X entity."
 	},
-	name: {
+	type: {
 		type: "string",
-		description: "Name"
+		"const": "ServiceOffering",
+		description: "Type"
 	},
 	providedBy: {
 		anyOf: [
@@ -1236,7 +1543,7 @@ var properties = {
 				type: "string"
 			},
 			{
-				$ref: "https://schema.twindev.org/gaia-x/Participant"
+				$ref: "https://schema.twindev.org/gaia-x/LegalPerson"
 			},
 			{
 				type: "object",
@@ -1362,8 +1669,21 @@ var properties = {
 		description: "Participant that provides the offering"
 	},
 	servicePolicy: {
-		$ref: "https://schema.twindev.org/gaia-x/ObjectOrArray%3CIJsonLdNodeObject%3E",
-		description: "ODRL policy associated to the service offering"
+		description: "Object or array data type",
+		anyOf: [
+			{
+				$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+			},
+			{
+				type: "array",
+				items: false,
+				prefixItems: [
+					{
+						$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+					}
+				]
+			}
+		]
 	},
 	aggregationOfResources: {
 		anyOf: [
@@ -1515,12 +1835,12 @@ var properties = {
 };
 var required = [
 	"@context",
+	"endpoint",
 	"id",
-	"type",
 	"name",
 	"providedBy",
 	"servicePolicy",
-	"endpoint"
+	"type"
 ];
 var additionalProperties = {
 	anyOf: [
@@ -1557,8 +1877,6 @@ var ServiceOfferingSchema = {
 	additionalProperties: additionalProperties
 };
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
 /**
  * Handle all the data types for Gaia-X.
  */
@@ -1567,6 +1885,11 @@ class GaiaXDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
+        DataTypeHandlerFactory.register(`${GaiaXContexts.TwinContext}/${"GaiaXContextType"}`, () => ({
+            context: GaiaXContexts.TwinContext,
+            type: "GaiaXContextType",
+            jsonSchema: async () => GaiaXContextTypeSchema
+        }));
         DataTypeHandlerFactory.register(`${GaiaXContexts.ContextRoot}${GaiaXTypes.DataExchangeComponent}`, () => ({
             context: GaiaXContexts.ContextRoot,
             type: GaiaXTypes.DataExchangeComponent,
@@ -1592,10 +1915,10 @@ class GaiaXDataTypes {
             type: GaiaXTypes.ServiceOffering,
             jsonSchema: async () => ServiceOfferingSchema
         }));
-        DataTypeHandlerFactory.register(`${GaiaXContexts.ContextRoot}${GaiaXTypes.Participant}`, () => ({
+        DataTypeHandlerFactory.register(`${GaiaXContexts.ContextRoot}${GaiaXTypes.LegalPerson}`, () => ({
             context: GaiaXContexts.ContextRoot,
-            type: GaiaXTypes.Participant,
-            jsonSchema: async () => ParticipantSchema
+            type: GaiaXTypes.LegalPerson,
+            jsonSchema: async () => LegalPersonSchema
         }));
         DataTypeHandlerFactory.register(`${GaiaXContexts.ContextRoot}${GaiaXTypes.RegistrationNumber}`, () => ({
             context: GaiaXContexts.ContextRoot,

package/dist/types/index.d.ts

@@ -6,6 +6,6 @@ export * from "./models/IAddress";
 export * from "./models/IDataExchangeComponent";
 export * from "./models/IDataResource";
 export * from "./models/IEndpoint";
-export * from "./models/IParticipant";
+export * from "./models/ILegalPerson";
 export * from "./models/IRegistrationNumber";
 export * from "./models/IServiceOffering";