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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/dist/cjs/index.cjs +391 -68
  2. package/dist/esm/index.mjs +391 -68
  3. package/dist/types/index.d.ts +1 -1
  4. package/dist/types/models/IDataResource.d.ts +5 -8
  5. package/dist/types/models/IGaiaXEntity.d.ts +24 -0
  6. package/dist/types/models/ILegalPerson.d.ts +50 -0
  7. package/dist/types/models/IServiceOffering.d.ts +6 -18
  8. package/dist/types/models/gaiaXContexts.d.ts +4 -0
  9. package/dist/types/models/gaiaXTypes.d.ts +2 -2
  10. package/docs/changelog.md +25 -0
  11. package/docs/reference/index.md +1 -1
  12. package/docs/reference/interfaces/IAddress.md +1 -1
  13. package/docs/reference/interfaces/IDataExchangeComponent.md +1 -1
  14. package/docs/reference/interfaces/IDataResource.md +25 -13
  15. package/docs/reference/interfaces/IEndpoint.md +1 -1
  16. package/docs/reference/interfaces/ILegalPerson.md +139 -0
  17. package/docs/reference/interfaces/IRegistrationNumber.md +1 -1
  18. package/docs/reference/interfaces/IServiceOffering.md +26 -14
  19. package/docs/reference/variables/GaiaXContexts.md +6 -0
  20. package/docs/reference/variables/GaiaXTypes.md +3 -3
  21. package/package.json +4 -4
  22. package/dist/types/models/IParticipant.d.ts +0 -35
  23. package/docs/reference/interfaces/IParticipant.md +0 -63
package/dist/types/models/IParticipant.d.ts DELETED
@@ -1,35 +0,0 @@
1
- import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
- import type { GaiaXContextType } from "./gaiaXContextType";
3
- import type { GaiaXTypes } from "./gaiaXTypes";
4
- import type { IAddress } from "./IAddress";
5
- import type { IRegistrationNumber } from "./IRegistrationNumber";
6
- /**
7
- * A Legal Person participating in the ecosystem
8
- */
9
- export interface IParticipant extends IJsonLdNodeObject {
10
- /**
11
- * The LD context
12
- */
13
- "@context": GaiaXContextType;
14
- /**
15
- * The participant Id.
16
- */
17
- id: string;
18
- /**
19
- * JSON-LD type.
20
- */
21
- type: typeof GaiaXTypes.Participant;
22
- /**
23
- * The legal registration number.
24
- */
25
- registrationNumber: IRegistrationNumber;
26
- /**
27
- * The legal name.
28
- */
29
- legalName: string;
30
- /**
31
- * Legal Address
32
- *
33
- */
34
- legalAddress: IAddress;
35
- }
package/docs/reference/interfaces/IParticipant.md DELETED
@@ -1,63 +0,0 @@
1
- # Interface: IParticipant
2
-
3
- A Legal Person participating in the ecosystem
4
-
5
- ## Extends
6
-
7
- - `IJsonLdNodeObject`
8
-
9
- ## Indexable
10
-
11
- \[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \}
12
-
13
- ## Properties
14
-
15
- ### @context
16
-
17
- > **@context**: [`GaiaXContextType`](../type-aliases/GaiaXContextType.md)
18
-
19
- The LD context
20
-
21
- #### Overrides
22
-
23
- `IJsonLdNodeObject.@context`
24
-
25
- ***
26
-
27
- ### id
28
-
29
- > **id**: `string`
30
-
31
- The participant Id.
32
-
33
- ***
34
-
35
- ### type
36
-
37
- > **type**: `"LegalPerson"`
38
-
39
- JSON-LD type.
40
-
41
- ***
42
-
43
- ### registrationNumber
44
-
45
- > **registrationNumber**: [`IRegistrationNumber`](IRegistrationNumber.md)
46
-
47
- The legal registration number.
48
-
49
- ***
50
-
51
- ### legalName
52
-
53
- > **legalName**: `string`
54
-
55
- The legal name.
56
-
57
- ***
58
-
59
- ### legalAddress
60
-
61
- > **legalAddress**: [`IAddress`](IAddress.md)
62
-
63
- Legal Address