@hanzo/commerce 7.1.5 → 7.1.6

package/service/path-utils.ts

@@ -1,26 +1,26 @@
-import type { SelectedPaths } from '../types'
-import sep from './sep'
-
-export const getSelectedPaths = (
-  skuPath: string
-): { paths: SelectedPaths; level: number } => {
-  
-  const toks = skuPath.split(sep.tok)
-  const level = toks.length - 1
-  const paths: SelectedPaths = {}
-  for (let l = 1; l <= level; l++ ) {
-    paths[l] = [toks[l]]   
-  } 
-  return {
-    paths,
-    level
-  }
-}
-
-export const getParentPath = (skuPath: string): string => (
-  skuPath.split(sep.tok).slice(0, -1).join(sep.tok)
-)
-
-export const lastToken = (skuPath: string): string => (
-  skuPath.split(sep.tok).pop()!
+import type { SelectedPaths } from '../types'
+import sep from './sep'
+
+export const getSelectedPaths = (
+  skuPath: string
+): { paths: SelectedPaths; level: number } => {
+  
+  const toks = skuPath.split(sep.tok)
+  const level = toks.length - 1
+  const paths: SelectedPaths = {}
+  for (let l = 1; l <= level; l++ ) {
+    paths[l] = [toks[l]]   
+  } 
+  return {
+    paths,
+    level
+  }
+}
+
+export const getParentPath = (skuPath: string): string => (
+  skuPath.split(sep.tok).slice(0, -1).join(sep.tok)
+)
+
+export const lastToken = (skuPath: string): string => (
+  skuPath.split(sep.tok).pop()!
 )

package/service/sep.ts

@@ -1,7 +1,7 @@
-import type { TokenSeparators } from '../types'
-
-export default {
-  tok: '-',
-  subTok: '_',
-  decimal: '.'
+import type { TokenSeparators } from '../types'
+
+export default {
+  tok: '-',
+  subTok: '_',
+  decimal: '.'
 } satisfies TokenSeparators 

package/tsconfig.json

@@ -1,10 +1,10 @@
-{
-  "extends": "../tsconfig.hanzo.base.json",
-  "include": [
-    "**/*.ts",
-    "**/*.tsx",
-  ],
-  "exclude": [
-    "node_modules",
-  ]
-}
+{
+  "extends": "../tsconfig.hanzo.base.json",
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+  ],
+  "exclude": [
+    "node_modules",
+  ]
+}

package/types/README.md

@@ -1,2 +1,2 @@
-These are the types that the card ui expects and understands.
+These are the types that the card ui expects and understands.
 There should always be adaptors both ways from Hanzo commerceJs types.

package/types/category-node.ts

@@ -1,50 +1,50 @@
-import type { ReactNode } from 'react'
-
-interface CategoryNode {
-  skuToken: string             // a token in the sku
-  label: string;
-    /** 
-     * Explicitly marks this node as a "last user-visible" / "outermost" Category. 
-     * Normally, a node is "outermost" when it has no subnodes 
-     * (and thus is a family with products -- "single-family")
-     * But if it *has* subnodes, and its subNodes are actually sibling families
-     * of a Category, it must be marked as "outermost" ("multi-family")
-     * */
-  outermost?: boolean;
-  img? : string | ReactNode  // icon is required 
-  imgAR? : number           // helps with svgs
-
-  /** 
-   * One word prompt that describes the 'meaning' of 
-   * the subnodes. 
-   * For example, if a node is 'Lux Credit', 
-   * it's subNodesLabel might be 'Level', so some UI's
-   * might be configured to render 'Level: Black'
-   * 
-   * or something like...
-   * 
-   * <Tabs title={parentNode.label + ': ' + parentNode.subNodesLabel} values={families.map((f) => (f.shortName))} />
-   * 
-   * ...which renders
-   *        
-   * Lux Credit Levels:
-   * Black   Elite   Founder   Sovereign 
-  */
-  subNodesLabel?: string   
-  subNodes?: CategoryNode[]
-}
-
-type CategoryNodeRole = 
-  'single-family' | 
-  'family-in-multi-family' | 
-  'multi-family' | 
-  'non-outermost' 
-
-  // Which facets tokens are 'on' at each level
-type SelectedPaths = Record<number, string[]>
-
-export type {
-  CategoryNodeRole,
-  CategoryNode,
-  SelectedPaths
+import type { ReactNode } from 'react'
+
+interface CategoryNode {
+  skuToken: string             // a token in the sku
+  label: string;
+    /** 
+     * Explicitly marks this node as a "last user-visible" / "outermost" Category. 
+     * Normally, a node is "outermost" when it has no subnodes 
+     * (and thus is a family with products -- "single-family")
+     * But if it *has* subnodes, and its subNodes are actually sibling families
+     * of a Category, it must be marked as "outermost" ("multi-family")
+     * */
+  outermost?: boolean;
+  img? : string | ReactNode  // icon is required 
+  imgAR? : number           // helps with svgs
+
+  /** 
+   * One word prompt that describes the 'meaning' of 
+   * the subnodes. 
+   * For example, if a node is 'Lux Credit', 
+   * it's subNodesLabel might be 'Level', so some UI's
+   * might be configured to render 'Level: Black'
+   * 
+   * or something like...
+   * 
+   * <Tabs title={parentNode.label + ': ' + parentNode.subNodesLabel} values={families.map((f) => (f.shortName))} />
+   * 
+   * ...which renders
+   *        
+   * Lux Credit Levels:
+   * Black   Elite   Founder   Sovereign 
+  */
+  subNodesLabel?: string   
+  subNodes?: CategoryNode[]
+}
+
+type CategoryNodeRole = 
+  'single-family' | 
+  'family-in-multi-family' | 
+  'multi-family' | 
+  'non-outermost' 
+
+  // Which facets tokens are 'on' at each level
+type SelectedPaths = Record<number, string[]>
+
+export type {
+  CategoryNodeRole,
+  CategoryNode,
+  SelectedPaths
 }

package/types/checkout.ts

@@ -1,47 +1,47 @@
-import type { ComponentType } from 'react'
-import type { UseFormReturn } from 'react-hook-form'
-
-type TransactionStatus = 'unpaid' | 'paid' | 'confirmed' | 'error'
-
-interface CheckoutStepComponentProps {
-  onDone: () => void
-  orderId: string | undefined
-  setOrderId: (orderId: string | undefined) => void
-}
-
-interface CheckoutStep {
-  name: string  
-  label?: string 
-  Comp: ComponentType<CheckoutStepComponentProps>
-}
-
-type ContactFormType = UseFormReturn<{
-  name: string
-  email: string
-}, any, {
-  name: string
-  email: string
-}>
-
-interface PaymentMethodComponentProps {
-  onDone: () => void
-  transactionStatus: TransactionStatus
-  setTransactionStatus: (status: TransactionStatus) => void
-  storePaymentInfo: (paymentInfo: any) => Promise<void>
-  contactForm: ContactFormType
-}
-
-interface PaymentMethodDesc {
-  value: string  
-  label: string 
-  Comp: ComponentType<PaymentMethodComponentProps>
-}
-
-export {
-  type TransactionStatus,
-  type CheckoutStepComponentProps,
-  type CheckoutStep,
-  type PaymentMethodComponentProps,
-  type PaymentMethodDesc,
-  type ContactFormType,
+import type { ComponentType } from 'react'
+import type { UseFormReturn } from 'react-hook-form'
+
+type TransactionStatus = 'unpaid' | 'paid' | 'confirmed' | 'error'
+
+interface CheckoutStepComponentProps {
+  onDone: () => void
+  orderId: string | undefined
+  setOrderId: (orderId: string | undefined) => void
+}
+
+interface CheckoutStep {
+  name: string  
+  label?: string 
+  Comp: ComponentType<CheckoutStepComponentProps>
+}
+
+type ContactFormType = UseFormReturn<{
+  name: string
+  email: string
+}, any, {
+  name: string
+  email: string
+}>
+
+interface PaymentMethodComponentProps {
+  onDone: () => void
+  transactionStatus: TransactionStatus
+  setTransactionStatus: (status: TransactionStatus) => void
+  storePaymentInfo: (paymentInfo: any) => Promise<void>
+  contactForm: ContactFormType
+}
+
+interface PaymentMethodDesc {
+  value: string  
+  label: string 
+  Comp: ComponentType<PaymentMethodComponentProps>
+}
+
+export {
+  type TransactionStatus,
+  type CheckoutStepComponentProps,
+  type CheckoutStep,
+  type PaymentMethodComponentProps,
+  type PaymentMethodDesc,
+  type ContactFormType,
 }

package/types/commerce-config.ts

@@ -1,13 +1,13 @@
-import type { ServiceOptions } from '..'
-import type { CategoryNode } from './category-node'
-import type { Family } from './family'
-import type { SelectionUISpecifier }  from './selection-ui-specifier'
-
-interface CommerceConfig {
-  families: Family[]
-  rootNode: CategoryNode
-  options?: ServiceOptions
-  uiSpecifiers?: Record<string, SelectionUISpecifier>
-}
-
-export { type CommerceConfig as default }
+import type { ServiceOptions } from '..'
+import type { CategoryNode } from './category-node'
+import type { Family } from './family'
+import type { SelectionUISpecifier }  from './selection-ui-specifier'
+
+interface CommerceConfig {
+  families: Family[]
+  rootNode: CategoryNode
+  options?: ServiceOptions
+  uiSpecifiers?: Record<string, SelectionUISpecifier>
+}
+
+export { type CommerceConfig as default }

package/types/commerce-service.ts

@@ -1,122 +1,122 @@
-import type { LineItem, ObsLineItemRef } from './line-item'
-import type { CategoryNode, SelectedPaths, CategoryNodeRole } from './category-node'
-import type { Family, ObsFamilyRef} from './family'
-import type Promo from './promo'
-
-
-interface CommerceService extends ObsLineItemRef, ObsFamilyRef {
-
-    /** Items in cart */
-  get cartItems(): LineItem[]
-    /** Total of all quantities of all items in cart */
-  get cartQuantity(): number
-    /** Total of all prices x quantities of items in cart */
-  get cartTotal(): number
-
-  get promoAppliedCartTotal(): number
-
-  get cartEmpty(): boolean
-
-  get appliedPromo(): Promo | null
-  setAppliedPromo(promo: Promo | null): void
-    /** returns the price with promo applied, of undefined if no promo or promo does not apply */
-  itemPromoPrice(item: LineItem): number | undefined
-   
-  getFamilySubtotal(familyId: string): number
-
-  createOrder(email: string, name?: string): Promise<string | undefined>
-  updateOrderShippingInfo(orderId: string, shippingInfo: any): Promise<void>
-  updateOrderPaymentInfo(orderId: string, paymentInfo: any): Promise<void>
-
-    /** 
-     * Sets the tokens at each level supplied.
-     * If a level is selected as [], nothing will be selected.
-     * If a level is missing (undefined), everything at that level is selected
-     * 
-     * This selects one or more Family's, and all the LineItem's in them.
-     * 
-     * An empty value object selects all Family's and all LineItem's,
-     * */ 
-  selectPaths(value: SelectedPaths): Family[]
-  selectPath(skuPath: string): Family[] 
-
-    /**
-     * With role as ...
-     *  
-     * 'single-family': 
-     *    item: item with skuPath as SKU, otherwise undefined
-     *    node: node at path (or item's parent node),
-     *    family: node at path as family (or item's parent node as family), 
-     *    families: undefined 
-     * 
-     * 'family-in-multi-family': 
-     *    item: item with skuPath as SKU, otherwise undefined
-     *    node: parent node of this family (or parent node of item's family)
-     *    family: this family (or item's family)
-     *    families: this family (or item's family) and siblings
-     * 
-     * 'multi-family': 
-     *    item: undefined
-     *    node: node at path 
-     *    family: undefined
-     *    families: subnodes / families of this node
-     *    
-     * 'non-outermost': 
-     *    item: undefined
-     *    node: node at path
-     *    family: undefined
-     *    families: undefined
-     * 
-    */
-  peek(skuPath: string): {
-    role: CategoryNodeRole
-    family: Family | undefined
-    families: Family[] | undefined
-    node: CategoryNode | undefined
-    item: LineItem | undefined
-  } | string // or error string
-
-    /** @deprecated
-     *  Whether this path defines a Family, or if it has further levels 
-     * */
-  getNodeAtPath(skuPath: string): CategoryNode | undefined 
-
-  get selectedPaths(): SelectedPaths // returns a copy
-  
-  get selectedItems(): LineItem[]
-  get selectedFamilies(): Family[] 
-  get hasSelection(): boolean
-
-
-    /** 
-     * Who are the subnodes selected at 'level'? 
-     * If more than one value is selected at 'level', 
-     * the returned CategoryNode[] may represent multiple sets. 
-     * */ 
-  getSelectedNodesAtLevel(level: number): CategoryNode[] | undefined 
-
-      /**
-     * For convenience, so widgets can share state.
-     * "current" is unrelated to what branches and items are 
-     * "selected" (with CategoryNode's and paths)
-     * 
-     *  SEE ALSO: from ObsLineItemRef and ObsFamilyRef, there are also
-     *  get item(): LineItem | undefined
-     *  get family(): Family | undefined
-     * 
-     *  These simply delegate to these functions
-     *  */ 
-  setCurrentItem(sku: string | undefined): boolean // valid sku and was set.
-  get currentItem(): LineItem | undefined
-  setCurrentFamily(id: string | undefined): boolean // valid id and was set.
-  get currentFamily(): Family | undefined
-
-    // utility
-  getFamilyById(id: string): Family | undefined
-  getItemBySku(sku: string): LineItem | undefined
-}
-
-
-export {
-  type CommerceService as default
+import type { LineItem, ObsLineItemRef } from './line-item'
+import type { CategoryNode, SelectedPaths, CategoryNodeRole } from './category-node'
+import type { Family, ObsFamilyRef} from './family'
+import type Promo from './promo'
+
+
+interface CommerceService extends ObsLineItemRef, ObsFamilyRef {
+
+    /** Items in cart */
+  get cartItems(): LineItem[]
+    /** Total of all quantities of all items in cart */
+  get cartQuantity(): number
+    /** Total of all prices x quantities of items in cart */
+  get cartTotal(): number
+
+  get promoAppliedCartTotal(): number
+
+  get cartEmpty(): boolean
+
+  get appliedPromo(): Promo | null
+  setAppliedPromo(promo: Promo | null): void
+    /** returns the price with promo applied, of undefined if no promo or promo does not apply */
+  itemPromoPrice(item: LineItem): number | undefined
+   
+  getFamilySubtotal(familyId: string): number
+
+  createOrder(email: string, name?: string): Promise<string | undefined>
+  updateOrderShippingInfo(orderId: string, shippingInfo: any): Promise<void>
+  updateOrderPaymentInfo(orderId: string, paymentInfo: any): Promise<void>
+
+    /** 
+     * Sets the tokens at each level supplied.
+     * If a level is selected as [], nothing will be selected.
+     * If a level is missing (undefined), everything at that level is selected
+     * 
+     * This selects one or more Family's, and all the LineItem's in them.
+     * 
+     * An empty value object selects all Family's and all LineItem's,
+     * */ 
+  selectPaths(value: SelectedPaths): Family[]
+  selectPath(skuPath: string): Family[] 
+
+    /**
+     * With role as ...
+     *  
+     * 'single-family': 
+     *    item: item with skuPath as SKU, otherwise undefined
+     *    node: node at path (or item's parent node),
+     *    family: node at path as family (or item's parent node as family), 
+     *    families: undefined 
+     * 
+     * 'family-in-multi-family': 
+     *    item: item with skuPath as SKU, otherwise undefined
+     *    node: parent node of this family (or parent node of item's family)
+     *    family: this family (or item's family)
+     *    families: this family (or item's family) and siblings
+     * 
+     * 'multi-family': 
+     *    item: undefined
+     *    node: node at path 
+     *    family: undefined
+     *    families: subnodes / families of this node
+     *    
+     * 'non-outermost': 
+     *    item: undefined
+     *    node: node at path
+     *    family: undefined
+     *    families: undefined
+     * 
+    */
+  peek(skuPath: string): {
+    role: CategoryNodeRole
+    family: Family | undefined
+    families: Family[] | undefined
+    node: CategoryNode | undefined
+    item: LineItem | undefined
+  } | string // or error string
+
+    /** @deprecated
+     *  Whether this path defines a Family, or if it has further levels 
+     * */
+  getNodeAtPath(skuPath: string): CategoryNode | undefined 
+
+  get selectedPaths(): SelectedPaths // returns a copy
+  
+  get selectedItems(): LineItem[]
+  get selectedFamilies(): Family[] 
+  get hasSelection(): boolean
+
+
+    /** 
+     * Who are the subnodes selected at 'level'? 
+     * If more than one value is selected at 'level', 
+     * the returned CategoryNode[] may represent multiple sets. 
+     * */ 
+  getSelectedNodesAtLevel(level: number): CategoryNode[] | undefined 
+
+      /**
+     * For convenience, so widgets can share state.
+     * "current" is unrelated to what branches and items are 
+     * "selected" (with CategoryNode's and paths)
+     * 
+     *  SEE ALSO: from ObsLineItemRef and ObsFamilyRef, there are also
+     *  get item(): LineItem | undefined
+     *  get family(): Family | undefined
+     * 
+     *  These simply delegate to these functions
+     *  */ 
+  setCurrentItem(sku: string | undefined): boolean // valid sku and was set.
+  get currentItem(): LineItem | undefined
+  setCurrentFamily(id: string | undefined): boolean // valid id and was set.
+  get currentFamily(): Family | undefined
+
+    // utility
+  getFamilyById(id: string): Family | undefined
+  getItemBySku(sku: string): LineItem | undefined
+}
+
+
+export {
+  type CommerceService as default
 }

package/types/family.ts

@@ -1,26 +1,26 @@
-import type { ImageDef } from '@hanzo/ui/types'
-import type Product from './product'
-
-interface Family {
-  id: string            // LXB-AU-B
-  title: string         // Minted Bar, Lux Elite Card
-  titleShort?: string   // Elite
-  parentTitle?: string  // Lux Gold, Lux Credit
-  byline?: string       // literal text, or name of function on 'this' object that returns a string
-  desc?: string
-  img?: ImageDef, 
-    // inbound to the service, they're Products 
-    // when it's initialized, interally they become LineItems
-    // always ok to cast up to LineItem thereafter
-  products: Product[] 
-}
-
-
-interface ObsFamilyRef {
-  get family(): Family | undefined
-}
-
-export {
-  type Family, 
-  type ObsFamilyRef
+import type { ImageDef } from '@hanzo/ui/types'
+import type Product from './product'
+
+interface Family {
+  id: string            // LXB-AU-B
+  title: string         // Minted Bar, Lux Elite Card
+  titleShort?: string   // Elite
+  parentTitle?: string  // Lux Gold, Lux Credit
+  byline?: string       // literal text, or name of function on 'this' object that returns a string
+  desc?: string
+  img?: ImageDef, 
+    // inbound to the service, they're Products 
+    // when it's initialized, interally they become LineItems
+    // always ok to cast up to LineItem thereafter
+  products: Product[] 
+}
+
+
+interface ObsFamilyRef {
+  get family(): Family | undefined
+}
+
+export {
+  type Family, 
+  type ObsFamilyRef
 }

package/types/index.ts

@@ -1,15 +1,15 @@
-
-export type { default as CommerceService } from './commerce-service'
-export type { default as CommerceConfig } from './commerce-config'
-export type { default as MultiFamilySelectorProps } from './multi-family-selector-props'
-export type { default as Product } from './product'
-export type { default as Promo } from './promo'
-export type { default as TokenSeparators } from './token-separators'
-
-export * from './category-node'
-export * from './checkout'
-export * from './family'
-export * from './item-selector'
-export * from './line-item'
-export * from './selection-ui-specifier'
-export * from './string-mutator'
+
+export type { default as CommerceService } from './commerce-service'
+export type { default as CommerceConfig } from './commerce-config'
+export type { default as MultiFamilySelectorProps } from './multi-family-selector-props'
+export type { default as Product } from './product'
+export type { default as Promo } from './promo'
+export type { default as TokenSeparators } from './token-separators'
+
+export * from './category-node'
+export * from './checkout'
+export * from './family'
+export * from './item-selector'
+export * from './line-item'
+export * from './selection-ui-specifier'
+export * from './string-mutator'