simple-module-pagebuilder 0.0.1__py3-none-any.whl

pagebuilder/utils/pagesApi.ts

@@ -0,0 +1,111 @@
+/** Page, layout, and revision calls against the pagebuilder admin API. */
+
+import { request } from './request';
+import type {
+  LayoutDetail,
+  LayoutRevisionRead,
+  LayoutUpdate,
+  PageDetail,
+  PageRead,
+  PageRevisionRead,
+  PageWritePayload,
+  RevisionDiff,
+  ScheduleRequest,
+} from './types';
+
+export const createPage = (data: PageWritePayload & { title: string; slug: string }) =>
+  request<PageDetail>('/pages', { method: 'POST', body: JSON.stringify(data) });
+
+export const savePage = (id: number, data: PageWritePayload) =>
+  request<PageDetail>(`/pages/${id}`, { method: 'PUT', body: JSON.stringify(data) });
+
+export const deletePage = (id: number) => request<void>(`/pages/${id}`, { method: 'DELETE' });
+
+function noteBody(note?: string | null): BodyInit | undefined {
+  return note ? JSON.stringify({ note }) : undefined;
+}
+
+export const publishPage = (id: number, note?: string | null) =>
+  request<PageRead>(`/pages/${id}/publish`, {
+    method: 'POST',
+    body: noteBody(note),
+  });
+
+export const unpublishPage = (id: number, note?: string | null) =>
+  request<PageRead>(`/pages/${id}/unpublish`, {
+    method: 'POST',
+    body: noteBody(note),
+  });
+
+export const submitPage = (id: number, note?: string | null) =>
+  request<PageRead>(`/pages/${id}/submit`, {
+    method: 'POST',
+    body: noteBody(note),
+  });
+
+export const approvePage = (id: number, note?: string | null) =>
+  request<PageRead>(`/pages/${id}/approve`, {
+    method: 'POST',
+    body: noteBody(note),
+  });
+
+export const rejectPage = (id: number, note: string) =>
+  request<PageRead>(`/pages/${id}/reject`, {
+    method: 'POST',
+    body: JSON.stringify({ note }),
+  });
+
+export const listPendingPages = () => request<{ items: PageRead[] }>('/pages/pending');
+
+export const schedulePage = (id: number, body: ScheduleRequest) =>
+  request<PageRead>(`/pages/${id}/schedule`, {
+    method: 'POST',
+    body: JSON.stringify(body),
+  });
+
+/**
+ * Drive a rejection prompt → reject API round-trip. Returns the
+ * updated page on success, or a string describing why the call was
+ * skipped (cancelled / empty note / API error).
+ *
+ * Shared by the editor and the pending-review queue so both surfaces
+ * stay in sync on prompt copy + empty-note handling.
+ */
+export async function promptAndReject(id: number): Promise<PageRead | { skipped: string }> {
+  const note = window.prompt('Reason for rejection (shown to the editor):');
+  if (note === null) return { skipped: 'cancelled' };
+  const trimmed = note.trim();
+  if (!trimmed) return { skipped: 'A rejection note is required.' };
+  try {
+    return await rejectPage(id, trimmed);
+  } catch (e) {
+    return { skipped: e instanceof Error ? e.message : 'Reject failed' };
+  }
+}
+
+export const listRevisions = (id: number) =>
+  request<{ items: PageRevisionRead[] }>(`/pages/${id}/revisions`);
+
+export const restoreRevision = (pageId: number, revisionId: number) =>
+  request<PageDetail>(`/pages/${pageId}/revisions/${revisionId}/restore`, {
+    method: 'POST',
+  });
+
+export const diffRevisions = (pageId: number, beforeId: number, afterId: number) =>
+  request<RevisionDiff>(`/pages/${pageId}/revisions/${beforeId}/diff/${afterId}`);
+
+export const getLayout = () => request<LayoutDetail>('/layout');
+
+export const saveLayout = (body: LayoutUpdate) =>
+  request<LayoutDetail>('/layout', {
+    method: 'PUT',
+    body: JSON.stringify(body),
+  });
+
+export const listLayoutRevisions = () =>
+  request<{ items: LayoutRevisionRead[] }>('/layout/revisions');
+
+export const restoreLayoutRevision = (revisionId: number) =>
+  request<LayoutDetail>(`/layout/revisions/${revisionId}/restore`, {
+    method: 'POST',
+  });

pagebuilder/utils/parse-list.ts

@@ -0,0 +1,7 @@
+export function parseList(value: string | undefined | null): string[] {
+  if (!value) return [];
+  return value
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .filter(Boolean);
+}

pagebuilder/utils/request.ts

