feeef 0.7.4 → 0.8.0

package/build/src/core/entities/attachment.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Shared AI attachment contract used by image prompt templates and image generations.
+ */
+export declare const ATTACHMENT_TYPES: readonly ["image", "url", "audio", "product", "store"];
+export type AttachmentType = (typeof ATTACHMENT_TYPES)[number];
+export interface AttachmentBase {
+    value: string;
+    label?: string | null;
+    prompt?: string | null;
+}
+export interface ImageAttachmentPayload extends AttachmentBase {
+    type: 'image';
+}
+export interface UrlAttachmentPayload extends AttachmentBase {
+    type: 'url';
+}
+export interface AudioAttachmentPayload extends AttachmentBase {
+    type: 'audio';
+}
+export interface ProductAttachmentPayload extends AttachmentBase {
+    type: 'product';
+}
+export interface StoreAttachmentPayload extends AttachmentBase {
+    type: 'store';
+}
+export type AttachmentPayload = ImageAttachmentPayload | UrlAttachmentPayload | AudioAttachmentPayload | ProductAttachmentPayload | StoreAttachmentPayload;
+export declare function isAttachmentType(value: unknown): value is AttachmentType;
+export declare function normalizeAttachmentPayload(value: unknown): AttachmentPayload | null;
+export declare function normalizeAttachmentPayloads(value: unknown): AttachmentPayload[];
+export declare function serializeAttachmentPayload(payload: AttachmentPayload): Record<string, unknown>;
+export declare function serializeAttachmentPayloads(attachments: AttachmentPayload[] | null | undefined): Record<string, unknown>[];

package/build/src/core/entities/image_generation.d.ts

@@ -0,0 +1,71 @@
+import { AttachmentPayload } from './attachment.js';
+export type ImageGenerationStatus = 'pending' | 'processing' | 'completed' | 'published' | 'failed';
+export type ImageGenerationResolution = 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH';
+export type ImageGenerationAspectRatio = '1:1' | '16:9' | '9:16' | '4:3' | '3:4' | '4:5' | '9:32' | '1:8' | '8:1' | '1:4' | '4:1';
+export interface ImageGenerationHistoryItem {
+    id: string;
+    createdAt: string;
+    generatedImageUrl: string | null;
+    configs: Record<string, unknown>;
+}
+export interface ImageGenerationUserSummary {
+    id: string;
+    name?: string | null;
+    photoUrl?: string | null;
+}
+export interface ImageGeneration {
+    id: string;
+    userId: string | null;
+    storeId: string | null;
+    title: string | null;
+    generatedImageUrl: string | null;
+    configs: Record<string, unknown>;
+    generations: ImageGenerationHistoryItem[];
+    status: ImageGenerationStatus;
+    tags: string[];
+    createdAt: string;
+    updatedAt: string | null;
+    deletedAt: string | null;
+    user?: ImageGenerationUserSummary | null;
+}
+export interface PaginatedResourceResponse<T> {
+    data: T[];
+    meta: Record<string, unknown>;
+    hasMore: boolean;
+    total?: number;
+    page?: number;
+    limit?: number;
+}
+export interface ImageGenerationListOptions {
+    page?: number;
+    limit?: number;
+    storeId?: string;
+    tags?: string[];
+    params?: Record<string, unknown>;
+}
+export interface ImageGenerationGalleryOptions {
+    page?: number;
+    limit?: number;
+    params?: Record<string, unknown>;
+}
+export interface ImageGenerationGenerateInput {
+    id?: string | null;
+    storeId?: string | null;
+    title?: string | null;
+    prompt?: string | null;
+    imageFile?: File | Blob | Uint8Array | ArrayBuffer | null;
+    aspectRatio?: ImageGenerationAspectRatio;
+    resolution?: ImageGenerationResolution;
+    systemInstructions?: string | null;
+    attachments?: AttachmentPayload[];
+    model?: string | null;
+    googleSearch?: boolean;
+    imageSearch?: boolean;
+}
+export interface ImageGenerationPublishInput {
+    id: string;
+    isPublished: boolean;
+}
+export declare function normalizeImageGeneration(value: unknown): ImageGeneration;
+export declare function normalizePaginatedResponse<T>(value: unknown, mapper: (item: unknown) => T): PaginatedResourceResponse<T>;
+export declare function createImageGenerationFormData(input: ImageGenerationGenerateInput): FormData;

package/build/src/core/entities/image_prompt_template.d.ts

@@ -0,0 +1,41 @@
+import { AttachmentPayload } from './attachment.js';
+/**
+ * Image prompt template entity used by merchant AI product-image flows.
+ */
+export interface ImagePromptTemplate {
+    id: string;
+    name: string;
+    description: string | null;
+    prompt: string;
+    tags: string[];
+    attachments: AttachmentPayload[];
+    previewImageUrl: string | null;
+    propsSchema: Record<string, unknown>;
+    props: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string | null;
+}
+export interface ImagePromptTemplateCreate {
+    name: string;
+    description?: string | null;
+    prompt: string;
+    tags?: string[];
+    attachments?: AttachmentPayload[];
+    previewImageUrl?: string | null;
+    propsSchema?: Record<string, unknown>;
+    props?: Record<string, unknown>;
+}
+export interface ImagePromptTemplateUpdate {
+    name?: string;
+    description?: string | null;
+    prompt?: string;
+    tags?: string[];
+    attachments?: AttachmentPayload[];
+    previewImageUrl?: string | null;
+    propsSchema?: Record<string, unknown>;
+    props?: Record<string, unknown>;
+    setToNull?: string[];
+}
+export declare function normalizeImagePromptTemplate(value: unknown): ImagePromptTemplate;
+export declare function serializeImagePromptTemplateCreate(value: ImagePromptTemplateCreate): Record<string, unknown>;
+export declare function serializeImagePromptTemplateUpdate(value: ImagePromptTemplateUpdate): Record<string, unknown>;

