@agntcms/next 0.2.0

package/dist/server.d.cts

@@ -0,0 +1,153 @@
+import { G as GetGlobal, P as PreviewMode } from './rateLimit-CiROGTLE.cjs';
+export { F as FieldIn, a as GetContent, b as GetContentInput, c as GetContentOptions, d as GetGlobalInput, L as ListPages, e as ListPagesInput, f as ListPagesSort, g as PageContent, h as PreviewField, i as PreviewFieldOrigin, R as RateLimit, j as RateLimitOptions, k as RateLimitResult, l as Runtime, m as RuntimeOptions, S as SubmitForm, n as SubmitFormDeps, o as SubmitFormInput, p as SubmitFormResult, q as createListPages, r as createRateLimit, s as createRuntime, t as createSubmitForm } from './rateLimit-CiROGTLE.cjs';
+import { C as ContentStorageAdapter, A as AssetStorageAdapter } from './assets-Cyt9upqW.cjs';
+export { a as AssetUploadInput, b as AssetUploadResult, D as DraftSummary, G as GlobalSummary, H as HistoryEntry, P as PageMode, c as PageSummaryEntry, d as PublishedPageEntry } from './assets-Cyt9upqW.cjs';
+import { o as SubmissionStorageAdapter } from './form-BqY0H1V5.cjs';
+export { A as AnyFormDefinition, j as BooleanField, B as ButtonField, i as ButtonValue, c as FieldDescriptor, y as FieldKind, x as FieldValueFor, b as FormDefinition, p as FormFieldDescriptor, q as FormFieldOverride, n as FormFieldOverrides, r as FormOverridesField, m as FormOverridesFieldDescriptor, a as FormSchema, I as ImageField, d as ImageValue, L as LinkField, h as LinkValue, l as ListField, z as ListItem, N as NumberField, P as Page, C as PageSeo, w as PageSummary, f as ReferenceField, g as ReferenceValue, R as RichTextField, D as Section, S as SectionSchema, k as SelectField, E as SelectOption, s as Submission, t as SubmissionAdapterInfo, u as SubmissionSummary, v as SubmissionsNotReadableError, T as TextField, V as VideoField, e as VideoValue } from './form-BqY0H1V5.cjs';
+export { hasUniqueSectionIds, hrefOf, isExternalLink, linkAnchorAttrs, normalizeLinkValue, validateEmail, validateExternalUrl, validateInternalSlug, validatePhone } from './index.cjs';
+export { G as Global } from './global-CV23g5Bn.cjs';
+import { A as AnySectionDefinition } from './defineSection-9qQ5ulAH.cjs';
+export { D as DataOf, a as DefineSectionInput, F as FieldDataType, S as SectionComponent, b as SectionDefinition, d as defineSection } from './defineSection-9qQ5ulAH.cjs';
+import { ReactNode } from 'react';
+export { D as DefineFormInput, H as HoneypotCollisionError, I as InvalidFormFieldError, a as InvalidFormNameError, d as defineForm } from './defineForm-CJ8KZC93.cjs';
+export { D as DuplicateFormNameError, F as FormDefinitionList, a as FormRegistry, b as buildFormRegistry } from './registry-CraTTwT7.cjs';
+
+declare const NOT_FOUND_PAGE_SLUG = "404";
+declare const SERVER_ERROR_PAGE_SLUG = "500";
+interface ReservedPageSlugViolation {
+    readonly slug: string;
+    readonly canonicalSlug: string;
+    readonly message: string;
+}
+declare const getReservedPageSlugViolation: (slug: string) => ReservedPageSlugViolation | null;
+declare const isSitemapEligibleSlug: (slug: string) => boolean;
+
+/** Config for `createFsContentAdapter`. */
+interface FsContentAdapterOptions {
+    /** Absolute path to the root of the content tree (ARCHITECTURE.md §3). */
+    readonly contentRoot: string;
+}
+declare const createFsContentAdapter: (options: FsContentAdapterOptions) => ContentStorageAdapter;
+
+/** Config for `createFsAssetAdapter`. */
+interface FsAssetAdapterOptions {
+    /**
+     * Absolute path to the directory where uploaded bytes land. In the
+     * template this is `public/assets/`, served as static files by Next.js.
+     */
+    readonly assetsRoot: string;
+    /**
+     * URL prefix prepended to stored filenames to produce `AssetUploadResult.url`.
+     * Example: `/assets` yields URLs like `/assets/<hash>.png`.
+     * The prefix MUST NOT end in `/`; the adapter always joins with a single
+     * `/` before the filename.
+     */
+    readonly publicUrlBase: string;
+}
+declare const createFsAssetAdapter: (options: FsAssetAdapterOptions) => AssetStorageAdapter;
+
+/** Config for `createFsSubmissionAdapter`. */
+interface FsSubmissionAdapterOptions {
+    /** Absolute path to the root of the submissions tree (e.g. `<projectRoot>/content/submissions`). */
+    readonly submissionsRoot: string;
+    /**
+     * Maximum number of newest entries `list()` returns. Default: 500.
+     * Bounds the AdminModal "Submissions" tab response size — a v1
+     * mitigation in lieu of full pagination (deferred to v0.3, see
+     * ARCHITECTURE.md §11). Older entries beyond the cap are still on
+     * disk but invisible to `list`. Must be a positive integer.
+     */
+    readonly maxList?: number;
+}
+declare const createFsSubmissionAdapter: (options: FsSubmissionAdapterOptions) => SubmissionStorageAdapter;
+
+/** Config for `createWebhookSubmissionAdapter`. */
+interface WebhookSubmissionAdapterOptions {
+    /** Absolute URL to POST submissions to. MUST be `http(s)://...`. */
+    readonly url: string;
+    /** Optional headers (e.g. `Authorization: Bearer ...`). */
+    readonly headers?: Record<string, string>;
+    /**
+     * Per-request timeout in milliseconds. Default: 10_000 (10s). When the
+     * webhook does not respond within this window we abort the fetch and
+     * throw — the route handler catches and maps to HTTP 502, so a hung
+     * upstream cannot block a Next.js worker. Set to a positive integer.
+     */
+    readonly timeoutMs?: number;
+    /**
+     * Fetch implementation. Optional — defaults to the global `fetch`. Tests
+     * pass a fake. Typed as the minimal surface we use to avoid pinning to
+     * a specific lib.dom/node-types version.
+     */
+    readonly fetch?: WebhookFetch;
+}
+/** Minimal `fetch`-like signature needed by the webhook adapter. */
+type WebhookFetch = (url: string, init: WebhookFetchInit) => Promise<WebhookFetchResponse>;
+interface WebhookFetchInit {
+    readonly method: 'POST';
+    readonly headers: Record<string, string>;
+    readonly body: string;
+    /**
+     * Optional `AbortSignal` for the per-request timeout. The adapter
+     * always sets this when calling `fetch`. The fake fetch used in tests
+     * may inspect `signal.aborted` to simulate a timed-out request.
+     */
+    readonly signal?: AbortSignal;
+}
+interface WebhookFetchResponse {
+    readonly ok: boolean;
+    readonly status: number;
+    text(): Promise<string>;
+}
+declare const createWebhookSubmissionAdapter: (options: WebhookSubmissionAdapterOptions) => SubmissionStorageAdapter;
+
+interface DefaultAdapterOptions {
+    /** Project root. Defaults to `process.cwd()`. */
+    readonly projectRoot?: string;
+}
+/**
+ * Create the default FS content adapter using the canonical path
+ * `<projectRoot>/content` (ARCHITECTURE.md §3).
+ */
+declare function createDefaultContentAdapter(options?: DefaultAdapterOptions): ContentStorageAdapter;
+/**
+ * Create the default FS asset adapter using the canonical path
+ * `<projectRoot>/public/assets` with URL base `/assets`
+ * (ARCHITECTURE.md §3).
+ */
+declare function createDefaultAssetAdapter(options?: DefaultAdapterOptions): AssetStorageAdapter;
+/**
+ * Create the default FS submission adapter using the canonical path
+ * `<projectRoot>/content/submissions` (ARCHITECTURE.md §3, §6.5).
+ *
+ * Templates are expected to add `content/submissions/` to `.gitignore`
+ * (skills-dev scope, Dispatch 3 territory). The framework does not
+ * touch git here.
+ */
+declare function createDefaultSubmissionAdapter(options?: DefaultAdapterOptions): SubmissionStorageAdapter;
+
+interface GlobalSlotProps {
+    /** The global's name as registered in `content/globals/<name>.json`. */
+    readonly name: string;
+    /** The runtime's `getGlobal` (from `createRuntime`). */
+    readonly getGlobal: GetGlobal;
+    /** Section definitions registry. Same shape as `<PageRenderer>` consumes. */
+    readonly definitions: readonly AnySectionDefinition[];
+    /**
+     * Read mode — same `'preview' | 'published'` as `getContent`. The
+     * caller passes the same value it would pass to `getContent`,
+     * typically derived from `draftMode().isEnabled`.
+     */
+    readonly mode: PreviewMode;
+    /** Rendered when the global doesn't exist or has no matching definition. */
+    readonly fallback?: ReactNode;
+}
+/**
+ * Renders a named global by looking up its `type` in the section
+ * definitions registry. When `mode === 'preview'`, wraps the render
+ * output with a `GlobalSaveProvider` so descendant editable widgets
+ * dispatch saves to `/api/agntcms/global/save`.
+ */
+declare function GlobalSlot(props: GlobalSlotProps): Promise<React.ReactElement | null>;
+
+export { AnySectionDefinition, AssetStorageAdapter, ContentStorageAdapter, type DefaultAdapterOptions, type FsAssetAdapterOptions, type FsContentAdapterOptions, type FsSubmissionAdapterOptions, GetGlobal, GlobalSlot, type GlobalSlotProps, NOT_FOUND_PAGE_SLUG, PreviewMode, SERVER_ERROR_PAGE_SLUG, SubmissionStorageAdapter, type WebhookFetch, type WebhookFetchInit, type WebhookFetchResponse, type WebhookSubmissionAdapterOptions, createDefaultAssetAdapter, createDefaultContentAdapter, createDefaultSubmissionAdapter, createFsAssetAdapter, createFsContentAdapter, createFsSubmissionAdapter, createWebhookSubmissionAdapter, getReservedPageSlugViolation, isSitemapEligibleSlug };

