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

package/src/jwts/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 jwtSignSchema = require('./jwt-sign.schema.json');
+const jwtSignResponse200Schema = require('./jwt-sign.response.200.schema.json');
+const jwtDecodeSchema = require('./jwt-decode.schema.json');
+const jwtDecodeResponse200Schema = require('./jwt-decode.response.200.schema.json');
+const jwtVerifySchema = require('./jwt-verify.schema.json');
+const jwtVerifyResponse200Schema = require('./jwt-verify.response.200.schema.json');
+
+module.exports = {
+  jwtSignSchema,
+  jwtSignResponse200Schema,
+  jwtDecodeSchema,
+  jwtDecodeResponse200Schema,
+  jwtVerifySchema,
+  jwtVerifyResponse200Schema,
+};

package/src/jwts/jwt-decode.response.200.schema.json

@@ -0,0 +1,20 @@
+{
+  "title": "jwt-decode-response-200",
+  "$id": "jwt-decode-response-200",
+  "type": "object",
+  "properties": {
+    "payload": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "header": {
+      "type": "object",
+      "additionalProperties": true
+    }
+  },
+  "required": [
+    "payload",
+    "header"
+  ],
+  "additionalProperties": false
+}

package/src/jwts/jwt-decode.schema.json

@@ -0,0 +1,15 @@
+{
+  "title": "jwts-decode",
+  "$id": "jwts-decode",
+  "type": "object",
+  "properties": {
+    "jwt": {
+      "type": "string",
+      "description": "a jwt string."
+    }
+  },
+  "required": [
+    "jwt"
+  ],
+  "additionalProperties": false
+}

package/src/jwts/jwt-sign.response.200.schema.json

@@ -0,0 +1,14 @@
+{
+  "title": "jwt-sign-response-200",
+  "$id": "jwt-sign-response-200",
+  "type": "object",
+  "properties": {
+    "jwt": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "jwt"
+  ],
+  "additionalProperties": false
+}

package/src/jwts/jwt-sign.schema.json

@@ -0,0 +1,40 @@
+{
+  "title": "jwt-sign",
+  "$id": "jwt-sign",
+  "type": "object",
+  "properties": {
+    "payload": {
+      "type": "object"
+    },
+    "options": {
+      "type": "object",
+      "properties": {
+        "issuer": {
+          "type": "string",
+          "description": "did or random uuid of the issuer"
+        },
+        "audience": {
+          "type": "string",
+          "description": "did or random uuid of the audience"
+        },
+        "subject": {
+          "type": "string",
+          "description": "did or random uuid of the subject"
+        },
+        "expiresIn": {
+          "type": "string",
+          "description": "a ISO 8601 formatted duration string"
+        }
+      },
+      "required": [
+        "issuer",
+        "subject"
+      ]
+    }
+  },
+  "required": [
+    "payload",
+    "options"
+  ],
+  "additionalProperties": false
+}

package/src/jwts/jwt-verify.response.200.schema.json

@@ -0,0 +1,17 @@
+{
+  "title": "jwt-verify-response-200",
+  "$id": "jwt-verify-response-200",
+  "type": "object",
+  "properties": {
+    "verified": {
+      "type": "boolean"
+    },
+    "error": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "verified"
+  ],
+  "additionalProperties": false
+}

package/src/jwts/jwt-verify.schema.json

@@ -0,0 +1,19 @@
+{
+  "title": "jwts-verify",
+  "$id": "jwts-verify",
+  "type": "object",
+  "properties": {
+    "jwt": {
+      "type": "string",
+      "description": "jwt string"
+    },
+    "publicKey": {
+      "type": "object",
+      "description": "jwk public key"
+    }
+  },
+  "required": [
+    "jwt"
+  ],
+  "additionalProperties": false
+}

package/src/organization/index.js

