@velocitycareerlabs/libapp 1.25.0-dev-build.17c2a2ff0 → 1.25.0-dev-build.1a18f10e5

package/schemas/id-document-v1.0.schema.json

@@ -0,0 +1,278 @@
+{
+  "title": "ID document",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitynetwork.foundation/schemas/id-document-v1.0",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "@context": {
+      "$ref": "#/definitions/Json-ld-context_Schema"
+    },
+    "type": {
+      "type": "string",
+      "default": "IdDocument"
+    },
+    "documentType": {
+      "type": "string",
+      "description": "The type of document.",
+      "maxLength": 32
+    },
+    "authority": {
+      "$ref": "#/definitions/Organization_Schema"
+    },
+    "validity": {
+      "$ref": "#/definitions/Validity_Schema"
+    },
+    "person": {
+      "$ref": "#/definitions/Person_Schema"
+    },
+    "identifier": {
+      "type": "string",
+      "description": "The id number.",
+      "maxLength": 64
+    },
+    "nationality": {
+      "type": "string",
+      "pattern": "^[A-Z]{2}$",
+      "description": "The nationality of the person holding the document.",
+      "maxLength": 2
+    },
+    "postalAddress": {
+      "$ref": "#/definitions/Address_Schema"
+    }
+  },
+  "required": [
+    "documentType",
+    "authority",
+    "identifier",
+    "person"
+  ],
+  "definitions": {
+    "Json-ld-context_Schema": {
+      "title": "json-ld-context",
+      "oneOf": [
+        {
+          "type": "string",
+          "maxLength": 2048
+        },
+        {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "maxLength": 2048
+          }
+        }
+      ],
+      "description": "Simplified context for Velocity Publishers to Use"
+    },
+    "Address_Schema": {
+      "title": "Address",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Address"
+        },
+        "streetAddress": {
+          "type": "string",
+          "description": "The street address.",
+          "maxLength": 512
+        },
+        "addressLocality": {
+          "type": "string",
+          "description": "The locality of the address, e.g., town or city name.",
+          "maxLength": 256
+        },
+        "addressRegion": {
+          "type": "string",
+          "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3})?$",
+          "description": "The region where the place is. These are states, provinces, etc. Must be an [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2)",
+          "maxLength": 6
+        },
+        "postCode": {
+          "type": "string",
+          "description": "Postcode or zip code of the address.",
+          "maxLength": 32
+        },
+        "addressCountry": {
+          "type": "string",
+          "description": "The country where the place is. Must be an [ISO 3166 2 letter country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)",
+          "pattern": "^[A-Z]{2}$",
+          "maxLength": 2
+        }
+      },
+      "required": [
+        "addressCountry"
+      ]
+    },
+    "Did_Schema": {
+      "title": "DID",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "Organization_Schema": {
+      "title": "Organization",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Organization"
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the organization.",
+          "maxLength": 256
+        },
+        "identifier": {
+          "$ref": "#/definitions/Did_Schema"
+        },
+        "place": {
+          "$ref": "#/definitions/Place_Schema"
+        }
+      },
+      "required": [
+        "name",
+        "place"
+      ]
+    },
+    "Person_Schema": {
+      "title": "Person",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Person"
+        },
+        "givenName": {
+          "type": "string",
+          "description": "The given name or first name of the person.",
+          "maxLength": 64
+        },
+        "familyName": {
+          "type": "string",
+          "description": "The family name or surname of the person.",
+          "maxLength": 64
+        },
+        "middleName": {
+          "type": "string",
+          "description": "The middle name of the person.",
+          "maxLength": 256
+        },
+        "namePrefix": {
+          "type": "string",
+          "description": "A prefix to the name such as Dr or Sir.",
+          "maxLength": 8
+        },
+        "nameSuffix": {
+          "type": "string",
+          "description": "A suffix to the name such as Jr. or Sr.",
+          "maxLength": 16
+        },
+        "birthDate": {
+          "type": "string",
+          "format": "date",
+          "description": "The date of birth of the person."
+        },
+        "birthPlace": {
+          "$ref": "#/definitions/Place_Schema"
+        },
+        "gender": {
+          "type": "string",
+          "enum": [
+            "Male",
+            "Female",
+            "Other"
+          ],
+          "description": "The gender of the person."
+        }
+      },
+      "required": [
+        "givenName",
+        "birthDate"
+      ]
+    },
+    "Place_Schema": {
+      "title": "Place",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Place"
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the place, e.g., building name, branch name, etc.",
+          "maxLength": 256
+        },
+        "addressLocality": {
+          "type": "string",
+          "description": "The locality where the place is, e.g., town or city name.",
+          "maxLength": 256
+        },
+        "addressRegion": {
+          "type": "string",
+          "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3})?$",
+          "description": "The region where the place is. These are states, provinces, etc. Must be an [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2)",
+          "maxLength": 6
+        },
+        "addressCountry": {
+          "type": "string",
+          "description": "The country where the place is. Must be an [ISO 3166 2 letter country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)",
+          "pattern": "^[A-Z]{2}$",
+          "maxLength": 2
+        }
+      },
+      "required": [
+        "addressCountry"
+      ]
+    },
+    "Validity_Schema": {
+      "title": "Validity",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Validity"
+        },
+        "firstValidFrom": {
+          "type": "string",
+          "format": "date",
+          "description": "The original date from which a certification, document or license is valid. "
+        },
+        "validFrom": {
+          "oneOf": [
+            {
+              "format": "date"
+            },
+            {
+              "format": "date-time"
+            }
+          ],
+          "description": "The date from which a certification, document or license is valid. In case of renewal, validFrom date will state the date or renewal. ",
+          "type": "string"
+        },
+        "validUntil": {
+          "oneOf": [
+            {
+              "format": "date"
+            },
+            {
+              "format": "date-time"
+            }
+          ],
+          "description": "The date until which a certification, document or license is valid. ",
+          "type": "string"
+        },
+        "validIn": {
+          "$ref": "#/definitions/Place_Schema"
+        }
+      }
+    }
+  }
+}

