@stigg/js-client-sdk 0.20.0

package/dist/models.d.ts

@@ -0,0 +1,171 @@
+import { AccessDeniedReason, BillingModel, BillingPeriod, EntitlementResetPeriod, MonthlyAccordingTo, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, WeeklyAccordingTo } from './api/generated/types';
+export { BillingPeriod, BillingModel, ErrorCode, AccessDeniedReason, EntitlementResetPeriod, TrialPeriodUnits, } from './api/generated/types';
+export declare enum FeatureType {
+    Boolean = "BOOLEAN",
+    Number = "NUMBER"
+}
+export declare enum MeterType {
+    Fluctuating = "Fluctuating",
+    Incremental = "Incremental",
+    None = "None"
+}
+export declare type BaseEntitlement = {
+    isValid: boolean;
+    isGranted: boolean;
+    featureType?: FeatureType;
+    featureDisplayName?: string;
+    featureDescription?: string | null;
+    accessDeniedReason?: AccessDeniedReason | null;
+    featureId?: string | null;
+};
+export interface FallbackEntitlement extends BaseEntitlement {
+    isValid: false;
+}
+export interface InvalidEntitlement extends BaseEntitlement {
+    isValid: false;
+    isGranted: false;
+    accessDeniedReason: AccessDeniedReason.FeatureNotFound | AccessDeniedReason.CustomerNotFound | AccessDeniedReason.Unknown;
+}
+export interface ValidEntitlement extends BaseEntitlement {
+    isValid: true;
+}
+export interface BooleanEntitlement extends ValidEntitlement {
+    featureType: FeatureType.Boolean;
+}
+export interface NumberEntitlement extends ValidEntitlement {
+    featureType: FeatureType.Number;
+    usageLimit: number;
+    featureUnits?: string;
+    featureUnitsPlural?: string;
+    hasUnlimitedUsage: boolean;
+}
+export interface MeteredEntitlement extends NumberEntitlement {
+    featureType: FeatureType.Number;
+    meterType: MeterType.Fluctuating | MeterType.Incremental | MeterType.None;
+    currentUsage: number;
+    requestedUsage: number | null;
+    resetPeriod?: EntitlementResetPeriod | null;
+    nextResetDate?: any | null;
+    resetPeriodConfiguration?: {
+        __typename: 'MonthlyResetPeriodConfig';
+        monthlyAccordingTo?: MonthlyAccordingTo | null | undefined;
+    } | {
+        __typename: 'WeeklyResetPeriodConfig';
+        weeklyAccordingTo?: WeeklyAccordingTo | null | undefined;
+    } | null;
+}
+export declare type Entitlement = FallbackEntitlement | InvalidEntitlement | BooleanEntitlement | NumberEntitlement | MeteredEntitlement;
+export declare const INVALID_ENTITLEMENT: InvalidEntitlement;
+export declare type PackageEntitlement = {
+    usageLimit: number;
+    featureType: FeatureType;
+    featureMeterType?: MeterType | null;
+    featureUnits?: string | null;
+    featureUnitsPlural?: string | null;
+    featureDisplayName: string;
+    featureDescription?: string | null;
+    featureId: string;
+    hasUnlimitedUsage?: boolean | null;
+    resetPeriod?: EntitlementResetPeriod | null;
+};
+export declare type PromotionalEntitlement = {
+    usageLimit: number;
+    featureType: FeatureType;
+    featureMeterType?: MeterType | null;
+    featureUnits?: string | null;
+    featureUnitsPlural?: string | null;
+    featureDisplayName: string;
+    featureDescription?: string | null;
+    featureId: string;
+    hasUnlimitedUsage?: boolean | null;
+    resetPeriod?: EntitlementResetPeriod | null;
+    status: PromotionalEntitlementStatus;
+    endDate?: Date;
+    isVisible: boolean;
+};
+export declare type Price = {
+    billingModel: BillingModel;
+    billingPeriod: BillingPeriod;
+    amount: number;
+    currency: string;
+    feature?: {
+        featureUnits?: string | null | undefined;
+        featureUnitsPlural?: string | null | undefined;
+        displayName: string;
+    } | null;
+};
+export declare type BasePlan = {
+    displayName: string;
+    id: string;
+};
+export declare type Plan = {
+    id: string;
+    displayName: string;
+    description?: string | null;
+    order: number;
+    basePlan?: BasePlan;
+    entitlements: PackageEntitlement[];
+    inheritedEntitlements: PackageEntitlement[];
+    prices: Price[];
+    defaultTrialConfig?: DefaultTrialConfig | null;
+    compatibleAddons: Addon[];
+};
+export declare type DefaultTrialConfig = {
+    duration: number;
+    units: TrialPeriodUnits;
+};
+export declare type EntitlementOptions = {
+    requestedUsage?: number;
+    shouldTrack?: boolean;
+    fallbackGrantedValue?: boolean;
+};
+export declare type FetchEntitlement = {
+    customerId: string;
+    featureId: string;
+    options?: EntitlementOptions;
+};
+export declare type Addon = {
+    id: string;
+    displayName: string;
+    description: string;
+    entitlements: PackageEntitlement[];
+};
+export declare type SubscriptionAddon = {
+    quantity: number;
+    addon: Addon;
+};
+export declare type Subscription = {
+    id: string;
+    status: SubscriptionStatus;
+    plan: Plan;
+    price: Price | null;
+    addons: SubscriptionAddon[];
+    billingId?: string;
+    crmId?: string;
+    startDate: Date;
+    endDate?: Date;
+};
+export declare type Customer = {
+    id: string;
+    name?: string;
+    email?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    subscriptions: Subscription[];
+    promotionalEntitlements: PromotionalEntitlement[];
+    getActiveSubscriptions(): Subscription[];
+    getActivePromotionalEntitlements(): PromotionalEntitlement[];
+    getActiveTrials(): Subscription[];
+};
+declare type CustomerState = Omit<Customer, 'getActiveSubscriptions' | 'getActivePromotionalEntitlements' | 'getActiveTrials'>;
+export declare class CustomerModel implements Customer {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    subscriptions: Subscription[];
+    promotionalEntitlements: PromotionalEntitlement[];
+    constructor(state: CustomerState);
+    getActiveSubscriptions(): Subscription[];
+    getActiveTrials(): Subscription[];
+    getActivePromotionalEntitlements(): PromotionalEntitlement[];
+}

