@unified-latex/unified-latex-types 1.0.0

package/README.md

@@ -0,0 +1,153 @@
+<!-- DO NOT MODIFY -->
+<!-- This file was autogenerated by build-docs.ts -->
+<!-- Edit the docstring in index.ts and regenerate -->
+<!-- rather than editing this file directly. -->
+# unified-latex-types
+
+## What is this?
+
+Types for the `unified-latex` Abstract Syntax Tree (AST). These types extend the `unist` AST,
+but instead of a `children` attribute, they have a `content` attribute.
+
+## When should I use this?
+
+If you're working with `unified-latex` ASTs.
+
+# Types
+
+## `Ast`
+
+```typescript
+export type Ast = Node | Argument | Node[];
+```
+
+## `EnvInfo`
+
+```typescript
+export type EnvInfo = {
+    renderInfo?: {
+        /**
+         * Whether the body of the environment should be treated as math mode
+         *
+         * @type {boolean}
+         */
+        inMathMode?: boolean;
+        /**
+         * Whether to align the environment contents based on `&` and `\\` delimiters
+         * (like a matrix or tabular environment).
+         *
+         * @type {boolean}
+         */
+        alignContent?: boolean;
+        /**
+         * Whether the arguments should be treated as pgfkeys-type arguments.
+         *
+         * @type {boolean}
+         */
+        pgfkeysArgs?: boolean;
+    };
+    /**
+     * Function to process the body of an environment. The return value of `processContent`
+     * is treated as the new body.
+     *
+     */
+    processContent?: (ast: Ast.Node[]) => Ast.Node[];
+    /**
+     * The environment signature as an xparse argument specification string.
+     *
+     * @type {string}
+     */
+    signature?: string;
+};
+```
+
+## `EnvInfoRecord`
+
+```typescript
+export type EnvInfoRecord = Record<string, EnvInfo>;
+```
+
+## `GenericAst`
+
+```typescript
+export type GenericAst = GenericNode | GenericNode[];
+```
+
+## `MacroInfo`
+
+```typescript
+export type MacroInfo = {
+    renderInfo?: {
+        /**
+         * Whether the macro's contents wraps along with the current
+         * paragraph or displays as it's own block.
+         *
+         * @type {boolean}
+         */
+        inParMode?: boolean;
+        /**
+         * Whether the arguments should be processed as pgfkeys-type arguments.
+         *
+         * @type {boolean}
+         */
+        pgfkeysArgs?: boolean;
+        /**
+         * Whether there should be line breaks before and after the macro
+         * (e.g., like the \section{...} command.)
+         *
+         * @type {boolean}
+         */
+        breakAround?: boolean;
+        /**
+         * Whether the contents of the macro should be assumed to be in math mode.
+         *
+         * @type {boolean}
+         */
+        inMathMode?: boolean;
+        /**
+         * Whether the arguments should be rendered with a hanging indent when the wrap
+         * (like the arguments to \item in an enumerate environment.)
+         *
+         * @type {boolean}
+         */
+        hangingIndent?: boolean;
+    };
+    /**
+     * The macro signature as an xparse argument specification string.
+     *
+     * @type {string}
+     */
+    signature?: string;
+    /**
+     * Some special macros like `^` and `_` don't use
+     * an escape token. When matching against these macros,
+     * care must be taken to match the macro contents and the macro's
+     * escape token.
+     */
+    escapeToken?: string;
+};
+```
+
+## `MacroInfoRecord`
+
+```typescript
+export type MacroInfoRecord = Record<string, MacroInfo>;
+```
+
+## `Node`
+
+```typescript
+export type Node =
+    | Root
+    | String
+    | Whitespace
+    | Parbreak
+    | Comment
+    | Macro
+    | Environment
+    | VerbatimEnvironment
+    | InlineMath
+    | DisplayMath
+    | Group
+    | Verb;
+```

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./libs/ast-types";
+export * from "./libs/type-guard";
+export * from "./libs/info-specs";
+/**
+ * ## What is this?
+ *
+ * Types for the `unified-latex` Abstract Syntax Tree (AST). These types extend the `unist` AST,
+ * but instead of a `children` attribute, they have a `content` attribute.
+ *
+ * ## When should I use this?
+ *
+ * If you're working with `unified-latex` ASTs.
+ */
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAGlC;;;;;;;;;GASG"}

package/dist/index.js

@@ -0,0 +1,15 @@
+export * from "./libs/ast-types";
+export * from "./libs/type-guard";
+export * from "./libs/info-specs";
+// NOTE: The docstring comment must be the last item in the index.ts file!
+/**
+ * ## What is this?
+ *
+ * Types for the `unified-latex` Abstract Syntax Tree (AST). These types extend the `unist` AST,
+ * but instead of a `children` attribute, they have a `content` attribute.
+ *
+ * ## When should I use this?
+ *
+ * If you're working with `unified-latex` ASTs.
+ */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAElC,0EAA0E;AAC1E;;;;;;;;;GASG"}

