@openreceive/angular 0.4.5 → 0.4.8

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 CHANGED
@@ -1,6 +1,30 @@
1
1
  # @openreceive/angular
2
2
 
3
- Angular wrapper for the OpenReceive checkout custom element.
3
+ Add Bitcoin Lightning checkout to your Angular app with a standalone
4
+ component. Give it an order reference to show payment choices, QR codes, and
5
+ live payment status. The component wraps the shared OpenReceive custom
6
+ element and fits into your existing checkout page.
7
+
8
+ OpenReceive supports optional swaps from **USDT, USDC, SOL, and ETH** through
9
+ a configured swap provider. The provider converts the payment to **BTC over
10
+ Lightning**, which settles into the merchant's connected wallet. Available
11
+ assets and networks depend on the provider; swaps are optional.
12
+
13
+ Pair this browser package with an OpenReceive server integration. Your server
14
+ authorizes the order, sets the amount, configures swaps, and verifies
15
+ settlement; wallet and provider credentials stay on the server.
16
+
17
+ ## Install
18
+
19
+ Use Node.js 22 or later for package tooling and Angular 17 or later.
20
+
21
+ ```sh
22
+ npm install @openreceive/angular
23
+ ```
24
+
25
+ Follow the [frontend checkout guide](https://github.com/openreceive/openreceive/blob/master/docs/guides/frontend-checkout.md)
26
+ to connect the component to your server routes. Use the server-side payment
27
+ hook to fulfill orders; browser callbacks update the interface.
4
28
 
5
29
  ## Mount
6
30
 
@@ -37,7 +61,7 @@ Angular selector is `openreceive-angular-checkout`, and it renders the
37
61
  Pass `reference` to let the element create the checkout (create mode), or pass a
38
62
  `checkout` snapshot to render one your server already created. Prop names,
39
63
  defaults, and the full surface are shared across the wrappers — see
40
- `docs/internal/wrapper-parity.md` in the repository.
64
+ [frontend checkout guide](https://github.com/openreceive/openreceive/blob/master/docs/guides/frontend-checkout.md).
41
65
 
42
66
  Event handlers (`onCopy`, `onOpenWallet`, `onState`, `onSettled`,
43
67
  `onProviderCopy`, `onStartOver`, `onError`) are `@Input()` props, not Angular
package/dist/README.md CHANGED
@@ -1,6 +1,30 @@
1
1
  # @openreceive/angular
2
2
 
3
- Angular wrapper for the OpenReceive checkout custom element.
3
+ Add Bitcoin Lightning checkout to your Angular app with a standalone
4
+ component. Give it an order reference to show payment choices, QR codes, and
5
+ live payment status. The component wraps the shared OpenReceive custom
6
+ element and fits into your existing checkout page.
7
+
8
+ OpenReceive supports optional swaps from **USDT, USDC, SOL, and ETH** through
9
+ a configured swap provider. The provider converts the payment to **BTC over
10
+ Lightning**, which settles into the merchant's connected wallet. Available
11
+ assets and networks depend on the provider; swaps are optional.
12
+
13
+ Pair this browser package with an OpenReceive server integration. Your server
14
+ authorizes the order, sets the amount, configures swaps, and verifies
15
+ settlement; wallet and provider credentials stay on the server.
16
+
17
+ ## Install
18
+
19
+ Use Node.js 22 or later for package tooling and Angular 17 or later.
20
+
21
+ ```sh
22
+ npm install @openreceive/angular
23
+ ```
24
+
25
+ Follow the [frontend checkout guide](https://github.com/openreceive/openreceive/blob/master/docs/guides/frontend-checkout.md)
26
+ to connect the component to your server routes. Use the server-side payment
27
+ hook to fulfill orders; browser callbacks update the interface.
4
28
 
5
29
  ## Mount
6
30
 
@@ -37,7 +61,7 @@ Angular selector is `openreceive-angular-checkout`, and it renders the
37
61
  Pass `reference` to let the element create the checkout (create mode), or pass a
38
62
  `checkout` snapshot to render one your server already created. Prop names,
39
63
  defaults, and the full surface are shared across the wrappers — see
40
- `docs/internal/wrapper-parity.md` in the repository.
64
+ [frontend checkout guide](https://github.com/openreceive/openreceive/blob/master/docs/guides/frontend-checkout.md).
41
65
 
42
66
  Event handlers (`onCopy`, `onOpenWallet`, `onState`, `onSettled`,
43
67
  `onProviderCopy`, `onStartOver`, `onError`) are `@Input()` props, not Angular
@@ -92,10 +92,10 @@ class ElementBindingsDirective {
92
92
  }
93
93
  return wrapped;
94
94
  }
95
- static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.0.3", ngImport: i0, type: ElementBindingsDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
96
- static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "22.0.3", type: ElementBindingsDirective, isStandalone: true, selector: "[openreceiveElementBindings]", inputs: { bindings: ["openreceiveElementBindings", "bindings"] }, usesOnChanges: true, ngImport: i0 });
95
+ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.1", ngImport: i0, type: ElementBindingsDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
96
+ static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "22.1.1", type: ElementBindingsDirective, isStandalone: true, selector: "[openreceiveElementBindings]", inputs: { bindings: ["openreceiveElementBindings", "bindings"] }, usesOnChanges: true, ngImport: i0 });
97
97
  }