package/dist/services/cacheService.d.ts

@@ -0,0 +1,9 @@
+import CachedEntitlement from './cachedEntitlement';
+export interface CacheService {
+    isLoaded: boolean;
+    setEntitlements(entitlements: Map<string, CachedEntitlement>): void;
+    getEntitlement(featureId: string): CachedEntitlement | null;
+    getEntitlements(): Map<string, CachedEntitlement>;
+    validateFeature(featureId: string): boolean;
+    setFeatures(features: string[]): void;
+}

package/dist/services/cachedEntitlement.d.ts

@@ -0,0 +1,24 @@
+import { EntitlementResetPeriod, FeatureType, MeterType } from '../models';
+import { ResetPeriodConfigurationFragment } from '../api/generated/types';
+export interface CalculatedEntitlement {
+    featureId: string;
+    featureType: FeatureType;
+    usageLimit?: number | null;
+    featureUnits?: string;
+    featureUnitsPlural?: string;
+    featureDisplayName?: string;
+    featureDescription?: string | null;
+    hasUnlimitedUsage: boolean;
+    meterType: MeterType.Fluctuating | MeterType.Incremental | MeterType.None;
+}
+export interface EntitlementUsage {
+    currentUsage: number;
+    resetPeriod?: EntitlementResetPeriod | null;
+    nextResetDate?: any | null;
+    resetPeriodConfiguration?: ResetPeriodConfigurationFragment | null;
+}
+export default class CachedEntitlement {
+    readonly calculatedEntitlement: CalculatedEntitlement;
+    readonly featureUsage: EntitlementUsage;
+    constructor(calculatedEntitlement: CalculatedEntitlement, featureUsage: EntitlementUsage);
+}

package/dist/services/entitlementDecisionService.d.ts

@@ -0,0 +1,9 @@
+import CachedEntitlement from './cachedEntitlement';
+import { AccessDeniedReason } from '../api/generated/types';
+export declare class EntitlementDecisionService {
+    static decideEntitlementPolicy(entitlement?: CachedEntitlement | null, requestUsage?: number): Decision;
+}
+export interface Decision {
+    readonly isGranted: boolean;
+    readonly accessDeniedReason?: AccessDeniedReason;
+}

package/dist/services/entitlementsService.d.ts

