@verii/endpoints-organizations-registrar 1.0.0-pre.1752076816

package/src/controllers/organizations/schemas/organization-kyb-profile-creation.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-kyb-profile-creation",
+  "type": "object",
+  "title": "An organization in persistent storage",
+  "description": "Profile info for an organization",
+  "allOf": [
+    {
+      "$ref": "organization-profile-base#"
+    }
+  ],
+  "required": [
+    "website",
+    "adminGivenName",
+    "adminFamilyName",
+    "adminTitle",
+    "adminEmail",
+    "signatoryGivenName",
+    "signatoryFamilyName",
+    "signatoryTitle",
+    "signatoryEmail",
+    "physicalAddress",
+    "linkedInProfile",
+    "registrationNumbers"
+  ]
+}

package/src/controllers/organizations/schemas/organization-profile-creation.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-profile-creation",
+  "title": "Editable Organization Profile Information",
+  "type": "object",
+  "description": "Profile info for an org that can be set in a \"form\"",
+  "allOf": [{
+    "$ref": "organization-profile-base#"
+  }],
+  "required": [
+    "type",
+    "name",
+    "website",
+    "description",
+    "location",
+    "logo",
+    "contactEmail",
+    "technicalEmail"
+  ]
+}

package/src/controllers/organizations/schemas/organization-profile-update.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-profile-update",
+  "title": "Editable Organization Profile Information",
+  "type": "object",
+  "description": "Profile info for an org that can be set in a \"form\"",
+  "allOf": [{
+    "$ref": "organization-profile-base#"
+  }],
+  "required": [
+    "type",
+    "name",
+    "description",
+    "location",
+    "logo",
+    "contactEmail",
+    "technicalEmail"
+  ]
+}

package/src/controllers/organizations/schemas/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/controllers/organizations/schemas/organization-registry-service-response.schema.json

@@ -0,0 +1,26 @@
+{
+  "title": "organization-registry-service-response",
+  "$id": "https://velocitycareerlabs.io/organization-registry-service-response.schema.json",
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "credentialTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    {
+      "$ref": "did-service#"
+    }
+  ],
+  "required": [
+    "id",
+    "type",
+    "serviceEndpoint"
+  ]
+}

package/src/controllers/organizations/schemas/organization-service.schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "organization-service",
+  "title": "organization-service",
+  "type": "object",
+  "additionalProperties": true,
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "credentialTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "supportedExchangeProtocols": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "VN_API",
+              "OPENID4VC"
+            ]
+          },
+          "minItems": 1
+        }
+      }
+    },
+    {
+      "$ref": "did-service#"
+    }
+  ]
+}

package/src/controllers/organizations/schemas/organization-verified-profile.schema.json

@@ -0,0 +1,123 @@
+{
+  "$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"
+            },
+            "alsoKnownAs": {
+              "title": "Also Known As",
+              "description": "https://www.w3.org/TR/did-core/#also-known-as",
+              "type": "array",
+              "items": {
+                "type": "string",
+                "format": "uri"
+              }
+            }
+          }
+        },
+        "credentialSubject": {
+          "$ref": "organization-profile#"
+        },
+        "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"
+        },
+        "issuanceDate": {
+          "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",
+        "issuanceDate",
+        "credentialChecks"
+      ]
+    }
+  ]
+}

package/src/controllers/organizations/schemas/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
+}

package/src/controllers/organizations/schemas/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/controllers/reference/controller.js