@@ -0,0 +1,52 @@
+/**
+ * Shared fetch plumbing for the pagebuilder JSON admin API.
+ *
+ * All endpoints live under `/api/pagebuilder` and return JSON. We use
+ * plain fetch + same-origin cookies for auth, plus an `X-CSRF-Token`
+ * header on every mutating request (token is read from the
+ * `pagebuilder_csrf` cookie set by the view layer).
+ */
+
+export const BASE = '/api/pagebuilder';
+
+export const CSRF_COOKIE = 'pagebuilder_csrf';
+
+const UNSAFE_METHODS = new Set(['POST', 'PUT', 'PATCH', 'DELETE']);
+
+export function readCookie(name: string): string | null {
+  if (typeof document === 'undefined') return null;
+  const target = `${name}=`;
+  for (const piece of document.cookie.split(';')) {
+    const trimmed = piece.trim();
+    if (trimmed.startsWith(target)) {
+      return decodeURIComponent(trimmed.slice(target.length));
+    }
+  }
+  return null;
+}
+
+export async function request<T>(path: string, init: RequestInit = {}): Promise<T> {
+  const isFormData = init.body instanceof FormData;
+  const method = (init.method ?? 'GET').toUpperCase();
+  const csrfHeaders: Record<string, string> = {};
+  if (UNSAFE_METHODS.has(method)) {
+    const token = readCookie(CSRF_COOKIE);
+    if (token) csrfHeaders['X-CSRF-Token'] = token;
+  }
+  const response = await fetch(`${BASE}${path}`, {
+    credentials: 'same-origin',
+    headers: {
+      ...(isFormData ? {} : { 'Content-Type': 'application/json' }),
+      Accept: 'application/json',
+      ...csrfHeaders,
+      ...(init.headers || {}),
+    },
+    ...init,
+  });
+  if (!response.ok) {
+    const text = await response.text();
+    throw new Error(`Request failed (${response.status}): ${text}`);
+  }
+  if (response.status === 204) return undefined as T;
+  return (await response.json()) as T;
+}

pagebuilder/utils/slugify.ts

@@ -0,0 +1,9 @@
+export function slugify(value: string): string {
+  return value
+    .toLowerCase()
+    .normalize('NFKD')
+    .replace(/[̀-ͯ]/g, '')
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .slice(0, 200);
+}

pagebuilder/utils/types.ts

