@codepress/blog 0.2.0 → 0.3.0

package/dist/editor/BlogEditorMount.d.ts

@@ -27,6 +27,8 @@ export interface BlogEditorMountProps {
     auth: BlogEditorAuth;
     /** A post that does not exist yet: open the editor straight away. */
     isNew?: boolean;
+    /** Open an existing post's editor straight away instead of showing the Edit button. */
+    startEditing?: boolean;
     /** The host page's header the toolbar pins below. */
     header?: BlogEditorHeader;
     /** The reading column's classes; defaults to a 720px column. */
@@ -68,4 +70,4 @@ export declare function appPageUrl(appUrl: string, organizationSlug: string | nu
  * the answer is `can_edit`; everyone else gets nothing and never downloads the
  * editor.
  */
-export declare function BlogEditorMount({ site, slug, apiBase, auth, isNew, header, column, appUrl, timings, onEditingChange, onPublished, onLeave, controller, slots, actions, }: BlogEditorMountProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function BlogEditorMount({ site, slug, apiBase, auth, isNew, startEditing, header, column, appUrl, timings, onEditingChange, onPublished, onLeave, controller, slots, actions, }: BlogEditorMountProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/editor/client.d.ts

@@ -40,6 +40,8 @@ export interface Capabilities {
     /** The org that owns the site and the repo its posts live in; set for editors only. */
     organization_slug?: string | null;
     repository_full_name?: string | null;
+    /** Whether the site's organization lets editors edit on the site's own page; reported to anyone. */
+    host_editing_enabled?: boolean;
 }
 export type SaveResult = {
     kind: "saved";
@@ -73,7 +75,11 @@ export interface DraftClient {
     } | {
         error: string;
     }>;
-    saveDraft(site: string, slug: string, html: string, baseSha: string | null): Promise<SaveResult>;
+    saveDraft(site: string, slug: string, html: string, baseSha: string | null, 
+    /** `keepalive`: the page is going away, so the request must outlive it. */
+    options?: {
+        keepalive?: boolean;
+    }): Promise<SaveResult>;
     publishDraft(site: string, slug: string): Promise<ActionResult>;
     discardDraft(site: string, slug: string): Promise<ActionResult>;
 }

package/dist/editor/client.js

@@ -1,6 +1,6 @@
 import {
   createDraftClient
-} from "../chunks/chunk-3WRTL63O.js";
+} from "../chunks/chunk-WEBQTRDI.js";
 export {
   createDraftClient
 };

package/dist/editor/config.d.ts

@@ -22,3 +22,9 @@ export declare const DEFAULT_APP_URL = "https://codepress.dev";
  * viewport y of its bottom edge. Floating panels (Ask CodePress) keep below it.
  */
 export declare const BLOG_TOOLBAR_BOTTOM_VAR = "--blog-toolbar-bottom";
+/**
+ * The class every editor root carries (the editor, the Edit button, the
+ * loading notice, the new-post form, and the portaled menus and tooltips).
+ * `@codepress/blog/editor.css` styles only inside it.
+ */
+export declare const EDITOR_SCOPE_CLASS = "cp-blog-editor";

package/dist/editor/host.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Editing a blog on the site's own page. The page never sees a CodePress
+ * login: Edit hands off to codepress.dev's consent page with a PKCE
+ * challenge, which sends the browser back to the callback route with a
+ * one-time code, and the callback trades the code (with the verifier this tab
+ * kept) for a site-scoped editor token that lives 30 minutes in this tab's
+ * sessionStorage. Nothing renders unless the content site reports host
+ * editing enabled.
+ *
+ * Client-only. In the App Router a `"use client"` file must import these (the
+ * file `init` writes), because this entry also exports non-component helpers.
+ */
+import { type ReactNode } from "react";
+import { type BlogEditorTimings } from "./config.js";
+/** The query parameter that opens the editor on a post, or the new-post form on the index. */
+export declare const EDIT_PARAM = "cp-edit";
+/** Where the callback route lives below the blog's base path. */
+export declare const CALLBACK_SEGMENT = "__cp/callback";
+/** The consent page on the CodePress app. */
+export declare const CONSENT_PATH = "/blog-edit/consent";
+/** Page loads this module starts; a test replaces them. */
+export declare const navigation: {
+    assign: (url: string) => void;
+    replace: (url: string) => void;
+};
+/** How a site's pages reach its CodePress content site. */
+export interface HostEditingConfig {
+    /** The content site's slug. */
+    site: string;
+    /** The CodePress API root, `…/v1`. */
+    apiBase: string;
+    /** Where the blog is mounted, e.g. `/blog`. */
+    basePath: string;
+    /** The CodePress app (consent, Ask CodePress, History); defaults to https://codepress.dev. */
+    appUrl?: string;
+    /** The page's ISR window in seconds, for the note after a publish. */
+    revalidate?: number;
+    timings?: Partial<BlogEditorTimings>;
+}
+export interface HostEditingProps extends HostEditingConfig {
+    /** The post on this page; omitted on the index, which offers New post. */
+    slug?: string;
+    /** The page as readers see it; hidden while editing. */
+    children?: ReactNode;
+}
+interface StoredToken {
+    token: string;
+    /** Epoch milliseconds. */
+    expiresAt: number;
+}
+/** This tab's editor token for `site`, or null when there is none or it has (nearly) expired. */
+export declare function readSiteToken(site: string, now?: number): StoredToken | null;
+export declare function clearSiteToken(site: string): void;
+/** A PKCE verifier: 32 random bytes, base64url (43 characters). */
+export declare function createVerifier(): string;
+/** The S256 challenge of `verifier`. */
+export declare function challengeFor(verifier: string): Promise<string>;
+/** The callback route's path for a blog mounted at `basePath`. */
+export declare function callbackPath(basePath: string): string;
+/**
+ * `value` when it is a path on this site below the blog, else the blog's
+ * index: the callback never sends the browser anywhere else.
+ */
+export declare function safeReturnPath(basePath: string, value: string | null | undefined): string;
+/** The consent page URL for this page. */
+export declare function consentUrl({ appUrl, site, origin, basePath, challenge, }: {
+    appUrl: string;
+    site: string;
+    origin: string;
+    basePath: string;
+    challenge: string;
+}): string;
+/** Starts the hand-off: keeps a verifier in this tab, then goes to the consent page. */
+export declare function startHandoff(config: Pick<HostEditingConfig, "site" | "basePath" | "appUrl">, returnTo: string): Promise<void>;
+/** A same-tab, same-origin link click that would leave this page, as an absolute URL. */
+export declare function leavingLinkOf(event: MouseEvent): string | null;
+/**
+ * The page's edit mode: an Edit link on a post (New post on the index) when
+ * the content site reports host editing enabled; with `?cp-edit` and this
+ * tab's site token, the editor over the post; without a token, the consent
+ * hand-off. Readers see `children` and nothing else.
+ */
+export declare function HostEditing({ site, apiBase, basePath, appUrl, revalidate, timings, slug, children, }: HostEditingProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * The callback route (`<basePath>/__cp/callback`): trades the consent page's
+ * code and this tab's verifier for the site token, then returns to the page
+ * that started. A declined consent, or a site that does not report host
+ * editing enabled, goes back to that page without editing; opened directly
+ * on such a site, it renders nothing.
+ */
+export declare function HostEditorCallback({ site, apiBase, basePath, }: HostEditingConfig): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/editor/index.d.ts

@@ -6,7 +6,8 @@
 export { BlogEditorMount, appPageUrl, type AskPanelProps, type BlogEditorMountProps, type DesignLinkContext, } from "./BlogEditorMount.js";
 export type { BlogEditorController, BlogEditorControllerRef, } from "./controller.js";
 export { NewPostForm, isValidNewSlug, type NewPostFormProps, } from "./NewPostForm.js";
-export { BLOG_TOOLBAR_BOTTOM_VAR, DEFAULT_TIMINGS, type BlogEditorTimings, } from "./config.js";
+export { BLOG_TOOLBAR_BOTTOM_VAR, DEFAULT_TIMINGS, EDITOR_SCOPE_CLASS, type BlogEditorTimings, } from "./config.js";
 export { DEFAULT_HEADER_SELECTOR, type BlogEditorHeader } from "./header.js";
 export { designUrl, type DesignTarget } from "./EditDesignLink.js";
+export { CALLBACK_SEGMENT, CONSENT_PATH, EDIT_PARAM, HostEditing, HostEditorCallback, callbackPath, challengeFor, clearSiteToken, consentUrl, createVerifier, readSiteToken, safeReturnPath, startHandoff, type HostEditingConfig, type HostEditingProps, } from "./host.js";
 export * from "./client.js";