fuze-store-shared 1.0.0 → 1.0.1

package/.prettierignore

@@ -0,0 +1,2 @@
+build/
+node_modules/

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "endOfLine": "auto"
+}

package/dist/enums/index.d.ts

@@ -0,0 +1,11 @@
+export * from './plan.enum';
+export * from './subscription.enum';
+import * as planEnum from './plan.enum';
+import * as subscriptionEnum from './subscription.enum';
+declare const enums: {
+    Status: typeof subscriptionEnum.Status;
+    Feature: typeof planEnum.Feature;
+    Plan: typeof planEnum.Plan;
+};
+export default enums;
+//# sourceMappingURL=index.d.ts.map

package/dist/enums/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/enums/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AAGpC,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AAGxD,QAAA,MAAM,KAAK;;;;CAGV,CAAC;AAEF,eAAe,KAAK,CAAC"}

package/dist/enums/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+// Named exports
+__exportStar(require("./plan.enum"), exports);
+__exportStar(require("./subscription.enum"), exports);
+// Default export object
+const planEnum = __importStar(require("./plan.enum"));
+const subscriptionEnum = __importStar(require("./subscription.enum"));
+const enums = {
+    ...planEnum,
+    ...subscriptionEnum,
+};
+exports.default = enums;
+//# sourceMappingURL=index.js.map

package/dist/enums/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gBAAgB;AAChB,8CAA4B;AAC5B,sDAAoC;AAEpC,wBAAwB;AACxB,sDAAwC;AACxC,sEAAwD;AAGxD,MAAM,KAAK,GAAG;IACZ,GAAG,QAAQ;IACX,GAAG,gBAAgB;CACpB,CAAC;AAEF,kBAAe,KAAK,CAAC"}

package/dist/enums/plan.enum.d.ts

@@ -0,0 +1,47 @@
+/**
+ * List of plan enums
+ *
+ * @module PlanEnums
+ * @category Enums
+ *
+ */
+export declare enum Feature {
+    DASHBOARD = "dashboard",
+    POS = "pos",
+    EVENT_BASIC = "event_basic",// List View
+    EVENT_ADVANCED = "event_advanced",// Calendar, Agenda, Day, List View
+    AREA = "area",// Area Management
+    UNIT = "unit",// Unit Management
+    TRANSACTIONS = "transactions",// Order Histories, Sales Transactions
+    REFUNDS = "refunds",// Sales Refunds
+    CATALOGS = "catalogs",// Categories, Products, Services, Modifiers
+    STAFFS = "staffs",
+    CUSTOMERS = "customers",
+    ROLES_AND_PERMISSIONS = "roles_and_permissions",
+    REALTIME_SYNC = "realtime_sync",
+    IMPORT_DATA = "import_data",
+    EXPORT_DATA = "export_data",
+    TAXES = "taxes",
+    ORDER_HISTORIES = "order_histories",
+    GIFT_CARDS = "gift_cards",
+    REPORTS_BASICS = "reports_basic",// View Basic Reports
+    REPORTS_ADVANCED = "reports_advanced",// View, Download Reports
+    EXPENSES = "expenses",
+    DISCOUNTS_BASIC = "discounts_basic",// Basic Discounts
+    DISCOUNTS_ADVANCED = "discounts_advanced",// Basic with Schedules
+    STORE_SESSION = "store_session",// Store Session Management
+    EMAIL_NOTIFICATIONS = "email_notifications",// Email Notifications
+    SMS_NOTIFICATIONS = "sms_notifications",// TODO=
+    PRINTER = "printer",
+    STORE_LIMIT = "store_limit",
+    WAITING_LIST = "waiting_list",
+    AI_AGENT = "ai_agent"
+}
+export declare enum Plan {
+    FREETRIAL = "FREETRIAL",
+    STARTER = "STARTER",
+    BASIC = "BASIC",
+    STANDARD = "STANDARD",
+    PREMIUM = "PREMIUM"
+}
+//# sourceMappingURL=plan.enum.d.ts.map

package/dist/enums/plan.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.enum.d.ts","sourceRoot":"","sources":["../../src/enums/plan.enum.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,oBAAY,OAAO;IACjB,SAAS,cAAc;IACvB,GAAG,QAAQ;IACX,WAAW,gBAAgB,CAAE,YAAY;IACzC,cAAc,mBAAmB,CAAE,mCAAmC;IACtE,IAAI,SAAS,CAAE,kBAAkB;IACjC,IAAI,SAAS,CAAE,kBAAkB;IACjC,YAAY,iBAAiB,CAAE,sCAAsC;IACrE,OAAO,YAAY,CAAE,gBAAgB;IACrC,QAAQ,aAAa,CAAE,4CAA4C;IACnE,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,qBAAqB,0BAA0B;IAC/C,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,eAAe,oBAAoB;IACnC,UAAU,eAAe;IACzB,cAAc,kBAAkB,CAAE,qBAAqB;IACvD,gBAAgB,qBAAqB,CAAE,yBAAyB;IAChE,QAAQ,aAAa;IACrB,eAAe,oBAAoB,CAAE,kBAAkB;IACvD,kBAAkB,uBAAuB,CAAE,uBAAuB;IAClE,aAAa,kBAAkB,CAAE,2BAA2B;IAC5D,mBAAmB,wBAAwB,CAAE,sBAAsB;IACnE,iBAAiB,sBAAsB,CAAE,QAAQ;IACjD,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;CACtB;AAED,oBAAY,IAAI;IACd,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB"}

