@adobe/spacecat-shared-tokowaka-client 1.1.1 → 1.2.0

package/.releaserc.cjs

@@ -0,0 +1,17 @@
+module.exports = {
+  extends: "semantic-release-monorepo",
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", {
+      "changelogFile": "CHANGELOG.md",
+    }],
+    "@semantic-release/npm",
+    ["@semantic-release/git", {
+      "assets": ["package.json", "CHANGELOG.md"],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }],
+    ["@semantic-release/github", {}],
+  ],
+  branches: ['main'],
+};

package/CHANGELOG.md

@@ -1,3 +1,72 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.2.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.1.0...@adobe/spacecat-shared-tokowaka-client-v1.2.0) (2025-11-27)
+
+
+### Features
+
+* url path-wise edge deployment  ([#1178](https://github.com/adobe/spacecat-shared/issues/1178)) ([37b0d1a](https://github.com/adobe/spacecat-shared/commit/37b0d1a388f842a62cb95eb5272feb49d1dfb3e8))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.1.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.6...@adobe/spacecat-shared-tokowaka-client-v1.1.0) (2025-11-25)
+
+
+### Features
+
+* edge rollback feature for tokowaka ([#1167](https://github.com/adobe/spacecat-shared/issues/1167)) ([b47fd05](https://github.com/adobe/spacecat-shared/commit/b47fd0518ae1fe220914bfd88810383a306775fd))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.0.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.5...@adobe/spacecat-shared-tokowaka-client-v1.0.6) (2025-11-22)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#1162](https://github.com/adobe/spacecat-shared/issues/1162)) ([f0152c5](https://github.com/adobe/spacecat-shared/commit/f0152c5ecddb75b6b3c6e2f0d756d5fb04171dd3))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.0.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.4...@adobe/spacecat-shared-tokowaka-client-v1.0.5) (2025-11-21)
+
+
+### Bug Fixes
+
+* edge preview feature for Tokowaka ([#1124](https://github.com/adobe/spacecat-shared/issues/1124)) ([cd2a06f](https://github.com/adobe/spacecat-shared/commit/cd2a06f62e3ca9e8c2b87e1810d420a06a002526))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.0.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.3...@adobe/spacecat-shared-tokowaka-client-v1.0.4) (2025-11-15)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#1131](https://github.com/adobe/spacecat-shared/issues/1131)) ([d4a3f4a](https://github.com/adobe/spacecat-shared/commit/d4a3f4a653e59e9bdde7926ea8f1a2f9b68739ff))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.0.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.2...@adobe/spacecat-shared-tokowaka-client-v1.0.3) (2025-11-13)
+
+
+### Bug Fixes
+
+* add faq mapper for edge deploy API ([#1083](https://github.com/adobe/spacecat-shared/issues/1083)) ([4c7ff9d](https://github.com/adobe/spacecat-shared/commit/4c7ff9db3312e76fa8965a2d53a699528975f414))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.0.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.1...@adobe/spacecat-shared-tokowaka-client-v1.0.2) (2025-11-08)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#1107](https://github.com/adobe/spacecat-shared/issues/1107)) ([f4cdb50](https://github.com/adobe/spacecat-shared/commit/f4cdb50f96d18dd92de81055f2b58310a68c0cac))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.0.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.0.0...@adobe/spacecat-shared-tokowaka-client-v1.0.1) (2025-11-01)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#1081](https://github.com/adobe/spacecat-shared/issues/1081)) ([4476494](https://github.com/adobe/spacecat-shared/commit/44764944350f9344d0ca5e2af5a2161cc7470899))
+
+# @adobe/spacecat-shared-tokowaka-client-v1.0.0 (2025-10-30)
+
+
+### Bug Fixes
+
+* add releaserc to tokowaka client ([#1071](https://github.com/adobe/spacecat-shared/issues/1071)) ([e49f02c](https://github.com/adobe/spacecat-shared/commit/e49f02ce455868f1035bce4f87553a2b82ad7d68))
+* update publish config for tokowaka client ([#1070](https://github.com/adobe/spacecat-shared/issues/1070)) ([066d5a1](https://github.com/adobe/spacecat-shared/commit/066d5a1c00848323c2828041004c0959ca015890))
+
+
+### Features
+
+* add tokowaka client ([#1025](https://github.com/adobe/spacecat-shared/issues/1025)) ([7af58b0](https://github.com/adobe/spacecat-shared/commit/7af58b03ef341c32b35a6614365024af6a636a56))
+
 # @adobe/spacecat-shared-tokowaka-client
 
 ## 1.0.0 (2025-10-15)
@@ -9,4 +78,3 @@
 * S3 configuration management
 * Extensible mapper pattern for opportunity-specific transformations
 * Built-in support for headings opportunity
-

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Adobe Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at Grp-opensourceoffice@adobe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
+

package/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to Project Franklin
+
+This project (like almost all of Project Franklin) is an Open Development project and welcomes contributions from everyone who finds it useful or lacking.
+
+## Code Of Conduct
+
+This project adheres to the Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to cstaub at adobe dot com.
+
+## Contributor License Agreement
+
+All third-party contributions to this project must be accompanied by a signed contributor license. This gives Adobe permission to redistribute your contributions as part of the project. [Sign our CLA](http://opensource.adobe.com/cla.html)! You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!
+
+## Things to Keep in Mind
+
+This project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.
+
+For other contributors, a maintainer of the project has to approve the pull request.
+
+# Before You Contribute
+
+* Check that there is an existing issue in GitHub issues
+* Check if there are other pull requests that might overlap or conflict with your intended contribution
+
+# How to Contribute
+
+1. Fork the repository
+2. Make some changes on a branch on your fork
+3. Create a pull request from your branch
+
+In your pull request, outline:
+
+* What the changes intend
+* How they change the existing code
+* If (and what) they breaks
+* Start the pull request with the GitHub issue ID, e.g. #123
+
+Lastly, please follow the [pull request template](.github/pull_request_template.md) when submitting a pull request!
+
+Each commit message that is not part of a pull request:
+
+* Should contain the issue ID like `#123`
+* Can contain the tag `[trivial]` for trivial changes that don't relate to an issue
+
+
+
+## Coding Styleguides
+
+We enforce a coding styleguide using `eslint`. As part of your build, run `npm run lint` to check if your code is conforming to the style guide. We do the same for every PR in our CI, so PRs will get rejected if they don't follow the style guide.
+
+You can fix some of the issues automatically by running `npx eslint . --fix`.
+
+## Commit Message Format
+
+This project uses a structured commit changelog format that should be used for every commit. Use `npm run commit` instead of your usual `git commit` to generate commit messages using a wizard.
+
+```bash
+# either add all changed files
+$ git add -A
+# or selectively add files
+$ git add package.json
+# then commit using the wizard
+$ npm run commit
+```
+
+# How Contributions get Reviewed
+
+One of the maintainers will look at the pull request within one week. Feedback on the pull request will be given in writing, in GitHub.
+
+# Release Management
+
+The project's committers will release to the [Adobe organization on npmjs.org](https://www.npmjs.com/org/adobe).
+Please contact the [Adobe Open Source Advisory Board](https://git.corp.adobe.com/OpenSourceAdvisoryBoard/discuss/issues) to get access to the npmjs organization.
+
+The release process is fully automated using `semantic-release`, increasing the version numbers, etc. based on the contents of the commit messages found.

package/README.md

@@ -26,34 +26,76 @@ Creates a client instance from a context object.
 **Required context properties:**
 - `context.s3.s3Client` (S3Client): AWS S3 client instance
 - `context.log` (Object, optional): Logger instance
-- `context.env.TOKOWAKA_SITE_CONFIG_BUCKET` (string): S3 bucket name for configurations
+- `context.env.TOKOWAKA_SITE_CONFIG_BUCKET` (string): S3 bucket name for deployed configurations
+- `context.env.TOKOWAKA_PREVIEW_BUCKET` (string): S3 bucket name for preview configurations
 - `context.env.TOKOWAKA_CDN_PROVIDER` (string): CDN provider for cache invalidation
 - `context.env.TOKOWAKA_CDN_CONFIG` (string): JSON configuration for CDN client
+- `context.env.TOKOWAKA_EDGE_URL` (string): Tokowaka edge URL for preview HTML fetching
 
 ## Environment Variables
 
 **Required:**
-- `TOKOWAKA_SITE_CONFIG_BUCKET` - S3 bucket name for storing configurations
+- `TOKOWAKA_SITE_CONFIG_BUCKET` - S3 bucket name for storing deployed configurations
+- `TOKOWAKA_PREVIEW_BUCKET` - S3 bucket name for storing preview configurations
 
 **Optional (for CDN invalidation):**
 - `TOKOWAKA_CDN_PROVIDER` - CDN provider name (e.g., "cloudfront")
 - `TOKOWAKA_CDN_CONFIG` - JSON string with CDN-specific configuration. (e.g., { "cloudfront": { "distributionId": <distribution-id>, "region": "us-east-1" }})
 
+**Optional (for preview functionality):**
+- `TOKOWAKA_EDGE_URL` - Tokowaka edge URL for fetching HTML content during preview
+
 ### Main Methods
 
 #### `deploySuggestions(site, opportunity, suggestions)`
 
-Generates configuration and uploads to S3. **Automatically fetches existing configuration and merges** new suggestions with it. Invalidates CDN cache after upload.
+Generates configuration and uploads to S3 **per URL**. **Automatically fetches existing configuration for each URL and merges** new suggestions with it. Invalidates CDN cache after upload.
+
+**Architecture Change:** Creates one S3 file per URL instead of a single file with all URLs. This prevents files from growing too large over time.
 
 **Returns:** `Promise<DeploymentResult>` with:
-- `s3Path` - S3 key where config was uploaded
-- `cdnInvalidation` - CDN invalidation result (or error)
+- `s3Paths` - Array of S3 keys where configs were uploaded (one per URL)
+- `cdnInvalidations` - Array of CDN invalidation results (one per URL)
 - `succeededSuggestions` - Array of deployed suggestions
 - `failedSuggestions` - Array of `{suggestion, reason}` objects for ineligible suggestions
 
-#### `fetchConfig(apiKey)`
+#### `rollbackSuggestions(site, opportunity, suggestions)`
+
+Rolls back previously deployed suggestions by removing their patches from the configuration. **Automatically fetches existing configuration for each URL** and removes patches matching the provided suggestions. Invalidates CDN cache after upload.
+
+**Architecture Change:** Updates one S3 file per URL instead of a single file with all URLs.
+
+**Mapper-Specific Rollback Behavior:**
+- Each opportunity mapper handles its own rollback logic via `rollbackPatches()` method
+- **FAQ:** Automatically removes the "FAQs" heading patch if no FAQ suggestions remain for that URL
+- **Headings/Summarization:** Simple removal by suggestion ID (default behavior)
+
+**Returns:** `Promise<RollbackResult>` with:
+- `s3Paths` - Array of S3 keys where configs were uploaded (one per URL)
+- `cdnInvalidations` - Array of CDN invalidation results (one per URL)
+- `succeededSuggestions` - Array of rolled back suggestions
+- `failedSuggestions` - Array of `{suggestion, reason}` objects for ineligible suggestions
+- `removedPatchesCount` - Total number of patches removed across all URLs
+
+#### `previewSuggestions(site, opportunity, suggestions, options)`
 
-Fetches existing Tokowaka configuration from S3.
+Previews suggestions by uploading to preview S3 path and fetching HTML comparison. **All suggestions must belong to the same URL.**
+
+**Returns:** `Promise<PreviewResult>` with:
+- `s3Path` - S3 key where preview config was uploaded
+- `config` - Preview configuration object
+- `cdnInvalidation` - CDN invalidation result
+- `succeededSuggestions` - Array of previewed suggestions
+- `failedSuggestions` - Array of `{suggestion, reason}` objects for ineligible suggestions
+- `html` - Object with `url`, `originalHtml`, and `optimizedHtml`
+
+#### `fetchConfig(url, isPreview)`
+
+Fetches existing Tokowaka configuration from S3 for a specific URL.
+
+**Parameters:**
+- `url` - Full URL (e.g., 'https://www.example.com/products/item')
+- `isPreview` - Whether to fetch from preview path (default: false)
 
 **Returns:** `Promise<TokowakaConfig | null>` - Configuration object or null if not found
 
@@ -63,37 +105,135 @@ Merges existing configuration with new configuration. For each URL path, checks
 
 **Returns:** `TokowakaConfig` - Merged configuration
 
-#### `generateConfig(site, opportunity, suggestions)`
+#### `generateConfig(url, opportunity, suggestions)`
+
+Generates Tokowaka configuration from opportunity suggestions for a specific URL without uploading.
+
+**Parameters:**
+- `url` - Full URL for which to generate config
+- `opportunity` - Opportunity entity
+- `suggestions` - Array of suggestion entities
+
+#### `uploadConfig(url, config, isPreview)`
 
-Generates Tokowaka configuration from opportunity suggestions without uploading.
+Uploads configuration to S3 for a specific URL.
 
-#### `uploadConfig(apiKey, config)`
+**Parameters:**
+- `url` - Full URL (e.g., 'https://www.example.com/products/item')
+- `config` - Tokowaka configuration object
+- `isPreview` - Whether to upload to preview path (default: false)
 
-Uploads configuration to S3. Returns S3 key of uploaded configuration.
+**Returns:** `Promise<string>` - S3 key of uploaded configuration
 
 ## CDN Cache Invalidation
 
 The client invalidates CDN cache after uploading configurations. Failures are logged but don't block deployment.
 
+## Site Configuration
+
+Sites must have the following configuration in their `tokowakaConfig`:
+
+```javascript
+{
+  "tokowakaConfig": {
+    "apiKey": "legacy-key-kept-for-backward-compatibility", // Optional, kept for backward compatibility
+    "forwardedHost": "www.example.com"  // Required for preview functionality
+  }
+}
+```
+
+**Note:** 
+- `apiKey` is optional and **not used** for S3 paths or HTTP headers (kept in schema for potential future use)
+- `forwardedHost` is **required** for preview functionality to fetch HTML from Tokowaka edge
+
 ## Supported Opportunity Types
 
 ### Headings
 
 **Deployment Eligibility:** Only suggestions with `checkType: 'heading-empty'`, `checkType: 'heading-missing-h1'` and `checkType: 'heading-h1-length'` can be deployed currently.
 
+### FAQ
+
+**Deployment Eligibility:** Suggestions must have `shouldOptimize: true` flag and valid FAQ item structure.
+
+**Special Behavior:** Automatically manages heading patch - adds heading when first FAQ is deployed, removes heading when last FAQ is rolled back.
+
 ### Content Summarization
 
-**Deployment Eligibility:**  Currently all suggestions for `summarization` opportunity can be deployed.
+**Deployment Eligibility:** Currently all suggestions for `summarization` opportunity can be deployed.
 
 ## S3 Storage
 
-Configurations are stored at:
+Configurations are now stored **per URL** with domain-level metadata:
+
+### Structure
+```
+s3://{TOKOWAKA_SITE_CONFIG_BUCKET}/opportunities/{normalized-domain}/
+├── config (domain-level metaconfig: siteId, prerender)
+├── {base64-encoded-path-1} (URL-specific patches)
+├── {base64-encoded-path-2} (URL-specific patches)
+└── ...
+```
+
+For preview configurations:
+```
+s3://{TOKOWAKA_PREVIEW_BUCKET}/preview/opportunities/{normalized-domain}/
+├── config
+├── {base64-encoded-path-1}
+└── ...
 ```
-s3://{TOKOWAKA_SITE_CONFIG_BUCKET}/opportunities/{tokowakaApiKey}
+
+**Architecture Change:** Each URL has its own configuration file instead of one file per site. Domain-level metaconfig is stored separately to avoid duplication.
+
+**URL Normalization:**
+- Domain: Strips `www.` prefix (e.g., `www.example.com` → `example.com`)
+- Path: Removes trailing slash (except for root `/`), ensures starts with `/`, then base64 URL encodes
+
+**Example:**
+- URL: `https://www.example.com/products/item`
+- Metaconfig Path: `opportunities/example.com/config`
+- Patch Config Path: `opportunities/example.com/L3Byb2R1Y3RzL2l0ZW0`
+- Where `L3Byb2R1Y3RzL2l0ZW0` is base64 URL encoding of `/products/item`
+
+### Metaconfig File Structure
+Domain-level metaconfig (created once per domain, shared by all URLs):
+```json
+{
+  "siteId": "abc-123",
+  "prerender": true
+}
 ```
 
-**Note:** The configuration is stored as a JSON file containing the complete Tokowaka optimization config for the site.
+### Configuration File Structure
+Per-URL configuration (flat structure):
+```json
+{
+  "url": "https://example.com/products/item",
+  "version": "1.0",
+  "forceFail": false,
+  "prerender": true,
+  "patches": [
+    {
+      "opportunityId": "abc-123",
+      "suggestionId": "xyz-789",
+      "prerenderRequired": true,
+      "lastUpdated": 1234567890,
+      "op": "insertAfter",
+      "selector": "main",
+      "value": { ... },
+      "valueFormat": "hast",
+      "target": "ai-bots"
+    }
+  ]
+}
+```
 
+**Note:** 
+- `siteId` is stored only in domain-level `config` (metaconfig)
+- `prerender` is stored in both metaconfig (domain-level) and patch files (URL-level)
+- The `baseURL` field has been renamed to `url`
+- The `tokowakaOptimizations` nested structure has been removed
+- The `tokowakaForceFail` field has been renamed to `forceFail`
 
 ## Reference Material
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {
@@ -35,10 +35,10 @@
   },
   "dependencies": {
     "@adobe/spacecat-shared-utils": "1.66.1",
-    "@aws-sdk/client-cloudfront": "3.893.0",
-    "@aws-sdk/client-s3": "3.893.0",
+    "@aws-sdk/client-cloudfront": "3.937.0",
+    "@aws-sdk/client-s3": "3.937.0",
     "mdast-util-from-markdown": "2.0.2",
-    "mdast-util-to-hast": "12.1.0"
+    "mdast-util-to-hast": "12.3.0"
   },
   "devDependencies": {
     "aws-sdk-client-mock": "4.1.0",