@stigg/js-client-sdk 1.25.0 → 1.27.0

package/dist/models.d.ts

@@ -156,14 +156,17 @@ export declare type DefaultTrialConfig = {
 export declare type GetBooleanEntitlement = {
     featureId: string;
     options?: BooleanEntitlementOptions;
+    resourceId?: string;
 };
 export declare type GetNumericEntitlement = {
     featureId: string;
     options?: NumericEntitlementOptions;
+    resourceId?: string;
 };
 export declare type GetMeteredEntitlement = {
     featureId: string;
     options?: MeteredEntitlementOptions;
+    resourceId?: string;
 };
 export declare type GetPaywall = {
     productId?: string;
@@ -223,6 +226,7 @@ export declare type ExperimentInfo = {
 export declare type Subscription = {
     id: string;
     status: SubscriptionStatus;
+    resourceId?: string;
     plan: Plan;
     price: SubscriptionPrice | null;
     pricingType: PricingType;
@@ -348,6 +352,7 @@ export declare type EstimateSubscription = {
     unitQuantity?: number;
     billingInformation?: SubscriptionBillingInfo;
     promotionCode?: string;
+    skipTrial?: boolean;
 };
 export declare type EstimateSubscriptionUpdate = {
     subscriptionId: string;

package/dist/services/entitlementCheckReportingService.d.ts

@@ -6,5 +6,5 @@ export declare class EntitlementCheckReportingService {
     private readonly customerId;
     private readonly loggerService;
     constructor(entitlementsApi: EntitlementsApi, customerId: string, loggerService: LoggerService);
-    reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number): void;
+    reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number, resourceId?: string): void;
 }

package/dist/services/entitlementsService.d.ts

@@ -22,15 +22,15 @@ export declare class EntitlementsService {
     restartPolling(intervalMs: number): void;
     refresh(): Promise<void>;
     get isInitialized(): boolean;
-    getBooleanEntitlement(featureId: string, fallbackEntitlement: BooleanEntitlement, options?: BooleanEntitlementOptions): BooleanEntitlement;
-    getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, options?: NumericEntitlementOptions): NumericEntitlement;
-    getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, options?: MeteredEntitlementOptions): MeteredEntitlement;
+    getBooleanEntitlement(featureId: string, fallbackEntitlement: BooleanEntitlement, resourceId?: string, options?: BooleanEntitlementOptions): BooleanEntitlement;
+    getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, resourceId?: string, options?: NumericEntitlementOptions): NumericEntitlement;
+    getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, resourceId?: string, options?: MeteredEntitlementOptions): MeteredEntitlement;
     private tryTrackEntitlementCheck;
     loadEntitlements(skipEdge?: boolean): Promise<void>;
     private loadEntitlementsFromRemote;
     protected storeFetchedEntitlementsInCache(entitlements: EntitlementFragment[]): void;
     private getLastEntitlementsUpdate;
