@stigg/js-client-sdk 3.33.0 → 3.35.0

package/dist/offlineClient.d.ts

@@ -0,0 +1,34 @@
+import { Stigg, StiggClient } from './clients';
+import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
+export declare class OfflineStigg extends Stigg {
+    getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
+    getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
+    getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
+    getEntitlements(): Promise<Entitlement[]>;
+    addListener(): void;
+    clearCustomer(): void;
+    clearResource(): void;
+    getActiveSubscriptionsList(): Promise<SlimSubscriptionFragmentV2Fragment[]>;
+    getCoupons(): Promise<Coupon[]>;
+    getSubscription(): Promise<Subscription>;
+    get isCustomerLoaded(): boolean;
+    get isResourceLoaded(): boolean;
+    get isWidgetWatermarkEnabled(): boolean;
+    removeListener(): void;
+    waitForInitialization(): Promise<StiggClient>;
+    setResource(): Promise<void>;
+    getCheckoutState(): Promise<GetCheckoutStateResults>;
+    applySubscription(): Promise<ApplySubscriptionResults>;
+    estimateSubscription(): Promise<SubscriptionPreview>;
+    previewSubscription(): Promise<SubscriptionPreviewV2>;
+    estimateSubscriptionUpdate(): Promise<SubscriptionPreview>;
+    waitForCheckoutCompleted(): Promise<Subscription | null>;
+    refresh(): Promise<void>;
+    fetchUsageHistory(): Promise<UsageHistoryPoint[] | undefined>;
+    getUsageHistoryV2(): Promise<UsageHistoryV2Fragment>;
+    setCustomerId(): Promise<void>;
+    getPaywall(): Promise<Paywall>;
+    getCustomerPortal(): Promise<CustomerPortal>;
+    getActiveSubscriptions(): Promise<Subscription[]>;
+    getCustomer(): Promise<Customer>;
+}

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

@@ -7,6 +7,7 @@ import SubscriptionsApi from './SubscriptionsApi';
 import SubscriptionEstimationsApi from './SubscriptionEstimationsApi';
 import MockPaywallApi from './MockPaywallApi';
 import { EdgeApiClient } from './EdgeApiClient';
+import { UsageHistoryApi } from './UsageHistoryApi';
 declare class ApiGateway {
     sdkConfiguration: SdkConfigurationApi;
     paywall: PaywallApi;
@@ -15,6 +16,7 @@ declare class ApiGateway {
     customers: CustomersApi;
     coupons: CouponsApi;
     subscriptionEstimations: SubscriptionEstimationsApi;
+    usageHistoryApi: UsageHistoryApi;
     constructor(client: ApolloClient<NormalizedCacheObject>, edgeApiClient: EdgeApiClient | null);
 }
 export default ApiGateway;

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

@@ -0,0 +1,7 @@
+import { UsageHistoryV2Input, GetUsageHistoryV2Query } from '@stigg/api-client-js/src/generated/sdk';
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+export declare class UsageHistoryApi {
+    private readonly client;
+    constructor(client: ApolloClient<NormalizedCacheObject>);
+    getUsageHistoryV2(input: UsageHistoryV2Input): Promise<import("@apollo/client/core").ApolloQueryResult<GetUsageHistoryV2Query>>;
+}

package/dist/src/client.d.ts

@@ -1,7 +1,8 @@
-import { SlimSubscriptionFragmentV2Fragment } from '@stigg/api-client-js/src/generated/sdk';
+import { SlimSubscriptionFragmentV2Fragment, UsageHistoryV2Fragment, UsageHistoryV2Input } from '@stigg/api-client-js/src/generated/sdk';
 import { ClientConfiguration } from './configuration';
 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 } from './models';
 import { EventNames, Events } from './services/eventEmitter';
