@verii/common-schemas 1.0.0-pre.1752076816

package/src/issuing/index.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const w3cVcSchema = require('./w3c-vc.schema.json');
+const newOfferRelatedResourceSchema = require('./new-offer-related-resource.schema.json');
+
+module.exports = {
+  newOfferRelatedResourceSchema,
+  w3cVcSchema,
+  ...require('./holder-offer.schema'),
+};

package/src/issuing/new-offer-related-resource.schema.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitycareerlabs.io/new-offer-related-resource.schema.json",
+  "title": "New Offer Related Resource",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "the id of the resource that is an related resource",
+          "format": "uri"
+        },
+        "type": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "the type of related resource. Typically omitted"
+        },
+        "mediaType": {
+          "type": "string",
+          "description": "the media type of the URI. Can be used to validate what is downloaded"
+        },
+        "digestSRI": {
+          "type": "string",
+          "description": "the digest of the object"
+        },
+        "name": {
+          "type": "string",
+          "description": "the name of the referenced resource"
+        },
+        "hint": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "rendering hints for wallets. Can be used to validate the downloaded credential. Eg PDF or VerifiableCredential"
+        }
+      },
+      "required": [
+        "id"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "offerId": {
+          "type": "string",
+          "description": "a reference to an offerId in the same exchange"
+        },
+        "type": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "the type of related resource. Typically omitted"
+        }
+      },
+      "required": [
+        "offerId"
+      ]
+    }
+  ]
+}

package/src/issuing/w3c-vc.schema.json

@@ -0,0 +1,196 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitycareerlabs.io/w3c-vc.schema.json",
+  "type": "object",
+  "title": "w3c-vc",
+  "description": "An w3c vc schema",
+  "additionalProperties": true,
+  "properties": {
+    "@context": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "The JSON-LD context of the credential. @context is defaulted based on the VN credential metadata for the type chosen below"
+    },
+    "type": {
+      "type": "array",
+      "description": "The JSON-LD type of the credential.",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1
+    },
+    "credentialSubject": {
+      "type": "object",
+      "description": "Contains all the claims of the credential",
+      "additionalProperties": true
+    },
+    "validUntil": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "validFrom": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "name": {
+      "type": "string"
+    },
+    "issuer": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The issuer id."
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of brand"
+        },
+        "image": {
+          "type": "string",
+          "description": "The uri to image"
+        }
+      }
+    },
+    "replaces": {
+      "type": "array",
+      "items": {
+        "$ref": "https://velocitycareerlabs.io/new-offer-related-resource.schema.json#"
+      }
+    },
+    "relatedResource": {
+      "type": "array",
+      "items": {
+        "$ref": "https://velocitycareerlabs.io/new-offer-related-resource.schema.json#"
+      }
+    },
+    "description": {
+      "type": "string"
+    },
+    "image": {
+      "type": "string",
+      "format": "uri"
+    },
+    "awardedDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "endorsement": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": true
+      }
+    },
+    "endorsementJwt": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "evidence": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": true
+      }
+    },
+    "credentialSchema": {
+      "oneOf": [{
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uri"
+          },
+          "type": {
+            "type": "string"
+          }
+        }
+      }, {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "format": "uri"
+            },
+            "type": {
+              "type": "string"
+            }
+          }
+        }
+      }]
+    },
+    "credentialStatus": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uri"
+        },
+        "type": {
+          "type": "string"
+        }
+      }
+    },
+    "refreshService": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uri"
+        },
+        "type": {
+          "type": "string"
+        }
+      }
+    },
+    "termsOfUrl": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        }
+      }
+    },
+    "expirationDate": {
+      "type": "string",
+      "format": "date-time",
+      "deprecated": true
+    },
+    "linkedCredentials": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "linkedCredentialId": {
+            "type": "string"
+          },
+          "linkType": {
+            "type": "string",
+            "enum": [
+              "REPLACE"
+            ]
+          }
+        },
+        "required": [
+          "linkedCredentialId",
+          "linkType"
+        ]
+      },
+      "deprecated": true
+    }
+  },
+  "required": [
+    "type",
+    "credentialSubject"
+  ]
+}

package/src/organization/address.schema.json

@@ -0,0 +1,33 @@
+{
+  "title": "address",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/address.schema.json",
+  "additionalProperties": false,
+  "description": "address validation schema",
+  "properties": {
+    "line1": {
+      "type": "string"
+    },
+    "line2": {
+      "type": "string"
+    },
+    "line3": {
+      "type": "string"
+    },
+    "regionCode": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3})?$",
+      "description": "An uppercase region code as defined by [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)"
+    },
+    "countryCode": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^[A-Z]{2}$",
+      "description": "An uppercase two-letter country code as defined by [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)"
+    },
+    "postcode": {
+      "type": "string"
+    }
+  }
+}

package/src/organization/index.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2023 Velocity Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const organizationProfileBaseSchema = require('./organization-profile-base.schema.json');
+const organizationProfileSchema = require('./organization-profile.schema.json');
+const registrarMessage = require('./registrar-message.json');
+const registrarMessageResponse = require('./registrar-message-response.json');
+const addressSchema = require('./address.schema.json');
+const locationSchema = require('./location.schema.json');
+
+module.exports = {
+  addressSchema,
+  locationSchema,
+  organizationProfileBaseSchema,
+  organizationProfileSchema,
+  registrarMessage,
+  registrarMessageResponse,
+};

