feat: expose organization domains in public APIs (CM-1266) (#4315)

Signed-off-by: Yeganathan S <63534555+skwowet@users.noreply.github.com>

Author: skwowet

backend/src/api/public/openapi.yaml

@@ -779,8 +779,11 @@ paths:
   /organizations:
     get:
       operationId: getOrganization
-      summary: Look up an organization by domain
-      description: Find a verified organization by its primary domain.
+      summary: Look up an organization by domain or name
+      description: >
+        Provide domain, name, or both. When both are provided, the domain and
+        name must belong to the same organization. If multiple organizations
+        match, the most active one is returned.
       tags:
         - Organizations
       security:
@@ -789,12 +792,20 @@ paths:
       parameters:
         - name: domain
           in: query
-          required: true
+          required: false
           description: Primary domain of the organization.
           schema:
             type: string
             minLength: 1
           example: linuxfoundation.org
+        - name: name
+          in: query
+          required: false
+          description: Exact display name of the organization.
+          schema:
+            type: string
+            minLength: 1
+          example: Linux Foundation
       responses:
         '200':
           description: Organization found.
@@ -805,13 +816,14 @@ paths:
               example:
                 id: 550e8400-e29b-41d4-a716-446655440000
                 name: Linux Foundation
+                domain: linuxfoundation.org
                 logo: https://example.com/logo.png
         '401':
           $ref: '#/components/responses/Unauthorized'
         '403':
           $ref: '#/components/responses/Forbidden'
         '404':
-          description: No verified organization found for the given domain.
+          description: No organization found for the given domain or name.
           content:
             application/json:
               schema:
@@ -876,15 +888,26 @@ paths:
                 required:
                   - id
                   - name
+                  - domain
                 properties:
                   id:
                     type: string
                     format: uuid
                   name:
                     type: string
+                  domain:
+                    type: string
+                    description: Verified primary domain of the organization.
+                  logo:
+                    type:
+                      - string
+                      - 'null'
+                    description: URL of the organization logo.
               example:
                 id: 550e8400-e29b-41d4-a716-446655440000
                 name: Acme Corp
+                domain: acme.com
+                logo: https://example.com/logo.png
         '400':
           $ref: '#/components/responses/BadRequest'
         '401':
@@ -1218,6 +1241,7 @@ components:
         - id
         - organizationId
         - organizationName
+        - organizationDomains
         - jobTitle
         - verified
         - verifiedBy
@@ -1243,6 +1267,11 @@ components:
             - string
             - 'null'
           description: URL of the organization logo.
+        organizationDomains:
+          type: array
+          items:
+            type: string
+          description: Verified primary domains for the organization, in alphabetical order.
         jobTitle:
           type:
             - string
@@ -1531,13 +1560,17 @@ components:
       required:
         - id
         - name
+        - domain
       properties:
         id:
           type: string
           format: uuid
         name:
           type: string
           description: Display name of the organization.
+        domain:
+          type: string
+          description: Verified primary domain.
         logo:
           type: string
           description: URL of the organization logo. Only present if available.

backend/src/api/public/v1/members/work-experiences/createMemberWorkExperience.ts

@@ -117,7 +117,7 @@ export async function createMemberWorkExperience(req: Request, res: Response): P
         memberOrganizationIds: [data.organizationId],
       })
 
-      const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId])
+      const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId], { withDomains: true })
       createdMo = (orgsMap.get(memberId) ?? []).find((mo) => mo.id === newMemberOrgId)
 
       captureNewState(createdMo ?? null)

backend/src/api/public/v1/members/work-experiences/getMemberWorkExperiences.ts

@@ -27,7 +27,7 @@ export async function getMemberWorkExperiences(req: Request, res: Response): Pro
     throw new NotFoundError('Member not found')
   }
 
-  const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId])
+  const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId], { withDomains: true })
   const workExperiences = groupMemberOrganizations(orgsMap.get(memberId) ?? []).map(
     toMemberWorkExperience,
   )

backend/src/api/public/v1/members/work-experiences/updateMemberWorkExperience.ts