package/schemas/id-document.schema.json

@@ -0,0 +1,169 @@
+{
+  "title": "id-document",
+  "type": "object",
+  "$id": "id-document",
+  "version": 1,
+  "description": "id document v1 schema",
+  "definitions": {
+    "DID": {
+      "type": "string",
+      "format": "regex",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "MultiLingualString": {
+      "type": "object",
+      "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}$"
+            }
+          }
+        }
+      },
+      "additionalProperties": false,
+      "format": "regex",
+      "pattern": "^[a-zA-Z0-9\\s]*$",
+      "maxLength": 64,
+      "required": [
+        "localized"
+      ]
+    },
+    "Date": {
+      "type": "object",
+      "properties": {
+        "day": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 31
+        },
+        "month": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 12
+        },
+        "year": {
+          "type": "integer",
+          "minimum": 1950
+        }
+      },
+      "additionalProperties": false
+    },
+    "Location": {
+      "type": "object",
+      "properties": {
+        "countryCode": {
+          "type": "string",
+          "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)"
+        },
+        "regionCode": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[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)"
+        }
+      }
+    },
+    "Address": {
+      "type": "object",
+      "properties": {
+        "line1": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        },
+        "line2": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        },
+        "line3": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        },
+        "regionCode": {
+          "type": "string",
+          "format": "regex",
+          "pattern": "^[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)"
+        },
+        "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",
+          "format": "regex",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        }
+      }
+    }
+  },
+  "properties": {
+    "kind": {
+      "type": "string",
+      "description": "DriversLicense, IdCard, SSN, NI Number, etc"
+    },
+    "authority": {
+      "$ref": "#/definitions/MultiLingualString",
+      "description": "name of the issuing authority"
+    },
+    "authorityId": {
+      "type": "string",
+      "description": "DID id of the issuing authority"
+    },
+    "location": {
+      "$ref": "#/definitions/Location"
+    },
+    "identityNumber": {
+      "type": "string",
+      "description": "The id number of the identity credential"
+    },
+    "firstName": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "lastName": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "middleNames": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "address": {
+      "$ref": "#/definitions/Address"
+    },
+    "dob": {
+      "$ref": "#/definitions/Date"
+    }
+  },
+  "required": [
+    "kind",
+    "identityNumber",
+    "authority",
+    "firstName"
+  ]
+}

package/schemas/license-v1.0.schema.json

