@adobe/spacecat-shared-project-engine-client 1.10.0 → 1.11.0

package/README.md

@@ -46,8 +46,18 @@ version control. Semrush only provides the file (no endpoint access in the near
 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.
+`npm run generate`, and review the diff. A committed checksum lock
+(`spec/projectengine_swagger_public.yaml.sha256`) is verified by `npm run spec:verify` (wired into
+`pretest`, so CI enforces it): any re-vendor of the spec fails the build until the hash is
+explicitly regenerated with `npm run spec:lock` and reviewed. A true live-drift contract test
+against Semrush remains blocked on endpoint access.
+
+Both scripts use a **package-root-relative** path and assume the working directory is this
+package root — always invoke them via `npm run spec:verify` / `npm run spec:lock`, which npm
+runs from the package root, rather than calling `shasum -c` by hand from the monorepo root or a
+subdirectory (that yields a confusing "no such file" error). They also assume `shasum` (Perl,
+present on macOS and the `ubuntu-latest` CI runner); minimal images such as Alpine ship
+`sha256sum` instead and would need the scripts adjusted.
 
 ## Pipeline
 
@@ -144,6 +154,7 @@ Stateful endpoints (backed by the store):
 | `POST /v2/workspaces/{id}/projects/{project_id}/aio/prompts/tagged` | create prompts grouped by tag name |
 | `POST /v2/workspaces/{id}/projects/{project_id}/aio/prompts/by_tags` | list prompts (empty `tag_ids` lists all; otherwise OR-filter) |
 | `DELETE /v2/workspaces/{id}/projects/{project_id}/aio/prompts` | batch-delete prompts by id |
+| `POST /v2/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/rename` | in-place text edit (id stable; `409` on a sibling-text collision; `is_updated` mirrors the live layer) |
 
 ### Test control routes (not part of the Project Engine API)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-project-engine-client",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Shared modules of the Spacecat Services - Semrush Project Engine client and generated types",
   "type": "module",
   "main": "src/index.js",
@@ -20,12 +20,15 @@
     "npm": ">=10.9.0 <12.0.0"
   },
   "scripts": {
+    "pretest": "npm run spec:verify",
     "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",
+    "spec:verify": "shasum -a 256 -c spec/projectengine_swagger_public.yaml.sha256",
+    "spec:lock": "shasum -a 256 spec/projectengine_swagger_public.yaml > spec/projectengine_swagger_public.yaml.sha256",
     "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",

package/src/generated/types.ts

@@ -2289,7 +2289,7 @@ export interface components {
             replace?: boolean;
         };
         "model.RenamePromptRequest": {
-            new_name?: string;
+            new_name?: string | null;
         };
         "model.RenamePromptResponse": {
             id?: string;
@@ -7723,6 +7723,15 @@ export interface operations {
                     "application/json": components["schemas"]["http_server.BasicResponse"];
                 };
             };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
             /** @description Internal Server Error */
             500: {
                 headers: {