@umbraco-ai/core 18.0.0 → 18.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umbraco-ai/core",
-  "version": "18.0.0",
+  "version": "18.1.0",
   "type": "module",
   "types": "./types/umbraco-ai-public-types.d.ts",
   "files": [

package/types/umbraco-ai-public-types.d.ts

@@ -30,40 +30,21 @@ export declare type AiDocumentMetadataModel = {
     variants: Array<AiVariantIdModel>;
     isVariant: boolean;
     isSegmented: boolean;
-    name?: string | null;
-};
-
-export declare type AiDocumentMetadataModelWritable = {
-    contentTypeKey: string;
-    variants: Array<AiVariantIdModelWritable>;
-    isVariant: boolean;
-    isSegmented: boolean;
-    name?: string | null;
+    name?: null | string;
 };
 
 export declare type AiPropertyOperationModel = 'AddItem' | 'RemoveItem' | 'MoveItem' | 'SetValue' | 'ClearValue';
 
-declare type AiPropertyPathSegmentModel = {
-    [key: string]: never;
-};
-
 export declare type AiPropertyValueOperationErrorModel = {
     code: string;
     message: string;
-    details?: {
-        [key: string]: JsonNode;
-    } | null;
+    details?: null | JsonObject;
 };
 
 export declare type AiVariantIdModel = {
-    culture?: string | null;
-    segment?: string | null;
-    readonly isInvariant: boolean;
-};
-
-export declare type AiVariantIdModelWritable = {
-    culture?: string | null;
-    segment?: string | null;
+    culture: null | string;
+    segment: null | string;
+    isInvariant: boolean;
 };
 
 declare type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
@@ -285,12 +266,16 @@ declare type EntityVersionResponseModel = {
     entityId: string;
     version: number;
     dateCreated: string;
-    createdByUserId?: string | null;
-    createdByUserName?: string | null;
-    changeDescription?: string | null;
+    createdByUserId?: null | string;
+    createdByUserName?: null | string;
+    changeDescription?: null | string;
 };
 
-declare type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
+declare type ErrInterceptor<Err, Res, Req, Options> = (error: Err, 
+/** response may be undefined due to a network error where no response object is produced */
+response: Res | undefined, 
+/** request may be undefined, because error may be from building the request object itself */
+request: Req | undefined, options: Options) => Err | Promise<Err>;
 
 export declare function formatDateTime(input: string | Date, locale?: string): string;
 
@@ -315,7 +300,7 @@ declare class Interceptors<Interceptor> {
 }
 
 declare type InvokeData = {
-    body?: PropertyValueOperationRequestModelWritable;
+    body: PropertyValueOperationRequestModel;
     path?: never;
     query?: never;
     url: '/umbraco/ai/management/api/v1/property-value-operation';
@@ -339,18 +324,10 @@ declare type InvokeResponses = {
     200: PropertyValueOperationResponseModel;
 };
 
-declare type JsonNode = {
-    options?: JsonNodeOptions | null;
-    parent?: JsonNode | null;
-    root: JsonNode;
-};
-
-declare type JsonNodeOptions = {
-    propertyNameCaseInsensitive: boolean;
-};
+declare type JsonNode = unknown;
 
-declare type JsonNodeWritable = {
-    [key: string]: never;
+declare type JsonObject = {
+    [key: string]: unknown;
 };
 
 /**
@@ -480,32 +457,22 @@ declare type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
 declare type Options_2<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 
 export declare type PropertyValueOperationRequestModel = {
-    path: Array<AiPropertyPathSegmentModel>;
+    path: Array<unknown>;
     operation: AiPropertyOperationModel;
-    args?: JsonNode | null;
-    rootValue?: JsonNode | null;
-    rootEditorSchemaAlias: string;
+    args?: null | JsonNode;
+    rootValue?: null | JsonNode;
     documentMetadata: AiDocumentMetadataModel;
 };
 
-export declare type PropertyValueOperationRequestModelWritable = {
-    path: Array<AiPropertyPathSegmentModel>;
-    operation: AiPropertyOperationModel;
-    args?: JsonNodeWritable | null;
-    rootValue?: JsonNodeWritable | null;
-    rootEditorSchemaAlias: string;
-    documentMetadata: AiDocumentMetadataModelWritable;
-};
-
 export declare type PropertyValueOperationResponseModel = {
     success: boolean;
-    newRootValue?: JsonNode | null;
-    blockKey?: string | null;
-    error?: AiPropertyValueOperationErrorModel | null;
+    newRootValue?: null | JsonNode;
+    blockKey?: null | string;
+    error?: null | AiPropertyValueOperationErrorModel;
 };
 
 export declare class PropertyValueOperationsService {
-    static invoke<ThrowOnError extends boolean = false>(options?: Options<InvokeData, ThrowOnError>): RequestResult<InvokeResponses, InvokeErrors, ThrowOnError, "fields">;
+    static invoke<ThrowOnError extends boolean = false>(options: Options<InvokeData, ThrowOnError>): RequestResult<InvokeResponses, InvokeErrors, ThrowOnError, "fields">;
 }
 
 declare type QuerySerializer = (query: Record<string, unknown>) => string;
@@ -558,8 +525,10 @@ declare type RequestResult<TData = unknown, TError = unknown, ThrowOnError exten
     data: undefined;
     error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
 }) & {
-    request: Request;
-    response: Response;
+    /** request may be undefined, because error may be from building the request object itself */
+    request?: Request;
+    /** response may be undefined, because error may be from building the request object itself or from a network error */
+    response?: Response;
 }>;
 
 declare type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
@@ -671,7 +640,7 @@ declare type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unk
     stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
 };
 
-declare type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
+declare type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
 
 declare interface StreamEvent<TData = unknown> {
     data: TData;
@@ -1393,6 +1362,85 @@ export declare interface UaiFrontendToolRepositoryApi extends UmbApi {
     getTools(): Promise<UaiFrontendToolData[]>;
 }
 
+/**
+ * A single generated image, returned as base64 data and/or a URL.
+ * @public
+ */
+export declare interface UaiGeneratedImage {
+    /** Base64-encoded image data, when the provider returned inline data. */
+    data?: string;
+    /** Image URL, when the provider returned a hosted/URI image. */
+    url?: string;
+    /** Media type of the image (e.g. "image/png"). */
+    mediaType?: string;
+}
+
+/**
+ * Public API for generating images from a text prompt.
+ *
+ * Image generation is experimental and only available when the
+ * `Umbraco:AI:Experimental:ImageGeneration` feature flag is enabled server-side;
+ * otherwise the server returns 404.
+ * @public
+ */
+export declare class UaiImageGenerationController extends UmbControllerBase {
+    #private;
+    constructor(host: UmbControllerHost);
+    /**
+     * Generates one or more images from a text prompt.
+     * @param prompt - The text prompt describing the desired image(s).
+     * @param options - Optional configuration (profile ID/alias, count, size, original images, abort signal).
+     * @returns The generation result or error.
+     */
+    generate(prompt: string, options?: UaiImageGenerationOptions): Promise<{
+        data?: UaiImageGenerationResult;
+        error?: unknown;
+    }>;
+}
+
+/**
+ * Options for image generation (public API).
+ * @public
+ */
+export declare interface UaiImageGenerationOptions {
+    /** Profile ID (GUID) or alias. If omitted, uses the default image-generation profile. */
+    profileIdOrAlias?: string;
+    /** Number of images to generate. */
+    count?: number;
+    /** Image size as "{width}x{height}" (e.g. "1024x1024"). */
+    size?: string;
+    /** Response format: "url", "data", or "hosted". */
+    responseFormat?: string;
+    /** Original images to edit (maskless edit). */
+    originalImages?: UaiImageInput[];
+    /** AbortSignal for cancellation. */
+    signal?: AbortSignal;
+}
+
+/* Excluded from this release type: UaiImageGenerationRequest */
+
+/**
+ * Result of an image-generation request.
+ * @public
+ */
+export declare interface UaiImageGenerationResult {
+    images: UaiGeneratedImage[];
+    usage?: {
+        inputTokens?: number;
+        outputTokens?: number;
+        totalTokens?: number;
+    };
+}
+
+/**
+ * A base64-encoded input image for maskless editing.
+ * @public
+ */
+export declare interface UaiImageInput {
+    data: string;
+    mediaType: string;
+}
+
 /**
  * A card with background/border chrome wrapping a labeled field.
  */
@@ -2600,8 +2648,8 @@ export declare class UaiWorkspaceRegistryContext extends UmbControllerBase {
 
 declare type ValueChangeModel = {
     path: string;
-    oldValue?: string | null;
-    newValue?: string | null;
+    oldValue?: null | string;
+    newValue?: null | string;
 };
 
 /**