@@ -0,0 +1,252 @@
+{
+  "title": "License",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitynetwork.foundation/schemas/license-v1.0",
+  "allOf": [
+    {
+      "$ref": "#/definitions/Certification-license-base"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "CertificationLicense"
+        },
+        "identifier": {
+          "type": "string",
+          "description": "The number or other unique identifier of the license held by the person. ",
+          "maxLength": 512
+        },
+        "validity": {
+          "$ref": "#/definitions/Validity_Schema"
+        },
+        "endorsementCode": {
+          "type": "array",
+          "description": "Endorsements to the license such as vehicle class A1, B, in driver's license, or specialties in nursing license.",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "maxLength": 128
+          }
+        },
+        "restrictionCode": {
+          "type": "array",
+          "description": "Restrictions to the license such as need to wear glasses in driver's license.",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "maxLength": 128
+          }
+        }
+      }
+    }
+  ],
+  "required": [
+    "authority",
+    "name",
+    "identifier"
+  ],
+  "definitions": {
+    "Certification-license-base": {
+      "title": "Certification-license-base",
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "type": "object",
+      "properties": {
+        "@context": {
+          "$ref": "#/definitions/Json-ld-context_Schema"
+        },
+        "authority": {
+          "$ref": "#/definitions/Organization_Schema"
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the certification or license.",
+          "maxLength": 256
+        },
+        "description": {
+          "type": "string",
+          "description": "Detailed description of the certification or license.",
+          "maxLength": 2048
+        },
+        "alignment": {
+          "type": "array",
+          "description": "A public resource to which the certification or license is aligned.",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/definitions/Alignment_Schema"
+          }
+        }
+      }
+    },
+    "Json-ld-context_Schema": {
+      "title": "json-ld-context",
+      "oneOf": [
+        {
+          "type": "string",
+          "maxLength": 2048
+        },
+        {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "maxLength": 2048
+          }
+        }
+      ],
+      "description": "Simplified context for Velocity Publishers to Use"
+    },
+    "Alignment_Schema": {
+      "title": "Alignment",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "AlignmentObject"
+        },
+        "targetName": {
+          "type": "string",
+          "description": "Name of the target alignment.",
+          "maxLength": 256
+        },
+        "targetUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL of the target alignment. ",
+          "maxLength": 2048
+        },
+        "targetDescription": {
+          "type": "string",
+          "description": "Detailed description of the target alignment. ",
+          "maxLength": 2048
+        },
+        "targetCode": {
+          "type": "string",
+          "description": "Code of the target alignment. ",
+          "maxLength": 256
+        },
+        "targetFramework": {
+          "type": "string",
+          "description": "The framework to which the target belongs. ",
+          "maxLength": 256
+        }
+      },
+      "required": [
+        "targetName",
+        "targetUrl"
+      ]
+    },
+    "Did_Schema": {
+      "title": "DID",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "Organization_Schema": {
+      "title": "Organization",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Organization"
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the organization.",
+          "maxLength": 256
+        },
+        "identifier": {
+          "$ref": "#/definitions/Did_Schema"
+        },
+        "place": {
+          "$ref": "#/definitions/Place_Schema"
+        }
+      },
+      "required": [
+        "name",
+        "place"
+      ]
+    },
+    "Place_Schema": {
+      "title": "Place",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Place"
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the place, e.g., building name, branch name, etc.",
+          "maxLength": 256
+        },
+        "addressLocality": {
+          "type": "string",
+          "description": "The locality where the place is, e.g., town or city name.",
+          "maxLength": 256
+        },
+        "addressRegion": {
+          "type": "string",
+          "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3})?$",
+          "description": "The region where the place is. These are states, provinces, etc. Must be an [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2)",
+          "maxLength": 6
+        },
+        "addressCountry": {
+          "type": "string",
+          "description": "The country where the place is. Must be an [ISO 3166 2 letter country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)",
+          "pattern": "^[A-Z]{2}$",
+          "maxLength": 2
+        }
+      },
+      "required": [
+        "addressCountry"
+      ]
+    },
+    "Validity_Schema": {
+      "title": "Validity",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "Validity"
+        },
+        "firstValidFrom": {
+          "type": "string",
+          "format": "date",
+          "description": "The original date from which a certification, document or license is valid. "
+        },
+        "validFrom": {
+          "oneOf": [
+            {
+              "format": "date"
+            },
+            {
+              "format": "date-time"
+            }
+          ],
+          "description": "The date from which a certification, document or license is valid. In case of renewal, validFrom date will state the date or renewal. ",
+          "type": "string"
+        },
+        "validUntil": {
+          "oneOf": [
+            {
+              "format": "date"
+            },
+            {
+              "format": "date-time"
+            }
+          ],
+          "description": "The date until which a certification, document or license is valid. ",
+          "type": "string"
+        },
+        "validIn": {
+          "$ref": "#/definitions/Place_Schema"
+        }
+      }
+    }
+  }
+}