esender-email-editor 1.1.0 → 1.2.1

package/dist/index.d.ts

@@ -35,37 +35,6 @@ interface TemplateApiResponse {
     template?: TemplateDocument;
 }
 
-/**
- * Module-level API configuration for the editor.
- *
- * Consumers override these via the `apiConfig` prop on <Package />. Internal
- * modules (axiosClient, license, template, UploadMedia) read from this module
- * instead of hardcoded constants so the editor can talk to any backend that
- * implements the same contract.
- *
- * Endpoint defaults follow the spec paths (e.g. /template/create). The host
- * URL (`baseUrl`) defaults to the eSender production API.
- *
- * Template URLs may contain :projectId / :templateId placeholders, which
- * `resolveTemplatePath` substitutes at call time.
- */
-interface ApiConfig {
-    /** API host. No trailing slash. */
-    baseUrl?: string;
-    /** POST — exchange apiKey for access + refresh tokens. */
-    verifyUrl?: string;
-    /** POST — exchange refresh token for new access token. */
-    refreshUrl?: string;
-    /** POST — create or update a template (templateId in body for update). */
-    saveTemplateUrl?: string;
-    /** GET — load the project's current template. `:projectId` is substituted. */
-    getTemplatesUrl?: string;
-    /** GET — load a specific template. `:projectId` / `:templateId` are substituted. */
-    getTemplateByIdUrl?: string;
-    /** POST (multipart) — upload an image. Receives a hosted URL back. */
-    uploadMediaUrl?: string;
-}
-
 /**
  * Editor event callbacks exposed to consumers via <Package />.
  *
@@ -114,7 +83,18 @@ interface LoadTemplateOptions {
 interface EditorHandle {
     getJson: () => any;
     getHtml: () => any;
-    loadJson: (json: string, raw?: boolean) => void;
+    /**
+     * Restore a previously saved template from JSON. Accepts either the raw
+     * stringified output of `getJson()` or the deserialized object.
+     * Pass `null` to clear the canvas to an empty template.
+     */
+    loadJson: (json: string | object | null, raw?: boolean) => void;
+    /**
+     * Load raw HTML into the editor. The HTML is wrapped in an MJML `mj-raw`
+     * block and rendered verbatim — the editor cannot break arbitrary HTML
+     * back into editable blocks, so for full editability prefer `loadJson`.
+     */
+    loadHtml: (html: string) => void;
     /**
      * Export the current editor state (HTML + JSON) and persist it to the
      * template API. apiKey comes from the Package's prop. Pass `templateId` to
@@ -134,16 +114,48 @@ interface PackageProps extends EditorEventCallbacks {
      * backwards-compatible prop signatures during the migration. Ignored at runtime.
      */
     projectId?: string;
-    /**
-     * Override default API endpoints (base URL + per-route paths). Consumers
-     * who self-host the backend pass this to point the editor at their server.
-     */
-    apiConfig?: ApiConfig;
     onLicenseError?: (error: LicenseError) => void;
     customButtons?: ReactNode;
     showUndoRedo?: boolean;
 }
 declare const Package: React.ForwardRefExoticComponent<PackageProps & React.RefAttributes<EditorHandle>>;
 
+/**
+ * Public entry for @bitbeast-private-limited/antd-email-editor.
+ *
+ * This file is the rollup input — it intentionally exports ONLY the consumer
+ * surface. Do NOT export internal utilities, store, contexts, MJML helpers or
+ * any other implementation detail from here. Anything re-exported below
+ * becomes part of the SDK's public contract and breaks consumers on removal.
+ */
+
+/**
+ * Imperative editor instance returned by `ref.current`. Alias for {@link EditorHandle}.
+ */
+type EditorInstance = EditorHandle;
+/**
+ * Stored template record returned by the save/load APIs. Alias for {@link TemplateDocument}.
+ */
+type TemplateData = TemplateDocument;
+/**
+ * MJML JSON tree describing a template. This is the shape `getJson()` produces
+ * once parsed back into an object — kept intentionally loose since the tree
+ * has many MJML-tag-specific variants.
+ */
+type TemplateJson = Record<string, unknown> & {
+    tagName: string;
+    attributes?: Record<string, unknown>;
+    children?: unknown[];
+    content?: string;
+};
+/**
+ * Arguments accepted by {@link EditorHandle.saveTemplate}. Alias for {@link SaveTemplateOptions}.
+ */
+type SaveTemplatePayload = SaveTemplateOptions;
+/**
+ * Arguments accepted by {@link EditorHandle.loadTemplate}. Alias for {@link LoadTemplateOptions}.
+ */
+type LoadTemplatePayload = LoadTemplateOptions;
+
 export { Package, Package as default };
-export type { ApiConfig, EditorEventCallbacks, EditorHandle, LicenseError, LicenseErrorCode, LoadEvent, LoadTemplateOptions, MediaUploadEvent, PackageProps, RefreshTokenResponse, SaveEvent, SaveTemplateOptions, TemplateApiResponse, TemplateDocument, VerifyLicenseResponse };
+export type { EditorEventCallbacks, EditorHandle, EditorInstance, LicenseError, LicenseErrorCode, LoadEvent, LoadTemplateOptions, LoadTemplatePayload, MediaUploadEvent, PackageProps, RefreshTokenResponse, SaveEvent, SaveTemplateOptions, SaveTemplatePayload, TemplateApiResponse, TemplateData, TemplateDocument, TemplateJson, VerifyLicenseResponse };