@profplum700/etsy-v3-api-client 2.5.4 → 3.0.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 interface EtsyClientConfig {
     keystring: string;
-    sharedSecret?: string;
+    sharedSecret: string;
     accessToken: string;
     refreshToken: string;
     expiresAt: Date;
@@ -183,6 +183,10 @@ interface EtsyListing {
     occasion?: string;
     style_id?: number[];
     non_taxable?: boolean;
+    is_personalizable?: boolean;
+    personalization_is_required?: boolean;
+    personalization_char_count_max?: number;
+    personalization_instructions?: string;
     is_customizable?: boolean;
     is_digital?: boolean;
     file_data?: string;
@@ -285,6 +289,28 @@ interface ListingParams {
     legacy?: boolean;
 }
 type ListingIncludes = 'Shipping' | 'Images' | 'Shop' | 'User' | 'Translations' | 'Inventory' | 'Videos';
+type EtsyPersonalizationQuestionType = 'text_input' | 'dropdown' | 'unlabeled_upload' | 'labeled_upload';
+interface EtsyPersonalizationOption {
+    option_id?: number | null;
+    label: string;
+}
+interface EtsyPersonalizationQuestion {
+    question_id?: number | null;
+    question_type: EtsyPersonalizationQuestionType;
+    question_text: string;
+    instructions?: string | null;
+    required: boolean;
+    max_allowed_characters?: number | null;
+    max_allowed_files?: number | null;
+    options?: EtsyPersonalizationOption[] | null;
+}
+interface EtsyListingPersonalization {
+    personalization_questions: EtsyPersonalizationQuestion[];
+}
+interface UpdatePersonalizationParams {
+    personalization_questions: EtsyPersonalizationQuestion[];
+    supports_multiple_personalization_questions?: boolean;
+}
 interface SearchParams {
     limit?: number;
     offset?: number;
@@ -402,7 +428,7 @@ interface LoggerInterface {
     warn(_message: string, ..._args: unknown[]): void;
     error(_message: string, ..._args: unknown[]): void;
 }
-declare const ETSY_WHEN_MADE_VALUES: readonly ["1990s", "1980s", "1970s", "1960s", "1950s", "1940s", "1930s", "1920s", "1910s", "1900s", "1800s", "1700s", "before_1700"];
+declare const ETSY_WHEN_MADE_VALUES: readonly ["2020_2026", "2010_2019", "2007_2009", "before_2007", "2000_2006", "1990s", "1980s", "1970s", "1960s", "1950s", "1940s", "1930s", "1920s", "1910s", "1900s", "1800s", "1700s", "before_1700"];
 interface UpdateShopParams {
     title?: string;
     announcement?: string;
@@ -1308,7 +1334,7 @@ declare class EtsyClient {
     private cache?;
     private cacheTtl;
     private keystring;
-    private sharedSecret?;
+    private sharedSecret;
     private bulkOperationManager;
     constructor(config: EtsyClientConfig);
     private makeRequest;
@@ -1412,6 +1438,9 @@ declare class EtsyClient {
     getListingVideos(listingId: string): Promise<EtsyListingVideo[]>;
     getListingVideo(listingId: string, videoId: string): Promise<EtsyListingVideo>;
     deleteListingVideo(shopId: string, listingId: string, videoId: string): Promise<void>;
+    getListingPersonalizations(listingId: string): Promise<EtsyListingPersonalization>;
+    updateListingPersonalization(shopId: string, listingId: string, params: UpdatePersonalizationParams): Promise<EtsyListingPersonalization>;
+    deleteListingPersonalization(shopId: string, listingId: string): Promise<void>;
     createListingTranslation(shopId: string, listingId: string, language: string, params: CreateListingTranslationParams): Promise<EtsyListingTranslation>;
     getListingTranslation(shopId: string, listingId: string, language: string): Promise<EtsyListingTranslation>;
     updateListingTranslation(shopId: string, listingId: string, language: string, params: UpdateListingTranslationParams): Promise<EtsyListingTranslation>;
@@ -1702,7 +1731,7 @@ interface WebhookConfig {
     algorithm?: 'sha256' | 'sha1';
     verifySignatures?: boolean;
 }
-type EtsyWebhookEventType = 'receipt.updated' | 'receipt.created' | 'listing.updated' | 'listing.created' | 'listing.deactivated' | 'shop.updated';
+type EtsyWebhookEventType = 'receipt.updated' | 'receipt.created' | 'listing.updated' | 'listing.created' | 'listing.deactivated' | 'shop.updated' | 'order.shipped' | 'order.delivered' | 'order.paid' | 'order.canceled';
 interface EtsyWebhookEvent {
     type: EtsyWebhookEventType;
     timestamp: number;
@@ -2075,7 +2104,7 @@ declare function createAuthHelper(config: AuthHelperConfig): AuthHelper;
 declare function createTokenManager(config: EtsyClientConfig, storage?: TokenStorage): TokenManager;
 declare function createRateLimiter(config?: Partial<RateLimitConfig>): EtsyRateLimiter;
 
-declare const VERSION = "2.2.0";
+declare const VERSION = "3.0.1";
 declare const LIBRARY_NAME = "etsy-v3-api-client";
 declare function getLibraryInfo(): {
     name: string;
@@ -2087,4 +2116,4 @@ declare function getLibraryInfo(): {
 };
 
 export { AuthHelper, BatchQueryExecutor, BulkOperationManager, COMMON_SCOPE_COMBINATIONS, CacheWithInvalidation, CreateListingSchema, DEFAULT_RETRY_CONFIG, ETSY_RATE_LIMITS, ETSY_SCOPES, EncryptedFileTokenStorage, EtsyApiError, EtsyAuthError, EtsyClient, EtsyRateLimitError, EtsyRateLimiter, EtsyWebhookHandler, FieldValidator, FileTokenStorage, GlobalRequestQueue, LFUCache, LIBRARY_NAME, LRUCache, ListingQueryBuilder, LocalStorageTokenStorage, MemoryTokenStorage, PaginatedResults, PluginManager, ReceiptQueryBuilder, RedisCacheStorage, RetryManager, SecureTokenStorage, SessionStorageTokenStorage, TokenManager, UpdateListingSchema, UpdateShopSchema, VERSION, ValidationException, Validator, WebhookSecurity, combineValidators, createAnalyticsPlugin, createAuthHelper, createBatchQuery, createBulkOperationManager, createCacheStorage, createCacheWithInvalidation, createCachingPlugin, createCodeChallenge, createDefaultTokenStorage, createEtsyClient, createListingQuery, createLoggingPlugin, createPaginatedResults, createRateLimitPlugin, createRateLimiter, createReceiptQuery, createRedisCacheStorage, createRetryPlugin, createTokenManager, createValidator, createWebhookHandler, createWebhookSecurity, decryptAES256GCM, EtsyClient as default, defaultRateLimiter, deriveKeyFromPassword, encryptAES256GCM, executeBulkOperation, field, generateCodeVerifier, generateEncryptionKey, generateRandomBase64Url, generateState, getAvailableStorage, getEnvironmentInfo, getGlobalQueue, getLibraryInfo, hasLocalStorage, hasSessionStorage, isBrowser, isNode, isSecureStorageSupported, sha256, sha256Base64Url, validate, validateEncryptionKey, validateOrThrow, withQueryBuilder, withQueue, withRetry };
-export type { AdvancedCachingConfig, AnalyticsPluginConfig, ApproachingLimitCallback, AuthHelperConfig, BulkImageUploadOperation, BulkOperationConfig, BulkOperationError, BulkOperationResult, BulkOperationSummary, BulkUpdateListingOperation, CacheEntry, CacheStats, CacheStorage, CacheStrategy, CachingPluginConfig, ConsolidateReturnPoliciesParams, CreateDraftListingParams, CreateListingTranslationParams, CreateReadinessStateParams, CreateReceiptShipmentParams, CreateReturnPolicyParams, CreateShippingProfileDestinationParams, CreateShippingProfileParams, CreateShippingProfileUpgradeParams, CreateShopSectionParams, EncryptedData, EncryptedStorageConfig, EtsyApiResponse, EtsyBuyerTaxonomyNode, EtsyBuyerTaxonomyProperty, EtsyBuyerTaxonomyPropertyScale, EtsyBuyerTaxonomyPropertyValue, EtsyClientConfig, EtsyClientWithQueryBuilder, EtsyErrorDetails, EtsyListing, EtsyListingFile, EtsyListingImage, EtsyListingInventory, EtsyListingOffering, EtsyListingProduct, EtsyListingProperty, EtsyListingPropertyScale, EtsyListingPropertyValue, EtsyListingTranslation, EtsyListingVariationImage, EtsyListingVideo, EtsyPagination, EtsyPayment, EtsyPaymentAccountLedgerEntry, EtsyPaymentAdjustment, EtsyPlugin, EtsyRateLimitHeaders, EtsyReview, EtsySellerTaxonomyNode, EtsyShippingCarrier, EtsyShippingCarrierMailClass, EtsyShippingProfile, EtsyShippingProfileDestination, EtsyShippingProfileUpgrade, EtsyShop, EtsyShopHolidayPreference, EtsyShopProcessingProfile, EtsyShopProductionPartner, EtsyShopReceipt, EtsyShopReceiptShipment, EtsyShopReceiptTransaction, EtsyShopRefund, EtsyShopReturnPolicy, EtsyShopSection, EtsyTokenResponse, EtsyTokens, EtsyTransactionVariation, EtsyUser, EtsyUserAddress, EtsyWebhookEvent, EtsyWebhookEventType, FindActiveListingsByShopParams, FindShopsParams, GetFeaturedListingsParams, GetLedgerEntryPaymentsParams, GetListingsByIdsParams, GetListingsByReturnPolicyParams, GetListingsBySectionParams, GetListingsByShopReceiptParams, GetPaymentAccountLedgerEntriesParams, GetReadinessStateParams, GetReviewsParams, GetShopReceiptsParams, GetTransactionsByListingParams, GetTransactionsByShopParams, ListingParams, ListingSortOn, ListingState, LoggerInterface, LoggingPluginConfig, PageFetcher, PaginationOptions, PluginRequestConfig, PluginResponse, QueueOptions, RateLimitConfig, RateLimitErrorType, RateLimitPluginConfig, RateLimitStatus, RedisClientLike, RedisConfig, RequestPriority, RetryConfig, RetryOptions, RetryPluginConfig, SearchParams, SecureTokenStorageConfig, SortOrder, TokenRefreshCallback, TokenRotationCallback, TokenRotationConfig, TokenScopesParams, TokenScopesResponse, TokenStorage, UpdateHolidayPreferencesParams, UpdateListingInventoryParams, UpdateListingParams, UpdateListingPropertyParams, UpdateListingTranslationParams, UpdateReadinessStateParams, UpdateReturnPolicyParams, UpdateShippingProfileDestinationParams, UpdateShippingProfileParams, UpdateShippingProfileUpgradeParams, UpdateShopParams, UpdateShopReceiptParams, UpdateShopSectionParams, UpdateVariationImagesParams, UploadListingFileParams, UploadListingImageParams, ValidationError, ValidationOptions, ValidationResult, ValidationSchema, ValidatorFunction, WebhookConfig, WebhookEventHandler, WebhookSecurityConfig };
+export type { AdvancedCachingConfig, AnalyticsPluginConfig, ApproachingLimitCallback, AuthHelperConfig, BulkImageUploadOperation, BulkOperationConfig, BulkOperationError, BulkOperationResult, BulkOperationSummary, BulkUpdateListingOperation, CacheEntry, CacheStats, CacheStorage, CacheStrategy, CachingPluginConfig, ConsolidateReturnPoliciesParams, CreateDraftListingParams, CreateListingTranslationParams, CreateReadinessStateParams, CreateReceiptShipmentParams, CreateReturnPolicyParams, CreateShippingProfileDestinationParams, CreateShippingProfileParams, CreateShippingProfileUpgradeParams, CreateShopSectionParams, EncryptedData, EncryptedStorageConfig, EtsyApiResponse, EtsyBuyerTaxonomyNode, EtsyBuyerTaxonomyProperty, EtsyBuyerTaxonomyPropertyScale, EtsyBuyerTaxonomyPropertyValue, EtsyClientConfig, EtsyClientWithQueryBuilder, EtsyErrorDetails, EtsyListing, EtsyListingFile, EtsyListingImage, EtsyListingInventory, EtsyListingOffering, EtsyListingPersonalization, EtsyListingProduct, EtsyListingProperty, EtsyListingPropertyScale, EtsyListingPropertyValue, EtsyListingTranslation, EtsyListingVariationImage, EtsyListingVideo, EtsyPagination, EtsyPayment, EtsyPaymentAccountLedgerEntry, EtsyPaymentAdjustment, EtsyPersonalizationOption, EtsyPersonalizationQuestion, EtsyPersonalizationQuestionType, EtsyPlugin, EtsyRateLimitHeaders, EtsyReview, EtsySellerTaxonomyNode, EtsyShippingCarrier, EtsyShippingCarrierMailClass, EtsyShippingProfile, EtsyShippingProfileDestination, EtsyShippingProfileUpgrade, EtsyShop, EtsyShopHolidayPreference, EtsyShopProcessingProfile, EtsyShopProductionPartner, EtsyShopReceipt, EtsyShopReceiptShipment, EtsyShopReceiptTransaction, EtsyShopRefund, EtsyShopReturnPolicy, EtsyShopSection, EtsyTokenResponse, EtsyTokens, EtsyTransactionVariation, EtsyUser, EtsyUserAddress, EtsyWebhookEvent, EtsyWebhookEventType, FindActiveListingsByShopParams, FindShopsParams, GetFeaturedListingsParams, GetLedgerEntryPaymentsParams, GetListingsByIdsParams, GetListingsByReturnPolicyParams, GetListingsBySectionParams, GetListingsByShopReceiptParams, GetPaymentAccountLedgerEntriesParams, GetReadinessStateParams, GetReviewsParams, GetShopReceiptsParams, GetTransactionsByListingParams, GetTransactionsByShopParams, ListingParams, ListingSortOn, ListingState, LoggerInterface, LoggingPluginConfig, PageFetcher, PaginationOptions, PluginRequestConfig, PluginResponse, QueueOptions, RateLimitConfig, RateLimitErrorType, RateLimitPluginConfig, RateLimitStatus, RedisClientLike, RedisConfig, RequestPriority, RetryConfig, RetryOptions, RetryPluginConfig, SearchParams, SecureTokenStorageConfig, SortOrder, TokenRefreshCallback, TokenRotationCallback, TokenRotationConfig, TokenScopesParams, TokenScopesResponse, TokenStorage, UpdateHolidayPreferencesParams, UpdateListingInventoryParams, UpdateListingParams, UpdateListingPropertyParams, UpdateListingTranslationParams, UpdatePersonalizationParams, UpdateReadinessStateParams, UpdateReturnPolicyParams, UpdateShippingProfileDestinationParams, UpdateShippingProfileParams, UpdateShippingProfileUpgradeParams, UpdateShopParams, UpdateShopReceiptParams, UpdateShopSectionParams, UpdateVariationImagesParams, UploadListingFileParams, UploadListingImageParams, ValidationError, ValidationOptions, ValidationResult, ValidationSchema, ValidatorFunction, WebhookConfig, WebhookEventHandler, WebhookSecurityConfig };

package/dist/index.esm.js

@@ -247,6 +247,26 @@ class EtsyRateLimitError extends Error {
         return this.errorType !== 'qpd_exhausted';
     }
 }
+const ETSY_WHEN_MADE_VALUES = [
+    '2020_2026',
+    '2010_2019',
+    '2007_2009',
+    'before_2007',
+    '2000_2006',
+    '1990s',
+    '1980s',
+    '1970s',
+    '1960s',
+    '1950s',
+    '1940s',
+    '1930s',
+    '1920s',
+    '1910s',
+    '1900s',
+    '1800s',
+    '1700s',
+    'before_1700'
+];
 
 const isBrowser$1 = typeof window !== 'undefined' && typeof window.document !== 'undefined';
 const isNode$1 = typeof process !== 'undefined' && !!process.versions?.node;
@@ -1084,10 +1104,10 @@ class FieldValidator {
             const value = data[this.field];
             if (value === undefined || value === null)
                 return null;
-            if (typeof value !== 'number' || Number.isNaN(value)) {
+            if (typeof value !== 'number' || !Number.isFinite(value)) {
                 return {
                     field: this.field,
-                    message: options.message || `${this.field} must be a number`,
+                    message: options.message || `${this.field} must be a finite number`,
                     value
                 };
             }
@@ -1192,28 +1212,10 @@ const CreateListingSchema = new Validator()
     .rule(field('title').string({ min: 1, max: 140, message: 'title must be 1-140 characters' }))
     .rule(field('description').string({ max: 65535, message: 'description must be less than 65535 characters' }))
     .rule(field('price').required())
-    .rule(field('price').number({ min: 0.2, max: 50000, message: 'price must be between 0.20 and 50000.00' }))
+    .rule(field('price').number({ positive: true, message: 'price must be a finite positive number' }))
     .rule(field('who_made').enum(['i_did', 'someone_else', 'collective'], 'who_made must be one of: i_did, someone_else, collective'))
-    .rule(field('when_made').enum([
-    'made_to_order',
-    '2020_2024',
-    '2010_2019',
-    '2005_2009',
-    '2000_2004',
-    '1990s',
-    '1980s',
-    '1970s',
-    '1960s',
-    '1950s',
-    '1940s',
-    '1930s',
-    '1920s',
-    '1910s',
-    '1900s',
-    '1800s',
-    '1700s',
-    'before_1700'
-]))
+    .rule(field('when_made').required())
+    .rule(field('when_made').enum(['made_to_order', ...ETSY_WHEN_MADE_VALUES]))
     .rule(field('taxonomy_id').required())
     .rule(field('taxonomy_id').number({ integer: true, positive: true, message: 'taxonomy_id must be a positive integer' }));
 const UpdateListingSchema = new Validator()
@@ -1342,6 +1344,9 @@ class MemoryCache {
 }
 class EtsyClient {
     constructor(config) {
+        if (!config.sharedSecret) {
+            throw new EtsyAuthError('sharedSecret is REQUIRED for Etsy API v3 application usage. See: https://github.com/profplum700/etsy-v3-api-client/issues/21');
+        }
         this.tokenManager = new TokenManager(config);
         this.baseUrl = config.baseUrl || 'https://api.etsy.com/v3/application';
         this.logger = new DefaultLogger();
@@ -1461,10 +1466,7 @@ class EtsyClient {
         return body;
     }
     getApiKey() {
-        if (this.sharedSecret) {
-            return `${this.keystring}:${this.sharedSecret}`;
-        }
-        return this.keystring;
+        return `${this.keystring}:${this.sharedSecret}`;
     }
     async getUser() {
         return this.makeRequest('/users/me');
@@ -2135,6 +2137,22 @@ class EtsyClient {
     async deleteListingVideo(shopId, listingId, videoId) {
         await this.makeRequest(`/shops/${shopId}/listings/${listingId}/videos/${videoId}`, { method: 'DELETE' }, false);
     }
+    async getListingPersonalizations(listingId) {
+        return this.makeRequest(`/listings/${listingId}/personalization`);
+    }
+    async updateListingPersonalization(shopId, listingId, params) {
+        const { supports_multiple_personalization_questions, ...body } = params;
+        const query = supports_multiple_personalization_questions
+            ? '?supports_multiple_personalization_questions=true'
+            : '';
+        return this.makeRequest(`/shops/${shopId}/listings/${listingId}/personalization${query}`, {
+            method: 'POST',
+            body: JSON.stringify(body)
+        }, false);
+    }
+    async deleteListingPersonalization(shopId, listingId) {
+        await this.makeRequest(`/shops/${shopId}/listings/${listingId}/personalization`, { method: 'DELETE' }, false);
+    }
     async createListingTranslation(shopId, listingId, language, params) {
         const body = this.buildFormBody(params);
         return this.makeRequest(`/shops/${shopId}/listings/${listingId}/translations/${language}`, {
@@ -4282,7 +4300,7 @@ function createTokenManager(config, storage) {
 function createRateLimiter(config) {
     return new EtsyRateLimiter(config);
 }
-const VERSION = '2.2.0';
+const VERSION = '3.0.1';
 const LIBRARY_NAME = 'etsy-v3-api-client';
 function getLibraryInfo() {
     return {