@aglyn/plugins-ai 1.0.0-beta.292 → 1.0.0-beta.293

package/src/lib/jobs/ai-site-import-compile.d.ts

@@ -0,0 +1,147 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type AiLayoutCompiledPage, type AiLayoutPagePlan } from '../layout-language/ai-layout-compiler';
+import type { AiLayoutDesign } from '../layout-language/ai-layout-design';
+import { type AiLayoutDesignAnswer, type AiLayoutSection, type AiLayoutSettlement } from '../layout-language/ai-layout-language';
+import type { AiLayoutTargets } from '../layout-language/ai-layout-links';
+import { type SiteImportIconShape, type SiteImportLayout } from '../model/ai-site-import';
+import { type AiSiteImportDocument } from './ai-site-import-document';
+/**
+ * The model a page brought in asks its design answer on (AGL-4107): the page
+ * step's own tier, balanced, whatever the deployment's default model is — the
+ * job's own pick where it is that tier or above.
+ */
+export declare function aiImportPageModel(modelFor?: (kind: 'job.page') => string | undefined): string;
+/**
+ * Every page the import plans that a page brought in may link (AGL-4107), by
+ * the id its draft is written under: a link to one in a wave still to come
+ * shows its words until that page is live, then goes there.
+ */
+export declare function aiSiteImportLinkablePages(doc: Pick<AiSiteImportDocument, 'links'> | null): Array<{
+    id: string;
+    label: string;
+    slug: string;
+}>;
+/**
+ * The listing a page brought in keeps (AGL-4107): its source's own title and
+ * description, word for word, never clipped and never rewritten — the 10/29
+ * import's Home was retitled "Aglyn: Build a Website with AI, Free to Start".
+ * Only a part the source left empty takes what was `written` for it.
+ */
+export declare function aiImportedPageListing(screen: {
+    seoTitle: string;
+    seoDescription: string;
+}, written?: {
+    title?: string;
+    description?: string;
+}): {
+    title: string;
+    description: string;
+};
+/** Whether a page brought in still owes a part of its listing: one its source left empty. */
+export declare function aiImportedPageListingOwed(listing: {
+    title: string;
+    description: string;
+}): boolean;
+/**
+ * The layout of a page whose read kept none (AGL-4107): its lines in their
+ * sections — the opening, then one at each second-level heading — each line
+ * where the source put it, in order.
+ */
+export declare function aiSiteImportLayoutOfLines(doc: Pick<AiSiteImportDocument, 'blocks' | 'title'>): SiteImportLayout;
+/** The layout a page is built from: the reader's, else one read from its lines. */
+export declare function aiSiteImportLayoutOf(doc: Pick<AiSiteImportDocument, 'blocks' | 'title' | 'layout'>): SiteImportLayout;
+/**
+ * The page's sections by name, in order (AGL-4107): the source's own, as its
+ * layout names them — its `aria-label`s, its headings — two of one name told
+ * apart, so a link to either finds it. The page's plan has exactly these.
+ */
+export declare function aiSiteImportSectionNames(doc: Pick<AiSiteImportDocument, 'blocks' | 'title' | 'layout'>): string[];
+/**
+ * A path's drawing moved onto the icon element's 24-unit square (AGL-4107):
+ * every coordinate scaled from its viewBox and centered, every relative move
+ * scaled alone, an arc's radii scaled and its flags and rotation kept.
+ * `null` for anything that is not path data.
+ */
+export declare function aiSiteImportPathOn24(d: string, viewBox: string): string | null;
+/**
+ * The source's icon as the icon element draws one (AGL-4107): one path on its
+ * 24-unit square. A one-path icon is its path, moved onto the square; a small
+ * drawing of several filled shapes is their paths together. A drawing made of
+ * strokes, or of shapes a transform moves, has no one path, and is left out:
+ * an icon is no word of the page.
+ */
+export declare function aiSiteImportIconPath(shape: SiteImportIconShape | undefined): string | null;
+export interface AiSiteImportDesigned {
+    sections: AiLayoutSection[];
+    /** Lines taken into a block, by index of the page's blocks. */
+    used: Set<number>;
+    /** Pictures the library could not hold. */
+    missing: Set<number>;
+    settled: AiLayoutSettlement[];
+}
+/**
+ * The page's sections in the layout language (AGL-4107): the source's layout,
+ * each section in its own band (or the answer's, where the source gave none),
+ * its row, its groups and their items, its tables, tabs and pictures, every
+ * line taken exactly once and every line the layout placed nowhere added at
+ * its section's end.
+ */
+export declare function aiSiteImportDesignedSections(doc: AiSiteImportDocument, answer?: AiLayoutDesignAnswer | null, options?: {
+    formId?: string | null;
+}): AiSiteImportDesigned;
+export interface AiSiteImportCompileInput {
+    doc: AiSiteImportDocument;
+    /** The ids the page stores its sections under, in plan order: one for each of the page's sections. */
+    sectionIds: readonly string[];
+    /** The page's plan: its title and its sections by name. */
+    plan: AiLayoutPagePlan;
+    targets: AiLayoutTargets;
+    /** The site the page belongs to, which its hero is drawn for. */
+    design?: AiLayoutDesign | null;
+    language?: string;
+    /** The page's design answer, for a main page; absent, the page is drawn as its source lays it out. */
+    answer?: AiLayoutDesignAnswer | null;
+}
+export interface AiSiteImportCompiled extends Pick<AiLayoutCompiledPage, 'tree' | 'sectionRoots'> {
+    sections: AiLayoutSection[];
+    /** The lines on the page, by index of its blocks, in source order. */
+    placed: number[];
+    /** Every line the page has. */
+    lines: number;
+    /** The words on the page, and the words its lines hold. */
+    words: number;
+    sourceWords: number;
+    /** Set when the page ran past what one page may weigh, and its last sections keep only their names. */
+    cut: boolean;
+    settled: AiLayoutSettlement[];
+}
+/**
+ * The page brought in, built by the site compiler (AGL-4107): every line on
+ * it exactly once, every word as its source wrote it, laid out as its source
+ * lays it out and drawn in the site's own theme.
+ */
+export declare function aiCompileImportedPage(input: AiSiteImportCompileInput): AiSiteImportCompiled;
+/** The most characters of a page's structure a design prompt shows. */
+export declare const AI_SITE_IMPORT_DESIGN_MAX_CHARS = 12000;
+/**
+ * The page's structure as its design answer reads it (AGL-4107): each
+ * section's name, band, alignment and what it shows, its groups numbered as
+ * the answer names them. No word of the page is in it but its sections'
+ * names, which are fenced where the prompt shows them.
+ */
+export declare function aiSiteImportDesignText(doc: Pick<AiSiteImportDocument, 'blocks' | 'title' | 'layout'>): string;