Merge branch 'main' into release

Author: DarianM

.github/workflows/deploy.yml

@@ -121,7 +121,7 @@ jobs:
       #region Summary
       - name: Create Job summary
         if: always()
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         id: summary
         with:
           script: |
@@ -166,7 +166,7 @@ jobs:
       - name: Create deploy comment
         if: github.event_name == 'pull_request'
         continue-on-error: true
-        uses: edumserrano/find-create-or-update-comment@v2
+        uses: edumserrano/find-create-or-update-comment@v3
         with:
           issue-number: ${{ github.event.pull_request.number }}
           body-includes: '<!-- worker-deploy-summary -->'

.github/workflows/pr-checks.yml

@@ -18,7 +18,7 @@ jobs:
     name: Typecheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ./.github/workflows/setup
       - run: pnpm typecheck
 
@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Environment setup
         uses: ./.github/workflows/setup
       - name: Check lint
@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Environment setup
         uses: ./.github/workflows/setup
       - name: Check format

.github/workflows/pr-title-check.yml

@@ -13,6 +13,6 @@ jobs:
     name: Check PR Title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v5
+      - uses: amannn/action-semantic-pull-request@v6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -46,3 +46,6 @@ dist
 !cdn/dist/.gitkeep
 build
 .cache
+
+# macOS
+.DS_Store

api/README.md

@@ -0,0 +1,21 @@
+# Publisher Tools - API
+
+This package contains the Hono-based API server that powers the Publisher Tools. It runs on Cloudflare Workers and is responsible for fetching tool configurations, handling Open Payments, and managing probabilistic revenue sharing.
+
+## Endpoints
+
+The API exposes endpoints related to the following functionalities:
+
+- **Tool Configuration:** Handles fetching the configuration for the monetization tools (see `src/routes/get-config.ts`).
+- **Payments:** Manages the Open Payments flow (see `src/routes/payment.ts`).
+- **Probabilistic Revshare:** Handles logic related to probabilistic revenue sharing (see `src/routes/probabilistic-revshare.ts`).
+
+## Development
+
+To run the API server for local development, you can use the `dev` script from the project root:
+
+```sh
+pnpm -C api dev
+```
+
+This will start the Cloudflare Wrangler development server, which automatically reloads on file changes.

api/package.json

@@ -16,7 +16,7 @@
   "dependencies": {
     "@hono/zod-validator": "^0.7.3",
     "@interledger/open-payments": "^7.1.3",
-    "@noble/ed25519": "^2.3.0",
+    "@noble/ed25519": "^3.0.0",
     "@paralleldrive/cuid2": "^2.2.2",
     "@shared/config-storage-service": "workspace:^",
     "@shared/probabilistic-revenue-share": "workspace:^",

api/src/utils/utils.ts

@@ -1,7 +1,7 @@
 import { signMessage } from 'http-message-signatures/lib/httpbis'
 import { createContentDigestHeader } from 'httpbis-digest-headers'
 import type { Request } from 'http-message-signatures'
-import * as ed from '@noble/ed25519'
+import { signAsync } from '@noble/ed25519'
 import type { ContentfulStatusCode } from 'hono/utils/http-status'
 import { HTTPException } from 'hono/http-exception'
 
@@ -104,7 +104,7 @@ function createSigner(key: Uint8Array, keyId: string) {
     id: keyId,
     alg: 'ed25519',
     async sign(data: Uint8Array) {
-      return Buffer.from(await ed.signAsync(data, key))
+      return Buffer.from(await signAsync(data, key))
     }
   }
 }

api/wrangler.toml

@@ -3,9 +3,5 @@ main = "src/index.ts"
 compatibility_date = "2024-09-23"
 compatibility_flags = ["nodejs_compat"]
 
-[vars]
-FRONTEND_URL = "https://webmonetization.org/tools/"
-AWS_PREFIX = "20250717"
-
 [dev]
 port = 8787

cdn/README.md

@@ -0,0 +1,28 @@
+# Publisher Tools - CDN
+
+This package is responsible for building and delivering the final, browser-ready JavaScript assets (the banner and widget scripts) that publishers embed on their websites.
+
+It takes the raw source code from the `@tools/components` package, bundles it using `esbuild`, and prepares it for delivery via the Cloudflare CDN.
+
+## Build Process
+
+The core of this package is the custom build script located at `build.js`. This script uses `esbuild` to compile the TypeScript source from `src/` and the components from the `components` package into distributable files.
+
+The main entry points for the build are:
+
+- `src/banner.ts`
+- `src/widget.ts`
+
+The output is placed in the `dist/` directory.
+
+## Assets
+
+This package also manages static assets required by the components, such as fonts. The build process ensures that these assets are correctly referenced and made available through the CDN. Fonts are located in the `src/assets/fonts` directory.
+
+## Development
+
+To build the assets and run a local development server that simulates the CDN, use the `dev` script from the project root. This will watch for file changes in both the `cdn` and `components` packages and automatically rebuild.
+
+```sh
+pnpm -C cdn dev
+```

components/README.md

@@ -0,0 +1,24 @@
+# Publisher Tools - Components
+
+This package contains the core, embeddable web components for the Publisher Tools, built using the [Lit](https://lit.dev/) library. These components are intended to be placed on publishers' websites.
+
+## Core Components
+
+- **Banner:** A notification banner that can be displayed on a publisher's site. The source is located in `src/banner.ts`.
+- **Widget:** The interactive monetization widget. Its source code is in the `src/widget/` directory.
+
+## Build Process
+
+This package contains the raw source code for the web components but does not have its own build process.
+
+The components are imported and bundled by the **`cdn`** package, which is responsible for compiling them into a browser-ready format. They are also used by the **`frontend`** package for demonstration purposes.
+
+Please see the `cdn` package for more details on the build and delivery process.
+
+## Development
+
+The only available script is for type checking, which can be run from the project root:
+
+```sh
+pnpm -C components typecheck
+```