@twin.org/federated-catalogue-models 0.0.1-next.10
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.
- package/LICENSE +201 -0
- package/README.md +21 -0
- package/dist/cjs/index.cjs +1212 -0
- package/dist/esm/index.mjs +1206 -0
- package/dist/types/dataTypes/federatedCatalogueDataTypes.d.ts +9 -0
- package/dist/types/index.d.ts +42 -0
- package/dist/types/models/ICatalogueBase.d.ts +25 -0
- package/dist/types/models/ICatalogueEntry.d.ts +8 -0
- package/dist/types/models/IComplianceCredential.d.ts +37 -0
- package/dist/types/models/IComplianceEvidence.d.ts +26 -0
- package/dist/types/models/IComplianceVerificationResult.d.ts +19 -0
- package/dist/types/models/ICredential.d.ts +21 -0
- package/dist/types/models/IFederatedCatalogueComponent.d.ts +89 -0
- package/dist/types/models/IVerificationResult.d.ts +13 -0
- package/dist/types/models/api/ICatalogueEntryGetRequest.d.ts +15 -0
- package/dist/types/models/api/ICompliancePresentationRequest.d.ts +9 -0
- package/dist/types/models/api/IDataResourceGetResponse.d.ts +10 -0
- package/dist/types/models/api/IDataResourceListRequest.d.ts +27 -0
- package/dist/types/models/api/IDataResourceListResponse.d.ts +10 -0
- package/dist/types/models/api/IDataSpaceConnectorGetResponse.d.ts +10 -0
- package/dist/types/models/api/IDataSpaceConnectorListRequest.d.ts +27 -0
- package/dist/types/models/api/IDataSpaceConnectorListResponse.d.ts +10 -0
- package/dist/types/models/api/IFederatedCatalogueGetRequest.d.ts +12 -0
- package/dist/types/models/api/IParticipantGetResponse.d.ts +10 -0
- package/dist/types/models/api/IParticipantListRequest.d.ts +31 -0
- package/dist/types/models/api/IParticipantListResponse.d.ts +10 -0
- package/dist/types/models/api/IServiceOfferingGetResponse.d.ts +10 -0
- package/dist/types/models/api/IServiceOfferingListRequest.d.ts +27 -0
- package/dist/types/models/api/IServiceOfferingListResponse.d.ts +10 -0
- package/dist/types/models/data-resource/IDataResourceCredential.d.ts +11 -0
- package/dist/types/models/data-resource/IDataResourceEntry.d.ts +29 -0
- package/dist/types/models/data-resource/IDataResourceList.d.ts +25 -0
- package/dist/types/models/data-space-connector/IDataSpaceConnector.d.ts +77 -0
- package/dist/types/models/data-space-connector/IDataSpaceConnectorCredential.d.ts +11 -0
- package/dist/types/models/data-space-connector/IDataSpaceConnectorEntry.d.ts +18 -0
- package/dist/types/models/data-space-connector/IDataSpaceConnectorList.d.ts +25 -0
- package/dist/types/models/federatedCatalogueContextInstances.d.ts +14 -0
- package/dist/types/models/federatedCatalogueContextType.d.ts +11 -0
- package/dist/types/models/federatedCatalogueContexts.d.ts +13 -0
- package/dist/types/models/federatedCatalogueEntryType.d.ts +7 -0
- package/dist/types/models/federatedCatalogueTypes.d.ts +53 -0
- package/dist/types/models/participant/IParticipantCredential.d.ts +11 -0
- package/dist/types/models/participant/IParticipantEntry.d.ts +12 -0
- package/dist/types/models/participant/IParticipantList.d.ts +25 -0
- package/dist/types/models/service-offering/IServiceOfferingCredential.d.ts +11 -0
- package/dist/types/models/service-offering/IServiceOfferingEntry.d.ts +25 -0
- package/dist/types/models/service-offering/IServiceOfferingList.d.ts +25 -0
- package/dist/types/models/verificationFailureReasons.d.ts +53 -0
- package/docs/changelog.md +73 -0
- package/docs/examples.md +1 -0
- package/docs/reference/classes/FederatedCatalogueContextInstances.md +29 -0
- package/docs/reference/classes/FederatedCatalogueDataTypes.md +25 -0
- package/docs/reference/index.md +58 -0
- package/docs/reference/interfaces/ICatalogueEntryGetRequest.md +37 -0
- package/docs/reference/interfaces/IComplianceCredential.md +103 -0
- package/docs/reference/interfaces/IComplianceEvidence.md +45 -0
- package/docs/reference/interfaces/ICompliancePresentationRequest.md +11 -0
- package/docs/reference/interfaces/IComplianceVerificationResult.md +55 -0
- package/docs/reference/interfaces/ICredential.md +51 -0
- package/docs/reference/interfaces/IDataResourceCredential.md +43 -0
- package/docs/reference/interfaces/IDataResourceEntry.md +131 -0
- package/docs/reference/interfaces/IDataResourceGetResponse.md +11 -0
- package/docs/reference/interfaces/IDataResourceList.md +35 -0
- package/docs/reference/interfaces/IDataResourceListRequest.md +55 -0
- package/docs/reference/interfaces/IDataResourceListResponse.md +11 -0
- package/docs/reference/interfaces/IDataSpaceConnector.md +130 -0
- package/docs/reference/interfaces/IDataSpaceConnectorCredential.md +43 -0
- package/docs/reference/interfaces/IDataSpaceConnectorEntry.md +224 -0
- package/docs/reference/interfaces/IDataSpaceConnectorGetResponse.md +11 -0
- package/docs/reference/interfaces/IDataSpaceConnectorList.md +35 -0
- package/docs/reference/interfaces/IDataSpaceConnectorListRequest.md +55 -0
- package/docs/reference/interfaces/IDataSpaceConnectorListResponse.md +11 -0
- package/docs/reference/interfaces/IFederatedCatalogueComponent.md +313 -0
- package/docs/reference/interfaces/IFederatedCatalogueGetRequest.md +23 -0
- package/docs/reference/interfaces/IParticipantCredential.md +43 -0
- package/docs/reference/interfaces/IParticipantEntry.md +83 -0
- package/docs/reference/interfaces/IParticipantGetResponse.md +11 -0
- package/docs/reference/interfaces/IParticipantList.md +35 -0
- package/docs/reference/interfaces/IParticipantListRequest.md +61 -0
- package/docs/reference/interfaces/IParticipantListResponse.md +11 -0
- package/docs/reference/interfaces/IServiceOfferingCredential.md +43 -0
- package/docs/reference/interfaces/IServiceOfferingEntry.md +119 -0
- package/docs/reference/interfaces/IServiceOfferingGetResponse.md +11 -0
- package/docs/reference/interfaces/IServiceOfferingList.md +35 -0
- package/docs/reference/interfaces/IServiceOfferingListRequest.md +55 -0
- package/docs/reference/interfaces/IServiceOfferingListResponse.md +11 -0
- package/docs/reference/interfaces/IVerificationResult.md +23 -0
- package/docs/reference/type-aliases/FederatedCatalogueContextType.md +5 -0
- package/docs/reference/type-aliases/FederatedCatalogueContexts.md +5 -0
- package/docs/reference/type-aliases/FederatedCatalogueEntryType.md +5 -0
- package/docs/reference/type-aliases/FederatedCatalogueTypes.md +5 -0
- package/docs/reference/type-aliases/ICatalogueEntry.md +5 -0
- package/docs/reference/type-aliases/VerificationFailureReasons.md +5 -0
- package/docs/reference/variables/FederatedCatalogueContexts.md +13 -0
- package/docs/reference/variables/FederatedCatalogueTypes.md +73 -0
- package/docs/reference/variables/VerificationFailureReasons.md +73 -0
- package/package.json +45 -0
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Variable: VerificationFailureReasons
|
|
2
|
+
|
|
3
|
+
> `const` **VerificationFailureReasons**: `object`
|
|
4
|
+
|
|
5
|
+
The verification failure reasons.
|
|
6
|
+
|
|
7
|
+
## Type declaration
|
|
8
|
+
|
|
9
|
+
### InvalidCredentialType
|
|
10
|
+
|
|
11
|
+
> `readonly` **InvalidCredentialType**: `"invalidCredentialType"` = `"invalidCredentialType"`
|
|
12
|
+
|
|
13
|
+
Credential type is invalid.
|
|
14
|
+
|
|
15
|
+
### InvalidIssuer
|
|
16
|
+
|
|
17
|
+
> `readonly` **InvalidIssuer**: `"invalidIssuer"` = `"invalidIssuer"`
|
|
18
|
+
|
|
19
|
+
The issuer is invalid.
|
|
20
|
+
|
|
21
|
+
### NotValidYet
|
|
22
|
+
|
|
23
|
+
> `readonly` **NotValidYet**: `"notValidYet"` = `"notValidYet"`
|
|
24
|
+
|
|
25
|
+
Credential is not valid yet.
|
|
26
|
+
|
|
27
|
+
### Expired
|
|
28
|
+
|
|
29
|
+
> `readonly` **Expired**: `"expired"` = `"expired"`
|
|
30
|
+
|
|
31
|
+
Credential ahs expired.
|
|
32
|
+
|
|
33
|
+
### EvidenceCannotBeVerified
|
|
34
|
+
|
|
35
|
+
> `readonly` **EvidenceCannotBeVerified**: `"evidenceCannotBeVerified"` = `"evidenceCannotBeVerified"`
|
|
36
|
+
|
|
37
|
+
Credential's evidence cannot be verified.
|
|
38
|
+
|
|
39
|
+
### NoValidityEndPeriod
|
|
40
|
+
|
|
41
|
+
> `readonly` **NoValidityEndPeriod**: `"noValidityEndPeriod"` = `"noValidityEndPeriod"`
|
|
42
|
+
|
|
43
|
+
Credential has no expiration.
|
|
44
|
+
|
|
45
|
+
### MissingSubject
|
|
46
|
+
|
|
47
|
+
> `readonly` **MissingSubject**: `"missingSubject"` = `"missingSubject"`
|
|
48
|
+
|
|
49
|
+
Credential's subject is missing.
|
|
50
|
+
|
|
51
|
+
### MissingEvidences
|
|
52
|
+
|
|
53
|
+
> `readonly` **MissingEvidences**: `"missingEvidences"` = `"missingEvidences"`
|
|
54
|
+
|
|
55
|
+
Credential's evidences are missing.
|
|
56
|
+
|
|
57
|
+
### GeneralVerificationError
|
|
58
|
+
|
|
59
|
+
> `readonly` **GeneralVerificationError**: `"generalVerificationError"` = `"generalVerificationError"`
|
|
60
|
+
|
|
61
|
+
General error happened while verifying and the credential cannot be deemed as verified.
|
|
62
|
+
|
|
63
|
+
### IntegrityCheckFailed
|
|
64
|
+
|
|
65
|
+
> `readonly` **IntegrityCheckFailed**: `"integrityCheckFailed"` = `"integrityCheckFailed"`
|
|
66
|
+
|
|
67
|
+
Credential's integrity check has failed
|
|
68
|
+
|
|
69
|
+
### EvidenceCannotBeRetrieved
|
|
70
|
+
|
|
71
|
+
> `readonly` **EvidenceCannotBeRetrieved**: `"evidenceCannotBeRetrieved"` = `"evidenceCannotBeRetrieved"`
|
|
72
|
+
|
|
73
|
+
Credential's Evidence cannot be retrieved.
|
package/package.json
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@twin.org/federated-catalogue-models",
|
|
3
|
+
"version": "0.0.1-next.10",
|
|
4
|
+
"description": "Models which define the structure of the Federated Catalogue Service",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/twinfoundation/federated-catalogue.git",
|
|
8
|
+
"directory": "packages/federated-catalogue-models"
|
|
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/core": "next",
|
|
18
|
+
"@twin.org/data-core": "next",
|
|
19
|
+
"@twin.org/data-json-ld": "next",
|
|
20
|
+
"@twin.org/entity": "next",
|
|
21
|
+
"@twin.org/nameof": "next",
|
|
22
|
+
"@twin.org/standards-gaia-x": "next",
|
|
23
|
+
"@twin.org/standards-schema-org": "next",
|
|
24
|
+
"@twin.org/standards-w3c-did": "next",
|
|
25
|
+
"@twin.org/standards-w3c-odrl": "next"
|
|
26
|
+
},
|
|
27
|
+
"main": "./dist/cjs/index.cjs",
|
|
28
|
+
"module": "./dist/esm/index.mjs",
|
|
29
|
+
"types": "./dist/types/index.d.ts",
|
|
30
|
+
"exports": {
|
|
31
|
+
".": {
|
|
32
|
+
"types": "./dist/types/index.d.ts",
|
|
33
|
+
"require": "./dist/cjs/index.cjs",
|
|
34
|
+
"import": "./dist/esm/index.mjs"
|
|
35
|
+
},
|
|
36
|
+
"./locales/*.json": "./locales/*.json"
|
|
37
|
+
},
|
|
38
|
+
"files": [
|
|
39
|
+
"dist/cjs",
|
|
40
|
+
"dist/esm",
|
|
41
|
+
"dist/types",
|
|
42
|
+
"locales",
|
|
43
|
+
"docs"
|
|
44
|
+
]
|
|
45
|
+
}
|