@verii/server-credentialagent 1.0.0-pre.1752076816

package/src/controllers/operator/tenants/_tenantId/disclosures/schemas/agent-disclosure-presentation-definition.schema.json

@@ -0,0 +1,404 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Presentation Definition",
+  "$id": "https://velocitycareerlabs.io/agent-disclosure-presentation-definition.schema.json",
+  "definitions": {
+    "schema": {
+      "type": "object",
+      "properties": {
+        "uri": {
+          "type": "string"
+        },
+        "required": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "uri"
+      ],
+      "additionalProperties": false
+    },
+    "filter": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "format": {
+          "type": "string"
+        },
+        "pattern": {
+          "type": "string"
+        },
+        "minimum": {
+          "type": [
+            "number",
+            "string"
+          ]
+        },
+        "minLength": {
+          "type": "integer"
+        },
+        "maxLength": {
+          "type": "integer"
+        },
+        "exclusiveMinimum": {
+          "type": [
+            "number",
+            "string"
+          ]
+        },
+        "exclusiveMaximum": {
+          "type": [
+            "number",
+            "string"
+          ]
+        },
+        "maximum": {
+          "type": [
+            "number",
+            "string"
+          ]
+        },
+        "const": {
+          "type": [
+            "number",
+            "string"
+          ]
+        },
+        "enum": {
+          "type": "array",
+          "items": {
+            "type": [
+              "number",
+              "string"
+            ]
+          }
+        },
+        "not": {
+          "type": "object",
+          "minProperties": 1
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "additionalProperties": false
+    },
+    "format": {
+      "type": "object",
+      "patternProperties": {
+        "^jwt$|^jwt_vc$|^jwt_vp$": {
+          "type": "object",
+          "properties": {
+            "alg": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "required": [
+            "alg"
+          ],
+          "additionalProperties": false
+        },
+        "^ldp_vc$|^ldp_vp$|^ldp$": {
+          "type": "object",
+          "properties": {
+            "proof_type": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "required": [
+            "proof_type"
+          ],
+          "additionalProperties": false
+        },
+        "additionalProperties": false
+      },
+      "additionalProperties": false
+    },
+    "submission_requirements": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "purpose": {
+          "type": "string"
+        },
+        "rule": {
+          "type": "string",
+          "enum": [
+            "all",
+            "pick"
+          ]
+        },
+        "count": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "min": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "max": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "from": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "rule",
+        "from"
+      ],
+      "additionalProperties": false
+    },
+    "input_descriptors": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "purpose": {
+          "type": "string"
+        },
+        "group": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "schema": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/schema"
+          }
+        },
+        "constraints": {
+          "type": "object",
+          "properties": {
+            "limit_disclosure": {
+              "type": "string",
+              "enum": [
+                "required",
+                "preferred"
+              ]
+            },
+            "statuses": {
+              "type": "object",
+              "properties": {
+                "active": {
+                  "type": "object",
+                  "properties": {
+                    "directive": {
+                      "type": "string",
+                      "enum": [
+                        "required",
+                        "allowed",
+                        "disallowed"
+                      ]
+                    }
+                  }
+                },
+                "suspended": {
+                  "type": "object",
+                  "properties": {
+                    "directive": {
+                      "type": "string",
+                      "enum": [
+                        "required",
+                        "allowed",
+                        "disallowed"
+                      ]
+                    }
+                  }
+                },
+                "revoked": {
+                  "type": "object",
+                  "properties": {
+                    "directive": {
+                      "type": "string",
+                      "enum": [
+                        "required",
+                        "allowed",
+                        "disallowed"
+                      ]
+                    }
+                  }
+                }
+              }
+            },
+            "fields": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/field"
+              }
+            },
+            "subject_is_issuer": {
+              "type": "string",
+              "enum": [
+                "required",
+                "preferred"
+              ]
+            },
+            "is_holder": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field_id": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "directive": {
+                    "type": "string",
+                    "enum": [
+                      "required",
+                      "preferred"
+                    ]
+                  }
+                },
+                "required": [
+                  "field_id",
+                  "directive"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "same_subject": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field_id": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "directive": {
+                    "type": "string",
+                    "enum": [
+                      "required",
+                      "preferred"
+                    ]
+                  }
+                },
+                "required": [
+                  "field_id",
+                  "directive"
+                ],
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "schema"
+      ],
+
+      "additionalProperties": false
+    },
+    "field": {
+      "type": "object",
+      "oneOf": [
+        {
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "path": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "purpose": {
+              "type": "string"
+            },
+            "filter": {
+              "$ref": "#/definitions/filter"
+            }
+          },
+          "required": [
+            "path"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "path": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "purpose": {
+              "type": "string"
+            },
+            "filter": {
+              "$ref": "#/definitions/filter"
+            },
+            "predicate": {
+              "type": "string",
+              "enum": [
+                "required",
+                "preferred"
+              ]
+            }
+          },
+          "required": [
+            "path",
+            "filter",
+            "predicate"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "purpose": {
+      "type": "string"
+    },
+    "submission_requirements": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/submission_requirements"
+      }
+    },
+    "input_descriptors": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/input_descriptors"
+      },
+      "minItems": 1
+    }
+  },
+  "required": ["input_descriptors"],
+  "additionalProperties": false
+}

