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

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

@@ -0,0 +1,42 @@
+{
+  "title": "organization-search-query-params",
+  "type": "object",
+  "$id": "organization-search-query-params",
+  "description": "Query parameters used for searching organizations",
+  "allOf": [
+    {
+      "$ref": "https://velocitynetwork.foundation/schemas/page-query.schema.json#"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "filter": {
+          "type": "object",
+          "properties": {
+            "serviceTypes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "credentialTypes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "did": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "q": {
+          "type": "string"
+        }
+      }
+    }
+  ]
+}

package/src/organization/public-key.schema.json

@@ -0,0 +1,99 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "public-key",
+  "type": "object",
+  "title": "public-key",
+  "description": "A public key is a verification method. Public keys are used for digital signatures, encryption and other cryptographic operations, which in turn are the basis for purposes such as authentication.",
+  "additionalProperties": true,
+  "properties": {
+    "id": {
+      "title": "Public Key ID",
+      "type": "string",
+      "example": [
+        "did:example:123#primary"
+      ]
+    },
+    "type": {
+      "title": "Public Key Type",
+      "type": "string",
+      "enum": [
+        "EcdsaSecp256k1VerificationKey2019",
+        "X25519KeyAgreementKey2019",
+        "Ed25519VerificationKey2018",
+        "JsonWebKey2020"
+      ],
+      "example": [
+        "EcdsaSecp256k1VerificationKey2019"
+      ]
+    },
+    "controller": {
+      "title": "Controller",
+      "description": "https://w3c.github.io/did-core-registries/#controller",
+      "type": "string",
+      "example": [
+        "did:example:123"
+      ]
+    }
+  },
+  "oneOf": [
+    {
+      "properties": {
+        "publicKeyJwk": {
+          "title": "Public Key JWK",
+          "description": "https://w3c.github.io/did-spec-registries/#publickeyjwk",
+          "type": "object",
+          "properties": {
+            "crv": {
+              "type": "string"
+            },
+            "kid": {
+              "type": "string"
+            },
+            "kty": {
+              "type": "string"
+            },
+            "x": {
+              "type": "string"
+            },
+            "y": {
+              "type": "string"
+            }
+          },
+          "example": [
+            {
+              "crv": "secp256k1",
+              "kid": "JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw",
+              "kty": "EC",
+              "x": "dWCvM4fTdeM0KmloF57zxtBPXTOythHPMm1HCLrdd3A",
+              "y": "36uMVGM7hnw-N6GnjFcihWE3SkrhMLzzLCdPMXPEXlA"
+            }
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "controller",
+        "publicKeyJwk"
+      ]
+    },
+    {
+      "properties": {
+        "publicKeyBase58": {
+          "title": "Public Key Base58",
+          "description": "https://w3c.github.io/did-spec-registries/#publickeybase58",
+          "type": "string",
+          "example": [
+            "CaSHXEvLKS6SfN9aBfkVGBpp15jSnaHazqHgLHp8KZ3Y"
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "controller",
+        "publicKeyBase58"
+      ]
+    }
+  ]
+}

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"]
+}

package/src/organization/registrar-message.json

@@ -0,0 +1,84 @@
+{
+    "$id": "registrar-message",
+    "type": "object",
+    "properties": {
+        "messageType": {
+            "type": "string",
+            "enum": [
+                "test",
+                "create_tenant"
+            ]
+        },
+        "messageId": {
+            "type": "string"
+        },
+        "payload": {
+            "type": "object",
+            "properties": {
+                "caoDid": {
+                    "type": "string"
+                },
+                "caoService": {
+                    "$ref": "did-service#"
+                },
+                "create_tenant": {
+                    "type": "object",
+                    "properties": {
+                        "did": {
+                            "type": "string"
+                        },
+                        "serviceIds": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "keys": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "properties": {
+                                    "kidFragment": {
+                                        "type": "string",
+                                        "pattern": "^#[a-zA-Z0-9-_:?=&;]+$"
+                                    },
+                                    "purposes": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        }
+                                    },
+                                    "key": {
+                                        "type": "string"
+                                    },
+                                    "publicKey": {
+                                        "type": "string"
+                                    },
+                                    "algorithm": {
+                                        "type": "string",
+                                        "enum": [
+                                            "SECP256K1",
+                                            "ED25519"
+                                        ]
+                                    },
+                                    "encoding": {
+                                        "type": "string",
+                                        "enum": [
+                                            "hex",
+                                            "base58",
+                                            "jwk"
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "required": [
+        "messageType",
+        "messageId"
+    ]
+}

package/src/verification/identify-webhook.request.body.schema.json

@@ -0,0 +1,113 @@
+{
+  "title": "identify-webhook-request-body",
+  "$id": "identify-webhook-request-body",
+  "type": "object",
+  "anyOf": [
+    {
+      "properties": {
+        "idDocumentCredentials": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id"
+                ],
+                "deprecated": true
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "credentialSubject": {
+                    "type": "object",
+                    "properties": {
+                      "id": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "id"
+                    ]
+                  }
+                },
+                "required": [
+                  "credentialSubject"
+                ]
+              }
+            ]
+          }
+        },
+        "exchangeId": {
+          "type": "string"
+        },
+        "vendorOriginContext": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "idDocumentCredentials",
+        "exchangeId"
+      ]
+    },
+    {
+      "properties": {
+        "idDocumentCredentials": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id"
+                ],
+                "deprecated": true
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "credentialSubject": {
+                    "type": "object",
+                    "properties": {
+                      "id": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "id"
+                    ]
+                  }
+                },
+                "required": [
+                  "credentialSubject"
+                ]
+              }
+            ]
+          }
+        },
+        "exchangeId": {
+          "type": "string"
+        },
+        "vendorOriginContext": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "idDocumentCredentials",
+        "vendorOriginContext",
+        "exchangeId"
+      ]
+    }
+  ]
+}

package/src/verification/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 identifyWebhookRequestBodySchema = require('./identify-webhook.request.body.schema.json');
+const verificationIdentifyResponse200Schema = require('./verification.identify.response.200.schema.json');
+
+module.exports = {
+  identifyWebhookRequestBodySchema,
+  verificationIdentifyResponse200Schema,
+};

package/src/verification/verification.identify.response.200.schema.json

@@ -0,0 +1,12 @@
+{
+  "title": "verification-identify-response-200",
+  "$id": "verification-identify-response-200",
+  "type": "object",
+  "properties": {
+    "vendorUserId": { "type": "string" }
+  },
+  "required": [
+    "vendorUserId"
+  ],
+  "additionalProperties": false
+}