-    getEntitlements(): Promise<BooleanEntitlement[]>;
+    getEntitlements(resourceId: string | null): Promise<BooleanEntitlement[]>;
 }
 export declare type GetEntitlementResult = {
     entitlement: CachedEntitlement | null;

package/dist/src/api/EntitlementsApi.d.ts

@@ -9,6 +9,6 @@ declare class EntitlementsApi {
     pollEntitlements(customerId: string, interval: number): import("../utils/ObservablePoller").ObservablePoller<GetEntitlementsQuery> | import("@apollo/client/core").ObservableQuery<GetEntitlementsQuery, import("@stigg/api-client-js/src/generated/sdk").Exact<{
         query: import("@stigg/api-client-js/src/generated/sdk").FetchEntitlementsQuery;
     }>>;
-    reportEntitlementRequested(featureId: string, customerId: string, entitlementCheckResult: EntitlementCheckResult, requestedUsage?: number): Promise<void>;
+    reportEntitlementRequested(featureId: string, customerId: string, entitlementCheckResult: EntitlementCheckResult, resourceId?: string, requestedUsage?: number): Promise<void>;
 }
 export default EntitlementsApi;

package/dist/src/client.d.ts

@@ -12,7 +12,7 @@ export interface StiggClient {
     getPaywall: (params?: GetPaywall) => Promise<Paywall>;
     getCustomer: () => Promise<Customer>;
     getCoupons(): Promise<Coupon[]>;
-    getEntitlements: () => Promise<Entitlement[]>;
+    getEntitlements: (resourceId?: string) => Promise<Entitlement[]>;
     refresh: () => Promise<void>;
     waitForCheckoutCompleted(params?: WaitForCheckoutCompleted): Promise<Subscription | null>;
     waitForInitialization(): Promise<StiggClient>;
@@ -80,24 +80,31 @@ export declare class Stigg implements StiggClient {
     refresh(): Promise<void>;
     /**
      * Get boolean entitlement of feature for a customer
+     *
+     * @param {string} featureId
+     * @param {string} resourceId
+     * @param {BooleanEntitlementOptions} options
+     * @return {BooleanEntitlement} boolean entitlement
      */
-    getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
+    getBooleanEntitlement({ featureId, options, resourceId }: GetBooleanEntitlement): BooleanEntitlement;
     /**
      * Get numeric entitlement of feature for a customer
      *
      * @param {string} featureId
+     * @param {string} resourceId
      * @param {NumericEntitlementOptions} options
      * @return {NumericEntitlement} numeric entitlement
      */
-    getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
+    getNumericEntitlement({ featureId, options, resourceId }: GetNumericEntitlement): NumericEntitlement;
     /**
      * Get metered entitlement of feature for a customer
      *
      * @param {string} featureId
+     * @param {string} resourceId
      * @param {MeteredEntitlementOptions} options
      * @return {MeteredEntitlement} metered entitlement
      */
-    getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
+    getMeteredEntitlement({ featureId, options, resourceId }: GetMeteredEntitlement): MeteredEntitlement;
     /**
      * Get paywall data for rendering the paywall
      * @deprecated *Optional* `productId` is now deprecated and will be changed to a *required* field soon.
@@ -126,9 +133,10 @@ export declare class Stigg implements StiggClient {
     /**
      * Get a list of entitlements
      *
+     * @param {string} resourceId
      * @returns {Promise<Entitlement[]>}
      */
-    getEntitlements(): Promise<Entitlement[]>;
+    getEntitlements(resourceId?: string): Promise<Entitlement[]>;
     /**
      * Estimate subscription
      * @return {Promise<SubscriptionPreview>} Preview of the subscription.

package/dist/src/models.d.ts

@@ -156,14 +156,17 @@ export declare type DefaultTrialConfig = {
 export declare type GetBooleanEntitlement = {
     featureId: string;
     options?: BooleanEntitlementOptions;
+    resourceId?: string;
 };
 export declare type GetNumericEntitlement = {
     featureId: string;
     options?: NumericEntitlementOptions;
+    resourceId?: string;
 };
 export declare type GetMeteredEntitlement = {
     featureId: string;
     options?: MeteredEntitlementOptions;
+    resourceId?: string;
 };
 export declare type GetPaywall = {
     productId?: string;
@@ -223,6 +226,7 @@ export declare type ExperimentInfo = {
 export declare type Subscription = {
     id: string;
     status: SubscriptionStatus;
+    resourceId?: string;
     plan: Plan;
     price: SubscriptionPrice | null;
     pricingType: PricingType;
@@ -348,6 +352,7 @@ export declare type EstimateSubscription = {
     unitQuantity?: number;
     billingInformation?: SubscriptionBillingInfo;
     promotionCode?: string;
+    skipTrial?: boolean;
 };
 export declare type EstimateSubscriptionUpdate = {
     subscriptionId: string;

package/dist/src/services/entitlementCheckReportingService.d.ts

@@ -6,5 +6,5 @@ export declare class EntitlementCheckReportingService {
     private readonly customerId;
     private readonly loggerService;
     constructor(entitlementsApi: EntitlementsApi, customerId: string, loggerService: LoggerService);
-    reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number): void;
+    reportEntitlementCheckRequested(featureId: string, entitlement: EntitlementCheckResult, requestedUsage?: number, resourceId?: string): void;
 }

package/dist/src/services/entitlementsService.d.ts

@@ -22,15 +22,15 @@ export declare class EntitlementsService {
     restartPolling(intervalMs: number): void;
     refresh(): Promise<void>;
     get isInitialized(): boolean;
-    getBooleanEntitlement(featureId: string, fallbackEntitlement: BooleanEntitlement, options?: BooleanEntitlementOptions): BooleanEntitlement;
-    getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, options?: NumericEntitlementOptions): NumericEntitlement;
-    getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, options?: MeteredEntitlementOptions): MeteredEntitlement;
+    getBooleanEntitlement(featureId: string, fallbackEntitlement: BooleanEntitlement, resourceId?: string, options?: BooleanEntitlementOptions): BooleanEntitlement;
+    getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, resourceId?: string, options?: NumericEntitlementOptions): NumericEntitlement;
+    getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, resourceId?: string, options?: MeteredEntitlementOptions): MeteredEntitlement;
     private tryTrackEntitlementCheck;
     loadEntitlements(skipEdge?: boolean): Promise<void>;
     private loadEntitlementsFromRemote;
     protected storeFetchedEntitlementsInCache(entitlements: EntitlementFragment[]): void;
     private getLastEntitlementsUpdate;
-    getEntitlements(): Promise<BooleanEntitlement[]>;
+    getEntitlements(resourceId: string | null): Promise<BooleanEntitlement[]>;
 }
 export declare type GetEntitlementResult = {
     entitlement: CachedEntitlement | null;

package/dist/src/utils/cacheKeysHelpers.d.ts

@@ -0,0 +1,5 @@
+import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
+import CachedEntitlement from '../services/cachedEntitlement';
+export declare const buildCacheKeyFromEntitlement: (entitlement: EntitlementFragment) => string;
+export declare const buildCacheKey: (featureId: string, resourceId?: string | null | undefined) => string;
+export declare const filterEntitlementsByResourceId: (entitlements: Map<string, CachedEntitlement>, resourceId: string | null) => Array<[entitlementKey: string, entitlement: CachedEntitlement]>;

package/dist/utils/cacheKeysHelpers.d.ts

@@ -0,0 +1,5 @@
+import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
+import CachedEntitlement from '../services/cachedEntitlement';
+export declare const buildCacheKeyFromEntitlement: (entitlement: EntitlementFragment) => string;
+export declare const buildCacheKey: (featureId: string, resourceId?: string | null | undefined) => string;
+export declare const filterEntitlementsByResourceId: (entitlements: Map<string, CachedEntitlement>, resourceId: string | null) => Array<[entitlementKey: string, entitlement: CachedEntitlement]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "1.25.0",
+  "version": "1.27.0",
   "description": "Stigg client-side SDK for Browser",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,7 +28,7 @@
   "dependencies": {
     "@apollo/client": "^3.4.17",
     "@sentry/browser": "^7.11.1",
-    "@stigg/api-client-js": "0.373.1",
+    "@stigg/api-client-js": "0.374.2",
     "axios": "^1.2.2",
     "cross-fetch": "^3.1.4",
     "husky": "^7.0.4",