@twin.org/federated-catalogue-service 0.0.1-next.3

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 (46) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +21 -0
  3. package/dist/cjs/index.cjs +2149 -0
  4. package/dist/esm/index.mjs +2131 -0
  5. package/dist/types/entities/dataResourceEntry.d.ts +59 -0
  6. package/dist/types/entities/dataSpaceConnectorEntry.d.ts +66 -0
  7. package/dist/types/entities/participantEntry.d.ts +42 -0
  8. package/dist/types/entities/serviceOfferingEntry.d.ts +55 -0
  9. package/dist/types/federatedCatalogueRoutes.d.ts +113 -0
  10. package/dist/types/federatedCatalogueService.d.ts +138 -0
  11. package/dist/types/index.d.ts +10 -0
  12. package/dist/types/models/IFederatedCatalogueConfig.d.ts +15 -0
  13. package/dist/types/models/IFederatedCatalogueConstructorOptions.d.ts +38 -0
  14. package/dist/types/restEntryPoints.d.ts +2 -0
  15. package/dist/types/schema.d.ts +4 -0
  16. package/dist/types/verification/complianceCredentialVerificationService.d.ts +32 -0
  17. package/docs/changelog.md +40 -0
  18. package/docs/examples.md +1 -0
  19. package/docs/open-api/spec.json +5345 -0
  20. package/docs/overview.md +21 -0
  21. package/docs/reference/classes/DataResourceEntry.md +118 -0
  22. package/docs/reference/classes/DataSpaceConnectorEntry.md +133 -0
  23. package/docs/reference/classes/FederatedCatalogueService.md +381 -0
  24. package/docs/reference/classes/ParticipantEntry.md +85 -0
  25. package/docs/reference/classes/ServiceOfferingEntry.md +109 -0
  26. package/docs/reference/functions/complianceCredentialPresentation.md +37 -0
  27. package/docs/reference/functions/dataResourceCredentialPresentation.md +37 -0
  28. package/docs/reference/functions/dataResourceGet.md +31 -0
  29. package/docs/reference/functions/dataResourceList.md +31 -0
  30. package/docs/reference/functions/dataSpaceConnectorCredentialPresentation.md +37 -0
  31. package/docs/reference/functions/dataSpaceConnectorGet.md +31 -0
  32. package/docs/reference/functions/dataSpaceConnectorList.md +31 -0
  33. package/docs/reference/functions/generateRestRoutesFederatedCatalogue.md +25 -0
  34. package/docs/reference/functions/initSchema.md +9 -0
  35. package/docs/reference/functions/participantGet.md +31 -0
  36. package/docs/reference/functions/participantList.md +31 -0
  37. package/docs/reference/functions/serviceOfferingCredentialPresentation.md +37 -0
  38. package/docs/reference/functions/serviceOfferingGet.md +31 -0
  39. package/docs/reference/functions/serviceOfferingList.md +31 -0
  40. package/docs/reference/index.md +36 -0
  41. package/docs/reference/interfaces/IFederatedCatalogueConfig.md +21 -0
  42. package/docs/reference/interfaces/IFederatedCatalogueConstructorOptions.md +83 -0
  43. package/docs/reference/variables/restEntryPoints.md +3 -0
  44. package/docs/reference/variables/tagsFederatedCatalogue.md +5 -0
  45. package/locales/en.json +21 -0
  46. package/package.json +52 -0
package/locales/en.json ADDED
@@ -0,0 +1,21 @@
1
+ {
2
+ "error": {
3
+ "federatedCatalogueService": {
4
+ "credentialCannotBeRetrieved": "Credential \"{credentialUrl}\" cannot be retrieved",
5
+ "complianceCredentialNotVerified": "Compliance credential cannot be verified",
6
+ "credentialVerificationError": "Credential \"{credentialUrl}\" verification error",
7
+ "unknownHashingAlgorithm": "Unknown hashing algorithm: \"{hashingAlg}\"",
8
+ "noEvidence": "No Credential evidence provided for the type of Compliance Claimed",
9
+ "providerIsNotParticipant": "Provider is not known as participant",
10
+ "entryNotFound": "The requested entry has not been found in the Catalogue",
11
+ "unknownEntryType": "The entry type is not known to the Catalogue"
12
+ }
13
+ },
14
+ "info": {
15
+ "federatedCatalogueService": {
16
+ "verifyingEvidenceCredential": "Verifying evidence credential \"{credentialUrl}\" ...",
17
+ "credentialEvidenceVerified": "Credential evidence \"{credentialUrl}\" verified",
18
+ "complianceCredentialVerified": "Compliance credential verified and entry added to the Catalogue"
19
+ }
20
+ }
21
+ }
package/package.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "name": "@twin.org/federated-catalogue-service",
3
+ "version": "0.0.1-next.3",
4
+ "description": "Federated Catalogue contract implementation and REST endpoint definitions",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/twinfoundation/federated-catalogue.git",
8
+ "directory": "packages/federated-catalogue-service"
9
+ },
10
+ "author": "jose.cantera@iota.org",
11
+ "license": "Apache-2.0",
12
+ "type": "module",
13
+ "engines": {
14
+ "node": ">=20.0.0"
15
+ },
16
+ "dependencies": {
17
+ "@twin.org/api-models": "next",
18
+ "@twin.org/core": "next",
19
+ "@twin.org/crypto": "next",
20
+ "@twin.org/data-json-ld": "next",
21
+ "@twin.org/entity": "next",
22
+ "@twin.org/entity-storage-models": "next",
23
+ "@twin.org/federated-catalogue-models": "0.0.1-next.3",
24
+ "@twin.org/identity-models": "next",
25
+ "@twin.org/identity-service": "next",
26
+ "@twin.org/logging-models": "next",
27
+ "@twin.org/nameof": "next",
28
+ "@twin.org/standards-gaia-x": "next",
29
+ "@twin.org/standards-schema-org": "next",
30
+ "@twin.org/standards-w3c-did": "next",
31
+ "@twin.org/standards-w3c-odrl": "next",
32
+ "@twin.org/web": "next"
33
+ },
34
+ "main": "./dist/cjs/index.cjs",
35
+ "module": "./dist/esm/index.mjs",
36
+ "types": "./dist/types/index.d.ts",
37
+ "exports": {
38
+ ".": {
39
+ "types": "./dist/types/index.d.ts",
40
+ "require": "./dist/cjs/index.cjs",
41
+ "import": "./dist/esm/index.mjs"
42
+ },
43
+ "./locales/*.json": "./locales/*.json"
44
+ },
45
+ "files": [
46
+ "dist/cjs",
47
+ "dist/esm",
48
+ "dist/types",
49
+ "locales",
50
+ "docs"
51
+ ]
52
+ }