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

package/src/entities/images/extension/deactivate.extension.js

@@ -0,0 +1,27 @@
+const { isEmpty } = require('lodash/fp');
+const { ImageState } = require('../domain');
+
+const deactivateExtension = (parent) => ({
+  deactivate: async (url) => {
+    const image = await parent.findOne({
+      filter: {
+        url,
+      },
+    });
+    if (isEmpty(image)) {
+      return;
+    }
+    await parent.collection().updateOne(
+      { url },
+      {
+        $set: {
+          updatedAt: new Date(),
+          state: ImageState.INACTIVE,
+        },
+      }
+    );
+  },
+  extensions: parent.extensions.concat(['deactivate']),
+});
+
+module.exports = { deactivateExtension };

package/src/entities/images/extension/find-by-url.extension.js

@@ -0,0 +1,24 @@
+const newError = require('http-errors');
+const { isEmpty } = require('lodash/fp');
+
+const findByUrlExtension = (parent) => ({
+  findByUrl: async (url, userId) => {
+    const imageData = await parent.findOne({
+      filter: {
+        url,
+        userId,
+      },
+    });
+
+    if (isEmpty(imageData)) {
+      throw newError(404, 'Image not found', {
+        errorCode: 'image_not_found',
+      });
+    }
+
+    return imageData;
+  },
+  extensions: parent.extensions.concat(['findByUrl']),
+});
+
+module.exports = { findByUrlExtension };

package/src/entities/images/extension/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  ...require('./find-by-url.extension'),
+  ...require('./activate.extension'),
+  ...require('./deactivate.extension'),
+};

package/src/entities/images/factories/images-factory.js

@@ -0,0 +1,43 @@
+/*
+ * 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 { register } = require('@spencejs/spence-factories');
+
+const { testRegistrarUser } = require('@verii/tests-helpers');
+const imagesRepoPlugin = require('../repo');
+const { ImageState } = require('../domain');
+
+module.exports = (app) =>
+  register(
+    'image',
+    imagesRepoPlugin(app)({ config: app.config }),
+    async (overrides, { getOrBuild }) => {
+      const userId = await getOrBuild('userId', () => testRegistrarUser.sub);
+
+      return {
+        userId,
+        key: 'file-1234567.png',
+        url: 'http://media.localhost.test/file-1234567.png',
+        uploadUrl: 'http://aws.s3.test/file-1234567.png',
+        uploadSucceeded: false,
+        state: ImageState.PENDING_UPLOAD,
+        createdAt: new Date(),
+        updatedAt: new Date(),
+        ...overrides(),
+      };
+    }
+  );

package/src/entities/images/factories/index.js

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ *
+ */
+module.exports = { ...require('./images-factory') };

package/src/entities/images/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  imageRepoPlugin: require('./repo'),
+  ...require('./domain'),
+  ...require('./schema'),
+};

package/src/entities/images/repo.js

@@ -0,0 +1,43 @@
+const {
+  repoFactory,
+  autoboxIdsExtension,
+} = require('@spencejs/spence-mongo-repos');
+const {
+  findByUrlExtension,
+  activateExtension,
+  deactivateExtension,
+} = require('./extension');
+
+module.exports = (app, options, next = () => {}) => {
+  next();
+  return repoFactory(
+    {
+      name: 'images',
+      entityName: 'images',
+      defaultProjection: {
+        _id: 1,
+        key: 1,
+        url: 1,
+        uploadUrl: 1,
+        userId: 1,
+        state: 1,
+        uploadSucceeded: 1,
+        activateAt: 1,
+        createdAt: 1,
+        updatedAt: 1,
+        errorCode: 1,
+      },
+      timestampKeys: {
+        createdAt: 'createdAt',
+        updatedAt: 'updatedAt',
+      },
+      extensions: [
+        autoboxIdsExtension,
+        findByUrlExtension,
+        activateExtension,
+        deactivateExtension,
+      ],
+    },
+    app
+  );
+};

package/src/entities/images/schema/image-metadata.schema.js