package/dist/libs/ast-types.d.ts

@@ -0,0 +1,85 @@
+export declare type GenericAst = GenericNode | GenericNode[];
+export interface GenericNode {
+    [x: string]: any;
+    type: string;
+    _renderInfo?: object;
+}
+interface BaseNode {
+    type: string;
+    _renderInfo?: any;
+    position?: {
+        start: {
+            offset: number;
+            line: number;
+            column: number;
+        };
+        end: {
+            offset: number;
+            line: number;
+            column: number;
+        };
+    };
+}
+interface ContentNode extends BaseNode {
+    content: Node[];
+}
+export interface Root extends ContentNode {
+    type: "root";
+}
+export interface String extends BaseNode {
+    type: "string";
+    content: string;
+}
+export interface Whitespace extends BaseNode {
+    type: "whitespace";
+}
+export interface Parbreak extends BaseNode {
+    type: "parbreak";
+}
+export interface Comment extends BaseNode {
+    type: "comment";
+    content: string;
+    sameline?: boolean;
+    suffixParbreak?: boolean;
+    leadingWhitespace?: boolean;
+}
+export interface Macro extends BaseNode {
+    type: "macro";
+    content: string;
+    escapeToken?: string;
+    args?: Argument[];
+}
+export interface Environment extends ContentNode {
+    type: "environment" | "mathenv";
+    env: string;
+    args?: Argument[];
+}
+export interface VerbatimEnvironment extends BaseNode {
+    type: "verbatim";
+    env: string;
+    content: string;
+}
+export interface DisplayMath extends ContentNode {
+    type: "displaymath";
+}
+export interface Group extends ContentNode {
+    type: "group";
+}
+export interface InlineMath extends ContentNode {
+    type: "inlinemath";
+}
+export interface Verb extends BaseNode {
+    type: "verb";
+    env: string;
+    escape: string;
+    content: string;
+}
+export interface Argument extends ContentNode {
+    type: "argument";
+    openMark: string;
+    closeMark: string;
+}
+export declare type Node = Root | String | Whitespace | Parbreak | Comment | Macro | Environment | VerbatimEnvironment | InlineMath | DisplayMath | Group | Verb;
+export declare type Ast = Node | Argument | Node[];
+export {};
+//# sourceMappingURL=ast-types.d.ts.map

package/dist/libs/ast-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-types.d.ts","sourceRoot":"","sources":["../../libs/ast-types.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC;AAErD,MAAM,WAAW,WAAW;IACxB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAGD,UAAU,QAAQ;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,EAAE;QACP,KAAK,EAAE;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;QACxD,GAAG,EAAE;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;KACzD,CAAC;CACL;AAED,UAAU,WAAY,SAAQ,QAAQ;IAClC,OAAO,EAAE,IAAI,EAAE,CAAC;CACnB;AAGD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACrC,IAAI,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,MAAO,SAAQ,QAAQ;IACpC,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,UAAW,SAAQ,QAAQ;IACxC,IAAI,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACtC,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACrC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,KAAM,SAAQ,QAAQ;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC5C,IAAI,EAAE,aAAa,GAAG,SAAS,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,mBAAoB,SAAQ,QAAQ;IACjD,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC5C,IAAI,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,KAAM,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC3C,IAAI,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,IAAK,SAAQ,QAAQ;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,QAAS,SAAQ,WAAW;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,oBAAY,IAAI,GACV,IAAI,GACJ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,OAAO,GACP,KAAK,GACL,WAAW,GACX,mBAAmB,GACnB,UAAU,GACV,WAAW,GACX,KAAK,GACL,IAAI,CAAC;AAEX,oBAAY,GAAG,GAAG,IAAI,GAAG,QAAQ,GAAG,IAAI,EAAE,CAAC"}

package/dist/libs/ast-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ast-types.js.map

package/dist/libs/ast-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-types.js","sourceRoot":"","sources":["../../libs/ast-types.ts"],"names":[],"mappings":""}

package/dist/libs/info-specs.d.ts

