@carddb/client 0.4.6 → 0.5.0

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, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, Deck, DeckReadState, DeckPublishedVersionSelector, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, 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, DeckTokenIssuerCreateInput, DeckTokenIssuer, DeckAPIApplicationAccessGrantInput, DeckTokenExchangeInput, DeckTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, Ruleset, RulesetVersionStatus, RulesetVersion, DeckValidationRules, RulesetVersionDraftImportFromDatasetRecordInput, RulesetVersionDraftImportPreview, RulesetValidationImpact, RulesetCreateInput, RulesetUpdateInput, RulesetVersionDraftCreateInput, RulesetVersionDraftUpdateInput, RulesetVersionPublishInput, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanUploadSessionInput, ConfirmScanUploadInput, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
+import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, DatasetFilterValueConnection, Deck, DeckReadState, DeckPublishedVersionSelector, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, 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, DeckTokenIssuerCreateInput, DeckTokenIssuer, DeckAPIApplicationAccessGrantInput, DeckTokenExchangeInput, DeckTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, Ruleset, RulesetVersionStatus, RulesetVersion, DeckValidationRules, RulesetVersionDraftImportFromDatasetRecordInput, RulesetVersionDraftImportPreview, RulesetValidationImpact, RulesetCreateInput, RulesetUpdateInput, RulesetVersionDraftCreateInput, RulesetVersionDraftUpdateInput, RulesetVersionPublishInput, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanUploadSessionInput, ConfirmScanUploadInput, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
 export * from '@carddb/core';
 
 /**
@@ -368,6 +368,16 @@ interface GetDatasetByKeyOptions extends GetDatasetOptions {
     /** Stable dataset key */
     datasetKey: string;
 }
+interface DatasetFilterValuesOptions extends GetDatasetOptions {
+    /** Optional case-insensitive search within values */
+    search?: string;
+    /** Include per-value record counts. More expensive than listing values only. */
+    includeCounts?: boolean;
+    /** Maximum number of values per field (default: 50, max: 500) */
+    first?: number;
+    /** Cursor for pagination. Applies to each requested field. */
+    after?: string;
+}
 declare class DatasetsResource extends BaseResource {
     constructor(connection: Connection, config: Configuration);
     /**
@@ -417,6 +427,20 @@ declare class DatasetsResource extends BaseResource {
      * const datasets = await client.datasets.getMany(['id1', 'id2', 'id3'])
      */
     getMany(ids: string[], options?: GetDatasetOptions): Promise<Dataset[]>;
+    /**
+     * Get distinct filter values for one or more filterable fields.
+     *
+     * @example
+     * const values = await client.datasets.filterValues('dataset-id', ['name', 'colors'], {
+     *   includeCounts: true,
+     *   first: 500,
+     * })
+     */
+    filterValues(id: string, fields: string[], options?: DatasetFilterValuesOptions): Promise<DatasetFilterValueConnection[]>;
+    /**
+     * Get distinct filter values for a dataset by publisher/game/dataset keys.
+     */
+    filterValues(publisherSlug: string, gameKey: string, datasetKey: string, fields: string[], options?: DatasetFilterValuesOptions): Promise<DatasetFilterValueConnection[]>;
 }
 
 /**

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, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, Deck, DeckReadState, DeckPublishedVersionSelector, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, 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, DeckTokenIssuerCreateInput, DeckTokenIssuer, DeckAPIApplicationAccessGrantInput, DeckTokenExchangeInput, DeckTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, Ruleset, RulesetVersionStatus, RulesetVersion, DeckValidationRules, RulesetVersionDraftImportFromDatasetRecordInput, RulesetVersionDraftImportPreview, RulesetValidationImpact, RulesetCreateInput, RulesetUpdateInput, RulesetVersionDraftCreateInput, RulesetVersionDraftUpdateInput, RulesetVersionPublishInput, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanUploadSessionInput, ConfirmScanUploadInput, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
+import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, DatasetFilterValueConnection, Deck, DeckReadState, DeckPublishedVersionSelector, ViewerDecksFilterInput, AppDecksFilterInput, PublicDecksFilterInput, DeckVersion, DeckDiff, DeckValidateInput, DeckValidation, DeckHydrateEntriesInput, DeckHydrateEntriesPayload, DeckExportFormat, DeckExportPayload, DeckSectionDefinition, DeckCollaborator, 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, DeckTokenIssuerCreateInput, DeckTokenIssuer, DeckAPIApplicationAccessGrantInput, DeckTokenExchangeInput, DeckTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, Ruleset, RulesetVersionStatus, RulesetVersion, DeckValidationRules, RulesetVersionDraftImportFromDatasetRecordInput, RulesetVersionDraftImportPreview, RulesetValidationImpact, RulesetCreateInput, RulesetUpdateInput, RulesetVersionDraftCreateInput, RulesetVersionDraftUpdateInput, RulesetVersionPublishInput, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanUploadSessionInput, ConfirmScanUploadInput, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
 export * from '@carddb/core';
 
 /**
@@ -368,6 +368,16 @@ interface GetDatasetByKeyOptions extends GetDatasetOptions {
     /** Stable dataset key */
     datasetKey: string;
 }
