@goodfellow-cms/admin 0.3.0 → 0.5.0

package/README.md

@@ -2,7 +2,7 @@
 
 The admin panel: the visual editor for a site's pages, collections, media, header and footer, and settings, which publishes to the site's repository from the browser.
 
-It's built with each site's own config, so the editor always has the site's blocks: `goodfellow build` adds it at `/admin`, and Next.js sites render `GoodfellowAdmin` from `@goodfellow-cms/next` there.
+Its editor is built with each site's own config, so it always has the site's blocks, and runs them in frames sandboxed away from the admin panel's page, which signs in and publishes: `goodfellow build` adds the page at `/admin` and the editor at `/admin/editor/`, and Next.js sites render `GoodfellowAdmin` and `GoodfellowEditor` from `@goodfellow-cms/next` there.
 
 [Goodfellow](https://github.com/goodfellow-cms/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://goodfellow-cms.github.io/goodfellow-cms/) for everything else.
 

package/dist/editor.d.ts

@@ -0,0 +1,18 @@
+import { GoodfellowConfig } from "@goodfellow-cms/core";
+//#region src/frame/app.d.ts
+/**
+ * Starts the site's frame in `element`: tells the admin panel's page it's
+ * ready, and waits for its port. Only the page that made the frame can answer,
+ * since a sandboxed frame's parent is the only window that can reach it.
+ */
+interface EditorFrameOptions {
+  /**
+   * Where the frame loads `@tailwindcss/browser` from, where the admin
+   * panel's own address for it can't be loaded from the frame, such as a
+   * `blob:` address only the admin panel's page can read.
+   */
+  tailwindBrowserUrl?: string;
+}
+export declare function mountEditorFrame(config: GoodfellowConfig, element?: Element, options?: EditorFrameOptions): void;
+//#endregion
+export type { EditorFrameOptions };