@@ -120,7 +120,7 @@ export async function updateMemberWorkExperience(req: Request, res: Response): P
         memberOrganizationIds: [data.organizationId],
       })
 
-      const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId])
+      const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId], { withDomains: true })
 
       const updatedMo = groupMemberOrganizations(orgsMap.get(memberId) ?? []).find(
         (mo) => mo.id === workExperienceId,

backend/src/api/public/v1/members/work-experiences/verifyMemberWorkExperience.ts

@@ -52,6 +52,18 @@ export async function verifyMemberWorkExperience(req: Request, res: Response): P
     throw new NotFoundError('Work experience not found')
   }
 
+  const orgsMapBeforeChange = await fetchManyMemberOrgsWithOrgData(qx, [memberId], {
+    withDomains: true,
+  })
+
+  const workExperienceWithOrgData = groupMemberOrganizations(
+    orgsMapBeforeChange.get(memberId) ?? [],
+  ).find((mo) => mo.id === workExperienceId)
+
+  if (!workExperienceWithOrgData) {
+    throw new NotFoundError('Work experience not found')
+  }
+
   const overlappingGroupedRows = getOverlappingGroupedMemberOrganizations(memberOrgs, memberOrg)
 
   const memberOrgIdsToDelete = [
@@ -100,13 +112,16 @@ export async function verifyMemberWorkExperience(req: Request, res: Response): P
     }),
   )
 
-  const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId])
+  const orgsMap = await fetchManyMemberOrgsWithOrgData(qx, [memberId], { withDomains: true })
 
-  const responseMo: IMemberRoleWithOrganization =
-    groupMemberOrganizations(orgsMap.get(memberId) ?? []).find(
-      (mo) => mo.id === workExperienceId,
-    ) ??
-    ({ ...memberOrg, ...updatedMemberOrg, verified, verifiedBy } as IMemberRoleWithOrganization)
+  const responseMo: IMemberRoleWithOrganization = groupMemberOrganizations(
+    orgsMap.get(memberId) ?? [],
+  ).find((mo) => mo.id === workExperienceId) ?? {
+    ...workExperienceWithOrgData,
+    ...updatedMemberOrg,
+    verified,
+    verifiedBy,
+  }
 
   ok(res, toMemberWorkExperience(responseMo))
 }

backend/src/api/public/v1/organizations/createOrganization.ts

@@ -2,7 +2,7 @@ import type { Request, Response } from 'express'
 import { z } from 'zod'
 
 import { captureApiChange, organizationCreateAction } from '@crowd/audit-logs'
-import { InternalError } from '@crowd/common'
+import { BadRequestError, InternalError, normalizeHostname } from '@crowd/common'
 import { findOrCreateOrganization, optionsQx } from '@crowd/data-access-layer'
 import { OrganizationAttributeSource, OrganizationIdentityType } from '@crowd/types'
 
