Class CustomerDashboardMembershipService

constructor

• new CustomerDashboardMembershipService(
      __namedParameters: {
          db: B2bDatabase;
          internalEventPublisher: InternalEventPublisher;
      },
  ): CustomerDashboardMembershipService

  Parameters

  • __namedParameters: { db: B2bDatabase; internalEventPublisher: InternalEventPublisher }

  Returns CustomerDashboardMembershipService

Staticinstance

delete

• delete(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          userId: string;
      },
  ): Promise<
      | { ok: true; value: { removed: boolean } & MemberSnapshot }
      | { error: ServiceError; ok: false },
  >

  team/remove:w and the same reach as update: the row is soft-deleted. removed is false when it was already removed (a concurrent removal, or a retry); published either way. With a caller's tx nothing is published: the caller publishes after its commit.

  Parameters

  • args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        userId: string;
    }

  Returns Promise<
      | { ok: true; value: { removed: boolean } & MemberSnapshot }
      | { error: ServiceError; ok: false },
  >

get

• get(
      args: CustomerDashboardCaller & { userId: string },
  ): Promise<CustomerDashboardMember | null>

  Hidden, absent, deleted and forbidden all read as null.

  Parameters

  • args: CustomerDashboardCaller & { userId: string }

  Returns Promise<CustomerDashboardMember | null>

search

• search(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
          createdAt?: DbTimestampCriteria;
          includeDeleted?: boolean;
          orderBy?: OrderBy[];
          page?: number;
          pageSize?: number;
          query?: string;
          roleIds?: string[];
          statuses?: ("ACTIVE" | "DELETED" | "DISABLED")[];
          updatedAt?: DbTimestampCriteria;
          userIds?: string[];
      },
  ): Promise<
      | { error: ServiceError; ok: false }
      | {
          ok: true;
          value: {
              assignableRoles: Pick<CustomerDashboardRole, "id" | "name">[];
              hasNext: boolean;
              items: CustomerDashboardMember[];
              total: number;
          };
      },
  >

  One page of the members the caller may see, with the roles they may assign. Members of an internal role are invisible unless the caller is internal, whatever the filters say.

  Parameters

  • args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
        createdAt?: DbTimestampCriteria;
        includeDeleted?: boolean;
        orderBy?: OrderBy[];
        page?: number;
        pageSize?: number;
        query?: string;
        roleIds?: string[];
        statuses?: ("ACTIVE" | "DELETED" | "DISABLED")[];
        updatedAt?: DbTimestampCriteria;
        userIds?: string[];
    }
    • CustomerDashboardCaller
    • CustomerDashboardStaffCaller

    • OptionalcreatedAt?: DbTimestampCriteria

    • OptionalincludeDeleted?: boolean

    • OptionalorderBy?: OrderBy[]

      Defaults to name ASC, email ASC.

    • Optionalpage?: number

    • OptionalpageSize?: number

    • Optionalquery?: string

      Case-insensitive substring over email, first and last name.

    • OptionalroleIds?: string[]

    • Optionalstatuses?: ("ACTIVE" | "DELETED" | "DISABLED")[]

    • OptionalupdatedAt?: DbTimestampCriteria

    • OptionaluserIds?: string[]

  Returns Promise<
      | { error: ServiceError; ok: false }
      | {
          ok: true;
          value: {
              assignableRoles: Pick<CustomerDashboardRole, "id" | "name">[];
              hasNext: boolean;
              items: CustomerDashboardMember[];
              total: number;
          };
      },
  >

searchOwn

• searchOwn(
      args: {
          customerIds?: string[];
          dashboardUserId: string;
          enterable?: boolean;
          page?: number;
          pageSize?: number;
          q?: string;
          statuses?: ("ACTIVE" | "DELETED" | "DISABLED")[];
          workspaceIds?: string[];
      },
  ): Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardOwnMembership[];
              total: number;
              user: CustomerDashboardOwnUser
              | null;
          };
      },
  >

  The caller's own live memberships across every customer, by customer name, with each one's grants and their user row. Needs no permission. q matches the customer's shared search document.

  Parameters

  • args: {
        customerIds?: string[];
        dashboardUserId: string;
        enterable?: boolean;
        page?: number;
        pageSize?: number;
        q?: string;
        statuses?: ("ACTIVE" | "DELETED" | "DISABLED")[];
        workspaceIds?: string[];
    }

    • OptionalcustomerIds?: string[]

    • dashboardUserId: string

    • Optionalenterable?: boolean

      Only memberships a session can enter: ACTIVE, of a live ACTIVE customer with its main organization.

    • Optionalpage?: number

    • OptionalpageSize?: number

    • Optionalq?: string

    • Optionalstatuses?: ("ACTIVE" | "DELETED" | "DISABLED")[]

    • OptionalworkspaceIds?: string[]

  Returns Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardOwnMembership[];
              total: number;
              user: CustomerDashboardOwnUser
              | null;
          };
      },
  >

searchRoles

• searchRoles(
      args: CustomerDashboardCaller | CustomerDashboardStaffCaller,
  ): Promise<
      | { ok: true; value: { items: CustomerDashboardRoleGrants[] } }
      | { error: ServiceError; ok: false },
  >

  Every role in the caller's role set that they can see, highest rank first, with its grants: what the team page shows an owner choosing one.

  Parameters

  • args: CustomerDashboardCaller | CustomerDashboardStaffCaller

  Returns Promise<
      | { ok: true; value: { items: CustomerDashboardRoleGrants[] } }
      | { error: ServiceError; ok: false },
  >

