@appcorp/stellar-solutions-modules 0.1.34 → 0.1.36

package/global-modules/tax/types.js

@@ -1,22 +1,190 @@
 "use strict";
+/**
+ * Tax Module Types
+ *
+ * This module defines all TypeScript interfaces, types, and enums for the Tax feature.
+ * Provides type safety and clear contracts for all tax-related operations.
+ *
+ * Type Categories:
+ * - Context Types (React context and state management)
+ * - Entity Types (Backend data structures)
+ * - State Types (Frontend component state)
+ * - API Types (Request/response interfaces)
+ * - UI Types (Drawer and component enums)
+ * - Utility Types (Helper and computed types)
+ *
+ * Advanced Features:
+ * - Tax management with rate calculations
+ * - CRUD operations support
+ * - Enhanced search and pagination
+ *
+ * Naming Conventions:
+ * - Interfaces: PascalCase with descriptive suffixes (Type, State, Args)
+ * - Enums: UPPER_SNAKE_CASE for values, PascalCase for enum names
+ * - Types: PascalCase following interface conventions
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PREFERENCE_MODAL = exports.TAX_DRAWER = exports.PAYMENT_TYPE = void 0;
-// export enum PAYMENT_MODE {
-//   BANK_TRANSFER = 'BANK_TRANSFER',
-//   CASH = 'CASH',
-//   CHEQUE = 'CHEQUE',
-//   OTHER = 'OTHER',
-// }
+exports.PREFERENCE_MODAL = exports.formatTaxRate = exports.calculateTaxAmount = exports.getTaxRateAsNumber = exports.getTaxDisplayName = exports.isTaxDefault = exports.isTaxEnabled = exports.isFetchTaxesArgs = exports.isPaymentType = exports.isTaxDrawer = exports.isTaxTypeBE = exports.PAYMENT_TYPE = exports.TAX_DRAWER = void 0;
+// ============================================================================
+// UI ENUMS (Component State Definitions)
+// ============================================================================
+/**
+ * Tax Drawer Types
+ *
+ * Enumeration of all available drawer states for tax UI.
+ */
+var TAX_DRAWER;
+(function (TAX_DRAWER) {
+    TAX_DRAWER["FORM_DRAWER"] = "FORM_DRAWER";
+})(TAX_DRAWER || (exports.TAX_DRAWER = TAX_DRAWER = {}));
+/**
+ * Payment Types
+ *
+ * Enumeration of payment type classifications.
+ */
 var PAYMENT_TYPE;
 (function (PAYMENT_TYPE) {
     PAYMENT_TYPE["FULL_PAYMENT"] = "FULL_PAYMENT";
     PAYMENT_TYPE["PARTIAL_PAYMENT"] = "PARTIAL_PAYMENT";
 })(PAYMENT_TYPE || (exports.PAYMENT_TYPE = PAYMENT_TYPE = {}));
-var TAX_DRAWER;
-(function (TAX_DRAWER) {
-    TAX_DRAWER["FORM_DRAWER"] = "FORM_DRAWER";
-})(TAX_DRAWER || (exports.TAX_DRAWER = TAX_DRAWER = {}));
+// ============================================================================
+// TYPE GUARDS (Runtime Type Checking)
+// ============================================================================
+/**
+ * Type guard to check if object is a valid TaxTypeBE
+ */
+var isTaxTypeBE = function (obj) {
+    return (typeof obj === "object" &&
+        obj !== null &&
+        "id" in obj &&
+        "taxName" in obj &&
+        "taxRate" in obj &&
+        typeof obj.enabled === "boolean" &&
+        typeof obj.isDefault === "boolean");
+};
+exports.isTaxTypeBE = isTaxTypeBE;
+/**
+ * Type guard to check if string is a valid tax drawer type
+ */
+var isTaxDrawer = function (value) {
+    return Object.values(TAX_DRAWER).includes(value);
+};
+exports.isTaxDrawer = isTaxDrawer;
+/**
+ * Type guard to check if string is a valid payment type
+ */
+var isPaymentType = function (value) {
+    return Object.values(PAYMENT_TYPE).includes(value);
+};
+exports.isPaymentType = isPaymentType;
+/**
+ * Type guard to check if object has valid tax filter structure
+ */
+var isFetchTaxesArgs = function (obj) {
+    return (typeof obj === "object" &&
+        obj !== null &&
+        typeof obj.currentPage === "number" &&
+        typeof obj.pageLimit === "number");
+};
+exports.isFetchTaxesArgs = isFetchTaxesArgs;
+// ============================================================================
+// UTILITY FUNCTIONS (Type Helpers)
+// ============================================================================
+/**
+ * Check if tax is enabled
+ */
+var isTaxEnabled = function (tax) {
+    return tax.enabled;
+};
+exports.isTaxEnabled = isTaxEnabled;
+/**
+ * Check if tax is default
+ */
+var isTaxDefault = function (tax) {
+    return tax.isDefault;
+};
+exports.isTaxDefault = isTaxDefault;
+/**
+ * Get tax display name
+ */
+var getTaxDisplayName = function (tax) {
+    return tax.taxName;
+};
+exports.getTaxDisplayName = getTaxDisplayName;
+/**
+ * Get tax rate as number
+ */
+var getTaxRateAsNumber = function (tax) {
+    return parseFloat(tax.taxRate) || 0;
+};
+exports.getTaxRateAsNumber = getTaxRateAsNumber;
+/**
+ * Calculate tax amount
+ */
+var calculateTaxAmount = function (amount, tax) {
+    var rate = (0, exports.getTaxRateAsNumber)(tax);
+    return (amount * rate) / 100;
+};
+exports.calculateTaxAmount = calculateTaxAmount;
+/**
+ * Format tax rate for display
+ */
+var formatTaxRate = function (tax) {
+    return "".concat(tax.taxRate, "%");
+};
+exports.formatTaxRate = formatTaxRate;
+/**
+ * Legacy Preference Modal Enum
+ * TODO: Move to preferences module
+ */
 var PREFERENCE_MODAL;
 (function (PREFERENCE_MODAL) {
     PREFERENCE_MODAL["DUMMY"] = "DUMMY";
 })(PREFERENCE_MODAL || (exports.PREFERENCE_MODAL = PREFERENCE_MODAL = {}));
