siteplane 0.1.36

package/dist/next.d.ts

@@ -0,0 +1,91 @@
+type NextConfigLike = {
+  env?: Record<string, string | undefined>;
+};
+
+export type SiteplaneNextOptions = {
+  projectDir?: string;
+  buildRevision?: string;
+};
+
+export type SiteplaneFieldScanIssue = {
+  code: string;
+  message: string;
+  fieldId?: string;
+  filePath: string;
+};
+
+type SiteplaneSourceMapping = {
+  kind: "function";
+  filePath: string;
+  exportName?: string;
+  sourcePath?: string;
+  editTarget?: string;
+};
+
+type SiteplaneDomMapping = {
+  attribute: "data-siteplane-field-id";
+  previewStrategy: "dom" | "event";
+};
+
+type SiteplaneContractFieldBase = {
+  fieldId: string;
+  routeKey: string;
+  source: SiteplaneSourceMapping;
+  dom?: SiteplaneDomMapping;
+};
+
+export type SiteplaneSiteFieldContractV1 = {
+  version: 1;
+  fieldContractVersion: string;
+  scannerContractVersion: string;
+  fields: Array<
+    | (SiteplaneContractFieldBase & {
+        fieldType: "text" | "longText";
+        fallback: string;
+      })
+    | (SiteplaneContractFieldBase & {
+        fieldType: "link";
+        fallback: {
+          href: string;
+          label?: string;
+          target?: "_self" | "_blank";
+        };
+      })
+    | (SiteplaneContractFieldBase & {
+        fieldType: "image";
+        fallback: {
+          src: string;
+          alt: string;
+          width?: number;
+          height?: number;
+          crop?: {
+            x: number;
+            y: number;
+            zoom: number;
+            aspectRatio: number;
+          };
+        };
+      })
+  >;
+};
+
+export declare class SiteplaneNextContractError extends Error {
+  readonly code:
+    | "field_contract_scan_failed"
+    | "missing_build_revision"
+    | "missing_field_contract"
+    | "stale_field_contract";
+}
+
+export declare function scanNextProjectFieldContract(projectDir: string): Promise<{
+  fieldContractHash: string;
+  contract: SiteplaneSiteFieldContractV1;
+  hardErrors: SiteplaneFieldScanIssue[];
+  warnings: SiteplaneFieldScanIssue[];
+  suggestions: SiteplaneFieldScanIssue[];
+}>;
+
+export declare function withSiteplane<TConfig extends NextConfigLike>(
+  nextConfig: TConfig,
+  options?: SiteplaneNextOptions
+): Promise<TConfig & { env: Record<string, string | undefined> }>;