@stacksjs/commerce 0.70.88 → 0.70.91

package/dist/shippings/shipping-methods/store.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Create a new shipping method
+ *
+ * @param data The shipping method data to store
+ * @returns The newly created shipping method record
+ */
+export declare function store(data: NewShippingMethod): Promise<ShippingMethodJsonResponse>;
+/**
+ * Create multiple shipping methods at once
+ *
+ * @param data Array of shipping method data to store
+ * @returns Number of shipping methods created
+ */
+export declare function bulkStore(data: NewShippingMethod[]): Promise<number>;
+/**
+ * Format shipping method options for dropdown menus or selectors
+ *
+ * @returns Array of formatted shipping method options with id, name, and status
+ */
+export declare function formatShippingOptions(): Promise<{ id: number, name: string, status: string | string[], base_rate: number }[]>;
+/**
+ * Get active shipping methods
+ *
+ * @returns List of active shipping methods
+ */
+export declare function getActiveShippingMethods(): Promise<ShippingMethodJsonResponse[]>;
+declare type ShippingMethodJsonResponse = ModelRow<typeof ShippingMethod>;
+declare type NewShippingMethod = NewModelData<typeof ShippingMethod>;

package/dist/shippings/shipping-methods/update.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Update a shipping method
+ *
+ * @param id The ID of the shipping method
+ * @param data The shipping method data to update
+ * @returns The updated shipping method record
+ */
+export declare function update(id: number, data: ShippingMethodUpdate): Promise<ShippingMethodJsonResponse>;
+/**
+ * Update a shipping method's status
+ *
+ * @param id The ID of the shipping method
+ * @param status The new status
+ * @returns The updated shipping method with the new status
+ */
+export declare function updateStatus(id: number, status: string | string[]): Promise<ShippingMethodJsonResponse>;
+/**
+ * Update pricing information for a shipping method
+ *
+ * @param id The ID of the shipping method
+ * @param base_rate Optional updated base rate
+ * @param free_shipping Optional updated free shipping threshold
+ * @returns The updated shipping method
+ */
+export declare function updatePricing(id: number, base_rate?: number, free_shipping?: number): Promise<ShippingMethodJsonResponse>;
+declare type ShippingMethodJsonResponse = ModelRow<typeof ShippingMethod>;
+declare type ShippingMethodUpdate = UpdateModelData<typeof ShippingMethod>;

package/dist/shippings/shipping-rates/destroy.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Delete a shipping rate by ID
+ *
+ * @param id The ID of the shipping rate to delete
+ * @returns True if the shipping rate was deleted, false otherwise
+ */
+export declare function destroy(id: number): Promise<boolean>;
+/**
+ * Delete multiple shipping rates by ID
+ *
+ * @param ids Array of shipping rate IDs to delete
+ * @returns Number of shipping rates deleted
+ */
+export declare function bulkDestroy(ids: number[]): Promise<number>;
+/**
+ * Delete shipping rates by zone
+ *
+ * @param zone The zone to delete shipping rates for
+ * @returns Number of shipping rates deleted
+ */
+export declare function destroyByZone(zone: string): Promise<number>;
+/**
+ * Delete shipping rates by method
+ *
+ * @param method The shipping method to delete rates for
+ * @returns Number of shipping rates deleted
+ */
+export declare function destroyByMethod(method: string): Promise<number>;