+// ============================================================================
+// OPTIMIZATION SUMMARY
+// ============================================================================
+/*
+ * Tax Types File Optimizations Applied:
+ *
+ * 1. **Comprehensive Documentation**
+ *    - Added detailed JSDoc comments for all interfaces and types
+ *    - Organized types into logical categories with clear section headers
+ *    - Explained purpose and usage for each type definition
+ *
+ * 2. **Enhanced Type Safety**
+ *    - Added utility types for common operations (form fields, required fields, etc.)
+ *    - Implemented runtime type guards for validation
+ *    - Used more specific Record<string, string> for errors
+ *    - Added comprehensive API response types for better backend integration
+ *
+ * 3. **Improved Organization**
+ *    - Grouped related types into logical sections (Context, Entity, State, API, UI, Utility)
+ *    - Separated tax specific types from legacy types
+ *    - Consistent naming conventions throughout
+ *    - Clear separation between entity, state, and utility types
+ *
+ * 4. **Developer Experience**
+ *    - Utility types for common development tasks
+ *    - Type guards for runtime validation
+ *    - Helper functions for tax manipulation (calculateTaxAmount, formatTaxRate, etc.)
+ *    - Comprehensive interfaces with clear field descriptions
+ *    - Better IDE support through detailed type definitions
+ *
+ * 5. **Legacy Type Management**
+ *    - Moved unrelated types to legacy section with TODO comments
+ *    - Clear migration path for future refactoring
+ *    - Maintained backward compatibility while organizing properly
+ *
+ * 6. **Tax-Specific Enhancements**
+ *    - Tax utility functions (calculateTaxAmount, formatTaxRate, isTaxEnabled, etc.)
+ *    - Comprehensive API types for all operations
+ *    - Enhanced form and state type definitions
+ *    - Tax-specific validation and utility types
+ *
+ * 7. **Maintainability**
+ *    - Modular type structure for easy extension
+ *    - Clear relationships between different type categories
+ *    - Self-documenting code with comprehensive comments
+ *    - Consistent patterns for future type additions
+ */

