@stigg/js-client-sdk 1.29.0 → 1.31.0

package/dist/models.d.ts

@@ -156,17 +156,14 @@ 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;

package/dist/services/entitlementCheckReportingService.d.ts

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

package/dist/services/entitlementsService.d.ts

@@ -1,38 +1,34 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { BooleanEntitlement, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, BooleanEntitlementOptions, NumericEntitlementOptions } from '../models';
+import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
+import { BooleanEntitlement, BooleanEntitlementOptions, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, NumericEntitlementOptions } from '../models';
 import CachedEntitlement from './cachedEntitlement';
 import { CacheService } from './cacheService';
-import { Decision } from './entitlementDecisionService';
 import { LoggerService } from './loggerService';
 import { EdgeApiClient } from '../api/EdgeApiClient';
-import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
 export declare class EntitlementsService {
     private readonly customerId;
     private readonly cacheService;
     private loggerService;
     private onEntitlementsUpdated;
+    private readonly resourceId?;
     private readonly entitlementsApi;
     private readonly modelMapper;
     private loadingEntitlements;
     private entitlementsPollingObserver;
     private entitlementCheckReportingService;
-    constructor(customerId: string, cacheService: CacheService, client: ApolloClient<NormalizedCacheObject>, batchedGraphClient: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null, loggerService: LoggerService, onEntitlementsUpdated: (cachedEntitlements: Map<string, CachedEntitlement>) => void);
+    constructor(customerId: string, cacheService: CacheService, client: ApolloClient<NormalizedCacheObject>, batchedGraphClient: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null, loggerService: LoggerService, onEntitlementsUpdated: (cachedEntitlements: Map<string, CachedEntitlement>) => void, resourceId?: string | undefined);
     startPolling(interval: number): void;
     stopPolling(): void;
     restartPolling(intervalMs: number): void;
     refresh(): Promise<void>;
     get isInitialized(): boolean;
-    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;
+    getBooleanEntitlement(featureId: string, fallbackEntitlement: BooleanEntitlement, options?: BooleanEntitlementOptions): BooleanEntitlement;
+    getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, options?: NumericEntitlementOptions): NumericEntitlement;
+    getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, options?: MeteredEntitlementOptions): MeteredEntitlement;
     private tryTrackEntitlementCheck;
     loadEntitlements(skipEdge?: boolean): Promise<void>;
     private loadEntitlementsFromRemote;
     protected storeFetchedEntitlementsInCache(entitlements: EntitlementFragment[]): void;
     private getLastEntitlementsUpdate;
-    getEntitlements(resourceId: string | null): Promise<BooleanEntitlement[]>;
+    getEntitlements(): Promise<BooleanEntitlement[]>;
 }
-export declare type GetEntitlementResult = {
-    entitlement: CachedEntitlement | null;
-    decision: Decision;
-};

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

@@ -14,9 +14,9 @@ export declare class EdgeApiClient {
         customerToken?: string | null;
     }): EdgeApiClient | null;
     getPaywall(productId?: string, billingCountryCode?: string): Promise<ApolloQueryResult<GetPaywallQuery>>;
-    getEntitlements(customerId: string): Promise<ApolloQueryResult<GetEntitlementsQuery>>;
+    getEntitlements(customerId: string, resourceId: string | undefined): Promise<ApolloQueryResult<GetEntitlementsQuery>>;
     getSdkConfiguration(): Promise<ApolloQueryResult<GetSdkConfigurationQuery>>;
-    watchEntitlements(customerId: string, interval: number): ObservablePoller<GetEntitlementsQuery>;
+    watchEntitlements(customerId: string, interval: number, resourceId: string | undefined): ObservablePoller<GetEntitlementsQuery>;
     private get;
 }
 export {};

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

