feat: expose organization domains in public APIs

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.
@@ -804,14 +815,15 @@ paths:
                 $ref: '#/components/schemas/Organization'
               example:
                 id: 550e8400-e29b-41d4-a716-446655440000
-                name: Linux Foundation
+                displayName: 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
@@ -1530,14 +1559,18 @@ components:
       type: object
       required:
         - id
-        - name
+        - displayName
+        - domain
       properties:
         id:
           type: string
           format: uuid
-        name:
+        displayName:
           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

@@ -100,13 +100,19 @@ 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)
+    ({
+      ...memberOrg,
+      ...updatedMemberOrg,
+      verified,
+      verifiedBy,
+      organizationDomains: [],
+    } as IMemberRoleWithOrganization)
 
   ok(res, toMemberWorkExperience(responseMo))
 }

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

@@ -61,5 +61,5 @@ export async function createOrganization(req: Request, res: Response): Promise<v
     )
   })
 
-  created(res, { id: organizationId, name, logo })
+  created(res, { id: organizationId, name, logo, domain })
 }

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

@@ -2,56 +2,32 @@ 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 { 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 } = validateOrThrow(querySchema, req.query)
   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: domain ? normalizeHostname(domain, false) : undefined,
   })
 
-  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 } : {}),
-  })
+  ok(res, organization)
 }

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/data-access-layer/src/members/organizations.ts

@@ -213,27 +213,60 @@ export async function fetchManyMemberOrgs(
 export async function fetchManyMemberOrgsWithOrgData(
   qx: QueryExecutor,
   memberIds: string[],
+  { withDomains = false }: { withDomains?: boolean } = {},
 ): Promise<Map<string, IMemberRoleWithOrganization[]>> {
-  const memberRoles = (await qx.select(
-    `
-      SELECT mo.*, o."displayName" as "organizationName", o.logo as "organizationLogo"
-      FROM "memberOrganizations" mo
-      join "organizations" o on mo."organizationId" = o.id
-      WHERE mo."memberId" in ($(memberIds:csv))
+  const domainSelect = withDomains
+    ? `,
+      COALESCE(oid.domains, '{}') AS "organizationDomains"`
+    : ''
+
+  const domainJoin = withDomains
+    ? `
+      LEFT JOIN (
+        SELECT
+          oi."organizationId",
+          array_agg(DISTINCT lower(oi.value) ORDER BY lower(oi.value)) AS domains
+        FROM "organizationIdentities" oi
+        WHERE oi.type = 'primary-domain'
+          AND oi.verified = true
+          AND oi."organizationId" IN (
+            SELECT DISTINCT mo2."organizationId"
+            FROM "memberOrganizations" mo2
+            WHERE mo2."memberId" IN ($(memberIds:csv))
+              AND mo2."deletedAt" IS NULL
+          )
+        GROUP BY oi."organizationId"
+      ) oid ON oid."organizationId" = mo."organizationId"`
+    : ''
+
+  const sql = `
+    SELECT
+      mo.*,
+      o."displayName" AS "organizationName",
+      o.logo AS "organizationLogo"
+      ${domainSelect}
+    FROM "memberOrganizations" mo
+    JOIN organizations o ON o.id = mo."organizationId"
+    ${domainJoin}
+    WHERE mo."memberId" IN ($(memberIds:csv))
       AND mo."deletedAt" IS NULL;
-    `,
-    {
-      memberIds,
-    },
-  )) as IMemberRoleWithOrganization[]
+  `
+
+  const memberRoles = (await qx.select(sql, {
+    memberIds,
+  })) as IMemberRoleWithOrganization[]
+
+  const result = new Map<string, IMemberRoleWithOrganization[]>()
 
-  const resultMap = new Map<string, IMemberRoleWithOrganization[]>()
   for (const memberId of memberIds) {
-    const roles = memberRoles.filter((r) => r.memberId === memberId)
-    resultMap.set(memberId, roles)
+    result.set(memberId, [])
   }
 
-  return resultMap
+  for (const role of memberRoles) {
+    result.get(role.memberId)!.push(role)
+  }
+
+  return result
 }
 
 export async function fetchManyOrganizationAffiliationPolicies(