@@ -0,0 +1,89 @@
+import * as Ast from "./ast-types";
+export declare type EnvInfo = {
+    renderInfo?: {
+        /**
+         * Whether the body of the environment should be treated as math mode
+         *
+         * @type {boolean}
+         */
+        inMathMode?: boolean;
+        /**
+         * Whether to align the environment contents based on `&` and `\\` delimiters
+         * (like a matrix or tabular environment).
+         *
+         * @type {boolean}
+         */
+        alignContent?: boolean;
+        /**
+         * Whether the arguments should be treated as pgfkeys-type arguments.
+         *
+         * @type {boolean}
+         */
+        pgfkeysArgs?: boolean;
+    };
+    /**
+     * Function to process the body of an environment. The return value of `processContent`
+     * is treated as the new body.
+     *
+     */
+    processContent?: (ast: Ast.Node[]) => Ast.Node[];
+    /**
+     * The environment signature as an xparse argument specification string.
+     *
+     * @type {string}
+     */
+    signature?: string;
+};
+export declare type MacroInfo = {
+    renderInfo?: {
+        /**
+         * Whether the macro's contents wraps along with the current
+         * paragraph or displays as it's own block.
+         *
+         * @type {boolean}
+         */
+        inParMode?: boolean;
+        /**
+         * Whether the arguments should be processed as pgfkeys-type arguments.
+         *
+         * @type {boolean}
+         */
+        pgfkeysArgs?: boolean;
+        /**
+         * Whether there should be line breaks before and after the macro
+         * (e.g., like the \section{...} command.)
+         *
+         * @type {boolean}
+         */
+        breakAround?: boolean;
+        /**
+         * Whether the contents of the macro should be assumed to be in math mode.
+         *
+         * @type {boolean}
+         */
+        inMathMode?: boolean;
+        /**
+         * Whether the arguments should be rendered with a hanging indent when the wrap
+         * (like the arguments to \item in an enumerate environment.)
+         *
+         * @type {boolean}
+         */
+        hangingIndent?: boolean;
+    };
+    /**
+     * The macro signature as an xparse argument specification string.
+     *
+     * @type {string}
+     */
+    signature?: string;
+    /**
+     * Some special macros like `^` and `_` don't use
+     * an escape token. When matching against these macros,
+     * care must be taken to match the macro contents and the macro's
+     * escape token.
+     */
+    escapeToken?: string;
+};
+export declare type EnvInfoRecord = Record<string, EnvInfo>;
+export declare type MacroInfoRecord = Record<string, MacroInfo>;
+//# sourceMappingURL=info-specs.d.ts.map

package/dist/libs/info-specs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"info-specs.d.ts","sourceRoot":"","sources":["../../libs/info-specs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,aAAa,CAAC;AAEnC,oBAAY,OAAO,GAAG;IAClB,UAAU,CAAC,EAAE;QACT;;;;WAIG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;;;;WAKG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;;WAIG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;IACF;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;IACjD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,SAAS,GAAG;IACpB,UAAU,CAAC,EAAE;QACT;;;;;WAKG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB;;;;WAIG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB;;;;;WAKG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;;;;WAKG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;IACF;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACpD,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC"}

package/dist/libs/info-specs.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=info-specs.js.map

package/dist/libs/info-specs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"info-specs.js","sourceRoot":"","sources":["../../libs/info-specs.ts"],"names":[],"mappings":""}

package/dist/libs/type-guard.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generic type of a type-guard function.
+ */
+export interface TypeGuard<T> {
+    (node: any): node is T;
+}
+//# sourceMappingURL=type-guard.d.ts.map

package/dist/libs/type-guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guard.d.ts","sourceRoot":"","sources":["../../libs/type-guard.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IACxB,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC;CAC1B"}

package/dist/libs/type-guard.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=type-guard.js.map

package/dist/libs/type-guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guard.js","sourceRoot":"","sources":["../../libs/type-guard.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "@unified-latex/unified-latex-types",
+    "version": "1.0.0",
+    "description": "type definitions for unified-latex",
+    "main": "dist/index.js",
+    "type": "module",
+    "dependencies": {
+        "@unified-latex/unified-latex-types": "^1.0.0"
+    },
+    "files": [
+        "dist/**/*.ts",
+        "dist/**/*.js",
+        "dist/**/*.map",
+        "dist/**/*.json"
+    ],
+    "exports": {
+        ".": "./dist/index.js",
+        "./*js": "./dist/*js",
+        "./*": "./dist/*.js"
+    },
+    "typesVersions": {
+        "*": {
+            "*": [
+                "dist/*"
+            ]
+        }
+    },
+    "scripts": {
+        "build": "npm run clean && npm run compile",
+        "clean": "rm -rf ./dist && rm -rf tsconfig.tsbuildinfo",
+        "compile": "tsc -b tsconfig.json"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/siefkenj/unified-latex.git"
+    },
+    "keywords": [
+        "pegjs",
+        "latex",
+        "parser",
+        "prettier",
+        "unified-latex",
+        "unified"
+    ],
+    "author": "Jason Siefken",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/siefkenj/unified-latex/issues"
+    },
+    "homepage": "https://github.com/siefkenj/unified-latex#readme"
+}