searchRolesGranting

• searchRolesGranting(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
          permissionKeys: readonly (
              "terms/accept:w"
              | "deposit/swift-wire:r"
              | "deposit/us-wire:r"
          )[];
      },
  ): Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: { items: string[] } },
  >

  The names of the non-internal roles in the caller's role set that grant any of permissionKeys, highest rank first. Any ACTIVE member may read it, unlike searchRoles's team:r, so a login that can't act learns who can.

  Parameters

  • args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
        permissionKeys: readonly (
            "terms/accept:w"
            | "deposit/swift-wire:r"
            | "deposit/us-wire:r"
        )[];
    }

  Returns Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: { items: string[] } },
  >

update

• update(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
          data: {
              firstName?: string;
              lastName?: string;
              roleId?: string;
              status?: "ACTIVE" | "DISABLED";
          };
          requestMetadata?: {
              geoLocation?: {
                  city?: string;
                  country?: string;
                  countryRegion?: string;
                  flag?: string;
                  latitude?: string;
                  longitude?: string;
                  postalCode?: string;
                  region?: string;
              };
              ipAddress?: string;
              userAgent?: {
                  browser: { name?: string; version?: string };
                  cpu: { architecture?: string };
                  device: { model?: string; type?: string; vendor?: string };
                  engine: { name?: string; version?: string };
                  isBot: boolean;
                  os: { name?: string; version?: string };
                  ua: string;
              };
          };
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          userId: string;
      },
  ): Promise<
      | {
          ok: true;
          value: MemberSnapshot & { previousRoleName: string
          | null };
      }
      | { error: UpdateError; ok: false },
  >

  roleId and status need team/role:w, a member within the caller's reach who isn't the caller, and a target role within reach. firstName / lastName rename the caller's OWN user only. A status that changes is recorded as user.workspaceStatusChanged in the same transaction. With a caller's tx nothing is published: the caller publishes after its commit.

  Parameters

  • args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
        data: {
            firstName?: string;
            lastName?: string;
            roleId?: string;
            status?: "ACTIVE" | "DISABLED";
        };
        requestMetadata?: {
            geoLocation?: {
                city?: string;
                country?: string;
                countryRegion?: string;
                flag?: string;
                latitude?: string;
                longitude?: string;
                postalCode?: string;
                region?: string;
            };
            ipAddress?: string;
            userAgent?: {
                browser: { name?: string; version?: string };
                cpu: { architecture?: string };
                device: { model?: string; type?: string; vendor?: string };
                engine: { name?: string; version?: string };
                isBot: boolean;
                os: { name?: string; version?: string };
                ua: string;
            };
        };
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        userId: string;
    }
    • CustomerDashboardCaller
    • CustomerDashboardStaffCaller

    • data: {
          firstName?: string;
          lastName?: string;
          roleId?: string;
          status?: "ACTIVE" | "DISABLED";
      }

    • OptionalrequestMetadata?: {
          geoLocation?: {
              city?: string;
              country?: string;
              countryRegion?: string;
              flag?: string;
              latitude?: string;
              longitude?: string;
              postalCode?: string;
              region?: string;
          };
          ipAddress?: string;
          userAgent?: {
              browser: { name?: string; version?: string };
              cpu: { architecture?: string };
              device: { model?: string; type?: string; vendor?: string };
              engine: { name?: string; version?: string };
              isBot: boolean;
              os: { name?: string; version?: string };
              ua: string;
          };
      }

      The request's IP, location and agent, stored on the activity a status change records.

      • OptionalgeoLocation?: {
            city?: string;
            country?: string;
            countryRegion?: string;
            flag?: string;
            latitude?: string;
            longitude?: string;
            postalCode?: string;
            region?: string;
        }

        Geolocation information from the request

        • Optionalcity?: string

          The city that the request originated from.

        • Optionalcountry?: string

          The country that the request originated from (ISO 3166-1 alpha-2).

        • OptionalcountryRegion?: string

          The ISO 3166-2 region code of the client (CloudFront-Viewer-Country-Region).

        • Optionalflag?: string

          The flag emoji for the country — derived from country at render time.

        • Optionallatitude?: string

          The latitude of the client.

        • Optionallongitude?: string

          The longitude of the client.

        • OptionalpostalCode?: string

          The postal code of the client

        • Optionalregion?: string

          Legacy Vercel edge region; unpopulated under CloudFront.

      • OptionalipAddress?: string

        IP address of the request

      • OptionaluserAgent?: {
            browser: { name?: string; version?: string };
            cpu: { architecture?: string };
            device: { model?: string; type?: string; vendor?: string };
            engine: { name?: string; version?: string };
            isBot: boolean;
            os: { name?: string; version?: string };
            ua: string;
        }

        User agent information from the request

    • Optionaltx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>

    • userId: string

  Returns Promise<
      | {
          ok: true;
          value: MemberSnapshot & { previousRoleName: string
          | null };
      }
      | { error: UpdateError; ok: false },
  >