@tileflow/dev 0.1.0-alpha.17 → 0.1.0-alpha.19

package/dist/artifacts.d.ts

@@ -0,0 +1,152 @@
+import { TileflowStyleOptions, MapLibreStyle } from '@tileflow/core';
+import { TileflowMapBuildManifestV1, TileflowBuildCatalog, TileflowStyleInspection, TileflowBuildStyles, TileflowMapBuildProvenanceV1, TileflowPreparedMapAssets } from '@tileflow/core/build';
+import { TileflowRuntimeManifest } from '@tileflow/core/manifest';
+import { TileflowBuildAsset, PreparedTileflowBuildCatalog, TileflowSourceCatalog, PreparedTileflowCatalog } from './icons.js';
+export { defaultTileflowConfigPath } from './config.js';
+
+declare const tileflowArtifactSessionSchemaVersion: 1;
+type TileflowArtifactDiagnostic = {
+    code?: string;
+    message: string;
+    path: string;
+    phase?: string;
+};
+type TileflowArtifactSessionState = {
+    status: 'building';
+    generation: number;
+    lastGoodGeneration?: number;
+} | {
+    status: 'ready';
+    generation: number;
+    artifacts: TileflowBuildArtifacts;
+    lastGoodGeneration: number;
+} | {
+    status: 'invalid';
+    generation: number;
+    diagnostics: TileflowArtifactDiagnostic[];
+    lastGoodGeneration?: number;
+};
+type TileflowArtifactSessionOptions = TileflowBuildArtifactsOptions & {
+    debounceMs?: number;
+    ignoredPaths?: string[];
+    watch?: boolean;
+};
+type TileflowArtifactSession = {
+    close(): Promise<void>;
+    getLastGoodArtifacts(): TileflowBuildArtifacts | undefined;
+    getState(): TileflowArtifactSessionState;
+    refresh(reason?: string): Promise<void>;
+    subscribe(listener: (state: TileflowArtifactSessionState) => void): () => void;
+};
+declare function createTileflowArtifactDiagnostics(error: unknown, cwd: string): TileflowArtifactDiagnostic[];
+
+/** Normalize a development route base. This is a URL pathname, never a filesystem path. */
+declare function normalizeTileflowBasePath(value?: string): string;
+/**
+ * Join a bundler public URL prefix to the Tileflow route without changing URL-reference kind.
+ * In particular, `./` and `../` remain path-relative rather than becoming root-relative.
+ */
+declare function joinTileflowPublicUrl(publicBase: string, basePath: string): string;
+/**
+ * Resolve the public URL at which a manifest is exposed and the URLs embedded inside its artifacts.
+ * Path-relative deployments use owner-relative references because the manifest already lives below
+ * the public prefix.
+ */
+declare function resolveTileflowArtifactPublicUrls(publicBase: string, basePath: string): {
+    assetBaseUrl?: string;
+    publicBaseUrl: string;
+    styleBaseUrl: string;
+};
+/** Convert a validated route base to a bundler-relative asset prefix. */
+declare function getTileflowAssetBasePath(basePath: string): string;
+declare function getTileflowAssetFileName(basePath: string, fileName: string): string;
+
+declare const tileflowArtifactPlanSchemaVersion: 1;
+declare const tileflowArtifactInventoryFileName = ".tileflow-artifacts.json";
+type TileflowManifestOptions = {
+    styleBaseUrl?: string;
+};
+type TileflowBuildArtifactsOptions = {
+    apiBaseUrl?: string;
+    assetBaseUrl?: string;
+    config?: string;
+    cwd?: string;
+    /** Build a memory-only compiler sidecar for local authoring tools. */
+    inspection?: boolean;
+    styleBaseUrl?: string;
+};
+type TileflowBuildStyleInspections = Record<string, Record<string, TileflowStyleInspection>>;
+/** Compatibility shape consumed by sessions and capture callers. */
+type TileflowBuildArtifacts = {
+    assets: TileflowBuildAsset[];
+    buildManifest: TileflowMapBuildManifestV1;
+    manifest: TileflowRuntimeManifest;
+    project: TileflowBuildCatalog;
+    /** Optional local-only provenance. It is never serialized as a build artifact. */
+    styleInspections?: TileflowBuildStyleInspections;
+    styles: TileflowBuildStyles;
+    watchPaths: string[];
+};
+type TileflowArtifactFile = TileflowBuildAsset;
+type TileflowArtifactInputGraph = {
+    /** Exact executable config modules and data files observed during evaluation. */
+    files: string[];
+    /** Asset directories whose children can change without changing the config module. */
+    directories: string[];
+};
+/**
+ * Complete, deterministic output of compiling one prepared source generation.
+ * `sourceProject` is retained for diagnostics only; `project` is the portable runtime input.
+ */
+type TileflowArtifactPlan = TileflowBuildArtifacts & {
+    files: TileflowArtifactFile[];
+    inputs: TileflowArtifactInputGraph;
+    project: PreparedTileflowBuildCatalog;
+    schemaVersion: typeof tileflowArtifactPlanSchemaVersion;
+    sourceProject: TileflowSourceCatalog;
+};
+type CreateTileflowArtifactPlanOptions = Pick<TileflowBuildArtifactsOptions, 'apiBaseUrl' | 'assetBaseUrl' | 'inspection' | 'styleBaseUrl'> & {
+    inputFiles?: readonly string[];
+};
+type WriteTileflowArtifactPlanOptions = {
+    cwd?: string;
+    outDir: string;
+    /** Explicit escape hatch for replacing a Hosted delivery manifest with self-hosted artifacts. */
+    overwriteHostedManifest?: boolean;
+};
+type WriteTileflowBuildArtifactsOptions = TileflowBuildArtifactsOptions & WriteTileflowArtifactPlanOptions;
+declare class TileflowHostedManifestOverwriteError extends Error {
+    readonly code: "HOSTED_MANIFEST_OVERWRITE_REFUSED";
+    constructor(path: string);
+}
+declare function createTileflowManifest(project: TileflowBuildCatalog, options?: TileflowManifestOptions): TileflowRuntimeManifest;
+declare function createTileflowStyle(project: TileflowBuildCatalog, mapName: string, options?: TileflowStyleOptions): MapLibreStyle;
+declare function createTileflowStyles(project: TileflowBuildCatalog, options?: Omit<TileflowStyleOptions, 'preparedAssets' | 'theme'> & {
+    mapAssets?: Readonly<Record<string, TileflowPreparedMapAssets>>;
+}): TileflowBuildStyles;
+/** Compiles only a prepared project, keeping local source resolution out of core compilation. */
+declare function createTileflowArtifactPlan(prepared: PreparedTileflowCatalog, options?: CreateTileflowArtifactPlanOptions): Promise<TileflowArtifactPlan>;
+declare function createTileflowBuildArtifacts(options?: TileflowBuildArtifactsOptions): Promise<TileflowArtifactPlan>;
+declare function getTileflowArtifactFiles(artifacts: TileflowBuildArtifacts): TileflowArtifactFile[];
+/** Resolve portable build provenance without making it part of any map authoring revision. */
+declare function createTileflowBuildProvenance(cwd: string): Promise<TileflowMapBuildProvenanceV1>;
+declare function createTileflowArtifactSession(options?: TileflowArtifactSessionOptions): Promise<TileflowArtifactSession>;
+declare function getTileflowWatchPaths(options?: Pick<TileflowBuildArtifactsOptions, 'config' | 'cwd'>): Promise<string[]>;
+declare function isTileflowArtifactInputPath(inputs: TileflowArtifactInputGraph, path: string): boolean;
+/** Shared refresh gate for adapters that receive filesystem or framework lifecycle events. */
+declare function refreshTileflowArtifactSession(session: TileflowArtifactSession, options: {
+    inputPath?: string;
+    reason: string;
+}): Promise<boolean>;
+declare function writeTileflowBuildArtifacts(options: WriteTileflowBuildArtifactsOptions): Promise<TileflowArtifactPlan>;
+/**
+ * Replaces one managed artifact generation and records its exact file inventory. Unmanaged files
+ * are never scanned or removed. A caught filesystem failure restores every previous managed file.
+ */
+declare function writeTileflowArtifactPlan(artifacts: TileflowArtifactPlan, options: WriteTileflowArtifactPlanOptions): Promise<void>;
+/** Prevents a framework build from silently replacing the frontend's Hosted delivery contract. */
+declare function assertTileflowSelfHostedManifestTarget(manifestPath: string, options?: {
+    overwriteHostedManifest?: boolean;
+}): Promise<void>;
+
+export { type CreateTileflowArtifactPlanOptions, PreparedTileflowBuildCatalog, PreparedTileflowCatalog, type TileflowArtifactDiagnostic, type TileflowArtifactFile, type TileflowArtifactInputGraph, type TileflowArtifactPlan, type TileflowArtifactSession, type TileflowArtifactSessionOptions, type TileflowArtifactSessionState, type TileflowBuildArtifacts, type TileflowBuildArtifactsOptions, TileflowBuildAsset, type TileflowBuildStyleInspections, TileflowHostedManifestOverwriteError, type TileflowManifestOptions, TileflowSourceCatalog, type WriteTileflowArtifactPlanOptions, type WriteTileflowBuildArtifactsOptions, assertTileflowSelfHostedManifestTarget, createTileflowArtifactDiagnostics, createTileflowArtifactPlan, createTileflowArtifactSession, createTileflowBuildArtifacts, createTileflowBuildProvenance, createTileflowManifest, createTileflowStyle, createTileflowStyles, getTileflowArtifactFiles, getTileflowAssetBasePath, getTileflowAssetFileName, getTileflowWatchPaths, isTileflowArtifactInputPath, joinTileflowPublicUrl, normalizeTileflowBasePath, refreshTileflowArtifactSession, resolveTileflowArtifactPublicUrls, tileflowArtifactInventoryFileName, tileflowArtifactPlanSchemaVersion, tileflowArtifactSessionSchemaVersion, writeTileflowArtifactPlan, writeTileflowBuildArtifacts };