98
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.3", ngImport: i0, type: ElementBindingsDirective, decorators: [{
98
+ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.1", ngImport: i0, type: ElementBindingsDirective, decorators: [{
99
99
  type: Directive,
100
100
  args: [{
101
101
  selector: "[openreceiveElementBindings]",
@@ -223,8 +223,8 @@ class CheckoutComponent {
223
223
  };
224
224
  return createWrapperCheckoutShellBinding(this.checkout ?? null, options);
225
225
  }
226
- static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.0.3", ngImport: i0, type: CheckoutComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
227
- static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "22.0.3", type: CheckoutComponent, isStandalone: true, selector: "openreceive-angular-checkout", inputs: { checkout: "checkout", reference: "reference", prefix: "prefix", csrfHeader: "csrfHeader", paymentWizard: "paymentWizard", decodeLinkUrl: "decodeLinkUrl", themeToggle: "themeToggle", defaultTheme: "defaultTheme", storageKey: "storageKey", metadata: "metadata", syncUrl: "syncUrl", resumePathPrefix: "resumePathPrefix", routeReference: "routeReference", resumePaymentHash: "resumePaymentHash", resumable: "resumable", onCopy: "onCopy", onOpenWallet: "onOpenWallet", onState: "onState", onSettled: "onSettled", onProviderCopy: "onProviderCopy", onStartOver: "onStartOver", onError: "onError", options: "options" }, usesOnChanges: true, ngImport: i0, template: `
226
+ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.1", ngImport: i0, type: CheckoutComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
227
+ static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "22.1.1", type: CheckoutComponent, isStandalone: true, selector: "openreceive-angular-checkout", inputs: { checkout: "checkout", reference: "reference", prefix: "prefix", csrfHeader: "csrfHeader", paymentWizard: "paymentWizard", decodeLinkUrl: "decodeLinkUrl", themeToggle: "themeToggle", defaultTheme: "defaultTheme", storageKey: "storageKey", metadata: "metadata", syncUrl: "syncUrl", resumePathPrefix: "resumePathPrefix", routeReference: "routeReference", resumePaymentHash: "resumePaymentHash", resumable: "resumable", onCopy: "onCopy", onOpenWallet: "onOpenWallet", onState: "onState", onSettled: "onSettled", onProviderCopy: "onProviderCopy", onStartOver: "onStartOver", onError: "onError", options: "options" }, usesOnChanges: true, ngImport: i0, template: `
228
228
  <section [openreceiveElementBindings]="rootBindings">
229
229
  @if (elementsReady && shell; as shell) {
230
230
  @if (shell.themeToggle) {
@@ -237,7 +237,7 @@ class CheckoutComponent {
237
237
  </section>
238
238
  `, isInline: true, dependencies: [{ kind: "directive", type: ElementBindingsDirective, selector: "[openreceiveElementBindings]", inputs: ["openreceiveElementBindings"] }] });
239
239
  }
240
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.3", ngImport: i0, type: CheckoutComponent, decorators: [{
240
+ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.1", ngImport: i0, type: CheckoutComponent, decorators: [{
241
241
  type: Component,
242
242
  args: [{
243
243
  selector: "openreceive-angular-checkout",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@openreceive/angular",
3
- "version": "0.4.5",
4
- "description": "Angular wrapper for the OpenReceive checkout custom element.",
3
+ "version": "0.4.8",
4
+ "description": "Angular component for Bitcoin Lightning checkout and optional USDT, USDC, SOL and ETH swaps.",
5
5
  "keywords": [
6
6
  "bitcoin",
7
7
  "lightning",
@@ -20,8 +20,8 @@
20
20
  "module": "./dist/fesm2022/openreceive-angular.mjs",
21
21
  "types": "./dist/types/openreceive-angular.d.ts",
22
22
  "dependencies": {
23
- "@openreceive/browser": "0.4.5",
24
- "@openreceive/elements": "0.4.5"
23
+ "@openreceive/browser": "0.4.8",
24
+ "@openreceive/elements": "0.4.8"
25
25
  },
26
26
  "peerDependencies": {
27
27
  "@angular/core": ">=17.0.0"
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (BTCPay Server)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Connect a BTCPay Server store to a receive-only NWC wallet with the OpenReceive
6
6
  plugin, and optionally let payers pay BTCPay invoices with USDT, USDC, ETH or
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (Django)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a Django project — the app you are already working in. You
6
6
  do not need a copy of the OpenReceive source: the Python package is on PyPI
@@ -245,11 +245,25 @@ built on `@openreceive/browser/headless`. Read that before writing components.
245
245
  "switch payment method".
246
246
  - No "Open wallet" button on desktop.
247
247
  - Wallet suggestions: `getPaymentWizardRoutes()` +
248
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
249
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
250
- resolves (`image` is `undefined` until then) — so serve nothing and set no
251
- asset option. When it works, the logos and payment icons render; a missing
252
- image means a CSP `img-src` that blocks `data:`, and the console names it.
248
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
249
+ images load from a JavaScript chunk. For a custom headless UI, load it when
250
+ a tutorial opens and look up the returned table by the tutorial's `path`:
251
+
252
+ ```js
253
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
254
+
255
+ const images = await loadPayTutorialImages();
256
+ const src = images[tutorial.path]; // data URI for the selected tutorial
257
+ ```
258
+
259
+ Render `src` as the image source and update your UI after loading. Existing
260
+ display objects do not update: their `tutorial.image` stays `undefined` if
261
+ created before loading. Alternatively, await the loader, recreate the displays
262
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
263
+ Show the caption while loading or if loading fails; never use an empty image
264
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
265
+ For missing images, check CSP errors, failed chunks, and stale displays.
266
+ Registry paths are lookup keys; there is no asset option or image route.
253
267
  The registry answers ~37 wallets: pass
254
268
  `providerPreviewLimit` and build "show all" from `display.providerCount`,
255
269
  or they push the QR off the screen.
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (FastAPI)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a FastAPI application — the app you are already working in.
6
6
  You do not need a copy of the OpenReceive source: the engine is on PyPI
@@ -242,11 +242,25 @@ components.
242
242
  "switch payment method".
243
243
  - No "Open wallet" button on desktop.
244
244
  - Wallet suggestions: `getPaymentWizardRoutes()` +
245
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
246
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
247
- resolves (`image` is `undefined` until then) — so serve nothing and set no
248
- asset option. When it works, the logos and payment icons render; a missing
249
- image means a CSP `img-src` that blocks `data:`, and the console names it.
245
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
246
+ images load from a JavaScript chunk. For a custom headless UI, load it when
247
+ a tutorial opens and look up the returned table by the tutorial's `path`:
248
+
249
+ ```js
250
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
251
+
252
+ const images = await loadPayTutorialImages();
253
+ const src = images[tutorial.path]; // data URI for the selected tutorial
254
+ ```
255
+
256
+ Render `src` as the image source and update your UI after loading. Existing
257
+ display objects do not update: their `tutorial.image` stays `undefined` if
258
+ created before loading. Alternatively, await the loader, recreate the displays
259
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
260
+ Show the caption while loading or if loading fails; never use an empty image
261
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
262
+ For missing images, check CSP errors, failed chunks, and stale displays.
263
+ Registry paths are lookup keys; there is no asset option or image route.
250
264
 
251
265
  ## More documentation
252
266
 
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (Fastify)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a Fastify application — the app you are already working in.
6
6
  You do not need a copy of the OpenReceive source: the packages are on npm, and
@@ -225,11 +225,25 @@ components.
225
225
  "switch payment method".
226
226
  - No "Open wallet" button on desktop.
227
227
  - Wallet suggestions: `getPaymentWizardRoutes()` +
228
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
229
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
230
- resolves (`image` is `undefined` until then) — so serve nothing and set no
231
- asset option. When it works, the logos and payment icons render; a missing
232
- image means a CSP `img-src` that blocks `data:`, and the console names it.
228
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
229
+ images load from a JavaScript chunk. For a custom headless UI, load it when
230
+ a tutorial opens and look up the returned table by the tutorial's `path`:
231
+
232
+ ```js
233
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
234
+
235
+ const images = await loadPayTutorialImages();
236
+ const src = images[tutorial.path]; // data URI for the selected tutorial
237
+ ```
238
+
239
+ Render `src` as the image source and update your UI after loading. Existing
240
+ display objects do not update: their `tutorial.image` stays `undefined` if
241
+ created before loading. Alternatively, await the loader, recreate the displays
242
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
243
+ Show the caption while loading or if loading fails; never use an empty image
244
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
245
+ For missing images, check CSP errors, failed chunks, and stale displays.
246
+ Registry paths are lookup keys; there is no asset option or image route.
233
247
 
234
248
  ## More documentation
235
249
 
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (Laravel)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a Laravel application — the app you are already working in.
6
6
  You do not need a copy of the OpenReceive source: the package is on Packagist
@@ -230,11 +230,25 @@ built on `@openreceive/browser/headless`. Read that before writing components.
230
230
  "switch payment method".
231
231
  - No "Open wallet" button on desktop.
232
232
  - Wallet suggestions: `getPaymentWizardRoutes()` +
233
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
234
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
235
- resolves (`image` is `undefined` until then) — so serve nothing and set no
236
- asset option. When it works, the logos and payment icons render; a missing
237
- image means a CSP `img-src` that blocks `data:`, and the console names it.
233
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
234
+ images load from a JavaScript chunk. For a custom headless UI, load it when
235
+ a tutorial opens and look up the returned table by the tutorial's `path`:
236
+
237
+ ```js
238
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
239
+
240
+ const images = await loadPayTutorialImages();
241
+ const src = images[tutorial.path]; // data URI for the selected tutorial
242
+ ```
243
+
244
+ Render `src` as the image source and update your UI after loading. Existing
245
+ display objects do not update: their `tutorial.image` stays `undefined` if
246
+ created before loading. Alternatively, await the loader, recreate the displays
247
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
248
+ Show the caption while loading or if loading fails; never use an empty image
249
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
250
+ For missing images, check CSP errors, failed chunks, and stale displays.
251
+ Registry paths are lookup keys; there is no asset option or image route.
238
252
  The registry answers ~37 wallets: pass
239
253
  `providerPreviewLimit` and build "show all" from `display.providerCount`,
240
254
  or they push the QR off the screen.
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (Next.js)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a Next.js App Router application — the app you are already
6
6
  working in. You do not need a copy of the OpenReceive source: the packages are
@@ -231,11 +231,25 @@ components.
231
231
  "switch payment method".
232
232
  - No "Open wallet" button on desktop.
233
233
  - Wallet suggestions: `getPaymentWizardRoutes()` +
234
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
235
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
236
- resolves (`image` is `undefined` until then) — so serve nothing and set no
237
- asset option. When it works, the logos and payment icons render; a missing
238
- image means a CSP `img-src` that blocks `data:`, and the console names it.
234
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
235
+ images load from a JavaScript chunk. For a custom headless UI, load it when
236
+ a tutorial opens and look up the returned table by the tutorial's `path`:
237
+
238
+ ```js
239
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
240
+
241
+ const images = await loadPayTutorialImages();
242
+ const src = images[tutorial.path]; // data URI for the selected tutorial
243
+ ```
244
+
245
+ Render `src` as the image source and update your UI after loading. Existing
246
+ display objects do not update: their `tutorial.image` stays `undefined` if
247
+ created before loading. Alternatively, await the loader, recreate the displays
248
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
249
+ Show the caption while loading or if loading fails; never use an empty image
250
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
251
+ For missing images, check CSP errors, failed chunks, and stale displays.
252
+ Registry paths are lookup keys; there is no asset option or image route.
239
253
 
240
254
  ## More documentation
241
255
 
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (Node.js)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a Node application — the app you are already working in. You
6
6
  do not need a copy of the OpenReceive source: the packages are on npm, and the
@@ -217,11 +217,25 @@ components.
217
217
  "switch payment method".
218
218
  - No "Open wallet" button on desktop.
219
219
  - Wallet suggestions: `getPaymentWizardRoutes()` +
220
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
221
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
222
- resolves (`image` is `undefined` until then) — so serve nothing and set no
223
- asset option. When it works, the logos and payment icons render; a missing
224
- image means a CSP `img-src` that blocks `data:`, and the console names it.
220
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
221
+ images load from a JavaScript chunk. For a custom headless UI, load it when
222
+ a tutorial opens and look up the returned table by the tutorial's `path`:
223
+
224
+ ```js
225
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
226
+
227
+ const images = await loadPayTutorialImages();
228
+ const src = images[tutorial.path]; // data URI for the selected tutorial
229
+ ```
230
+
231
+ Render `src` as the image source and update your UI after loading. Existing
232
+ display objects do not update: their `tutorial.image` stays `undefined` if
233
+ created before loading. Alternatively, await the loader, recreate the displays
234
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
235
+ Show the caption while loading or if loading fails; never use an empty image
236
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
237
+ For missing images, check CSP errors, failed chunks, and stale displays.
238
+ Registry paths are lookup keys; there is no asset option or image route.
225
239
 
226
240
  ## More documentation
227
241
 
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (PHP)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a PHP application — the app you are already working in. You
6
6
  do not need a copy of the OpenReceive source: the engine is on Packagist
@@ -243,11 +243,25 @@ of https://openreceive.org/guides/checkout-ux.md, for a UI built on
243
243
  "switch payment method".
244
244
  - No "Open wallet" button on desktop.
245
245
  - Wallet suggestions: `getPaymentWizardRoutes()` +
246
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
247
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
248
- resolves (`image` is `undefined` until then) — so serve nothing and set no
249
- asset option. When it works, the logos and payment icons render; a missing
250
- image means a CSP `img-src` that blocks `data:`, and the console names it.
246
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
247
+ images load from a JavaScript chunk. For a custom headless UI, load it when
248
+ a tutorial opens and look up the returned table by the tutorial's `path`:
249
+
250
+ ```js
251
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
252
+
253
+ const images = await loadPayTutorialImages();
254
+ const src = images[tutorial.path]; // data URI for the selected tutorial
255
+ ```
256
+
257
+ Render `src` as the image source and update your UI after loading. Existing
258
+ display objects do not update: their `tutorial.image` stays `undefined` if
259
+ created before loading. Alternatively, await the loader, recreate the displays
260
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
261
+ Show the caption while loading or if loading fails; never use an empty image
262
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
263
+ For missing images, check CSP errors, failed chunks, and stale displays.
264
+ Registry paths are lookup keys; there is no asset option or image route.
251
265
 
252
266
  ## More documentation
253
267
 
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (Rails)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Add OpenReceive to a Rails application — the app you are already working in. You
6
6
  do not need a copy of the OpenReceive source: the gem is on RubyGems, the
@@ -224,11 +224,25 @@ built on `@openreceive/browser/headless`. Read that before writing components.
224
224
  "switch payment method".
225
225
  - No "Open wallet" button on desktop.
226
226
  - Wallet suggestions: `getPaymentWizardRoutes()` +
227
- `createWizardRouteDisplays`. Lightning only. Every image ships inside
228
- the JavaScript — logos as data URIs, tutorials once `loadPayTutorialImages()`
229
- resolves (`image` is `undefined` until then) — so serve nothing and set no
230
- asset option. When it works, the logos and payment icons render; a missing
231
- image means a CSP `img-src` that blocks `data:`, and the console names it.
227
+ `createWizardRouteDisplays`. Lightning only. Logos are data URIs; tutorial
228
+ images load from a JavaScript chunk. For a custom headless UI, load it when
229
+ a tutorial opens and look up the returned table by the tutorial's `path`:
230
+
231
+ ```js
232
+ import { loadPayTutorialImages } from "@openreceive/browser/headless";
233
+
234
+ const images = await loadPayTutorialImages();
235
+ const src = images[tutorial.path]; // data URI for the selected tutorial
236
+ ```
237
+
238
+ Render `src` as the image source and update your UI after loading. Existing
239
+ display objects do not update: their `tutorial.image` stays `undefined` if
240
+ created before loading. Alternatively, await the loader, recreate the displays
241
+ with `createWizardRouteDisplays`, and render the new `tutorial.image`.
242
+ Show the caption while loading or if loading fails; never use an empty image
243
+ source. Deploy all JavaScript chunks and allow `data:` in CSP `img-src`.
244
+ For missing images, check CSP errors, failed chunks, and stale displays.
245
+ Registry paths are lookup keys; there is no asset option or image route.
232
246
  The registry answers ~37 wallets: pass
233
247
  `providerPreviewLimit` and build "show all" from `display.providerCount`,
234
248
  or they push the QR off the screen.
@@ -1,6 +1,6 @@
1
1
  # OpenReceive agent directions (WordPress + WooCommerce)
2
2
 
3
- These directions describe OpenReceive 0.4.5.
3
+ These directions describe OpenReceive 0.4.8.
4
4
 
5
5
  Install and configure the OpenReceive gateway in the existing WooCommerce
6
6
  store. Preserve its theme, checkout, customer accounts, order model and prices.
@@ -90,6 +90,29 @@ Requirements: WordPress 6.6+, WooCommerce 9+, 64-bit PHP 8.2+ with GMP and sodiu
90
90
  and MySQL 8 or MariaDB 10.5+. Activation creates payment-attempt tables in the
91
91
  existing WordPress database. No separate database or application is required.
92
92
 
93
+ ### Get the installable archive
94
+
95
+ Use `openreceive-wordpress-<version>.zip` from the selected
96
+ [OpenReceive GitHub release](https://github.com/OpenReceive/openreceive/releases)
97
+ when that asset is listed. A GitHub source-code zip is not the plugin archive.
98
+ If the release does not yet provide a built zip, build it on a development
99
+ machine with Node 22+, PHP 8.2+, Composer and WP-CLI:
100
+
101
+ ```sh
102
+ git clone https://github.com/OpenReceive/openreceive.git
103
+ cd openreceive
104
+ git checkout <release-tag>
105
+ npm ci
106
+ npm run build:packages
107
+ composer install --working-dir=packages/php/wordpress
108
+ npm run release:wordpress:build
109
+ ```
110
+
111
+ Upload the resulting `dist/openreceive-wordpress-<version>.zip`. WP-CLI must be
112
+ on `PATH`, or set `OPENRECEIVE_WP_CLI` to the absolute path of its phar. The
113
+ WordPress server needs neither Node nor Composer: dependencies and checkout
114
+ assets are bundled inside the built plugin.
115
+
93
116
  ### Configure the wallet
94
117
 
95
118
  Open **WooCommerce → Settings → Payments → OpenReceive**. Enter a receive-only