package/build/src/feeef/feeef.d.ts

@@ -15,6 +15,8 @@ import { ShippingMethodRepository } from './repositories/shipping_methods.js';
 import { FeedbackRepository } from './repositories/feedbacks.js';
 import { ProductLandingPageTemplatesRepository } from './repositories/product_landing_page_templates.js';
 import { ProductLandingPagesRepository } from './repositories/product_landing_pages.js';
+import { ImagePromptTemplatesRepository } from './repositories/image_prompt_templates.js';
+import { ImageGenerationsRepository } from './repositories/image_generations.js';
 import { CartService } from './services/cart.js';
 import { ActionsService } from './services/actions.js';
 import { NotificationsService } from './services/notifications.js';
@@ -72,6 +74,14 @@ export declare class FeeeF {
      * The repository for managing product landing page templates.
      */
     productLandingPageTemplates: ProductLandingPageTemplatesRepository;
+    /**
+     * The repository for managing image prompt templates.
+     */
+    imagePromptTemplates: ImagePromptTemplatesRepository;
+    /**
+     * The repository for managing async image generations.
+     */
+    imageGenerations: ImageGenerationsRepository;
     /**
      * The repository for managing users.
      */

package/build/src/feeef/repositories/image_generations.d.ts

@@ -0,0 +1,26 @@
+import { AxiosInstance } from 'axios';
+import { ImageGeneration, ImageGenerationGalleryOptions, ImageGenerationGenerateInput, ImageGenerationListOptions, ImageGenerationPublishInput, PaginatedResourceResponse } from '../../core/entities/image_generation.js';
+/**
+ * Repository for async image-generation flows.
+ */
+export declare class ImageGenerationsRepository {
+    client: AxiosInstance;
+    resource: string;
+    constructor(client: AxiosInstance);
+    list(options?: ImageGenerationListOptions): Promise<PaginatedResourceResponse<ImageGeneration>>;
+    gallery(options?: ImageGenerationGalleryOptions): Promise<PaginatedResourceResponse<ImageGeneration>>;
+    find(id: string): Promise<ImageGeneration>;
+    createImageGeneration(input: ImageGenerationGenerateInput & {
+        storeId: string;
+    }): Promise<ImageGeneration>;
+    generateImageGeneration(input: ImageGenerationGenerateInput): Promise<ImageGeneration>;
+    rerunGeneration(id: string, input?: Omit<ImageGenerationGenerateInput, 'id'>): Promise<ImageGeneration>;
+    setPublished(input: ImageGenerationPublishInput): Promise<ImageGeneration>;
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+}
+/**
+ * Backward-compatible alias with the Dart naming.
+ */
+export type AiRepository = ImageGenerationsRepository;

package/build/src/feeef/repositories/image_prompt_templates.d.ts

@@ -0,0 +1,38 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, ModelRepository } from './repository.js';
+import { ImagePromptTemplate, ImagePromptTemplateCreate, ImagePromptTemplateUpdate } from '../../core/entities/image_prompt_template.js';
+export interface ImagePromptTemplateListOptions {
+    page?: number;
+    offset?: number;
+    limit?: number;
+    id?: string;
+    name?: string;
+    nameLike?: string;
+    q?: string;
+    search?: string;
+    tags?: string[];
+    hasPreview?: boolean;
+    orderBy?: 'created_at' | 'updated_at' | 'name';
+    params?: Record<string, unknown>;
+}
+/**
+ * Repository for image prompt template CRUD.
+ */
+export declare class ImagePromptTemplatesRepository extends ModelRepository<ImagePromptTemplate, ImagePromptTemplateCreate, ImagePromptTemplateUpdate> {
+    constructor(client: AxiosInstance);
+    find(options: {
+        id: string;
+        by?: string;
+        params?: Record<string, unknown>;
+    }): Promise<ImagePromptTemplate>;
+    list(options?: ImagePromptTemplateListOptions): Promise<ListResponse<ImagePromptTemplate>>;
+    create(dataOrOptions: ImagePromptTemplateCreate | {
+        data: ImagePromptTemplateCreate;
+        params?: Record<string, unknown>;
+    }, params?: Record<string, unknown>): Promise<ImagePromptTemplate>;
+    update(options: {
+        id: string;
+        data: ImagePromptTemplateUpdate;
+        params?: Record<string, unknown>;
+    }): Promise<ImagePromptTemplate>;
+}

package/build/src/index.d.ts

@@ -4,6 +4,9 @@ export * from './core/entities/store.js';
 export * from './core/entities/product.js';
 export * from './core/entities/product_landing_page.js';
 export * from './core/entities/product_landing_page_template.js';
+export * from './core/entities/attachment.js';
+export * from './core/entities/image_prompt_template.js';
+export * from './core/entities/image_generation.js';
 export * from './core/entities/user.js';
 export * from './core/entities/shipping_method.js';
 export * from './core/entities/shipping_price.js';
@@ -22,6 +25,8 @@ export * from './feeef/repositories/users.js';
 export * from './feeef/repositories/stores.js';
 export * from './feeef/repositories/products.js';
 export * from './feeef/repositories/orders.js';
+export * from './feeef/repositories/image_prompt_templates.js';
+export * from './feeef/repositories/image_generations.js';
 export * from './feeef/repositories/categories.js';
 export * from './feeef/repositories/feedbacks.js';
 export * from './feeef/repositories/countries.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "feeef",
   "description": "feeef sdk for javascript",
-  "version": "0.7.4",
+  "version": "0.8.0",
   "main": "build/index.js",
   "type": "module",
   "files": [