@@ -0,0 +1,21 @@
+import { CacheService } from './cacheService';
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import { Entitlement, InvalidEntitlement } from '../models';
+import { Decision } from './entitlementDecisionService';
+import CachedEntitlement from './cachedEntitlement';
+export declare class EntitlementsService {
+    private readonly customerId;
+    private readonly cacheService;
+    private readonly entitlementsApi;
+    private readonly modelMapper;
+    private loadingEntitlements;
+    constructor(customerId: string, cacheService: CacheService, client: ApolloClient<NormalizedCacheObject>);
+    getEntitlement<T extends Entitlement>(featureRefId: string, requestedUsage?: number): T | InvalidEntitlement;
+    loadEntitlements(): Promise<void>;
+    private doLoadEntitlements;
+    getEntitlements(): Promise<Entitlement[]>;
+}
+export declare type GetEntitlementResult = {
+    entitlement: CachedEntitlement | null;
+    decision: Decision;
+};

package/dist/services/inMemoryCacheService.d.ts

@@ -0,0 +1,13 @@
+import { CacheService } from './cacheService';
+import CachedEntitlement from './cachedEntitlement';
+export declare class InMemoryCacheService implements CacheService {
+    private entitlements;
+    isLoaded: boolean;
+    private features;
+    constructor();
+    getEntitlement(featureId: string): CachedEntitlement | null;
+    validateFeature(featureId: string): boolean;
+    setFeatures: (features: string[]) => Set<string>;
+    setEntitlements(entitlements: Map<string, CachedEntitlement>): void;
+    getEntitlements(): Map<string, CachedEntitlement>;
+}

package/dist/utils/ModelMapper.d.ts

@@ -0,0 +1,21 @@
+import { CustomerFragment, EntitlementFragment, GetPlansQuery, SlimEntitlementFragment } from '../api/generated/types';
+import { Customer, Entitlement, Plan } from '../models';
+import CachedEntitlement from '../services/cachedEntitlement';
+import { Decision } from '../services/entitlementDecisionService';
+export declare class ModelMapper {
+    mapEntitlementByDecision: (decision: Decision, featureId: string, entitlement: CachedEntitlement, requestedUsage?: number | undefined) => Entitlement;
+    mapSlimEntitlement(entitlement: SlimEntitlementFragment): Entitlement;
+    mapFullEntitlementByDecision(entitlement: CachedEntitlement, decision: Decision, customerId: string, requestedUsage?: number): Entitlement;
+    mapFullEntitlement(fullEntitlement: EntitlementFragment): Entitlement;
+    mapCachedEntitlement(entitlement: EntitlementFragment, currentUsage?: number, nextResetDate?: number | null): CachedEntitlement;
+    mapCachedEntitlements(updatedEntitlements: EntitlementFragment[]): Map<string, CachedEntitlement>;
+    mapPlans(resultData: GetPlansQuery): Plan[];
+    private mapPrice;
+    private mapPlan;
+    mapCustomer(customer: CustomerFragment): Customer;
+    private mapPackageEntitlement;
+    private mapPromotionalEntitlement;
+    private mapSubscription;
+    private mapAddon;
+    private sortPlans;
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@stigg/js-client-sdk",
+  "version": "0.20.0",
+  "description": "Stigg client-side SDK for Browser",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "repository": "https://github.com/stiggio/js-client-sdk.git",
+  "license": "MIT",
+  "scripts": {
+    "start": "webpack serve",
+    "build:types": "tsc --emitDeclarationOnly",
+    "build": "yarn build:types && webpack",
+    "build:watch": "webpack --watch",
+    "build:prod": "yarn build:types && webpack --env production",
+    "generate": "graphql-codegen && yarn run fix:lint",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "fix:lint": "eslint src --ext .ts --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "prepare": "husky install"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "dependencies": {
+    "@apollo/client": "^3.4.17",
+    "graphql": "^16.0.1",
+    "husky": "^7.0.4",
+    "cross-fetch": "^3.1.4",
+    "lint-staged": "^12.0.2",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^14.1.0",
+    "@commitlint/config-conventional": "^14.1.0",
+    "@graphql-codegen/cli": "^2.3.0",
+    "@graphql-codegen/fragment-matcher": "^3.2.1",
+    "@graphql-codegen/schema-ast": "^2.4.0",
+    "@graphql-codegen/typescript": "^2.4.0",
+    "@graphql-codegen/typescript-operations": "^2.2.0",
+    "@types/jest": "^27.0.2",
+    "@types/lodash": "^4.14.177",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "eslint": "^8.2.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.3.1",
+    "jest-fetch-mock": "^3.0.3",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.4.1",
+    "ts-jest": "^27.0.7",
+    "ts-loader": "^9.2.6",
+    "typescript": "^4.5.3",
+    "msw": "^0.35.0",
+    "webpack": "^5.64.1",
+    "webpack-cli": "^4.9.1",
+    "webpack-dev-server": "^4.5.0"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "prettier --check",
+      "eslint --cache"
+    ]
+  }
+}