+import { LoggerService } from './services/loggerService';
 export interface StiggClient {
     isCustomerLoaded: boolean;
     isResourceLoaded: boolean;
@@ -32,13 +33,14 @@ export interface StiggClient {
     estimateSubscription(estimateSubscription: EstimateSubscription): Promise<SubscriptionPreview>;
     estimateSubscriptionUpdate(estimateSubscriptionUpdate: EstimateSubscriptionUpdate): Promise<SubscriptionPreview>;
     previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>;
+    getUsageHistoryV2(input: UsageHistoryV2Input): Promise<UsageHistoryV2Fragment>;
 }
 export declare class Stigg implements StiggClient {
     private readonly apiGateway;
     private readonly edgeApiClient;
     private readonly graphClient;
     private readonly batchedGraphClient;
-    private readonly configuration;
+    protected readonly configuration: Required<ClientConfiguration>;
     private readonly loggerService;
     private globalEntitlementsService;
     private resourceEntitlementsService;
@@ -46,7 +48,7 @@ export declare class Stigg implements StiggClient {
     private readonly eventEmitter;
     private readonly initializationStateTracker;
     private showWidgetsWatermark;
-    private constructor();
+    protected constructor(configuration: Required<ClientConfiguration>, loggerService: LoggerService);
     /**
      * Creates an instance of Stigg client.
      *
@@ -194,6 +196,10 @@ export declare class Stigg implements StiggClient {
      * @param {PreviewSubscription} previewSubscription
      */
     previewSubscription(previewSubscription: PreviewSubscription): Promise<SubscriptionPreviewV2>;
+    /**
+     * Get customer usage history of a feature.
+     */
+    getUsageHistoryV2(input: UsageHistoryV2Input): Promise<UsageHistoryV2Fragment>;
     /**
      * Waits for a subscription to be activated after a completed checkout.
      * This method should be called on page load after the customer is redirected to the success URL.

package/dist/src/clients.d.ts

@@ -0,0 +1,2 @@
+export { OfflineStigg } from './offlineClient';
+export { Stigg, StiggClient } from './client';

package/dist/src/configuration.d.ts

@@ -21,6 +21,7 @@ export declare type ClientConfiguration = {
     entitlementsFallback?: EntitlementsFallback;
     clientName?: string;
     clientVersion?: string;
+    offline?: boolean;
 };
 export declare function validateConfiguration(configuration: ClientConfiguration, loggerService: LoggerService): void;
 export declare function getConfiguration(configuration: ClientConfiguration): Required<ClientConfiguration>;

package/dist/src/index.d.ts

@@ -2,4 +2,5 @@ export { ClientConfiguration } from './configuration';
 export { StiggClient } from './client';
 export { LogLevel, LogConfiguration, Logger } from './services/loggerService';
 export * from './models';
+export { OfflineStigg } from './offlineClient';
 export { Stigg as default } from './client';

package/dist/src/offlineClient.d.ts

@@ -0,0 +1,34 @@
+import { Stigg, StiggClient } from './clients';
+import { ApplySubscriptionResults, BooleanEntitlement, Coupon, Customer, CustomerPortal, Entitlement, GetBooleanEntitlement, GetCheckoutStateResults, GetMeteredEntitlement, GetNumericEntitlement, MeteredEntitlement, NumericEntitlement, Paywall, SlimSubscriptionFragmentV2Fragment, Subscription, SubscriptionPreview, SubscriptionPreviewV2, UsageHistoryPoint, UsageHistoryV2Fragment } from './models';
+export declare class OfflineStigg extends Stigg {
+    getBooleanEntitlement({ featureId, options }: GetBooleanEntitlement): BooleanEntitlement;
+    getMeteredEntitlement({ featureId, options }: GetMeteredEntitlement): MeteredEntitlement;
+    getNumericEntitlement({ featureId, options }: GetNumericEntitlement): NumericEntitlement;
+    getEntitlements(): Promise<Entitlement[]>;
+    addListener(): void;
+    clearCustomer(): void;
+    clearResource(): void;
+    getActiveSubscriptionsList(): Promise<SlimSubscriptionFragmentV2Fragment[]>;
+    getCoupons(): Promise<Coupon[]>;
+    getSubscription(): Promise<Subscription>;
+    get isCustomerLoaded(): boolean;
+    get isResourceLoaded(): boolean;
+    get isWidgetWatermarkEnabled(): boolean;
+    removeListener(): void;
+    waitForInitialization(): Promise<StiggClient>;
+    setResource(): Promise<void>;
+    getCheckoutState(): Promise<GetCheckoutStateResults>;
+    applySubscription(): Promise<ApplySubscriptionResults>;
+    estimateSubscription(): Promise<SubscriptionPreview>;
+    previewSubscription(): Promise<SubscriptionPreviewV2>;
+    estimateSubscriptionUpdate(): Promise<SubscriptionPreview>;
+    waitForCheckoutCompleted(): Promise<Subscription | null>;
+    refresh(): Promise<void>;
+    fetchUsageHistory(): Promise<UsageHistoryPoint[] | undefined>;
+    getUsageHistoryV2(): Promise<UsageHistoryV2Fragment>;
+    setCustomerId(): Promise<void>;
+    getPaywall(): Promise<Paywall>;
+    getCustomerPortal(): Promise<CustomerPortal>;
+    getActiveSubscriptions(): Promise<Subscription[]>;
+    getCustomer(): Promise<Customer>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "3.33.0",
+  "version": "3.35.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": "2.217.0",
+    "@stigg/api-client-js": "2.235.0",
     "cross-fetch": "^3.1.6",
     "dayjs": "^1.11.13",
     "fetch-retry": "^5.0.6",