@twin.org/standards-gaia-x 0.0.1-next.25

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

@@ -0,0 +1,61 @@
+/**
+ * The types concerning Gaia-X.
+ */
+export declare const GaiaXTypes: {
+    /**
+     * Data Resource
+     */
+    readonly DataResource: "DataResource";
+    /**
+     * Service Offering Type
+     */
+    readonly ServiceOffering: "ServiceOffering";
+    /**
+     * Participant
+     */
+    readonly Participant: "LegalPerson";
+    /**
+     * Data Exchange Component
+     */
+    readonly DataExchangeComponent: "DataExchangeComponent";
+    /**
+     * Address
+     */
+    readonly Address: "Address";
+    /**
+     * Endpoint
+     */
+    readonly Endpoint: "Endpoint";
+    /**
+     * Registration number
+     */
+    readonly RegistrationNumber: "RegistrationNumber";
+    /**
+     * Local Registration number
+     */
+    readonly LocalRegistrationNumber: "LocalRegistrationNumber";
+    /**
+     * EORI
+     */
+    readonly EORI: "EORI";
+    /**
+     * VAT ID
+     */
+    readonly VatID: "VatID";
+    /**
+     * EU ID
+     */
+    readonly EUID: "EUID";
+    /**
+     * GLEIF LEI code.
+     */
+    readonly LeiCode: "LeiCode";
+    /**
+     * Tax Id.
+     */
+    readonly TaxID: "TaxID";
+};
+/**
+ * The types concerning Gaia-X.
+ */
+export type GaiaXTypes = (typeof GaiaXTypes)[keyof typeof GaiaXTypes];

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/standards-gaia-x - Changelog
+
+## v0.0.1-next.25
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/standards-gaia-x - Examples

package/docs/reference/index.md

@@ -0,0 +1,21 @@
+# @twin.org/standards-gaia-x
+
+## Interfaces
+
+- [IAddress](interfaces/IAddress.md)
+- [IDataExchangeComponent](interfaces/IDataExchangeComponent.md)
+- [IDataResource](interfaces/IDataResource.md)
+- [IEndpoint](interfaces/IEndpoint.md)
+- [IParticipant](interfaces/IParticipant.md)
+- [IRegistrationNumber](interfaces/IRegistrationNumber.md)
+- [IServiceOffering](interfaces/IServiceOffering.md)
+
+## Type Aliases
+
+- [GaiaXContexts](type-aliases/GaiaXContexts.md)
+- [GaiaXTypes](type-aliases/GaiaXTypes.md)
+
+## Variables
+
+- [GaiaXContexts](variables/GaiaXContexts.md)
+- [GaiaXTypes](variables/GaiaXTypes.md)

package/docs/reference/interfaces/IAddress.md

@@ -0,0 +1,28 @@
+# Interface: IAddress
+
+Address as defined by Gaia-X
+https://docs.gaia-x.eu/ontology/development/classes/Address/
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### type
+
+> **type**: `undefined` \| `"Address"`
+
+JSON-LD @ type. In this case it is allowed to be omitted as it is usually a child node.
+
+***
+
+### countryCode
+
+> **countryCode**: `string` \| `number`
+
+Country code in ISO 3166-1 alpha2, alpha-3 or numeric format

package/docs/reference/interfaces/IDataExchangeComponent.md

@@ -0,0 +1,20 @@
+# Interface: IDataExchangeComponent
+
+Data Exchange component as defined by Gaia-X
+https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### type
+
+> **type**: `"DataExchangeComponent"` \| \[`"DataExchangeComponent"`, `...string[]`\]
+
+The type of JSON-LD node

package/docs/reference/interfaces/IDataResource.md

@@ -0,0 +1,98 @@
+# Interface: IDataResource
+
+A Data Resource as defined by Gaia-X.
+See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### @context
+
+> **@context**: `"https://w3id.org/gaia-x/development"` \| \[`"https://w3id.org/gaia-x/development"`, `...IJsonLdContextDefinitionElement[]`\]
+
+The LD Context
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### id
+
+> **id**: `string`
+
+Subject Id
+
+***
+
+### type
+
+> **type**: `"DataResource"`
+
+Subject type
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description
+
+***
+
+### name
+
+> **name**: `string`
+
+The Resource Name
+
+***
+
+### exposedThrough
+
+> **exposedThrough**: `string` \| [`IDataExchangeComponent`](IDataExchangeComponent.md) \| `IJsonLdNodeObject` & `object`
+
+Exposed through a Data Exchange Component.
+'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.
+
+***
+
+### producedBy
+
+> **producedBy**: `string`
+
+Who is the data producer
+
+***
+
+### license
+
+> **license**: `string`
+
+Pointer (URL) to the license
+
+***
+
+### copyrightOwnedBy
+
+> **copyrightOwnedBy**: `string`
+
+Copyright owner
+
+***
+
+### resourcePolicy
+
+> **resourcePolicy**: `IJsonLdNodeObject`
+
+ODRL Policy