@@ -0,0 +1,58 @@
+const { values } = require('lodash/fp');
+const { ImageState } = require('../domain');
+
+const imageMetadataSchema = {
+  title: 'image-metadata',
+  $id: 'https://velocitycareerlabs.io/image-metadata.schema.json',
+  type: 'object',
+  description: 'Image metadata schema',
+  properties: {
+    imageMetadata: {
+      type: 'object',
+      properties: {
+        url: {
+          type: 'string',
+        },
+        userId: {
+          type: 'string',
+        },
+        uploadUrl: {
+          type: 'string',
+        },
+        state: {
+          type: 'string',
+          enum: values(ImageState),
+        },
+        uploadSucceeded: {
+          type: 'boolean',
+        },
+        errorCode: {
+          type: 'string',
+        },
+        createdAt: {
+          type: 'string',
+          format: 'date-time',
+        },
+        updatedAt: {
+          type: 'string',
+          format: 'date-time',
+        },
+        activateAt: {
+          type: 'string',
+          format: 'date-time',
+        },
+      },
+      required: [
+        'url',
+        'userId',
+        'state',
+        'uploadSucceeded',
+        'createdAt',
+        'updatedAt',
+      ],
+    },
+  },
+  required: ['imageMetadata'],
+};
+
+module.exports = { imageMetadataSchema };

package/src/entities/images/schema/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('./image-metadata.schema'),
+};

package/src/entities/index.js

@@ -0,0 +1,31 @@
+/*
+ * 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.
+ *
+ */
+
+module.exports = {
+  ...require('./groups'),
+  ...require('./invitations'),
+  ...require('./images'),
+  ...require('./oauth'),
+  ...require('./organization-services'),
+  ...require('./organizations'),
+  ...require('./organization-keys'),
+  ...require('./registrar-consents'),
+  ...require('./monitors'),
+  // TODO probably remove the below once broker is refactored vl-5139
+  ...require('./signatories'),
+  ...require('./users'),
+};

package/src/entities/invitations/domains/build-invitation-url.js

@@ -0,0 +1,14 @@
+const { sprintf } = require('sprintf-js');
+const { isEmpty } = require('lodash/fp');
+
+const buildInvitationUrl = ({ code, ticket }, { config }) => {
+  const url = new URL(sprintf(config.inviteUrl, [code]));
+  if (!isEmpty(ticket)) {
+    url.searchParams.append('signup_url', encodeURI(ticket));
+  }
+  return url.toString();
+};
+
+module.exports = {
+  buildInvitationUrl,
+};

package/src/entities/invitations/domains/get-given-family-name-from-name.js

@@ -0,0 +1,20 @@
+const { split, isEmpty } = require('lodash/fp');
+
+const getGivenFamilyNameFromName = (inviteeProfileName) => {
+  const [givenName, familyName] = split(' ', inviteeProfileName);
+
+  if (isEmpty(familyName)) {
+    return {
+      givenName,
+    };
+  }
+
+  return {
+    givenName,
+    familyName,
+  };
+};
+
+module.exports = {
+  getGivenFamilyNameFromName,
+};

package/src/entities/invitations/domains/index.js

@@ -0,0 +1,7 @@
+module.exports = {
+  ...require('./build-invitation-url'),
+  ...require('./get-given-family-name-from-name'),
+  ...require('./init-invitation-emails'),
+  ...require('./is-invitation-expired'),
+  ...require('./validate-invitee-email'),
+};

package/src/entities/invitations/domains/init-invitation-emails.js

@@ -0,0 +1,17 @@
+const inviteeInvitationEmail = async (
+  { inviterOrganization, inviteeEmail, uri },
+  context
+) => ({
+  subject: await context.renderTemplate('invitee-invitation-email-subject', {
+    inviterOrganization,
+  }),
+  message: await context.renderTemplate('invitee-invitation-email-body', {
+    inviterOrganization,
+    uri,
+  }),
+  sender: context.config.registrarSupportEmail,
+  recipients: [inviteeEmail],
+  html: true,
+});
+
+module.exports = { inviteeInvitationEmail };

package/src/entities/invitations/domains/is-invitation-expired.js

@@ -0,0 +1,5 @@
+const isInvitationExpired = (invitation) => invitation.expiresAt < new Date();
+
+module.exports = {
+  isInvitationExpired,
+};

