@stigg/js-client-sdk 0.22.2 → 0.23.0

package/dist/api/initApolloClient.d.ts

@@ -1,7 +1,7 @@
 import { ApolloClient } from '@apollo/client/core';
 declare type ApolloClientConfiguration = {
-    sdkKey: string;
+    apiKey: string;
     baseUri: string;
 };
-declare const initApolloClient: ({ sdkKey, baseUri }: Partial<ApolloClientConfiguration>) => ApolloClient<import("@apollo/client/core").NormalizedCacheObject>;
+declare const initApolloClient: ({ apiKey, baseUri }: Partial<ApolloClientConfiguration>) => ApolloClient<import("@apollo/client/core").NormalizedCacheObject>;
 export default initApolloClient;

package/dist/client.d.ts

@@ -1,9 +1,11 @@
-import { EntitlementOptions, Customer, Entitlement, InvalidEntitlement, Plan, FallbackEntitlement } from './models';
+import { Customer, Entitlement, Plan, BooleanEntitlement, NumericEntitlement, MeteredEntitlement, GetBooleanEntitlement, GetNumericEntitlement, GetMeteredEntitlement, GetPaywall } from './models';
 import { ClientConfiguration } from './configuration';
 export interface StiggClient {
-    getEntitlement: <T extends Entitlement>(featureId: string, options?: EntitlementOptions) => T | InvalidEntitlement | FallbackEntitlement;
-    setCustomerId: (customerId: string) => void;
-    getPaywall: (productId?: string) => Promise<Plan[]>;
+    getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement;
+    getNumericEntitlement: (params: GetNumericEntitlement) => NumericEntitlement;
+    getMeteredEntitlement: (params: GetMeteredEntitlement) => MeteredEntitlement;
+    setCustomerId: (customerId: string) => Promise<void>;
+    getPaywall: (params?: GetPaywall) => Promise<Plan[]>;
     getCustomer: () => Promise<Customer>;
     getEntitlements: () => Promise<Entitlement[]>;
     refresh: () => Promise<void>;
@@ -12,15 +14,60 @@ export declare class Stigg implements StiggClient {
     private readonly apiGateway;
     private readonly graphClient;
     private readonly configuration;
+    private readonly loggerService;
     private entitlementsService;
     private readonly modelMapper;
     private constructor();
-    static initialize(configuration: ClientConfiguration): Promise<StiggClient>;
+    /**
+     * Initialize the SDK
+     * @param {ClientConfiguration} configuration
+     * @returns {Stigg | null}
+     */
+    static initialize(configuration: ClientConfiguration): Promise<StiggClient | null>;
+    /**
+     * Set the customer ID, usually after the customer signs in or restores a session
+     * @returns {Promise<void>}
+     */
     setCustomerId(customerId: string): Promise<void>;
+    /**
+     * Reload entitlements
+     */
     refresh(): Promise<void>;
-    getEntitlement<T extends Entitlement>(featureId: string, options?: EntitlementOptions): T | InvalidEntitlement | FallbackEntitlement;
-    private handleNoEntitlementFound;
-    getPaywall(productId?: string): Promise<Plan[]>;
+    /**
+     * Get boolean entitlement of feature for a customer
+     * @param {string} featureId
+     * @param {BooleanEntitlementOptions} options
+     * @return {BooleanEntitlement} boolean entitlement
+     */
+    getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
+    /**
+     * Get numeric entitlement of feature for a customer
+     * @param {string} featureId
+     * @param {NumericEntitlementOptions} options
+     * @return {NumericEntitlement} numeric entitlement
+     */
+    getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
+    /**
+     * Get metered entitlement of feature for a customer
+     * @param {string} featureId
+     * @param {MeteredEntitlementOptions} options
+     * @return {MeteredEntitlement} metered entitlement
+     */
+    getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
+    /**
+     * Get a list of plans for rendering the paywall
+     * @returns {Promise<Plan[]>}
+     */
+    getPaywall({ productId }?: GetPaywall): Promise<Plan[]>;
+    /**
+     * Get a customer
+     * @returns {Promise<Customer>}
+     */
     getCustomer(): Promise<Customer>;
-    getEntitlements(): Promise<Entitlement[] | never[]>;
+    /**
+     * Get a list of entitlements
+     * @returns {Promise<Entitlement[]>}
+     */
+    getEntitlements(): Promise<Entitlement[]>;
+    private withErrorHandling;
 }

package/dist/configuration.d.ts

@@ -1,9 +1,11 @@
+import { LogConfiguration, LoggerService } from './services/loggerService';
 export declare type ClientConfiguration = {
-    sdkKey: string;
+    apiKey: string;
     baseUri?: string;
     customerId?: string;
     entitlementPollingInterval?: number;
+    logConfiguration?: LogConfiguration;
 };
-export declare function validateConfiguration(configuration: ClientConfiguration): void;
-export declare function withDefaults(configuration: ClientConfiguration): Required<ClientConfiguration>;
+export declare function validateConfiguration(configuration: ClientConfiguration, loggerService: LoggerService): boolean;
+export declare function getConfiguration(configuration: ClientConfiguration): Required<ClientConfiguration>;
 export declare function ensureCustomerRefIdExists({ customerId }: ClientConfiguration): string;