package/src/controllers/operator/tenants/_tenantId/disclosures/schemas/agent-disclosure.schema.js

@@ -0,0 +1,24 @@
+const { mutableEntitySchema } = require('@verii/common-schemas');
+const newAgentDisclosureSchema = require('./new-agent-disclosure.schema.json');
+
+const agentDisclosureSchema = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  $id: 'https://velocitycareerlabs.io/agent-disclosure-v0.8.schema.json',
+  title: 'agent-disclosure',
+  description:
+    // eslint-disable-next-line max-len
+    'The disclosure request made by an inspector on the velocity network. It describes credential types wanted and (in the future) predicate information as well as terms and conditions for usage of the data',
+  properties: {
+    ...mutableEntitySchema.properties,
+    ...newAgentDisclosureSchema.properties,
+    tenantId: {
+      type: 'string',
+    },
+  },
+  additionalProperties: false,
+  required: ['id', 'vendorEndpoint', 'createdAt', 'updatedAt'],
+};
+
+module.exports = {
+  agentDisclosureSchema,
+};

package/src/controllers/operator/tenants/_tenantId/disclosures/schemas/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 agentDisclosurePresentationDefinitionSchema = require('./agent-disclosure-presentation-definition.schema.json');
+const { agentDisclosureSchema } = require('./agent-disclosure.schema');
+const newAgentDisclosureSchema = require('./new-agent-disclosure.schema.json');
+const {
+  updateAgentDisclosureSchema,
+} = require('./update-agent-disclosure.schema');
+
+module.exports = {
+  agentDisclosurePresentationDefinitionSchema,
+  agentDisclosureSchema,
+  newAgentDisclosureSchema,
+  updateAgentDisclosureSchema,
+};

