@lownoise-studio/rendershield 0.3.0 → 1.0.0

package/src/errors.ts

@@ -0,0 +1,48 @@
+/**
+ * Stable error codes for programmatic consumers and CI integrations.
+ */
+export type RenderShieldErrorCode =
+  | "CONFIG_MISSING"
+  | "CONFIG_INVALID"
+  | "OUTPUT_PATH_UNSAFE"
+  | "CONTENT_INVALID"
+  | "BUILD_FAILED"
+  | "VALIDATION_FAILED"
+  | "VERIFY_FAILED"
+  | "CLI_INVALID_ARGS";
+
+export class RenderShieldError extends Error {
+  readonly code: RenderShieldErrorCode;
+  readonly details?: Record<string, unknown>;
+
+  constructor(
+    code: RenderShieldErrorCode,
+    message: string,
+    details?: Record<string, unknown>
+  ) {
+    super(message);
+    this.name = "RenderShieldError";
+    this.code = code;
+    this.details = details;
+  }
+}
+
+export function isRenderShieldError(err: unknown): err is RenderShieldError {
+  return err instanceof RenderShieldError;
+}
+
+export function renderShieldError(
+  code: RenderShieldErrorCode,
+  message: string,
+  details?: Record<string, unknown>
+): RenderShieldError {
+  return new RenderShieldError(code, message, details);
+}
+
+/** Format an error for CLI output; includes code when available. */
+export function formatCliError(err: unknown): string {
+  if (isRenderShieldError(err)) {
+    return `[${err.code}] ${err.message}`;
+  }
+  return err instanceof Error ? err.message : String(err);
+}

package/src/index.ts

@@ -0,0 +1,40 @@
+/**
+ * RenderShield programmatic API.
+ *
+ * CLI usage: `npx rendershield <command>`
+ * Library usage: import commands and core helpers from `@lownoise-studio/rendershield`.
+ */
+
+export { cmdInit } from "./commands/init.js";
+export { cmdBuild } from "./commands/build.js";
+export {
+  cmdVerify,
+  type VerifyProdOptions,
+  type VerifyLocalResult,
+  type VerifyProdResult,
+  type VerifyResult,
+} from "./commands/verify.js";
+
+export { loadConfig } from "./core/loadConfig.js";
+export { loadAllMarkdownDocs } from "./core/loadMarkdown.js";
+export { renderPageHtml } from "./core/renderHtml.js";
+export {
+  validatePrerenderHtml,
+  checkPrerenderContract,
+  type ValidateParams,
+  type ContractCheckResult,
+} from "./core/validateOutput.js";
+export { generateSitemapXml } from "./core/generateSitemap.js";
+export { generateRobotsTxt } from "./core/generateRobots.js";
+export { generateWorkerJs } from "./core/generateWorker.js";
+
+export type { RenderShieldConfig, MarkdownDoc, SchemaType } from "./types.js";
+export { SCHEMA_TYPES } from "./types.js";
+
+export {
+  RenderShieldError,
+  isRenderShieldError,
+  renderShieldError,
+  formatCliError,
+  type RenderShieldErrorCode,
+} from "./errors.js";

package/src/types.ts

@@ -1,3 +1,6 @@
+export const SCHEMA_TYPES = ["Article", "BlogPosting", "WebPage"] as const;
+export type SchemaType = (typeof SCHEMA_TYPES)[number];
+
 export type RenderShieldConfig = {
     version: 1;
     site: {
@@ -13,7 +16,7 @@ export type RenderShieldConfig = {
           name: string; // blog
           pattern: string; // blog/**/*.md
           routeBase: string; // /blog
-          schemaType: "Article"; // v0 only supports Article
+          schemaType: SchemaType;
         }>;
       };
     };