@codingfactory/mediables-vue 2.3.6 → 2.4.1

package/dist/types/editor.d.ts

@@ -42,7 +42,9 @@ export interface VariantSavePayload {
     height: number;
 }
 /**
- * Event payload when saving an edited image
+ * Event payload when saving an edited image.
+ * `state` is the canonical serializable state (v3.0.0+).
+ * `metadata` is kept for backward compatibility with existing consumers.
  */
 export interface SaveEventPayload {
     imageData: string;
@@ -50,7 +52,9 @@ export interface SaveEventPayload {
         width: number;
         height: number;
     };
-    metadata: {
+    state: ImageEditorSessionState;
+    /** @deprecated Use `state` instead. Kept for backward compatibility. */
+    metadata?: {
         hasCrop: boolean;
         cropRect: CropRect | null;
         filters: string[];
@@ -170,3 +174,84 @@ export type EditorTool = 'crop' | 'filter' | 'adjust' | 'text' | 'draw' | 'none'
  * Editor view mode
  */
 export type ViewMode = 'edit' | 'preview' | 'split';
+/**
+ * Primitive types allowed in filter parameter values.
+ */
+export type ImageEditorPrimitive = string | number | boolean;
+/**
+ * Serializable state for a single filter in the editor.
+ */
+export interface ImageEditorFilterState {
+    id: string;
+    enabled: boolean;
+    values: Record<string, ImageEditorPrimitive>;
+}
+/**
+ * Canonical serializable state for the entire editor session.
+ * This is the single source of truth for editor state persistence.
+ */
+export interface ImageEditorSessionState {
+    version: 1;
+    crop: {
+        rect: CropRect | null;
+        aspectRatio: string;
+        shape: 'free' | 'square' | 'circle';
+    };
+    filters: ImageEditorFilterState[];
+}
+/**
+ * Payload emitted when saving an edited image (v3.0.0+).
+ * Uses Blob instead of base64 for better memory efficiency.
+ */
+export interface ImageEditorSavePayload {
+    blob: Blob;
+    mimeType: string;
+    dimensions: {
+        width: number;
+        height: number;
+    };
+    state: ImageEditorSessionState;
+}
+/**
+ * Options for opening the image editor.
+ */
+export interface ImageEditorOpenOptions {
+    image?: string | Blob | File | null;
+    state?: ImageEditorSessionState | null;
+    sessionKey?: string | number;
+}
+/**
+ * Response from GET /editor/{uuid}/edit.
+ */
+export interface ImageEditorEditSessionResponse {
+    success: true;
+    media: Media;
+    editable_source_url: string;
+    editor_source_media_uuid: string | null;
+    editor_state: ImageEditorSessionState | null;
+    urls: {
+        original: string;
+        large?: string;
+        medium?: string;
+    };
+}
+/**
+ * Response from POST /editor/{uuid}/save (202 Accepted).
+ */
+export interface ImageEditorSaveAcceptedResponse {
+    success: true;
+    message: string;
+    job_id: string;
+    status_url: string;
+}
+/**
+ * Response from GET /editor/jobs/{jobId} (polling endpoint).
+ */
+export interface ImageEditorJobStatusResponse {
+    success: boolean;
+    id: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    media?: Media;
+    media_uuid?: string;
+    error?: string;
+}

package/dist/utils/imageEditorState.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Canonical Image Editor State normalizer/serializer.
+ * Single source of truth for converting between internal editor state
+ * and the canonical ImageEditorSessionState persistence format.
+ */
+import type { ImageEditorSessionState } from '../types/editor';
+/**
+ * Normalize and validate an ImageEditorSessionState object.
+ * Strips invalid data and returns a clean, safe-to-persist state.
+ * Returns null if the input is fundamentally invalid.
+ */
+export declare function normalizeEditorState(raw: unknown): ImageEditorSessionState | null;
+/**
+ * Serialize an ImageEditorSessionState to a JSON string.
+ * Normalizes first to ensure only valid data is serialized.
+ */
+export declare function serializeEditorState(state: ImageEditorSessionState): string | null;
+/**
+ * Deserialize a JSON string to an ImageEditorSessionState.
+ * Returns null if the JSON is invalid or doesn't pass validation.
+ */
+export declare function deserializeEditorState(json: string): ImageEditorSessionState | null;
+/**
+ * Create an empty default ImageEditorSessionState.
+ */
+export declare function createEmptyEditorState(): ImageEditorSessionState;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codingfactory/mediables-vue",
-  "version": "2.3.6",
+  "version": "2.4.1",
   "publishConfig": {
     "access": "public"
   },