@stigg/js-client-sdk 3.25.0 → 3.27.0

package/dist/models.d.ts

@@ -26,8 +26,11 @@ export interface NumericEntitlement extends BaseEntitlement {
     value?: number;
     isUnlimited: boolean;
 }
+/** @deprecated - fields were moved into {@link MeteredEntitlement} */
 export declare type ResetSettings = {
+    /** @deprecated - renamed to {@link MeteredEntitlement.usagePeriodEnd} */
     nextResetDate: Date;
+    /** @deprecated - renamed to {@link MeteredEntitlement.resetPeriod} */
     resetPeriod: EntitlementResetPeriod;
 };
 export interface MeteredEntitlement extends BaseEntitlement {
@@ -35,6 +38,14 @@ export interface MeteredEntitlement extends BaseEntitlement {
     isUnlimited: boolean;
     currentUsage: number;
     requestedUsage: number;
+    resetPeriod?: EntitlementResetPeriod;
+    /** The anchor for calculating the usage period for metered entitlements with a reset period configured */
+    usagePeriodAnchor?: Date;
+    /** The start date of the usage period for metered entitlements with a reset period configured */
+    usagePeriodStart?: Date;
+    /** The end date of the usage period for metered entitlements with a reset period configured */
+    usagePeriodEnd?: Date;
+    /** @deprecated fields were moved into {@link MeteredEntitlement} */
     resetSettings?: ResetSettings;
 }
 export declare type Entitlement = BooleanEntitlement | NumericEntitlement | MeteredEntitlement;

package/dist/services/cachedEntitlement.d.ts

@@ -9,8 +9,10 @@ export interface CalculatedEntitlement {
 }
 export interface EntitlementUsage {
     currentUsage: number;
+    usagePeriodAnchor?: Date;
+    usagePeriodStart?: Date;
+    usagePeriodEnd?: Date;
     resetPeriod?: EntitlementResetPeriod | null;
-    nextResetDate?: any | null;
     resetPeriodConfiguration?: ResetPeriodConfigurationFragment | null;
 }
 export default class CachedEntitlement {

package/dist/services/entitlementsService.d.ts

@@ -21,6 +21,7 @@ export declare class EntitlementsService {
     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 handleUsagePeriodOver;
     private tryTrackEntitlementCheck;
     loadEntitlements(skipEdge?: boolean): Promise<void>;
     private loadEntitlementsFromRemote;

package/dist/src/models.d.ts

@@ -26,8 +26,11 @@ export interface NumericEntitlement extends BaseEntitlement {
     value?: number;
     isUnlimited: boolean;
 }
+/** @deprecated - fields were moved into {@link MeteredEntitlement} */
 export declare type ResetSettings = {
+    /** @deprecated - renamed to {@link MeteredEntitlement.usagePeriodEnd} */
     nextResetDate: Date;
+    /** @deprecated - renamed to {@link MeteredEntitlement.resetPeriod} */
     resetPeriod: EntitlementResetPeriod;
 };
 export interface MeteredEntitlement extends BaseEntitlement {
@@ -35,6 +38,14 @@ export interface MeteredEntitlement extends BaseEntitlement {
     isUnlimited: boolean;
     currentUsage: number;
     requestedUsage: number;
+    resetPeriod?: EntitlementResetPeriod;
+    /** The anchor for calculating the usage period for metered entitlements with a reset period configured */
+    usagePeriodAnchor?: Date;
+    /** The start date of the usage period for metered entitlements with a reset period configured */
+    usagePeriodStart?: Date;
+    /** The end date of the usage period for metered entitlements with a reset period configured */
+    usagePeriodEnd?: Date;
+    /** @deprecated fields were moved into {@link MeteredEntitlement} */
     resetSettings?: ResetSettings;
 }
 export declare type Entitlement = BooleanEntitlement | NumericEntitlement | MeteredEntitlement;

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

@@ -9,8 +9,10 @@ export interface CalculatedEntitlement {
 }
 export interface EntitlementUsage {
     currentUsage: number;
+    usagePeriodAnchor?: Date;
+    usagePeriodStart?: Date;
+    usagePeriodEnd?: Date;
     resetPeriod?: EntitlementResetPeriod | null;
-    nextResetDate?: any | null;
     resetPeriodConfiguration?: ResetPeriodConfigurationFragment | null;
 }
 export default class CachedEntitlement {

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

@@ -21,6 +21,7 @@ export declare class EntitlementsService {
     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 handleUsagePeriodOver;
     private tryTrackEntitlementCheck;
     loadEntitlements(skipEdge?: boolean): Promise<void>;
     private loadEntitlementsFromRemote;

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

@@ -7,7 +7,7 @@ export declare class ModelMapper {
     mapNumericEntitlement(entitlement: CachedEntitlement, decision: Decision): NumericEntitlement;
     mapMeteredEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): MeteredEntitlement;
     mapEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): BooleanEntitlement;
-    mapCachedEntitlement(entitlement: EntitlementFragment, currentUsage?: number, nextResetDate?: number | null): CachedEntitlement;
+    mapCachedEntitlement(entitlement: EntitlementFragment): CachedEntitlement;
     mapCachedEntitlements(updatedEntitlements: EntitlementFragment[]): Map<string, CachedEntitlement>;
     mapPlans(resultData: GetPaywallQuery): Plan[];
     mapPaywall(resultData: GetPaywallQuery): Paywall;

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

@@ -0,0 +1,5 @@
+import { EntitlementResetPeriod } from '@stigg/api-client-js/src/generated/sdk';
+export declare function calculateUsagePeriod(usagePeriodAnchor: Date, baseDate: Date, resetPeriod: EntitlementResetPeriod): {
+    usagePeriodStart: Date;
+    usagePeriodEnd: Date;
+};

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

@@ -0,0 +1 @@
+export declare const mapDate: (date?: string | number | null | undefined) => Date | undefined;

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

@@ -0,0 +1,7 @@
+import { FeatureType, MeterType } from '@stigg/api-client-js/src/generated/sdk';
+declare type Feature = {
+    featureType: FeatureType;
+    meterType?: MeterType | null;
+};
+export declare function isMetered(feature?: Feature): boolean;
+export {};

package/dist/utils/ModelMapper.d.ts

@@ -7,7 +7,7 @@ export declare class ModelMapper {
     mapNumericEntitlement(entitlement: CachedEntitlement, decision: Decision): NumericEntitlement;
     mapMeteredEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): MeteredEntitlement;
     mapEntitlement(entitlement: CachedEntitlement, decision: Decision, requestedUsage?: number): BooleanEntitlement;
-    mapCachedEntitlement(entitlement: EntitlementFragment, currentUsage?: number, nextResetDate?: number | null): CachedEntitlement;
+    mapCachedEntitlement(entitlement: EntitlementFragment): CachedEntitlement;
     mapCachedEntitlements(updatedEntitlements: EntitlementFragment[]): Map<string, CachedEntitlement>;
     mapPlans(resultData: GetPaywallQuery): Plan[];
     mapPaywall(resultData: GetPaywallQuery): Paywall;

package/dist/utils/calculateUsagePeriod.d.ts

@@ -0,0 +1,5 @@
+import { EntitlementResetPeriod } from '@stigg/api-client-js/src/generated/sdk';
+export declare function calculateUsagePeriod(usagePeriodAnchor: Date, baseDate: Date, resetPeriod: EntitlementResetPeriod): {
+    usagePeriodStart: Date;
+    usagePeriodEnd: Date;
+};

package/dist/utils/dateUtils.d.ts

@@ -0,0 +1 @@
+export declare const mapDate: (date?: string | number | null | undefined) => Date | undefined;

package/dist/utils/isMetered.d.ts

@@ -0,0 +1,7 @@
+import { FeatureType, MeterType } from '@stigg/api-client-js/src/generated/sdk';
+declare type Feature = {
+    featureType: FeatureType;
+    meterType?: MeterType | null;
+};
+export declare function isMetered(feature?: Feature): boolean;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stigg/js-client-sdk",
-  "version": "3.25.0",
+  "version": "3.27.0",
   "description": "Stigg client-side SDK for Browser",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,8 +28,9 @@
   "dependencies": {
     "@apollo/client": "^3.4.17",
     "@sentry/browser": "^7.11.1",
-    "@stigg/api-client-js": "2.129.0",
+    "@stigg/api-client-js": "2.151.0",
     "cross-fetch": "^3.1.6",
+    "dayjs": "^1.11.13",
     "fetch-retry": "^5.0.6",
     "husky": "^7.0.4",
     "lint-staged": "^12.0.2",