@@ -0,0 +1,39 @@
+/**
+ * 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 organizationProfileModificationSchema = require('./organization-profile-modification.schema.json');
+const organizationProfilePublicResponseSchema = require('./organization-profile-public-response.schema');
+const organizationProfileSchema = require('./organization-profile.schema.json');
+const organizationSearchQueryParamsSchema = require('./organization.search.query-params.schema.json');
+const organizationSearchQueryProfileParamsSchema = require('./organization.search-profile.query-params.schema.json');
+const organizationProfileVerifiableCredentialSchema = require('./organization-profile-verifiable-credential.schema.json');
+const organizationVerifiedProfileSchema = require('./organization-verified-profile.schema.json');
+const publicKeySchema = require('./public-key.schema.json');
+const registrarMessage = require('./registrar-message.json');
+const registrarMessageResponse = require('./registrar-message-response.json');
+
+module.exports = {
+  organizationProfileModificationSchema,
+  organizationProfilePublicResponseSchema,
+  organizationProfileSchema,
+  organizationSearchQueryParamsSchema,
+  organizationSearchQueryProfileParamsSchema,
+  organizationProfileVerifiableCredentialSchema,
+  organizationVerifiedProfileSchema,
+  publicKeySchema,
+  registrarMessage,
+  registrarMessageResponse,
+};

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

@@ -0,0 +1,172 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-profile-modification",
+  "title": "Editable 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"
+    },
+    "secureMessagesUrl": {
+      "type": "string"
+    },
+    "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"
+        ]
+      }
+    },
+    "adminName": {
+      "type": "string",
+      "description": "Name of the admin"
+    },
+    "adminTitle": {
+      "type": "string",
+      "description": "Title of the admin"
+    },
+    "adminEmail": {
+      "type": "string",
+      "format": "email",
+      "description": "Email of the admin"
+    },
+    "signatoryName": {
+      "type": "string",
+      "description": "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"
+    }
+  },
+  "required": [
+    "name",
+    "location",
+    "logo",
+    "type",
+    "adminName",
+    "adminTitle",
+    "adminEmail",
+    "signatoryName",
+    "signatoryTitle",
+    "signatoryEmail",
+    "physicalAddress",
+    "linkedInProfile",
+    "contactEmail",
+    "technicalEmail",
+    "description"
+  ]
+}

package/src/organization/organization-profile-public-response.schema.js

@@ -0,0 +1,16 @@
+const { filter } = require('lodash/fp');
+const profileModificationSchema = require('./organization-profile-modification.schema.json');
+
+module.exports = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  $id: 'organization-profile-public-response',
+  title: 'Organization Public Profile Response',
+  type: 'object',
+  additionalProperties: false,
+  description: 'Profile info for an org in the response',
+  properties: profileModificationSchema.properties,
+  required: filter(
+    ['name', 'location', 'logo', 'type', 'physicalAddress', 'linkedInProfile'],
+    profileModificationSchema.required
+  ),
+};

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

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-profile-verifiable-credential",
+  "type": "object",
+  "title": "Organization Profile Verifiable Credential",
+  "description": "An organization's profile as a verifiable credential",
+  "properties": {
+    "format": {
+      "type": "string",
+      "enum": [
+        "jwt_vc"
+      ],
+      "description": "the format of the verifiable credential"
+    },
+    "vc": {
+      "type": "string",
+      "description": "the verifiable credential containing the organization's profile"
+    }
+  },
+  "required": [
+    "format",
+    "vc"
+  ]
+
+}

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

@@ -0,0 +1,57 @@
+{
+  "$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-public-response#"
+    },
+    {
+      "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"
+        },
+        "updatedAt": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "permittedVelocityServiceCategory"
+      ]
+    }
+  ]
+}

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

@@ -0,0 +1,125 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-verified-profile",
+  "type": "object",
+  "title": "An organization verified profile",
+  "description": "Verified profile information for an organization",
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "A unique id for the credential that was disclosed at this time."
+        },
+        "type": {
+          "type": "array",
+          "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",
+          "items": {
+            "type": "string"
+          }
+        },
+        "issuer": {
+          "type": "object",
+          "description": "DID of the issuer",
+          "properties": {
+            "id": {
+              "type": "string"
+            }
+          }
+        },
+        "credentialSubject": {
+          "allOf": [
+            {
+              "$ref": "organization-profile-public-response#"
+            },
+            {
+              "properties": {
+                "id": {
+                  "type": "string"
+                }
+              }
+            }
+          ]
+        },
+        "credentialSchema": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            }
+          }
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time",
+          "description": "when the credential will start being valid"
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "when the credential will expire"
+        },
+        "issued": {
+          "type": "string",
+          "format": "date-time",
+          "description": "when did the issuer actually issue the verified credential"
+        },
+        "credentialChecks": {
+          "type": "object",
+          "properties": {
+            "checked": {
+              "type": "string",
+              "format": "date-time",
+              "description": "when did the system last run checks on the profile VC"
+            },
+            "TRUSTED_ISSUER": {
+              "type": "string",
+              "enum": [
+                "PASS",
+                "FAIL",
+                "NOT_CHECKED",
+                "SELF_SIGNED"
+              ]
+            },
+            "UNREVOKED": {
+              "type": "string",
+              "enum": [
+                "PASS",
+                "FAIL",
+                "NOT_CHECKED"
+              ]
+            },
+            "UNEXPIRED": {
+              "type": "string",
+              "enum": [
+                "PASS",
+                "FAIL",
+                "NOT_CHECKED",
+                "NOT_APPLICABLE"
+              ]
+            },
+            "UNTAMPERED": {
+              "type": "string",
+              "enum": [
+                "PASS",
+                "FAIL",
+                "NOT_CHECKED"
+              ]
+            }
+          }
+        }
+      },
+      "required": [
+        "type",
+        "issuer",
+        "credentialSubject",
+        "issued",
+        "credentialChecks"
+      ]
+    }
+  ]
+}

package/src/organization/organization.search-profile.query-params.schema.json

@@ -0,0 +1,50 @@
+{
+  "title": "organization-search-query-params",
+  "type": "object",
+  "$id": "organization-search-profile-query-params",
+  "description": "Query parameters used for searching organizations",
+  "properties": {
+    "filter": {
+      "type": "object",
+      "properties": {
+        "serviceTypes": {
+          "type": "array",
+          "items": {"type": "string"}
+        },
+        "did": {
+          "type": "array",
+          "items": {"type": "string"}
+        }
+      }
+    },
+    "page": {
+      "type": "object",
+      "properties": {
+        "size": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "skip": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "q": {
+      "type": "string"
+    },
+    "sort": {
+      "type": "array",
+      "items": {
+        "type": "array",
+        "minItems": 2,
+        "maxItems": 2
+      }
+    },
+    "no-service-endpoint-transform": {
+      "type": "string",
+      "enum": ["1", "true"]
+    }
+  },
+  "additionalProperties": false
+}