package/dist/enums/plan.enum.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * List of plan enums
+ *
+ * @module PlanEnums
+ * @category Enums
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plan = exports.Feature = void 0;
+var Feature;
+(function (Feature) {
+    Feature["DASHBOARD"] = "dashboard";
+    Feature["POS"] = "pos";
+    Feature["EVENT_BASIC"] = "event_basic";
+    Feature["EVENT_ADVANCED"] = "event_advanced";
+    Feature["AREA"] = "area";
+    Feature["UNIT"] = "unit";
+    Feature["TRANSACTIONS"] = "transactions";
+    Feature["REFUNDS"] = "refunds";
+    Feature["CATALOGS"] = "catalogs";
+    Feature["STAFFS"] = "staffs";
+    Feature["CUSTOMERS"] = "customers";
+    Feature["ROLES_AND_PERMISSIONS"] = "roles_and_permissions";
+    Feature["REALTIME_SYNC"] = "realtime_sync";
+    Feature["IMPORT_DATA"] = "import_data";
+    Feature["EXPORT_DATA"] = "export_data";
+    Feature["TAXES"] = "taxes";
+    Feature["ORDER_HISTORIES"] = "order_histories";
+    Feature["GIFT_CARDS"] = "gift_cards";
+    Feature["REPORTS_BASICS"] = "reports_basic";
+    Feature["REPORTS_ADVANCED"] = "reports_advanced";
+    Feature["EXPENSES"] = "expenses";
+    Feature["DISCOUNTS_BASIC"] = "discounts_basic";
+    Feature["DISCOUNTS_ADVANCED"] = "discounts_advanced";
+    Feature["STORE_SESSION"] = "store_session";
+    Feature["EMAIL_NOTIFICATIONS"] = "email_notifications";
+    Feature["SMS_NOTIFICATIONS"] = "sms_notifications";
+    Feature["PRINTER"] = "printer";
+    Feature["STORE_LIMIT"] = "store_limit";
+    Feature["WAITING_LIST"] = "waiting_list";
+    Feature["AI_AGENT"] = "ai_agent";
+})(Feature || (exports.Feature = Feature = {}));
+var Plan;
+(function (Plan) {
+    Plan["FREETRIAL"] = "FREETRIAL";
+    Plan["STARTER"] = "STARTER";
+    Plan["BASIC"] = "BASIC";
+    Plan["STANDARD"] = "STANDARD";
+    Plan["PREMIUM"] = "PREMIUM";
+})(Plan || (exports.Plan = Plan = {}));
+//# sourceMappingURL=plan.enum.js.map

package/dist/enums/plan.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.enum.js","sourceRoot":"","sources":["../../src/enums/plan.enum.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,IAAY,OA+BX;AA/BD,WAAY,OAAO;IACjB,kCAAuB,CAAA;IACvB,sBAAW,CAAA;IACX,sCAA2B,CAAA;IAC3B,4CAAiC,CAAA;IACjC,wBAAa,CAAA;IACb,wBAAa,CAAA;IACb,wCAA6B,CAAA;IAC7B,8BAAmB,CAAA;IACnB,gCAAqB,CAAA;IACrB,4BAAiB,CAAA;IACjB,kCAAuB,CAAA;IACvB,0DAA+C,CAAA;IAC/C,0CAA+B,CAAA;IAC/B,sCAA2B,CAAA;IAC3B,sCAA2B,CAAA;IAC3B,0BAAe,CAAA;IACf,8CAAmC,CAAA;IACnC,oCAAyB,CAAA;IACzB,2CAAgC,CAAA;IAChC,gDAAqC,CAAA;IACrC,gCAAqB,CAAA;IACrB,8CAAmC,CAAA;IACnC,oDAAyC,CAAA;IACzC,0CAA+B,CAAA;IAC/B,sDAA2C,CAAA;IAC3C,kDAAuC,CAAA;IACvC,8BAAmB,CAAA;IACnB,sCAA2B,CAAA;IAC3B,wCAA6B,CAAA;IAC7B,gCAAqB,CAAA;AACvB,CAAC,EA/BW,OAAO,uBAAP,OAAO,QA+BlB;AAED,IAAY,IAMX;AAND,WAAY,IAAI;IACd,+BAAuB,CAAA;IACvB,2BAAmB,CAAA;IACnB,uBAAe,CAAA;IACf,6BAAqB,CAAA;IACrB,2BAAmB,CAAA;AACrB,CAAC,EANW,IAAI,oBAAJ,IAAI,QAMf"}

package/dist/enums/subscription.enum.d.ts

@@ -0,0 +1,13 @@
+/**
+ * List of subscription enums
+ *
+ * @module SubscriptionEnums
+ * @category Enums
+ *
+ */
+export declare enum Status {
+    ACTIVE = "ACTIVE",
+    PENDING = "PENDING",
+    CANCELED = "CANCELED"
+}
+//# sourceMappingURL=subscription.enum.d.ts.map

package/dist/enums/subscription.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.enum.d.ts","sourceRoot":"","sources":["../../src/enums/subscription.enum.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,oBAAY,MAAM;IAChB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB"}

package/dist/enums/subscription.enum.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * List of subscription enums
+ *
+ * @module SubscriptionEnums
+ * @category Enums
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Status = void 0;
+var Status;
+(function (Status) {
+    Status["ACTIVE"] = "ACTIVE";
+    Status["PENDING"] = "PENDING";
+    Status["CANCELED"] = "CANCELED";
+})(Status || (exports.Status = Status = {}));
+//# sourceMappingURL=subscription.enum.js.map

package/dist/enums/subscription.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.enum.js","sourceRoot":"","sources":["../../src/enums/subscription.enum.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,2BAAiB,CAAA;IACjB,6BAAmB,CAAA;IACnB,+BAAqB,CAAA;AACvB,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB"}

package/dist/helpers/date.helper.d.ts

@@ -0,0 +1,18 @@
+/**
+ * List of date helpers
+ *
+ * @module DateHelper
+ * @category Helpers
+ *
+ */
+/**
+ * Formats a given date into a specified string pattern.
+ *
+ * @param date - The date to format, which can be a `Date` object or an ISO date string. If omitted, returns an empty string.
+ * @param patterns - The format pattern to use (default: `'MMM dd, yyyy hh:mm aa'`).
+ * @returns The formatted date string, or an empty string if no date is provided.
+ *
+ * @see https://date-fns.org/docs/format
+ */
+export declare function formatDate(date?: Date | string, patterns?: string): string;
+//# sourceMappingURL=date.helper.d.ts.map

package/dist/helpers/date.helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/date.helper.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,EACpB,QAAQ,SAA0B,UAOnC"}