@@ -0,0 +1,171 @@
+/**
+ * Wire types for the pagebuilder JSON admin API.
+ *
+ * These mirror the Pydantic DTOs in `pagebuilder.contracts.schemas`. Keep
+ * the two in sync when either changes.
+ */
+
+export type PageStatus = 'draft' | 'submitted_for_review' | 'published';
+
+export type RevisionEvent = 'publish' | 'unpublish' | 'submit' | 'approve' | 'reject';
+
+export interface PageRead {
+  id: number;
+  slug: string;
+  title: string;
+  status: PageStatus;
+  has_published: boolean;
+  meta_description: string | null;
+  og_image: string | null;
+  canonical_url: string | null;
+  index_in_search: boolean;
+  rejection_note: string | null;
+  publish_at: string | null;
+  unpublish_at: string | null;
+  created_at: string;
+  updated_at: string | null;
+}
+
+export interface PageDetail extends PageRead {
+  draft_data: Record<string, unknown>;
+  published_data: Record<string, unknown> | null;
+  json_ld: Record<string, unknown> | null;
+}
+
+export interface LayoutDetail {
+  id: number;
+  header_data: Record<string, unknown>;
+  footer_data: Record<string, unknown>;
+  created_at: string;
+  updated_at: string | null;
+}
+
+export interface LayoutRevisionRead {
+  id: number;
+  layout_id: number;
+  note: string | null;
+  created_at: string;
+  created_by: string | null;
+}
+
+export interface LayoutUpdate {
+  header_data?: Record<string, unknown> | null;
+  footer_data?: Record<string, unknown> | null;
+  note?: string | null;
+}
+
+export interface PageRevisionRead {
+  id: number;
+  page_id: number;
+  title: string;
+  meta_description: string | null;
+  og_image: string | null;
+  event: RevisionEvent;
+  note: string | null;
+  created_at: string;
+  created_by: string | null;
+}
+
+export interface MediaAssetVariant {
+  filename: string;
+  url: string;
+  content_type: string;
+  width: number;
+  height: number | null;
+  size_bytes: number;
+}
+
+export interface MediaAssetRead {
+  id: number;
+  filename: string;
+  original_filename: string;
+  content_type: string;
+  size_bytes: number;
+  url: string;
+  width: number | null;
+  height: number | null;
+  folder: string | null;
+  variants: Record<string, MediaAssetVariant>;
+  created_at: string;
+}
+
+export interface MediaListResponse {
+  items: MediaAssetRead[];
+  next_cursor: number | null;
+  folders: string[];
+  /** Only present when the request used offset paging. */
+  total?: number | null;
+}
+
+export interface MediaListQuery {
+  search?: string;
+  content_type?: string;
+  /**
+   * Folder filter. Omit for "any folder", pass an empty string for
+   * "Unfiled" (rows where folder IS NULL), or pass a path like
+   * "marketing/heros" to match an exact folder.
+   */
+  folder?: string;
+  min_size_bytes?: number;
+  max_size_bytes?: number;
+  cursor?: number;
+  /** Offset paging, used by the image-picker gallery. Makes the response
+   *  carry `total`; takes precedence over `cursor`. */
+  offset?: number;
+  limit?: number;
+}
+
+export interface PageWritePayload {
+  title?: string;
+  slug?: string;
+  meta_description?: string | null;
+  og_image?: string | null;
+  canonical_url?: string | null;
+  index_in_search?: boolean;
+  json_ld?: Record<string, unknown> | null;
+  draft_data?: Record<string, unknown>;
+  publish_at?: string | null;
+  unpublish_at?: string | null;
+}
+
+/**
+ * Body for ``POST /pages/{id}/schedule``.
+ *
+ * A field's *presence* tells the server "act on me" — omit a field to
+ * leave the stored value alone, send ``null`` to clear it, send an ISO
+ * timestamp to set it. So ``{publish_at: "2026-…"}`` schedules a publish
+ * without touching ``unpublish_at``.
+ */
+export interface ScheduleRequest {
+  publish_at?: string | null;
+  unpublish_at?: string | null;
+}
+
+export interface BlockChange {
+  id: string;
+  type?: string;
+  fields: string[];
+  type_before?: string;
+}
+
+export interface MetadataChange {
+  before: unknown;
+  after: unknown;
+}
+
+export interface RevisionDiff {
+  before_id: number;
+  after_id: number;
+  metadata: Record<string, MetadataChange>;
+  blocks: {
+    added: BlockChange[];
+    removed: BlockChange[];
+    changed: BlockChange[];
+  };
+}
+
+export interface UploadMediaOptions {
+  folder?: string | null;
+  onProgress?: (loaded: number, total: number) => void;
+  signal?: AbortSignal;
+}

pagebuilder/utils/widgetUtils.ts

@@ -0,0 +1,11 @@
+/** Barrel for helpers the ported GCA widgets import as a group.
+ *
+ * Mirrors the source package's `utils` barrel. `cn` came from @geowiki/shared
+ * there; here it comes from the UI package we already depend on, so there's no
+ * second clsx/tailwind-merge implementation in the tree.
+ */
+
+export { cn } from '@simple-module-py/ui/lib/utils';
+
+export { decorativeAriaProps } from './decorative-image';
+export { parseList } from './parse-list';

