@drincs/pixi-vn-ink 1.1.2 → 1.1.3

package/dist/parser.d.cts

@@ -1,5 +1,6 @@
-import { C as CompileSharedType, I as IssueType, a as InkHashtagCommandInfo, H as HashtagCommandOccurrence, D as DivertOccurrence } from './types-B7f5EzP5.cjs';
-export { b as InkValidationInfo } from './types-B7f5EzP5.cjs';
+import { C as CompileSharedType, I as IssueType, a as InkHashtagCommandInfo, H as HashtagCommandOccurrence, D as DivertOccurrence, S as SchemaValidationIssue } from './types-C31N1m1a.cjs';
+export { b as InkValidationInfo } from './types-C31N1m1a.cjs';
+import { ValidateFunction } from 'ajv';
 import 'inkjs/engine/Error';
 
 declare namespace InkCompiler {
@@ -44,6 +45,38 @@ declare namespace InkCompiler {
      *                    target is reported only once.
      */
     function getUnknownDivertTargets(source: string, knownLabels: readonly string[]): DivertOccurrence[];
+    /**
+     * Compiles a JSON Schema object into a reusable Ajv validator. Fetching the schema (from a
+     * URL, a bundled file, ...) and caching the result across calls is entirely up to the caller
+     * (e.g. `vitePluginInk` fetches by the document's own `$schema` URL and caches per URL; a VS
+     * Code extension might instead cache to disk or bundle a schema offline) — this function only
+     * ever compiles the schema object it's given.
+     *
+     * @param schema JSON Schema object to compile.
+     * @returns A compiled Ajv validator, reusable across many {@link validateAgainstJsonSchema} calls.
+     */
+    function getSchemaValidator(schema: object): ValidateFunction;
+    /**
+     * Validates a document against a JSON Schema, returning any mismatch as a structured
+     * {@link SchemaValidationIssue} — never throws on a validation mismatch, so a schema drift
+     * never has to block a caller's build/compile step. Mismatches on an exported `PixiVNJson`
+     * payload are expected to mostly land inside `operations` (e.g. a custom hashtag-command
+     * handler returning a slightly malformed operation), so each issue includes the nearest
+     * `$origin` — the original `# ...` ink source line — when one can be traced, to make it
+     * findable.
+     *
+     * Returns plain data rather than logging/warning itself: it's up to the caller (a Vite plugin,
+     * a VS Code extension, ...) to decide how each issue is surfaced (console warning, editor
+     * diagnostic with a squiggly under `element`, ...).
+     *
+     * @param data   The document to validate.
+     * @param schema Either a JSON Schema object (compiled on the fly via
+     *               {@link getSchemaValidator}) or an already-compiled validator — pass a
+     *               precompiled one when validating many documents against the same schema to
+     *               avoid recompiling every time.
+     * @returns Array of {@link SchemaValidationIssue}, empty when the document is valid.
+     */
+    function validateAgainstJsonSchema(data: unknown, schema: object | ValidateFunction): SchemaValidationIssue[];
 }
 
-export { DivertOccurrence, HashtagCommandOccurrence, InkCompiler, InkHashtagCommandInfo };
+export { DivertOccurrence, HashtagCommandOccurrence, InkCompiler, InkHashtagCommandInfo, SchemaValidationIssue };

package/dist/parser.d.ts

@@ -1,5 +1,6 @@
-import { C as CompileSharedType, I as IssueType, a as InkHashtagCommandInfo, H as HashtagCommandOccurrence, D as DivertOccurrence } from './types-B7f5EzP5.js';
-export { b as InkValidationInfo } from './types-B7f5EzP5.js';
+import { C as CompileSharedType, I as IssueType, a as InkHashtagCommandInfo, H as HashtagCommandOccurrence, D as DivertOccurrence, S as SchemaValidationIssue } from './types-C31N1m1a.js';
+export { b as InkValidationInfo } from './types-C31N1m1a.js';
+import { ValidateFunction } from 'ajv';
 import 'inkjs/engine/Error';
 
 declare namespace InkCompiler {
@@ -44,6 +45,38 @@ declare namespace InkCompiler {
      *                    target is reported only once.
      */
     function getUnknownDivertTargets(source: string, knownLabels: readonly string[]): DivertOccurrence[];
+    /**
+     * Compiles a JSON Schema object into a reusable Ajv validator. Fetching the schema (from a
+     * URL, a bundled file, ...) and caching the result across calls is entirely up to the caller
+     * (e.g. `vitePluginInk` fetches by the document's own `$schema` URL and caches per URL; a VS
+     * Code extension might instead cache to disk or bundle a schema offline) — this function only
+     * ever compiles the schema object it's given.
+     *
+     * @param schema JSON Schema object to compile.
+     * @returns A compiled Ajv validator, reusable across many {@link validateAgainstJsonSchema} calls.
+     */
+    function getSchemaValidator(schema: object): ValidateFunction;
+    /**
+     * Validates a document against a JSON Schema, returning any mismatch as a structured
+     * {@link SchemaValidationIssue} — never throws on a validation mismatch, so a schema drift
+     * never has to block a caller's build/compile step. Mismatches on an exported `PixiVNJson`
+     * payload are expected to mostly land inside `operations` (e.g. a custom hashtag-command
+     * handler returning a slightly malformed operation), so each issue includes the nearest
+     * `$origin` — the original `# ...` ink source line — when one can be traced, to make it
+     * findable.
+     *
+     * Returns plain data rather than logging/warning itself: it's up to the caller (a Vite plugin,
+     * a VS Code extension, ...) to decide how each issue is surfaced (console warning, editor
+     * diagnostic with a squiggly under `element`, ...).
+     *
+     * @param data   The document to validate.
+     * @param schema Either a JSON Schema object (compiled on the fly via
+     *               {@link getSchemaValidator}) or an already-compiled validator — pass a
+     *               precompiled one when validating many documents against the same schema to
+     *               avoid recompiling every time.
+     * @returns Array of {@link SchemaValidationIssue}, empty when the document is valid.
+     */
+    function validateAgainstJsonSchema(data: unknown, schema: object | ValidateFunction): SchemaValidationIssue[];
 }
 
-export { DivertOccurrence, HashtagCommandOccurrence, InkCompiler, InkHashtagCommandInfo };
+export { DivertOccurrence, HashtagCommandOccurrence, InkCompiler, InkHashtagCommandInfo, SchemaValidationIssue };