@encorekit/web-sdk 2.1.4 → 2.2.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 +20 -0
- package/dist/cjs/index.cjs +1 -1
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/umd/encore.min.js +1 -1
- package/dist/umd/encore.min.js.map +1 -1
- package/package.json +1 -1
- package/types/analytics/events.d.ts +54 -2
- package/types/analytics/events.d.ts.map +1 -1
- package/types/api/APIClient.d.ts +15 -1
- package/types/api/APIClient.d.ts.map +1 -1
- package/types/api/generated/types.d.ts +94 -7
- package/types/api/generated/types.d.ts.map +1 -1
- package/types/api/models.d.ts +7 -0
- package/types/api/models.d.ts.map +1 -1
- package/types/core/Configuration.d.ts +2 -0
- package/types/core/Configuration.d.ts.map +1 -1
- package/types/core/Encore.d.ts.map +1 -1
- package/types/core/giftVariant.d.ts +11 -6
- package/types/core/giftVariant.d.ts.map +1 -1
- package/types/core/share.d.ts +58 -0
- package/types/core/share.d.ts.map +1 -0
- package/types/core/unlockCode.d.ts +25 -0
- package/types/core/unlockCode.d.ts.map +1 -0
- package/types/core/version.d.ts +1 -1
- package/types/types.d.ts +61 -8
- package/types/types.d.ts.map +1 -1
- package/types/ui/CodeUnlock.d.ts +151 -0
- package/types/ui/CodeUnlock.d.ts.map +1 -0
- package/types/ui/GiftSheet.d.ts +47 -3
- package/types/ui/GiftSheet.d.ts.map +1 -1
- package/types/ui/GiftUnwrap.d.ts +70 -0
- package/types/ui/GiftUnwrap.d.ts.map +1 -1
- package/types/ui/OfferModal.d.ts +30 -0
- package/types/ui/OfferModal.d.ts.map +1 -1
- package/types/ui/giftUnwrapArt.d.ts +6 -0
- package/types/ui/giftUnwrapArt.d.ts.map +1 -1
- package/types/ui/giftUnwrapCopy.d.ts +20 -0
- package/types/ui/giftUnwrapCopy.d.ts.map +1 -1
- package/types/ui/styles.d.ts.map +1 -1
package/types/ui/OfferModal.d.ts
CHANGED
|
@@ -53,6 +53,21 @@ export interface OfferModalOptions {
|
|
|
53
53
|
* every surface derived from it. Sanitized — an unrecognised value is ignored.
|
|
54
54
|
*/
|
|
55
55
|
backgroundColor?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Which top corner the × sits in. `'start'` puts it top left, for a composition that
|
|
58
|
+
* gives the top right to another control (the `shareFromHeader` share button).
|
|
59
|
+
* Defaults to `'end'`, where every other composition has it.
|
|
60
|
+
*/
|
|
61
|
+
closePosition?: 'start' | 'end';
|
|
62
|
+
/**
|
|
63
|
+
* Asked before the ×, Escape or a backdrop click dismisses. Return `true` to take the
|
|
64
|
+
* gesture over, and the modal then neither emits `close`/`backdropClick` nor hides.
|
|
65
|
+
* `shareForLater` uses it: every dismissal gesture opens the "keep your gift for
|
|
66
|
+
* later" panel until the panel is open, and the panel's own close is the real one. Absent, or returning `false`, every
|
|
67
|
+
* gesture dismisses as it always has. A throwing interceptor counts as `false`, so a
|
|
68
|
+
* bug in it can never trap the user on the sheet.
|
|
69
|
+
*/
|
|
70
|
+
interceptDismiss?: (gesture: 'close' | 'escape' | 'backdrop') => boolean;
|
|
56
71
|
}
|
|
57
72
|
export declare class OfferModal {
|
|
58
73
|
#private;
|
|
@@ -81,6 +96,21 @@ export declare class OfferModal {
|
|
|
81
96
|
* screen readers announce the dialog by what the user actually sees.
|
|
82
97
|
*/
|
|
83
98
|
setLabelledBy(id: string): void;
|
|
99
|
+
/**
|
|
100
|
+
* Hide or show the × while the sheet is up, for a screen that puts another control
|
|
101
|
+
* in its corner (`giftUnwrap`'s ready screen, whose Back sits top left). `hidden`
|
|
102
|
+
* rather than a style, so the focus trap skips it too. If it held focus, focus moves
|
|
103
|
+
* to the first control still in the dialog.
|
|
104
|
+
*/
|
|
105
|
+
setCloseButtonHidden(hidden: boolean): void;
|
|
106
|
+
/** The ×, while the sheet is up and has one. For returning focus to it. */
|
|
107
|
+
getCloseButton(): HTMLButtonElement | null;
|
|
108
|
+
/**
|
|
109
|
+
* Take the ×, backdrop-click and Escape away from a sheet built dismissible. One way
|
|
110
|
+
* only: a gate that must keep an exit opens dismissible, and applies the caller's
|
|
111
|
+
* `dismissible: false` once the exit is no longer needed.
|
|
112
|
+
*/
|
|
113
|
+
preventDismissal(): void;
|
|
84
114
|
/**
|
|
85
115
|
* Set modal content
|
|
86
116
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OfferModal.d.ts","sourceRoot":"","sources":["../../src/ui/OfferModal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAI/C,UAAU,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrD,KAAK,EAAE,IAAI,CAAC;IACZ,aAAa,EAAE,IAAI,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"OfferModal.d.ts","sourceRoot":"","sources":["../../src/ui/OfferModal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAI/C,UAAU,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrD,KAAK,EAAE,IAAI,CAAC;IACZ,aAAa,EAAE,IAAI,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAChC;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,KAAK,OAAO,CAAC;CAC1E;AAED,qBAAa,UAAU;;gBA4BT,KAAK,GAAE,cAAmB,EAAE,OAAO,GAAE,iBAAsB;IAevE;;OAEG;IACH,IAAI,IAAI,IAAI;IAwCZ;;OAEG;IACH,IAAI,IAAI,IAAI;IA8CZ;;;;OAIG;IACH,kBAAkB,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,MAAM,IAAI;IAYnE;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAI/B;;;;;OAKG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAS3C,2EAA2E;IAC3E,cAAc,IAAI,iBAAiB,GAAG,IAAI;IAe1C;;;;OAIG;IACH,gBAAgB,IAAI,IAAI;IAiBxB;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IA4BtC;;OAEG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,aAAa,EAC9B,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,GAC3C,MAAM,IAAI;IA8Kb;;OAEG;IACH,OAAO,IAAI,IAAI;CAoBhB"}
|
|
@@ -52,4 +52,10 @@ export declare const CHECK_CIRCLE_SVG: string;
|
|
|
52
52
|
export declare const RADIO_SELECTED_SVG: string;
|
|
53
53
|
/** `icon-back-chevron.svg`, 20×20. */
|
|
54
54
|
export declare const BACK_CHEVRON_SVG: string;
|
|
55
|
+
/**
|
|
56
|
+
* The share glyph, SF Symbols' `arrowshape.turn.up.right` (the name `shareFromHeader`
|
|
57
|
+
* uses): the unsuffixed, hollow variant, so stroked rather than filled, as Android
|
|
58
|
+
* draws it.
|
|
59
|
+
*/
|
|
60
|
+
export declare const SHARE_ARROW_SVG: string;
|
|
55
61
|
//# sourceMappingURL=giftUnwrapArt.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"giftUnwrapArt.d.ts","sourceRoot":"","sources":["../../src/ui/giftUnwrapArt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAaH;;;GAGG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAyCrC;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,MAAM,CA8BvC;AAED,oFAAoF;AACpF,wBAAgB,eAAe,IAAI,MAAM,CAoBxC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAWrC;AAED,+CAA+C;AAC/C,eAAO,MAAM,gBAAgB,QAGnB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,QAIrB,CAAC;AAEX,sCAAsC;AACtC,eAAO,MAAM,gBAAgB,QAGnB,CAAC"}
|
|
1
|
+
{"version":3,"file":"giftUnwrapArt.d.ts","sourceRoot":"","sources":["../../src/ui/giftUnwrapArt.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAaH;;;GAGG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAyCrC;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,MAAM,CA8BvC;AAED,oFAAoF;AACpF,wBAAgB,eAAe,IAAI,MAAM,CAoBxC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAWrC;AAED,+CAA+C;AAC/C,eAAO,MAAM,gBAAgB,QAGnB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,QAIrB,CAAC;AAEX,sCAAsC;AACtC,eAAO,MAAM,gBAAgB,QAGnB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAIlB,CAAC"}
|
|
@@ -54,4 +54,24 @@ export declare function unwrapClaimLabel(offer: Offer): string;
|
|
|
54
54
|
* language keeps its own words.
|
|
55
55
|
*/
|
|
56
56
|
export declare function unwrapReadyBullets(offer: Offer): string[];
|
|
57
|
+
/**
|
|
58
|
+
* The "share for later" designs' own words (backend#659: `shareFromHeader`,
|
|
59
|
+
* `shareForLater`). The panel's title and line are the variant file's, verbatim, the
|
|
60
|
+
* newline included.
|
|
61
|
+
*/
|
|
62
|
+
export declare const SHARE_COPY: {
|
|
63
|
+
readonly panelTitle: "Keep your gift for later";
|
|
64
|
+
readonly panelSubtitle: "Choose any offer below.\nShare the link to pick it later.";
|
|
65
|
+
/** The panel's close control. It closes the whole presentation, so it says so. */
|
|
66
|
+
readonly panelCloseLabel: "Close";
|
|
67
|
+
/** Shown once the link is on the clipboard, the web route where no sheet confirms it. */
|
|
68
|
+
readonly copied: "Link copied";
|
|
69
|
+
/** Shown when neither the share sheet nor the clipboard would take the link. */
|
|
70
|
+
readonly unavailable: "Couldn’t share the link";
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* "Share {advertiser}": the panel's CTA (the variant's `Share ${selectedAdvertiserName}`)
|
|
74
|
+
* and the header control's accessible name. Unnamed, it shares "this gift".
|
|
75
|
+
*/
|
|
76
|
+
export declare function shareLabel(offer: Offer | undefined): string;
|
|
57
77
|
//# sourceMappingURL=giftUnwrapCopy.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"giftUnwrapCopy.d.ts","sourceRoot":"","sources":["../../src/ui/giftUnwrapCopy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,eAAe,CAAC;AAIzD,eAAO,MAAM,WAAW;IACtB,0DAA0D;;IAE1D,uEAAuE;;IAEvE;yDACqD;;IAErD,kEAAkE;;;CAG1D,CAAC;AAEX;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAKvD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAGrD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,CAiBzD"}
|
|
1
|
+
{"version":3,"file":"giftUnwrapCopy.d.ts","sourceRoot":"","sources":["../../src/ui/giftUnwrapCopy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,UAAU,IAAI,KAAK,EAAE,MAAM,eAAe,CAAC;AAIzD,eAAO,MAAM,WAAW;IACtB,0DAA0D;;IAE1D,uEAAuE;;IAEvE;yDACqD;;IAErD,kEAAkE;;;CAG1D,CAAC;AAEX;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAKvD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAGrD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,CAiBzD;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;IAGrB,kFAAkF;;IAElF,yFAAyF;;IAEzF,gFAAgF;;CAExE,CAAC;AAEX;;;GAGG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,CAG3D"}
|
package/types/ui/styles.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/ui/styles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH,eAAO,MAAM,OAAO;;;CAGV,CAAC;AAGX,eAAO,MAAM,WAAW;;;;CAId,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmOG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AACtC,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAC3C,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;;IAI/B,0FAA0F;;CAElF,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;
|
|
1
|
+
{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/ui/styles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH,eAAO,MAAM,OAAO;;;CAGV,CAAC;AAGX,eAAO,MAAM,WAAW;;;;CAId,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmOG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AACtC,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAC3C,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;;IAI/B,0FAA0F;;CAElF,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AA00KD;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,GAAE,cAAmB,GAAG,IAAI,CAgB7D;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAe1D;AAED;;GAEG;AACH,wBAAgB,EAAE,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAE/C;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7C"}
|