@screenbook/core 0.0.1 → 0.1.0

package/dist/index.cjs

@@ -2,7 +2,8 @@ let zod = require("zod");
 
 //#region src/types.ts
 /**
-* Schema for screen metadata definition
+* Schema for screen metadata definition (runtime validation)
+* @internal
 */
 const screenSchema = zod.z.object({
 	id: zod.z.string().min(1),
@@ -13,6 +14,7 @@ const screenSchema = zod.z.object({
 	dependsOn: zod.z.array(zod.z.string()).optional(),
 	entryPoints: zod.z.array(zod.z.string()).optional(),
 	next: zod.z.array(zod.z.string()).optional(),
+	allowCycles: zod.z.boolean().optional(),
 	description: zod.z.string().optional(),
 	links: zod.z.array(zod.z.object({
 		label: zod.z.string(),
@@ -20,7 +22,8 @@ const screenSchema = zod.z.object({
 	})).optional()
 });
 /**
-* Schema for progressive adoption configuration
+* Schema for progressive adoption configuration (runtime validation)
+* @internal
 */
 const adoptionSchema = zod.z.object({
 	mode: zod.z.enum(["full", "progressive"]).default("full"),
@@ -28,7 +31,8 @@ const adoptionSchema = zod.z.object({
 	minimumCoverage: zod.z.number().min(0).max(100).optional()
 });
 /**
-* Schema for Screenbook configuration
+* Schema for Screenbook configuration (runtime validation)
+* @internal
 */
 const configSchema = zod.z.object({
 	outDir: zod.z.string().default(".screenbook"),

package/dist/index.d.cts

@@ -3,7 +3,116 @@ import { z } from "zod";
 //#region src/types.d.ts
 
 /**
- * Schema for screen metadata definition
+ * External link to related resources
+ */
+interface ScreenLink {
+  /**
+   * Display label for the link
+   * @example "Figma Design"
+   * @example "Storybook"
+   */
+  label: string;
+  /**
+   * URL to the external resource
+   * @example "https://figma.com/file/..."
+   * @example "https://storybook.example.com/?path=/story/billing-invoice"
+   */
+  url: string;
+}
+/**
+ * Screen metadata definition for the screen catalog.
+ *
+ * @example
+ * ```ts
+ * const screen: Screen = {
+ *   id: "billing.invoice.detail",
+ *   title: "Invoice Detail",
+ *   route: "/billing/invoices/:id",
+ *   owner: ["billing-team"],
+ *   tags: ["billing", "invoice"],
+ *   dependsOn: ["InvoiceAPI.getDetail"],
+ *   next: ["billing.invoice.edit"],
+ * }
+ * ```
+ */
+interface Screen {
+  /**
+   * Unique identifier for the screen using dot notation
+   * @example "billing.invoice.detail"
+   * @example "auth.login"
+   * @example "settings.profile"
+   */
+  id: string;
+  /**
+   * Human-readable title displayed in the screen catalog
+   * @example "Invoice Detail"
+   * @example "Login"
+   * @example "User Profile Settings"
+   */
+  title: string;
+  /**
+   * Route path pattern with optional dynamic segments
+   * @example "/billing/invoices/:id"
+   * @example "/auth/login"
+   * @example "/settings/profile"
+   */
+  route: string;
+  /**
+   * Team(s) or domain(s) that own this screen
+   * @example ["billing-team"]
+   * @example ["platform", "billing"]
+   */
+  owner?: string[];
+  /**
+   * Tags for categorization and filtering in the catalog
+   * @example ["billing", "invoice"]
+   * @example ["auth", "security"]
+   */
+  tags?: string[];
+  /**
+   * APIs or services this screen depends on for impact analysis
+   * @example ["InvoiceAPI.getDetail", "PaymentAPI.getStatus"]
+   * @example ["UserAPI.getProfile"]
+   */
+  dependsOn?: string[];
+  /**
+   * Screen IDs that can navigate to this screen (incoming edges)
+   * @example ["billing.invoice.list"]
+   * @example ["dashboard.home", "nav.sidebar"]
+   */
+  entryPoints?: string[];
+  /**
+   * Screen IDs this screen can navigate to (outgoing edges)
+   * @example ["billing.invoice.edit", "billing.payment.start"]
+   * @example ["billing.invoice.list"]
+   */
+  next?: string[];
+  /**
+   * Allow circular navigation involving this screen.
+   * When true, cycles that include this screen will not trigger warnings.
+   * @default false
+   * @example true
+   */
+  allowCycles?: boolean;
+  /**
+   * Optional description explaining the screen's purpose
+   * @example "Displays detailed invoice information including line items and payment status"
+   */
+  description?: string;
+  /**
+   * Links to external resources like Storybook, Figma, or documentation
+   * @example [{ label: "Figma", url: "https://figma.com/file/..." }]
+   */
+  links?: ScreenLink[];
+}
+/**
+ * Input type for defineScreen function.
+ * Same as Screen but used for input validation.
+ */
+type ScreenInput = Screen;
+/**
+ * Schema for screen metadata definition (runtime validation)
+ * @internal
  */
 declare const screenSchema: z.ZodObject<{
   id: z.ZodString;
@@ -14,6 +123,7 @@ declare const screenSchema: z.ZodObject<{
   dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
   entryPoints: z.ZodOptional<z.ZodArray<z.ZodString>>;
   next: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  allowCycles: z.ZodOptional<z.ZodBoolean>;
   description: z.ZodOptional<z.ZodString>;
   links: z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
@@ -21,15 +131,43 @@ declare const screenSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 /**
- * Type for screen metadata definition
- */
-type Screen = z.infer<typeof screenSchema>;
-/**
- * Input type for defineScreen function (allows partial optional fields)
+ * Progressive adoption configuration for gradual rollout.
+ *
+ * @example
+ * ```ts
+ * const adoption: AdoptionConfig = {
+ *   mode: "progressive",
+ *   includePatterns: ["src/pages/billing/**"],
+ *   minimumCoverage: 80,
+ * }
+ * ```
  */
-type ScreenInput = z.input<typeof screenSchema>;
+interface AdoptionConfig {
+  /**
+   * Adoption mode for screen metadata coverage
+   * - `"full"`: All routes must have screen.meta.ts (default)
+   * - `"progressive"`: Only check coverage within includePatterns
+   * @default "full"
+   * @example "full"
+   * @example "progressive"
+   */
+  mode?: "full" | "progressive";
+  /**
+   * Glob patterns to include for coverage checking (progressive mode only)
+   * @example ["src/pages/billing/**"]
+   * @example ["src/pages/auth/**", "src/pages/settings/**"]
+   */
+  includePatterns?: string[];
+  /**
+   * Minimum coverage percentage required to pass lint (0-100)
+   * @example 80
+   * @example 100
+   */
+  minimumCoverage?: number;
+}
 /**
- * Schema for progressive adoption configuration
+ * Schema for progressive adoption configuration (runtime validation)
+ * @internal
  */
 declare const adoptionSchema: z.ZodObject<{
   mode: z.ZodDefault<z.ZodEnum<{
@@ -40,11 +178,85 @@ declare const adoptionSchema: z.ZodObject<{
   minimumCoverage: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
- * Type for progressive adoption configuration
+ * Screenbook configuration options.
+ */
+interface Config {
+  /**
+   * Output directory for generated files
+   * @default ".screenbook"
+   * @example ".screenbook"
+   * @example "dist/screenbook"
+   */
+  outDir: string;
+  /**
+   * Glob pattern for screen metadata files.
+   * Supports colocation: place screen.meta.ts alongside your route files.
+   * @default "src/**\/screen.meta.ts"
+   * @example "src/**\/screen.meta.ts"
+   * @example "app/**\/screen.meta.ts"
+   */
+  metaPattern: string;
+  /**
+   * Glob pattern for route files (for generate/lint commands)
+   * @example "src/pages/**\/page.tsx"
+   * @example "app/**\/page.tsx"
+   * @example "src/routes/**\/*.tsx"
+   */
+  routesPattern?: string;
+  /**
+   * Patterns to ignore when scanning (glob patterns).
+   * Defaults to node_modules and .git directories.
+   */
+  ignore: string[];
+  /**
+   * Progressive adoption configuration for gradual rollout
+   * @example { mode: "progressive", includePatterns: ["src/pages/billing/**"], minimumCoverage: 80 }
+   */
+  adoption?: AdoptionConfig;
+}
+/**
+ * Input type for defineConfig function.
+ * All fields with defaults are optional in input.
+ *
+ * @example
+ * ```ts
+ * defineConfig({
+ *   metaPattern: "app/**\/screen.meta.ts",
+ *   routesPattern: "app/**\/page.tsx",
+ * })
+ * ```
  */
-type AdoptionConfig = z.infer<typeof adoptionSchema>;
+interface ConfigInput {
+  /**
+   * Output directory for generated files
+   * @default ".screenbook"
+   * @example ".screenbook"
+   */
+  outDir?: string;
+  /**
+   * Glob pattern for screen metadata files
+   * @default "src/**\/screen.meta.ts"
+   * @example "app/**\/screen.meta.ts"
+   */
+  metaPattern?: string;
+  /**
+   * Glob pattern for route files (for generate/lint commands)
+   * @example "src/pages/**\/page.tsx"
+   */
+  routesPattern?: string;
+  /**
+   * Patterns to ignore when scanning.
+   * Defaults to node_modules and .git directories.
+   */
+  ignore?: string[];
+  /**
+   * Progressive adoption configuration
+   */
+  adoption?: AdoptionConfig;
+}
 /**
- * Schema for Screenbook configuration
+ * Schema for Screenbook configuration (runtime validation)
+ * @internal
  */
 declare const configSchema: z.ZodObject<{
   outDir: z.ZodDefault<z.ZodString>;
@@ -60,14 +272,6 @@ declare const configSchema: z.ZodObject<{
     minimumCoverage: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
-/**
- * Type for Screenbook configuration
- */
-type Config = z.infer<typeof configSchema>;
-/**
- * Input type for defineConfig function
- */
-type ConfigInput = z.input<typeof configSchema>;
 //#endregion
 //#region src/defineScreen.d.ts
 /**

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/defineScreen.ts"],"sourcesContent":[],"mappings":";;;;;;AAKA;cAAa,cAAY,CAAA,CAAA;;;;;;;;;;;;;;;;;;KA0Cb,MAAA,GAAS,CAAA,CAAE,aAAa;;;;KAKxB,WAAA,GAAc,CAAA,CAAE,aAAa;;;;cAK5B,gBAAc,CAAA,CAAA;EApDF,IAAA,cAAA,UAAA,CAAA;IAAA,IAAA,EAAA,MAAA;IA0Cb,WAAM,EAAA,aAAkB;EAKxB,CAAA,CAAA,CAAA;EAKC,eAAA,eAoBX,WAAA,YAAA,CAAA,CAAA;;;;;;KAKU,cAAA,GAAiB,CAAA,CAAE,aAAa;;;;AAzBjB,cA8Bd,YA9Bc,EA8BF,CAAA,CAAA,SA9BE,CAAA;EAyBf,MAAA,cAAc,YAAkB,CAAA;EAK/B,WAAA,cAyBX,YAAA,CAAA;;;;;;;;;;;;;;;KAKU,MAAA,GAAS,CAAA,CAAE,aAAa;;;;KAKxB,WAAA,GAAc,CAAA,CAAE,aAAa;;;;;AArHzC;;;;;;;;;;;;;;;iBCqBgB,YAAA,QAAoB,cAAc;;;;;;;;;;;;;ADrBzB,iBCqCT,YAAA,CDrCS,KAAA,CAAA,ECqCW,WDrCX,CAAA,ECqC8B,MDrC9B"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/defineScreen.ts"],"sourcesContent":[],"mappings":";;;;;;AAKA;AA+BiB,UA/BA,UAAA,CA6GR;EAOG;AAMZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA3FiB,MAAA;;;;AA4HjB;AA8BA;;;;;;;;;EAA2B,KAAA,EAAA,MAAA;EAAA;AAS3B;AAmDA;AAqCA;;;;;;;;;;;;;;;;;;;;;EAAyB,SAAA,CAAA,EAAA,MAAA,EAAA;EAAA;;;;ACrQzB;EAgBgB,WAAA,CAAA,EAAA,MAAY,EAAA;;;;;;;;;;;;;;;;;;;;;;;UDwEnB;;;;;;KAOG,WAAA,GAAc;;;;;cAMb,cAAY,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAiCR,cAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;cA8BJ,gBAAc,CAAA,CAAA;;;;;;;;;;;UASV,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAoCL;;;;;;;;;;;;;;UAeK,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;aA8BL;;;;;;cAOC,cAAY,CAAA,CAAA;;;;;;;;;;;;;;;;;;AA1RzB;AA+BA;AAqFA;AAMA;;;;;;;;;;;;iBCrGgB,YAAA,QAAoB,cAAc;;;;;;;;;;;;;iBAgBlC,YAAA,SAAoB,cAAmB"}

package/dist/index.d.mts

@@ -3,7 +3,116 @@ import { z } from "zod";
 //#region src/types.d.ts
 
 /**
- * Schema for screen metadata definition
+ * External link to related resources
+ */
+interface ScreenLink {
+  /**
+   * Display label for the link
+   * @example "Figma Design"
+   * @example "Storybook"
+   */
+  label: string;
+  /**
+   * URL to the external resource
+   * @example "https://figma.com/file/..."
+   * @example "https://storybook.example.com/?path=/story/billing-invoice"
+   */
+  url: string;
+}
+/**
+ * Screen metadata definition for the screen catalog.
+ *
+ * @example
+ * ```ts
+ * const screen: Screen = {
+ *   id: "billing.invoice.detail",
+ *   title: "Invoice Detail",
+ *   route: "/billing/invoices/:id",
+ *   owner: ["billing-team"],
+ *   tags: ["billing", "invoice"],
+ *   dependsOn: ["InvoiceAPI.getDetail"],
+ *   next: ["billing.invoice.edit"],
+ * }
+ * ```
+ */
+interface Screen {
+  /**
+   * Unique identifier for the screen using dot notation
+   * @example "billing.invoice.detail"
+   * @example "auth.login"
+   * @example "settings.profile"
+   */
+  id: string;
+  /**
+   * Human-readable title displayed in the screen catalog
+   * @example "Invoice Detail"
+   * @example "Login"
+   * @example "User Profile Settings"
+   */
+  title: string;
+  /**
+   * Route path pattern with optional dynamic segments
+   * @example "/billing/invoices/:id"
+   * @example "/auth/login"
+   * @example "/settings/profile"
+   */
+  route: string;
+  /**
+   * Team(s) or domain(s) that own this screen
+   * @example ["billing-team"]
+   * @example ["platform", "billing"]
+   */
+  owner?: string[];
+  /**
+   * Tags for categorization and filtering in the catalog
+   * @example ["billing", "invoice"]
+   * @example ["auth", "security"]
+   */
+  tags?: string[];
+  /**
+   * APIs or services this screen depends on for impact analysis
+   * @example ["InvoiceAPI.getDetail", "PaymentAPI.getStatus"]
+   * @example ["UserAPI.getProfile"]
+   */
+  dependsOn?: string[];
+  /**
+   * Screen IDs that can navigate to this screen (incoming edges)
+   * @example ["billing.invoice.list"]
+   * @example ["dashboard.home", "nav.sidebar"]
+   */
+  entryPoints?: string[];
+  /**
+   * Screen IDs this screen can navigate to (outgoing edges)
+   * @example ["billing.invoice.edit", "billing.payment.start"]
+   * @example ["billing.invoice.list"]
+   */
+  next?: string[];
+  /**
+   * Allow circular navigation involving this screen.
+   * When true, cycles that include this screen will not trigger warnings.
+   * @default false
+   * @example true
+   */
+  allowCycles?: boolean;
+  /**
+   * Optional description explaining the screen's purpose
+   * @example "Displays detailed invoice information including line items and payment status"
+   */
+  description?: string;
+  /**
+   * Links to external resources like Storybook, Figma, or documentation
+   * @example [{ label: "Figma", url: "https://figma.com/file/..." }]
+   */
+  links?: ScreenLink[];
+}
+/**
+ * Input type for defineScreen function.
+ * Same as Screen but used for input validation.
+ */
+type ScreenInput = Screen;
+/**
+ * Schema for screen metadata definition (runtime validation)
+ * @internal
  */
 declare const screenSchema: z.ZodObject<{
   id: z.ZodString;
@@ -14,6 +123,7 @@ declare const screenSchema: z.ZodObject<{
   dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
   entryPoints: z.ZodOptional<z.ZodArray<z.ZodString>>;
   next: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  allowCycles: z.ZodOptional<z.ZodBoolean>;
   description: z.ZodOptional<z.ZodString>;
   links: z.ZodOptional<z.ZodArray<z.ZodObject<{
     label: z.ZodString;
@@ -21,15 +131,43 @@ declare const screenSchema: z.ZodObject<{
   }, z.core.$strip>>>;
 }, z.core.$strip>;
 /**
- * Type for screen metadata definition
- */
-type Screen = z.infer<typeof screenSchema>;
-/**
- * Input type for defineScreen function (allows partial optional fields)
+ * Progressive adoption configuration for gradual rollout.
+ *
+ * @example
+ * ```ts
+ * const adoption: AdoptionConfig = {
+ *   mode: "progressive",
+ *   includePatterns: ["src/pages/billing/**"],
+ *   minimumCoverage: 80,
+ * }
+ * ```
  */
-type ScreenInput = z.input<typeof screenSchema>;
+interface AdoptionConfig {
+  /**
+   * Adoption mode for screen metadata coverage
+   * - `"full"`: All routes must have screen.meta.ts (default)
+   * - `"progressive"`: Only check coverage within includePatterns
+   * @default "full"
+   * @example "full"
+   * @example "progressive"
+   */
+  mode?: "full" | "progressive";
+  /**
+   * Glob patterns to include for coverage checking (progressive mode only)
+   * @example ["src/pages/billing/**"]
+   * @example ["src/pages/auth/**", "src/pages/settings/**"]
+   */
+  includePatterns?: string[];
+  /**
+   * Minimum coverage percentage required to pass lint (0-100)
+   * @example 80
+   * @example 100
+   */
+  minimumCoverage?: number;
+}
 /**
- * Schema for progressive adoption configuration
+ * Schema for progressive adoption configuration (runtime validation)
+ * @internal
  */
 declare const adoptionSchema: z.ZodObject<{
   mode: z.ZodDefault<z.ZodEnum<{
@@ -40,11 +178,85 @@ declare const adoptionSchema: z.ZodObject<{
   minimumCoverage: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
- * Type for progressive adoption configuration
+ * Screenbook configuration options.
+ */
+interface Config {
+  /**
+   * Output directory for generated files
+   * @default ".screenbook"
+   * @example ".screenbook"
+   * @example "dist/screenbook"
+   */
+  outDir: string;
+  /**
+   * Glob pattern for screen metadata files.
+   * Supports colocation: place screen.meta.ts alongside your route files.
+   * @default "src/**\/screen.meta.ts"
+   * @example "src/**\/screen.meta.ts"
+   * @example "app/**\/screen.meta.ts"
+   */
+  metaPattern: string;
+  /**
+   * Glob pattern for route files (for generate/lint commands)
+   * @example "src/pages/**\/page.tsx"
+   * @example "app/**\/page.tsx"
+   * @example "src/routes/**\/*.tsx"
+   */
+  routesPattern?: string;
+  /**
+   * Patterns to ignore when scanning (glob patterns).
+   * Defaults to node_modules and .git directories.
+   */
+  ignore: string[];
+  /**
+   * Progressive adoption configuration for gradual rollout
+   * @example { mode: "progressive", includePatterns: ["src/pages/billing/**"], minimumCoverage: 80 }
+   */
+  adoption?: AdoptionConfig;
+}
+/**
+ * Input type for defineConfig function.
+ * All fields with defaults are optional in input.
+ *
+ * @example
+ * ```ts
+ * defineConfig({
+ *   metaPattern: "app/**\/screen.meta.ts",
+ *   routesPattern: "app/**\/page.tsx",
+ * })
+ * ```
  */
-type AdoptionConfig = z.infer<typeof adoptionSchema>;
+interface ConfigInput {
+  /**
+   * Output directory for generated files
+   * @default ".screenbook"
+   * @example ".screenbook"
+   */
+  outDir?: string;
+  /**
+   * Glob pattern for screen metadata files
+   * @default "src/**\/screen.meta.ts"
+   * @example "app/**\/screen.meta.ts"
+   */
+  metaPattern?: string;
+  /**
+   * Glob pattern for route files (for generate/lint commands)
+   * @example "src/pages/**\/page.tsx"
+   */
+  routesPattern?: string;
+  /**
+   * Patterns to ignore when scanning.
+   * Defaults to node_modules and .git directories.
+   */
+  ignore?: string[];
+  /**
+   * Progressive adoption configuration
+   */
+  adoption?: AdoptionConfig;
+}
 /**
- * Schema for Screenbook configuration
+ * Schema for Screenbook configuration (runtime validation)
+ * @internal
  */
 declare const configSchema: z.ZodObject<{
   outDir: z.ZodDefault<z.ZodString>;
@@ -60,14 +272,6 @@ declare const configSchema: z.ZodObject<{
     minimumCoverage: z.ZodOptional<z.ZodNumber>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
-/**
- * Type for Screenbook configuration
- */
-type Config = z.infer<typeof configSchema>;
-/**
- * Input type for defineConfig function
- */
-type ConfigInput = z.input<typeof configSchema>;
 //#endregion
 //#region src/defineScreen.d.ts
 /**

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/defineScreen.ts"],"sourcesContent":[],"mappings":";;;;;;AAKA;cAAa,cAAY,CAAA,CAAA;;;;;;;;;;;;;;;;;;KA0Cb,MAAA,GAAS,CAAA,CAAE,aAAa;;;;KAKxB,WAAA,GAAc,CAAA,CAAE,aAAa;;;;cAK5B,gBAAc,CAAA,CAAA;EApDF,IAAA,cAAA,UAAA,CAAA;IAAA,IAAA,EAAA,MAAA;IA0Cb,WAAM,EAAA,aAAkB;EAKxB,CAAA,CAAA,CAAA;EAKC,eAAA,eAoBX,WAAA,YAAA,CAAA,CAAA;;;;;;KAKU,cAAA,GAAiB,CAAA,CAAE,aAAa;;;;AAzBjB,cA8Bd,YA9Bc,EA8BF,CAAA,CAAA,SA9BE,CAAA;EAyBf,MAAA,cAAc,YAAkB,CAAA;EAK/B,WAAA,cAyBX,YAAA,CAAA;;;;;;;;;;;;;;;KAKU,MAAA,GAAS,CAAA,CAAE,aAAa;;;;KAKxB,WAAA,GAAc,CAAA,CAAE,aAAa;;;;;AArHzC;;;;;;;;;;;;;;;iBCqBgB,YAAA,QAAoB,cAAc;;;;;;;;;;;;;ADrBzB,iBCqCT,YAAA,CDrCS,KAAA,CAAA,ECqCW,WDrCX,CAAA,ECqC8B,MDrC9B"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/defineScreen.ts"],"sourcesContent":[],"mappings":";;;;;;AAKA;AA+BiB,UA/BA,UAAA,CA6GR;EAOG;AAMZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA3FiB,MAAA;;;;AA4HjB;AA8BA;;;;;;;;;EAA2B,KAAA,EAAA,MAAA;EAAA;AAS3B;AAmDA;AAqCA;;;;;;;;;;;;;;;;;;;;;EAAyB,SAAA,CAAA,EAAA,MAAA,EAAA;EAAA;;;;ACrQzB;EAgBgB,WAAA,CAAA,EAAA,MAAY,EAAA;;;;;;;;;;;;;;;;;;;;;;;UDwEnB;;;;;;KAOG,WAAA,GAAc;;;;;cAMb,cAAY,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAiCR,cAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;cA8BJ,gBAAc,CAAA,CAAA;;;;;;;;;;;UASV,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAoCL;;;;;;;;;;;;;;UAeK,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;aA8BL;;;;;;cAOC,cAAY,CAAA,CAAA;;;;;;;;;;;;;;;;;;AA1RzB;AA+BA;AAqFA;AAMA;;;;;;;;;;;;iBCrGgB,YAAA,QAAoB,cAAc;;;;;;;;;;;;;iBAgBlC,YAAA,SAAoB,cAAmB"}

package/dist/index.mjs

@@ -2,7 +2,8 @@ import { z } from "zod";
 
 //#region src/types.ts
 /**
-* Schema for screen metadata definition
+* Schema for screen metadata definition (runtime validation)
+* @internal
 */
 const screenSchema = z.object({
 	id: z.string().min(1),
@@ -13,6 +14,7 @@ const screenSchema = z.object({
 	dependsOn: z.array(z.string()).optional(),
 	entryPoints: z.array(z.string()).optional(),
 	next: z.array(z.string()).optional(),
+	allowCycles: z.boolean().optional(),
 	description: z.string().optional(),
 	links: z.array(z.object({
 		label: z.string(),
@@ -20,7 +22,8 @@ const screenSchema = z.object({
 	})).optional()
 });
 /**
-* Schema for progressive adoption configuration
+* Schema for progressive adoption configuration (runtime validation)
+* @internal
 */
 const adoptionSchema = z.object({
 	mode: z.enum(["full", "progressive"]).default("full"),
@@ -28,7 +31,8 @@ const adoptionSchema = z.object({
 	minimumCoverage: z.number().min(0).max(100).optional()
 });
 /**
-* Schema for Screenbook configuration
+* Schema for Screenbook configuration (runtime validation)
+* @internal
 */
 const configSchema = z.object({
 	outDir: z.string().default(".screenbook"),

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/types.ts","../src/defineScreen.ts"],"sourcesContent":["import { z } from \"zod\"\n\n/**\n * Schema for screen metadata definition\n */\nexport const screenSchema = z.object({\n\t/** Unique identifier for the screen (e.g., \"billing.invoice.detail\") */\n\tid: z.string().min(1),\n\n\t/** Human-readable title of the screen */\n\ttitle: z.string().min(1),\n\n\t/** Route path pattern (e.g., \"/billing/invoices/:id\") */\n\troute: z.string().min(1),\n\n\t/** Team(s) or domain(s) that own this screen */\n\towner: z.array(z.string()).optional(),\n\n\t/** Tags for categorization and filtering */\n\ttags: z.array(z.string()).optional(),\n\n\t/** APIs or services this screen depends on */\n\tdependsOn: z.array(z.string()).optional(),\n\n\t/** Screen IDs that can navigate to this screen */\n\tentryPoints: z.array(z.string()).optional(),\n\n\t/** Screen IDs this screen can navigate to */\n\tnext: z.array(z.string()).optional(),\n\n\t/** Optional description of the screen */\n\tdescription: z.string().optional(),\n\n\t/** Links to external resources (Storybook, Figma, etc.) */\n\tlinks: z\n\t\t.array(\n\t\t\tz.object({\n\t\t\t\tlabel: z.string(),\n\t\t\t\turl: z.string().url(),\n\t\t\t}),\n\t\t)\n\t\t.optional(),\n})\n\n/**\n * Type for screen metadata definition\n */\nexport type Screen = z.infer<typeof screenSchema>\n\n/**\n * Input type for defineScreen function (allows partial optional fields)\n */\nexport type ScreenInput = z.input<typeof screenSchema>\n\n/**\n * Schema for progressive adoption configuration\n */\nexport const adoptionSchema = z.object({\n\t/**\n\t * Adoption mode\n\t * - \"full\": All routes must have screen.meta.ts (default)\n\t * - \"progressive\": Only check coverage within includePatterns\n\t */\n\tmode: z.enum([\"full\", \"progressive\"]).default(\"full\"),\n\n\t/**\n\t * Glob patterns to include for coverage checking (progressive mode only)\n\t * @example [\"src/pages/billing/**\"] - Only check billing module\n\t * @example [\"src/pages/auth/**\", \"src/pages/settings/**\"] - Check multiple modules\n\t */\n\tincludePatterns: z.array(z.string()).optional(),\n\n\t/**\n\t * Minimum coverage percentage required to pass lint\n\t * @example 80 - Fail if coverage is below 80%\n\t */\n\tminimumCoverage: z.number().min(0).max(100).optional(),\n})\n\n/**\n * Type for progressive adoption configuration\n */\nexport type AdoptionConfig = z.infer<typeof adoptionSchema>\n\n/**\n * Schema for Screenbook configuration\n */\nexport const configSchema = z.object({\n\t/** Output directory for generated files */\n\toutDir: z.string().default(\".screenbook\"),\n\n\t/**\n\t * Glob pattern for screen metadata files\n\t * Supports colocation: place screen.meta.ts alongside your route files\n\t * @example \"src/**\\/screen.meta.ts\" - scan entire src directory\n\t * @example \"app/**\\/screen.meta.ts\" - for Next.js App Router\n\t */\n\tmetaPattern: z.string().default(\"src/**/screen.meta.ts\"),\n\n\t/**\n\t * Glob pattern for route files (for generate/lint commands)\n\t * @example \"src/pages/**\\/page.tsx\" - Vite/React\n\t * @example \"app/**\\/page.tsx\" - Next.js App Router\n\t * @example \"src/routes/**\\/*.tsx\" - React Router\n\t */\n\troutesPattern: z.string().optional(),\n\n\t/** Patterns to ignore when scanning (glob patterns) */\n\tignore: z.array(z.string()).default([\"**/node_modules/**\", \"**/.git/**\"]),\n\n\t/** Progressive adoption configuration for gradual rollout */\n\tadoption: adoptionSchema.optional(),\n})\n\n/**\n * Type for Screenbook configuration\n */\nexport type Config = z.infer<typeof configSchema>\n\n/**\n * Input type for defineConfig function\n */\nexport type ConfigInput = z.input<typeof configSchema>\n","import {\n\ttype Config,\n\ttype ConfigInput,\n\tconfigSchema,\n\ttype Screen,\n\ttype ScreenInput,\n\tscreenSchema,\n} from \"./types.js\"\n\n/**\n * Define a screen with metadata for the screen catalog.\n *\n * @example\n * ```ts\n * export const screen = defineScreen({\n *   id: \"billing.invoice.detail\",\n *   title: \"Invoice Detail\",\n *   route: \"/billing/invoices/:id\",\n *   owner: [\"billing\"],\n *   tags: [\"billing\", \"invoice\"],\n *   dependsOn: [\"InvoiceAPI.getDetail\"],\n *   entryPoints: [\"billing.invoice.list\"],\n *   next: [\"billing.invoice.edit\"],\n * })\n * ```\n */\nexport function defineScreen(input: ScreenInput): Screen {\n\treturn screenSchema.parse(input)\n}\n\n/**\n * Define Screenbook configuration.\n *\n * @example\n * ```ts\n * export default defineConfig({\n *   screensDir: \"src/screens\",\n *   outDir: \".screenbook\",\n *   metaPattern: \"**\\/screen.meta.ts\",\n * })\n * ```\n */\nexport function defineConfig(input: ConfigInput = {}): Config {\n\treturn configSchema.parse(input)\n}\n"],"mappings":";;;;;;AAKA,MAAa,eAAe,EAAE,OAAO;CAEpC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE;CAGrB,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE;CAGxB,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE;CAGxB,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAGrC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAGpC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAGzC,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAG3C,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAGpC,aAAa,EAAE,QAAQ,CAAC,UAAU;CAGlC,OAAO,EACL,MACA,EAAE,OAAO;EACR,OAAO,EAAE,QAAQ;EACjB,KAAK,EAAE,QAAQ,CAAC,KAAK;EACrB,CAAC,CACF,CACA,UAAU;CACZ,CAAC;;;;AAeF,MAAa,iBAAiB,EAAE,OAAO;CAMtC,MAAM,EAAE,KAAK,CAAC,QAAQ,cAAc,CAAC,CAAC,QAAQ,OAAO;CAOrD,iBAAiB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAM/C,iBAAiB,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU;CACtD,CAAC;;;;AAUF,MAAa,eAAe,EAAE,OAAO;CAEpC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,cAAc;CAQzC,aAAa,EAAE,QAAQ,CAAC,QAAQ,wBAAwB;CAQxD,eAAe,EAAE,QAAQ,CAAC,UAAU;CAGpC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,sBAAsB,aAAa,CAAC;CAGzE,UAAU,eAAe,UAAU;CACnC,CAAC;;;;;;;;;;;;;;;;;;;;;ACtFF,SAAgB,aAAa,OAA4B;AACxD,QAAO,aAAa,MAAM,MAAM;;;;;;;;;;;;;;AAejC,SAAgB,aAAa,QAAqB,EAAE,EAAU;AAC7D,QAAO,aAAa,MAAM,MAAM"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/types.ts","../src/defineScreen.ts"],"sourcesContent":["import { z } from \"zod\"\n\n/**\n * External link to related resources\n */\nexport interface ScreenLink {\n\t/**\n\t * Display label for the link\n\t * @example \"Figma Design\"\n\t * @example \"Storybook\"\n\t */\n\tlabel: string\n\t/**\n\t * URL to the external resource\n\t * @example \"https://figma.com/file/...\"\n\t * @example \"https://storybook.example.com/?path=/story/billing-invoice\"\n\t */\n\turl: string\n}\n\n/**\n * Screen metadata definition for the screen catalog.\n *\n * @example\n * ```ts\n * const screen: Screen = {\n *   id: \"billing.invoice.detail\",\n *   title: \"Invoice Detail\",\n *   route: \"/billing/invoices/:id\",\n *   owner: [\"billing-team\"],\n *   tags: [\"billing\", \"invoice\"],\n *   dependsOn: [\"InvoiceAPI.getDetail\"],\n *   next: [\"billing.invoice.edit\"],\n * }\n * ```\n */\nexport interface Screen {\n\t/**\n\t * Unique identifier for the screen using dot notation\n\t * @example \"billing.invoice.detail\"\n\t * @example \"auth.login\"\n\t * @example \"settings.profile\"\n\t */\n\tid: string\n\n\t/**\n\t * Human-readable title displayed in the screen catalog\n\t * @example \"Invoice Detail\"\n\t * @example \"Login\"\n\t * @example \"User Profile Settings\"\n\t */\n\ttitle: string\n\n\t/**\n\t * Route path pattern with optional dynamic segments\n\t * @example \"/billing/invoices/:id\"\n\t * @example \"/auth/login\"\n\t * @example \"/settings/profile\"\n\t */\n\troute: string\n\n\t/**\n\t * Team(s) or domain(s) that own this screen\n\t * @example [\"billing-team\"]\n\t * @example [\"platform\", \"billing\"]\n\t */\n\towner?: string[]\n\n\t/**\n\t * Tags for categorization and filtering in the catalog\n\t * @example [\"billing\", \"invoice\"]\n\t * @example [\"auth\", \"security\"]\n\t */\n\ttags?: string[]\n\n\t/**\n\t * APIs or services this screen depends on for impact analysis\n\t * @example [\"InvoiceAPI.getDetail\", \"PaymentAPI.getStatus\"]\n\t * @example [\"UserAPI.getProfile\"]\n\t */\n\tdependsOn?: string[]\n\n\t/**\n\t * Screen IDs that can navigate to this screen (incoming edges)\n\t * @example [\"billing.invoice.list\"]\n\t * @example [\"dashboard.home\", \"nav.sidebar\"]\n\t */\n\tentryPoints?: string[]\n\n\t/**\n\t * Screen IDs this screen can navigate to (outgoing edges)\n\t * @example [\"billing.invoice.edit\", \"billing.payment.start\"]\n\t * @example [\"billing.invoice.list\"]\n\t */\n\tnext?: string[]\n\n\t/**\n\t * Allow circular navigation involving this screen.\n\t * When true, cycles that include this screen will not trigger warnings.\n\t * @default false\n\t * @example true\n\t */\n\tallowCycles?: boolean\n\n\t/**\n\t * Optional description explaining the screen's purpose\n\t * @example \"Displays detailed invoice information including line items and payment status\"\n\t */\n\tdescription?: string\n\n\t/**\n\t * Links to external resources like Storybook, Figma, or documentation\n\t * @example [{ label: \"Figma\", url: \"https://figma.com/file/...\" }]\n\t */\n\tlinks?: ScreenLink[]\n}\n\n/**\n * Input type for defineScreen function.\n * Same as Screen but used for input validation.\n */\nexport type ScreenInput = Screen\n\n/**\n * Schema for screen metadata definition (runtime validation)\n * @internal\n */\nexport const screenSchema = z.object({\n\tid: z.string().min(1),\n\ttitle: z.string().min(1),\n\troute: z.string().min(1),\n\towner: z.array(z.string()).optional(),\n\ttags: z.array(z.string()).optional(),\n\tdependsOn: z.array(z.string()).optional(),\n\tentryPoints: z.array(z.string()).optional(),\n\tnext: z.array(z.string()).optional(),\n\tallowCycles: z.boolean().optional(),\n\tdescription: z.string().optional(),\n\tlinks: z\n\t\t.array(\n\t\t\tz.object({\n\t\t\t\tlabel: z.string(),\n\t\t\t\turl: z.string().url(),\n\t\t\t}),\n\t\t)\n\t\t.optional(),\n})\n\n/**\n * Progressive adoption configuration for gradual rollout.\n *\n * @example\n * ```ts\n * const adoption: AdoptionConfig = {\n *   mode: \"progressive\",\n *   includePatterns: [\"src/pages/billing/**\"],\n *   minimumCoverage: 80,\n * }\n * ```\n */\nexport interface AdoptionConfig {\n\t/**\n\t * Adoption mode for screen metadata coverage\n\t * - `\"full\"`: All routes must have screen.meta.ts (default)\n\t * - `\"progressive\"`: Only check coverage within includePatterns\n\t * @default \"full\"\n\t * @example \"full\"\n\t * @example \"progressive\"\n\t */\n\tmode?: \"full\" | \"progressive\"\n\n\t/**\n\t * Glob patterns to include for coverage checking (progressive mode only)\n\t * @example [\"src/pages/billing/**\"]\n\t * @example [\"src/pages/auth/**\", \"src/pages/settings/**\"]\n\t */\n\tincludePatterns?: string[]\n\n\t/**\n\t * Minimum coverage percentage required to pass lint (0-100)\n\t * @example 80\n\t * @example 100\n\t */\n\tminimumCoverage?: number\n}\n\n/**\n * Schema for progressive adoption configuration (runtime validation)\n * @internal\n */\nexport const adoptionSchema = z.object({\n\tmode: z.enum([\"full\", \"progressive\"]).default(\"full\"),\n\tincludePatterns: z.array(z.string()).optional(),\n\tminimumCoverage: z.number().min(0).max(100).optional(),\n})\n\n/**\n * Screenbook configuration options.\n */\nexport interface Config {\n\t/**\n\t * Output directory for generated files\n\t * @default \".screenbook\"\n\t * @example \".screenbook\"\n\t * @example \"dist/screenbook\"\n\t */\n\toutDir: string\n\n\t/**\n\t * Glob pattern for screen metadata files.\n\t * Supports colocation: place screen.meta.ts alongside your route files.\n\t * @default \"src/**\\/screen.meta.ts\"\n\t * @example \"src/**\\/screen.meta.ts\"\n\t * @example \"app/**\\/screen.meta.ts\"\n\t */\n\tmetaPattern: string\n\n\t/**\n\t * Glob pattern for route files (for generate/lint commands)\n\t * @example \"src/pages/**\\/page.tsx\"\n\t * @example \"app/**\\/page.tsx\"\n\t * @example \"src/routes/**\\/*.tsx\"\n\t */\n\troutesPattern?: string\n\n\t/**\n\t * Patterns to ignore when scanning (glob patterns).\n\t * Defaults to node_modules and .git directories.\n\t */\n\tignore: string[]\n\n\t/**\n\t * Progressive adoption configuration for gradual rollout\n\t * @example { mode: \"progressive\", includePatterns: [\"src/pages/billing/**\"], minimumCoverage: 80 }\n\t */\n\tadoption?: AdoptionConfig\n}\n\n/**\n * Input type for defineConfig function.\n * All fields with defaults are optional in input.\n *\n * @example\n * ```ts\n * defineConfig({\n *   metaPattern: \"app/**\\/screen.meta.ts\",\n *   routesPattern: \"app/**\\/page.tsx\",\n * })\n * ```\n */\nexport interface ConfigInput {\n\t/**\n\t * Output directory for generated files\n\t * @default \".screenbook\"\n\t * @example \".screenbook\"\n\t */\n\toutDir?: string\n\n\t/**\n\t * Glob pattern for screen metadata files\n\t * @default \"src/**\\/screen.meta.ts\"\n\t * @example \"app/**\\/screen.meta.ts\"\n\t */\n\tmetaPattern?: string\n\n\t/**\n\t * Glob pattern for route files (for generate/lint commands)\n\t * @example \"src/pages/**\\/page.tsx\"\n\t */\n\troutesPattern?: string\n\n\t/**\n\t * Patterns to ignore when scanning.\n\t * Defaults to node_modules and .git directories.\n\t */\n\tignore?: string[]\n\n\t/**\n\t * Progressive adoption configuration\n\t */\n\tadoption?: AdoptionConfig\n}\n\n/**\n * Schema for Screenbook configuration (runtime validation)\n * @internal\n */\nexport const configSchema = z.object({\n\toutDir: z.string().default(\".screenbook\"),\n\tmetaPattern: z.string().default(\"src/**/screen.meta.ts\"),\n\troutesPattern: z.string().optional(),\n\tignore: z.array(z.string()).default([\"**/node_modules/**\", \"**/.git/**\"]),\n\tadoption: adoptionSchema.optional(),\n})\n","import {\n\ttype Config,\n\ttype ConfigInput,\n\tconfigSchema,\n\ttype Screen,\n\ttype ScreenInput,\n\tscreenSchema,\n} from \"./types.js\"\n\n/**\n * Define a screen with metadata for the screen catalog.\n *\n * @example\n * ```ts\n * export const screen = defineScreen({\n *   id: \"billing.invoice.detail\",\n *   title: \"Invoice Detail\",\n *   route: \"/billing/invoices/:id\",\n *   owner: [\"billing\"],\n *   tags: [\"billing\", \"invoice\"],\n *   dependsOn: [\"InvoiceAPI.getDetail\"],\n *   entryPoints: [\"billing.invoice.list\"],\n *   next: [\"billing.invoice.edit\"],\n * })\n * ```\n */\nexport function defineScreen(input: ScreenInput): Screen {\n\treturn screenSchema.parse(input)\n}\n\n/**\n * Define Screenbook configuration.\n *\n * @example\n * ```ts\n * export default defineConfig({\n *   screensDir: \"src/screens\",\n *   outDir: \".screenbook\",\n *   metaPattern: \"**\\/screen.meta.ts\",\n * })\n * ```\n */\nexport function defineConfig(input: ConfigInput = {}): Config {\n\treturn configSchema.parse(input)\n}\n"],"mappings":";;;;;;;AA+HA,MAAa,eAAe,EAAE,OAAO;CACpC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE;CACrB,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE;CACxB,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE;CACxB,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACrC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACpC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACzC,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAC3C,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACpC,aAAa,EAAE,SAAS,CAAC,UAAU;CACnC,aAAa,EAAE,QAAQ,CAAC,UAAU;CAClC,OAAO,EACL,MACA,EAAE,OAAO;EACR,OAAO,EAAE,QAAQ;EACjB,KAAK,EAAE,QAAQ,CAAC,KAAK;EACrB,CAAC,CACF,CACA,UAAU;CACZ,CAAC;;;;;AA4CF,MAAa,iBAAiB,EAAE,OAAO;CACtC,MAAM,EAAE,KAAK,CAAC,QAAQ,cAAc,CAAC,CAAC,QAAQ,OAAO;CACrD,iBAAiB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAC/C,iBAAiB,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU;CACtD,CAAC;;;;;AA6FF,MAAa,eAAe,EAAE,OAAO;CACpC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,cAAc;CACzC,aAAa,EAAE,QAAQ,CAAC,QAAQ,wBAAwB;CACxD,eAAe,EAAE,QAAQ,CAAC,UAAU;CACpC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,sBAAsB,aAAa,CAAC;CACzE,UAAU,eAAe,UAAU;CACnC,CAAC;;;;;;;;;;;;;;;;;;;;;AC3QF,SAAgB,aAAa,OAA4B;AACxD,QAAO,aAAa,MAAM,MAAM;;;;;;;;;;;;;;AAejC,SAAgB,aAAa,QAAqB,EAAE,EAAU;AAC7D,QAAO,aAAa,MAAM,MAAM"}

package/package.json

@@ -1,48 +1,48 @@
 {
-  "name": "@screenbook/core",
-  "version": "0.0.1",
-  "description": "Core library for Screenbook - screen metadata definitions and validation",
-  "type": "module",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.mts"
-    }
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
-  "files": [
-    "dist"
-  ],
-  "dependencies": {
-    "zod": "^4.0.0"
-  },
-  "devDependencies": {
-    "tsdown": "^0.18.0"
-  },
-  "keywords": [
-    "screenbook",
-    "screen",
-    "catalog",
-    "navigation",
-    "graph"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/wadakatu/screenbook.git",
-    "directory": "packages/core"
-  },
-  "homepage": "https://github.com/wadakatu/screenbook#readme",
-  "bugs": {
-    "url": "https://github.com/wadakatu/screenbook/issues"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "test": "vitest run",
-    "test:watch": "vitest"
-  }
-}
+	"name": "@screenbook/core",
+	"version": "0.1.0",
+	"description": "Core library for Screenbook - screen metadata definitions and validation",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/index.mjs",
+			"require": "./dist/index.cjs",
+			"types": "./dist/index.d.mts"
+		}
+	},
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.mts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsdown",
+		"dev": "tsdown --watch",
+		"test": "vitest run",
+		"test:watch": "vitest"
+	},
+	"dependencies": {
+		"zod": "^4.0.0"
+	},
+	"devDependencies": {
+		"tsdown": "catalog:"
+	},
+	"keywords": [
+		"screenbook",
+		"screen",
+		"catalog",
+		"navigation",
+		"graph"
+	],
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/wadakatu/screenbook.git",
+		"directory": "packages/core"
+	},
+	"homepage": "https://github.com/wadakatu/screenbook#readme",
+	"bugs": {
+		"url": "https://github.com/wadakatu/screenbook/issues"
+	}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Screenbook Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.