@pushwoosh/rpc-gateway-ai-assistant 0.1.113 → 0.1.115

package/index.d.ts

@@ -1,7 +1,7 @@
-import { BuilderService as pushwoosh_aibuilder_v1_BuilderService } from './pushwoosh_aibuilder_v1';
+import { AiGenService as pushwoosh_aigen_v1_AiGenService } from './pushwoosh_aigen_v1';
 import { AssistantService as pushwoosh_accounts_assistant_v1_AssistantService } from './pushwoosh_accounts_assistant_v1';
 export type API = {
-    builder: pushwoosh_aibuilder_v1_BuilderService;
+    aiGen: pushwoosh_aigen_v1_AiGenService;
     assistant: pushwoosh_accounts_assistant_v1_AssistantService;
 };
 export { data } from './data';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-ai-assistant",
-    "version": "0.1.113",
+    "version": "0.1.115",
     "description": "AI Assistant api gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_aibuilder_v1.d.ts

@@ -1,196 +1,3 @@
-import { RpcMethod } from './commonTypes';
-export type BuilderService_GenerateDescription = RpcMethod<BuilderGenerateDescriptionRequest, BuilderGenerateDescriptionResponse>;
-export interface BuilderService {
-    Create(request: BuilderCreateRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<AsyncIterable<BuilderCreateStreamEvent>>;
-    Update(request: BuilderUpdateRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<AsyncIterable<BuilderUpdateEvent>>;
-    GenerateBlock(request: BuilderGenerateBlockRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<AsyncIterable<BuilderCreateStreamEvent>>;
-    GenerateDescription: BuilderService_GenerateDescription;
-}
-export type BuilderDescriptionField = 'BUILDER_DESCRIPTION_FIELD_UNSPECIFIED' | 'BUILDER_DESCRIPTION_FIELD_TEMPLATE_NAME' | 'BUILDER_DESCRIPTION_FIELD_SUBJECT' | 'BUILDER_DESCRIPTION_FIELD_PREHEADER';
-export type BuilderGenerateDescriptionRequest = {
-    document: AiBuilderDocument;
-    field: BuilderDescriptionField;
-    application: string;
-    textModel: LLMProvider;
-};
-export type BuilderGenerateDescriptionResponse = {
-    text: string;
-};
-export type LLMProvider = 'LLM_PROVIDER_UNSPECIFIED' | 'LLM_PROVIDER_QWEN' | 'LLM_PROVIDER_GEMINI';
-export type BuilderCreateRequest = {
-    prompt: string;
-    application: string;
-    structureModel: LLMProvider;
-    textModel: LLMProvider;
-    generateImages: boolean;
-    settings: DocumentSettings;
-    textVariants: Record<string, TextVariantStyle>;
-    colorScheme: Record<string, ColorSchemeItem>;
-};
-export type BuilderUpdateRequest = {
-    document: AiBuilderDocument;
-    prompt: string;
-    blockId?: string;
-    application: string;
-    textVariants: Record<string, TextVariantStyle>;
-    colorScheme: Record<string, ColorSchemeItem>;
-    model: LLMProvider;
-};
-export type BuilderGenerateBlockRequest = {
-    prompt: string;
-    application: string;
-    blockType: DocumentBlockType;
-    document: AiBuilderDocument;
-    prevBlockId: string;
-    generateImages: boolean;
-    blockId: string;
-    structureModel: LLMProvider;
-    textModel: LLMProvider;
-};
-export type BuilderDoneEvent = {
-    summary: string;
-};
-export type BuilderUpdateEvent_event_updateBlock = {
-    type: 'updateBlock';
-    data: BuilderCreateDocumentBlock;
-};
-export type BuilderUpdateEvent_event_deleteBlock = {
-    type: 'deleteBlock';
-    data: string;
-};
-export type BuilderUpdateEvent_event_done = {
-    type: 'done';
-    data: BuilderDoneEvent;
-};
-export type BuilderUpdateEvent_event_error = {
-    type: 'error';
-    data: string;
-};
-export type BuilderUpdateEvent_event_updateSettings = {
-    type: 'updateSettings';
-    data: DocumentSettings;
-};
-export type BuilderUpdateEvent_event = BuilderUpdateEvent_event_updateBlock | BuilderUpdateEvent_event_deleteBlock | BuilderUpdateEvent_event_done | BuilderUpdateEvent_event_error | BuilderUpdateEvent_event_updateSettings;
-export type BuilderUpdateEvent = {
-    event: BuilderUpdateEvent_event;
-};
-export type BuilderCreateColorSettings = {
-    backgroundColor: string;
-    textColor: string;
-};
-export type BuilderCreateBlockColors = {
-    backgroundColor: string;
-    borderColor: string;
-};
-export type BuilderCreateDocument = {
-    blocks: BuilderCreateDocumentBlock[];
-    settings: BuilderCreateColorSettings;
-    textVariants: Record<string, TextVariantStyle>;
-    colorScheme: Record<string, ColorSchemeItem>;
-    emailMeta: EmailMeta;
-};
-export type BuilderCreateDocumentBlock_block_card = {
-    type: 'card';
-    data: BuilderCreateCard;
-};
-export type BuilderCreateDocumentBlock_block_columns = {
-    type: 'columns';
-    data: BuilderCreateColumns;
-};
-export type BuilderCreateDocumentBlock_block = BuilderCreateDocumentBlock_block_card | BuilderCreateDocumentBlock_block_columns;
-export type BuilderCreateDocumentBlock = {
-    id: string;
-    styles?: BuilderCreateBlockColors;
-    block: BuilderCreateDocumentBlock_block;
-};
-export type BuilderCreateCard = {
-    layout: CardLayout;
-    image?: Image;
-    content: Content;
-    /** Mirrors AiBuilderCard.image_fit for the streamed Create/Update output. */
-    imageFit: CardImageFit;
-    /** Mirrors AiBuilderCard.accent_fit; only meaningful for LEFT / RIGHT layouts. */
-    accentFit: boolean;
-};
-export type BuilderCreateColumns = {
-    withImages: boolean;
-    columns: BuilderCreateColumn[];
-    /** Content rendered above the columns row. */
-    contentBefore?: Content;
-    /** Content rendered below the columns row. */
-    contentAfter?: Content;
-};
-export type BuilderCreateColumn = {
-    image?: Image;
-    content: Content;
-    width?: string;
-};
-export type BuilderCreateStreamEvent_event_structure = {
-    type: 'structure';
-    data: BuilderCreateDocument;
-};
-export type BuilderCreateStreamEvent_event_textDelta = {
-    type: 'textDelta';
-    data: BuilderCreateTextDelta;
-};
-export type BuilderCreateStreamEvent_event_imageDelta = {
-    type: 'imageDelta';
-    data: BuilderCreateImageDelta;
-};
-export type BuilderCreateStreamEvent_event_done = {
-    type: 'done';
-    data: BuilderDoneEvent;
-};
-export type BuilderCreateStreamEvent_event_error = {
-    type: 'error';
-    data: string;
-};
-export type BuilderCreateStreamEvent_event_progress = {
-    type: 'progress';
-    data: string;
-};
-export type BuilderCreateStreamEvent_event_buttonGroupDelta = {
-    type: 'buttonGroupDelta';
-    data: BuilderCreateButtonGroupDelta;
-};
-export type BuilderCreateStreamEvent_event_contentError = {
-    type: 'contentError';
-    data: BuilderContentError;
-};
-export type BuilderCreateStreamEvent_event = BuilderCreateStreamEvent_event_structure | BuilderCreateStreamEvent_event_textDelta | BuilderCreateStreamEvent_event_imageDelta | BuilderCreateStreamEvent_event_done | BuilderCreateStreamEvent_event_error | BuilderCreateStreamEvent_event_progress | BuilderCreateStreamEvent_event_buttonGroupDelta | BuilderCreateStreamEvent_event_contentError;
-export type BuilderCreateStreamEvent = {
-    event: BuilderCreateStreamEvent_event;
-};
-export type BuilderContentError = {
-    blockId: string;
-    field: string;
-    error: string;
-};
-export type BuilderCreateTextDelta = {
-    blockId: string;
-    field: string;
-    textBlock: TextBlock;
-};
-export type BuilderCreateImageDelta = {
-    blockId: string;
-    field: string;
-    src: string;
-    alt: string;
-    width: number;
-    height: number;
-    mediaUuid: string;
-};
-export type BuilderCreateButtonGroupDelta = {
-    blockId: string;
-    field: string;
-    buttonGroup: ButtonGroup;
-};
 export type DocumentBlockType = 'DOCUMENT_BLOCK_TYPE_UNSPECIFIED' | 'DOCUMENT_BLOCK_TYPE_CARD' | 'DOCUMENT_BLOCK_TYPE_COLUMNS';
 export type CardLayout = 'CARD_LAYOUT_UNSPECIFIED' | 'CARD_LAYOUT_RIGHT' | 'CARD_LAYOUT_LEFT' | 'CARD_LAYOUT_TOP' | 'CARD_LAYOUT_NO' | 'CARD_LAYOUT_BACKGROUND';
 export type ButtonGroupAlign = 'BUTTON_GROUP_ALIGN_UNSPECIFIED' | 'BUTTON_GROUP_ALIGN_LEFT' | 'BUTTON_GROUP_ALIGN_CENTER' | 'BUTTON_GROUP_ALIGN_RIGHT';
@@ -395,9 +202,21 @@ export type AiBuilderBlock = {
 export type EmailMeta = {
     subject: string;
     preheader: string;
+    templateName: string;
 };
-export type AiBuilderDocument = {
+/**
+ * AiBuilderPage groups a list of blocks under a single logical page. For
+ * now every document has exactly one page; the structure is in place so
+ * multi-page documents (landing pages with several screens, email digests
+ * with tabs, etc.) can be added without a further schema break.
+ */
+export type AiBuilderPage = {
+    id: string;
     blocks: AiBuilderBlock[];
+};
+export type AiBuilderDocument = {
+    /** MVP: always one page. Consumers may assume pages[0] exists. */
+    pages: AiBuilderPage[];
     settings: DocumentSettings;
     textVariants: Record<string, TextVariantStyle>;
     colorScheme: Record<string, ColorSchemeItem>;

package/pushwoosh_aigen_v1.d.ts

@@ -0,0 +1,256 @@
+import { AiBuilderDocument as pushwoosh_aibuilder_v1_AiBuilderDocument } from './pushwoosh_aibuilder_v1';
+import { DocumentSettings as pushwoosh_aibuilder_v1_DocumentSettings } from './pushwoosh_aibuilder_v1';
+import { TextVariantStyle as pushwoosh_aibuilder_v1_TextVariantStyle } from './pushwoosh_aibuilder_v1';
+import { ColorSchemeItem as pushwoosh_aibuilder_v1_ColorSchemeItem } from './pushwoosh_aibuilder_v1';
+import { CardLayout as pushwoosh_aibuilder_v1_CardLayout } from './pushwoosh_aibuilder_v1';
+import { Image as pushwoosh_aibuilder_v1_Image } from './pushwoosh_aibuilder_v1';
+import { Content as pushwoosh_aibuilder_v1_Content } from './pushwoosh_aibuilder_v1';
+import { CardImageFit as pushwoosh_aibuilder_v1_CardImageFit } from './pushwoosh_aibuilder_v1';
+/**
+ * AiGenService unifies document create / edit / per-block regeneration and
+ * targeted block insertion into a single streaming RPC. Dispatch rules:
+ * - document empty                       → create a new document
+ * - document set                         → edit existing document (diff planner)
+ * - document set + block_path            → regenerate only that block; planner
+ * skipped, structure_diff NOT emitted
+ * - document set + add_block             → insert one new block at a given
+ * position; planner skipped, a
+ * single-entry structure_diff is
+ * synthesised so the client applies
+ * it like any other edit
+ * block_path and add_block are mutually exclusive.
+ *
+ * Addressing: every block reference on the wire is a path of ids. For MVP
+ * single-page documents the path is always `[page_id, block_id]`. The path
+ * form is in place so multi-page documents (email digests with tabs,
+ * multi-screen landing pages) can be addressed deeper without a further
+ * schema break.
+ */
+export interface AiGenService {
+    Generate(request: AiGenRequest, options?: {
+        signal?: AbortSignal;
+    }): Promise<AsyncIterable<AiGenEvent>>;
+}
+export type AiGenBlockTypeHint = 'AI_GEN_BLOCK_TYPE_HINT_UNSPECIFIED' | 'AI_GEN_BLOCK_TYPE_HINT_CARD' | 'AI_GEN_BLOCK_TYPE_HINT_COLUMNS';
+/**
+ * AiGenBlockPath wraps a block-addressing path so it can appear inside
+ * repeated fields — proto3 disallows `repeated repeated`. Path is
+ * `[page_id, block_id]` for MVP; additional segments may appear when
+ * multi-page or nested containers land.
+ */
+export type AiGenBlockPath = {
+    path: string[];
+};
+export type AiGenRequest = {
+    prompt: string;
+    /** Empty → create a new document. Set → edit. */
+    document?: pushwoosh_aibuilder_v1_AiBuilderDocument;
+    /**
+     * Bypass mode: path `[page_id, block_id]` of the block to regenerate.
+     * Requires `document`. Mutually exclusive with `add_block`. Empty =
+     * no bypass.
+     */
+    blockPath: string[];
+    application: string;
+    generateImages: boolean;
+    /** Used on create; in edit taken from document. */
+    settings?: pushwoosh_aibuilder_v1_DocumentSettings;
+    textVariants: Record<string, pushwoosh_aibuilder_v1_TextVariantStyle>;
+    colorScheme: Record<string, pushwoosh_aibuilder_v1_ColorSchemeItem>;
+    /**
+     * Set → add-block mode: insert a single new block into `document` at a
+     * client-specified position, skipping the planner. Mutually exclusive
+     * with `block_path`. Requires `document`.
+     */
+    addBlock?: AiGenAddBlock;
+};
+/**
+ * AiGenAddBlock triggers add-block mode on Generate. The server emits a
+ * single-entry structure_diff echoing these fields so the UI can match an
+ * optimistically-rendered placeholder, followed by the block_delta and any
+ * image_deltas for the new block.
+ */
+export type AiGenAddBlock = {
+    /**
+     * Client-provided path for the new block: `[page_id, new_block_id]`.
+     * `page_id` must reference an existing page in `document`; the new
+     * block_id must not collide with any existing block id in that page.
+     */
+    blockPath: string[];
+    /**
+     * Path of the block this one should be inserted after:
+     * `[page_id, existing_block_id]`. Must share `page_id` with
+     * `block_path`. Empty = insert at the beginning of the page referenced
+     * by `block_path[0]`.
+     */
+    afterPath: string[];
+    /**
+     * Optional. UNSPECIFIED = the block generator decides card vs columns
+     * based on the prompt and surrounding blocks.
+     */
+    typeHint: AiGenBlockTypeHint;
+};
+export type AiGenStructureBlock = {
+    /** [page_id, block_id] */
+    blockPath: string[];
+    typeHint: AiGenBlockTypeHint;
+    /** per-block prompt for the block generator */
+    prompt: string;
+};
+/** Emitted once for create, before any block_delta. */
+export type AiGenStructure = {
+    blocks: AiGenStructureBlock[];
+};
+export type AiGenStructureAdd = {
+    /** [page_id, new_block_id] — disjoint from existing ids in that page */
+    blockPath: string[];
+    typeHint: AiGenBlockTypeHint;
+    prompt: string;
+    /**
+     * Path of the block this one should be inserted after. Empty → insert
+     * at the beginning of the page referenced by `block_path[0]`. May
+     * reference an existing block path or another add.block_path from the
+     * same diff (must share `page_id`).
+     */
+    afterPath: string[];
+};
+export type AiGenStructureReplace = {
+    /** existing block path, preserved */
+    blockPath: string[];
+    typeHint: AiGenBlockTypeHint;
+    prompt: string;
+};
+/**
+ * Emitted once for edit (when the planner ran), before any block_delta.
+ * Not emitted on the block_path bypass path.
+ */
+export type AiGenStructureDiff = {
+    add: AiGenStructureAdd[];
+    remove: AiGenBlockPath[];
+    replace: AiGenStructureReplace[];
+    updateSettings?: pushwoosh_aibuilder_v1_DocumentSettings;
+    updateTextVariants: Record<string, pushwoosh_aibuilder_v1_TextVariantStyle>;
+    updateColorScheme: Record<string, pushwoosh_aibuilder_v1_ColorSchemeItem>;
+};
+export type AiGenBlockColors = {
+    backgroundColor: string;
+    borderColor: string;
+};
+export type AiGenCard = {
+    layout: pushwoosh_aibuilder_v1_CardLayout;
+    image?: pushwoosh_aibuilder_v1_Image;
+    content: pushwoosh_aibuilder_v1_Content;
+    imageFit: pushwoosh_aibuilder_v1_CardImageFit;
+    accentFit: boolean;
+};
+export type AiGenColumn = {
+    image?: pushwoosh_aibuilder_v1_Image;
+    content: pushwoosh_aibuilder_v1_Content;
+    width?: string;
+};
+export type AiGenColumns = {
+    withImages: boolean;
+    columns: AiGenColumn[];
+    contentBefore?: pushwoosh_aibuilder_v1_Content;
+    contentAfter?: pushwoosh_aibuilder_v1_Content;
+};
+export type AiGenBlock_block_card = {
+    type: 'card';
+    data: AiGenCard;
+};
+export type AiGenBlock_block_columns = {
+    type: 'columns';
+    data: AiGenColumns;
+};
+export type AiGenBlock_block = AiGenBlock_block_card | AiGenBlock_block_columns;
+/**
+ * AiGenBlock is the payload carried by block_delta. The block's own id
+ * lives in the enclosing event's `block_path`; the payload is id-less.
+ */
+export type AiGenBlock = {
+    styles?: AiGenBlockColors;
+    block: AiGenBlock_block;
+};
+/**
+ * Full block delivered after generation. Images (if any) arrive separately
+ * via image_delta events referencing the same block_path.
+ */
+export type AiGenBlockDelta = {
+    blockPath: string[];
+    block: AiGenBlock;
+};
+export type AiGenImageDelta = {
+    blockPath: string[];
+    /**
+     * Field path inside the block ("image", "columns[0].image", ...),
+     * matching the content-addressing scheme used by the old Create API.
+     */
+    field: string;
+    src: string;
+    alt: string;
+    width: number;
+    height: number;
+    mediaUuid: string;
+};
+export type AiGenBlockError = {
+    blockPath: string[];
+    /**
+     * Optional field path for granular errors (e.g. a specific image inside a
+     * block). Empty → the block itself failed.
+     */
+    field: string;
+    error: string;
+};
+export type AiGenDoneEvent = {
+    summary: string;
+};
+/**
+ * AiGenTextDescription carries a generated short text for a document-level
+ * description field (template name, email subject, preheader, ...) so the
+ * client can render it as it arrives instead of waiting for done.
+ */
+export type AiGenTextDescription = {
+    /** "template_name" | "subject" | "preheader" */
+    type: string;
+    description: string;
+};
+export type AiGenEvent_event_progress = {
+    type: 'progress';
+    data: string;
+};
+export type AiGenEvent_event_structure = {
+    type: 'structure';
+    data: AiGenStructure;
+};
+export type AiGenEvent_event_structureDiff = {
+    type: 'structureDiff';
+    data: AiGenStructureDiff;
+};
+export type AiGenEvent_event_blockDelta = {
+    type: 'blockDelta';
+    data: AiGenBlockDelta;
+};
+export type AiGenEvent_event_imageDelta = {
+    type: 'imageDelta';
+    data: AiGenImageDelta;
+};
+export type AiGenEvent_event_blockError = {
+    type: 'blockError';
+    data: AiGenBlockError;
+};
+export type AiGenEvent_event_done = {
+    type: 'done';
+    data: AiGenDoneEvent;
+};
+export type AiGenEvent_event_fatal = {
+    type: 'fatal';
+    data: string;
+};
+export type AiGenEvent_event_textDescription = {
+    type: 'textDescription';
+    data: AiGenTextDescription;
+};
+export type AiGenEvent_event = AiGenEvent_event_progress | AiGenEvent_event_structure | AiGenEvent_event_structureDiff | AiGenEvent_event_blockDelta | AiGenEvent_event_imageDelta | AiGenEvent_event_blockError | AiGenEvent_event_done | AiGenEvent_event_fatal | AiGenEvent_event_textDescription;
+export type AiGenEvent = {
+    event: AiGenEvent_event;
+};

package/pushwoosh_aigen_v1.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};