package/dist/helpers/date.helper.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * List of date helpers
+ *
+ * @module DateHelper
+ * @category Helpers
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDate = formatDate;
+const date_fns_1 = require("date-fns");
+/**
+ * Formats a given date into a specified string pattern.
+ *
+ * @param date - The date to format, which can be a `Date` object or an ISO date string. If omitted, returns an empty string.
+ * @param patterns - The format pattern to use (default: `'MMM dd, yyyy hh:mm aa'`).
+ * @returns The formatted date string, or an empty string if no date is provided.
+ *
+ * @see https://date-fns.org/docs/format
+ */
+function formatDate(date, patterns = 'MMM dd, yyyy hh:mm aa') {
+    if (date) {
+        return (0, date_fns_1.format)(new Date(date), patterns);
+    }
+    return '';
+}
+//# sourceMappingURL=date.helper.js.map

package/dist/helpers/date.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.helper.js","sourceRoot":"","sources":["../../src/helpers/date.helper.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAaH,gCASC;AApBD,uCAAkC;AAElC;;;;;;;;GAQG;AACH,SAAgB,UAAU,CACxB,IAAoB,EACpB,QAAQ,GAAG,uBAAuB;IAElC,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,IAAA,iBAAM,EAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/dist/helpers/index.d.ts

@@ -0,0 +1,6 @@
+export * from './date.helper';
+declare const helper: {
+    formatDate(date?: Date | string, patterns?: string): string;
+};
+export default helper;
+//# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAM9B,QAAA,MAAM,MAAM;;CAEX,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/helpers/index.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+// Named exports
+__exportStar(require("./date.helper"), exports);
+// Default export object
+const dateHelper = __importStar(require("./date.helper"));
+const helper = {
+    ...dateHelper,
+};
+exports.default = helper;
+//# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gBAAgB;AAChB,gDAA8B;AAE9B,wBAAwB;AACxB,0DAA4C;AAG5C,MAAM,MAAM,GAAG;IACb,GAAG,UAAU;CACd,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/dist/helpers/plan.helper.d.ts

@@ -0,0 +1,72 @@
+/**
+ * List of plan helpers
+ *
+ * @module PlanHelper
+ * @category Helpers
+ *
+ */
+import { Plan as SubscriptionPlan } from '../enums/plan.enum';
+import { Plan, PlanFeatureValue } from '../types/plan';
+/**
+ * A mapping of feature keys to their corresponding human-readable labels.
+ *
+ * This record is used to display user-friendly names for various features
+ * throughout the application, such as in plan selection, feature lists, or UI components.
+ *
+ * @remarks
+ * Each key represents a unique feature identifier, and the value is the label shown to users.
+ *
+ * @example
+ * ```typescript
+ * const label = featureLabels['dashboard']; // "Dashboard"
+ * ```
+ */
+export declare const featureLabels: Record<string, string>;
+/**
+ * Returns the features that are unique to a specific plan compared to all lower-tier plans.
+ *
+ * The function compares the features of the target plan against all plans lower in the hierarchy.
+ * A feature is considered unique if all lower-tier plans either lack the feature or have a strictly lesser value.
+ * Supports boolean and numeric feature values.
+ *
+ * @param planCode - The code of the target plan to compare (case-insensitive).
+ * @param plans - An array of all available plans, each with a code and features.
+ * @returns An object mapping feature keys to their unique values for the target plan.
+ * @throws If the plan code is invalid or the plan is not found in the provided plans array.
+ */
+export declare function getUniqueFeaturesByPlan(planCode: SubscriptionPlan, plans: Plan[]): Record<string, PlanFeatureValue>;
+/**
+ * Returns an array of unique feature names for a given subscription plan.
+ *
+ * @param planCode - The code representing the subscription plan to retrieve features for.
+ * @param plans - An array of available plans to search for unique features.
+ * @returns An array of strings representing the names of unique features for the specified plan.
+ */
+export declare function getUniqueKeyFeaturesByPlan(planCode: SubscriptionPlan, plans: Plan[]): string[];
+/**
+ * Returns a mapping of feature keys to the values of those features in plans
+ * that differ from the PREMIUM plan.
+ *
+ * For each feature in the PREMIUM plan, if any other plan has a different value
+ * for that feature, the result will include an entry for that feature. The entry
+ * maps each plan code (excluding PREMIUM) to its differing feature value.
+ *
+ * @param plans - Array of Plan objects to compare, each containing a set of features.
+ * @returns An object where each key is a feature that differs from the PREMIUM plan,
+ *          and the value is an object mapping plan codes to their differing feature values.
+ */
+export declare function getDifferentFeaturesValues(plans: Plan[]): Record<string, Record<string, PlanFeatureValue>>;
+/**
+ * Returns a formatted string representation of a plan feature value based on the feature type.
+ *
+ * - For numeric values, formats the value and appends a descriptive label depending on the feature.
+ * - For boolean values, returns "Unlimited" for certain features if `true`, otherwise "Included".
+ * - For string values, returns the value as-is.
+ * - Returns "--" if the value does not match any expected type.
+ *
+ * @param value - The value of the plan feature, which can be a number, boolean, or string.
+ * @param feature - The feature key used to determine formatting and labeling.
+ * @returns A formatted string representing the feature value for display purposes.
+ */
+export declare function getFeatureValue(value: PlanFeatureValue, feature: string): string;
+//# sourceMappingURL=plan.helper.d.ts.map

package/dist/helpers/plan.helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/plan.helper.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAW,IAAI,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CA8BhD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,IAAI,EAAE,oCAwCd;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,IAAI,EAAE,YAId;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,IAAI,EAAE,GACZ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CA0BlD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,UAkEvE"}

package/dist/helpers/plan.helper.js

