@velocitycareerlabs/common-schemas 1.17.0-dev-build.1bc6fcace

package/src/did/index.js

@@ -0,0 +1,29 @@
+/**
+ * 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 didDocSchema = require('./did-doc.schema.json');
+const didServiceSchema = require('./did-service.schema.json');
+const didProofSchema = require('./did-proof.schema.json');
+const modifyDidServiceSchema = require('./modify-did-service.schema.json');
+const didKeySchema = require('./did-key.schema.json');
+
+module.exports = {
+  didDocSchema,
+  didServiceSchema,
+  didProofSchema,
+  modifyDidServiceSchema,
+  didKeySchema,
+};

package/src/did/modify-did-service.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "modify-did-service",
+  "title": "modify-did-service",
+  "type": "object",
+  "properties": {
+    "serviceEndpoint": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "serviceEndpoint"
+  ]
+}

package/src/entity/immutable-entity.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "$id": "immutable-entity",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "required": ["id", "createdAt"]
+}

package/src/entity/index.js

@@ -0,0 +1,20 @@
+/**
+ * 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 immutableEntitySchema = require('./immutable-entity.schema.json');
+const mutableEntitySchema = require('./mutable-entity.schema.json');
+
+module.exports = { mutableEntitySchema, immutableEntitySchema };

package/src/entity/mutable-entity.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "$id": "mutable-entity",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "required": ["id", "createdAt", "updatedAt"]
+}

package/src/error/error.schema.json

@@ -0,0 +1,19 @@
+{
+  "type": "object",
+  "$id": "error",
+  "properties": {
+    "error": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    },
+    "statusCode": {
+      "type": "integer"
+    },
+    "errorCode": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": true
+}

package/src/error/index.js

@@ -0,0 +1,19 @@
+/**
+ * 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 errorSchema = require('./error.schema.json');
+
+module.exports = { errorSchema };

package/src/general/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/general/date.schema.json

@@ -0,0 +1,23 @@
+{
+  "title": "date",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/date.schema.json",
+  "description": "date validation schema",
+  "properties": {
+    "day": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 31
+    },
+    "month": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 12
+    },
+    "year": {
+      "type": "integer",
+      "minimum": 500
+    }
+  },
+  "additionalProperties": false
+}

package/src/general/email.schema.json

@@ -0,0 +1,13 @@
+{
+  "title": "email",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/email.schema.json",
+  "description": "email schema",
+  "properties": {
+    "email": {
+      "type": "string",
+      "format": "email"
+    }
+  },
+  "required": ["email"]
+}

package/src/general/error-response.schema.json

@@ -0,0 +1,20 @@
+{
+    "title": "error-response",
+    "type": "object",
+    "$id": "https://velocitynetwork.foundation/schemas/error-response.schema.json",
+    "description": "error response schema",
+    "properties": {
+        "error": {
+            "type": "string"
+        },
+        "message": {
+            "type": "string"
+        },
+        "statusCode": {
+            "type": "integer"
+        },
+        "errorCode": {
+            "type": "string"
+        }
+    }
+}

package/src/general/index.js

@@ -0,0 +1,37 @@
+/**
+ * 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 addressSchema = require('./address.schema.json');
+const dateSchema = require('./date.schema.json');
+const locationSchema = require('./location.schema.json');
+const multilingualStringSchema = require('./multilingual-string.schema.json');
+const emailSchema = require('./email.schema.json');
+const phoneSchema = require('./phone.schema.json');
+const pageBodySchema = require('./page-body.schema.json');
+const pageQuerySchema = require('./page-query.schema.json');
+const errorResponseSchema = require('./error-response.schema.json');
+
+module.exports = {
+  addressSchema,
+  dateSchema,
+  locationSchema,
+  multilingualStringSchema,
+  emailSchema,
+  phoneSchema,
+  pageBodySchema,
+  pageQuerySchema,
+  errorResponseSchema,
+};

package/src/general/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/general/multilingual-string.schema.json

@@ -0,0 +1,40 @@
+
+{
+  "type": "object",
+  "title": "multilingual-string",
+  "$id": "https://velocitynetwork.foundation/schemas/multilingual-string.schema.json",
+  "additionalProperties": false,
+  "description": "an internationalized version of a string",
+  "properties": {
+    "localized": {
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[a-z]{2}(_[A-Z]{2})?$"
+      },
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "preferredLocale": {
+      "type": "object",
+      "properties": {
+        "country": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[A-Z]{2}$"
+        },
+        "language": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[a-z]{2}$"
+        }
+      },
+      "required": [
+        "language"
+      ]
+    }
+  },
+  "required": [
+    "localized"
+  ]
+}

package/src/general/page-body.schema.json

@@ -0,0 +1,28 @@
+{
+  "title": "page-body",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/page-body.schema.json",
+  "description": "Schema for configuring pagination with a page body",
+  "properties": {
+    "size": {
+      "type": "number",
+      "description": "The number of items to display per page"
+    },
+    "skip": {
+      "type": "number",
+      "description": "The number of items to skip before displaying the page (DEPRECATED)"
+    },
+    "nextPageToken": {
+      "type": "string",
+      "description": "The token to use to retrieve the next page"
+    },
+    "prevPageToken": {
+      "type": "string",
+      "description": "The token to use to retrieve the previous page"
+    }
+  },
+  "required": [
+    "size"
+  ],
+  "additionalProperties": false
+}

package/src/general/page-query.schema.json

@@ -0,0 +1,29 @@
+{
+    "title": "page-query",
+    "type": "object",
+    "$id": "https://velocitynetwork.foundation/schemas/page-query.schema.json",
+    "description": "Schema for configuring pagination with a page in the querystring",
+    "properties": {
+        "page": {
+            "type": "object",
+            "properties": {
+                "size": {
+                    "type": "integer",
+                    "minimum": 1
+                },
+                "skip": {
+                    "type": "integer",
+                    "minimum": 0
+                }
+            }
+        },
+        "sort": {
+            "type": "array",
+            "items": {
+                "type": "array",
+                "minItems": 2,
+                "maxItems": 2
+            }
+        }
+    }
+}

package/src/general/phone.schema.json

@@ -0,0 +1,13 @@
+{
+  "title": "phone",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/phone-number.schema.json",
+  "description": "phone schema",
+  "properties": {
+    "phone": {
+      "type": "string",
+      "pattern": "^\\+[1-9]\\d{1,14}$"
+    }
+  },
+  "required": ["phone"]
+}

package/src/identity/id-document.schema.json

@@ -0,0 +1,39 @@
+{
+  "title": "id-document",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/id-document.schema.json",
+  "description": "id document v1 schema",
+  "properties": {
+    "kind": {
+      "type": "string",
+      "description": "DriversLicense, IdCard, SSN, NI Number, etc"
+    },
+    "authorityId": {
+      "type": "string",
+      "description": "DID id of the issuing authority"
+    },
+    "location": {
+      "$ref": "https://velocitynetwork.foundation/schemas/location.schema.json#"
+    },
+    "identityNumber": {
+      "type": "string",
+      "description": "The id number of the identity credential"
+    },
+    "firstName": {
+      "$ref": "https://velocitynetwork.foundation/schemas/multilingual-string.schema.json#"
+    },
+    "lastName": {
+      "$ref": "https://velocitynetwork.foundation/schemas/multilingual-string.schema.json#"
+    },
+    "middleNames": {
+      "$ref": "https://velocitynetwork.foundation/schemas/multilingual-string.schema.json#"
+    },
+    "address": {
+      "$ref": "https://velocitynetwork.foundation/schemas/address.schema.json#"
+    },
+    "dob": {
+      "$ref": "https://velocitynetwork.foundation/schemas/date.schema.json#"
+    }
+  },
+  "required": []
+}

package/src/identity/index.js

@@ -0,0 +1,21 @@
+/**
+ * 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 idDocumentSchema = require('./id-document.schema.json');
+
+module.exports = {
+  idDocumentSchema,
+};

package/src/issuing/holder-offer.schema.json

@@ -0,0 +1,142 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitycareerlabs.io/holder-offer.schema.json",
+  "type": "object",
+  "description": "An offer is similar to a credential but is never encoded as a JWT as it doesnt carry the digital signature.",
+  "additionalProperties": false,
+  "properties": {
+    "type": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "type is identical to the standard based type found on verifiable credentials but does not accept a string, it only accepts an array to indicate an unordered set of type URIs"
+    },
+    "issuer": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "id"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "description": "the did id for the issuer."
+            },
+            "type": {
+              "type": "string",
+              "description": "the type of the issuer property"
+            },
+            "name": {
+              "type": "string"
+            },
+            "image": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "credentialSubject": {
+      "type": "object",
+      "additionalProperties": true,
+      "description": "Contains all the claims of the credential"
+    },
+    "credentialSchema": {
+      "oneOf": [
+        {
+          "type": "object",
+          "description": "Contains all the claims of the credential",
+          "properties": {
+            "type": {
+              "type": "string"
+            },
+            "id": {
+              "type": "string",
+              "format": "uri"
+            }
+          },
+          "required": [
+            "type",
+            "id"
+          ]
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "description": "Contains all the claims of the credential",
+            "properties": {
+              "type": {
+                "type": "string"
+              },
+              "id": {
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "required": [
+              "type",
+              "id"
+            ]
+          }
+        }
+      ]
+    },
+    "offerCreationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "offerExpirationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "offerId": {
+      "type": "string"
+    },
+    "id": {
+      "type": "string"
+    },
+    "exchangeId": {
+      "type": "string"
+    },
+    "hash": {
+      "type": "string"
+    },
+    "linkedCredentials": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "linkCode": {
+            "type": "string"
+          },
+          "linkType": {
+            "type": "string",
+            "enum": [
+              "REPLACE"
+            ]
+          }
+        },
+        "required": [
+          "linkCode",
+          "linkType"
+        ]
+      }
+    }
+  },
+  "required": [
+    "type",
+    "issuer",
+    "credentialSubject",
+    "offerCreationDate",
+    "offerExpirationDate",
+    "offerId",
+    "hash"
+  ]
+}

package/src/issuing/index.js

@@ -0,0 +1,23 @@
+/**
+ * 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 issuerDataSchema = require('./issuer-data.schema.json');
+const holderOfferSchema = require('./holder-offer.schema.json');
+
+module.exports = {
+  issuerDataSchema,
+  holderOfferSchema,
+};

package/src/issuing/issuer-data.schema.json

@@ -0,0 +1,26 @@
+{
+  "title": "issuer-data",
+  "type": "object",
+  "$id": "https://velocitynetwork.foundation/schemas/issuer-data.schema.json",
+  "description": "issuer data schema",
+  "properties": {
+    "credentialType": {
+      "type": "string"
+    },
+    "issuer": {
+      "type": "string"
+    },
+    "issued": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "validFrom": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "validUntil": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}