@simpleapps-com/augur-utils 0.1.0

package/dist/index.cjs

@@ -0,0 +1,46 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/cache-config.ts
+var CACHE_CONFIG = {
+  STATIC: {
+    staleTime: 1e3 * 60 * 60,
+    // 1 hour
+    gcTime: 1e3 * 60 * 60 * 24
+    // 24 hours
+  },
+  SEMI_STATIC: {
+    staleTime: 1e3 * 60 * 10,
+    // 10 minutes
+    gcTime: 1e3 * 60 * 60 * 4
+    // 4 hours
+  },
+  DYNAMIC: {
+    staleTime: 1e3 * 60 * 5,
+    // 5 minutes
+    gcTime: 1e3 * 60 * 30
+    // 30 minutes
+  },
+  CART: {
+    staleTime: 1e3 * 60 * 2,
+    // 2 minutes
+    gcTime: 1e3 * 60 * 30
+    // 30 minutes
+  },
+  REALTIME: {
+    staleTime: 0,
+    gcTime: 1e3 * 60 * 5
+    // 5 minutes
+  }
+};
+
+// src/format-price.ts
+function formatPrice(price, locale = "en-US", currency = "USD") {
+  return new Intl.NumberFormat(locale, {
+    style: "currency",
+    currency,
+    minimumFractionDigits: 2
+  }).format(price);
+}
+
+
+
+exports.CACHE_CONFIG = CACHE_CONFIG; exports.formatPrice = formatPrice;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/augur-packages/augur-packages/packages/augur-utils/dist/index.cjs","../src/cache-config.ts","../src/format-price.ts"],"names":[],"mappings":"AAAA;ACkBO,IAAM,aAAA,EAAe;AAAA,EAC1B,MAAA,EAAQ;AAAA,IACN,SAAA,EAAW,IAAA,EAAO,GAAA,EAAK,EAAA;AAAA;AAAA,IACvB,MAAA,EAAQ,IAAA,EAAO,GAAA,EAAK,GAAA,EAAK;AAAA;AAAA,EAC3B,CAAA;AAAA,EACA,WAAA,EAAa;AAAA,IACX,SAAA,EAAW,IAAA,EAAO,GAAA,EAAK,EAAA;AAAA;AAAA,IACvB,MAAA,EAAQ,IAAA,EAAO,GAAA,EAAK,GAAA,EAAK;AAAA;AAAA,EAC3B,CAAA;AAAA,EACA,OAAA,EAAS;AAAA,IACP,SAAA,EAAW,IAAA,EAAO,GAAA,EAAK,CAAA;AAAA;AAAA,IACvB,MAAA,EAAQ,IAAA,EAAO,GAAA,EAAK;AAAA;AAAA,EACtB,CAAA;AAAA,EACA,IAAA,EAAM;AAAA,IACJ,SAAA,EAAW,IAAA,EAAO,GAAA,EAAK,CAAA;AAAA;AAAA,IACvB,MAAA,EAAQ,IAAA,EAAO,GAAA,EAAK;AAAA;AAAA,EACtB,CAAA;AAAA,EACA,QAAA,EAAU;AAAA,IACR,SAAA,EAAW,CAAA;AAAA,IACX,MAAA,EAAQ,IAAA,EAAO,GAAA,EAAK;AAAA;AAAA,EACtB;AACF,CAAA;ADPA;AACA;AE7BO,SAAS,WAAA,CACd,KAAA,EACA,OAAA,EAAiB,OAAA,EACjB,SAAA,EAAmB,KAAA,EACX;AACR,EAAA,OAAO,IAAI,IAAA,CAAK,YAAA,CAAa,MAAA,EAAQ;AAAA,IACnC,KAAA,EAAO,UAAA;AAAA,IACP,QAAA;AAAA,IACA,qBAAA,EAAuB;AAAA,EACzB,CAAC,CAAA,CAAE,MAAA,CAAO,KAAK,CAAA;AACjB;AF2BA;AACE;AACA;AACF,uEAAC","file":"/home/runner/work/augur-packages/augur-packages/packages/augur-utils/dist/index.cjs","sourcesContent":[null,"/**\n * Centralized cache configuration for React Query (TanStack Query)\n *\n * staleTime -- How long cached data is considered \"fresh\". While fresh,\n *   React Query serves the cache instantly and does NOT refetch in the\n *   background. After staleTime expires the data is \"stale\" and will be\n *   refetched on the next access (mount, window focus, etc.).\n *\n * gcTime (garbage collection time) -- How long UNUSED cached data stays in\n *   memory after all components using it unmount. Once gcTime expires the\n *   cache entry is deleted entirely.\n *\n * STATIC (1h):   categories, menus, item details\n * SEMI_STATIC (10m): pricing, stock, search results\n * DYNAMIC (5m):  infinite scroll data\n * CART (2m):     cart lines, cart header\n * REALTIME (0):  active orders, checkout state\n */\nexport const CACHE_CONFIG = {\n  STATIC: {\n    staleTime: 1000 * 60 * 60,      // 1 hour\n    gcTime: 1000 * 60 * 60 * 24,    // 24 hours\n  },\n  SEMI_STATIC: {\n    staleTime: 1000 * 60 * 10,      // 10 minutes\n    gcTime: 1000 * 60 * 60 * 4,     // 4 hours\n  },\n  DYNAMIC: {\n    staleTime: 1000 * 60 * 5,       // 5 minutes\n    gcTime: 1000 * 60 * 30,         // 30 minutes\n  },\n  CART: {\n    staleTime: 1000 * 60 * 2,       // 2 minutes\n    gcTime: 1000 * 60 * 30,         // 30 minutes\n  },\n  REALTIME: {\n    staleTime: 0,\n    gcTime: 1000 * 60 * 5,          // 5 minutes\n  },\n} as const;\n\nexport type CacheTier = keyof typeof CACHE_CONFIG;\n","/**\n * Locale-aware currency formatting.\n * Defaults to USD -- consumers can override locale and currency.\n */\nexport function formatPrice(\n  price: number,\n  locale: string = \"en-US\",\n  currency: string = \"USD\",\n): string {\n  return new Intl.NumberFormat(locale, {\n    style: \"currency\",\n    currency,\n    minimumFractionDigits: 2,\n  }).format(price);\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,611 @@
+type TCartLine = {
+    cartHdrUid?: string | number | undefined;
+    invMastUid: number;
+    invMastUidCount: number;
+    isAssembly: string;
+    itemId: string;
+    lineNo: number;
+    lineNote: null;
+    quantity: number;
+    unitOfMeasure: string;
+};
+type TCartLookUp = {
+    cartHdrUid: number;
+    cartToken: string;
+    contactId: number;
+    customerId: number;
+    userId: number;
+};
+type TCartHdrUid = Pick<TCartLine, "cartHdrUid">;
+type TOrderCartLine = {
+    inv_mast_uid: number;
+    item_id: string;
+    qty: number;
+    uom: string;
+    weight: number;
+    classId5: string | null;
+    unitPrice: number;
+    manualPriceOverride?: string;
+};
+
+type TCategoryChild = {
+    itemCategoryUid: number;
+    itemCategoryId: string;
+    itemCategoryDesc: string;
+    fullPath: string;
+    cleanPath: string;
+    categoryImage: string;
+    sequenceNo: number;
+    productCollection: null;
+    itemCount: number;
+};
+type TCategory = {
+    itemCategoryUid: number;
+    itemCategoryId: string;
+    itemCategoryDesc: string;
+    categoryImage: string | false;
+    parentItemCategoryUid: number;
+    nodeCount: number;
+    fullPath: string;
+    cleanPath: string;
+    displayOnWebFlag: string;
+    subItemCategoryUids: number[];
+    maxItems: number;
+    itemsByCategory: number;
+    children: TCategoryChild[];
+    childrenTotal: number;
+    childrenCount: number;
+};
+type TItemCategory = {
+    itemCategoryUid: number;
+    itemCategoryId: string;
+    itemCategoryDesc: string;
+    masterCategoryFlag: string;
+    parentCategoryFlag: string;
+    displayOnWebFlag: string;
+    displayMasterProductFlag: string;
+    catalogPage: string | null;
+    deleteFlag: string;
+    dateCreated: string;
+    createdBy: string;
+    dateLastModified: string;
+    lastMaintainedBy: string;
+    subCategoryImageFile: string | null;
+    updateCd: number;
+    statusCd: number;
+    processCd: number;
+    itemCount: number;
+};
+type TProductCategory = {
+    fullPath: string;
+    itemCategoryDesc: string;
+    itemCategoryId: string;
+    itemCategoryUid: number;
+    itemCount: number;
+    productCollection: any;
+    sequenceNo: number;
+    children: TProductCategory[];
+    childrenTotal: number;
+};
+
+type TInventorySupplier = {
+    inventorySupplierUid: number;
+    invMastUid: number;
+    supplierId: number;
+    upcCode: string;
+    checkDigit: string;
+    upc: string;
+    supplierPartNo: string;
+    primarySupplierFlag: string | null;
+};
+
+type TItemUom = {
+    unitOfMeasure: string;
+    unitSize: number;
+};
+
+type TItemAttribute = {
+    attributeName: string;
+    attributeValue: string;
+};
+type TAttributeValue = {
+    attributeValue: string;
+    attributeValueUid: number;
+};
+type TAttribute = {
+    attributeDesc: string;
+    attributeId: string;
+    attributeUid: number;
+    sequenceNo: number;
+    valueCount: number;
+    values: TAttributeValue[];
+};
+
+type TInvMast = {
+    invMastUid: number;
+    itemId: string;
+    itemDesc: string;
+    deleteFlag: string;
+    weight: number;
+    dateCreated: string;
+    dateLastModified: string;
+    inactive: string;
+    classId1: string;
+    classId2: string | null;
+    classId3: string | null;
+    classId4: string;
+    classId5: string;
+    upcOrEan: string;
+    upcOrEanId: string;
+    serialized: string;
+    productType: string;
+    dLength: string | null;
+    shortCode: string;
+    price1: number;
+    price2: number;
+    price3: number;
+    price4: number;
+    price5: number;
+    price6: number;
+    price7: number;
+    price8: number;
+    price9: number;
+    price10: number;
+    extendedDesc: string | null;
+    defaultSellingUnit: string;
+    hazMatFlag: string;
+    keywords: string;
+    disposition: string;
+    baseUnit: string;
+    restrictedFlag: string | null;
+    parkerProductCd: number | null;
+    parkerDivisionCd: number | null;
+    commodityCode: string;
+    unspscCode: string | null;
+    dciCode: string | null;
+    epaCertReqFlag: string;
+    length: null;
+    width: null;
+    height: null;
+    itemNotes: null;
+    vndrStock: unknown | null;
+    manufacturerName: string;
+    brandName: string;
+    partNumber: null;
+    updateCd: number;
+    defaultProductGroup: string;
+    upcOrEanPrefix: string;
+    upcOrEanItem: string;
+    attributeGroupUid: number | null;
+    defaultPriceFamilyUid: number;
+    purchasePricingUnit: string;
+    purchasePricingUnitSize: number;
+    salesPricingUnit: string;
+    salesPricingUnitSize: number;
+    defaultPurchasingUnit: string;
+    statusCd: number;
+    onlineCd: number;
+    processCd: number;
+};
+type TStockData = {
+    baseUnit: string;
+    baseUnitSize: number;
+    calcQtyAllocated: number;
+    calcQtyAvailable: number;
+    calcQtyOnHand: number;
+    companyId: string;
+    defaultSellingUnit: string;
+    defaultSellingUnitSize: number;
+    discontinued: string;
+    divisor: number;
+    locationId: number;
+    locationName: string;
+    nextDueInPoDate: string | null;
+    orderQuantity: number;
+    primaryBin: string;
+    productGroupId: string;
+    qtyAllocated: number;
+    qtyAvailable: number;
+    qtyBackordered: number;
+    qtyFrozen: number;
+    qtyOnHand: number;
+    qtyQuarantined: number;
+    stockable: string;
+    unallocated: number;
+};
+type TStock = {
+    companySummary: Record<string, number>;
+    stockData: TStockData[];
+};
+type TInvMastDoc = {
+    invMastUid: number;
+    itemId: string;
+    itemDesc: string;
+    displayDesc: string;
+    extendedDesc: string | null;
+    defaultSellingUnit: string;
+    baseUnit: string;
+    vndrStock: number | null;
+    classId1: string | null;
+    classId2: string | null;
+    classId3: string | null;
+    classId4: string | null;
+    classId5: string | null;
+    defaultProductGroup: string | null;
+    upcOrEanId: string | null;
+    upcOrEan: string | null;
+    weight: number | null;
+    length: number | null;
+    width: number | null;
+    height: number | null;
+    inventorySupplier: TInventorySupplier[];
+    itemUom: TItemUom[];
+    attributes: TItemAttribute[];
+    images: string[];
+    categoryList: number[];
+    userDefined: any[];
+    invMastText: any[];
+    stock: TStock;
+};
+
+type TProductStockData = {
+    locationId: number;
+    companyId: string;
+    qtyOnHand: number;
+    qtyAllocated: number;
+    stockable: string;
+    unallocated: number;
+    nextDueInPoDate: string | null;
+    qtyBackordered: number;
+    primaryBin: string;
+    discontinued: string;
+    qtyFrozen: number;
+    qtyQuarantined: number;
+    qtyAvailable: number;
+};
+type TProductItem = {
+    brandName: string;
+    defaultSellingUnit: string;
+    extendedDesc: string;
+    images: string[];
+    invMastUid: number;
+    itemDesc: string;
+    itemId: string;
+    displayDesc: string;
+    manufacturerName: string;
+    shortCode: string | null;
+    classId5: string;
+    stock: {
+        stockData: TProductStockData[];
+        companySummary: Record<string, number>;
+    };
+    sourceFields: {
+        display_desc: string;
+    };
+    vndrStock: number;
+};
+type TItemDetails = {
+    attributes: TItemAttribute[];
+    categoryList: number[];
+    classId1: string | null;
+    classId2: string | null;
+    classId3: string | null;
+    classId4: string | null;
+    classId5: string | null;
+    defaultSellingUnit: string;
+    displayDesc: any;
+    extendedDesc: string;
+    images: string[];
+    invMastText: any[];
+    invMastUid: number;
+    itemDesc: string;
+    itemId: string;
+    itemUom: TItemUom[];
+    length: number;
+    vndrStock: any;
+    userDefined: any[];
+    isWood: boolean;
+    defaultProductGroup: string | null;
+};
+type TItemAccessory = {
+    childItemUom: TItemUom[];
+    childItemDesc: string;
+    childInvMastUid: number;
+    childItemId: string;
+};
+type TItemRelatedProduct = TItemDetails & {
+    childItemUom: TItemUom[];
+    childItemDesc: string;
+    childInvMastUid: number;
+    childItemId: string;
+    childImages: string[];
+};
+
+type TLibraryPriceBreak = {
+    calculationValue: number;
+    break: number;
+    unitPrice: number;
+};
+type TLibraryPriceData = {
+    unitPrice: number;
+    quantity: number;
+    pricePageUid: number;
+    pricePageCdType: number;
+    pricePageCdDesc: string;
+    effectiveDate: string;
+    expirationDate: string;
+    itemId: string;
+    invMastUid: number;
+    pricingMethodCd: number;
+    pricingMethodCdDesc: string;
+    sourcePriceCd: number;
+    sourcePriceCdDesc: string;
+    calculationMethodCd: number;
+    calculationMethodCdDesc: string;
+    totalingMethodCd: number;
+    totalingMethodCdDesc: string;
+    purchasePricingUnit: string;
+    purchasePricingUnitSize: number;
+    salesPricingUnit: string;
+    salesPricingUnitSize: number;
+    unitOfMeasure: string;
+    unitOfMeasureSize: number;
+    defaultSellingUnit: string;
+    defaultSellingUnitSize: number;
+    defaultPurchasingUnit: string;
+    defaultPurchasingUnitSize: number;
+    baseUnit: string;
+    baseUnitSize: number;
+    sourcePrice: number;
+    multiplier: number;
+    pricePageDiscountGroupId: string;
+    invLocSalesDiscountGroup: string;
+    baseSize: number;
+    basePrice: number;
+    breaks: Record<string, TLibraryPriceBreak>;
+};
+type TPriceData = {
+    pricedFrom: string;
+    unitPrice: number;
+    unitOfMeasure?: string;
+    jobPrice: boolean;
+    priceType: string;
+    customer: {
+        customerId: number;
+        valid: boolean;
+        sourcePriceCd: boolean;
+        hasJobPricing: boolean;
+    };
+    item: {
+        itemId: string;
+        valid: boolean;
+        invMastUid: number;
+        quantity: number;
+        unitOfMeasure: string;
+    };
+    options: {
+        customerId: string;
+        itemId: string;
+        cacheTtl: number;
+    };
+    messages: string[];
+    libraryPriceData: TLibraryPriceData;
+    listPrice: number;
+};
+
+type TItemsFilters = {
+    filters: any[];
+    limit: number;
+    offset: number;
+    sortBy: string;
+    q: string;
+    page?: number;
+};
+
+type TApiResponse<T> = {
+    status: string;
+    data: T | undefined;
+    error: {
+        message: string;
+    } | undefined;
+};
+
+type CustomerDocument = {
+    customerId: number;
+    companyId: string;
+    customerName: string;
+    class1Id: string;
+    class2Id: string | null;
+    class3Id: string | null;
+    class4Id: string | null;
+    class5Id: string | null;
+    webEnabledFlag: string;
+    deleteFlag: string;
+    salesRepId: string;
+    poNoRequired: string;
+    termsId: string;
+    termsDesc: string;
+    taxableFlag: string;
+    userDefined: string[];
+};
+
+type MenuItem = {
+    id: number;
+    access: number;
+    alias: string;
+    level: number;
+    link: string;
+    menuType: string;
+    parentId: number;
+    path: string;
+    published: number;
+    title: string;
+    type: string;
+    children: MenuItem[];
+};
+
+type OrderHeader = {
+    carrier_id: string;
+    carrier_name: string;
+    contact_id: string;
+    customer_id: string;
+    company_id: string;
+    user_id: string;
+    user_email: string;
+    quote: "Y" | "N";
+    import_as_quote: "Y" | "N";
+    ip_address: string;
+    order_source: string;
+    web_source: string;
+    class_id1: string | null;
+    class_id2: string | null;
+    class_id3: string | null;
+    class_id4: string | null;
+    class_id5: string | null;
+    generate_po_number: number;
+    is_sample: string;
+    order_date: string;
+    customer_po_number: string;
+    ship_to_name: string;
+    ship_to_address1: string;
+    ship_to_address2: string;
+    ship_to_city: string;
+    ship_to_state: string;
+    ship_to_country: string;
+    ship_to_postal_code: string;
+    ship_to_address3: string | null;
+    ship_to_companyname: string;
+    ship_to_phone: string;
+    ship_to_email: string;
+    terms: string | null;
+    packing_basis: string | null;
+    delivery_instructions: string | null;
+    cart_tax: {
+        tax_amount: number;
+        tax_amount_string: string;
+    };
+    shipping_estimate: number;
+    incoming_freight: number;
+    handling_fee: number;
+    manager_approval_needed: number;
+};
+type OrderLine = {
+    item_id: string;
+    item_name: string;
+    currency: string;
+    index: number;
+    item_category: string;
+    price: number;
+    quantity: number;
+    displayDesc: string;
+};
+type OrderPayment = {
+    first_name: string;
+    last_name: string;
+    street_address1: string;
+    street_address2: string;
+    city: string;
+    state: string;
+    zip_code: string;
+    country: string;
+    processor: "invoice" | "element";
+    paymentType: "unified" | "invoice";
+};
+type OrderNote = {
+    note: string;
+    note_areas: string[];
+};
+
+type TShippingMethod = {
+    billingWeight: number;
+    billingWeightUom: string | null;
+    guaranteedDaysToDelivery: string | null;
+    negotiatedRates: number;
+    scheduledDeliveryTime: string | null;
+    serviceCode: string;
+    serviceName: string;
+    serviceOptionsCharges: number;
+    totalCharges: number;
+    transportationCharges: number;
+};
+
+type TTaxItem = {
+    itemId: string;
+    quantity: number;
+    unitOfMeasure: string;
+    unitPrice: number;
+};
+type TTax = {
+    taxEstimate: number;
+    customerId: number;
+    postalCode: string;
+    taxRate: number;
+    items: TTaxItem[];
+};
+
+type TMetaTags = {
+    invMastExtUid: number;
+    invMastUid: number;
+    metaTitle: string;
+    metaDescription: string;
+    metaKeywords: string;
+};
+type TWebDesc = {
+    invMastUid: number;
+    invMastWebDescUid: number;
+    webDesc1: string | null;
+    webDesc2: string | null;
+    webDesc3: string | null;
+    webDesc4: string | null;
+    webDescFull: string | null;
+};
+
+/**
+ * Centralized cache configuration for React Query (TanStack Query)
+ *
+ * staleTime -- How long cached data is considered "fresh". While fresh,
+ *   React Query serves the cache instantly and does NOT refetch in the
+ *   background. After staleTime expires the data is "stale" and will be
+ *   refetched on the next access (mount, window focus, etc.).
+ *
+ * gcTime (garbage collection time) -- How long UNUSED cached data stays in
+ *   memory after all components using it unmount. Once gcTime expires the
+ *   cache entry is deleted entirely.
+ *
+ * STATIC (1h):   categories, menus, item details
+ * SEMI_STATIC (10m): pricing, stock, search results
+ * DYNAMIC (5m):  infinite scroll data
+ * CART (2m):     cart lines, cart header
+ * REALTIME (0):  active orders, checkout state
+ */
+declare const CACHE_CONFIG: {
+    readonly STATIC: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+    };
+    readonly SEMI_STATIC: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+    };
+    readonly DYNAMIC: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+    };
+    readonly CART: {
+        readonly staleTime: number;
+        readonly gcTime: number;
+    };
+    readonly REALTIME: {
+        readonly staleTime: 0;
+        readonly gcTime: number;
+    };
+};
+type CacheTier = keyof typeof CACHE_CONFIG;
+
+/**
+ * Locale-aware currency formatting.
+ * Defaults to USD -- consumers can override locale and currency.
+ */
+declare function formatPrice(price: number, locale?: string, currency?: string): string;
+
+export { CACHE_CONFIG, type CacheTier, type CustomerDocument, type MenuItem, type OrderHeader, type OrderLine, type OrderNote, type OrderPayment, type TApiResponse, type TAttribute, type TAttributeValue, type TCartHdrUid, type TCartLine, type TCartLookUp, type TCategory, type TCategoryChild, type TInvMast, type TInvMastDoc, type TInventorySupplier, type TItemAccessory, type TItemAttribute, type TItemCategory, type TItemDetails, type TItemRelatedProduct, type TItemUom, type TItemsFilters, type TLibraryPriceBreak, type TLibraryPriceData, type TMetaTags, type TOrderCartLine, type TPriceData, type TProductCategory, type TProductItem, type TProductStockData, type TShippingMethod, type TStock, type TStockData, type TTax, type TTaxItem, type TWebDesc, formatPrice };