@final-commerce/command-frame 0.3.2-preprod.1 → 0.4.0-preprod.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -29
- package/dist/actions/apply-transition/mock.d.ts +1 -1
- package/dist/actions/apply-transition/mock.js +8 -18
- package/dist/actions/apply-transition/types.d.ts +6 -4
- package/dist/actions/extension-payment/types.d.ts +2 -2
- package/dist/actions/get-available-transitions/mock.d.ts +5 -3
- package/dist/actions/get-available-transitions/mock.js +24 -12
- package/dist/actions/integration-payment/types.d.ts +2 -0
- package/dist/actions/partial-payment/types.d.ts +2 -2
- package/dist/actions/redeem-payment/types.d.ts +2 -0
- package/dist/actions/terminal-payment/types.d.ts +3 -3
- package/dist/demo/database.d.ts +2 -2
- package/dist/demo/database.js +271 -264
- package/dist/projects/render/mocks.js +2 -0
- package/dist/projects/render/types.d.ts +2 -1
- package/dist/pubsub/topics/orders/index.d.ts +2 -2
- package/dist/pubsub/topics/orders/index.js +27 -27
- package/dist/pubsub/topics/orders/types.d.ts +15 -15
- package/dist/pubsub/topics/orders/types.js +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -71,7 +71,7 @@ For building applications that run inside the Render Point of Sale interface.
|
|
|
71
71
|
- **Features:** Order management, Product catalog, Customer management, Payments, Hardware integration (Cash drawer, Printer), Custom tables, Secrets storage.
|
|
72
72
|
|
|
73
73
|
```typescript
|
|
74
|
-
import { RenderClient } from
|
|
74
|
+
import { RenderClient } from '@final-commerce/command-frame';
|
|
75
75
|
|
|
76
76
|
const client = new RenderClient();
|
|
77
77
|
const products = await client.getProducts();
|
|
@@ -85,7 +85,7 @@ For building applications that run inside the Final Commerce Management Dashboar
|
|
|
85
85
|
- **Features:** Context, catalog, entities, custom tables, secrets, and optional host-specific commands (navigation, media, tax, branding, notifications) when the dashboard implements them.
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
|
-
import { ManageClient } from
|
|
88
|
+
import { ManageClient } from '@final-commerce/command-frame';
|
|
89
89
|
|
|
90
90
|
const client = new ManageClient();
|
|
91
91
|
const context = await client.getContext();
|
|
@@ -99,14 +99,14 @@ The pub/sub system allows iframe extensions to subscribe to topics and receive r
|
|
|
99
99
|
- **Topics:** Cart (16), Customers (8), Orders (5), Payments (2), Products (4), Refunds (4), Print (3), Custom Tables (3), Outlet (2), Station (2), Session (2), Users (2).
|
|
100
100
|
|
|
101
101
|
```typescript
|
|
102
|
-
import { topics } from
|
|
102
|
+
import { topics } from '@final-commerce/command-frame';
|
|
103
103
|
|
|
104
|
-
const subscriptionId = topics.subscribe(
|
|
105
|
-
|
|
104
|
+
const subscriptionId = topics.subscribe('cart', (event) => {
|
|
105
|
+
console.log('Cart event:', event.type, event.data);
|
|
106
106
|
});
|
|
107
107
|
|
|
108
108
|
// Unsubscribe when done
|
|
109
|
-
topics.unsubscribe(
|
|
109
|
+
topics.unsubscribe('cart', subscriptionId);
|
|
110
110
|
```
|
|
111
111
|
|
|
112
112
|
## Hooks
|
|
@@ -118,21 +118,21 @@ Hooks are **session-scoped** event callbacks that run in the host (Render) conte
|
|
|
118
118
|
- A stable `hookId` is required for deduplication (safe on iframe reload).
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
|
-
import { hooks } from
|
|
121
|
+
import { hooks } from '@final-commerce/command-frame';
|
|
122
122
|
|
|
123
123
|
hooks.register(
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
124
|
+
'cart',
|
|
125
|
+
async (event, hostCommands) => {
|
|
126
|
+
await hostCommands.upsertCustomTableData({
|
|
127
|
+
tableName: 'cart-events-log',
|
|
128
|
+
data: { eventType: event.type, payload: event.data, timestamp: event.timestamp },
|
|
129
|
+
});
|
|
130
|
+
},
|
|
131
|
+
{ hookId: 'my-extension:cart-log' },
|
|
132
132
|
);
|
|
133
133
|
|
|
134
134
|
// Unregister when no longer needed
|
|
135
|
-
hooks.unregister(
|
|
135
|
+
hooks.unregister('my-extension:cart-log');
|
|
136
136
|
```
|
|
137
137
|
|
|
138
138
|
## Interceptors
|
|
@@ -147,14 +147,14 @@ Interceptors let an extension **gate a POS flow** (approve / modify / block) at
|
|
|
147
147
|
import { interceptors } from '@final-commerce/command-frame';
|
|
148
148
|
|
|
149
149
|
interceptors.register(
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
150
|
+
'refund_start',
|
|
151
|
+
async (payload, cmds) => {
|
|
152
|
+
if (payload.paymentTypes.includes('redeem')) {
|
|
153
|
+
return cmds.openExtensionOverlay({ point: 'refund_start', payload });
|
|
154
|
+
}
|
|
155
|
+
return true; // nothing for us to do
|
|
156
|
+
},
|
|
157
|
+
{ interceptorId: 'my-extension:refund-guard' },
|
|
158
158
|
);
|
|
159
159
|
```
|
|
160
160
|
|
|
@@ -171,13 +171,21 @@ interceptors.register(
|
|
|
171
171
|
Exported APIs: `installExtensionRefundListener`, `EXTENSION_REFUND_REQUEST_ACTION`, types **`ExtensionRefundParams`** / **`ExtensionRefundResponse`**.
|
|
172
172
|
|
|
173
173
|
```typescript
|
|
174
|
-
import {
|
|
175
|
-
|
|
176
|
-
|
|
174
|
+
import {
|
|
175
|
+
installExtensionRefundListener,
|
|
176
|
+
type ExtensionRefundParams,
|
|
177
|
+
type ExtensionRefundResponse,
|
|
178
|
+
} from '@final-commerce/command-frame';
|
|
179
|
+
|
|
180
|
+
const unsubscribe = installExtensionRefundListener(
|
|
181
|
+
async (params: ExtensionRefundParams): Promise<ExtensionRefundResponse> => {
|
|
177
182
|
// params.paymentType === "redeem", params.amount in major currency units, params.saleId, params.processor, etc.
|
|
178
183
|
const ok = await myGiftCardProvider.refund(params);
|
|
179
|
-
return ok
|
|
180
|
-
}
|
|
184
|
+
return ok
|
|
185
|
+
? { success: true, extensionTransactionId: ok.providerRefundId }
|
|
186
|
+
: { success: false, error: 'Refund declined' };
|
|
187
|
+
},
|
|
188
|
+
);
|
|
181
189
|
|
|
182
190
|
// on teardown (optional)
|
|
183
191
|
// unsubscribe();
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { ApplyTransitionParams, ApplyTransitionResponse } from "./types";
|
|
2
2
|
/**
|
|
3
|
-
* Mock implementation: applies all transitions except a
|
|
3
|
+
* Mock implementation: applies all transitions except a known-invalid one
|
|
4
4
|
* so the demo app can show both successful and blocked responses.
|
|
5
5
|
*/
|
|
6
6
|
export declare const applyTransitionMock: (params: ApplyTransitionParams) => Promise<ApplyTransitionResponse>;
|
|
@@ -1,33 +1,23 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Mock implementation: applies all transitions except a
|
|
2
|
+
* Mock implementation: applies all transitions except a known-invalid one
|
|
3
3
|
* so the demo app can show both successful and blocked responses.
|
|
4
4
|
*/
|
|
5
5
|
export const applyTransitionMock = (params) => {
|
|
6
|
-
const {
|
|
7
|
-
if (
|
|
6
|
+
const { targetFulfillmentState } = params;
|
|
7
|
+
if (targetFulfillmentState === "cancelled") {
|
|
8
8
|
return Promise.resolve({
|
|
9
9
|
result: {
|
|
10
10
|
allowed: false,
|
|
11
|
-
blockedBy: "
|
|
12
|
-
guard: "no-
|
|
13
|
-
reason: "Cannot
|
|
14
|
-
}
|
|
15
|
-
});
|
|
16
|
-
}
|
|
17
|
-
if (to.payment === "paid" && to.fulfillment === "cancelled") {
|
|
18
|
-
return Promise.resolve({
|
|
19
|
-
result: {
|
|
20
|
-
allowed: false,
|
|
21
|
-
blockedBy: "cross_axis_rule",
|
|
22
|
-
guard: "no-pay-cancelled",
|
|
23
|
-
reason: "Cannot mark a cancelled order as paid"
|
|
11
|
+
blockedBy: "condition",
|
|
12
|
+
guard: "no-cancel-open-order",
|
|
13
|
+
reason: "Cannot cancel an order with open items"
|
|
24
14
|
}
|
|
25
15
|
});
|
|
26
16
|
}
|
|
27
17
|
return Promise.resolve({
|
|
28
18
|
result: { allowed: true },
|
|
29
19
|
from: { payment: "unpaid", fulfillment: "draft" },
|
|
30
|
-
to,
|
|
31
|
-
displayState:
|
|
20
|
+
to: { payment: "unpaid", fulfillment: targetFulfillmentState },
|
|
21
|
+
displayState: `unpaid / ${targetFulfillmentState}`
|
|
32
22
|
});
|
|
33
23
|
};
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type { CFStatePair, CFTransitionResult } from "../../common-types/order-state";
|
|
2
2
|
export interface ApplyTransitionParams {
|
|
3
|
-
/** Order to transition. */
|
|
4
|
-
orderId
|
|
5
|
-
/** Target state
|
|
6
|
-
|
|
3
|
+
/** Order to transition. Omit to target the active order — materializing one from the live cart if none exists. */
|
|
4
|
+
orderId?: string;
|
|
5
|
+
/** Target fulfillment state. The payment axis is never client-settable. */
|
|
6
|
+
targetFulfillmentState: string;
|
|
7
|
+
/** Clear the terminal after transitioning the ACTIVE order (park parity). Default true. */
|
|
8
|
+
clearTerminal?: boolean;
|
|
7
9
|
}
|
|
8
10
|
export interface ApplyTransitionResponse {
|
|
9
11
|
result: CFTransitionResult;
|
|
@@ -15,8 +15,8 @@ export interface ExtensionPaymentParams {
|
|
|
15
15
|
referenceId?: string;
|
|
16
16
|
extensionId?: string;
|
|
17
17
|
metadata?: Record<string, unknown>;
|
|
18
|
-
/** Override the fulfillment
|
|
19
|
-
|
|
18
|
+
/** Override the fulfillment landing on full payment. Omitted: preserve advanced fulfillment, auto-fulfill from draft/pending/on_hold. */
|
|
19
|
+
targetFulfillmentState?: string;
|
|
20
20
|
/** EMV data when the underlying payment carries one (typed as `IntegrationEmvData` by the integration wrapper). */
|
|
21
21
|
emvData?: unknown;
|
|
22
22
|
/** Processor fee in integer MINOR currency units; recorded on the order's paymentMethod.processorFee. */
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { GetAvailableTransitions } from "./types";
|
|
2
2
|
/**
|
|
3
3
|
* Mock implementation: returns a fixed set of plausible transitions
|
|
4
|
-
* so the demo app has data to render.
|
|
4
|
+
* so the demo app has data to render. Mirrors an UNPAID order under the
|
|
5
|
+
* default (empty cross-axis rules) config: fulfillment can advance without
|
|
6
|
+
* payment (FI-6383), plus the classic park/void moves.
|
|
5
7
|
*/
|
|
6
|
-
export declare const getAvailableTransitionsMock:
|
|
8
|
+
export declare const getAvailableTransitionsMock: GetAvailableTransitions;
|
|
@@ -1,26 +1,38 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Mock implementation: returns a fixed set of plausible transitions
|
|
3
|
-
* so the demo app has data to render.
|
|
3
|
+
* so the demo app has data to render. Mirrors an UNPAID order under the
|
|
4
|
+
* default (empty cross-axis rules) config: fulfillment can advance without
|
|
5
|
+
* payment (FI-6383), plus the classic park/void moves.
|
|
4
6
|
*/
|
|
5
|
-
export const getAvailableTransitionsMock =
|
|
7
|
+
export const getAvailableTransitionsMock = () => Promise.resolve({
|
|
6
8
|
transitions: [
|
|
7
9
|
{
|
|
8
|
-
to: { payment: "
|
|
9
|
-
displayLabel: "
|
|
10
|
-
conditions: [{ met: true, description: "Order
|
|
10
|
+
to: { payment: "unpaid", fulfillment: "in_progress" },
|
|
11
|
+
displayLabel: "Start Preparing",
|
|
12
|
+
conditions: [{ met: true, description: "Order has items" }]
|
|
11
13
|
},
|
|
12
14
|
{
|
|
13
|
-
to: { payment: "
|
|
14
|
-
displayLabel: "
|
|
15
|
-
conditions: [{ met: true, description: "Order
|
|
15
|
+
to: { payment: "unpaid", fulfillment: "fulfilled" },
|
|
16
|
+
displayLabel: "Mark Fulfilled",
|
|
17
|
+
conditions: [{ met: true, description: "Order has items" }]
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
to: { payment: "unpaid", fulfillment: "on_hold" },
|
|
21
|
+
displayLabel: "Park Order",
|
|
22
|
+
conditions: [{ met: true, description: "Order is open" }]
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
to: { payment: "paid", fulfillment: "fulfilled" },
|
|
26
|
+
displayLabel: "Complete Payment",
|
|
27
|
+
conditions: [{ met: true, description: "Balance due > 0" }]
|
|
16
28
|
},
|
|
17
29
|
{
|
|
18
30
|
to: { payment: "voided", fulfillment: "cancelled" },
|
|
19
31
|
displayLabel: "Void Order",
|
|
20
32
|
conditions: [
|
|
21
33
|
{ met: true, description: "Order exists" },
|
|
22
|
-
{ met: false, description: "No payments captured (mock: skipped)" }
|
|
23
|
-
]
|
|
24
|
-
}
|
|
25
|
-
]
|
|
34
|
+
{ met: false, description: "No payments captured (mock: skipped)" }
|
|
35
|
+
]
|
|
36
|
+
}
|
|
37
|
+
]
|
|
26
38
|
});
|
|
@@ -51,6 +51,8 @@ export interface IntegrationPaymentParams {
|
|
|
51
51
|
metadata?: Record<string, unknown>;
|
|
52
52
|
/** Provider fee in integer MINOR currency units — stored on paymentMethod.processorFee. */
|
|
53
53
|
processorFee?: number;
|
|
54
|
+
/** Override the fulfillment landing on full payment. Omitted: preserve advanced fulfillment, auto-fulfill from draft/pending/on_hold. */
|
|
55
|
+
targetFulfillmentState?: string;
|
|
54
56
|
}
|
|
55
57
|
export type IntegrationPaymentResponse = ExtensionPaymentResponse;
|
|
56
58
|
export type IntegrationPayment = (params: IntegrationPaymentParams) => Promise<IntegrationPaymentResponse>;
|
|
@@ -7,8 +7,8 @@ export interface PartialPaymentParams {
|
|
|
7
7
|
isPercent?: boolean;
|
|
8
8
|
/** If true, opens the split payment UI. */
|
|
9
9
|
openUI?: boolean;
|
|
10
|
-
/** Override the fulfillment
|
|
11
|
-
|
|
10
|
+
/** Override the fulfillment landing on full payment. Omitted: preserve advanced fulfillment, auto-fulfill from draft/pending/on_hold. */
|
|
11
|
+
targetFulfillmentState?: string;
|
|
12
12
|
}
|
|
13
13
|
export interface PartialPaymentResponse {
|
|
14
14
|
success: boolean;
|
|
@@ -12,6 +12,8 @@ export interface RedeemPaymentParams {
|
|
|
12
12
|
processor?: string;
|
|
13
13
|
referenceId?: string;
|
|
14
14
|
metadata?: Record<string, unknown>;
|
|
15
|
+
/** Override the fulfillment landing on full payment. Omitted: preserve advanced fulfillment, auto-fulfill from draft/pending/on_hold. */
|
|
16
|
+
targetFulfillmentState?: string;
|
|
15
17
|
}
|
|
16
18
|
export type RedeemPaymentResponse = ExtensionPaymentResponse;
|
|
17
19
|
export type RedeemPayment = (params: RedeemPaymentParams) => Promise<RedeemPaymentResponse>;
|
|
@@ -12,9 +12,9 @@ export interface TerminalPaymentParams {
|
|
|
12
12
|
*/
|
|
13
13
|
amount: number;
|
|
14
14
|
/** "Bluetooth" or "Cloud". Defaults to "Cloud". */
|
|
15
|
-
paymentType?:
|
|
16
|
-
/** Override the fulfillment
|
|
17
|
-
|
|
15
|
+
paymentType?: "Bluetooth" | "Cloud";
|
|
16
|
+
/** Override the fulfillment landing on full payment. Omitted: preserve advanced fulfillment, auto-fulfill from draft/pending/on_hold. */
|
|
17
|
+
targetFulfillmentState?: string;
|
|
18
18
|
}
|
|
19
19
|
export interface TerminalPaymentResponse {
|
|
20
20
|
success: boolean;
|
package/dist/demo/database.d.ts
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* Mock Database for Standalone/Demo Mode
|
|
3
3
|
* Stores mock data that mimics the Render environment
|
|
4
4
|
*/
|
|
5
|
-
import { CFActiveCompany, CFActiveUser, CFActiveStation, CFActiveOutlet, CFActiveOrder, CFCustomer, CFProduct, CFActiveCart, CFCategory, CFActiveProduct, CFSession, CFActiveRefundDetails, CFSmartGridLayout } from
|
|
6
|
-
export * from
|
|
5
|
+
import { CFActiveCompany, CFActiveUser, CFActiveStation, CFActiveOutlet, CFActiveOrder, CFCustomer, CFProduct, CFActiveCart, CFCategory, CFActiveProduct, CFSession, CFActiveRefundDetails, CFSmartGridLayout } from '../CommonTypes';
|
|
6
|
+
export * from './mocks';
|
|
7
7
|
/** Replace mock catalog / context data in place (same array references mock handlers use). */
|
|
8
8
|
export interface MockDatabaseConfig {
|
|
9
9
|
company?: Partial<CFActiveCompany>;
|