@aglyn/plugins-ai 1.0.0-beta.270 → 1.0.0-beta.272

package/src/lib/jobs/ai-site-inspiration-signals.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @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 AiSiteButtons, type AiSiteCorners, type AiSiteDensity, type AiSiteGround } from '../model/ai-site-kinds';
+import { type AiSiteCards, type AiSiteHeader } from '../model/ai-site-look';
+import { type AiSiteMotionStyle } from '../layout-language/ai-layout-motion';
+import { type AiReferencePage } from './ai-theme-brand-inputs';
+/**
+ * What a site the person likes says about how it is built (AGL-3975), read by
+ * code into the site job's own vocabularies. SIGNALS ONLY: every value here
+ * is a member of a closed set this module or the look's modules define, or a
+ * hex color. Nothing the page SAYS — no sentence, heading, name, picture
+ * address or logo — is kept, so nothing of it can reach a prompt or a page.
+ * The page's words are read only to tell one kind of section from another,
+ * and the answer is the kind, never the words.
+ *
+ * One page and at most two of its stylesheets (`readReferencePage`), never a
+ * crawl. Every reader is best effort: a signal the page does not show is
+ * `null`, and the site job chooses that dimension as it always has.
+ */
+/** The kinds of section a page is read into, in the site plan's own words. */
+export declare const AI_SITE_INSPIRATION_SECTIONS: readonly ["hero", "about", "features", "steps", "stats", "gallery", "menu", "products", "pricing", "testimonials", "logos", "team", "events", "blog", "faq", "newsletter", "booking", "contact", "cta"];
+export type AiSiteInspirationSection = (typeof AI_SITE_INSPIRATION_SECTIONS)[number];
+/** What a site offers its visitors, which a paid start maps onto Aglyn's own parts. */
+export declare const AI_SITE_INSPIRATION_FEATURES: readonly ["booking", "store", "blog", "forms", "gallery", "events", "menu", "testimonials", "newsletter"];
+export type AiSiteInspirationFeature = (typeof AI_SITE_INSPIRATION_FEATURES)[number];
+/** The mood of a site's headings' type. */
+export declare const AI_SITE_INSPIRATION_FONT_MOODS: readonly ["serif", "sans", "display"];
+export type AiSiteInspirationFontMood = (typeof AI_SITE_INSPIRATION_FONT_MOODS)[number];
+/** How a site's main buttons are drawn: a fill, or only an outline. */
+export declare const AI_SITE_INSPIRATION_BUTTON_FILLS: readonly ["filled", "outline"];
+export type AiSiteInspirationButtonFill = (typeof AI_SITE_INSPIRATION_BUTTON_FILLS)[number];
+declare const ALIGNS: readonly ["start", "center"];
+/** The most sections of one page that are kept, in order. */
+export declare const AI_SITE_INSPIRATION_MAX_SECTIONS = 10;
+/** One site's signals. */
+export interface AiSiteInspirationSite {
+    /** Its home page's sections, top to bottom, the header and footer left out. */
+    sections: AiSiteInspirationSection[];
+    density: AiSiteDensity | null;
+    /** Its header: the logo at the start with the links after it, or centered. */
+    headerAlign: (typeof ALIGNS)[number] | null;
+    /** What sets its header bar off the page. */
+    header: AiSiteHeader | null;
+    /** Its brand colors, most used first, the colorful before the greys. */
+    colors: string[];
+    ground: AiSiteGround | null;
+    fontMood: AiSiteInspirationFontMood | null;
+    buttons: AiSiteButtons | null;
+    buttonFill: AiSiteInspirationButtonFill | null;
+    corners: AiSiteCorners | null;
+    cards: AiSiteCards | null;
+    motion: AiSiteMotionStyle | null;
+    /** What it offers its visitors; empty on a Free start, which maps none. */
+    features: AiSiteInspirationFeature[];
+}
+/** What a job read of the sites it was given, as its plan keeps it. */
+export interface AiSiteInspiration {
+    v: 1;
+    sites: AiSiteInspirationSite[];
+    /** How many of the sites given could not be read. */
+    unread: number;
+}
+interface CssRule {
+    selector: string;
+    decls: Map<string, string>;
+}
+/** Each rule of a stylesheet, its selector and declarations; nested at-rules are read by their inner rules. */
+export declare function cssRulesOf(css: string): CssRule[];
+/** The page's sections in order, a run of one kind read as one section. */
+export declare function inspirationSectionsOf(html: string): AiSiteInspirationSection[];
+/** One font family's mood. */
+export declare function inspirationFontMood(family: string): AiSiteInspirationFontMood | null;
+/**
+ * A read page's signals (AGL-3975). Pure over the page and its sheets, so the
+ * specs read recorded pages; nothing of the page but these values leaves.
+ */
+export declare function aiSiteInspirationSignals(page: Pick<AiReferencePage, 'html' | 'stylesheets'>): AiSiteInspirationSite;
+/**
+ * Stored signals, read back defensively: a plan travels through the confirm
+ * door and a unit's inputs, so every value is held to its closed set again
+ * and anything else is dropped. `null` for nothing usable.
+ */
+export declare function aiReadSiteInspiration(value: unknown): AiSiteInspiration | null;
+export {};