simple_module_pagebuilder-0.0.1.dist-info/METADATA

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: simple_module_pagebuilder
+Version: 0.0.1
+Summary: Drag-and-drop visual page builder for simple_module apps
+Project-URL: Repository, https://github.com/antosubash/simple_module_python_modules
+Author-email: Anto Subash <antosubash@live.com>
+License-Expression: MIT
+Keywords: cms,pagebuilder,puck,simple-module
+Requires-Python: >=3.12
+Requires-Dist: pillow>=10.0
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: simple-module-core<0.1,>=0.0.25
+Requires-Dist: simple-module-db<0.1,>=0.0.25
+Requires-Dist: simple-module-hosting<0.1,>=0.0.25
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: sqlmodel>=0.0.21
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: simple-module-test<0.1,>=0.0.25; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# simple_module_pagebuilder
+
+Drag-and-drop visual page builder for [simple_module](https://github.com/antosubash/simple_module_python)
+apps. Pages are composed from a reusable block library using
+[Puck](https://puckeditor.com) and stored as JSON; published pages are served
+at `/p/{slug}`.
+
+## Features
+
+- **Visual editor** — Puck-based drag-and-drop with a block library (heading,
+  text, image, button, columns, spacer) and a media picker.
+- **Site layout** — a shared header/footer layout, edited the same way, wrapped
+  around every public page.
+- **Media library** — uploads with magic-byte content sniffing, folder
+  organisation, and server-generated WebP thumbnails.
+- **Revisions** — every status transition snapshots the page, with a diff view
+  and restore-as-draft.
+- **Approval workflow** — edit → submit for review → approve / reject, gated by
+  three separate permissions.
+- **Scheduled publishing** — set `publish_at` / `unpublish_at`; a background
+  poller flips status at the due time.
+- **SEO** — per-page meta description, canonical URL, OG image, JSON-LD, plus
+  `/sitemap.xml` and `/robots.txt`.
+
+## Installation
+
+```bash
+uv add simple_module_pagebuilder
+```
+
+Then add it to your host's `pyproject.toml` dependencies. The module is
+discovered at boot through the `simple_module` entry point — no registration
+code required.
+
+Its frontend ships inside the wheel. Pull its JS dependencies into your host's
+client app and regenerate the page manifest with:
+
+```bash
+smpy host sync-js-deps --host-client-app=host/client_app
+smpy host gen-pages --host-dir=host/client_app
+```
+
+## Usage
+
+Once installed and migrated, sign in and open `/pagebuilder`:
+
+1. **Create a page** — `/pagebuilder/new`. Give it a title; the slug is derived
+   from it and stays editable.
+2. **Compose it** — drag blocks from the Puck sidebar. Images come from the
+   media library, which uploads and thumbnails them for you.
+3. **Publish it** — publish directly with `pagebuilder.publish`, or submit for
+   review if your role only carries `pagebuilder.edit`. Reviewers work through
+   `/pagebuilder/pending`.
+4. **Schedule it** — set `publish_at` / `unpublish_at` instead of publishing
+   now, and the poller flips the status at the due time.
+5. **View it** — the page is live at `/p/{slug}`, wrapped in the site layout
+   from `/pagebuilder/layout`.
+
+Every transition writes a revision, so `/pagebuilder/{id}/edit` can compare any
+two revisions and restore either one as a draft.
+
+## Migrations
+
+This module ships **no** migrations — that is the framework convention. Its
+SQLModel tables are picked up by your host's `build_module_metadata()`, so
+after installing it run:
+
+```bash
+make migration msg="add pagebuilder"
+make migrate
+```
+
+Add `branch_labels = ("pagebuilder",)` to that first generated revision so the
+module can later be removed on its own with
+`alembic downgrade pagebuilder@base`.
+
+## Permissions
+
+| Permission | Grants |
+|---|---|
+| `pagebuilder.edit` | Draft, save, submit for review, restore a revision |
+| `pagebuilder.publish` | Publish and unpublish directly |
+| `pagebuilder.approve` | Approve or reject a submitted page |
+
+`DEFAULT_ROLE_MAP` in `pagebuilder.permissions` suggests three roles —
+`pagebuilder_editor`, `pagebuilder_publisher`, `pagebuilder_approver` —
+cumulatively mapped to those permissions.
+
+## Settings
+
+All settings use the `SM_PAGEBUILDER_` env prefix.
+
+| Setting | Default | Purpose |
+|---|---|---|
+| `public_route_prefix` | `/p` | Where published pages are served |
+| `requires_auth` | `true` | Gate the admin surface behind authentication |
+| `csrf_protect` | `true` | Require a CSRF token on mutating admin requests |
+| `media_root` | `var/pagebuilder/media` | Upload storage directory |
+| `media_url_prefix` | `/media/pagebuilder` | Public URL prefix for uploads |
+| `media_max_bytes` | `10485760` | Per-upload size ceiling |
+| `media_thumbnail_widths` | `320,640,1280,1920` | Widths generated as WebP |
+| `media_webp_quality` | `82` | WebP encoder quality |
+| `public_csp` | see `settings.py` | CSP header on public pages |
+| `public_cache_max_age` | `60` | `max-age` on public pages |
+| `public_base_url` | `None` | Absolute base for canonical URLs and the sitemap |
+| `site_name` | `None` | OpenGraph site name |
+| `sitemap_enabled` | `true` | Serve `/sitemap.xml` |
+| `robots_enabled` | `true` | Serve `/robots.txt` |
+| `scheduler_enabled` | `true` | Run the scheduled publish/unpublish poller |
+| `scheduler_interval_seconds` | `30` | Poll interval |
+
+## Routes
+
+**Admin views** (under `/pagebuilder`): `/`, `/new`, `/{page_id}/edit`,
+`/pending`, `/layout`, `/media`.
+
+**Admin API** (under `/api/pagebuilder`): pages CRUD, workflow transitions,
+revisions and diffs, layout and its revisions, uploads.
+
+**Public**: `/p/{slug}`, `/sitemap.xml`, `/robots.txt`.
+
+## Contracts
+
+DTOs other modules may depend on are exported from `pagebuilder.contracts`.
+Everything else in the package is internal and may change without a major
+version bump.
+
+## Licence
+
+MIT