Skip to content

Commit d9bd94c

Browse files
committed
Add cash tracking session event targets.
1 parent 46f5749 commit d9bd94c

File tree

8 files changed

+79
-3
lines changed

8 files changed

+79
-3
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2+
import {ExtensionTargetType} from '../types/ExtensionTargetType';
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: ExtensionTargetType.PosCashTrackingSessionStartObserve,
6+
description:
7+
'An event extension target that observes when cash tracking session is canceled',
8+
category: 'Targets',
9+
subCategory: 'Cash tracking',
10+
isVisualComponent: false,
11+
related: [],
12+
type: 'Target',
13+
};
14+
15+
export default data;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2+
import {ExtensionTargetType} from '../types/ExtensionTargetType';
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: ExtensionTargetType.PosCashTrackingSessionStartObserve,
6+
description:
7+
'An event extension target that observes when cash tracking session completes',
8+
category: 'Targets',
9+
subCategory: 'Cash tracking',
10+
isVisualComponent: false,
11+
related: [],
12+
type: 'Target',
13+
};
14+
15+
export default data;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2+
import {ExtensionTargetType} from '../types/ExtensionTargetType';
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: ExtensionTargetType.PosCashTrackingSessionStartObserve,
6+
description:
7+
'An event extension target that observes when cash tracking session starts',
8+
category: 'Targets',
9+
subCategory: 'Cash tracking',
10+
isVisualComponent: false,
11+
related: [],
12+
type: 'Target',
13+
};
14+
15+
export default data;

packages/ui-extensions/docs/surfaces/point-of-sale/reference/types/ExtensionTargetType.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ export enum ExtensionTargetType {
1616
PosDraftOrderDetailsActionMenuItemRender = 'pos.draft-order-details.action.menu-item.render',
1717
PosDraftOrderDetailsActionRender = 'pos.draft-order-details.action.render',
1818
PosDraftOrderDetailsBlockRender = 'pos.draft-order-details.block.render',
19-
PosTransactionCompletedObserve = 'pos.transaction-completed.observe',
19+
PosTransactionCompletedObserve = 'pos.transaction-completed.event.observe',
20+
PosCashTrackingSessionStartObserve = 'pos.cash-tracking-session-start.event.observe',
21+
PosCashTrackingSessionCancelObserve = 'pos.cash-tracking-session-cancel.event.observe',
22+
PosCashTrackingSessionCompleteObserver = 'pos.cash-tracking-session-complete.event.observe',
2023
}
2124

2225
export enum TargetLink {
@@ -37,5 +40,8 @@ export enum TargetLink {
3740
PosDraftOrderDetailsActionMenuItemRender = '[pos.draft-order-details.action.menu-item.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-menu-item-render)',
3841
PosDraftOrderDetailsActionRender = '[pos.draft-order-details.action.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-render)',
3942
PosDraftOrderDetailsBlockRender = '[pos.draft-order-details.block.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-block-render)',
40-
PosTransactionCompletedObserve = '[pos.transaction-completed.observe](/docs/api/pos-ui-extensions/targets/post-purchase/pos-transaction-completed-observe)',
43+
PosTransactionCompletedObserve = '[pos.transaction-completed.event.observe](/docs/api/pos-ui-extensions/targets/post-purchase/pos-transaction-completed-observe)',
44+
PosCashTrackingSessionStartObserve = '[pos.cash-tracking-session-start.event.observe](/docs/api/pos-ui-extensions/targets/cash-tracking/pos-cash-tracking-session-start-observe)',
45+
PosCashTrackingSessionCancelObserve = '[pos.cash-tracking-session-cancel.event.observe](/docs/api/pos-ui-extensions/targets/cash-tracking/pos-cash-tracking-session-cancel-observe)',
46+
PosCashTrackingSessionCompleteObserver = '[pos.cash-tracking-session-complete.event.observe](/docs/api/pos-ui-extensions/targets/cash-tracking/pos-cash-tracking-session-complete-observe)',
4147
}

packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
4949
### Features
5050
5151
- Added support for the ${TargetLink.PosTransactionCompletedObserve} target.
52+
- Added support for cash tracking session. ${TargetLink.PosCashTrackingSessionStartObserve}, ${TargetLink.PosCashTrackingSessionCancelObserve}, ${TargetLink.PosCashTrackingSessionCompleteObserver} targets.
5253
`,
5354
},
5455
{
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import {BaseInput} from './BaseInput';
2+
3+
export interface CashTrackingSessionStartInput extends BaseInput {
4+
id: string;
5+
openingTime: string;
6+
}
7+
8+
export interface CashTrackingSessionEndInput extends BaseInput {
9+
id: string;
10+
closingTime: string;
11+
}
Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
import {BaseIntent} from '../intent';
2+
import {
3+
CashTrackingSessionStartInput,
4+
CashTrackingSessionEndInput,
5+
} from './input/CashTrackingSessionInput';
26
import {PurchaseCompleteInput} from './input/PurchaseCompleteInput';
37

48
export interface EventExtensionTargets {
5-
'pos.transaction-completed.observe': (
9+
'pos.transaction-completed.event.observe': (
610
input: PurchaseCompleteInput,
711
) => BaseIntent;
12+
'pos.cash-tracking-session-start.event.observe': (
13+
input: CashTrackingSessionStartInput,
14+
) => BaseIntent;
15+
'pos.cash-tracking-session-cancel.event.observe': (
16+
input: CashTrackingSessionEndInput,
17+
) => BaseIntent;
18+
'pos.cash-tracking-session-complete.event.observe': (
19+
input: CashTrackingSessionEndInput,
20+
) => BaseIntent;
821
}
922

1023
export type EventExtensionTarget = keyof EventExtensionTargets;

0 commit comments

Comments
 (0)