@aglyn/plugins-ai 1.0.0-beta.271 → 1.0.0-beta.273

package/src/lib/jobs/ai-job-import-step.d.ts

@@ -0,0 +1,136 @@
+/**
+ * @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 PluginMediaIngest } from '@aglyn/aglyn/plugin-manager/plugin-media-ingest';
+import type { AiJob, AiJobItemLedger } from '../model/ai-jobs.types';
+import { type AiSiteImportLeftOutReason, type AiSiteImportPage, type AiSiteImportPageRead, type AiSiteImportState, type AiSiteImportWave } from '../model/ai-site-import';
+import { crawlSiteForImport, type SiteImportCrawlSeams, type SiteImportInventory } from '../site-import/site-import-crawl';
+import { type SiteImportPhotosDeps } from '../site-import/site-import-images';
+import { fileSiteImportReview } from '../site-import/site-import-review';
+import { type AiJobAdmission } from './ai-job-admission';
+import { readAiScreenRoom } from './ai-job-drafts';
+import { type AiLayoutSitePage } from './ai-job-layout-site-pages';
+import { aiSitePageWritten } from './ai-job-site-step';
+import { type AiJobStepRunner } from './ai-job-text-step';
+import { aiJobStepRunnerFor } from './ai-jobs';
+/** Waves (the read included) one workspace may start in a day. */
+export declare const SITE_IMPORT_WAVES_PER_ORG_PER_DAY = 12;
+/** The rate-limit key a workspace's imports share. */
+export declare function siteImportRateKey(orgId: string): string;
+/** The crawl's clock when the import reads the whole site. */
+export declare const AI_SITE_IMPORT_READ_MS = 150000;
+/** The crawl's clock when a wave reads its own pages again. */
+export declare const AI_SITE_IMPORT_WAVE_READ_MS = 90000;
+/** The clock for one page's photos: each is fetched and stored through the library's door. */
+export declare const AI_SITE_IMPORT_PHOTOS_MS = 90000;
+/** The least time each pass that asks no model needs. */
+export declare const AI_SITE_IMPORT_PASS_MINIMUM_MS: {
+    readonly read: number;
+    readonly wave: number;
+    readonly photos: number;
+};
+/**
+ * The passes one import may take: a read, then for every page its photos,
+ * its answer and its listing, every wave's start and the header and footer,
+ * with room for re-asks.
+ */
+export declare const AI_SITE_IMPORT_MAX_PASSES: number;
+/** Customer-safe sentences. */
+export declare const AI_SITE_IMPORT_COPY: {
+    readonly noSite: "Open the site to bring your website into.";
+    readonly badDomain: "This website’s address cannot be brought in.";
+    readonly ownership: (domain: string) => string;
+    readonly limit: "This workspace has started as many site waves as it can today (12). Start this wave again tomorrow.";
+    readonly robots: (domain: string) => string;
+    readonly nothing: (domain: string) => string;
+    readonly unavailable: "Bringing a site in is not available on this workspace right now.";
+    readonly frameUnavailable: "The header and footer could not be built here; your pages use the site’s own layout.";
+    readonly pageUnavailable: "Pages cannot be built here right now.";
+    readonly pageNotWritten: "This page could not be written from its old page. Its spend is given back.";
+    readonly plan: "Bringing an existing site in is included on every paid plan.";
+    readonly role: "Only the workspace owner or an admin can bring a site in.";
+};
+export interface AiSiteImportOwnership {
+    current: boolean;
+    method: string | null;
+    provenAt: number | null;
+    detail: string | null;
+}
+export interface AiSiteImportStepDeps {
+    crawl?: typeof crawlSiteForImport;
+    crawlSeams?: SiteImportCrawlSeams;
+    runnerFor?: typeof aiJobStepRunnerFor;
+    ownership?: (orgId: string, domain: string) => Promise<AiSiteImportOwnership | null>;
+    rateLimit?: (key: string, options: {
+        limit: number;
+        windowMs: number;
+    }) => Promise<{
+        allowed: boolean;
+    }>;
+    releaseFlagOn?: (orgId: string) => Promise<boolean>;
+    ingest?: () => PluginMediaIngest | null;
+    fetchImage?: SiteImportPhotosDeps['fetch'];
+    readRoom?: typeof readAiScreenRoom;
+    readSiteName?: (firestore: FirebaseFirestore.Firestore, hostId: string) => Promise<string>;
+    fileReview?: typeof fileSiteImportReview;
+    pageWritten?: typeof aiSitePageWritten;
+    mintId?: () => string;
+    clock?: () => number;
+}
+/** The proved domain an import job is for, or `null`. */
+export declare function aiSiteImportDomainOf(job: Pick<AiJob, 'inputs'>): string | null;
+/**
+ * The pages the header and a page may link: the ones of this wave and those
+ * before it that are in or still coming, home first, at most the header's
+ * seven. A page of a later wave is not linked: it may never be brought in.
+ */
+export declare function aiSiteImportLinkedPages(state: AiSiteImportState, items: readonly AiJobItemLedger[], wave: number): AiLayoutSitePage[];
+/** The header and footer's job: a layout of the site's name, linking the wave's pages, in the layout language. */
+export declare function aiSiteImportFrameJob(job: AiJob, state: AiSiteImportState, wave: AiSiteImportWave, items: readonly AiJobItemLedger[]): AiJob;
+/** One page's job: a page job's plan of one screen, its sections from the old page's headings, its text fenced. */
+export declare function aiSiteImportPageJob(job: AiJob, state: AiSiteImportState, page: AiSiteImportPage, items: readonly AiJobItemLedger[]): AiJob;
+/** The least time the import's next pass needs: a read's, a photo pass's, or the time of the step its unit is handed to. */
+export declare function aiSiteImportRunMinimumMs(job: AiJob, runnerFor?: typeof aiJobStepRunnerFor): number;
+export declare function createAiJobImportStep(deps?: AiSiteImportStepDeps): AiJobStepRunner;
+/** The home page's menu, as same-site paths in its order. */
+export declare function siteImportMenu(crawled: Pick<SiteImportInventory, 'pages' | 'origins'>): string[];
+/**
+ * What a wave's read came to for each page: the page read again, or why it
+ * is left out now. Matched by address; a page the site sent to another of its
+ * own addresses is matched in the order the wave asked for it.
+ */
+export declare function siteImportWaveReads(asked: readonly AiSiteImportPage[], crawled: Pick<SiteImportInventory, 'pages' | 'skipped'>, at: string, options?: {
+    /** The read's clock ran out: a page it did not reach is left for the next pass, not left out. */
+    cutShort?: boolean;
+}): Map<string, AiSiteImportPageRead | AiSiteImportLeftOutReason>;
+export interface AiSiteImportAdmissionDeps {
+    releaseFlagOn?: (orgId: string) => Promise<boolean>;
+    ownership?: (orgId: string, domain: string) => Promise<AiSiteImportOwnership | null>;
+    memberRole?: (uid: string, orgId: string) => Promise<string | null>;
+}
+/**
+ * What an import asks before it exists and before each wave (AGL-3976): the
+ * release flag, a site to bring it into, a paid plan, the owner or an admin,
+ * and a CURRENT proof that the workspace owns the domain. Nothing is spent on
+ * a refusal, and the day's limit is the step's to count, once a wave runs.
+ */
+export declare function createAiSiteImportAdmission(deps?: AiSiteImportAdmissionDeps): AiJobAdmission;
+/**
+ * The import kind's registrations (AGL-3976), by a call from `server.ts`,
+ * never by an import: its runner with each pass's least time, its pass bound
+ * and its admission.
+ */
+export declare function registerAiSiteImportJob(deps?: AiSiteImportStepDeps): void;