@@ -5,8 +5,8 @@ declare class EntitlementsApi {
     private readonly client;
     private readonly edgeApiClient;
     constructor(client: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null);
-    getEntitlements(customerId: string, skipEdge?: boolean): Promise<import("@apollo/client/core").ApolloQueryResult<GetEntitlementsQuery>>;
-    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<{
+    getEntitlements(customerId: string, skipEdge?: boolean, resourceId?: string): Promise<import("@apollo/client/core").ApolloQueryResult<GetEntitlementsQuery>>;
+    pollEntitlements(customerId: string, interval: number, resourceId?: string): 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, resourceId?: string, requestedUsage?: number): Promise<void>;

package/dist/src/client.d.ts

@@ -7,8 +7,10 @@ export interface StiggClient {
     getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement;
     getNumericEntitlement: (params: GetNumericEntitlement) => NumericEntitlement;
     getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement;
-    setCustomerId: (customerId: string, customerToken?: string | null) => Promise<void>;
+    setCustomerId: (customerId: string, customerToken?: string | null, resourceId?: string | null) => Promise<void>;
     clearCustomer: () => void;
+    setResource: (resourceId: string) => Promise<void>;
+    clearResource: () => Promise<void>;
     getPaywall: (params?: GetPaywall) => Promise<Paywall>;
     getCustomer: () => Promise<Customer>;
     getCoupons(): Promise<Coupon[]>;
@@ -69,11 +71,19 @@ export declare class Stigg implements StiggClient {
     /**
      * Set the customer ID, usually after the customer signs in or restores a session
      */
-    setCustomerId(customerId: string, customerToken?: string | null): Promise<void>;
+    setCustomerId(customerId: string, customerToken?: string | null, resourceId?: string | null): Promise<void>;
     /**
      * Clear the customer ID, usually after the customer signs out
      */
     clearCustomer(): void;
+    /**
+     * Set the customer's resource ID, usually after the customer select a specific resource.
+     */
+    setResource(resourceId: string): Promise<void>;
+    /**
+     * Unset the customer's resource ID, usually after the customer exit a specific resource.
+     */
+    clearResource(): Promise<void>;
     /**
      * Reload entitlements
      */
@@ -86,7 +96,7 @@ export declare class Stigg implements StiggClient {
      * @param {BooleanEntitlementOptions} options
      * @return {BooleanEntitlement} boolean entitlement
      */
-    getBooleanEntitlement({ featureId, options, resourceId }: GetBooleanEntitlement): BooleanEntitlement;
+    getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
     /**
      * Get numeric entitlement of feature for a customer
      *
@@ -95,7 +105,7 @@ export declare class Stigg implements StiggClient {
      * @param {NumericEntitlementOptions} options
      * @return {NumericEntitlement} numeric entitlement
      */
-    getNumericEntitlement({ featureId, options, resourceId }: GetNumericEntitlement): NumericEntitlement;
+    getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
     /**
      * Get metered entitlement of feature for a customer
      *
@@ -104,7 +114,7 @@ export declare class Stigg implements StiggClient {
      * @param {MeteredEntitlementOptions} options
      * @return {MeteredEntitlement} metered entitlement
      */
-    getMeteredEntitlement({ featureId, options, resourceId }: GetMeteredEntitlement): MeteredEntitlement;
+    getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
     /**
      * Get paywall data for rendering the paywall
      * @deprecated *Optional* `productId` is now deprecated and will be changed to a *required* field soon.
@@ -133,10 +143,9 @@ export declare class Stigg implements StiggClient {
     /**
      * Get a list of entitlements
      *
-     * @param {string} resourceId
      * @returns {Promise<Entitlement[]>}
      */
-    getEntitlements(resourceId?: string): Promise<Entitlement[]>;
+    getEntitlements(): Promise<Entitlement[]>;
     /**
      * Estimate subscription
      * @return {Promise<SubscriptionPreview>} Preview of the subscription.

package/dist/src/configuration.d.ts

@@ -8,6 +8,7 @@ export declare type ClientConfiguration = {
     baseUri?: string;
     baseEdgeUri?: string;
     customerId?: string | null;
+    resourceId?: string | null;
     customerToken?: string | null;
     entitlementPollingInterval?: number;
     useEntitlementPolling?: boolean;

package/dist/src/models.d.ts

@@ -156,17 +156,14 @@ 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;

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

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

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

@@ -1,38 +1,34 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
-import { BooleanEntitlement, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, BooleanEntitlementOptions, NumericEntitlementOptions } from '../models';
+import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
+import { BooleanEntitlement, BooleanEntitlementOptions, MeteredEntitlement, MeteredEntitlementOptions, NumericEntitlement, NumericEntitlementOptions } from '../models';
 import CachedEntitlement from './cachedEntitlement';
 import { CacheService } from './cacheService';
-import { Decision } from './entitlementDecisionService';
 import { LoggerService } from './loggerService';
 import { EdgeApiClient } from '../api/EdgeApiClient';
-import { EntitlementFragment } from '@stigg/api-client-js/src/generated/sdk';
 export declare class EntitlementsService {
     private readonly customerId;
     private readonly cacheService;
     private loggerService;
     private onEntitlementsUpdated;
+    private readonly resourceId?;
     private readonly entitlementsApi;
     private readonly modelMapper;
     private loadingEntitlements;
     private entitlementsPollingObserver;
     private entitlementCheckReportingService;
-    constructor(customerId: string, cacheService: CacheService, client: ApolloClient<NormalizedCacheObject>, batchedGraphClient: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null, loggerService: LoggerService, onEntitlementsUpdated: (cachedEntitlements: Map<string, CachedEntitlement>) => void);
+    constructor(customerId: string, cacheService: CacheService, client: ApolloClient<NormalizedCacheObject>, batchedGraphClient: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null, loggerService: LoggerService, onEntitlementsUpdated: (cachedEntitlements: Map<string, CachedEntitlement>) => void, resourceId?: string | undefined);
     startPolling(interval: number): void;
     stopPolling(): void;
     restartPolling(intervalMs: number): void;
     refresh(): Promise<void>;
     get isInitialized(): boolean;
-    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;
+    getBooleanEntitlement(featureId: string, fallbackEntitlement: BooleanEntitlement, options?: BooleanEntitlementOptions): BooleanEntitlement;
+    getNumericEntitlement(featureId: string, fallbackEntitlement: NumericEntitlement, options?: NumericEntitlementOptions): NumericEntitlement;
+    getMeteredEntitlement(featureId: string, fallbackEntitlement: MeteredEntitlement, options?: MeteredEntitlementOptions): MeteredEntitlement;
     private tryTrackEntitlementCheck;
     loadEntitlements(skipEdge?: boolean): Promise<void>;
     private loadEntitlementsFromRemote;
     protected storeFetchedEntitlementsInCache(entitlements: EntitlementFragment[]): void;
     private getLastEntitlementsUpdate;
-    getEntitlements(resourceId: string | null): Promise<BooleanEntitlement[]>;
+    getEntitlements(): Promise<BooleanEntitlement[]>;
 }
-export declare type GetEntitlementResult = {
-    entitlement: CachedEntitlement | null;
-    decision: Decision;
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "1.29.0",
+  "version": "1.31.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.385.0",
+    "@stigg/api-client-js": "0.386.0",
     "axios": "^1.2.2",
     "cross-fetch": "^3.1.4",
     "husky": "^7.0.4",

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

@@ -1,5 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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]>;