Class GirasolCardAdminService

Root of the card hierarchy: the one girasol-card-search namespace the customer and admin surfaces share, and the bust seam every writer inherits. Both surfaces project the same row, so one cached shape serves both.

Hierarchy (View Summary)

GirasolCardCache
- GirasolCardAdminService

Index

Constructors

constructor

new GirasolCardAdminService(
    args: {
        db: B2bDatabase;
        girasolClient: GirasolClient;
        valkeyClient: ValkeyClient | null;
    },
): GirasolCardAdminService
Parameters
- args: {
      db: B2bDatabase;
      girasolClient: GirasolClient;
      valkeyClient: ValkeyClient | null;
  }
Returns GirasolCardAdminService
Overrides GirasolCardCache.constructor
- Defined in packages/girasol-card-services/src/GirasolCardAdminService.ts:45

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<GirasolCardSearchItem>>

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`girasolClient

girasolClient: GirasolClient

`Static`instance

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

The process service: the shared database, Valkey and Girasol.

Methods

get

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

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 GirasolCardCache.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

search

search(
    __namedParameters: GirasolCardSearchFilters & {
        customerIds?: string[];
        orderBy?: GirasolCardOrderBy;
        page?: number;
        pageSize?: number;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: GirasolCardSearchItem[]; total: number };
    },
>
Search cards across all customers, or those in customerIds. Reads only the database; page defaults to 1 and pageSize to 10.
Parameters
- __namedParameters: GirasolCardSearchFilters & {
      customerIds?: string[];
      orderBy?: GirasolCardOrderBy;
      page?: number;
      pageSize?: number;
  }
  - OptionalcustomerIds?: string[]
  - OptionalorderBy?: GirasolCardOrderBy
  - Optionalpage?: number
    
    Defaults to 1
  - OptionalpageSize?: number
    
    Defaults to 10
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: GirasolCardSearchItem[]; total: number };
    },
>
- Defined in packages/girasol-card-services/src/GirasolCardAdminService.ts:82

`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 GirasolCardCache.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

syncStatuses

syncStatuses(
    __namedParameters: { girasolAccountId: string },
): Promise<
    | {
        ok: true;
        value: {
            checked: number;
            missing: string[];
            updated: {
                id: string;
                previousStatus: | "ACTIVE"
                | "DELETED"
                | "BLOCKED"
                | "REJECTED"
                | "UNKNOWN"
                | "CREATED"
                | "REQUESTED"
                | "EXPIRED"
                | "FROZEN"
                | "DELIVERED";
                status: | "ACTIVE"
                | "DELETED"
                | "BLOCKED"
                | "REJECTED"
                | "UNKNOWN"
                | "CREATED"
                | "REQUESTED"
                | "EXPIRED"
                | "FROZEN"
                | "DELIVERED";
            }[];
        };
    }
    | {
        error: GirasolAccountError
        | ServiceError<"CARD_ACCOUNT_NOT_FOUND">;
        ok: false;
    },
>
Stores the status Girasol reports for every card on one card account, with a single getCardsByAccount call. A card Girasol does not list keeps its stored status and is returned in missing.
Parameters
- __namedParameters: { girasolAccountId: string }
Returns Promise<
    | {
        ok: true;
        value: {
            checked: number;
            missing: string[];
            updated: {
                id: string;
                previousStatus: | "ACTIVE"
                | "DELETED"
                | "BLOCKED"
                | "REJECTED"
                | "UNKNOWN"
                | "CREATED"
                | "REQUESTED"
                | "EXPIRED"
                | "FROZEN"
                | "DELIVERED";
                status: | "ACTIVE"
                | "DELETED"
                | "BLOCKED"
                | "REJECTED"
                | "UNKNOWN"
                | "CREATED"
                | "REQUESTED"
                | "EXPIRED"
                | "FROZEN"
                | "DELIVERED";
            }[];
        };
    }
    | {
        error: GirasolAccountError
        | ServiceError<"CARD_ACCOUNT_NOT_FOUND">;
        ok: false;
    },
>
- Defined in packages/girasol-card-services/src/GirasolCardAdminService.ts:151

`Protected` `Static`getSearchArgs

getSearchArgs(
__namedParameters: { id: 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: { id: string }
Returns { ids: string[]; page: number; pageSize: number }
- Defined in packages/girasol-card-services/src/GirasolCardAdminService.ts:74

Class GirasolCardAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolCardAdminService

Properties

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Protected` `Readonly`girasolClient

`Static`instance

Methods

get

Parameters

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

invalidateCache

Parameters

Returns Promise<void>

search

Parameters

`Optional`customerIds?: string[]

`Optional`orderBy?: GirasolCardOrderBy

`Optional`page?: number

`Optional`pageSize?: number

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

`Protected`searchTags

Parameters

Returns string[]

syncStatuses

Parameters

`Protected` `Static`getSearchArgs

Parameters

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

Settings

On This Page

Class GirasolCardAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolCardAdminService

Properties

Protected Readonlycache

Protected Readonlydb

Protected ReadonlygirasolClient

Staticinstance

Methods

get

Parameters

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

invalidateCache

Parameters

Returns Promise<void>

search

Parameters

OptionalcustomerIds?: string[]

OptionalorderBy?: GirasolCardOrderBy

Optionalpage?: number

OptionalpageSize?: number

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

ProtectedsearchTags

Parameters

Returns string[]

syncStatuses

Parameters

Protected StaticgetSearchArgs

Parameters

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

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Protected` `Readonly`girasolClient

`Static`instance

`Optional`customerIds?: string[]

`Optional`orderBy?: GirasolCardOrderBy

`Optional`page?: number

`Optional`pageSize?: number

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

`Protected`searchTags

`Protected` `Static`getSearchArgs