Class GirasolCardQueryService

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
- GirasolCardQueryService
  - GirasolCardService

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<GirasolCardSearchItem>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

The process service, on the shared database and Valkey.

Methods

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 }>
- Defined in packages/girasol-card-services/src/GirasolCardQueryService.ts:183

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

`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 }
- Defined in packages/girasol-card-services/src/GirasolCardQueryService.ts:200

Class GirasolCardQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolCardQueryService

Properties

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

Methods

get

Parameters

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

invalidateCache

Parameters

Returns Promise<void>

search

Parameters

customerId: 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[]

`Protected` `Static`getSearchArgs

Parameters

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

Settings

On This Page

Class GirasolCardQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolCardQueryService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

get

Parameters

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

invalidateCache

Parameters

Returns Promise<void>

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[]

Protected StaticgetSearchArgs

Parameters

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

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`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