@xlr-lib/xlr-sdk 0.1.1--canary.9.190

package/types/types.d.ts

@@ -0,0 +1,30 @@
+import type { Node } from "jsonc-parser";
+export interface BaseValidationMessage<ErrorType extends string = string> {
+    /** Validation Type */
+    type: ErrorType;
+    /** Error message text */
+    message: string;
+    /** JSONC node that the error originates from */
+    node: Node;
+    /** Level of the message */
+    severity: ValidationSeverity;
+}
+export interface TypeValidationError extends BaseValidationMessage<"type"> {
+    /** Expected types */
+    expected?: string[] | string | number | boolean;
+}
+export type MissingValidationError = BaseValidationMessage<"missing">;
+export type UnknownValidationError = BaseValidationMessage<"unknown">;
+export interface ValueValidationError extends BaseValidationMessage<"value"> {
+    /** Expected value */
+    expected?: string;
+}
+export type UnexpectedValidationError = BaseValidationMessage<"unexpected">;
+export type ValidationMessage = TypeValidationError | MissingValidationError | UnknownValidationError | ValueValidationError | UnexpectedValidationError;
+export declare enum ValidationSeverity {
+    Error = 1,
+    Warning = 2,
+    Info = 3,
+    Trace = 4
+}
+//# sourceMappingURL=types.d.ts.map

package/types/utils.d.ts

@@ -0,0 +1,13 @@
+import type { NodeTypeStrings, NodeTypeMap, TransformFunction, NodeType } from "@xlr-lib/xlr";
+type TypedTransformFunction<T extends NodeTypeStrings = NodeTypeStrings> = (input: NodeTypeMap[T]) => NodeTypeMap[T];
+export type TransformFunctionMap = {
+    [nodeType in NodeTypeStrings]?: Array<TypedTransformFunction<nodeType>>;
+};
+export declare function xlrTransformWalker(transformMap: TransformFunctionMap): (node: NodeType) => NodeType;
+/**
+ * Helper function for simple transforms
+ * Walks an XLR tree looking for the specified node type calls the supplied function when called
+ */
+export declare function simpleTransformGenerator<T extends NodeTypeStrings = NodeTypeStrings>(typeToTransform: T, capabilityToTransform: string | Array<string>, functionToRun: TypedTransformFunction<T>): TransformFunction;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/types/validator.d.ts

@@ -0,0 +1,27 @@
+import type { Node } from "jsonc-parser";
+import type { NamedType, NodeType, ObjectType, OrType, RefType } from "@xlr-lib/xlr";
+import type { ValidationMessage } from "./types";
+export interface XLRValidatorConfig {
+    /** URL mapping for supplemental documentation */
+    urlMapping?: Record<string, string>;
+}
+/**
+ * Validator for XLRs on JSON Nodes
+ */
+export declare class XLRValidator {
+    private config;
+    private resolveType;
+    private regexCache;
+    constructor(resolveType: (id: string) => NamedType<NodeType> | undefined, config?: XLRValidatorConfig);
+    /** Main entrypoint for validation */
+    validateType(rootNode: Node, xlrNode: NodeType): Array<ValidationMessage>;
+    private generateNestedTypesInfo;
+    private validateTemplate;
+    private validateArray;
+    private validateObject;
+    private validateLiteralType;
+    getRefType(ref: RefType): NodeType;
+    private getRegex;
+    computeIntersectionType(types: Array<NodeType>): ObjectType | OrType;
+}
+//# sourceMappingURL=validator.d.ts.map