@stacksjs/commerce 0.75.41 → 0.75.43

package/dist/imports/shopware-admin.d.ts

@@ -0,0 +1,89 @@
+import type { AccountAdapter, AccountCustomer, AccountOrder, MappedAccountRecord } from './account-types';
+import type { AdminRequestOptions } from './admin-http';
+import type { OrderStatus } from '../orders/events';
+/** One Admin API customer as a normalized customer, or null with the reason. Pure. */
+export declare function mapShopwareCustomer(raw: ShopwareCustomerPayload, context?: { currency?: string }): MappedAccountRecord<AccountCustomer>;
+/**
+ * The Stacks status for a Shopware order, from its three state machines:
+ * the order (open, in_progress, completed, cancelled), the delivery (open,
+ * shipped, shipped_partially, returned, ...) and the payment (open, paid,
+ * refunded, ...).
+ */
+export declare function shopwareOrderStatus(raw: Pick<ShopwareOrderPayload, 'stateMachineState' | 'deliveries' | 'transactions'>): { status: OrderStatus, mapped: boolean, sourceStatus: string };
+/**
+ * A variant line's label with its options, `Bio T-Shirt - Blau, M`. Shopware
+ * labels every variant with the parent's name and keeps the options in the
+ * payload, so two sizes of one shirt would otherwise read the same.
+ */
+export declare function shopwareLineLabel(label: string, options: unknown): string;
+/** One Admin API order as a normalized order, or null with the reason. Pure. */
+export declare function mapShopwareOrder(raw: ShopwareOrderPayload, context?: { currency?: string }): MappedAccountRecord<AccountOrder>;
+/**
+ * The shop's base URL, from the storefront URL or an API endpoint
+ * (`.../api`, `.../store-api`). HTTPS only, except on this machine.
+ */
+export declare function shopwareAdminBase(storeUrl: string, adminUrl?: string): string;
+/** Criteria for one page of customers. */
+export declare function shopwareCustomerCriteria(page: number, limit: number): Record<string, unknown>;
+/** Criteria for one page of orders, with their line items and addresses. */
+export declare function shopwareOrderCriteria(page: number, limit: number): Record<string, unknown>;
+/** A bearer token for the integration, from the client_credentials grant. */
+export declare function shopwareAccessToken(base: string, clientId: string, clientSecret: string, request: Omit<AdminRequestOptions, 'json' | 'method' | 'headers'>): Promise<string>;
+export declare const shopwareAccountAdapter: AccountAdapter;
+export declare interface ShopwareAddressPayload {
+  id?: string | null
+  firstName?: string | null
+  lastName?: string | null
+  company?: string | null
+  street?: string | null
+  additionalAddressLine1?: string | null
+  zipcode?: string | null
+  city?: string | null
+  phoneNumber?: string | null
+  country?: { iso?: string | null, name?: string | null } | null
+}
+export declare interface ShopwareCustomerPayload {
+  id: string
+  customerNumber?: string | null
+  email?: string | null
+  firstName?: string | null
+  lastName?: string | null
+  company?: string | null
+  active?: boolean | null
+  guest?: boolean | null
+  orderTotalAmount?: number | null
+  lastOrderDate?: string | null
+  createdAt?: string | null
+  defaultBillingAddress?: ShopwareAddressPayload | null
+}
+export declare interface ShopwareLineItemPayload {
+  id: string
+  parentId?: string | null
+  productId?: string | null
+  referencedId?: string | null
+  label?: string | null
+  quantity?: number | null
+  unitPrice?: number | null
+  totalPrice?: number | null
+  type?: string | null
+  payload?: { productNumber?: string | null, parentId?: string | null, options?: Array<{ group?: string | null, option?: string | null }> | null } | unknown[] | null
+}
+declare interface StatePayload {
+  stateMachineState?: { technicalName?: string | null } | null
+}
+export declare interface ShopwareOrderPayload extends StatePayload {
+  id: string
+  orderNumber?: string | null
+  orderDateTime?: string | null
+  amountTotal?: number | null
+  amountNet?: number | null
+  shippingTotal?: number | null
+  customerComment?: string | null
+  billingAddressId?: string | null
+  currency?: { isoCode?: string | null } | null
+  orderCustomer?: { customerId?: string | null, email?: string | null, firstName?: string | null, lastName?: string | null } | null
+  lineItems?: ShopwareLineItemPayload[] | null
+  addresses?: ShopwareAddressPayload[] | null
+  deliveries?: Array<StatePayload & { shippingOrderAddress?: ShopwareAddressPayload | null }> | null
+  transactions?: Array<StatePayload & { createdAt?: string | null }> | null
+}