@@ -0,0 +1,211 @@
+"use strict";
+/**
+ * List of plan helpers
+ *
+ * @module PlanHelper
+ * @category Helpers
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.featureLabels = void 0;
+exports.getUniqueFeaturesByPlan = getUniqueFeaturesByPlan;
+exports.getUniqueKeyFeaturesByPlan = getUniqueKeyFeaturesByPlan;
+exports.getDifferentFeaturesValues = getDifferentFeaturesValues;
+exports.getFeatureValue = getFeatureValue;
+const plan_enum_1 = require("../enums/plan.enum");
+/**
+ * A mapping of feature keys to their corresponding human-readable labels.
+ *
+ * This record is used to display user-friendly names for various features
+ * throughout the application, such as in plan selection, feature lists, or UI components.
+ *
+ * @remarks
+ * Each key represents a unique feature identifier, and the value is the label shown to users.
+ *
+ * @example
+ * ```typescript
+ * const label = featureLabels['dashboard']; // "Dashboard"
+ * ```
+ */
+exports.featureLabels = {
+    dashboard: 'Dashboard',
+    pos: 'Point of Sales',
+    event_basic: 'Basic Events',
+    event_advanced: 'Advanced Events',
+    area: 'Area Management',
+    unit: 'Table/Room Management',
+    transactions: 'Sale Transactions',
+    refunds: 'Refunds',
+    catalogs: 'Catalog Management',
+    staffs: 'Staffs',
+    customers: 'Customers',
+    roles_and_permissions: 'Roles and Permissions',
+    import_data: 'Import Data',
+    export_data: 'Export Data',
+    order_histories: 'Order Histories',
+    waiting_list: 'Waiting List',
+    taxes: 'Taxes',
+    gift_cards: 'Gift Cards',
+    reports_basic: 'Basic Reports',
+    reports_advanced: 'Advanced Reports',
+    discounts_basic: 'Basic Discounts',
+    discounts_advanced: 'Advanced Discounts',
+    store_session: 'Store Session',
+    email_notifications: 'Email Notifications',
+    sms_notifications: 'SMS Notifications',
+    printer: 'Printer Integration',
+    ai_agent: 'AI Assistant',
+    store_limit: 'Store Limit',
+    realtime_sync: 'Real-time Sync',
+};
+/**
+ * Returns the features that are unique to a specific plan compared to all lower-tier plans.
+ *
+ * The function compares the features of the target plan against all plans lower in the hierarchy.
+ * A feature is considered unique if all lower-tier plans either lack the feature or have a strictly lesser value.
+ * Supports boolean and numeric feature values.
+ *
+ * @param planCode - The code of the target plan to compare (case-insensitive).
+ * @param plans - An array of all available plans, each with a code and features.
+ * @returns An object mapping feature keys to their unique values for the target plan.
+ * @throws If the plan code is invalid or the plan is not found in the provided plans array.
+ */
+function getUniqueFeaturesByPlan(planCode, plans) {
+    const hierarchy = [
+        plan_enum_1.Plan.FREETRIAL,
+        plan_enum_1.Plan.BASIC,
+        plan_enum_1.Plan.STARTER,
+        plan_enum_1.Plan.STANDARD,
+        plan_enum_1.Plan.PREMIUM,
+    ];
+    const targetIndex = hierarchy.indexOf(planCode);
+    if (targetIndex === -1)
+        throw new Error('Invalid plan code');
+    const targetPlan = plans.find((p) => p.code === planCode);
+    if (!targetPlan)
+        throw new Error('Plan not found');
+    const lowerPlans = plans.filter((p) => hierarchy.indexOf(p.code) < targetIndex);
+    const uniqueFeatures = {};
+    // 1️⃣ Find features unique/improved vs lower plans
+    for (const [featureKey, featureValue] of Object.entries(targetPlan.features)) {
+        const isUnique = lowerPlans.every((lp) => {
+            const lowerValue = lp.features[featureKey];
+            if (typeof featureValue === 'boolean') {
+                return featureValue && !lowerValue;
+            }
+            if (typeof featureValue === 'number' && typeof lowerValue === 'number') {
+                return featureValue > lowerValue;
+            }
+            return featureValue !== lowerValue;
+        });
+        if (isUnique)
+            uniqueFeatures[featureKey] = featureValue;
+    }
+    return uniqueFeatures;
+}
+/**
+ * Returns an array of unique feature names for a given subscription plan.
+ *
+ * @param planCode - The code representing the subscription plan to retrieve features for.
+ * @param plans - An array of available plans to search for unique features.
+ * @returns An array of strings representing the names of unique features for the specified plan.
+ */
+function getUniqueKeyFeaturesByPlan(planCode, plans) {
+    const uniqueFeatures = getUniqueFeaturesByPlan(planCode, plans);
+    return Object.keys(uniqueFeatures);
+}
+/**
+ * Returns a mapping of feature keys to the values of those features in plans
+ * that differ from the PREMIUM plan.
+ *
+ * For each feature in the PREMIUM plan, if any other plan has a different value
+ * for that feature, the result will include an entry for that feature. The entry
+ * maps each plan code (excluding PREMIUM) to its differing feature value.
+ *
+ * @param plans - Array of Plan objects to compare, each containing a set of features.
+ * @returns An object where each key is a feature that differs from the PREMIUM plan,
+ *          and the value is an object mapping plan codes to their differing feature values.
+ */
+function getDifferentFeaturesValues(plans) {
+    const targetPlan = plans.find((p) => p.code === plan_enum_1.Plan.PREMIUM);
+    if (!targetPlan)
+        return {};
+    const differentFeatures = {};
+    // Find features that differ from any other plan (lower OR higher)
+    for (const [featureKey, featureValue] of Object.entries(targetPlan.features)) {
+        const otherValues = plans.map((p) => p.features[featureKey]);
+        const hasDifference = otherValues.some((v) => v !== featureValue);
+        if (hasDifference) {
+            differentFeatures[featureKey] = Object.fromEntries(plans
+                .map((p) => [p.code, p.features[featureKey]])
+                .filter(([_, v]) => v !== featureValue));
+        }
+    }
+    return differentFeatures;
+}
+/**
+ * Returns a formatted string representation of a plan feature value based on the feature type.
+ *
+ * - For numeric values, formats the value and appends a descriptive label depending on the feature.
+ * - For boolean values, returns "Unlimited" for certain features if `true`, otherwise "Included".
+ * - For string values, returns the value as-is.
+ * - Returns "--" if the value does not match any expected type.
+ *
+ * @param value - The value of the plan feature, which can be a number, boolean, or string.
+ * @param feature - The feature key used to determine formatting and labeling.
+ * @returns A formatted string representing the feature value for display purposes.
+ */
+function getFeatureValue(value, feature) {
+    if (typeof value === 'number') {
+        const formattedValue = Intl.NumberFormat('en-US', {
+            maximumFractionDigits: 0,
+        }).format(value);
+        if (feature === plan_enum_1.Feature.POS) {
+            return `${formattedValue} orders per month`;
+        }
+        if (feature === plan_enum_1.Feature.AREA) {
+            return `${formattedValue} area(s)`;
+        }
+        if (feature === plan_enum_1.Feature.TRANSACTIONS ||
+            feature === plan_enum_1.Feature.ORDER_HISTORIES) {
+            return `up to last ${formattedValue} month(s)`;
+        }
+        if (feature === plan_enum_1.Feature.CATALOGS) {
+            return `${formattedValue} products / services`;
+        }
+        if (feature === plan_enum_1.Feature.STAFFS) {
+            return `${formattedValue} staff(s)`;
+        }
+        if (feature === plan_enum_1.Feature.CUSTOMERS) {
+            return `${formattedValue} saved customer(s)`;
+        }
+        if (feature === plan_enum_1.Feature.STORE_LIMIT) {
+            return `up to ${formattedValue} store(s)`;
+        }
+    }
+    if ((feature === plan_enum_1.Feature.STORE_LIMIT ||
+        feature === plan_enum_1.Feature.EVENT_ADVANCED ||
+        feature === plan_enum_1.Feature.STAFFS ||
+        feature === plan_enum_1.Feature.UNIT ||
+        feature === plan_enum_1.Feature.POS ||
+        feature === plan_enum_1.Feature.TRANSACTIONS ||
+        feature === plan_enum_1.Feature.CATALOGS ||
+        feature === plan_enum_1.Feature.CUSTOMERS ||
+        feature === plan_enum_1.Feature.SMS_NOTIFICATIONS ||
+        feature === plan_enum_1.Feature.AI_AGENT ||
+        feature === plan_enum_1.Feature.AREA) &&
+        value === true) {
+        return 'Unlimited';
+    }
+    if (value === true) {
+        return 'Included';
+    }
+    else if (typeof value === 'number') {
+        return Intl.NumberFormat('en-US', { maximumFractionDigits: 0 }).format(value);
+    }
+    else if (typeof value === 'string') {
+        return value;
+    }
+    return '--';
+}
+//# sourceMappingURL=plan.helper.js.map