package/dist/server.d.ts

@@ -0,0 +1,153 @@
+import { G as GetGlobal, P as PreviewMode } from './rateLimit-CXptRM_K.js';
+export { F as FieldIn, a as GetContent, b as GetContentInput, c as GetContentOptions, d as GetGlobalInput, L as ListPages, e as ListPagesInput, f as ListPagesSort, g as PageContent, h as PreviewField, i as PreviewFieldOrigin, R as RateLimit, j as RateLimitOptions, k as RateLimitResult, l as Runtime, m as RuntimeOptions, S as SubmitForm, n as SubmitFormDeps, o as SubmitFormInput, p as SubmitFormResult, q as createListPages, r as createRateLimit, s as createRuntime, t as createSubmitForm } from './rateLimit-CXptRM_K.js';
+import { C as ContentStorageAdapter, A as AssetStorageAdapter } from './assets-P8OCigDG.js';
+export { a as AssetUploadInput, b as AssetUploadResult, D as DraftSummary, G as GlobalSummary, H as HistoryEntry, P as PageMode, c as PageSummaryEntry, d as PublishedPageEntry } from './assets-P8OCigDG.js';
+import { o as SubmissionStorageAdapter } from './form-BqY0H1V5.js';
+export { A as AnyFormDefinition, j as BooleanField, B as ButtonField, i as ButtonValue, c as FieldDescriptor, y as FieldKind, x as FieldValueFor, b as FormDefinition, p as FormFieldDescriptor, q as FormFieldOverride, n as FormFieldOverrides, r as FormOverridesField, m as FormOverridesFieldDescriptor, a as FormSchema, I as ImageField, d as ImageValue, L as LinkField, h as LinkValue, l as ListField, z as ListItem, N as NumberField, P as Page, C as PageSeo, w as PageSummary, f as ReferenceField, g as ReferenceValue, R as RichTextField, D as Section, S as SectionSchema, k as SelectField, E as SelectOption, s as Submission, t as SubmissionAdapterInfo, u as SubmissionSummary, v as SubmissionsNotReadableError, T as TextField, V as VideoField, e as VideoValue } from './form-BqY0H1V5.js';
+export { hasUniqueSectionIds, hrefOf, isExternalLink, linkAnchorAttrs, normalizeLinkValue, validateEmail, validateExternalUrl, validateInternalSlug, validatePhone } from './index.js';
+export { G as Global } from './global-CV23g5Bn.js';
+import { A as AnySectionDefinition } from './defineSection-Kr0pWqMY.js';
+export { D as DataOf, a as DefineSectionInput, F as FieldDataType, S as SectionComponent, b as SectionDefinition, d as defineSection } from './defineSection-Kr0pWqMY.js';
+import { ReactNode } from 'react';
+export { D as DefineFormInput, H as HoneypotCollisionError, I as InvalidFormFieldError, a as InvalidFormNameError, d as defineForm } from './defineForm-Bp9vzW56.js';
+export { D as DuplicateFormNameError, F as FormDefinitionList, a as FormRegistry, b as buildFormRegistry } from './registry-DMujGqt0.js';
+
+declare const NOT_FOUND_PAGE_SLUG = "404";
+declare const SERVER_ERROR_PAGE_SLUG = "500";
+interface ReservedPageSlugViolation {
+    readonly slug: string;
+    readonly canonicalSlug: string;
+    readonly message: string;
+}
+declare const getReservedPageSlugViolation: (slug: string) => ReservedPageSlugViolation | null;
+declare const isSitemapEligibleSlug: (slug: string) => boolean;
+
+/** Config for `createFsContentAdapter`. */
+interface FsContentAdapterOptions {
+    /** Absolute path to the root of the content tree (ARCHITECTURE.md §3). */
+    readonly contentRoot: string;
+}
+declare const createFsContentAdapter: (options: FsContentAdapterOptions) => ContentStorageAdapter;
+
+/** Config for `createFsAssetAdapter`. */
+interface FsAssetAdapterOptions {
+    /**
+     * Absolute path to the directory where uploaded bytes land. In the
+     * template this is `public/assets/`, served as static files by Next.js.
+     */
+    readonly assetsRoot: string;
+    /**
+     * URL prefix prepended to stored filenames to produce `AssetUploadResult.url`.
+     * Example: `/assets` yields URLs like `/assets/<hash>.png`.
+     * The prefix MUST NOT end in `/`; the adapter always joins with a single
+     * `/` before the filename.
+     */
+    readonly publicUrlBase: string;
+}
+declare const createFsAssetAdapter: (options: FsAssetAdapterOptions) => AssetStorageAdapter;
+
+/** Config for `createFsSubmissionAdapter`. */
+interface FsSubmissionAdapterOptions {
+    /** Absolute path to the root of the submissions tree (e.g. `<projectRoot>/content/submissions`). */
+    readonly submissionsRoot: string;
+    /**
+     * Maximum number of newest entries `list()` returns. Default: 500.
+     * Bounds the AdminModal "Submissions" tab response size — a v1
+     * mitigation in lieu of full pagination (deferred to v0.3, see
+     * ARCHITECTURE.md §11). Older entries beyond the cap are still on
+     * disk but invisible to `list`. Must be a positive integer.
+     */
+    readonly maxList?: number;
+}
+declare const createFsSubmissionAdapter: (options: FsSubmissionAdapterOptions) => SubmissionStorageAdapter;
+
+/** Config for `createWebhookSubmissionAdapter`. */
+interface WebhookSubmissionAdapterOptions {
+    /** Absolute URL to POST submissions to. MUST be `http(s)://...`. */
+    readonly url: string;
+    /** Optional headers (e.g. `Authorization: Bearer ...`). */
+    readonly headers?: Record<string, string>;
+    /**
+     * Per-request timeout in milliseconds. Default: 10_000 (10s). When the
+     * webhook does not respond within this window we abort the fetch and
+     * throw — the route handler catches and maps to HTTP 502, so a hung
+     * upstream cannot block a Next.js worker. Set to a positive integer.
+     */
+    readonly timeoutMs?: number;
+    /**
+     * Fetch implementation. Optional — defaults to the global `fetch`. Tests
+     * pass a fake. Typed as the minimal surface we use to avoid pinning to
+     * a specific lib.dom/node-types version.
+     */
+    readonly fetch?: WebhookFetch;
+}
+/** Minimal `fetch`-like signature needed by the webhook adapter. */
+type WebhookFetch = (url: string, init: WebhookFetchInit) => Promise<WebhookFetchResponse>;
+interface WebhookFetchInit {
+    readonly method: 'POST';
+    readonly headers: Record<string, string>;
+    readonly body: string;
+    /**
+     * Optional `AbortSignal` for the per-request timeout. The adapter
+     * always sets this when calling `fetch`. The fake fetch used in tests
+     * may inspect `signal.aborted` to simulate a timed-out request.
+     */
+    readonly signal?: AbortSignal;
+}
+interface WebhookFetchResponse {
+    readonly ok: boolean;
+    readonly status: number;
+    text(): Promise<string>;
+}
+declare const createWebhookSubmissionAdapter: (options: WebhookSubmissionAdapterOptions) => SubmissionStorageAdapter;
+
+interface DefaultAdapterOptions {
+    /** Project root. Defaults to `process.cwd()`. */
+    readonly projectRoot?: string;
+}
+/**
+ * Create the default FS content adapter using the canonical path
+ * `<projectRoot>/content` (ARCHITECTURE.md §3).
+ */
+declare function createDefaultContentAdapter(options?: DefaultAdapterOptions): ContentStorageAdapter;
+/**
+ * Create the default FS asset adapter using the canonical path
+ * `<projectRoot>/public/assets` with URL base `/assets`
+ * (ARCHITECTURE.md §3).
+ */
+declare function createDefaultAssetAdapter(options?: DefaultAdapterOptions): AssetStorageAdapter;
+/**
+ * Create the default FS submission adapter using the canonical path
+ * `<projectRoot>/content/submissions` (ARCHITECTURE.md §3, §6.5).
+ *
+ * Templates are expected to add `content/submissions/` to `.gitignore`
+ * (skills-dev scope, Dispatch 3 territory). The framework does not
+ * touch git here.
+ */
+declare function createDefaultSubmissionAdapter(options?: DefaultAdapterOptions): SubmissionStorageAdapter;
+
+interface GlobalSlotProps {
+    /** The global's name as registered in `content/globals/<name>.json`. */
+    readonly name: string;
+    /** The runtime's `getGlobal` (from `createRuntime`). */
+    readonly getGlobal: GetGlobal;
+    /** Section definitions registry. Same shape as `<PageRenderer>` consumes. */
+    readonly definitions: readonly AnySectionDefinition[];
+    /**
+     * Read mode — same `'preview' | 'published'` as `getContent`. The
+     * caller passes the same value it would pass to `getContent`,
+     * typically derived from `draftMode().isEnabled`.
+     */
+    readonly mode: PreviewMode;
+    /** Rendered when the global doesn't exist or has no matching definition. */
+    readonly fallback?: ReactNode;
+}
+/**
+ * Renders a named global by looking up its `type` in the section
+ * definitions registry. When `mode === 'preview'`, wraps the render
+ * output with a `GlobalSaveProvider` so descendant editable widgets
+ * dispatch saves to `/api/agntcms/global/save`.
+ */
+declare function GlobalSlot(props: GlobalSlotProps): Promise<React.ReactElement | null>;
+
+export { AnySectionDefinition, AssetStorageAdapter, ContentStorageAdapter, type DefaultAdapterOptions, type FsAssetAdapterOptions, type FsContentAdapterOptions, type FsSubmissionAdapterOptions, GetGlobal, GlobalSlot, type GlobalSlotProps, NOT_FOUND_PAGE_SLUG, PreviewMode, SERVER_ERROR_PAGE_SLUG, SubmissionStorageAdapter, type WebhookFetch, type WebhookFetchInit, type WebhookFetchResponse, type WebhookSubmissionAdapterOptions, createDefaultAssetAdapter, createDefaultContentAdapter, createDefaultSubmissionAdapter, createFsAssetAdapter, createFsContentAdapter, createFsSubmissionAdapter, createWebhookSubmissionAdapter, getReservedPageSlugViolation, isSitemapEligibleSlug };