@stigg/js-client-sdk 3.45.0 → 3.46.0

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
@@ -22,6 +22,10 @@ export declare type BaseEntitlement = {
22
22
  };
23
23
  export interface BooleanEntitlement extends BaseEntitlement {
24
24
  }
25
+ export interface EnumEntitlement extends BaseEntitlement {
26
+ enumValues: string[];
27
+ requestedValues?: string[];
28
+ }
25
29
  export interface NumericEntitlement extends BaseEntitlement {
26
30
  value?: number;
27
31
  isUnlimited: boolean;
@@ -55,6 +59,8 @@ export declare const BOOLEAN_DEFAULT_FALLBACK_ENTITLEMENT: BooleanEntitlement;
55
59
  export declare const NUMERIC_DEFAULT_FALLBACK_ENTITLEMENT: NumericEntitlement;
56
60
  /** @internal */
57
61
  export declare const METERED_DEFAULT_FALLBACK_ENTITLEMENT: MeteredEntitlement;
62
+ /** @internal */
63
+ export declare const ENUM_DEFAULT_FALLBACK_ENTITLEMENT: EnumEntitlement;
58
64
  export declare type PackageEntitlement = {
59
65
  usageLimit: number;
60
66
  feature?: EntitlementFeature;
@@ -155,6 +161,11 @@ export declare type GetMeteredEntitlement = {
155
161
  options?: MeteredEntitlementOptions;
156
162
  resourceId?: string;
157
163
  };
164
+ export declare type GetEnumEntitlement = {
165
+ featureId: string;
166
+ resourceId?: string;
167
+ options?: EnumEntitlementOptions;
168
+ };
158
169
  export declare type PaginatedResult<T> = {
159
170
  data: T[];
160
171
  pageInfo: PageInfoFragment;
@@ -225,7 +236,7 @@ export declare type ApplySubscriptionResults = {
225
236
  subscription?: Subscription;
226
237
  };
227
238
  export declare type EntitlementsFallback = {
228
- [featureId: string]: BooleanEntitlementFallback | NumericEntitlementFallback | MeteredEntitlementFallback;
239
+ [featureId: string]: BooleanEntitlementFallback | NumericEntitlementFallback | MeteredEntitlementFallback | EnumEntitlementFallback;
229
240
  };
230
241
  export declare type BooleanEntitlementFallback = {
231
242
  hasAccess: boolean;
@@ -248,6 +259,15 @@ export declare type MeteredEntitlementFallback = {
248
259
  usageLimit?: number;
249
260
  isUnlimited?: boolean;
250
261
  };
262
+ export declare type EnumEntitlementFallback = {
263
+ hasAccess: boolean;
264
+ enumValues?: string[];
265
+ };
266
+ export declare type EnumEntitlementOptions = {
267
+ requestedValues?: string[];
268
+ shouldTrack?: boolean;
269
+ fallback?: EnumEntitlementFallback;
270
+ };
251
271
  export declare type MeteredEntitlementOptions = {
252
272
  requestedUsage?: number;
253
273
  shouldTrack?: boolean;
@@ -1,9 +1,10 @@
1
1
  import { Stigg, StiggClient } from './clients';
2
- import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
2
+ import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EnumEntitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetEnumEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
3
3
  export declare class OfflineStigg extends Stigg {
4
4
  getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
5
5
  getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
6
6
  getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
7
+ getEnumEntitlement({ featureId, options }: GetEnumEntitlement): EnumEntitlement;
7
8
  getEntitlements(): Promise<Entitlement[]>;
8
9
  addListener(): void;
9
10
  clearCustomer(): void;
@@ -6,6 +6,7 @@ export interface CalculatedEntitlement {
6
6
  hasSoftLimit: boolean;
7
7
  feature?: EntitlementFeature;
8
8
  accessDeniedReason?: AccessDeniedReason;
9
+ enumValues?: string[];
9
10
  }
10
11
  export interface EntitlementUsage {
11
12
  currentUsage: number;
@@ -7,5 +7,5 @@ export declare class EntitlementCheckReportingService {
7
7
  private readonly loggerService;
8
8
  private readonly resourceId?;
9
9
  constructor(entitlementsApi: EntitlementsApi, customerId: string, loggerService: LoggerService, resourceId?: string | undefined);
10
- reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number): void;
10
+ reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number, requestedValues?: string[]): void;
11
11
  }
@@ -1,7 +1,7 @@
1
1
  import CachedEntitlement from './cachedEntitlement';
2
2
  import { AccessDeniedReason } from '../models';
3
3
  export declare class EntitlementDecisionService {
4
- static decideEntitlementPolicy(entitlement?: CachedEntitlement | null, requestUsage?: number): Decision;
4
+ static decideEntitlementPolicy(entitlement?: CachedEntitlement | null, requestUsage?: number, requestedValues?: string[]): Decision;
5
5
  }
6
6
  export interface Decision {
7
7
  readonly hasAccess: boolean;
@@ -1,6 +1,6 @@
1
1
  import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
2
2
  import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
3
- import { BooleanEntitlement, BooleanEntitlementOptions, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, NumericEntitlementOptions } from '../models';
3
+ import { BooleanEntitlement, BooleanEntitlementOptions, EnumEntitlement, EnumEntitlementOptions, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, NumericEntitlementOptions } from '../models';
4
4
  import CachedEntitlement from './cachedEntitlement';
5
5
  import { CacheService } from './cacheService';
6
6
  import { LoggerService } from './loggerService';
@@ -22,6 +22,7 @@ export declare class EntitlementsService {
22
22
  getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, options?: NumericEntitlementOptions): NumericEntitlement;
23
23
  getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, options?: MeteredEntitlementOptions): MeteredEntitlement;
24
24
  private handleUsagePeriodOver;
25
+ getEnumEntitlement(featureId: string, fallbackEntitlement: EnumEntitlement, options?: EnumEntitlementOptions): EnumEntitlement;
25
26
  private tryTrackEntitlementCheck;
26
27
  loadEntitlements(skipEdge?: boolean): Promise<void>;
27
28
  private loadEntitlementsFromRemote;
@@ -6,6 +6,6 @@ declare class EntitlementsApi {
6
6
  private readonly edgeApiClient;
7
7
  constructor(client: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null);
8
8
  getEntitlements(customerId: string, skipEdge?: boolean, resourceId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetEntitlementsQuery>>;
9
- reportEntitlementRequested(featureId: string, customerId: string, entitlementCheckResult: EntitlementCheckResult, resourceId?: string, requestedUsage?: number): Promise<void>;
9
+ reportEntitlementRequested(featureId: string, customerId: string, entitlementCheckResult: EntitlementCheckResult, resourceId?: string, requestedUsage?: number, requestedValues?: string[]): Promise<void>;
10
10
  }
11
11
  export default EntitlementsApi;
@@ -1,6 +1,6 @@
1
1
  import { SlimSubscriptionFragmentV2Fragment, SubscriptionInvoicePreviewFragment, UsageHistoryV2Fragment, UsageHistoryV2Input } from '@stigg/api-client-js/src/generated/sdk';
2
2
  import { ClientConfiguration } from './configuration';
3
- import { ApplySubscription, ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, GetSubscription, MeteredEntitlement, NumericEntitlement, Paywall, PreviewSubscription, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, WaitForCheckoutCompleted, PreviewNextInvoice, GetSubscriptionsParams, GetSubscriptionsResult } from './models';
3
+ import { ApplySubscription, ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EstimateSubscription, EstimateSubscriptionUpdate, FetchUsageHistory, GetActiveSubscriptions, GetBooleanEntitlement, GetCheckoutStateResults, GetCheckoutState, GetCustomerPortal, GetMeteredEntitlement, GetNumericEntitlement, GetPaywall, GetSubscription, MeteredEntitlement, NumericEntitlement, Paywall, PreviewSubscription, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, WaitForCheckoutCompleted, PreviewNextInvoice, GetSubscriptionsParams, GetSubscriptionsResult, EnumEntitlement, GetEnumEntitlement } from './models';
4
4
  import { EventNames, Events } from './services/eventEmitter';
5
5
  import { LoggerService } from './services/loggerService';
6
6
  export interface StiggClient {
@@ -10,6 +10,7 @@ export interface StiggClient {
10
10
  getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement;
11
11
  getNumericEntitlement: (params: GetNumericEntitlement) => NumericEntitlement;
12
12
  getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement;
13
+ getEnumEntitlement: (params: GetEnumEntitlement) => EnumEntitlement;
13
14
  fetchUsageHistory: (params: FetchUsageHistory) => Promise<UsageHistoryPoint[] | undefined>;
14
15
  setCustomerId: (customerId: string, customerToken?: string | null, resourceId?: string | null) => Promise<void>;
15
16
  clearCustomer: () => void;
@@ -130,6 +131,15 @@ export declare class Stigg implements StiggClient {
130
131
  * @return {MeteredEntitlement} metered entitlement
131
132
  */
132
133
  getMeteredEntitlement({ featureId, options, resourceId }: GetMeteredEntitlement): MeteredEntitlement;
134
+ /**
135
+ * Get enum entitlement of feature for a customer
136
+ *
137
+ * @param {string} featureId
138
+ * @param {string} resourceId
139
+ * @param {EnumEntitlementOptions} options
140
+ * @return {EnumEntitlement} enum entitlement
141
+ */
142
+ getEnumEntitlement({ featureId, options, resourceId }: GetEnumEntitlement): EnumEntitlement;
133
143
  /**
134
144
  * Get paywall data for rendering the paywall
135
145
  * @deprecated *Optional* `productId` is now deprecated and will be changed to a *required* field soon.
@@ -22,6 +22,10 @@ export declare type BaseEntitlement = {
22
22
  };
23
23
  export interface BooleanEntitlement extends BaseEntitlement {
24
24
  }
25
+ export interface EnumEntitlement extends BaseEntitlement {
26
+ enumValues: string[];
27
+ requestedValues?: string[];
28
+ }
25
29
  export interface NumericEntitlement extends BaseEntitlement {
26
30
  value?: number;
27
31
  isUnlimited: boolean;
@@ -55,6 +59,8 @@ export declare const BOOLEAN_DEFAULT_FALLBACK_ENTITLEMENT: BooleanEntitlement;
55
59
  export declare const NUMERIC_DEFAULT_FALLBACK_ENTITLEMENT: NumericEntitlement;
56
60
  /** @internal */
57
61
  export declare const METERED_DEFAULT_FALLBACK_ENTITLEMENT: MeteredEntitlement;
62
+ /** @internal */
63
+ export declare const ENUM_DEFAULT_FALLBACK_ENTITLEMENT: EnumEntitlement;
58
64
  export declare type PackageEntitlement = {
59
65
  usageLimit: number;
60
66
  feature?: EntitlementFeature;
@@ -155,6 +161,11 @@ export declare type GetMeteredEntitlement = {
155
161
  options?: MeteredEntitlementOptions;
156
162
  resourceId?: string;
157
163
  };
164
+ export declare type GetEnumEntitlement = {
165
+ featureId: string;
166
+ resourceId?: string;
167
+ options?: EnumEntitlementOptions;
168
+ };
158
169
  export declare type PaginatedResult<T> = {
159
170
  data: T[];
160
171
  pageInfo: PageInfoFragment;
@@ -225,7 +236,7 @@ export declare type ApplySubscriptionResults = {
225
236
  subscription?: Subscription;
226
237
  };
227
238
  export declare type EntitlementsFallback = {
228
- [featureId: string]: BooleanEntitlementFallback | NumericEntitlementFallback | MeteredEntitlementFallback;
239
+ [featureId: string]: BooleanEntitlementFallback | NumericEntitlementFallback | MeteredEntitlementFallback | EnumEntitlementFallback;
229
240
  };
230
241
  export declare type BooleanEntitlementFallback = {
231
242
  hasAccess: boolean;
@@ -248,6 +259,15 @@ export declare type MeteredEntitlementFallback = {
248
259
  usageLimit?: number;
249
260
  isUnlimited?: boolean;
250
261
  };
262
+ export declare type EnumEntitlementFallback = {
263
+ hasAccess: boolean;
264
+ enumValues?: string[];
265
+ };
266
+ export declare type EnumEntitlementOptions = {
267
+ requestedValues?: string[];
268
+ shouldTrack?: boolean;
269
+ fallback?: EnumEntitlementFallback;
270
+ };
251
271
  export declare type MeteredEntitlementOptions = {
252
272
  requestedUsage?: number;
253
273
  shouldTrack?: boolean;
@@ -1,9 +1,10 @@
1
1
  import { Stigg, StiggClient } from './clients';
2
- import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
2
+ import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, EnumEntitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetEnumEntitlement, GetMeteredEntitlement, GetNumericEntitlement, GetSubscriptionsResult, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionInvoicePreviewFragment, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
3
3
  export declare class OfflineStigg extends Stigg {
4
4
  getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
5
5
  getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
6
6
  getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
7
+ getEnumEntitlement({ featureId, options }: GetEnumEntitlement): EnumEntitlement;
7
8
  getEntitlements(): Promise<Entitlement[]>;
8
9
  addListener(): void;
9
10
  clearCustomer(): void;
@@ -6,6 +6,7 @@ export interface CalculatedEntitlement {
6
6
  hasSoftLimit: boolean;
7
7
  feature?: EntitlementFeature;
8
8
  accessDeniedReason?: AccessDeniedReason;
9
+ enumValues?: string[];
9
10
  }
10
11
  export interface EntitlementUsage {
11
12
  currentUsage: number;
@@ -7,5 +7,5 @@ export declare class EntitlementCheckReportingService {
7
7
  private readonly loggerService;
8
8
  private readonly resourceId?;
9
9
  constructor(entitlementsApi: EntitlementsApi, customerId: string, loggerService: LoggerService, resourceId?: string | undefined);
10
- reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number): void;
10
+ reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number, requestedValues?: string[]): void;
11
11
  }
@@ -1,7 +1,7 @@
1
1
  import CachedEntitlement from './cachedEntitlement';
2
2
  import { AccessDeniedReason } from '../models';
3
3
  export declare class EntitlementDecisionService {
4
- static decideEntitlementPolicy(entitlement?: CachedEntitlement | null, requestUsage?: number): Decision;
4
+ static decideEntitlementPolicy(entitlement?: CachedEntitlement | null, requestUsage?: number, requestedValues?: string[]): Decision;
5
5
  }
6
6
  export interface Decision {
7
7
  readonly hasAccess: boolean;
@@ -1,6 +1,6 @@
1
1
  import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
2
2
  import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
3
- import { BooleanEntitlement, BooleanEntitlementOptions, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, NumericEntitlementOptions } from '../models';
3
+ import { BooleanEntitlement, BooleanEntitlementOptions, EnumEntitlement, EnumEntitlementOptions, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, NumericEntitlementOptions } from '../models';
4
4
  import CachedEntitlement from './cachedEntitlement';
5
5
  import { CacheService } from './cacheService';
6
6
  import { LoggerService } from './loggerService';
@@ -22,6 +22,7 @@ export declare class EntitlementsService {
22
22
  getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, options?: NumericEntitlementOptions): NumericEntitlement;
23
23
  getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, options?: MeteredEntitlementOptions): MeteredEntitlement;
24
24
  private handleUsagePeriodOver;
25
+ getEnumEntitlement(featureId: string, fallbackEntitlement: EnumEntitlement, options?: EnumEntitlementOptions): EnumEntitlement;
25
26
  private tryTrackEntitlementCheck;
26
27
  loadEntitlements(skipEdge?: boolean): Promise<void>;
27
28
  private loadEntitlementsFromRemote;
@@ -1,11 +1,12 @@
1
1
  import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment, SlimCustomerFragment } 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, SubscriptionPreviewInvoice, SlimCustomer, SubscriptionPreviewCredits } from '../models';
2
+ import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, EnumEntitlement, EnumEntitlementFallback, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer, SubscriptionPreviewCredits } from '../models';
3
3
  import CachedEntitlement from '../services/cachedEntitlement';
4
4
  import { Decision } from '../services/entitlementDecisionService';
5
5
  export declare class ModelMapper {
6
6
  mapBooleanEntitlement(entitlement: CachedEntitlement, decision: Decision): BooleanEntitlement;
7
7
  mapNumericEntitlement(entitlement: CachedEntitlement, decision: Decision): NumericEntitlement;
8
8
  mapMeteredEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): MeteredEntitlement;
9
+ mapEnumEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedValues?: string[]): EnumEntitlement;
9
10
  mapEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): BooleanEntitlement;
10
11
  mapCachedEntitlement(entitlement: EntitlementFragment): CachedEntitlement;
11
12
  mapCachedEntitlements(updatedEntitlements: EntitlementFragment[]): Map<string, CachedEntitlement>;
@@ -34,8 +35,9 @@ export declare class ModelMapper {
34
35
  private getResetPeriodData;
35
36
  mapFallbackBooleanEntitlementResult(entitlement: BooleanEntitlementFallback, decision: Decision): EntitlementCheckResult;
36
37
  mapFallbackNumericEntitlementResult(entitlement: NumericEntitlementFallback, decision: Decision): EntitlementCheckResult;
37
- mapEntitlementResult(decision: Decision, entitlement?: CachedEntitlement, requestedUsage?: number): EntitlementCheckResult;
38
+ mapEntitlementResult(decision: Decision, entitlement?: CachedEntitlement, requestedUsage?: number, requestedValues?: string[]): EntitlementCheckResult;
38
39
  mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
40
+ mapFallbackEnumEntitlementResult(entitlement: EnumEntitlementFallback, decision: Decision, requestedValues?: string[]): EntitlementCheckResult;
39
41
  mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
40
42
  mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
41
43
  mapCredits(fragment: NonNullable<SubscriptionPreviewFragment['credits']>): SubscriptionPreviewCredits;
@@ -24,4 +24,12 @@ export declare function mapGetEntitlementsFallback(entitlementsFallback?: Entitl
24
24
  feature: {
25
25
  id: string;
26
26
  };
27
+ } | {
28
+ hasAccess: boolean;
29
+ enumValues?: string[] | undefined;
30
+ isFallback: boolean;
31
+ accessDeniedReason: AccessDeniedReason;
32
+ feature: {
33
+ id: string;
34
+ };
27
35
  })[];
@@ -1,11 +1,12 @@
1
1
  import { ApplySubscriptionMutation, CustomerFragment, CustomerPortalFragment, CustomerResourceFragment, EntitlementCheckResult, EntitlementFragment, CheckoutStateFragment, GetCouponsQuery, GetMockPaywallQuery, GetPaywallQuery, SubscriptionFragment, SubscriptionPreviewFragment, UsageHistoryFragment, SubscriptionPreviewV2Fragment, SubscriptionPreviewInvoiceFragment, ImmediateSubscriptionPreviewInvoiceFragment, SlimCustomerFragment } 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, SubscriptionPreviewInvoice, SlimCustomer, SubscriptionPreviewCredits } from '../models';
2
+ import { BooleanEntitlement, BooleanEntitlementFallback, ApplySubscriptionResults, Coupon, Customer, CustomerPortal, CustomerResource, GetCheckoutStateResults, EnumEntitlement, EnumEntitlementFallback, MeteredEntitlement, MeteredEntitlementFallback, Money, NumericEntitlement, NumericEntitlementFallback, Paywall, Plan, Subscription, SubscriptionPreview, SubscriptionPreviewDiscount, UsageHistoryPoint, SubscriptionPreviewV2, SubscriptionPreviewInvoice, SlimCustomer, SubscriptionPreviewCredits } from '../models';
3
3
  import CachedEntitlement from '../services/cachedEntitlement';
4
4
  import { Decision } from '../services/entitlementDecisionService';
5
5
  export declare class ModelMapper {
6
6
  mapBooleanEntitlement(entitlement: CachedEntitlement, decision: Decision): BooleanEntitlement;
7
7
  mapNumericEntitlement(entitlement: CachedEntitlement, decision: Decision): NumericEntitlement;
8
8
  mapMeteredEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): MeteredEntitlement;
9
+ mapEnumEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedValues?: string[]): EnumEntitlement;
9
10
  mapEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): BooleanEntitlement;
10
11
  mapCachedEntitlement(entitlement: EntitlementFragment): CachedEntitlement;
11
12
  mapCachedEntitlements(updatedEntitlements: EntitlementFragment[]): Map<string, CachedEntitlement>;
@@ -34,8 +35,9 @@ export declare class ModelMapper {
34
35
  private getResetPeriodData;
35
36
  mapFallbackBooleanEntitlementResult(entitlement: BooleanEntitlementFallback, decision: Decision): EntitlementCheckResult;
36
37
  mapFallbackNumericEntitlementResult(entitlement: NumericEntitlementFallback, decision: Decision): EntitlementCheckResult;
37
- mapEntitlementResult(decision: Decision, entitlement?: CachedEntitlement, requestedUsage?: number): EntitlementCheckResult;
38
+ mapEntitlementResult(decision: Decision, entitlement?: CachedEntitlement, requestedUsage?: number, requestedValues?: string[]): EntitlementCheckResult;
38
39
  mapFallbackMeteredEntitlementResult(entitlement: MeteredEntitlementFallback, decision: Decision, requestedUsage?: number): EntitlementCheckResult;
40
+ mapFallbackEnumEntitlementResult(entitlement: EnumEntitlementFallback, decision: Decision, requestedValues?: string[]): EntitlementCheckResult;
39
41
  mapTaxFields(fragment: SubscriptionPreviewFragment | SubscriptionPreviewFragment['subscription'] | SubscriptionPreviewInvoiceFragment | ImmediateSubscriptionPreviewInvoiceFragment): Pick<SubscriptionPreview, 'tax' | 'taxDetails'>;
40
42
  mapSubscriptionPreview(fragment: SubscriptionPreviewFragment): SubscriptionPreview;
41
43
  mapCredits(fragment: NonNullable<SubscriptionPreviewFragment['credits']>): SubscriptionPreviewCredits;
@@ -24,4 +24,12 @@ export declare function mapGetEntitlementsFallback(entitlementsFallback?: Entitl
24
24
  feature: {
25
25
  id: string;
26
26
  };
27
+ } | {
28
+ hasAccess: boolean;
29
+ enumValues?: string[] | undefined;
30
+ isFallback: boolean;
31
+ accessDeniedReason: AccessDeniedReason;
32
+ feature: {
33
+ id: string;
34
+ };
27
35
  })[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stigg/js-client-sdk",
3
- "version": "3.45.0",
3
+ "version": "3.46.0",
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": "2.458.0",
31
+ "@stigg/api-client-js": "2.475.1",
32
32
  "cross-fetch": "^3.1.6",
33
33
  "dayjs": "^1.11.13",
34
34
  "fetch-retry": "^5.0.6",