package/dist/helpers/plan.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.helper.js","sourceRoot":"","sources":["../../src/helpers/plan.helper.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AA+DH,0DA0CC;AASD,gEAMC;AAcD,gEA4BC;AAcD,0CAkEC;AAhPD,kDAAuE;AAGvE;;;;;;;;;;;;;GAaG;AACU,QAAA,aAAa,GAA2B;IACnD,SAAS,EAAE,WAAW;IACtB,GAAG,EAAE,gBAAgB;IACrB,WAAW,EAAE,cAAc;IAC3B,cAAc,EAAE,iBAAiB;IACjC,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,uBAAuB;IAC7B,YAAY,EAAE,mBAAmB;IACjC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,oBAAoB;IAC9B,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,qBAAqB,EAAE,uBAAuB;IAC9C,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,gBAAgB,EAAE,kBAAkB;IACpC,eAAe,EAAE,iBAAiB;IAClC,kBAAkB,EAAE,oBAAoB;IACxC,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,iBAAiB,EAAE,mBAAmB;IACtC,OAAO,EAAE,qBAAqB;IAC9B,QAAQ,EAAE,cAAc;IACxB,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,gBAAgB;CAChC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,uBAAuB,CACrC,QAA0B,EAC1B,KAAa;IAEb,MAAM,SAAS,GAAG;QAChB,gBAAgB,CAAC,SAAS;QAC1B,gBAAgB,CAAC,KAAK;QACtB,gBAAgB,CAAC,OAAO;QACxB,gBAAgB,CAAC,QAAQ;QACzB,gBAAgB,CAAC,OAAO;KACzB,CAAC;IACF,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE7D,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IAC1D,IAAI,CAAC,UAAU;QAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEnD,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAC7B,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAC/C,CAAC;IAEF,MAAM,cAAc,GAAqB,EAAE,CAAC;IAE5C,mDAAmD;IACnD,KAAK,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CACrD,UAAU,CAAC,QAAQ,CACpB,EAAE,CAAC;QACF,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE;YACvC,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC3C,IAAI,OAAO,YAAY,KAAK,SAAS,EAAE,CAAC;gBACtC,OAAO,YAAY,IAAI,CAAC,UAAU,CAAC;YACrC,CAAC;YACD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBACvE,OAAO,YAAY,GAAG,UAAU,CAAC;YACnC,CAAC;YACD,OAAO,YAAY,KAAK,UAAU,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ;YAAE,cAAc,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IAC1D,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACxC,QAA0B,EAC1B,KAAa;IAEb,MAAM,cAAc,GAAG,uBAAuB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,0BAA0B,CACxC,KAAa;IAEb,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC1E,IAAI,CAAC,UAAU;QAAE,OAAO,EAAE,CAAC;IAE3B,MAAM,iBAAiB,GAGnB,EAAE,CAAC;IAEP,kEAAkE;IAClE,KAAK,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CACrD,UAAU,CAAC,QAAQ,CACpB,EAAE,CAAC;QACF,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC;QAElE,IAAI,aAAa,EAAE,CAAC;YAClB,iBAAiB,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,WAAW,CAChD,KAAK;iBACF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;iBAC5C,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,CAAC,CAC1C,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAAC,KAAuB,EAAE,OAAe;IACtE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;YAChD,qBAAqB,EAAE,CAAC;SACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEjB,IAAI,OAAO,KAAK,mBAAO,CAAC,GAAG,EAAE,CAAC;YAC5B,OAAO,GAAG,cAAc,mBAAmB,CAAC;QAC9C,CAAC;QAED,IAAI,OAAO,KAAK,mBAAO,CAAC,IAAI,EAAE,CAAC;YAC7B,OAAO,GAAG,cAAc,UAAU,CAAC;QACrC,CAAC;QAED,IACE,OAAO,KAAK,mBAAO,CAAC,YAAY;YAChC,OAAO,KAAK,mBAAO,CAAC,eAAe,EACnC,CAAC;YACD,OAAO,cAAc,cAAc,WAAW,CAAC;QACjD,CAAC;QAED,IAAI,OAAO,KAAK,mBAAO,CAAC,QAAQ,EAAE,CAAC;YACjC,OAAO,GAAG,cAAc,sBAAsB,CAAC;QACjD,CAAC;QAED,IAAI,OAAO,KAAK,mBAAO,CAAC,MAAM,EAAE,CAAC;YAC/B,OAAO,GAAG,cAAc,WAAW,CAAC;QACtC,CAAC;QAED,IAAI,OAAO,KAAK,mBAAO,CAAC,SAAS,EAAE,CAAC;YAClC,OAAO,GAAG,cAAc,oBAAoB,CAAC;QAC/C,CAAC;QAED,IAAI,OAAO,KAAK,mBAAO,CAAC,WAAW,EAAE,CAAC;YACpC,OAAO,SAAS,cAAc,WAAW,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,IACE,CAAC,OAAO,KAAK,mBAAO,CAAC,WAAW;QAC9B,OAAO,KAAK,mBAAO,CAAC,cAAc;QAClC,OAAO,KAAK,mBAAO,CAAC,MAAM;QAC1B,OAAO,KAAK,mBAAO,CAAC,IAAI;QACxB,OAAO,KAAK,mBAAO,CAAC,GAAG;QACvB,OAAO,KAAK,mBAAO,CAAC,YAAY;QAChC,OAAO,KAAK,mBAAO,CAAC,QAAQ;QAC5B,OAAO,KAAK,mBAAO,CAAC,SAAS;QAC7B,OAAO,KAAK,mBAAO,CAAC,iBAAiB;QACrC,OAAO,KAAK,mBAAO,CAAC,QAAQ;QAC5B,OAAO,KAAK,mBAAO,CAAC,IAAI,CAAC;QAC3B,KAAK,KAAK,IAAI,EACd,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CACpE,KAAK,CACN,CAAC;IACJ,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/types/plan.d.ts

