@twin.org/standards-gaia-x 0.0.2-next.9 → 0.0.3-next.10

package/dist/es/schemas/ServiceOffering.json

@@ -0,0 +1,425 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/gaia-x-loire/ServiceOffering",
+    "description": "A Service offering",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Gaia-X JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/gaia-x-loire/"
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://schema.twindev.org/gaia-x-loire/"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://schema.twindev.org/gaia-x-loire/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@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"
+        },
+        "id": {
+            "type": "string",
+            "description": "The Id."
+        },
+        "name": {
+            "type": "string",
+            "description": "Name of the Service Offering."
+        },
+        "description": {
+            "type": "string",
+            "description": "Description of the Gaia-X entity."
+        },
+        "type": {
+            "type": "string",
+            "const": "ServiceOffering",
+            "description": "Type"
+        },
+        "providedBy": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/gaia-x-loire/LegalPerson"
+                },
+                {
+                    "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"
+                    ]
+                }
+            ],
+            "description": "Participant that provides the offering"
+        },
+        "servicePolicy": {
+            "description": "Object or array data type",
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
+                    }
+                }
+            ]
+        },
+        "aggregationOfResources": {
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/gaia-x-loire/DataResource"
+                    }
+                },
+                {
+                    "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": "DataResource"
+                        },
+                        "@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"
+                    ]
+                }
+            ],
+            "description": "Resources aggregated It is supported different representations, inline, by reference both providing the URI or a partial JSON-LD Node object"
+        },
+        "endpoint": {
+            "$ref": "https://schema.twindev.org/gaia-x-loire/Endpoint",
+            "description": "The endpoint"
+        }
+    },
+    "required": [
+        "@context",
+        "id",
+        "name",
+        "providedBy",
+        "servicePolicy",
+        "type"
+    ],
+    "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"
+            }
+        ]
+    }
+}

package/dist/types/index.d.ts

@@ -1,11 +1,11 @@
-export * from "./dataTypes/gaiaXDataTypes";
-export * from "./models/gaiaXContexts";
-export * from "./models/gaiaXContextType";
-export * from "./models/gaiaXTypes";
-export * from "./models/IAddress";
-export * from "./models/IDataExchangeComponent";
-export * from "./models/IDataResource";
-export * from "./models/IEndpoint";
-export * from "./models/ILegalPerson";
-export * from "./models/IRegistrationNumber";
-export * from "./models/IServiceOffering";
+export * from "./dataTypes/gaiaXDataTypes.js";
+export * from "./models/gaiaXContexts.js";
+export * from "./models/gaiaXContextType.js";
+export * from "./models/gaiaXTypes.js";
+export * from "./models/IGaiaXAddress.js";
+export * from "./models/IGaiaXDataExchangeComponent.js";
+export * from "./models/IGaiaXDataResource.js";
+export * from "./models/IGaiaXEndpoint.js";
+export * from "./models/IGaiaXLegalPerson.js";
+export * from "./models/IGaiaXRegistrationNumber.js";
+export * from "./models/IGaiaXServiceOffering.js";

package/dist/types/models/{IAddress.d.ts → IGaiaXAddress.d.ts}

@@ -1,10 +1,10 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXTypes } from "./gaiaXTypes";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
 /**
  * Address as defined by Gaia-X
  * https://docs.gaia-x.eu/ontology/development/classes/Address/
  */
