@stigg/js-client-sdk 2.22.1 → 2.23.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/models.d.ts CHANGED
@@ -374,7 +374,19 @@ export declare type SubscriptionPricePreview = {
374
374
  subTotal: Money;
375
375
  totalExcludingTax: Money;
376
376
  total: Money;
377
- tax: Money;
377
+ tax?: Money;
378
+ discountAmount?: Money;
379
+ taxDetails?: SubscriptionPreviewTaxDetails;
380
+ discount?: SubscriptionPreviewDiscount;
381
+ };
382
+ export declare type RecurringSubscriptionPreview = {
383
+ total: Money;
384
+ subTotal: Money;
385
+ totalExcludingTax: Money;
386
+ tax?: Money;
387
+ discount?: Money;
388
+ taxDetails?: SubscriptionPreviewTaxDetails;
389
+ discountDetails?: SubscriptionPreviewDiscount;
378
390
  };
379
391
  export declare type SubscriptionPreviewDiscount = {
380
392
  type: DiscountType;
@@ -397,6 +409,7 @@ export interface SubscriptionPreview {
397
409
  totalExcludingTax: Money;
398
410
  total: Money;
399
411
  tax?: Money;
412
+ discountAmount?: Money;
400
413
  taxDetails?: SubscriptionPreviewTaxDetails;
401
414
  discount?: SubscriptionPreviewDiscount;
402
415
  billingPeriodRange: DateRange;
@@ -406,6 +419,21 @@ export interface SubscriptionPreview {
406
419
  hasScheduledUpdates?: boolean;
407
420
  credits?: SubscriptionPreviewCredits;
408
421
  }
422
+ export interface SubscriptionPreviewV2 {
423
+ total: Money;
424
+ subTotal: Money;
425
+ totalExcludingTax: Money;
426
+ tax?: Money;
427
+ discount?: Money;
428
+ taxDetails?: SubscriptionPreviewTaxDetails;
429
+ discountDetails?: SubscriptionPreviewDiscount;
430
+ proration?: SubscriptionPreviewProration;
431
+ credits?: SubscriptionPreviewCredits;
432
+ recurringSubscription?: RecurringSubscriptionPreview;
433
+ billingPeriodRange: DateRange;
434
+ isPlanDowngrade?: boolean;
435
+ hasScheduledUpdates?: boolean;
436
+ }
409
437
  export declare type EstimateSubscription = {
410
438
  customerId: string;
411
439
  resourceId?: string;
@@ -1,5 +1,5 @@
1
1
  import { ClientConfiguration } from './configuration';
2
- import { BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Paywall, Subscription, SubscriptionPreview, UsageHistoryPoint, WaitForCheckoutCompleted, ApplySubscription, ApplySubscriptionResults, PreviewSubscription } from './models';
2
+ import { BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, MeteredEntitlement, NumericEntitlement, Paywall, Subscription, SubscriptionPreview, UsageHistoryPoint, WaitForCheckoutCompleted, ApplySubscription, ApplySubscriptionResults, PreviewSubscription, SubscriptionPreviewV2 } from './models';
3
3
  import { EventNames, Events } from './services/eventEmitter';
4
4
  export interface StiggClient {
5
5
  isCustomerLoaded: boolean;
@@ -28,7 +28,7 @@ export interface StiggClient {
28
28
  getCustomerPortal(params?: GetCustomerPortal): Promise<CustomerPortal>;
29
29
  estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>;
30
30
  estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
31
- previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreview>;
31
+ previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>;
32
32
  }
33
33
  export declare class Stigg implements StiggClient {
34
34
  private readonly apiGateway;
@@ -189,7 +189,7 @@ export declare class Stigg implements StiggClient {
189
189
  * @return {Promise<SubscriptionPreview>} Preview of the subscription.
190
190
  * @param {PreviewSubscription} previewSubscription
191
191
  */
192
- previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreview>;
192
+ previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>;
193
193
  /**
194
194
  * Waits for a subscription to be activated after a completed checkout.
195
195
  * This method should be called on page load after the customer is redirected to the success URL.
@@ -374,7 +374,19 @@ export declare type SubscriptionPricePreview = {
374
374
  subTotal: Money;
375
375
  totalExcludingTax: Money;
376
376
  total: Money;
377
- tax: Money;
377
+ tax?: Money;
378
+ discountAmount?: Money;
379
+ taxDetails?: SubscriptionPreviewTaxDetails;
380
+ discount?: SubscriptionPreviewDiscount;
381
+ };
382
+ export declare type RecurringSubscriptionPreview = {
383
+ total: Money;
384
+ subTotal: Money;
385
+ totalExcludingTax: Money;
386
+ tax?: Money;
387
+ discount?: Money;
388
+ taxDetails?: SubscriptionPreviewTaxDetails;
389
+ discountDetails?: SubscriptionPreviewDiscount;
378
390
  };
379
391
  export declare type SubscriptionPreviewDiscount = {
380
392
  type: DiscountType;
@@ -397,6 +409,7 @@ export interface SubscriptionPreview {
397
409
  totalExcludingTax: Money;
398
410
  total: Money;
399
411
  tax?: Money;
412
+ discountAmount?: Money;
400
413
  taxDetails?: SubscriptionPreviewTaxDetails;
401
414
  discount?: SubscriptionPreviewDiscount;
402
415
  billingPeriodRange: DateRange;
@@ -406,6 +419,21 @@ export interface SubscriptionPreview {
406
419
  hasScheduledUpdates?: boolean;
407
420
  credits?: SubscriptionPreviewCredits;
408
421
  }
422
+ export interface SubscriptionPreviewV2 {
423
+ total: Money;
424
+ subTotal: Money;
425
+ totalExcludingTax: Money;
426
+ tax?: Money;
427
+ discount?: Money;
428
+ taxDetails?: SubscriptionPreviewTaxDetails;
429
+ discountDetails?: SubscriptionPreviewDiscount;
430
+ proration?: SubscriptionPreviewProration;
431
+ credits?: SubscriptionPreviewCredits;
432
+ recurringSubscription?: RecurringSubscriptionPreview;
433
+ billingPeriodRange: DateRange;
434
+ isPlanDowngrade?: boolean;
435
+ hasScheduledUpdates?: boolean;
436
+ }
409
437
  export declare type EstimateSubscription = {
410
438
  customerId: string;
411
439
  resourceId?: string;
@@ -1,5 +1,5 @@
1
- import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment } from '@stigg/api-client-js/src/generated/sdk';
2
- import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint } from '../models';
1
+ import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment } from '@stigg/api-client-js/src/generated/sdk';
2
+ import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2 } from '../models';
3
3
  import CachedEntitlement from '../services/cachedEntitlement';
4
4
  import { Decision } from '../services/entitlementDecisionService';
5
5
  export declare class ModelMapper {
@@ -34,8 +34,9 @@ export declare class ModelMapper {
34
34
  mapFallbackNumericEntitlementResult(entitlement: NumericEntitlementFallback, decision: Decision): EntitlementCheckResult;
35
35
  mapEntitlementResult(decision: Decision, entitlement?: CachedEntitlement, requestedUsage?: number): EntitlementCheckResult;
36
36
  mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
37
- mapTaxFields(fragment: SubscriptionPreviewFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
37
+ mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewV2Fragment | SubscriptionPreviewV2Fragment['recurringSubscription']): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
38
38
  mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
39
+ mapSubscriptionPreviewV2(fragment: SubscriptionPreviewV2Fragment): SubscriptionPreviewV2;
39
40
  mapDiscount(discount: NonNullable<SubscriptionPreviewFragment['discount']>): SubscriptionPreviewDiscount;
40
41
  mapMoney(fragment: {
41
42
  amount: number;
@@ -1,5 +1,5 @@
1
- import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment } from '@stigg/api-client-js/src/generated/sdk';
2
- import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint } from '../models';
1
+ import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment } from '@stigg/api-client-js/src/generated/sdk';
2
+ import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2 } from '../models';
3
3
  import CachedEntitlement from '../services/cachedEntitlement';
4
4
  import { Decision } from '../services/entitlementDecisionService';
5
5
  export declare class ModelMapper {
@@ -34,8 +34,9 @@ export declare class ModelMapper {
34
34
  mapFallbackNumericEntitlementResult(entitlement: NumericEntitlementFallback, decision: Decision): EntitlementCheckResult;
35
35
  mapEntitlementResult(decision: Decision, entitlement?: CachedEntitlement, requestedUsage?: number): EntitlementCheckResult;
36
36
  mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
37
- mapTaxFields(fragment: SubscriptionPreviewFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
37
+ mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewV2Fragment | SubscriptionPreviewV2Fragment['recurringSubscription']): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
38
38
  mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
39
+ mapSubscriptionPreviewV2(fragment: SubscriptionPreviewV2Fragment): SubscriptionPreviewV2;
39
40
  mapDiscount(discount: NonNullable<SubscriptionPreviewFragment['discount']>): SubscriptionPreviewDiscount;
40
41
  mapMoney(fragment: {
41
42
  amount: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stigg/js-client-sdk",
3
- "version": "2.22.1",
3
+ "version": "2.23.1",
4
4
  "description": "Stigg client-side SDK for Browser",
5
5
  "main": "dist/index.js",
6
6
  "typings": "dist/index.d.ts",
@@ -28,7 +28,7 @@
28
28
  "dependencies": {
29
29
  "@apollo/client": "^3.4.17",
30
30
  "@sentry/browser": "^7.11.1",
31
- "@stigg/api-client-js": "0.556.0",
31
+ "@stigg/api-client-js": "0.561.1",
32
32
  "cross-fetch": "^3.1.6",
33
33
  "fetch-retry": "^5.0.6",
34
34
  "husky": "^7.0.4",