package/dist/shippings/shipping-rates/fetch.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Fetch a shipping rate by ID
+ */
+export declare function fetchById(id: number): Promise<ShippingRateJsonResponse | undefined>;
+/**
+ * Fetch all shipping rates with their shipping zones and methods
+ */
+export declare function fetchAll(): Promise<ShippingRateJsonResponse[]>;
+/**
+ * Get shipping rates by zone
+ *
+ * @param zoneId Shipping zone identifier
+ * @returns List of shipping rates for the specified zone
+ */
+export declare function getRatesByZone(zoneId: number): Promise<ShippingRateJsonResponse[]>;
+/**
+ * Get shipping rate based on weight and zone.
+ *
+ * **⚠️ Caller-trusted zone (stacksjs/stacks#1879 Co-11).** This
+ * function does NOT verify that the `zoneId` actually serves the
+ * customer's declared address. A user in NYC can pass a Texas
+ * `zoneId` and get cheaper shipping. Use `getRateByWeightAndAddress`
+ * below when the request boundary involves untrusted input — it
+ * resolves the zone server-side from the address.
+ *
+ * Kept for back-compat with internal callers that have already
+ * resolved the zone (admin tooling, scheduled fulfillment jobs).
+ *
+ * @param weight Weight in the appropriate unit
+ * @param zoneId Shipping zone identifier (caller-trusted)
+ * @returns Matching shipping rate or undefined
+ */
+export declare function getRateByWeightAndZone(weight: number, zoneId: number): Promise<ShippingRateJsonResponse | undefined>;
+/**
+ * Resolve the canonical shipping zone for a delivery address
+ * (stacksjs/stacks#1879 Co-11). Walks the zones table looking for
+ * the most specific match: postal-code → region → country-only.
+ * Returns null when no zone covers the address.
+ *
+ * The current zones schema stores `countries` as a comma-separated
+ * string (per `getZonesByCountry`'s LIKE-query); we use the same
+ * convention here. Apps with a normalized zone-country join table
+ * can override by replacing this function via the package facade.
+ */
+export declare function resolveZoneForAddress(address: ShippingAddress): Promise<number | null>;
+/**
+ * Safer counterpart to `getRateByWeightAndZone`. Resolves the zone
+ * server-side from the delivery address, then fetches the rate
+ * for that zone. Throws when the address doesn't match any active
+ * zone — caller surfaces "we don't ship to your area" to the user.
+ *
+ * Use this from any HTTP/API boundary where the address is
+ * caller-controlled. Internal callers that already have a verified
+ * zone can stay on `getRateByWeightAndZone`.
+ *
+ * @example
+ * ```ts
+ * const rate = await getRateByWeightAndAddress(2.5, {
+ *   countryCode: 'US',
+ *   region: 'NY',
+ *   postalCode: '10001',
+ * })
+ * if (!rate) throw new HttpError(404, 'No shipping rate for this address')
+ * ```
+ */
+export declare function getRateByWeightAndAddress(weight: number, address: ShippingAddress): Promise<ShippingRateJsonResponse | undefined>;
+/**
+ * Verify that a caller-supplied `zoneId` actually serves the given
+ * address. Returns true when the address resolves to the same zone.
+ * Use when a flow already has a `zoneId` from earlier and just
+ * wants to confirm it wasn't tampered with mid-checkout.
+ */
+export declare function validateZoneMatchesAddress(zoneId: number, address: ShippingAddress): Promise<boolean>;
+/**
+ * Format shipping rate options for dropdown menus or selectors
+ *
+ * @returns Array of formatted shipping rate options with id, method, zone, and rate
+ */
+export declare function formatShippingRateOptions(): Promise<{ id: number, shipping_method_id: number, shipping_zone_id: number, rate: number }[]>;
+/**
+ * Get shipping rates for a specific method
+ *
+ * @param methodId The shipping method to filter by
+ * @returns List of shipping rates for the specified method
+ */
+export declare function getShippingRatesByMethod(methodId: number): Promise<ShippingRateJsonResponse[]>;
+/**
+ * Shipping address shape used by the safe-by-default lookup helpers
+ * (stacksjs/stacks#1879 Co-11). All fields except `countryCode` are
+ * optional — zone matching tries them in order of specificity
+ * (postal → region → country) and returns the most specific match.
+ */
+export declare interface ShippingAddress {
+  countryCode: string
+  region?: string
+  postalCode?: string
+}
+declare type ShippingRateJsonResponse = ModelRow<typeof ShippingRate>;

package/dist/shippings/shipping-rates/index.d.ts

@@ -0,0 +1,33 @@
+export type { ShippingAddress } from './fetch';
+export {
+  bulkDestroy,
+  destroy,
+  destroyByMethod,
+  destroyByZone,
+} from './destroy';
+// Functions from fetch.ts
+export {
+  fetchAll,
+  fetchById,
+  formatShippingRateOptions,
+  // Safe-by-default address-based lookups (stacksjs/stacks#1879 Co-11).
+  // Use these from request handlers where the address is caller-controlled.
+  getRateByWeightAndAddress,
+  getRateByWeightAndZone,
+  getRatesByZone,
+  getShippingRatesByMethod,
+  resolveZoneForAddress,
+  validateZoneMatchesAddress,
+} from './fetch';
+// Functions from store.ts
+export {
+  bulkStore,
+  store,
+} from './store';
+// Functions from update.ts
+export {
+  bulkUpdate,
+  update,
+  updateByMethod,
+  updateByZone,
+} from './update';

package/dist/shippings/shipping-rates/store.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Create a new shipping rate
+ *
+ * @param data The shipping rate data to store
+ * @returns The newly created shipping rate record
+ */
+export declare function store(data: NewShippingRate): Promise<ShippingRateJsonResponse>;
+/**
+ * Create multiple shipping rates at once
+ *
+ * @param data Array of shipping rate data to store
+ * @returns Number of shipping rates created
+ */
+export declare function bulkStore(data: NewShippingRate[]): Promise<number>;
+// Import dependencies
+declare type ShippingRateJsonResponse = ModelRow<typeof ShippingRate>;
+declare type NewShippingRate = NewModelData<typeof ShippingRate>;