@@ -1,4 +1,5 @@
-export type PlanCode = 'FREE' | 'BASIC' | 'STARTER' | 'STANDARD' | 'PREMIUM';
+import { Plan as PlanCode } from '../enums/plan.enum';
+export type PlanFeatureValue = string | number | boolean;
 export type Plan = {
     id: string;
     name: string;
@@ -8,6 +9,6 @@ export type Plan = {
     commissionRate: number;
     currency: string;
     code: PlanCode;
-    features: Record<string, string | number | boolean>;
+    features: Record<string, PlanFeatureValue>;
 };
 //# sourceMappingURL=plan.d.ts.map

package/dist/types/plan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../src/types/plan.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAE,SAAS,CAAC;AAE5E,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAC,MAAM,GAAC,OAAO,CAAC,CAAC;CACjD,CAAC"}
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../src/types/plan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEtD,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEzD,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC5C,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,28 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+
+const compat = new FlatCompat({
+  // import.meta.dirname is available after Node.js v20.11.0
+  baseDirectory: import.meta.dirname,
+  recommendedConfig: js.configs.recommended,
+});
+
+const eslintConfig = [
+  ...compat.config({
+    root: true,
+    extends: ['eslint:recommended', 'prettier'],
+    ignorePatterns: ['node_modules/', 'dist/'],
+    parserOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'module',
+      project: './tsconfig.json', // Required for type-aware linting
+    },
+    rules: {
+      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    },
+  }),
+  eslintPluginPrettierRecommended,
+];
+
+export default eslintConfig;

package/package.json

@@ -1,15 +1,31 @@
 {
   "name": "fuze-store-shared",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/Fuze-Store/fuze-store-shared.git",
-  "author": "kimdelrosario006 <KDelRosario@jaycar.com.au>",
+  "author": "sherlock003 <kimuel.delrosario@gmail.com>",
   "license": "MIT",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "lint": "eslint src/**/*.ts --fix",
+    "lint:check": "eslint src/**/*.ts"
   },
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^8.46.0",
+    "@typescript-eslint/parser": "^8.46.0",
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "prettier": "^3.6.2",
     "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "date-fns": "^4.1.0"
+  },
+  "exports": {
+    "./helpers": "./dist/helpers/index.js",
+    "./enums": "./dist/enums/index.js",
+    ".": "./dist/index.js"
   }
-}
+}

package/src/enums/index.ts

@@ -0,0 +1,14 @@
+// Named exports
+export * from './plan.enum';
+export * from './subscription.enum';
+
+// Default export object
+import * as planEnum from './plan.enum';
+import * as subscriptionEnum from './subscription.enum';
+
+const enums = {
+  ...planEnum,
+  ...subscriptionEnum,
+};
+
+export default enums;

package/src/enums/plan.enum.ts

@@ -0,0 +1,48 @@
+/**
+ * List of plan enums
+ *
+ * @module PlanEnums
+ * @category Enums
+ *
+ */
+
+export enum Feature {
+  DASHBOARD = 'dashboard',
+  POS = 'pos',
+  EVENT_BASIC = 'event_basic', // List View
+  EVENT_ADVANCED = 'event_advanced', // Calendar, Agenda, Day, List View
+  AREA = 'area', // Area Management
+  UNIT = 'unit', // Unit Management
+  TRANSACTIONS = 'transactions', // Order Histories, Sales Transactions
+  REFUNDS = 'refunds', // Sales Refunds
+  CATALOGS = 'catalogs', // Categories, Products, Services, Modifiers
+  STAFFS = 'staffs',
+  CUSTOMERS = 'customers',
+  ROLES_AND_PERMISSIONS = 'roles_and_permissions',
+  REALTIME_SYNC = 'realtime_sync',
+  IMPORT_DATA = 'import_data',
+  EXPORT_DATA = 'export_data',
+  TAXES = 'taxes',
+  ORDER_HISTORIES = 'order_histories',
+  GIFT_CARDS = 'gift_cards',
+  REPORTS_BASICS = 'reports_basic', // View Basic Reports
+  REPORTS_ADVANCED = 'reports_advanced', // View, Download Reports
+  EXPENSES = 'expenses',
+  DISCOUNTS_BASIC = 'discounts_basic', // Basic Discounts
+  DISCOUNTS_ADVANCED = 'discounts_advanced', // Basic with Schedules
+  STORE_SESSION = 'store_session', // Store Session Management
+  EMAIL_NOTIFICATIONS = 'email_notifications', // Email Notifications
+  SMS_NOTIFICATIONS = 'sms_notifications', // TODO=
+  PRINTER = 'printer',
+  STORE_LIMIT = 'store_limit',
+  WAITING_LIST = 'waiting_list',
+  AI_AGENT = 'ai_agent', // TODO=
+}
+
+export enum Plan {
+  FREETRIAL = 'FREETRIAL',
+  STARTER = 'STARTER',
+  BASIC = 'BASIC',
+  STANDARD = 'STANDARD',
+  PREMIUM = 'PREMIUM',
+}