-export interface IAddress extends IJsonLdNodeObject {
+export interface IGaiaXAddress extends IJsonLdNodeObject {
     /**
      * JSON-LD @ type. In this case it is allowed to be omitted as it is usually a child node.
      */

package/dist/types/models/{IDataExchangeComponent.d.ts → IGaiaXDataExchangeComponent.d.ts}

@@ -1,11 +1,11 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXContextType } from "./gaiaXContextType";
-import type { GaiaXTypes } from "./gaiaXTypes";
+import type { GaiaXContextType } from "./gaiaXContextType.js";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
 /**
  * Data Exchange component as defined by Gaia-X
  * https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent
  */
-export interface IDataExchangeComponent extends IJsonLdNodeObject {
+export interface IGaiaXDataExchangeComponent extends IJsonLdNodeObject {
     /**
      * The LD Context
      */

package/dist/types/models/{IDataResource.d.ts → IGaiaXDataResource.d.ts}

@@ -1,15 +1,16 @@
 import type { ObjectOrArray } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXContextType } from "./gaiaXContextType";
-import type { GaiaXTypes } from "./gaiaXTypes";
-import type { IDataExchangeComponent } from "./IDataExchangeComponent";
-import type { IGaiaXEntity } from "./IGaiaXEntity";
-import type { ILegalPerson } from "./ILegalPerson";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { GaiaXContextType } from "./gaiaXContextType.js";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
+import type { IGaiaXDataExchangeComponent } from "./IGaiaXDataExchangeComponent.js";
+import type { IGaiaXEntity } from "./IGaiaXEntity.js";
+import type { IGaiaXLegalPerson } from "./IGaiaXLegalPerson.js";
 /**
  * A Data Resource as defined by Gaia-X.
  * See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
  */
-export interface IDataResource extends IGaiaXEntity {
+export interface IGaiaXDataResource extends IGaiaXEntity {
     /**
      * The LD Context
      */
@@ -31,14 +32,14 @@ export interface IDataResource extends IGaiaXEntity {
      * 'string' in case just an Id pointing to the Data Exchange Component is supplied
      * the third case covers the idiom where a JSON-LD Node is supplied with id and type.
      */
-    exposedThrough: IDataExchangeComponent | string | (IJsonLdNodeObject & {
+    exposedThrough: IGaiaXDataExchangeComponent | string | (IJsonLdNodeObject & {
         id: string;
         type: typeof GaiaXTypes.DataExchangeComponent;
     });
     /**
      * Who is the data producer
      */
-    producedBy: ILegalPerson | string;
+    producedBy: IGaiaXLegalPerson | string;
     /**
      * Pointer (URL) to the license
      */
@@ -46,9 +47,9 @@ export interface IDataResource extends IGaiaXEntity {
     /**
      * Copyright owner
      */
-    copyrightOwnedBy: ILegalPerson | string;
+    copyrightOwnedBy: IGaiaXLegalPerson | string;
     /**
      * ODRL Policy
      */
-    resourcePolicy: ObjectOrArray<IJsonLdNodeObject>;
+    resourcePolicy: ObjectOrArray<IOdrlPolicy>;
 }

package/dist/types/models/{IEndpoint.d.ts → IGaiaXEndpoint.d.ts}

@@ -1,10 +1,10 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXTypes } from "./gaiaXTypes";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
 /**
  * Endpoint as defined by the Gaia-X ontology.
  * https://docs.gaia-x.eu/ontology/development/classes/Endpoint
  */
-export interface IEndpoint extends IJsonLdNodeObject {
+export interface IGaiaXEndpoint extends IJsonLdNodeObject {
     /**
      * The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node.
      */

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

@@ -1,5 +1,5 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXContextType } from "./gaiaXContextType";
+import type { GaiaXContextType } from "./gaiaXContextType.js";
 /**
  * GaiaX Entity.
  * @see https://docs.gaia-x.eu/ontology/development/classes/GaiaXEntity/

package/dist/types/models/{ILegalPerson.d.ts → IGaiaXLegalPerson.d.ts}

@@ -1,13 +1,13 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXTypes } from "./gaiaXTypes";
-import type { IAddress } from "./IAddress";
-import type { IGaiaXEntity } from "./IGaiaXEntity";
-import type { IRegistrationNumber } from "./IRegistrationNumber";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
+import type { IGaiaXAddress } from "./IGaiaXAddress.js";
+import type { IGaiaXEntity } from "./IGaiaXEntity.js";
+import type { IGaiaXRegistrationNumber } from "./IGaiaXRegistrationNumber.js";
 /**
  * A Legal Person as defined by Gaia-X.
  * @see https://docs.gaia-x.eu/ontology/development/classes/LegalPerson/.
  */
-export interface ILegalPerson extends IGaiaXEntity {
+export interface IGaiaXLegalPerson extends IGaiaXEntity {
     /**
      * JSON-LD type.
      */
@@ -16,7 +16,7 @@ export interface ILegalPerson extends IGaiaXEntity {
      * The legal registration number.
      * @see https://docs.gaia-x.eu/ontology/development/slots/registrationNumber/
      */
-    registrationNumber: IRegistrationNumber;
+    registrationNumber: IGaiaXRegistrationNumber;
     /**
      * The legal name.
      */
@@ -25,12 +25,12 @@ export interface ILegalPerson extends IGaiaXEntity {
      * Legal Address
      * @see https://docs.gaia-x.eu/ontology/development/slots/legalAddress/
      */
-    legalAddress: IAddress;
+    legalAddress: IGaiaXAddress;
     /**
      * Headquarters address.
      * @see https://docs.gaia-x.eu/ontology/development/slots/headquartersAddress/
      */
-    headquartersAddress?: IAddress;
+    headquartersAddress?: IGaiaXAddress;
     /**
      * Parent organization.
      * @see https://docs.gaia-x.eu/ontology/development/slots/parentOrganizationOf/

package/dist/types/models/{IRegistrationNumber.d.ts → IGaiaXRegistrationNumber.d.ts}

@@ -1,10 +1,10 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXTypes } from "./gaiaXTypes";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
 /**
  * Registration Number as defined by the Gaia-X ontology.
  * https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/
  */
-export interface IRegistrationNumber extends IJsonLdNodeObject {
+export interface IGaiaXRegistrationNumber extends IJsonLdNodeObject {
     /**
      * JSON-LD Type.
      */

package/dist/types/models/{IServiceOffering.d.ts → IGaiaXServiceOffering.d.ts}

@@ -1,14 +1,15 @@
 import type { ObjectOrArray } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { GaiaXTypes } from "./gaiaXTypes";
-import type { IDataResource } from "./IDataResource";
-import type { IEndpoint } from "./IEndpoint";
-import type { IGaiaXEntity } from "./IGaiaXEntity";
-import type { ILegalPerson } from "./ILegalPerson";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { GaiaXTypes } from "./gaiaXTypes.js";
+import type { IGaiaXDataResource } from "./IGaiaXDataResource.js";
+import type { IGaiaXEndpoint } from "./IGaiaXEndpoint.js";
+import type { IGaiaXEntity } from "./IGaiaXEntity.js";
+import type { IGaiaXLegalPerson } from "./IGaiaXLegalPerson.js";
 /**
  * A Service offering
  */
-export interface IServiceOffering extends IGaiaXEntity {
+export interface IGaiaXServiceOffering extends IGaiaXEntity {
     /**
      * Type
      */
@@ -20,25 +21,25 @@ export interface IServiceOffering extends IGaiaXEntity {
     /**
      * Participant that provides the offering
      */
-    providedBy: string | ILegalPerson | (IJsonLdNodeObject & {
+    providedBy: string | IGaiaXLegalPerson | (IJsonLdNodeObject & {
         id: string;
         type: typeof GaiaXTypes.LegalPerson;
     });
     /**
      * ODRL policy associated to the service offering
      */
-    servicePolicy: ObjectOrArray<IJsonLdNodeObject>;
+    servicePolicy: ObjectOrArray<IOdrlPolicy>;
     /**
      * Resources aggregated
      * It is supported different representations, inline,
      * by reference both providing the URI or a partial JSON-LD Node object
      */
-    aggregationOfResources?: string[] | IDataResource[] | (IJsonLdNodeObject & {
+    aggregationOfResources?: string[] | IGaiaXDataResource[] | (IJsonLdNodeObject & {
         id: string;
         type: typeof GaiaXTypes.DataResource;
     });
     /**
      * The endpoint
      */
-    endpoint: IEndpoint;
+    endpoint?: IGaiaXEndpoint;
 }

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

@@ -1,5 +1,5 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
-import type { GaiaXContexts } from "./gaiaXContexts";
+import type { GaiaXContexts } from "./gaiaXContexts.js";
 /**
  * The Gaia-X JSON-LD context type.
  */