esbuild + declarations

package-lock.json

@@ -14,7 +14,8 @@
       },
       "devDependencies": {
         "esbuild": "^0.25.2",
-        "folktest": "git+https://git.kitsu.cafe/rowan/folktest.git"
+        "folktest": "git+https://git.kitsu.cafe/rowan/folktest.git",
+        "typescript": "^5.8.3"
       }
     },
     "node_modules/@esbuild/aix-ppc64": {

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "type": "module",
   "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "author": "Rowan <rowan@kitsu.cafe> (https://kitsu.cafe)",
   "scripts": {
     "test": "./tests/index.js",
@@ -13,7 +14,8 @@
   "description": "",
   "devDependencies": {
     "esbuild": "^0.25.2",
-    "folktest": "git+https://git.kitsu.cafe/rowan/folktest.git"
+    "folktest": "git+https://git.kitsu.cafe/rowan/folktest.git",
+    "typescript": "^5.8.3"
   },
   "dependencies": {
     "izuna": "git+https://git.kitsu.cafe/rowan/izuna.git",

src/byte.d.ts

@@ -0,0 +1,16 @@
+/** @import { ParserState } from './state.js' */
+export const char: any;
+export const tag: any;
+export const charNoCase: any;
+export const tagNoCase: any;
+export function anyChar(state: any): any;
+export const take: any;
+export const oneOf: any;
+export const noneOf: any;
+export const digit: any;
+export const lowerAlpha: any;
+export const upperAlpha: any;
+export const alpha: (state: ParserState) => any;
+export const alphanumeric: (state: ParserState) => any;
+export function eof(state: any): any;
+import type { ParserState } from './state.js';

src/clone.d.ts

@@ -0,0 +1,2 @@
+export const Clone: unique symbol;
+export function clone(target: any): any;

src/combinator.d.ts

@@ -0,0 +1,14 @@
+export function seq(...parsers: Parser[]): (
+/** @param {ParserState} state */
+state: ParserState) => any;
+export function any(...parsers: any[]): (
+/**
+ * @param {ParserState} state
+ */
+state: ParserState) => any;
+export const map: any;
+export const delimited: any;
+export const preceded: any;
+export const terminated: any;
+export const separatedPair: any;
+import type { ParserState } from './state.js';

src/cond.d.ts

@@ -0,0 +1,7 @@
+/** @import { Result } from '../vendor/kojima/src/index.js' */
+/** @import { ParserState } from './state.js' */
+export const maybe: any;
+export const not: any;
+export const until: any;
+export const verify: any;
+export const skip: any;

src/const.d.ts

@@ -0,0 +1,5 @@
+export const LowerAlpha: "abcdefghijklmnopqrstuvwxyz";
+export const UpperAlpha: string;
+export const Alpha: string;
+export const Digits: "1234567890";
+export const Alphanumeric: string;

src/fn.d.ts

@@ -0,0 +1,11 @@
+export function iter(value: any): IndexableIterator;
+export function clone(state: ParserState): any;
+export function succeed<T>(v: T | T[], [x, y]: ParserState): any;
+export function fail(msg: string, state: ParserState, e?: Error): any;
+export function nth<T>(n: number & keyof T, iter: T[]): T[][number & keyof T];
+export function next(state: ParserState): any;
+export function diff<T>(a: T[], b: T[]): T[];
+export const join: any;
+export const mapStr: any;
+import { IndexableIterator } from './iter.js';
+import type { ParserState } from './state.js';

src/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./byte.js";
+export * from "./combinator.js";
+export * from "./cond.js";
+export * from "./multi.js";
+export * from "./state.js";

src/iter.d.ts

@@ -0,0 +1,14 @@
+export class IndexableIterator {
+    constructor(value: any, index?: number);
+    _value: any;
+    _index: number;
+    clone(): IndexableIterator;
+    done(): boolean;
+    next(): {
+        value: any;
+        done: boolean;
+    };
+    [Clone](): IndexableIterator;
+    [Symbol.iterator](): IndexableIterator;
+}
+import { Clone } from './clone.js';

src/multi.d.ts

@@ -0,0 +1,7 @@
+/** @import { ParseError, ParserState } from './state.js' */
+/** @import { Result } from '../vendor/kojima/src/index.js' */
+export const takeWhile: any;
+export const takeUntil: any;
+export const skip: any;
+export const many: any;
+export function many1(parser: any): any;

src/state.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @typedef {Readonly<[any[], Iterator<any>]>} ParserState
+ */
+export class ParseError extends Error {
+    /**
+     * @param {string} message
+     * @param {ParserState} state
+     * @param {Error} [cause]
+     */
+    constructor(message: string, state: ParserState, cause?: Error);
+    state: readonly [any[], Iterator<any, any, any>];
+}
+export class State extends Tuple {
+    static from(values: any): State;
+    constructor(remaining: any, read?: any[]);
+    next(): any;
+    [Clone](): Readonly<State>;
+}
+export function state(remaining: any, read: any): State;
+export const parse: any;
+export const parseAll: any;
+export type ParserState = Readonly<[any[], Iterator<any>]>;
+import { Tuple } from './tuple.js';
+import { Clone } from './clone.js';

src/tuple.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @param {...any} values
+ */
+export class Tuple {
+    static from(values: any): Readonly<Tuple>;
+    constructor(values: any);
+    _values: any;
+    _length: any;
+    get length(): any;
+    _setEntry([key, value]: [any, any], index: any): void;
+    toString(): string;
+    clone(): any;
+    [Clone](): any;
+    [Symbol.iterator](): IndexableIterator;
+}
+export function tuple(values: any): Readonly<Tuple>;
+import { Clone } from './clone.js';
+import { IndexableIterator } from './iter.js';

tests/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

tests/units/bytes.d.ts

@@ -0,0 +1 @@
+export const Byte: any[];

tests/units/common.d.ts

@@ -0,0 +1,3 @@
+export const assertState: any;
+export const parseEq: any;
+export const parseErr: any;

tests/units/cond.d.ts

@@ -0,0 +1 @@
+export const Conditionals: any[];

tests/units/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./bytes.js";
+export * from "./iter.js";
+export * from "./cond.js";

tests/units/iter.d.ts

@@ -0,0 +1 @@
+export const Iterator: any[];

tsconfig.json

@@ -0,0 +1,113 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "libReplacement": true,                           /* Enable lib replacement. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "erasableSyntaxOnly": true,                       /* Do not allow runtime constructs that are not part of ECMAScript. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}