package/src/enums/subscription.enum.ts

@@ -0,0 +1,13 @@
+/**
+ * List of subscription enums
+ *
+ * @module SubscriptionEnums
+ * @category Enums
+ *
+ */
+
+export enum Status {
+  ACTIVE = 'ACTIVE',
+  PENDING = 'PENDING',
+  CANCELED = 'CANCELED',
+}

package/src/helpers/date.helper.ts

@@ -0,0 +1,29 @@
+/**
+ * List of date helpers
+ *
+ * @module DateHelper
+ * @category Helpers
+ *
+ */
+
+import { format } from 'date-fns';
+
+/**
+ * Formats a given date into a specified string pattern.
+ *
+ * @param date - The date to format, which can be a `Date` object or an ISO date string. If omitted, returns an empty string.
+ * @param patterns - The format pattern to use (default: `'MMM dd, yyyy hh:mm aa'`).
+ * @returns The formatted date string, or an empty string if no date is provided.
+ * 
+ * @see https://date-fns.org/docs/format
+ */
+export function formatDate(
+  date?: Date | string,
+  patterns = 'MMM dd, yyyy hh:mm aa',
+) {
+  if (date) {
+    return format(new Date(date), patterns);
+  }
+
+  return '';
+}

package/src/helpers/index.ts

@@ -0,0 +1,11 @@
+// Named exports
+export * from './date.helper';
+
+// Default export object
+import * as dateHelper from './date.helper';
+
+const helper = {
+  ...dateHelper,
+};
+
+export default helper;

package/src/helpers/plan.helper.ts

