@botlr/sdk 0.0.0-stage → 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,661 @@
+type BotlrContext = {
+    appId: string;
+    locale?: string;
+    preview?: boolean;
+};
+type BotlrClientConfig = {
+    /** API origin, for example `https://api.botlr.io`. No trailing slash. */
+    baseUrl: string;
+    /** App instance ID. Sent as `x-botlr-app-id` on every request. */
+    appId: string;
+    /** Site token. Sent as `Authorization: Bearer` on every read. Optional in dev mode. */
+    apiKey?: string;
+    /** Preview JWT, passed as `token` to `/api/resolve` when `preview` is on. */
+    previewToken?: string;
+    /**
+     * Personal access token with `write:sections`. Used only by `sections.push`;
+     * the server never accepts it for reads.
+     */
+    personalToken?: string;
+    /** A fetch implementation; defaults to the global `fetch`. */
+    fetch?: typeof fetch;
+    locale?: string;
+    preview?: boolean;
+};
+type BotlrQueryValue = string | number | boolean | null | undefined;
+type BotlrQuery = Record<string, BotlrQueryValue | BotlrQueryValue[]>;
+type BotlrEntryMeta = {
+    id: string;
+    contentType: string;
+    createdAt?: string;
+    updatedAt?: string;
+    publishedAt?: string;
+    locale?: string;
+};
+type BotlrEntry<TFields> = BotlrEntryMeta & {
+    fields: TFields;
+};
+type GetEntryBySlugParams = {
+    contentType: string;
+    slug: string;
+    locale?: string;
+};
+type GetEntriesParams = {
+    contentType: string;
+    locale?: string;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    filters?: Record<string, BotlrQueryValue>;
+};
+type GetSingletonParams = {
+    key: string;
+    locale?: string;
+};
+type GetPageListParams = {
+    parentId?: string;
+    appInstanceId?: string;
+    tags?: string[];
+    limit?: number;
+    offset?: number;
+    locale?: string;
+    orderBy?: string;
+    type?: string;
+};
+type GetPageSlugListParams = {
+    appInstanceId?: string;
+    locale?: string;
+    limit?: number;
+    offset?: number;
+};
+/**
+ * Publisher scope: the app instance a page is rendered for. Injected into
+ * every section component so it can build asset URLs and scope content.
+ */
+interface PublisherScope {
+    /** Organization slug (for example "acme") */
+    orgSlug: string;
+    /** Project slug (for example "website") */
+    projectSlug: string;
+    /** App instance slug (for example "production") */
+    appInstanceSlug: string;
+    /** App instance ID (UUID) */
+    appInstanceId: string;
+    /** Current locale (for example "en", "da") */
+    locale: string;
+    /**
+     * URL prefix for the current locale ("" for the default locale, "en" for
+     * English). Used to strip locale prefixes from hard-coded hrefs when
+     * matching against page slugs. No leading or trailing slash.
+     */
+    localePrefix?: string;
+}
+type BreadcrumbItem = {
+    id: string;
+    name: string;
+    slug?: string;
+    full_slug?: string;
+};
+/** The page a section is rendered on. */
+interface PageScope {
+    id: string;
+    kind: string;
+    name: string;
+    /** Full slug without locale and leading slash */
+    slug: string;
+    breadcrumbs?: BreadcrumbItem[];
+}
+type ResponsiveSpan = {
+    mobile: number;
+    tablet?: number;
+    desktop?: number;
+};
+type ResponsiveGap = {
+    mobile?: number;
+    tablet?: number;
+    desktop?: number;
+};
+type GridColumn = {
+    span: ResponsiveSpan;
+    sections: LayoutNode[];
+    hideOnMobile?: boolean;
+    hideOnTablet?: boolean;
+    hideOnDesktop?: boolean;
+};
+type SpacingSize = "none" | "xs" | "sm" | "md" | "lg" | "xl" | "2xl";
+type GridContainerInstance = {
+    _key: string;
+    type: "grid-container";
+    columns: GridColumn[];
+    gap?: ResponsiveGap;
+    status?: "draft" | "published";
+    publishedAt?: string;
+    collapsed?: boolean;
+    visibility?: VisibilityRules[];
+    maxWidth?: "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "full" | "none";
+    paddingX?: SpacingSize;
+    paddingY?: SpacingSize;
+    marginX?: SpacingSize | "auto";
+    marginY?: SpacingSize;
+    background?: string;
+    fullWidthBackground?: boolean;
+    border?: boolean;
+    borderRadius?: "none" | "sm" | "md" | "lg" | "xl" | "2xl" | "full";
+    shadow?: "none" | "sm" | "md" | "lg" | "xl" | "2xl";
+    alignItems?: "start" | "center" | "end" | "stretch";
+    justifyContent?: "start" | "center" | "end" | "between" | "around" | "evenly";
+};
+type InlineSectionInstance = {
+    _key: string;
+    mode: "inline";
+    sectionType: string;
+    props: Record<string, any>;
+    status?: "draft" | "published";
+    publishedAt?: string;
+    visibility?: VisibilityRules[];
+};
+type SharedSectionInstance = {
+    _key: string;
+    mode: "shared";
+    sharedSectionId: string;
+    overrides?: Record<string, any>;
+    visibility?: VisibilityRules[];
+};
+type LayoutNode = InlineSectionInstance | SharedSectionInstance | GridContainerInstance;
+/** Per-locale visibility rules on a layout node. */
+interface VisibilityRules {
+    locale: string;
+    includePages?: string[];
+    excludePages?: string[];
+    includePatterns?: string[];
+    excludePatterns?: string[];
+    includeDocTypes?: string[];
+    excludeDocTypes?: string[];
+    includeEnvironments?: string[];
+    excludeEnvironments?: string[];
+    requireRoles?: string[];
+    excludeRoles?: string[];
+}
+type AssetData = {
+    id: string;
+    filename: string;
+    mime_type: string;
+    url?: string;
+    metadata?: Record<string, any>;
+};
+type PageDiscoveryData = {
+    id: string;
+    name: string;
+    slug?: string;
+    full_slug?: string;
+    description?: string;
+    image?: AssetData;
+    published_at?: string;
+    seo_meta?: Record<string, any>;
+    display_meta?: Record<string, any>;
+};
+type ThemeData = {
+    id: string;
+    name: string;
+    default_template_html: string;
+    default_template_css?: string;
+    settings?: Record<string, any>;
+};
+type PageTemplateData = {
+    template_html?: string;
+    template_css?: string;
+    layout?: Record<string, LayoutNode[]>;
+};
+type PageResponse = {
+    id: string;
+    name: string;
+    slug?: string;
+    /** Full slug without locale prefix, set by `resolvePage`. */
+    full_slug?: string;
+    layout: Record<string, LayoutNode[]>;
+    status: string;
+    theme?: ThemeData;
+    page_template?: PageTemplateData;
+    seo_meta?: Record<string, any>;
+    /** The same page in other locales, for hreflang links. */
+    alternate_translations?: AlternateTranslation[];
+    breadcrumbs?: BreadcrumbItem[];
+};
+/** One translation of a page: its locale and full slug with leading slash. */
+type AlternateTranslation = {
+    locale: string;
+    full_slug: string;
+} & Record<string, string>;
+type PageListResponse = {
+    success: boolean;
+    data: PageDiscoveryData[];
+    total: number;
+};
+type PageSlugListResponse = {
+    data: string[];
+};
+type MenuResponse = {
+    success: boolean;
+    menu: any;
+};
+type FormResponse = {
+    success: boolean;
+    form: any;
+};
+type ContentData = {
+    id: string;
+    type: string;
+    name: string;
+    slug?: string;
+    full_slug?: string;
+    content?: Record<string, any>;
+    layout?: Record<string, LayoutNode[]>;
+    seo_meta?: Record<string, any>;
+    status: string;
+    theme?: ThemeData;
+    page_template?: PageTemplateData;
+};
+type RedirectData = {
+    destination: string;
+    status_code: number;
+};
+/** Build-time redirect list. `source`/`destination` are full paths, locale prefix included. */
+type RedirectEntry = {
+    source: string;
+    /** Internal path or absolute URL */
+    destination: string;
+    /** Defaults to 308 */
+    status_code?: number;
+    locale?: string | null;
+};
+type RedirectsResponse = {
+    redirects?: RedirectEntry[];
+};
+type ResolveResponse = {
+    kind: "page" | "redirect" | "dynamic" | "404";
+    data?: ContentData;
+    redirect?: RedirectData;
+    breadcrumbs?: BreadcrumbItem[];
+    alternate_translations?: AlternateTranslation[];
+};
+type ListField = {
+    id: string;
+    key: string;
+    label: string;
+    type: string;
+    isLocalized: boolean;
+    isRequired: boolean;
+    sortOrder: number;
+    config: Record<string, any>;
+    visibility: string;
+    isReadOnly: boolean;
+    alignment: string;
+};
+type ListResponse = {
+    success: boolean;
+    data: {
+        id: string;
+        slug: string;
+        name: string;
+        description?: string;
+        defaultLang: string;
+        enabledLanguages: string[];
+        fields: ListField[];
+        rows: Record<string, any>[];
+    };
+};
+
+/**
+ * Section source bridge: types and hash helpers.
+ *
+ * Mirrors the contract in xam-mono's docs/SECTION_SOURCE_BRIDGE.md. The hash
+ * rules are reproduced here exactly as the server computes them, so a client
+ * can tell "clean", "modified", "behind" and "diverged" apart without a
+ * round trip:
+ *
+ * - `file.sha256`  = sha256 of the UTF-8 content, hex, content exactly as sent
+ * - `contentHash`  = sha256 over `"{path}\n{sha256}\n"` for every file, sorted by path
+ *
+ * The manifest is not hashed.
+ */
+/** The source variant a section is stored for, for example `react-next` or `html`. */
+type SectionFramework = string;
+type SectionSourceScope = "instance" | "shared";
+/** `<slug>.botlr.json`, kept next to the section's entry file. */
+interface SectionManifest {
+    /** Section definition slug. Must equal the name used in the URL on push. */
+    section: string;
+    framework: SectionFramework;
+    /** Entry file, relative to the manifest's directory. Must be listed in `files`. */
+    entry: string;
+    /** Named export of the component in `entry`. */
+    exportName?: string;
+    /** Every file of the section, relative to the manifest's directory, forward slashes only. */
+    files: string[];
+    title?: string;
+    description?: string;
+    category?: string;
+    icon?: string;
+    dependencies?: SectionDependencies;
+    /** Unknown keys are kept by the server. */
+    [key: string]: unknown;
+}
+interface SectionDependencies {
+    /** npm packages the section imports, with the ranges the app uses. */
+    npm?: Record<string, string>;
+    /** Local modules the section imports; the pulling app must already have them. */
+    internal?: string[];
+}
+/**
+ * Pull state keys the server strips from a manifest. The CLI keeps these in
+ * `.botlr/sections.lock.json`, never in the manifest.
+ */
+declare const MANIFEST_STATE_KEYS: readonly ["version", "hash", "contentHash", "pulledAt", "scope"];
+interface SectionSourceFileInput {
+    path: string;
+    content: string;
+}
+interface SectionSourceFile extends SectionSourceFileInput {
+    sha256: string;
+}
+interface SectionDefinitionScope {
+    tenantId: string;
+    organizationId: string | null;
+    projectId: string | null;
+}
+interface SectionDefinition {
+    id: string;
+    name: string;
+    title: string;
+    schema: Record<string, unknown>;
+    scope: SectionDefinitionScope;
+}
+interface SectionSource {
+    scope: SectionSourceScope;
+    framework: SectionFramework;
+    version: number;
+    contentHash: string;
+    manifest: SectionManifest;
+    message: string | null;
+    createdAt: string;
+    files: SectionSourceFile[];
+}
+interface SectionSourceScopeSummary {
+    version: number;
+    contentHash: string;
+    updatedAt: string;
+}
+interface SectionSourceSummary {
+    name: string;
+    title: string;
+    definitionId: string;
+    instance: SectionSourceScopeSummary | null;
+    shared: SectionSourceScopeSummary | null;
+    /** Which scope a pull without `scope` returns. */
+    effective: SectionSourceScope;
+}
+interface SectionSourceListResponse {
+    framework: SectionFramework;
+    sections: SectionSourceSummary[];
+}
+interface SectionSourcePullResponse {
+    /** null only for an instance row whose section no longer resolves to a definition */
+    definition: SectionDefinition | null;
+    source: SectionSource;
+}
+interface SectionSourceListParams {
+    framework: SectionFramework;
+}
+interface SectionSourcePullParams {
+    framework: SectionFramework;
+    /** A specific version; latest when omitted. */
+    version?: number;
+    /** Force one scope instead of "instance first, shared second". */
+    scope?: SectionSourceScope;
+}
+interface SectionSourcePushBody {
+    framework: SectionFramework;
+    manifest: SectionManifest;
+    files: SectionSourceFileInput[];
+    /** Defaults to the client's `appId`. */
+    appInstanceId?: string;
+    /** Write the shared row (per section definition) instead of this app's row. */
+    shared?: boolean;
+    /**
+     * The version the push is based on; 0 means "none yet". Omit to force the
+     * push without a conflict check.
+     */
+    baseVersion?: number;
+    /** At most 500 characters. */
+    message?: string;
+    /** Add a project-scoped section definition when none exists. */
+    create?: boolean;
+}
+interface SectionSourcePushResponse {
+    /** true on 201 (new version), false on 200 (nothing changed) */
+    created: boolean;
+    scope: SectionSourceScope;
+    definition: SectionDefinition;
+    version: number;
+    contentHash: string;
+}
+declare const SECTION_SOURCE_LIMITS: {
+    readonly maxFiles: 50;
+    readonly maxFileBytes: number;
+    readonly maxTotalBytes: number;
+    readonly maxPathLength: 200;
+    readonly maxMessageLength: 500;
+};
+declare const SECTION_PATH_RE: RegExp;
+declare const SECTION_FRAMEWORK_RE: RegExp;
+/** True when `path` is a relative path the bridge accepts. */
+declare function isValidSectionPath(path: string): boolean;
+declare function isValidFramework(framework: string): boolean;
+/** sha256 of the UTF-8 encoding of `content`, as lowercase hex. */
+declare function fileSha256(content: string): Promise<string>;
+/**
+ * The content hash of a file set: sha256 over `"{path}\n{sha256}\n"` for every
+ * file, sorted by path. Accepts files with a precomputed `sha256` or plain
+ * `{ path, content }` pairs.
+ */
+declare function contentHash(files: ReadonlyArray<SectionSourceFileInput | SectionSourceFile>): Promise<string>;
+/** Every file with its `sha256`, in the order given. Files that already carry one are kept as is. */
+declare function hashFiles(files: ReadonlyArray<SectionSourceFileInput | SectionSourceFile>): Promise<SectionSourceFile[]>;
+/** A copy of `manifest` without the pull-state keys the server strips. */
+declare function stripManifestState<T extends Record<string, unknown>>(manifest: T): SectionManifest;
+
+type RequestOptions = Omit<RequestInit, "headers"> & {
+    query?: BotlrQuery;
+    context?: Partial<BotlrContext>;
+    headers?: Record<string, string>;
+};
+declare function toQueryString(query: BotlrQuery): string;
+declare function contextToHeaders(context?: Partial<BotlrContext>): Record<string, string>;
+type BotlrClient = ReturnType<typeof createBotlrClient>;
+/**
+ * A Botlr client. Every call sends the site token as `Authorization: Bearer`
+ * plus `x-botlr-app-id`, `x-botlr-locale` and `x-botlr-preview` from the
+ * config; `sections.push` sends the personal token instead.
+ */
+declare function createBotlrClient(config: BotlrClientConfig): {
+    request: <T>(path: string, options?: RequestOptions) => Promise<T>;
+    /** The resolved config, for wrappers that need `baseUrl` or `appId`. */
+    config: Readonly<BotlrClientConfig>;
+    withContext(contextOverride: Partial<BotlrContext>): {
+        request: <T>(path: string, options?: RequestOptions) => Promise<T>;
+        /** The resolved config, for wrappers that need `baseUrl` or `appId`. */
+        config: Readonly<BotlrClientConfig>;
+        withContext(contextOverride: Partial<BotlrContext>): /*elided*/ any;
+        getEntryBySlug<TFields>(params: GetEntryBySlugParams): Promise<BotlrEntry<TFields> | null>;
+        getEntries<TFields>(params: GetEntriesParams): Promise<{
+            items: BotlrEntry<TFields>[];
+            total: number;
+        }>;
+        getSingleton<TFields>(params: GetSingletonParams): Promise<BotlrEntry<TFields> | null>;
+        getPageBySlug(slug: string, locale?: string): Promise<PageResponse>;
+        resolveUrl(slug: string, locale?: string): Promise<ResolveResponse>;
+        getPageList(params?: GetPageListParams): Promise<PageListResponse>;
+        getPageSlugList(params?: GetPageSlugListParams): Promise<PageSlugListResponse>;
+        getMenu(key: string, locale?: string): Promise<MenuResponse>;
+        getForm(key: string, locale?: string): Promise<FormResponse>;
+        getList(appId: string, listId: string, locale?: string): Promise<ListResponse>;
+        getConfigurator<T = unknown>(configuratorId: string, versionId?: string): Promise<T>;
+        /** GET `/api/{endpoint}` with the app and locale added to the query. */
+        getData<T = unknown>(endpoint: string, queryParams?: BotlrQuery, locale?: string): Promise<T>;
+        /** POST `data` as JSON to `/api/{endpoint}`, for forms and other submissions. */
+        submitData<T = unknown>(endpoint: string, data: Record<string, unknown>, locale?: string, queryParams?: BotlrQuery): Promise<T>;
+        getAppInfo<T = unknown>(): Promise<T>;
+        getSitemap<T = unknown>(): Promise<T>;
+        /** Every redirect for the app, across all locales. */
+        getRedirects(): Promise<RedirectsResponse>;
+        getAssetById<T = unknown>(assetId: string): Promise<T>;
+        sections: {
+            /** Every section the app can pull for `framework`, with the latest version per scope. */
+            list(params: SectionSourceListParams): Promise<SectionSourceListResponse>;
+            /** The section's source: this app's row first, the shared row second. */
+            pull(name: string, params: SectionSourcePullParams): Promise<SectionSourcePullResponse>;
+            /**
+             * Push a new version with the personal access token (`write:sections`).
+             * Resolves with `created: true` on 201 and `created: false` when nothing
+             * changed; throws `BotlrConflictError` when `baseVersion` is not the latest.
+             */
+            push(name: string, body: SectionSourcePushBody): Promise<SectionSourcePushResponse>;
+        };
+    };
+    getEntryBySlug<TFields>(params: GetEntryBySlugParams): Promise<BotlrEntry<TFields> | null>;
+    getEntries<TFields>(params: GetEntriesParams): Promise<{
+        items: BotlrEntry<TFields>[];
+        total: number;
+    }>;
+    getSingleton<TFields>(params: GetSingletonParams): Promise<BotlrEntry<TFields> | null>;
+    getPageBySlug(slug: string, locale?: string): Promise<PageResponse>;
+    resolveUrl(slug: string, locale?: string): Promise<ResolveResponse>;
+    getPageList(params?: GetPageListParams): Promise<PageListResponse>;
+    getPageSlugList(params?: GetPageSlugListParams): Promise<PageSlugListResponse>;
+    getMenu(key: string, locale?: string): Promise<MenuResponse>;
+    getForm(key: string, locale?: string): Promise<FormResponse>;
+    getList(appId: string, listId: string, locale?: string): Promise<ListResponse>;
+    getConfigurator<T = unknown>(configuratorId: string, versionId?: string): Promise<T>;
+    /** GET `/api/{endpoint}` with the app and locale added to the query. */
+    getData<T = unknown>(endpoint: string, queryParams?: BotlrQuery, locale?: string): Promise<T>;
+    /** POST `data` as JSON to `/api/{endpoint}`, for forms and other submissions. */
+    submitData<T = unknown>(endpoint: string, data: Record<string, unknown>, locale?: string, queryParams?: BotlrQuery): Promise<T>;
+    getAppInfo<T = unknown>(): Promise<T>;
+    getSitemap<T = unknown>(): Promise<T>;
+    /** Every redirect for the app, across all locales. */
+    getRedirects(): Promise<RedirectsResponse>;
+    getAssetById<T = unknown>(assetId: string): Promise<T>;
+    sections: {
+        /** Every section the app can pull for `framework`, with the latest version per scope. */
+        list(params: SectionSourceListParams): Promise<SectionSourceListResponse>;
+        /** The section's source: this app's row first, the shared row second. */
+        pull(name: string, params: SectionSourcePullParams): Promise<SectionSourcePullResponse>;
+        /**
+         * Push a new version with the personal access token (`write:sections`).
+         * Resolves with `created: true` on 201 and `created: false` when nothing
+         * changed; throws `BotlrConflictError` when `baseVersion` is not the latest.
+         */
+        push(name: string, body: SectionSourcePushBody): Promise<SectionSourcePushResponse>;
+    };
+};
+declare function createBotlrFactory(defaults?: {
+    fetch?: typeof fetch;
+}): {
+    create(config: Omit<BotlrClientConfig, "fetch">): {
+        request: <T>(path: string, options?: RequestOptions) => Promise<T>;
+        /** The resolved config, for wrappers that need `baseUrl` or `appId`. */
+        config: Readonly<BotlrClientConfig>;
+        withContext(contextOverride: Partial<BotlrContext>): /*elided*/ any;
+        getEntryBySlug<TFields>(params: GetEntryBySlugParams): Promise<BotlrEntry<TFields> | null>;
+        getEntries<TFields>(params: GetEntriesParams): Promise<{
+            items: BotlrEntry<TFields>[];
+            total: number;
+        }>;
+        getSingleton<TFields>(params: GetSingletonParams): Promise<BotlrEntry<TFields> | null>;
+        getPageBySlug(slug: string, locale?: string): Promise<PageResponse>;
+        resolveUrl(slug: string, locale?: string): Promise<ResolveResponse>;
+        getPageList(params?: GetPageListParams): Promise<PageListResponse>;
+        getPageSlugList(params?: GetPageSlugListParams): Promise<PageSlugListResponse>;
+        getMenu(key: string, locale?: string): Promise<MenuResponse>;
+        getForm(key: string, locale?: string): Promise<FormResponse>;
+        getList(appId: string, listId: string, locale?: string): Promise<ListResponse>;
+        getConfigurator<T = unknown>(configuratorId: string, versionId?: string): Promise<T>;
+        /** GET `/api/{endpoint}` with the app and locale added to the query. */
+        getData<T = unknown>(endpoint: string, queryParams?: BotlrQuery, locale?: string): Promise<T>;
+        /** POST `data` as JSON to `/api/{endpoint}`, for forms and other submissions. */
+        submitData<T = unknown>(endpoint: string, data: Record<string, unknown>, locale?: string, queryParams?: BotlrQuery): Promise<T>;
+        getAppInfo<T = unknown>(): Promise<T>;
+        getSitemap<T = unknown>(): Promise<T>;
+        /** Every redirect for the app, across all locales. */
+        getRedirects(): Promise<RedirectsResponse>;
+        getAssetById<T = unknown>(assetId: string): Promise<T>;
+        sections: {
+            /** Every section the app can pull for `framework`, with the latest version per scope. */
+            list(params: SectionSourceListParams): Promise<SectionSourceListResponse>;
+            /** The section's source: this app's row first, the shared row second. */
+            pull(name: string, params: SectionSourcePullParams): Promise<SectionSourcePullResponse>;
+            /**
+             * Push a new version with the personal access token (`write:sections`).
+             * Resolves with `created: true` on 201 and `created: false` when nothing
+             * changed; throws `BotlrConflictError` when `baseVersion` is not the latest.
+             */
+            push(name: string, body: SectionSourcePushBody): Promise<SectionSourcePushResponse>;
+        };
+    };
+};
+
+/**
+ * Thrown for every non-2xx response. `status` is the HTTP status and
+ * `details` the parsed JSON body (or the raw text when the body is not JSON).
+ */
+declare class BotlrError extends Error {
+    readonly status: number | undefined;
+    readonly details: unknown;
+    constructor(message: string, status?: number, details?: unknown);
+}
+/** The latest version of a section source, as reported on a push conflict. */
+type ConflictLatest = {
+    version: number;
+    contentHash: string;
+};
+/**
+ * Thrown by `sections.push` on 409: `baseVersion` was not the latest version,
+ * or a concurrent push won. `latest` is null when the server has no version
+ * at all (the client sent a `baseVersion` above 0 for a section with no source).
+ */
+declare class BotlrConflictError extends BotlrError {
+    readonly latest: ConflictLatest | null;
+    constructor(message: string, latest: ConflictLatest | null, details?: unknown);
+}
+
+/** An asset as a section prop: the legacy bare id, or the `AssetData` object. */
+type AssetRef = string | AssetData | null | undefined;
+declare function isAssetData(value: unknown): value is AssetData;
+declare function getAssetId(asset: AssetRef): string | undefined;
+/** The filename, when the asset is an `AssetData` object. A bare id has none. */
+declare function getAssetFilename(asset: AssetRef): string | undefined;
+interface AssetUrlOptions {
+    /** The media server origin, for example `https://media.example.com`. */
+    mediaUrl: string;
+    /** The image recipe segment; defaults to `view`. */
+    recipe?: string;
+}
+/**
+ * The media server URL of an asset:
+ * `{mediaUrl}/images/{orgSlug}/{assetId}/{recipe}/{filename}`.
+ *
+ * Falls back to `image.jpg` for a bare id, and to `{mediaUrl}/images/{assetId}`
+ * when no org slug is known.
+ */
+declare function getAssetUrl(asset: AssetRef, scope: Partial<Pick<PublisherScope, "orgSlug">> | undefined, options: AssetUrlOptions): string | undefined;
+/**
+ * `getAssetUrl` bound to a media server, for an app's own `getAssetUrl`:
+ *
+ * ```ts
+ * export const getAssetUrl = createAssetUrl({ mediaUrl: process.env.NEXT_PUBLIC_MEDIA_URL! });
+ * getAssetUrl(asset, scope, "thumb");
+ * ```
+ */
+declare function createAssetUrl(options: AssetUrlOptions): (asset: AssetRef, scope: Partial<Pick<PublisherScope, "orgSlug">> | undefined, recipe?: string) => string | undefined;
+
+export { type AlternateTranslation, type AssetData, type AssetRef, type AssetUrlOptions, type BotlrClient, type BotlrClientConfig, BotlrConflictError, type BotlrContext, type BotlrEntry, type BotlrEntryMeta, BotlrError, type BotlrQuery, type BotlrQueryValue, type BreadcrumbItem, type ConflictLatest, type ContentData, type FormResponse, type GetEntriesParams, type GetEntryBySlugParams, type GetPageListParams, type GetPageSlugListParams, type GetSingletonParams, type GridColumn, type GridContainerInstance, type InlineSectionInstance, type LayoutNode, type ListField, type ListResponse, MANIFEST_STATE_KEYS, type MenuResponse, type PageDiscoveryData, type PageListResponse, type PageResponse, type PageScope, type PageSlugListResponse, type PageTemplateData, type PublisherScope, type RedirectData, type RedirectEntry, type RedirectsResponse, type RequestOptions, type ResolveResponse, type ResponsiveGap, type ResponsiveSpan, SECTION_FRAMEWORK_RE, SECTION_PATH_RE, SECTION_SOURCE_LIMITS, type SectionDefinition, type SectionDefinitionScope, type SectionDependencies, type SectionFramework, type SectionManifest, type SectionSource, type SectionSourceFile, type SectionSourceFileInput, type SectionSourceListParams, type SectionSourceListResponse, type SectionSourcePullParams, type SectionSourcePullResponse, type SectionSourcePushBody, type SectionSourcePushResponse, type SectionSourceScope, type SectionSourceScopeSummary, type SectionSourceSummary, type SharedSectionInstance, type SpacingSize, type ThemeData, type VisibilityRules, contentHash, contextToHeaders, createAssetUrl, createBotlrClient, createBotlrFactory, fileSha256, getAssetFilename, getAssetId, getAssetUrl, hashFiles, isAssetData, isValidFramework, isValidSectionPath, stripManifestState, toQueryString };