package/dist/artifacts.js

@@ -0,0 +1,62 @@
+import {
+  TileflowHostedManifestOverwriteError,
+  assertTileflowSelfHostedManifestTarget,
+  createTileflowArtifactDiagnostics,
+  createTileflowArtifactPlan,
+  createTileflowArtifactSession,
+  createTileflowBuildArtifacts,
+  createTileflowBuildProvenance,
+  createTileflowManifest,
+  createTileflowStyle,
+  createTileflowStyles,
+  getTileflowArtifactFiles,
+  getTileflowWatchPaths,
+  isTileflowArtifactInputPath,
+  refreshTileflowArtifactSession,
+  tileflowArtifactInventoryFileName,
+  tileflowArtifactPlanSchemaVersion,
+  tileflowArtifactSessionSchemaVersion,
+  writeTileflowArtifactPlan,
+  writeTileflowBuildArtifacts
+} from "./chunk-O7PE6FB2.js";
+import {
+  getTileflowAssetBasePath,
+  getTileflowAssetFileName,
+  joinTileflowPublicUrl,
+  normalizeTileflowBasePath,
+  resolveTileflowArtifactPublicUrls
+} from "./chunk-VEB43KDS.js";
+import "./chunk-BALG4DSG.js";
+import "./chunk-BL3FK4GO.js";
+import "./chunk-KDFTE4Q5.js";
+import {
+  defaultTileflowConfigPath
+} from "./chunk-BKHIZ7H2.js";
+import "./chunk-D4OE4ITL.js";
+export {
+  TileflowHostedManifestOverwriteError,
+  assertTileflowSelfHostedManifestTarget,
+  createTileflowArtifactDiagnostics,
+  createTileflowArtifactPlan,
+  createTileflowArtifactSession,
+  createTileflowBuildArtifacts,
+  createTileflowBuildProvenance,
+  createTileflowManifest,
+  createTileflowStyle,
+  createTileflowStyles,
+  defaultTileflowConfigPath,
+  getTileflowArtifactFiles,
+  getTileflowAssetBasePath,
+  getTileflowAssetFileName,
+  getTileflowWatchPaths,
+  isTileflowArtifactInputPath,
+  joinTileflowPublicUrl,
+  normalizeTileflowBasePath,
+  refreshTileflowArtifactSession,
+  resolveTileflowArtifactPublicUrls,
+  tileflowArtifactInventoryFileName,
+  tileflowArtifactPlanSchemaVersion,
+  tileflowArtifactSessionSchemaVersion,
+  writeTileflowArtifactPlan,
+  writeTileflowBuildArtifacts
+};