+interface DatasetFilterValuesOptions extends GetDatasetOptions {
+    /** Optional case-insensitive search within values */
+    search?: string;
+    /** Include per-value record counts. More expensive than listing values only. */
+    includeCounts?: boolean;
+    /** Maximum number of values per field (default: 50, max: 500) */
+    first?: number;
+    /** Cursor for pagination. Applies to each requested field. */
+    after?: string;
+}
 declare class DatasetsResource extends BaseResource {
     constructor(connection: Connection, config: Configuration);
     /**
@@ -417,6 +427,20 @@ declare class DatasetsResource extends BaseResource {
      * const datasets = await client.datasets.getMany(['id1', 'id2', 'id3'])
      */
     getMany(ids: string[], options?: GetDatasetOptions): Promise<Dataset[]>;
+    /**
+     * Get distinct filter values for one or more filterable fields.
+     *
+     * @example
+     * const values = await client.datasets.filterValues('dataset-id', ['name', 'colors'], {
+     *   includeCounts: true,
+     *   first: 500,
+     * })
+     */
+    filterValues(id: string, fields: string[], options?: DatasetFilterValuesOptions): Promise<DatasetFilterValueConnection[]>;
+    /**
+     * Get distinct filter values for a dataset by publisher/game/dataset keys.
+     */
+    filterValues(publisherSlug: string, gameKey: string, datasetKey: string, fields: string[], options?: DatasetFilterValuesOptions): Promise<DatasetFilterValueConnection[]>;
 }
 
 /**

package/dist/index.js

@@ -901,6 +901,36 @@ var DatasetsResource = class extends BaseResource {
       return result["fetchDatasets"] ?? [];
     });
   }
+  async filterValues(idOrPublisherSlug, fieldsOrGameKey, datasetKeyOrFields, fieldsOrOptions, maybeOptions) {
+    let queryParams;
+    let options;
+    if (Array.isArray(fieldsOrGameKey)) {
+      queryParams = { id: idOrPublisherSlug, fields: fieldsOrGameKey };
+      options = datasetKeyOrFields ?? {};
+    } else {
+      queryParams = {
+        publisherSlug: idOrPublisherSlug,
+        gameKey: fieldsOrGameKey,
+        datasetKey: datasetKeyOrFields,
+        fields: fieldsOrOptions
+      };
+      options = maybeOptions ?? {};
+      this.validateAccess(queryParams.publisherSlug, queryParams.gameKey);
+    }
+    const { query, variables } = QueryBuilder.fetchDatasetFilterValues({
+      ...queryParams,
+      search: options.search,
+      includeCounts: options.includeCounts,
+      first: options.first,
+      after: options.after
+    });
+    const key = this.cacheKey("datasets", "filterValues", variables);
+    return this.withCache(key, "datasets", options, async () => {
+      const result = await this.connection.execute(query, variables);
+      const dataset = result["fetchDataset"];
+      return dataset?.filterValues ?? [];
+    });
+  }
 };
 var DecksResource = class extends BaseResource {
   constructor(connection, config) {