Class GirasolCardService

Customer card writes. Each write to Girasol stores the status Girasol answers, then busts the cache this class reads through.

Hierarchy (View Summary)

GirasolCardQueryService
- GirasolCardService

Index

Constructors

constructor

new GirasolCardService(
    args: {
        db: B2bDatabase;
        girasolClient: GirasolClient;
        internalEventPublisher: InternalEventPublisher | null;
        productQuoteService: ProductQuoteService;
        valkeyClient: ValkeyClient | null;
    },
): GirasolCardService
Parameters
- args: {
      db: B2bDatabase;
      girasolClient: GirasolClient;
      internalEventPublisher: InternalEventPublisher | null;
      productQuoteService: ProductQuoteService;
      valkeyClient: ValkeyClient | null;
  }
Returns GirasolCardService
Overrides GirasolCardQueryService.constructor
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:109

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<GirasolCardSearchItem>>

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`girasolClient

girasolClient: GirasolClient

`Static`instance

instance: (...args: []) => GirasolCardService = ...

The process service: the shared database, Valkey, Girasol, the quote engine and the internal bus.

Methods

activate

activate(
    __namedParameters: {
        customerId: string;
        cvv: string;
        id: string;
        pin: string;
    },
): Promise<
    | {
        ok: true;
        value: | "ACTIVE"
        | "DELETED"
        | "BLOCKED"
        | "REJECTED"
        | "UNKNOWN"
        | "CREATED"
        | "REQUESTED"
        | "EXPIRED"
        | "FROZEN"
        | "DELIVERED";
    }
    | {
        error: | ServiceError<
            "INVALID_CVV"
            | "INVALID_PIN"
            | "CVV_MISMATCH"
            | "ACTIVATION_REJECTED",
        >
        | ServiceError<"CARD_NOT_FOUND" | "LAST_FOUR_DIGITS_UNAVAILABLE">;
        ok: false;
    },
>
Activates a delivered physical card with the CVV printed on it and a new PIN. Neither value is stored, logged or put in an error.
Parameters
- __namedParameters: { customerId: string; cvv: string; id: string; pin: string }
Returns Promise<
    | {
        ok: true;
        value: | "ACTIVE"
        | "DELETED"
        | "BLOCKED"
        | "REJECTED"
        | "UNKNOWN"
        | "CREATED"
        | "REQUESTED"
        | "EXPIRED"
        | "FROZEN"
        | "DELIVERED";
    }
    | {
        error: | ServiceError<
            "INVALID_CVV"
            | "INVALID_PIN"
            | "CVV_MISMATCH"
            | "ACTIVATION_REJECTED",
        >
        | ServiceError<"CARD_NOT_FOUND" | "LAST_FOUR_DIGITS_UNAVAILABLE">;
        ok: false;
    },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:382

block

block(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | {
        ok: true;
        value: | "ACTIVE"
        | "DELETED"
        | "BLOCKED"
        | "REJECTED"
        | "UNKNOWN"
        | "CREATED"
        | "REQUESTED"
        | "EXPIRED"
        | "FROZEN"
        | "DELIVERED";
    }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
    | {
        ok: true;
        value: | "ACTIVE"
        | "DELETED"
        | "BLOCKED"
        | "REJECTED"
        | "UNKNOWN"
        | "CREATED"
        | "REQUESTED"
        | "EXPIRED"
        | "FROZEN"
        | "DELIVERED";
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:344

create

create(
    request: CreateInput,
): Promise<
    | { ok: true; value: GirasolCardSearchItem }
    | {
        error:
            | ServiceError<"INVALID_PHONE">
            | GirasolCardValidateInputError
            | ServiceError<"CARD_ACCOUNT_NOT_FOUND" | "CARD_ACCOUNT_NOT_ACTIVE">;
        ok: false;
    },
>
Parameters
- request: CreateInput
Returns Promise<
    | { ok: true; value: GirasolCardSearchItem }
    | {
        error:
            | ServiceError<"INVALID_PHONE">
            | GirasolCardValidateInputError
            | ServiceError<"CARD_ACCOUNT_NOT_FOUND" | "CARD_ACCOUNT_NOT_ACTIVE">;
        ok: false;
    },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:122

freeze

freeze(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value:
            | "ACTIVE"
            | "DELETED"
            | "BLOCKED"
            | "REJECTED"
            | "UNKNOWN"
            | "CREATED"
            | "REQUESTED"
            | "EXPIRED"
            | "FROZEN"
            | "DELIVERED";
    },
>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value:
            | "ACTIVE"
            | "DELETED"
            | "BLOCKED"
            | "REJECTED"
            | "UNKNOWN"
            | "CREATED"
            | "REQUESTED"
            | "EXPIRED"
            | "FROZEN"
            | "DELIVERED";
    },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:286

get

get(
id: { customerId: string; id: string },
): Promise<{ ok: true; value: GirasolCardSearchItem | null }>
Get card by ID for the customer.
Parameters
- id: { customerId: string; id: string }
  The ID of the card. Example: card_1234567890.
Returns Promise<{ ok: true; value: GirasolCardSearchItem | null }>
Inherited from GirasolCardQueryService.get
- Defined in packages/girasol-card-services/src/GirasolCardQueryService.ts:183

`Protected`getActiveCardAccount

getActiveCardAccount(
    __namedParameters: { customerId: string },
): Promise<
    | {
        ok: true;
        value: {
            externalId: string;
            girasolAccountNumber: string;
            id: number;
            status: "ACTIVE"
            | "DELETED"
            | "INACTIVE"
            | "UNKNOWN";
        };
    }
    | { error: ServiceError; ok: false },
>
The customer's active Girasol card account.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<
    | {
        ok: true;
        value: {
            externalId: string;
            girasolAccountNumber: string;
            id: number;
            status: "ACTIVE"
            | "DELETED"
            | "INACTIVE"
            | "UNKNOWN";
        };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:624

invalidateCache

invalidateCache(
    __namedParameters: {
        customerIds: readonly string[];
        keys?: readonly CacheKey[];
        records?: readonly string[];
    },
): Promise<void>
Clear each customer's membership tag and each record tag wherever cached, and always this namespace's collection tag. keys are exact deletes in this instance's key space: the only bust a null client honours.
Parameters
- __namedParameters: {
      customerIds: readonly string[];
      keys?: readonly CacheKey[];
      records?: readonly string[];
  }
Returns Promise<void>
Inherited from GirasolCardQueryService.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

recordLastFourDigits

recordLastFourDigits(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | {
        ok: true;
        value: Pick<
            {
                cardholderName: string;
                createdAt: Date;
                displayName: string;
                expiryMonth: string
                | null;
                expiryYear: string | null;
                firstName: string;
                girasolCardId: string;
                id: string;
                lastFourDigits: string | null;
                lastName: string;
                maskedCardNumber: string;
                phone: string;
                shippingAddress:
                    | {
                        city: string;
                        countryCode: string;
                        line1: string;
                        line2?: string;
                        postalCode: string;
                        region?: string;
                    }
                    | null;
                status: | "ACTIVE"
                | "DELETED"
                | "BLOCKED"
                | "REJECTED"
                | "UNKNOWN"
                | "CREATED"
                | "REQUESTED"
                | "EXPIRED"
                | "FROZEN"
                | "DELIVERED";
                statusDescription: string;
                type: "VIRTUAL"
                | "PHYSICAL";
                typeDescription: string;
                updatedAt: Date;
            },
            "girasolCardId",
        > & { lastFourDigits: string };
    }
    | { error: ServiceError; ok: false },
>
Returns a physical card's last four digits, storing them from Girasol when the row has none. Activation needs them, and create may not have had them.
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
    | {
        ok: true;
        value: Pick<
            {
                cardholderName: string;
                createdAt: Date;
                displayName: string;
                expiryMonth: string
                | null;
                expiryYear: string | null;
                firstName: string;
                girasolCardId: string;
                id: string;
                lastFourDigits: string | null;
                lastName: string;
                maskedCardNumber: string;
                phone: string;
                shippingAddress:
                    | {
                        city: string;
                        countryCode: string;
                        line1: string;
                        line2?: string;
                        postalCode: string;
                        region?: string;
                    }
                    | null;
                status: | "ACTIVE"
                | "DELETED"
                | "BLOCKED"
                | "REJECTED"
                | "UNKNOWN"
                | "CREATED"
                | "REQUESTED"
                | "EXPIRED"
                | "FROZEN"
                | "DELIVERED";
                statusDescription: string;
                type: "VIRTUAL"
                | "PHYSICAL";
                typeDescription: string;
                updatedAt: Date;
            },
            "girasolCardId",
        > & { lastFourDigits: string };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:446

revealDetails

revealDetails(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | { ok: true; value: GirasolCardDetails }
    | { error: ServiceError; ok: false },
>
Reads the card's PAN, CVV, printed name and expiry from Girasol. The result is never cached, logged or stored.
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
| { ok: true; value: GirasolCardDetails }
| { error: ServiceError; ok: false },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:257

search

search(
    page: GirasolCardSearchFilters & {
        customerId: string;
        orderBy?: GirasolCardOrderBy;
        page?: number;
        pageSize?: number;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: GirasolCardSearchItem[]; total: number };
    },
>
Search cards for the customer. Reads only the database.
Parameters
- page: GirasolCardSearchFilters & {
      customerId: string;
      orderBy?: GirasolCardOrderBy;
      page?: number;
      pageSize?: number;
  }
  Defaults to 1.
  - customerId: string
  - OptionalorderBy?: GirasolCardOrderBy
  - Optionalpage?: number
    
    Defaults to 1
  - OptionalpageSize?: number
    
    Defaults to 10
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: GirasolCardSearchItem[]; total: number };
    },
>
Inherited from GirasolCardQueryService.search
- Defined in packages/girasol-card-services/src/GirasolCardQueryService.ts:215

`Protected`searchTags

searchTags(
    __namedParameters: {
        customerIds: readonly string[] | undefined;
        fields?: readonly string[];
        records?: readonly string[];
    },
): string[]
Tags for a page: the scope its query searched (each customer's membership tag, else the collection tag), so an empty page is bustable too, plus the records it projects and the fields that chose or ordered its rows.
Parameters
- __namedParameters: {
      customerIds: readonly string[] | undefined;
      fields?: readonly string[];
      records?: readonly string[];
  }
Returns string[]
Inherited from GirasolCardQueryService.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

unfreeze

unfreeze(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value:
            | "ACTIVE"
            | "DELETED"
            | "BLOCKED"
            | "REJECTED"
            | "UNKNOWN"
            | "CREATED"
            | "REQUESTED"
            | "EXPIRED"
            | "FROZEN"
            | "DELIVERED";
    },
>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
    | { error: ServiceError; ok: false }
    | {
        ok: true;
        value:
            | "ACTIVE"
            | "DELETED"
            | "BLOCKED"
            | "REJECTED"
            | "UNKNOWN"
            | "CREATED"
            | "REQUESTED"
            | "EXPIRED"
            | "FROZEN"
            | "DELIVERED";
    },
>
- Defined in packages/girasol-card-services/src/GirasolCardService.ts:315

`Protected` `Static`getSearchArgs

getSearchArgs(
__namedParameters: { customerId: string; id: string },
): { customerId: string; ids: string[]; page: number; pageSize: number }
The search arguments get reads through. Every default is spelled out, so the same object is also search's cache key for that entry.
Parameters
- __namedParameters: { customerId: string; id: string }
Returns { customerId: string; ids: string[]; page: number; pageSize: number }
Inherited from GirasolCardQueryService.getSearchArgs
- Defined in packages/girasol-card-services/src/GirasolCardQueryService.ts:200

Class GirasolCardService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolCardService

Properties

Protected Readonlycache

Protected Readonlydb

Protected ReadonlygirasolClient

Staticinstance

Methods

activate

Parameters

block

Parameters

Returns Promise< | { ok: true; value: | "ACTIVE" | "DELETED" | "BLOCKED" | "REJECTED" | "UNKNOWN" | "CREATED" | "REQUESTED" | "EXPIRED" | "FROZEN" | "DELIVERED"; } | { error: ServiceError; ok: false },>

create

Parameters

Returns Promise< | { ok: true; value: GirasolCardSearchItem } | { error: | ServiceError<"INVALID_PHONE"> | GirasolCardValidateInputError | ServiceError<"CARD_ACCOUNT_NOT_FOUND" | "CARD_ACCOUNT_NOT_ACTIVE">; ok: false; },>

freeze

Parameters

Returns Promise< | { error: ServiceError; ok: false } | { ok: true; value: | "ACTIVE" | "DELETED" | "BLOCKED" | "REJECTED" | "UNKNOWN" | "CREATED" | "REQUESTED" | "EXPIRED" | "FROZEN" | "DELIVERED"; },>

get

Parameters

Returns Promise<{ ok: true; value: GirasolCardSearchItem | null }>

ProtectedgetActiveCardAccount

Parameters

Returns Promise< | { ok: true; value: { externalId: string; girasolAccountNumber: string; id: number; status: "ACTIVE" | "DELETED" | "INACTIVE" | "UNKNOWN"; }; } | { error: ServiceError; ok: false },>

invalidateCache

Parameters

Returns Promise<void>

recordLastFourDigits

Parameters

revealDetails

Parameters

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

search

Parameters

customerId: string

OptionalorderBy?: GirasolCardOrderBy

Optionalpage?: number

OptionalpageSize?: number

Returns Promise< { ok: true; value: { hasNext: boolean; items: GirasolCardSearchItem[]; total: number }; },>

ProtectedsearchTags

Parameters

Returns string[]

unfreeze

Parameters

Returns Promise< | { error: ServiceError; ok: false } | { ok: true; value: | "ACTIVE" | "DELETED" | "BLOCKED" | "REJECTED" | "UNKNOWN" | "CREATED" | "REQUESTED" | "EXPIRED" | "FROZEN" | "DELIVERED"; },>

Protected StaticgetSearchArgs

Parameters

Returns { customerId: string; ids: string[]; page: number; pageSize: number }

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Protected` `Readonly`girasolClient

