@abco20/btxml-checker 0.1.0

package/dist/index-CZlTfNCD.d.ts

@@ -0,0 +1,47 @@
+import { D as Diagnostic } from './diagnostic-B5htzyJ9.js';
+import { B as BtDocument } from './ast-BbfR3S_b.js';
+
+type ParseOptions = {
+    readonly uri?: string;
+    readonly path?: string;
+    readonly kind?: "bt-xml" | "model-xml" | "unknown";
+    readonly mode?: "strict" | "tolerant";
+};
+type ParseResult = {
+    readonly ok: true;
+    readonly document: BtDocument;
+    readonly diagnostics: Diagnostic[];
+    readonly partial: false;
+} | {
+    readonly ok: false;
+    readonly document?: BtDocument;
+    readonly diagnostics: Diagnostic[];
+    readonly partial: boolean;
+};
+type FormatOptions = {
+    readonly indentWidth?: number;
+    readonly xmlDeclaration?: "always" | "never" | "preserve";
+    readonly blankLineBetweenBehaviorTrees?: boolean;
+    readonly lineEnding?: "lf" | "crlf" | "auto";
+    readonly force?: boolean;
+};
+type FormatResult = {
+    readonly ok: true;
+    readonly text: string;
+    readonly changed: boolean;
+    readonly skipped: false;
+    readonly diagnostics: Diagnostic[];
+} | {
+    readonly ok: true;
+    readonly skipped: true;
+    readonly diagnostics: Diagnostic[];
+} | {
+    readonly ok: false;
+    readonly text?: string;
+    readonly skipped: false;
+    readonly diagnostics: Diagnostic[];
+};
+
+declare function formatBtXml(text: string, options?: FormatOptions): FormatResult;
+
+export { type FormatOptions as F, type ParseOptions as P, type ParseResult as a, type FormatResult as b, formatBtXml as f };

package/dist/index.d.ts

