@carddb/client 0.1.2 → 0.1.3

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _carddb_core from '@carddb/core';
-import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, Dataset, Deck, DeckCreateInput, DeckUpdateInput, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, APIKeyInfo } 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';
 export * from '@carddb/core';
 
 /**
@@ -331,6 +331,10 @@ interface FetchDeckOptions {
     cache?: boolean;
 }
 type FetchDeckByExternalRefOptions = FetchDeckOptions;
+type FetchDeckBySlugOptions = FetchDeckOptions;
+type ListDeckVersionsOptions = ListDecksOptions;
+type ListDeckCollaboratorsOptions = FetchDeckOptions;
+type ListDeckPreviewTokensOptions = FetchDeckOptions;
 interface HydrateDeckEntriesOptions {
     /** Publisher slug (uses default if configured) */
     publisherSlug?: string;
@@ -351,6 +355,14 @@ declare class DecksResource extends BaseResource {
      * Fetch a hosted deck by CardDB UUID.
      */
     fetch(id: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch one deck owned by the current account or API application.
+     */
+    fetchMine(id: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch a hosted deck by canonical or historical slug.
+     */
+    fetchBySlug(publisherSlug: string, gameKey: string, slug: string, options?: FetchDeckBySlugOptions): Promise<Deck | null>;
     /**
      * Fetch a hosted deck by external reference for the current API application.
      */
@@ -359,6 +371,26 @@ declare class DecksResource extends BaseResource {
      * List decks owned by the current account or API application.
      */
     listMine(options?: ListDecksOptions): Promise<Collection<Deck>>;
+    /**
+     * Fetch one immutable published deck version.
+     */
+    fetchVersion(id: string, options?: FetchDeckOptions): Promise<DeckVersion | null>;
+    /**
+     * List immutable published versions for a deck.
+     */
+    listVersions(deckId: string, options?: ListDeckVersionsOptions): Promise<Collection<DeckVersion>>;
+    /**
+     * Fetch current draft data using a revocable preview token.
+     */
+    preview(token: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * List collaborators for a deck.
+     */
+    listCollaborators(deckId: string, options?: ListDeckCollaboratorsOptions): Promise<DeckCollaborator[]>;
+    /**
+     * List draft preview tokens for a deck.
+     */
+    listPreviewTokens(deckId: string, options?: ListDeckPreviewTokensOptions): Promise<DeckPreviewToken[]>;
     /**
      * Create a hosted deck.
      */
@@ -371,6 +403,26 @@ declare class DecksResource extends BaseResource {
      * Delete a hosted deck.
      */
     delete(id: string): Promise<boolean>;
+    /**
+     * Publish the current draft as an immutable deck version.
+     */
+    publish(id: string, input?: DeckPublishInput): Promise<DeckVersion>;
+    /**
+     * Create or update a deck collaborator.
+     */
+    upsertCollaborator(deckId: string, accountId: string, role: DeckCollaboratorRole): Promise<DeckCollaborator>;
+    /**
+     * Remove a deck collaborator.
+     */
+    removeCollaborator(deckId: string, accountId: string): Promise<boolean>;
+    /**
+     * Create a revocable draft preview token.
+     */
+    createPreviewToken(input: DeckPreviewTokenCreateInput): Promise<DeckPreviewTokenCreatePayload>;
+    /**
+     * Revoke a draft preview token.
+     */
+    revokePreviewToken(id: string): Promise<boolean>;
     /**
      * Hydrate third-party-owned deck entries without storing them in CardDB.
      */
@@ -777,4 +829,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 FetchDeckOptions, GamesResource, type GetDatasetOptions, type GetGameOptions, type GetPublisherOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, 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, 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 };

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, DeckCreateInput, DeckUpdateInput, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, APIKeyInfo } 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';
 export * from '@carddb/core';
 
 /**
@@ -331,6 +331,10 @@ interface FetchDeckOptions {
     cache?: boolean;
 }
 type FetchDeckByExternalRefOptions = FetchDeckOptions;
+type FetchDeckBySlugOptions = FetchDeckOptions;
+type ListDeckVersionsOptions = ListDecksOptions;
+type ListDeckCollaboratorsOptions = FetchDeckOptions;
+type ListDeckPreviewTokensOptions = FetchDeckOptions;
 interface HydrateDeckEntriesOptions {
     /** Publisher slug (uses default if configured) */
     publisherSlug?: string;
@@ -351,6 +355,14 @@ declare class DecksResource extends BaseResource {
      * Fetch a hosted deck by CardDB UUID.
      */
     fetch(id: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch one deck owned by the current account or API application.
+     */
+    fetchMine(id: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * Fetch a hosted deck by canonical or historical slug.
+     */
+    fetchBySlug(publisherSlug: string, gameKey: string, slug: string, options?: FetchDeckBySlugOptions): Promise<Deck | null>;
     /**
      * Fetch a hosted deck by external reference for the current API application.
      */
@@ -359,6 +371,26 @@ declare class DecksResource extends BaseResource {
      * List decks owned by the current account or API application.
      */
     listMine(options?: ListDecksOptions): Promise<Collection<Deck>>;
+    /**
+     * Fetch one immutable published deck version.
+     */
+    fetchVersion(id: string, options?: FetchDeckOptions): Promise<DeckVersion | null>;
+    /**
+     * List immutable published versions for a deck.
+     */
+    listVersions(deckId: string, options?: ListDeckVersionsOptions): Promise<Collection<DeckVersion>>;
+    /**
+     * Fetch current draft data using a revocable preview token.
+     */
+    preview(token: string, options?: FetchDeckOptions): Promise<Deck | null>;
+    /**
+     * List collaborators for a deck.
+     */
+    listCollaborators(deckId: string, options?: ListDeckCollaboratorsOptions): Promise<DeckCollaborator[]>;
+    /**
+     * List draft preview tokens for a deck.
+     */
+    listPreviewTokens(deckId: string, options?: ListDeckPreviewTokensOptions): Promise<DeckPreviewToken[]>;
     /**
      * Create a hosted deck.
      */
@@ -371,6 +403,26 @@ declare class DecksResource extends BaseResource {
      * Delete a hosted deck.
      */
     delete(id: string): Promise<boolean>;
+    /**
+     * Publish the current draft as an immutable deck version.
+     */
+    publish(id: string, input?: DeckPublishInput): Promise<DeckVersion>;
+    /**
+     * Create or update a deck collaborator.
+     */
+    upsertCollaborator(deckId: string, accountId: string, role: DeckCollaboratorRole): Promise<DeckCollaborator>;
+    /**
+     * Remove a deck collaborator.
+     */
+    removeCollaborator(deckId: string, accountId: string): Promise<boolean>;
+    /**
+     * Create a revocable draft preview token.
+     */
+    createPreviewToken(input: DeckPreviewTokenCreateInput): Promise<DeckPreviewTokenCreatePayload>;
+    /**
+     * Revoke a draft preview token.
+     */
+    revokePreviewToken(id: string): Promise<boolean>;
     /**
      * Hydrate third-party-owned deck entries without storing them in CardDB.
      */
@@ -777,4 +829,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 FetchDeckOptions, GamesResource, type GetDatasetOptions, type GetGameOptions, type GetPublisherOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, 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, 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 };

package/dist/index.js

@@ -746,6 +746,28 @@ var DecksResource = class extends BaseResource {
       return result["fetchDeck"] ?? null;
     });
   }
+  /**
+   * Fetch one deck owned by the current account or API application.
+   */
+  async fetchMine(id, options = {}) {
+    const key = this.cacheKey("decks", "fetchMine", { id });
+    return this.withCache(key, "decks", options, async () => {
+      const { query } = QueryBuilder.myDeck();
+      const result = await this.connection.execute(query, { id });
+      return result["myDeck"] ?? null;
+    });
+  }
+  /**
+   * Fetch a hosted deck by canonical or historical slug.
+   */
+  async fetchBySlug(publisherSlug, gameKey, slug, options = {}) {
+    const key = this.cacheKey("decks", "fetchBySlug", { publisherSlug, gameKey, slug });
+    return this.withCache(key, "decks", options, async () => {
+      const { query } = QueryBuilder.fetchDeckBySlug();
+      const result = await this.connection.execute(query, { publisherSlug, gameKey, slug });
+      return result["fetchDeckBySlug"] ?? null;
+    });
+  }
   /**
    * Fetch a hosted deck by external reference for the current API application.
    */
@@ -774,6 +796,68 @@ var DecksResource = class extends BaseResource {
       nextPageLoader: async (cursor) => this.listMine({ ...options, after: cursor })
     });
   }
+  /**
+   * Fetch one immutable published deck version.
+   */
+  async fetchVersion(id, options = {}) {
+    const key = this.cacheKey("decks", "fetchVersion", { id });
+    return this.withCache(key, "decks", options, async () => {
+      const { query } = QueryBuilder.deckVersion();
+      const result = await this.connection.execute(query, { id });
+      return result["deckVersion"] ?? null;
+    });
+  }
+  /**
+   * List immutable published versions for a deck.
+   */
+  async listVersions(deckId, options = {}) {
+    const { query, variables: pageVariables } = QueryBuilder.deckVersions({
+      first: options.first,
+      after: options.after
+    });
+    const variables = { deckId, ...pageVariables };
+    const key = this.cacheKey("decks", "listVersions", variables);
+    const data = await this.withCache(key, "decks", options, async () => {
+      const result = await this.connection.execute(query, variables);
+      return result["deckVersions"];
+    });
+    return new Collection(data, {
+      nextPageLoader: async (cursor) => this.listVersions(deckId, { ...options, after: cursor })
+    });
+  }
+  /**
+   * Fetch current draft data using a revocable preview token.
+   */
+  async preview(token, options = {}) {
+    const key = this.cacheKey("decks", "preview", { token });
+    return this.withCache(key, "decks", options, async () => {
+      const { query } = QueryBuilder.deckPreview();
+      const result = await this.connection.execute(query, { token });
+      return result["deckPreview"] ?? null;
+    });
+  }
+  /**
+   * List collaborators for a deck.
+   */
+  async listCollaborators(deckId, options = {}) {
+    const key = this.cacheKey("decks", "listCollaborators", { deckId });
+    return this.withCache(key, "decks", options, async () => {
+      const { query } = QueryBuilder.deckCollaborators();
+      const result = await this.connection.execute(query, { deckId });
+      return result["deckCollaborators"];
+    });
+  }
+  /**
+   * List draft preview tokens for a deck.
+   */
+  async listPreviewTokens(deckId, options = {}) {
+    const key = this.cacheKey("decks", "listPreviewTokens", { deckId });
+    return this.withCache(key, "decks", options, async () => {
+      const { query } = QueryBuilder.deckPreviewTokens();
+      const result = await this.connection.execute(query, { deckId });
+      return result["deckPreviewTokens"];
+    });
+  }
   /**
    * Create a hosted deck.
    */
@@ -800,6 +884,50 @@ var DecksResource = class extends BaseResource {
     const result = await this.connection.execute(query, { id });
     return Boolean(result["deckDelete"]);
   }
+  /**
+   * Publish the current draft as an immutable deck version.
+   */
+  async publish(id, input = {}) {
+    const { query } = QueryBuilder.publishDeck();
+    const variables = QueryBuilder.deckPublishVariables(id, input);
+    const result = await this.connection.execute(query, variables);
+    return result["deckPublish"];
+  }
+  /**
+   * Create or update a deck collaborator.
+   */
+  async upsertCollaborator(deckId, accountId, role) {
+    const { query } = QueryBuilder.upsertDeckCollaborator();
+    const variables = QueryBuilder.deckCollaboratorVariables(deckId, accountId, role);
+    const result = await this.connection.execute(query, variables);
+    return result["deckCollaboratorUpsert"];
+  }
+  /**
+   * Remove a deck collaborator.
+   */
+  async removeCollaborator(deckId, accountId) {
+    const { query } = QueryBuilder.removeDeckCollaborator();
+    const variables = QueryBuilder.deckCollaboratorVariables(deckId, accountId);
+    const result = await this.connection.execute(query, variables);
+    return Boolean(result["deckCollaboratorRemove"]);
+  }
+  /**
+   * Create a revocable draft preview token.
+   */
+  async createPreviewToken(input) {
+    const { query } = QueryBuilder.createDeckPreviewToken();
+    const variables = QueryBuilder.deckPreviewTokenCreateVariables(input);
+    const result = await this.connection.execute(query, variables);
+    return result["deckPreviewTokenCreate"];
+  }
+  /**
+   * Revoke a draft preview token.
+   */
+  async revokePreviewToken(id) {
+    const { query } = QueryBuilder.revokeDeckPreviewToken();
+    const result = await this.connection.execute(query, { id });
+    return Boolean(result["deckPreviewTokenRevoke"]);
+  }
   /**
    * Hydrate third-party-owned deck entries without storing them in CardDB.
    */
@@ -825,7 +953,11 @@ var DecksResource = class extends BaseResource {
       });
       return result["fetchRecordsByIdentifier"];
     });
-    const recordsByIdentifier = recordsByDeckIdentifier(records, identifiers, options.identifierField);
+    const recordsByIdentifier = recordsByDeckIdentifier(
+      records,
+      identifiers,
+      options.identifierField
+    );
     return options.entries.map((entry) => ({
       ...entry,
       record: recordsByIdentifier.get(entry.identifier) ?? null