`Static`instance

Returns Promise<
| {
ok: true;
value: | "ACTIVE"
| "DELETED"
| "BLOCKED"
| "REJECTED"
| "UNKNOWN"
| "CREATED"
| "REQUESTED"
| "EXPIRED"
| "FROZEN"
| "DELIVERED";
}
| { error: ServiceError; ok: false },
>

Returns Promise<
| { ok: true; value: GirasolCardSearchItem }
| {
error:
| ServiceError<"INVALID_PHONE">
| GirasolCardValidateInputError
| ServiceError<"CARD_ACCOUNT_NOT_FOUND" | "CARD_ACCOUNT_NOT_ACTIVE">;
ok: false;
},
>

Returns Promise<
| { error: ServiceError; ok: false }
| {
ok: true;
value:
| "ACTIVE"
| "DELETED"
| "BLOCKED"
| "REJECTED"
| "UNKNOWN"
| "CREATED"
| "REQUESTED"
| "EXPIRED"
| "FROZEN"
| "DELIVERED";
},
>

`Protected`getActiveCardAccount

Returns Promise<
| {
ok: true;
value: {
externalId: string;
girasolAccountNumber: string;
id: number;
status: "ACTIVE"
| "DELETED"
| "INACTIVE"
| "UNKNOWN";
};
}
| { error: ServiceError; ok: false },
>

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

`Optional`orderBy?: GirasolCardOrderBy

`Optional`page?: number

`Optional`pageSize?: number

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: GirasolCardSearchItem[]; total: number };
},
>

`Protected`searchTags

Returns Promise<
| { error: ServiceError; ok: false }
| {
ok: true;
value:
| "ACTIVE"
| "DELETED"
| "BLOCKED"
| "REJECTED"
| "UNKNOWN"
| "CREATED"
| "REQUESTED"
| "EXPIRED"
| "FROZEN"
| "DELIVERED";
},
>

`Protected` `Static`getSearchArgs