Class CustomerDashboardInviteService

constructor

• new CustomerDashboardInviteService(
      __namedParameters: {
          db: B2bDatabase;
          internalEventPublisher: InternalEventPublisher;
          inviteMailer: DashboardInviteMailer;
      },
  ): CustomerDashboardInviteService

  Parameters

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

  Returns CustomerDashboardInviteService

Staticinstance

create

• create(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
          dashboardOrigin: string;
          email: string;
          roleId: string;
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
      },
  ): Promise<
      | {
          ok: true;
          value: Pick<CustomerDashboardInvite, "email" | "roleId" | "roleName"> & {
              outcome: "INVITED" | "ADDED";
          };
      }
      | { error: ServiceError; ok: false },
  >

  Invites an address to a role within the caller's reach and emails it. An address with a pending invite is settled first: one to the same role is emailed again, and one to another role is refused, as it would re-role it.

  An address a registered login holds (linked to Cognito, confirmed) is ADDED instead: the invite, new or the one already open, is accepted for them at once, as their sign-in would, and nothing is emailed. When that acceptance would not give them this role, it stays PENDING and is emailed. With a caller's tx nothing is published: the caller publishes after its commit.

  Parameters

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

    • dashboardOrigin: string

      The origin the invitee signs up at: the email's link points there.

    • email: string

    • roleId: string

    • Optionaltx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>

  Returns Promise<
      | {
          ok: true;
          value: Pick<CustomerDashboardInvite, "email" | "roleId" | "roleName"> & {
              outcome: "INVITED" | "ADDED";
          };
      }
      | { error: ServiceError; ok: false },
  >

delete

• delete(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & (
          ({ id: string; } | { email: string; }) & { tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations> | undefined; }
      ),
  ): Promise<{ ok: true; value: T } | { error: ServiceError; ok: false }>

  Revokes a pending invite, by id or by address: the row is soft-deleted, so its link stops working. One to a role hidden from the caller reads as not found, so it can't be probed. By id, an invite already revoked writes nothing and publishes again: a retry finds it there. With a caller's tx nothing is published: the caller publishes after its commit.

  Parameters

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

  Returns Promise<{ ok: true; value: T } | { error: ServiceError; ok: false }>

get

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

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

  Parameters

  • args: CustomerDashboardCaller & { id: string }

  Returns Promise<CustomerDashboardInvite | null>

search

• search(
      args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
          createdAt?: DbTimestampCriteria;
          emails?: string[];
          ids?: string[];
          includeDeleted?: boolean;
          page?: number;
          pageSize?: number;
          statuses?: ("PENDING" | "DELETED" | "ACCEPTED" | "REVOKED" | "EXPIRED")[];
          updatedAt?: DbTimestampCriteria;
      },
  ): Promise<
      | {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardInvite[];
              total: number;
          };
      }
      | { error: ServiceError; ok: false },
  >

  Invites to an internal role are invisible unless the caller is internal.

  Parameters

  • args: (CustomerDashboardCaller | CustomerDashboardStaffCaller) & {
        createdAt?: DbTimestampCriteria;
        emails?: string[];
        ids?: string[];
        includeDeleted?: boolean;
        page?: number;
        pageSize?: number;
        statuses?: ("PENDING" | "DELETED" | "ACCEPTED" | "REVOKED" | "EXPIRED")[];
        updatedAt?: DbTimestampCriteria;
    }
    • CustomerDashboardCaller
    • CustomerDashboardStaffCaller

    • OptionalcreatedAt?: DbTimestampCriteria

    • Optionalemails?: string[]

      Matched case-insensitively.

    • Optionalids?: string[]

    • OptionalincludeDeleted?: boolean

    • Optionalpage?: number

    • OptionalpageSize?: number

    • Optionalstatuses?: ("PENDING" | "DELETED" | "ACCEPTED" | "REVOKED" | "EXPIRED")[]

    • OptionalupdatedAt?: DbTimestampCriteria

  Returns Promise<
      | {
          ok: true;
          value: {
              hasNext: boolean;
              items: CustomerDashboardInvite[];
              total: number;
          };
      }
      | { error: ServiceError; ok: false },
  >