package/dist/imports/woocommerce-admin.d.ts

@@ -0,0 +1,66 @@
+import type { AccountAdapter, AccountCustomer, AccountOrder, MappedAccountRecord } from './account-types';
+import type { OrderStatus } from '../orders/events';
+/** The Stacks status for a WooCommerce status, and whether it was a known one. */
+export declare function wooOrderStatus(status: string | null | undefined): { status: OrderStatus, mapped: boolean };
+/** One REST API customer as a normalized customer, or null with the reason. Pure. */
+export declare function mapWooCustomer(raw: WooCustomerPayload): MappedAccountRecord<AccountCustomer>;
+/** One REST API order as a normalized order, or null with the reason. Pure. */
+export declare function mapWooOrder(raw: WooOrderPayload, context?: { currency?: string }): MappedAccountRecord<AccountOrder>;
+/** The REST API base for a store URL. HTTPS only: Basic auth over HTTP sends the secret in the clear. */
+export declare function wooAdminBase(storeUrl: string, adminUrl?: string): string;
+/** `Authorization: Basic ...` for a consumer key and secret. */
+export declare function wooAuthorization(consumerKey: string, consumerSecret: string): string;
+export declare const wooCommerceAccountAdapter: AccountAdapter;
+export declare interface WooAddressPayload {
+  first_name?: string | null
+  last_name?: string | null
+  company?: string | null
+  address_1?: string | null
+  address_2?: string | null
+  city?: string | null
+  state?: string | null
+  postcode?: string | null
+  country?: string | null
+  email?: string | null
+  phone?: string | null
+}
+export declare interface WooCustomerPayload {
+  id: number | string
+  email?: string | null
+  first_name?: string | null
+  last_name?: string | null
+  username?: string | null
+  role?: string | null
+  date_created_gmt?: string | null
+  billing?: WooAddressPayload | null
+  shipping?: WooAddressPayload | null
+  avatar_url?: string | null
+}
+export declare interface WooOrderLinePayload {
+  id: number | string
+  name?: string | null
+  product_id?: number | null
+  variation_id?: number | null
+  quantity?: number | null
+  subtotal?: string | null
+  total?: string | null
+  sku?: string | null
+}
+export declare interface WooOrderPayload {
+  id: number | string
+  number?: string | null
+  status?: string | null
+  currency?: string | null
+  date_created_gmt?: string | null
+  discount_total?: string | null
+  shipping_total?: string | null
+  total?: string | null
+  total_tax?: string | null
+  customer_id?: number | null
+  customer_note?: string | null
+  billing?: WooAddressPayload | null
+  shipping?: WooAddressPayload | null
+  line_items?: WooOrderLinePayload[] | null
+  fee_lines?: Array<{ id?: number | string, name?: string | null, total?: string | null }> | null
+  refunds?: Array<{ id?: number | string, reason?: string | null, total?: string | null }> | null
+}

package/dist/imports/woocommerce.d.ts

@@ -9,6 +9,12 @@ import type { CatalogAdapter, MappedProduct } from './types';
  */
 export declare function wooPrices(prices: WooPricesPayload | null | undefined): Prices;
 declare function terms(list: WooTermPayload[] | null | undefined): Array<{ name: string, slug: string }>;
+/**
+ * A product slug as the shopper reads it. WordPress stores a non-ASCII slug
+ * percent-encoded (`sencha-%e7%b7%91%e8%8c%b6-100g`) and the Store API hands
+ * it over that way; a malformed escape is kept as sent.
+ */
+export declare function wooSlug(value: unknown): string | null;
 /** One Store API product, plus its fetched variations, as a catalog product. Pure. */
 export declare function mapWooProduct(raw: WooProductPayload, context?: WooMapContext): MappedProduct;
 export declare const wooCommerceAdapter: CatalogAdapter;