npm - @kelviq/js-sdk - Versions diffs - 1.0.0 - Mend

@kelviq/js-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE.md +9 -0
package/README.md +15 -0
package/dist/index.d.ts +175 -0
package/dist/kelviq-js-sdk.iife.js +1 -0
package/dist/kelviq-js-sdk.js +295 -0
package/dist/kelviq-js-sdk.umd.js +1 -0
package/package.json +62 -0

package/LICENSE.md ADDED Viewed

@@ -0,0 +1,9 @@
+MIT License
+Copyright (c) 2022 Kamil Bysiec
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+title: "JavaScript SDK"
+description: "Documentation for the Kelviq JavaScript SDK"
+icon: "js"
+---
+The `@kelviq/js-sdk` is a lightweight, plain TypeScript library designed for interacting with the Kelviq entitlement service. It allows you to:
+- Fetch all feature entitlements for a specific organization and customer.
+- Cache these entitlements client-side for efficient and repeated access.
+- Check if a user has access to a particular feature.
+- Retrieve specific entitlement details, including boolean flags, numeric configurations, and metered usage data.
+- Manually refresh entitlement data from the server.
+### Docs - https://docs.kelviq.com/frontend-integration/js-sdk

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,175 @@
+// Generated by dts-bundle-generator v9.5.1
+export interface Entitlement {
+	featureId: string;
+	hasAccess: boolean;
+	type: "boolean" | "customizable" | "metered";
+}
+export interface BooleanEntitlement extends Entitlement {
+	type: "boolean";
+}
+export interface ConfigEntitlement extends Entitlement {
+	type: "customizable";
+	configuration: number | null;
+}
+export interface MeteredEntitlement extends Entitlement {
+	type: "metered";
+	limit: number | null;
+	used: number;
+	remaining: number | null;
+	resetAt?: string | null;
+	hardLimit?: boolean;
+}
+export type AnyEntitlement = BooleanEntitlement | ConfigEntitlement | MeteredEntitlement;
+export type EntitlementMap = Record<string, AnyEntitlement>;
+/**
+ * Configuration for an API request.
+ * @template ReqBody The type of the request body.
+ */
+export interface ApiRequestConfig<ReqBody = any> {
+	/** The URL for the request. */
+	url: string;
+	/** HTTP method (GET, POST, PUT, DELETE, etc.). Defaults to GET. */
+	method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD";
+	/** Custom headers for the request. */
+	headers?: Record<string, string>;
+	/** Data to be sent as the request body. */
+	body?: ReqBody;
+	/** Timeout for the request in milliseconds. Defaults to 5000ms. */
+	timeout?: number;
+	/** Maximum number of retry attempts for failed requests. Defaults to 3. */
+	maxRetries?: number;
+	/** Base delay (in milliseconds) for exponential backoff between retries. Defaults to 1000ms. */
+	backoffBaseDelay?: number;
+	/** Optional: The static authentication token string. */
+	accessToken?: string | null;
+	/** Optional: Query parameters to be appended to the URL. */
+	queryParams?: Record<string, string | number | boolean | undefined>;
+}
+/**
+ * Represents the structure of a successful API response.
+ * @template ResData The type of the data in the response body.
+ */
+export interface ApiResponse<ResData> {
+	/** HTTP status code of the response. */
+	status: number;
+	/** HTTP status text of the response. */
+	statusText: string;
+	/** Parsed data from the response body. */
+	data: ResData;
+}
+/** Optional behavioral configuration options for the KelviqProvider. */
+export interface KelviqApiOptions {
+	/** Optional: Maximum number of retries for API requests. Defaults to 3. */
+	maxRetries?: number;
+	/** Optional: Timeout for API requests in milliseconds. Defaults to 5000. */
+	timeout?: number;
+	/** Optional: Base delay (in milliseconds) for exponential backoff strategy in retries.
+	 * If not provided, the `apiRequest` service's default will be used.
+	 */
+	backoffBaseDelay?: number;
+}
+/**
+ * Configuration options for initializing the KelviqClient.
+ */
+export interface KelviqClientOptions {
+	/** Base URL for the Kelviq API (e.g., https://edge.api.kelviq.com/api/v1). Required. */
+	apiUrl?: string;
+	/** Path for fetching all entitlements (e.g., "/entitlement-check"). Required. */
+	entitlementsPath?: string;
+	/** The customer ID, sent as a query parameter. Required. */
+	customerId?: string;
+	/** Optional: The static authentication token string for API requests. */
+	accessToken: string;
+	environment?: "sandbox" | "production";
+	/**
+	 * If true, `fetchAllEntitlements()` will be called immediately upon client creation using `createKelviqClient`.
+	 * Defaults to `false`.
+	 */
+	initializeAndFetch?: boolean;
+	/** Optional callback for handling errors that occur within the SDK during entitlement fetching. */
+	onError?: (error: Error) => void;
+	apiConfig?: KelviqApiOptions;
+}
+declare function apiRequest<ResData = any, ReqBody = any>(config: ApiRequestConfig<ReqBody>): Promise<ApiResponse<ResData>>;
+declare class KelviqClient {
+	private readonly options;
+	private entitlementsCache;
+	private isFetching;
+	private lastFetchError;
+	private readonly apiRequestService;
+	/**
+	 * Creates an instance of KelviqClient.
+	 * Prefer using the `createKelviqClient` factory function for instantiation.
+	 * @internal
+	 * @param options Configuration options for the client.
+	 * @param customApiRequest Optional: A custom function to handle API requests, conforming to ApiRequestConfig and ApiResponse.
+	 */
+	constructor(options: KelviqClientOptions, customApiRequest?: typeof apiRequest);
+	/**
+	 * Fetches all entitlements from the API for the configured orgId and customerId,
+	 * processes them, and caches the result.
+	 * Subsequent calls will return cached data unless `forceRefresh` is true.
+	 *
+	 * @param forceRefresh - If true, fetches from the API even if data is already cached. Defaults to false.
+	 * @returns A promise that resolves to the map of entitlements (EntitlementMap).
+	 * @throws Will throw an error if the API request fails after all retries.
+	 */
+	fetchAllEntitlements(forceRefresh?: boolean): Promise<EntitlementMap>;
+	/**
+	 * Retrieves a specific entitlement from the local cache.
+	 * Note: `fetchAllEntitlements()` must be called successfully at least once before using this method,
+	 * or the cache will be empty.
+	 *
+	 * @param featureId The unique key of the feature.
+	 * @param type The expected type of the entitlement ('boolean', 'config', 'metered').
+	 * @returns The processed entitlement object if found in the cache and the type matches, otherwise `null`.
+	 * Logs a warning if entitlements haven't been fetched or if a type mismatch occurs.
+	 */
+	getEntitlement<T extends AnyEntitlement>(featureId: string, type: T["type"]): T | null;
+	/**
+	 * Checks if the user has access to a specific feature based on cached entitlements.
+	 * Note: `fetchAllEntitlements()` should be called successfully at least once before using this method.
+	 *
+	 * @param featureId The key of the feature.
+	 * @returns `true` if access is granted, `false` if denied or the feature is not found in the cache.
+	 * Logs a warning and returns `false` if entitlements haven't been fetched.
+	 */
+	hasAccess(featureId: string): boolean;
+	/**
+	 * Returns the currently cached map of all entitlements.
+	 * `fetchAllEntitlements()` should be called successfully at least once.
+	 * @returns The EntitlementMap (a record of featureKey to entitlement data) or `null` if not fetched or an error occurred during the last fetch.
+	 */
+	getAllEntitlements(): EntitlementMap | null;
+	/**
+	 * Indicates if an entitlement fetch operation is currently in progress.
+	 * @returns `true` if a fetch is in progress, `false` otherwise.
+	 */
+	isLoading(): boolean;
+	/**
+	 * Returns the last error that occurred during an entitlement fetch operation.
+	 * @returns An `Error` object if the last fetch failed, otherwise `null`.
+	 */
+	getLastError(): Error | null;
+	/**
+	 * Clears the local entitlement cache and resets loading and error states.
+	 * After calling this, `fetchAllEntitlements()` will need to be called again to populate the cache.
+	 */
+	clearCache(): void;
+}
+/**
+ * Factory function to create and initialize a KelviqClient instance.
+ * This is the recommended way to get an SDK client.
+ * @param options Configuration options for the client.
+ * @param customApiRequest Optional: A custom function to handle API requests, useful for testing or custom HTTP clients.
+ * @returns An instance of KelviqClient.
+ */
+declare function kelviqSDK(// Renamed from createKelviqClient
+options: KelviqClientOptions, customApiRequest?: typeof apiRequest): KelviqClient;
+export {
+	kelviqSDK as default,
+};
+export {};