package/src/organization/location.schema.json

@@ -0,0 +1,20 @@
+{
+  "title": "location",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/location.schema.json",
+  "description": "location validation schema",
+  "properties": {
+    "countryCode": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^[A-Z]{2}$"
+    },
+    "regionCode": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^[A-Za-z0-9]{1,3}(-[A-Za-z0-9]{1,3})?$",
+      "description": "An uppercase region code as defined by [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)"
+    }
+  },
+  "additionalProperties": false
+}

package/src/organization/organization-profile-base.schema.json

@@ -0,0 +1,169 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-profile-base",
+  "title": "Base Organization Profile Information",
+  "type": "object",
+  "additionalProperties": false,
+  "description": "Profile info for an org that can be set in a \"form\"",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "the name of the of",
+      "maxLength": 100
+    },
+    "location": {
+      "$ref": "https://velocitynetwork.foundation/schemas/location.schema.json#"
+    },
+    "logo": {
+      "type": "string",
+      "description": "the logo to be used for the org",
+      "format": "uri"
+    },
+    "website": {
+      "type": "string",
+      "format": "uri"
+    },
+    "alsoKnownAs": {
+      "title": "Also Known As",
+      "description": "https://www.w3.org/TR/did-core/#also-known-as",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "uri"
+      }
+    },
+    "contactEmail": {
+      "type": "string",
+      "format": "email"
+    },
+    "technicalEmail": {
+      "type": "string",
+      "format": "email"
+    },
+    "description": {
+      "type": "string"
+    },
+    "founded": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^\\d{4}(-\\d{2}(-\\d{2})?)?$"
+    },
+    "closed": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^\\d{4}(-\\d{2}(-\\d{2})?)?$"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "company",
+        "non-profit"
+      ],
+      "default": "company"
+    },
+    "registrationNumbers": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "authority": {
+            "type": "string",
+            "enum": [
+              "NationalAuthority",
+              "DunnAndBradstreet",
+              "GLEIF",
+              "LinkedIn"
+            ]
+          },
+          "number": {
+            "type": "string"
+          },
+          "uri": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "required": [
+          "authority",
+          "number"
+        ]
+      }
+    },
+    "commercialEntities": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "the type of commericial entity",
+            "enum": [
+              "Brand",
+              "Department"
+            ]
+          },
+          "name": {
+            "type": "string",
+            "description": "the commercial name of the org",
+            "maxLength": 100
+          },
+          "logo": {
+            "type": "string",
+            "description": "the commercial logo to be used for the org",
+            "format": "uri"
+          },
+          "description": {
+            "type": "string",
+            "description": "a description associated with this entity"
+          }
+        },
+        "required": [
+          "type",
+          "name",
+          "logo"
+        ]
+      }
+    },
+    "adminGivenName": {
+      "type": "string",
+      "description": "Given name of the admin"
+    },
+    "adminFamilyName": {
+      "type": "string",
+      "description": "Family name of the admin"
+    },
+    "adminTitle": {
+      "type": "string",
+      "description": "Title of the admin"
+    },
+    "adminEmail": {
+      "type": "string",
+      "format": "email",
+      "description": "Email of the admin"
+    },
+    "signatoryGivenName": {
+      "type": "string",
+      "description": "Given name of the signatory"
+    },
+    "signatoryFamilyName": {
+      "type": "string",
+      "description": "Family name of the signatory"
+    },
+    "signatoryTitle": {
+      "type": "string",
+      "description": "Title of the signatory"
+    },
+    "signatoryEmail": {
+      "type": "string",
+      "format": "email",
+      "description": "Email of the signatory"
+    },
+    "physicalAddress": {
+      "$ref": "https://velocitynetwork.foundation/schemas/address.schema.json#"
+    },
+    "linkedInProfile": {
+      "type": "string",
+      "format": "uri"
+    }
+  }
+}

package/src/organization/organization-profile.schema.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-profile",
+  "type": "object",
+  "title": "An organization in persistent storage",
+  "description": "Profile info for an organization",
+  "allOf": [
+    {
+      "$ref": "organization-profile-base#",
+      "required": [
+        "type",
+        "name",
+        "website",
+        "location",
+        "logo"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$",
+          "description": "the did of the organization"
+        },
+        "verifiableCredentialJwt": {
+          "type": "string",
+          "format": "uri",
+          "description": "the jwt of the vc that has the profile information encoded with in"
+        },
+        "permittedVelocityServiceCategory": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "Issuer",
+              "Inspector",
+              "CredentialAgentOperator",
+              "NodeOperator",
+              "NotaryIssuer",
+              "HolderAppProvider",
+              "TrustRoot",
+              "IdentityIssuer",
+              "IdDocumentIssuer",
+              "NotaryIdDocumentIssuer",
+              "ContactIssuer",
+              "NotaryContactIssuer"
+            ]
+          }
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "required": [
+        "id",
+        "permittedVelocityServiceCategory"
+      ]
+    }
+  ]
+}

package/src/organization/registrar-message-response.json

@@ -0,0 +1,9 @@
+{
+  "$id": "registrar-message-response",
+  "type": "object",
+  "properties": {
+    "messageType": { "type": "string", "enum": ["ack"] },
+    "messageId": { "type": "string" }
+  },
+  "required": ["messageType", "messageId"]
+}