@adobe/spacecat-shared-project-engine-client 1.1.0

package/LICENSE.txt

@@ -0,0 +1,263 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions
+      of this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+APACHE JACKRABBIT SUBCOMPONENTS
+
+Apache Jackrabbit includes parts with separate copyright notices and license
+terms. Your use of these subcomponents is subject to the terms and conditions
+of the following licenses:
+
+    XPath 2.0/XQuery 1.0 Parser:
+    http://www.w3.org/2002/11/xquery-xpath-applets/xgrammar.zip
+
+    Copyright (C) 2002 World Wide Web Consortium, (Massachusetts Institute of
+    Technology, European Research Consortium for Informatics and Mathematics,
+    Keio University). All Rights Reserved.
+
+    This work is distributed under the W3C(R) Software License in the hope
+    that it will be useful, but WITHOUT ANY WARRANTY; without even the
+    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+    W3C(R) SOFTWARE NOTICE AND LICENSE
+    http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
+
+    This work (and included software, documentation such as READMEs, or
+    other related items) is being provided by the copyright holders under
+    the following license. By obtaining, using and/or copying this work,
+    you (the licensee) agree that you have read, understood, and will comply
+    with the following terms and conditions.
+
+    Permission to copy, modify, and distribute this software and its
+    documentation, with or without modification, for any purpose and
+    without fee or royalty is hereby granted, provided that you include
+    the following on ALL copies of the software and documentation or
+    portions thereof, including modifications:
+
+       1. The full text of this NOTICE in a location viewable to users
+          of the redistributed or derivative work.
+
+       2. Any pre-existing intellectual property disclaimers, notices,
+          or terms and conditions. If none exist, the W3C Software Short
+          Notice should be included (hypertext is preferred, text is
+          permitted) within the body of any redistributed or derivative code.
+
+       3. Notice of any changes or modifications to the files, including
+          the date changes were made. (We recommend you provide URIs to the
+          location from which the code is derived.)
+
+    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
+    HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
+    INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
+    FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
+    DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
+    TRADEMARKS OR OTHER RIGHTS.
+
+    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
+    OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
+    DOCUMENTATION.
+
+    The name and trademarks of copyright holders may NOT be used in
+    advertising or publicity pertaining to the software without specific,
+    written prior permission. Title to copyright in this software and
+    any associated documentation will at all times remain with
+    copyright holders.

package/README.md