package/src/controllers/operator/tenants/_tenantId/disclosures/schemas/new-agent-disclosure.schema.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://velocitycareerlabs.io/new-agent-disclosure.schema.json",
+  "title": "new-agent-disclosure",
+  "type": "object",
+  "description": "The disclosure request made by an inspector on the velocity network. It describes credential types wanted and (in the future) predicate information as well as terms and conditions for usage of the data",
+  "properties": {
+    "types": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "The credential type to be disclosed"
+          }
+        }
+      },
+      "description": "To be expanded. Predicates will be added and associated with each credential type. Enables expression of expressions that limit the kinds of credential requested"
+    },
+    "presentationDefinition": {
+      "$ref": "https://velocitycareerlabs.io/agent-disclosure-presentation-definition.schema.json#"
+    },
+    "identificationMethods": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "enum": [
+          "verifiable_presentation",
+          "preauth"
+        ]
+      },
+      "default": [
+        "verifiable_presentation"
+      ],
+      "description": "To be expanded. Predicates will be added and associated with each credential type. Enables expression of expressions that limit the kinds of credential requested"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description field for this disclosure"
+    },
+    "vendorOrganizationId": {
+      "deprecated": true,
+      "type": "string",
+      "description": "the vendor's internal id for the organization doing the inspection"
+    },
+    "vendorDisclosureId": {
+      "type": "string",
+      "description": "the vendor's internal id for the requistion or position"
+    },
+    "vendorEndpoint": {
+      "type": "string",
+      "default": "receive-checked-credentials",
+      "enum": [
+        "receive-checked-credentials",
+        "receive-unchecked-credentials",
+        "receive-applicant",
+        "issuing-identification",
+        "integrated-issuing-identification"
+      ]
+    },
+    "identityMatchers": {
+      "type": "object",
+      "properties": {
+        "rules": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 1,
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "json path(s) to resolve in order"
+              },
+              "rule": {
+                "type": "string",
+                "description": "the rule to run. ONly pick is supported right ow",
+                "enum": [
+                  "pick",
+                  "equal"
+                ]
+              },
+              "valueIndex": {
+                "type": "integer",
+                "description": "the index to use with in a data row in values. Value must return true when compared using ==="
+              }
+            },
+            "required": [
+              "path",
+              "rule",
+              "valueIndex"
+            ]
+          }
+        },
+        "vendorUserIdIndex": {
+          "type": "integer",
+          "description": "the index to use for the 'userId' value for a matched user. Must be convertable to a string"
+        }
+      },
+      "required": [
+        "vendorUserIdIndex",
+        "rules"
+      ]
+    },
+    "purpose": {
+      "type": "string",
+      "description": "purpose is a summary of the description"
+    },
+    "duration": {
+      "type": "string",
+      "description": "duration can be a number of days (5d), weeks (12w), months (6m) or years (7y)"
+    },
+    "termsUrl": {
+      "type": "string"
+    },
+    "deactivationDate": {
+      "type": "string",
+      "format": "date-time",
+      "description": "can be configured to deactivate at a predetermined time or to be deactivated on demand by setting this to now"
+    },
+    "sendPushOnVerification": {
+      "type": "boolean",
+      "description": "whether a push notification should be sent when verification occurs",
+      "default": false
+    },
+    "authTokensExpireIn": {
+      "type": "integer",
+      "default": "10080"
+    },
+    "offerMode": {
+      "type": "string",
+      "enum": [
+        "preloaded",
+        "webhook"
+      ]
+    },
+    "configurationType": {
+      "type": "string",
+      "enum": [
+        "issuing",
+        "inspection"
+      ]
+    },
+    "commercialEntityName": {
+      "type": "string"
+    },
+    "commercialEntityLogo": {
+      "type": "string"
+    },
+    "feed": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "termsUrl",
+    "vendorEndpoint"
+  ]
+}

package/src/controllers/operator/tenants/_tenantId/disclosures/schemas/update-agent-disclosure.schema.js

@@ -0,0 +1,20 @@
+const { omit } = require('lodash/fp');
+const newAgentDisclosureSchema = require('./new-agent-disclosure.schema.json');
+
+const updateAgentDisclosureSchema = {
+  ...newAgentDisclosureSchema,
+  $id: 'https://velocitycareerlabs.io/update-agent-disclosure.schema.json',
+  title: 'update-agent-disclosure',
+  description: 'Slightly modified from new-agent-disclosure',
+  properties: {
+    ...omit(['feed'], newAgentDisclosureSchema.properties),
+    setIssuingDefault: {
+      type: 'boolean',
+    },
+  },
+  additionalProperties: false,
+};
+
+module.exports = {
+  updateAgentDisclosureSchema,
+};

package/src/controllers/operator/tenants/_tenantId/exchanges/_exchangeId/autohooks.js

@@ -0,0 +1,30 @@
+/**
+ * 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 { exchangeLoaderPlugin } = require('../../../../../../plugins');
+
+module.exports = async (fastify) => {
+  fastify.register(exchangeLoaderPlugin).autoSchemaPreset({
+    params: {
+      type: 'object',
+      properties: {
+        ...fastify.currentAutoSchemaPreset.params.properties,
+        exchangeId: { type: 'string', minLength: 1 },
+      },
+    },
+    tags: ['offer-exchanges'],
+  });
+};