package/src/entities/invitations/domains/validate-invitee-email.js

@@ -0,0 +1,18 @@
+const newError = require('http-errors');
+
+const validateInviteeEmail = (email) => {
+  const re = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
+  if (!re.test(email)) {
+    throw newError(
+      400,
+      'The email address is invalid and the invitation was not sent',
+      {
+        errorCode: 'bad_invitee_email',
+      }
+    );
+  }
+};
+
+module.exports = {
+  validateInviteeEmail,
+};

package/src/entities/invitations/factories/index.js

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ *
+ */
+module.exports = { ...require('./invitations-factory') };

package/src/entities/invitations/factories/invitations-factory.js

@@ -0,0 +1,51 @@
+/*
+ * 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 { omit } = require('lodash/fp');
+const { register } = require('@spencejs/spence-factories');
+const { addWeeks } = require('date-fns/fp');
+const invitationsRepoPlugin = require('../repo');
+
+module.exports = (app) =>
+  register(
+    'invitation',
+    invitationsRepoPlugin(app)({ config: app.config }),
+    async (overrides) => {
+      const overridesResult = overrides();
+      const inviteeService =
+        overridesResult.inviteeOrganization?.didDoc.service;
+      const inviteeProfile = overridesResult.inviteeOrganization?.profile;
+      const inviterDid = overridesResult.inviterOrganization?.didDoc.id;
+
+      return {
+        inviteeEmail: 'foo@example.com',
+        invitationUrl: 'https://someurl.com',
+        inviteeService,
+        inviteeProfile,
+        inviterDid,
+        code: '1234567812345678',
+        expiresAt: addWeeks(1, new Date()),
+        createdAt: new Date(),
+        updatedAt: new Date(),
+        createdBy: 'sub-123',
+        ...omit(
+          ['inviterOrganization', 'inviteeOrganization'],
+          overridesResult
+        ),
+      };
+    }
+  );

package/src/entities/invitations/index.js

@@ -0,0 +1,6 @@
+module.exports = {
+  invitationsRepoPlugin: require('./repo'),
+  ...require('./domains'),
+  ...require('./orchestrators'),
+  ...require('./schemas'),
+};

package/src/entities/invitations/orchestrators/accept-invitation.js

@@ -0,0 +1,24 @@
+const { isInvitationExpired } = require('../domains');
+
+const acceptInvitation = async (invitationCode, ctx) => {
+  const { repos, log, user } = ctx;
+  if (!invitationCode) {
+    return undefined;
+  }
+  const invitation = await repos.invitations.findOne({
+    filter: { code: invitationCode },
+  });
+  if (!invitation) {
+    log.warn({ invitationCode }, 'unable to accept invalid invitation');
+    return undefined;
+  }
+  if (isInvitationExpired(invitation)) {
+    log.warn({ invitationCode }, 'unable to accept expired invitation');
+    return undefined;
+  }
+  return repos.invitations.update(invitation._id, {
+    acceptedAt: new Date(),
+    acceptedBy: user.sub,
+  });
+};
+module.exports = { acceptInvitation };

package/src/entities/invitations/orchestrators/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ...require('./accept-invitation'),
+  ...require('./send-email-invitee'),
+};

package/src/entities/invitations/orchestrators/send-email-invitee.js

@@ -0,0 +1,36 @@
+const { buildInvitationUrl, inviteeInvitationEmail } = require('../domains');
+
+const initSendEmailInvitee = (fastify) => {
+  const { sendEmail, sendError } = fastify;
+
+  return async (
+    { ticket, inviteeEmail, inviterOrganization, code },
+    context
+  ) => {
+    try {
+      const uri = buildInvitationUrl({ code, ticket }, context);
+
+      await sendEmail(
+        await inviteeInvitationEmail(
+          {
+            inviteeEmail,
+            inviterOrganization,
+            uri,
+          },
+          context
+        )
+      );
+      return 'invitation_sent';
+    } catch (error) {
+      const message = 'Unable to send invitation email to user';
+      const messageContext = { err: error, email: inviteeEmail };
+      context.log.error(messageContext, message);
+      sendError(error, { ...messageContext, message });
+      return 'invitation_not_sent';
+    }
+  };
+};
+
+module.exports = {
+  initSendEmailInvitee,
+};

package/src/entities/invitations/repo.js

@@ -0,0 +1,37 @@
+const {
+  repoFactory,
+  autoboxIdsExtension,
+} = require('@spencejs/spence-mongo-repos');
+const { deletedExtension } = require('@verii/spencer-mongo-extensions');
+
+module.exports = (app, options, next = () => {}) => {
+  next();
+  return repoFactory(
+    {
+      name: 'invitations',
+      entityName: 'invitations',
+      defaultProjection: {
+        _id: 1,
+        acceptedAt: 1,
+        acceptedBy: 1,
+        invitationUrl: 1,
+        inviterDid: 1,
+        inviteeEmail: 1,
+        inviteeService: 1,
+        inviteeProfile: 1,
+        keyIndividuals: 1,
+        inviteeDid: 1,
+        code: 1,
+        expiresAt: 1,
+        createdAt: 1,
+        createdBy: 1,
+        updatedAt: 1,
+        updatedBy: 1,
+        deletedAt: 1,
+        deletedBy: 1,
+      },
+      extensions: [autoboxIdsExtension, deletedExtension()],
+    },
+    app
+  );
+};

package/src/entities/invitations/schemas/add-invitation-body.js

@@ -0,0 +1,122 @@
+const { omit, values, pick } = require('lodash/fp');
+const { organizationProfileBaseSchema } = require('@verii/common-schemas');
+const {
+  ServiceCategories,
+  ServiceTypesOfServiceCategory,
+} = require('@verii/organizations-registry');
+
+const keyIndividualProperties = [
+  'adminGivenName',
+  'adminFamilyName',
+  'adminTitle',
+  'adminEmail',
+  'signatoryGivenName',
+  'signatoryFamilyName',
+  'signatoryTitle',
+  'signatoryEmail',
+];
+
+const addInvitationBodySchema = {
+  title: 'add-invitation-body',
+  $id: 'https://velocitycareerlabs.io/add-invitation-body.json',
+  type: 'object',
+  description:
+    'payload for adding a invitations to an organization in the registrar',
+  properties: {
+    inviteeEmail: {
+      type: 'string',
+    },
+    inviteeService: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: {
+            type: 'string',
+          },
+          type: {
+            type: 'string',
+            enum: [
+              ...values(
+                ServiceTypesOfServiceCategory[
+                  ServiceCategories.IdDocumentIssuer
+                ]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[
+                  ServiceCategories.NotaryIdDocumentIssuer
+                ]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[ServiceCategories.ContactIssuer]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[
+                  ServiceCategories.NotaryContactIssuer
+                ]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[ServiceCategories.Inspector]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[ServiceCategories.Issuer]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[ServiceCategories.NotaryIssuer]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[ServiceCategories.IdentityIssuer]
+              ),
+              ...values(
+                ServiceTypesOfServiceCategory[
+                  ServiceCategories.HolderAppProvider
+                ]
+              ),
+            ],
+            minLength: 1,
+          },
+          serviceEndpoint: {
+            type: 'string',
+          },
+          credentialTypes: {
+            type: 'array',
+            items: {
+              type: 'string',
+            },
+          },
+        },
+        required: ['id', 'type', 'serviceEndpoint'],
+      },
+    },
+    inviteeProfile: {
+      type: 'object',
+      properties: {
+        ...omit(
+          keyIndividualProperties,
+          organizationProfileBaseSchema.properties
+        ),
+        type: omit(['default'], organizationProfileBaseSchema.properties.type),
+      },
+      required: ['name'],
+    },
+    inviteeDid: {
+      type: 'string',
+    },
+    keyIndividuals: {
+      type: 'object',
+      properties: pick(
+        keyIndividualProperties,
+        organizationProfileBaseSchema.properties
+      ),
+      required: ['adminGivenName', 'adminFamilyName', 'adminEmail'],
+    },
+  },
+  required: [
+    'inviteeEmail',
+    'inviteeService',
+    'inviteeProfile',
+    'keyIndividuals',
+  ],
+};
+
+module.exports = { addInvitationBodySchema };