package/docs/reference/interfaces/IEndpoint.md

@@ -0,0 +1,44 @@
+# Interface: IEndpoint
+
+Endpoint as defined by the Gaia-X ontology.
+https://docs.gaia-x.eu/ontology/development/classes/Endpoint
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### type
+
+> **type**: `undefined` \| `"Endpoint"`
+
+The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node.
+
+***
+
+### endpointURL
+
+> **endpointURL**: `string`
+
+The endpoint URL
+
+***
+
+### formalDescription?
+
+> `optional` **formalDescription**: `string`
+
+The formal description
+
+***
+
+### standardConformity?
+
+> `optional` **standardConformity**: `IJsonLdNodeObject`
+
+Standards conformity

package/docs/reference/interfaces/IParticipant.md

@@ -0,0 +1,63 @@
+# Interface: IParticipant
+
+A Legal Person participating in the ecosystem
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### @context
+
+> **@context**: `"https://w3id.org/gaia-x/development"` \| \[`"https://w3id.org/gaia-x/development"`, `...IJsonLdContextDefinitionElement[]`\]
+
+The LD context
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### id
+
+> **id**: `string`
+
+The participant Id.
+
+***
+
+### type
+
+> **type**: `"LegalPerson"`
+
+JSON-LD type.
+
+***
+
+### registrationNumber
+
+> **registrationNumber**: [`IRegistrationNumber`](IRegistrationNumber.md)
+
+The legal registration number.
+
+***
+
+### legalName
+
+> **legalName**: `string`
+
+The legal name.
+
+***
+
+### legalAddress
+
+> **legalAddress**: [`IAddress`](IAddress.md)
+
+Legal Address

package/docs/reference/interfaces/IRegistrationNumber.md

@@ -0,0 +1,93 @@
+# Interface: IRegistrationNumber
+
+Registration Number as defined by the Gaia-X ontology.
+https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### type
+
+> **type**: `"RegistrationNumber"` \| `"LocalRegistrationNumber"` \| `"EORI"` \| `"VatID"` \| `"EUID"` \| `"LeiCode"` \| `"TaxID"`
+
+JSON-LD Type.
+
+***
+
+### local?
+
+> `optional` **local**: `string`
+
+Local Registration.
+
+***
+
+### countryCode?
+
+> `optional` **countryCode**: `string`
+
+Country code. See https://docs.gaia-x.eu/ontology/development/enums/CountryNameAlpha2/
+
+***
+
+### subdivisionCountryCode?
+
+> `optional` **subdivisionCountryCode**: `string`
+
+Subdivision country code.
+See https://docs.gaia-x.eu/ontology/development/enums/RegionCode/
+
+***
+
+### vatID?
+
+> `optional` **vatID**: `string`
+
+The VAT identification number.
+
+***
+
+### leiCode?
+
+> `optional` **leiCode**: `string`
+
+Unique LEI number as defined by GLEIF.
+
+***
+
+### eori?
+
+> `optional` **eori**: `string`
+
+The Economic Operators Registration and Identification number (EORI).
+
+***
+
+### country?
+
+> `optional` **country**: `string`
+
+The country where the EORI is registered written in plain english
+
+***
+
+### euid?
+
+> `optional` **euid**: `string`
+
+The European Unique Identifier (EUID) for business located in the European Ec.
+
+***
+
+### taxId?
+
+> `optional` **taxId**: `string`
+
+The company tax ID.

package/docs/reference/interfaces/IServiceOffering.md

@@ -0,0 +1,89 @@
+# Interface: IServiceOffering
+
+A Service offering
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## Properties
+
+### @context
+
+> **@context**: `"https://w3id.org/gaia-x/development"` \| \[`"https://w3id.org/gaia-x/development"`, `...IJsonLdContextDefinitionElement[]`\]
+
+The LD context
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### id
+
+> **id**: `string`
+
+Id
+
+***
+
+### type
+
+> **type**: `"ServiceOffering"`
+
+Type
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description
+
+***
+
+### name
+
+> **name**: `string`
+
+Name
+
+***
+
+### providedBy
+
+> **providedBy**: `string` \| [`IParticipant`](IParticipant.md) \| `IJsonLdNodeObject` & `object`
+
+Participant that provides the offering
+
+***
+
+### servicePolicy
+
+> **servicePolicy**: `IJsonLdNodeObject`
+
+ODRL policy associated to the service offering
+
+***
+
+### aggregationOfResources?
+
+> `optional` **aggregationOfResources**: `string`[] \| [`IDataResource`](IDataResource.md)[] \| `IJsonLdNodeObject` & `object`
+
+Resources aggregated
+It is supported different representations, inline,
+by reference both providing the URI or a partial JSON-LD Node object
+
+***
+
+### endpoint
+
+> **endpoint**: [`IEndpoint`](IEndpoint.md)
+
+The endpoint