@@ -0,0 +1,327 @@
+export { f as formatBtXml } from './index-CZlTfNCD.js';
+import { E as EffectiveFileConfig, R as ResolvedBtxmlConfig } from './types-BgqDzlJ8.js';
+import { D as Diagnostic } from './diagnostic-B5htzyJ9.js';
+import { M as ModelAugmentationFile, W as WorkspaceInput } from './types-BaOc_AYN.js';
+export { c as createInitConfig, g as getEffectiveConfigForFile, a as getEffectiveConfigForUri, n as normalizeBtxmlConfig, p as parseBtxmlConfig } from './effective-t_u6qJ-7.js';
+import { z } from 'zod';
+import './ast-BbfR3S_b.js';
+import './public-types-B2noBQY9.js';
+
+type ValidateOptions = {
+    config: EffectiveFileConfig;
+    augmentations?: readonly ModelAugmentationFile[];
+    uri?: string;
+    path?: string;
+};
+type ValidateResult = {
+    ok: boolean;
+    diagnostics: Diagnostic[];
+};
+
+declare function validateBtXml(text: string, options: ValidateOptions): ValidateResult;
+
+type CheckOptions = {
+    readonly config: EffectiveFileConfig;
+    readonly uri?: string;
+    readonly path?: string;
+    /**
+     * Whether to check formatting.
+     * Default: true.
+     */
+    readonly format?: boolean;
+};
+type CheckResult = {
+    readonly ok: true;
+    readonly diagnostics: readonly Diagnostic[];
+    readonly formattedText?: string;
+    readonly needsFormat: false;
+    readonly skipped: boolean;
+} | {
+    readonly ok: false;
+    readonly diagnostics: readonly Diagnostic[];
+    readonly formattedText?: string;
+    readonly needsFormat: boolean;
+    readonly skipped: boolean;
+};
+declare function checkBtXml(text: string, options: CheckOptions): CheckResult;
+
+type WorkspaceCheckInput = {
+    inputs: WorkspaceInput[];
+    config: ResolvedBtxmlConfig;
+};
+type WorkspaceCheckResult = {
+    ok: boolean;
+    files: Array<{
+        uri: string;
+        path?: string;
+        diagnostics: Diagnostic[];
+        skipped?: boolean;
+        skipReason?: string;
+        formatted?: boolean;
+    }>;
+    projectDiagnostics: Diagnostic[];
+    summary: {
+        files: number;
+        errors: number;
+        warnings: number;
+        infos: number;
+        formatErrors?: number;
+    };
+};
+
+declare function checkBtWorkspace(input: WorkspaceCheckInput): Promise<WorkspaceCheckResult>;
+
+declare const jsonCheckReportSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    version: z.ZodLiteral<2>;
+    schemaVersion: z.ZodLiteral<"2">;
+    toolVersion: z.ZodString;
+    project: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    projectDiagnostics: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        rule: z.ZodOptional<z.ZodString>;
+        severity: z.ZodEnum<{
+            error: "error";
+            warning: "warning";
+            info: "info";
+        }>;
+        message: z.ZodString;
+        uri: z.ZodString;
+        range: z.ZodOptional<z.ZodObject<{
+            start: z.ZodObject<{
+                line: z.ZodNumber;
+                character: z.ZodNumber;
+                offset: z.ZodNumber;
+            }, z.core.$strict>;
+            end: z.ZodObject<{
+                line: z.ZodNumber;
+                character: z.ZodNumber;
+                offset: z.ZodNumber;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+        relatedInformation: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            uri: z.ZodString;
+            range: z.ZodObject<{
+                start: z.ZodObject<{
+                    line: z.ZodNumber;
+                    character: z.ZodNumber;
+                    offset: z.ZodNumber;
+                }, z.core.$strict>;
+                end: z.ZodObject<{
+                    line: z.ZodNumber;
+                    character: z.ZodNumber;
+                    offset: z.ZodNumber;
+                }, z.core.$strict>;
+            }, z.core.$strict>;
+            message: z.ZodString;
+        }, z.core.$strict>>>;
+        suppressed: z.ZodOptional<z.ZodBoolean>;
+        details: z.ZodOptional<z.ZodObject<{
+            primaryLabel: z.ZodOptional<z.ZodString>;
+            help: z.ZodOptional<z.ZodString>;
+            notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>>;
+        data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strict>>;
+    files: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        diagnostics: z.ZodArray<z.ZodObject<{
+            code: z.ZodString;
+            rule: z.ZodOptional<z.ZodString>;
+            severity: z.ZodEnum<{
+                error: "error";
+                warning: "warning";
+                info: "info";
+            }>;
+            message: z.ZodString;
+            uri: z.ZodString;
+            range: z.ZodOptional<z.ZodObject<{
+                start: z.ZodObject<{
+                    line: z.ZodNumber;
+                    character: z.ZodNumber;
+                    offset: z.ZodNumber;
+                }, z.core.$strict>;
+                end: z.ZodObject<{
+                    line: z.ZodNumber;
+                    character: z.ZodNumber;
+                    offset: z.ZodNumber;
+                }, z.core.$strict>;
+            }, z.core.$strict>>;
+            relatedInformation: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                uri: z.ZodString;
+                range: z.ZodObject<{
+                    start: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                    end: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                }, z.core.$strict>;
+                message: z.ZodString;
+            }, z.core.$strict>>>;
+            suppressed: z.ZodOptional<z.ZodBoolean>;
+            details: z.ZodOptional<z.ZodObject<{
+                primaryLabel: z.ZodOptional<z.ZodString>;
+                help: z.ZodOptional<z.ZodString>;
+                notes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strict>>;
+            data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strict>>;
+        needsFormat: z.ZodOptional<z.ZodBoolean>;
+        skipped: z.ZodOptional<z.ZodBoolean>;
+        skipReason: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    summary: z.ZodObject<{
+        files: z.ZodNumber;
+        errors: z.ZodNumber;
+        warnings: z.ZodNumber;
+        infos: z.ZodNumber;
+        suppressed: z.ZodNumber;
+        baselineFiltered: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+declare const jsonRepairReportSchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    version: z.ZodLiteral<2>;
+    schemaVersion: z.ZodLiteral<"2">;
+    toolVersion: z.ZodString;
+    groups: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        kind: z.ZodEnum<{
+            "model-signature-conflict": "model-signature-conflict";
+            "duplicate-model-id": "duplicate-model-id";
+            "duplicate-port-name": "duplicate-port-name";
+        }>;
+        nodeId: z.ZodString;
+        portName: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodString;
+        codes: z.ZodArray<z.ZodString>;
+        severity: z.ZodEnum<{
+            error: "error";
+            warning: "warning";
+        }>;
+        pairwiseConflictCount: z.ZodNumber;
+        definitions: z.ZodArray<z.ZodObject<{
+            definitionId: z.ZodString;
+            uri: z.ZodOptional<z.ZodString>;
+            range: z.ZodOptional<z.ZodObject<{
+                start: z.ZodObject<{
+                    line: z.ZodNumber;
+                    character: z.ZodNumber;
+                    offset: z.ZodNumber;
+                }, z.core.$strict>;
+                end: z.ZodObject<{
+                    line: z.ZodNumber;
+                    character: z.ZodNumber;
+                    offset: z.ZodNumber;
+                }, z.core.$strict>;
+            }, z.core.$strict>>;
+            sourceKind: z.ZodString;
+            kind: z.ZodString;
+            signatureId: z.ZodString;
+            signatureText: z.ZodString;
+        }, z.core.$strict>>;
+        signatures: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            signatureKey: z.ZodString;
+            signatureText: z.ZodString;
+            definitions: z.ZodArray<z.ZodObject<{
+                definitionId: z.ZodString;
+                uri: z.ZodOptional<z.ZodString>;
+                range: z.ZodOptional<z.ZodObject<{
+                    start: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                    end: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
+            editableDefinitions: z.ZodArray<z.ZodObject<{
+                definitionId: z.ZodString;
+                uri: z.ZodOptional<z.ZodString>;
+                range: z.ZodOptional<z.ZodObject<{
+                    start: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                    end: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
+            nonEditableDefinitions: z.ZodArray<z.ZodObject<{
+                definitionId: z.ZodString;
+                uri: z.ZodOptional<z.ZodString>;
+                range: z.ZodOptional<z.ZodObject<{
+                    start: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                    end: z.ZodObject<{
+                        line: z.ZodNumber;
+                        character: z.ZodNumber;
+                        offset: z.ZodNumber;
+                    }, z.core.$strict>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        differences: z.ZodArray<z.ZodUnknown>;
+        usageEvidence: z.ZodObject<{
+            nodeId: z.ZodString;
+            totalUsages: z.ZodNumber;
+            byPort: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$strict>;
+        usageImpacts: z.ZodArray<z.ZodUnknown>;
+        differencePattern: z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strict>;
+        actions: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+            description: z.ZodString;
+            kind: z.ZodEnum<{
+                "match-signature": "match-signature";
+                "keep-model-definition": "keep-model-definition";
+                "keep-port-definition": "keep-port-definition";
+                manual: "manual";
+                skip: "skip";
+            }>;
+            applicable: z.ZodBoolean;
+            targetSignatureId: z.ZodOptional<z.ZodString>;
+            editSummary: z.ZodObject<{
+                files: z.ZodNumber;
+                definitions: z.ZodNumber;
+                edits: z.ZodNumber;
+                affectedUris: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>;
+            workspaceEdits: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+            usageImpact: z.ZodOptional<z.ZodUnknown>;
+            warnings: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    summary: z.ZodObject<{
+        groups: z.ZodNumber;
+        signatureConflictGroups: z.ZodNumber;
+        duplicateModelGroups: z.ZodNumber;
+        duplicatePortGroups: z.ZodNumber;
+        pairwiseSignatureConflicts: z.ZodNumber;
+        errors: z.ZodNumber;
+        warnings: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+
+export { type CheckResult, type WorkspaceCheckResult, checkBtWorkspace, checkBtXml, jsonCheckReportSchema, jsonRepairReportSchema, validateBtXml };