@doxbrix/doxloop 0.1.4 → 0.2.0

package/dist/project.d.ts

@@ -1,11 +1,19 @@
-import type { DocumentationBrief, DesignReference, DoxloopProject, DoxbrixSiteConfig, GeneratorName, SourceBinding } from './types.js';
+import type { DocumentationBrief, DesignReference, DoxloopProject, DoxbrixSiteConfig, GeneratorName, SourceBinding, SourceKind, SyncConfig, SyncTrigger } from './types.js';
 export declare const PROJECT_FILE: string;
+export declare const ROOT_CONTENT_IGNORED_DIRECTORIES: Set<string>;
 export declare function defaultDocumentationBrief(): DocumentationBrief;
+export declare function completeDocumentationBriefForCreate(brief: DocumentationBrief): DocumentationBrief;
+export declare function defaultSyncConfig(): SyncConfig;
 export declare function findProjectRoot(start: string): Promise<string>;
 export declare function loadProject(root: string): Promise<DoxloopProject>;
+/**
+ * The project's saved default model, but only for the agent it was chosen
+ * for: a Codex model ID must not be handed to Claude Code or Gemini.
+ */
+export declare function projectDefaultModel(project: Pick<DoxloopProject, 'defaultAgent' | 'defaultModel'>, agent: string | undefined): string | undefined;
 export declare function saveDefaultAgent(root: string, agent: DoxloopProject['defaultAgent']): Promise<void>;
 export declare function saveProjectSettings(root: string, changes: {
-    [Key in 'title' | 'defaultAgent' | 'sources' | 'designReferences' | 'application' | 'deployment' | 'documentation']?: DoxloopProject[Key] | undefined;
+    [Key in 'title' | 'defaultAgent' | 'defaultModel' | 'sources' | 'designReferences' | 'application' | 'deployment' | 'documentation' | 'sync']?: DoxloopProject[Key] | undefined;
 }): Promise<void>;
 export declare function siteConfigPath(root: string, project?: DoxloopProject): Promise<string>;
 export declare function loadSiteConfig(root: string, project?: DoxloopProject): Promise<DoxbrixSiteConfig>;
@@ -13,7 +21,15 @@ export declare function doxbrixPageIds(config: DoxbrixSiteConfig): string[];
 export declare function parseSource(raw: string): SourceBinding;
 export declare function parseSpec(raw: string): SourceBinding;
 export declare function isSpecUrl(location: string): boolean;
-export declare function sourceKind(source: SourceBinding): 'directory' | 'openapi';
+export declare function sourceKind(source: SourceBinding): SourceKind;
+/**
+ * `--docs name=url` or `--docs url`: an existing documentation website to crawl.
+ * The returned binding is not yet materialized; its `path` holds the URL until
+ * the crawl writes the snapshot and replaces it with the snapshot directory.
+ */
+export declare function parseDocsSite(raw: string): SourceBinding;
+/** A `docs-site` binding whose snapshot has not been crawled yet: its path is still the URL. */
+export declare function isUnmaterializedDocsSite(source: SourceBinding): boolean;
 export declare function resolveSeparateProjectLayout(options: {
     cwd: string;
     source: string;
@@ -24,6 +40,7 @@ export declare function resolveSeparateProjectLayout(options: {
     sourceBinding: SourceBinding;
 }>;
 export declare function validateProjectSourceBoundaries(projectRoot: string, sources: SourceBinding[]): Promise<void>;
+export declare function validateSourceScopes(sources: SourceBinding[]): void;
 export declare function assertNewProjectDirectory(projectRoot: string): Promise<void>;
 export declare function parseDesignReference(raw: string): DesignReference;
 export declare function addDesignReferences(root: string, references: DesignReference[]): Promise<void>;
@@ -34,12 +51,27 @@ export declare function scaffoldProject(options: {
     designReferences?: DesignReference[];
     generator?: GeneratorName;
 }): Promise<string>;
+/**
+ * Machine-local Doxloop state that never belongs in version control. Shared by
+ * the scaffold and by importing an existing documentation folder.
+ */
+export declare const PROJECT_GITIGNORE_ENTRIES: readonly string[];
 export declare function loadPages(root: string, project: DoxloopProject): Promise<string[]>;
+/**
+ * File extensions the configured generator treats as readable pages. Everything
+ * else inside the content directory is site data, not documentation.
+ */
+export declare function pageExtensions(root: string, project: DoxloopProject): Promise<Set<string>>;
 export declare function readPage(path: string): Promise<{
     title: string;
     description?: string;
     body: string;
+    /** SEO fields from frontmatter, rendered by the preview and the static build. */
+    canonical?: string;
+    socialImage?: string;
 }>;
 export declare function pageId(contentRoot: string, path: string): string;
 export declare function relativePath(root: string, path: string): string;
+export declare function titleFromDirectory(directory: string): string;
+export declare function parseSyncTrigger(raw: string): SyncTrigger;
 //# sourceMappingURL=project.d.ts.map