@micelio/strapi-plugin-core 0.1.0 → 0.2.0

package/dist/admin/src/translations/en.json.d.ts

@@ -90,7 +90,43 @@ declare const _default: {
   "status.plugins.fix": "Fix",
   "status.diagnostics.copy": "Copy diagnostics",
   "status.diagnostics.copied": "The diagnostics were copied.",
-  "status.diagnostics.failed": "The diagnostics could not be copied."
+  "status.diagnostics.failed": "The diagnostics could not be copied.",
+  "preview.title": "Preview",
+  "preview.page": "Preview of {title}",
+  "preview.subtitle": "The saved draft, as the site renders it.",
+  "preview.back": "Back to the entry",
+  "preview.pane": "Preview",
+  "preview.entry.title": "Entry",
+  "preview.entry.readOnly": "Read-only",
+  "preview.entry.body": "The form is in the Content Manager: open it in another tab, edit and save the entry there. This page shows the saved draft and loads it again after each save.",
+  "preview.entry.bodyReadOnly": "You may read this entry but not edit it. The preview shows its saved draft.",
+  "preview.entry.locale": "Locale: {locale}",
+  "preview.entry.saved": "Draft saved {date}",
+  "preview.entry.open": "Open in the Content Manager, in a new tab",
+  "preview.entry.view": "View in the Content Manager, in a new tab",
+  "preview.device.group": "Preview width",
+  "preview.device.phone": "Phone",
+  "preview.device.tablet": "Tablet",
+  "preview.device.desktop": "Desktop",
+  "preview.static": "As static site",
+  "preview.locale": "Locale",
+  "preview.reload": "Reload",
+  "preview.updating": "Updating the preview",
+  "preview.shortcuts": "Shortcuts: Ctrl+Shift+1, 2 and 3 for phone, tablet and desktop; Ctrl+Shift+S for the static site; Ctrl+Shift+Left Arrow back to the entry. On a Mac use Command instead of Ctrl. They do not work while you type in a field.",
+  "preview.frame.title": "Preview of {title}",
+  "preview.blocked.title": "The admin does not allow this site in a frame",
+  "preview.blocked.body": "The Content Security Policy of the admin does not list {origin} in frame-src, so the browser refuses to show it. Add it to frame-src in the strapi::security config of the Strapi project and restart it. The host check on the Micelio status page reports it too.",
+  "preview.upgrade.title": "Upgrade the frontend",
+  "preview.upgrade.body": "The site's frontend speaks the preview protocol versions {versions}, and this plugin speaks none of them. The preview stays plain: it shows the draft and loads it again as a whole after each save.",
+  "preview.error.entry": "The entry could not be loaded.",
+  "preview.error.missing": "This entry does not exist.",
+  "preview.error.unavailable": "This site has no preview: set its url in the Content Manager (Site), and make sure the frontend runs there.",
+  "preview.error.forbidden": "You may not preview this entry. It needs the permission to preview drafts and the permission to read the entry.",
+  "preview.error.unsupported": "This type has no preview: its entries do not belong to a site.",
+  "preview.error.busy": "Too many preview requests. Wait a minute, then reload.",
+  "preview.error.failed": "The preview could not load. Reload to try again.",
+  "action.preview": "Preview",
+  "action.preview.unsaved": "Preview: save your changes first"
 }
 ;
 

package/dist/admin/src/utils/fetchError.d.ts

@@ -0,0 +1,2 @@
+/** The HTTP status of an error the admin's fetch client threw, if it carries one. */
+export declare function statusOf(error: unknown): number | undefined;

package/dist/admin/src/utils/previewAction.d.ts

@@ -0,0 +1,22 @@
+/** The part of a content type's schema the edit view's action reads. */
+export interface ActionSchema {
+    attributes?: Record<string, {
+        type?: string;
+    } | undefined>;
+    pluginOptions?: {
+        micelio?: {
+            siteScoped?: unknown;
+        };
+    };
+}
+/**
+ * Whether an entry of this type has a preview: the type belongs to a site (`withSiteScope`) and has
+ * a dynamic zone, which is where the blocks of a page live.
+ *
+ * @remarks
+ * The server's handler for Strapi's own "Open preview" button (`server/src/preview/shortcut.ts`)
+ * applies the same rule; the two stay apart because the admin imports nothing at runtime from the server.
+ */
+export declare function hasPreview(schema: ActionSchema | undefined): boolean;
+/** The admin path of the preview page for an entry, which `PreviewPage` reads (`preview/:uid/:documentId`). */
+export declare function previewPagePath(uid: string, documentId: string, locale: string | null): string;

package/dist/admin/src/utils/previewPane.d.ts

@@ -0,0 +1,59 @@
+/** The widths of the preview, as the design's toolbar offers them (phone, tablet and desktop). */
+export declare const DEVICES: readonly [{
+    readonly id: "phone";
+    readonly width: 320;
+}, {
+    readonly id: "tablet";
+    readonly width: 768;
+}, {
+    readonly id: "desktop";
+    readonly width: 1280;
+}];
+/** A device of the toolbar. */
+export type DeviceId = (typeof DEVICES)[number]['id'];
+/** What the toolbar shows: the draft with its islands, or with each island on its static alternative. */
+export type PreviewMode = 'live' | 'static';
+/** An action a shortcut of the Shortcuts sheet (Preview and Page groups) runs. */
+export type PreviewShortcut = {
+    action: 'device';
+    device: DeviceId;
+} | {
+    action: 'static' | 'back';
+};
+/** The minutes the page waits after it asked for a token before it asks for a new one: the grant lasts 15 minutes. */
+export declare const GRANT_REFRESH_MINUTES = 14;
+/** How often the page reads the document to notice a save made elsewhere, in milliseconds. */
+export declare const SAVE_POLL_MS = 4000;
+/** The envelope versions the admin speaks: its own release's (ADR-0019, section 4). */
+export declare const SPOKEN_VERSIONS: readonly number[];
+/** The keys of a keyboard event the shortcuts read. */
+export interface ShortcutEvent {
+    code: string;
+    key: string;
+    ctrlKey: boolean;
+    metaKey: boolean;
+    shiftKey: boolean;
+    altKey: boolean;
+    target: unknown;
+}
+/**
+ * The URL the iframe loads: the one the token route answered, asking for the static alternatives in
+ * static mode.
+ *
+ * @returns The URL, and the origin of the site, the only origin the page talks to; `undefined` when `url`
+ * is not an `http` or `https` URL.
+ */
+export declare function frameTarget(url: string, mode: PreviewMode): {
+    src: string;
+    origin: string;
+} | undefined;
+/** Whether a shortcut would land in a field the editor types in or chooses from with the keys. */
+export declare function isTypingTarget(target: unknown): boolean;
+/**
+ * The preview shortcut a key press is, from the Shortcuts sheet: ⌘⇧1, ⌘⇧2 and ⌘⇧3 for the widths,
+ * ⌘⇧S for "as static site" and ⌘⇧← back to the entry (⌘ is Ctrl on Windows and Linux).
+ *
+ * @remarks
+ * Never inside a field. A press with Alt, or with ⌘ and Ctrl together, is not one.
+ */
+export declare function previewShortcut(event: ShortcutEvent): PreviewShortcut | undefined;