package/docs/reference/type-aliases/GaiaXContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: GaiaXContexts
+
+> **GaiaXContexts**: *typeof* [`GaiaXContexts`](../variables/GaiaXContexts.md)\[keyof *typeof* [`GaiaXContexts`](../variables/GaiaXContexts.md)\]
+
+The LD Contexts concerning Gaia-X.

package/docs/reference/type-aliases/GaiaXTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: GaiaXTypes
+
+> **GaiaXTypes**: *typeof* [`GaiaXTypes`](../variables/GaiaXTypes.md)\[keyof *typeof* [`GaiaXTypes`](../variables/GaiaXTypes.md)\]
+
+The types concerning Gaia-X.

package/docs/reference/variables/GaiaXContexts.md

@@ -0,0 +1,19 @@
+# Variable: GaiaXContexts
+
+> `const` **GaiaXContexts**: `object`
+
+The LD Contexts concerning Gaia-X.
+
+## Type declaration
+
+### GaiaXLdContext
+
+> `readonly` **GaiaXLdContext**: `"https://w3id.org/gaia-x/development"` = `"https://w3id.org/gaia-x/development"`
+
+The Gaia-X LD Context
+
+### W3IdSecurityJwsLdContext
+
+> `readonly` **W3IdSecurityJwsLdContext**: `"https://w3id.org/security/suites/jws-2020/v1"` = `"https://w3id.org/security/suites/jws-2020/v1"`
+
+The W3id security LD Context

package/docs/reference/variables/GaiaXTypes.md

@@ -0,0 +1,85 @@
+# Variable: GaiaXTypes
+
+> `const` **GaiaXTypes**: `object`
+
+The types concerning Gaia-X.
+
+## Type declaration
+
+### DataResource
+
+> `readonly` **DataResource**: `"DataResource"` = `"DataResource"`
+
+Data Resource
+
+### ServiceOffering
+
+> `readonly` **ServiceOffering**: `"ServiceOffering"` = `"ServiceOffering"`
+
+Service Offering Type
+
+### Participant
+
+> `readonly` **Participant**: `"LegalPerson"` = `"LegalPerson"`
+
+Participant
+
+### DataExchangeComponent
+
+> `readonly` **DataExchangeComponent**: `"DataExchangeComponent"` = `"DataExchangeComponent"`
+
+Data Exchange Component
+
+### Address
+
+> `readonly` **Address**: `"Address"` = `"Address"`
+
+Address
+
+### Endpoint
+
+> `readonly` **Endpoint**: `"Endpoint"` = `"Endpoint"`
+
+Endpoint
+
+### RegistrationNumber
+
+> `readonly` **RegistrationNumber**: `"RegistrationNumber"` = `"RegistrationNumber"`
+
+Registration number
+
+### LocalRegistrationNumber
+
+> `readonly` **LocalRegistrationNumber**: `"LocalRegistrationNumber"` = `"LocalRegistrationNumber"`
+
+Local Registration number
+
+### EORI
+
+> `readonly` **EORI**: `"EORI"` = `"EORI"`
+
+EORI
+
+### VatID
+
+> `readonly` **VatID**: `"VatID"` = `"VatID"`
+
+VAT ID
+
+### EUID
+
+> `readonly` **EUID**: `"EUID"` = `"EUID"`
+
+EU ID
+
+### LeiCode
+
+> `readonly` **LeiCode**: `"LeiCode"` = `"LeiCode"`
+
+GLEIF LEI code.
+
+### TaxID
+
+> `readonly` **TaxID**: `"TaxID"` = `"TaxID"`
+
+Tax Id.

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,37 @@
+{
+	"name": "@twin.org/standards-gaia-x",
+	"version": "0.0.1-next.25",
+	"description": "Models which define the structure of Gaia-x",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/standards.git",
+		"directory": "packages/standards-gaia-x"
+	},
+	"author": "jose.cantera@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/data-json-ld": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}