@podlite/schema 0.0.3 → 0.0.7

package/lib/types.d.ts

@@ -0,0 +1,332 @@
+export interface RuleHandler<T = any> {
+    (writer: any, processor: any, tree: PodliteDocument): (node: T, ctx: any, interator: any) => void | AstTree | PodNode;
+}
+export interface Plugin {
+    toAst?: RuleHandler;
+    toAstAfter?: RuleHandler;
+    toHtml?: RuleHandler;
+}
+export interface Plugins {
+    [name: string]: Plugin;
+}
+export interface RulesStrict {
+    'A<>': RuleHandler<FormattingCodeA>;
+    'B<>': RuleHandler<FormattingCodeB>;
+    'C<>': RuleHandler<FormattingCodeC>;
+    'E<>': RuleHandler<FormattingCodeE>;
+    'D<>': RuleHandler<FormattingCodeD>;
+    'I<>': RuleHandler<FormattingCodeI>;
+    'K<>': RuleHandler<FormattingCodeAny>;
+    'R<>': RuleHandler<FormattingCodeAny>;
+    'T<>': RuleHandler<FormattingCodeAny>;
+    'V<>': RuleHandler<FormattingCodeAny>;
+    'N<>': RuleHandler<FormattingCodeN>;
+    'X<>': RuleHandler<FormattingCodeX>;
+    'S<>': RuleHandler<FormattingCodeS>;
+    'L<>': RuleHandler<FormattingCodeL>;
+    'U<>': RuleHandler<FormattingCodeAny>;
+    'Z<>': RuleHandler<FormattingCodeAny>;
+    'pod': RuleHandler<Para>;
+    'root': RuleHandler<RootBlock>;
+    ':para': RuleHandler<Para>;
+    ':text': RuleHandler<Text>;
+    ':blankline': RuleHandler<BlankLine>;
+    ':ambient': RuleHandler<Ambient>;
+    ':code': RuleHandler<Code>;
+    ':verbatim': RuleHandler<Verbatim>;
+    ':list': RuleHandler<List>;
+    ':config': RuleHandler<BlockConfig>;
+    ':alias': RuleHandler<Alias>;
+    'data': RuleHandler<BlockData>;
+    'code': RuleHandler<BlockCode>;
+    'para': RuleHandler<BlockPara>;
+    'defn': RuleHandler<BlockDefn>;
+    'nested': RuleHandler<BlockNested>;
+    'output': RuleHandler<BlockOutput>;
+    'input': RuleHandler<BlockInput>;
+    'image': RuleHandler<BlockImage>;
+    ':image': RuleHandler<Image>;
+    'item:block': RuleHandler<BlockItem>;
+    'item': RuleHandler<BlockItem>;
+    'comment:block': RuleHandler<BlockComment>;
+    'comment': RuleHandler<BlockComment>;
+    'head:block': RuleHandler<BlockHead>;
+    'head': RuleHandler<BlockHead>;
+    ':fcode': RuleHandler<FormattingCodes>;
+    'table:block': RuleHandler<BlockTable>;
+    'table': RuleHandler<BlockTable>;
+    ':separator': RuleHandler<Separator>;
+    'table_row': RuleHandler<TableRow>;
+    'table_cell': RuleHandler<TableCell>;
+    'table_head': RuleHandler<TableHead>;
+    ':toc': RuleHandler<Toc>;
+    ':toc-list': RuleHandler<TocList>;
+    ':toc-item': RuleHandler<TocItem>;
+    'Diagram': RuleHandler<BlockDiagram>;
+    'Image': RuleHandler<BlockNamed>;
+}
+export interface Rules extends RulesStrict {
+    [name: string]: RuleHandler;
+}
+export interface Position {
+    line: number;
+    column: number;
+    offset: number;
+}
+export interface Location {
+    start: Position;
+    end: Position;
+}
+export interface Image {
+    type: 'image';
+    src: string;
+    alt?: string;
+}
+export interface Toc {
+    type: 'toc';
+    title?: string;
+    content: TocList;
+}
+export interface TocList {
+    type: 'toc-list';
+    level: number;
+    content: Array<TocItem | TocList>;
+}
+export interface TocItem {
+    type: 'toc-item';
+    node: PodNode;
+    content: Array<Node>;
+}
+export interface BlockImage extends Omit<Block, 'content'> {
+    name: 'image';
+    caption?: string;
+    link?: string;
+    content: [Image, BlockCaption];
+}
+export interface BlockCaption extends Omit<Block, 'content' | 'location' | 'margin' | 'config' | 'id'> {
+    name: 'caption';
+    content: Array<Node>;
+}
+export interface RootBlock extends Omit<Block, 'location'> {
+    name: 'root';
+    content: AstTree;
+}
+export interface FormattingCodeB {
+    type: "fcode";
+    name: "B";
+    content?: Array<Node>;
+}
+export interface FormattingCodeC {
+    type: "fcode";
+    name: "C";
+    content?: Array<FormattingCodes | string>;
+}
+export interface FormattingCodeE {
+    type: "fcode";
+    name: "E";
+    content: Array<{
+        type: "number";
+        value: number;
+    }>;
+}
+export interface FormattingCodeN {
+    type: "fcode";
+    name: "N";
+    content?: Array<FormattingCodes | string>;
+}
+export interface FormattingCodeX {
+    type: "fcode";
+    name: "X";
+    entry: Array<string> | null;
+    content?: Array<FormattingCodes | string>;
+}
+export interface FormattingCodeZ {
+    type: "fcode";
+    name: "Z";
+    content?: string;
+}
+export interface FormattingCodeV {
+    type: "fcode";
+    name: "V";
+    content?: string;
+}
+export interface FormattingCodeS {
+    type: "fcode";
+    name: "S";
+    content?: string | Text;
+}
+export interface FormattingCodeA {
+    type: "fcode";
+    name: "A";
+    content: string | Text;
+}
+export interface FormattingCodeD {
+    type: "fcode";
+    name: "D";
+    synonyms: Array<string>;
+    content: string;
+}
+export interface FormattingCodeL {
+    type: "fcode";
+    name: "L";
+    meta: string | null;
+    content: string | Text;
+}
+export interface FormattingCodeI {
+    type: "fcode";
+    name: "I";
+    meta: string;
+    content: string | Text;
+}
+export interface FormattingCodeAny {
+    type: "fcode";
+    name: string;
+    content?: Array<FormattingCodes | string>;
+}
+export interface Ambient {
+    type: "ambient";
+    text: string;
+    location: Location;
+}
+export interface Verbatim {
+    type: "verbatim";
+    value: string;
+}
+export interface Text {
+    type: "text";
+    value: string;
+}
+export interface Para {
+    type: "para";
+    text: string;
+    margin: string;
+    location: Location;
+    content: Array<Node | FormattingCodes>;
+}
+export interface Code {
+    type: "code";
+    text: string;
+    margin: string;
+    location: Location;
+    content: Array<Verbatim | string>;
+}
+export interface BlankLine {
+    type: "blankline";
+}
+export interface List {
+    type: "list";
+    level: string | number;
+    content: Array<BlockItem | BlankLine | List>;
+    list: "itemized";
+}
+export interface ConfigItemKV {
+    [key: string]: string | number | boolean;
+}
+export interface BrokenConfigItem extends Omit<ConfigItem, 'type'> {
+}
+export interface ConfigItem {
+    name: string;
+    value: boolean | string | number | Array<string | number | boolean> | ConfigItemKV;
+    type: string;
+}
+export interface BlockConfig {
+    name: string;
+    type: "config";
+    config: Array<ConfigItem>;
+    margin: string;
+}
+export interface Alias {
+    name: string;
+    type: "alias";
+    replacement: Array<string>;
+    margin: string;
+}
+export interface Separator {
+    type: 'separator';
+    text: string;
+}
+export interface Block {
+    type: "block";
+    location: Location;
+    content: Array<Node>;
+    margin: string;
+    config?: Array<ConfigItem | BrokenConfigItem>;
+    id?: string;
+}
+export interface BlockPod extends Block {
+    name: 'pod';
+}
+export interface BlockData extends Block {
+    name: 'data';
+}
+export interface BlockComment extends Block {
+    name: 'comment';
+}
+export interface BlockDefn extends Block {
+    name: 'defn';
+}
+export interface BlockItem extends Block {
+    name: "item";
+    content: Array<Node>;
+    level: string | number;
+}
+export interface BlockOutput extends Block {
+    name: "output";
+}
+export interface BlockInput extends Block {
+    name: "input";
+}
+export interface BlockPara extends Block {
+    name: "para";
+}
+export interface BlockCode extends Block {
+    name: 'code';
+}
+export interface BlockNested extends Block {
+    name: 'nested';
+}
+export interface BlockHead extends Block {
+    name: 'head';
+    level: number | string;
+}
+export interface BlockTable extends Omit<Block, 'content'> {
+    name: "table";
+    content: Array<TableHead | TableSeparator | TableRow | BlankLine>;
+    text?: string;
+}
+export interface TableCell {
+    name: "table_cell";
+    type: "block";
+    content: Array<string>;
+}
+export interface TableRow {
+    name: "table_row";
+    type: "block";
+    content: Array<TableCell>;
+}
+export interface TableHead {
+    name: "table_head";
+    type: "block";
+    content: Array<TableCell>;
+}
+export interface TableSeparator {
+    "type": "separator";
+    "text": string;
+}
+export declare type BlockAny = BlockNamed;
+export interface BlockNamed extends Omit<Block, 'content'> {
+    name: Capitalize<string>;
+    content: [(Verbatim | Para | Code)?] | Array<Image | BlockCaption>;
+}
+export interface BlockDiagram extends Omit<BlockNamed, 'content'> {
+    name: 'Diagram';
+    content: [Verbatim];
+    custom?: {
+        location: Location;
+    };
+}
+export declare type FormattingCodes = FormattingCodeA | FormattingCodeC | FormattingCodeB | FormattingCodeD | FormattingCodeE | FormattingCodeI | FormattingCodeL | FormattingCodeN | FormattingCodeX | FormattingCodeZ | FormattingCodeV | FormattingCodeS | FormattingCodeAny;
+export declare type PodNode = Ambient | BlockPod | BlockData | BlockCode | BlankLine | BlockNested | BlockOutput | BlockInput | BlockPara | BlockHead | BlockComment | BlockDefn | string | Para | Text | Code | BlockNamed | BlockAny | Verbatim | BlockTable | List | BlockConfig | BlockItem | Alias | BlockImage | Image | RootBlock | Separator | BlockCaption | FormattingCodes | Toc;
+export declare type Node = PodNode;
+export declare type AstTree = Array<PodNode>;
+export declare type PodliteDocument = RootBlock;

