@carddb/client 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +37 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +28 -6
- package/dist/index.d.ts +28 -6
- package/dist/index.js +37 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _carddb_core from '@carddb/core';
|
|
2
|
-
import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, 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, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
|
|
2
|
+
import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, 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, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, 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';
|
|
3
3
|
export * from '@carddb/core';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -1386,6 +1386,18 @@ type CreateScanJobOptions = Omit<CreateScanJobInput, 'publisherSlug' | 'gameKey'
|
|
|
1386
1386
|
/** Game key, defaults to client defaultGame */
|
|
1387
1387
|
gameKey?: string;
|
|
1388
1388
|
};
|
|
1389
|
+
type CreateScanUploadSessionOptions = Omit<CreateScanUploadSessionInput, 'publisherSlug' | 'gameKey'> & {
|
|
1390
|
+
/** Publisher slug, defaults to client defaultPublisher */
|
|
1391
|
+
publisherSlug?: string;
|
|
1392
|
+
/** Game key, defaults to client defaultGame */
|
|
1393
|
+
gameKey?: string;
|
|
1394
|
+
};
|
|
1395
|
+
type ConfirmScanUploadOptions = Omit<ConfirmScanUploadInput, 'publisherSlug' | 'gameKey'> & {
|
|
1396
|
+
/** Publisher slug, defaults to client defaultPublisher */
|
|
1397
|
+
publisherSlug?: string;
|
|
1398
|
+
/** Game key, defaults to client defaultGame */
|
|
1399
|
+
gameKey?: string;
|
|
1400
|
+
};
|
|
1389
1401
|
type ScanMetricsOptions = Omit<ScanMetricsInput, 'publisherSlug' | 'gameKey'> & {
|
|
1390
1402
|
/** Publisher slug, defaults to client defaultPublisher */
|
|
1391
1403
|
publisherSlug?: string;
|
|
@@ -1420,6 +1432,14 @@ interface VerifyWebhookSignatureInput {
|
|
|
1420
1432
|
}
|
|
1421
1433
|
declare class ScansResource extends BaseResource {
|
|
1422
1434
|
constructor(connection: Connection, config: Configuration);
|
|
1435
|
+
/**
|
|
1436
|
+
* Create a mobile-safe scan image upload session using a scan-scoped credential.
|
|
1437
|
+
*/
|
|
1438
|
+
createUploadSession(input: CreateScanUploadSessionOptions): Promise<PresignedUpload>;
|
|
1439
|
+
/**
|
|
1440
|
+
* Confirm that a scan image upload completed and return the uploaded file.
|
|
1441
|
+
*/
|
|
1442
|
+
confirmUpload(input: ConfirmScanUploadOptions): Promise<File>;
|
|
1423
1443
|
/**
|
|
1424
1444
|
* Create a scan job for an already uploaded image file.
|
|
1425
1445
|
*/
|
|
@@ -1445,6 +1465,8 @@ declare class ScansResource extends BaseResource {
|
|
|
1445
1465
|
*/
|
|
1446
1466
|
verifyWebhookSignature(input: VerifyWebhookSignatureInput): Promise<boolean>;
|
|
1447
1467
|
private resolveCreateJobInput;
|
|
1468
|
+
private resolveCreateUploadSessionInput;
|
|
1469
|
+
private resolveConfirmUploadInput;
|
|
1448
1470
|
private resolveMetricsInput;
|
|
1449
1471
|
}
|
|
1450
1472
|
|
|
@@ -1634,10 +1656,10 @@ declare class CardDBClient {
|
|
|
1634
1656
|
*
|
|
1635
1657
|
* Format: CardDB-SDK/js/{version} ({runtime}/{runtime_version})
|
|
1636
1658
|
* Examples:
|
|
1637
|
-
* - CardDB-SDK/js/0.1
|
|
1638
|
-
* - CardDB-SDK/js/0.1
|
|
1639
|
-
* - CardDB-SDK/js/0.1
|
|
1640
|
-
* - CardDB-SDK/js/0.1
|
|
1659
|
+
* - CardDB-SDK/js/0.4.1 (node/20.10.0)
|
|
1660
|
+
* - CardDB-SDK/js/0.4.1 (bun/1.0.0)
|
|
1661
|
+
* - CardDB-SDK/js/0.4.1 (chrome/120.0.0.0)
|
|
1662
|
+
* - CardDB-SDK/js/0.4.1 (firefox/121.0)
|
|
1641
1663
|
*/
|
|
1642
1664
|
/**
|
|
1643
1665
|
* Generate the User-Agent string for CardDB SDK
|
|
@@ -1665,4 +1687,4 @@ declare function readCache<T>(cache: Cache, key: string): Promise<T | null>;
|
|
|
1665
1687
|
*/
|
|
1666
1688
|
declare function writeCache<T>(cache: Cache, key: string, value: T, ttl: number): Promise<void>;
|
|
1667
1689
|
|
|
1668
|
-
export { BaseResource, CardDBClient, Configuration, Connection, type CreateScanJobOptions, 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, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetGameRegionsOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GetScanJobOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListScanTemplatesOptions, type ListViewerDecksOptions, type PollScanJobOptions, type PollSignal, type PreviewScanTemplateOptions, PublishersResource, RecordsResource, type ResolveScanTemplateOptions, RulesResource, type SaveScanTemplateOptions, type ScanMetricsOptions, ScanTemplatesResource, ScansResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type UpdateScanTemplateOptions, type UploadFileInput, type VerifyWebhookSignatureInput, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
|
|
1690
|
+
export { BaseResource, CardDBClient, Configuration, type ConfirmScanUploadOptions, Connection, type CreateScanJobOptions, type CreateScanUploadSessionOptions, 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, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetGameRegionsOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GetScanJobOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListScanTemplatesOptions, type ListViewerDecksOptions, type PollScanJobOptions, type PollSignal, type PreviewScanTemplateOptions, PublishersResource, RecordsResource, type ResolveScanTemplateOptions, RulesResource, type SaveScanTemplateOptions, type ScanMetricsOptions, ScanTemplatesResource, ScansResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type UpdateScanTemplateOptions, type UploadFileInput, type VerifyWebhookSignatureInput, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _carddb_core from '@carddb/core';
|
|
2
|
-
import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, 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, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, DatasetImportPreviewInput, DatasetImportPreviewResult, DatasetImportValidateInput, BulkImportResult, DatasetImportRunInput, ImportJob, ImportJobStatus, ImportLogLevel, ImportJobLog, GameImportPreviewInput, GameImportPreview, GameImportRunInput, GameImportJob, DatasetExportInput, ExportJob, ExportJobStatus, File, FileUploadInput, PresignedUpload, UploadPurpose, CreateScanJobInput, ScanJobPayload, ScanJob, SubmitScanFeedbackInput, ScanFeedbackPayload, ScanMetricsInput, ScanMetrics, ResolveScanTemplateInput, ScanTemplateResolution, ScanTemplatesInput, ScanTemplate, SaveScanTemplateInput, ScanTemplatePayload, PreviewScanTemplateInput, ScanTemplatePreview, APIKeyInfo } from '@carddb/core';
|
|
2
|
+
import { Logger, LogLevel, Cache, ResourceType, CardDBConfig, RateLimitInfo, GraphQLErrorInfo, Collection, Publisher, Game, GameCreateInput, GameUpdateInput, GameScanRegion, Dataset, DatasetSchema, 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, DeckSessionTokenExchangeInput, DeckSessionTokenExchangePayload, HydrateDeckEntryInput, HydratedDeckEntry, FilterInput, DatasetRecord, DatasetRecordsUpsertInput, DatasetRecordsUpsertPayload, DatasetRecordsDeleteInput, DatasetRecordDeleteJob, DatasetRecordDeleteJobStatus, 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';
|
|
3
3
|
export * from '@carddb/core';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -1386,6 +1386,18 @@ type CreateScanJobOptions = Omit<CreateScanJobInput, 'publisherSlug' | 'gameKey'
|
|
|
1386
1386
|
/** Game key, defaults to client defaultGame */
|
|
1387
1387
|
gameKey?: string;
|
|
1388
1388
|
};
|
|
1389
|
+
type CreateScanUploadSessionOptions = Omit<CreateScanUploadSessionInput, 'publisherSlug' | 'gameKey'> & {
|
|
1390
|
+
/** Publisher slug, defaults to client defaultPublisher */
|
|
1391
|
+
publisherSlug?: string;
|
|
1392
|
+
/** Game key, defaults to client defaultGame */
|
|
1393
|
+
gameKey?: string;
|
|
1394
|
+
};
|
|
1395
|
+
type ConfirmScanUploadOptions = Omit<ConfirmScanUploadInput, 'publisherSlug' | 'gameKey'> & {
|
|
1396
|
+
/** Publisher slug, defaults to client defaultPublisher */
|
|
1397
|
+
publisherSlug?: string;
|
|
1398
|
+
/** Game key, defaults to client defaultGame */
|
|
1399
|
+
gameKey?: string;
|
|
1400
|
+
};
|
|
1389
1401
|
type ScanMetricsOptions = Omit<ScanMetricsInput, 'publisherSlug' | 'gameKey'> & {
|
|
1390
1402
|
/** Publisher slug, defaults to client defaultPublisher */
|
|
1391
1403
|
publisherSlug?: string;
|
|
@@ -1420,6 +1432,14 @@ interface VerifyWebhookSignatureInput {
|
|
|
1420
1432
|
}
|
|
1421
1433
|
declare class ScansResource extends BaseResource {
|
|
1422
1434
|
constructor(connection: Connection, config: Configuration);
|
|
1435
|
+
/**
|
|
1436
|
+
* Create a mobile-safe scan image upload session using a scan-scoped credential.
|
|
1437
|
+
*/
|
|
1438
|
+
createUploadSession(input: CreateScanUploadSessionOptions): Promise<PresignedUpload>;
|
|
1439
|
+
/**
|
|
1440
|
+
* Confirm that a scan image upload completed and return the uploaded file.
|
|
1441
|
+
*/
|
|
1442
|
+
confirmUpload(input: ConfirmScanUploadOptions): Promise<File>;
|
|
1423
1443
|
/**
|
|
1424
1444
|
* Create a scan job for an already uploaded image file.
|
|
1425
1445
|
*/
|
|
@@ -1445,6 +1465,8 @@ declare class ScansResource extends BaseResource {
|
|
|
1445
1465
|
*/
|
|
1446
1466
|
verifyWebhookSignature(input: VerifyWebhookSignatureInput): Promise<boolean>;
|
|
1447
1467
|
private resolveCreateJobInput;
|
|
1468
|
+
private resolveCreateUploadSessionInput;
|
|
1469
|
+
private resolveConfirmUploadInput;
|
|
1448
1470
|
private resolveMetricsInput;
|
|
1449
1471
|
}
|
|
1450
1472
|
|
|
@@ -1634,10 +1656,10 @@ declare class CardDBClient {
|
|
|
1634
1656
|
*
|
|
1635
1657
|
* Format: CardDB-SDK/js/{version} ({runtime}/{runtime_version})
|
|
1636
1658
|
* Examples:
|
|
1637
|
-
* - CardDB-SDK/js/0.1
|
|
1638
|
-
* - CardDB-SDK/js/0.1
|
|
1639
|
-
* - CardDB-SDK/js/0.1
|
|
1640
|
-
* - CardDB-SDK/js/0.1
|
|
1659
|
+
* - CardDB-SDK/js/0.4.1 (node/20.10.0)
|
|
1660
|
+
* - CardDB-SDK/js/0.4.1 (bun/1.0.0)
|
|
1661
|
+
* - CardDB-SDK/js/0.4.1 (chrome/120.0.0.0)
|
|
1662
|
+
* - CardDB-SDK/js/0.4.1 (firefox/121.0)
|
|
1641
1663
|
*/
|
|
1642
1664
|
/**
|
|
1643
1665
|
* Generate the User-Agent string for CardDB SDK
|
|
@@ -1665,4 +1687,4 @@ declare function readCache<T>(cache: Cache, key: string): Promise<T | null>;
|
|
|
1665
1687
|
*/
|
|
1666
1688
|
declare function writeCache<T>(cache: Cache, key: string, value: T, ttl: number): Promise<void>;
|
|
1667
1689
|
|
|
1668
|
-
export { BaseResource, CardDBClient, Configuration, Connection, type CreateScanJobOptions, 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, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetGameRegionsOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GetScanJobOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListScanTemplatesOptions, type ListViewerDecksOptions, type PollScanJobOptions, type PollSignal, type PreviewScanTemplateOptions, PublishersResource, RecordsResource, type ResolveScanTemplateOptions, RulesResource, type SaveScanTemplateOptions, type ScanMetricsOptions, ScanTemplatesResource, ScansResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type UpdateScanTemplateOptions, type UploadFileInput, type VerifyWebhookSignatureInput, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
|
|
1690
|
+
export { BaseResource, CardDBClient, Configuration, type ConfirmScanUploadOptions, Connection, type CreateScanJobOptions, type CreateScanUploadSessionOptions, 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, ExportsResource, type FetchDeckByExternalRefOptions, type FetchDeckBySlugOptions, type FetchDeckOptions, FilesResource, GamesResource, type GetDatasetByKeyOptions, type GetDatasetOptions, type GetFileOptions, type GetGameByKeyOptions, type GetGameBySlugOptions, type GetGameOptions, type GetGameRegionsOptions, type GetImportFormatByKeyOptions, type GetImportFormatOptions, type GetPublisherOptions, type GetRecordByDatasetIdentifierOptions, type GetRecordByIdentifierOptions, type GetRecordOptions, type GetRecordsByIdentifierOptions, type GetScanJobOptions, type GraphQLResponse, type HydrateDeckEntriesOptions, ImportFormatsResource, ImportsResource, type ListAppDecksOptions, type ListDatasetsOptions, type ListDeckAccessTokenIssuersOptions, type ListDeckApiApplicationAccessesOptions, type ListDeckCollaboratorsOptions, type ListDeckEmbedTokensOptions, type ListDeckImportFormatsOptions, type ListDeckPreviewTokensOptions, type ListDeckVersionsOptions, type ListDecksOptions, type ListExportJobsOptions, type ListFormatsOptions, type ListGameImportJobsOptions, type ListGamesOptions, type ListImportFormatsOptions, type ListImportJobLogsOptions, type ListImportJobsOptions, type ListMyDeckApiApplicationAccessesOptions, type ListPublicDecksOptions, type ListRecordDeleteJobsOptions, type ListRecordsOptions, type ListRuleDatasetsOptions, type ListRulesOptions, type ListScanTemplatesOptions, type ListViewerDecksOptions, type PollScanJobOptions, type PollSignal, type PreviewScanTemplateOptions, PublishersResource, RecordsResource, type ResolveScanTemplateOptions, RulesResource, type SaveScanTemplateOptions, type ScanMetricsOptions, ScanTemplatesResource, ScansResource, type SearchDatasetsOptions, type SearchGamesOptions, type SearchPublishersOptions, type SearchRecordsOptions, type UpdateScanTemplateOptions, type UploadFileInput, type VerifyWebhookSignatureInput, type WaitForExportJobOptions, type WaitForImportJobOptions, type WaitForRecordDeleteJobOptions, cacheKey, getRateLimitInfo, getSDKVersion, getUserAgent, readCache, writeCache };
|
package/dist/index.js
CHANGED
|
@@ -185,7 +185,7 @@ var Configuration = class _Configuration {
|
|
|
185
185
|
};
|
|
186
186
|
|
|
187
187
|
// src/user-agent.ts
|
|
188
|
-
var SDK_VERSION = "0.1
|
|
188
|
+
var SDK_VERSION = "0.4.1";
|
|
189
189
|
function detectRuntime() {
|
|
190
190
|
if (typeof globalThis !== "undefined" && "Bun" in globalThis) {
|
|
191
191
|
const bunVersion = globalThis.Bun && typeof globalThis.Bun === "object" && globalThis.Bun.version;
|
|
@@ -2608,6 +2608,30 @@ var ScansResource = class extends BaseResource {
|
|
|
2608
2608
|
constructor(connection, config) {
|
|
2609
2609
|
super(connection, config);
|
|
2610
2610
|
}
|
|
2611
|
+
/**
|
|
2612
|
+
* Create a mobile-safe scan image upload session using a scan-scoped credential.
|
|
2613
|
+
*/
|
|
2614
|
+
async createUploadSession(input) {
|
|
2615
|
+
const scopedInput = this.resolveCreateUploadSessionInput(input);
|
|
2616
|
+
const { query } = QueryBuilder.createScanUploadSession();
|
|
2617
|
+
const result = await this.connection.execute(
|
|
2618
|
+
query,
|
|
2619
|
+
QueryBuilder.createScanUploadSessionVariables(scopedInput)
|
|
2620
|
+
);
|
|
2621
|
+
return result["createScanUploadSession"];
|
|
2622
|
+
}
|
|
2623
|
+
/**
|
|
2624
|
+
* Confirm that a scan image upload completed and return the uploaded file.
|
|
2625
|
+
*/
|
|
2626
|
+
async confirmUpload(input) {
|
|
2627
|
+
const scopedInput = this.resolveConfirmUploadInput(input);
|
|
2628
|
+
const { query } = QueryBuilder.confirmScanUpload();
|
|
2629
|
+
const result = await this.connection.execute(
|
|
2630
|
+
query,
|
|
2631
|
+
QueryBuilder.confirmScanUploadVariables(scopedInput)
|
|
2632
|
+
);
|
|
2633
|
+
return result["confirmScanUpload"];
|
|
2634
|
+
}
|
|
2611
2635
|
/**
|
|
2612
2636
|
* Create a scan job for an already uploaded image file.
|
|
2613
2637
|
*/
|
|
@@ -2699,6 +2723,18 @@ var ScansResource = class extends BaseResource {
|
|
|
2699
2723
|
this.validateAccess(publisherSlug, gameKey);
|
|
2700
2724
|
return { ...input, publisherSlug, gameKey };
|
|
2701
2725
|
}
|
|
2726
|
+
resolveCreateUploadSessionInput(input) {
|
|
2727
|
+
const publisherSlug = this.resolvePublisher(input.publisherSlug);
|
|
2728
|
+
const gameKey = this.resolveGame(input.gameKey);
|
|
2729
|
+
this.validateAccess(publisherSlug, gameKey);
|
|
2730
|
+
return { ...input, publisherSlug, gameKey };
|
|
2731
|
+
}
|
|
2732
|
+
resolveConfirmUploadInput(input) {
|
|
2733
|
+
const publisherSlug = this.resolvePublisher(input.publisherSlug);
|
|
2734
|
+
const gameKey = this.resolveGame(input.gameKey);
|
|
2735
|
+
this.validateAccess(publisherSlug, gameKey);
|
|
2736
|
+
return { ...input, publisherSlug, gameKey };
|
|
2737
|
+
}
|
|
2702
2738
|
resolveMetricsInput(input) {
|
|
2703
2739
|
const publisherSlug = this.resolvePublisher(input.publisherSlug);
|
|
2704
2740
|
const gameKey = this.resolveGame(input.gameKey);
|