package/dist/kelviq-js-sdk.iife.js ADDED Viewed

@@ -0,0 +1 @@

+ var kelviqSDK=function(){"use strict";var P=Object.defineProperty;var b=(d,m,y)=>m in d?P(d,m,{enumerable:!0,configurable:!0,writable:!0,value:y}):d[m]=y;var A=(d,m,y)=>b(d,typeof m!="symbol"?m+"":m,y);function d(s){const n={};return!s||!Array.isArray(s.entitlements)?(console.warn("[Kelviq SDK] transformApiEntitlements: Invalid or empty entitlements array in API response.",s),n):(s.entitlements.forEach(e=>{if(!e||typeof e.featureId!="string"||typeof e.featureType!="string"){console.warn("[Kelviq SDK] transformApiEntitlements: Skipping invalid raw entitlement object:",e);return}let t=null;const f={featureId:e.featureId,hasAccess:e.hasAccess};if(e.featureType==="BOOLEAN")t={...f,type:"boolean"};else if(e.featureType==="CUSTOMIZABLE"){const r=e;t={...f,type:"customizable",configuration:typeof r.value=="number"?r.value:null}}else if(e.featureType==="METER"){const r=e,E=typeof r.usageLimit=="number"?r.usageLimit:null,o=typeof r.currentUsage=="number"?r.currentUsage:0;t={...f,type:"metered",limit:E,used:o,remaining:E!==null?E-o:null,resetAt:r.resetAt,hardLimit:r.hardLimit}}else{const r=e;console.warn(`[Kelviq SDK] transformApiEntitlements: Encountered unknown or unhandled entitlement featureType: '${String(r.featureType)}' for feature '${String(r.feature)}'. This entitlement will be ignored.`)}t&&(n[t.featureId]=t)}),n)}const m="GET",y=5e3,R=3,$=1e3;function F(s){const{method:n=m,headers:e={},body:t,timeout:f=y,maxRetries:r=R,backoffBaseDelay:E=$,queryParams:o,accessToken:v}=s;let a=s.url,g=0;return new Promise((T,l)=>{if(o){const c=new URLSearchParams;for(const p in o)o[p]!==void 0&&c.append(p,String(o[p]));c.toString()&&(a=a+(a.includes("?")?"&":"?")+c.toString())}function u(){const c=new XMLHttpRequest;c.open(n,a,!0),c.timeout=f;const p={Accept:"application/json","X-Requested-With":"XMLHttpRequest",...e};n!=="GET"&&t&&typeof t=="object"&&!(t instanceof FormData)&&(p["Content-Type"]||(p["Content-Type"]="application/json")),v&&(p.Authorization=`Bearer ${v}`);for(const[i,h]of Object.entries(p))c.setRequestHeader(i,h);c.onload=function(){const{status:i,statusText:h,responseText:S}=c;if(i>=200&&i<300)try{const q=S?JSON.parse(S):{};T({status:i,statusText:h,data:q})}catch(q){const D=q instanceof Error?q:new Error(String(q));console.error(`Kelviq SDK (apiRequest): Invalid JSON response for URL ${a}. Error: ${D.message}. Response: ${S}`),l(new Error(`Invalid JSON response: ${D.message}`))}else K(`Request to ${a} failed with status ${i} ${h}. Response: ${S}`)},c.onerror=()=>K(`Network error for URL ${a}. The request could not be completed.`),c.ontimeout=()=>K(`Request to ${a} timed out.`);function K(i){if(g<r){g++;const h=Math.min(E*Math.pow(2,g-1),3e4);console.warn(`Kelviq SDK (apiRequest): Retrying request to ${a}. Attempt ${g}/${r}. Error: ${i}. Retrying in ${h}ms.`),setTimeout(u,h)}else l(new Error(`${i} (Max retries ${r} reached)`))}try{let i=t;t&&typeof t=="object"&&!(t instanceof FormData)&&p["Content-Type"]==="application/json"&&(i=JSON.stringify(t)),c.send(i)}catch(i){const h=i instanceof Error?i:new Error(String(i));console.error(`Kelviq SDK (apiRequest): Error sending request to ${a}.`,h),l(new Error(`Failed to send request: ${h.message}`))}}u()})}const L="https://edge.api.kelviq.com/api/v1/",w="https://edge.sandboxapi.kelviq.com/api/v1/",C="entitlements/";class I{constructor(n,e){A(this,"options");A(this,"entitlementsCache",null);A(this,"isFetching",!1);A(this,"lastFetchError",null);A(this,"apiRequestService");if(!n||!n.customerId)throw new Error("[Kelviq SDK] KelviqClient: CustomerId is required in options.");this.options={...n,apiConfig:n.apiConfig||{},entitlementsPath:n.entitlementsPath||C},this.apiRequestService=e||F}async fetchAllEntitlements(n=!1){if(this.isFetching)return Promise.reject(new Error("[Kelviq SDK] An entitlement fetch is already in progress."));if(this.entitlementsCache&&!n)return Promise.resolve(this.entitlementsCache);this.isFetching=!0,this.lastFetchError=null;const{apiUrl:e=this.options.environment==="sandbox"?w:L,entitlementsPath:t,customerId:f,accessToken:r,apiConfig:E,onError:o}=this.options,v=e.replace(/\/$/,""),a=t.replace(/^\//,""),g=`${v}/${a}`,T={customer_id:f};try{const l=await this.apiRequestService({url:g,method:"GET",queryParams:T,accessToken:r,...E||{}});if(l&&l.data&&Array.isArray(l.data.entitlements))return this.entitlementsCache=d(l.data),this.isFetching=!1,this.entitlementsCache;{const u=new Error("[Kelviq SDK] Received empty, malformed, or invalid data structure from entitlements API.");throw this.lastFetchError=u,this.isFetching=!1,this.entitlementsCache=null,o&&o(u),u}}catch(l){const u=l instanceof Error?l:new Error(String(l));throw this.lastFetchError=u,this.isFetching=!1,this.entitlementsCache=null,o&&o(u),u}}getEntitlement(n,e){if(!this.entitlementsCache)return console.warn(`[Kelviq SDK] getEntitlement: Entitlements not fetched or cache is empty for featureId '${n}'. Call fetchAllEntitlements() first.`),null;const t=this.entitlementsCache[n];return t?t.type===e?t:(console.warn(`[Kelviq SDK] getEntitlement: Type mismatch for featureId '${n}'. Expected type '${e}', but cached type is '${t.type}'.`),null):null}hasAccess(n){if(!this.entitlementsCache)return console.warn(`[Kelviq SDK] hasAccess: Entitlements not fetched yet for featureId '${n}'. Call fetchAllEntitlements() first. Returning false.`),!1;const e=this.entitlementsCache[n];return e?e.hasAccess:!1}getAllEntitlements(){return this.entitlementsCache}isLoading(){return this.isFetching}getLastError(){return this.lastFetchError}clearCache(){this.entitlementsCache=null,this.isFetching=!1,this.lastFetchError=null,console.log("[Kelviq SDK] Entitlement cache cleared.")}}function U(s,n){const e={...s,initializeAndFetch:s.initializeAndFetch||!0,apiConfig:s.apiConfig||{},environment:s.environment||"production",entitlementsPath:s.entitlementsPath||C},t=new I(e,n);return e.initializeAndFetch===!0&&t.fetchAllEntitlements().catch(f=>{console.error("[Kelviq SDK] Initial fetch on client creation failed:",f.message)}),t}return U}();

package/dist/kelviq-js-sdk.js ADDED Viewed

@@ -0,0 +1,295 @@
+var K = Object.defineProperty;
+var C = (r, t, e) => t in r ? K(r, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : r[t] = e;
+var E = (r, t, e) => C(r, typeof t != "symbol" ? t + "" : t, e);
+function R(r) {
+  const t = {};
+  return !r || !Array.isArray(r.entitlements) ? (console.warn(
+    "[Kelviq SDK] transformApiEntitlements: Invalid or empty entitlements array in API response.",
+    r
+  ), t) : (r.entitlements.forEach((e) => {
+    if (!e || typeof e.featureId != "string" || typeof e.featureType != "string") {
+      console.warn(
+        "[Kelviq SDK] transformApiEntitlements: Skipping invalid raw entitlement object:",
+        e
+      );
+      return;
+    }
+    let n = null;
+    const m = {
+      featureId: e.featureId,
+      hasAccess: e.hasAccess
+    };
+    if (e.featureType === "BOOLEAN")
+      n = {
+        ...m,
+        type: "boolean"
+      };
+    else if (e.featureType === "CUSTOMIZABLE") {
+      const i = e;
+      n = {
+        ...m,
+        type: "customizable",
+        configuration: typeof i.value == "number" ? i.value : null
+      };
+    } else if (e.featureType === "METER") {
+      const i = e, p = typeof i.usageLimit == "number" ? i.usageLimit : null, o = typeof i.currentUsage == "number" ? i.currentUsage : 0;
+      n = {
+        ...m,
+        type: "metered",
+        limit: p,
+        used: o,
+        remaining: p !== null ? p - o : null,
+        resetAt: i.resetAt,
+        hardLimit: i.hardLimit
+      };
+    } else {
+      const i = e;
+      console.warn(
+        `[Kelviq SDK] transformApiEntitlements: Encountered unknown or unhandled entitlement featureType: '${String(i.featureType)}' for feature '${String(i.feature)}'. This entitlement will be ignored.`
+      );
+    }
+    n && (t[n.featureId] = n);
+  }), t);
+}
+const $ = "GET", D = 5e3, F = 3, L = 1e3;
+function w(r) {
+  const {
+    method: t = $,
+    headers: e = {},
+    // Renamed to avoid conflict with internal 'headers' variable
+    body: n,
+    timeout: m = D,
+    maxRetries: i = F,
+    backoffBaseDelay: p = L,
+    queryParams: o,
+    accessToken: g
+    // Use the direct accessToken
+  } = r;
+  let a = r.url, d = 0;
+  return new Promise((q, l) => {
+    if (o) {
+      const c = new URLSearchParams();
+      for (const f in o)
+        o[f] !== void 0 && c.append(f, String(o[f]));
+      c.toString() && (a = a + (a.includes("?") ? "&" : "?") + c.toString());
+    }
+    function u() {
+      const c = new XMLHttpRequest();
+      c.open(t, a, !0), c.timeout = m;
+      const f = {
+        Accept: "application/json",
+        "X-Requested-With": "XMLHttpRequest",
+        ...e
+        // Apply custom headers, allowing them to override defaults
+      };
+      t !== "GET" && n && typeof n == "object" && !(n instanceof FormData) && (f["Content-Type"] || (f["Content-Type"] = "application/json")), g && (f.Authorization = `Bearer ${g}`);
+      for (const [s, h] of Object.entries(f))
+        c.setRequestHeader(s, h);
+      c.onload = function() {
+        const { status: s, statusText: h, responseText: A } = c;
+        if (s >= 200 && s < 300)
+          try {
+            const y = A ? JSON.parse(A) : {};
+            q({ status: s, statusText: h, data: y });
+          } catch (y) {
+            const S = y instanceof Error ? y : new Error(String(y));
+            console.error(
+              `Kelviq SDK (apiRequest): Invalid JSON response for URL ${a}. Error: ${S.message}. Response: ${A}`
+            ), l(new Error(`Invalid JSON response: ${S.message}`));
+          }
+        else
+          v(
+            `Request to ${a} failed with status ${s} ${h}. Response: ${A}`
+          );
+      }, c.onerror = () => v(
+        `Network error for URL ${a}. The request could not be completed.`
+      ), c.ontimeout = () => v(`Request to ${a} timed out.`);
+      function v(s) {
+        if (d < i) {
+          d++;
+          const h = Math.min(
+            p * Math.pow(2, d - 1),
+            3e4
+            // Cap retry delay at 30 seconds
+          );
+          console.warn(
+            `Kelviq SDK (apiRequest): Retrying request to ${a}. Attempt ${d}/${i}. Error: ${s}. Retrying in ${h}ms.`
+          ), setTimeout(u, h);
+        } else
+          l(
+            new Error(`${s} (Max retries ${i} reached)`)
+          );
+      }
+      try {
+        let s = n;
+        n && typeof n == "object" && !(n instanceof FormData) && f["Content-Type"] === "application/json" && (s = JSON.stringify(n)), c.send(s);
+      } catch (s) {
+        const h = s instanceof Error ? s : new Error(String(s));
+        console.error(
+          `Kelviq SDK (apiRequest): Error sending request to ${a}.`,
+          h
+        ), l(new Error(`Failed to send request: ${h.message}`));
+      }
+    }
+    u();
+  });
+}
+const I = "https://edge.api.kelviq.com/api/v1/", U = "https://edge.sandboxapi.kelviq.com/api/v1/", T = "entitlements/";
+class P {
+  /**
+   * Creates an instance of KelviqClient.
+   * Prefer using the `createKelviqClient` factory function for instantiation.
+   * @internal
+   * @param options Configuration options for the client.
+   * @param customApiRequest Optional: A custom function to handle API requests, conforming to ApiRequestConfig and ApiResponse.
+   */
+  constructor(t, e) {
+    E(this, "options");
+    E(this, "entitlementsCache", null);
+    E(this, "isFetching", !1);
+    E(this, "lastFetchError", null);
+    E(this, "apiRequestService");
+    if (!t || !t.customerId)
+      throw new Error(
+        "[Kelviq SDK] KelviqClient: CustomerId is required in options."
+      );
+    this.options = {
+      ...t,
+      apiConfig: t.apiConfig || {},
+      entitlementsPath: t.entitlementsPath || T
+    }, this.apiRequestService = e || w;
+  }
+  /**
+   * Fetches all entitlements from the API for the configured orgId and customerId,
+   * processes them, and caches the result.
+   * Subsequent calls will return cached data unless `forceRefresh` is true.
+   *
+   * @param forceRefresh - If true, fetches from the API even if data is already cached. Defaults to false.
+   * @returns A promise that resolves to the map of entitlements (EntitlementMap).
+   * @throws Will throw an error if the API request fails after all retries.
+   */
+  async fetchAllEntitlements(t = !1) {
+    if (this.isFetching)
+      return Promise.reject(
+        new Error("[Kelviq SDK] An entitlement fetch is already in progress.")
+      );
+    if (this.entitlementsCache && !t)
+      return Promise.resolve(this.entitlementsCache);
+    this.isFetching = !0, this.lastFetchError = null;
+    const {
+      apiUrl: e = this.options.environment === "sandbox" ? U : I,
+      entitlementsPath: n,
+      customerId: m,
+      accessToken: i,
+      apiConfig: p,
+      onError: o
+    } = this.options, g = e.replace(/\/$/, ""), a = n.replace(/^\//, ""), d = `${g}/${a}`, q = {
+      customer_id: m
+    };
+    try {
+      const l = await this.apiRequestService(
+        {
+          url: d,
+          method: "GET",
+          queryParams: q,
+          accessToken: i,
+          ...p || {}
+        }
+      );
+      if (l && l.data && Array.isArray(l.data.entitlements))
+        return this.entitlementsCache = R(l.data), this.isFetching = !1, this.entitlementsCache;
+      {
+        const u = new Error(
+          "[Kelviq SDK] Received empty, malformed, or invalid data structure from entitlements API."
+        );
+        throw this.lastFetchError = u, this.isFetching = !1, this.entitlementsCache = null, o && o(u), u;
+      }
+    } catch (l) {
+      const u = l instanceof Error ? l : new Error(String(l));
+      throw this.lastFetchError = u, this.isFetching = !1, this.entitlementsCache = null, o && o(u), u;
+    }
+  }
+  /**
+   * Retrieves a specific entitlement from the local cache.
+   * Note: `fetchAllEntitlements()` must be called successfully at least once before using this method,
+   * or the cache will be empty.
+   *
+   * @param featureId The unique key of the feature.
+   * @param type The expected type of the entitlement ('boolean', 'config', 'metered').
+   * @returns The processed entitlement object if found in the cache and the type matches, otherwise `null`.
+   * Logs a warning if entitlements haven't been fetched or if a type mismatch occurs.
+   */
+  getEntitlement(t, e) {
+    if (!this.entitlementsCache)
+      return console.warn(
+        `[Kelviq SDK] getEntitlement: Entitlements not fetched or cache is empty for featureId '${t}'. Call fetchAllEntitlements() first.`
+      ), null;
+    const n = this.entitlementsCache[t];
+    return n ? n.type === e ? n : (console.warn(
+      `[Kelviq SDK] getEntitlement: Type mismatch for featureId '${t}'. Expected type '${e}', but cached type is '${n.type}'.`
+    ), null) : null;
+  }
+  /**
+   * Checks if the user has access to a specific feature based on cached entitlements.
+   * Note: `fetchAllEntitlements()` should be called successfully at least once before using this method.
+   *
+   * @param featureId The key of the feature.
+   * @returns `true` if access is granted, `false` if denied or the feature is not found in the cache.
+   * Logs a warning and returns `false` if entitlements haven't been fetched.
+   */
+  hasAccess(t) {
+    if (!this.entitlementsCache)
+      return console.warn(
+        `[Kelviq SDK] hasAccess: Entitlements not fetched yet for featureId '${t}'. Call fetchAllEntitlements() first. Returning false.`
+      ), !1;
+    const e = this.entitlementsCache[t];
+    return e ? e.hasAccess : !1;
+  }
+  /**
+   * Returns the currently cached map of all entitlements.
+   * `fetchAllEntitlements()` should be called successfully at least once.
+   * @returns The EntitlementMap (a record of featureKey to entitlement data) or `null` if not fetched or an error occurred during the last fetch.
+   */
+  getAllEntitlements() {
+    return this.entitlementsCache;
+  }
+  /**
+   * Indicates if an entitlement fetch operation is currently in progress.
+   * @returns `true` if a fetch is in progress, `false` otherwise.
+   */
+  isLoading() {
+    return this.isFetching;
+  }
+  /**
+   * Returns the last error that occurred during an entitlement fetch operation.
+   * @returns An `Error` object if the last fetch failed, otherwise `null`.
+   */
+  getLastError() {
+    return this.lastFetchError;
+  }
+  /**
+   * Clears the local entitlement cache and resets loading and error states.
+   * After calling this, `fetchAllEntitlements()` will need to be called again to populate the cache.
+   */
+  clearCache() {
+    this.entitlementsCache = null, this.isFetching = !1, this.lastFetchError = null, console.log("[Kelviq SDK] Entitlement cache cleared.");
+  }
+}
+function _(r, t) {
+  const e = {
+    ...r,
+    initializeAndFetch: r.initializeAndFetch || !0,
+    apiConfig: r.apiConfig || {},
+    environment: r.environment || "production",
+    entitlementsPath: r.entitlementsPath || T
+  }, n = new P(e, t);
+  return e.initializeAndFetch === !0 && n.fetchAllEntitlements().catch((m) => {
+    console.error(
+      "[Kelviq SDK] Initial fetch on client creation failed:",
+      m.message
+    );
+  }), n;
+}
+export {
+  _ as default
+};

package/dist/kelviq-js-sdk.umd.js ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,62 @@
+{
+  "name": "@kelviq/js-sdk",
+  "version": "1.0.0",
+  "module": "./dist/kelviq-js-sdk.js",
+  "type": "module",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/kelviq-js-sdk.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./dist/": {
+      "import": "./dist/",
+      "types": "./dist/"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "dev": "vite --host",
+    "build": "rimraf dist/**/* && tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
+    "lint:scripts": "eslint . --ext .ts",
+    "lint:styles": "stylelint ./**/*.{css,scss}",
+    "format:scripts": "prettier . --write",
+    "format:styles": "stylelint ./**/*.{css,scss} --fix",
+    "format": "npm run format:scripts && npm run format:styles",
+    "prepare": "husky && echo 'npx lint-staged' > .husky/pre-commit && git add .husky/pre-commit",
+    "uninstall-husky": "npm uninstall husky --no-save && git config --unset core.hooksPath && npx rimraf .husky"
+  },
+  "devDependencies": {
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^22.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "@vitest/coverage-v8": "^2.0.4",
+    "copyfiles": "^2.4.1",
+    "dts-bundle-generator": "^9.5.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "husky": "^9.1.4",
+    "lint-staged": "^15.2.7",
+    "postcss": "^8.4.40",
+    "postcss-scss": "^4.0.9",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "stylelint": "^16.8.1",
+    "stylelint-config-recommended": "^14.0.1",
+    "stylelint-config-sass-guidelines": "^12.0.0",
+    "stylelint-order": "^6.0.4",
+    "stylelint-prettier": "^5.0.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3",
+    "vite": "^5.3.5",
+    "vitest": "^2.0.4"
+  }
+}