@canonical/webarchitect 0.10.0 → 0.11.0

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC"}

package/dist/types/lib/ajv.d.ts

@@ -1,4 +0,0 @@
-import ajvPackage from "ajv";
-declare const ajv: ajvPackage.Ajv;
-export default ajv;
-//# sourceMappingURL=ajv.d.ts.map

package/dist/types/lib/ajv.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ajv.d.ts","sourceRoot":"","sources":["../../../src/lib/ajv.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,KAAK,CAAC;AAqB7B,QAAA,MAAM,GAAG,gBAIP,CAAC;AAwDH,eAAe,GAAG,CAAC"}

package/dist/types/lib/describeSchema.d.ts

@@ -1,22 +0,0 @@
-import type { JSONSchema7 } from "json-schema";
-/**
- * Generates a human-readable description of what a JSON schema validates.
- * Summarizes key constraints like type, required properties, patterns, etc.
- * Used to provide clear feedback about what validation rules are being applied.
- *
- * @param schema - JSON Schema to describe
- * @returns Human-readable description of the schema's validation rules
- *
- * @example
- * ```typescript
- * const schema = {
- *   type: "object",
- *   required: ["name", "version"],
- *   properties: { name: {}, version: {} }
- * };
- * const desc = describeSchema(schema);
- * // Returns: "must be object, must have properties: name, version, expected properties: name, version"
- * ```
- */
-export default function describeSchema(schema: JSONSchema7): string;
-//# sourceMappingURL=describeSchema.d.ts.map

package/dist/types/lib/describeSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"describeSchema.d.ts","sourceRoot":"","sources":["../../../src/lib/describeSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAqClE"}

package/dist/types/lib/discoverAllRulesets.d.ts

@@ -1,9 +0,0 @@
-import type { RulesetLocation } from "../types.js";
-/**
- * Discovers all available rulesets (bundled and local)
- */
-export default function discoverAllRulesets(): Promise<{
-    bundled: RulesetLocation[];
-    local: RulesetLocation[];
-}>;
-//# sourceMappingURL=discoverAllRulesets.d.ts.map

package/dist/types/lib/discoverAllRulesets.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"discoverAllRulesets.d.ts","sourceRoot":"","sources":["../../../src/lib/discoverAllRulesets.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnD;;GAEG;AACH,wBAA8B,mBAAmB,IAAI,OAAO,CAAC;IAC3D,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,KAAK,EAAE,eAAe,EAAE,CAAC;CAC1B,CAAC,CAOD"}

package/dist/types/lib/discoverRulesetsInDir.d.ts

@@ -1,6 +0,0 @@
-import type { RulesetLocation } from "../types.js";
-/**
- * Discovers .ruleset.json files in a directory
- */
-export default function discoverRulesetsInDir(dir: string, type: "bundled" | "local"): Promise<RulesetLocation[]>;
-//# sourceMappingURL=discoverRulesetsInDir.d.ts.map

package/dist/types/lib/discoverRulesetsInDir.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"discoverRulesetsInDir.d.ts","sourceRoot":"","sources":["../../../src/lib/discoverRulesetsInDir.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;GAEG;AACH,wBAA8B,qBAAqB,CACjD,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,SAAS,GAAG,OAAO,GACxB,OAAO,CAAC,eAAe,EAAE,CAAC,CA8B5B"}

package/dist/types/lib/executeValidationRules.d.ts

@@ -1,22 +0,0 @@
-import type { Schema, ValidationResult } from "../types.js";
-/**
- * Executes all validation rules defined in a schema against a project.
- * Iterates through each rule in the schema and delegates to validateRule.
- *
- * @param projectPath - Absolute or relative path to the project directory to validate
- * @param schema - Schema object containing validation rules to execute
- * @returns Promise that resolves to an array of validation results
- *
- * @example
- * ```typescript
- * const schema = {
- *   name: "my-schema",
- *   "package-config": {
- *     file: { name: "package.json", contains: {...} }
- *   }
- * };
- * const results = await executeValidationRules("/path/to/project", schema);
- * ```
- */
-export default function executeValidationRules(projectPath: string, schema: Schema): Promise<ValidationResult[]>;
-//# sourceMappingURL=executeValidationRules.d.ts.map

package/dist/types/lib/executeValidationRules.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"executeValidationRules.d.ts","sourceRoot":"","sources":["../../../src/lib/executeValidationRules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAQ,MAAM,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGlE;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAA8B,sBAAsB,CAClD,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA4B7B"}

package/dist/types/lib/index.d.ts

@@ -1,15 +0,0 @@
-/**
- * Internal library modules - re-exported as named exports
- */
-export { default as ajv } from "./ajv.js";
-export { default as describeSchema } from "./describeSchema.js";
-export { default as discoverAllRulesets } from "./discoverAllRulesets.js";
-export { default as discoverRulesetsInDir } from "./discoverRulesetsInDir.js";
-export { default as executeValidationRules } from "./executeValidationRules.js";
-export { default as listDirectory } from "./listDirectory.js";
-export { default as loadFullSchema } from "./loadFullSchema.js";
-export { default as resolveSchema } from "./resolveSchema.js";
-export { default as validateDirectoryRule } from "./validateDirectoryRule.js";
-export { default as validateFileRule } from "./validateFileRule.js";
-export { default as validateRule } from "./validateRule.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAChF,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/types/lib/listDirectory.d.ts

