@adobe/spacecat-shared-project-engine-client 1.15.0 → 1.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-project-engine-client",
-  "version": "1.15.0",
+  "version": "1.17.0",
   "description": "Shared modules of the Spacecat Services - Semrush Project Engine client and generated types",
   "type": "module",
   "main": "src/index.js",
@@ -63,7 +63,7 @@
     "c8": "11.0.0",
     "chai": "6.2.2",
     "counterfact": "2.14.0",
-    "js-yaml": "4.2.0",
+    "js-yaml": "4.3.0",
     "mocha": "11.7.6",
     "mocha-multi-reporters": "1.5.1",
     "openapi-typescript": "7.13.0",

package/src/generated/types.ts

@@ -1623,6 +1623,106 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v3/workspaces/{id}/projects/{project_id}/aio/prompts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create prompts
+         * @description Create prompts. Response returns per-item `{id, name, is_new, metadata}`. Dedupe hits preserve the previously stored metadata and report `is_new = false`.
+         */
+        post: operations["aio-create-prompts"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update a single prompt
+         * @description RFC 7396 JSON Merge Patch. Both `name` and `metadata` are optional; the request must include at least one. `name: null` is rejected (400). `metadata: null` wipes the entire metadata block (row.metadata → NULL). `metadata: {...}` applies an RFC 7396 merge to the four metadata keys (absent = keep, string = set, null = delete). When a merge removes the last surviving metadata key, the row's metadata collapses to `null`.
+         */
+        patch: operations["aio-patch-prompt"];
+        trace?: never;
+    };
+    "/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/metadata": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update single prompt metadata (merge)
+         * @description RFC 7396 JSON Merge Patch for a single prompt: string values set/overwrite the stored key, absent keys keep the stored value, explicit JSON `null` deletes the key. When a patch removes the last surviving key, the row's metadata collapses to `null`. Thin adapter over the batch service method.
+         */
+        patch: operations["aio-patch-prompt-metadata"];
+        trace?: never;
+    };
+    "/v3/workspaces/{id}/projects/{project_id}/aio/prompts/metadata": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Batch update prompt metadata (merge)
+         * @description RFC 7396 JSON Merge Patch: for each item, string values set/overwrite the stored key, absent keys keep the stored value, and explicit JSON `null` deletes the key from stored metadata. When a patch removes the last surviving key, the row's metadata collapses to `null`. The whole batch runs in one transaction — a CHECK-constraint violation on any item rolls the batch back and returns 400.
+         */
+        patch: operations["aio-patch-prompts-metadata-batch"];
+        trace?: never;
+    };
+    "/v3/workspaces/{id}/projects/{project_id}/aio/prompts/tagged": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create tagged AIO prompts
+         * @description Create prompts with per-item tags and metadata. Response returns per-item `{id, name, is_new, metadata}`.
+         */
+        post: operations["aio-create-tagged-prompts"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ai_models": {
         parameters: {
             query?: never;
@@ -1722,11 +1822,38 @@ export interface components {
         "model.AIOProjectInitializedResponse": {
             initialized?: boolean;
         };
+        "model.AIOPromptCreateItem": {
+            metadata?: components["schemas"]["model.AIOPromptMetadata"];
+            name: string;
+        };
+        "model.AIOPromptCreateResult": {
+            id: string;
+            is_new: boolean;
+            metadata?: components["schemas"]["model.AIOPromptMetadata"];
+            name: string;
+        };
+        "model.AIOPromptCreateWithMetadataResponse": {
+            existing_count?: number;
+            items?: components["schemas"]["model.AIOPromptCreateResult"][];
+        };
+        "model.AIOPromptMetadata": {
+            created_at?: string;
+            created_by?: string;
+            updated_at?: string;
+            updated_by?: string;
+        };
+        "model.AIOPromptMetadataPatch": {
+            created_at?: string | null;
+            created_by?: string | null;
+            updated_at?: string | null;
+            updated_by?: string | null;
+        };
         "model.AIOPromptWithStatus": {
             id: string;
             is_new?: boolean;
+            metadata?: components["schemas"]["model.AIOPromptMetadata"];
             name: string;
-            tags: components["schemas"]["model.AIOTag"][];
+            tags?: components["schemas"]["model.AIOTag"][];
         };
         "model.AIOPromptsListRequest": {
             limit?: number;
@@ -2035,9 +2162,16 @@ export interface components {
         "model.CreateAIOProductsResponse": {
             products?: components["schemas"]["model.AIOProductEntity"][];
         };
+        "model.CreateAIOPromptsRequest": {
+            items: components["schemas"]["model.AIOPromptCreateItem"][];
+            tag_ids?: string[];
+        };
         "model.CreateProjectAIModelRequest": {
             model_id: string;
         };
+        "model.CreateTaggedAIOPromptsRequest": {
+            prompts: components["schemas"]["model.TaggedAIOPromptCreateItem"][];
+        };
         "model.CustomExtractionRequest": {
             additional_info?: string;
             id?: string;
@@ -2170,6 +2304,17 @@ export interface components {
                 [key: string]: boolean;
             };
         };
+        "model.PatchAIOPromptRequest": {
+            metadata?: null | components["schemas"]["model.AIOPromptMetadataPatch"];
+            name?: string;
+        };
+        "model.PatchAIOPromptsBatchItem": {
+            metadata: components["schemas"]["model.AIOPromptMetadataPatch"];
+            prompt_id: string;
+        };
+        "model.PatchAIOPromptsBatchRequest": {
+            items: components["schemas"]["model.PatchAIOPromptsBatchItem"][];
+        };
         "model.ProjectAIModelListResponse": {
             items?: components["schemas"]["model.ProjectAIModelResponse"][];
             page?: number;
@@ -2378,6 +2523,11 @@ export interface components {
             total?: number;
             existing_count?: number;
         };
+        "model.TaggedAIOPromptCreateItem": {
+            metadata?: components["schemas"]["model.AIOPromptMetadata"];
+            name: string;
+            tags?: string[];
+        };
         "model.TreeNodeListRequest": {
             names: string[];
             parent_id?: string;
@@ -7798,6 +7948,8 @@ export interface operations {
             query?: {
                 /** @description Get draft project data */
                 draft?: boolean;
+                /** @description Include prompt metadata into response */
+                include_metadata?: boolean;
             };
             header?: never;
             path: {
@@ -8567,6 +8719,370 @@ export interface operations {
             };
         };
     };
+    "aio-create-prompts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Workspace UUID */
+                id: string;
+                /** @description Project UUID */
+                project_id: string;
+            };
+            cookie?: never;
+        };
+        /** @description Prompt items with optional metadata + optional shared tag_ids */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["model.CreateAIOPromptsRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["model.AIOPromptCreateWithMetadataResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+        };
+    };
+    "aio-patch-prompt": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Workspace UUID */
+                id: string;
+                /** @description Project UUID */
+                project_id: string;
+                /** @description Prompt UUID */
+                prompt_id: string;
+            };
+            cookie?: never;
+        };
+        /** @description Optional name and/or metadata merge patch */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["model.PatchAIOPromptRequest"];
+            };
+        };
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "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: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+        };
+    };
+    "aio-patch-prompt-metadata": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Workspace UUID */
+                id: string;
+                /** @description Project UUID */
+                project_id: string;
+                /** @description Prompt UUID */
+                prompt_id: string;
+            };
+            cookie?: never;
+        };
+        /** @description Metadata merge patch */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["model.AIOPromptMetadataPatch"];
+            };
+        };
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+        };
+    };
+    "aio-patch-prompts-metadata-batch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Workspace UUID */
+                id: string;
+                /** @description Project UUID */
+                project_id: string;
+            };
+            cookie?: never;
+        };
+        /** @description Batch of {prompt_id, metadata} patches */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["model.PatchAIOPromptsBatchRequest"];
+            };
+        };
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+        };
+    };
+    "aio-create-tagged-prompts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Workspace UUID */
+                id: string;
+                /** @description Project UUID */
+                project_id: string;
+            };
+            cookie?: never;
+        };
+        /** @description Prompts with per-item tags and metadata */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["model.CreateTaggedAIOPromptsRequest"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["model.AIOPromptCreateWithMetadataResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["http_server.BasicResponse"];
+                };
+            };
+        };
+    };
     "ai-list-global-models": {
         parameters: {
             query?: {

package/src/index.d.ts

@@ -111,7 +111,7 @@ type TransportData<P extends keyof paths, M extends keyof paths[P]> =
   | null;
 
 /**
- * Intent-named facade over {@link SerenityProjectEngineApiClient}. Wraps the 28 in-spec
+ * Intent-named facade over {@link SerenityProjectEngineApiClient}. Wraps the 32 in-spec
  * Project Engine operations spacecat-api-service consumes behind verb+resource methods, so
  * consumers depend on this seam rather than the raw client's literal path strings. Each method
  * is THIN: it forwards the caller's openapi-fetch `init` to the underlying client and resolves
@@ -324,6 +324,46 @@ export interface SerenityProjectEngineTransport {
   ): Promise<
     TransportData<'/v2/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/rename', 'post'>
   >;
+  /**
+   * POST /v3/workspaces/{id}/projects/{project_id}/aio/prompts — aio-create-prompts
+   * (metadata-carrying create, LLMO-6289)
+   */
+  createPromptsWithMetadata(
+    ...init: TransportInitParam<
+      TransportInit<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts', 'post'>
+    >
+  ): Promise<TransportData<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts', 'post'>>;
+  /**
+   * PATCH /v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}
+   * — aio-patch-prompt (combined name + metadata merge-patch, LLMO-6289)
+   */
+  patchPrompt(
+    ...init: TransportInitParam<
+      TransportInit<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}', 'patch'>
+    >
+  ): Promise<
+    TransportData<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}', 'patch'>
+  >;
+  /**
+   * PATCH /v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/metadata
+   * — aio-patch-prompt-metadata (metadata-only merge-patch, LLMO-6289)
+   */
+  patchPromptMetadata(
+    ...init: TransportInitParam<
+      TransportInit<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/metadata', 'patch'>
+    >
+  ): Promise<
+    TransportData<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/metadata', 'patch'>
+  >;
+  /**
+   * PATCH /v3/workspaces/{id}/projects/{project_id}/aio/prompts/metadata
+   * — aio-patch-prompts-metadata-batch (atomic batch metadata merge-patch, LLMO-6289)
+   */
+  patchPromptsMetadataBatch(
+    ...init: TransportInitParam<
+      TransportInit<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts/metadata', 'patch'>
+    >
+  ): Promise<TransportData<'/v3/workspaces/{id}/projects/{project_id}/aio/prompts/metadata', 'patch'>>;
   /** GET /v2/workspaces/{id}/projects/{project_id}/aio/tags — aio-get-project-tags */
   listProjectTags(
     ...init: TransportInitParam<

package/src/rest-transport.js

@@ -22,7 +22,7 @@ import { ProjectEngineApiError } from './errors.js';
 
 /**
  * Intent-named facade over the raw {@link createSerenityProjectEngineApiClient} openapi-fetch
- * client. It wraps ONLY the 28 in-spec Project Engine operations that spacecat-api-service
+ * client. It wraps ONLY the 32 in-spec Project Engine operations that spacecat-api-service
  * consumes, behind verb+resource method names, so consumers depend on this seam rather than the
  * raw client and its literal path strings. Each method is THIN: it forwards the caller's
  * openapi-fetch `init` (params.path/query, body) to `client.<METHOD>('<literal path>', init)` and
@@ -222,6 +222,34 @@ export function createSerenityProjectEngineTransport(options) {
     renamePrompt(init) {
       return unwrap('POST', client.POST('/v2/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/rename', init));
     },
+    /**
+     * POST /v3/workspaces/{id}/projects/{project_id}/aio/prompts — aio-create-prompts
+     * (metadata-carrying create; each item is `{ name, metadata }`, LLMO-6289)
+     */
+    createPromptsWithMetadata(init) {
+      return unwrap('POST', client.POST('/v3/workspaces/{id}/projects/{project_id}/aio/prompts', init));
+    },
+    /**
+     * PATCH /v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}
+     * — aio-patch-prompt (combined name + metadata merge-patch, RFC 7396, LLMO-6289)
+     */
+    patchPrompt(init) {
+      return unwrap('PATCH', client.PATCH('/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}', init));
+    },
+    /**
+     * PATCH /v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/metadata
+     * — aio-patch-prompt-metadata (metadata-only merge-patch, RFC 7396, LLMO-6289)
+     */
+    patchPromptMetadata(init) {
+      return unwrap('PATCH', client.PATCH('/v3/workspaces/{id}/projects/{project_id}/aio/prompts/{prompt_id}/metadata', init));
+    },
+    /**
+     * PATCH /v3/workspaces/{id}/projects/{project_id}/aio/prompts/metadata
+     * — aio-patch-prompts-metadata-batch (atomic batch metadata merge-patch, LLMO-6289)
+     */
+    patchPromptsMetadataBatch(init) {
+      return unwrap('PATCH', client.PATCH('/v3/workspaces/{id}/projects/{project_id}/aio/prompts/metadata', init));
+    },
     /** GET /v2/workspaces/{id}/projects/{project_id}/aio/tags — aio-get-project-tags */
     listProjectTags(init) {
       return unwrap('GET', client.GET('/v2/workspaces/{id}/projects/{project_id}/aio/tags', init));