react-shopwave-connect 0.1.1
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.
- package/LICENSE +21 -0
- package/README.md +258 -0
- package/dist/core/index.cjs +426 -0
- package/dist/core/index.cjs.map +1 -0
- package/dist/core/index.d.cts +481 -0
- package/dist/core/index.d.ts +481 -0
- package/dist/core/index.js +399 -0
- package/dist/core/index.js.map +1 -0
- package/dist/hooks/index.cjs +783 -0
- package/dist/hooks/index.cjs.map +1 -0
- package/dist/hooks/index.d.cts +424 -0
- package/dist/hooks/index.d.ts +424 -0
- package/dist/hooks/index.js +749 -0
- package/dist/hooks/index.js.map +1 -0
- package/dist/index.cjs +824 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +618 -0
- package/dist/index.d.ts +618 -0
- package/dist/index.js +763 -0
- package/dist/index.js.map +1 -0
- package/package.json +85 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["merged: Extras","headers: Record<string, string>","extras: Record<string, unknown>","extras: Record<string, unknown>","extras: Record<string, unknown>","result: { [id: number]: Product }","extras: Record<string, unknown>","DEFAULT_BASKET_FILTERS: BasketFilters","DEFAULT_PAGINATION: BasketPagination","whereConditions: string[]","keyIndices: { [key: string]: number }","productSubKeys: { [key: string]: number }","products: BasketItem[]","combinedRows: BasketReportRow[]","productsWithNames: BasketItem[]","map: { [id: number]: Consumer }"],"sources":["../../src/core/request.ts","../../src/core/category.ts","../../src/core/consumer.ts","../../src/core/employee.ts","../../src/core/product.ts","../../src/core/promotion.ts","../../src/core/store.ts","../../src/core/report.ts","../../src/core/session.ts","../../src/core/entity.ts","../../src/core/basket.ts"],"sourcesContent":["import type { apiResponse } from \"./types\";\n\n/**\n * Per-call configuration shared by every core API function.\n *\n * Nothing here is React-specific. By accepting these options per call, the\n * core layer works in the browser/Next (relative `/api/...` URLs, the default)\n * AND in Node / CLI / Vue / Angular by passing an absolute `baseUrl`, an auth\n * `token`, and/or a custom `fetch` implementation.\n */\nexport interface RequestOptions {\n /**\n * Prefixed in front of every request path. Leave undefined in the browser to\n * use relative URLs (e.g. `/api/products`). In Node/CLI pass something like\n * `https://api.shopwave.com`.\n */\n baseUrl?: string;\n\n /** OAuth/session token forwarded in the `extras.token` header. */\n token?: string;\n\n /**\n * Custom fetch implementation. Defaults to the global `fetch`. Useful for\n * Node < 18, testing, or injecting interceptors.\n */\n fetch?: typeof fetch;\n\n /** Optional abort signal for cancellation (used by the hooks layer). */\n signal?: AbortSignal;\n}\n\n/** The Shopwave API ships request metadata inside a single `extras` header. */\nexport type Extras = Record<string, unknown>;\n\nfunction resolveFetch(options: RequestOptions): typeof fetch {\n const f = options.fetch ?? (typeof fetch !== \"undefined\" ? fetch : undefined);\n if (!f) {\n throw new Error(\n \"No fetch implementation available. Pass `options.fetch` (e.g. node-fetch / undici) when running outside the browser.\"\n );\n }\n return f;\n}\n\nfunction buildExtras(extras: Extras, options: RequestOptions): Extras {\n const merged: Extras = { \"Content-Type\": \"application/json\", ...extras };\n if (options.token != null && merged.token == null) {\n merged.token = options.token;\n }\n return merged;\n}\n\n/**\n * Returns a JSON string of API errors if the response carries any, otherwise\n * `null`. Mirrors the original `!responseJson.api.message.errors` checks.\n */\nexport function getApiErrors(api?: apiResponse): string | null {\n const errors = api?.message?.errors;\n if (errors && Object.keys(errors).length > 0) {\n return JSON.stringify(errors);\n }\n return null;\n}\n\n/**\n * GET helper. Sends request metadata via the `extras` header exactly like the\n * original hooks did, parses JSON, and returns the typed payload.\n */\nexport async function apiGet<T>(\n path: string,\n extras: Extras,\n options: RequestOptions = {}\n): Promise<T> {\n const doFetch = resolveFetch(options);\n const url = (options.baseUrl ?? \"\") + path;\n\n const headers = { extras: JSON.stringify(buildExtras(extras, options)) };\n console.log('[API GET]', { url, headers });\n\n const response = await doFetch(url, {\n method: \"GET\",\n headers,\n signal: options.signal,\n });\n\n if (!response.ok) {\n throw new Error(`Network response was not ok (${response.status})`);\n }\n\n return (await response.json()) as T;\n}\n\n/**\n * JSON body helper for POST/PUT mutations.\n */\nexport async function apiSend<T>(\n path: string,\n method: \"POST\" | \"PUT\",\n payload: unknown,\n options: RequestOptions = {}\n): Promise<T> {\n const doFetch = resolveFetch(options);\n const url = (options.baseUrl ?? \"\") + path;\n\n const headers: Record<string, string> = { \"Content-Type\": \"application/json\" };\n if (options.token != null) {\n headers.token = options.token;\n }\n\n console.log(`[API ${method}]`, { url, headers, payload });\n\n const response = await doFetch(url, {\n method,\n headers,\n body: JSON.stringify(payload),\n signal: options.signal,\n });\n\n if (!response.ok) {\n throw new Error(`Failed to ${method.toLowerCase()}: ${response.statusText}`);\n }\n\n return (await response.json()) as T;\n}\n\n/**\n * DELETE helper.\n */\nexport async function apiDelete(\n path: string,\n options: RequestOptions = {}\n): Promise<void> {\n const doFetch = resolveFetch(options);\n const url = (options.baseUrl ?? \"\") + path;\n\n const headers: Record<string, string> = {};\n if (options.token != null) {\n headers.token = options.token;\n }\n\n console.log('[API DELETE]', { url, headers });\n\n const response = await doFetch(url, {\n method: \"DELETE\",\n headers,\n signal: options.signal,\n });\n\n if (!response.ok) {\n throw new Error(`Failed to delete: ${response.statusText}`);\n }\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\nexport interface Category {\n id: number;\n title: string;\n parentId: number | null;\n deleteDate: string;\n activeDate: string;\n type: number;\n}\n\nexport interface CategoryResponse {\n categories: {\n [key: number]: Category;\n };\n api: apiResponse;\n}\n\nexport interface FetchCategoriesParams {\n categoryIds?: Array<number>;\n /** Whether to include soft-deleted records. Defaults to `false`. */\n deleted?: boolean;\n /** Token override (also accepted via `options.token`). */\n token?: string;\n}\n\n/**\n * Fetches categories. Framework-agnostic: returns the flattened `Category[]`\n * or throws on API errors.\n */\nexport async function fetchCategories(\n params: FetchCategoriesParams = {},\n options: RequestOptions = {}\n): Promise<Category[]> {\n const extras: Record<string, unknown> = { deleted: params.deleted ?? false };\n\n if (params.categoryIds) {\n extras.categoryIds = params.categoryIds;\n }\n if (params.token) {\n extras.token = params.token;\n }\n\n const json = await apiGet<CategoryResponse>(\"/api/categories\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return Object.values(json.categories ?? {});\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\nexport interface Consumer {\n id: number;\n activeCount: number;\n firstName: string;\n lastName: string;\n email: string;\n}\n\nexport interface ConsumerResponse {\n consumers: {\n [key: number]: Consumer;\n };\n api: apiResponse;\n}\n\n/**\n * Fetches consumers by id. Returns an empty array when no ids are supplied\n * (the original hook short-circuited in that case).\n */\nexport async function fetchConsumers(\n consumerIds: number[] | null | undefined,\n options: RequestOptions = {}\n): Promise<Consumer[]> {\n if (!consumerIds || consumerIds.length === 0) {\n return [];\n }\n\n const extras: Record<string, unknown> = { ids: consumerIds.join(\",\") };\n\n const json = await apiGet<ConsumerResponse>(\"/api/consumer\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return Object.values(json.consumers ?? {});\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\nexport const rolesById = {\n \"1\": \"Owner\",\n \"2\": \"Manager\",\n \"3\": \"Assistant\",\n \"4\": \"Guest\",\n \"5\": \"Assistant Manager\",\n} as const;\n\nexport interface Employee {\n id: number;\n firstName: string;\n lastName: string;\n email: string;\n roleId: number;\n joinedDate: string;\n exitDate: string;\n stores: {\n [key: number]: {\n id: number;\n roleId: number;\n };\n };\n}\n\nexport interface EmployeeResponse {\n employees: {\n [key: number]: Employee;\n };\n api: apiResponse;\n}\n\nexport interface FetchEmployeesParams {\n /** Optional id filter. Forwarded when provided. */\n employeeIds?: Array<number>;\n /** Whether to include soft-deleted records. Defaults to `false`. */\n deleted?: boolean;\n}\n\n/**\n * Fetches employees. Returns the flattened `Employee[]`.\n */\nexport async function fetchEmployees(\n params: FetchEmployeesParams = {},\n options: RequestOptions = {}\n): Promise<Employee[]> {\n const extras: Record<string, unknown> = { deleted: params.deleted ?? false };\n\n if (params.employeeIds) {\n extras.employeeIds = params.employeeIds;\n }\n\n const json = await apiGet<EmployeeResponse>(\"/api/employees\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return Object.values(json.employees ?? {});\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\nexport interface ProductInstance {\n id: number;\n price: string;\n taxPercentage: string;\n timestamp: string;\n size: string;\n name: string;\n activeDate: string;\n tags: string;\n}\n\nexport interface Product {\n id: number;\n barcode: string;\n name: string;\n details: string;\n tags: string;\n unit: number;\n timestamp: string;\n activeDate: string;\n deleteDate: string;\n images: Array<string>;\n categories: Array<number>;\n instances: {\n [key: number]: ProductInstance;\n };\n}\n\nexport interface ProductResponse {\n products: {\n [key: number]: Product;\n };\n api: apiResponse;\n}\n\nexport interface FetchProductsParams {\n productIds?: Array<number>;\n storeId?: number;\n /** Whether to include soft-deleted records. Defaults to `false`. */\n deleted?: boolean;\n /** Token override (also accepted via `options.token`). */\n token?: string;\n}\n\n/**\n * Fetches products. Returns the flattened `Product[]`.\n */\nexport async function fetchProducts(\n params: FetchProductsParams = {},\n options: RequestOptions = {}\n): Promise<Product[]> {\n const extras: Record<string, unknown> = { deleted: params.deleted ?? false };\n\n if (params.productIds) {\n extras.productIds = params.productIds;\n }\n if (params.storeId) {\n extras.storeId = params.storeId;\n }\n if (params.token) {\n extras.token = params.token;\n }\n\n const json = await apiGet<ProductResponse>(\"/api/products\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return Object.values(json.products ?? {});\n}\n\n/**\n * Fetches products by id and returns them keyed by id, transparently batching\n * the request (default 200 ids per call) to stay within API limits. Extracted\n * from the original `useBasketReport` inline batching loop so it can be reused\n * outside React.\n */\nexport async function fetchProductsMap(\n productIds: number[] | null | undefined,\n options: RequestOptions = {},\n batchSize = 200\n): Promise<{ [id: number]: Product }> {\n const result: { [id: number]: Product } = {};\n if (!productIds || productIds.length === 0) {\n return result;\n }\n\n for (let i = 0; i < productIds.length; i += batchSize) {\n const batch = productIds.slice(i, i + batchSize);\n const products = await fetchProducts({ productIds: batch }, options);\n for (const product of products) {\n result[product.id] = product;\n }\n }\n\n return result;\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\n/** Promotion rule identifiers as stored by the Shopwave API. */\nexport enum PromotionRuleSet {\n Percentage = \"|%^/\",\n Combo = \"&%</\",\n MealDeal = \"&=^/\",\n}\n\nexport interface Promotion {\n id: number;\n merchantId: number;\n storeIds: number[];\n categoryIds: { [key: string]: number };\n productIds: { [key: string]: any };\n title: string;\n details: string | null;\n terms: string | null;\n startDate: string;\n endDate: string;\n daysAvailable: number[];\n automatic: number;\n rule: PromotionRuleSet;\n x: number;\n y: number | null;\n}\n\nexport interface PromotionResponse {\n promotions: {\n [key: number]: Promotion;\n };\n api: apiResponse;\n}\n\nexport interface FetchPromotionsParams {\n /** Optional id filter. Forwarded when provided. */\n promotionIds?: Array<number>;\n /** Whether to include soft-deleted records. Defaults to `false`. */\n deleted?: boolean;\n /** Token override (also accepted via `options.token`). */\n token?: string;\n}\n\n/**\n * Fetches promotions. Returns the flattened `Promotion[]`.\n */\nexport async function fetchPromotions(\n params: FetchPromotionsParams = {},\n options: RequestOptions = {}\n): Promise<Promotion[]> {\n const extras: Record<string, unknown> = { deleted: params.deleted ?? false };\n\n if (params.promotionIds) {\n extras.promotionIds = params.promotionIds;\n }\n if (params.token) {\n extras.token = params.token;\n }\n\n const json = await apiGet<PromotionResponse>(\"/api/promotions\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return Object.values(json.promotions ?? {});\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\nexport interface Store {\n id: number;\n lat: number;\n lng: number;\n addressLine1: string;\n addressLine2: string | null;\n addressLine3: string;\n phoneNumber: string;\n city: string;\n postcode: string;\n countryId: number | null;\n timezoneId: number | null;\n storeDeleteDate: string | null;\n email: string | null;\n sandbox: boolean | null;\n}\n\nexport interface StoreResponse {\n stores: {\n [key: number]: Store;\n };\n api: apiResponse;\n}\n\nexport interface FetchStoresParams {\n /** Whether to include soft-deleted records. Defaults to `false`. */\n deleted?: boolean;\n}\n\n/**\n * Fetches stores. Returns the flattened `Store[]`.\n */\nexport async function fetchStores(\n params: FetchStoresParams = {},\n options: RequestOptions = {}\n): Promise<Store[]> {\n const extras: Record<string, unknown> = { deleted: params.deleted ?? false };\n\n const json = await apiGet<StoreResponse>(\"/api/stores\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return Object.values(json.stores ?? {});\n}\n","import { apiGet, getApiErrors, type RequestOptions } from \"./request\";\nimport type { apiResponse } from \"./types\";\n\nexport interface ReportKey {\n name: string;\n type: string;\n item?: ReportKey[];\n}\n\nexport interface ReportData {\n keys: ReportKey[];\n data: any[][];\n}\n\nexport interface ReportResponse {\n reports: {\n [key: string]: ReportData;\n };\n api: apiResponse;\n}\n\nexport interface ReportQuery {\n FROM: string;\n WHERE?: {\n AND?: string[];\n OR?: string[];\n };\n SELECT?: string[];\n LIMIT?: number;\n OFFSET?: number;\n}\n\nexport interface ReportQueryMap {\n [key: string]: ReportQuery;\n}\n\n/**\n * Runs one or more report queries and returns the `reports` map keyed by query\n * name. The query is JSON-encoded into the `extras.query` header, matching the\n * original endpoint contract.\n */\nexport async function fetchReport(\n query: ReportQueryMap,\n options: RequestOptions = {}\n): Promise<ReportResponse[\"reports\"]> {\n const extras: Record<string, unknown> = { query: JSON.stringify(query) };\n\n const json = await apiGet<ReportResponse>(\"/api/report\", extras, options);\n\n const error = getApiErrors(json.api);\n if (error) {\n throw new Error(error);\n }\n\n return json.reports ?? {};\n}\n","import { apiDelete, type RequestOptions } from \"./request\";\n\n/**\n * Ends the current server session.\n *\n * This is the framework-agnostic half of the original `useLogout` hook. The\n * Next.js-specific redirect logic (router.push to the auth server logout URL,\n * built from server actions) is intentionally NOT included here because it is\n * tied to `next/navigation` and `'use server'` actions — see the README.\n */\nexport async function logout(options: RequestOptions = {}): Promise<void> {\n await apiDelete(\"/api/session?action=logout\", options);\n}\n","import { apiDelete, apiSend, type RequestOptions } from \"./request\";\n\n/**\n * Generic CRUD-style mutations extracted from `useHandleDelete` /\n * `useHandleSubmit`. The original hooks also surfaced notistack snackbars; that\n * UI concern is deliberately left to the hooks/host layer so core stays\n * dependency-free.\n */\n\n/**\n * Deletes `/api/{resourcePath}/{entityId}`.\n */\nexport async function deleteEntity(\n resourcePath: string,\n entityId: number | string,\n options: RequestOptions = {}\n): Promise<void> {\n if (entityId == null || entityId === \"\") {\n throw new Error(\"entityId is missing\");\n }\n await apiDelete(`/api/${resourcePath}/${entityId}`, options);\n}\n\nexport interface SubmitEntityArgs {\n /** Fully-resolved endpoint, e.g. `/api/products` or `/api/products/42`. */\n endpoint: string;\n /** Defaults to PUT when an `entityId` exists, otherwise POST. */\n method?: \"POST\" | \"PUT\";\n /** The request payload (already transformed by the caller). */\n payload: unknown;\n}\n\nexport interface SubmitEntityResponse<R = any> {\n result?: R;\n [key: string]: unknown;\n}\n\n/**\n * Sends a create/update mutation and returns the parsed `result` field\n * (matching the original `result.result` access).\n */\nexport async function submitEntity<R = any>(\n { endpoint, method = \"POST\", payload }: SubmitEntityArgs,\n options: RequestOptions = {}\n): Promise<R | undefined> {\n const json = await apiSend<SubmitEntityResponse<R>>(\n endpoint,\n method,\n payload,\n options\n );\n return json.result;\n}\n","import type { Consumer } from \"./consumer\";\nimport type { Product } from \"./product\";\nimport type { ReportQueryMap, ReportResponse } from \"./report\";\n\n// ── Basket Report Types (preserved from the original `types/basket.ts`) ──────\n\nexport interface BasketItem {\n productId: number;\n productName: string;\n quantity: number;\n price: number;\n tax: number;\n}\n\nexport interface Basket {\n id: number;\n name: string;\n consumerId: number;\n products: BasketItem[];\n total: number;\n taxTotal: number;\n status: \"pending\" | \"completed\" | \"cancelled\";\n completeDate: string;\n}\n\nexport interface BasketReportRow {\n id: number;\n basketId: number;\n basketName: string;\n consumerId: number;\n consumerName: string;\n consumerEmail: string;\n products: BasketItem[];\n basketTotal: number;\n tax: number;\n dateTime: string;\n status: string;\n}\n\nexport interface BasketSummary {\n totalBaskets: number;\n totalRevenue: number;\n totalTax: number;\n uniqueConsumers: number;\n}\n\nexport interface BasketFilters {\n search: string;\n dateRange: {\n start: Date | null;\n end: Date | null;\n };\n consumerId: number | null;\n status: \"all\" | \"pending\" | \"completed\" | \"cancelled\";\n}\n\nexport interface BasketPagination {\n page: number;\n pageSize: number;\n total: number;\n}\n\nexport const DEFAULT_BASKET_FILTERS: BasketFilters = {\n search: \"\",\n dateRange: {\n start: null,\n end: null,\n },\n consumerId: null,\n status: \"all\",\n};\n\nexport const DEFAULT_PAGINATION: BasketPagination = {\n page: 0,\n pageSize: 25,\n total: 0,\n};\n\n/** Intermediate shape produced by {@link parseBasketReportData}. */\nexport interface ParsedBasket {\n id: number;\n name: string;\n consumerId: number;\n products: BasketItem[];\n total: number;\n taxTotal: number;\n status: \"completed\";\n completeDate: string;\n}\n\n// ── Pure transform helpers (extracted from the original `useBasketReport`) ────\n\n/** Formats a date as `YYYY-MM-DD HH:mm:ss` for the report query. */\nexport function formatDateForQuery(date: Date, isEndOfDay = false): string {\n const year = date.getFullYear();\n const month = String(date.getMonth() + 1).padStart(2, \"0\");\n const day = String(date.getDate()).padStart(2, \"0\");\n const time = isEndOfDay ? \"23:59:59\" : \"00:00:00\";\n return `${year}-${month}-${day} ${time}`;\n}\n\n/** Builds the `Basket` report query from a set of filters. */\nexport function buildBasketReportQuery(filters: BasketFilters): ReportQueryMap {\n const whereConditions: string[] = [];\n\n const today = new Date();\n const startDate = filters.dateRange.start ?? today;\n const endDate = filters.dateRange.end ?? today;\n\n whereConditions.push(\n `Basket.completeDate > '${formatDateForQuery(startDate, false)}'`\n );\n whereConditions.push(\n `Basket.completeDate < '${formatDateForQuery(endDate, true)}'`\n );\n\n if (filters.consumerId) {\n whereConditions.push(`Basket.consumerId = ${filters.consumerId}`);\n }\n\n if (filters.status !== \"all\") {\n whereConditions.push(`Basket.status = '${filters.status}'`);\n }\n\n return {\n baskets: {\n FROM: \"Basket\",\n WHERE: whereConditions.length > 0 ? { AND: whereConditions } : undefined,\n },\n };\n}\n\n/** Flattens the raw report rows/keys into structured baskets. */\nexport function parseBasketReportData(\n reports: ReportResponse[\"reports\"] | null | undefined\n): ParsedBasket[] {\n if (!reports?.baskets?.data || !reports?.baskets?.keys) {\n return [];\n }\n\n const { keys, data } = reports.baskets;\n\n const keyIndices: { [key: string]: number } = {};\n keys.forEach((key, index) => {\n keyIndices[key.name] = index;\n });\n\n const productKey = keys.find((k) => k.name === \"Basket.Product\");\n const productSubKeys: { [key: string]: number } = {};\n if (productKey?.item) {\n productKey.item.forEach((subKey, index) => {\n productSubKeys[subKey.name] = index;\n });\n }\n\n return data.map((row) => {\n const productsArray = (row[keyIndices[\"Basket.Product\"]] as any[][]) || [];\n const products: BasketItem[] = productsArray.map((productRow) => ({\n productId: productRow[productSubKeys[\"Basket.Product.productId\"]] as number,\n productName: `Product #${productRow[productSubKeys[\"Basket.Product.productId\"]]}`,\n quantity:\n (productRow[productSubKeys[\"Basket.Product.quantity\"]] as number) || 1,\n price:\n (productRow[productSubKeys[\"Basket.Product.productPrice\"]] as number) ||\n 0,\n tax:\n (productRow[\n productSubKeys[\"Basket.Product.productTaxPercentage\"]\n ] as number) || 0,\n }));\n\n const total = products.reduce((sum, p) => sum + p.price * p.quantity, 0);\n const taxTotal = products.reduce(\n (sum, p) => sum + p.price * p.quantity * p.tax,\n 0\n );\n\n const completeDateTimestamp = row[keyIndices[\"Basket.completeDate\"]] as number;\n const completeDate = completeDateTimestamp\n ? new Date(completeDateTimestamp).toISOString()\n : \"\";\n\n return {\n id: row[keyIndices[\"Basket.id\"]] as number,\n name: row[keyIndices[\"Basket.name\"]] as string,\n consumerId: row[keyIndices[\"Basket.consumerId\"]] as number,\n products,\n total,\n taxTotal,\n status: \"completed\" as const,\n completeDate,\n };\n });\n}\n\n/** Unique non-null consumer ids referenced by a set of baskets. */\nexport function collectConsumerIds(baskets: ParsedBasket[]): number[] | null {\n if (!baskets.length) return null;\n const ids = baskets\n .map((b) => b.consumerId)\n .filter((id): id is number => id != null);\n return ids.length > 0 ? [...new Set(ids)] : null;\n}\n\n/** Unique product ids referenced by a set of baskets. */\nexport function collectProductIds(baskets: ParsedBasket[]): number[] | null {\n if (!baskets.length) return null;\n const ids = new Set<number>();\n baskets.forEach((basket) => {\n basket.products.forEach((product) => {\n if (product.productId) {\n ids.add(product.productId);\n }\n });\n });\n return ids.size > 0 ? [...ids] : null;\n}\n\nexport interface CombineBasketRowsParams {\n baskets: ParsedBasket[];\n consumerMap: { [id: number]: Consumer };\n productMap: { [id: number]: Product };\n search?: string;\n}\n\n/** Joins baskets with consumer + product lookups, applies search, sorts. */\nexport function combineBasketRows({\n baskets,\n consumerMap,\n productMap,\n search,\n}: CombineBasketRowsParams): BasketReportRow[] {\n if (!baskets.length) return [];\n\n let combinedRows: BasketReportRow[] = baskets.map((basket) => {\n const consumer = basket.consumerId ? consumerMap[basket.consumerId] : null;\n\n const productsWithNames: BasketItem[] = basket.products.map((p) => {\n const product = productMap[p.productId];\n return {\n ...p,\n productName: product?.name || `Product #${p.productId}`,\n };\n });\n\n return {\n id: basket.id,\n basketId: basket.id,\n basketName: basket.name || `Basket #${basket.id}`,\n consumerId: basket.consumerId,\n consumerName: consumer\n ? `${consumer.firstName} ${consumer.lastName}`\n : \"Unknown\",\n consumerEmail: consumer?.email || \"-\",\n products: productsWithNames,\n basketTotal: (basket.total || 0) / 100,\n tax: basket.taxTotal || 0,\n dateTime: basket.completeDate,\n status: basket.status || \"pending\",\n };\n });\n\n if (search) {\n const searchLower = search.toLowerCase();\n combinedRows = combinedRows.filter(\n (row) =>\n row.basketId.toString().includes(searchLower) ||\n row.basketName.toLowerCase().includes(searchLower) ||\n row.consumerName.toLowerCase().includes(searchLower) ||\n row.consumerEmail.toLowerCase().includes(searchLower)\n );\n }\n\n combinedRows.sort((a, b) => {\n const dateA = new Date(a.dateTime).getTime();\n const dateB = new Date(b.dateTime).getTime();\n return dateB - dateA;\n });\n\n return combinedRows;\n}\n\n/** Aggregate totals for a set of report rows. */\nexport function computeBasketSummary(rows: BasketReportRow[]): BasketSummary {\n const uniqueConsumerIds = new Set(rows.map((row) => row.consumerId));\n return {\n totalBaskets: rows.length,\n totalRevenue: rows.reduce((sum, row) => sum + row.basketTotal, 0),\n totalTax: rows.reduce((sum, row) => sum + row.tax, 0),\n uniqueConsumers: uniqueConsumerIds.size,\n };\n}\n\n/** Builds a consumer id → consumer lookup. */\nexport function buildConsumerMap(consumers: Consumer[] | null | undefined): {\n [id: number]: Consumer;\n} {\n const map: { [id: number]: Consumer } = {};\n if (consumers) {\n consumers.forEach((consumer) => {\n map[consumer.id] = consumer;\n });\n }\n return map;\n}\n"],"mappings":";;AAkCA,SAAS,aAAa,SAAuC;CAC3D,MAAM,IAAI,QAAQ,UAAU,OAAO,UAAU,cAAc,QAAQ;AACnE,KAAI,CAAC,EACH,OAAM,IAAI,MACR,uHACD;AAEH,QAAO;;AAGT,SAAS,YAAY,QAAgB,SAAiC;CACpE,MAAMA,SAAiB;EAAE,gBAAgB;EAAoB,GAAG;EAAQ;AACxE,KAAI,QAAQ,SAAS,QAAQ,OAAO,SAAS,KAC3C,QAAO,QAAQ,QAAQ;AAEzB,QAAO;;;;;;AAOT,SAAgB,aAAa,KAAkC;CAC7D,MAAM,SAAS,KAAK,SAAS;AAC7B,KAAI,UAAU,OAAO,KAAK,OAAO,CAAC,SAAS,EACzC,QAAO,KAAK,UAAU,OAAO;AAE/B,QAAO;;;;;;AAOT,eAAsB,OACpB,MACA,QACA,UAA0B,EAAE,EAChB;CACZ,MAAM,UAAU,aAAa,QAAQ;CACrC,MAAM,OAAO,QAAQ,WAAW,MAAM;CAEtC,MAAM,UAAU,EAAE,QAAQ,KAAK,UAAU,YAAY,QAAQ,QAAQ,CAAC,EAAE;AACxE,SAAQ,IAAI,aAAa;EAAE;EAAK;EAAS,CAAC;CAE1C,MAAM,WAAW,MAAM,QAAQ,KAAK;EAClC,QAAQ;EACR;EACA,QAAQ,QAAQ;EACjB,CAAC;AAEF,KAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MAAM,gCAAgC,SAAS,OAAO,GAAG;AAGrE,QAAQ,MAAM,SAAS,MAAM;;;;;AAM/B,eAAsB,QACpB,MACA,QACA,SACA,UAA0B,EAAE,EAChB;CACZ,MAAM,UAAU,aAAa,QAAQ;CACrC,MAAM,OAAO,QAAQ,WAAW,MAAM;CAEtC,MAAMC,UAAkC,EAAE,gBAAgB,oBAAoB;AAC9E,KAAI,QAAQ,SAAS,KACnB,SAAQ,QAAQ,QAAQ;AAG1B,SAAQ,IAAI,QAAQ,OAAO,IAAI;EAAE;EAAK;EAAS;EAAS,CAAC;CAEzD,MAAM,WAAW,MAAM,QAAQ,KAAK;EAClC;EACA;EACA,MAAM,KAAK,UAAU,QAAQ;EAC7B,QAAQ,QAAQ;EACjB,CAAC;AAEF,KAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MAAM,aAAa,OAAO,aAAa,CAAC,IAAI,SAAS,aAAa;AAG9E,QAAQ,MAAM,SAAS,MAAM;;;;;AAM/B,eAAsB,UACpB,MACA,UAA0B,EAAE,EACb;CACf,MAAM,UAAU,aAAa,QAAQ;CACrC,MAAM,OAAO,QAAQ,WAAW,MAAM;CAEtC,MAAMA,UAAkC,EAAE;AAC1C,KAAI,QAAQ,SAAS,KACnB,SAAQ,QAAQ,QAAQ;AAG1B,SAAQ,IAAI,gBAAgB;EAAE;EAAK;EAAS,CAAC;CAE7C,MAAM,WAAW,MAAM,QAAQ,KAAK;EAClC,QAAQ;EACR;EACA,QAAQ,QAAQ;EACjB,CAAC;AAEF,KAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MAAM,qBAAqB,SAAS,aAAa;;;;;;;;;ACtH/D,eAAsB,gBACpB,SAAgC,EAAE,EAClC,UAA0B,EAAE,EACP;CACrB,MAAMC,SAAkC,EAAE,SAAS,OAAO,WAAW,OAAO;AAE5E,KAAI,OAAO,YACT,QAAO,cAAc,OAAO;AAE9B,KAAI,OAAO,MACT,QAAO,QAAQ,OAAO;CAGxB,MAAM,OAAO,MAAM,OAAyB,mBAAmB,QAAQ,QAAQ;CAE/E,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,OAAO,OAAO,KAAK,cAAc,EAAE,CAAC;;;;;;;;;AC7B7C,eAAsB,eACpB,aACA,UAA0B,EAAE,EACP;AACrB,KAAI,CAAC,eAAe,YAAY,WAAW,EACzC,QAAO,EAAE;CAKX,MAAM,OAAO,MAAM,OAAyB,iBAFJ,EAAE,KAAK,YAAY,KAAK,IAAI,EAAE,EAED,QAAQ;CAE7E,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,OAAO,OAAO,KAAK,aAAa,EAAE,CAAC;;;;;ACpC5C,MAAa,YAAY;CACvB,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;CACN;;;;AAmCD,eAAsB,eACpB,SAA+B,EAAE,EACjC,UAA0B,EAAE,EACP;CACrB,MAAMC,SAAkC,EAAE,SAAS,OAAO,WAAW,OAAO;AAE5E,KAAI,OAAO,YACT,QAAO,cAAc,OAAO;CAG9B,MAAM,OAAO,MAAM,OAAyB,kBAAkB,QAAQ,QAAQ;CAE9E,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,OAAO,OAAO,KAAK,aAAa,EAAE,CAAC;;;;;;;;ACX5C,eAAsB,cACpB,SAA8B,EAAE,EAChC,UAA0B,EAAE,EACR;CACpB,MAAMC,SAAkC,EAAE,SAAS,OAAO,WAAW,OAAO;AAE5E,KAAI,OAAO,WACT,QAAO,aAAa,OAAO;AAE7B,KAAI,OAAO,QACT,QAAO,UAAU,OAAO;AAE1B,KAAI,OAAO,MACT,QAAO,QAAQ,OAAO;CAGxB,MAAM,OAAO,MAAM,OAAwB,iBAAiB,QAAQ,QAAQ;CAE5E,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,OAAO,OAAO,KAAK,YAAY,EAAE,CAAC;;;;;;;;AAS3C,eAAsB,iBACpB,YACA,UAA0B,EAAE,EAC5B,YAAY,KACwB;CACpC,MAAMC,SAAoC,EAAE;AAC5C,KAAI,CAAC,cAAc,WAAW,WAAW,EACvC,QAAO;AAGT,MAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,WAAW;EAErD,MAAM,WAAW,MAAM,cAAc,EAAE,YADzB,WAAW,MAAM,GAAG,IAAI,UAAU,EACU,EAAE,QAAQ;AACpE,OAAK,MAAM,WAAW,SACpB,QAAO,QAAQ,MAAM;;AAIzB,QAAO;;;;;;AChGT,IAAY,gEAAL;AACL;AACA;AACA;;;;;;AAwCF,eAAsB,gBACpB,SAAgC,EAAE,EAClC,UAA0B,EAAE,EACN;CACtB,MAAMC,SAAkC,EAAE,SAAS,OAAO,WAAW,OAAO;AAE5E,KAAI,OAAO,aACT,QAAO,eAAe,OAAO;AAE/B,KAAI,OAAO,MACT,QAAO,QAAQ,OAAO;CAGxB,MAAM,OAAO,MAAM,OAA0B,mBAAmB,QAAQ,QAAQ;CAEhF,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,OAAO,OAAO,KAAK,cAAc,EAAE,CAAC;;;;;;;;AChC7C,eAAsB,YACpB,SAA4B,EAAE,EAC9B,UAA0B,EAAE,EACV;CAGlB,MAAM,OAAO,MAAM,OAAsB,eAFD,EAAE,SAAS,OAAO,WAAW,OAAO,EAEZ,QAAQ;CAExE,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;;;;;;;;;;ACPzC,eAAsB,YACpB,OACA,UAA0B,EAAE,EACQ;CAGpC,MAAM,OAAO,MAAM,OAAuB,eAFF,EAAE,OAAO,KAAK,UAAU,MAAM,EAAE,EAEP,QAAQ;CAEzE,MAAM,QAAQ,aAAa,KAAK,IAAI;AACpC,KAAI,MACF,OAAM,IAAI,MAAM,MAAM;AAGxB,QAAO,KAAK,WAAW,EAAE;;;;;;;;;;;;;AC5C3B,eAAsB,OAAO,UAA0B,EAAE,EAAiB;AACxE,OAAM,UAAU,8BAA8B,QAAQ;;;;;;;;;;;;;;ACCxD,eAAsB,aACpB,cACA,UACA,UAA0B,EAAE,EACb;AACf,KAAI,YAAY,QAAQ,aAAa,GACnC,OAAM,IAAI,MAAM,sBAAsB;AAExC,OAAM,UAAU,QAAQ,aAAa,GAAG,YAAY,QAAQ;;;;;;AAqB9D,eAAsB,aACpB,EAAE,UAAU,SAAS,QAAQ,WAC7B,UAA0B,EAAE,EACJ;AAOxB,SANa,MAAM,QACjB,UACA,QACA,SACA,QACD,EACW;;;;;ACWd,MAAaC,yBAAwC;CACnD,QAAQ;CACR,WAAW;EACT,OAAO;EACP,KAAK;EACN;CACD,YAAY;CACZ,QAAQ;CACT;AAED,MAAaC,qBAAuC;CAClD,MAAM;CACN,UAAU;CACV,OAAO;CACR;;AAiBD,SAAgB,mBAAmB,MAAY,aAAa,OAAe;AAKzE,QAAO,GAJM,KAAK,aAAa,CAIhB,GAHD,OAAO,KAAK,UAAU,GAAG,EAAE,CAAC,SAAS,GAAG,IAAI,CAGlC,GAFZ,OAAO,KAAK,SAAS,CAAC,CAAC,SAAS,GAAG,IAAI,CAEpB,GADlB,aAAa,aAAa;;;AAKzC,SAAgB,uBAAuB,SAAwC;CAC7E,MAAMC,kBAA4B,EAAE;CAEpC,MAAM,wBAAQ,IAAI,MAAM;CACxB,MAAM,YAAY,QAAQ,UAAU,SAAS;CAC7C,MAAM,UAAU,QAAQ,UAAU,OAAO;AAEzC,iBAAgB,KACd,0BAA0B,mBAAmB,WAAW,MAAM,CAAC,GAChE;AACD,iBAAgB,KACd,0BAA0B,mBAAmB,SAAS,KAAK,CAAC,GAC7D;AAED,KAAI,QAAQ,WACV,iBAAgB,KAAK,uBAAuB,QAAQ,aAAa;AAGnE,KAAI,QAAQ,WAAW,MACrB,iBAAgB,KAAK,oBAAoB,QAAQ,OAAO,GAAG;AAG7D,QAAO,EACL,SAAS;EACP,MAAM;EACN,OAAO,gBAAgB,SAAS,IAAI,EAAE,KAAK,iBAAiB,GAAG;EAChE,EACF;;;AAIH,SAAgB,sBACd,SACgB;AAChB,KAAI,CAAC,SAAS,SAAS,QAAQ,CAAC,SAAS,SAAS,KAChD,QAAO,EAAE;CAGX,MAAM,EAAE,MAAM,SAAS,QAAQ;CAE/B,MAAMC,aAAwC,EAAE;AAChD,MAAK,SAAS,KAAK,UAAU;AAC3B,aAAW,IAAI,QAAQ;GACvB;CAEF,MAAM,aAAa,KAAK,MAAM,MAAM,EAAE,SAAS,iBAAiB;CAChE,MAAMC,iBAA4C,EAAE;AACpD,KAAI,YAAY,KACd,YAAW,KAAK,SAAS,QAAQ,UAAU;AACzC,iBAAe,OAAO,QAAQ;GAC9B;AAGJ,QAAO,KAAK,KAAK,QAAQ;EAEvB,MAAMC,YADiB,IAAI,WAAW,sBAAkC,EAAE,EAC7B,KAAK,gBAAgB;GAChE,WAAW,WAAW,eAAe;GACrC,aAAa,YAAY,WAAW,eAAe;GACnD,UACG,WAAW,eAAe,+BAA0C;GACvE,OACG,WAAW,eAAe,mCAC3B;GACF,KACG,WACC,eAAe,2CACD;GACnB,EAAE;EAEH,MAAM,QAAQ,SAAS,QAAQ,KAAK,MAAM,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE;EACxE,MAAM,WAAW,SAAS,QACvB,KAAK,MAAM,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,KAC3C,EACD;EAED,MAAM,wBAAwB,IAAI,WAAW;EAC7C,MAAM,eAAe,wBACjB,IAAI,KAAK,sBAAsB,CAAC,aAAa,GAC7C;AAEJ,SAAO;GACL,IAAI,IAAI,WAAW;GACnB,MAAM,IAAI,WAAW;GACrB,YAAY,IAAI,WAAW;GAC3B;GACA;GACA;GACA,QAAQ;GACR;GACD;GACD;;;AAIJ,SAAgB,mBAAmB,SAA0C;AAC3E,KAAI,CAAC,QAAQ,OAAQ,QAAO;CAC5B,MAAM,MAAM,QACT,KAAK,MAAM,EAAE,WAAW,CACxB,QAAQ,OAAqB,MAAM,KAAK;AAC3C,QAAO,IAAI,SAAS,IAAI,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG;;;AAI9C,SAAgB,kBAAkB,SAA0C;AAC1E,KAAI,CAAC,QAAQ,OAAQ,QAAO;CAC5B,MAAM,sBAAM,IAAI,KAAa;AAC7B,SAAQ,SAAS,WAAW;AAC1B,SAAO,SAAS,SAAS,YAAY;AACnC,OAAI,QAAQ,UACV,KAAI,IAAI,QAAQ,UAAU;IAE5B;GACF;AACF,QAAO,IAAI,OAAO,IAAI,CAAC,GAAG,IAAI,GAAG;;;AAWnC,SAAgB,kBAAkB,EAChC,SACA,aACA,YACA,UAC6C;AAC7C,KAAI,CAAC,QAAQ,OAAQ,QAAO,EAAE;CAE9B,IAAIC,eAAkC,QAAQ,KAAK,WAAW;EAC5D,MAAM,WAAW,OAAO,aAAa,YAAY,OAAO,cAAc;EAEtE,MAAMC,oBAAkC,OAAO,SAAS,KAAK,MAAM;GACjE,MAAM,UAAU,WAAW,EAAE;AAC7B,UAAO;IACL,GAAG;IACH,aAAa,SAAS,QAAQ,YAAY,EAAE;IAC7C;IACD;AAEF,SAAO;GACL,IAAI,OAAO;GACX,UAAU,OAAO;GACjB,YAAY,OAAO,QAAQ,WAAW,OAAO;GAC7C,YAAY,OAAO;GACnB,cAAc,WACV,GAAG,SAAS,UAAU,GAAG,SAAS,aAClC;GACJ,eAAe,UAAU,SAAS;GAClC,UAAU;GACV,cAAc,OAAO,SAAS,KAAK;GACnC,KAAK,OAAO,YAAY;GACxB,UAAU,OAAO;GACjB,QAAQ,OAAO,UAAU;GAC1B;GACD;AAEF,KAAI,QAAQ;EACV,MAAM,cAAc,OAAO,aAAa;AACxC,iBAAe,aAAa,QACzB,QACC,IAAI,SAAS,UAAU,CAAC,SAAS,YAAY,IAC7C,IAAI,WAAW,aAAa,CAAC,SAAS,YAAY,IAClD,IAAI,aAAa,aAAa,CAAC,SAAS,YAAY,IACpD,IAAI,cAAc,aAAa,CAAC,SAAS,YAAY,CACxD;;AAGH,cAAa,MAAM,GAAG,MAAM;EAC1B,MAAM,QAAQ,IAAI,KAAK,EAAE,SAAS,CAAC,SAAS;AAE5C,SADc,IAAI,KAAK,EAAE,SAAS,CAAC,SAAS,GAC7B;GACf;AAEF,QAAO;;;AAIT,SAAgB,qBAAqB,MAAwC;CAC3E,MAAM,oBAAoB,IAAI,IAAI,KAAK,KAAK,QAAQ,IAAI,WAAW,CAAC;AACpE,QAAO;EACL,cAAc,KAAK;EACnB,cAAc,KAAK,QAAQ,KAAK,QAAQ,MAAM,IAAI,aAAa,EAAE;EACjE,UAAU,KAAK,QAAQ,KAAK,QAAQ,MAAM,IAAI,KAAK,EAAE;EACrD,iBAAiB,kBAAkB;EACpC;;;AAIH,SAAgB,iBAAiB,WAE/B;CACA,MAAMC,MAAkC,EAAE;AAC1C,KAAI,UACF,WAAU,SAAS,aAAa;AAC9B,MAAI,SAAS,MAAM;GACnB;AAEJ,QAAO"}
|
|
@@ -0,0 +1,481 @@
|
|
|
1
|
+
//#region src/core/types.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* Shared API envelope types.
|
|
4
|
+
*
|
|
5
|
+
* Preserved exactly from the original `model/message.ts` so existing
|
|
6
|
+
* response handling keeps working.
|
|
7
|
+
*/
|
|
8
|
+
interface ErrorMessage {
|
|
9
|
+
id: number;
|
|
10
|
+
title: string;
|
|
11
|
+
details: string;
|
|
12
|
+
moreInfo: string;
|
|
13
|
+
}
|
|
14
|
+
interface SuccessMessage {
|
|
15
|
+
id: number;
|
|
16
|
+
title: string;
|
|
17
|
+
details: string;
|
|
18
|
+
}
|
|
19
|
+
interface MessageInfo {
|
|
20
|
+
errors: {
|
|
21
|
+
[key: number]: ErrorMessage;
|
|
22
|
+
};
|
|
23
|
+
success: {
|
|
24
|
+
[key: number]: SuccessMessage;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
interface apiResponse {
|
|
28
|
+
message: MessageInfo;
|
|
29
|
+
codeBaseVersion: number;
|
|
30
|
+
executionTime_milliSeconds: number;
|
|
31
|
+
}
|
|
32
|
+
//#endregion
|
|
33
|
+
//#region src/core/request.d.ts
|
|
34
|
+
/**
|
|
35
|
+
* Per-call configuration shared by every core API function.
|
|
36
|
+
*
|
|
37
|
+
* Nothing here is React-specific. By accepting these options per call, the
|
|
38
|
+
* core layer works in the browser/Next (relative `/api/...` URLs, the default)
|
|
39
|
+
* AND in Node / CLI / Vue / Angular by passing an absolute `baseUrl`, an auth
|
|
40
|
+
* `token`, and/or a custom `fetch` implementation.
|
|
41
|
+
*/
|
|
42
|
+
interface RequestOptions {
|
|
43
|
+
/**
|
|
44
|
+
* Prefixed in front of every request path. Leave undefined in the browser to
|
|
45
|
+
* use relative URLs (e.g. `/api/products`). In Node/CLI pass something like
|
|
46
|
+
* `https://api.shopwave.com`.
|
|
47
|
+
*/
|
|
48
|
+
baseUrl?: string;
|
|
49
|
+
/** OAuth/session token forwarded in the `extras.token` header. */
|
|
50
|
+
token?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Custom fetch implementation. Defaults to the global `fetch`. Useful for
|
|
53
|
+
* Node < 18, testing, or injecting interceptors.
|
|
54
|
+
*/
|
|
55
|
+
fetch?: typeof fetch;
|
|
56
|
+
/** Optional abort signal for cancellation (used by the hooks layer). */
|
|
57
|
+
signal?: AbortSignal;
|
|
58
|
+
}
|
|
59
|
+
/** The Shopwave API ships request metadata inside a single `extras` header. */
|
|
60
|
+
type Extras = Record<string, unknown>;
|
|
61
|
+
/**
|
|
62
|
+
* Returns a JSON string of API errors if the response carries any, otherwise
|
|
63
|
+
* `null`. Mirrors the original `!responseJson.api.message.errors` checks.
|
|
64
|
+
*/
|
|
65
|
+
declare function getApiErrors(api?: apiResponse): string | null;
|
|
66
|
+
/**
|
|
67
|
+
* GET helper. Sends request metadata via the `extras` header exactly like the
|
|
68
|
+
* original hooks did, parses JSON, and returns the typed payload.
|
|
69
|
+
*/
|
|
70
|
+
declare function apiGet<T>(path: string, extras: Extras, options?: RequestOptions): Promise<T>;
|
|
71
|
+
/**
|
|
72
|
+
* JSON body helper for POST/PUT mutations.
|
|
73
|
+
*/
|
|
74
|
+
declare function apiSend<T>(path: string, method: "POST" | "PUT", payload: unknown, options?: RequestOptions): Promise<T>;
|
|
75
|
+
/**
|
|
76
|
+
* DELETE helper.
|
|
77
|
+
*/
|
|
78
|
+
declare function apiDelete(path: string, options?: RequestOptions): Promise<void>;
|
|
79
|
+
//#endregion
|
|
80
|
+
//#region src/core/category.d.ts
|
|
81
|
+
interface Category {
|
|
82
|
+
id: number;
|
|
83
|
+
title: string;
|
|
84
|
+
parentId: number | null;
|
|
85
|
+
deleteDate: string;
|
|
86
|
+
activeDate: string;
|
|
87
|
+
type: number;
|
|
88
|
+
}
|
|
89
|
+
interface CategoryResponse {
|
|
90
|
+
categories: {
|
|
91
|
+
[key: number]: Category;
|
|
92
|
+
};
|
|
93
|
+
api: apiResponse;
|
|
94
|
+
}
|
|
95
|
+
interface FetchCategoriesParams {
|
|
96
|
+
categoryIds?: Array<number>;
|
|
97
|
+
/** Whether to include soft-deleted records. Defaults to `false`. */
|
|
98
|
+
deleted?: boolean;
|
|
99
|
+
/** Token override (also accepted via `options.token`). */
|
|
100
|
+
token?: string;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Fetches categories. Framework-agnostic: returns the flattened `Category[]`
|
|
104
|
+
* or throws on API errors.
|
|
105
|
+
*/
|
|
106
|
+
declare function fetchCategories(params?: FetchCategoriesParams, options?: RequestOptions): Promise<Category[]>;
|
|
107
|
+
//#endregion
|
|
108
|
+
//#region src/core/consumer.d.ts
|
|
109
|
+
interface Consumer {
|
|
110
|
+
id: number;
|
|
111
|
+
activeCount: number;
|
|
112
|
+
firstName: string;
|
|
113
|
+
lastName: string;
|
|
114
|
+
email: string;
|
|
115
|
+
}
|
|
116
|
+
interface ConsumerResponse {
|
|
117
|
+
consumers: {
|
|
118
|
+
[key: number]: Consumer;
|
|
119
|
+
};
|
|
120
|
+
api: apiResponse;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Fetches consumers by id. Returns an empty array when no ids are supplied
|
|
124
|
+
* (the original hook short-circuited in that case).
|
|
125
|
+
*/
|
|
126
|
+
declare function fetchConsumers(consumerIds: number[] | null | undefined, options?: RequestOptions): Promise<Consumer[]>;
|
|
127
|
+
//#endregion
|
|
128
|
+
//#region src/core/employee.d.ts
|
|
129
|
+
declare const rolesById: {
|
|
130
|
+
readonly "1": "Owner";
|
|
131
|
+
readonly "2": "Manager";
|
|
132
|
+
readonly "3": "Assistant";
|
|
133
|
+
readonly "4": "Guest";
|
|
134
|
+
readonly "5": "Assistant Manager";
|
|
135
|
+
};
|
|
136
|
+
interface Employee {
|
|
137
|
+
id: number;
|
|
138
|
+
firstName: string;
|
|
139
|
+
lastName: string;
|
|
140
|
+
email: string;
|
|
141
|
+
roleId: number;
|
|
142
|
+
joinedDate: string;
|
|
143
|
+
exitDate: string;
|
|
144
|
+
stores: {
|
|
145
|
+
[key: number]: {
|
|
146
|
+
id: number;
|
|
147
|
+
roleId: number;
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
interface EmployeeResponse {
|
|
152
|
+
employees: {
|
|
153
|
+
[key: number]: Employee;
|
|
154
|
+
};
|
|
155
|
+
api: apiResponse;
|
|
156
|
+
}
|
|
157
|
+
interface FetchEmployeesParams {
|
|
158
|
+
/** Optional id filter. Forwarded when provided. */
|
|
159
|
+
employeeIds?: Array<number>;
|
|
160
|
+
/** Whether to include soft-deleted records. Defaults to `false`. */
|
|
161
|
+
deleted?: boolean;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Fetches employees. Returns the flattened `Employee[]`.
|
|
165
|
+
*/
|
|
166
|
+
declare function fetchEmployees(params?: FetchEmployeesParams, options?: RequestOptions): Promise<Employee[]>;
|
|
167
|
+
//#endregion
|
|
168
|
+
//#region src/core/product.d.ts
|
|
169
|
+
interface ProductInstance {
|
|
170
|
+
id: number;
|
|
171
|
+
price: string;
|
|
172
|
+
taxPercentage: string;
|
|
173
|
+
timestamp: string;
|
|
174
|
+
size: string;
|
|
175
|
+
name: string;
|
|
176
|
+
activeDate: string;
|
|
177
|
+
tags: string;
|
|
178
|
+
}
|
|
179
|
+
interface Product {
|
|
180
|
+
id: number;
|
|
181
|
+
barcode: string;
|
|
182
|
+
name: string;
|
|
183
|
+
details: string;
|
|
184
|
+
tags: string;
|
|
185
|
+
unit: number;
|
|
186
|
+
timestamp: string;
|
|
187
|
+
activeDate: string;
|
|
188
|
+
deleteDate: string;
|
|
189
|
+
images: Array<string>;
|
|
190
|
+
categories: Array<number>;
|
|
191
|
+
instances: {
|
|
192
|
+
[key: number]: ProductInstance;
|
|
193
|
+
};
|
|
194
|
+
}
|
|
195
|
+
interface ProductResponse {
|
|
196
|
+
products: {
|
|
197
|
+
[key: number]: Product;
|
|
198
|
+
};
|
|
199
|
+
api: apiResponse;
|
|
200
|
+
}
|
|
201
|
+
interface FetchProductsParams {
|
|
202
|
+
productIds?: Array<number>;
|
|
203
|
+
storeId?: number;
|
|
204
|
+
/** Whether to include soft-deleted records. Defaults to `false`. */
|
|
205
|
+
deleted?: boolean;
|
|
206
|
+
/** Token override (also accepted via `options.token`). */
|
|
207
|
+
token?: string;
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Fetches products. Returns the flattened `Product[]`.
|
|
211
|
+
*/
|
|
212
|
+
declare function fetchProducts(params?: FetchProductsParams, options?: RequestOptions): Promise<Product[]>;
|
|
213
|
+
/**
|
|
214
|
+
* Fetches products by id and returns them keyed by id, transparently batching
|
|
215
|
+
* the request (default 200 ids per call) to stay within API limits. Extracted
|
|
216
|
+
* from the original `useBasketReport` inline batching loop so it can be reused
|
|
217
|
+
* outside React.
|
|
218
|
+
*/
|
|
219
|
+
declare function fetchProductsMap(productIds: number[] | null | undefined, options?: RequestOptions, batchSize?: number): Promise<{
|
|
220
|
+
[id: number]: Product;
|
|
221
|
+
}>;
|
|
222
|
+
//#endregion
|
|
223
|
+
//#region src/core/promotion.d.ts
|
|
224
|
+
/** Promotion rule identifiers as stored by the Shopwave API. */
|
|
225
|
+
declare enum PromotionRuleSet {
|
|
226
|
+
Percentage = "|%^/",
|
|
227
|
+
Combo = "&%</",
|
|
228
|
+
MealDeal = "&=^/",
|
|
229
|
+
}
|
|
230
|
+
interface Promotion {
|
|
231
|
+
id: number;
|
|
232
|
+
merchantId: number;
|
|
233
|
+
storeIds: number[];
|
|
234
|
+
categoryIds: {
|
|
235
|
+
[key: string]: number;
|
|
236
|
+
};
|
|
237
|
+
productIds: {
|
|
238
|
+
[key: string]: any;
|
|
239
|
+
};
|
|
240
|
+
title: string;
|
|
241
|
+
details: string | null;
|
|
242
|
+
terms: string | null;
|
|
243
|
+
startDate: string;
|
|
244
|
+
endDate: string;
|
|
245
|
+
daysAvailable: number[];
|
|
246
|
+
automatic: number;
|
|
247
|
+
rule: PromotionRuleSet;
|
|
248
|
+
x: number;
|
|
249
|
+
y: number | null;
|
|
250
|
+
}
|
|
251
|
+
interface PromotionResponse {
|
|
252
|
+
promotions: {
|
|
253
|
+
[key: number]: Promotion;
|
|
254
|
+
};
|
|
255
|
+
api: apiResponse;
|
|
256
|
+
}
|
|
257
|
+
interface FetchPromotionsParams {
|
|
258
|
+
/** Optional id filter. Forwarded when provided. */
|
|
259
|
+
promotionIds?: Array<number>;
|
|
260
|
+
/** Whether to include soft-deleted records. Defaults to `false`. */
|
|
261
|
+
deleted?: boolean;
|
|
262
|
+
/** Token override (also accepted via `options.token`). */
|
|
263
|
+
token?: string;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Fetches promotions. Returns the flattened `Promotion[]`.
|
|
267
|
+
*/
|
|
268
|
+
declare function fetchPromotions(params?: FetchPromotionsParams, options?: RequestOptions): Promise<Promotion[]>;
|
|
269
|
+
//#endregion
|
|
270
|
+
//#region src/core/store.d.ts
|
|
271
|
+
interface Store {
|
|
272
|
+
id: number;
|
|
273
|
+
lat: number;
|
|
274
|
+
lng: number;
|
|
275
|
+
addressLine1: string;
|
|
276
|
+
addressLine2: string | null;
|
|
277
|
+
addressLine3: string;
|
|
278
|
+
phoneNumber: string;
|
|
279
|
+
city: string;
|
|
280
|
+
postcode: string;
|
|
281
|
+
countryId: number | null;
|
|
282
|
+
timezoneId: number | null;
|
|
283
|
+
storeDeleteDate: string | null;
|
|
284
|
+
email: string | null;
|
|
285
|
+
sandbox: boolean | null;
|
|
286
|
+
}
|
|
287
|
+
interface StoreResponse {
|
|
288
|
+
stores: {
|
|
289
|
+
[key: number]: Store;
|
|
290
|
+
};
|
|
291
|
+
api: apiResponse;
|
|
292
|
+
}
|
|
293
|
+
interface FetchStoresParams {
|
|
294
|
+
/** Whether to include soft-deleted records. Defaults to `false`. */
|
|
295
|
+
deleted?: boolean;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Fetches stores. Returns the flattened `Store[]`.
|
|
299
|
+
*/
|
|
300
|
+
declare function fetchStores(params?: FetchStoresParams, options?: RequestOptions): Promise<Store[]>;
|
|
301
|
+
//#endregion
|
|
302
|
+
//#region src/core/report.d.ts
|
|
303
|
+
interface ReportKey {
|
|
304
|
+
name: string;
|
|
305
|
+
type: string;
|
|
306
|
+
item?: ReportKey[];
|
|
307
|
+
}
|
|
308
|
+
interface ReportData {
|
|
309
|
+
keys: ReportKey[];
|
|
310
|
+
data: any[][];
|
|
311
|
+
}
|
|
312
|
+
interface ReportResponse {
|
|
313
|
+
reports: {
|
|
314
|
+
[key: string]: ReportData;
|
|
315
|
+
};
|
|
316
|
+
api: apiResponse;
|
|
317
|
+
}
|
|
318
|
+
interface ReportQuery {
|
|
319
|
+
FROM: string;
|
|
320
|
+
WHERE?: {
|
|
321
|
+
AND?: string[];
|
|
322
|
+
OR?: string[];
|
|
323
|
+
};
|
|
324
|
+
SELECT?: string[];
|
|
325
|
+
LIMIT?: number;
|
|
326
|
+
OFFSET?: number;
|
|
327
|
+
}
|
|
328
|
+
interface ReportQueryMap {
|
|
329
|
+
[key: string]: ReportQuery;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Runs one or more report queries and returns the `reports` map keyed by query
|
|
333
|
+
* name. The query is JSON-encoded into the `extras.query` header, matching the
|
|
334
|
+
* original endpoint contract.
|
|
335
|
+
*/
|
|
336
|
+
declare function fetchReport(query: ReportQueryMap, options?: RequestOptions): Promise<ReportResponse["reports"]>;
|
|
337
|
+
//#endregion
|
|
338
|
+
//#region src/core/session.d.ts
|
|
339
|
+
/**
|
|
340
|
+
* Ends the current server session.
|
|
341
|
+
*
|
|
342
|
+
* This is the framework-agnostic half of the original `useLogout` hook. The
|
|
343
|
+
* Next.js-specific redirect logic (router.push to the auth server logout URL,
|
|
344
|
+
* built from server actions) is intentionally NOT included here because it is
|
|
345
|
+
* tied to `next/navigation` and `'use server'` actions — see the README.
|
|
346
|
+
*/
|
|
347
|
+
declare function logout(options?: RequestOptions): Promise<void>;
|
|
348
|
+
//#endregion
|
|
349
|
+
//#region src/core/entity.d.ts
|
|
350
|
+
/**
|
|
351
|
+
* Generic CRUD-style mutations extracted from `useHandleDelete` /
|
|
352
|
+
* `useHandleSubmit`. The original hooks also surfaced notistack snackbars; that
|
|
353
|
+
* UI concern is deliberately left to the hooks/host layer so core stays
|
|
354
|
+
* dependency-free.
|
|
355
|
+
*/
|
|
356
|
+
/**
|
|
357
|
+
* Deletes `/api/{resourcePath}/{entityId}`.
|
|
358
|
+
*/
|
|
359
|
+
declare function deleteEntity(resourcePath: string, entityId: number | string, options?: RequestOptions): Promise<void>;
|
|
360
|
+
interface SubmitEntityArgs {
|
|
361
|
+
/** Fully-resolved endpoint, e.g. `/api/products` or `/api/products/42`. */
|
|
362
|
+
endpoint: string;
|
|
363
|
+
/** Defaults to PUT when an `entityId` exists, otherwise POST. */
|
|
364
|
+
method?: "POST" | "PUT";
|
|
365
|
+
/** The request payload (already transformed by the caller). */
|
|
366
|
+
payload: unknown;
|
|
367
|
+
}
|
|
368
|
+
interface SubmitEntityResponse<R = any> {
|
|
369
|
+
result?: R;
|
|
370
|
+
[key: string]: unknown;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* Sends a create/update mutation and returns the parsed `result` field
|
|
374
|
+
* (matching the original `result.result` access).
|
|
375
|
+
*/
|
|
376
|
+
declare function submitEntity<R = any>({
|
|
377
|
+
endpoint,
|
|
378
|
+
method,
|
|
379
|
+
payload
|
|
380
|
+
}: SubmitEntityArgs, options?: RequestOptions): Promise<R | undefined>;
|
|
381
|
+
//#endregion
|
|
382
|
+
//#region src/core/basket.d.ts
|
|
383
|
+
interface BasketItem {
|
|
384
|
+
productId: number;
|
|
385
|
+
productName: string;
|
|
386
|
+
quantity: number;
|
|
387
|
+
price: number;
|
|
388
|
+
tax: number;
|
|
389
|
+
}
|
|
390
|
+
interface Basket {
|
|
391
|
+
id: number;
|
|
392
|
+
name: string;
|
|
393
|
+
consumerId: number;
|
|
394
|
+
products: BasketItem[];
|
|
395
|
+
total: number;
|
|
396
|
+
taxTotal: number;
|
|
397
|
+
status: "pending" | "completed" | "cancelled";
|
|
398
|
+
completeDate: string;
|
|
399
|
+
}
|
|
400
|
+
interface BasketReportRow {
|
|
401
|
+
id: number;
|
|
402
|
+
basketId: number;
|
|
403
|
+
basketName: string;
|
|
404
|
+
consumerId: number;
|
|
405
|
+
consumerName: string;
|
|
406
|
+
consumerEmail: string;
|
|
407
|
+
products: BasketItem[];
|
|
408
|
+
basketTotal: number;
|
|
409
|
+
tax: number;
|
|
410
|
+
dateTime: string;
|
|
411
|
+
status: string;
|
|
412
|
+
}
|
|
413
|
+
interface BasketSummary {
|
|
414
|
+
totalBaskets: number;
|
|
415
|
+
totalRevenue: number;
|
|
416
|
+
totalTax: number;
|
|
417
|
+
uniqueConsumers: number;
|
|
418
|
+
}
|
|
419
|
+
interface BasketFilters {
|
|
420
|
+
search: string;
|
|
421
|
+
dateRange: {
|
|
422
|
+
start: Date | null;
|
|
423
|
+
end: Date | null;
|
|
424
|
+
};
|
|
425
|
+
consumerId: number | null;
|
|
426
|
+
status: "all" | "pending" | "completed" | "cancelled";
|
|
427
|
+
}
|
|
428
|
+
interface BasketPagination {
|
|
429
|
+
page: number;
|
|
430
|
+
pageSize: number;
|
|
431
|
+
total: number;
|
|
432
|
+
}
|
|
433
|
+
declare const DEFAULT_BASKET_FILTERS: BasketFilters;
|
|
434
|
+
declare const DEFAULT_PAGINATION: BasketPagination;
|
|
435
|
+
/** Intermediate shape produced by {@link parseBasketReportData}. */
|
|
436
|
+
interface ParsedBasket {
|
|
437
|
+
id: number;
|
|
438
|
+
name: string;
|
|
439
|
+
consumerId: number;
|
|
440
|
+
products: BasketItem[];
|
|
441
|
+
total: number;
|
|
442
|
+
taxTotal: number;
|
|
443
|
+
status: "completed";
|
|
444
|
+
completeDate: string;
|
|
445
|
+
}
|
|
446
|
+
/** Formats a date as `YYYY-MM-DD HH:mm:ss` for the report query. */
|
|
447
|
+
declare function formatDateForQuery(date: Date, isEndOfDay?: boolean): string;
|
|
448
|
+
/** Builds the `Basket` report query from a set of filters. */
|
|
449
|
+
declare function buildBasketReportQuery(filters: BasketFilters): ReportQueryMap;
|
|
450
|
+
/** Flattens the raw report rows/keys into structured baskets. */
|
|
451
|
+
declare function parseBasketReportData(reports: ReportResponse["reports"] | null | undefined): ParsedBasket[];
|
|
452
|
+
/** Unique non-null consumer ids referenced by a set of baskets. */
|
|
453
|
+
declare function collectConsumerIds(baskets: ParsedBasket[]): number[] | null;
|
|
454
|
+
/** Unique product ids referenced by a set of baskets. */
|
|
455
|
+
declare function collectProductIds(baskets: ParsedBasket[]): number[] | null;
|
|
456
|
+
interface CombineBasketRowsParams {
|
|
457
|
+
baskets: ParsedBasket[];
|
|
458
|
+
consumerMap: {
|
|
459
|
+
[id: number]: Consumer;
|
|
460
|
+
};
|
|
461
|
+
productMap: {
|
|
462
|
+
[id: number]: Product;
|
|
463
|
+
};
|
|
464
|
+
search?: string;
|
|
465
|
+
}
|
|
466
|
+
/** Joins baskets with consumer + product lookups, applies search, sorts. */
|
|
467
|
+
declare function combineBasketRows({
|
|
468
|
+
baskets,
|
|
469
|
+
consumerMap,
|
|
470
|
+
productMap,
|
|
471
|
+
search
|
|
472
|
+
}: CombineBasketRowsParams): BasketReportRow[];
|
|
473
|
+
/** Aggregate totals for a set of report rows. */
|
|
474
|
+
declare function computeBasketSummary(rows: BasketReportRow[]): BasketSummary;
|
|
475
|
+
/** Builds a consumer id → consumer lookup. */
|
|
476
|
+
declare function buildConsumerMap(consumers: Consumer[] | null | undefined): {
|
|
477
|
+
[id: number]: Consumer;
|
|
478
|
+
};
|
|
479
|
+
//#endregion
|
|
480
|
+
export { Basket, BasketFilters, BasketItem, BasketPagination, BasketReportRow, BasketSummary, Category, CategoryResponse, CombineBasketRowsParams, Consumer, ConsumerResponse, DEFAULT_BASKET_FILTERS, DEFAULT_PAGINATION, Employee, EmployeeResponse, ErrorMessage, Extras, FetchCategoriesParams, FetchEmployeesParams, FetchProductsParams, FetchPromotionsParams, FetchStoresParams, MessageInfo, ParsedBasket, Product, ProductInstance, ProductResponse, Promotion, PromotionResponse, PromotionRuleSet, ReportData, ReportKey, ReportQuery, ReportQueryMap, ReportResponse, RequestOptions, Store, StoreResponse, SubmitEntityArgs, SubmitEntityResponse, SuccessMessage, apiDelete, apiGet, apiResponse, apiSend, buildBasketReportQuery, buildConsumerMap, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, deleteEntity, fetchCategories, fetchConsumers, fetchEmployees, fetchProducts, fetchProductsMap, fetchPromotions, fetchReport, fetchStores, formatDateForQuery, getApiErrors, logout, parseBasketReportData, rolesById, submitEntity };
|
|
481
|
+
//# sourceMappingURL=index.d.cts.map
|