@@ -1,20 +0,0 @@
-/**
- * Lists the contents of a directory, separating files and subdirectories.
- * Used for strict mode validation to detect unexpected files or directories.
- *
- * @param path - Path to the directory to list
- * @returns Promise that resolves to an object containing arrays of file and directory names
- * @throws Will throw an error if the directory cannot be read
- *
- * @example
- * ```typescript
- * const contents = await listDirectory("/path/to/project");
- * console.log(contents.files);       // ["package.json", "README.md"]
- * console.log(contents.directories); // ["src", "dist", "node_modules"]
- * ```
- */
-export default function listDirectory(path: string): Promise<{
-    files: string[];
-    directories: string[];
-}>;
-//# sourceMappingURL=listDirectory.d.ts.map

package/dist/types/lib/listDirectory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"listDirectory.d.ts","sourceRoot":"","sources":["../../../src/lib/listDirectory.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,wBAA8B,aAAa,CACzC,IAAI,EAAE,MAAM,GACX,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CASrD"}

package/dist/types/lib/loadFullSchema.d.ts

@@ -1,20 +0,0 @@
-import type { Schema } from "../types.js";
-/**
- * Loads a schema and recursively resolves all extended schemas.
- * Merges rules from parent schemas with child schemas, where child
- * rules override parent rules with the same name. Special properties
- * like $schema and name are preserved from the child schema.
- *
- * @param schemaArg - Schema identifier (built-in name, file path, or URL)
- * @returns Promise that resolves to the fully merged schema with all extensions resolved
- * @throws Will throw an error if any schema in the inheritance chain cannot be loaded
- *
- * @example
- * ```typescript
- * // Load a schema that extends other schemas
- * const schema = await loadFullSchema("package-react");
- * // Returns merged schema with rules from base, base-package, and package-react
- * ```
- */
-export default function loadFullSchema(schemaArg: string): Promise<Schema>;
-//# sourceMappingURL=loadFullSchema.d.ts.map

package/dist/types/lib/loadFullSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"loadFullSchema.d.ts","sourceRoot":"","sources":["../../../src/lib/loadFullSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C;;;;;;;;;;;;;;;;GAgBG;AACH,wBAA8B,cAAc,CAC1C,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAYjB"}

package/dist/types/lib/resolveSchema.d.ts

@@ -1,29 +0,0 @@
-import type { Schema } from "../types.js";
-/**
- * Resolves a schema identifier to a loaded and validated schema object.
- * Supports three resolution methods:
- * 1. Remote URLs (http:// or https://) - fetches schema from the web
- * 2. Local files - looks for .json files in current directory
- * 3. Built-in rulesets - checks bundled rulesets directory
- *
- * The loaded schema is validated against the mother schema to ensure
- * it conforms to the expected structure.
- *
- * @param schemaArg - Schema identifier: URL, file path, or built-in name
- * @returns Promise that resolves to the validated schema object
- * @throws Will throw an error if schema cannot be found or is invalid
- *
- * @example
- * ```typescript
- * // Load built-in ruleset
- * const schema1 = await resolveSchema("base-package");
- *
- * // Load from local file
- * const schema2 = await resolveSchema("./my-rules.json");
- *
- * // Load from URL
- * const schema3 = await resolveSchema("https://example.com/schema.json");
- * ```
- */
-export default function resolveSchema(schemaArg: string): Promise<Schema>;
-//# sourceMappingURL=resolveSchema.d.ts.map

package/dist/types/lib/resolveSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"resolveSchema.d.ts","sourceRoot":"","sources":["../../../src/lib/resolveSchema.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAkD1C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAA8B,aAAa,CACzC,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CA4CjB"}

package/dist/types/lib/validateDirectoryRule.d.ts

@@ -1,26 +0,0 @@
-import type { DirectoryRule, ValidationResult } from "../types.js";
-/**
- * Validates a directory against a directory rule specification.
- * Checks that the directory exists and validates its contents recursively.
- * In strict mode, also ensures no unexpected files or directories are present.
- *
- * @param projectPath - Base path where the directory should exist
- * @param dirRule - Directory rule specification including name and expected contents
- * @param ruleName - Name of the rule for error reporting (e.g., "src-structure")
- * @returns Promise that resolves to an array of validation results
- *
- * @example
- * ```typescript
- * const rule = {
- *   name: "src",
- *   contains: {
- *     files: [{ name: "index.ts", contains: {...} }],
- *     directories: [{ name: "components", contains: {...} }]
- *   },
- *   strict: true
- * };
- * const results = await validateDirectoryRule("/project", rule, "source-structure");
- * ```
- */
-export default function validateDirectoryRule(projectPath: string, dirRule: DirectoryRule, ruleName: string): Promise<ValidationResult[]>;
-//# sourceMappingURL=validateDirectoryRule.d.ts.map

