This page indexes the public TypeScript entrypoints in the workspace. Use the guides for behavior and operational boundaries; use this reference to confirm an exported name, type, or method signature.
How to use this reference
- Import from the exact package entrypoint named by a section heading. Unsupported deep imports may change without notice.
- Read driver interfaces with the matching configuration guide and provider guide; a type signature cannot express credentials, webhook, queue, or compliance obligations.
- Run
pnpm docs:buildafter changing an exported contract. The generated diff is part of the public-surface review. - Check stability and compatibility before depending on a beta or experimental export.
@adocommercekit/admin
ADMIN_PANEL_FRONTEND_ROOT
Value
Host-relative root of the published frontend tree.
"inertia"ADMIN_PANEL_HOST_DEPENDENCIES
Value
npm packages the host must own directly (ASPEC §2.2). The vendored coss and Bklit components import them, so they cannot be dependencies of this package: the published files live in the host’s source tree and are resolved by the host’s bundler.
Generated from the vendored tree by scripts/vendor_registry.mjs; the
contract test asserts this constant matches registry_provenance.json.
{ readonly '@base-ui/react': "^1.6.0"; readonly '@daypicker/react': "^10.0.1"; readonly '@number-flow/react': "^0.6.2"; readonly '@types/d3-array': "^3.2.2"; readonly '@types/d3-shape': "^3.1.8"; readonly '@visx/curve': "4.0.1-alpha.0"; readonly '@visx/event': "4.0.1-alpha.0"; readonly '@visx/gradient': "4.0.1-alpha.0"; readonly '@visx/grid': "4.0.1-alpha.0"; readonly '@visx/group': "4.0.1-alpha.0"; readonly '@visx/pattern': "4.0.1-alpha.0"; readonly '@visx/responsive': "4.0.1-alpha.0"; readonly '@visx/scale': "4.0.1-alpha.0"; readonly '@visx/shape': "4.0.1-alpha.0"; readonly 'class-variance-authority': "^0.7.1"; readonly clsx: "^2.1.1"; readonly 'd3-array': "^3.2.4"; readonly 'd3-shape': "^3.2.0"; readonly 'lucide-react': "^1.27.0"; readonly motion: "^12.43.0"; readonly 'tailwind-merge': "^3.6.0"; readonly '@tailwindcss/vite': "^4.1.16"; readonly tailwindcss: "^4.1.16"; readonly zod: "^4.1.13"; }ADMIN_PANEL_I18N_DESTINATION
Value
"inertia/lib/commerce/i18n.ts"ADMIN_PANEL_NAV_DESTINATION
Value
"inertia/components/commerce/shell/nav.ts"ADMIN_PANEL_PREFIX
Value
"/admin/commerce"adminPanelFrontendFiles
Function
Every file under stubs/inertia, as host-relative destinations. Frontend
files are published by plain copy rather than through Ace codemods: stub
rendering interprets {{ }}, and JSX is full of style={{ … }}.
() => Promise<{ marker: string; destination: string; sourcePath: string; }[]>AdminPanelHostDependency
Type
"@base-ui/react" | "@daypicker/react" | "@number-flow/react" | "@types/d3-array" | "@types/d3-shape" | "@visx/curve" | "@visx/event" | "@visx/gradient" | "@visx/grid" | "@visx/group" | "@visx/pattern" | "@visx/responsive" | "@visx/scale" | "@visx/shape" | "class-variance-authority" | "clsx" | "d3-array" | "d3-shape" | "lucide-react" | "motion" | "tailwind-merge" | "@tailwindcss/vite" | "tailwindcss" | "zod"adminPanelRoute
Function
Looks a panel route up by name; throws when the name is not in the table.
(name: string) => AdminPanelRouteAdminPanelRoute
Type
{ readonly method: "GET"; readonly path: "/"; readonly name: "commerce.admin.panel.dashboard"; readonly ability: readonly ["commerce.metrics.view", "commerce.orders.view", "commerce.products.view", "commerce.inventory.view", "commerce.customers.view", "commerce.payments.reconcile", "commerce.returns.view", "commerce.webhooks.view", "commerce.media.view", "commerce.audit.view"]; readonly component: "admin/commerce/dashboard"; } | { readonly method: "GET"; readonly path: "/orders"; readonly name: "commerce.admin.panel.orders.index"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/index"; } | { readonly method: "GET"; readonly path: "/orders/:id"; readonly name: "commerce.admin.panel.orders.show"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/show"; } | { readonly method: "POST"; readonly path: "/orders/:id/transition"; readonly name: "commerce.admin.panel.orders.transition"; readonly ability: "commerce.orders.transition"; readonly component: null; } | { readonly method: "POST"; readonly path: "/orders/:id/cancel"; readonly name: "commerce.admin.panel.orders.cancel"; readonly ability: "commerce.orders.cancel"; readonly component: null; } | { readonly method: "POST"; readonly path: "/orders/:id/adjustments"; readonly name: "commerce.admin.panel.orders.adjustments.store"; readonly ability: "commerce.orders.adjust"; readonly component: null; } | { readonly method: "POST"; readonly path: "/orders/:id/shipments"; readonly name: "commerce.admin.panel.shipments.store"; readonly ability: "commerce.shipments.manage"; readonly component: null; } | { readonly method: "POST"; readonly path: "/shipments/:id/transition"; readonly name: "commerce.admin.panel.shipments.transition"; readonly ability: "commerce.ship…AdminPanelRouteDefinition
Interface
AdminPanelRouteDefinitionPublic members
method:"GET" | "POST" | "PATCH" | "PUT" | "DELETE"path:stringname:stringability:anycomponent:string | null
adminPanelRoutes
Value
The complete Inertia panel surface (ASPEC §7.2 page inventory plus the mutations those pages submit). This table is the single source of truth: the published routes stub, the nav catalog, the docs page, and the contract test are all checked against it.
ASPEC §7.2 is a closed list. Adding a page here without amending the spec is
the scope creep ARCH §13 named; the contract test counts the GET rows.
Every mutation row has a counterpart in adminEndpoints of
@adocommercekit/admin-api/contract carrying the same ability — the panel
never gains a capability the REST surface lacks (ADMIN_PLAN §2.2), and the
contract test proves the correspondence.
readonly [{ readonly method: "GET"; readonly path: "/"; readonly name: "commerce.admin.panel.dashboard"; readonly ability: readonly ["commerce.metrics.view", "commerce.orders.view", "commerce.products.view", "commerce.inventory.view", "commerce.customers.view", "commerce.payments.reconcile", "commerce.returns.view", "commerce.webhooks.view", "commerce.media.view", "commerce.audit.view"]; readonly component: "admin/commerce/dashboard"; }, { readonly method: "GET"; readonly path: "/orders"; readonly name: "commerce.admin.panel.orders.index"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/index"; }, { readonly method: "GET"; readonly path: "/orders/:id"; readonly name: "commerce.admin.panel.orders.show"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/show"; }, { readonly method: "POST"; readonly path: "/orders/:id/transition"; readonly name: "commerce.admin.panel.orders.transition"; readonly ability: "commerce.orders.transition"; readonly component: null; }, { readonly method: "POST"; readonly path: "/orders/:id/cancel"; readonly name: "commerce.admin.panel.orders.cancel"; readonly ability: "commerce.orders.cancel"; readonly component: null; }, { readonly method: "POST"; readonly path: "/orders/:id/adjustments"; readonly name: "commerce.admin.panel.orders.adjustments.store"; readonly ability: "commerce.orders.adjust"; readonly component: null; }, { readonly method: "POST"; readonly path: "/orders/:id/shipments"; readonly name: "commerce.admin.panel.shipments.store"; readonly ability: "commerce.shipments.manage"; readonly component: null; }, { readonly method: "POST"; readonly path: "/shipments/:id/transition"; readonly name: "commerce.admin.panel.shipments.transition"; readonly ability: "commerce.s…AdminPanelUpgradeArtifactDefinition
Interface
AdminPanelUpgradeArtifactDefinitionPublic members
marker:stringdestination:stringstub:string
adminPanelUpgradeManifest
Value
The server-side files configure() publishes through Ace codemods, in
publication order. Frontend files are not listed here: they are discovered
by walking stubs/inertia, because the vendored registry tree is 130 files
and a hand-maintained list would drift on the first re-vendor.
{ readonly packageName: "@adocommercekit/admin"; readonly version: string; readonly artifacts: { marker: string; destination: string; stub: string; }[]; }AdminPanelUpgradeNote
Interface
AdminPanelUpgradeNotePublic members
kind:AdminPanelUpgradeNoteKindmessage:string
AdminPanelUpgradeNoteKind
Type
AdminPanelUpgradeNoteKindconfigure
Function
(command: Configure) => Promise<void>describeAdminPanelUpgrade
Function
The panel-specific additions ASPEC §11 requires in the upgrade report:
vendored-component changes carry upstream attribution, new i18n keys and nav
items are surfaced explicitly, and added abilities print with a reminder that
host policy mappings need extending. Returns an empty list for a host that has
not published the panel yet — the ordinary add plan already covers that.
(root: string) => Promise<AdminPanelUpgradeNote[]>loadAdminPanelUpgradeArtifacts
Function
Loader commerce:upgrade calls. Server stubs first, then the frontend tree,
so a host reviewing the diff sees controllers and routes before 130 vendored
component files.
(root?: string) => Promise<any>packagedRegistryProvenance
Function
() => Promise<RegistryProvenance>REGISTRY_PROVENANCE_DESTINATION
Value
"inertia/components/commerce/registry_provenance.json"RegistryProvenance
Interface
RegistryProvenancePublic members
retrievedAt:stringregistries:Record<string, { namespace: string; repository: string; revision: string; revisionDate: string; license: string; items: string[]; requestedItems: string[]; }>hostDependencies:Record<string, string>files:RegistryProvenanceFile[]
RegistryProvenanceFile
Interface
RegistryProvenanceFilePublic members
registry:stringitem:stringupstreamPath:stringdestination:stringupstreamSha256:stringvendoredSha256:string
stubsRoot
Value
string@adocommercekit/admin/configure
configure
Function
(command: Configure) => Promise<void>publishedStubs
Value
string[]@adocommercekit/admin/contract
ADMIN_PANEL_HOST_DEPENDENCIES
Value
npm packages the host must own directly (ASPEC §2.2). The vendored coss and Bklit components import them, so they cannot be dependencies of this package: the published files live in the host’s source tree and are resolved by the host’s bundler.
Generated from the vendored tree by scripts/vendor_registry.mjs; the
contract test asserts this constant matches registry_provenance.json.
{ readonly '@base-ui/react': "^1.6.0"; readonly '@daypicker/react': "^10.0.1"; readonly '@number-flow/react': "^0.6.2"; readonly '@types/d3-array': "^3.2.2"; readonly '@types/d3-shape': "^3.1.8"; readonly '@visx/curve': "4.0.1-alpha.0"; readonly '@visx/event': "4.0.1-alpha.0"; readonly '@visx/gradient': "4.0.1-alpha.0"; readonly '@visx/grid': "4.0.1-alpha.0"; readonly '@visx/group': "4.0.1-alpha.0"; readonly '@visx/pattern': "4.0.1-alpha.0"; readonly '@visx/responsive': "4.0.1-alpha.0"; readonly '@visx/scale': "4.0.1-alpha.0"; readonly '@visx/shape': "4.0.1-alpha.0"; readonly 'class-variance-authority': "^0.7.1"; readonly clsx: "^2.1.1"; readonly 'd3-array': "^3.2.4"; readonly 'd3-shape': "^3.2.0"; readonly 'lucide-react': "^1.27.0"; readonly motion: "^12.43.0"; readonly 'tailwind-merge': "^3.6.0"; readonly '@tailwindcss/vite': "^4.1.16"; readonly tailwindcss: "^4.1.16"; readonly zod: "^4.1.13"; }ADMIN_PANEL_PREFIX
Value
"/admin/commerce"AdminPanelHostDependency
Type
"@base-ui/react" | "@daypicker/react" | "@number-flow/react" | "@types/d3-array" | "@types/d3-shape" | "@visx/curve" | "@visx/event" | "@visx/gradient" | "@visx/grid" | "@visx/group" | "@visx/pattern" | "@visx/responsive" | "@visx/scale" | "@visx/shape" | "class-variance-authority" | "clsx" | "d3-array" | "d3-shape" | "lucide-react" | "motion" | "tailwind-merge" | "@tailwindcss/vite" | "tailwindcss" | "zod"adminPanelLandingAbilities
Value
The root redirects non-metrics operators to their first permitted page.
readonly ["commerce.metrics.view", "commerce.orders.view", "commerce.products.view", "commerce.inventory.view", "commerce.customers.view", "commerce.payments.reconcile", "commerce.returns.view", "commerce.webhooks.view", "commerce.media.view", "commerce.audit.view"]adminPanelRoute
Function
Looks a panel route up by name; throws when the name is not in the table.
(name: string) => AdminPanelRouteAdminPanelRoute
Type
{ readonly method: "GET"; readonly path: "/"; readonly name: "commerce.admin.panel.dashboard"; readonly ability: readonly ["commerce.metrics.view", "commerce.orders.view", "commerce.products.view", "commerce.inventory.view", "commerce.customers.view", "commerce.payments.reconcile", "commerce.returns.view", "commerce.webhooks.view", "commerce.media.view", "commerce.audit.view"]; readonly component: "admin/commerce/dashboard"; } | { readonly method: "GET"; readonly path: "/orders"; readonly name: "commerce.admin.panel.orders.index"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/index"; } | { readonly method: "GET"; readonly path: "/orders/:id"; readonly name: "commerce.admin.panel.orders.show"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/show"; } | { readonly method: "POST"; readonly path: "/orders/:id/transition"; readonly name: "commerce.admin.panel.orders.transition"; readonly ability: "commerce.orders.transition"; readonly component: null; } | { readonly method: "POST"; readonly path: "/orders/:id/cancel"; readonly name: "commerce.admin.panel.orders.cancel"; readonly ability: "commerce.orders.cancel"; readonly component: null; } | { readonly method: "POST"; readonly path: "/orders/:id/adjustments"; readonly name: "commerce.admin.panel.orders.adjustments.store"; readonly ability: "commerce.orders.adjust"; readonly component: null; } | { readonly method: "POST"; readonly path: "/orders/:id/shipments"; readonly name: "commerce.admin.panel.shipments.store"; readonly ability: "commerce.shipments.manage"; readonly component: null; } | { readonly method: "POST"; readonly path: "/shipments/:id/transition"; readonly name: "commerce.admin.panel.shipments.transition"; readonly ability: "commerce.ship…AdminPanelRouteDefinition
Interface
AdminPanelRouteDefinitionPublic members
method:"GET" | "POST" | "PATCH" | "PUT" | "DELETE"path:stringname:stringability:anycomponent:string | null
adminPanelRoutes
Value
The complete Inertia panel surface (ASPEC §7.2 page inventory plus the mutations those pages submit). This table is the single source of truth: the published routes stub, the nav catalog, the docs page, and the contract test are all checked against it.
ASPEC §7.2 is a closed list. Adding a page here without amending the spec is
the scope creep ARCH §13 named; the contract test counts the GET rows.
Every mutation row has a counterpart in adminEndpoints of
@adocommercekit/admin-api/contract carrying the same ability — the panel
never gains a capability the REST surface lacks (ADMIN_PLAN §2.2), and the
contract test proves the correspondence.
readonly [{ readonly method: "GET"; readonly path: "/"; readonly name: "commerce.admin.panel.dashboard"; readonly ability: readonly ["commerce.metrics.view", "commerce.orders.view", "commerce.products.view", "commerce.inventory.view", "commerce.customers.view", "commerce.payments.reconcile", "commerce.returns.view", "commerce.webhooks.view", "commerce.media.view", "commerce.audit.view"]; readonly component: "admin/commerce/dashboard"; }, { readonly method: "GET"; readonly path: "/orders"; readonly name: "commerce.admin.panel.orders.index"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/index"; }, { readonly method: "GET"; readonly path: "/orders/:id"; readonly name: "commerce.admin.panel.orders.show"; readonly ability: "commerce.orders.view"; readonly component: "admin/commerce/orders/show"; }, { readonly method: "POST"; readonly path: "/orders/:id/transition"; readonly name: "commerce.admin.panel.orders.transition"; readonly ability: "commerce.orders.transition"; readonly component: null; }, { readonly method: "POST"; readonly path: "/orders/:id/cancel"; readonly name: "commerce.admin.panel.orders.cancel"; readonly ability: "commerce.orders.cancel"; readonly component: null; }, { readonly method: "POST"; readonly path: "/orders/:id/adjustments"; readonly name: "commerce.admin.panel.orders.adjustments.store"; readonly ability: "commerce.orders.adjust"; readonly component: null; }, { readonly method: "POST"; readonly path: "/orders/:id/shipments"; readonly name: "commerce.admin.panel.shipments.store"; readonly ability: "commerce.shipments.manage"; readonly component: null; }, { readonly method: "POST"; readonly path: "/shipments/:id/transition"; readonly name: "commerce.admin.panel.shipments.transition"; readonly ability: "commerce.s…@adocommercekit/admin/upgrade
ADMIN_PANEL_FRONTEND_ROOT
Value
Host-relative root of the published frontend tree.
"inertia"ADMIN_PANEL_I18N_DESTINATION
Value
"inertia/lib/commerce/i18n.ts"ADMIN_PANEL_NAV_DESTINATION
Value
"inertia/components/commerce/shell/nav.ts"adminPanelFrontendFiles
Function
Every file under stubs/inertia, as host-relative destinations. Frontend
files are published by plain copy rather than through Ace codemods: stub
rendering interprets {{ }}, and JSX is full of style={{ … }}.
() => Promise<{ marker: string; destination: string; sourcePath: string; }[]>AdminPanelUpgradeArtifactDefinition
Interface
AdminPanelUpgradeArtifactDefinitionPublic members
marker:stringdestination:stringstub:string
adminPanelUpgradeManifest
Value
The server-side files configure() publishes through Ace codemods, in
publication order. Frontend files are not listed here: they are discovered
by walking stubs/inertia, because the vendored registry tree is 130 files
and a hand-maintained list would drift on the first re-vendor.
{ readonly packageName: "@adocommercekit/admin"; readonly version: string; readonly artifacts: { marker: string; destination: string; stub: string; }[]; }AdminPanelUpgradeNote
Interface
AdminPanelUpgradeNotePublic members
kind:AdminPanelUpgradeNoteKindmessage:string
AdminPanelUpgradeNoteKind
Type
AdminPanelUpgradeNoteKinddescribeAdminPanelUpgrade
Function
The panel-specific additions ASPEC §11 requires in the upgrade report:
vendored-component changes carry upstream attribution, new i18n keys and nav
items are surfaced explicitly, and added abilities print with a reminder that
host policy mappings need extending. Returns an empty list for a host that has
not published the panel yet — the ordinary add plan already covers that.
(root: string) => Promise<AdminPanelUpgradeNote[]>loadAdminPanelUpgradeArtifacts
Function
Loader commerce:upgrade calls. Server stubs first, then the frontend tree,
so a host reviewing the diff sees controllers and routes before 130 vendored
component files.
(root?: string) => Promise<any>packagedRegistryProvenance
Function
() => Promise<RegistryProvenance>REGISTRY_PROVENANCE_DESTINATION
Value
"inertia/components/commerce/registry_provenance.json"RegistryProvenance
Interface
RegistryProvenancePublic members
retrievedAt:stringregistries:Record<string, { namespace: string; repository: string; revision: string; revisionDate: string; license: string; items: string[]; requestedItems: string[]; }>hostDependencies:Record<string, string>files:RegistryProvenanceFile[]
RegistryProvenanceFile
Interface
RegistryProvenanceFilePublic members
registry:stringitem:stringupstreamPath:stringdestination:stringupstreamSha256:stringvendoredSha256:string
@adocommercekit/admin-api
ADMIN_API_PREFIX
Value
"/api/commerce/admin"ADMIN_AUDIT_TABLE
Value
"admin_audit_entries"ADMIN_RATE_LIMITS
Value
Rate-limit tiers the published routes stub applies (ASPEC §4.2).
{ readonly preAuth: { readonly scope: "admin-pre-auth"; readonly requests: 600; readonly windowSeconds: 60; }; readonly mutation: { readonly scope: "admin-mutation"; readonly requests: 60; readonly windowSeconds: 60; }; readonly read: { readonly scope: "admin-read"; readonly requests: 240; readonly windowSeconds: 60; }; readonly metrics: { readonly scope: "admin-metrics"; readonly requests: 120; readonly windowSeconds: 60; }; }ADMIN_SHIPMENT_TRANSITIONS
Value
Readonly<Record<ShipmentState, readonly AdminShipmentTransition[]>>adminAbilityTarget
Function
(ability: CommerceAbility) => AdminAbilityTargetAdminAbilityTarget
Interface
Where a frozen ability is enforced: the shipped policy class the host extends
and the method on it. Derived from commercePolicyAbilities so the catalog
stays the single source of truth — an ability core adds without a policy
method makes this module throw at load, not silently allow.
AdminAbilityTargetPublic members
policy:string | number | symbolmethod:string
adminAbilityTargets
Function
The complete ability → policy method map, for host policy scaffolding and docs.
() => ReadonlyMap<CommerceAbility, AdminAbilityTarget>AdminActor
Interface
The actor an admin request runs as, resolved by the published auth middleware from the host’s own user model. The engine never reads host user tables.
The three fields serve three consumers and are deliberately not collapsed:
id is the opaque value recorded verbatim in the audit trail, label is what
the trail and the panel header display, and user is the host principal the
Bouncer policy methods receive so role mapping works against the host’s own
model rather than an engine projection of it.
AdminActorPublic members
id:stringlabel:string | nulluser:unknown
AdminAuditEntry
Type
AdminAuditEntryAdminAuditEntryInput
Interface
AdminAuditEntryInputPublic members
actorId:stringactorLabel:string | null | undefinedability:CommerceAbilitysubjectType:"return" | "product" | "category" | "order" | "payment" | "payment_intent" | "shipment" | "inventory_level" | "customer" | "inventory_movement" | "inventory_transfer" | "product_bulk" | "webhook_destination" | "webhook_delivery" | "media_asset" | "payment_operation" | "event_outbox" | "promotion_campaign" | "gift_card" | "review"subjectId:stringsummary:Readonly<Record<string, string | number | boolean | null>>idempotencyKey:string | null | undefinedrequestId:string | null | undefined
AdminAuditFilter
Interface
AdminAuditFilterPublic members
actorId:string | undefinedability:CommerceAbility[] | undefinedsubjectType:"return" | "product" | "category" | "order" | "payment" | "payment_intent" | "shipment" | "inventory_level" | "customer" | "inventory_movement" | "inventory_transfer" | "product_bulk" | "webhook_destination" | "webhook_delivery" | "media_asset" | "payment_operation" | "event_outbox" | "promotion_campaign" | "gift_card" | "review" | undefinedsubjectId:string | undefinedcreatedAfter:DateTime<boolean> | undefinedcreatedBefore:DateTime<boolean> | undefinedcursor:string | undefinedlimit:number | undefined
AdminAuditService
Class
The append-only admin audit trail (ASPEC §4.3, §5.2).
There is no update or delete path by design; retention is the host’s job and the operations doc carries the pruning recipe. The table is written through the query builder rather than a Lucid model so it needs no model-registry entry and no host-side model file — nothing about it is extensible.
AdminAuditServicePublic members
db:Databaseconfig:{ tablePrefix: string; }table:stringrecord:(entry: AdminAuditEntryInput, options?: MutationOptions) => Promise<AdminAuditEntry>list:(filter?: AdminAuditFilter) => Promise<AdminListPage<AdminAuditEntry>>
AdminAuditSubjectType
Type
"return" | "product" | "category" | "order" | "payment" | "payment_intent" | "shipment" | "inventory_level" | "customer" | "inventory_movement" | "inventory_transfer" | "product_bulk" | "webhook_destination" | "webhook_delivery" | "media_asset" | "payment_operation" | "event_outbox" | "promotion_campaign" | "gift_card" | "review"adminAuditSubjectTypes
Value
Subject kinds the audit trail records. Kept as a closed union so the
(subject_type, subject_id, created_at) index stays selective and the panel
can render a stable filter list.
readonly ["product", "category", "order", "payment", "payment_intent", "shipment", "inventory_level", "customer", "inventory_movement", "inventory_transfer", "product_bulk", "webhook_destination", "webhook_delivery", "media_asset", "payment_operation", "event_outbox", "return", "promotion_campaign", "gift_card", "review"]AdminAuditSummary
Type
Compact before/after summary. Values are scalars only: the summary is the
merchant’s operational record of what changed, never a snapshot of the
record. The type is enforced at runtime by assertAuditSummary because the
callers are host-owned controllers where types can be cast away.
Readonly<Record<string, string | number | boolean | null>>adminEndpoint
Function
Looks an endpoint up by route name; throws when the name is not in the table.
(name: string) => AdminEndpointAdminEndpoint
Type
{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.admin.products.index"; readonly ability: "commerce.products.view"; } | { readonly method: "POST"; readonly path: "/products"; readonly name: "commerce.admin.products.store"; readonly ability: "commerce.products.manage"; } | { readonly method: "GET"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.show"; readonly ability: "commerce.products.view"; } | { readonly method: "PATCH"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.update"; readonly ability: "commerce.products.manage"; } | { readonly method: "DELETE"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.destroy"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/archive"; readonly name: "commerce.admin.products.archive"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/bulk/status"; readonly name: "commerce.admin.products.bulk.status"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/options"; readonly name: "commerce.admin.products.options.store"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/variants/generate"; readonly name: "commerce.admin.products.variants.generate"; readonly ability: "commerce.products.manage"; } | { readonly method: "PUT"; readonly path: "/products/:id/categories"; readonly name: "commerce.admin.products.categories"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/images"; readonly name: "commerce.admin.products.images.store"; readonly ability: "commerce.produ…AdminEndpointDefinition
Interface
AdminEndpointDefinitionPublic members
method:"GET" | "POST" | "PATCH" | "PUT" | "DELETE"path:stringname:stringability:anyidempotent:boolean | undefined
adminEndpoints
Value
The complete admin REST surface (ASPEC §4.1). This table is the single source of truth: the published routes stub, the ability middleware, the reference documentation, and the contract test are all checked against it.
ability is enforced by commerceAdminAbility middleware before the
controller body runs, so a row without an ability cannot exist.
readonly [{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.admin.products.index"; readonly ability: "commerce.products.view"; }, { readonly method: "POST"; readonly path: "/products"; readonly name: "commerce.admin.products.store"; readonly ability: "commerce.products.manage"; }, { readonly method: "GET"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.show"; readonly ability: "commerce.products.view"; }, { readonly method: "PATCH"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.update"; readonly ability: "commerce.products.manage"; }, { readonly method: "DELETE"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.destroy"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/archive"; readonly name: "commerce.admin.products.archive"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/bulk/status"; readonly name: "commerce.admin.products.bulk.status"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/options"; readonly name: "commerce.admin.products.options.store"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/variants/generate"; readonly name: "commerce.admin.products.variants.generate"; readonly ability: "commerce.products.manage"; }, { readonly method: "PUT"; readonly path: "/products/:id/categories"; readonly name: "commerce.admin.products.categories"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/images"; readonly name: "commerce.admin.products.images.store"; readonly ability: "commerce.produ…AdminInvalidTransitionException
Class
A state-machine refusal, restated for the admin wire contract (ASPEC §4.2).
Core raises E_STATE_TRANSITION; the admin surface answers
409 E_COMMERCE_INVALID_TRANSITION with currentState, because that field is
what lets the panel refresh a stale action button instead of failing silently.
AdminInvalidTransitionExceptionadminOpenApi
Value
{ readonly openapi: "3.1.0"; readonly info: { readonly title: "Adocommerce Kit Admin API"; readonly version: "1.0.0"; readonly description: "Versioned wire contract for the host-published administration API."; }; readonly servers: readonly [{ readonly url: "/api/commerce/admin"; }]; readonly paths: Record<string, Record<string, unknown>>; readonly components: { readonly securitySchemes: { readonly adminSession: { readonly type: "apiKey"; readonly in: "cookie"; readonly name: "session"; }; }; readonly schemas: { readonly AdminError: { readonly type: "object"; readonly required: readonly ["error"]; readonly properties: { readonly error: { readonly type: "object"; readonly required: readonly ["code", "message"]; readonly properties: { readonly code: { readonly type: "string"; }; readonly message: { readonly type: "string"; }; readonly details: {}; readonly requestId: { readonly type: "string"; }; }; }; }; }; }; readonly responses: { readonly AdminError: { readonly description: "Admin error envelope"; readonly content: { readonly 'application/json': { readonly schema: { readonly $ref: "#/components/schemas/AdminError"; }; }; }; }; }; }; }AdminPreAuthRateLimitStore
Class
Separate container token so unauthenticated IP churn cannot evict actor budgets.
AdminPreAuthRateLimitStorePublic members
consume:(key: string, limit: number, windowSeconds: number, now?: number) => AdminRateLimitResult | Promise<AdminRateLimitResult>
AdminRateLimiter
Class
AdminRateLimiterPublic members
store:AdminRateLimitStorepreAuthStore:AdminRateLimitStoreconsume:(scope: string, actorKey: string, limit: number, windowSeconds: number, now?: number) => Promise<AdminRateLimitResult>
AdminRateLimitResult
Interface
AdminRateLimitResultPublic members
allowed:booleanlimit:numberremaining:numberresetAt:numberretryAfter:number
AdminRateLimitStore
Class
Container token for authenticated actor budgets. Override in a host provider.
AdminRateLimitStorePublic members
consume:(key: string, limit: number, windowSeconds: number, now?: number) => AdminRateLimitResult | Promise<AdminRateLimitResult>
AdminRateLimitTier
Type
"preAuth" | "mutation" | "read" | "metrics"AdminRedisRateLimitClient
Interface
Adapt your Redis library’s EVAL method; no Redis library is required by this package.
AdminRedisRateLimitClientPublic members
eval:(script: string, keys: string[], arguments_: string[]) => Promise<unknown>
AdminShipmentTransition
Type
The shipment operations the admin surface exposes. Shipments do not run on a
declarative state machine like orders and payments do — FulfillmentService
enforces its own preconditions — so the legal-transition set is declared here
once and consumed by both surfaces: the REST controller rejects an illegal
transition with 409 E_COMMERCE_INVALID_TRANSITION before calling the
service, and the panel (AD-33) renders action buttons from the same table.
The service remains the authority; this table exists so the boundary answers “what can I do next?” without guessing from an error message.
AdminShipmentTransitionassertAuditSummary
Function
(summary: AdminAuditSummary) => voidcanTransitionShipment
Function
(state: ShipmentState, transition: AdminShipmentTransition) => booleanCommercePolicyName
Type
string | number | symbolconfigure
Function
(command: Configure) => Promise<void>MemoryAdminRateLimitStore
Class
MemoryAdminRateLimitStorePublic members
#buckets:Map<string, AdminRateLimitBucket>maxKeys:numberconsume:(key: string, limit: number, windowSeconds: number, now?: number) => AdminRateLimitResult
RedisAdminRateLimitStore
Class
RedisAdminRateLimitStorePublic members
client:AdminRedisRateLimitClientkeyPrefix:stringconsume:(key: string, limit: number, windowSeconds: number, now?: number) => Promise<AdminRateLimitResult>
stubsRoot
Value
stringtranslateAdminError
Function
Maps a service failure onto the admin wire contract, returning the error to throw. Unknown errors are returned untouched so a genuine bug still surfaces as a 500 rather than being laundered into a client error.
Two translations, both required by ASPEC §4.2:
E_STATE_TRANSITIONbecomesE_COMMERCE_INVALID_TRANSITIONwith the state the caller observed, which is more useful than the state the machine read.- A
RangeErroris a rejected input the validator could not express — an over-refund, an over-fulfilled line, a category moved under its own child — and belongs in the 422 envelope, not in a stack trace.
(error: unknown, currentState?: string) => unknownunknown
Value
any@adocommercekit/admin-api/configure
AUDIT_MIGRATION_MARKER
Value
"commercekit:admin_audit"configure
Function
(command: Configure) => Promise<void>publishedStubs
Value
The stubs configure() publishes, in order. Derived from the upgrade manifest
so the two lists cannot drift: every published file is baselined and every
baselined file is published.
string[]@adocommercekit/admin-api/contract
ADMIN_API_PREFIX
Value
"/api/commerce/admin"ADMIN_RATE_LIMITS
Value
Rate-limit tiers the published routes stub applies (ASPEC §4.2).
{ readonly preAuth: { readonly scope: "admin-pre-auth"; readonly requests: 600; readonly windowSeconds: 60; }; readonly mutation: { readonly scope: "admin-mutation"; readonly requests: 60; readonly windowSeconds: 60; }; readonly read: { readonly scope: "admin-read"; readonly requests: 240; readonly windowSeconds: 60; }; readonly metrics: { readonly scope: "admin-metrics"; readonly requests: 120; readonly windowSeconds: 60; }; }adminEndpoint
Function
Looks an endpoint up by route name; throws when the name is not in the table.
(name: string) => AdminEndpointAdminEndpoint
Type
{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.admin.products.index"; readonly ability: "commerce.products.view"; } | { readonly method: "POST"; readonly path: "/products"; readonly name: "commerce.admin.products.store"; readonly ability: "commerce.products.manage"; } | { readonly method: "GET"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.show"; readonly ability: "commerce.products.view"; } | { readonly method: "PATCH"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.update"; readonly ability: "commerce.products.manage"; } | { readonly method: "DELETE"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.destroy"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/archive"; readonly name: "commerce.admin.products.archive"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/bulk/status"; readonly name: "commerce.admin.products.bulk.status"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/options"; readonly name: "commerce.admin.products.options.store"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/variants/generate"; readonly name: "commerce.admin.products.variants.generate"; readonly ability: "commerce.products.manage"; } | { readonly method: "PUT"; readonly path: "/products/:id/categories"; readonly name: "commerce.admin.products.categories"; readonly ability: "commerce.products.manage"; } | { readonly method: "POST"; readonly path: "/products/:id/images"; readonly name: "commerce.admin.products.images.store"; readonly ability: "commerce.produ…AdminEndpointDefinition
Interface
AdminEndpointDefinitionPublic members
method:"GET" | "POST" | "PATCH" | "PUT" | "DELETE"path:stringname:stringability:anyidempotent:boolean | undefined
adminEndpoints
Value
The complete admin REST surface (ASPEC §4.1). This table is the single source of truth: the published routes stub, the ability middleware, the reference documentation, and the contract test are all checked against it.
ability is enforced by commerceAdminAbility middleware before the
controller body runs, so a row without an ability cannot exist.
readonly [{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.admin.products.index"; readonly ability: "commerce.products.view"; }, { readonly method: "POST"; readonly path: "/products"; readonly name: "commerce.admin.products.store"; readonly ability: "commerce.products.manage"; }, { readonly method: "GET"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.show"; readonly ability: "commerce.products.view"; }, { readonly method: "PATCH"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.update"; readonly ability: "commerce.products.manage"; }, { readonly method: "DELETE"; readonly path: "/products/:id"; readonly name: "commerce.admin.products.destroy"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/archive"; readonly name: "commerce.admin.products.archive"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/bulk/status"; readonly name: "commerce.admin.products.bulk.status"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/options"; readonly name: "commerce.admin.products.options.store"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/variants/generate"; readonly name: "commerce.admin.products.variants.generate"; readonly ability: "commerce.products.manage"; }, { readonly method: "PUT"; readonly path: "/products/:id/categories"; readonly name: "commerce.admin.products.categories"; readonly ability: "commerce.products.manage"; }, { readonly method: "POST"; readonly path: "/products/:id/images"; readonly name: "commerce.admin.products.images.store"; readonly ability: "commerce.produ…AdminRateLimitTier
Type
"preAuth" | "mutation" | "read" | "metrics"@adocommercekit/admin-api/services
ADMIN_AUDIT_TABLE
Value
"admin_audit_entries"AdminAuditEntry
Type
AdminAuditEntryAdminAuditEntryInput
Interface
AdminAuditEntryInputPublic members
actorId:stringactorLabel:string | null | undefinedability:CommerceAbilitysubjectType:"return" | "product" | "category" | "order" | "payment" | "payment_intent" | "shipment" | "inventory_level" | "customer" | "inventory_movement" | "inventory_transfer" | "product_bulk" | "webhook_destination" | "webhook_delivery" | "media_asset" | "payment_operation" | "event_outbox" | "promotion_campaign" | "gift_card" | "review"subjectId:stringsummary:Readonly<Record<string, string | number | boolean | null>>idempotencyKey:string | null | undefinedrequestId:string | null | undefined
AdminAuditFilter
Interface
AdminAuditFilterPublic members
actorId:string | undefinedability:CommerceAbility[] | undefinedsubjectType:"return" | "product" | "category" | "order" | "payment" | "payment_intent" | "shipment" | "inventory_level" | "customer" | "inventory_movement" | "inventory_transfer" | "product_bulk" | "webhook_destination" | "webhook_delivery" | "media_asset" | "payment_operation" | "event_outbox" | "promotion_campaign" | "gift_card" | "review" | undefinedsubjectId:string | undefinedcreatedAfter:DateTime<boolean> | undefinedcreatedBefore:DateTime<boolean> | undefinedcursor:string | undefinedlimit:number | undefined
AdminAuditService
Class
The append-only admin audit trail (ASPEC §4.3, §5.2).
There is no update or delete path by design; retention is the host’s job and the operations doc carries the pruning recipe. The table is written through the query builder rather than a Lucid model so it needs no model-registry entry and no host-side model file — nothing about it is extensible.
AdminAuditServicePublic members
db:Databaseconfig:{ tablePrefix: string; }table:stringrecord:(entry: AdminAuditEntryInput, options?: MutationOptions) => Promise<AdminAuditEntry>list:(filter?: AdminAuditFilter) => Promise<AdminListPage<AdminAuditEntry>>
AdminAuditSubjectType
Type
"return" | "product" | "category" | "order" | "payment" | "payment_intent" | "shipment" | "inventory_level" | "customer" | "inventory_movement" | "inventory_transfer" | "product_bulk" | "webhook_destination" | "webhook_delivery" | "media_asset" | "payment_operation" | "event_outbox" | "promotion_campaign" | "gift_card" | "review"adminAuditSubjectTypes
Value
Subject kinds the audit trail records. Kept as a closed union so the
(subject_type, subject_id, created_at) index stays selective and the panel
can render a stable filter list.
readonly ["product", "category", "order", "payment", "payment_intent", "shipment", "inventory_level", "customer", "inventory_movement", "inventory_transfer", "product_bulk", "webhook_destination", "webhook_delivery", "media_asset", "payment_operation", "event_outbox", "return", "promotion_campaign", "gift_card", "review"]AdminAuditSummary
Type
Compact before/after summary. Values are scalars only: the summary is the
merchant’s operational record of what changed, never a snapshot of the
record. The type is enforced at runtime by assertAuditSummary because the
callers are host-owned controllers where types can be cast away.
Readonly<Record<string, string | number | boolean | null>>assertAuditSummary
Function
(summary: AdminAuditSummary) => void@adocommercekit/admin-api/admin_provider
default
Class
Registers shared audit and rate-limit services. Hosts may override the two store tokens with Redis-backed stores in a provider registered after this one. Keep pre-auth and actor budgets separate even when using the same Redis client.
AdminApiProviderPublic members
app:ApplicationServiceregister:() => void
@adocommercekit/admin-api/upgrade
AdminUpgradeArtifactDefinition
Interface
AdminUpgradeArtifactDefinitionPublic members
marker:stringdestination:stringstub:stringadvisory:{ id: string; severity: "low" | "moderate" | "high" | "critical"; summary: string; } | undefined
adminUpgradeManifest
Value
Every file configure() publishes, in publication order. commerce:upgrade
diffs the host copy against the recorded baseline of source, so this list
and publishedStubs in configure.ts must stay identical — the contract test
asserts exactly that.
The audit migration is absent on purpose: migrations carry a Date.now()
prefix and are detected by their commercekit: marker, never re-published.
{ readonly packageName: "@adocommercekit/admin-api"; readonly version: string; readonly artifacts: ({ marker: string; destination: string; stub: string; advisory?: undefined; } | { marker: string; destination: string; stub: string; advisory: { readonly id: "ACK-ADMIN-AUTHORIZATION-2026-01"; readonly severity: "high"; readonly summary: "Derive resource channels on the server and enforce authorized channel constraints on admin listings."; }; } | { marker: string; destination: string; stub: string; advisory: { readonly id: "ACK-ADMIN-RATE-LIMIT-2026-01"; readonly severity: "moderate"; readonly summary: "Isolate pre-authentication budgets and use injectable shared stores to prevent admin lockout and multi-instance limit bypass."; }; })[]; }loadAdminUpgradeArtifacts
Function
() => Promise<{ marker: string; destination: string; source: string; advisory?: { readonly id: "ACK-ADMIN-AUTHORIZATION-2026-01"; readonly severity: "high"; readonly summary: "Derive resource channels on the server and enforce authorized channel constraints on admin listings."; } | { readonly id: "ACK-ADMIN-RATE-LIMIT-2026-01"; readonly severity: "moderate"; readonly summary: "Isolate pre-authentication budgets and use injectable shared stores to prevent admin lockout and multi-instance limit bypass."; } | undefined; }[]>@adocommercekit/biteship
applyBiteshipWebhookEvent
Function
(event: ExternalEventInput, fulfillment: FulfillmentService, models: ModelRegistry, options?: MutationOptions) => Promise<void>biteship
Function
(options: BiteshipOptions) => () => Promise<BiteshipProvider>BITESHIP_API_BASE_URL
Value
"https://api.biteship.com/v1"BITESHIP_API_VERSION
Value
"v1"BiteshipOptions
Interface
BiteshipOptionsPublic members
apiKey:stringorigin:BiteshipOrigincouriers:string[]baseUrl:string | undefinedquoteTtlSeconds:number | undefinedcacheTtlSeconds:number | undefinedcacheMaxEntries:number | undefinedtimeoutMs:number | undefinedtimeoutBehavior:"block" | "fallback" | undefinedfallbackQuotes:((request: ShippingQuoteRequest, error: unknown) => Promise<ShippingQuoteDraft[]>) | undefinedresolveArea:((address: AddressInput) => Promise<string>) | undefineddefaultService:string | undefinedwebhookVerifier:((body: Buffer, signature: string) => boolean) | undefinedwebhookSecret:string | undefinedpreparationStore:BiteshipPreparationStore | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
BiteshipOrigin
Interface
BiteshipOriginPublic members
areaId:stringpostalCode:string | undefinedaddress:stringcontactName:stringcontactPhone:stringcontactEmail:string | undefined
BiteshipPreparationClaim
Type
BiteshipPreparationClaimbiteshipPreparationStore
Function
Resolve Adonis services lazily, so this can safely be used from a config module.
(table?: string) => BiteshipPreparationStoreBiteshipPreparationStore
Interface
BiteshipPreparationStorePublic members
claim:(reference: string) => Promise<BiteshipPreparationClaim>complete:(reference: string, response: Record<string, unknown>) => Promise<void>markUncertain:(reference: string) => Promise<void>
BiteshipProvider
Class
BiteshipProviderPublic members
code:"biteship"#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }#baseUrl:string#cache:Map<string, CachedQuotes>#preparing:Map<string, any>options:BiteshipOptionscapabilities:() => { readonly rates: true; readonly waybill: true; readonly tracking: true; readonly insurance: true; readonly cod: true; readonly returnTracking: true; }quote:(input: ShippingQuoteRequest) => Promise<ShippingQuoteDraft[]>prepare:(input: Parameters<FulfillmentProvider["prepare"]>[0]) => ReturnType<FulfillmentProvider["prepare"]>#prepare:(input: Parameters<FulfillmentProvider["prepare"]>[0]) => Promise<{ providerShipmentId: string; waybill: string; trackingNumber: string; carrier: string | undefined; raw: { id: string; status: any; }; }>status:(providerShipmentId: string) => Promise<{ status: any; occurredAt: DateTime<true> | DateTime<false> | undefined; raw: { id: any; status: any; }; }>normalizeTrackingWebhook:(body: Buffer, signature?: string) => BiteshipWebhookEventingestTrackingWebhook:(body: Buffer, signature: string | undefined, inbox: ExternalEventInboxService, handler: Parameters<ExternalEventInboxService["process"]>[1]) => Promise<{ duplicate: boolean; processed: boolean; }>#destinationArea:(address: AddressInput | null) => Promise<string>#quoteKey:(input: ShippingQuoteRequest, destination: string) => string#request:(path: string, init: RequestInit) => Promise<Record<string, any>>
BiteshipRequestError
Class
BiteshipRequestErrorPublic members
code:"BITESHIP_REQUEST_FAILED"status:number | undefinedname:stringmessage:stringstack:string | undefinedcause:unknown
BiteshipWebhookEvent
Interface
BiteshipWebhookEventPublic members
providerShipmentId:stringtype:"order.status" | "order.price" | "order.waybill_id" | "unhandled"status:anyoccurredAt:DateTime<boolean> | undefinedraw:Record<string, unknown>
configure
Function
(command: Configure) => Promise<void>DatabaseBiteshipPreparationStore
Class
Persist before contacting the provider: an uncertain create must never be re-posted.
DatabaseBiteshipPreparationStorePublic members
db:Databasetable:stringclaim:(reference: string) => Promise<BiteshipPreparationClaim>complete:(reference: string, response: Record<string, unknown>) => Promise<void>markUncertain:(reference: string) => Promise<void>resolve:(reference: string, response: Record<string, unknown>) => Promise<void>confirmNotCreated:(reference: string) => Promise<void>
enMessages
Value
Record<"biteship.quote.unavailable" | "biteship.tracking.returned", string>idIDMessages
Value
{ readonly "biteship.quote.unavailable": "Tarif pengiriman Biteship tidak tersedia"; readonly "biteship.tracking.returned": "Paket dikembalikan oleh kurir"; }@adocommercekit/biteship/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/biteship/upgrade
biteshipUpgradeManifest
Value
{ packageName: string; version: string; artifacts: { marker: string; destination: string; stub: string; }[]; }loadBiteshipUpgradeArtifacts
Function
(_root?: string) => Promise<UpgradeArtifact[]>@adocommercekit/core
ADMIN_LIST_DEFAULT_LIMIT
Value
25ADMIN_LIST_MAX_LIMIT
Value
100ADMIN_TOTAL_CEILING
Value
Row ceiling for the total probe. Beyond it an admin list reports total: null and the UI renders “1–25 of many” — an exact count past a thousand rows
is not information a human acts on, and an unbounded COUNT(*) over the 100k
rehearsal dataset blows the §3.3 budget.
1000AdminCursor
Interface
The decoded keyset position: the sort key of the last row of the previous page plus its id, which breaks ties deterministically.
AdminCursorPublic members
key:stringid:string
AdminCursorContext
Interface
AdminCursorContextPublic members
sort:stringdirection:AdminSortDirection
AdminKeysetWindow
Interface
AdminKeysetWindowPublic members
column:stringvalue:string | number | bigintidColumn:stringid:stringdirection:AdminSortDirection
AdminListPage
Interface
One page of an admin list query (ASPEC §3.3).
nextCursor is null on the last page. total is null whenever the
filtered count is not obtainable from a single indexed COUNT(*); the UI
renders “1–25 of many” in that case.
AdminListPage<T>Public members
items:T[]nextCursor:string | nulltotal:number | null
AdminSortDirection
Type
AdminSortDirectionboundedAdminTotal
Function
Turns a bounded primary-key probe into a total. Callers select at most
ADMIN_TOTAL_CEILING + 1 keys; overflowing the ceiling means “many”.
(probe: readonly unknown[]) => number | nullCartNotActiveException
Class
CartNotActiveExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CartPricesChangedException
Class
CartPricesChangedExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
clampAdminLimit
Function
Clamps a caller-supplied page size into [1, 100], defaulting to 25.
(limit?: number) => numberCOMMERCE_CAPABILITIES
Value
{ readonly deferredPayments: "payments.deferred.v1"; readonly cashOnDelivery: "payments.cod.v1"; readonly dynamicShippingQuotes: "shipping.dynamic_quotes.v1"; readonly fulfillmentProviders: "fulfillment.providers.v1"; }COMMERCE_ERROR_STATUSES
Value
Readonly<Partial<Record<`E_${Uppercase<string>}`, number | "varies">>>CommerceCapability
Type
CommerceCapabilityCommerceCapabilityRegistry
Class
Runtime capability lookup for independently installed commerce packages.
CommerceCapabilityRegistryPublic members
#capabilities:ReadonlySet<string>supports:(capability: string) => booleanrequire:(capability: string) => voidlist:() => readonly string[]
CommerceConfigException
Class
CommerceConfigExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CommerceConfigInput
Interface
CommerceConfigInputPublic members
tablePrefix:string | undefinedchannels:{ default: string; }currencies:{ supported: CurrencyCode[]; default: CurrencyCode; exponents?: Partial<Record<CurrencyCode, 0 | 2 | 3>>; rounding?: Rounding; }customers:{ userModel: LazyImport<unknown> | null; userForeignKey?: string; }carts:{ tokenStrategy?: DriverFactory; abandonedAfterMinutes?: number; guardMaxLineQuantity?: number; }pricing:{ resolver?: DriverFactory; taxInclusivePricing?: boolean; }search:{ driver?: DriverFactory<SearchDriver>; } | undefinedimages:{ storage?: DriverFactory<ProductImageStorage>; maxBytes?: number; maxPerProduct?: number; } | undefinedinventory:{ reservationTtlMinutes?: number; backorderPolicy?: "deny" | "allow" | "per_item"; allocation?: DriverFactory; }payments:{ default: string; methods: Record<string, DriverFactory>; captureMode?: "automatic" | "manual"; deferred?: { inventoryPolicy?: "reserve" | "commit"; }; codFee?: { amount: bigint | number | string; currency: string; label?: string; }; }shipping:{ calculators: Record<string, DriverFactory>; eligibility?: DriverFactory; quoteProviders?: Record<string, DriverFactory>; selectionSecret?: string; }fulfillment:{ providers?: Record<string, DriverFactory>; } | undefinedtaxes:{ calculator?: DriverFactory; addressResolver?: DriverFactory<TaxAddressResolver>; }orders:{ numberGenerator?: DriverFactory; autoConfirm?: boolean; }models:Partial<ModelRegistryOverrides> | undefinedevents:{ outbox?: { enabled: boolean; drainBatchSize?: number; }; } | undefinedwebhooks:{ requestTimeoutMs?: number; allowedHosts?: string[]; allowLocalhost?: boolean; } | undefinedjobs:{ dispatcher?: "queue" | "inline"; } | undefined
CommerceErrorCode
Type
Extension packages may define their own E_* codes by subclassing
CommerceException; the core codes stay enumerable through
CoreCommerceErrorCode.
`E_${Uppercase<string>}`CommerceErrorDetails
Type
Readonly<Record<string, unknown>>CommerceException
Class
CommerceExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CommerceForbiddenException
Class
Raised at the HTTP/Inertia boundary when the actor lacks the ability an admin endpoint declares. The ability name travels in the payload on purpose: it is frozen catalog vocabulary (ASPEC §3.2), not a secret, and the panel needs it to explain the denial.
CommerceForbiddenExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CommerceManager
Class
CommerceManagerPublic members
#factoryCache:WeakMap<DriverFactory, Promise<unknown>>#drivers:ResolvedCommerceDrivers | undefined#bootPromise:Promise<ResolvedCommerceDrivers> | undefinedcapabilities:CommerceCapabilityRegistryapp:ApplicationServiceconfig:ResolvedCommerceConfigisBooted:booleandrivers:ResolvedCommerceDrivers#resolve:(factory: DriverFactory) => Promise<unknown>boot:(options: { queueAvailable: boolean; }) => Promise<ResolvedCommerceDrivers>#resolveAll:(options: { queueAvailable: boolean; }) => Promise<ResolvedCommerceDrivers>shutdown:() => Promise<void>
CommerceNotFoundException
Class
CommerceNotFoundExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CompensationError
Interface
CompensationErrorPublic members
step:stringerror:unknown
configure
Function
(command: Configure) => Promise<void>configureMoney
Function
(options: { exponents?: Readonly<Partial<Record<string, 0 | 2 | 3>>>; rounding?: Rounding; }) => voidCoreCommerceErrorCode
Type
CoreCommerceErrorCodeCurrencyCode
Type
stringcurrencyExponent
Function
(currency: CurrencyCode) => 0 | 2 | 3CurrencyMismatchException
Class
CurrencyMismatchExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
decodeAdminCursor
Function
Rejects malformed cursors and cursors from a different sort window.
(cursor: string | undefined | null, context: AdminCursorContext) => AdminCursor | nulldefineConfig
Function
Normalize configuration without resolving imports or driver factories.
(input: CommerceConfigInput) => ResolvedCommerceConfigdefineStateMachine
Function
<S extends string, T extends string>(definition: { name: string; states: readonly S[]; initial: S; transitions: Record<T, { from: S | S[]; to: S; }>; }) => StateMachineDefinition<S, T>DriverFactory
Type
DriverFactory<T>encodeAdminCursor
Function
(cursor: AdminCursor, context: AdminCursorContext) => stringescapeLike
Function
(value: string) => stringIdempotencyConflictException
Class
IdempotencyConflictExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
InsufficientStockException
Class
InsufficientStockExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
InvalidCommerceInputException
Class
InvalidCommerceInputExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
InvalidCursorException
Class
InvalidCursorExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
keysetWindow
Function
Builds the WHERE fragment that resumes a keyset scan after window.
(sort, id) > (value, id) is expanded to sort > value OR (sort = value AND id > id) so the composite index on (sort, id) is usable on every dialect —
row-value comparison is PostgreSQL-only.
(window: AdminKeysetWindow) => (builder: ChainableContract) => voidLineQuantityException
Class
LineQuantityExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
LucidStateMachinePersistence
Class
LucidStateMachinePersistence<S, T, Trx>Public members
#stateColumn:string#auditTable:string#subjectType:stringdatabase:StateMachineDatabase<Trx>subjectTable:stringbuffer:(name: string, payload: Readonly<Record<string, unknown>>, trx: Trx) => void | Promise<void>transaction:<R>(callback: (trx: Trx) => Promise<R>) => Promise<R>conditionalUpdate:(subjectId: string, from: S, to: S, trx: Trx) => Promise<boolean>insertAudit:(audit: StateTransitionAudit<S, T>, trx: Trx) => Promise<void>bufferEvent:(name: string, payload: Readonly<Record<string, unknown>>, trx: Trx) => void | Promise<void>
ModelRegistryOverrides
Interface
ModelRegistryOverridesPublic members
channel:LazyImport<unknown>product:LazyImport<unknown>productImage:LazyImport<unknown>productOption:LazyImport<unknown>productOptionValue:LazyImport<unknown>productVariant:LazyImport<unknown>category:LazyImport<unknown>priceList:LazyImport<unknown>price:LazyImport<unknown>customerGroup:LazyImport<unknown>customer:LazyImport<unknown>address:LazyImport<unknown>cart:LazyImport<unknown>cartLine:LazyImport<unknown>cartAdjustment:LazyImport<unknown>shippingMethod:LazyImport<unknown>taxZone:LazyImport<unknown>taxRate:LazyImport<unknown>taxCategory:LazyImport<unknown>order:LazyImport<unknown>orderLine:LazyImport<unknown>paymentIntent:LazyImport<unknown>payment:LazyImport<unknown>paymentInstruction:LazyImport<unknown>shipment:LazyImport<unknown>stockLocation:LazyImport<unknown>inventoryItem:LazyImport<unknown>inventoryLevel:LazyImport<unknown>reservation:LazyImport<unknown>inventoryMovement:LazyImport<unknown>inventoryTransfer:LazyImport<unknown>orderAdjustment:LazyImport<unknown>shipmentLine:LazyImport<unknown>refund:LazyImport<unknown>capture:LazyImport<unknown>paymentCustomer:LazyImport<unknown>paymentMethod:LazyImport<unknown>webhookEvent:LazyImport<unknown>paymentOperation:LazyImport<unknown>idempotencyKey:LazyImport<unknown>eventOutbox:LazyImport<unknown>webhookDestination:LazyImport<unknown>webhookDelivery:LazyImport<unknown>mediaAsset:LazyImport<unknown>returnReason:LazyImport<unknown>returnRequest:LazyImport<unknown>returnLine:LazyImport<unknown>
Money
Class
MoneyPublic members
amount:bigintcurrency:stringassertCurrency:(other: Money) => voidadd:(other: Money) => Moneysubtract:(other: Money) => Moneymultiply:(factor: number | bigint, rounding?: Rounding) => Moneypercentage:(basisPoints: number, rounding?: Rounding) => Moneynegate:() => Moneyallocate:(ratios: number[]) => Money[]split:(parts: number) => Money[]isZero:() => booleanisNegative:() => booleanequals:(other: Money) => booleancompare:(other: Money) => -1 | 0 | 1toDecimal:() => stringtoJSON:() => { amount: string; currency: CurrencyCode; }
moneyColumn
Function
Maps one Money property to a <prefix>_amount BIGINT and
<prefix>_currency CHAR(3) column pair.
(options?: { columnPrefix?: string; }) => PropertyDecoratornormalizeDateCursorKey
Function
Normalize date keysets to the database representation on every dialect.
(key: string) => stringpaginateAdminRows
Function
Slices one extra row off the end of an over-fetched result set and turns it
into the next cursor. Callers request limit + 1 rows.
<T>(rows: T[], limit: number, cursorOf: (row: T) => AdminCursor, context: AdminCursorContext) => { items: T[]; nextCursor: string | null; }PaymentDeclineCode
Type
PaymentDeclineCodePaymentDeclinedException
Class
PaymentDeclinedExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PaymentIntentMismatchException
Class
PaymentIntentMismatchExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PaymentProviderException
Class
PaymentProviderExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PriceNotFoundException
Class
PriceNotFoundExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
ProductInUseException
Class
ProductInUseExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PromotionNotApplicableException
Class
PromotionNotApplicableExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
renderCommerceException
Function
(error: CommerceException) => { error: { details?: Readonly<Record<string, unknown>> | undefined; code: `E_${Uppercase<string>}`; message: string; }; }ResolvedCommerceConfig
Interface
ResolvedCommerceConfigPublic members
tablePrefix:stringchannels:{ default: string; }currencies:{ supported: CurrencyCode[]; default: CurrencyCode; exponents: Readonly<Partial<Record<CurrencyCode, 0 | 2 | 3>>>; rounding: Rounding; }customers:{ userModel: LazyImport<unknown> | null; userForeignKey: string; }carts:{ tokenStrategy: DriverFactory; abandonedAfterMinutes: number; guardMaxLineQuantity: number; }pricing:{ resolver: DriverFactory; taxInclusivePricing: boolean; }search:{ driver?: DriverFactory<SearchDriver>; }images:{ storage?: DriverFactory<ProductImageStorage>; maxBytes: number; maxPerProduct: number; }inventory:{ reservationTtlMinutes: number; backorderPolicy: "deny" | "allow" | "per_item"; allocation?: DriverFactory; }payments:{ default: string; methods: Readonly<Record<string, DriverFactory>>; captureMode: "automatic" | "manual"; deferred: { inventoryPolicy: "reserve" | "commit"; }; codFee?: { amount: bigint | number | string; currency: string; label: string; }; }shipping:{ calculators: Readonly<Record<string, DriverFactory>>; eligibility?: DriverFactory; quoteProviders: Readonly<Record<string, DriverFactory>>; selectionSecret?: string; }fulfillment:{ providers: Readonly<Record<string, DriverFactory>>; }taxes:{ calculator: DriverFactory; addressResolver?: DriverFactory<TaxAddressResolver>; }orders:{ numberGenerator?: DriverFactory; autoConfirm: boolean; }models:Readonly<Partial<ModelRegistryOverrides>>events:{ outbox: { enabled: boolean; drainBatchSize: number; }; }webhooks:{ requestTimeoutMs: number; allowedHosts: readonly string[]; allowLocalhost: boolean; }jobs:{ dispatcher: "queue" | "inline"; automatic: boolean; }
ResourceConflictException
Class
ResourceConflictExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
ReturnNotAllowedException
Class
ReturnNotAllowedExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
Rounding
Type
RoundingShippingNotEligibleException
Class
ShippingNotEligibleExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
sqlDateTime
Function
(value: DateTime) => stringStateMachineRunner
Class
StateMachineRunner<S, T, Trx>Public members
#guards:Map<T, TransitionGuard<S, T, Trx>[]>#beforeHooks:Map<T, TransitionHook<S, T, Trx>[]>#afterHooks:Map<T, TransitionHook<S, T, Trx>[]>definition:StateMachineDefinition<S, T>persistence:StateMachinePersistence<S, T, Trx>can:(subject: Stateful<S>, transition: T) => booleanregisterGuard:(transition: T, guard: TransitionGuard<S, T, Trx>) => voidregisterHook:(transition: T, hook: "before" | "after", handler: TransitionHook<S, T, Trx>) => voidapply:(subject: Stateful<S>, transition: T, context?: TransitionContext, options?: { trx?: Trx; actor?: string | undefined; }) => Promise<void>
StateTransitionException
Class
StateTransitionExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
stubsRoot
Value
Path to the root directory where the stubs are stored. We use this path within commands and the configure hook
stringvalidateCommerceConfig
Function
(config: ResolvedCommerceConfig, options: { queueAvailable: boolean; }) => voidWebhookSignatureException
Class
WebhookSignatureExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
Workflow
Class
Workflow<C>Public members
#steps:WorkflowStep<C>[]name:stringtransactionRunner:WorkflowTransactionRunner<C> | undefinedlogger:WorkflowLoggersteps:readonly WorkflowStep<C>[]insertBefore:(step: string, newStep: WorkflowStep<C>) => Workflow<C>insertAfter:(step: string, newStep: WorkflowStep<C>) => Workflow<C>replace:(step: string, newStep: WorkflowStep<C>) => Workflow<C>remove:(step: string) => Workflow<C>run:(context: C) => Promise<void>#contextRunner:(context: C) => WorkflowTransactionRunner<C>#index:(name: string) => number#assertUniqueNames:() => void
WorkflowFailedException
Class
WorkflowFailedExceptionPublic members
compensationErrors:readonly CompensationError[]code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
@adocommercekit/core/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/core/commerce_provider
default
Class
CommerceProviderPublic members
app:ApplicationServiceregister:() => voidboot:() => Promise<void>start:() => Promise<void>shutdown:() => Promise<void>
@adocommercekit/core/commands
getCommand
Function
(metaData: { commandName: string; }) => Promise<typeof CommerceSeedDemo | null>getMetaData
Function
() => Promise<({ commandName: string; description: string; help: string; namespace: string; aliases: never[]; flags: ({ name: string; flagName: string; required: boolean; type: string; description: string; default: number; } | { name: string; flagName: string; required: boolean; type: string; description: string; default?: undefined; })[]; args: never[]; options: { startApp: boolean; }; filePath: string; } | { commandName: string; description: string; help: string; namespace: string; aliases: never[]; flags: { name: string; flagName: string; required: boolean; type: string; description: string; }[]; args: { name: string; required: boolean; type: string; description: string; }[]; options: { startApp: boolean; }; filePath: string; })[]>@adocommercekit/core/services/main
AdminCheckoutFunnelStage
Type
AdminCheckoutFunnelStageAdminCheckoutStage
Type
AdminCheckoutStageAdminCustomerFilter
Interface
AdminCustomerFilterPublic members
channelIds:readonly string[] | undefinedsearch:string | undefinedgroupId:string | undefinedsort:AdminCustomerSort | undefineddirection:AdminSortDirection | undefinedcursor:string | undefinedlimit:number | undefined
AdminCustomerSort
Type
AdminCustomerSortAdminInventoryLevelFilter
Interface
AdminInventoryLevelFilterPublic members
locationId:string | undefinedsearch:string | undefinedchannelIds:readonly string[] | undefinedbelowReorderPoint:boolean | undefinedsort:AdminInventoryLevelSort | undefineddirection:AdminSortDirection | undefinedcursor:string | undefinedlimit:number | undefined
AdminInventoryLevelSort
Type
AdminInventoryLevelSortAdminLowStockLevel
Type
AdminLowStockLevelAdminMetricsInterval
Type
AdminMetricsIntervalAdminMetricsPeriod
Type
The dashboard result shapes are declared as type aliases rather than interfaces
on purpose. TypeScript gives an object type alias an implicit index signature
but never an interface, so only an alias is assignable to the JSON-serializable
constraint inertia.defer() places on a deferred prop. These values are pure
JSON by construction, and the declaration should say so.
AdminMetricsPeriodAdminMetricsRange
Interface
AdminMetricsRangePublic members
channelId:string | undefinedchannelIds:readonly string[] | undefinedlocationId:string | undefinedcurrency:stringfrom:DateTime<boolean>to:DateTime<boolean>
AdminMetricsService
Class
Read-only dashboard aggregates (ASPEC §3.4).
Every method is scoped to exactly one currency: the dashboard renders one currency at a time and there is no cross-currency aggregation, mirroring the ledger’s integrity rule. Money crosses the wire as stringified minor units so no precision is lost.
Revenue is derived from the payment ledger (captures minus succeeded refunds), never from order totals, so the dashboard reconciles with the ledger exports to the cent.
AdminMetricsServicePublic members
db:Databaseconfig:ResolvedCommerceConfigdialect:"postgres" | "mysql" | "sqlite"table:(suffix: string) => stringtimestamp:(value: DateTime) => string | Knex.Raw<any>bucketSql:(column: string, interval: AdminMetricsInterval) => stringbucketKeys:(range: AdminMetricsRange, interval: AdminMetricsInterval) => string[]capturedPayments:(range: AdminMetricsRange) => DatabaseQueryBuilderContract<any>succeededRefunds:(range: AdminMetricsRange) => DatabaseQueryBuilderContract<any>placedOrders:(range: AdminMetricsRange) => DatabaseQueryBuilderContract<any>summary:(range: AdminMetricsRange) => Promise<AdminMetricsSummary>period:(ordersPlaced: number, grossRevenue: string, refundTotal: string, activeCarts: number, capturedOrders: number) => AdminMetricsPeriodrevenueSeries:(interval: AdminMetricsInterval, range: AdminMetricsRange) => Promise<AdminRevenueBucket[]>ordersByStatus:(range: AdminMetricsRange) => Promise<AdminOrdersByStatus[]>topProducts:(range: AdminMetricsRange, limit?: number) => Promise<AdminTopProduct[]>paymentMethodMix:(range: AdminMetricsRange) => Promise<AdminPaymentMethodSlice[]>checkoutFunnel:(range: AdminMetricsRange) => Promise<AdminCheckoutFunnelStage[]>lowStock:(range: AdminMetricsRange, limit?: number) => Promise<AdminLowStockLevel[]>
AdminMetricsSummary
Type
AdminMetricsSummaryAdminOrderFilter
Interface
AdminOrderFilterPublic members
status:OrderState[] | undefinedchannelId:string | undefinedchannelIds:readonly string[] | undefinedcustomerId:string | undefinednumberPrefix:string | undefinedemail:string | undefinedplacedAfter:DateTime<boolean> | undefinedplacedBefore:DateTime<boolean> | undefinedsort:AdminOrderSort | undefineddirection:AdminSortDirection | undefinedcursor:string | undefinedlimit:number | undefined
AdminOrdersByStatus
Type
AdminOrdersByStatusAdminOrderSort
Type
AdminOrderSortAdminPaymentFilter
Interface
AdminPaymentFilterPublic members
state:PaymentState[] | undefinedprovider:string | undefinedorderId:string | undefinedchannelIds:readonly string[] | undefinedsort:AdminPaymentSort | undefineddirection:AdminSortDirection | undefinedcursor:string | undefinedlimit:number | undefined
AdminPaymentMethodSlice
Type
AdminPaymentMethodSliceAdminPaymentSort
Type
AdminPaymentSortAdminProductFilter
Interface
AdminProductFilterPublic members
status:ProductStatus[] | undefinedchannelIds:readonly string[] | undefinedcategoryId:string | undefinedsearch:string | undefinedsort:AdminProductSort | undefineddirection:AdminSortDirection | undefinedcursor:string | undefinedlimit:number | undefined
AdminProductSort
Type
AdminProductSortAdminRevenueBucket
Type
AdminRevenueBucketAdminTopProduct
Type
AdminTopProductAdminWebhookDelivery
Type
AdminWebhookDeliveryAdminWebhookDestination
Interface
AdminWebhookDestinationPublic members
id:stringname:stringurl:stringactive:booleansubscriptions:string[]headers:Record<string, string> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>
cartesianProduct
Function
<T>(axes: readonly (readonly T[])[]) => T[][]CartService
Class
CartServicePublic members
#processors:CartProcessor[]db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigtokenStrategy:CartTokenStrategypriceResolver:PriceResolverevents:TransactionalEventEmitter | undefinedregisterProcessor:(processor: CartProcessor) => voidcheckoutCompleted:(cart: Cart, order: import("../models/order.js").Order, trx: TransactionClientContract) => Promise<void>findOrCreateFromContext:(ctx: HttpContext) => Promise<Cart>create:(input: { channelId: string; currency: string; token?: string; }, options?: MutationOptions) => Promise<Cart>findByToken:(token: string) => Promise<Cart | null>addLine:(cart: Cart, input: { variantId: string; quantity: number; }, options?: MutationOptions) => Promise<Cart>updateLineQuantity:(cart: Cart, lineId: string, quantity: number, options?: MutationOptions) => Promise<Cart>removeLine:(cart: Cart, lineId: string, options?: MutationOptions) => Promise<Cart>setEmail:(cart: Cart, email: string, options?: MutationOptions) => Promise<Cart>setAddresses:(cart: Cart, input: { shipping?: AddressInput; billing?: AddressInput; }, options?: MutationOptions) => Promise<Cart>setShippingMethod:(cart: Cart, methodId: string, options?: MutationOptions) => Promise<Cart>assignCustomer:(cart: Cart, customerId: string, options?: MutationOptions) => Promise<Cart>mergeCarts:(target: Cart, source: Cart, options?: MutationOptions) => Promise<Cart>recalculate:(cart: Cart, options?: MutationOptions) => Promise<Cart>totals:(cart: Cart) => CartTotalsupdateCart:(cart: Cart, values: Partial<Cart>, options?: MutationOptions) => Promise<Cart>lockActiveCart:(id: string, trx: TransactionClientContract) => Promise<Cart>channelContext:(cart: Cart, trx: TransactionClientContract) => Promise<ChannelContext>load:(id: string, trx?: TransactionClientContract) => Promise<Cart>assertQuantity:(quantity: number) => void
cartSnapshot
Function
(cart: Parameters<CartProcessor["process"]>[0], ctx: RecalculationContext) => CartSnapshotCatalogService
Class
CatalogServicePublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigproductImages:ProductImageServiceevents:TransactionalEventEmitter | undefinedsearch:SearchService | undefinedlistProducts:(filter?: AdminProductFilter) => Promise<AdminListPage<Product>>createProduct:(data: CreateProductInput, options?: MutationOptions) => Promise<Product>updateProduct:(id: string, data: UpdateProductInput, options?: MutationOptions) => Promise<Product>bulkUpdateProductStatus:(ids: string[], status: ProductStatus, options?: MutationOptions) => Promise<Product[]>archiveProduct:(id: string, options?: MutationOptions) => Promise<Product>deleteProduct:(id: string, options?: MutationOptions) => Promise<void>addOption:(productId: string, input: { name: string; values: string[]; }, options?: MutationOptions) => Promise<ProductOption>generateVariants:(productId: string, options?: MutationOptions) => Promise<ProductVariant[]>createCategory:(data: { name: string; slug: string; parentId?: string | null; position?: number; }, options?: MutationOptions) => Promise<Category>categoryDescendants:(categoryId: string) => Promise<Category[]>listCategories:() => Promise<Category[]>updateCategory:(id: string, data: { name?: string; slug?: string; parentId?: string | null; position?: number; }, options?: MutationOptions) => Promise<Category>deleteCategory:(id: string, options?: MutationOptions) => Promise<void>syncProductCategories:(productId: string, categoryIds: readonly string[], options?: MutationOptions) => Promise<void>assignCategory:(productId: string, categoryId: string, options?: MutationOptions) => Promise<void>findBySlug:(slug: string, ctx: ChannelContext) => Promise<Product | null>
ChannelService
Class
ChannelServicePublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigevents:TransactionalEventEmitter | undefinedcreate:(data: CreateChannelInput, options?: MutationOptions) => Promise<Channel>findByCode:(code: string) => Promise<Channel | null>list:() => Promise<Channel[]>resolve:(channelCode?: string, currency?: string) => Promise<ChannelContext>bootstrapDefault:(options?: MutationOptions) => Promise<Channel>
chargeableWeight
Function
(parcel: Parcel, volumetricDivisor?: number) => numberCheckoutService
Class
CheckoutServicePublic members
registry:ModelRegistryworkflow:PlaceOrderWorkflowidempotency:IdempotencyServiceinventory:InventoryServicepayments:PaymentServiceplace:(cart: Cart, input: PlaceOrderInput) => Promise<Order>reconcileStuck:(before?: DateTime<true>) => Promise<number>loadOrder:(id: string) => Promise<Order>
CommerceManager
Class
CommerceManagerPublic members
#factoryCache:WeakMap<DriverFactory, Promise<unknown>>#drivers:ResolvedCommerceDrivers | undefined#bootPromise:Promise<ResolvedCommerceDrivers> | undefinedcapabilities:CommerceCapabilityRegistryapp:ApplicationServiceconfig:ResolvedCommerceConfigisBooted:booleandrivers:ResolvedCommerceDrivers#resolve:(factory: DriverFactory) => Promise<unknown>boot:(options: { queueAvailable: boolean; }) => Promise<ResolvedCommerceDrivers>#resolveAll:(options: { queueAvailable: boolean; }) => Promise<ResolvedCommerceDrivers>shutdown:() => Promise<void>
CreateChannelInput
Interface
CreateChannelInputPublic members
code:stringname:stringdefaultCurrency:stringsupportedCurrencies:string[]isDefault:boolean | undefinedmetadata:Record<string, unknown> | undefined
CreateCustomerInput
Interface
CreateCustomerInputPublic members
email:string | null | undefinedfirstName:string | undefinedlastName:string | undefinedphone:string | undefineduserId:string | undefinedgroupId:string | undefinedmetadata:Record<string, unknown> | undefined
CustomerExportAuthorizationError
Class
CustomerExportAuthorizationErrorPublic members
code:"CUSTOMER_EXPORT_UNAUTHORIZED"name:stringmessage:stringstack:string | undefinedcause:unknown
CustomerPortabilityExport
Interface
CustomerPortabilityExportPublic members
schemaVersion:"commerce.customer-export.v1"exportedAt:stringcustomer:{ id: string; email: string | null; firstName: string | null; lastName: string | null; phone: string | null; metadata: Record<string, unknown> | null; createdAt: string; }addresses:{ firstName: string; lastName: string; company: string | null; line1: string; line2: string | null; city: string; region: string | null; postalCode: string | null; countryCode: string; phone: string | null; metadata: Record<string, unknown> | null; }[]orders:{ number: string; state: string; currency: string; email: string; shippingAddress: AddressInput; billingAddress: AddressInput; totals: { subtotal: string; shipping: string; tax: string; discount: string; grand: string; }; placedAt: string; lines: Array<{ productName: string; variantName: string | null; sku: string | null; quantity: number; unitPrice: string; fulfilledQuantity: number; refundedQuantity: number; }>; adjustments: Array<{ sourceType: string; label: string; amount: string; included: boolean; metadata: Record<string, unknown> | null; }>; shipments: Array<{ state: string; carrier: string | null; trackingNumber: string | null; }>; }[]
CustomerService
Class
CustomerServicePublic members
db:Databaseregistry:ModelRegistryevents:TransactionalEventEmitter | undefinedlist:(filter?: AdminCustomerFilter) => Promise<AdminListPage<Customer>>create:(data: CreateCustomerInput, options?: MutationOptions) => Promise<Customer>updateProfile:(customerId: string, data: { email?: string | null; firstName?: string | null; lastName?: string | null; phone?: string | null; }, options?: MutationOptions) => Promise<Customer>createGroup:(data: { code: string; name: string; }, options?: MutationOptions) => Promise<CustomerGroup>addAddress:(customerId: string, data: AddressInput & { isDefaultShipping?: boolean; isDefaultBilling?: boolean; }, options?: MutationOptions) => Promise<Address>updateAddress:(customerId: string, addressId: string, data: Partial<AddressInput & { isDefaultShipping: boolean; isDefaultBilling: boolean; }>, options?: MutationOptions) => Promise<Address>deleteAddress:(customerId: string, addressId: string, options?: MutationOptions) => Promise<void>findByUserId:(userId: string) => Promise<Customer | null>export:(customerId: string, authorize: (customer: Customer) => boolean | Promise<boolean>) => Promise<CustomerPortabilityExport>lastActivityAt:(customerIds: string[]) => Promise<Map<string, DateTime | null>>rethrowEmailConflict:(error: unknown) => neveranonymize:(customerId: string, options?: MutationOptions) => Promise<Customer>
EncryptionPort
Interface
EncryptionPortPublic members
encrypt:(value: unknown) => string | Promise<string>decrypt:((value: string) => unknown | Promise<unknown>) | undefined
EventOutboxService
Class
EventOutboxServicePublic members
#consumers:Map<string, OutboxConsumer>db:Databasetable:stringbatchSize:numberregisterConsumer:(name: string, consumer: OutboxConsumer) => () => voidwrite:(name: string, payload: unknown, transaction: TransactionHookClient) => Promise<void>drain:(now?: DateTime<true>) => Promise<{ sent: number; failed: number; }>replay:(id: string, options?: MutationOptions) => Promise<boolean>deadLetters:(input?: { cursor?: string; limit?: number; }) => Promise<{ items: Array<Record<string, unknown>>; nextCursor: string | null; }>affected:(result: unknown) => numbererrorMessage:(error: unknown) => string
ExternalEventInboxService
Class
ExternalEventInboxServicePublic members
db:Databasetable:stringingest:(input: ExternalEventInput) => Promise<{ id: string; duplicate: boolean; }>process:(id: string, handler: (event: ExternalEventInput, trx: TransactionClientContract) => Promise<void>) => Promise<boolean>isUniqueViolation:(error: unknown) => booleanerrorMessage:(error: unknown) => string
ExternalEventInput
Interface
ExternalEventInputPublic members
source:stringeventId:stringtype:stringpayload:unknownoccurredAt:DateTime<boolean> | null | undefined
FulfillmentService
Class
FulfillmentServicePublic members
db:Databaseregistry:ModelRegistryproviders:Readonly<Record<string, FulfillmentProvider>>inventory:InventoryServiceorders:OrderServiceevents:TransactionalEventEmitter | undefinedcancel:(shipment: Shipment, input?: { reason?: string; }, options?: MutationOptions) => Promise<Shipment>applyTrackingEvent:(input: { provider: string; providerShipmentId: string; status: FulfillmentStatus | "canceled" | "on_hold"; occurredAt?: DateTime; raw?: unknown; }, options?: MutationOptions) => Promise<Shipment>markReturnedToSender:(shipment: Shipment, input: { reference: string; }, options?: MutationOptions) => Promise<Shipment>create:(order: Order, lines: Array<{ orderLineId: string; quantity: number; }>, options?: MutationOptions) => Promise<Shipment>prepare:(shipment: Shipment, providerCode: string, input?: { service?: string; insurance?: { amount: Money; }; idempotencyKey?: string; }) => Promise<Shipment>handoff:(shipment: Shipment, options?: MutationOptions) => Promise<Shipment>recordStatus:(shipment: Shipment, state: "delivered" | "delivery_failed" | "returned", input?: { occurredAt?: DateTime; eventId?: string; }, options?: MutationOptions) => Promise<Shipment>preparationInput:(shipment: Shipment) => Promise<{ order: Order; parcels: Parcel[]; }>
IdempotencyService
Class
IdempotencyServicePublic members
db:Databaseregistry:ModelRegistryhash:(request: unknown) => stringclaim:(scope: string, key: string, request: unknown) => Promise<IdempotencyClaim>complete:(record: IdempotencyKey, response: unknown, options?: MutationOptions) => Promise<void>abandon:(record: IdempotencyKey, error?: unknown) => Promise<void>purgeExpired:(now?: DateTime<true>) => Promise<number>canonicalJson:(value: unknown) => stringnormalize:(value: unknown) => unknownisUniqueViolation:(error: unknown) => boolean
InventoryService
Class
InventoryServicePublic members
#backorderPolicies:InventoryBackorderPolicy[]db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigallocation:StockAllocationStrategyevents:TransactionalEventEmitter | undefinedregisterBackorderPolicy:(policy: InventoryBackorderPolicy) => voidlistLevels:(filter?: AdminInventoryLevelFilter) => Promise<AdminListPage<InventoryLevel>>createLocation:(input: { code: string; name: string; address?: AddressInput; isDefault?: boolean; }, options?: MutationOptions) => Promise<StockLocation>createItem:(input: { variantId: string; tracked?: boolean; backorderable?: boolean; }, options?: MutationOptions) => Promise<InventoryItem>setLevel:(itemId: string, locationId: string, onHand: number, options?: MutationOptions) => Promise<InventoryLevel>availability:(variantId: string, locationId?: string) => Promise<{ onHand: number; reserved: number; available: number; }>adjustOnHand:(itemId: string, locationId: string, delta: number, reason: string, options?: MutationOptions) => Promise<InventoryLevel>reserveForCart:(cart: Cart, options?: MutationOptions) => Promise<Reservation[]>releaseCartReservations:(cart: Cart, options?: MutationOptions) => Promise<void>consumeReservations:(cart: Cart, _order: unknown, options?: MutationOptions) => Promise<void>bindReservationExpiry:(cart: Cart, expiresAt: DateTime, options?: MutationOptions) => Promise<void>compensateDeferred:(cart: Cart, policy: "reserve" | "commit", options?: MutationOptions) => Promise<void>settleDeferred:(cart: Cart, order: unknown, policy: "reserve" | "commit", options?: MutationOptions) => Promise<void>restockReturnedShipment:(shipment: Shipment, options?: MutationOptions) => Promise<void>expireStale:(now?: DateTime<true>) => Promise<number>auditReservedTotals:() => Promise<Array<{ levelId: string; stored: number; actual: number; }>>listMovements:(input?: { itemId?: string; locationId?: string; type?: InventoryMovementType; limit?: number; channelIds?: readonly string[]; }) => Promise<InventoryMovement[]>receive:(input: { itemId: string; locationId: string; quantity: number; reference?: string; metadata?: Record<string, unknown>; }, options?: MutationOptions) => Promise<InventoryMovement>restockFromReturn:(input: { variantId: string; quantity: number; reference: string; locationId?: string; }, options?: MutationOptions) => Promise<InventoryMovement | null>adjust:(input: { itemId: string; locationId: string; quantityDelta: number; reference?: string; metadata?: Record<string, unknown>; }, options?: MutationOptions) => Promise<InventoryMovement>cycleCount:(input: { itemId: string; locationId: string; countedOnHand: number; reference?: string; metadata?: Record<string, unknown>; }, options?: MutationOptions) => Promise<InventoryMovement | null>createTransfer:(input: { itemId: string; sourceLocationId: string; destinationLocationId: string; quantity: number; reference?: string; }, options?: MutationOptions) => Promise<InventoryTransfer>completeTransfer:(id: string, options?: MutationOptions) => Promise<InventoryTransfer>cancelTransfer:(id: string, options?: MutationOptions) => Promise<InventoryTransfer>recordAdjustment:(type: "receipt" | "adjustment" | "return", delta: number, input: { itemId: string; locationId: string; reference?: string; metadata?: Record<string, unknown>; }, options?: MutationOptions, eventReason?: string) => Promise<InventoryMovement>lockLevel:(itemId: string, locationId: string, trx: TransactionClientContract, create: boolean) => Promise<InventoryLevel>createMovement:(level: InventoryLevel, type: InventoryMovementType, quantityDelta: number, reference: string | undefined, metadata: Record<string, unknown> | undefined, actor: string | undefined, transferId: string | null, trx: TransactionClientContract, eventReason?: string) => Promise<InventoryMovement>releaseReservation:(reservation: Reservation, trx: TransactionClientContract) => Promise<void>
MediaLibraryService
Class
MediaLibraryServicePublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigstorage:ProductImageStorage | undefinedlist:(input?: { query?: string; limit?: number; }) => Promise<MediaAsset[]>listPage:(input?: { query?: string; cursor?: string; limit?: number; }) => Promise<AdminListPage<MediaAsset>>upload:(input: MediaUpload, options?: MutationOptions) => Promise<MediaAsset>attachToProduct:(assetId: string, productId: string, input?: { altText?: string | null; }, options?: MutationOptions) => Promise<ProductImage>delete:(id: string, options?: MutationOptions) => Promise<void>inspect:(input: MediaUpload) => { extension: "jpg" | "png" | "webp"; mimeType: "image/jpeg" | "image/png" | "image/webp"; width: number; height: number; }requireStorage:() => ProductImageStorage
MediaUpload
Interface
MediaUploadPublic members
contents:Uint8Array<ArrayBufferLike>clientName:stringcontentType:string | undefinedaltText:string | null | undefinedmetadata:Record<string, unknown> | undefined
OrderService
Class
OrderServicePublic members
machine:StateMachineRunner<OrderState, OrderTransition, TransactionClientContract>db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfiginventory:InventoryServicenumberGenerator:OrderNumberGenerator | undefinedevents:TransactionalEventEmitter | undefinedfindByNumber:(number: string) => Promise<Order | null>list:(filter?: AdminOrderFilter) => Promise<AdminListPage<Order>>createFromCart:(cart: Cart, options?: MutationOptions) => Promise<Order>transition:(order: Order, transition: OrderTransition, context?: TransitionContext, options?: MutationOptions) => Promise<Order>cancel:(order: Order, reason: string, options?: MutationOptions) => Promise<Order>addAdjustment:(order: Order, draft: AdjustmentDraft, options?: MutationOptions) => Promise<Order>recomputeTotals:(orderId: string, trx: TransactionClientContract) => Promise<void>nextSequentialNumber:(trx: TransactionClientContract) => Promise<string>transitionEvent:(order: Order, transition: OrderTransition, context: Readonly<Record<string, unknown>>) => OrderConfirmed | OrderCanceled | OrderFulfilled | OrderCompleted | undefinedload:(id: string, trx?: TransactionClientContract) => Promise<Order>
OutboundWebhookService
Class
OutboundWebhookServicePublic members
db:Databaseregistry:ModelRegistryencryption:EncryptionPortfetcher:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }settings:WebhookOptionslistDestinations:() => Promise<WebhookDestination[]>createDestination:(input: WebhookDestinationInput, options?: MutationOptions) => Promise<WebhookDestination>updateDestination:(id: string, input: WebhookDestinationUpdate, options?: MutationOptions) => Promise<WebhookDestination>deleteDestination:(id: string, options?: MutationOptions) => Promise<void>consume:(event: { id: string; name: string; payload: unknown; }) => Promise<void>listDeliveries:(input?: { destinationId?: string; status?: "pending" | "delivered" | "failed"; limit?: number; cursor?: string; }) => Promise<{ items: WebhookDelivery[]; nextCursor: string | null; }>replayDelivery:(id: string, options?: MutationOptions) => Promise<WebhookDelivery>claimDelivery:(destination: WebhookDestination, event: { id: string; name: string; payload: unknown; }) => Promise<WebhookDelivery>deliver:(destination: WebhookDestination, delivery: WebhookDelivery, deadline?: AbortSignal) => Promise<boolean>validate:(input: WebhookDestinationInput) => WebhookDestinationInputmatches:(subscriptions: string[], event: string) => booleansafeHeaders:(headers: Record<string, string> | null) => Record<string, string>secret:(destination: WebhookDestination) => Promise<string>requireOutbox:() => voidheaders:(destination: WebhookDestination) => Promise<Record<string, string> | null>rotateSecret:(id: string, options?: MutationOptions) => Promise<{ secret: string; }>ping:(id: string, options?: MutationOptions) => Promise<WebhookDelivery>toAdminDestination:(model: WebhookDestination) => Promise<AdminWebhookDestination>toAdminDelivery:(model: WebhookDelivery) => AdminWebhookDeliveryparseUrl:(value: string) => URLguardUrl:(value: string, signal: AbortSignal) => Promise<void>blockedAddress:(address: string) => booleanreadResponse:(response: Response) => Promise<string>
OutboxConsumer
Type
OutboxConsumerPaymentService
Class
PaymentServicePublic members
machine:StateMachineRunner<PaymentIntentState, "review" | "authorize" | "require_action" | "pend" | "capture" | "fail" | "settle" | "void" | "refund_partial" | "refund" | "restore_capture" | "expire", TransactionClientContract>db:Databaseregistry:ModelRegistryproviders:Readonly<Record<string, PaymentProvider>>encryption:EncryptionPortconfig:ResolvedCommerceConfiginventory:InventoryServiceorders:OrderServiceevents:TransactionalEventEmitter | undefinedprovider:(code: string) => PaymentProviderpaymentMethodCodes:(providerCode: string) => string[]listPayments:(filter?: AdminPaymentFilter) => Promise<AdminListPage<Payment>>createIntent:(subject: Cart | Order, method: string, options?: MutationOptions & { idempotencyKey?: string; }) => Promise<PaymentIntent>confirm:(intent: PaymentIntent, input: { token?: string; }, options?: MutationOptions & { idempotencyKey?: string; }) => Promise<PaymentIntent>paymentForIntent:(intentId: string, trx?: TransactionClientContract) => Promise<Payment | null>settle:(intent: PaymentIntent, input: { amount: Money; reference?: string; occurredAt?: DateTime; providerStatus?: string; raw?: unknown; }, options?: MutationOptions) => Promise<PaymentIntent>settleCod:(order: Order, amount: Money, reference: string, options?: MutationOptions) => Promise<PaymentIntent>rejectDeferred:(intent: PaymentIntent, reason: string, options?: MutationOptions & { idempotencyKey?: string; }) => Promise<PaymentIntent>expirePending:(now?: DateTime<true>) => Promise<number>expireOne:(intentId: string, now: DateTime, providerStatus: string, occurredAt?: DateTime) => Promise<void>markReview:(intent: PaymentIntent, order: Order | null, reason: string, trx: TransactionClientContract) => Promise<PaymentIntent>vaultCustomer:(customerId: string, providerCode: string, input?: { email?: string; name?: string; idempotencyKey?: string; }, options?: MutationOptions) => Promise<PaymentCustomer>setupPaymentMethod:(paymentCustomerId: string, input?: { token?: string; returnUrl?: string; makeDefault?: boolean; idempotencyKey?: string; }, options?: MutationOptions) => Promise<{ requiresAction: true; clientSecret: string; } | { requiresAction: false; paymentMethod: PaymentMethod; }>listPaymentMethods:(customerId: string, providerCode?: string) => Promise<PaymentMethod[]>chargeOffSession:(input: { paymentCustomerId: string; paymentMethodId: string; orderId: string; amount: Money; reference: string; idempotencyKey: string; }, options?: MutationOptions) => Promise<PaymentIntent>capture:(payment: Payment, amount?: Money, options?: MutationOptions & { idempotencyKey?: string; onCommitted?: (payment: Payment, trx: TransactionClientContract) => Promise<void>; }) => Promise<Payment>refund:(payment: Payment, input: { captureId?: string; amount?: Money; reason?: string; returnId?: string; }, options?: MutationOptions & { idempotencyKey?: string; onCommitted?: (refund: Refund, trx: TransactionClientContract) => Promise<void>; }) => Promise<Refund>listOperations:(filters?: { state?: "started" | "completed" | "failed" | "uncertain"; operation?: "capture" | "refund"; paymentId?: string; channelIds?: readonly string[]; cursor?: string; limit?: number; }) => Promise<AdminListPage<PaymentOperation>>resolveOperation:(operationId: string, input: { outcome: "completed" | "failed"; providerReference?: string; note?: string; }, options?: MutationOptions) => Promise<PaymentOperation>reconcileOperations:(options?: { olderThanMinutes?: number; limit?: number; }) => Promise<number>refreshRefundState:(paymentId: string, trx: TransactionClientContract) => Promise<void>claimPaymentOperation:(payment: Payment, intent: PaymentIntent, operation: "capture" | "refund", key: string, amount: Money, request: Record<string, unknown>, options?: MutationOptions) => Promise<{ operation: PaymentOperation; replayPaymentId?: string; replayRefundId?: string; }>completePaymentOperation:(operation: PaymentOperation, response: unknown, trx: TransactionClientContract) => Promise<void>markPaymentOperationUncertain:(operation: PaymentOperation, error: unknown) => Promise<void>loadPayment:(id: string, trx?: TransactionClientContract) => Promise<Payment>void:(intent: PaymentIntent, options?: MutationOptions & { idempotencyKey?: string; }) => Promise<PaymentIntent>ingestWebhook:(providerCode: string, raw: RawWebhookRequest) => Promise<WebhookIngestResult>applyWebhookEvent:(providerCode: string, event: NormalizedPaymentEvent, trx: TransactionClientContract) => Promise<void>ensureCapture:(payment: Payment, intent: PaymentIntent, providerCaptureId: string, raw: unknown, trx: TransactionClientContract, amount?: Money, providerChargeId?: string) => Promise<Capture>ensureAuthorizedPayment:(intent: PaymentIntent, raw: unknown, trx: TransactionClientContract) => Promise<Payment>normalizedWebhookPayload:(event: NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }) => Record<string, unknown>intent:(id: string, trx?: TransactionClientContract) => Promise<PaymentIntent>isUniqueViolation:(error: unknown) => boolean
PlaceOrderContext
Interface
PlaceOrderContextPublic members
cart:Cartinput:PlaceOrderInputidempotency:IdempotencyKeytrx:TransactionClientContract | undefinedorder:Order | undefinedintent:PaymentIntent | undefinedpayment:Payment | undefinedownsIntent:boolean | undefinedworkflowCompensationErrors:readonly { step: string; error: unknown; }[] | undefinedtransaction:(callback: (context: PlaceOrderContext) => Promise<void>) => Promise<void>
PlaceOrderWorkflow
Class
PlaceOrderWorkflowPublic members
#workflow:Workflow<PlaceOrderContext>#captureAmountResolver:((context: PlaceOrderContext) => Promise<Money | undefined>) | undefineddb:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigcarts:CartServiceinventory:InventoryServiceorders:OrderServicepayments:PaymentServiceshipping:ShippingServiceidempotency:IdempotencyServiceevents:TransactionalEventEmittersteps:readonly WorkflowStep<PlaceOrderContext>[]registerCaptureAmountResolver:(resolver: (context: PlaceOrderContext) => Promise<Money | undefined>) => PlaceOrderWorkflowinsertBefore:(step: string, newStep: WorkflowStep<PlaceOrderContext>) => PlaceOrderWorkflowinsertAfter:(step: string, newStep: WorkflowStep<PlaceOrderContext>) => PlaceOrderWorkflowreplace:(step: string, newStep: WorkflowStep<PlaceOrderContext>) => PlaceOrderWorkflowremove:(step: string) => PlaceOrderWorkflowrun:(context: PlaceOrderContext) => Promise<void>finalizeExisting:(cart: Cart, order: Order, intent?: PaymentIntent) => Promise<Order>releaseCartReservations:(cart: Cart) => Promise<void>cancelAbandoned:(order: Order) => Promise<Order>defaultSteps:() => WorkflowStep<PlaceOrderContext>[]validateCart:(context: PlaceOrderContext) => Promise<void>lockCart:(context: PlaceOrderContext) => Promise<void>createPayment:(context: PlaceOrderContext) => Promise<void>compensatePayment:(context: PlaceOrderContext) => Promise<void>finalize:(context: PlaceOrderContext, completeIdempotency: boolean) => Promise<void>emit:(context: PlaceOrderContext) => Promise<void>context:(cart: Cart, input: PlaceOrderInput, idempotency: IdempotencyKey) => PlaceOrderContext
PricingService
Class
PricingServicePublic members
db:Databaseregistry:ModelRegistrycreatePriceList:(data: { name: string; channelId?: string | null; customerGroupId?: string | null; priority?: number; startsAt?: DateTime | null; endsAt?: DateTime | null; isDefault?: boolean; }, options?: MutationOptions) => Promise<PriceList>createPrice:(data: { priceListId: string; variantId: string; unitPrice: Money; minQuantity?: number; }, options?: MutationOptions) => Promise<Price>
ProductImageService
Class
ProductImageServicePublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigstorage:ProductImageStorage | undefinedevents:TransactionalEventEmitter | undefinedupload:(productId: string, input: ProductImageUpload, options?: MutationOptions) => Promise<ProductImage>update:(productId: string, imageId: string, input: UpdateProductImageInput, options?: MutationOptions) => Promise<ProductImage>reorder:(productId: string, imageIds: string[], options?: MutationOptions) => Promise<ProductImage[]>remove:(productId: string, imageId: string, options?: MutationOptions) => Promise<void>scheduleProductDeletion:(productId: string, trx: TransactionClientContract) => Promise<void>inspect:(input: ProductImageUpload) => { extension: "jpg" | "png" | "webp"; mimeType: "image/jpeg" | "image/png" | "image/webp"; width: number; height: number; }requireStorage:() => ProductImageStoragefind:(productId: string, imageId: string, trx: TransactionClientContract) => Promise<ProductImage>assertVariants:(productId: string, input: string[], trx: TransactionClientContract) => Promise<string[]>scheduleStorageDeletion:(image: Pick<ProductImage, "assetId" | "disk" | "key">, trx: TransactionClientContract) => voidnormalizePositions:(productId: string, trx: TransactionClientContract) => Promise<void>
ProductImageUpload
Interface
ProductImageUploadPublic members
contents:Uint8Array<ArrayBufferLike>clientName:stringcontentType:string | undefined
RequestReturnInput
Interface
RequestReturnInputPublic members
orderId:stringnote:string | undefinedlines:{ orderLineId: string; quantity: number; reasonId: string; note?: string; }[]
ResolvedCommerceDrivers
Interface
ResolvedCommerceDriversPublic members
cartTokenStrategy:CartTokenStrategypriceResolver:PriceResolversearch:SearchDriver | undefinedproductImageStorage:ProductImageStorage | undefinedpaymentMethods:Readonly<Record<string, PaymentProvider>>shippingCalculators:Readonly<Record<string, ShippingCalculator>>shippingQuoteProviders:Readonly<Record<string, DynamicShippingQuoteProvider>>fulfillmentProviders:Readonly<Record<string, FulfillmentProvider>>inventoryAllocation:StockAllocationStrategy | undefinedshippingEligibility:ShippingEligibility | undefinedtaxCalculator:TaxCalculatortaxAddressResolver:TaxAddressResolver | undefinedorderNumberGenerator:OrderNumberGenerator | undefined
ReturnInspectionInput
Interface
ReturnInspectionInputPublic members
returnLineId:stringacceptedQuantity:numberrejectedQuantity:numberdisposition:ReturnDisposition | undefinednote:string | undefined
ReturnService
Class
ReturnServicePublic members
machine:StateMachineRunner<ReturnState, ReturnTransition, TransactionClientContract>db:Databaseregistry:ModelRegistrytablePrefix:stringpayments:PaymentServicecarts:CartServiceinventory:InventoryServiceorders:OrderServiceevents:TransactionalEventEmitter | undefinedlist:(filters?: { state?: ReturnState; orderId?: string; channelIds?: readonly string[]; cursor?: string; limit?: number; }) => Promise<AdminListPage<ReturnRequest>>find:(id: string) => Promise<ReturnRequest | null>listForCustomer:(customerId: string, input?: { limit?: number; cursor?: string; }) => Promise<{ data: ReturnRequest[]; nextCursor: string | null; }>findForCustomer:(customerId: string, returnId: string) => Promise<ReturnRequest | null>listReasons:() => Promise<ReturnReason[]>createReason:(input: { code: string; name: string; requiresNote?: boolean; metadata?: Record<string, unknown>; }, options?: MutationOptions) => Promise<ReturnReason>request:(customerId: string, input: RequestReturnInput, options?: MutationOptions) => Promise<ReturnRequest>authorize:(request: ReturnRequest, options?: MutationOptions) => Promise<ReturnRequest>cancel:(request: ReturnRequest, options?: MutationOptions) => Promise<ReturnRequest>receive:(request: ReturnRequest, quantities: Array<{ returnLineId: string; quantity: number; }>, options?: MutationOptions) => Promise<ReturnRequest>inspect:(request: ReturnRequest, options?: MutationOptions) => Promise<ReturnRequest>recordInspection:(request: ReturnRequest, inspections: ReturnInspectionInput[], options?: MutationOptions) => Promise<ReturnRequest>approve:(request: ReturnRequest, options?: MutationOptions) => Promise<ReturnRequest>reject:(request: ReturnRequest, options?: MutationOptions) => Promise<ReturnRequest>refund:(request: ReturnRequest, input?: { paymentId?: string; reason?: string; }, options?: MutationOptions & { onCommitted?: (result: ReturnRequest, trx: TransactionClientContract) => Promise<void>; }) => Promise<ReturnRequest>exchange:(request: ReturnRequest, replacements: Array<{ variantId: string; quantity: number; }>, options?: MutationOptions & { onCommitted?: (result: ReturnRequest, trx: TransactionClientContract) => Promise<void>; }) => Promise<ReturnRequest>close:(request: ReturnRequest, options?: MutationOptions) => Promise<ReturnRequest>transition:(request: ReturnRequest, transition: ReturnTransition, context: TransitionContext, options?: MutationOptions, mutate?: (request: ReturnRequest) => void) => Promise<ReturnRequest>applyTransition:(current: ReturnRequest, transition: ReturnTransition, context: TransitionContext, trx: TransactionClientContract, options?: MutationOptions) => Promise<void>reservedQuantity:(orderLineId: string, trx: TransactionClientContract) => Promise<number>lock:(id: string, trx: TransactionClientContract) => Promise<ReturnRequest>load:(id: string, trx?: TransactionClientContract) => Promise<ReturnRequest>decodeCursor:(cursor: string) => { createdAt: DateTime; id: string; }
SEARCH_DELETE_JOB
Value
"commerce.search.delete_product"SEARCH_INDEX_JOB
Value
"commerce.search.index_product"SEARCH_REINDEX_JOB
Value
"commerce.search.reindex_products"SearchService
Class
SearchServicePublic members
db:Databaseregistry:ModelRegistrytablePrefix:stringdriver:SearchDriver | undefinedjobs:JobDispatcherService | undefinedsearch:(input: SearchQuery) => Promise<SearchResult>scheduleIndex:(productId: string, trx: TransactionClientContract) => voidscheduleDelete:(productId: string, trx: TransactionClientContract) => voidindexProduct:(productId: string) => Promise<void>deleteProduct:(productId: string) => Promise<void>reindex:(batchSize?: number) => Promise<number>document:(productId: string) => Promise<SearchDocument | null>dispatch:(job: string, payload: Readonly<Record<string, unknown>>) => Promise<void>
ShippingCartProcessor
Class
ShippingCartProcessorPublic members
name:"shipping"position:500shipping:ShippingServiceprocess:(cart: Parameters<CartProcessor["process"]>[0], ctx: RecalculationContext) => Promise<AdjustmentDraft[]>
ShippingService
Class
ShippingServicePublic members
db:Databaseregistry:ModelRegistrycalculators:Readonly<Record<string, ShippingCalculator>>eligibility:ShippingEligibilityquoteProviders:Readonly<Record<string, DynamicShippingQuoteProvider>>selectionSecret:string | undefinedcreateMethod:(data: { code: string; name: string; calculator: string; calculatorConfig: Record<string, unknown>; channelId?: string | null; position?: number; enabled?: boolean; }, options?: MutationOptions) => Promise<ShippingMethod>eligibleMethods:(snapshot: CartSnapshot, channelId: string, trx?: TransactionClientContract) => Promise<ShippingMethod[]>calculator:(code: string) => ShippingCalculatorquote:(cart: Cart, providerCode: string, options?: { cod?: { amount: Money; }; insurance?: { amount: Money; }; }) => Promise<ShippingQuote[]>selectQuote:(cart: Cart, selectionToken: string, options?: MutationOptions) => Promise<Cart>assertSelectedQuote:(cart: Cart, suppliedToken?: string, trx?: TransactionClientContract) => Promise<QuoteSelectionPayload | null>verifySelection:(cart: Cart, token: string, trx?: TransactionClientContract) => Promise<QuoteSelectionPayload>quoteRequest:(cart: Cart, options: { cod?: { amount: Money; }; insurance?: { amount: Money; }; }, trx?: TransactionClientContract) => Promise<ShippingQuoteRequest>signSelection:(payload: QuoteSelectionPayload) => stringdecodeSelection:(token: string) => QuoteSelectionPayload
TaxCartProcessor
Class
TaxCartProcessorPublic members
name:"tax"position:1000config:ResolvedCommerceConfigcalculator:TaxCalculatoraddressResolver:TaxAddressResolver | undefinedprocess:(cart: Parameters<CartProcessor["process"]>[0], ctx: RecalculationContext) => Promise<AdjustmentDraft[]>
TaxService
Class
TaxServicePublic members
db:Databaseregistry:ModelRegistrycreateCategory:(data: { code: string; name: string; }, options?: MutationOptions) => Promise<TaxCategory>createZone:(data: { name: string; countryCodes: string[]; regionPattern?: string | null; postalPattern?: string | null; }, options?: MutationOptions) => Promise<TaxZone>createRate:(data: { zoneId: string; taxCategoryId?: string | null; name: string; rateBp: number; }, options?: MutationOptions) => Promise<TaxRate>
UpdateProductImageInput
Interface
UpdateProductImageInputPublic members
altText:string | null | undefinedvariantIds:string[] | undefined
WebhookDestinationInput
Interface
WebhookDestinationInputPublic members
name:stringurl:stringsecret:stringsubscriptions:string[]active:boolean | undefinedheaders:Record<string, string> | null | undefined
WebhookDestinationUpdate
Interface
WebhookDestinationUpdatePublic members
name:string | undefinedurl:string | undefinedsecret:string | undefinedsubscriptions:string[] | undefinedactive:boolean | undefinedheaders:Record<string, string> | null | undefined
WebhookOptions
Interface
WebhookOptionsPublic members
outboxEnabled:boolean | undefinedrequestTimeoutMs:number | undefinedallowedHosts:readonly string[] | undefinedallowLocalhost:boolean | undefined
@adocommercekit/core/models
Address
Class
AddressPublic members
customerId:string | nullfirstName:stringlastName:stringcompany:string | nullline1:stringline2:string | nullcity:stringregion:string | nullpostalCode:string | nullcountryCode:stringphone:string | nullisDefaultShipping:booleanisDefaultBilling:booleancustomer:BelongsTo<typeof Customer>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => AddressuseConnection:(connection: string) => Address$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Address>>, allowExtraProperties?: boolean) => Addressmerge:(value: Partial<ModelAttributes<Address>>, allowExtraProperties?: boolean) => AddressisDirty:(fields?: "id" | "company" | "createdAt" | "updatedAt" | "customerId" | "firstName" | "lastName" | "line1" | "line2" | "city" | "region" | "postalCode" | "countryCode" | "phone" | "isDefaultShipping" | "isDefaultBilling" | "metadata" | ("id" | "company" | "createdAt" | "updatedAt" | "customerId" | "firstName" | "lastName" | "line1" | "line2" | "city" | "region" | "postalCode" | "countryCode" | "phone" | "isDefaultShipping" | "isDefaultBilling" | "metadata" | undefined)[] | undefined) => booleanenableForceUpdate:() => Addresssave:() => Promise<Address>saveQuietly:() => Promise<Address>lockForUpdate:<T>(callback: (user: Address) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Address>load:LucidRowPreload<Address>loadOnce:LucidRowPreloadOnce<Address>preload:LucidRowPreload<Address>loadAggregate:<Self extends Address, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Address, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Address>>(relation: Name) => NonNullable<Address[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Address[Name] & {})["client"] : never
BaseCommerceModel
Class
BaseCommerceModelPublic members
id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => BaseCommerceModeluseConnection:(connection: string) => BaseCommerceModel$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<BaseCommerceModel>>, allowExtraProperties?: boolean) => BaseCommerceModelmerge:(value: Partial<ModelAttributes<BaseCommerceModel>>, allowExtraProperties?: boolean) => BaseCommerceModelisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | ("id" | "createdAt" | "updatedAt" | "metadata" | undefined)[] | undefined) => booleanenableForceUpdate:() => BaseCommerceModelsave:() => Promise<BaseCommerceModel>saveQuietly:() => Promise<BaseCommerceModel>lockForUpdate:<T>(callback: (user: BaseCommerceModel) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<BaseCommerceModel>load:LucidRowPreload<BaseCommerceModel>loadOnce:LucidRowPreloadOnce<BaseCommerceModel>preload:LucidRowPreload<BaseCommerceModel>loadAggregate:<Self extends BaseCommerceModel, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends BaseCommerceModel, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<BaseCommerceModel[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & BaseCommerceModel[Name] & {})["client"] : never
Capture
Class
CapturePublic members
paymentId:stringintentId:stringstate:CaptureStateamount:MoneyamountAmount:bigintamountCurrency:stringproviderCaptureId:stringproviderChargeId:string | nullrawPayload:unknownpayment:BelongsTo<typeof Payment>intent:BelongsTo<typeof PaymentIntent>refunds:HasMany<typeof Refund>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CaptureuseConnection:(connection: string) => Capture$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Capture>>, allowExtraProperties?: boolean) => Capturemerge:(value: Partial<ModelAttributes<Capture>>, allowExtraProperties?: boolean) => CaptureisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "paymentId" | "intentId" | "state" | "amountAmount" | "amountCurrency" | "providerCaptureId" | "providerChargeId" | "rawPayload" | ("id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "paymentId" | "intentId" | "state" | "amountAmount" | "amountCurrency" | "providerCaptureId" | "providerChargeId" | "rawPayload" | undefined)[] | undefined) => booleanenableForceUpdate:() => Capturesave:() => Promise<Capture>saveQuietly:() => Promise<Capture>lockForUpdate:<T>(callback: (user: Capture) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Capture>load:LucidRowPreload<Capture>loadOnce:LucidRowPreloadOnce<Capture>preload:LucidRowPreload<Capture>loadAggregate:<Self extends Capture, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Capture, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Capture>>(relation: Name) => NonNullable<Capture[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Capture[Name] & {})["client"] : never
CaptureState
Type
CaptureStateCart
Class
CartPublic members
token:stringchannelId:stringcurrency:stringcustomerId:string | nullemail:string | nullstatus:CartStatusshippingAddress:AddressInput | nullbillingAddress:AddressInput | nullshippingMethodId:string | nullcompletedOrderId:string | nullshippingQuoteToken:string | nullshippingQuoteExpiresAt:DateTime<boolean> | nullsubtotalAmount:bigintshippingTotalAmount:biginttaxTotalAmount:bigintdiscountTotalAmount:bigintgrandTotalAmount:bigintlastActivityAt:DateTime<boolean>channel:BelongsTo<typeof Channel>customer:BelongsTo<typeof Customer>shippingMethod:BelongsTo<typeof ShippingMethod>lines:HasMany<typeof CartLine>adjustments:HasMany<typeof CartAdjustment>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CartuseConnection:(connection: string) => Cart$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Cart>>, allowExtraProperties?: boolean) => Cartmerge:(value: Partial<ModelAttributes<Cart>>, allowExtraProperties?: boolean) => CartisDirty:(fields?: "id" | "status" | "createdAt" | "email" | "updatedAt" | "customerId" | "metadata" | "currency" | "token" | "channelId" | "shippingAddress" | "billingAddress" | "shippingMethodId" | "completedOrderId" | "shippingQuoteToken" | "shippingQuoteExpiresAt" | "subtotalAmount" | "shippingTotalAmount" | "taxTotalAmount" | "discountTotalAmount" | "grandTotalAmount" | "lastActivityAt" | ("id" | "status" | "createdAt" | "email" | "updatedAt" | "customerId" | "metadata" | "currency" | "token" | "channelId" | "shippingAddress" | "billingAddress" | "shippingMethodId" | "completedOrderId" | "shippingQuoteToken" | "shippingQuoteExpiresAt" | "subtotalAmount" | "shippingTotalAmount" | "taxTotalAmount" | "discountTotalAmount" | "grandTotalAmount" | "lastActivityAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => Cartsave:() => Promise<Cart>saveQuietly:() => Promise<Cart>lockForUpdate:<T>(callback: (user: Cart) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Cart>load:LucidRowPreload<Cart>loadOnce:LucidRowPreloadOnce<Cart>preload:LucidRowPreload<Cart>loadAggregate:<Self extends Cart, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Cart, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Cart>>(relation: Name) => NonNullable<Cart[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Cart[Name] & {})["client"] : never
CartAdjustment
Class
CartAdjustmentPublic members
cartId:stringcartLineId:string | nullsourceType:stringsourceId:string | nulllabel:stringamount:MoneyamountAmount:bigintamountCurrency:stringincluded:booleaneligible:booleanposition:numberid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CartAdjustmentuseConnection:(connection: string) => CartAdjustment$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<CartAdjustment>>, allowExtraProperties?: boolean) => CartAdjustmentmerge:(value: Partial<ModelAttributes<CartAdjustment>>, allowExtraProperties?: boolean) => CartAdjustmentisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "amountAmount" | "amountCurrency" | "cartId" | "position" | "cartLineId" | "sourceType" | "sourceId" | "label" | "included" | "eligible" | ("id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "amountAmount" | "amountCurrency" | "cartId" | "position" | "cartLineId" | "sourceType" | "sourceId" | "label" | "included" | "eligible" | undefined)[] | undefined) => booleanenableForceUpdate:() => CartAdjustmentsave:() => Promise<CartAdjustment>saveQuietly:() => Promise<CartAdjustment>lockForUpdate:<T>(callback: (user: CartAdjustment) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<CartAdjustment>load:LucidRowPreload<CartAdjustment>loadOnce:LucidRowPreloadOnce<CartAdjustment>preload:LucidRowPreload<CartAdjustment>loadAggregate:<Self extends CartAdjustment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends CartAdjustment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<CartAdjustment[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & CartAdjustment[Name] & {})["client"] : never
CartLine
Class
CartLinePublic members
cartId:stringvariantId:stringquantity:numberunitPrice:MoneyunitPriceAmount:bigintunitPriceCurrency:stringcart:BelongsTo<typeof Cart>variant:BelongsTo<typeof ProductVariant>adjustments:HasMany<typeof CartAdjustment>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CartLineuseConnection:(connection: string) => CartLine$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<CartLine>>, allowExtraProperties?: boolean) => CartLinemerge:(value: Partial<ModelAttributes<CartLine>>, allowExtraProperties?: boolean) => CartLineisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "cartId" | "variantId" | "quantity" | "unitPrice" | "unitPriceAmount" | "unitPriceCurrency" | ("id" | "createdAt" | "updatedAt" | "metadata" | "cartId" | "variantId" | "quantity" | "unitPrice" | "unitPriceAmount" | "unitPriceCurrency" | undefined)[] | undefined) => booleanenableForceUpdate:() => CartLinesave:() => Promise<CartLine>saveQuietly:() => Promise<CartLine>lockForUpdate:<T>(callback: (user: CartLine) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<CartLine>load:LucidRowPreload<CartLine>loadOnce:LucidRowPreloadOnce<CartLine>preload:LucidRowPreload<CartLine>loadAggregate:<Self extends CartLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends CartLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<CartLine>>(relation: Name) => NonNullable<CartLine[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & CartLine[Name] & {})["client"] : never
CartStatus
Type
CartStatusCategory
Class
CategoryPublic members
parentId:string | nullname:stringslug:stringpath:stringposition:numberparent:BelongsTo<typeof Category>children:HasMany<typeof Category>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CategoryuseConnection:(connection: string) => Category$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Category>>, allowExtraProperties?: boolean) => Categorymerge:(value: Partial<ModelAttributes<Category>>, allowExtraProperties?: boolean) => CategoryisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "position" | "parentId" | "slug" | "path" | ("id" | "name" | "createdAt" | "updatedAt" | "metadata" | "position" | "parentId" | "slug" | "path" | undefined)[] | undefined) => booleanenableForceUpdate:() => Categorysave:() => Promise<Category>saveQuietly:() => Promise<Category>lockForUpdate:<T>(callback: (user: Category) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Category>load:LucidRowPreload<Category>loadOnce:LucidRowPreloadOnce<Category>preload:LucidRowPreload<Category>loadAggregate:<Self extends Category, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Category, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Category>>(relation: Name) => NonNullable<Category[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Category[Name] & {})["client"] : never
Channel
Class
ChannelPublic members
code:stringname:stringdefaultCurrency:stringsupportedCurrencies:string[]isDefault:booleanid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ChanneluseConnection:(connection: string) => Channel$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Channel>>, allowExtraProperties?: boolean) => Channelmerge:(value: Partial<ModelAttributes<Channel>>, allowExtraProperties?: boolean) => ChannelisDirty:(fields?: "code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "defaultCurrency" | "supportedCurrencies" | "isDefault" | ("code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "defaultCurrency" | "supportedCurrencies" | "isDefault" | undefined)[] | undefined) => booleanenableForceUpdate:() => Channelsave:() => Promise<Channel>saveQuietly:() => Promise<Channel>lockForUpdate:<T>(callback: (user: Channel) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Channel>load:LucidRowPreload<Channel>loadOnce:LucidRowPreloadOnce<Channel>preload:LucidRowPreload<Channel>loadAggregate:<Self extends Channel, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Channel, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<Channel[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Channel[Name] & {})["client"] : never
configureBaseCommerceModel
Function
(config: Pick<ResolvedCommerceConfig, "tablePrefix">) => voidCustomer
Class
CustomerPublic members
email:string | nullfirstName:string | nulllastName:string | nullphone:string | nulluserId:string | nullgroupId:string | nullanonymizedAt:DateTime<boolean> | nullgroup:BelongsTo<typeof CustomerGroup>addresses:HasMany<typeof Address>returns:HasMany<typeof ReturnRequest>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CustomeruseConnection:(connection: string) => Customer$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Customer>>, allowExtraProperties?: boolean) => Customermerge:(value: Partial<ModelAttributes<Customer>>, allowExtraProperties?: boolean) => CustomerisDirty:(fields?: "id" | "createdAt" | "email" | "updatedAt" | "firstName" | "lastName" | "phone" | "metadata" | "userId" | "groupId" | "anonymizedAt" | ("id" | "createdAt" | "email" | "updatedAt" | "firstName" | "lastName" | "phone" | "metadata" | "userId" | "groupId" | "anonymizedAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => Customersave:() => Promise<Customer>saveQuietly:() => Promise<Customer>lockForUpdate:<T>(callback: (user: Customer) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Customer>load:LucidRowPreload<Customer>loadOnce:LucidRowPreloadOnce<Customer>preload:LucidRowPreload<Customer>loadAggregate:<Self extends Customer, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Customer, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Customer>>(relation: Name) => NonNullable<Customer[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Customer[Name] & {})["client"] : never
CustomerGroup
Class
CustomerGroupPublic members
code:stringname:stringcustomers:HasMany<typeof Customer>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => CustomerGroupuseConnection:(connection: string) => CustomerGroup$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<CustomerGroup>>, allowExtraProperties?: boolean) => CustomerGroupmerge:(value: Partial<ModelAttributes<CustomerGroup>>, allowExtraProperties?: boolean) => CustomerGroupisDirty:(fields?: "code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | ("code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | undefined)[] | undefined) => booleanenableForceUpdate:() => CustomerGroupsave:() => Promise<CustomerGroup>saveQuietly:() => Promise<CustomerGroup>lockForUpdate:<T>(callback: (user: CustomerGroup) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<CustomerGroup>load:LucidRowPreload<CustomerGroup>loadOnce:LucidRowPreloadOnce<CustomerGroup>preload:LucidRowPreload<CustomerGroup>loadAggregate:<Self extends CustomerGroup, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends CustomerGroup, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<CustomerGroup>>(relation: Name) => NonNullable<CustomerGroup[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & CustomerGroup[Name] & {})["client"] : never
EventOutbox
Class
EventOutboxPublic members
id:stringeventName:stringpayload:unknownstatus:OutboxStatusattempts:numberleaseToken:string | nullleasedUntil:DateTime<boolean> | nulllastError:string | nulldeadLetteredAt:DateTime<boolean> | nullavailableAt:DateTime<boolean>createdAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => EventOutboxuseConnection:(connection: string) => EventOutbox$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<EventOutbox>>, allowExtraProperties?: boolean) => EventOutboxmerge:(value: Partial<ModelAttributes<EventOutbox>>, allowExtraProperties?: boolean) => EventOutboxisDirty:(fields?: "id" | "status" | "createdAt" | "eventName" | "attempts" | "deadLetteredAt" | "lastError" | "payload" | "leaseToken" | "leasedUntil" | "availableAt" | ("id" | "status" | "createdAt" | "eventName" | "attempts" | "deadLetteredAt" | "lastError" | "payload" | "leaseToken" | "leasedUntil" | "availableAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => EventOutboxsave:() => Promise<EventOutbox>saveQuietly:() => Promise<EventOutbox>lockForUpdate:<T>(callback: (user: EventOutbox) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<EventOutbox>load:LucidRowPreload<EventOutbox>loadOnce:LucidRowPreloadOnce<EventOutbox>preload:LucidRowPreload<EventOutbox>loadAggregate:<Self extends EventOutbox, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends EventOutbox, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<EventOutbox[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & EventOutbox[Name] & {})["client"] : never
getModelRegistry
Function
() => ModelRegistryIdempotencyKey
Class
IdempotencyKeyPublic members
key:stringscope:stringrequestHash:stringstatus:IdempotencyStatusresponse:unknownexpiresAt:DateTime<boolean>failedAt:DateTime<boolean> | nullid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => IdempotencyKeyuseConnection:(connection: string) => IdempotencyKey$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<IdempotencyKey>>, allowExtraProperties?: boolean) => IdempotencyKeymerge:(value: Partial<ModelAttributes<IdempotencyKey>>, allowExtraProperties?: boolean) => IdempotencyKeyisDirty:(fields?: "id" | "status" | "createdAt" | "updatedAt" | "key" | "metadata" | "expiresAt" | "scope" | "requestHash" | "response" | "failedAt" | ("id" | "status" | "createdAt" | "updatedAt" | "key" | "metadata" | "expiresAt" | "scope" | "requestHash" | "response" | "failedAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => IdempotencyKeysave:() => Promise<IdempotencyKey>saveQuietly:() => Promise<IdempotencyKey>lockForUpdate:<T>(callback: (user: IdempotencyKey) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<IdempotencyKey>load:LucidRowPreload<IdempotencyKey>loadOnce:LucidRowPreloadOnce<IdempotencyKey>preload:LucidRowPreload<IdempotencyKey>loadAggregate:<Self extends IdempotencyKey, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends IdempotencyKey, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<IdempotencyKey[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & IdempotencyKey[Name] & {})["client"] : never
IdempotencyStatus
Type
IdempotencyStatusInventoryItem
Class
InventoryItemPublic members
variantId:stringtracked:booleanbackorderable:booleanvariant:BelongsTo<typeof ProductVariant>levels:HasMany<typeof InventoryLevel>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => InventoryItemuseConnection:(connection: string) => InventoryItem$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<InventoryItem>>, allowExtraProperties?: boolean) => InventoryItemmerge:(value: Partial<ModelAttributes<InventoryItem>>, allowExtraProperties?: boolean) => InventoryItemisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "variantId" | "tracked" | "backorderable" | ("id" | "createdAt" | "updatedAt" | "metadata" | "variantId" | "tracked" | "backorderable" | undefined)[] | undefined) => booleanenableForceUpdate:() => InventoryItemsave:() => Promise<InventoryItem>saveQuietly:() => Promise<InventoryItem>lockForUpdate:<T>(callback: (user: InventoryItem) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<InventoryItem>load:LucidRowPreload<InventoryItem>loadOnce:LucidRowPreloadOnce<InventoryItem>preload:LucidRowPreload<InventoryItem>loadAggregate:<Self extends InventoryItem, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends InventoryItem, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<InventoryItem>>(relation: Name) => NonNullable<InventoryItem[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & InventoryItem[Name] & {})["client"] : never
InventoryLevel
Class
InventoryLevelPublic members
itemId:stringlocationId:stringonHand:numberreserved:numberreorderPoint:number | nullitem:BelongsTo<typeof InventoryItem>location:BelongsTo<typeof StockLocation>reservations:HasMany<typeof Reservation>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => InventoryLeveluseConnection:(connection: string) => InventoryLevel$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<InventoryLevel>>, allowExtraProperties?: boolean) => InventoryLevelmerge:(value: Partial<ModelAttributes<InventoryLevel>>, allowExtraProperties?: boolean) => InventoryLevelisDirty:(fields?: "id" | "createdAt" | "onHand" | "updatedAt" | "metadata" | "itemId" | "locationId" | "reserved" | "reorderPoint" | ("id" | "createdAt" | "onHand" | "updatedAt" | "metadata" | "itemId" | "locationId" | "reserved" | "reorderPoint" | undefined)[] | undefined) => booleanenableForceUpdate:() => InventoryLevelsave:() => Promise<InventoryLevel>saveQuietly:() => Promise<InventoryLevel>lockForUpdate:<T>(callback: (user: InventoryLevel) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<InventoryLevel>load:LucidRowPreload<InventoryLevel>loadOnce:LucidRowPreloadOnce<InventoryLevel>preload:LucidRowPreload<InventoryLevel>loadAggregate:<Self extends InventoryLevel, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends InventoryLevel, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<InventoryLevel>>(relation: Name) => NonNullable<InventoryLevel[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & InventoryLevel[Name] & {})["client"] : never
InventoryMovement
Class
InventoryMovementPublic members
itemId:stringlocationId:stringtransferId:string | nulltype:InventoryMovementTypequantityDelta:numberonHandAfter:numberreference:string | nullactor:string | nullmetadata:Record<string, unknown> | nullitem:BelongsTo<typeof InventoryItem>location:BelongsTo<typeof StockLocation>id:stringcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => InventoryMovementuseConnection:(connection: string) => InventoryMovement$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<InventoryMovement>>, allowExtraProperties?: boolean) => InventoryMovementmerge:(value: Partial<ModelAttributes<InventoryMovement>>, allowExtraProperties?: boolean) => InventoryMovementisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "itemId" | "locationId" | "transferId" | "type" | "quantityDelta" | "onHandAfter" | "reference" | "actor" | ("id" | "createdAt" | "updatedAt" | "metadata" | "itemId" | "locationId" | "transferId" | "type" | "quantityDelta" | "onHandAfter" | "reference" | "actor" | undefined)[] | undefined) => booleanenableForceUpdate:() => InventoryMovementsave:() => Promise<InventoryMovement>saveQuietly:() => Promise<InventoryMovement>lockForUpdate:<T>(callback: (user: InventoryMovement) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<InventoryMovement>load:LucidRowPreload<InventoryMovement>loadOnce:LucidRowPreloadOnce<InventoryMovement>preload:LucidRowPreload<InventoryMovement>loadAggregate:<Self extends InventoryMovement, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends InventoryMovement, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<InventoryMovement>>(relation: Name) => NonNullable<InventoryMovement[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & InventoryMovement[Name] & {})["client"] : never
InventoryMovementType
Type
InventoryMovementTypeInventoryTransfer
Class
InventoryTransferPublic members
itemId:stringsourceLocationId:stringdestinationLocationId:stringquantity:numberstate:InventoryTransferStatereference:string | nullactor:string | nullcompletedAt:DateTime<boolean> | nullitem:BelongsTo<typeof InventoryItem>sourceLocation:BelongsTo<typeof StockLocation>destinationLocation:BelongsTo<typeof StockLocation>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => InventoryTransferuseConnection:(connection: string) => InventoryTransfer$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<InventoryTransfer>>, allowExtraProperties?: boolean) => InventoryTransfermerge:(value: Partial<ModelAttributes<InventoryTransfer>>, allowExtraProperties?: boolean) => InventoryTransferisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "state" | "quantity" | "completedAt" | "itemId" | "reference" | "actor" | "sourceLocationId" | "destinationLocationId" | ("id" | "createdAt" | "updatedAt" | "metadata" | "state" | "quantity" | "completedAt" | "itemId" | "reference" | "actor" | "sourceLocationId" | "destinationLocationId" | undefined)[] | undefined) => booleanenableForceUpdate:() => InventoryTransfersave:() => Promise<InventoryTransfer>saveQuietly:() => Promise<InventoryTransfer>lockForUpdate:<T>(callback: (user: InventoryTransfer) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<InventoryTransfer>load:LucidRowPreload<InventoryTransfer>loadOnce:LucidRowPreloadOnce<InventoryTransfer>preload:LucidRowPreload<InventoryTransfer>loadAggregate:<Self extends InventoryTransfer, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends InventoryTransfer, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<InventoryTransfer>>(relation: Name) => NonNullable<InventoryTransfer[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & InventoryTransfer[Name] & {})["client"] : never
InventoryTransferState
Type
InventoryTransferStateMediaAsset
Class
MediaAssetPublic members
name:stringurl:stringdisk:stringkey:stringmimeType:stringsizeBytes:numberwidth:numberheight:numberaltText:string | nullmetadata:Record<string, unknown> | nullproductImages:HasMany<typeof ProductImage>id:stringcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => MediaAssetuseConnection:(connection: string) => MediaAsset$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<MediaAsset>>, allowExtraProperties?: boolean) => MediaAssetmerge:(value: Partial<ModelAttributes<MediaAsset>>, allowExtraProperties?: boolean) => MediaAssetisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "disk" | "key" | "metadata" | "url" | "mimeType" | "sizeBytes" | "width" | "height" | "altText" | ("id" | "name" | "createdAt" | "updatedAt" | "disk" | "key" | "metadata" | "url" | "mimeType" | "sizeBytes" | "width" | "height" | "altText" | undefined)[] | undefined) => booleanenableForceUpdate:() => MediaAssetsave:() => Promise<MediaAsset>saveQuietly:() => Promise<MediaAsset>lockForUpdate:<T>(callback: (user: MediaAsset) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<MediaAsset>load:LucidRowPreload<MediaAsset>loadOnce:LucidRowPreloadOnce<MediaAsset>preload:LucidRowPreload<MediaAsset>loadAggregate:<Self extends MediaAsset, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends MediaAsset, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<MediaAsset>>(relation: Name) => NonNullable<MediaAsset[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & MediaAsset[Name] & {})["client"] : never
ModelImport
Type
ModelImportModelRegistry
Class
ModelRegistryPublic members
#resolved:Map<keyof ModelRegistryOverrides, LucidModel>#loaders:Readonly<Partial<Record<keyof ModelRegistryOverrides, ModelImport>>>get:(key: ModelRegistryKey) => Promise<LucidModel>boot:() => Promise<void>require:(key: ModelRegistryKey) => LucidModelrelatedModel:(key: ModelRegistryKey) => () => LucidModel
ModelRegistryKey
Type
keyof ModelRegistryOverridesmoneyColumn
Function
Maps one Money property to a <prefix>_amount BIGINT and
<prefix>_currency CHAR(3) column pair.
(options?: { columnPrefix?: string; }) => PropertyDecoratorOrder
Class
OrderPublic members
number:stringchannelId:stringcurrency:stringcustomerId:string | nullemail:stringstate:OrderStateshippingAddress:AddressInputbillingAddress:AddressInputsubtotalAmount:bigintshippingTotalAmount:biginttaxTotalAmount:bigintdiscountTotalAmount:bigintgrandTotalAmount:bigintplacedAt:DateTime<boolean>cartId:string | nullchannel:BelongsTo<typeof Channel>customer:BelongsTo<typeof Customer>cart:BelongsTo<typeof Cart>lines:HasMany<typeof OrderLine>adjustments:HasMany<typeof OrderAdjustment>shipments:HasMany<typeof Shipment>payments:HasMany<typeof Payment>paymentInstructions:HasMany<typeof PaymentInstruction>returns:HasMany<typeof ReturnRequest>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => OrderuseConnection:(connection: string) => Order$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Order>>, allowExtraProperties?: boolean) => Ordermerge:(value: Partial<ModelAttributes<Order>>, allowExtraProperties?: boolean) => OrderisDirty:(fields?: "number" | "id" | "createdAt" | "email" | "updatedAt" | "placedAt" | "customerId" | "metadata" | "state" | "currency" | "cartId" | "channelId" | "shippingAddress" | "billingAddress" | "subtotalAmount" | "shippingTotalAmount" | "taxTotalAmount" | "discountTotalAmount" | "grandTotalAmount" | ("number" | "id" | "createdAt" | "email" | "updatedAt" | "placedAt" | "customerId" | "metadata" | "state" | "currency" | "cartId" | "channelId" | "shippingAddress" | "billingAddress" | "subtotalAmount" | "shippingTotalAmount" | "taxTotalAmount" | "discountTotalAmount" | "grandTotalAmount" | undefined)[] | undefined) => booleanenableForceUpdate:() => Ordersave:() => Promise<Order>saveQuietly:() => Promise<Order>lockForUpdate:<T>(callback: (user: Order) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Order>load:LucidRowPreload<Order>loadOnce:LucidRowPreloadOnce<Order>preload:LucidRowPreload<Order>loadAggregate:<Self extends Order, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Order, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Order>>(relation: Name) => NonNullable<Order[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Order[Name] & {})["client"] : never
OrderAdjustment
Class
OrderAdjustmentPublic members
orderId:stringorderLineId:string | nullsourceType:stringsourceId:string | nulllabel:stringamount:MoneyamountAmount:bigintamountCurrency:stringincluded:booleaneligible:booleanposition:numberid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => OrderAdjustmentuseConnection:(connection: string) => OrderAdjustment$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<OrderAdjustment>>, allowExtraProperties?: boolean) => OrderAdjustmentmerge:(value: Partial<ModelAttributes<OrderAdjustment>>, allowExtraProperties?: boolean) => OrderAdjustmentisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "amountAmount" | "amountCurrency" | "orderId" | "position" | "sourceType" | "sourceId" | "label" | "included" | "eligible" | "orderLineId" | ("id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "amountAmount" | "amountCurrency" | "orderId" | "position" | "sourceType" | "sourceId" | "label" | "included" | "eligible" | "orderLineId" | undefined)[] | undefined) => booleanenableForceUpdate:() => OrderAdjustmentsave:() => Promise<OrderAdjustment>saveQuietly:() => Promise<OrderAdjustment>lockForUpdate:<T>(callback: (user: OrderAdjustment) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<OrderAdjustment>load:LucidRowPreload<OrderAdjustment>loadOnce:LucidRowPreloadOnce<OrderAdjustment>preload:LucidRowPreload<OrderAdjustment>loadAggregate:<Self extends OrderAdjustment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends OrderAdjustment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<OrderAdjustment[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & OrderAdjustment[Name] & {})["client"] : never
OrderLine
Class
OrderLinePublic members
orderId:stringvariantId:string | nullcartLineId:string | nullproductName:stringvariantName:string | nullsku:string | nullquantity:numberunitPrice:MoneyunitPriceAmount:bigintunitPriceCurrency:stringfulfilledQuantity:numberrefundedQuantity:numberorder:BelongsTo<typeof Order>variant:BelongsTo<typeof ProductVariant>adjustments:HasMany<typeof OrderAdjustment>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => OrderLineuseConnection:(connection: string) => OrderLine$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<OrderLine>>, allowExtraProperties?: boolean) => OrderLinemerge:(value: Partial<ModelAttributes<OrderLine>>, allowExtraProperties?: boolean) => OrderLineisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "orderId" | "variantId" | "quantity" | "unitPrice" | "unitPriceAmount" | "unitPriceCurrency" | "cartLineId" | "sku" | "productName" | "variantName" | "fulfilledQuantity" | "refundedQuantity" | ("id" | "createdAt" | "updatedAt" | "metadata" | "orderId" | "variantId" | "quantity" | "unitPrice" | "unitPriceAmount" | "unitPriceCurrency" | "cartLineId" | "sku" | "productName" | "variantName" | "fulfilledQuantity" | "refundedQuantity" | undefined)[] | undefined) => booleanenableForceUpdate:() => OrderLinesave:() => Promise<OrderLine>saveQuietly:() => Promise<OrderLine>lockForUpdate:<T>(callback: (user: OrderLine) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<OrderLine>load:LucidRowPreload<OrderLine>loadOnce:LucidRowPreloadOnce<OrderLine>preload:LucidRowPreload<OrderLine>loadAggregate:<Self extends OrderLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends OrderLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<OrderLine>>(relation: Name) => NonNullable<OrderLine[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & OrderLine[Name] & {})["client"] : never
OrderState
Type
OrderStateOrderTransition
Type
OrderTransitionOutboundWebhookDeliveryState
Type
OutboundWebhookDeliveryStateOutboxStatus
Type
OutboxStatusPayment
Class
PaymentPublic members
intentId:stringorderId:stringstate:PaymentStateamount:MoneyamountAmount:bigintamountCurrency:stringproviderChargeId:string | nullrawPayload:unknownintent:BelongsTo<typeof PaymentIntent>order:BelongsTo<typeof Order>refunds:HasMany<typeof Refund>captures:HasMany<typeof Capture>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PaymentuseConnection:(connection: string) => Payment$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Payment>>, allowExtraProperties?: boolean) => Paymentmerge:(value: Partial<ModelAttributes<Payment>>, allowExtraProperties?: boolean) => PaymentisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "intentId" | "state" | "amountAmount" | "amountCurrency" | "providerChargeId" | "rawPayload" | "orderId" | ("id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "intentId" | "state" | "amountAmount" | "amountCurrency" | "providerChargeId" | "rawPayload" | "orderId" | undefined)[] | undefined) => booleanenableForceUpdate:() => Paymentsave:() => Promise<Payment>saveQuietly:() => Promise<Payment>lockForUpdate:<T>(callback: (user: Payment) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Payment>load:LucidRowPreload<Payment>loadOnce:LucidRowPreloadOnce<Payment>preload:LucidRowPreload<Payment>loadAggregate:<Self extends Payment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Payment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Payment>>(relation: Name) => NonNullable<Payment[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Payment[Name] & {})["client"] : never
PaymentCustomer
Class
PaymentCustomerPublic members
customerId:stringprovider:stringproviderCustomerId:stringmetadata:Record<string, unknown> | nullpaymentMethods:HasMany<typeof PaymentMethod>id:stringcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PaymentCustomeruseConnection:(connection: string) => PaymentCustomer$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<PaymentCustomer>>, allowExtraProperties?: boolean) => PaymentCustomermerge:(value: Partial<ModelAttributes<PaymentCustomer>>, allowExtraProperties?: boolean) => PaymentCustomerisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "customerId" | "metadata" | "provider" | "providerCustomerId" | ("id" | "createdAt" | "updatedAt" | "customerId" | "metadata" | "provider" | "providerCustomerId" | undefined)[] | undefined) => booleanenableForceUpdate:() => PaymentCustomersave:() => Promise<PaymentCustomer>saveQuietly:() => Promise<PaymentCustomer>lockForUpdate:<T>(callback: (user: PaymentCustomer) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<PaymentCustomer>load:LucidRowPreload<PaymentCustomer>loadOnce:LucidRowPreloadOnce<PaymentCustomer>preload:LucidRowPreload<PaymentCustomer>loadAggregate:<Self extends PaymentCustomer, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends PaymentCustomer, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<PaymentCustomer>>(relation: Name) => NonNullable<PaymentCustomer[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & PaymentCustomer[Name] & {})["client"] : never
PaymentInstruction
Class
PaymentInstructionPublic members
intentId:stringorderId:stringtype:"virtual_account" | "qr_code" | "redirect" | "retail_outlet" | "bank_transfer"details:Record<string, unknown>expiresAt:DateTime<boolean>intent:BelongsTo<typeof PaymentIntent>order:BelongsTo<typeof Order>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PaymentInstructionuseConnection:(connection: string) => PaymentInstruction$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<PaymentInstruction>>, allowExtraProperties?: boolean) => PaymentInstructionmerge:(value: Partial<ModelAttributes<PaymentInstruction>>, allowExtraProperties?: boolean) => PaymentInstructionisDirty:(fields?: "id" | "details" | "createdAt" | "updatedAt" | "metadata" | "intentId" | "orderId" | "expiresAt" | "type" | ("id" | "details" | "createdAt" | "updatedAt" | "metadata" | "intentId" | "orderId" | "expiresAt" | "type" | undefined)[] | undefined) => booleanenableForceUpdate:() => PaymentInstructionsave:() => Promise<PaymentInstruction>saveQuietly:() => Promise<PaymentInstruction>lockForUpdate:<T>(callback: (user: PaymentInstruction) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<PaymentInstruction>load:LucidRowPreload<PaymentInstruction>loadOnce:LucidRowPreloadOnce<PaymentInstruction>preload:LucidRowPreload<PaymentInstruction>loadAggregate:<Self extends PaymentInstruction, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends PaymentInstruction, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<PaymentInstruction>>(relation: Name) => NonNullable<PaymentInstruction[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & PaymentInstruction[Name] & {})["client"] : never
PaymentIntent
Class
PaymentIntentPublic members
orderId:string | nullcartId:string | nullprovider:stringstate:PaymentIntentStateflow:"authorize_capture" | "deferred"inventoryPolicy:"reserve" | "commit" | nullamount:MoneyamountAmount:bigintamountCurrency:stringproviderIntentId:string | nullclientSecretEnc:string | nulllastError:Record<string, unknown> | nullexpiresAt:DateTime<boolean> | nullreviewReason:string | nullproviderEventTime:DateTime<boolean> | nullcurrentProviderStatus:string | nullorder:BelongsTo<typeof Order>cart:BelongsTo<typeof Cart>payments:HasMany<typeof Payment>instructions:HasMany<typeof PaymentInstruction>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PaymentIntentuseConnection:(connection: string) => PaymentIntent$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<PaymentIntent>>, allowExtraProperties?: boolean) => PaymentIntentmerge:(value: Partial<ModelAttributes<PaymentIntent>>, allowExtraProperties?: boolean) => PaymentIntentisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "state" | "amountAmount" | "amountCurrency" | "orderId" | "cartId" | "provider" | "flow" | "inventoryPolicy" | "providerIntentId" | "clientSecretEnc" | "lastError" | "expiresAt" | "reviewReason" | "providerEventTime" | "currentProviderStatus" | ("id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "state" | "amountAmount" | "amountCurrency" | "orderId" | "cartId" | "provider" | "flow" | "inventoryPolicy" | "providerIntentId" | "clientSecretEnc" | "lastError" | "expiresAt" | "reviewReason" | "providerEventTime" | "currentProviderStatus" | undefined)[] | undefined) => booleanenableForceUpdate:() => PaymentIntentsave:() => Promise<PaymentIntent>saveQuietly:() => Promise<PaymentIntent>lockForUpdate:<T>(callback: (user: PaymentIntent) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<PaymentIntent>load:LucidRowPreload<PaymentIntent>loadOnce:LucidRowPreloadOnce<PaymentIntent>preload:LucidRowPreload<PaymentIntent>loadAggregate:<Self extends PaymentIntent, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends PaymentIntent, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<PaymentIntent>>(relation: Name) => NonNullable<PaymentIntent[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & PaymentIntent[Name] & {})["client"] : never
PaymentIntentState
Type
PaymentIntentStatePaymentMethod
Class
PaymentMethodPublic members
paymentCustomerId:stringproviderPaymentMethodId:stringtype:stringlabel:stringlastFour:string | nullexpiryMonth:number | nullexpiryYear:number | nullisDefault:booleanmetadata:Record<string, unknown> | nullpaymentCustomer:BelongsTo<typeof PaymentCustomer>id:stringcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PaymentMethoduseConnection:(connection: string) => PaymentMethod$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<PaymentMethod>>, allowExtraProperties?: boolean) => PaymentMethodmerge:(value: Partial<ModelAttributes<PaymentMethod>>, allowExtraProperties?: boolean) => PaymentMethodisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "isDefault" | "label" | "type" | "paymentCustomerId" | "providerPaymentMethodId" | "lastFour" | "expiryMonth" | "expiryYear" | ("id" | "createdAt" | "updatedAt" | "metadata" | "isDefault" | "label" | "type" | "paymentCustomerId" | "providerPaymentMethodId" | "lastFour" | "expiryMonth" | "expiryYear" | undefined)[] | undefined) => booleanenableForceUpdate:() => PaymentMethodsave:() => Promise<PaymentMethod>saveQuietly:() => Promise<PaymentMethod>lockForUpdate:<T>(callback: (user: PaymentMethod) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<PaymentMethod>load:LucidRowPreload<PaymentMethod>loadOnce:LucidRowPreloadOnce<PaymentMethod>preload:LucidRowPreload<PaymentMethod>loadAggregate:<Self extends PaymentMethod, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends PaymentMethod, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<PaymentMethod>>(relation: Name) => NonNullable<PaymentMethod[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & PaymentMethod[Name] & {})["client"] : never
PaymentOperation
Class
PaymentOperationPublic members
paymentId:stringcaptureId:string | nullintentId:stringoperation:PaymentOperationTypeidempotencyKey:stringrequestHash:stringstate:PaymentOperationStateamount:MoneyamountAmount:bigintamountCurrency:stringresponse:unknownerror:unknownpayment:BelongsTo<typeof Payment>intent:BelongsTo<typeof PaymentIntent>capture:BelongsTo<typeof Capture>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PaymentOperationuseConnection:(connection: string) => PaymentOperation$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<PaymentOperation>>, allowExtraProperties?: boolean) => PaymentOperationmerge:(value: Partial<ModelAttributes<PaymentOperation>>, allowExtraProperties?: boolean) => PaymentOperationisDirty:(fields?: "error" | "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "paymentId" | "intentId" | "state" | "amountAmount" | "amountCurrency" | "captureId" | "requestHash" | "response" | "idempotencyKey" | "operation" | ("error" | "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "paymentId" | "intentId" | "state" | "amountAmount" | "amountCurrency" | "captureId" | "requestHash" | "response" | "idempotencyKey" | "operation" | undefined)[] | undefined) => booleanenableForceUpdate:() => PaymentOperationsave:() => Promise<PaymentOperation>saveQuietly:() => Promise<PaymentOperation>lockForUpdate:<T>(callback: (user: PaymentOperation) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<PaymentOperation>load:LucidRowPreload<PaymentOperation>loadOnce:LucidRowPreloadOnce<PaymentOperation>preload:LucidRowPreload<PaymentOperation>loadAggregate:<Self extends PaymentOperation, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends PaymentOperation, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<PaymentOperation>>(relation: Name) => NonNullable<PaymentOperation[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & PaymentOperation[Name] & {})["client"] : never
PaymentOperationState
Type
PaymentOperationStatePaymentOperationType
Type
PaymentOperationTypePaymentState
Type
PaymentStatePrice
Class
PricePublic members
priceListId:stringvariantId:stringunitPrice:MoneyunitPriceAmount:bigintunitPriceCurrency:stringminQuantity:numberpriceList:BelongsTo<typeof PriceList>variant:BelongsTo<typeof ProductVariant>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PriceuseConnection:(connection: string) => Price$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Price>>, allowExtraProperties?: boolean) => Pricemerge:(value: Partial<ModelAttributes<Price>>, allowExtraProperties?: boolean) => PriceisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "variantId" | "unitPrice" | "unitPriceAmount" | "unitPriceCurrency" | "priceListId" | "minQuantity" | ("id" | "createdAt" | "updatedAt" | "metadata" | "variantId" | "unitPrice" | "unitPriceAmount" | "unitPriceCurrency" | "priceListId" | "minQuantity" | undefined)[] | undefined) => booleanenableForceUpdate:() => Pricesave:() => Promise<Price>saveQuietly:() => Promise<Price>lockForUpdate:<T>(callback: (user: Price) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Price>load:LucidRowPreload<Price>loadOnce:LucidRowPreloadOnce<Price>preload:LucidRowPreload<Price>loadAggregate:<Self extends Price, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Price, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Price>>(relation: Name) => NonNullable<Price[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Price[Name] & {})["client"] : never
PriceList
Class
PriceListPublic members
name:stringchannelId:string | nullcustomerGroupId:string | nullpriority:numberstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullisDefault:booleanchannel:BelongsTo<typeof Channel>customerGroup:BelongsTo<typeof CustomerGroup>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => PriceListuseConnection:(connection: string) => PriceList$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<PriceList>>, allowExtraProperties?: boolean) => PriceListmerge:(value: Partial<ModelAttributes<PriceList>>, allowExtraProperties?: boolean) => PriceListisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "channelId" | "isDefault" | "customerGroupId" | "priority" | "startsAt" | "endsAt" | ("id" | "name" | "createdAt" | "updatedAt" | "metadata" | "channelId" | "isDefault" | "customerGroupId" | "priority" | "startsAt" | "endsAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => PriceListsave:() => Promise<PriceList>saveQuietly:() => Promise<PriceList>lockForUpdate:<T>(callback: (user: PriceList) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<PriceList>load:LucidRowPreload<PriceList>loadOnce:LucidRowPreloadOnce<PriceList>preload:LucidRowPreload<PriceList>loadAggregate:<Self extends PriceList, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends PriceList, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<PriceList>>(relation: Name) => NonNullable<PriceList[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & PriceList[Name] & {})["client"] : never
Product
Class
ProductPublic members
status:ProductStatusname:stringslug:stringdescription:string | nullimages:HasMany<typeof ProductImage>options:HasMany<typeof ProductOption>variants:HasMany<typeof ProductVariant>categories:ManyToMany<typeof Category>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ProductuseConnection:(connection: string) => Product$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Product>>, allowExtraProperties?: boolean) => Productmerge:(value: Partial<ModelAttributes<Product>>, allowExtraProperties?: boolean) => ProductisDirty:(fields?: "id" | "name" | "status" | "createdAt" | "updatedAt" | "metadata" | "slug" | "description" | ("id" | "name" | "status" | "createdAt" | "updatedAt" | "metadata" | "slug" | "description" | undefined)[] | undefined) => booleanenableForceUpdate:() => Productsave:() => Promise<Product>saveQuietly:() => Promise<Product>lockForUpdate:<T>(callback: (user: Product) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Product>load:LucidRowPreload<Product>loadOnce:LucidRowPreloadOnce<Product>preload:LucidRowPreload<Product>loadAggregate:<Self extends Product, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Product, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Product>>(relation: Name) => NonNullable<Product[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Product[Name] & {})["client"] : never
ProductImage
Class
ProductImagePublic members
productId:stringassetId:string | nullurl:stringdisk:string | nullkey:string | nullaltText:string | nullposition:numbermimeType:stringsizeBytes:numberwidth:numberheight:numberproduct:BelongsTo<typeof Product>variants:ManyToMany<typeof ProductVariant>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ProductImageuseConnection:(connection: string) => ProductImage$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ProductImage>>, allowExtraProperties?: boolean) => ProductImagemerge:(value: Partial<ModelAttributes<ProductImage>>, allowExtraProperties?: boolean) => ProductImageisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "assetId" | "disk" | "key" | "metadata" | "position" | "productId" | "url" | "mimeType" | "sizeBytes" | "width" | "height" | "altText" | ("id" | "createdAt" | "updatedAt" | "assetId" | "disk" | "key" | "metadata" | "position" | "productId" | "url" | "mimeType" | "sizeBytes" | "width" | "height" | "altText" | undefined)[] | undefined) => booleanenableForceUpdate:() => ProductImagesave:() => Promise<ProductImage>saveQuietly:() => Promise<ProductImage>lockForUpdate:<T>(callback: (user: ProductImage) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ProductImage>load:LucidRowPreload<ProductImage>loadOnce:LucidRowPreloadOnce<ProductImage>preload:LucidRowPreload<ProductImage>loadAggregate:<Self extends ProductImage, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ProductImage, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ProductImage>>(relation: Name) => NonNullable<ProductImage[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ProductImage[Name] & {})["client"] : never
ProductOption
Class
ProductOptionPublic members
productId:stringname:stringposition:numberproduct:BelongsTo<typeof Product>values:HasMany<typeof ProductOptionValue>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ProductOptionuseConnection:(connection: string) => ProductOption$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ProductOption>>, allowExtraProperties?: boolean) => ProductOptionmerge:(value: Partial<ModelAttributes<ProductOption>>, allowExtraProperties?: boolean) => ProductOptionisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "position" | "productId" | ("id" | "name" | "createdAt" | "updatedAt" | "metadata" | "position" | "productId" | undefined)[] | undefined) => booleanenableForceUpdate:() => ProductOptionsave:() => Promise<ProductOption>saveQuietly:() => Promise<ProductOption>lockForUpdate:<T>(callback: (user: ProductOption) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ProductOption>load:LucidRowPreload<ProductOption>loadOnce:LucidRowPreloadOnce<ProductOption>preload:LucidRowPreload<ProductOption>loadAggregate:<Self extends ProductOption, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ProductOption, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ProductOption>>(relation: Name) => NonNullable<ProductOption[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ProductOption[Name] & {})["client"] : never
ProductOptionValue
Class
ProductOptionValuePublic members
optionId:stringvalue:stringposition:numberoption:BelongsTo<typeof ProductOption>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ProductOptionValueuseConnection:(connection: string) => ProductOptionValue$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ProductOptionValue>>, allowExtraProperties?: boolean) => ProductOptionValuemerge:(value: Partial<ModelAttributes<ProductOptionValue>>, allowExtraProperties?: boolean) => ProductOptionValueisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "position" | "optionId" | "value" | ("id" | "createdAt" | "updatedAt" | "metadata" | "position" | "optionId" | "value" | undefined)[] | undefined) => booleanenableForceUpdate:() => ProductOptionValuesave:() => Promise<ProductOptionValue>saveQuietly:() => Promise<ProductOptionValue>lockForUpdate:<T>(callback: (user: ProductOptionValue) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ProductOptionValue>load:LucidRowPreload<ProductOptionValue>loadOnce:LucidRowPreloadOnce<ProductOptionValue>preload:LucidRowPreload<ProductOptionValue>loadAggregate:<Self extends ProductOptionValue, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ProductOptionValue, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ProductOptionValue>>(relation: Name) => NonNullable<ProductOptionValue[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ProductOptionValue[Name] & {})["client"] : never
ProductStatus
Type
ProductStatusProductVariant
Class
ProductVariantPublic members
productId:stringtaxCategoryId:string | nullsku:string | nullname:string | nullposition:numberisDefault:booleanweightGrams:number | nulllengthMm:number | nullwidthMm:number | nullheightMm:number | nullimages:ManyToMany<typeof ProductImage>product:BelongsTo<typeof Product>optionValues:ManyToMany<typeof ProductOptionValue>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ProductVariantuseConnection:(connection: string) => ProductVariant$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ProductVariant>>, allowExtraProperties?: boolean) => ProductVariantmerge:(value: Partial<ModelAttributes<ProductVariant>>, allowExtraProperties?: boolean) => ProductVariantisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "isDefault" | "position" | "productId" | "taxCategoryId" | "sku" | "weightGrams" | "lengthMm" | "widthMm" | "heightMm" | ("id" | "name" | "createdAt" | "updatedAt" | "metadata" | "isDefault" | "position" | "productId" | "taxCategoryId" | "sku" | "weightGrams" | "lengthMm" | "widthMm" | "heightMm" | undefined)[] | undefined) => booleanenableForceUpdate:() => ProductVariantsave:() => Promise<ProductVariant>saveQuietly:() => Promise<ProductVariant>lockForUpdate:<T>(callback: (user: ProductVariant) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ProductVariant>load:LucidRowPreload<ProductVariant>loadOnce:LucidRowPreloadOnce<ProductVariant>preload:LucidRowPreload<ProductVariant>loadAggregate:<Self extends ProductVariant, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ProductVariant, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ProductVariant>>(relation: Name) => NonNullable<ProductVariant[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ProductVariant[Name] & {})["client"] : never
Refund
Class
RefundPublic members
paymentId:stringcaptureId:string | nullstate:RefundStatereason:string | nullamount:MoneyamountAmount:bigintamountCurrency:stringproviderRefundId:string | nullrawPayload:unknownpayment:BelongsTo<typeof Payment>capture:BelongsTo<typeof Capture>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => RefunduseConnection:(connection: string) => Refund$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Refund>>, allowExtraProperties?: boolean) => Refundmerge:(value: Partial<ModelAttributes<Refund>>, allowExtraProperties?: boolean) => RefundisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "paymentId" | "state" | "amountAmount" | "amountCurrency" | "rawPayload" | "captureId" | "reason" | "providerRefundId" | ("id" | "createdAt" | "updatedAt" | "amount" | "metadata" | "paymentId" | "state" | "amountAmount" | "amountCurrency" | "rawPayload" | "captureId" | "reason" | "providerRefundId" | undefined)[] | undefined) => booleanenableForceUpdate:() => Refundsave:() => Promise<Refund>saveQuietly:() => Promise<Refund>lockForUpdate:<T>(callback: (user: Refund) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Refund>load:LucidRowPreload<Refund>loadOnce:LucidRowPreloadOnce<Refund>preload:LucidRowPreload<Refund>loadAggregate:<Self extends Refund, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Refund, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Refund>>(relation: Name) => NonNullable<Refund[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Refund[Name] & {})["client"] : never
RefundState
Type
RefundStateReservation
Class
ReservationPublic members
levelId:stringcartId:stringcartLineId:stringquantity:numberreturnedQuantity:numberbackorderedQuantity:numberexpiresAt:DateTime<boolean>state:ReservationStatelevel:BelongsTo<typeof InventoryLevel>cart:BelongsTo<typeof Cart>cartLine:BelongsTo<typeof CartLine>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ReservationuseConnection:(connection: string) => Reservation$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Reservation>>, allowExtraProperties?: boolean) => Reservationmerge:(value: Partial<ModelAttributes<Reservation>>, allowExtraProperties?: boolean) => ReservationisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "state" | "cartId" | "expiresAt" | "quantity" | "cartLineId" | "levelId" | "returnedQuantity" | "backorderedQuantity" | ("id" | "createdAt" | "updatedAt" | "metadata" | "state" | "cartId" | "expiresAt" | "quantity" | "cartLineId" | "levelId" | "returnedQuantity" | "backorderedQuantity" | undefined)[] | undefined) => booleanenableForceUpdate:() => Reservationsave:() => Promise<Reservation>saveQuietly:() => Promise<Reservation>lockForUpdate:<T>(callback: (user: Reservation) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Reservation>load:LucidRowPreload<Reservation>loadOnce:LucidRowPreloadOnce<Reservation>preload:LucidRowPreload<Reservation>loadAggregate:<Self extends Reservation, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Reservation, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Reservation>>(relation: Name) => NonNullable<Reservation[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Reservation[Name] & {})["client"] : never
ReservationState
Type
ReservationStateresolveCommerceTable
Function
(name: string) => stringReturnDisposition
Type
ReturnDispositionReturnLine
Class
ReturnLinePublic members
returnId:stringorderLineId:stringreasonId:stringrequestedQuantity:numberreceivedQuantity:numberacceptedQuantity:numberrejectedQuantity:numberdisposition:ReturnDisposition | nullnote:string | nullrefundAmount:MoneyrefundAmountAmount:bigintrefundAmountCurrency:stringreturnRequest:BelongsTo<typeof ReturnRequest>orderLine:BelongsTo<typeof OrderLine>reason:BelongsTo<typeof ReturnReason>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ReturnLineuseConnection:(connection: string) => ReturnLine$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ReturnLine>>, allowExtraProperties?: boolean) => ReturnLinemerge:(value: Partial<ModelAttributes<ReturnLine>>, allowExtraProperties?: boolean) => ReturnLineisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "note" | "refundAmount" | "refundAmountAmount" | "refundAmountCurrency" | "orderLineId" | "returnId" | "reasonId" | "requestedQuantity" | "receivedQuantity" | "acceptedQuantity" | "rejectedQuantity" | "disposition" | ("id" | "createdAt" | "updatedAt" | "metadata" | "note" | "refundAmount" | "refundAmountAmount" | "refundAmountCurrency" | "orderLineId" | "returnId" | "reasonId" | "requestedQuantity" | "receivedQuantity" | "acceptedQuantity" | "rejectedQuantity" | "disposition" | undefined)[] | undefined) => booleanenableForceUpdate:() => ReturnLinesave:() => Promise<ReturnLine>saveQuietly:() => Promise<ReturnLine>lockForUpdate:<T>(callback: (user: ReturnLine) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ReturnLine>load:LucidRowPreload<ReturnLine>loadOnce:LucidRowPreloadOnce<ReturnLine>preload:LucidRowPreload<ReturnLine>loadAggregate:<Self extends ReturnLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ReturnLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ReturnLine>>(relation: Name) => NonNullable<ReturnLine[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ReturnLine[Name] & {})["client"] : never
ReturnReason
Class
ReturnReasonPublic members
code:stringname:stringactive:booleanrequiresNote:booleanid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ReturnReasonuseConnection:(connection: string) => ReturnReason$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ReturnReason>>, allowExtraProperties?: boolean) => ReturnReasonmerge:(value: Partial<ModelAttributes<ReturnReason>>, allowExtraProperties?: boolean) => ReturnReasonisDirty:(fields?: "code" | "id" | "name" | "createdAt" | "updatedAt" | "active" | "metadata" | "requiresNote" | ("code" | "id" | "name" | "createdAt" | "updatedAt" | "active" | "metadata" | "requiresNote" | undefined)[] | undefined) => booleanenableForceUpdate:() => ReturnReasonsave:() => Promise<ReturnReason>saveQuietly:() => Promise<ReturnReason>lockForUpdate:<T>(callback: (user: ReturnReason) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ReturnReason>load:LucidRowPreload<ReturnReason>loadOnce:LucidRowPreloadOnce<ReturnReason>preload:LucidRowPreload<ReturnReason>loadAggregate:<Self extends ReturnReason, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ReturnReason, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<ReturnReason[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ReturnReason[Name] & {})["client"] : never
ReturnRequest
Class
ReturnRequestPublic members
number:stringorderId:stringcustomerId:string | nullstate:ReturnStatenote:string | nullcurrency:stringrefundAmount:MoneyrefundAmountAmount:bigintrefundAmountCurrency:stringrefundId:string | nullexchangeOrderId:string | nullauthorizedAt:DateTime<boolean> | nullreceivedAt:DateTime<boolean> | nullcompletedAt:DateTime<boolean> | nullorder:BelongsTo<typeof Order>customer:BelongsTo<typeof Customer>refund:BelongsTo<typeof Refund>exchangeOrder:BelongsTo<typeof Order>lines:HasMany<typeof ReturnLine>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ReturnRequestuseConnection:(connection: string) => ReturnRequest$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ReturnRequest>>, allowExtraProperties?: boolean) => ReturnRequestmerge:(value: Partial<ModelAttributes<ReturnRequest>>, allowExtraProperties?: boolean) => ReturnRequestisDirty:(fields?: "number" | "id" | "createdAt" | "updatedAt" | "customerId" | "metadata" | "state" | "currency" | "orderId" | "note" | "refundAmount" | "refundAmountAmount" | "refundAmountCurrency" | "refundId" | "exchangeOrderId" | "authorizedAt" | "receivedAt" | "completedAt" | ("number" | "id" | "createdAt" | "updatedAt" | "customerId" | "metadata" | "state" | "currency" | "orderId" | "note" | "refundAmount" | "refundAmountAmount" | "refundAmountCurrency" | "refundId" | "exchangeOrderId" | "authorizedAt" | "receivedAt" | "completedAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => ReturnRequestsave:() => Promise<ReturnRequest>saveQuietly:() => Promise<ReturnRequest>lockForUpdate:<T>(callback: (user: ReturnRequest) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ReturnRequest>load:LucidRowPreload<ReturnRequest>loadOnce:LucidRowPreloadOnce<ReturnRequest>preload:LucidRowPreload<ReturnRequest>loadAggregate:<Self extends ReturnRequest, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ReturnRequest, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ReturnRequest>>(relation: Name) => NonNullable<ReturnRequest[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ReturnRequest[Name] & {})["client"] : never
ReturnState
Type
ReturnStateReturnTransition
Type
ReturnTransitionShipment
Class
ShipmentPublic members
orderId:stringstate:ShipmentStatetrackingNumber:string | nullcarrier:string | nullshippedAt:DateTime<boolean> | nulldeliveredAt:DateTime<boolean> | nullprovider:string | nullproviderShipmentId:string | nullwaybill:string | nullhandedOffAt:DateTime<boolean> | nulldeliveryFailedAt:DateTime<boolean> | nullreturnedAt:DateTime<boolean> | nullinventoryRestockedAt:DateTime<boolean> | nullorder:BelongsTo<typeof Order>lines:HasMany<typeof ShipmentLine>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ShipmentuseConnection:(connection: string) => Shipment$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<Shipment>>, allowExtraProperties?: boolean) => Shipmentmerge:(value: Partial<ModelAttributes<Shipment>>, allowExtraProperties?: boolean) => ShipmentisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "deliveredAt" | "metadata" | "state" | "orderId" | "provider" | "trackingNumber" | "carrier" | "shippedAt" | "providerShipmentId" | "waybill" | "handedOffAt" | "deliveryFailedAt" | "returnedAt" | "inventoryRestockedAt" | ("id" | "createdAt" | "updatedAt" | "deliveredAt" | "metadata" | "state" | "orderId" | "provider" | "trackingNumber" | "carrier" | "shippedAt" | "providerShipmentId" | "waybill" | "handedOffAt" | "deliveryFailedAt" | "returnedAt" | "inventoryRestockedAt" | undefined)[] | undefined) => booleanenableForceUpdate:() => Shipmentsave:() => Promise<Shipment>saveQuietly:() => Promise<Shipment>lockForUpdate:<T>(callback: (user: Shipment) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<Shipment>load:LucidRowPreload<Shipment>loadOnce:LucidRowPreloadOnce<Shipment>preload:LucidRowPreload<Shipment>loadAggregate:<Self extends Shipment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends Shipment, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<Shipment>>(relation: Name) => NonNullable<Shipment[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Shipment[Name] & {})["client"] : never
ShipmentLine
Class
ShipmentLinePublic members
shipmentId:stringorderLineId:stringquantity:numbershipment:BelongsTo<typeof Shipment>orderLine:BelongsTo<typeof OrderLine>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ShipmentLineuseConnection:(connection: string) => ShipmentLine$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ShipmentLine>>, allowExtraProperties?: boolean) => ShipmentLinemerge:(value: Partial<ModelAttributes<ShipmentLine>>, allowExtraProperties?: boolean) => ShipmentLineisDirty:(fields?: "id" | "createdAt" | "updatedAt" | "metadata" | "quantity" | "orderLineId" | "shipmentId" | ("id" | "createdAt" | "updatedAt" | "metadata" | "quantity" | "orderLineId" | "shipmentId" | undefined)[] | undefined) => booleanenableForceUpdate:() => ShipmentLinesave:() => Promise<ShipmentLine>saveQuietly:() => Promise<ShipmentLine>lockForUpdate:<T>(callback: (user: ShipmentLine) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ShipmentLine>load:LucidRowPreload<ShipmentLine>loadOnce:LucidRowPreloadOnce<ShipmentLine>preload:LucidRowPreload<ShipmentLine>loadAggregate:<Self extends ShipmentLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ShipmentLine, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<ShipmentLine>>(relation: Name) => NonNullable<ShipmentLine[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ShipmentLine[Name] & {})["client"] : never
ShipmentState
Type
ShipmentStateShippingMethod
Class
ShippingMethodPublic members
code:stringname:stringcalculator:stringcalculatorConfig:Record<string, unknown>channelId:string | nullposition:numberenabled:booleanid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => ShippingMethoduseConnection:(connection: string) => ShippingMethod$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<ShippingMethod>>, allowExtraProperties?: boolean) => ShippingMethodmerge:(value: Partial<ModelAttributes<ShippingMethod>>, allowExtraProperties?: boolean) => ShippingMethodisDirty:(fields?: "code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "channelId" | "calculator" | "calculatorConfig" | "position" | "enabled" | ("code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "channelId" | "calculator" | "calculatorConfig" | "position" | "enabled" | undefined)[] | undefined) => booleanenableForceUpdate:() => ShippingMethodsave:() => Promise<ShippingMethod>saveQuietly:() => Promise<ShippingMethod>lockForUpdate:<T>(callback: (user: ShippingMethod) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<ShippingMethod>load:LucidRowPreload<ShippingMethod>loadOnce:LucidRowPreloadOnce<ShippingMethod>preload:LucidRowPreload<ShippingMethod>loadAggregate:<Self extends ShippingMethod, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends ShippingMethod, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<ShippingMethod[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & ShippingMethod[Name] & {})["client"] : never
StockLocation
Class
StockLocationPublic members
code:stringname:stringaddress:AddressInput | nullisDefault:booleanlevels:HasMany<typeof InventoryLevel>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => StockLocationuseConnection:(connection: string) => StockLocation$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<StockLocation>>, allowExtraProperties?: boolean) => StockLocationmerge:(value: Partial<ModelAttributes<StockLocation>>, allowExtraProperties?: boolean) => StockLocationisDirty:(fields?: "code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "isDefault" | "address" | ("code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "isDefault" | "address" | undefined)[] | undefined) => booleanenableForceUpdate:() => StockLocationsave:() => Promise<StockLocation>saveQuietly:() => Promise<StockLocation>lockForUpdate:<T>(callback: (user: StockLocation) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<StockLocation>load:LucidRowPreload<StockLocation>loadOnce:LucidRowPreloadOnce<StockLocation>preload:LucidRowPreload<StockLocation>loadAggregate:<Self extends StockLocation, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends StockLocation, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<StockLocation>>(relation: Name) => NonNullable<StockLocation[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & StockLocation[Name] & {})["client"] : never
TaxCategory
Class
TaxCategoryPublic members
code:stringname:stringid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => TaxCategoryuseConnection:(connection: string) => TaxCategory$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<TaxCategory>>, allowExtraProperties?: boolean) => TaxCategorymerge:(value: Partial<ModelAttributes<TaxCategory>>, allowExtraProperties?: boolean) => TaxCategoryisDirty:(fields?: "code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | ("code" | "id" | "name" | "createdAt" | "updatedAt" | "metadata" | undefined)[] | undefined) => booleanenableForceUpdate:() => TaxCategorysave:() => Promise<TaxCategory>saveQuietly:() => Promise<TaxCategory>lockForUpdate:<T>(callback: (user: TaxCategory) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<TaxCategory>load:LucidRowPreload<TaxCategory>loadOnce:LucidRowPreloadOnce<TaxCategory>preload:LucidRowPreload<TaxCategory>loadAggregate:<Self extends TaxCategory, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends TaxCategory, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<TaxCategory[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & TaxCategory[Name] & {})["client"] : never
TaxRate
Class
TaxRatePublic members
zoneId:stringtaxCategoryId:string | nullname:stringrateBp:numberid:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => TaxRateuseConnection:(connection: string) => TaxRate$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<TaxRate>>, allowExtraProperties?: boolean) => TaxRatemerge:(value: Partial<ModelAttributes<TaxRate>>, allowExtraProperties?: boolean) => TaxRateisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "taxCategoryId" | "zoneId" | "rateBp" | ("id" | "name" | "createdAt" | "updatedAt" | "metadata" | "taxCategoryId" | "zoneId" | "rateBp" | undefined)[] | undefined) => booleanenableForceUpdate:() => TaxRatesave:() => Promise<TaxRate>saveQuietly:() => Promise<TaxRate>lockForUpdate:<T>(callback: (user: TaxRate) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<TaxRate>load:LucidRowPreload<TaxRate>loadOnce:LucidRowPreloadOnce<TaxRate>preload:LucidRowPreload<TaxRate>loadAggregate:<Self extends TaxRate, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends TaxRate, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<TaxRate[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & TaxRate[Name] & {})["client"] : never
TaxZone
Class
TaxZonePublic members
name:stringcountryCodes:string[]regionPattern:string | nullpostalPattern:string | nullrates:HasMany<typeof TaxRate>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => TaxZoneuseConnection:(connection: string) => TaxZone$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<TaxZone>>, allowExtraProperties?: boolean) => TaxZonemerge:(value: Partial<ModelAttributes<TaxZone>>, allowExtraProperties?: boolean) => TaxZoneisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "metadata" | "countryCodes" | "regionPattern" | "postalPattern" | ("id" | "name" | "createdAt" | "updatedAt" | "metadata" | "countryCodes" | "regionPattern" | "postalPattern" | undefined)[] | undefined) => booleanenableForceUpdate:() => TaxZonesave:() => Promise<TaxZone>saveQuietly:() => Promise<TaxZone>lockForUpdate:<T>(callback: (user: TaxZone) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<TaxZone>load:LucidRowPreload<TaxZone>loadOnce:LucidRowPreloadOnce<TaxZone>preload:LucidRowPreload<TaxZone>loadAggregate:<Self extends TaxZone, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends TaxZone, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<TaxZone>>(relation: Name) => NonNullable<TaxZone[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & TaxZone[Name] & {})["client"] : never
WebhookDelivery
Class
WebhookDeliveryPublic members
destinationId:stringoutboxId:stringeventName:stringstatus:OutboundWebhookDeliveryStateattempts:numberrequestBody:stringresponseStatus:number | nullresponseBody:string | nulllastError:string | nullnextAttemptAt:DateTime<boolean> | nulldeliveredAt:DateTime<boolean> | nulldeadLetteredAt:DateTime<boolean> | nulldestination:BelongsTo<typeof WebhookDestination>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => WebhookDeliveryuseConnection:(connection: string) => WebhookDelivery$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<WebhookDelivery>>, allowExtraProperties?: boolean) => WebhookDeliverymerge:(value: Partial<ModelAttributes<WebhookDelivery>>, allowExtraProperties?: boolean) => WebhookDeliveryisDirty:(fields?: "id" | "status" | "createdAt" | "updatedAt" | "destinationId" | "outboxId" | "eventName" | "attempts" | "responseStatus" | "nextAttemptAt" | "deliveredAt" | "deadLetteredAt" | "metadata" | "lastError" | "requestBody" | "responseBody" | ("id" | "status" | "createdAt" | "updatedAt" | "destinationId" | "outboxId" | "eventName" | "attempts" | "responseStatus" | "nextAttemptAt" | "deliveredAt" | "deadLetteredAt" | "metadata" | "lastError" | "requestBody" | "responseBody" | undefined)[] | undefined) => booleanenableForceUpdate:() => WebhookDeliverysave:() => Promise<WebhookDelivery>saveQuietly:() => Promise<WebhookDelivery>lockForUpdate:<T>(callback: (user: WebhookDelivery) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<WebhookDelivery>load:LucidRowPreload<WebhookDelivery>loadOnce:LucidRowPreloadOnce<WebhookDelivery>preload:LucidRowPreload<WebhookDelivery>loadAggregate:<Self extends WebhookDelivery, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends WebhookDelivery, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<WebhookDelivery>>(relation: Name) => NonNullable<WebhookDelivery[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & WebhookDelivery[Name] & {})["client"] : never
WebhookDestination
Class
WebhookDestinationPublic members
name:stringurl:stringsecretEnc:stringactive:booleansubscriptions:string[]headersEnc:string | nulldeliveries:HasMany<typeof WebhookDelivery>id:stringmetadata:Record<string, unknown> | nullcreatedAt:DateTime<boolean>updatedAt:DateTime<boolean>$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => WebhookDestinationuseConnection:(connection: string) => WebhookDestination$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<WebhookDestination>>, allowExtraProperties?: boolean) => WebhookDestinationmerge:(value: Partial<ModelAttributes<WebhookDestination>>, allowExtraProperties?: boolean) => WebhookDestinationisDirty:(fields?: "id" | "name" | "createdAt" | "updatedAt" | "active" | "metadata" | "url" | "secretEnc" | "subscriptions" | "headersEnc" | ("id" | "name" | "createdAt" | "updatedAt" | "active" | "metadata" | "url" | "secretEnc" | "subscriptions" | "headersEnc" | undefined)[] | undefined) => booleanenableForceUpdate:() => WebhookDestinationsave:() => Promise<WebhookDestination>saveQuietly:() => Promise<WebhookDestination>lockForUpdate:<T>(callback: (user: WebhookDestination) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<WebhookDestination>load:LucidRowPreload<WebhookDestination>loadOnce:LucidRowPreloadOnce<WebhookDestination>preload:LucidRowPreload<WebhookDestination>loadAggregate:<Self extends WebhookDestination, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends WebhookDestination, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends ExtractModelRelations<WebhookDestination>>(relation: Name) => NonNullable<WebhookDestination[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & WebhookDestination[Name] & {})["client"] : never
WebhookEvent
Class
WebhookEventPublic members
id:stringprovider:stringproviderEventId:stringtype:stringpayload:unknownstatus:WebhookEventStatuserror:string | nullreceivedAt:DateTime<boolean>processedAt:DateTime<boolean> | nullproviderEventTime:DateTime<boolean> | nullproviderStatus:string | null$attributes:ModelObject$extras:ModelObject$original:ModelObject$preloaded:{ [relation: string]: LucidRow | LucidRow[]; }$sideloaded:ModelObject$primaryKeyValue:string | number | undefined$isPersisted:boolean$isNew:boolean$isLocal:boolean$dirty:ModelObject$isDirty:boolean$isDeleted:boolean$options:ModelOptions | undefined$trx:TransactionClientContract | undefined$setOptionsAndTrx:(options?: ModelAdapterOptions) => voiduseTransaction:(trx: TransactionClientContract) => WebhookEventuseConnection:(connection: string) => WebhookEvent$getQueryFor:{ (action: "insert", client: QueryClientContract): ReturnType<QueryClientContract["insertQuery"]>; (action: "update" | "delete" | "refresh", client: QueryClientContract): ModelQueryBuilderContract<LucidModel>; }$setAttribute:(key: string, value: any) => void$getAttribute:(key: string) => any$getAttributeFromCache:(key: string, callback: CacheNode["getter"]) => any$hasRelated:(key: string) => boolean$setRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$pushRelated:(key: string, result: OneOrMany<LucidRow> | null) => void$getRelated:(key: string, defaultValue?: any) => OneOrMany<LucidRow> | undefined | null$consumeAdapterResult:(adapterResult: ModelObject, sideloadAttributes?: ModelObject) => void$hydrateOriginals:() => voidfill:(value: Partial<ModelAttributes<WebhookEvent>>, allowExtraProperties?: boolean) => WebhookEventmerge:(value: Partial<ModelAttributes<WebhookEvent>>, allowExtraProperties?: boolean) => WebhookEventisDirty:(fields?: "error" | "id" | "status" | "provider" | "providerEventTime" | "receivedAt" | "payload" | "type" | "providerEventId" | "processedAt" | "providerStatus" | ("error" | "id" | "status" | "provider" | "providerEventTime" | "receivedAt" | "payload" | "type" | "providerEventId" | "processedAt" | "providerStatus" | undefined)[] | undefined) => booleanenableForceUpdate:() => WebhookEventsave:() => Promise<WebhookEvent>saveQuietly:() => Promise<WebhookEvent>lockForUpdate:<T>(callback: (user: WebhookEvent) => T | Promise<T>) => Promise<T>delete:() => Promise<void>deleteQuietly:() => Promise<void>refresh:() => Promise<WebhookEvent>load:LucidRowPreload<WebhookEvent>loadOnce:LucidRowPreloadOnce<WebhookEvent>preload:LucidRowPreload<WebhookEvent>loadAggregate:<Self extends WebhookEvent, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => LazyLoadAggregatesContract<Self>loadCount:<Self extends WebhookEvent, Name extends ExtractModelRelations<Self>, RelatedBuilder = NonNullable<Self[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & Self[Name] & {})["subQuery"] : never>(name: Name, callback?: ((builder: RelatedBuilder) => void) | undefined) => LazyLoadAggregatesContract<Self>serializeAttributes:(fields?: CherryPickFields, raw?: boolean) => ModelObjectserializeComputed:(fields?: CherryPickFields) => ModelObjectserializeRelations:{ (fields: undefined, raw: true): { [key: string]: LucidRow | LucidRow[]; }; (cherryPick: CherryPick["relations"] | undefined, raw: false | undefined): ModelObject; (cherryPick?: CherryPick["relations"], raw?: boolean): ModelObject; }serialize:(cherryPick?: CherryPick) => ModelObjecttoObject:() => ModelObjecttoJSON:() => ModelObjecttoAttributes:() => Record<string, any>related:<Name extends undefined>(relation: Name) => NonNullable<WebhookEvent[Name]> extends ModelRelations<LucidModel, LucidModel> ? (ModelRelations<LucidModel, LucidModel> & WebhookEvent[Name] & {})["client"] : never
WebhookEventStatus
Type
WebhookEventStatus@adocommercekit/core/events
CartAbandoned
Class
CartAbandonedPublic members
cartId:stringchannel:string
CartCreated
Class
CartCreatedPublic members
cartId:stringchannel:string
CartLineAdded
Class
CartLineAddedPublic members
cartId:stringlineId:stringvariantId:stringquantity:number
CartLineQuantityChanged
Class
CartLineQuantityChangedPublic members
cartId:stringlineId:stringvariantId:stringquantity:number
CartLineRemoved
Class
CartLineRemovedPublic members
cartId:stringlineId:stringvariantId:string
CartRecalculated
Class
CartRecalculatedPublic members
cartId:stringtotal:Money
ChannelCreated
Class
ChannelCreatedPublic members
channelId:stringcode:string
CheckoutStarted
Class
CheckoutStartedPublic members
cartId:string
CustomerAnonymized
Class
CustomerAnonymizedPublic members
customerId:string
CustomerRegistered
Class
CustomerRegisteredPublic members
customerId:stringemail:string | null
EventBufferLogger
Interface
EventBufferLoggerPublic members
error:(message: string, context: Readonly<Record<string, unknown>>) => void
EventEmitterPort
Interface
EventEmitterPortPublic members
emit:(event: string, payload: unknown) => Promise<unknown> | unknown
OrderCanceled
Class
OrderCanceledPublic members
orderId:stringcontext:Readonly<Record<string, unknown>>
OrderCompleted
Class
OrderCompletedPublic members
orderId:stringcontext:Readonly<Record<string, unknown>>
OrderConfirmed
Class
OrderConfirmedPublic members
orderId:stringcontext:Readonly<Record<string, unknown>>
OrderFulfilled
Class
OrderFulfilledPublic members
orderId:stringcontext:Readonly<Record<string, unknown>>
OrderPlaced
Class
OrderPlacedPublic members
orderId:stringnumber:stringtotal:MoneycustomerId:string | undefined
PaymentAuthorized
Class
PaymentAuthorizedPublic members
intentId:stringorderId:string | nullamount:Money
PaymentCaptured
Class
PaymentCapturedPublic members
intentId:stringorderId:string | nullamount:Money
PaymentExpired
Class
PaymentExpiredPublic members
intentId:stringorderId:stringexpiredAt:string
PaymentFailed
Class
PaymentFailedPublic members
intentId:stringorderId:string | nullamount:Money
PaymentReviewRequired
Class
PaymentReviewRequiredPublic members
intentId:stringorderId:stringreason:string
ProductArchived
Class
ProductArchivedPublic members
productId:string
ProductCreated
Class
ProductCreatedPublic members
productId:string
ProductImageCreated
Class
ProductImageCreatedPublic members
productId:stringimageId:string
ProductImageRemoved
Class
ProductImageRemovedPublic members
productId:stringimageId:string
ProductImagesReordered
Class
ProductImagesReorderedPublic members
productId:stringimageIds:string[]
ProductImageUpdated
Class
ProductImageUpdatedPublic members
productId:stringimageId:string
ProductUpdated
Class
ProductUpdatedPublic members
productId:string
RefundFailed
Class
RefundFailedPublic members
refundId:stringpaymentId:stringamount:Money
RefundSucceeded
Class
RefundSucceededPublic members
refundId:stringpaymentId:stringamount:Money
ReturnExchanged
Class
ReturnExchangedPublic members
returnId:stringexchangeOrderId:string
ReturnRefunded
Class
ReturnRefundedPublic members
returnId:stringrefundId:string | nullamount:MoneyorderId:stringpaymentAmount:MoneynonPaymentAmount:Money
ReturnRequested
Class
ReturnRequestedPublic members
returnId:stringorderId:stringcustomerId:string | null
ReturnStateChanged
Class
ReturnStateChangedPublic members
returnId:stringfrom:ReturnStateto:ReturnState
ShipmentDelivered
Class
ShipmentDeliveredPublic members
shipmentId:stringorderId:stringtracking:string | null
ShipmentDeliveryFailed
Class
ShipmentDeliveryFailedPublic members
shipmentId:stringorderId:string
ShipmentReturned
Class
ShipmentReturnedPublic members
shipmentId:stringorderId:string
ShipmentShipped
Class
ShipmentShippedPublic members
shipmentId:stringorderId:stringtracking:string | null
StockAdjusted
Class
StockAdjustedPublic members
itemId:stringlocationId:stringdelta:numberreason:string
StockLevelLow
Class
StockLevelLowPublic members
itemId:stringavailable:numberthreshold:number
TransactionalEventEmitter
Class
TransactionalEventEmitterPublic members
#buffers:WeakMap<TransactionHookClient, BufferState>emitter:EventEmitterPortlogger:EventBufferLoggeroutbox:TransactionalOutboxWriter | undefinedbuffer:(trx: TransactionHookClient, name: string, payload: unknown) => voidlinkNestedTransaction:(child: TransactionHookClient, parent: TransactionHookClient) => voidemit:(name: string, payload: unknown, trx?: TransactionHookClient) => Promise<void>nested:<R>(parent: TransactionHookClient, callback: (trx: TransactionHookClient) => Promise<R>) => Promise<R>#state:(trx: TransactionHookClient) => BufferState#flush:(events: BufferedEvent[]) => Promise<void>
TransactionalOutboxWriter
Interface
TransactionalOutboxWriterPublic members
write:(name: string, payload: unknown, trx: TransactionHookClient) => Promise<void>
TransactionHookClient
Interface
TransactionHookClientPublic members
after:(event: "commit" | "rollback", handler: () => void | Promise<void>) => TransactionHookClienttransaction:(<R>(callback: (trx: TransactionHookClient) => Promise<R>) => Promise<R>) | undefined
@adocommercekit/core/drivers
adonisDriveProductImages
Function
Store product images on any public disk configured through @adonisjs/drive.
(disk?: string) => DriverFactory<ProductImageStorage>AdonisQueuePort
Interface
AdonisQueuePortPublic members
dispatch:(job: string, payload: JobPayload, options?: JobDispatchOptions) => Promise<unknown>schedule:(cron: string, job: string, payload?: JobPayload) => Promise<unknown>shutdown:(() => Promise<unknown>) | undefined
allEnabledShippingEligibility
Function
() => (_app: ApplicationService) => ShippingEligibilityAllEnabledShippingEligibility
Class
AllEnabledShippingEligibilityPublic members
eligibleMethods:(_cart: CartSnapshot, methods: ShippingMethodConfig[]) => Promise<string[]>
cashOnDelivery
Function
(options?: { expiresAfterDays?: number; }) => DriverFactory<PaymentProvider>CashOnDeliveryPaymentProvider
Class
CashOnDeliveryPaymentProviderPublic members
code:"cod"expiresAfterDays:numbercapabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; flow: "deferred"; cod: boolean; }createIntent:() => Promise<{ providerIntentId: string; state: "pending"; expiresAt: DateTime<true>; }>confirm:() => Promise<{ state: "pending"; }>capture:() => Promise<{ providerChargeId: string; }>refund:() => Promise<{ providerRefundId: string; }>void:() => Promise<void>retrieveIntent:() => Promise<{ state: "pending"; }>verifyWebhook:() => Promise<boolean>normalizeWebhook:() => Promise<{ type: "unhandled"; providerEventId: `${string}-${string}-${string}-${string}-${string}`; }>
DatabasePriceResolver
Class
DatabasePriceResolverPublic members
db:Databaseconfig:Pick<ResolvedCommerceConfig, "tablePrefix">resolve:(input: { variantId: string; quantity: number; ctx: ChannelContext; trx?: TransactionClientContract; }) => Promise<{ unitPrice: Money; priceListId: string | null; }>
defaultPriceResolver
Function
() => (app: ApplicationService) => Promise<PriceResolver>flatRateShipping
Function
() => (_app: ApplicationService) => ShippingCalculatorFlatRateShipping
Class
FlatRateShippingPublic members
code:"flat"calculate:(input: { cart: CartSnapshot; method: ShippingMethodConfig; }) => Promise<Money>
freeShippingOver
Function
(options?: { threshold?: Money; }) => (_app: ApplicationService) => ShippingCalculatorFreeShippingOver
Class
FreeShippingOverPublic members
code:"free_over"threshold:Money | undefinedcalculate:(input: { cart: CartSnapshot; method: ShippingMethodConfig; }) => Promise<Money>
headerCartToken
Function
(options?: { header?: string; }) => (_app: ApplicationService) => CartTokenStrategyHeaderCartTokenStrategy
Class
HeaderCartTokenStrategyPublic members
header:stringread:(ctx: HttpContext) => string | nullissue:(_ctx: HttpContext, _token: string) => void
InlineJobDispatcher
Class
InlineJobDispatcherPublic members
#handlers:Map<string, InlineJobHandler>#timers:Set<NodeJS.Timeout>register:(job: string, handler: InlineJobHandler) => InlineJobDispatcherdispatch:(job: string, payload: JobPayload, options?: JobDispatchOptions) => Promise<void>schedule:(cron: string, job: string, payload?: JobPayload) => Promise<void>shutdown:() => Promise<void>
InlineJobHandler
Type
InlineJobHandlerJobDispatcher
Interface
JobDispatcherPublic members
dispatch:(job: string, payload: JobPayload, options?: JobDispatchOptions) => Promise<void>schedule:(cron: string, job: string, payload?: JobPayload) => Promise<void>shutdown:() => Promise<void>
JobDispatcherService
Class
JobDispatcherServicePublic members
#adapter:JobDispatcher | undefined#handlers:Map<string, InlineJobHandler>use:(adapter: JobDispatcher) => voidregister:(job: string, handler: InlineJobHandler) => () => voidjobNames:string[]handle:(job: string, payload?: JobPayload) => Promise<void>adapter:JobDispatcherdispatch:(job: string, payload: JobPayload, options?: JobDispatchOptions) => Promise<void>schedule:(cron: string, job: string, payload?: JobPayload) => Promise<void>shutdown:() => Promise<void>
JobDispatchOptions
Interface
JobDispatchOptionsPublic members
delay:number | undefined
JobPayload
Type
Readonly<Record<string, unknown>>manualPayment
Function
() => DriverFactory<PaymentProvider>ManualPaymentProvider
Class
ManualPaymentProviderPublic members
code:"manual"capabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; flow: "authorize_capture"; }createIntent:() => Promise<{ providerIntentId: string; state: "created"; }>confirm:() => Promise<{ state: "authorized"; }>capture:() => Promise<{ providerChargeId: string; }>refund:() => Promise<{ providerRefundId: string; }>void:() => Promise<void>verifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>
meilisearch
Function
(options: MeilisearchDriverOptions) => () => MeilisearchDriverMeilisearchDriver
Class
MeilisearchDriverPublic members
#host:string#apiKey:string | undefined#index:string#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }#taskTimeoutMs:number#taskPollIntervalMs:number#configured:Promise<void> | undefinedsearch:(input: SearchQuery) => Promise<SearchResult>upsert:(documents: SearchDocument[]) => Promise<void>delete:(ids: string[]) => Promise<void>clear:() => Promise<void>#headers:(contentType?: string) => Record<string, string>#ensureIndex:() => Promise<void>#submitTask:(response: Response) => Promise<void>
MeilisearchDriverOptions
Interface
MeilisearchDriverOptionsPublic members
host:stringapiKey:string | undefinedindex:string | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefinedtaskTimeoutMs:number | undefinedtaskPollIntervalMs:number | undefined
perItemShipping
Function
() => (_app: ApplicationService) => ShippingCalculatorPerItemShipping
Class
PerItemShippingPublic members
code:"per_item"calculate:(input: { cart: CartSnapshot; method: ShippingMethodConfig; }) => Promise<Money>
QueueJobDispatcher
Class
The only adapter that is coupled to the experimental queue package API.
QueueJobDispatcherPublic members
queue:AdonisQueuePortdispatch:(job: string, payload: JobPayload, options?: JobDispatchOptions) => Promise<void>schedule:(cron: string, job: string, payload?: JobPayload) => Promise<void>shutdown:() => Promise<void>
sessionCartToken
Function
(options?: { key?: string; }) => (_app: ApplicationService) => CartTokenStrategySessionCartTokenStrategy
Class
SessionCartTokenStrategyPublic members
key:stringread:(ctx: HttpContext) => string | nullissue:(ctx: HttpContext, token: string) => void
singleLocationAllocation
Function
() => DriverFactory<StockAllocationStrategy>SingleLocationAllocation
Class
SingleLocationAllocationPublic members
allocate:(input: Parameters<StockAllocationStrategy["allocate"]>[0]) => Promise<{ levelId: string; quantity: number; }[]>
typesense
Function
(options: TypesenseDriverOptions) => () => TypesenseDriverTypesenseDriver
Class
TypesenseDriverPublic members
#host:string#apiKey:string#collection:string#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }#configured:Promise<void> | undefinedsearch:(input: SearchQuery) => Promise<SearchResult>upsert:(documents: SearchDocument[]) => Promise<void>delete:(ids: string[]) => Promise<void>clear:() => Promise<void>#headers:(contentType?: string) => Record<string, string>#ensureCollection:() => Promise<void>
TypesenseDriverOptions
Interface
TypesenseDriverOptionsPublic members
host:stringapiKey:stringcollection:string | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
zoneTaxCalculator
Function
() => (app: ApplicationService) => Promise<TaxCalculator>ZoneTaxCalculator
Class
ZoneTaxCalculatorPublic members
db:Databaseconfig:Pick<ResolvedCommerceConfig, "tablePrefix">calculate:(input: { lines: TaxableLine[]; address: AddressInput | null; inclusive: boolean; trx?: TransactionClientContract; }) => Promise<TaxLineResult[]>
@adocommercekit/core/transformers
AddressTransformer
Class
AddressTransformerPublic members
toObject:() => { id: string; firstName: string; lastName: string; company: string | null; line1: string; line2: string | null; city: string; region: string | null; postalCode: string | null; countryCode: string; phone: string | null; metadata: Record<string, unknown> | undefined; }forStorefront:() => { id: string; firstName: string; lastName: string; company: string | null; line1: string; line2: string | null; city: string; region: string | null; postalCode: string | null; countryCode: string; phone: string | null; metadata: Record<string, unknown> | undefined; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; customerId: string | null; metadata: Record<string, unknown> | null; isDefaultShipping: boolean; isDefaultBilling: boolean; id: string; firstName: string; lastName: string; company: string | null; line1: string; line2: string | null; city: string; region: string | null; postalCode: string | null; countryCode: string; phone: string | null; }resource:AddresswhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
adminTimestamps
Function
Every forAdmin variant carries record timestamps: admin tables sort and
filter on them, and the audit trail reconciles against them.
(resource: { createdAt: DateTime | null; updatedAt: DateTime | null; }) => AdminTimestampsAdminTimestamps
Interface
AdminTimestampsPublic members
createdAt:string | nullupdatedAt:string | null
CartAdjustmentTransformer
Class
CartAdjustmentTransformerPublic members
toObject:() => { id: string; sourceType: string; sourceId: string | null; label: string; amount: SerializedMoney; included: boolean; eligible: boolean; position: number; metadata: Record<string, unknown> | undefined; }forStorefront:() => { id: string; sourceType: string; sourceId: string | null; label: string; amount: SerializedMoney; included: boolean; eligible: boolean; position: number; metadata: Record<string, unknown> | undefined; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; cartId: string; cartLineId: string | null; amount: SerializedAdminMoney; metadata: Record<string, unknown> | null; id: string; sourceType: string; sourceId: string | null; label: string; included: boolean; eligible: boolean; position: number; }resource:CartAdjustmentwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
CartLineTransformer
Class
CartLineTransformerPublic members
toObject:() => { id: string; variantId: string; quantity: number; unitPrice: SerializedMoney; }forStorefront:() => { total: SerializedMoney; variant: Item<ProductVariantTransformer, 1, "forStorefront"> | undefined; adjustments: Collection<CartAdjustmentTransformer, 1, "forStorefront"> | undefined; id: string; variantId: string; quantity: number; unitPrice: SerializedMoney; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; cartId: string; unitPrice: SerializedAdminMoney; total: SerializedAdminMoney; variant: Item<ProductVariantTransformer, 1, "forAdmin"> | undefined; adjustments: Collection<CartAdjustmentTransformer, 1, "forAdmin"> | undefined; metadata: Record<string, unknown> | null; id: string; variantId: string; quantity: number; }resource:CartLinewhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
CartTransformer
Class
CartTransformerPublic members
toObject:() => { id: string; token: string; status: CartStatus; currency: string; updatedAt: string | null; }forStorefront:() => { email: string | null; shippingAddress: AddressInput | null; billingAddress: AddressInput | null; shippingMethodId: string | null; lines: Collection<CartLineTransformer, 1, "forStorefront"> | undefined; adjustments: Collection<CartAdjustmentTransformer, 1, "forStorefront"> | undefined; promotions: { code: string; status: "applied" | "ineligible" | "exhausted" | "expired"; reason?: string; }[]; totals: { subtotal: SerializedMoney; shipping: SerializedMoney; tax: SerializedMoney; discount: SerializedMoney; grand: SerializedMoney; }; id: string; token: string; status: CartStatus; currency: string; updatedAt: string | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; id: string; status: CartStatus; currency: string; channelId: string; customerId: string | null; completedOrderId: string | null; email: string | null; shippingAddress: AddressInput | null; billingAddress: AddressInput | null; shippingMethodId: string | null; lastActivityAt: string | null; lines: Collection<CartLineTransformer, 1, "forAdmin"> | undefined; adjustments: Collection<CartAdjustmentTransformer, 1, "forAdmin"> | undefined; totals: { subtotal: SerializedAdminMoney; shipping: SerializedAdminMoney; tax: SerializedAdminMoney; discount: SerializedAdminMoney; grand: SerializedAdminMoney; }; metadata: Record<string, unknown> | null; }resource:CartwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
CategoryTransformer
Class
CategoryTransformerPublic members
toObject:() => { id: string; name: string; slug: string; path: string; }forStorefront:() => { id: string; name: string; slug: string; path: string; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; parentId: string | null; position: number; metadata: Record<string, unknown> | null; id: string; name: string; slug: string; path: string; }resource:CategorywhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ChannelTransformer
Class
ChannelTransformerPublic members
toObject:() => { id: string; code: string; name: string; defaultCurrency: string; }forStorefront:() => { supportedCurrencies: string[]; id: string; code: string; name: string; defaultCurrency: string; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; supportedCurrencies: string[]; isDefault: boolean; metadata: Record<string, unknown> | null; id: string; code: string; name: string; defaultCurrency: string; }resource:ChannelwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
CustomerTransformer
Class
CustomerTransformerPublic members
toObject:() => { id: string; email: string | null; firstName: string | null; lastName: string | null; }forStorefront:() => { phone: string | null; addresses: Collection<AddressTransformer, 1, "forStorefront"> | undefined; id: string; email: string | null; firstName: string | null; lastName: string | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; phone: string | null; userId: string | null; groupId: string | null; addresses: Collection<AddressTransformer, 1, "forAdmin"> | undefined; metadata: Record<string, unknown> | null; anonymizedAt: string | null; id: string; email: string | null; firstName: string | null; lastName: string | null; }resource:CustomerwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
InventoryItemTransformer
Class
InventoryItemTransformerPublic members
toObject:() => { id: string; variantId: string; tracked: boolean; backorderable: boolean; levels: Collection<InventoryLevelTransformer, 1, "toObject"> | undefined; }forStorefront:() => { variantId: string; available: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; id: string; variantId: string; tracked: boolean; backorderable: boolean; levels: Collection<InventoryLevelTransformer, 1, "forAdmin"> | undefined; metadata: Record<string, unknown> | null; }resource:InventoryItemwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
InventoryLevelTransformer
Class
InventoryLevelTransformerPublic members
toObject:() => { id: string; locationId: string; onHand: number; reserved: number; available: number; }forStorefront:() => { locationId: string; available: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; itemId: string; reorderPoint: number | null; metadata: Record<string, unknown> | null; id: string; locationId: string; onHand: number; reserved: number; available: number; }resource:InventoryLevelwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
OrderAdjustmentTransformer
Class
OrderAdjustmentTransformerPublic members
toObject:() => { id: string; sourceType: string; sourceId: string | null; label: string; amount: SerializedMoney; included: boolean; eligible: boolean; position: number; metadata: Record<string, unknown> | undefined; }forStorefront:() => { id: string; sourceType: string; sourceId: string | null; label: string; amount: SerializedMoney; included: boolean; eligible: boolean; position: number; metadata: Record<string, unknown> | undefined; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; orderId: string; orderLineId: string | null; amount: SerializedAdminMoney; metadata: Record<string, unknown> | null; id: string; sourceType: string; sourceId: string | null; label: string; included: boolean; eligible: boolean; position: number; }resource:OrderAdjustmentwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
OrderLineTransformer
Class
OrderLineTransformerPublic members
toObject:() => { id: string; variantId: string | null; productName: string; variantName: string | null; sku: string | null; quantity: number; unitPrice: SerializedMoney; total: SerializedMoney; fulfilledQuantity: number; refundedQuantity: number; }forStorefront:() => { id: string; variantId: string | null; productName: string; variantName: string | null; sku: string | null; quantity: number; unitPrice: SerializedMoney; total: SerializedMoney; fulfilledQuantity: number; refundedQuantity: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; orderId: string; cartLineId: string | null; unitPrice: SerializedAdminMoney; total: SerializedAdminMoney; metadata: Record<string, unknown> | null; id: string; variantId: string | null; productName: string; variantName: string | null; sku: string | null; quantity: number; fulfilledQuantity: number; refundedQuantity: number; }resource:OrderLinewhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
OrderTransformer
Class
OrderTransformerPublic members
toObject:() => { id: string; number: string; state: OrderState; currency: string; placedAt: string | null; }forStorefront:() => { email: string; shippingAddress: AddressInput; billingAddress: AddressInput; lines: Collection<OrderLineTransformer, 1, "forStorefront"> | undefined; adjustments: Collection<OrderAdjustmentTransformer, 1, "forStorefront"> | undefined; payments: Collection<PaymentTransformer, 1, "forStorefront"> | undefined; paymentInstructions: Collection<PaymentInstructionTransformer, 1, "forStorefront"> | undefined; shipments: Collection<ShipmentTransformer, 1, "forStorefront"> | undefined; totals: { subtotal: SerializedMoney; shipping: SerializedMoney; tax: SerializedMoney; discount: SerializedMoney; grand: SerializedMoney; }; accessToken: string | undefined; id: string; number: string; state: OrderState; currency: string; placedAt: string | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; channelId: string; customerId: string | null; cartId: string | null; email: string; shippingAddress: AddressInput; billingAddress: AddressInput; lines: Collection<OrderLineTransformer, 1, "forAdmin"> | undefined; adjustments: Collection<OrderAdjustmentTransformer, 1, "forAdmin"> | undefined; payments: Collection<PaymentTransformer, 1, "forAdmin"> | undefined; paymentInstructions: Collection<PaymentInstructionTransformer, 1, "forAdmin"> | undefined; shipments: Collection<ShipmentTransformer, 1, "forAdmin"> | undefined; totals: { subtotal: SerializedAdminMoney; shipping: SerializedAdminMoney; tax: SerializedAdminMoney; discount: SerializedAdminMoney; grand: SerializedAdminMoney; }; metadata: Record<string, unknown> | null; id: string; number: string; state: OrderState; currency: string; placedAt: string | null; }resource:OrderwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
PaymentInstructionTransformer
Class
PaymentInstructionTransformerPublic members
toObject:() => PaymentInstructionDataforStorefront:() => PaymentInstructionDataforAdmin:() => { createdAt: string | null; updatedAt: string | null; intentId: string; orderId: string; metadata: Record<string, unknown> | null; id: string; expiresAt: string | null; displayName?: string; type: "virtual_account"; bank: string; accountNumber: string; } | { createdAt: string | null; updatedAt: string | null; intentId: string; orderId: string; metadata: Record<string, unknown> | null; id: string; expiresAt: string | null; displayName?: string; type: "qr_code"; payload: string; imageUrl?: string; } | { createdAt: string | null; updatedAt: string | null; intentId: string; orderId: string; metadata: Record<string, unknown> | null; id: string; expiresAt: string | null; displayName?: string; type: "redirect"; url: string; } | { createdAt: string | null; updatedAt: string | null; intentId: string; orderId: string; metadata: Record<string, unknown> | null; id: string; expiresAt: string | null; displayName?: string; type: "retail_outlet"; outlet: string; paymentCode: string; } | { createdAt: string | null; updatedAt: string | null; intentId: string; orderId: string; metadata: Record<string, unknown> | null; id: string; expiresAt: string | null; displayName?: string; type: "bank_transfer"; bankName: string; accountNumber: string; accountName?: string; }resource:PaymentInstructionwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
PaymentIntentTransformer
Class
PaymentIntentTransformerPublic members
toObject:() => { id: string; provider: string; state: PaymentIntentState; amount: SerializedMoney; }forStorefront:() => { id: string; provider: string; state: PaymentIntentState; amount: SerializedMoney; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; orderId: string | null; cartId: string | null; flow: "authorize_capture" | "deferred"; inventoryPolicy: "reserve" | "commit" | null; amount: SerializedAdminMoney; providerIntentId: string | null; lastError: Record<string, unknown> | null; expiresAt: string | null; reviewReason: string | null; providerEventTime: string | null; currentProviderStatus: string | null; metadata: Record<string, unknown> | null; id: string; provider: string; state: PaymentIntentState; }resource:PaymentIntentwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
PaymentTransformer
Class
PaymentTransformerPublic members
toObject:() => { id: string; state: PaymentState; amount: SerializedMoney; }forStorefront:() => { id: string; state: PaymentState; amount: SerializedMoney; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; intentId: string; orderId: string; amount: SerializedAdminMoney; providerChargeId: string | null; refunds: Collection<RefundTransformer, 1, "forAdmin"> | undefined; metadata: Record<string, unknown> | null; id: string; state: PaymentState; }resource:PaymentwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
PriceListTransformer
Class
PriceListTransformerPublic members
toObject:() => { id: string; name: string; priority: number; startsAt: string | null; endsAt: string | null; }forStorefront:() => { id: string; name: string; priority: number; startsAt: string | null; endsAt: string | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; channelId: string | null; customerGroupId: string | null; isDefault: boolean; id: string; name: string; priority: number; startsAt: string | null; endsAt: string | null; }resource:PriceListwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
PriceTransformer
Class
PriceTransformerPublic members
toObject:() => { id: string; variantId: string; unitPrice: SerializedMoney; minQuantity: number; }forStorefront:() => { id: string; variantId: string; unitPrice: SerializedMoney; minQuantity: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; priceListId: string; unitPrice: SerializedAdminMoney; id: string; variantId: string; minQuantity: number; }resource:PricewhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ProductImageTransformer
Class
ProductImageTransformerPublic members
toObject:() => { id: string; url: string; altText: string | null; position: number; mimeType: string; width: number; height: number; }forStorefront:() => { variantIds: string[] | undefined; id: string; url: string; altText: string | null; position: number; mimeType: string; width: number; height: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; productId: string; disk: string | null; key: string | null; sizeBytes: number; variantIds: string[] | undefined; metadata: Record<string, unknown> | null; id: string; url: string; altText: string | null; position: number; mimeType: string; width: number; height: number; }resource:ProductImagewhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ProductOptionTransformer
Class
Product options and their values. Storefronts read option values through
variants, so this transformer has no forStorefront variant: it exists for the
admin product form, which edits the option axes themselves.
ProductOptionTransformerPublic members
toObject:() => { id: string; name: string; position: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; productId: string; values: { id: string; value: string; position: number; }[] | undefined; metadata: Record<string, unknown> | null; id: string; name: string; position: number; }resource:ProductOptionwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ProductTransformer
Class
ProductTransformerPublic members
toObject:() => { id: string; name: string; slug: string; status: ProductStatus; }forStorefront:() => { description: string | null; variants: Collection<ProductVariantTransformer, 1, "forStorefront"> | undefined; categories: Collection<CategoryTransformer, 1, "forStorefront"> | undefined; images: Collection<ProductImageTransformer, 1, "forStorefront"> | undefined; id: string; name: string; slug: string; status: ProductStatus; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; description: string | null; options: Collection<ProductOptionTransformer, 1, "forAdmin"> | undefined; variants: Collection<ProductVariantTransformer, 1, "forAdmin"> | undefined; categories: Collection<CategoryTransformer, 1, "forAdmin"> | undefined; images: Collection<ProductImageTransformer, 1, "forAdmin"> | undefined; metadata: Record<string, unknown> | null; id: string; name: string; slug: string; status: ProductStatus; }resource:ProductwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ProductVariantTransformer
Class
ProductVariantTransformerPublic members
toObject:() => { id: string; sku: string | null; name: string | null; isDefault: boolean; weightGrams: number | null; lengthMm: number | null; widthMm: number | null; heightMm: number | null; }forStorefront:() => { optionValues: { id: string; value: string; }[] | undefined; price: SerializedMoney | undefined; availability: { tracked: boolean; backorderable: boolean; quantity: number | null; available: boolean; } | undefined; id: string; sku: string | null; name: string | null; isDefault: boolean; weightGrams: number | null; lengthMm: number | null; widthMm: number | null; heightMm: number | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; productId: string; taxCategoryId: string | null; position: number; optionValues: { id: string; value: string; }[] | undefined; metadata: Record<string, unknown> | null; id: string; sku: string | null; name: string | null; isDefault: boolean; weightGrams: number | null; lengthMm: number | null; widthMm: number | null; heightMm: number | null; }resource:ProductVariantwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
RefundTransformer
Class
RefundTransformerPublic members
toObject:() => { id: string; state: RefundState; amount: SerializedMoney; reason: string | null; }forStorefront:() => { id: string; state: RefundState; amount: SerializedMoney; reason: string | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; paymentId: string; captureId: string | null; amount: SerializedAdminMoney; providerRefundId: string | null; metadata: Record<string, unknown> | null; id: string; state: RefundState; reason: string | null; }resource:RefundwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ReservationTransformer
Class
ReservationTransformerPublic members
toObject:() => { id: string; cartId: string; cartLineId: string; quantity: number; state: ReservationState; expiresAt: string | null; }forStorefront:() => { id: string; cartId: string; cartLineId: string; quantity: number; state: ReservationState; expiresAt: string | null; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; levelId: string; returnedQuantity: number; metadata: Record<string, unknown> | null; id: string; cartId: string; cartLineId: string; quantity: number; state: ReservationState; expiresAt: string | null; }resource:ReservationwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
serializeAdminMoney
Function
(money: Money, locale?: string) => SerializedAdminMoneySerializedAdminMoney
Interface
Admin surfaces receive the storefront money shape plus an explicit minor-unit field so charts and exports never parse a locale-formatted string.
SerializedAdminMoneyPublic members
amountMinor:stringamount:stringcurrency:stringformatted:string
SerializedMoney
Interface
SerializedMoneyPublic members
amount:stringcurrency:stringformatted:string
serializeMoney
Function
(money: Money, locale?: string) => SerializedMoneyShipmentTransformer
Class
ShipmentTransformerPublic members
toObject:() => { id: string; state: ShipmentState; carrier: string | null; trackingNumber: string | null; waybill: string | null; handedOffAt: string | null; shippedAt: string | null; deliveredAt: string | null; deliveryFailedAt: string | null; returnedAt: string | null; metadata: Record<string, unknown> | undefined; }forStorefront:() => { id: string; state: ShipmentState; carrier: string | null; trackingNumber: string | null; waybill: string | null; handedOffAt: string | null; shippedAt: string | null; deliveredAt: string | null; deliveryFailedAt: string | null; returnedAt: string | null; metadata: Record<string, unknown> | undefined; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; orderId: string; provider: string | null; providerShipmentId: string | null; inventoryRestockedAt: string | null; metadata: Record<string, unknown> | null; id: string; state: ShipmentState; carrier: string | null; trackingNumber: string | null; waybill: string | null; handedOffAt: string | null; shippedAt: string | null; deliveredAt: string | null; deliveryFailedAt: string | null; returnedAt: string | null; }resource:ShipmentwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
ShippingMethodTransformer
Class
ShippingMethodTransformerPublic members
toObject:() => { id: string; code: string; name: string; }forStorefront:() => { price: SerializedMoney | undefined; id: string; code: string; name: string; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; calculator: string; calculatorConfig: Record<string, unknown>; channelId: string | null; position: number; enabled: boolean; metadata: Record<string, unknown> | null; id: string; code: string; name: string; }resource:ShippingMethodwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
StockLocationTransformer
Class
StockLocationTransformerPublic members
toObject:() => { id: string; code: string; name: string; }forStorefront:() => { id: string; code: string; name: string; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; address: AddressInput | null; isDefault: boolean; metadata: Record<string, unknown> | null; id: string; code: string; name: string; }resource:StockLocationwhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
TaxCategoryTransformer
Class
TaxCategoryTransformerPublic members
toObject:() => { id: string; code: string; name: string; }forStorefront:() => { id: string; code: string; name: string; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; metadata: Record<string, unknown> | null; id: string; code: string; name: string; }resource:TaxCategorywhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
TaxRateTransformer
Class
TaxRateTransformerPublic members
toObject:() => { id: string; name: string; rateBp: number; }forStorefront:() => { id: string; name: string; rateBp: number; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; zoneId: string; taxCategoryId: string | null; metadata: Record<string, unknown> | null; id: string; name: string; rateBp: number; }resource:TaxRatewhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
TaxZoneTransformer
Class
TaxZoneTransformerPublic members
toObject:() => { id: string; name: string; }forStorefront:() => { id: string; name: string; }forAdmin:() => { createdAt: string | null; updatedAt: string | null; countryCodes: string[]; regionPattern: string | null; postalPattern: string | null; metadata: Record<string, unknown> | null; id: string; name: string; }resource:TaxZonewhenLoaded:<Value>(value: Value) => Maybe<Value>omit:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Omit<Data, Keys>pick:<Data extends Record<string, any>, Keys extends { [K in keyof Data]: Data[K] extends Function ? never : K; }[keyof Data]>(data: Data, keys: Keys[] | readonly Keys[]) => Pick<Data, Keys>when:<Value, Fallback = undefined>(conditional: boolean, resolver: () => Value, fallback?: Fallback) => Value | Fallback
@adocommercekit/core/types
AddressInput
Interface
AddressInputPublic members
firstName:stringlastName:stringcompany:string | null | undefinedline1:stringline2:string | null | undefinedcity:stringregion:string | null | undefinedpostalCode:string | null | undefinedcountryCode:stringphone:string | null | undefinedmetadata:Record<string, unknown> | undefined
AdjustmentDraft
Interface
AdjustmentDraftPublic members
cartLineId:string | null | undefinedsourceType:stringsourceId:string | null | undefinedlabel:stringamount:Moneyincluded:boolean | undefinedeligible:boolean | undefinedposition:numbermetadata:Record<string, unknown> | undefined
AdminCursor
Interface
The decoded keyset position: the sort key of the last row of the previous page plus its id, which breaks ties deterministically.
AdminCursorPublic members
key:stringid:string
AdminKeysetWindow
Interface
AdminKeysetWindowPublic members
column:stringvalue:string | number | bigintidColumn:stringid:stringdirection:AdminSortDirection
AdminListPage
Interface
One page of an admin list query (ASPEC §3.3).
nextCursor is null on the last page. total is null whenever the
filtered count is not obtainable from a single indexed COUNT(*); the UI
renders “1–25 of many” in that case.
AdminListPage<T>Public members
items:T[]nextCursor:string | nulltotal:number | null
AdminSortDirection
Type
AdminSortDirectionCartProcessor
Interface
CartProcessorPublic members
name:stringposition:numberprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:((cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>) | undefined
CartSnapshot
Interface
CartSnapshotPublic members
id:stringcurrency:stringlines:{ id: string; variantId: string; quantity: number; unitPrice: Money; metadata: Record<string, unknown> | null; }[]shippingAddress:AddressInput | nullshippingMethodId:string | nullsubtotal:Money
CartTokenStrategy
Interface
CartTokenStrategyPublic members
read:(ctx: HttpContext) => string | nullissue:(ctx: HttpContext, token: string) => void
CartTotals
Interface
CartTotalsPublic members
subtotal:MoneyshippingTotal:MoneytaxTotal:MoneydiscountTotal:MoneygrandTotal:Money
ChannelContext
Interface
ChannelContextPublic members
channelCode:stringcurrency:stringcustomerId:string | undefined
CheckoutResult
Interface
CheckoutResultPublic members
order:Order
CommerceConfigInput
Interface
CommerceConfigInputPublic members
tablePrefix:string | undefinedchannels:{ default: string; }currencies:{ supported: CurrencyCode[]; default: CurrencyCode; exponents?: Partial<Record<CurrencyCode, 0 | 2 | 3>>; rounding?: Rounding; }customers:{ userModel: LazyImport<unknown> | null; userForeignKey?: string; }carts:{ tokenStrategy?: DriverFactory; abandonedAfterMinutes?: number; guardMaxLineQuantity?: number; }pricing:{ resolver?: DriverFactory; taxInclusivePricing?: boolean; }search:{ driver?: DriverFactory<SearchDriver>; } | undefinedimages:{ storage?: DriverFactory<ProductImageStorage>; maxBytes?: number; maxPerProduct?: number; } | undefinedinventory:{ reservationTtlMinutes?: number; backorderPolicy?: "deny" | "allow" | "per_item"; allocation?: DriverFactory; }payments:{ default: string; methods: Record<string, DriverFactory>; captureMode?: "automatic" | "manual"; deferred?: { inventoryPolicy?: "reserve" | "commit"; }; codFee?: { amount: bigint | number | string; currency: string; label?: string; }; }shipping:{ calculators: Record<string, DriverFactory>; eligibility?: DriverFactory; quoteProviders?: Record<string, DriverFactory>; selectionSecret?: string; }fulfillment:{ providers?: Record<string, DriverFactory>; } | undefinedtaxes:{ calculator?: DriverFactory; addressResolver?: DriverFactory<TaxAddressResolver>; }orders:{ numberGenerator?: DriverFactory; autoConfirm?: boolean; }models:Partial<ModelRegistryOverrides> | undefinedevents:{ outbox?: { enabled: boolean; drainBatchSize?: number; }; } | undefinedwebhooks:{ requestTimeoutMs?: number; allowedHosts?: string[]; allowLocalhost?: boolean; } | undefinedjobs:{ dispatcher?: "queue" | "inline"; } | undefined
CreateProductInput
Interface
CreateProductInputPublic members
name:stringslug:stringdescription:string | null | undefinedstatus:"draft" | "active" | "archived" | undefinedmetadata:Record<string, unknown> | undefinedchannelIds:string[] | undefined
CustomerSnapshot
Interface
CustomerSnapshotPublic members
id:string | undefinedemail:string | null | undefinedfirstName:string | null | undefinedlastName:string | null | undefined
DeferredInventoryPolicy
Type
DeferredInventoryPolicyDeferredPaymentStatus
Type
DeferredPaymentStatusDriverFactory
Type
DriverFactory<T>DynamicShippingQuoteProvider
Interface
DynamicShippingQuoteProviderPublic members
code:stringquote:(input: ShippingQuoteRequest) => Promise<ShippingQuoteDraft[]>
FulfillmentProvider
Interface
FulfillmentProviderPublic members
code:stringprepare:(input: { shipmentId: string; order: Order; parcels: Parcel[]; service?: string; cod?: { amount: Money; }; insurance?: { amount: Money; }; idempotencyKey: string; }) => Promise<{ providerShipmentId: string; waybill: string; trackingNumber?: string; carrier?: string; raw?: unknown; }>status:((providerShipmentId: string) => Promise<{ status: FulfillmentStatus | "canceled" | "on_hold"; occurredAt?: DateTime; raw?: unknown; }>) | undefined
FulfillmentStatus
Type
FulfillmentStatusInventoryBackorderPolicy
Interface
InventoryBackorderPolicyPublic members
name:stringallowsBackorder:(input: { cart: Cart; line: CartLine; itemId: string; available: number; trx: TransactionClientContract; }) => boolean | Promise<boolean>
InventoryLevelSnapshot
Interface
InventoryLevelSnapshotPublic members
id:stringitemId:stringlocationId:stringonHand:numberreserved:numberavailable:numberisDefault:boolean
LazyImport
Type
LazyImport<T>ModelRegistryOverrides
Interface
ModelRegistryOverridesPublic members
channel:LazyImport<unknown>product:LazyImport<unknown>productImage:LazyImport<unknown>productOption:LazyImport<unknown>productOptionValue:LazyImport<unknown>productVariant:LazyImport<unknown>category:LazyImport<unknown>priceList:LazyImport<unknown>price:LazyImport<unknown>customerGroup:LazyImport<unknown>customer:LazyImport<unknown>address:LazyImport<unknown>cart:LazyImport<unknown>cartLine:LazyImport<unknown>cartAdjustment:LazyImport<unknown>shippingMethod:LazyImport<unknown>taxZone:LazyImport<unknown>taxRate:LazyImport<unknown>taxCategory:LazyImport<unknown>order:LazyImport<unknown>orderLine:LazyImport<unknown>paymentIntent:LazyImport<unknown>payment:LazyImport<unknown>paymentInstruction:LazyImport<unknown>shipment:LazyImport<unknown>stockLocation:LazyImport<unknown>inventoryItem:LazyImport<unknown>inventoryLevel:LazyImport<unknown>reservation:LazyImport<unknown>inventoryMovement:LazyImport<unknown>inventoryTransfer:LazyImport<unknown>orderAdjustment:LazyImport<unknown>shipmentLine:LazyImport<unknown>refund:LazyImport<unknown>capture:LazyImport<unknown>paymentCustomer:LazyImport<unknown>paymentMethod:LazyImport<unknown>webhookEvent:LazyImport<unknown>paymentOperation:LazyImport<unknown>idempotencyKey:LazyImport<unknown>eventOutbox:LazyImport<unknown>webhookDestination:LazyImport<unknown>webhookDelivery:LazyImport<unknown>mediaAsset:LazyImport<unknown>returnReason:LazyImport<unknown>returnRequest:LazyImport<unknown>returnLine:LazyImport<unknown>
MutationOptions
Interface
MutationOptionsPublic members
trx:TransactionClientContract | undefinedactor:string | undefined
NormalizedPaymentEvent
Type
NormalizedPaymentEventOffSessionChargeResult
Interface
OffSessionChargeResultPublic members
providerIntentId:stringproviderChargeId:string | undefinedstate:"captured" | "authorized" | "failed" | "requires_action" | "pending"clientSecret:string | undefinedraw:unknown
OrderNumberGenerator
Interface
OrderNumberGeneratorPublic members
next:(order: PendingOrder, trx?: TransactionClientContract) => Promise<string>
Parcel
Interface
ParcelPublic members
reference:stringquantity:numberweightGrams:numberdeclaredValue:Money | undefinedlengthMm:number | undefinedwidthMm:number | undefinedheightMm:number | undefined
PaymentCaptureResult
Interface
PaymentCaptureResultPublic members
providerChargeId:stringproviderCaptureId:string | undefinedraw:unknown
PaymentFlow
Type
PaymentFlowPaymentInstructionData
Type
PaymentInstructionDataPaymentInstructionDraft
Type
PaymentInstructionDraftPaymentInstructionKind
Type
PaymentInstructionKindPaymentProvider
Interface
PaymentProviderPublic members
code:stringcapabilities:() => PaymentProviderCapabilitiescreateIntent:(input: { amount: Money; currency: string; reference: string; customer?: CustomerSnapshot; idempotencyKey: string; }) => Promise<{ providerIntentId: string; clientSecret?: string; state: "created" | "requires_action" | "authorized" | "pending"; instructions?: PaymentInstructionDraft[]; expiresAt?: DateTime; raw?: unknown; adjustment?: AdjustmentDraft; }>confirm:(input: { providerIntentId: string; token?: string; idempotencyKey: string; }) => Promise<ProviderPaymentState>capture:(input: { providerIntentId: string; amount: Money; idempotencyKey: string; final?: boolean; }) => Promise<{ providerChargeId: string; providerCaptureId?: string; raw?: unknown; }>refund:(input: { providerChargeId: string; amount: Money; reason?: string; idempotencyKey: string; }) => Promise<{ providerRefundId: string; state?: "pending" | "succeeded" | "failed"; raw?: unknown; }>retrieveRefund:((input: { providerRefundId?: string; idempotencyKey?: string; providerChargeId?: string; }) => Promise<{ providerRefundId: string; state: "pending" | "succeeded" | "failed"; amount?: Money; raw?: unknown; } | null>) | undefinedvoid:(input: { providerIntentId: string; idempotencyKey: string; trx?: TransactionClientContract; }) => Promise<void>retrieveIntent:((providerIntentId: string) => Promise<DeferredPaymentStatus>) | undefinedcreateCustomer:((input: { reference: string; email?: string; name?: string; idempotencyKey: string; }) => Promise<{ providerCustomerId: string; raw?: unknown; }>) | undefinedsetupPaymentMethod:((input: { providerCustomerId: string; token?: string; returnUrl?: string; idempotencyKey: string; }) => Promise<{ providerPaymentMethodId?: string; clientSecret?: string; requiresAction: boolean; type?: string; label?: string; lastFour?: string; expiryMonth?: number; expiryYear?: number; raw?: unknown; }>) | undefinedchargeOffSession:((input: { providerCustomerId: string; providerPaymentMethodId: string; amount: Money; currency: string; reference: string; idempotencyKey: string; }) => Promise<{ providerIntentId: string; providerChargeId?: string; state: "authorized" | "captured" | "requires_action" | "pending" | "failed"; clientSecret?: string; raw?: unknown; }>) | undefinedhealthCheck:(() => Promise<void>) | undefinedverifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>
PaymentProviderCapabilities
Interface
PaymentProviderCapabilitiesPublic members
authorize:booleancapture:booleanrefund:booleanvoid:booleanclientConfirmation:booleanflow:PaymentFlow | undefinedcod:boolean | undefinedvaulting:boolean | undefinedrecurring:boolean | undefined
PaymentRefundResult
Interface
PaymentRefundResultPublic members
providerRefundId:stringstate:"succeeded" | "failed" | "pending" | undefinedraw:unknown
PendingOrder
Interface
PendingOrderPublic members
channelId:stringcurrency:stringcartId:string
PlaceOrderInput
Interface
PlaceOrderInputPublic members
payment:{ method: string; token?: string; intentId?: string; }shippingQuoteToken:string | undefinedidempotencyKey:string | undefined
PriceResolver
Interface
PriceResolverPublic members
resolve:(input: { variantId: string; quantity: number; ctx: ChannelContext; trx?: TransactionClientContract; }) => Promise<{ unitPrice: Money; priceListId: string | null; }>
ProductImageStorage
Interface
ProductImageStoragePublic members
disk:stringput:(key: string, contents: Uint8Array, options: { contentType: string; contentLength: number; }) => Promise<{ url: string; }>delete:(file: { disk: string; key: string; }) => Promise<void>
ProviderPaymentState
Type
ProviderPaymentStateRawWebhookRequest
Interface
RawWebhookRequestPublic members
body:Buffer<ArrayBufferLike>headers:Record<string, string>
RecalculationContext
Interface
RecalculationContextPublic members
channel:ChannelContextlines:CartLine[]previousAdjustments:CartAdjustment[]generatedAdjustments:AdjustmentDraft[]trx:TransactionClientContract
ResolvedCommerceConfig
Interface
ResolvedCommerceConfigPublic members
tablePrefix:stringchannels:{ default: string; }currencies:{ supported: CurrencyCode[]; default: CurrencyCode; exponents: Readonly<Partial<Record<CurrencyCode, 0 | 2 | 3>>>; rounding: Rounding; }customers:{ userModel: LazyImport<unknown> | null; userForeignKey: string; }carts:{ tokenStrategy: DriverFactory; abandonedAfterMinutes: number; guardMaxLineQuantity: number; }pricing:{ resolver: DriverFactory; taxInclusivePricing: boolean; }search:{ driver?: DriverFactory<SearchDriver>; }images:{ storage?: DriverFactory<ProductImageStorage>; maxBytes: number; maxPerProduct: number; }inventory:{ reservationTtlMinutes: number; backorderPolicy: "deny" | "allow" | "per_item"; allocation?: DriverFactory; }payments:{ default: string; methods: Readonly<Record<string, DriverFactory>>; captureMode: "automatic" | "manual"; deferred: { inventoryPolicy: "reserve" | "commit"; }; codFee?: { amount: bigint | number | string; currency: string; label: string; }; }shipping:{ calculators: Readonly<Record<string, DriverFactory>>; eligibility?: DriverFactory; quoteProviders: Readonly<Record<string, DriverFactory>>; selectionSecret?: string; }fulfillment:{ providers: Readonly<Record<string, DriverFactory>>; }taxes:{ calculator: DriverFactory; addressResolver?: DriverFactory<TaxAddressResolver>; }orders:{ numberGenerator?: DriverFactory; autoConfirm: boolean; }models:Readonly<Partial<ModelRegistryOverrides>>events:{ outbox: { enabled: boolean; drainBatchSize: number; }; }webhooks:{ requestTimeoutMs: number; allowedHosts: readonly string[]; allowLocalhost: boolean; }jobs:{ dispatcher: "queue" | "inline"; automatic: boolean; }
SearchDocument
Interface
SearchDocumentPublic members
id:stringname:stringslug:stringdescription:string | nullstatus:"draft" | "active" | "archived"channelIds:string[]categorySlugs:string[]variantSkus:string[]createdAt:stringupdatedAt:string
SearchDriver
Interface
SearchDriverPublic members
search:(input: SearchQuery) => Promise<SearchResult>upsert:(documents: SearchDocument[]) => Promise<void>delete:(ids: string[]) => Promise<void>clear:(() => Promise<void>) | undefinedshutdown:(() => Promise<void>) | undefined
SearchQuery
Interface
SearchQueryPublic members
query:string | undefinedchannelId:stringcategorySlug:string | undefinedsort:"name" | "newest" | undefinedlimit:numbercursor:string | undefined
SearchResult
Interface
SearchResultPublic members
ids:string[]nextCursor:string | nullestimatedTotal:number | undefined
ShippingCalculator
Interface
ShippingCalculatorPublic members
code:stringcalculate:(input: { cart: CartSnapshot; method: ShippingMethodConfig; }) => Promise<Money>
ShippingEligibility
Interface
ShippingEligibilityPublic members
eligibleMethods:(cart: CartSnapshot, methods: ShippingMethodConfig[]) => Promise<string[]>
ShippingMethodConfig
Interface
ShippingMethodConfigPublic members
id:stringcode:stringname:stringcalculator:stringcalculatorConfig:Record<string, unknown>
ShippingQuote
Interface
ShippingQuotePublic members
provider:stringservice:stringname:stringprice:MoneyexpiresAt:DateTime<boolean>selectionToken:stringmetadata:Record<string, unknown> | undefined
ShippingQuoteDraft
Interface
ShippingQuoteDraftPublic members
service:stringname:stringprice:MoneyexpiresAt:DateTime<boolean>metadata:Record<string, unknown> | undefined
ShippingQuoteRequest
Interface
ShippingQuoteRequestPublic members
cart:CartSnapshotparcels:Parcel[]cod:{ amount: Money; } | undefinedinsurance:{ amount: Money; } | undefined
Stateful
Interface
Stateful<S>Public members
id:stringstate:S
StateMachineDatabase
Interface
StateMachineDatabase<Trx>Public members
transaction:<R>(callback: (trx: Trx) => Promise<R>) => Promise<R>
StateMachineDefinition
Interface
StateMachineDefinition<S, T>Public members
name:stringstates:readonly S[]initial:Stransitions:Readonly<Record<T, { readonly from: readonly S[]; readonly to: S; }>>
StateMachinePersistence
Interface
StateMachinePersistence<S, T, Trx>Public members
transaction:<R>(callback: (trx: Trx) => Promise<R>) => Promise<R>conditionalUpdate:(subjectId: string, from: S, to: S, trx: Trx) => Promise<boolean>insertAudit:(audit: StateTransitionAudit<S, T>, trx: Trx) => Promise<void>bufferEvent:(name: string, payload: Readonly<Record<string, unknown>>, trx: Trx) => Promise<void> | void
StateMachineQuery
Interface
StateMachineQueryPublic members
where:(column: string | Record<string, unknown>, value?: unknown) => StateMachineQueryupdate:(values: Record<string, unknown>) => PromiseLike<number>
StateMachineTransaction
Interface
StateMachineTransactionPublic members
from:(table: string) => StateMachineQuerytable:(table: string) => StateMachineInsertQuery
StateTransitionAudit
Interface
StateTransitionAudit<S, T>Public members
machine:stringsubjectId:stringtransition:Tfrom:Sto:Sactor:string | undefinedcontext:TransitionContextcreatedAt:Date
StockAllocationStrategy
Interface
StockAllocationStrategyPublic members
allocate:(input: { itemId: string; quantity: number; levels: InventoryLevelSnapshot[]; backorderable: boolean; }) => Promise<Array<{ levelId: string; quantity: number; }>>
TaxableLine
Interface
TaxableLinePublic members
lineId:stringamount:MoneytaxCategoryCode:string | nullquantity:number
TaxCalculator
Interface
TaxCalculatorPublic members
calculate:(input: { lines: TaxableLine[]; address: AddressInput | null; inclusive: boolean; trx?: TransactionClientContract; }) => Promise<TaxLineResult[]>
TaxLineResult
Interface
TaxLineResultPublic members
lineId:stringrateName:stringrateBp:numberamount:Moneyincluded:booleansourceId:string | undefinedmetadata:Record<string, unknown> | undefined
TransitionContext
Interface
TransitionContextPublic members
actor:string | undefined
TransitionGuard
Type
TransitionGuard<S, T, Trx>TransitionHook
Type
TransitionHook<S, T, Trx>UpdateProductInput
Interface
UpdateProductInputPublic members
name:string | undefinedslug:string | undefineddescription:string | null | undefinedstatus:"draft" | "active" | "archived" | undefinedmetadata:Record<string, unknown> | undefinedchannelIds:string[] | undefined
WebhookIngestResult
Interface
WebhookIngestResultPublic members
status:"unhandled" | "processed" | "duplicate"providerEventId:string
WorkflowLogger
Interface
WorkflowLoggerPublic members
error:(message: string, context: Readonly<Record<string, unknown>>) => void
WorkflowStep
Interface
WorkflowStep<C>Public members
name:stringrun:(context: C) => Promise<void>compensate:((context: C) => Promise<void>) | undefinedboundary:"trx" | "external"
WorkflowTransactionRunner
Interface
WorkflowTransactionRunner<C>Public members
transaction:(context: C, callback: (transactionContext: C) => Promise<void>) => Promise<void>
@adocommercekit/core/validators
addCartLineValidator
Value
ValidatoraddressSchema
Value
SchemaTypescreateChannelValidator
Value
ValidatorcreateCustomerValidator
Value
ValidatorcreatePriceValidator
Value
ValidatorcreateProductOptionValidator
Value
ValidatorcreateProductValidator
Value
ValidatorsetCartAddressesValidator
Value
ValidatorsetCartEmailValidator
Value
ValidatorupdateCartLineValidator
Value
Validator@adocommercekit/core/errors
CartNotActiveException
Class
CartNotActiveExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CartPricesChangedException
Class
CartPricesChangedExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
COMMERCE_ERROR_STATUSES
Value
Readonly<Partial<Record<`E_${Uppercase<string>}`, number | "varies">>>CommerceConfigException
Class
CommerceConfigExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CommerceErrorCode
Type
Extension packages may define their own E_* codes by subclassing
CommerceException; the core codes stay enumerable through
CoreCommerceErrorCode.
`E_${Uppercase<string>}`CommerceErrorDetails
Type
Readonly<Record<string, unknown>>CommerceException
Class
CommerceExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CommerceForbiddenException
Class
Raised at the HTTP/Inertia boundary when the actor lacks the ability an admin endpoint declares. The ability name travels in the payload on purpose: it is frozen catalog vocabulary (ASPEC §3.2), not a secret, and the panel needs it to explain the denial.
CommerceForbiddenExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CommerceNotFoundException
Class
CommerceNotFoundExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
CompensationError
Interface
CompensationErrorPublic members
step:stringerror:unknown
CoreCommerceErrorCode
Type
CoreCommerceErrorCodeCurrencyMismatchException
Class
CurrencyMismatchExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
IdempotencyConflictException
Class
IdempotencyConflictExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
InsufficientStockException
Class
InsufficientStockExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
InvalidCommerceInputException
Class
InvalidCommerceInputExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
InvalidCursorException
Class
InvalidCursorExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
LineQuantityException
Class
LineQuantityExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PaymentDeclineCode
Type
PaymentDeclineCodePaymentDeclinedException
Class
PaymentDeclinedExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PaymentIntentMismatchException
Class
PaymentIntentMismatchExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PaymentProviderException
Class
PaymentProviderExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PriceNotFoundException
Class
PriceNotFoundExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
ProductInUseException
Class
ProductInUseExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
PromotionNotApplicableException
Class
PromotionNotApplicableExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
renderCommerceException
Function
(error: CommerceException) => { error: { details?: Readonly<Record<string, unknown>> | undefined; code: `E_${Uppercase<string>}`; message: string; }; }ResourceConflictException
Class
ResourceConflictExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
ReturnNotAllowedException
Class
ReturnNotAllowedExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
ShippingNotEligibleException
Class
ShippingNotEligibleExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
StateTransitionException
Class
StateTransitionExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
WebhookSignatureException
Class
WebhookSignatureExceptionPublic members
code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
WorkflowFailedException
Class
WorkflowFailedExceptionPublic members
compensationErrors:readonly CompensationError[]code:E_${Uppercase<string>}status:numberdetails:Readonly<Record<string, unknown>>handle:(error: CommerceException, ctx: { response: { status(code: number): { send(body: unknown): unknown; }; }; }) => unknownname:stringhelp:string | undefinedtoString:() => stringmessage:stringstack:string | undefinedcause:unknown
@adocommercekit/core/jobs
DrainEventOutbox
Class
DrainEventOutboxPublic members
outbox:EventOutboxServicehandle:() => Promise<{ sent: number; failed: number; }>
ExpireAbandonedCarts
Class
ExpireAbandonedCartsPublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedCommerceConfigevents:TransactionalEventEmitterhandle:() => Promise<number>
ExpirePendingPayments
Class
ExpirePendingPaymentsPublic members
payments:PaymentServicehandle:() => Promise<number>
ExpireStaleReservations
Class
ExpireStaleReservationsPublic members
inventory:InventoryServicehandle:() => Promise<number>
JOB_NAMES
Value
{ readonly expireStaleReservations: "commerce.expire_stale_reservations"; readonly expirePendingPayments: "commerce.expire_pending_payments"; readonly expireAbandonedCarts: "commerce.expire_abandoned_carts"; readonly reconcileStuckCheckouts: "commerce.reconcile_stuck_checkouts"; readonly reconcilePaymentOperations: "commerce.reconcile_payment_operations"; readonly drainEventOutbox: "commerce.drain_event_outbox"; readonly purgeExpiredIdempotencyKeys: "commerce.purge_expired_idempotency_keys"; }PurgeExpiredIdempotencyKeys
Class
PurgeExpiredIdempotencyKeysPublic members
idempotency:IdempotencyServicehandle:() => Promise<number>
ReconcilePaymentOperations
Class
ReconcilePaymentOperationsPublic members
payments:PaymentServicehandle:() => Promise<number>
ReconcileStuckCheckouts
Class
ReconcileStuckCheckoutsPublic members
checkout:CheckoutServiceconfig:ResolvedCommerceConfighandle:() => Promise<number>
@adocommercekit/core/policies
AdminAuthorizationConstraint
Interface
AdminAuthorizationConstraintPublic members
channelIds:readonly string[]
AdminAuthorizationScope
Interface
AdminAuthorizationScopePublic members
ability:"commerce.metrics.view" | "commerce.orders.view" | "commerce.products.view" | "commerce.inventory.view" | "commerce.customers.view" | "commerce.payments.reconcile" | "commerce.returns.view" | "commerce.webhooks.view" | "commerce.media.view" | "commerce.audit.view" | "commerce.orders.transition" | "commerce.orders.cancel" | "commerce.orders.adjust" | "commerce.shipments.manage" | "commerce.payments.capture" | "commerce.payments.refund" | "commerce.payments.void" | "commerce.products.manage" | "commerce.categories.manage" | "commerce.inventory.adjust" | "commerce.customers.anonymize" | "commerce.webhooks.manage" | "commerce.webhooks.replay" | "commerce.media.manage" | "commerce.returns.manage" | "commerce.payments.view" | "commerce.promotions.view" | "commerce.gift_cards.view" | "commerce.promotions.manage" | "commerce.gift_cards.manage" | "commerce.reviews.moderate"method:stringpath:stringparams:Readonly<Record<string, string>>query:Readonly<Record<string, unknown>>channelId:string | null
commerceAbilities
Value
The frozen admin ability catalog (ASPEC §3.2).
Ability names are the authorization vocabulary and the audit vocabulary: every admin endpoint, every Inertia admin action, and every audit entry names exactly one of these. Adding a name is a minor change; renaming one is breaking.
readonly ["commerce.products.view", "commerce.products.manage", "commerce.categories.manage", "commerce.orders.view", "commerce.orders.transition", "commerce.orders.cancel", "commerce.orders.adjust", "commerce.payments.view", "commerce.payments.capture", "commerce.payments.refund", "commerce.payments.void", "commerce.payments.reconcile", "commerce.returns.view", "commerce.returns.manage", "commerce.shipments.manage", "commerce.inventory.view", "commerce.inventory.adjust", "commerce.customers.view", "commerce.customers.anonymize", "commerce.metrics.view", "commerce.audit.view", "commerce.webhooks.view", "commerce.webhooks.manage", "commerce.webhooks.replay", "commerce.media.view", "commerce.media.manage", "commerce.promotions.view", "commerce.promotions.manage", "commerce.gift_cards.view", "commerce.gift_cards.manage", "commerce.reviews.moderate"]CommerceAbility
Type
"commerce.metrics.view" | "commerce.orders.view" | "commerce.products.view" | "commerce.inventory.view" | "commerce.customers.view" | "commerce.payments.reconcile" | "commerce.returns.view" | "commerce.webhooks.view" | "commerce.media.view" | "commerce.audit.view" | "commerce.orders.transition" | "commerce.orders.cancel" | "commerce.orders.adjust" | "commerce.shipments.manage" | "commerce.payments.capture" | "commerce.payments.refund" | "commerce.payments.void" | "commerce.products.manage" | "commerce.categories.manage" | "commerce.inventory.adjust" | "commerce.customers.anonymize" | "commerce.webhooks.manage" | "commerce.webhooks.replay" | "commerce.media.manage" | "commerce.returns.manage" | "commerce.payments.view" | "commerce.promotions.view" | "commerce.gift_cards.view" | "commerce.promotions.manage" | "commerce.gift_cards.manage" | "commerce.reviews.moderate"CommerceAbilityGroup
Type
"metrics" | "inventory" | "payments" | "orders" | "returns" | "customers" | "shipments" | "categories" | "products" | "audit" | "webhooks" | "media" | "promotions" | "giftCards" | "reviews"commerceAbilityGroups
Value
Resource groups, one per shipped policy class. The admin surfaces publish one controller group and one host policy stub per entry.
{ readonly products: readonly ["commerce.products.view", "commerce.products.manage"]; readonly categories: readonly ["commerce.categories.manage"]; readonly orders: readonly ["commerce.orders.view", "commerce.orders.transition", "commerce.orders.cancel", "commerce.orders.adjust"]; readonly payments: readonly ["commerce.payments.view", "commerce.payments.capture", "commerce.payments.refund", "commerce.payments.void", "commerce.payments.reconcile"]; readonly returns: readonly ["commerce.returns.view", "commerce.returns.manage"]; readonly shipments: readonly ["commerce.shipments.manage"]; readonly inventory: readonly ["commerce.inventory.view", "commerce.inventory.adjust"]; readonly customers: readonly ["commerce.customers.view", "commerce.customers.anonymize"]; readonly metrics: readonly ["commerce.metrics.view"]; readonly audit: readonly ["commerce.audit.view"]; readonly webhooks: readonly ["commerce.webhooks.view", "commerce.webhooks.manage", "commerce.webhooks.replay"]; readonly media: readonly ["commerce.media.view", "commerce.media.manage"]; readonly promotions: readonly ["commerce.promotions.view", "commerce.promotions.manage"]; readonly giftCards: readonly ["commerce.gift_cards.view", "commerce.gift_cards.manage"]; readonly reviews: readonly ["commerce.reviews.moderate"]; }CommerceAuditPolicy
Class
CommerceAuditPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceCategoryPolicy
Class
CommerceCategoryPolicyPublic members
manage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceCustomerPolicy
Class
CommerceCustomerPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponseanonymize:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceGiftCardPolicy
Class
CommerceGiftCardPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsemanage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceInventoryPolicy
Class
CommerceInventoryPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponseadjust:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceMediaPolicy
Class
CommerceMediaPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsemanage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceMetricsPolicy
Class
CommerceMetricsPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceOrderPolicy
Class
CommerceOrderPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsetransition:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsecancel:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponseadjust:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommercePaymentPolicy
Class
CommercePaymentPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsecapture:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponserefund:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsevoid:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsereconcile:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
commercePolicyAbilities
Value
The ability each shipped policy method authorizes. admin-api middleware and
the audit trail read this map, and the catalog test asserts it covers the
frozen catalog exactly once per ability.
{ readonly CommerceProductPolicy: { readonly view: "commerce.products.view"; readonly manage: "commerce.products.manage"; }; readonly CommerceCategoryPolicy: { readonly manage: "commerce.categories.manage"; }; readonly CommerceOrderPolicy: { readonly view: "commerce.orders.view"; readonly transition: "commerce.orders.transition"; readonly cancel: "commerce.orders.cancel"; readonly adjust: "commerce.orders.adjust"; }; readonly CommercePaymentPolicy: { readonly view: "commerce.payments.view"; readonly capture: "commerce.payments.capture"; readonly refund: "commerce.payments.refund"; readonly void: "commerce.payments.void"; readonly reconcile: "commerce.payments.reconcile"; }; readonly CommerceReturnPolicy: { readonly view: "commerce.returns.view"; readonly manage: "commerce.returns.manage"; }; readonly CommerceShipmentPolicy: { readonly manage: "commerce.shipments.manage"; }; readonly CommerceInventoryPolicy: { readonly view: "commerce.inventory.view"; readonly adjust: "commerce.inventory.adjust"; }; readonly CommerceCustomerPolicy: { readonly view: "commerce.customers.view"; readonly anonymize: "commerce.customers.anonymize"; }; readonly CommerceMetricsPolicy: { readonly view: "commerce.metrics.view"; }; readonly CommerceAuditPolicy: { readonly view: "commerce.audit.view"; }; readonly CommerceWebhookPolicy: { readonly view: "commerce.webhooks.view"; readonly manage: "commerce.webhooks.manage"; readonly replay: "commerce.webhooks.replay"; }; readonly CommerceMediaPolicy: { readonly view: "commerce.media.view"; readonly manage: "commerce.media.manage"; }; readonly CommercePromotionPolicy: { readonly view: "commerce.promotions.view"; readonly manage: "commerce.promotions.manage"; }; readonly CommerceGiftCardPolicy: { readonly view: "commerce.gift_cards.view"; readonly manag…CommerceProductPolicy
Class
Catalog reads and writes.
Hosts extend this class in app/policies/commerce/product_policy.ts and map
their own roles onto the two methods.
CommerceProductPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsemanage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommercePromotionPolicy
Class
CommercePromotionPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsemanage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceReturnPolicy
Class
CommerceReturnPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsemanage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceReviewPolicy
Class
CommerceReviewPolicyPublic members
moderate:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceShipmentPolicy
Class
CommerceShipmentPolicyPublic members
manage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
CommerceWebhookPolicy
Class
CommerceWebhookPolicyPublic members
view:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsemanage:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponsereplay:(_actor: unknown, _scope: AdminAuthorizationScope) => AuthorizationResponse
denyCommerceAbility
Function
The shipped denial. Every policy method returns it until the host stub overrides the method, so an unmapped ability is a 403 with the ability name in the message rather than a silent pass.
(ability: CommerceAbility) => AuthorizationResponseisCommerceAbility
Function
(value: string) => value is CommerceAbility@adocommercekit/core/testing
ADMIN_REDACTED_KEYS
Value
Keys that must never appear anywhere in a payload serialized for an admin
surface (ASPEC §3.1 redaction rules). Encoded once here so the core
transformer tests and the admin-api redaction walk (ASPEC §9) assert the
same list instead of drifting apart.
Both the camelCase model property and the snake_case column name are listed: a controller that leaks a raw row must fail the same assertion as one that leaks a model instance.
readonly string[]CartFactory
Value
FactoryModelContract<typeof Cart>ChannelFactory
Value
FactoryModelContract<typeof Channel>CustomerFactory
Value
FactoryModelContract<typeof Customer>fakeDeferredPaymentProvider
Function
() => FakeDeferredPaymentProviderFakeDeferredPaymentProvider
Class
FakeDeferredPaymentProviderPublic members
code:"fake_deferred"#counter:number#statuses:Map<string, DeferredPaymentStatus>capabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; flow: "deferred"; }createIntent:(_input: { amount: Money; }) => Promise<{ providerIntentId: string; state: "pending"; expiresAt: DateTime<true>; instructions: { type: "bank_transfer"; bankName: string; accountNumber: string; accountName: string; displayName: string; expiresAt: DateTime<true>; }[]; }>confirm:() => Promise<{ state: "pending"; }>capture:() => Promise<{ providerChargeId: string; }>refund:() => Promise<{ providerRefundId: string; }>void:() => Promise<void>retrieveIntent:(providerIntentId: string) => Promise<DeferredPaymentStatus>setStatus:(providerIntentId: string, status: DeferredPaymentStatus) => voidverifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>
fakeDriver
Function
Creates a deterministic driver factory for host and package tests.
<T>(value: T) => DriverFactory<T>fakePaymentProvider
Function
() => FakePaymentProviderFakePaymentProvider
Class
FakePaymentProviderPublic members
code:"fake"#counter:number#decline:PaymentDeclineCode | undefined#requiresAction:booleanwillDecline:(code: PaymentDeclineCode) => FakePaymentProviderwillRequireAction:() => FakePaymentProvidercapabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; }createIntent:() => Promise<{ providerIntentId: string; state: "created"; }>confirm:() => Promise<ProviderPaymentState>capture:() => Promise<{ providerChargeId: string; }>refund:() => Promise<{ providerRefundId: string; }>void:() => Promise<void>verifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>
findRedactedKeys
Function
Walks a serialized payload and returns the dotted paths of every redacted key it carries. An empty array is the only passing result.
(payload: unknown, path?: string) => string[]OrderFactory
Value
FactoryModelContract<typeof Order>PriceFactory
Value
FactoryModelContract<typeof Price>PriceListFactory
Value
FactoryModelContract<typeof PriceList>ProductFactory
Value
FactoryModelContract<typeof Product>VariantFactory
Value
FactoryModelContract<typeof ProductVariant>@adocommercekit/core/upgrade
applyUpgradeItem
Function
(root: string, item: UpgradePlanItem) => Promise<void>coreMigrations
Value
readonly [readonly ["foundation", "001_foundation.stub"], readonly ["catalog", "002_catalog.stub"], readonly ["customers", "003_customers.stub"], readonly ["pricing", "004_pricing.stub"], readonly ["fulfillment_taxes", "005_fulfillment_taxes.stub"], readonly ["carts", "006_carts.stub"], readonly ["orders_inventory", "007_orders_inventory.stub"], readonly ["payments_infrastructure", "008_payments_infrastructure.stub"], readonly ["transaction_beta", "009_transaction_beta.stub"], readonly ["generic_seams", "010_generic_seams.stub"], readonly ["admin_seams", "011_admin_seams.stub"], readonly ["product_images", "012_product_images.stub"], readonly ["durability_hardening", "013_durability_hardening.stub"], readonly ["external_events", "014_external_events.stub"], readonly ["returns", "015_returns.stub"], readonly ["operational_depth", "016_operational_depth.stub"], readonly ["payment_reconciliation", "017_payment_reconciliation.stub"], readonly ["inventory_backorders", "018_inventory_backorders.stub"], readonly ["customer_privacy", "019_customer_privacy.stub"], readonly ["webhook_hardening", "020_webhook_hardening.stub"]]inspectUpgrade
Function
(root: string, artifacts: readonly UpgradeArtifact[]) => Promise<UpgradePlanItem[]>inspectUpgradeArtifact
Function
(root: string, artifact: UpgradeArtifact) => Promise<UpgradePlanItem>publicationBasePath
Function
(root: string, marker: string) => stringrecordPublicationBase
Function
(root: string, artifact: UpgradeArtifact) => Promise<boolean>sha256
Function
(source: string) => stringUpgradeAction
Type
UpgradeActionUpgradeArtifact
Interface
UpgradeArtifactPublic members
marker:stringdestination:stringsource:stringadvisory:{ id: string; severity: "low" | "moderate" | "high" | "critical"; summary: string; } | undefinederror:string | undefined
UpgradePlanItem
Interface
UpgradePlanItemPublic members
action:UpgradeActionpublishedPath:stringbasePath:stringbaseSource:string | undefinedpublishedSource:string | undefinedmarker:stringdestination:stringsource:stringadvisory:{ id: string; severity: "low" | "moderate" | "high" | "critical"; summary: string; } | undefinederror:string | undefined
@adocommercekit/core/extension
AdminPanelExtension
Interface
AdminPanelExtensionPublic members
id:stringfiles:AdminPanelExtensionFile[]nav:AdminPanelExtensionWireSpec | undefinedi18n:AdminPanelExtensionWireSpec | undefinedcssSources:string[] | undefined
AdminPanelExtensionFile
Interface
AdminPanelExtensionFilePublic members
sourcePath:stringdestination:string
adminPanelExtensionMarker
Function
(id: string, destination: string) => stringAdminPanelExtensionReport
Interface
AdminPanelExtensionReportPublic members
published:string[]skipped:string[]wired:string[]unwirable:string[]panelMissing:boolean
AdminPanelExtensionWireSpec
Interface
AdminPanelExtensionWireSpecPublic members
fragmentDestination:stringexportName:string
adminPanelPublished
Function
(root: string) => Promise<boolean>AdminPanelWiringInput
Interface
AdminPanelWiringInputPublic members
nav:stringnavFragments:Record<string, string>i18n:stringi18nFragments:Record<string, string>css:string | undefinedabilities:readonly string[]
applyRegisteredAdminPanelExtensions
Function
Replays registered extension wiring over fresh panel sources. The admin package calls this before upgrade planning so an upstream panel update keeps package-owned nav, message, and CSS fragments without accepting host edits.
(root: string, artifacts: readonly UpgradeArtifact[]) => Promise<UpgradeArtifact[]>auditAdminPanelExtensionWiring
Function
Audit extension seams without coupling doctor to the publication implementation.
(input: AdminPanelWiringInput) => string[]loadAdminPanelExtensionUpgradeArtifacts
Function
An extension package may be installed without the panel; omitting its UI artifacts avoids offering files that the host cannot load.
(root: string, id: string, files: AdminPanelExtensionFile[]) => Promise<UpgradeArtifact[]>publishAdminPanelExtension
Function
Extension files are package-owned, but a differing host copy is sovereign and must reach the upgrade planner rather than being overwritten during configure.
(root: string, ext: AdminPanelExtension) => Promise<AdminPanelExtensionReport>wireCssSource
Function
(source: string, sourceDir: string) => string | undefinedwireI18nFragment
Function
(source: string, importPath: string, exportName: string) => string | undefinedwireNavFragment
Function
(source: string, importPath: string, exportName: string) => string | undefined@adocommercekit/engagement
CursorPage
Interface
CursorPage<T>Public members
data:T[]nextCursor:string | null
defineEngagementConfig
Function
(config?: EngagementConfig) => { tablePrefix: string; }EngagementConfig
Interface
EngagementConfigPublic members
tablePrefix:string | undefined
EngagementService
Class
EngagementServicePublic members
prefix:stringdb:Databasecarts:Pick<CartService, "addLine">table:(name: string) => stringtransaction:<T>(options: MutationOptions | undefined, run: (trx: TransactionClientContract) => Promise<T>) => Promise<T>lock:(trx: TransactionClientContract, table: string, id: string) => Promise<void>own:(trx: Database | TransactionClientContract, customerId: string, wishlistId: string) => Promise<any>page:<Row extends { id: string; }, T>(rows: Row[], input: ListInput, scope: string, map: (row: Row) => T) => CursorPage<T>limit:(input: ListInput) => numbercursor:(input: ListInput, scope: string) => string | undefinedcreateWishlist:(customerId: string, name?: string, options?: MutationOptions) => Promise<WishlistRecord>listWishlists:(customerId: string, input?: ListInput) => Promise<CursorPage<WishlistRecord>>addItem:(customerId: string, wishlistId: string, variantId: string, options?: MutationOptions) => Promise<WishlistItemRecord>removeItem:(customerId: string, wishlistId: string, itemId: string, options?: MutationOptions) => Promise<void>listItems:(customerId: string, wishlistId: string, input?: ListInput) => Promise<CursorPage<WishlistItemRecord>>moveToCart:(customerId: string, wishlistId: string, itemId: string, cart: Cart, quantity?: number, options?: MutationOptions) => Promise<Cart>review:(row: StoredReview) => ReviewRecordsubmitReview:(customerId: string, productId: string, input: ReviewInput, options?: MutationOptions) => Promise<ReviewRecord>moderateReview:(reviewId: string, state: ReviewState, options?: MutationOptions) => Promise<ReviewRecord>aggregate:(trx: TransactionClientContract, productId: string, previous: StoredReview | undefined, next: StoredReview) => Promise<void>rating:(productId: string) => Promise<RatingAggregate>listReviews:(productId: string, input?: ListInput) => Promise<CursorPage<Omit<ReviewRecord, "customerId">>>listModeration:(input?: ListInput & { state?: ReviewState; }) => Promise<CursorPage<ReviewRecord>>reviewPage:(filters: { productId?: string; state?: ReviewState; }, input: ListInput) => Promise<CursorPage<ReviewRecord>>
ListInput
Interface
ListInputPublic members
cursor:string | undefinedlimit:number | undefined
ProductReview
Class
ProductReviewPublic members
customerId:stringproductId:stringrating:numbertitle:stringbody:stringstate:ReviewState
RatingAggregate
Interface
RatingAggregatePublic members
count:numberaverage:number
ReviewInput
Interface
ReviewInputPublic members
rating:numbertitle:stringbody:string
ReviewRecord
Interface
ReviewRecordPublic members
id:stringcustomerId:stringproductId:stringrating:numbertitle:stringbody:stringstate:ReviewStateverifiedPurchase:true
ReviewState
Type
ReviewStateVerifiedPurchaseRequiredException
Class
VerifiedPurchaseRequiredExceptionWishlist
Class
WishlistPublic members
customerId:stringname:string
WishlistItem
Class
WishlistItemPublic members
wishlistId:stringvariantId:string
WishlistItemRecord
Interface
WishlistItemRecordPublic members
id:stringwishlistId:stringvariantId:string
WishlistRecord
Interface
WishlistRecordPublic members
id:stringcustomerId:stringname:string
@adocommercekit/engagement/models
ProductReview
Class
ProductReviewPublic members
customerId:stringproductId:stringrating:numbertitle:stringbody:stringstate:ReviewState
Wishlist
Class
WishlistPublic members
customerId:stringname:string
WishlistItem
Class
WishlistItemPublic members
wishlistId:stringvariantId:string
@adocommercekit/engagement/services
CursorPage
Interface
CursorPage<T>Public members
data:T[]nextCursor:string | null
EngagementService
Class
EngagementServicePublic members
prefix:stringdb:Databasecarts:Pick<CartService, "addLine">table:(name: string) => stringtransaction:<T>(options: MutationOptions | undefined, run: (trx: TransactionClientContract) => Promise<T>) => Promise<T>lock:(trx: TransactionClientContract, table: string, id: string) => Promise<void>own:(trx: Database | TransactionClientContract, customerId: string, wishlistId: string) => Promise<any>page:<Row extends { id: string; }, T>(rows: Row[], input: ListInput, scope: string, map: (row: Row) => T) => CursorPage<T>limit:(input: ListInput) => numbercursor:(input: ListInput, scope: string) => string | undefinedcreateWishlist:(customerId: string, name?: string, options?: MutationOptions) => Promise<WishlistRecord>listWishlists:(customerId: string, input?: ListInput) => Promise<CursorPage<WishlistRecord>>addItem:(customerId: string, wishlistId: string, variantId: string, options?: MutationOptions) => Promise<WishlistItemRecord>removeItem:(customerId: string, wishlistId: string, itemId: string, options?: MutationOptions) => Promise<void>listItems:(customerId: string, wishlistId: string, input?: ListInput) => Promise<CursorPage<WishlistItemRecord>>moveToCart:(customerId: string, wishlistId: string, itemId: string, cart: Cart, quantity?: number, options?: MutationOptions) => Promise<Cart>review:(row: StoredReview) => ReviewRecordsubmitReview:(customerId: string, productId: string, input: ReviewInput, options?: MutationOptions) => Promise<ReviewRecord>moderateReview:(reviewId: string, state: ReviewState, options?: MutationOptions) => Promise<ReviewRecord>aggregate:(trx: TransactionClientContract, productId: string, previous: StoredReview | undefined, next: StoredReview) => Promise<void>rating:(productId: string) => Promise<RatingAggregate>listReviews:(productId: string, input?: ListInput) => Promise<CursorPage<Omit<ReviewRecord, "customerId">>>listModeration:(input?: ListInput & { state?: ReviewState; }) => Promise<CursorPage<ReviewRecord>>reviewPage:(filters: { productId?: string; state?: ReviewState; }, input: ListInput) => Promise<CursorPage<ReviewRecord>>
ListInput
Interface
ListInputPublic members
cursor:string | undefinedlimit:number | undefined
RatingAggregate
Interface
RatingAggregatePublic members
count:numberaverage:number
ReviewInput
Interface
ReviewInputPublic members
rating:numbertitle:stringbody:string
ReviewRecord
Interface
ReviewRecordPublic members
id:stringcustomerId:stringproductId:stringrating:numbertitle:stringbody:stringstate:ReviewStateverifiedPurchase:true
ReviewState
Type
ReviewStateWishlistItemRecord
Interface
WishlistItemRecordPublic members
id:stringwishlistId:stringvariantId:string
WishlistRecord
Interface
WishlistRecordPublic members
id:stringcustomerId:stringname:string
@adocommercekit/engagement/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/engagement/upgrade
engagementUpgradeManifest
Value
{ packageName: string; version: string; artifacts: { marker: string; destination: string; stub: string; }[]; }loadEngagementUpgradeArtifacts
Function
(root?: string) => Promise<UpgradeArtifact[]>@adocommercekit/engagement/engagement_provider
default
Class
EngagementProviderPublic members
app:ApplicationServiceregister:() => void
@adocommercekit/id
assertCatalogCoverage
Function
(catalog: Partial<IdRegionalCatalog>) => asserts catalog is IdRegionalCatalogchecksumIndonesiaRegions
Function
(records: Iterable<IndonesiaRegionRecord>) => stringCOD_RECONCILIATION_SCHEMA
Value
"commerce.cod-reconciliation.v2"COD_REMITTANCE_SCHEMA
Value
"commerce.cod-remittance.v1"CodImportIssue
Interface
CodImportIssuePublic members
line:numberorderNumber:stringreference:stringreason:string
CodImportResult
Interface
CodImportResultPublic members
fileHash:stringsettled:numberduplicates:numberunmatched:CodImportIssue[]ambiguous:CodImportIssue[]invalid:CodImportIssue[]
CodReconciliationBatch
Interface
CodReconciliationBatchPublic members
id:stringfileName:string | nullfileHash:stringstate:"completed" | "failed" | "processing"rowCount:numbersettledCount:numberexceptionCount:numbercreatedAt:stringcompletedAt:string | null
CodReconciliationLine
Interface
CodReconciliationLinePublic members
id:stringline:numberorderNumber:stringreference:stringcarrier:stringwaybill:stringstatus:"delivered" | "rto"outcome:CodReconciliationOutcomegrossAmount:stringfeeAmount:stringadjustmentAmount:stringnetAmount:stringcurrency:stringreason:string | null
CodReconciliationOutcome
Type
CodReconciliationOutcomeCodReconciliationResult
Interface
CodReconciliationResultPublic members
lines:CodReconciliationLine[]id:stringfileName:string | nullfileHash:stringstate:"completed" | "failed" | "processing"rowCount:numbersettledCount:numberexceptionCount:numbercreatedAt:stringcompletedAt:string | null
CodReconciliationRow
Interface
CodReconciliationRowPublic members
status:stringcurrency:stringreference:stringcarrier:stringwaybill:stringschema_version:stringmerchant_id:stringorder_number:stringgross_amount:stringfee_amount:stringadjustment_amount:stringnet_amount:string
CodRemittanceImporter
Class
CodRemittanceImporterPublic members
#importsTable:stringdb:Databaseregistry:ModelRegistrypayments:PaymentServicemerchantId:stringimport:(contents: string, actor?: string) => Promise<CodImportResult>
CodRemittanceRow
Interface
CodRemittanceRowPublic members
amount:stringcurrency:stringreference:stringschema_version:stringmerchant_id:stringorder_number:string
configure
Function
(command: Configure) => Promise<void>ConsentAction
Type
ConsentActionConsentReceipt
Interface
ConsentReceiptPublic members
id:stringcustomerId:stringpurpose:stringnoticeVersion:stringaction:ConsentActioncapturedAt:stringevidence:Record<string, unknown>
ConsentReceiptService
Class
ConsentReceiptServicePublic members
#table:stringdb:Databasegrant:(input: { customerId: string; purpose: string; noticeVersion: string; evidence?: Record<string, unknown>; capturedAt?: Date; }) => Promise<ConsentReceipt>withdraw:(input: { customerId: string; purpose: string; noticeVersion: string; evidence?: Record<string, unknown>; capturedAt?: Date; }) => Promise<ConsentReceipt>hasValidPurpose:(customerId: string, purpose: string, noticeVersion?: string) => Promise<boolean>list:(customerId: string) => Promise<ConsentReceipt[]>#append:(action: ConsentAction, input: { customerId: string; purpose: string; noticeVersion: string; evidence?: Record<string, unknown>; capturedAt?: Date; }) => Promise<ConsentReceipt>
defineIdConfig
Function
(input?: Partial<Omit<IndonesiaExtensionConfig, "regions" | "pdp">> & { regions?: IndonesiaExtensionConfig["regions"]; pdp?: Partial<IndonesiaExtensionConfig["pdp"]>; }) => IndonesiaExtensionConfigenRegionalCatalog
Value
IdRegionalCatalogID_REGIONAL_MESSAGE_KEYS
Value
readonly ["address.province", "address.city", "address.district", "address.village", "address.postal_code", "address.postal_choice_required", "payment.kode_unik.title", "payment.kode_unik.exact_amount", "payment.expires_at", "payment.review_required", "tax.ppn", "tax.ppn_luxury", "privacy.consent.whatsapp", "privacy.consent.withdrawn", "privacy.request.export", "privacy.request.correction", "privacy.request.deletion", "shipping.delivery_failed", "shipping.returned"]idIDCatalog
Value
IdRegionalCatalogIdRegionalCatalog
Type
IdRegionalCatalogIdRegionalMessageKey
Type
"address.province" | "address.city" | "address.district" | "address.village" | "address.postal_code" | "address.postal_choice_required" | "payment.kode_unik.title" | "payment.kode_unik.exact_amount" | "payment.expires_at" | "payment.review_required" | "tax.ppn" | "tax.ppn_luxury" | "privacy.consent.whatsapp" | "privacy.consent.withdrawn" | "privacy.request.export" | "privacy.request.correction" | "privacy.request.deletion" | "shipping.delivery_failed" | "shipping.returned"INDONESIA_REGIONS_DELIVERY
Value
{ readonly mode: "importer_only"; readonly cadence: "quarterly"; readonly redistribution: "No administrative-area records are bundled. Hosts must supply a licensed source."; }IndonesiaAddressInput
Interface
IndonesiaAddressInputPublic members
firstName:stringlastName:stringcompany:string | undefinedline1:stringline2:string | undefinedphone:string | undefinedprovinceId:stringcityId:stringdistrictId:stringvillageId:string | undefinedpostalCode:string | undefined
IndonesiaAddressValidationError
Class
IndonesiaAddressValidationErrorPublic members
code:"INDONESIA_ADDRESS_INVALID"field:keyof IndonesiaAddressInputname:stringmessage:stringstack:string | undefinedcause:unknown
IndonesiaExtensionConfig
Interface
IndonesiaExtensionConfigPublic members
addressMode:booleanmerchantId:stringregions:{ onUnmatched?: (metric: UnmatchedIndonesiaAddressMetric) => void | Promise<void>; }pdp:{ authorize: PdpAuthorizer<unknown>; identity: { expiresAfterMinutes: number; maxAttempts: number; maxOpenChallenges?: number; cooldownSeconds?: number; }; slaDays: PdpSlaDays; retention?: { cron: string; policyVersion: string; inactiveAfterDays: number; batchSize?: number; }; }
IndonesiaLogisticsDashboard
Interface
IndonesiaLogisticsDashboardPublic members
shipments:IndonesiaLogisticsShipment[]batches:CodReconciliationBatch[]summary:{ active: number; delivered: number; rto: number; reconciliationExceptions: number; }
IndonesiaLogisticsService
Class
IndonesiaLogisticsServicePublic members
#shipmentsTable:string#ordersTable:string#importsTable:string#batchesTable:string#linesTable:string#intentsTable:stringdb:Databaseregistry:ModelRegistrypayments:PaymentServicemerchantId:stringfulfillment:anydashboard:(input?: { search?: string; state?: string; limit?: number; }) => Promise<IndonesiaLogisticsDashboard>reconcile:(contents: string, input?: { fileName?: string; actor?: string; }) => Promise<CodReconciliationResult>carrierPayables:(month: string) => Promise<{ csv: string; rows: number; }>#reconcileLine:(batchId: string, line: number, row: CodReconciliationRow, fileHash: string, actor?: string) => Promise<void>#result:(batch: Record<string, any>) => Promise<CodReconciliationResult>#batch:(row: Record<string, any>) => CodReconciliationBatch
IndonesiaLogisticsShipment
Interface
IndonesiaLogisticsShipmentPublic members
id:stringorderId:stringorderNumber:stringstate:stringcarrier:string | nullprovider:string | nullwaybill:string | nulltrackingNumber:string | nullhandedOffAt:string | nulldeliveredAt:string | nullreturnedAt:string | null
IndonesiaPpnCalculator
Class
IndonesiaPpnCalculatorPublic members
statutoryRateBp:numberregulation:stringcalculate:(input: Parameters<TaxCalculator["calculate"]>[0]) => Promise<TaxLineResult[]>
IndonesiaRegionImporter
Class
IndonesiaRegionImporterPublic members
#versionsTable:string#regionsTable:string#postalTable:stringdb:Databaseimport:(provenance: IndonesiaRegionProvenance, source: AsyncIterable<IndonesiaRegionRecord> | Iterable<IndonesiaRegionRecord>) => Promise<IndonesiaRegionImportResult>
IndonesiaRegionImportResult
Interface
IndonesiaRegionImportResultPublic members
version:stringchecksum:stringregions:numberpostalMappings:number
IndonesiaRegionLevel
Type
IndonesiaRegionLevelIndonesiaRegionListInput
Interface
IndonesiaRegionListInputPublic members
query:string | undefinedlevel:IndonesiaRegionLevel | undefinedcursor:string | undefinedlimit:number | undefined
IndonesiaRegionListPage
Interface
IndonesiaRegionListPagePublic members
items:IndonesiaRegionMatch[]nextCursor:string | nulltotal:number
IndonesiaRegionMatch
Interface
IndonesiaRegionMatchPublic members
sourceId:stringparentSourceId:string | nulllevel:IndonesiaRegionLevelname:string
IndonesiaRegionProvenance
Interface
IndonesiaRegionProvenancePublic members
source:stringsourceUrl:stringversion:stringretrievedAt:stringlicense:stringlicenseUrl:stringexpectedChecksum:stringcorrections:string[] | undefined
IndonesiaRegionRecord
Interface
IndonesiaRegionRecordPublic members
sourceId:stringparentSourceId:string | nulllevel:IndonesiaRegionLevelname:stringpostalCodes:string[] | undefined
IndonesiaRegionService
Class
IndonesiaRegionServicePublic members
#versionsTable:string#regionsTable:string#postalTable:stringdb:DatabaseonUnmatched:((metric: UnmatchedIndonesiaAddressMetric) => void | Promise<void>) | undefinedprovenance:() => Promise<Record<string, unknown> | null>list:(input?: IndonesiaRegionListInput) => Promise<IndonesiaRegionListPage>typeahead:(input: { query: string; level?: IndonesiaRegionLevel; parentSourceId?: string; limit?: number; }) => Promise<IndonesiaRegionMatch[]>find:(sourceId: string, level?: IndonesiaRegionLevel) => Promise<IndonesiaRegionMatch | null>postalCodes:(sourceId: string) => Promise<string[]>recordUnmatched:(metric: UnmatchedIndonesiaAddressMetric) => Promise<void>
kodeUnik
Function
(options: Omit<KodeUnikOptions, "database"> & { database?: Database; }) => DriverFactory<PaymentProvider>KodeUnikAdminAction
Type
KodeUnikAdminActionKodeUnikAdminService
Class
KodeUnikAdminService<Actor>Public members
db:Databasepayments:PaymentServiceprovider:KodeUnikPaymentProviderauthorize:KodeUnikAuthorizer<Actor>registry:anymatchBankStatement:(contents: string, input: { actor: Actor; actorId: string; }) => Promise<Array<{ line: number; reference: string; outcome: "settled" | "review" | "unmatched" | "ambiguous" | "invalid"; intentId?: string; }>>confirm:(input: { actor: Actor; actorId: string; order: Order; intent: PaymentIntent; reference: string; }) => Promise<PaymentIntent>reject:(input: { actor: Actor; actorId: string; order: Order; intent: PaymentIntent; reason: string; }) => Promise<PaymentIntent>lockOwnedLease:(order: Order, intent: PaymentIntent, trx: TransactionClientContract) => Promise<LeaseRow>assertAuthorized:(actor: Actor, action: KodeUnikAdminAction, order: Order) => Promise<void>
KodeUnikAuthorizationError
Class
KodeUnikAuthorizationErrorPublic members
code:"KODE_UNIK_UNAUTHORIZED"name:stringmessage:stringstack:string | undefinedcause:unknown
KodeUnikAuthorizer
Type
KodeUnikAuthorizer<Actor>KodeUnikManualRefundRequiredError
Class
KodeUnikManualRefundRequiredErrorPublic members
code:"KODE_UNIK_MANUAL_REFUND_REQUIRED"operatorAction:"record_manual_transfer_reference"name:stringmessage:stringstack:string | undefinedcause:unknown
KodeUnikOptions
Interface
KodeUnikOptionsPublic members
receivingAccount:KodeUnikReceivingAccountexpiresAfterMinutes:number | undefinedtablePrefix:string | undefineddatabase:Database | undefined
KodeUnikPaymentProvider
Class
KodeUnikPaymentProviderPublic members
code:"kode_unik"#activeTable:string#archiveTable:stringdb:Databaseoptions:Omit<KodeUnikOptions, "database">activeLeaseTable:() => stringcapabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; flow: "deferred"; }createIntent:(input: Parameters<PaymentProvider["createIntent"]>[0]) => Promise<{ providerIntentId: string; state: "pending"; expiresAt: DateTime<boolean>; adjustment: { sourceType: string; sourceId: string; label: string; amount: any; included: boolean; eligible: boolean; position: number; metadata: { receivingAccount: string; code: number; }; }; instructions: { displayName: string; expiresAt: DateTime<boolean>; metadata: { provider: string; receivingAccount: string; uniqueCode: string; }; accountName?: string | undefined; type: "bank_transfer"; bankName: string; accountNumber: string; }[]; raw: { leaseId: string; }; }>confirm:() => Promise<{ state: "pending"; }>capture:() => Promise<{ providerChargeId: string; }>refund:() => Promise<{ providerRefundId: string; }>void:(input: Parameters<PaymentProvider["void"]>[0]) => Promise<void>retrieveIntent:(providerIntentId: string) => Promise<DeferredPaymentStatus>healthCheck:() => Promise<void>verifyWebhook:(_raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:() => Promise<{ type: "unhandled"; providerEventId: string; }>archiveLease:(providerIntentId: string, outcome: LeaseOutcome, resolutionReference: string | null, trx?: TransactionClientContract) => Promise<void>allocate:(reference: string, baseAmount: Money) => Promise<LeaseRow>archiveExpired:(trx: TransactionClientContract) => Promise<void>archive:(lease: LeaseRow, outcome: LeaseOutcome, resolutionReference: string | null, client: LeaseClient) => Promise<void>assertIdr:(amount: Money) => void
KodeUnikReceivingAccount
Interface
KodeUnikReceivingAccountPublic members
id:stringbankName:stringaccountNumber:stringaccountName:string | undefined
parseCodReconciliationCsv
Function
(input: string) => CodReconciliationRow[]parseCodRemittanceCsv
Function
(input: string) => CodRemittanceRow[]PDP_RETENTION_JOB
Value
"commerce.id.pdp-retention.v1"PDP_SLA_JOB
Value
"commerce.id.pdp-sla.v1"PdpAuthorizationError
Class
PdpAuthorizationErrorPublic members
code:"PDP_UNAUTHORIZED"name:stringmessage:stringstack:string | undefinedcause:unknown
PdpAuthorizer
Type
PdpAuthorizer<Actor>PdpErasureService
Class
Keep statutory receipt facts, but remove free-form identifying evidence.
PdpErasureServicePublic members
db:Databaseprefix:stringscrub:(customerId: string) => Promise<void>
PdpIdentityChallenge
Interface
PdpIdentityChallengePublic members
id:stringcustomerId:stringpurpose:PdpIdentityPurposeattemptsRemaining:numberexpiresAt:stringverifiedAt:string | nullconsumedAt:string | null
PdpIdentityChallengeError
Class
PdpIdentityChallengeErrorPublic members
code:"PDP_IDENTITY_EXPIRED" | "PDP_IDENTITY_LOCKED" | "PDP_IDENTITY_UNVERIFIED" | "PDP_IDENTITY_CONSUMED" | "PDP_IDENTITY_MISMATCH"name:stringmessage:stringstack:string | undefinedcause:unknown
PdpIdentityPurpose
Type
PdpIdentityPurposePdpIdentityVerificationService
Class
PdpIdentityVerificationServicePublic members
#table:string#customersTable:stringdb:Databasedefaults:{ expiresAfterMinutes?: number; maxAttempts?: number; maxOpenChallenges?: number; cooldownSeconds?: number; }create:(input: { customerId: string; purpose: PdpIdentityPurpose; expiresAfterMinutes?: number; maxAttempts?: number; }) => Promise<PdpIdentityChallenge>verify:(input: { challengeId: string; customerId: string; verifyEvidence: () => boolean | Promise<boolean>; }) => Promise<PdpIdentityChallenge>consume:(input: { challengeId: string; customerId: string; purpose: PdpIdentityPurpose; }) => Promise<PdpIdentityChallenge>status:(challengeId: string, customerId: string) => Promise<PdpIdentityChallenge | null>#assertIdentity:(row: Record<string, any> | undefined, customerId: string) => asserts row is Record<string, any>#assertUsable:(row: Record<string, any>) => void#map:(row: Record<string, any>) => PdpIdentityChallenge
PdpLegalHoldService
Class
PdpLegalHoldServicePublic members
#table:stringdb:Databaseplace:(customerId: string, reason: string, actor: string) => Promise<string>release:(id: string, actor: string) => Promise<void>
PdpPortabilityExport
Interface
PdpPortabilityExportPublic members
schemaVersion:"commerce.id.pdp-export.v1"core:CustomerPortabilityExportconsentReceipts:ConsentReceipt[]rightsRequests:PdpRightsRequest[]
PdpRequestKind
Type
PdpRequestKindPdpRequestOverdue
Class
PdpRequestOverduePublic members
requestId:stringcustomerId:stringkind:stringdueAt:string
PdpRequestState
Type
PdpRequestStatePdpRetentionPolicy
Interface
PdpRetentionPolicyPublic members
version:stringinactiveBefore:DatebatchSize:number | undefined
PdpRetentionService
Class
PdpRetentionServicePublic members
#holdsTable:string#actionsTable:stringdb:Databaseregistry:ModelRegistrycustomers:CustomerServiceplan:(policy: PdpRetentionPolicy) => Promise<string[]>execute:(policy: PdpRetentionPolicy, options: { dryRun: boolean; }) => Promise<string[]>
PdpRightsRequest
Interface
PdpRightsRequestPublic members
id:stringcustomerId:stringkind:PdpRequestKindstate:PdpRequestStatenoticeVersion:stringrequestedAt:stringdueAt:stringverifiedAt:string | nullcompletedAt:string | nullresolutionNote:string | nullpayload:Record<string, unknown>
PdpRightsService
Class
PdpRightsService<Actor>Public members
#requestsTable:string#holdsTable:stringdb:Databaseregistry:ModelRegistrycustomers:CustomerServiceconsents:ConsentReceiptServiceauthorize:PdpAuthorizer<Actor>identity:PdpIdentityVerificationService | undefinedslaDays:PdpSlaDayssubmit:(input: { actor: Actor; customerId: string; kind: PdpRequestKind; noticeVersion: string; verificationId?: string; payload?: Record<string, unknown>; }) => Promise<PdpRightsRequest>approve:(input: { actor: Actor; requestId: string; resolutionNote?: string; }) => Promise<PdpRightsRequest>reject:(input: { actor: Actor; requestId: string; resolutionNote: string; }) => Promise<PdpRightsRequest>export:(actor: Actor, customerId: string) => Promise<PdpPortabilityExport>exportVerified:(actor: Actor, customerId: string, verificationId: string) => Promise<PdpPortabilityExport>list:(actor: Actor, customerId: string) => Promise<PdpRightsRequest[]>completeCorrection:(input: { actor: Actor; requestId: string; correction: Partial<Pick<Customer, "email" | "firstName" | "lastName" | "phone">>; }) => Promise<PdpRightsRequest>completeDeletion:(input: { actor: Actor; requestId: string; }) => Promise<PdpRightsRequest>#resolve:(input: { actor: Actor; requestId: string; resolutionNote?: string; }, state: "approved" | "rejected") => Promise<PdpRightsRequest>#request:(id: string) => Promise<PdpRightsRequest>#map:(row: Record<string, any>) => PdpRightsRequest#authorized:(actor: Actor, action: Parameters<PdpAuthorizer<Actor>>[1], customerId: string) => Promise<void>
PdpSlaDays
Type
PdpSlaDaysPPN_REGULATION
Value
"PMK 131/2024"PPN_STATUTORY_RATE_BP
Value
1200PpnAuditService
Class
PpnAuditServicePublic members
db:DatabasetablePrefix:stringgenerate:(month: string) => Promise<{ csv: string; rows: number; total: bigint; excludedTotal: bigint; excludedRows: number; }>
ppnCalculator
Function
(options?: PpnCalculatorOptions) => DriverFactory<TaxCalculator>PpnCalculatorOptions
Interface
PpnCalculatorOptionsPublic members
statutoryRateBp:number | undefinedregulation:string | undefined
PpnCategory
Type
PpnCategoryRunPdpRetention
Class
RunPdpRetentionPublic members
retention:PdpRetentionServicehandle:(payload: JobPayload) => Promise<void>
RunPdpSla
Class
RunPdpSlaPublic members
db:Databaseoutbox:EventOutboxServiceprefix:stringhandle:() => Promise<void>
UnmatchedIndonesiaAddressMetric
Interface
UnmatchedIndonesiaAddressMetricPublic members
countryCode:"ID"provinceId:string | undefinedcityId:string | undefineddistrictId:string | undefinedvillageId:string | undefinedreason:"unknown_region" | "ambiguous_postal_code" | "postal_code_mismatch"
validateIndonesiaAddress
Function
(input: IndonesiaAddressInput, regions: IndonesiaRegionService) => Promise<AddressInput>@adocommercekit/id/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/id/commands
getCommand
Function
(metaData: { commandName: string; }) => Promise<typeof CommerceIdCodImport | typeof CommerceIdPpnAudit | null>getMetaData
Function
() => Promise<{ commandName: string; description: string; help: string; namespace: string; aliases: never[]; flags: { name: string; flagName: string; required: boolean; type: string; description: string; }[]; args: never[]; options: { startApp: boolean; } | { startApp: boolean; }; filePath: string; }[]>@adocommercekit/id/id_provider
default
Class
IndonesiaExtensionProviderPublic members
app:ApplicationServiceregister:() => voidboot:() => Promise<void>start:() => Promise<void>
@adocommercekit/id/upgrade
indonesiaAdminPanelExtensionFiles
Value
{ sourcePath: string; destination: string; }[]IndonesiaUpgradeArtifactDefinition
Interface
IndonesiaUpgradeArtifactDefinitionPublic members
marker:stringdestination:stringstub:string
indonesiaUpgradeManifest
Value
{ readonly packageName: "@adocommercekit/id"; readonly version: string; readonly artifacts: { marker: string; destination: string; stub: string; }[]; }loadIndonesiaUpgradeArtifacts
Function
A root opts into panel-aware artifacts. Callers without one retain the original four-file contract used before package extensions existed.
(root?: string) => Promise<any[]>@adocommercekit/midtrans
configure
Function
(command: Configure) => Promise<void>midtrans
Function
(options: MidtransOptions) => DriverFactory<PaymentProvider>MIDTRANS_API_FAMILY
Value
"Core API v2"MIDTRANS_REFUND_CAPABILITIES
Value
Readonly<Record<MidtransChannel, RefundCapability>>MIDTRANS_SOURCE_RECORD
Value
Readonly<{ retrievedAt: "2026-07-24"; notification: "https://docs.midtrans.com/reference/https-notification"; signature: "https://docs.midtrans.com/docs/https-notification-webhooks#signature-key"; status: "https://docs.midtrans.com/reference/get-transaction-status"; qris: "https://docs.midtrans.com/reference/qris"; gopay: "https://docs.midtrans.com/reference/gopay"; refunds: "https://docs.midtrans.com/reference/refund-transaction"; }>MidtransChannel
Type
MidtransChannelMidtransManualRefundRequiredError
Class
MidtransManualRefundRequiredErrorPublic members
code:"MIDTRANS_MANUAL_REFUND_REQUIRED"channel:MidtransChannelguidance:stringname:stringmessage:stringstack:string | undefinedcause:unknown
MidtransOptions
Interface
MidtransOptionsPublic members
serverKey:stringclientKey:stringenvironment:"sandbox" | "production"channel:MidtransChannelexpiryMinutes:number | undefinedcallbackUrl:string | undefinedapiBase:string | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
MidtransPaymentProvider
Class
MidtransPaymentProviderPublic members
code:"midtrans"#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }options:MidtransOptionscapabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; flow: "deferred"; }refundCapability:() => RefundCapabilitycreateIntent:(input: Parameters<PaymentProvider["createIntent"]>[0]) => Promise<{ providerIntentId: string; state: "pending"; instructions: PaymentInstructionDraft[]; expiresAt: DateTime<boolean>; raw: JsonObject; }>confirm:() => Promise<{ state: "pending"; }>capture:() => Promise<{ providerChargeId: string; }>refund:(input: Parameters<PaymentProvider["refund"]>[0]) => Promise<{ providerRefundId: any; state: "succeeded" | "failed" | "pending"; raw: JsonObject; }>retrieveRefund:(input: Parameters<NonNullable<PaymentProvider["retrieveRefund"]>>[0]) => Promise<{ raw: JsonObject; amount?: any; providerRefundId: string; state: "succeeded"; } | null>void:(input: Parameters<PaymentProvider["void"]>[0]) => Promise<void>retrieveIntent:(providerIntentId: string) => Promise<{ state: "settled"; amount: any; occurredAt: DateTime<boolean> | undefined; reference: string; raw: JsonObject; } | { state: "expired" | "failed" | "pending"; occurredAt: DateTime<boolean> | undefined; raw: JsonObject; amount?: undefined; reference?: undefined; }>healthCheck:() => Promise<void>verifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>chargePayload:(input: Parameters<PaymentProvider["createIntent"]>[0]) => JsonObjectinstructions:(result: JsonObject, expiresAt: DateTime) => PaymentInstructionDraft[]paymentStatus:(payload: JsonObject) => "pending" | "settled" | "expired" | "failed"paymentEventType:(status: string) => "payment.pending" | "payment.authorized" | "payment.captured" | "payment.expired" | "payment.failed" | undefinedassertIdr:(amount: Money) => voidsafeAmount:(amount: Money) => numberrequest:(method: string, path: string, body?: JsonObject, idempotencyKey?: string) => Promise<JsonObject>rawRequest:(method: string, path: string, body?: JsonObject, idempotencyKey?: string) => Promise<Response>apiBase:() => string
midtransWebhookUrl
Function
(appUrl: string) => stringRefundCapability
Interface
RefundCapabilityPublic members
mode:"automatic" | "manual_transfer"guidance:string | undefined
@adocommercekit/midtrans/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/preorders
configure
Function
(command: Configure) => Promise<void>CreatePreorderInput
Interface
CreatePreorderInputPublic members
variantId:stringstartsAt:DateTime<boolean> | null | undefinedendsAt:DateTime<boolean> | null | undefinedexpectedShipAt:DateTime<boolean>allocationLimit:number | null | undefinedmaxPerOrder:number | undefineddepositPercent:number | null | undefineddepositAmount:number | null | undefinedrefundDepositOnCancel:boolean | undefinedmessage:string | null | undefinedmetadata:Record<string, unknown> | undefined
definePreordersConfig
Function
(input?: PreordersConfig) => ResolvedPreordersConfigPreorder
Class
PreorderPublic members
variantId:stringstatus:PreorderStatusstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullexpectedShipAt:DateTime<boolean>allocationLimit:number | nullallocatedQuantity:numbermaxPerOrder:numberdepositPercent:number | nulldepositAmount:number | nullrefundDepositOnCancel:booleanmessage:string | nullreleasedAt:DateTime<boolean> | nullcancelledAt:DateTime<boolean> | null
PreorderAllocation
Class
PreorderAllocationPublic members
preorderId:stringorderId:stringorderLineId:stringvariantId:stringquantity:numberstatus:PreorderAllocationStatusdepositAmount:stringbalanceAmount:stringcurrency:stringpaymentId:string | nulldepositCaptureId:string | nulldepositState:"captured" | "refunded" | "pending"balanceState:"captured" | "pending"refundDepositOnCancel:booleanexpectedShipAt:DateTime<boolean>readyAt:DateTime<boolean> | nullfulfilledAt:DateTime<boolean> | nullcancelledAt:DateTime<boolean> | null
PreorderAllocationStatus
Type
PreorderAllocationStatusPreorderAvailability
Interface
PreorderAvailabilityPublic members
preorderId:stringvariantId:stringstatus:PreorderAvailabilityStatusavailable:booleanstartsAt:string | nullendsAt:string | nullexpectedShipAt:stringremainingQuantity:number | nullmaxPerOrder:numbermessage:string | null
PreorderAvailabilityStatus
Type
PreorderAvailabilityStatusPreorderBackorderPolicy
Class
PreorderBackorderPolicyPublic members
name:"preorders"preorders:PreorderLookupoptions:Pick<PreorderOptions, "clock">allowsBackorder:(input: Parameters<InventoryBackorderPolicy["allowsBackorder"]>[0]) => Promise<boolean>
PreorderCartProcessor
Class
PreorderCartProcessorPublic members
name:"preorders"position:150preorders:PreorderLookupoptions:Pick<PreorderOptions, "clock">process:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>
PreorderErrorCode
Type
PreorderErrorCodePreorderException
Class
PreorderExceptionPublic members
code:PreorderErrorCode
PreorderOptions
Interface
PreorderOptionsPublic members
clock:(() => DateTime) | undefinedpayments:any
PreordersConfig
Interface
PreordersConfigPublic members
defaultMaxPerOrder:number | undefined
PreorderService
Class
PreorderServicePublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedPreordersConfigoptions:PreorderOptionsnow:() => DateTimecreate:(input: CreatePreorderInput, options?: MutationOptions) => Promise<Preorder>update:(id: string, input: UpdatePreorderInput, options?: MutationOptions) => Promise<Preorder>activate:(id: string, options?: MutationOptions) => Promise<Preorder>pause:(id: string, options?: MutationOptions) => Promise<Preorder>release:(id: string, options?: MutationOptions) => Promise<Preorder>cancel:(id: string, options?: MutationOptions) => Promise<Preorder>availability:(variantId: string) => Promise<PreorderAvailability | null>openForVariants:(variantIds: string[], trx?: TransactionClientContract) => Promise<Map<string, Preorder>>list:(limit?: number) => Promise<Preorder[]>allocations:(preorderId: string, limit?: number) => Promise<PreorderAllocation[]>allocateOrder:(order: Order, options?: MutationOptions) => Promise<PreorderAllocation[]>releaseOrder:(orderId: string, options?: MutationOptions) => Promise<number>markFulfilled:(id: string, options?: MutationOptions) => Promise<PreorderAllocation>cancelAllocation:(id: string, options?: MutationOptions) => Promise<PreorderAllocation>transition:(id: string, allowed: PreorderStatus[], options: MutationOptions | undefined, apply: (preorder: Preorder, now: DateTime) => void) => Promise<Preorder>transitionAllocation:(id: string, allowed: PreorderAllocationStatus[], target: PreorderAllocationStatus, options?: MutationOptions) => Promise<PreorderAllocation>cancelLockedAllocation:(allocation: PreorderAllocation, trx: TransactionClientContract) => Promise<void>refundDeposit:(allocation: PreorderAllocation) => Promise<void>requirePayments:() => PaymentServicedepositFor:(preorder: Preorder, total: bigint) => bigintcaptureAmountForOrder:(order: Order) => Promise<Money | undefined>recordDepositCapture:(orderId: string) => Promise<void>captureBalance:(allocation: PreorderAllocation) => Promise<void>assertAccepts:(preorder: Preorder, quantity: number, now: DateTime) => voidvalidateWindow:(input: { startsAt?: DateTime | null; endsAt?: DateTime | null; expectedShipAt: DateTime; allocationLimit?: number | null; maxPerOrder?: number; depositPercent?: number | null; depositAmount?: number | null; }) => voidtransitionError:(preorder: Preorder, action: string) => PreorderException
PreorderSnapshot
Interface
PreorderSnapshotPublic members
id:stringvariantId:stringstatus:PreorderStatusstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullexpectedShipAt:DateTime<boolean>allocationLimit:number | nullallocatedQuantity:numbermaxPerOrder:numbermessage:string | null
PreorderStatus
Type
PreorderStatusResolvedPreordersConfig
Interface
ResolvedPreordersConfigPublic members
defaultMaxPerOrder:number
resolvePreorderAvailability
Function
(preorder: PreorderSnapshot, now?: DateTime) => PreorderAvailabilityUpdatePreorderInput
Interface
UpdatePreorderInputPublic members
startsAt:DateTime<boolean> | null | undefinedendsAt:DateTime<boolean> | null | undefinedexpectedShipAt:DateTime<boolean> | undefinedallocationLimit:number | null | undefinedmaxPerOrder:number | undefineddepositPercent:number | null | undefineddepositAmount:number | null | undefinedrefundDepositOnCancel:boolean | undefinedmessage:string | null | undefinedmetadata:Record<string, unknown> | null | undefined
@adocommercekit/preorders/models
Preorder
Class
PreorderPublic members
variantId:stringstatus:PreorderStatusstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullexpectedShipAt:DateTime<boolean>allocationLimit:number | nullallocatedQuantity:numbermaxPerOrder:numberdepositPercent:number | nulldepositAmount:number | nullrefundDepositOnCancel:booleanmessage:string | nullreleasedAt:DateTime<boolean> | nullcancelledAt:DateTime<boolean> | null
PreorderAllocation
Class
PreorderAllocationPublic members
preorderId:stringorderId:stringorderLineId:stringvariantId:stringquantity:numberstatus:PreorderAllocationStatusdepositAmount:stringbalanceAmount:stringcurrency:stringpaymentId:string | nulldepositCaptureId:string | nulldepositState:"captured" | "refunded" | "pending"balanceState:"captured" | "pending"refundDepositOnCancel:booleanexpectedShipAt:DateTime<boolean>readyAt:DateTime<boolean> | nullfulfilledAt:DateTime<boolean> | nullcancelledAt:DateTime<boolean> | null
PreorderAllocationStatus
Type
PreorderAllocationStatusPreorderStatus
Type
PreorderStatus@adocommercekit/preorders/services
CreatePreorderInput
Interface
CreatePreorderInputPublic members
variantId:stringstartsAt:DateTime<boolean> | null | undefinedendsAt:DateTime<boolean> | null | undefinedexpectedShipAt:DateTime<boolean>allocationLimit:number | null | undefinedmaxPerOrder:number | undefineddepositPercent:number | null | undefineddepositAmount:number | null | undefinedrefundDepositOnCancel:boolean | undefinedmessage:string | null | undefinedmetadata:Record<string, unknown> | undefined
PreorderAvailability
Interface
PreorderAvailabilityPublic members
preorderId:stringvariantId:stringstatus:PreorderAvailabilityStatusavailable:booleanstartsAt:string | nullendsAt:string | nullexpectedShipAt:stringremainingQuantity:number | nullmaxPerOrder:numbermessage:string | null
PreorderAvailabilityStatus
Type
PreorderAvailabilityStatusPreorderBackorderPolicy
Class
PreorderBackorderPolicyPublic members
name:"preorders"preorders:PreorderLookupoptions:Pick<PreorderOptions, "clock">allowsBackorder:(input: Parameters<InventoryBackorderPolicy["allowsBackorder"]>[0]) => Promise<boolean>
PreorderCartProcessor
Class
PreorderCartProcessorPublic members
name:"preorders"position:150preorders:PreorderLookupoptions:Pick<PreorderOptions, "clock">process:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>
PreorderOptions
Interface
PreorderOptionsPublic members
clock:(() => DateTime) | undefinedpayments:any
PreorderService
Class
PreorderServicePublic members
db:Databaseregistry:ModelRegistryconfig:ResolvedPreordersConfigoptions:PreorderOptionsnow:() => DateTimecreate:(input: CreatePreorderInput, options?: MutationOptions) => Promise<Preorder>update:(id: string, input: UpdatePreorderInput, options?: MutationOptions) => Promise<Preorder>activate:(id: string, options?: MutationOptions) => Promise<Preorder>pause:(id: string, options?: MutationOptions) => Promise<Preorder>release:(id: string, options?: MutationOptions) => Promise<Preorder>cancel:(id: string, options?: MutationOptions) => Promise<Preorder>availability:(variantId: string) => Promise<PreorderAvailability | null>openForVariants:(variantIds: string[], trx?: TransactionClientContract) => Promise<Map<string, Preorder>>list:(limit?: number) => Promise<Preorder[]>allocations:(preorderId: string, limit?: number) => Promise<PreorderAllocation[]>allocateOrder:(order: Order, options?: MutationOptions) => Promise<PreorderAllocation[]>releaseOrder:(orderId: string, options?: MutationOptions) => Promise<number>markFulfilled:(id: string, options?: MutationOptions) => Promise<PreorderAllocation>cancelAllocation:(id: string, options?: MutationOptions) => Promise<PreorderAllocation>transition:(id: string, allowed: PreorderStatus[], options: MutationOptions | undefined, apply: (preorder: Preorder, now: DateTime) => void) => Promise<Preorder>transitionAllocation:(id: string, allowed: PreorderAllocationStatus[], target: PreorderAllocationStatus, options?: MutationOptions) => Promise<PreorderAllocation>cancelLockedAllocation:(allocation: PreorderAllocation, trx: TransactionClientContract) => Promise<void>refundDeposit:(allocation: PreorderAllocation) => Promise<void>requirePayments:() => PaymentServicedepositFor:(preorder: Preorder, total: bigint) => bigintcaptureAmountForOrder:(order: Order) => Promise<Money | undefined>recordDepositCapture:(orderId: string) => Promise<void>captureBalance:(allocation: PreorderAllocation) => Promise<void>assertAccepts:(preorder: Preorder, quantity: number, now: DateTime) => voidvalidateWindow:(input: { startsAt?: DateTime | null; endsAt?: DateTime | null; expectedShipAt: DateTime; allocationLimit?: number | null; maxPerOrder?: number; depositPercent?: number | null; depositAmount?: number | null; }) => voidtransitionError:(preorder: Preorder, action: string) => PreorderException
PreorderSnapshot
Interface
PreorderSnapshotPublic members
id:stringvariantId:stringstatus:PreorderStatusstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullexpectedShipAt:DateTime<boolean>allocationLimit:number | nullallocatedQuantity:numbermaxPerOrder:numbermessage:string | null
resolvePreorderAvailability
Function
(preorder: PreorderSnapshot, now?: DateTime) => PreorderAvailabilityUpdatePreorderInput
Interface
UpdatePreorderInputPublic members
startsAt:DateTime<boolean> | null | undefinedendsAt:DateTime<boolean> | null | undefinedexpectedShipAt:DateTime<boolean> | undefinedallocationLimit:number | null | undefinedmaxPerOrder:number | undefineddepositPercent:number | null | undefineddepositAmount:number | null | undefinedrefundDepositOnCancel:boolean | undefinedmessage:string | null | undefinedmetadata:Record<string, unknown> | null | undefined
@adocommercekit/preorders/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/preorders/upgrade
loadPreordersUpgradeArtifacts
Function
(root?: string) => Promise<UpgradeArtifact[]>preordersUpgradeManifest
Value
{ readonly packageName: "@adocommercekit/preorders"; readonly version: string; readonly artifacts: readonly [{ readonly marker: "preorders:config/preorders"; readonly destination: "config/commerce_preorders.ts"; readonly stub: "config/preorders.stub"; }, { readonly marker: "preorders:validators/preorders"; readonly destination: "app/validators/commerce_preorders.ts"; readonly stub: "validators/preorders.stub"; }, { readonly marker: "preorders:controllers/preorders"; readonly destination: "app/controllers/commerce/preorders_controller.ts"; readonly stub: "controllers/preorders_controller.stub"; }, { readonly marker: "preorders:controllers/admin-preorders"; readonly destination: "app/controllers/commerce_admin/preorders_controller.ts"; readonly stub: "controllers/admin_preorders_controller.stub"; }, { readonly marker: "preorders:routes/preorders"; readonly destination: "start/routes/commerce_preorders.ts"; readonly stub: "routes/preorders.stub"; }]; }@adocommercekit/preorders/preorders_provider
default
Class
PreordersProviderPublic members
app:ApplicationServiceregister:() => voidboot:() => Promise<void>
@adocommercekit/promotions
CampaignStatus
Type
CampaignStatusconfigure
Function
(command: Configure) => Promise<void>CreateCampaignInput
Interface
CreateCampaignInputPublic members
code:stringname:stringdescription:string | undefinedstatus:CampaignStatus | undefinedkind:PromotionKindvalue:string | number | bigintcurrency:string | undefinedstartsAt:DateTime<boolean> | undefinedendsAt:DateTime<boolean> | undefinedpriority:number | undefinedstackable:boolean | undefinedautomatic:boolean | undefinedusageLimit:number | undefinedperCustomerLimit:number | undefinedmatchType:PromotionMatchType | undefinedmetadata:Record<string, unknown> | undefined
CreatePromotionCodeInput
Interface
CreatePromotionCodeInputPublic members
code:stringusageLimit:number | undefinedperCustomerLimit:number | undefinedstartsAt:DateTime<boolean> | undefinedendsAt:DateTime<boolean> | undefinedmetadata:Record<string, unknown> | undefined
definePromotionsConfig
Function
(input?: PromotionsConfig) => ResolvedPromotionsConfigPromotionCampaign
Class
PromotionCampaignPublic members
code:stringname:stringdescription:string | nullstatus:CampaignStatuskind:PromotionKindvalueAmount:bigintvalueCurrency:string | nullstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullpriority:numberstackable:booleanautomatic:booleanusageLimit:number | nullperCustomerLimit:number | nullmatchType:PromotionMatchType
PromotionCartProcessor
Class
PromotionCartProcessorPublic members
name:stringposition:numbershippingOnly:booleanregistry:ModelRegistrytablePrefix:stringconfig:ResolvedPromotionsConfigclock:() => DateTimeprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:(cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>evaluateRules:(campaign: PromotionCampaign, cart: Cart, ctx: RecalculationContext) => Promise<Set<string>>claim:(candidate: Candidate, cart: Cart, trx: TransactionClientContract, now: DateTime) => Promise<"inactive" | "expired" | "exhausted" | null>withinLimits:(campaign: PromotionCampaign, code: PromotionCode | null, customerId: string | null, trx: TransactionClientContract, now: DateTime, excludeId?: string) => Promise<boolean>discountAmounts:(campaign: PromotionCampaign, cart: Cart, lines: CartLine[], running: Map<string, bigint>) => bigint[]withinWindow:(value: { startsAt: DateTime | null; endsAt: DateTime | null; }, now: DateTime) => booleancartCodes:(cart: Cart) => string[]
PromotionCode
Class
PromotionCodePublic members
campaignId:stringcode:stringactive:booleanusageLimit:number | nullperCustomerLimit:number | nullstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | null
PromotionFeedback
Interface
PromotionFeedbackPublic members
code:stringstatus:"expired" | "applied" | "ineligible" | "exhausted"reason:"expired" | "ineligible" | "exhausted" | "inactive" | undefined
PromotionKind
Type
PromotionKindPromotionMatchType
Type
PromotionMatchTypePromotionRedemption
Class
PromotionRedemptionPublic members
campaignId:stringcodeId:string | nullcartId:stringorderId:string | nullcustomerId:string | nullstate:RedemptionStateamount:MoneyamountAmount:bigintamountCurrency:stringexpiresAt:DateTime<boolean> | nullredeemedAt:DateTime<boolean> | nullreleasedAt:DateTime<boolean> | null
PromotionRule
Class
PromotionRulePublic members
campaignId:stringtype:PromotionRuleTypeconfiguration:Record<string, unknown>position:number
PromotionRuleType
Type
PromotionRuleTypePromotionsConfig
Interface
PromotionsConfigPublic members
pendingRedemptionMinutes:number | undefinedmaximumCodesPerCart:number | undefined
PromotionService
Class
PromotionServicePublic members
db:Databaseregistry:ModelRegistrycarts:CartServiceconfig:ResolvedPromotionsConfigclock:() => DateTimelistCampaigns:() => Promise<PromotionCampaign[]>findCampaign:(id: string) => Promise<PromotionCampaign | null>listCodes:(campaignId: string) => Promise<PromotionCode[]>expirePendingRedemptions:(options?: MutationOptions) => Promise<void>releaseOrder:(orderId: string, options?: MutationOptions) => Promise<void>createCampaign:(input: CreateCampaignInput, options?: MutationOptions) => Promise<PromotionCampaign>updateCampaign:(id: string, input: UpdateCampaignInput, options?: MutationOptions) => Promise<PromotionCampaign>endCampaign:(id: string, options?: MutationOptions) => Promise<PromotionCampaign>addRule:(campaignId: string, input: { type: PromotionRuleType; configuration: Record<string, unknown>; position?: number; metadata?: Record<string, unknown>; }, options?: MutationOptions) => Promise<PromotionRule>removeRule:(campaignId: string, ruleId: string, options?: MutationOptions) => Promise<void>createCode:(campaignId: string, input: CreatePromotionCodeInput, options?: MutationOptions) => Promise<PromotionCode>revokeCode:(codeId: string, options?: MutationOptions) => Promise<PromotionCode>applyCoupon:(cart: Cart, rawCode: string, options?: MutationOptions) => Promise<Cart>removeCoupon:(cart: Cart, rawCode: string, options?: MutationOptions) => Promise<Cart>validateCampaign:(input: Pick<CreateCampaignInput, "code" | "name" | "kind" | "value" | "currency" | "startsAt" | "endsAt" | "status" | "matchType">) => voidvalidateRule:(type: PromotionRuleType, configuration: Record<string, unknown>) => voidwithinWindow:(value: { startsAt: DateTime | null; endsAt: DateTime | null; }, now: DateTime) => booleancartCodes:(cart: Cart) => string[]inTransaction:<T>(options: MutationOptions | undefined, callback: (trx: TransactionClientContract) => Promise<T>) => Promise<T>
PromotionShippingProcessor
Class
PromotionShippingProcessorPublic members
name:"promotion_shipping"position:600shippingOnly:trueregistry:ModelRegistrytablePrefix:stringconfig:ResolvedPromotionsConfigclock:() => DateTimeprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:(cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>evaluateRules:(campaign: PromotionCampaign, cart: Cart, ctx: RecalculationContext) => Promise<Set<string>>claim:(candidate: Candidate, cart: Cart, trx: TransactionClientContract, now: DateTime) => Promise<"inactive" | "expired" | "exhausted" | null>withinLimits:(campaign: PromotionCampaign, code: PromotionCode | null, customerId: string | null, trx: TransactionClientContract, now: DateTime, excludeId?: string) => Promise<boolean>discountAmounts:(campaign: PromotionCampaign, cart: Cart, lines: CartLine[], running: Map<string, bigint>) => bigint[]withinWindow:(value: { startsAt: DateTime | null; endsAt: DateTime | null; }, now: DateTime) => booleancartCodes:(cart: Cart) => string[]
RedemptionState
Type
RedemptionStateResolvedPromotionsConfig
Interface
ResolvedPromotionsConfigPublic members
pendingRedemptionMinutes:numbermaximumCodesPerCart:number
unknown
Value
anyUpdateCampaignInput
Type
UpdateCampaignInput@adocommercekit/promotions/models
CampaignStatus
Type
CampaignStatusPromotionCampaign
Class
PromotionCampaignPublic members
code:stringname:stringdescription:string | nullstatus:CampaignStatuskind:PromotionKindvalueAmount:bigintvalueCurrency:string | nullstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | nullpriority:numberstackable:booleanautomatic:booleanusageLimit:number | nullperCustomerLimit:number | nullmatchType:PromotionMatchType
PromotionCode
Class
PromotionCodePublic members
campaignId:stringcode:stringactive:booleanusageLimit:number | nullperCustomerLimit:number | nullstartsAt:DateTime<boolean> | nullendsAt:DateTime<boolean> | null
PromotionKind
Type
PromotionKindPromotionMatchType
Type
PromotionMatchTypePromotionRedemption
Class
PromotionRedemptionPublic members
campaignId:stringcodeId:string | nullcartId:stringorderId:string | nullcustomerId:string | nullstate:RedemptionStateamount:MoneyamountAmount:bigintamountCurrency:stringexpiresAt:DateTime<boolean> | nullredeemedAt:DateTime<boolean> | nullreleasedAt:DateTime<boolean> | null
PromotionRule
Class
PromotionRulePublic members
campaignId:stringtype:PromotionRuleTypeconfiguration:Record<string, unknown>position:number
PromotionRuleType
Type
PromotionRuleTypeRedemptionState
Type
RedemptionState@adocommercekit/promotions/services
CreateCampaignInput
Interface
CreateCampaignInputPublic members
code:stringname:stringdescription:string | undefinedstatus:CampaignStatus | undefinedkind:PromotionKindvalue:string | number | bigintcurrency:string | undefinedstartsAt:DateTime<boolean> | undefinedendsAt:DateTime<boolean> | undefinedpriority:number | undefinedstackable:boolean | undefinedautomatic:boolean | undefinedusageLimit:number | undefinedperCustomerLimit:number | undefinedmatchType:PromotionMatchType | undefinedmetadata:Record<string, unknown> | undefined
CreatePromotionCodeInput
Interface
CreatePromotionCodeInputPublic members
code:stringusageLimit:number | undefinedperCustomerLimit:number | undefinedstartsAt:DateTime<boolean> | undefinedendsAt:DateTime<boolean> | undefinedmetadata:Record<string, unknown> | undefined
PromotionCartProcessor
Class
PromotionCartProcessorPublic members
name:stringposition:numbershippingOnly:booleanregistry:ModelRegistrytablePrefix:stringconfig:ResolvedPromotionsConfigclock:() => DateTimeprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:(cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>evaluateRules:(campaign: PromotionCampaign, cart: Cart, ctx: RecalculationContext) => Promise<Set<string>>claim:(candidate: Candidate, cart: Cart, trx: TransactionClientContract, now: DateTime) => Promise<"inactive" | "expired" | "exhausted" | null>withinLimits:(campaign: PromotionCampaign, code: PromotionCode | null, customerId: string | null, trx: TransactionClientContract, now: DateTime, excludeId?: string) => Promise<boolean>discountAmounts:(campaign: PromotionCampaign, cart: Cart, lines: CartLine[], running: Map<string, bigint>) => bigint[]withinWindow:(value: { startsAt: DateTime | null; endsAt: DateTime | null; }, now: DateTime) => booleancartCodes:(cart: Cart) => string[]
PromotionFeedback
Interface
PromotionFeedbackPublic members
code:stringstatus:"expired" | "applied" | "ineligible" | "exhausted"reason:"expired" | "ineligible" | "exhausted" | "inactive" | undefined
PromotionService
Class
PromotionServicePublic members
db:Databaseregistry:ModelRegistrycarts:CartServiceconfig:ResolvedPromotionsConfigclock:() => DateTimelistCampaigns:() => Promise<PromotionCampaign[]>findCampaign:(id: string) => Promise<PromotionCampaign | null>listCodes:(campaignId: string) => Promise<PromotionCode[]>expirePendingRedemptions:(options?: MutationOptions) => Promise<void>releaseOrder:(orderId: string, options?: MutationOptions) => Promise<void>createCampaign:(input: CreateCampaignInput, options?: MutationOptions) => Promise<PromotionCampaign>updateCampaign:(id: string, input: UpdateCampaignInput, options?: MutationOptions) => Promise<PromotionCampaign>endCampaign:(id: string, options?: MutationOptions) => Promise<PromotionCampaign>addRule:(campaignId: string, input: { type: PromotionRuleType; configuration: Record<string, unknown>; position?: number; metadata?: Record<string, unknown>; }, options?: MutationOptions) => Promise<PromotionRule>removeRule:(campaignId: string, ruleId: string, options?: MutationOptions) => Promise<void>createCode:(campaignId: string, input: CreatePromotionCodeInput, options?: MutationOptions) => Promise<PromotionCode>revokeCode:(codeId: string, options?: MutationOptions) => Promise<PromotionCode>applyCoupon:(cart: Cart, rawCode: string, options?: MutationOptions) => Promise<Cart>removeCoupon:(cart: Cart, rawCode: string, options?: MutationOptions) => Promise<Cart>validateCampaign:(input: Pick<CreateCampaignInput, "code" | "name" | "kind" | "value" | "currency" | "startsAt" | "endsAt" | "status" | "matchType">) => voidvalidateRule:(type: PromotionRuleType, configuration: Record<string, unknown>) => voidwithinWindow:(value: { startsAt: DateTime | null; endsAt: DateTime | null; }, now: DateTime) => booleancartCodes:(cart: Cart) => string[]inTransaction:<T>(options: MutationOptions | undefined, callback: (trx: TransactionClientContract) => Promise<T>) => Promise<T>
PromotionShippingProcessor
Class
PromotionShippingProcessorPublic members
name:"promotion_shipping"position:600shippingOnly:trueregistry:ModelRegistrytablePrefix:stringconfig:ResolvedPromotionsConfigclock:() => DateTimeprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:(cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>evaluateRules:(campaign: PromotionCampaign, cart: Cart, ctx: RecalculationContext) => Promise<Set<string>>claim:(candidate: Candidate, cart: Cart, trx: TransactionClientContract, now: DateTime) => Promise<"inactive" | "expired" | "exhausted" | null>withinLimits:(campaign: PromotionCampaign, code: PromotionCode | null, customerId: string | null, trx: TransactionClientContract, now: DateTime, excludeId?: string) => Promise<boolean>discountAmounts:(campaign: PromotionCampaign, cart: Cart, lines: CartLine[], running: Map<string, bigint>) => bigint[]withinWindow:(value: { startsAt: DateTime | null; endsAt: DateTime | null; }, now: DateTime) => booleancartCodes:(cart: Cart) => string[]
UpdateCampaignInput
Type
UpdateCampaignInput@adocommercekit/promotions/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/promotions/upgrade
loadPromotionsUpgradeArtifacts
Function
(root?: string) => Promise<UpgradeArtifact[]>promotionsAdminPanelExtensionFiles
Value
AdminPanelExtensionFile[]promotionsPanelArtifacts
Value
readonly [{ readonly marker: "promotions:controllers/panel-promotions"; readonly destination: "app/controllers/commerce_admin_panel/promotions_controller.ts"; readonly stub: "controllers/panel_promotions_controller.stub"; }, { readonly marker: "promotions:routes/panel-promotions"; readonly destination: "start/routes/commerce_admin_panel_promotions.ts"; readonly stub: "routes/panel_promotions.stub"; }]promotionsUpgradeManifest
Value
{ readonly packageName: "@adocommercekit/promotions"; readonly version: string; readonly artifacts: readonly [{ readonly marker: "promotions:config/promotions"; readonly destination: "config/commerce_promotions.ts"; readonly stub: "config/promotions.stub"; }, { readonly marker: "promotions:validators/promotions"; readonly destination: "app/validators/commerce_promotions.ts"; readonly stub: "validators/promotions.stub"; }, { readonly marker: "promotions:controllers/promotions"; readonly destination: "app/controllers/commerce/promotions_controller.ts"; readonly stub: "controllers/promotions_controller.stub"; }, { readonly marker: "promotions:controllers/admin-promotions"; readonly destination: "app/controllers/commerce_admin/promotions_controller.ts"; readonly stub: "controllers/admin_promotions_controller.stub"; }, { readonly marker: "promotions:routes/promotions"; readonly destination: "start/routes/commerce_promotions.ts"; readonly stub: "routes/promotions.stub"; }, { readonly marker: "promotions:routes/admin-promotions"; readonly destination: "start/routes/commerce_admin_promotions.ts"; readonly stub: "routes/admin_promotions.stub"; }]; }@adocommercekit/promotions/promotions_provider
default
Class
PromotionsProviderPublic members
app:ApplicationServiceregister:() => voidboot:() => Promise<void>start:() => Promise<void>
@adocommercekit/rajaongkir
configure
Function
(command: Configure) => Promise<void>enMessages
Value
Record<"rajaongkir.quote.unavailable" | "rajaongkir.fulfillment.unsupported", string>idIDMessages
Value
{ readonly "rajaongkir.quote.unavailable": "Tarif RajaOngkir tidak tersedia"; readonly "rajaongkir.fulfillment.unsupported": "Pembuatan resi tidak didukung oleh integrasi ini"; }KOMERCE_RAJAONGKIR_API_VERSION
Value
"v1"KOMERCE_RAJAONGKIR_BASE_URL
Value
"https://rajaongkir.komerce.id/api/v1"rajaOngkir
Function
(options: RajaOngkirOptions) => () => Promise<RajaOngkirProvider>RajaOngkirOptions
Interface
RajaOngkirOptionsPublic members
apiKey:stringoriginId:stringcouriers:string[]baseUrl:string | undefinedquoteTtlSeconds:number | undefinedtimeoutMs:number | undefinedresolveDestination:((address: AddressInput) => Promise<string>) | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
RajaOngkirProvider
Class
RajaOngkirProviderPublic members
code:"rajaongkir"#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }#baseUrl:stringoptions:RajaOngkirOptionscapabilities:() => { readonly rates: true; readonly tracking: true; readonly waybill: false; readonly fulfillment: false; readonly cod: false; readonly insurance: false; }quote:(input: ShippingQuoteRequest) => Promise<ShippingQuoteDraft[]>track:(waybill: string, courier: string) => Promise<{ status: FulfillmentStatus; occurredAt?: DateTime; raw: unknown; }>#destination:(address: AddressInput | null) => Promise<string>#request:(path: string, body?: URLSearchParams) => Promise<Record<string, any>>
RajaOngkirRequestError
Class
RajaOngkirRequestErrorPublic members
code:"RAJAONGKIR_REQUEST_FAILED"status:number | undefinedname:stringmessage:stringstack:string | undefinedcause:unknown
@adocommercekit/rajaongkir/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/store-credit
defineGiftCardsConfig
Function
(config?: GiftCardsConfig) => ResolvedGiftCardsConfigGiftCard
Class
GiftCardPublic members
codeHash:stringlast4:stringcurrency:stringinitialAmount:bigintbalanceAmount:bigintstate:GiftCardStateexpiresAt:DateTime<boolean> | nullcustomerId:string | null
GiftCardBalance
Interface
GiftCardBalancePublic members
available:booleancurrency:string | nullbalanceAmount:string | null
GiftCardCartProcessor
Class
GiftCardCartProcessorPublic members
name:"gift_cards"position:1100service:GiftCardServiceprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:(cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>
GiftCardException
Class
GiftCardExceptionGiftCardLedgerView
Interface
GiftCardLedgerViewPublic members
id:stringgiftCardId:stringorderId:string | nullkind:GiftCardTransactionKindamount:stringreference:stringcreatedAt:string
GiftCardPage
Interface
GiftCardPage<T>Public members
items:T[]nextCursor:string | nulltotal:null
GiftCardsConfig
Interface
GiftCardsConfigPublic members
clock:(() => DateTime) | undefined
GiftCardService
Class
GiftCardServicePublic members
db:Databaseconfig:ResolvedGiftCardsConfigtable:(name: string) => anyclient:(trx?: TransactionClientContract) => Knex<any, any>mutation:<T>(options: MutationOptions | undefined, run: (trx: TransactionClientContract) => Promise<T>) => Promise<T>usable:(card: CardRow, currency?: string, customerId?: string | null) => voidledger:(trx: TransactionClientContract, cardId: string, kind: GiftCardTransactionKind, amount: bigint, reference: string, orderId?: string | null) => Promise<void>issue:(input: IssueGiftCardInput, options?: MutationOptions) => Promise<{ card: GiftCardView; code: string; }>balance:(code: string, customerId?: string | null) => Promise<GiftCardBalance>apply:(cart: Cart, code: string, options?: MutationOptions) => Promise<void>remove:(cart: Cart, options?: MutationOptions) => Promise<void>adjustment:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>holdOrder:(orderId: string, customerId: string | null, currency: string, options?: MutationOptions) => Promise<void>captureOrder:(orderId: string, options?: MutationOptions) => Promise<void>releaseOrder:(orderId: string, options?: MutationOptions) => Promise<void>settleOrder:(orderId: string, release: boolean, options?: MutationOptions) => Promise<void>credit:(trx: TransactionClientContract, card: CardRow, amount: bigint) => Promise<void>refundOrder:(orderId: string, refundId: string, amount: Money, options?: MutationOptions) => Promise<void>disable:(id: string, options?: MutationOptions) => Promise<GiftCardView>adjust:(id: string, delta: Money, reference: string, options?: MutationOptions) => Promise<GiftCardView>list:(filters?: { cursor?: string; limit?: number; state?: GiftCardState; }) => Promise<GiftCardPage<GiftCardView>>ledgerPage:(id: string, filters?: { cursor?: string; limit?: number; }) => Promise<GiftCardPage<GiftCardLedgerView>>refundPayment:(paymentId: string, refundId: string, amount: Money) => Promise<void>
GiftCardState
Type
GiftCardStateGiftCardTransaction
Class
GiftCardTransactionPublic members
giftCardId:stringorderId:string | nullkind:GiftCardTransactionKindamount:bigintreference:string
GiftCardTransactionKind
Type
GiftCardTransactionKindGiftCardView
Interface
GiftCardViewPublic members
id:stringlast4:stringcurrency:stringinitialAmount:stringbalanceAmount:stringstate:GiftCardStateexpiresAt:string | nullcustomerId:string | null
IssueGiftCardInput
Interface
IssueGiftCardInputPublic members
amount:MoneycustomerId:string | null | undefinedexpiresAt:DateTime<boolean> | null | undefined
ResolvedGiftCardsConfig
Interface
ResolvedGiftCardsConfigPublic members
clock:() => DateTime
@adocommercekit/store-credit/models
GiftCard
Class
GiftCardPublic members
codeHash:stringlast4:stringcurrency:stringinitialAmount:bigintbalanceAmount:bigintstate:GiftCardStateexpiresAt:DateTime<boolean> | nullcustomerId:string | null
GiftCardState
Type
GiftCardStateGiftCardTransaction
Class
GiftCardTransactionPublic members
giftCardId:stringorderId:string | nullkind:GiftCardTransactionKindamount:bigintreference:string
GiftCardTransactionKind
Type
GiftCardTransactionKind@adocommercekit/store-credit/services
GiftCardBalance
Interface
GiftCardBalancePublic members
available:booleancurrency:string | nullbalanceAmount:string | null
GiftCardCartProcessor
Class
GiftCardCartProcessorPublic members
name:"gift_cards"position:1100service:GiftCardServiceprocess:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>checkoutCompleted:(cart: Cart, order: Order, trx: TransactionClientContract) => Promise<void>
GiftCardLedgerView
Interface
GiftCardLedgerViewPublic members
id:stringgiftCardId:stringorderId:string | nullkind:GiftCardTransactionKindamount:stringreference:stringcreatedAt:string
GiftCardPage
Interface
GiftCardPage<T>Public members
items:T[]nextCursor:string | nulltotal:null
GiftCardService
Class
GiftCardServicePublic members
db:Databaseconfig:ResolvedGiftCardsConfigtable:(name: string) => anyclient:(trx?: TransactionClientContract) => Knex<any, any>mutation:<T>(options: MutationOptions | undefined, run: (trx: TransactionClientContract) => Promise<T>) => Promise<T>usable:(card: CardRow, currency?: string, customerId?: string | null) => voidledger:(trx: TransactionClientContract, cardId: string, kind: GiftCardTransactionKind, amount: bigint, reference: string, orderId?: string | null) => Promise<void>issue:(input: IssueGiftCardInput, options?: MutationOptions) => Promise<{ card: GiftCardView; code: string; }>balance:(code: string, customerId?: string | null) => Promise<GiftCardBalance>apply:(cart: Cart, code: string, options?: MutationOptions) => Promise<void>remove:(cart: Cart, options?: MutationOptions) => Promise<void>adjustment:(cart: Cart, ctx: RecalculationContext) => Promise<AdjustmentDraft[]>holdOrder:(orderId: string, customerId: string | null, currency: string, options?: MutationOptions) => Promise<void>captureOrder:(orderId: string, options?: MutationOptions) => Promise<void>releaseOrder:(orderId: string, options?: MutationOptions) => Promise<void>settleOrder:(orderId: string, release: boolean, options?: MutationOptions) => Promise<void>credit:(trx: TransactionClientContract, card: CardRow, amount: bigint) => Promise<void>refundOrder:(orderId: string, refundId: string, amount: Money, options?: MutationOptions) => Promise<void>disable:(id: string, options?: MutationOptions) => Promise<GiftCardView>adjust:(id: string, delta: Money, reference: string, options?: MutationOptions) => Promise<GiftCardView>list:(filters?: { cursor?: string; limit?: number; state?: GiftCardState; }) => Promise<GiftCardPage<GiftCardView>>ledgerPage:(id: string, filters?: { cursor?: string; limit?: number; }) => Promise<GiftCardPage<GiftCardLedgerView>>refundPayment:(paymentId: string, refundId: string, amount: Money) => Promise<void>
GiftCardView
Interface
GiftCardViewPublic members
id:stringlast4:stringcurrency:stringinitialAmount:stringbalanceAmount:stringstate:GiftCardStateexpiresAt:string | nullcustomerId:string | null
IssueGiftCardInput
Interface
IssueGiftCardInputPublic members
amount:MoneycustomerId:string | null | undefinedexpiresAt:DateTime<boolean> | null | undefined
@adocommercekit/store-credit/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/store-credit/gift_cards_provider
default
Class
GiftCardsProviderPublic members
app:ApplicationServiceregister:() => voidboot:() => Promise<void>
@adocommercekit/store-credit/upgrade
giftCardsUpgradeManifest
Value
{ packageName: string; version: string; artifacts: { marker: string; destination: string; stub: string; }[]; }loadGiftCardsUpgradeArtifacts
Function
(root?: string) => Promise<UpgradeArtifact[]>@adocommercekit/storefront-api
configure
Function
(command: Configure) => Promise<void>FixedWindowRateLimiter
Class
FixedWindowRateLimiterPublic members
store:RateLimitStoreconsume:(key: string, limit: number, windowSeconds: number, now?: number) => Promise<RateLimitResult>
MemoryRateLimitStore
Class
MemoryRateLimitStorePublic members
#buckets:Map<string, RateLimitBucket>maxKeys:numberconsume:(key: string, limit: number, windowSeconds: number, now?: number) => RateLimitResult
RateLimitResult
Interface
RateLimitResultPublic members
allowed:booleanlimit:numberremaining:numberresetAt:numberretryAfter:number
RateLimitStore
Interface
RateLimitStorePublic members
consume:(key: string, limit: number, windowSeconds: number, now?: number) => RateLimitResult | Promise<RateLimitResult>
RedisRateLimitClient
Interface
An adapter for Redis clients exposing the standard EVAL command arguments.
RedisRateLimitClientPublic members
eval:(script: string, numberOfKeys: number, ...args: Array<string | number>) => Promise<unknown>
RedisRateLimitStore
Class
RedisRateLimitStorePublic members
client:RedisRateLimitClientprefix:stringconsume:(key: string, limit: number, windowSeconds: number, now?: number) => Promise<RateLimitResult>
STOREFRONT_API_PREFIX
Value
"/api/commerce"STOREFRONT_RATE_LIMIT_STORE
Value
Container binding for a shared storefront rate-limit store.
"commerce.storefront.rateLimitStore"StorefrontEndpoint
Type
{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.products.index"; } | { readonly method: "GET"; readonly path: "/products/:slug"; readonly name: "commerce.products.show"; } | { readonly method: "GET"; readonly path: "/customer"; readonly name: "commerce.customer.show"; } | { readonly method: "PATCH"; readonly path: "/customer"; readonly name: "commerce.customer.update"; } | { readonly method: "GET"; readonly path: "/customer/export"; readonly name: "commerce.customer.export"; } | { readonly method: "POST"; readonly path: "/customer/addresses"; readonly name: "commerce.customer.addresses.store"; } | { readonly method: "PATCH"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.update"; } | { readonly method: "DELETE"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.destroy"; } | { readonly method: "GET"; readonly path: "/cart"; readonly name: "commerce.cart.show"; } | { readonly method: "POST"; readonly path: "/cart/lines"; readonly name: "commerce.cart.lines.store"; } | { readonly method: "PATCH"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.update"; } | { readonly method: "DELETE"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.destroy"; } | { readonly method: "PUT"; readonly path: "/cart/email"; readonly name: "commerce.cart.email"; } | { readonly method: "PUT"; readonly path: "/cart/addresses"; readonly name: "commerce.cart.addresses"; } | { readonly method: "GET"; readonly path: "/cart/shipping-methods"; readonly name: "commerce.cart.shippingMethods"; } | { readonly method: "PUT"; readonly path: "/cart/shipping-method"; readonly name: "commerce.cart.shippingMethod"; } | { readonly method: "POST"; readonly path: "/cart…storefrontEndpoints
Value
readonly [{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.products.index"; }, { readonly method: "GET"; readonly path: "/products/:slug"; readonly name: "commerce.products.show"; }, { readonly method: "GET"; readonly path: "/customer"; readonly name: "commerce.customer.show"; }, { readonly method: "PATCH"; readonly path: "/customer"; readonly name: "commerce.customer.update"; }, { readonly method: "GET"; readonly path: "/customer/export"; readonly name: "commerce.customer.export"; }, { readonly method: "POST"; readonly path: "/customer/addresses"; readonly name: "commerce.customer.addresses.store"; }, { readonly method: "PATCH"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.update"; }, { readonly method: "DELETE"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.destroy"; }, { readonly method: "GET"; readonly path: "/cart"; readonly name: "commerce.cart.show"; }, { readonly method: "POST"; readonly path: "/cart/lines"; readonly name: "commerce.cart.lines.store"; }, { readonly method: "PATCH"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.update"; }, { readonly method: "DELETE"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.destroy"; }, { readonly method: "PUT"; readonly path: "/cart/email"; readonly name: "commerce.cart.email"; }, { readonly method: "PUT"; readonly path: "/cart/addresses"; readonly name: "commerce.cart.addresses"; }, { readonly method: "GET"; readonly path: "/cart/shipping-methods"; readonly name: "commerce.cart.shippingMethods"; }, { readonly method: "PUT"; readonly path: "/cart/shipping-method"; readonly name: "commerce.cart.shippingMethod"; }, { readonly method: "POST"; readonly path: "/cart/shipp…storefrontOpenApi
Value
{ readonly openapi: "3.1.0"; readonly info: { readonly title: "Adocommerce Kit Storefront API"; readonly version: "1.0.0"; readonly description: "Versioned wire contract for the host-published storefront API."; }; readonly servers: readonly [{ readonly url: "/api/commerce"; }]; readonly paths: Record<string, Record<string, unknown>>; readonly components: { readonly securitySchemes: { readonly session: { readonly type: "apiKey"; readonly in: "cookie"; readonly name: "session"; }; }; readonly schemas: { readonly CommerceError: { readonly type: "object"; readonly required: readonly ["error"]; readonly properties: { readonly error: { readonly type: "object"; readonly required: readonly ["code", "message"]; readonly properties: { readonly code: { readonly type: "string"; }; readonly message: { readonly type: "string"; }; readonly details: {}; readonly requestId: { readonly type: "string"; }; }; }; }; }; }; readonly responses: { readonly CommerceError: { readonly description: "Commerce error envelope"; readonly content: { readonly 'application/json': { readonly schema: { readonly $ref: "#/components/schemas/CommerceError"; }; }; }; }; }; }; }@adocommercekit/storefront-api/configure
configure
Function
(command: Configure) => Promise<void>publishedStubs
Value
readonly ["helpers/commerce_api.stub", "validators/commerce.stub", "middleware/commerce_errors_middleware.stub", "middleware/commerce_rate_limit_middleware.stub", "middleware/commerce_raw_body_middleware.stub", "controllers/customers_controller.stub", "controllers/products_controller.stub", "controllers/carts_controller.stub", "controllers/cart_lines_controller.stub", "controllers/checkout_controller.stub", "controllers/orders_controller.stub", "controllers/returns_controller.stub", "controllers/payment_webhooks_controller.stub", "routes/commerce.stub"]@adocommercekit/storefront-api/contract
STOREFRONT_API_PREFIX
Value
"/api/commerce"StorefrontEndpoint
Type
{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.products.index"; } | { readonly method: "GET"; readonly path: "/products/:slug"; readonly name: "commerce.products.show"; } | { readonly method: "GET"; readonly path: "/customer"; readonly name: "commerce.customer.show"; } | { readonly method: "PATCH"; readonly path: "/customer"; readonly name: "commerce.customer.update"; } | { readonly method: "GET"; readonly path: "/customer/export"; readonly name: "commerce.customer.export"; } | { readonly method: "POST"; readonly path: "/customer/addresses"; readonly name: "commerce.customer.addresses.store"; } | { readonly method: "PATCH"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.update"; } | { readonly method: "DELETE"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.destroy"; } | { readonly method: "GET"; readonly path: "/cart"; readonly name: "commerce.cart.show"; } | { readonly method: "POST"; readonly path: "/cart/lines"; readonly name: "commerce.cart.lines.store"; } | { readonly method: "PATCH"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.update"; } | { readonly method: "DELETE"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.destroy"; } | { readonly method: "PUT"; readonly path: "/cart/email"; readonly name: "commerce.cart.email"; } | { readonly method: "PUT"; readonly path: "/cart/addresses"; readonly name: "commerce.cart.addresses"; } | { readonly method: "GET"; readonly path: "/cart/shipping-methods"; readonly name: "commerce.cart.shippingMethods"; } | { readonly method: "PUT"; readonly path: "/cart/shipping-method"; readonly name: "commerce.cart.shippingMethod"; } | { readonly method: "POST"; readonly path: "/cart…storefrontEndpoints
Value
readonly [{ readonly method: "GET"; readonly path: "/products"; readonly name: "commerce.products.index"; }, { readonly method: "GET"; readonly path: "/products/:slug"; readonly name: "commerce.products.show"; }, { readonly method: "GET"; readonly path: "/customer"; readonly name: "commerce.customer.show"; }, { readonly method: "PATCH"; readonly path: "/customer"; readonly name: "commerce.customer.update"; }, { readonly method: "GET"; readonly path: "/customer/export"; readonly name: "commerce.customer.export"; }, { readonly method: "POST"; readonly path: "/customer/addresses"; readonly name: "commerce.customer.addresses.store"; }, { readonly method: "PATCH"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.update"; }, { readonly method: "DELETE"; readonly path: "/customer/addresses/:id"; readonly name: "commerce.customer.addresses.destroy"; }, { readonly method: "GET"; readonly path: "/cart"; readonly name: "commerce.cart.show"; }, { readonly method: "POST"; readonly path: "/cart/lines"; readonly name: "commerce.cart.lines.store"; }, { readonly method: "PATCH"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.update"; }, { readonly method: "DELETE"; readonly path: "/cart/lines/:id"; readonly name: "commerce.cart.lines.destroy"; }, { readonly method: "PUT"; readonly path: "/cart/email"; readonly name: "commerce.cart.email"; }, { readonly method: "PUT"; readonly path: "/cart/addresses"; readonly name: "commerce.cart.addresses"; }, { readonly method: "GET"; readonly path: "/cart/shipping-methods"; readonly name: "commerce.cart.shippingMethods"; }, { readonly method: "PUT"; readonly path: "/cart/shipping-method"; readonly name: "commerce.cart.shippingMethod"; }, { readonly method: "POST"; readonly path: "/cart/shipp…@adocommercekit/storefront-api/upgrade
loadStorefrontUpgradeArtifacts
Function
() => Promise<{ marker: string; destination: string; source: string; }[]>StorefrontUpgradeArtifactDefinition
Interface
StorefrontUpgradeArtifactDefinitionPublic members
marker:stringdestination:stringstub:string
storefrontUpgradeManifest
Value
{ readonly packageName: "@adocommercekit/storefront-api"; readonly version: string; readonly artifacts: { marker: string; destination: string; stub: string; }[]; }@adocommercekit/stripe
stripe
Function
(options: StripeOptions) => DriverFactory<PaymentProvider>stripeAmountScale
Function
Stripe API units per configured core minor unit.
(currency: string) => numberstripeCurrencyExponent
Function
(currency: string) => numberStripeOptions
Interface
StripeOptionsPublic members
apiKey:stringwebhookSecret:stringapiBase:string | undefinedwebhookToleranceSeconds:number | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
StripePaymentProvider
Class
StripePaymentProviderPublic members
code:"stripe"#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }options:StripeOptionssupportsCurrencyScaling:(_currency: string) => booleancapabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; vaulting: boolean; recurring: boolean; }createIntent:(input: Parameters<PaymentProvider["createIntent"]>[0]) => Promise<{ state: "authorized" | "created" | "requires_action"; clientSecret?: string | undefined; providerIntentId: string; }>confirm:(input: Parameters<PaymentProvider["confirm"]>[0]) => Promise<ProviderPaymentState>capture:(input: Parameters<PaymentProvider["capture"]>[0]) => Promise<{ raw: StripeObject; providerCaptureId?: string | undefined; providerChargeId: string; }>refund:(input: Parameters<PaymentProvider["refund"]>[0]) => Promise<{ providerRefundId: string; state: "succeeded" | "failed" | "pending"; raw: StripeObject; }>retrieveRefund:(input: Parameters<NonNullable<PaymentProvider["retrieveRefund"]>>[0]) => Promise<{ raw: StripeObject; amount?: any; providerRefundId: string; state: "succeeded" | "failed" | "pending"; } | null>void:(input: Parameters<PaymentProvider["void"]>[0]) => Promise<void>createCustomer:(input: Parameters<NonNullable<PaymentProvider["createCustomer"]>>[0]) => Promise<{ providerCustomerId: string; raw: StripeObject; }>setupPaymentMethod:(input: Parameters<NonNullable<PaymentProvider["setupPaymentMethod"]>>[0]) => Promise<{ raw: StripeObject; type: string; label: string; lastFour?: string; expiryMonth?: number; expiryYear?: number; providerPaymentMethodId: string; requiresAction: false; } | { raw: StripeObject; clientSecret?: string | undefined; requiresAction: true; }>chargeOffSession:(input: Parameters<NonNullable<PaymentProvider["chargeOffSession"]>>[0]) => Promise<{ raw: StripeObject; clientSecret?: string | undefined; state: "captured" | "authorized" | "failed" | "requires_action" | "pending"; providerChargeId?: string | undefined; providerIntentId: string; }>verifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>request:(method: string, path: string, body: Record<string, string>, idempotencyKey?: string) => Promise<StripeObject>refundState:(refund: StripeObject) => "pending" | "succeeded" | "failed"refundIdempotencyKey:(refund: StripeObject) => string | undefinedintentState:(intent: StripeObject) => "created" | "requires_action" | "authorized"normalizeDecline:(code: unknown) => PaymentDeclineCodefirstCharge:(intent: StripeObject) => StripeObject | undefinedpaymentMethodDetails:(method: StripeObject) => { type: string; label: string; lastFour?: string; expiryMonth?: number; expiryYear?: number; }eventMoney:(object: StripeObject, amountField: string) => Money | undefined
@adocommercekit/stripe/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/whatsapp
CommerceWhatsAppConfig
Interface
CommerceWhatsAppConfigPublic members
enabled:booleancloud:WhatsAppCloudOptionsnoticeVersion:stringmaxAttempts:numberappSecret:stringverifyToken:stringretryDelayMs:numberresolver:WhatsAppMessageResolverfallback:WhatsAppFallbackNotifier | undefinedlogger:WhatsAppLogger | undefined
configure
Function
(command: Configure) => Promise<void>defineWhatsAppConfig
Function
(input?: Partial<Omit<CommerceWhatsAppConfig, "cloud" | "resolver">> & { cloud?: Partial<WhatsAppCloudOptions>; resolver?: WhatsAppMessageResolver; }) => CommerceWhatsAppConfigenMessages
Value
Record<"whatsapp.order.placed" | "whatsapp.payment.captured" | "whatsapp.payment.expired" | "whatsapp.shipment.shipped" | "whatsapp.shipment.delivered" | "whatsapp.shipment.returned", string>idIDMessages
Value
{ readonly "whatsapp.order.placed": "Pesanan Anda telah dibuat"; readonly "whatsapp.payment.captured": "Pembayaran Anda telah diterima"; readonly "whatsapp.payment.expired": "Instruksi pembayaran telah kedaluwarsa"; readonly "whatsapp.shipment.shipped": "Pesanan Anda sedang dikirim"; readonly "whatsapp.shipment.delivered": "Pesanan Anda telah diterima"; readonly "whatsapp.shipment.returned": "Pesanan Anda dikembalikan"; }ingestWhatsAppWebhook
Function
(rawBody: Buffer, signature: string | null | undefined, appSecret: string, inbox: ExternalEventInboxService, handler: Parameters<ExternalEventInboxService["process"]>[1]) => Promise<{ accepted: number; duplicates: number; }>isRetryableWhatsAppError
Function
(error: unknown) => booleannormalizeWhatsAppWebhook
Function
(rawBody: Buffer) => WhatsAppWebhookEvent[]verifyWhatsAppHandshake
Function
(mode: unknown, token: unknown, challenge: unknown, verifyToken: string) => string | nullverifyWhatsAppWebhook
Function
(rawBody: Buffer, signature: string | null | undefined, appSecret: string) => booleanWHATSAPP_COMMERCE_EVENTS
Value
ReadonlySet<string>WHATSAPP_JOB
Value
"commerce.whatsapp.send-template.v1"WHATSAPP_PURPOSE
Value
"order_updates_whatsapp"WhatsAppCloudApiError
Class
WhatsAppCloudApiErrorPublic members
code:stringproviderCode:number | undefinedstatus:number | undefinedname:stringmessage:stringstack:string | undefinedcause:unknown
WhatsAppCloudClient
Class
WhatsAppCloudClientPublic members
#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }#baseUrl:stringoptions:WhatsAppCloudOptionssendTemplate:(message: WhatsAppTemplateMessage) => Promise<string>
WhatsAppCloudOptions
Interface
WhatsAppCloudOptionsPublic members
accessToken:stringphoneNumberId:stringapiVersion:stringbaseUrl:string | undefinedtimeoutMs:number | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
WhatsAppFallbackNotifier
Interface
WhatsAppFallbackNotifierPublic members
notify:(input: { event: string; customerId: string; reference: string; reason: string; }) => Promise<void>
WhatsAppLogger
Interface
WhatsAppLoggerPublic members
info:(message: string, context: Readonly<Record<string, unknown>>) => voiderror:(message: string, context: Readonly<Record<string, unknown>>) => void
WhatsAppMessageResolver
Interface
WhatsAppMessageResolverPublic members
resolve:(event: string, payload: unknown) => Promise<WhatsAppTemplateMessage | null>
WhatsAppNotificationOptions
Interface
WhatsAppNotificationOptionsPublic members
noticeVersion:stringmaxAttempts:number | undefinedfallback:WhatsAppFallbackNotifier | undefinedlogger:WhatsAppLogger | undefinedsendLog:WhatsAppSendLogretryDelayMs:number | undefined
WhatsAppNotificationService
Class
WhatsAppNotificationServicePublic members
client:WhatsAppCloudClientdispatcher:JobDispatcherconsents:ConsentReceiptServiceresolver:WhatsAppMessageResolveroptions:WhatsAppNotificationOptionsonEvent:(event: string, payload: unknown) => Promise<"queued" | "suppressed" | "ignored">handle:(payload: JobPayload) => Promise<void>#hasConsent:(customerId: string) => Promise<boolean>
WhatsAppSendAttempt
Interface
WhatsAppSendAttemptPublic members
reference:stringevent:stringattempt:number
WhatsAppSendLog
Interface
WhatsAppSendLogPublic members
queued:(input: WhatsAppSendAttempt) => Promise<void>sent:(input: WhatsAppSendAttempt, messageId: string) => Promise<void>failed:(input: WhatsAppSendAttempt, errorCode: string) => Promise<void>applyStatus:(event: ExternalEventInput, trx: TransactionClientContract) => Promise<void>
WhatsAppSendLogService
Class
WhatsAppSendLogServicePublic members
#table:stringdb:Databasequeued:(input: WhatsAppSendAttempt) => Promise<void>sent:(input: WhatsAppSendAttempt, messageId: string) => Promise<void>failed:(input: WhatsAppSendAttempt, errorCode: string) => Promise<void>#attempt:(input: WhatsAppSendAttempt) => DatabaseQueryBuilderContract<any>applyStatus:(event: ExternalEventInput, trx: TransactionClientContract) => Promise<void>
WhatsAppSendState
Type
WhatsAppSendStateWhatsAppTemplateDefinition
Interface
WhatsAppTemplateDefinitionPublic members
name:stringlanguage:string
WhatsAppTemplateMessage
Interface
WhatsAppTemplateMessagePublic members
customerId:stringto:stringtemplate:WhatsAppTemplateDefinitioncomponents:Record<string, unknown>[] | undefinedreference:string
WhatsAppTemplateNotApprovedError
Class
WhatsAppTemplateNotApprovedErrorPublic members
code:"WHATSAPP_TEMPLATE_NOT_APPROVED"providerCode:number | undefinedstatus:number | undefinedname:stringmessage:stringstack:string | undefinedcause:unknown
WhatsAppWebhookEvent
Interface
WhatsAppWebhookEventPublic members
id:stringtype:"message.received" | "message.status"payload:Record<string, unknown>
@adocommercekit/whatsapp/configure
configure
Function
(command: Configure) => Promise<void>@adocommercekit/whatsapp/whatsapp_provider
default
Class
WhatsAppProviderPublic members
#unsubscribe:Unsubscribe | undefinedapp:ApplicationServiceregister:() => voidboot:() => Promise<void>shutdown:() => Promise<void>#config:() => CommerceWhatsAppConfig
@adocommercekit/whatsapp/upgrade
loadWhatsAppUpgradeArtifacts
Function
(_root?: string) => Promise<Array<{ marker: string; destination: string; source: string; }>>whatsappUpgradeManifest
Value
{ readonly packageName: "@adocommercekit/whatsapp"; readonly version: string; readonly artifacts: readonly [{ readonly marker: "whatsapp:config/commerce_whatsapp"; readonly destination: "config/commerce_whatsapp.ts"; readonly stub: "config/commerce_whatsapp.stub"; }, { readonly marker: "whatsapp:controllers/whatsapp_webhooks"; readonly destination: "app/controllers/commerce/whatsapp_webhooks_controller.ts"; readonly stub: "controllers/whatsapp_webhooks_controller.stub"; }, { readonly marker: "whatsapp:routes/commerce_whatsapp"; readonly destination: "start/routes/commerce_whatsapp.ts"; readonly stub: "routes/commerce_whatsapp.stub"; }]; }@adocommercekit/xendit
configure
Function
(command: Configure) => Promise<void>xendit
Function
(options: XenditOptions) => DriverFactory<PaymentProvider>XENDIT_API_VERSION
Value
"2024-11-11"XENDIT_SOURCE_RECORD
Value
Readonly<{ retrievedAt: "2026-07-24"; paymentRequests: "https://docs.xendit.co/apidocs/create-payment-request"; status: "https://docs.xendit.co/apidocs/get-payment-request"; webhooks: "https://docs.xendit.co/apidocs/payment-webhook-notification"; authentication: "https://docs.xendit.co/apidocs/quick-setup"; }>XenditChannel
Type
XenditChannelXenditOptions
Interface
XenditOptionsPublic members
secretKey:stringwebhookToken:stringchannel:XenditChannelsuccessReturnUrl:string | undefinedfailureReturnUrl:string | undefinedexpiryMinutes:number | undefinedapiBase:string | undefinedfetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; } | undefined
XenditPaymentProvider
Class
XenditPaymentProviderPublic members
code:"xendit"#fetch:{ (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | URL | Request, init?: RequestInit): Promise<Response>; }options:XenditOptionscapabilities:() => { authorize: boolean; capture: boolean; refund: boolean; void: boolean; clientConfirmation: boolean; flow: "deferred"; }createIntent:(input: Parameters<PaymentProvider["createIntent"]>[0]) => Promise<{ providerIntentId: string; state: "pending"; instructions: PaymentInstructionDraft[]; expiresAt: DateTime<boolean>; raw: JsonObject; }>confirm:() => Promise<{ state: "pending"; }>capture:() => Promise<{ providerChargeId: string; }>refund:(input: Parameters<PaymentProvider["refund"]>[0]) => Promise<{ providerRefundId: string; state: "succeeded" | "failed" | "pending"; raw: JsonObject; }>retrieveRefund:(input: Parameters<NonNullable<PaymentProvider["retrieveRefund"]>>[0]) => Promise<{ raw: JsonObject; amount?: any; providerRefundId: any; state: "succeeded" | "failed" | "pending"; } | null>void:(input: Parameters<PaymentProvider["void"]>[0]) => Promise<void>retrieveIntent:(providerIntentId: string) => Promise<{ state: "settled"; amount: any; occurredAt: DateTime<boolean> | undefined; reference: string; raw: JsonObject; } | { state: "expired" | "failed" | "pending"; occurredAt: DateTime<boolean> | undefined; raw: JsonObject; amount?: undefined; reference?: undefined; }>healthCheck:() => Promise<void>verifyWebhook:(raw: RawWebhookRequest) => Promise<boolean>normalizeWebhook:(raw: RawWebhookRequest) => Promise<NormalizedPaymentEvent | { type: "unhandled"; providerEventId: string; raw?: unknown; }>instructions:(result: JsonObject, expiresAt: DateTime) => PaymentInstructionDraft[]deferredStatus:(status: string) => "pending" | "settled" | "expired" | "failed"paymentEventType:(status: string) => "payment.pending" | "payment.authorized" | "payment.captured" | "payment.expired" | "payment.failed" | undefinedassertIdr:(amount: Money) => voidrequest:(method: string, path: string, body?: JsonObject, idempotencyKey?: string) => Promise<JsonObject>rawRequest:(method: string, path: string, body?: JsonObject, idempotencyKey?: string) => Promise<Response>
@adocommercekit/xendit/configure
configure
Function
(command: Configure) => Promise<void>