package/global-modules/tax/validate.d.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from "zod";
 export declare const formValidation: z.ZodObject<{
     taxName: z.ZodString;
     taxRate: z.ZodString;

package/global-modules/tax/validate.js

@@ -2,16 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formValidation = void 0;
 var zod_1 = require("zod");
-var constants_1 = require("./constants");
+// Validation error messages
+var validationMessages = {
+    taxName: "Tax name is required",
+    taxRate: "Tax rate is required",
+    preferenceId: "Preference ID is required",
+};
 exports.formValidation = zod_1.z.object({
-    taxName: zod_1.z
-        .string()
-        .nonempty(constants_1.validationError.taxName),
-    taxRate: zod_1.z
-        .string()
-        .nonempty(constants_1.validationError.taxRate),
+    taxName: zod_1.z.string().nonempty(validationMessages.taxName),
+    taxRate: zod_1.z.string().nonempty(validationMessages.taxRate),
     enabled: zod_1.z.boolean(),
     isDefault: zod_1.z.boolean(),
     description: zod_1.z.string().optional(),
-    preferenceId: zod_1.z.string().nonempty(constants_1.validationError.preferenceId),
+    preferenceId: zod_1.z.string().nonempty(validationMessages.preferenceId),
 });

package/hooks/use-rtl.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Hook to detect RTL (Right-to-Left) layout based on current locale
+ * @returns {boolean} true if current locale requires RTL layout (Urdu), false otherwise
+ */
+export declare const useRTL: () => boolean;
+/**
+ * Hook to get RTL-aware CSS classes
+ *
+ * @returns Object containing common RTL-aware class combinations
+ *
+ * @example
+ * ```tsx
+ * const rtlClasses = useRTLClasses();
+ *
+ * // For icon buttons (ensures proper centering in RTL)
+ * <Button size="icon" className={`h-8 w-8 ${rtlClasses.iconButton}`}>
+ *   <Icon />
+ * </Button>
+ *
+ * // For buttons with icon and text
+ * <Button className={rtlClasses.iconWithText("left")}>
+ *   <Icon />
+ *   <span>Button Text</span>
+ * </Button>
+ * ```
+ */
+export declare const useRTLClasses: () => {
+    isRTL: boolean;
+    container: string;
+    direction: string;
+    flexRow: string;
+    flexRowReverse: string;
+    textAlign: string;
+    textAlignReverse: string;
+    marginLeft: string;
+    marginRight: string;
+    paddingLeft: (size: string) => string;
+    paddingRight: (size: string) => string;
+    gap: (size: string) => string;
+    roundedLeft: string;
+    roundedRight: string;
+    iconButton: string;
+    iconWithText: (iconPosition?: "left" | "right") => "flex items-center flex-row-reverse gap-2" | "flex items-center gap-2";
+};

package/hooks/use-rtl.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useRTLClasses = exports.useRTL = void 0;
+var next_intl_1 = require("next-intl");
+/**
+ * Hook to detect RTL (Right-to-Left) layout based on current locale
+ * @returns {boolean} true if current locale requires RTL layout (Urdu), false otherwise
+ */
+var useRTL = function () {
+    var locale = (0, next_intl_1.useLocale)();
+    return locale === "ur";
+};
+exports.useRTL = useRTL;
+/**
+ * Hook to get RTL-aware CSS classes
+ *
+ * @returns Object containing common RTL-aware class combinations
+ *
+ * @example
+ * ```tsx
+ * const rtlClasses = useRTLClasses();
+ *
+ * // For icon buttons (ensures proper centering in RTL)
+ * <Button size="icon" className={`h-8 w-8 ${rtlClasses.iconButton}`}>
+ *   <Icon />
+ * </Button>
+ *
+ * // For buttons with icon and text
+ * <Button className={rtlClasses.iconWithText("left")}>
+ *   <Icon />
+ *   <span>Button Text</span>
+ * </Button>
+ * ```
+ */
+var useRTLClasses = function () {
+    var isRTL = (0, exports.useRTL)();
+    return {
+        isRTL: isRTL,
+        // Container classes
+        container: isRTL ? "rtl" : "ltr",
+        direction: isRTL ? "rtl" : "ltr",
+        // Flex classes
+        flexRow: isRTL ? "flex-row-reverse" : "flex-row",
+        flexRowReverse: isRTL ? "flex-row" : "flex-row-reverse",
+        // Text alignment
+        textAlign: isRTL ? "text-right" : "text-left",
+        textAlignReverse: isRTL ? "text-left" : "text-right",
+        // Margin classes
+        marginLeft: isRTL ? "mr-auto" : "ml-auto",
+        marginRight: isRTL ? "ml-auto" : "mr-auto",
+        // Padding classes
+        paddingLeft: function (size) { return (isRTL ? "pr-".concat(size) : "pl-".concat(size)); },
+        paddingRight: function (size) { return (isRTL ? "pl-".concat(size) : "pr-".concat(size)); },
+        // Gap and spacing
+        gap: function (size) { return "gap-".concat(size); },
+        // Border radius (for buttons, cards, etc.)
+        roundedLeft: isRTL ? "rounded-r" : "rounded-l",
+        roundedRight: isRTL ? "rounded-l" : "rounded-r",
+        // Icon button classes for proper centering in RTL
+        iconButton: "flex items-center justify-center border",
+        // Icon with text combinations
+        iconWithText: function (iconPosition) {
+            if (iconPosition === void 0) { iconPosition = "left"; }
+            if (iconPosition === "left") {
+                return isRTL
+                    ? "flex items-center flex-row-reverse gap-2"
+                    : "flex items-center gap-2";
+            }
+            return isRTL
+                ? "flex items-center gap-2"
+                : "flex items-center flex-row-reverse gap-2";
+        },
+    };
+};
+exports.useRTLClasses = useRTLClasses;