gh-inari 0.3.0 → 0.5.3

package/dist/semantic-template.d.ts

@@ -0,0 +1,107 @@
+import { type CanonicalContract } from "./contract/ir.js";
+import { type TemplateSelector } from "./template-discovery.js";
+export declare const SEMANTIC_TEMPLATE_VERSION: 1;
+export declare const SEMANTIC_TEMPLATE_DIRECTORY: ".github/inari";
+export declare const SEMANTIC_ISSUE_DIRECTORY: ".github/inari/issues";
+export declare const SEMANTIC_PULL_REQUEST_FILE: ".github/inari/pull-request.json";
+export declare const GENERATED_TEMPLATE_NOTICE: "Generated by gh-inari from .github/inari; do not edit.";
+export type SemanticTemplateKind = "issue" | "pull_request";
+export type SemanticInputType = "string" | "enum" | "array" | "checklist";
+export interface SemanticOption {
+    readonly id?: string;
+    readonly value?: string;
+    readonly label: string;
+    readonly description?: string;
+    readonly required?: boolean;
+}
+export interface SemanticSection {
+    readonly id: string;
+    readonly kind: "input" | "documentation";
+    readonly type?: SemanticInputType;
+    readonly label?: string;
+    readonly description?: string;
+    readonly content?: string;
+    readonly required?: boolean;
+    readonly element?: "input" | "textarea" | "dropdown" | "checkboxes";
+    readonly placeholder?: string;
+    readonly defaultValue?: string | readonly string[];
+    readonly render?: string;
+    readonly multiple?: boolean;
+    readonly options?: readonly SemanticOption[];
+    readonly minLength?: number;
+    readonly maxLength?: number;
+    readonly pattern?: string;
+    readonly minItems?: number;
+    readonly maxItems?: number;
+    readonly headingLevel?: number;
+}
+export interface SemanticTemplateSource {
+    readonly version: typeof SEMANTIC_TEMPLATE_VERSION;
+    readonly kind: SemanticTemplateKind;
+    readonly id: string;
+    readonly name: string;
+    readonly description?: string;
+    readonly title?: string;
+    readonly labels?: readonly string[];
+    readonly sections: readonly SemanticSection[];
+}
+export interface SemanticTemplateIdentity {
+    readonly id: string;
+    readonly kind: SemanticTemplateKind;
+    readonly name: string;
+    readonly sourcePath: string;
+    readonly generatedPath: string;
+}
+export interface SemanticTemplateDocument extends SemanticTemplateIdentity {
+    readonly source: SemanticTemplateSource;
+}
+export type SemanticTemplateErrorCode = "SEMANTIC_TEMPLATE_INVALID_JSON" | "SEMANTIC_TEMPLATE_INVALID_ROOT" | "SEMANTIC_TEMPLATE_UNKNOWN_PROPERTY" | "SEMANTIC_TEMPLATE_UNSUPPORTED_VERSION" | "SEMANTIC_TEMPLATE_INVALID_VALUE" | "SEMANTIC_TEMPLATE_UNSUPPORTED_FIELD" | "SEMANTIC_TEMPLATE_AMBIGUOUS" | "SEMANTIC_TEMPLATE_DRIFT" | "SEMANTIC_TEMPLATE_SOURCE_ERROR";
+export interface SemanticTemplateViolation {
+    readonly code: SemanticTemplateErrorCode;
+    readonly path: string;
+    readonly message: string;
+}
+export declare class SemanticTemplateError extends Error {
+    readonly code: SemanticTemplateErrorCode;
+    readonly path: string;
+    readonly violations: readonly SemanticTemplateViolation[];
+    constructor(violations: readonly SemanticTemplateViolation[], options?: ErrorOptions);
+    toJSON(): {
+        code: SemanticTemplateErrorCode;
+        path: string;
+        message: string;
+        violations: readonly SemanticTemplateViolation[];
+    };
+}
+export interface SemanticTemplateSyncResult {
+    readonly check: boolean;
+    readonly changed: boolean;
+    readonly written: readonly string[];
+    readonly drift: readonly string[];
+    readonly staleGenerated: readonly string[];
+    readonly generated: readonly string[];
+}
+/** Find semantic contracts without reading their contents. */
+export declare function discoverSemanticTemplates(repositoryRoot?: string | URL): Promise<readonly SemanticTemplateIdentity[]>;
+/** Synchronous counterpart used by bounded governance and tooling callers. */
+export declare function discoverSemanticTemplatesSync(repositoryRoot?: string | URL): readonly SemanticTemplateIdentity[];
+export declare function readSemanticTemplate(repositoryRoot: string | URL, identity: SemanticTemplateIdentity): Promise<SemanticTemplateDocument>;
+export declare function readSemanticTemplateSync(repositoryRoot: string | URL, identity: SemanticTemplateIdentity): SemanticTemplateDocument;
+export declare function parseSemanticTemplate(serialized: string, sourcePath?: string): SemanticTemplateSource;
+export declare function normalizeSemanticTemplate(value: unknown, sourcePath?: string): SemanticTemplateSource;
+export declare function compileSemanticTemplate(repositoryRoot: string | URL, document: SemanticTemplateDocument): Promise<CanonicalContract>;
+export declare function compileSemanticTemplateSync(repositoryRoot: string | URL, document: SemanticTemplateDocument): CanonicalContract;
+/** Compile an already trusted semantic source without consulting the filesystem. */
+export declare function compileSemanticTemplateSource(source: SemanticTemplateSource, generatedPath: string): CanonicalContract;
+/** Render one semantic contract to the committed native GitHub projection. */
+export declare function renderSemanticNative(source: SemanticTemplateSource, generatedPath: string): string;
+export declare function renderSemanticCompactSchema(contract: unknown): unknown;
+export declare function syncSemanticTemplates(repositoryRoot?: string | URL, check?: boolean): Promise<SemanticTemplateSyncResult>;
+export declare function importNativeTemplate(repositoryRoot: string | URL, nativePath: string, destinationPath?: string): Promise<{
+    readonly path: string;
+    readonly source: SemanticTemplateSource;
+    readonly warning?: string;
+}>;
+export declare function semanticSourceFromContract(contractInput: unknown): SemanticTemplateSource;
+export declare function selectSemanticTemplate(identities: readonly SemanticTemplateIdentity[], kind: SemanticTemplateKind, selector?: string | TemplateSelector): SemanticTemplateIdentity;
+export declare function semanticTemplateGeneratedPath(kind: SemanticTemplateKind, id: string): string;