package/package.json

@@ -1,37 +1,47 @@
 {
   "name": "@podlite/schema",
-  "version": "0.0.3",
+  "version": "0.0.7",
   "description": "podlite schema",
   "main": "index.js",
   "types": "./lib/index.d.ts",
   "license": "MIT",
   "files": [
     "lib/**/*.js",
+    "lib/**/*.d.ts",
     "schema/*",
     "README.md",
     "CHANGELOG.md"
   ],
+  "engines": {
+    "node": ">=14"
+  },
+  "engineStrict": true,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "main": "index.js",
+    "module": "index.js",
+    "types": "./lib/index.d.ts"
   },
   "scripts": {
     "clean": "rm -rf lib tsconfig.tsbuildinfo",
-    "build": "yarn build:ts && yarn build:ast",
+    "build": "run-s build:ts build:ast",
     "build:ast": "ts-node scripts/make-ast-scheme.ts",
-    "build:ts": "tsc",
+    "build:ts": "yarn g:tsc --build $INIT_CWD",
     "watch": "npx nodemon -e js,ts --exec 'yarn' build",
-    "test": "jest"
+    "test": "yarn g:jest  --passWithNoTests"
   },
   "dependencies": {
     "ajv": "^7.2.3",
     "json-pointer": "^0.6.1",
-    "pod6": "0.0.38"
+    "nanoid": "^3.1.30",
+    "pod6": "0.0.43"
   },
   "devDependencies": {
-    "pod6": "*",
+    "@types/node": "^17.0.7",
+    "glob": "^7.2.0",
     "ts-node": "^9.1.1",
-    "typescript": "4.2.3",
-    "typescript-json-schema": "^0.50.0"
+    "typescript": "4.5.4",
+    "typescript-json-schema": "0.53.0"
   },
-  "gitHead": "658ca02b7366520f9516d86249622bc47f60a620"
-}
+  "module": "index.js"
+}