@carddb/client 0.1.4 → 0.2.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _carddb_core from '@carddb/core';
-import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, Dataset, Deck, DeckVersion, DeckCollaborator, DeckPreviewToken, DeckCreateInput, DeckUpdateInput, DeckPublishInput, DeckCollaboratorRole, DeckPreviewTokenCreateInput, DeckPreviewTokenCreatePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, APIKeyInfo } from '@carddb/core';
+import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, Dataset, Deck, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, DeckPreviewToken, DeckEmbedToken, DeckAccessTokenIssuer, DeckAPIApplicationAccess, DeckCreateInput, DeckUpdateInput, DeckUpsertByExternalRefInput, DeckUpsertByExternalRefPayload, DeckClaimInput, DeckOwnershipTransferPayload, DeckTransferOwnershipInput, DeckCopyInput, DeckCopyPayload, DeckEntryAddInput, DeckEntryMutationPayload, DeckEntryUpdateInput, DeckEntryReorderInput, DeckEntryReorderPayload, DeckEntriesReplaceInput, DeckEntriesReplacePayload, DeckImportInput, DeckImportPayload, DeckImportFormatDefinition, DeckImportFormatTestInput, DeckImportFormatTestPayload, DeckImportFormatCreateInput, DeckImportFormatUpdateInput, DeckPublishInput, DeckPublishPayload, DeckRemoveInvalidEntriesInput, DeckCollaboratorRole, DeckPreviewTokenCreateInput, DeckPreviewTokenCreatePayload, DeckEmbedTokenCreateInput, DeckEmbedTokenCreatePayload, DeckAccessTokenIssuerCreateInput, DeckAPIApplicationAccessGrantInput, DeckAccessTokenExchangeInput, DeckAccessTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, APIKeyInfo } from '@carddb/core';
 export * from '@carddb/core';
 
 /**
@@ -16,6 +16,11 @@ declare const DEFAULT_RETRY_BASE_DELAY = 1000;
 declare const DEFAULT_RETRY_MAX_DELAY = 30000;
 declare class Configuration {
     apiKey?: string;
+    publishableKey?: string;
+    secretKey?: string;
+    accessToken?: string;
+    private legacyApiKey?;
+    environment?: 'TEST' | 'LIVE';
     endpoint: string;
     timeout: number;
     openTimeout: number;
@@ -65,6 +70,18 @@ declare class Configuration {
      * Validate both publisher and game access
      */
     validateAccess(publisherSlug?: string, gameKey?: string): void;
+    /**
+     * Secret-key-only helpers are for server runtimes and trusted backend workflows.
+     */
+    requireSecretCredential(operation: string): void;
+    /**
+     * API key sent on requests when no OAuth bearer token is configured.
+     */
+    requestApiKey(): string | undefined;
+    /**
+     * Explicit legacy apiKey supplied by the caller, excluding publishable/secret aliases.
+     */
+    configApiKey(): string | undefined;
     /**
      * Check if a log level should be logged
      */
