esender-email-editor 1.0.2 → 1.1.0

package/dist/index.d.ts

@@ -23,6 +23,7 @@ interface TemplateDocument {
     _id: string;
     userId: string;
     projectId: string;
+    templateId?: string;
     HTML: string;
     JSON: unknown;
     createdAt?: string;
@@ -34,8 +35,76 @@ 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 />.
+ *
+ * Internal components reach these through `useEditorEvents()` instead of
+ * prop-drilling. Callbacks are stored in a ref so re-renders never re-fire
+ * subscribers, and a no-op fallback is returned when a callback is unset —
+ * call sites don't need to null-check.
+ */
+interface MediaUploadEvent {
+    url: string;
+    /** Original File object the user picked, if available. */
+    file?: File;
+    /** Raw API response body, untyped — varies by backend. */
+    response?: unknown;
+}
+interface SaveEvent {
+    projectId: string;
+    templateId?: string;
+    /** API response body from the save call. */
+    response: unknown;
+}
+interface LoadEvent {
+    projectId: string;
+    templateId?: string;
+    /** API response body from the load call. */
+    response: unknown;
+}
+interface EditorEventCallbacks {
+    onSave?: (event: SaveEvent) => void;
+    onLoad?: (event: LoadEvent) => void;
+    onTemplateChange?: (json: unknown) => void;
+    onHtmlExport?: (html: string) => void;
+    onMediaUpload?: (event: MediaUploadEvent) => void;
+}
+
 interface SaveTemplateOptions {
     projectId: string;
+    /** Provide to update an existing template instead of creating a new one. */
+    templateId?: string;
 }
 interface LoadTemplateOptions {
     projectId: string;
@@ -48,7 +117,8 @@ interface EditorHandle {
     loadJson: (json: string, raw?: boolean) => void;
     /**
      * Export the current editor state (HTML + JSON) and persist it to the
-     * eSender template API. apiKey comes from the Package's prop.
+     * template API. apiKey comes from the Package's prop. Pass `templateId` to
+     * update an existing template.
      */
     saveTemplate: (options: SaveTemplateOptions) => Promise<TemplateApiResponse>;
     /**
@@ -57,13 +127,18 @@ interface EditorHandle {
      */
     loadTemplate: (options: LoadTemplateOptions) => Promise<TemplateApiResponse>;
 }
-interface PackageProps {
+interface PackageProps extends EditorEventCallbacks {
     apiKey: string;
     /**
-     * @deprecated The new eSender license flow does not use projectId. Kept for
+     * @deprecated The license flow does not use projectId. Kept for
      * 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;
@@ -71,4 +146,4 @@ interface PackageProps {
 declare const Package: React.ForwardRefExoticComponent<PackageProps & React.RefAttributes<EditorHandle>>;
 
 export { Package, Package as default };
-export type { EditorHandle, LicenseError, LicenseErrorCode, LoadTemplateOptions, PackageProps, RefreshTokenResponse, SaveTemplateOptions, TemplateApiResponse, TemplateDocument, VerifyLicenseResponse };
+export type { ApiConfig, EditorEventCallbacks, EditorHandle, LicenseError, LicenseErrorCode, LoadEvent, LoadTemplateOptions, MediaUploadEvent, PackageProps, RefreshTokenResponse, SaveEvent, SaveTemplateOptions, TemplateApiResponse, TemplateDocument, VerifyLicenseResponse };