package/dist/shippings/shipping-rates/update.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Update a shipping rate
+ *
+ * @param id The shipping rate ID to update
+ * @param data The shipping rate data to update
+ * @returns The updated shipping rate record
+ */
+export declare function update(id: number, data: ShippingRateUpdate): Promise<ShippingRateJsonResponse>;
+/**
+ * Update multiple shipping rates at once
+ *
+ * @param updates Array of objects containing rate ID and update data
+ * @returns Number of shipping rates updated
+ */
+export declare function bulkUpdate(updates: Array<{
+  id: number
+  data: ShippingRateUpdate
+}>): Promise<number>;
+/**
+ * Update shipping rates by zone
+ *
+ * @param zone The zone to update rates for
+ * @param data The update data to apply
+ * @returns Number of shipping rates updated
+ */
+export declare function updateByZone(zone: number, data: ShippingRateUpdate): Promise<number>;
+/**
+ * Update shipping rates by method
+ *
+ * @param method The shipping method to update rates for
+ * @param data The update data to apply
+ * @returns Number of shipping rates updated
+ */
+export declare function updateByMethod(method: string, data: ShippingRateUpdate): Promise<number>;
+declare type ShippingRateJsonResponse = ModelRow<typeof ShippingRate>;
+declare type ShippingRateUpdate = UpdateModelData<typeof ShippingRate>;

package/dist/shippings/shipping-zones/destroy.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Delete a shipping zone by ID
+ *
+ * @param id The ID of the shipping zone to delete
+ * @returns True if the shipping zone was deleted, false otherwise
+ */
+export declare function destroy(id: number): Promise<boolean>;
+/**
+ * Soft delete a shipping zone by ID (updates status to 'inactive')
+ *
+ * @param id The ID of the shipping zone to soft delete
+ * @returns True if the shipping zone was soft deleted, false otherwise
+ */
+export declare function softDelete(id: number): Promise<boolean>;
+/**
+ * Delete multiple shipping zones by ID
+ *
+ * @param ids Array of shipping zone IDs to delete
+ * @returns Number of shipping zones deleted
+ */
+export declare function bulkDestroy(ids: number[]): Promise<number>;
+/**
+ * Soft delete multiple shipping zones by ID (updates status to 'inactive')
+ *
+ * @param ids Array of shipping zone IDs to soft delete
+ * @returns Number of shipping zones soft deleted
+ */
+export declare function bulkSoftDelete(ids: number[]): Promise<number>;

package/dist/shippings/shipping-zones/fetch.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Fetch all shipping zones
+ */
+export declare function fetchAll(): Promise<ShippingZoneJsonResponse[]>;
+/**
+ * Fetch a shipping zone by ID
+ */
+export declare function fetchById(id: number): Promise<ShippingZoneJsonResponse | undefined>;
+/**
+ * Format shipping zone options for dropdown menus or selectors
+ *
+ * @returns Array of formatted shipping zone options with id, name, and status
+ */
+export declare function formatZoneOptions(): Promise<{ id: number, name: string, status: string | string[], countries: string | undefined }[]>;
+/**
+ * Get active shipping zones
+ *
+ * @returns List of active shipping zones
+ */
+export declare function getActiveShippingZones(): Promise<ShippingZoneJsonResponse[]>;
+/**
+ * Get shipping zones by country code
+ *
+ * @param countryCode ISO country code
+ * @returns List of shipping zones covering the specified country
+ */
+export declare function getZonesByCountry(countryCode: string): Promise<ShippingZoneJsonResponse[]>;
+declare type ShippingZoneJsonResponse = ModelRow<typeof ShippingZone>;

package/dist/shippings/shipping-zones/index.d.ts

@@ -0,0 +1,23 @@
+export {
+  bulkDestroy,
+  bulkSoftDelete,
+  destroy,
+  softDelete,
+} from './destroy';
+export {
+  fetchAll,
+  fetchById,
+  formatZoneOptions,
+  getActiveShippingZones,
+  getZonesByCountry,
+} from './fetch';
+export {
+  bulkStore,
+  store,
+} from './store';
+export {
+  update,
+  updateCountries,
+  updateRegionsAndPostalCodes,
+  updateStatus,
+} from './update';

package/dist/shippings/shipping-zones/store.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Create a new shipping zone
+ *
+ * @param data The shipping zone data to store
+ * @returns The newly created shipping zone record
+ */
+export declare function store(data: NewShippingZone): Promise<ShippingZoneJsonResponse>;
+/**
+ * Create multiple shipping zones at once
+ *
+ * @param data Array of shipping zone data to store
+ * @returns Number of shipping zones created
+ */
+export declare function bulkStore(data: NewShippingZone[]): Promise<number>;
+// Import dependencies
+declare type ShippingZoneJsonResponse = ModelRow<typeof ShippingZone>;
+declare type NewShippingZone = NewModelData<typeof ShippingZone>;