@@ -0,0 +1,132 @@
+# @adobe/spacecat-shared-project-engine-client
+
+Typed integration with the Semrush **Project Engine API** (`/enterprise/projects/api`):
+
+- generated **TypeScript** (`src/generated/types.ts`) and **Pydantic v2** (`python/serenity_project_engine/`) types,
+- a thin **Project Engine client** (`openapi-fetch` over the generated `paths`) — IMS Bearer auth + idempotency-aware retries (see [Client](#client)),
+- a generation-time **spec-correction overlay** (`spec/overlays/corrections.yaml`) that aligns the vendored swagger with the live API,
+- a **Counterfact mock** for E2E tests and local dev (`npm run mock`); the stateful mock store lands in a follow-up (LLMO-5460).
+
+> **Not here yet:** the IMS auth-handler move and the stateful mock store are
+> tracked follow-ups (see LLMO-5461 / LLMO-5460).
+
+This package follows the `spacecat-shared` convention: **JS + ESM**, JSDoc-typed source,
+`mocha` + `chai` + `c8` for tests, and `@adobe/eslint-config-helix` for lint. The scaffold's
+TypeScript surface is ported to JS + JSDoc; the generated `types.ts` is a **type artifact only**,
+consumed by the client via JSDoc `import(...)` and by `openapi-fetch` at type-check time.
+
+## Client
+
+```js
+import { createSerenityProjectEngineApiClient } from '@adobe/spacecat-shared-project-engine-client';
+
+const client = createSerenityProjectEngineApiClient({
+  baseUrl: process.env.SEMRUSH_PROJECTS_BASE_URL, // origin only; the prefix is owned by the client
+  authToken: () => getImsToken(),                 // a static token or a (sync/async) per-request getter
+});
+
+const { data, error } = await client.GET('/v1/countries');
+```
+
+- **Auth:** the caller's IMS JWT is forwarded verbatim as `Authorization: Bearer <token>`. The
+  live API authenticates on Bearer directly — Semrush accepts the IMS token and the client mints
+  or exchanges **nothing**. The token source resolves once per request, so the header always
+  reflects the current caller.
+- **Base URL:** the client owns the fixed `/enterprise/projects/api` prefix; you pass only the
+  origin (any path/credentials are stripped). Non-`http(s)` base URLs fail fast at construction.
+- **Retries:** `429` is retried for any method; `5xx`/network errors only for idempotent methods
+  (so a POST is never replayed). Backoff is exponential with jitter, honours `Retry-After`, and is
+  capped at 20s/attempt. Pass `onRetry` to observe the loop.
+- **Shape:** this is a thin factory function rather than the `CLAUDE.md` "class + factory" client
+  pattern — the wrapper has no per-instance state or behaviour beyond what `openapi-fetch` already
+  provides, so a class would add ceremony without value. The typed surface IS the `openapi-fetch`
+  client.
+
+## Spec source
+
+The spec is a **vendored file** — `spec/projectengine_swagger_public.yaml` — kept under
+version control. Semrush only provides the file (no endpoint access in the near term), and
+it's **Swagger 2.0** (no v3/v3.1 on offer). The vendored file is **never edited**; where it
+diverges from the live API, a generation-time overlay corrects the converted artifact instead (see
+[Spec corrections](#spec-corrections)). Refresh is **manual**: drop in the newer file, re-run
+`npm run generate`, and review the diff. There is no automated drift detection while endpoint
+access is restricted.
+
+## Pipeline
+
+```
+spec/projectengine_swagger_public.yaml  (vendored, Swagger 2.0)
+        │
+        ├── Counterfact ── reads v2 directly ──►  mock (no conversion)   [npm run mock]
+        │
+        └── swagger2openapi (v2 → 3.x) ──►  build/openapi3.json
+                                                │
+                                                ├── apply-overlay (corrections) ──► build/openapi3.json (in place)
+                                                │
+                                                ├── openapi-typescript ──► src/generated/types.ts
+                                                └── datamodel-code-generator ──► python/serenity_project_engine/
+```
+
+The v2 → 3.x conversion exists **only** to feed the type generators (`openapi-typescript`
+is v3-only, and 3.x yields cleaner TS/Pydantic); the overlay then corrects that converted
+artifact before the generators run (see [Spec corrections](#spec-corrections)). **Counterfact reads
+the raw v2 file directly**, so the mock path never touches the converted artifact (and so does not
+see the corrections — a known gap the stateful-mock follow-up addresses).
+
+| Command | Does |
+| --- | --- |
+| `npm run spec:convert` | v2 → 3.x via `swagger2openapi --patch` → `build/openapi3.json` |
+| `npm run spec:overlay` | apply `spec/overlays/corrections.yaml` to `build/openapi3.json` in place |
+| `npm run generate:ts` | `openapi-typescript` → `src/generated/types.ts` |
+| `npm run generate:pydantic` | `datamodel-code-generator` → `python/serenity_project_engine/` package |
+| `npm run generate` | all of the above, in order |
+| `npm run mock` | Counterfact mock on `:4010`, straight off the v2 spec |
+
+`datamodel-code-generator` is a **Python** tool, not an npm dependency. Install it once on
+your `PATH` before running `generate:pydantic`:
+
+```bash
+pip install datamodel-code-generator
+```
+
+## Spec corrections
+
+The vendored swagger diverges from the live API in three places. A small OpenAPI Overlay
+(`spec/overlays/corrections.yaml`), applied to the converted OAS3 artifact at generation time by
+`scripts/apply-overlay.mjs`, corrects them; the vendored `spec/projectengine_swagger_public.yaml`
+is never touched.
+
+- **CR1 — missing endpoint.** Adds `GET /v1/ai_models` (the live global model catalog), which is
+  absent from the upstream swagger.
+- **CR2 — auth.** The spec models a required `Auth-Data-Jwt` header, but the live API authenticates
+  on `Authorization: Bearer <IMS>` only — Semrush accepts the IMS bearer directly. The overlay
+  removes `Auth-Data-Jwt` from every operation and adds an `imsBearer` security scheme.
+- **CR3 — drafts.** Corrects the `GET /v2/workspaces/{id}/projects` description: it also returns
+  initial, never-yet-published draft projects, not only published ones.
+
+Guard tests in `test/foundation.test.js` pin CR1 and CR2 against the generated surface, so a future
+Semrush spec refresh that silently drops the overlay fails loudly instead of regressing the
+generated types. `test/overlay.test.js` covers the overlay applier itself.
+
+## Committed vs generated
+
+- **Committed:** the vendored spec (`spec/projectengine_swagger_public.yaml`).
+- **Generated, committed in its own commit** and marked `linguist-generated` (see
+  `.gitattributes`) so it's collapsed in review and excluded from diff counts:
+  `src/generated/**`, `python/serenity_project_engine/**`.
+
+  `datamodel-code-generator` emits a **package** (`model.py`, `aiseo.py`, `http_server.py`,
+  `__init__.py`) rather than a single `models.py`: the vendored spec's Go-style dotted schema
+  names (`model.X`, `aiseo.X`, `http_server.X`) are modular references, which the generator maps
+  to one module per prefix. This is a tool-driven layout choice, not a spec edit.
+- **Gitignored intermediate:** `build/openapi3.json`, `.counterfact/`.
+
+## Notes
+
+- The package is `@adobe/spacecat-shared-*` and lives under the monorepo `packages/` layout.
+- Pydantic v2 is the default target; switch the `--output-model-type` flag in
+  `generate:pydantic` if a consumer needs v1.
+- Known spec-hygiene quirks the tooling surfaces (vendored as-is, not patched): a duplicated
+  parameter block on `GET .../issue_rules`, `id`-in-query-vs-path inconsistencies on some AIO
+  category/tag endpoints, and deprecated `keywords`/`tags` endpoints plus a deprecated v1
+  benchmarks `POST`.

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@adobe/spacecat-shared-project-engine-client",
+  "version": "1.1.0",
+  "description": "Shared modules of the Spacecat Services - Semrush Project Engine client and generated types",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "files": [
+    "src"
+  ],
+  "engines": {
+    "node": ">=22.0.0 <25.0.0",
+    "npm": ">=10.9.0 <12.0.0"
+  },
+  "scripts": {
+    "test": "c8 mocha",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "clean": "rm -rf node_modules build .counterfact",
+    "spec:convert": "mkdir -p build && swagger2openapi spec/projectengine_swagger_public.yaml --patch --outfile build/openapi3.json",
+    "spec:overlay": "node scripts/apply-overlay.mjs",
+    "generate:ts": "openapi-typescript build/openapi3.json --output src/generated/types.ts",
+    "generate:pydantic": "datamodel-codegen --input build/openapi3.json --input-file-type openapi --output python/serenity_project_engine/ --output-model-type pydantic_v2.BaseModel",
+    "generate": "npm run spec:convert && npm run spec:overlay && npm run generate:ts && npm run generate:pydantic",
+    "mock": "counterfact spec/projectengine_swagger_public.yaml .counterfact --port 4010"
+  },
+  "mocha": {
+    "reporter": "mocha-multi-reporters",
+    "reporter-options": "configFile=.mocha-multi.json",
+    "spec": "test/**/*.test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adobe/spacecat-shared.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/adobe/spacecat-shared/issues"
+  },
+  "homepage": "https://github.com/adobe/spacecat-shared/packages/spacecat-shared-project-engine-client/#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "openapi-fetch": "0.17.0"
+  },
+  "devDependencies": {
+    "c8": "11.0.0",
+    "chai": "6.2.2",
+    "counterfact": "2.14.0",
+    "js-yaml": "4.2.0",
+    "mocha": "11.7.6",
+    "mocha-multi-reporters": "1.5.1",
+    "openapi-typescript": "7.13.0",
+    "sinon": "22.0.0",
+    "swagger2openapi": "7.0.8"
+  }
+}

package/src/client.js

@@ -0,0 +1,133 @@
+/*
+ * Copyright 2026 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import createClient from 'openapi-fetch';
+import { createRetryingFetch, toTokenGetter } from './internal.js';
+
+/**
+ * @typedef {import('./internal.js').AuthTokenSource} AuthTokenSource
+ */
+
+/**
+ * A fully-typed Project Engine client (all operations from the generated `paths`).
+ * @typedef {import('openapi-fetch').Client<import('./generated/types.js').paths>}
+ *   SerenityProjectEngineApiClient
+ */
+
+/**
+ * @typedef {object} SerenityProjectEngineApiClientOptions
+ * @property {string} baseUrl Base URL of the Project Engine API — the origin of
+ *   `SEMRUSH_PROJECTS_BASE_URL` (e.g. `https://adobe-hackathon.semrush.com`), or the Counterfact
+ *   mock's origin for E2E / local dev. Only `protocol//host` is used; any path is dropped and the
+ *   client appends the fixed `/enterprise/projects/api` prefix itself, matching the deployed
+ *   api-service transport (`rest-transport.js`).
+ * @property {AuthTokenSource} authToken The caller's IMS JWT, or a (sync/async) getter resolved
+ *   per request. Sent as the `Authorization: Bearer <token>` header. The client performs NO token
+ *   exchange or minting — Semrush accepts the IMS bearer token directly, so the caller's token is
+ *   forwarded as-is.
+ * @property {number} [maxRetries=2] Retry attempts on 429 / retryable 5xx / network error.
+ *   Default 2 (3 tries total).
+ * @property {number} [retryBaseDelayMs=200] Base backoff in ms; grows exponentially per
+ *   attempt. Default 200.
+ * @property {import('./internal.js').OnRetry} [onRetry] Best-effort hook invoked before each
+ *   retry sleep (`{ attempt, delayMs, method, status?, error? }`), for logging/metrics. A retry
+ *   loop is otherwise silent — an operator can't tell "slow upstream" from "stuck in backoff". A
+ *   throwing or rejecting hook is swallowed and never affects the request.
+ * @property {typeof globalThis.fetch} [fetch] Injectable fetch (tests, custom agents).
+ *   Defaults to the global fetch.
+ */
+
+/**
+ * The Project Engine API path prefix — the vendored spec's `basePath`. The generated `paths`
+ * keys are relative to it, so the client owns it here, mirroring the deployed api-service
+ * transport (`rest-transport.js`), which appends this same constant to the env-configured origin.
+ */
+const API_PREFIX = '/enterprise/projects/api';
+
+/**
+ * Normalises the caller's base URL to `<origin>/enterprise/projects/api`, mirroring
+ * `rest-transport.js`: parse, keep only `protocol//host` — dropping any path or credentials so a
+ * misconfigured value can't bleed into every request — then append the fixed prefix. Unlike the
+ * prod-only transport it does NOT force https, since the client also targets the local Counterfact
+ * mock over http.
+ * @param {string} baseUrl
+ * @returns {string}
+ */
+function resolveBaseUrl(baseUrl) {
+  let parsed;
+  try {
+    parsed = new URL(baseUrl);
+  } catch {
+    throw new Error(`Project Engine client: invalid baseUrl ${JSON.stringify(baseUrl)}`);
+  }
+  // Restrict to http(s) so a `file:`/`ftp:`/etc. URL fails fast here with an actionable message
+  // rather than deep inside fetch(). Both schemes are allowed — https for prod, http for the
+  // local Counterfact mock.
+  if (parsed.protocol !== 'https:' && parsed.protocol !== 'http:') {
+    throw new Error(
+      `Project Engine client: baseUrl must be http(s), got ${parsed.protocol} in ${JSON.stringify(baseUrl)}`,
+    );
+  }
+  return `${parsed.protocol}//${parsed.host}${API_PREFIX}`;
+}
+
+/**
+ * Builds the openapi-fetch middleware that authenticates each request with the caller's IMS token
+ * as `Authorization: Bearer <token>` — the auth model proven by the deployed api-service transport
+ * (`rest-transport.js`). Semrush accepts the IMS bearer directly; the client mints/exchanges
+ * nothing.
+ * @param {() => string | Promise<string>} getToken
+ * @returns {import('openapi-fetch').Middleware}
+ */
+function authMiddleware(getToken) {
+  return {
+    async onRequest({ request }) {
+      const token = await getToken();
+      // Fail fast on a missing token rather than sending `Bearer undefined` (or an empty header),
+      // which Semrush would reject with an opaque 401.
+      if (!token) {
+        throw new Error('Project Engine client: authToken resolved to an empty value');
+      }
+      request.headers.set('Authorization', `Bearer ${token}`);
+      return request;
+    },
+  };
+}
+
+/**
+ * Creates a thin, typed client over the generated Project Engine `paths`. It owns the base
+ * URL (origin + `/enterprise/projects/api`), retries, and authenticating each request with the
+ * caller's IMS JWT as `Authorization: Bearer` — and nothing else; request/response shapes come
+ * straight from the generated types.
+ * @param {SerenityProjectEngineApiClientOptions} options
+ * @returns {SerenityProjectEngineApiClient}
+ */
+export function createSerenityProjectEngineApiClient(options) {
+  const {
+    baseUrl,
+    authToken,
+    maxRetries = 2,
+    retryBaseDelayMs = 200,
+    onRetry,
+    fetch: injectedFetch = globalThis.fetch,
+  } = options;
+
+  const client = createClient({
+    baseUrl: resolveBaseUrl(baseUrl),
+    fetch: createRetryingFetch(injectedFetch, maxRetries, retryBaseDelayMs, onRetry),
+  });
+  // Auth runs as openapi-fetch middleware, so the token getter resolves once per logical request
+  // and that token is reused across the request's retries (the retry layer clones the same Request
+  // — see createRetryingFetch). toTokenGetter() rejects a non-string/function authToken up front.
+  client.use(authMiddleware(toTokenGetter(authToken)));
+  return client;
+}