@@ -323,9 +340,20 @@ interface ListDecksOptions {
     first?: number;
     /** Cursor for pagination */
     after?: string;
+    /** Include archived decks in owner lists */
+    includeArchived?: boolean;
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
+interface ListViewerDecksOptions extends ListDecksOptions {
+    filter?: ViewerDecksFilterInput;
+}
+interface ListAppDecksOptions extends ListDecksOptions {
+    filter?: AppDecksFilterInput;
+}
+interface ListPublicDecksOptions extends Omit<ListDecksOptions, 'includeArchived'> {
+    filter?: PublicDecksFilterInput;
+}
 interface FetchDeckOptions {
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
@@ -335,6 +363,22 @@ type FetchDeckBySlugOptions = FetchDeckOptions;
 type ListDeckVersionsOptions = ListDecksOptions;
 type ListDeckCollaboratorsOptions = FetchDeckOptions;
 type ListDeckPreviewTokensOptions = FetchDeckOptions;
+type ListDeckEmbedTokensOptions = FetchDeckOptions;
+type ListDeckAccessTokenIssuersOptions = FetchDeckOptions;
+interface ListDeckApiApplicationAccessesOptions extends FetchDeckOptions {
+    includeRevoked?: boolean;
+}
+interface ListMyDeckApiApplicationAccessesOptions extends FetchDeckOptions {
+    applicationId?: string;
+}
+type ListDeckImportFormatsOptions = ListDecksOptions;
+interface DeckSectionDefinitionsOptions extends FetchDeckOptions {
+    publisherSlug?: string;
+    gameKey?: string;
+    gameId?: string;
+    rulesetKey?: string;
+    rulesetVersionId?: string;
+}
 interface HydrateDeckEntriesOptions {
     /** Publisher slug (uses default if configured) */
     publisherSlug?: string;
@@ -355,6 +399,10 @@ declare class DecksResource extends BaseResource {
      * Fetch a hosted deck by CardDB UUID.
      */
     fetch(id: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch a deck by UUID using the ownership-aware `deck` API.
+     */
+    get(id: string, options?: FetchDeckOptions): Promise<Deck | null>;
     /**
      * Fetch one deck owned by the current account or API application.
      */
@@ -363,14 +411,34 @@ declare class DecksResource extends BaseResource {
      * Fetch a hosted deck by canonical or historical slug.
      */
     fetchBySlug(publisherSlug: string, gameKey: string, slug: string, options?: FetchDeckBySlugOptions): Promise<Deck | null>;
+    /**
+     * Fetch by slug using the ownership-aware `deckBySlug` API.
+     */
+    getBySlug(publisherSlug: string, gameKey: string, slug: string, options?: FetchDeckBySlugOptions): Promise<Deck | null>;
     /**
      * Fetch a hosted deck by external reference for the current API application.
      */
     fetchByExternalRef(externalRef: string, options?: FetchDeckByExternalRefOptions): Promise<Deck | null>;
+    /**
+     * Fetch by external reference using the ownership-aware `deckByExternalRef` API.
+     */
+    getByExternalRef(externalRef: string, options?: FetchDeckByExternalRefOptions): Promise<Deck | null>;
     /**
      * List decks owned by the current account or API application.
      */
     listMine(options?: ListDecksOptions): Promise<Collection<Deck>>;
+    /**
+     * List decks owned by the current account or OAuth grant.
+     */
+    listViewer(options?: ListViewerDecksOptions): Promise<Collection<Deck>>;
+    /**
+     * List app-owned decks for the current secret-key API application.
+     */
+    listApp(options?: ListAppDecksOptions): Promise<Collection<Deck>>;
+    /**
+     * List published live decks eligible for public discovery.
+     */
+    listPublic(options?: ListPublicDecksOptions): Promise<Collection<Deck>>;
     /**
      * Fetch one immutable published deck version.
      */
@@ -383,6 +451,38 @@ declare class DecksResource extends BaseResource {
      * Fetch current draft data using a revocable preview token.
      */
     preview(token: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch published embed data using a revocable embed token.
+     */
+    embed(token: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch token-authorized published data using an exchanged access token.
+     */
+    access(token: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Compare the current draft against the latest published version.
+     */
+    draftDiff(id: string, options?: FetchDeckOptions): Promise<DeckDiff>;
+    /**
+     * Compare any two readable immutable deck versions from the same deck.
+     */
+    versionDiff(fromVersionId: string, toVersionId: string, options?: FetchDeckOptions): Promise<DeckDiff>;
+    /**
+     * Validate a draft against current or explicitly requested immutable rules/data.
+     */
+    validate(id: string, input?: DeckValidateInput, options?: FetchDeckOptions): Promise<DeckValidation>;
+    /**
+     * Hydrate unpersisted deck entries against a stored deck's game without mutating the deck.
+     */
+    hydrateDeckEntries(input: DeckHydrateEntriesInput, options?: FetchDeckOptions): Promise<DeckHydrateEntriesPayload>;
+    /**
+     * Export a readable deck representation in a deterministic text format.
+     */
+    exportDeck(id: string, format?: DeckExportFormat, options?: FetchDeckOptions): Promise<DeckExportPayload>;
+    /**
+     * Resolve current or historical ruleset section definitions.
+     */
+    sectionDefinitions(options?: DeckSectionDefinitionsOptions): Promise<DeckSectionDefinition[]>;
     /**
      * List collaborators for a deck.
      */
@@ -391,6 +491,22 @@ declare class DecksResource extends BaseResource {
      * List draft preview tokens for a deck.
      */
     listPreviewTokens(deckId: string, options?: ListDeckPreviewTokensOptions): Promise<DeckPreviewToken[]>;
+    /**
+     * List published embed tokens for a deck.
+     */
+    listEmbedTokens(deckId: string, options?: ListDeckEmbedTokensOptions): Promise<DeckEmbedToken[]>;
+    /**
+     * List trusted access token issuers for a deck.
+     */
+    listAccessTokenIssuers(deckId: string, options?: ListDeckAccessTokenIssuersOptions): Promise<DeckAccessTokenIssuer[]>;
+    /**
+     * List API applications with explicit access to one owned deck.
+     */
+    listApiApplicationAccesses(deckId: string, options?: ListDeckApiApplicationAccessesOptions): Promise<DeckAPIApplicationAccess[]>;
+    /**
+     * List selected-deck grants for the current account.
+     */
+    listMyApiApplicationAccesses(options?: ListMyDeckApiApplicationAccessesOptions): Promise<DeckAPIApplicationAccess[]>;
     /**
      * Create a hosted deck.
      */
@@ -399,14 +515,102 @@ declare class DecksResource extends BaseResource {
      * Update a hosted deck.
      */
     update(id: string, input: DeckUpdateInput): Promise<Deck>;
+    /**
+     * Update deck-level metadata without mutating entries.
+     */
+    updateMetadata(id: string, input: DeckUpdateInput): Promise<Deck>;
+    /**
+     * Create or replace a draft by API-application external reference.
+     */
+    upsertByExternalRef(input: DeckUpsertByExternalRefInput): Promise<DeckUpsertByExternalRefPayload>;
+    /**
+     * Claim an app-owned deck into the consenting OAuth user's account.
+     */
+    claim(id: string, input: DeckClaimInput): Promise<DeckOwnershipTransferPayload>;
+    /**
+     * Transfer a deck to another account.
+     */
+    transferOwnership(id: string, input: DeckTransferOwnershipInput): Promise<DeckOwnershipTransferPayload>;
+    /**
+     * Copy a deck into the current principal's ownership namespace.
+     */
+    copy(id: string, input: DeckCopyInput): Promise<DeckCopyPayload>;
+    /**
+     * Add one entry to a deck draft.
+     */
+    addEntry(input: DeckEntryAddInput): Promise<DeckEntryMutationPayload>;
+    /**
+     * Update one stable deck entry.
+     */
+    updateEntry(id: string, input: DeckEntryUpdateInput): Promise<DeckEntryMutationPayload>;
+    /**
+     * Remove one stable deck entry.
+     */
+    removeEntry(id: string, expectedDraftRevision: number): Promise<DeckEntryMutationPayload>;
+    /**
+     * Reorder deck entries within or across sections.
+     */
+    reorderEntries(deckId: string, input: DeckEntryReorderInput): Promise<DeckEntryReorderPayload>;
+    /**
+     * Explicitly replace all deck entries for import or repair flows.
+     */
+    replaceEntries(deckId: string, input: DeckEntriesReplaceInput): Promise<DeckEntriesReplacePayload>;
+    /**
+     * Import a decklist into an existing deck or dry-run resolution.
+     */
+    importDeck(input: DeckImportInput): Promise<DeckImportPayload>;
+    /**
+     * List publisher-managed configured import formats for a game.
+     */
+    listImportFormats(gameId: string, options?: ListDeckImportFormatsOptions): Promise<Collection<DeckImportFormatDefinition>>;
+    /**
+     * Fetch one configured import format by UUID.
+     */
+    fetchImportFormat(id: string, options?: FetchDeckOptions): Promise<DeckImportFormatDefinition | null>;
+    /**
+     * Preview configured import-format parsing and record resolution.
+     */
+    testImportFormat(input: DeckImportFormatTestInput): Promise<DeckImportFormatTestPayload>;
+    /**
+     * Create a publisher-managed configured import format.
+     */
+    createImportFormat(input: DeckImportFormatCreateInput): Promise<DeckImportFormatDefinition>;
+    /**
+     * Update a publisher-managed configured import format.
+     */
+    updateImportFormat(id: string, input: DeckImportFormatUpdateInput): Promise<DeckImportFormatDefinition>;
+    /**
+     * Archive a configured import format.
+     */
+    archiveImportFormat(id: string): Promise<DeckImportFormatDefinition>;
+    /**
+     * Restore an archived configured import format.
+     */
+    unarchiveImportFormat(id: string): Promise<DeckImportFormatDefinition>;
     /**
      * Delete a hosted deck.
      */
     delete(id: string): Promise<boolean>;
+    /**
+     * Recoverably hide a deck from normal owner and public lists.
+     */
+    archive(id: string): Promise<Deck>;
+    /**
+     * Restore an archived deck to draft or published state.
+     */
+    restore(id: string): Promise<Deck>;
+    /**
+     * Remove the current public published pointer while keeping version history.
+     */
+    unpublish(id: string): Promise<Deck>;
     /**
      * Publish the current draft as an immutable deck version.
      */
-    publish(id: string, input?: DeckPublishInput): Promise<DeckVersion>;
+    publish(id: string, input: DeckPublishInput): Promise<DeckPublishPayload>;
+    /**
+     * Remove draft entries that fail card-reference validation.
+     */
+    removeInvalidEntries(id: string, input: DeckRemoveInvalidEntriesInput): Promise<Deck>;
     /**
      * Create or update a deck collaborator.
      */
@@ -423,6 +627,42 @@ declare class DecksResource extends BaseResource {
      * Revoke a draft preview token.
      */
     revokePreviewToken(id: string): Promise<boolean>;
+    /**
+     * Create a revocable published embed token.
+     */
+    createEmbedToken(input: DeckEmbedTokenCreateInput): Promise<DeckEmbedTokenCreatePayload>;
+    /**
+     * Revoke a published embed token.
+     */
+    revokeEmbedToken(id: string): Promise<boolean>;
+    /**
+     * Trust the current API application to exchange short-lived deck access tokens.
+     */
+    createAccessTokenIssuer(input: DeckAccessTokenIssuerCreateInput): Promise<DeckAccessTokenIssuer>;
+    /**
+     * Revoke a trusted deck access token issuer.
+     */
+    revokeAccessTokenIssuer(id: string): Promise<boolean>;
+    /**
+     * Revoke only the direct signing key for a trusted deck access token issuer.
+     */
+    revokeAccessTokenIssuerSigningKey(id: string): Promise<DeckAccessTokenIssuer>;
+    /**
+     * Grant or update one OAuth app's selected-deck access.
+     */
+    grantApiApplicationAccess(input: DeckAPIApplicationAccessGrantInput): Promise<DeckAPIApplicationAccess>;
+    /**
+     * Revoke one OAuth app's selected-deck access.
+     */
+    revokeApiApplicationAccess(deckId: string, apiApplicationId: string): Promise<boolean>;
+    /**
+     * Exchange the current trusted API application credential for a deck access token.
+     */
+    exchangeAccessToken(input: DeckAccessTokenExchangeInput): Promise<DeckAccessTokenExchangePayload>;
+    /**
+     * Revoke an exchanged deck access token.
+     */
+    revokeAccessToken(id: string): Promise<boolean>;
     /**
      * Hydrate third-party-owned deck entries without storing them in CardDB.
      */
@@ -474,10 +714,14 @@ interface SearchRecordsOptions {
     after?: string;
     /** Whether to validate filter against schema (default: true) */
     validateSchema?: boolean;
+    /** Include live TCGPlayer pricing when configured for the dataset */
+    includePricing?: boolean;
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
 interface GetRecordOptions {
+    /** Include live TCGPlayer pricing when configured for the dataset */
+    includePricing?: boolean;
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
@@ -490,6 +734,8 @@ interface GetRecordByIdentifierOptions {
     datasetKey: string;
     /** The identifier value to look up */
     identifier: string;
+    /** Include live TCGPlayer pricing when configured for the dataset */
+    includePricing?: boolean;
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
@@ -502,6 +748,8 @@ interface GetRecordsByIdentifierOptions {
     datasetKey: string;
     /** Identifier values to look up */
     identifiers: string[];
+    /** Include live TCGPlayer pricing when configured for the dataset */
+    includePricing?: boolean;
     /** Whether to use cache (defaults to client config) */
     cache?: boolean;
 }
@@ -829,4 +1077,4 @@ declare function readCache<T>(cache: Cache, key: string): Promise<T | null>;
  */
 declare function writeCache<T>(cache: Cache, key: string, value: T, ttl: number): Promise<void>;
 
-export { BaseResource, CardDBClient, Configuration, Connection, DEFAULT_CACHE_TTL, DEFAULT_ENDPOINT, DEFAULT_MAX_NETWORK_RETRIES, DEFAULT_MAX_RETRIES, DEFAULT_OPEN_TIMEOUT, DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_DELAY, DEFAULT_TIMEOUT, DatasetsResource, DecksResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, GamesResource, type GetDatasetOptions, type GetGameOptions, type GetPublisherOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, type ListDeckCollaboratorsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListFormatsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, PublishersResource, RecordsResource, RulesResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
+export { BaseResource, CardDBClient, Configuration, Connection, DEFAULT_CACHE_TTL, DEFAULT_ENDPOINT, DEFAULT_MAX_NETWORK_RETRIES, DEFAULT_MAX_RETRIES, DEFAULT_OPEN_TIMEOUT, DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_DELAY, DEFAULT_TIMEOUT, DatasetsResource, type DeckSectionDefinitionsOptions, DecksResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, GamesResource, type GetDatasetOptions, type GetGameOptions, type GetPublisherOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, type ListAppDecksOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListFormatsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListViewerDecksOptions, PublishersResource, RecordsResource, RulesResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };