Class ShortUrlService

Index

Constructors

Properties

db redirectCache

Methods

create delete get resolveRedirect search update

Constructors

constructor

new ShortUrlService(
    __namedParameters: {
        db: B2bDatabase;
        valkeyClient: ValkeyClient | null;
    },
): ShortUrlService
Parameters
- __namedParameters: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns ShortUrlService
- Defined in packages/short-url-services/src/ShortUrlService.ts:35

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`redirectCache

redirectCache: ServiceCache<CachedShortUrlLookup>

Methods

create

create(
    __namedParameters: {
        customerId: string;
        expiresAt?: Date | null;
        name?: string | null;
        url: string;
    },
): Promise<{ ok: true; value: ShortUrl }>
Parameters
- __namedParameters: {
      customerId: string;
      expiresAt?: Date | null;
      name?: string | null;
      url: string;
  }
Returns Promise<{ ok: true; value: ShortUrl }>
- Defined in packages/short-url-services/src/ShortUrlService.ts:46

delete

delete(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in packages/short-url-services/src/ShortUrlService.ts:178

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<ShortUrl | null>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<ShortUrl | null>
- Defined in packages/short-url-services/src/ShortUrlService.ts:74

resolveRedirect

resolveRedirect(__namedParameters: { id: string }): Promise<string | null>
Resolve an unexpired short URL by its public external id. Used by the public redirect Lambda — intentionally not customer-scoped because the external id is globally unique (sqids-encoded primary key).

Cache strategy: cache the row including expiresAt so the expiry check remains precise within the TTL window. Negative-cache null to absorb scanner traffic against nonexistent ids.
Parameters
- __namedParameters: { id: string }
Returns Promise<string | null>
- Defined in packages/short-url-services/src/ShortUrlService.ts:216

search

search(
    __namedParameters: {
        customerId: string;
        expiresAt?: DbTimestampCriteria<Date>;
        ids?: string[];
        page?: number;
        pageSize?: number;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: ShortUrl[]; total: number };
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      expiresAt?: DbTimestampCriteria<Date>;
      ids?: string[];
      page?: number;
      pageSize?: number;
  }
  - customerId: string
  - OptionalexpiresAt?: DbTimestampCriteria<Date>
    
    Filter on the expiry timestamp; { before: "now" } = expired-only. NULL (never-expiring) rows are excluded whenever this criterion is set.
  - Optionalids?: string[]
  - Optionalpage?: number
  - OptionalpageSize?: number
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: ShortUrl[]; total: number };
    },
>
- Defined in packages/short-url-services/src/ShortUrlService.ts:85

update

update(
    __namedParameters: {
        customerId: string;
        data: { expiresAt?: Date | null; name?: string | null; url?: string };
        id: string;
    },
): Promise<
    { error: ServiceError; ok: false }
    | { ok: true; value: ShortUrl },
>
Parameters
- __namedParameters: {
      customerId: string;
      data: { expiresAt?: Date | null; name?: string | null; url?: string };
      id: string;
  }
Returns Promise<{ error: ServiceError; ok: false } | { ok: true; value: ShortUrl }>
- Defined in packages/short-url-services/src/ShortUrlService.ts:134