Build

GrapesJS · Aug 4, 2022 · 3183fc5 · 3183fc5
1 parent df9dabd
commit 3183fc5
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 15 deletions.
diff --git a/dist/grapesjs-plugin-export.min.js b/dist/grapesjs-plugin-export.min.js
diff --git a/dist/grapesjs-plugin-export.min.js.map b/dist/grapesjs-plugin-export.min.js.map
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -0,0 +1,67 @@
+import grapesjs from 'grapesjs';
+
+export declare type Editor = grapesjs.Editor;
+export declare type PluginOptions = {
+	/**
+	 * Type id used to register the new storage.
+	 * You can use this option in case you want to replace the already available storages (eg. `local`).
+	 * @default 'indexeddb'
+	 */
+	type?: string;
+	/**
+	 * Add a button inside the export dialog
+	 * @default true
+	 */
+	addExportBtn?: boolean;
+	/**
+	 * Label of the export button
+	 * @default 'Export to ZIP'
+	 */
+	btnLabel?: string;
+	/**
+	 * ZIP filename prefix
+	 * @default 'grapesjs_template'
+	 */
+	filenamePfx?: string;
+	/**
+	 * Use a function to generate the filename, eg. `filename: editor => 'my-file.zip',`
+	 */
+	filename?: (editor: Editor) => string;
+	/**
+	 * Callback to execute once the export is completed
+	 */
+	done?: () => void;
+	/**
+	 * Callback to execute on export error
+	 */
+	onError?: (error: Error) => void;
+	/**
+	 * Use the root object to create the folder structure of your zip (async functions are supported)
+	 * @example
+	 * root: {
+	 *   css: {
+	 *     'style.css': ed => ed.getCss(),
+	 *     'some-file.txt': 'My custom content',
+	 *   },
+	 *   img: async ed => {
+	 *     const images = await fetchImagesByStructue(ed.getComponents());
+	 *     return images;
+	 *     // Where `images` is an object like this:
+	 *     // { 'img1.png': '...png content', 'img2.jpg': '...jpg content' }
+	 *   },
+	 *   'index.html': ed => `<body>${ed.getHtml()}</body>`
+	 * }
+	 */
+	root?: Record<string, unknown>;
+	/**
+	 * Custom function for checking if the file content is binary
+	 */
+	isBinary?: (content: string, name: string) => boolean;
+};
+declare const plugin: grapesjs.Plugin<PluginOptions>;
+
+export {
+	plugin as default,
+};
+
+export {};
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,8 +1,9 @@
 {
   "name": "grapesjs-plugin-export",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "Export GrapesJS templates to ZIP",
-  "main": "dist/grapesjs-plugin-export.min.js",
+  "main": "dist/index.js",
+  "files": ["dist/*"],
   "scripts": {
     "start": "grapesjs-cli serve",
     "build": "grapesjs-cli build"