@@ -0,0 +1,249 @@
+/**
+ * List of plan helpers
+ *
+ * @module PlanHelper
+ * @category Helpers
+ *
+ */
+
+import { Feature, Plan as SubscriptionPlan } from '../enums/plan.enum';
+import { Plan, PlanFeatureValue } from '../types/plan';
+
+/**
+ * A mapping of feature keys to their corresponding human-readable labels.
+ *
+ * This record is used to display user-friendly names for various features
+ * throughout the application, such as in plan selection, feature lists, or UI components.
+ *
+ * @remarks
+ * Each key represents a unique feature identifier, and the value is the label shown to users.
+ *
+ * @example
+ * ```typescript
+ * const label = featureLabels['dashboard']; // "Dashboard"
+ * ```
+ */
+export const featureLabels: Record<string, string> = {
+  dashboard: 'Dashboard',
+  pos: 'Point of Sales',
+  event_basic: 'Basic Events',
+  event_advanced: 'Advanced Events',
+  area: 'Area Management',
+  unit: 'Table/Room Management',
+  transactions: 'Sale Transactions',
+  refunds: 'Refunds',
+  catalogs: 'Catalog Management',
+  staffs: 'Staffs',
+  customers: 'Customers',
+  roles_and_permissions: 'Roles and Permissions',
+  import_data: 'Import Data',
+  export_data: 'Export Data',
+  order_histories: 'Order Histories',
+  waiting_list: 'Waiting List',
+  taxes: 'Taxes',
+  gift_cards: 'Gift Cards',
+  reports_basic: 'Basic Reports',
+  reports_advanced: 'Advanced Reports',
+  discounts_basic: 'Basic Discounts',
+  discounts_advanced: 'Advanced Discounts',
+  store_session: 'Store Session',
+  email_notifications: 'Email Notifications',
+  sms_notifications: 'SMS Notifications',
+  printer: 'Printer Integration',
+  ai_agent: 'AI Assistant',
+  store_limit: 'Store Limit',
+  realtime_sync: 'Real-time Sync',
+};
+
+/**
+ * Returns the features that are unique to a specific plan compared to all lower-tier plans.
+ *
+ * The function compares the features of the target plan against all plans lower in the hierarchy.
+ * A feature is considered unique if all lower-tier plans either lack the feature or have a strictly lesser value.
+ * Supports boolean and numeric feature values.
+ *
+ * @param planCode - The code of the target plan to compare (case-insensitive).
+ * @param plans - An array of all available plans, each with a code and features.
+ * @returns An object mapping feature keys to their unique values for the target plan.
+ * @throws If the plan code is invalid or the plan is not found in the provided plans array.
+ */
+export function getUniqueFeaturesByPlan(
+  planCode: SubscriptionPlan,
+  plans: Plan[],
+) {
+  const hierarchy = [
+    SubscriptionPlan.FREETRIAL,
+    SubscriptionPlan.BASIC,
+    SubscriptionPlan.STARTER,
+    SubscriptionPlan.STANDARD,
+    SubscriptionPlan.PREMIUM,
+  ];
+  const targetIndex = hierarchy.indexOf(planCode);
+  if (targetIndex === -1) throw new Error('Invalid plan code');
+
+  const targetPlan = plans.find((p) => p.code === planCode);
+  if (!targetPlan) throw new Error('Plan not found');
+
+  const lowerPlans = plans.filter(
+    (p) => hierarchy.indexOf(p.code) < targetIndex,
+  );
+
+  const uniqueFeatures: Plan['features'] = {};
+
+  // 1️⃣ Find features unique/improved vs lower plans
+  for (const [featureKey, featureValue] of Object.entries(
+    targetPlan.features,
+  )) {
+    const isUnique = lowerPlans.every((lp) => {
+      const lowerValue = lp.features[featureKey];
+      if (typeof featureValue === 'boolean') {
+        return featureValue && !lowerValue;
+      }
+      if (typeof featureValue === 'number' && typeof lowerValue === 'number') {
+        return featureValue > lowerValue;
+      }
+      return featureValue !== lowerValue;
+    });
+
+    if (isUnique) uniqueFeatures[featureKey] = featureValue;
+  }
+
+  return uniqueFeatures;
+}
+
+/**
+ * Returns an array of unique feature names for a given subscription plan.
+ *
+ * @param planCode - The code representing the subscription plan to retrieve features for.
+ * @param plans - An array of available plans to search for unique features.
+ * @returns An array of strings representing the names of unique features for the specified plan.
+ */
+export function getUniqueKeyFeaturesByPlan(
+  planCode: SubscriptionPlan,
+  plans: Plan[],
+) {
+  const uniqueFeatures = getUniqueFeaturesByPlan(planCode, plans);
+  return Object.keys(uniqueFeatures);
+}
+
+/**
+ * Returns a mapping of feature keys to the values of those features in plans
+ * that differ from the PREMIUM plan.
+ *
+ * For each feature in the PREMIUM plan, if any other plan has a different value
+ * for that feature, the result will include an entry for that feature. The entry
+ * maps each plan code (excluding PREMIUM) to its differing feature value.
+ *
+ * @param plans - Array of Plan objects to compare, each containing a set of features.
+ * @returns An object where each key is a feature that differs from the PREMIUM plan,
+ *          and the value is an object mapping plan codes to their differing feature values.
+ */
+export function getDifferentFeaturesValues(
+  plans: Plan[],
+): Record<string, Record<string, PlanFeatureValue>> {
+  const targetPlan = plans.find((p) => p.code === SubscriptionPlan.PREMIUM);
+  if (!targetPlan) return {};
+
+  const differentFeatures: Record<
+    string,
+    Record<string, PlanFeatureValue>
+  > = {};
+
+  // Find features that differ from any other plan (lower OR higher)
+  for (const [featureKey, featureValue] of Object.entries(
+    targetPlan.features,
+  )) {
+    const otherValues = plans.map((p) => p.features[featureKey]);
+    const hasDifference = otherValues.some((v) => v !== featureValue);
+
+    if (hasDifference) {
+      differentFeatures[featureKey] = Object.fromEntries(
+        plans
+          .map((p) => [p.code, p.features[featureKey]])
+          .filter(([_, v]) => v !== featureValue),
+      );
+    }
+  }
+
+  return differentFeatures;
+}
+
+/**
+ * Returns a formatted string representation of a plan feature value based on the feature type.
+ *
+ * - For numeric values, formats the value and appends a descriptive label depending on the feature.
+ * - For boolean values, returns "Unlimited" for certain features if `true`, otherwise "Included".
+ * - For string values, returns the value as-is.
+ * - Returns "--" if the value does not match any expected type.
+ *
+ * @param value - The value of the plan feature, which can be a number, boolean, or string.
+ * @param feature - The feature key used to determine formatting and labeling.
+ * @returns A formatted string representing the feature value for display purposes.
+ */
+export function getFeatureValue(value: PlanFeatureValue, feature: string) {
+  if (typeof value === 'number') {
+    const formattedValue = Intl.NumberFormat('en-US', {
+      maximumFractionDigits: 0,
+    }).format(value);
+
+    if (feature === Feature.POS) {
+      return `${formattedValue} orders per month`;
+    }
+
+    if (feature === Feature.AREA) {
+      return `${formattedValue} area(s)`;
+    }
+
+    if (
+      feature === Feature.TRANSACTIONS ||
+      feature === Feature.ORDER_HISTORIES
+    ) {
+      return `up to last ${formattedValue} month(s)`;
+    }
+
+    if (feature === Feature.CATALOGS) {
+      return `${formattedValue} products / services`;
+    }
+
+    if (feature === Feature.STAFFS) {
+      return `${formattedValue} staff(s)`;
+    }
+
+    if (feature === Feature.CUSTOMERS) {
+      return `${formattedValue} saved customer(s)`;
+    }
+
+    if (feature === Feature.STORE_LIMIT) {
+      return `up to ${formattedValue} store(s)`;
+    }
+  }
+
+  if (
+    (feature === Feature.STORE_LIMIT ||
+      feature === Feature.EVENT_ADVANCED ||
+      feature === Feature.STAFFS ||
+      feature === Feature.UNIT ||
+      feature === Feature.POS ||
+      feature === Feature.TRANSACTIONS ||
+      feature === Feature.CATALOGS ||
+      feature === Feature.CUSTOMERS ||
+      feature === Feature.SMS_NOTIFICATIONS ||
+      feature === Feature.AI_AGENT ||
+      feature === Feature.AREA) &&
+    value === true
+  ) {
+    return 'Unlimited';
+  }
+
+  if (value === true) {
+    return 'Included';
+  } else if (typeof value === 'number') {
+    return Intl.NumberFormat('en-US', { maximumFractionDigits: 0 }).format(
+      value,
+    );
+  } else if (typeof value === 'string') {
+    return value;
+  }
+
+  return '--';
+}

package/src/index.ts

@@ -1,4 +1,3 @@
 export * from './types/invoice';
 export * from './types/plan';
 export * from './types/subscription';
-

package/src/types/plan.ts

@@ -1,5 +1,6 @@
+import { Plan as PlanCode } from '../enums/plan.enum';
 
-export type PlanCode = 'FREE' | 'BASIC' | 'STARTER' | 'STANDARD' |'PREMIUM';
+export type PlanFeatureValue = string | number | boolean;
 
 export type Plan = {
   id: string;
@@ -10,5 +11,5 @@ export type Plan = {
   commissionRate: number;
   currency: string;
   code: PlanCode;
-  features: Record<string, string|number|boolean>;
+  features: Record<string, PlanFeatureValue>;
 };

package/src/types/subscription.ts

@@ -51,8 +51,8 @@ export type Subscription = {
    * list of subscription invoices
    */
   invoices?: Invoice[];
-//   /**
-//    * list of active coupon redemptions
-//    */
-//   activeRedemptions?: CouponRedemption[];
+  //   /**
+  //    * list of active coupon redemptions
+  //    */
+  //   activeRedemptions?: CouponRedemption[];
 };

package/tsconfig.json

@@ -10,6 +10,8 @@
     "module": "nodenext",
     "target": "esnext",
     "types": [],
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
     // For nodejs:
     // "lib": ["esnext"],
     // "types": ["node"],
@@ -39,7 +41,7 @@
     "isolatedModules": true,
     "noUncheckedSideEffectImports": true,
     "moduleDetection": "force",
-    "skipLibCheck": true,
+    "skipLibCheck": true
   },
-  "include": ["src"]
+  "include": ["src/**/*.ts"]
 }