package/dist/shippings/shipping-zones/update.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Update a shipping zone
+ *
+ * @param id The ID of the shipping zone
+ * @param data The shipping zone data to update
+ * @returns The updated shipping zone record
+ */
+export declare function update(id: number, data: ShippingZoneUpdate): Promise<ShippingZoneJsonResponse>;
+/**
+ * Update a shipping zone's status
+ *
+ * @param id The ID of the shipping zone
+ * @param status The new status
+ * @returns The updated shipping zone with the new status
+ */
+export declare function updateStatus(id: number, status: string | string[]): Promise<ShippingZoneJsonResponse>;
+/**
+ * Update countries for a shipping zone
+ *
+ * @param id The ID of the shipping zone
+ * @param countries The updated countries JSON string
+ * @returns The updated shipping zone
+ */
+export declare function updateCountries(id: number, countries: string): Promise<ShippingZoneJsonResponse>;
+/**
+ * Update regions and/or postal codes for a shipping zone
+ *
+ * @param id The ID of the shipping zone
+ * @param regions Optional updated regions JSON string
+ * @param postal_codes Optional updated postal codes JSON string
+ * @returns The updated shipping zone
+ */
+export declare function updateRegionsAndPostalCodes(id: number, regions?: string, postal_codes?: string): Promise<ShippingZoneJsonResponse>;
+declare type ShippingZoneJsonResponse = ModelRow<typeof ShippingZone>;
+declare type ShippingZoneUpdate = UpdateModelData<typeof ShippingZone>;

package/dist/tax/destroy.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Delete a tax rate by ID
+ *
+ * @param id The ID of the tax rate to delete
+ * @returns True if the tax rate was deleted, false otherwise
+ */
+export declare function destroy(id: number): Promise<boolean>;
+/**
+ * Delete multiple tax rates by ID
+ *
+ * @param ids Array of tax rate IDs to delete
+ * @returns Number of tax rates deleted
+ */
+export declare function bulkDestroy(ids: number[]): Promise<number>;

package/dist/tax/fetch.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Fetch a tax rate by ID
+ */
+export declare function fetchById(id: number): Promise<TaxRateJsonResponse | undefined>;
+/**
+ * Fetch all tax rates
+ */
+export declare function fetchAll(): Promise<TaxRateJsonResponse[]>;
+declare type TaxRateJsonResponse = ModelRow<typeof TaxRate>;

package/dist/tax/index.d.ts

@@ -0,0 +1,21 @@
+// Functions from destroy.ts
+export {
+  bulkDestroy,
+  destroy,
+} from './destroy';
+// Functions from fetch.ts
+export {
+  fetchAll,
+  fetchById,
+} from './fetch';
+// Functions from store.ts
+export {
+  bulkStore,
+  store,
+} from './store';
+// Functions from update.ts
+export {
+  update,
+  updateRate,
+  updateStatus,
+} from './update';

package/dist/tax/store.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Create a new tax rate
+ *
+ * @param data Tax rate data to store
+ * @returns The newly created tax rate record
+ */
+export declare function store(data: NewTaxRate): Promise<TaxRateJsonResponse>;
+/**
+ * Create multiple tax rates at once
+ *
+ * @param data Array of tax rate data to store
+ * @returns Number of tax rates created
+ */
+export declare function bulkStore(data: NewTaxRate[]): Promise<number>;
+declare type TaxRateJsonResponse = ModelRow<typeof TaxRate>;
+declare type NewTaxRate = NewModelData<typeof TaxRate>;

package/dist/tax/update.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Update a tax rate
+ *
+ * @param id The id of the tax rate to update
+ * @param data The tax rate data to update
+ * @returns The updated tax rate record
+ */
+export declare function update(id: number, data: TaxRateUpdate): Promise<TaxRateJsonResponse>;
+/**
+ * Update a tax rate's status
+ *
+ * @param id The ID of the tax rate
+ * @param status The new status
+ * @returns The updated tax rate with the new status
+ */
+export declare function updateStatus(id: number, status: 'active' | 'inactive'): Promise<TaxRateJsonResponse>;
+/**
+ * Update rate information for a tax rate
+ *
+ * @param id The ID of the tax rate
+ * @param rate The updated rate value
+ * @returns The updated tax rate
+ */
+export declare function updateRate(id: number, rate: number): Promise<TaxRateJsonResponse>;
+declare type TaxRateJsonResponse = ModelRow<typeof TaxRate>;
+declare type TaxRateUpdate = UpdateModelData<typeof TaxRate>;