@oval-vote/oval 0.1.0 → 0.1.2

package/README.md

@@ -9,7 +9,7 @@ const oval = require("@oval-vote/oval");
 const source = fs.readFileSync("guide.oval", "utf8");
 
 oval.check(source);
-// [{ code: "V14", severity: "warning", range: { start: 120, end: 124 }, message: "..." }]
+// [{ code: "unused-declaration", severity: "warning", range: { start: 120, end: 124 }, message: "..." }]
 
 oval.compile(source);
 // The canonical JSON model described by the specification's guide.schema.json.
@@ -17,9 +17,19 @@ oval.compile(source);
 
 oval.format(source);
 // The formatted source. Throws the diagnostics when the document has syntax errors.
+
+oval.catalog();
+// Every diagnostic the package can report, in the specification's order:
+// [{ identifier: "illegal-tab", severity: "error", title: "Illegal Tab",
+//    url: "https://spec.oval.vote/draft/#sec-Illegal-Tab" }, ...]
+
+oval.languageMajor(); // 1, the major version of the language this package reads
+oval.version(); // the package's own version
 ```
 
-Ranges are byte offsets into the UTF-8 source.
+Ranges are byte offsets into the UTF-8 source. Diagnostic codes are the identifiers of the
+specification's entries, and the typings declare them as a string union, so a `switch` over a
+code is checked by TypeScript.
 
 The language is specified in [oval-vote/oval-spec](https://github.com/oval-vote/oval-spec) and
 implemented in [oval-vote/oval](https://github.com/oval-vote/oval), which also provides the `oval`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oval-vote/oval",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Parse, validate, compile, and format Oval voting guides",
   "license": "MIT",
   "type": "commonjs",

package/pkg/oval_wasm.d.ts

@@ -1,17 +1,109 @@
 /* tslint:disable */
 /* eslint-disable */
 
+export type DiagnosticIdentifier =
+| "illegal-tab"
+| "unexpected-character"
+| "unterminated-string"
+| "invalid-escape"
+| "malformed-number"
+| "malformed-url"
+| "inconsistent-dedent"
+| "unexpected-token"
+| "missing-identifier"
+| "missing-name"
+| "missing-contest-kind"
+| "missing-value"
+| "missing-body"
+| "missing-block"
+| "unexpected-block"
+| "unexpected-entry"
+| "repeated-field"
+| "repeated-flag"
+| "misplaced-entry"
+| "empty-recommendation"
+| "unsupported-version"
+| "missing-guide-field"
+| "empty-document"
+| "invalid-date"
+| "undeclared-reference"
+| "duplicate-declaration"
+| "mismatched-reference"
+| "block-on-reference"
+| "misplaced-candidate-field"
+| "empty-ballot"
+| "empty-section"
+| "contest-without-campaigns"
+| "campaign-without-members"
+| "duplicate-member"
+| "candidate-in-two-campaigns"
+| "invalid-multiple-count"
+| "invalid-ranked-max"
+| "retention-campaign-count"
+| "missing-recommendation"
+| "repeated-recommendation"
+| "campaign-not-in-contest"
+| "repeated-oppose"
+| "repeated-stance"
+| "tiers-in-single"
+| "support-over-max"
+| "retention-stance"
+| "markdown-profile"
+| "unused-declaration"
+| "duplicate-party-name"
+| "duplicate-ballot-title"
+| "support-over-count"
+| "non-head-reference"
+| "unpaired-outcome"
+| "insecure-url";
+
+export type Severity = "error" | "warning";
+
+export interface Diagnostic {
+    code: DiagnosticIdentifier;
+    severity: Severity;
+    range: { start: number; end: number };
+    message: string;
+}
+
+export interface CatalogEntry {
+    identifier: DiagnosticIdentifier;
+    severity: Severity;
+    title: string;
+    url: string;
+}
+
+export type Compiled = Record<string, unknown>;
+
+
+
+/**
+ * Every diagnostic the implementation can report, in the specification's order, with the
+ * address of its entry on the specification's site.
+ */
+export function catalog(): CatalogEntry[];
+
 /**
  * Parses and validates `source`, returning every diagnostic in source order.
  */
-export function check(source: string): any;
+export function check(source: string): Diagnostic[];
 
 /**
  * Compiles `source` to its canonical form, or fails with the diagnostics.
  */
-export function compile(source: string): any;
+export function compile(source: string): Compiled;
 
 /**
  * Formats `source`, or fails with the diagnostics.
  */
 export function format(source: string): string;
+
+/**
+ * The major version of the Oval language this package reads.
+ */
+export function languageMajor(): number;
+
+/**
+ * The version of this package.
+ */
+export function version(): string;

package/pkg/oval_wasm.js

@@ -1,9 +1,23 @@
 /* @ts-self-types="./oval_wasm.d.ts" */
 
+/**
+ * Every diagnostic the implementation can report, in the specification's order, with the
+ * address of its entry on the specification's site.
+ * @returns {CatalogEntry[]}
+ */
+function catalog() {
+    const ret = wasm.catalog();
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+exports.catalog = catalog;
+
 /**
  * Parses and validates `source`, returning every diagnostic in source order.
  * @param {string} source
- * @returns {any}
+ * @returns {Diagnostic[]}
  */
 function check(source) {
     const ptr0 = passStringToWasm0(source, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -19,7 +33,7 @@ exports.check = check;
 /**
  * Compiles `source` to its canonical form, or fails with the diagnostics.
  * @param {string} source
- * @returns {any}
+ * @returns {Compiled}
  */
 function compile(source) {
     const ptr0 = passStringToWasm0(source, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -58,6 +72,34 @@ function format(source) {
     }
 }
 exports.format = format;
+
+/**
+ * The major version of the Oval language this package reads.
+ * @returns {number}
+ */
+function languageMajor() {
+    const ret = wasm.languageMajor();
+    return ret >>> 0;
+}
+exports.languageMajor = languageMajor;
+
+/**
+ * The version of this package.
+ * @returns {string}
+ */
+function version() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const ret = wasm.version();
+        deferred1_0 = ret[0];
+        deferred1_1 = ret[1];
+        return getStringFromWasm0(ret[0], ret[1]);
+    } finally {
+        wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+    }
+}
+exports.version = version;
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,

package/pkg/oval_wasm_bg.wasm.d.ts

@@ -1,12 +1,15 @@
 /* tslint:disable */
 /* eslint-disable */
 export const memory: WebAssembly.Memory;
+export const catalog: () => [number, number, number];
 export const check: (a: number, b: number) => [number, number, number];
 export const compile: (a: number, b: number) => [number, number, number];
 export const format: (a: number, b: number) => [number, number, number, number];
+export const languageMajor: () => number;
+export const version: () => [number, number];
 export const __wbindgen_externrefs: WebAssembly.Table;
+export const __externref_table_dealloc: (a: number) => void;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_free: (a: number, b: number, c: number) => void;
-export const __externref_table_dealloc: (a: number) => void;
 export const __wbindgen_start: () => void;