@@ -17,16 +17,20 @@ const bodySchema = z.object({
 })
 
 export async function createOrganization(req: Request, res: Response): Promise<void> {
-  const { name, domain, source, logo } = validateOrThrow(bodySchema, req.body)
+  const { name, domain: rawDomain, source, logo } = validateOrThrow(bodySchema, req.body)
 
-  const qx = optionsQx(req)
+  const domain = normalizeHostname(rawDomain, false)
+
+  if (!domain) {
+    throw new BadRequestError(`Invalid domain: ${rawDomain}`)
+  }
 
-  let organizationId: string | undefined
+  const qx = optionsQx(req)
 
-  await qx.tx(async (tx) => {
+  const organizationId = await qx.tx(async (tx) => {
     const orgSource = OrganizationAttributeSource.LFX_SERVE
 
-    organizationId = await findOrCreateOrganization(tx, orgSource, {
+    const organizationId = await findOrCreateOrganization(tx, orgSource, {
       displayName: name,
       logo,
       identities: [
@@ -59,7 +63,9 @@ export async function createOrganization(req: Request, res: Response): Promise<v
         })
       }),
     )
+
+    return organizationId
   })
 
-  created(res, { id: organizationId, name, logo })
+  created(res, { id: organizationId, name, logo, domain })
 }

backend/src/api/public/v1/organizations/getOrganization.ts

@@ -1,57 +1,41 @@
 import type { Request, Response } from 'express'
 import { z } from 'zod'
 
-import { NotFoundError, normalizeHostname } from '@crowd/common'
-import {
-  OrgIdentityField,
-  OrganizationField,
-  findOrgAttributes,
-  findOrgById,
-  optionsQx,
-  queryOrgIdentities,
-} from '@crowd/data-access-layer'
-import { OrganizationIdentityType } from '@crowd/types'
+import { BadRequestError, NotFoundError, normalizeHostname } from '@crowd/common'
+import { findOrganizationByNameOrDomain, optionsQx } from '@crowd/data-access-layer'
 
 import { ok } from '@/utils/api'
 import { validateOrThrow } from '@/utils/validation'
 
-const querySchema = z.object({
-  domain: z.string().trim().min(1),
-})
+const querySchema = z
+  .object({
+    name: z.string().trim().min(1).optional(),
+    domain: z.string().trim().min(1).optional(),
+  })
+  .refine((data) => data.name || data.domain, {
+    message: 'Either name or domain must be provided',
+  })
 
 export async function getOrganization(req: Request, res: Response): Promise<void> {
-  const { domain } = validateOrThrow(querySchema, req.query)
+  const { name, domain: rawDomain } = validateOrThrow(querySchema, req.query)
+
+  const domain = rawDomain ? normalizeHostname(rawDomain, false) : undefined
+
+  if (rawDomain && !domain) {
+    throw new BadRequestError(`Invalid domain: ${rawDomain}`)
+  }
 
   const qx = optionsQx(req)
 
-  const results = await queryOrgIdentities(qx, {
-    fields: [OrgIdentityField.ORGANIZATION_ID],
-    filter: {
-      and: [
-        { value: { eq: normalizeHostname(domain, false) } },
-        { type: { eq: OrganizationIdentityType.PRIMARY_DOMAIN } },
-        { verified: { eq: true } },
-      ],
-    },
+  const organization = await findOrganizationByNameOrDomain(qx, {
+    name,
+    domain,
   })
 
-  const organizationId = results[0]?.organizationId
-
-  if (!organizationId) {
+  if (!organization) {
     throw new NotFoundError('Organization not found')
   }
 
-  const org = await findOrgById(qx, organizationId, [
-    OrganizationField.ID,
-    OrganizationField.DISPLAY_NAME,
-  ])
-
-  const attributes = await findOrgAttributes(qx, organizationId)
-  const logo = attributes.find((a) => a.name === 'logo')?.value
-
-  ok(res, {
-    id: org.id,
-    name: org.displayName,
-    ...(logo ? { logo } : {}),
-  })
+  const { logo, ...rest } = organization
+  ok(res, { ...rest, ...(logo ? { logo } : {}) })
 }

backend/src/utils/mapper.ts

@@ -182,6 +182,7 @@ export function toMemberWorkExperience(mo: IMemberRoleWithOrganization) {
     organizationId: mo.organizationId,
     organizationName: mo.organizationName,
     organizationLogo: mo.organizationLogo,
+    organizationDomains: mo.organizationDomains ?? [],
     jobTitle: mo.title ?? null,
     verified: mo.verified ?? false,
     verifiedBy: mo.verifiedBy ?? null,

services/libs/common/src/domain.ts

@@ -14,7 +14,7 @@ interface ParseResult {
 }
 
 export const cleanURL = (url: string): string =>
-  url.replace(/^(?:https?:\/\/)?(?:www\.)?([^/]+)(?:\/.*)?$/, '$1')
+  url.replace(/^(?:https?:\/\/)?(?:www\.)?([^/]+)(?:\/.*)?$/i, '$1')
 
 export const isValidDomain = (parsed: ParseResult): boolean =>
   Boolean(parsed.domain && parsed.isIcann)