package/dist/types/lib/validateDirectoryRule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateDirectoryRule.d.ts","sourceRoot":"","sources":["../../../src/lib/validateDirectoryRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAInE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAA8B,qBAAqB,CACjD,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA4H7B"}

package/dist/types/lib/validateFileRule.d.ts

@@ -1,29 +0,0 @@
-import type { FileRule, ValidationResult } from "../types.js";
-/**
- * Validates a file against a file rule specification.
- * Reads the file, parses it as JSON, and validates against the provided schema.
- * Provides detailed error messages for missing files, invalid JSON, or schema violations.
- *
- * @param projectPath - Base path where the file should exist
- * @param fileRule - File rule specification including name and JSON schema
- * @param ruleName - Name of the rule for error reporting (e.g., "package-config")
- * @returns Promise that resolves to an array with a single validation result
- *
- * @example
- * ```typescript
- * const rule = {
- *   name: "package.json",
- *   contains: {
- *     type: "object",
- *     properties: {
- *       name: { type: "string" },
- *       version: { type: "string" }
- *     },
- *     required: ["name", "version"]
- *   }
- * };
- * const results = await validateFileRule("/project", rule, "package-config");
- * ```
- */
-export default function validateFileRule(projectPath: string, fileRule: FileRule, ruleName: string): Promise<ValidationResult[]>;
-//# sourceMappingURL=validateFileRule.d.ts.map

package/dist/types/lib/validateFileRule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateFileRule.d.ts","sourceRoot":"","sources":["../../../src/lib/validateFileRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAI9D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAA8B,gBAAgB,CAC5C,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAoE7B"}

package/dist/types/lib/validateRule.d.ts

@@ -1,21 +0,0 @@
-import type { Rule, ValidationResult } from "../types.js";
-/**
- * Validates a rule against a project path.
- * Determines whether the rule is a file or directory rule and delegates
- * to the appropriate validation logic.
- *
- * @param projectPath - Absolute or relative path to the project directory to validate
- * @param rule - Rule object containing either file or directory validation specification
- * @param ruleName - Name of the rule for error reporting
- * @returns Promise that resolves to an array of validation results
- *
- * @example
- * ```typescript
- * const rule = {
- *   file: { name: "package.json", contains: {...} }
- * };
- * const results = await validateRule("/path/to/project", rule, "package-config");
- * ```
- */
-export default function validateRule(projectPath: string, rule: Rule, ruleName: string): Promise<ValidationResult[]>;
-//# sourceMappingURL=validateRule.d.ts.map

package/dist/types/lib/validateRule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validateRule.d.ts","sourceRoot":"","sources":["../../../src/lib/validateRule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAI1D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAA8B,YAAY,CACxC,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAY7B"}

package/dist/types/types.d.ts

@@ -1,42 +0,0 @@
-import type { JSONSchema7 } from "json-schema";
-export interface FileRule {
-    name: string;
-    contains: JSONSchema7;
-}
-export interface DirectoryRule {
-    name: string;
-    contains?: {
-        files?: FileRule[];
-        directories?: DirectoryRule[];
-    };
-    strict?: boolean;
-}
-export type Rule = {
-    file: FileRule;
-} | {
-    directory: DirectoryRule;
-};
-export interface Schema {
-    $schema?: string;
-    name: string;
-    extends?: string[];
-    [ruleName: string]: Rule | string | string[] | undefined;
-}
-export interface ValidationResult {
-    rule: string;
-    passed: boolean;
-    message?: string;
-    context?: {
-        type: "file" | "directory";
-        target: string;
-        description?: string;
-        schema?: unknown;
-        value?: unknown;
-    };
-}
-export interface RulesetLocation {
-    type: "bundled" | "local";
-    path: string;
-    name: string;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/C,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,WAAW,CAAC;CACvB;AAGD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE;QAET,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;QACnB,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;KAC/B,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAGD,MAAM,MAAM,IAAI,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,aAAa,CAAA;CAAE,CAAC;AAGrE,MAAM,WAAW,MAAM;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;CAC1D;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/types/validate.d.ts

@@ -1,23 +0,0 @@
-import type { ValidationResult } from "./types.js";
-/**
- * Main validation function that validates a project against a specified ruleset.
- * This is the primary API entry point for the webarchitect validation system.
- * Handles schema loading, inheritance resolution, and rule execution.
- *
- * @param projectPath - Path to the project directory to validate
- * @param schemaArg - Schema identifier: built-in name, file path, or URL
- * @returns Promise that resolves to an array of validation results
- * @throws Will throw an error if schema cannot be loaded or is invalid
- *
- * @example
- * ```typescript
- * // Validate current directory with built-in ruleset
- * const results = await validate(process.cwd(), "base-package");
- *
- * // Check if validation passed
- * const passed = results.every(r => r.passed);
- * console.log(passed ? "All checks passed!" : "Some checks failed");
- * ```
- */
-export default function validate(projectPath: string, schemaArg: string): Promise<ValidationResult[]>;
-//# sourceMappingURL=validate.d.ts.map

package/dist/types/validate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/validate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAA8B,QAAQ,CACpC,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAG7B"}