@flex-development/docmark-util-symbol 1.0.0-dev.1

package/LICENSE.md

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Flex Development, LLC All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,120 @@
+# docmark-util-symbol
+
+[![github release](https://img.shields.io/github/v/release/flex-development/docmark.svg?include_prereleases\&sort=semver)](https://github.com/flex-development/docmark/releases/latest)
+[![npm](https://img.shields.io/npm/v/@flex-development/docmark-util-symbol.svg)](https://npmjs.com/package/@flex-development/docmark-util-symbol)
+[![npm downloads](https://img.shields.io/npm/dm/@flex-development/docmark-util-symbol.svg)](https://www.npmcharts.com/compare/@flex-development/docmark-util-symbol?interval=30)
+[![install size](https://packagephobia.now.sh/badge?p=@flex-development/docmark-util-symbol)](https://packagephobia.now.sh/result?p=@flex-development/docmark-util-symbol)
+[![minified bundle size](https://badgen.net/bundlephobia/min/@flex-development/docmark-util-symbol?cache)](https://bundlephobia.com/package/@flex-development/docmark-util-symbol)
+[![tree shaking suppport](https://badgen.net/bundlephobia/tree-shaking/@flex-development/docmark-util-symbol)](https://bundlephobia.com/package/@flex-development/docmark-util-symbol)
+[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
+[![license](https://img.shields.io/github/license/flex-development/docmark-util-symbol.svg)](LICENSE.md)
+[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript\&logoColor=ffffff)](https://typescriptlang.org)
+[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat\&logo=yarn\&logoColor=ffffff)](https://yarnpkg.com)
+
+[docmark][] utility with symbols.
+
+## Contents
+
+- [What is this?](#what-is-this)
+- [When should I use this?](#when-should-i-use-this)
+- [Install](#install)
+- [Use](#use)
+- [API](#api)
+- [Types](#types)
+- [Contribute](#contribute)
+
+## What is this?
+
+This package exposes constants used throughout the docmark ecosystem.
+
+## When should I use this?
+
+This package is useful when making your docmark extensions.
+It’s useful to reference these constants by name instead of value while developing.
+
+## Install
+
+This package is [ESM only][esm].
+
+In Node.js with [yarn][]:
+
+```sh
+yarn add @flex-development/docmark-util-symbol
+```
+
+<blockquote>
+  <small>
+    See <a href='https://yarnpkg.com/protocol/git'>Git - Protocols | Yarn</a>
+    &nbsp;for details regarding installing from Git.
+  </small>
+</blockquote>
+
+In Deno with [`esm.sh`][esmsh]:
+
+```ts
+import { chars, codes, constants, ct, ev, tt } from 'https://esm.sh/@flex-development/docmark-util-symbol'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import { chars, codes, constants, ct, ev, tt } from 'https://esm.sh/@flex-development/docmark-util-symbol'
+</script>
+```
+
+## Use
+
+```js
+import { chars, codes, constants, ct, ev, tt } from '@flex-development/docmark-util-symbol'
+
+console.log(chars.at) // '@'
+console.log(codes.at) // 64
+console.log(constants.tabSize) // 4
+console.log(ct.comment) // 'comment'
+console.log(ev.enter) // 'enter'
+console.log(tt.tagName) // 'tagName'
+```
+
+## API
+
+This package exports the identifiers `chars`, `codes`, `constants`, `ct`, `ev`, and `tt`.\
+There is no default export.
+
+Each identifier is an object mapping strings to values.\
+See the [code](./src/) for the exposed data.
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports no additional types.
+
+## Project
+
+### Version
+
+docmark-util-symbol adheres to [semver][].
+
+### Contribute
+
+See [`CONTRIBUTING.md`](../../CONTRIBUTING.md).
+
+This project has a [code of conduct](../../CODE_OF_CONDUCT.md).
+By interacting with this repository, organization, or community you agree to abide by its terms.
+
+### Sponsor
+
+Small primitives power larger systems.
+Support long-term stability by sponsoring Flex Development.
+
+[docmark]: ../../README.md
+
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[semver]: https://semver.org
+
+[typescript]: https://www.typescriptlang.org
+
+[yarn]: https://yarnpkg.com

package/dist/index.d.mts

@@ -0,0 +1,601 @@
+/**
+ * @file chars
+ * @module docmark-util-symbol/chars
+ */
+/**
+ * Character dictionary.
+ *
+ * Although docmark works based on character codes,
+ * this module includes string versions of those codes.
+ *
+ * @see https://symbl.cc/en/unicode/blocks/basic-latin
+ * @see https://symbl.cc/en/unicode/blocks/latin-1-supplement
+ *
+ * @enum {string | null}
+ */
+declare const chars: {
+    readonly ack: "\u0006";
+    readonly ampersand: "&";
+    readonly apostrophe: "'";
+    readonly asterisk: "*";
+    readonly at: "@";
+    readonly atSign: "@";
+    readonly backslash: "\\";
+    readonly bar: "|";
+    readonly bel: "\u0007";
+    readonly bom: "";
+    readonly break: "";
+    readonly bs: "\b";
+    readonly can: "\u0018";
+    readonly caret: "^";
+    readonly colon: ":";
+    readonly comma: ",";
+    readonly cr: "\r";
+    readonly crlf: "\r\n";
+    readonly dash: "-";
+    readonly dc1: "\u0011";
+    readonly dc2: "\u0012";
+    readonly dc3: "\u0013";
+    readonly dc4: "\u0014";
+    readonly del: "";
+    readonly digit0: "0";
+    readonly digit1: "1";
+    readonly digit2: "2";
+    readonly digit3: "3";
+    readonly digit4: "4";
+    readonly digit5: "5";
+    readonly digit6: "6";
+    readonly digit7: "7";
+    readonly digit8: "8";
+    readonly digit9: "9";
+    readonly dle: "\u0010";
+    readonly dollar: "$";
+    readonly dollarSign: "$";
+    readonly dot: ".";
+    readonly ellipsis: "...";
+    readonly em: "\u0019";
+    readonly empty: "";
+    readonly enq: "\u0005";
+    readonly eof: null;
+    readonly eos: null;
+    readonly eot: "\u0004";
+    readonly equal: "=";
+    readonly equalsTo: "=";
+    readonly esc: "\u001B";
+    readonly etb: "\u0017";
+    readonly etx: "\u0003";
+    readonly exclamation: "!";
+    readonly exclamationMark: "!";
+    readonly ff: "\f";
+    readonly fs: "\u001C";
+    readonly graveAccent: "`";
+    readonly greaterThan: ">";
+    readonly gs: "\u001D";
+    readonly gt: ">";
+    readonly hash: "#";
+    readonly ht: "\t";
+    readonly hyphen: "-";
+    readonly leftAngleBracket: "<";
+    readonly leftBrace: "{";
+    readonly leftBracket: "[";
+    readonly leftCurlyBrace: "{";
+    readonly leftParen: "(";
+    readonly leftParenthesis: "(";
+    readonly leftSquareBracket: "[";
+    readonly lessThan: "<";
+    readonly lf: "\n";
+    readonly lowercaseA: "a";
+    readonly lowercaseB: "b";
+    readonly lowercaseC: "c";
+    readonly lowercaseD: "d";
+    readonly lowercaseE: "e";
+    readonly lowercaseF: "f";
+    readonly lowercaseG: "g";
+    readonly lowercaseH: "h";
+    readonly lowercaseI: "i";
+    readonly lowercaseJ: "j";
+    readonly lowercaseK: "k";
+    readonly lowercaseL: "l";
+    readonly lowercaseM: "m";
+    readonly lowercaseN: "n";
+    readonly lowercaseO: "o";
+    readonly lowercaseP: "p";
+    readonly lowercaseQ: "q";
+    readonly lowercaseR: "r";
+    readonly lowercaseS: "s";
+    readonly lowercaseT: "t";
+    readonly lowercaseU: "u";
+    readonly lowercaseV: "v";
+    readonly lowercaseW: "w";
+    readonly lowercaseX: "x";
+    readonly lowercaseY: "y";
+    readonly lowercaseZ: "z";
+    readonly ls: "\u2028";
+    readonly lt: "<";
+    readonly minus: "-";
+    readonly nak: "\u0015";
+    readonly nbsp: " ";
+    readonly nul: "\0";
+    readonly numberSign: "#";
+    readonly percent: "%";
+    readonly percentSign: "%";
+    readonly plus: "+";
+    readonly plusSign: "+";
+    readonly ps: "\u2029";
+    readonly questionMark: "?";
+    readonly quotation: "\"";
+    readonly quotationMark: "\"";
+    readonly replacement: "�";
+    readonly replacementCharacter: "�";
+    readonly rightAngleBracket: ">";
+    readonly rightBrace: "}";
+    readonly rightBracket: "]";
+    readonly rightCurlyBrace: "}";
+    readonly rightParen: ")";
+    readonly rightParenthesis: ")";
+    readonly rightSquareBracket: "]";
+    readonly rs: "\u001E";
+    readonly semicolon: ";";
+    readonly si: "\u000F";
+    readonly slash: "/";
+    readonly so: "\u000E";
+    readonly soh: "\u0001";
+    readonly space: " ";
+    readonly stx: "\u0002";
+    readonly sub: "\u001A";
+    readonly syn: "\u0016";
+    readonly tilde: "~";
+    readonly underscore: "_";
+    readonly uppercaseA: "A";
+    readonly uppercaseB: "B";
+    readonly uppercaseC: "C";
+    readonly uppercaseD: "D";
+    readonly uppercaseE: "E";
+    readonly uppercaseF: "F";
+    readonly uppercaseG: "G";
+    readonly uppercaseH: "H";
+    readonly uppercaseI: "I";
+    readonly uppercaseJ: "J";
+    readonly uppercaseK: "K";
+    readonly uppercaseL: "L";
+    readonly uppercaseM: "M";
+    readonly uppercaseN: "N";
+    readonly uppercaseO: "O";
+    readonly uppercaseP: "P";
+    readonly uppercaseQ: "Q";
+    readonly uppercaseR: "R";
+    readonly uppercaseS: "S";
+    readonly uppercaseT: "T";
+    readonly uppercaseU: "U";
+    readonly uppercaseV: "V";
+    readonly uppercaseW: "W";
+    readonly uppercaseX: "X";
+    readonly uppercaseY: "Y";
+    readonly uppercaseZ: "Z";
+    readonly us: "\u001F";
+    readonly verticalBar: "|";
+    readonly vt: "\v";
+    readonly zwj: "‍";
+    readonly zwnj: "‌";
+};
+
+/**
+ * @file codes
+ * @module docmark-util-symbol/codes
+ */
+/**
+ * Character codes.
+ *
+ * docmark works based on character codes.
+ * This module contains constants for the ASCII block and the replacement
+ * character.
+ *
+ * A few codes are handled in a special way, such as line endings (CR, LF,
+ * and CR+LF, commonly known as end-of-line: EOLs), as well as tab (horizontal
+ * tab) and its expansion based on what column it’s at (virtual space).
+ * As values are preprocessed before handling them, the actual characters LF,
+ * CR, and HT are guaranteed to not exist.
+ *
+ * @see https://symbl.cc/en/unicode/blocks/basic-latin
+ * @see https://symbl.cc/en/unicode/blocks/latin-1-supplement
+ * @see https://util.unicode.org/UnicodeJsps/character.jsp
+ * @see https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp
+ *
+ * @enum {string | null}
+ */
+declare const codes: {
+    readonly eof: null;
+    readonly eos: null;
+    readonly bos: -1000;
+    readonly sof: -1000;
+    readonly empty: -999;
+    readonly break: -13;
+    readonly carriageReturn: -5;
+    readonly lineFeed: -4;
+    readonly carriageReturnLineFeed: -3;
+    readonly horizontalTab: -2;
+    readonly virtualSpace: -1;
+    readonly nul: 0;
+    readonly soh: 1;
+    readonly stx: 2;
+    readonly etx: 3;
+    readonly eot: 4;
+    readonly enq: 5;
+    readonly ack: 6;
+    readonly bel: 7;
+    readonly bs: 8;
+    readonly ht: 9;
+    readonly lf: 10;
+    readonly vt: 11;
+    readonly ff: 12;
+    readonly cr: 13;
+    readonly so: 14;
+    readonly si: 15;
+    readonly dle: 16;
+    readonly dc1: 17;
+    readonly dc2: 18;
+    readonly dc3: 19;
+    readonly dc4: 20;
+    readonly nak: 21;
+    readonly syn: 22;
+    readonly etb: 23;
+    readonly can: 24;
+    readonly em: 25;
+    readonly sub: 26;
+    readonly esc: 27;
+    readonly fs: 28;
+    readonly gs: 29;
+    readonly rs: 30;
+    readonly us: 31;
+    readonly space: 32;
+    readonly exclamationMark: 33;
+    readonly quotationMark: 34;
+    readonly numberSign: 35;
+    readonly dollarSign: 36;
+    readonly percentSign: 37;
+    readonly ampersand: 38;
+    readonly apostrophe: 39;
+    readonly leftParenthesis: 40;
+    readonly rightParenthesis: 41;
+    readonly asterisk: 42;
+    readonly plusSign: 43;
+    readonly comma: 44;
+    readonly dash: 45;
+    readonly dot: 46;
+    readonly slash: 47;
+    readonly digit0: 48;
+    readonly digit1: 49;
+    readonly digit2: 50;
+    readonly digit3: 51;
+    readonly digit4: 52;
+    readonly digit5: 53;
+    readonly digit6: 54;
+    readonly digit7: 55;
+    readonly digit8: 56;
+    readonly digit9: 57;
+    readonly colon: 58;
+    readonly semicolon: 59;
+    readonly lessThan: 60;
+    readonly equalsTo: 61;
+    readonly greaterThan: 62;
+    readonly questionMark: 63;
+    readonly atSign: 64;
+    readonly uppercaseA: 65;
+    readonly uppercaseB: 66;
+    readonly uppercaseC: 67;
+    readonly uppercaseD: 68;
+    readonly uppercaseE: 69;
+    readonly uppercaseF: 70;
+    readonly uppercaseG: 71;
+    readonly uppercaseH: 72;
+    readonly uppercaseI: 73;
+    readonly uppercaseJ: 74;
+    readonly uppercaseK: 75;
+    readonly uppercaseL: 76;
+    readonly uppercaseM: 77;
+    readonly uppercaseN: 78;
+    readonly uppercaseO: 79;
+    readonly uppercaseP: 80;
+    readonly uppercaseQ: 81;
+    readonly uppercaseR: 82;
+    readonly uppercaseS: 83;
+    readonly uppercaseT: 84;
+    readonly uppercaseU: 85;
+    readonly uppercaseV: 86;
+    readonly uppercaseW: 87;
+    readonly uppercaseX: 88;
+    readonly uppercaseY: 89;
+    readonly uppercaseZ: 90;
+    readonly leftSquareBracket: 91;
+    readonly backslash: 92;
+    readonly rightSquareBracket: 93;
+    readonly caret: 94;
+    readonly underscore: 95;
+    readonly graveAccent: 96;
+    readonly lowercaseA: 97;
+    readonly lowercaseB: 98;
+    readonly lowercaseC: 99;
+    readonly lowercaseD: 100;
+    readonly lowercaseE: 101;
+    readonly lowercaseF: 102;
+    readonly lowercaseG: 103;
+    readonly lowercaseH: 104;
+    readonly lowercaseI: 105;
+    readonly lowercaseJ: 106;
+    readonly lowercaseK: 107;
+    readonly lowercaseL: 108;
+    readonly lowercaseM: 109;
+    readonly lowercaseN: 110;
+    readonly lowercaseO: 111;
+    readonly lowercaseP: 112;
+    readonly lowercaseQ: 113;
+    readonly lowercaseR: 114;
+    readonly lowercaseS: 115;
+    readonly lowercaseT: 116;
+    readonly lowercaseU: 117;
+    readonly lowercaseV: 118;
+    readonly lowercaseW: 119;
+    readonly lowercaseX: 120;
+    readonly lowercaseY: 121;
+    readonly lowercaseZ: 122;
+    readonly leftCurlyBrace: 123;
+    readonly verticalBar: 124;
+    readonly rightCurlyBrace: 125;
+    readonly tilde: 126;
+    readonly del: 127;
+    readonly nbsp: 160;
+    readonly zwnj: 8204;
+    readonly zwj: 8205;
+    readonly ls: 8232;
+    readonly ps: 8233;
+    readonly bom: 65279;
+    readonly byteOrderMarker: 65279;
+    readonly replacement: 65533;
+    readonly replacementCharacter: 65533;
+};
+
+/**
+ * @file constants
+ * @module docmark-util-symbol/constants
+ */
+/**
+ * Constant values.
+ *
+ * @enum {number | string}
+ */
+declare const constants: {
+    readonly attentionSideAfter: 2;
+    readonly attentionSideBefore: 1;
+    readonly atxHeadingOpeningFenceSizeMax: 6;
+    readonly autolinkDomainSizeMax: 63;
+    readonly autolinkSchemeSizeMax: 32;
+    readonly cdataOpeningString: "CDATA[";
+    readonly characterGroupPunctuation: 2;
+    readonly characterGroupWhitespace: 1;
+    readonly characterReferenceDecimalSizeMax: 7;
+    readonly characterReferenceHexadecimalSizeMax: 6;
+    readonly characterReferenceNamedSizeMax: 31;
+    readonly codeFencedSequenceSizeMin: 3;
+    readonly commentPaddingSizeMin: 2;
+    readonly contentTypeComment: "comment";
+    readonly contentTypeContent: "content";
+    readonly contentTypeDocument: "document";
+    readonly contentTypeFlow: "flow";
+    readonly contentTypeSource: "source";
+    readonly contentTypeString: "string";
+    readonly contentTypeText: "text";
+    readonly contentTypeType: "type";
+    readonly hardBreakPrefixSizeMin: 2;
+    readonly htmlBasic: 6;
+    readonly htmlCdata: 5;
+    readonly htmlComment: 2;
+    readonly htmlComplete: 7;
+    readonly htmlDeclaration: 4;
+    readonly htmlInstruction: 3;
+    readonly htmlRaw: 1;
+    readonly htmlRawSizeMax: 8;
+    readonly linkReferenceSizeMax: 999;
+    readonly linkResourceDestinationBalanceMax: 32;
+    readonly listItemValueSizeMax: 10;
+    readonly numericBaseDecimal: 10;
+    readonly numericBaseHexadecimal: 16;
+    readonly tabSize: 4;
+    readonly thematicBreakMarkerCountMin: 3;
+    readonly v8MaxSafeChunkSize: 10000;
+};
+
+/**
+ * @file ct
+ * @module docmark-util-symbol/ct
+ */
+/**
+ * Registry of all content types used by docmark.
+ *
+ * @enum {string}
+ */
+declare const ct: {
+    readonly comment: "comment";
+    readonly content: "content";
+    readonly document: "document";
+    readonly flow: "flow";
+    readonly source: "source";
+    readonly string: "string";
+    readonly text: "text";
+    readonly type: "type";
+};
+
+/**
+ * @file ev
+ * @module docmark-util-symbol/ev
+ */
+/**
+ * Event types used by docmark.
+ *
+ * @enum {'enter' | 'ext'}
+ */
+declare const ev: {
+    readonly enter: "enter";
+    readonly exit: "exit";
+};
+
+/**
+ * @file kind
+ * @module docmark-util-symbol/kind
+ */
+/**
+ * Registry of all comment kinds exposed by docmark.
+ *
+ * @enum {string}
+ */
+declare const kind: {
+    readonly block: "block";
+    readonly docblock: "docblock";
+    readonly line: "line";
+};
+
+/**
+ * @file tt
+ * @module docmark-util-symbol/tt
+ */
+/**
+ * Registry of all token types exposed by docmark.
+ *
+ * @todo remove extension-specific types
+ *
+ * @enum {string}
+ */
+declare const tt: {
+    readonly atxHeading: "atxHeading";
+    readonly atxHeadingSequence: "atxHeadingSequence";
+    readonly atxHeadingText: "atxHeadingText";
+    readonly autolink: "autolink";
+    readonly autolinkEmail: "autolinkEmail";
+    readonly autolinkMarker: "autolinkMarker";
+    readonly autolinkProtocol: "autolinkProtocol";
+    readonly blockQuote: "blockQuote";
+    readonly blockQuoteMarker: "blockQuoteMarker";
+    readonly blockQuotePrefix: "blockQuotePrefix";
+    readonly blockQuotePrefixWhitespace: "blockQuotePrefixWhitespace";
+    readonly blockTag: "blockTag";
+    readonly characterEscape: "characterEscape";
+    readonly characterEscapeValue: "characterEscapeValue";
+    readonly characterReference: "characterReference";
+    readonly characterReferenceMarker: "characterReferenceMarker";
+    readonly characterReferenceMarkerHexadecimal: "characterReferenceMarkerHexadecimal";
+    readonly characterReferenceMarkerNumeric: "characterReferenceMarkerNumeric";
+    readonly characterReferenceValue: "characterReferenceValue";
+    readonly chunkComment: "chunkComment";
+    readonly chunkContent: "chunkContent";
+    readonly chunkDocument: "chunkDocument";
+    readonly chunkFlow: "chunkFlow";
+    readonly chunkMarkdown: "chunkMarkdown";
+    readonly chunkString: "chunkString";
+    readonly chunkText: "chunkText";
+    readonly chunkType: "chunkType";
+    readonly codeFenced: "codeFenced";
+    readonly codeFencedFence: "codeFencedFence";
+    readonly codeFencedFenceInfo: "codeFencedFenceInfo";
+    readonly codeFencedFenceMeta: "codeFencedFenceMeta";
+    readonly codeFencedFenceSequence: "codeFencedFenceSequence";
+    readonly codeFlowValue: "codeFlowValue";
+    readonly codeIndented: "codeIndented";
+    readonly codeText: "codeText";
+    readonly codeTextData: "codeTextData";
+    readonly codeTextPadding: "codeTextPadding";
+    readonly codeTextSequence: "codeTextSequence";
+    readonly comment: "comment";
+    readonly commentCloser: "commentCloser";
+    readonly commentLineMarker: "commentLineMarker";
+    readonly commentLinePrefix: "commentLinePrefix";
+    readonly commentOpener: "commentOpener";
+    readonly commentPadding: "commentPadding";
+    readonly content: "content";
+    readonly data: "data";
+    readonly definition: "definition";
+    readonly definitionDestination: "definitionDestination";
+    readonly definitionDestinationLiteral: "definitionDestinationLiteral";
+    readonly definitionDestinationLiteralMarker: "definitionDestinationLiteralMarker";
+    readonly definitionDestinationRaw: "definitionDestinationRaw";
+    readonly definitionDestinationString: "definitionDestinationString";
+    readonly definitionLabel: "definitionLabel";
+    readonly definitionLabelMarker: "definitionLabelMarker";
+    readonly definitionLabelString: "definitionLabelString";
+    readonly definitionMarker: "definitionMarker";
+    readonly definitionTitle: "definitionTitle";
+    readonly definitionTitleMarker: "definitionTitleMarker";
+    readonly definitionTitleString: "definitionTitleString";
+    readonly emphasis: "emphasis";
+    readonly emphasisSequence: "emphasisSequence";
+    readonly emphasisText: "emphasisText";
+    readonly eoc: "eoc";
+    readonly escapeMarker: "escapeMarker";
+    readonly hardBreakEscape: "hardBreakEscape";
+    readonly hardBreakTrailing: "hardBreakTrailing";
+    readonly htmlFlow: "htmlFlow";
+    readonly htmlFlowData: "htmlFlowData";
+    readonly htmlText: "htmlText";
+    readonly htmlTextData: "htmlTextData";
+    readonly identifier: "identifier";
+    readonly image: "image";
+    readonly inlineTag: "inlineTag";
+    readonly inlineTagMarker: "inlineTagMarker";
+    readonly inlineTagText: "inlineTagText";
+    readonly label: "label";
+    readonly labelEnd: "labelEnd";
+    readonly labelImage: "labelImage";
+    readonly labelImageMarker: "labelImageMarker";
+    readonly labelLink: "labelLink";
+    readonly labelMarker: "labelMarker";
+    readonly labelText: "labelText";
+    readonly lineEnding: "lineEnding";
+    readonly lineEndingBlank: "lineEndingBlank";
+    readonly linePrefix: "linePrefix";
+    readonly lineSuffix: "lineSuffix";
+    readonly link: "link";
+    readonly listItemIndent: "listItemIndent";
+    readonly listItemMarker: "listItemMarker";
+    readonly listItemPrefix: "listItemPrefix";
+    readonly listItemPrefixWhitespace: "listItemPrefixWhitespace";
+    readonly listItemValue: "listItemValue";
+    readonly listOrdered: "listOrdered";
+    readonly listUnordered: "listUnordered";
+    readonly namepath: "namepath";
+    readonly namepathConnector: "namepathConnector";
+    readonly namepathIdentifier: "namepathIdentifier";
+    readonly namepathMarker: "namepathMarker";
+    readonly paragraph: "paragraph";
+    readonly reference: "reference";
+    readonly referenceMarker: "referenceMarker";
+    readonly referenceString: "referenceString";
+    readonly resource: "resource";
+    readonly resourceDestination: "resourceDestination";
+    readonly resourceDestinationLiteral: "resourceDestinationLiteral";
+    readonly resourceDestinationLiteralMarker: "resourceDestinationLiteralMarker";
+    readonly resourceDestinationRaw: "resourceDestinationRaw";
+    readonly resourceDestinationString: "resourceDestinationString";
+    readonly resourceMarker: "resourceMarker";
+    readonly resourceTitle: "resourceTitle";
+    readonly resourceTitleMarker: "resourceTitleMarker";
+    readonly resourceTitleString: "resourceTitleString";
+    readonly setextHeading: "setextHeading";
+    readonly setextHeadingLine: "setextHeadingLine";
+    readonly setextHeadingLineSequence: "setextHeadingLineSequence";
+    readonly setextHeadingText: "setextHeadingText";
+    readonly strong: "strong";
+    readonly strongSequence: "strongSequence";
+    readonly strongText: "strongText";
+    readonly summary: "summary";
+    readonly summaryMarker: "summaryMarker";
+    readonly tagName: "tagName";
+    readonly tagNameIdentifier: "tagNameIdentifier";
+    readonly tagNameMarker: "tagNameMarker";
+    readonly thematicBreak: "thematicBreak";
+    readonly thematicBreakSequence: "thematicBreakSequence";
+    readonly typeExpression: "typeExpression";
+    readonly typeExpressionValue: "typeExpressionValue";
+    readonly typeMetadata: "typeMetadata";
+    readonly typeMetadataMarker: "typeMetadataMarker";
+    readonly whitespace: "whitespace";
+};
+
+export { chars, codes, constants, ct, ev, kind, tt };

package/dist/index.mjs

@@ -0,0 +1,515 @@
+const chars = {
+    ack: '\u0006',
+    ampersand: '&',
+    apostrophe: '\'',
+    asterisk: '*',
+    at: '@',
+    atSign: '@',
+    backslash: '\\',
+    bar: '|',
+    bel: '\u0007',
+    bom: '\ufeff',
+    break: '',
+    bs: '\b',
+    can: '\u0018',
+    caret: '^',
+    colon: ':',
+    comma: ',',
+    cr: '\r',
+    crlf: '\r\n',
+    dash: '-',
+    dc1: '\u0011',
+    dc2: '\u0012',
+    dc3: '\u0013',
+    dc4: '\u0014',
+    del: '\u007f',
+    digit0: '0',
+    digit1: '1',
+    digit2: '2',
+    digit3: '3',
+    digit4: '4',
+    digit5: '5',
+    digit6: '6',
+    digit7: '7',
+    digit8: '8',
+    digit9: '9',
+    dle: '\u0010',
+    dollar: '$',
+    dollarSign: '$',
+    dot: '.',
+    ellipsis: '...',
+    em: '\u0019',
+    empty: '',
+    enq: '\u0005',
+    eof: null,
+    eos: null,
+    eot: '\u0004',
+    equal: '=',
+    equalsTo: '=',
+    esc: '\u001b',
+    etb: '\u0017',
+    etx: '\u0003',
+    exclamation: '!',
+    exclamationMark: '!',
+    ff: '\f',
+    fs: '\u001c',
+    graveAccent: '`',
+    greaterThan: '>',
+    gs: '\u001d',
+    gt: '>',
+    hash: '#',
+    ht: '\t',
+    hyphen: '-',
+    leftAngleBracket: '<',
+    leftBrace: '{',
+    leftBracket: '[',
+    leftCurlyBrace: '{',
+    leftParen: '(',
+    leftParenthesis: '(',
+    leftSquareBracket: '[',
+    lessThan: '<',
+    lf: '\n',
+    lowercaseA: 'a',
+    lowercaseB: 'b',
+    lowercaseC: 'c',
+    lowercaseD: 'd',
+    lowercaseE: 'e',
+    lowercaseF: 'f',
+    lowercaseG: 'g',
+    lowercaseH: 'h',
+    lowercaseI: 'i',
+    lowercaseJ: 'j',
+    lowercaseK: 'k',
+    lowercaseL: 'l',
+    lowercaseM: 'm',
+    lowercaseN: 'n',
+    lowercaseO: 'o',
+    lowercaseP: 'p',
+    lowercaseQ: 'q',
+    lowercaseR: 'r',
+    lowercaseS: 's',
+    lowercaseT: 't',
+    lowercaseU: 'u',
+    lowercaseV: 'v',
+    lowercaseW: 'w',
+    lowercaseX: 'x',
+    lowercaseY: 'y',
+    lowercaseZ: 'z',
+    ls: '\u2028',
+    lt: '<',
+    minus: '-',
+    nak: '\u0015',
+    nbsp: '\u00a0',
+    nul: '\0',
+    numberSign: '#',
+    percent: '%',
+    percentSign: '%',
+    plus: '+',
+    plusSign: '+',
+    ps: '\u2029',
+    questionMark: '?',
+    quotation: '"',
+    quotationMark: '"',
+    replacement: '�',
+    replacementCharacter: '�',
+    rightAngleBracket: '>',
+    rightBrace: '}',
+    rightBracket: ']',
+    rightCurlyBrace: '}',
+    rightParen: ')',
+    rightParenthesis: ')',
+    rightSquareBracket: ']',
+    rs: '\u001e',
+    semicolon: ';',
+    si: '\u000f',
+    slash: '/',
+    so: '\u000e',
+    soh: '\u0001',
+    space: ' ',
+    stx: '\u0002',
+    sub: '\u001a',
+    syn: '\u0016',
+    tilde: '~',
+    underscore: '_',
+    uppercaseA: 'A',
+    uppercaseB: 'B',
+    uppercaseC: 'C',
+    uppercaseD: 'D',
+    uppercaseE: 'E',
+    uppercaseF: 'F',
+    uppercaseG: 'G',
+    uppercaseH: 'H',
+    uppercaseI: 'I',
+    uppercaseJ: 'J',
+    uppercaseK: 'K',
+    uppercaseL: 'L',
+    uppercaseM: 'M',
+    uppercaseN: 'N',
+    uppercaseO: 'O',
+    uppercaseP: 'P',
+    uppercaseQ: 'Q',
+    uppercaseR: 'R',
+    uppercaseS: 'S',
+    uppercaseT: 'T',
+    uppercaseU: 'U',
+    uppercaseV: 'V',
+    uppercaseW: 'W',
+    uppercaseX: 'X',
+    uppercaseY: 'Y',
+    uppercaseZ: 'Z',
+    us: '\u001f',
+    verticalBar: '|',
+    vt: '\v',
+    zwj: '\u200d',
+    zwnj: '\u200c'
+};
+
+const codes = {
+    eof: null,
+    eos: null,
+    bos: -1e3,
+    sof: -1e3,
+    empty: -999,
+    break: -13,
+    carriageReturn: -5,
+    lineFeed: -4,
+    carriageReturnLineFeed: -3,
+    horizontalTab: -2,
+    virtualSpace: -1,
+    nul: 0,
+    soh: 1,
+    stx: 2,
+    etx: 3,
+    eot: 4,
+    enq: 5,
+    ack: 6,
+    bel: 7,
+    bs: 8,
+    ht: 9,
+    lf: 10,
+    vt: 11,
+    ff: 12,
+    cr: 13,
+    so: 14,
+    si: 15,
+    dle: 16,
+    dc1: 17,
+    dc2: 18,
+    dc3: 19,
+    dc4: 20,
+    nak: 21,
+    syn: 22,
+    etb: 23,
+    can: 24,
+    em: 25,
+    sub: 26,
+    esc: 27,
+    fs: 28,
+    gs: 29,
+    rs: 30,
+    us: 31,
+    space: 32,
+    exclamationMark: 33,
+    quotationMark: 34,
+    numberSign: 35,
+    dollarSign: 36,
+    percentSign: 37,
+    ampersand: 38,
+    apostrophe: 39,
+    leftParenthesis: 40,
+    rightParenthesis: 41,
+    asterisk: 42,
+    plusSign: 43,
+    comma: 44,
+    dash: 45,
+    dot: 46,
+    slash: 47,
+    digit0: 48,
+    digit1: 49,
+    digit2: 50,
+    digit3: 51,
+    digit4: 52,
+    digit5: 53,
+    digit6: 54,
+    digit7: 55,
+    digit8: 56,
+    digit9: 57,
+    colon: 58,
+    semicolon: 59,
+    lessThan: 60,
+    equalsTo: 61,
+    greaterThan: 62,
+    questionMark: 63,
+    atSign: 64,
+    uppercaseA: 65,
+    uppercaseB: 66,
+    uppercaseC: 67,
+    uppercaseD: 68,
+    uppercaseE: 69,
+    uppercaseF: 70,
+    uppercaseG: 71,
+    uppercaseH: 72,
+    uppercaseI: 73,
+    uppercaseJ: 74,
+    uppercaseK: 75,
+    uppercaseL: 76,
+    uppercaseM: 77,
+    uppercaseN: 78,
+    uppercaseO: 79,
+    uppercaseP: 80,
+    uppercaseQ: 81,
+    uppercaseR: 82,
+    uppercaseS: 83,
+    uppercaseT: 84,
+    uppercaseU: 85,
+    uppercaseV: 86,
+    uppercaseW: 87,
+    uppercaseX: 88,
+    uppercaseY: 89,
+    uppercaseZ: 90,
+    leftSquareBracket: 91,
+    backslash: 92,
+    rightSquareBracket: 93,
+    caret: 94,
+    underscore: 95,
+    graveAccent: 96,
+    lowercaseA: 97,
+    lowercaseB: 98,
+    lowercaseC: 99,
+    lowercaseD: 100,
+    lowercaseE: 101,
+    lowercaseF: 102,
+    lowercaseG: 103,
+    lowercaseH: 104,
+    lowercaseI: 105,
+    lowercaseJ: 106,
+    lowercaseK: 107,
+    lowercaseL: 108,
+    lowercaseM: 109,
+    lowercaseN: 110,
+    lowercaseO: 111,
+    lowercaseP: 112,
+    lowercaseQ: 113,
+    lowercaseR: 114,
+    lowercaseS: 115,
+    lowercaseT: 116,
+    lowercaseU: 117,
+    lowercaseV: 118,
+    lowercaseW: 119,
+    lowercaseX: 120,
+    lowercaseY: 121,
+    lowercaseZ: 122,
+    leftCurlyBrace: 123,
+    verticalBar: 124,
+    rightCurlyBrace: 125,
+    tilde: 126,
+    del: 127,
+    nbsp: 160,
+    zwnj: 8204,
+    zwj: 8205,
+    ls: 8232,
+    ps: 8233,
+    bom: 65_279,
+    byteOrderMarker: 65_279,
+    replacement: 65_533,
+    replacementCharacter: 65_533
+};
+
+const constants = {
+    attentionSideAfter: 2,
+    attentionSideBefore: 1,
+    atxHeadingOpeningFenceSizeMax: 6,
+    autolinkDomainSizeMax: 63,
+    autolinkSchemeSizeMax: 32,
+    cdataOpeningString: 'CDATA[',
+    characterGroupPunctuation: 2,
+    characterGroupWhitespace: 1,
+    characterReferenceDecimalSizeMax: 7,
+    characterReferenceHexadecimalSizeMax: 6,
+    characterReferenceNamedSizeMax: 31,
+    codeFencedSequenceSizeMin: 3,
+    commentPaddingSizeMin: 2,
+    contentTypeComment: 'comment',
+    contentTypeContent: 'content',
+    contentTypeDocument: 'document',
+    contentTypeFlow: 'flow',
+    contentTypeSource: 'source',
+    contentTypeString: 'string',
+    contentTypeText: 'text',
+    contentTypeType: 'type',
+    hardBreakPrefixSizeMin: 2,
+    htmlBasic: 6,
+    htmlCdata: 5,
+    htmlComment: 2,
+    htmlComplete: 7,
+    htmlDeclaration: 4,
+    htmlInstruction: 3,
+    htmlRaw: 1,
+    htmlRawSizeMax: 8,
+    linkReferenceSizeMax: 999,
+    linkResourceDestinationBalanceMax: 32,
+    listItemValueSizeMax: 10,
+    numericBaseDecimal: 10,
+    numericBaseHexadecimal: 0x10,
+    tabSize: 4,
+    thematicBreakMarkerCountMin: 3,
+    v8MaxSafeChunkSize: 10_000
+};
+
+const ct = {
+    comment: constants.contentTypeComment,
+    content: constants.contentTypeContent,
+    document: constants.contentTypeDocument,
+    flow: constants.contentTypeFlow,
+    source: constants.contentTypeSource,
+    string: constants.contentTypeString,
+    text: constants.contentTypeText,
+    type: constants.contentTypeType
+};
+
+const ev = {
+    enter: 'enter',
+    exit: 'exit'
+};
+
+const kind = {
+    block: 'block',
+    docblock: 'docblock',
+    line: 'line'
+};
+
+const tt = {
+    atxHeading: 'atxHeading',
+    atxHeadingSequence: 'atxHeadingSequence',
+    atxHeadingText: 'atxHeadingText',
+    autolink: 'autolink',
+    autolinkEmail: 'autolinkEmail',
+    autolinkMarker: 'autolinkMarker',
+    autolinkProtocol: 'autolinkProtocol',
+    blockQuote: 'blockQuote',
+    blockQuoteMarker: 'blockQuoteMarker',
+    blockQuotePrefix: 'blockQuotePrefix',
+    blockQuotePrefixWhitespace: 'blockQuotePrefixWhitespace',
+    blockTag: 'blockTag',
+    characterEscape: 'characterEscape',
+    characterEscapeValue: 'characterEscapeValue',
+    characterReference: 'characterReference',
+    characterReferenceMarker: 'characterReferenceMarker',
+    characterReferenceMarkerHexadecimal: 'characterReferenceMarkerHexadecimal',
+    characterReferenceMarkerNumeric: 'characterReferenceMarkerNumeric',
+    characterReferenceValue: 'characterReferenceValue',
+    chunkComment: 'chunkComment',
+    chunkContent: 'chunkContent',
+    chunkDocument: 'chunkDocument',
+    chunkFlow: 'chunkFlow',
+    chunkMarkdown: 'chunkMarkdown',
+    chunkString: 'chunkString',
+    chunkText: 'chunkText',
+    chunkType: 'chunkType',
+    codeFenced: 'codeFenced',
+    codeFencedFence: 'codeFencedFence',
+    codeFencedFenceInfo: 'codeFencedFenceInfo',
+    codeFencedFenceMeta: 'codeFencedFenceMeta',
+    codeFencedFenceSequence: 'codeFencedFenceSequence',
+    codeFlowValue: 'codeFlowValue',
+    codeIndented: 'codeIndented',
+    codeText: 'codeText',
+    codeTextData: 'codeTextData',
+    codeTextPadding: 'codeTextPadding',
+    codeTextSequence: 'codeTextSequence',
+    comment: 'comment',
+    commentCloser: 'commentCloser',
+    commentLineMarker: 'commentLineMarker',
+    commentLinePrefix: 'commentLinePrefix',
+    commentOpener: 'commentOpener',
+    commentPadding: 'commentPadding',
+    content: 'content',
+    data: 'data',
+    definition: 'definition',
+    definitionDestination: 'definitionDestination',
+    definitionDestinationLiteral: 'definitionDestinationLiteral',
+    definitionDestinationLiteralMarker: 'definitionDestinationLiteralMarker',
+    definitionDestinationRaw: 'definitionDestinationRaw',
+    definitionDestinationString: 'definitionDestinationString',
+    definitionLabel: 'definitionLabel',
+    definitionLabelMarker: 'definitionLabelMarker',
+    definitionLabelString: 'definitionLabelString',
+    definitionMarker: 'definitionMarker',
+    definitionTitle: 'definitionTitle',
+    definitionTitleMarker: 'definitionTitleMarker',
+    definitionTitleString: 'definitionTitleString',
+    emphasis: 'emphasis',
+    emphasisSequence: 'emphasisSequence',
+    emphasisText: 'emphasisText',
+    eoc: 'eoc',
+    escapeMarker: 'escapeMarker',
+    hardBreakEscape: 'hardBreakEscape',
+    hardBreakTrailing: 'hardBreakTrailing',
+    htmlFlow: 'htmlFlow',
+    htmlFlowData: 'htmlFlowData',
+    htmlText: 'htmlText',
+    htmlTextData: 'htmlTextData',
+    identifier: 'identifier',
+    image: 'image',
+    inlineTag: 'inlineTag',
+    inlineTagMarker: 'inlineTagMarker',
+    inlineTagText: 'inlineTagText',
+    label: 'label',
+    labelEnd: 'labelEnd',
+    labelImage: 'labelImage',
+    labelImageMarker: 'labelImageMarker',
+    labelLink: 'labelLink',
+    labelMarker: 'labelMarker',
+    labelText: 'labelText',
+    lineEnding: 'lineEnding',
+    lineEndingBlank: 'lineEndingBlank',
+    linePrefix: 'linePrefix',
+    lineSuffix: 'lineSuffix',
+    link: 'link',
+    listItemIndent: 'listItemIndent',
+    listItemMarker: 'listItemMarker',
+    listItemPrefix: 'listItemPrefix',
+    listItemPrefixWhitespace: 'listItemPrefixWhitespace',
+    listItemValue: 'listItemValue',
+    listOrdered: 'listOrdered',
+    listUnordered: 'listUnordered',
+    namepath: 'namepath',
+    namepathConnector: 'namepathConnector',
+    namepathIdentifier: 'namepathIdentifier',
+    namepathMarker: 'namepathMarker',
+    paragraph: 'paragraph',
+    reference: 'reference',
+    referenceMarker: 'referenceMarker',
+    referenceString: 'referenceString',
+    resource: 'resource',
+    resourceDestination: 'resourceDestination',
+    resourceDestinationLiteral: 'resourceDestinationLiteral',
+    resourceDestinationLiteralMarker: 'resourceDestinationLiteralMarker',
+    resourceDestinationRaw: 'resourceDestinationRaw',
+    resourceDestinationString: 'resourceDestinationString',
+    resourceMarker: 'resourceMarker',
+    resourceTitle: 'resourceTitle',
+    resourceTitleMarker: 'resourceTitleMarker',
+    resourceTitleString: 'resourceTitleString',
+    setextHeading: 'setextHeading',
+    setextHeadingLine: 'setextHeadingLine',
+    setextHeadingLineSequence: 'setextHeadingLineSequence',
+    setextHeadingText: 'setextHeadingText',
+    strong: 'strong',
+    strongSequence: 'strongSequence',
+    strongText: 'strongText',
+    summary: 'summary',
+    summaryMarker: 'summaryMarker',
+    tagName: 'tagName',
+    tagNameIdentifier: 'tagNameIdentifier',
+    tagNameMarker: 'tagNameMarker',
+    thematicBreak: 'thematicBreak',
+    thematicBreakSequence: 'thematicBreakSequence',
+    typeExpression: 'typeExpression',
+    typeExpressionValue: 'typeExpressionValue',
+    typeMetadata: 'typeMetadata',
+    typeMetadataMarker: 'typeMetadataMarker',
+    whitespace: 'whitespace'
+};
+
+export { chars, codes, constants, ct, ev, kind, tt };

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@flex-development/docmark-util-symbol",
+  "description": "",
+  "version": "1.0.0-dev.1",
+  "keywords": [
+    "docmark",
+    "symbol",
+    "typescript",
+    "util",
+    "utility"
+  ],
+  "license": "BSD-3-Clause",
+  "homepage": "https://github.com/flex-development/docmark-util-types/tree/main/packages/flex-development/docmark-util-symbol",
+  "repository": {
+    "directory": "packages/docmark-util-symbol",
+    "type": "git",
+    "url": "git+https://github.com/flex-development/docmark.git"
+  },
+  "bugs": "https://github.com/flex-development/docmark/issues",
+  "author": {
+    "name": "Lexus Drumgold",
+    "url": "https://github.com/unicornware"
+  },
+  "publishConfig": {
+    "access": "public",
+    "diff-dst-prefix": "docmark-util-symbol",
+    "diff-src-prefix": "docmark-util-symbol",
+    "directory": "./",
+    "executableFiles": [],
+    "node-options": null,
+    "pack-destination": ".",
+    "parseable": true,
+    "prefer-dedupe": true,
+    "provenance": true,
+    "tag-version-prefix": "docmark-util-symbol"
+  },
+  "type": "module",
+  "files": [
+    "LICENSE.md",
+    "README.md",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "docmark": "./src/index.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "devDependencies": {
+    "micromark-util-symbol": "2.0.1"
+  },
+  "sideEffects": false,
+  "build": "e5677e85725ab3bf4f4645e3ed427703d91bf9a4"
+}