@@ -0,0 +1,103 @@
+/*
+ * Copyright 2025 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 createError = require('http-errors');
+const {
+  getCountries,
+  isLanguageCodeValid,
+  isLanguageSupported,
+} = require('@verii/country-data');
+const {
+  CachingConstants,
+} = require('@verii/endpoints-credential-types-registrar');
+
+const DEFAULT_LANGUAGE_CODE_FALLBACK = 'en';
+
+const countriesController = async (fastify) => {
+  fastify.get(
+    '/countries',
+    {
+      schema: fastify.autoSchema({
+        querystring: {
+          type: 'object',
+          properties: {
+            lge: { type: 'string', description: 'Language' },
+          },
+        },
+        response: {
+          200: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                name: {
+                  type: 'string',
+                  description:
+                    'The name of the country in the language of the "lge" query parameter',
+                },
+                code: {
+                  type: 'string',
+                  description: 'The ISO 3166-1 country code',
+                },
+                regions: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    properties: {
+                      name: {
+                        type: 'string',
+                        description:
+                          'The name of the subdivision in the language of the "lge" query parameter',
+                      },
+                      code: {
+                        type: 'string',
+                        description: 'The ISO 3166-2 subdivision code',
+                      },
+                    },
+                    required: ['name', 'code'],
+                  },
+                },
+              },
+              required: ['name', 'code', 'regions'],
+            },
+          },
+        },
+      }),
+    },
+    async ({ query: { lge } }, reply) => {
+      if (lge != null && !isLanguageCodeValid(lge)) {
+        throw createError(400, '"lge" query parameter is malformed');
+      }
+      const selectedLge =
+        lge != null && isLanguageSupported(lge)
+          ? lge
+          : DEFAULT_LANGUAGE_CODE_FALLBACK;
+      const countries = await getCountries(selectedLge);
+      return reply
+        .header(
+          CachingConstants.CACHE_CONTROL_HEADER,
+          CachingConstants.MAX_AGE_CACHE_CONTROL
+        )
+        .send(countries);
+    }
+  );
+};
+
+// eslint-disable-next-line better-mutation/no-mutation
+countriesController.prefixOverride = '/reference';
+
+module.exports = countriesController;

package/src/controllers/resolve-did/controller.js

@@ -0,0 +1,45 @@
+const {
+  didServiceSchema,
+  modifyDidServiceSchema,
+} = require('@verii/common-schemas');
+const { resolveDid } = require('./resolve-did');
+const { didDocSchema, didProofSchema, publicKeySchema } = require('./schemas');
+
+const resolveDidController = async (fastify) => {
+  fastify
+    .addSchema(modifyDidServiceSchema)
+    .addSchema(didServiceSchema)
+    .addSchema(publicKeySchema)
+    .addSchema(didProofSchema)
+    .addSchema(didDocSchema);
+
+  fastify.get(
+    '/:did',
+    {
+      schema: fastify.autoSchema({
+        tags: ['registrar_organizations'],
+        params: {
+          type: 'object',
+          properties: {
+            did: {
+              type: 'string',
+              description: 'the did document',
+              pattern: '^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$',
+            },
+          },
+        },
+        response: {
+          200: { $ref: 'did-doc#' },
+        },
+      }),
+    },
+    async (req) => {
+      const {
+        params: { did },
+      } = req;
+      return resolveDid(did, req);
+    }
+  );
+};
+
+module.exports = resolveDidController;

package/src/controllers/resolve-did/resolve-did.js

@@ -0,0 +1,30 @@
+const newError = require('http-errors');
+const { resolveDidWeb, isWebDid } = require('@verii/did-web');
+const { buildDidDocWithAlternativeId } = require('@verii/did-doc');
+const { isEmpty } = require('lodash/fp');
+
+const resolveDid = async (did, context) => {
+  if (isWebDid(did)) {
+    return resolveDidWeb(did).catch((error) => {
+      if (error.errorCode === 'did_resolution_failed') {
+        throw newError(404, error.message, { errorCode: error.errorCode });
+      }
+      throw error;
+    });
+  }
+  return resolveLocalDid(did, context);
+};
+
+const resolveLocalDid = async (did, { repos }) => {
+  const organization = await repos.organizations.findOneByDid(did);
+  const didDoc = organization?.didDoc;
+
+  if (isEmpty(didDoc)) {
+    throw newError(404, `Could not resolve ${did}`, {
+      errorCode: 'did_resolution_failed',
+    });
+  }
+  return buildDidDocWithAlternativeId(did, didDoc);
+};
+
+module.exports = { resolveDid };