myst-common - npm Package Compare versions

Comparing version 0.0.12 to 0.0.13

dist/cjs/index.js

@@ -14,3 +14,3 @@ "use strict";
 exports.__esModule = true;
-exports.TemplateOptionType = exports.TemplateKind = exports.extractPart = exports.selectBlockParts = exports.mergeTextNodes = exports.copyNode = exports.setTextAsChild = exports.liftChildren = exports.createHtmlId = exports.normalizeLabel = exports.createId = exports.fileInfo = exports.fileWarn = exports.fileError = exports.toText = void 0;
+exports.ParseTypesEnum = exports.TemplateOptionType = exports.TemplateKind = exports.extractPart = exports.selectBlockParts = exports.mergeTextNodes = exports.copyNode = exports.setTextAsChild = exports.liftChildren = exports.createHtmlId = exports.normalizeLabel = exports.createId = exports.fileInfo = exports.fileWarn = exports.fileError = exports.toText = void 0;
 var utils_1 = require("./utils");
@@ -34,1 +34,3 @@ __createBinding(exports, utils_1, "toText");
 __createBinding(exports, templates_1, "TemplateOptionType");
+var types_1 = require("./types");
+__createBinding(exports, types_1, "ParseTypesEnum");

dist/cjs/types.js

 "use strict";
 exports.__esModule = true;
+exports.ParseTypesEnum = void 0;
+// Types for defining roles and directives
+var ParseTypesEnum;
+(function (ParseTypesEnum) {
+    ParseTypesEnum["string"] = "string";
+    ParseTypesEnum["number"] = "number";
+    ParseTypesEnum["boolean"] = "boolean";
+    ParseTypesEnum["parsed"] = "parsed";
+})(ParseTypesEnum = exports.ParseTypesEnum || (exports.ParseTypesEnum = {}));

dist/esm/index.js

 export { toText, fileError, fileWarn, fileInfo, createId, normalizeLabel, createHtmlId, liftChildren, setTextAsChild, copyNode, mergeTextNodes, } from './utils';
 export { selectBlockParts, extractPart } from './extractParts';
 export { TemplateKind, TemplateOptionType } from './templates';
+export { ParseTypesEnum } from './types';

dist/esm/types.js

@@ -1,1 +0,8 @@
-export {};
+// Types for defining roles and directives
+export var ParseTypesEnum;
+(function (ParseTypesEnum) {
+    ParseTypesEnum["string"] = "string";
+    ParseTypesEnum["number"] = "number";
+    ParseTypesEnum["boolean"] = "boolean";
+    ParseTypesEnum["parsed"] = "parsed";
+})(ParseTypesEnum || (ParseTypesEnum = {}));

dist/types/index.d.ts

 export { toText, fileError, fileWarn, fileInfo, createId, normalizeLabel, createHtmlId, liftChildren, setTextAsChild, copyNode, mergeTextNodes, } from './utils';
 export { selectBlockParts, extractPart } from './extractParts';
 export { TemplateKind, TemplateOptionType } from './templates';
+export { ParseTypesEnum } from './types';
 export type { MessageInfo } from './utils';
-export type { GenericNode, GenericParent, Citations, Footnotes, References } from './types';
+export type { GenericNode, GenericParent, Citations, Footnotes, References, ArgDefinition, DirectiveData, RoleData, DirectiveSpec, RoleSpec, ParseTypes, } from './types';
 //# sourceMappingURL=index.d.ts.map

dist/types/types.d.ts

 import type { Root } from 'mdast';
 import type { FootnoteDefinition, Node } from 'myst-spec';
+import type { VFile } from 'vfile';
 export declare type GenericNode<T extends Record<string, any> = Record<string, any>> = {
@@ -29,2 +30,44 @@ type: string;
 };
+export declare enum ParseTypesEnum {
+    string = "string",
+    number = "number",
+    boolean = "boolean",
+    parsed = "parsed"
+}
+export declare type ParseTypes = string | number | boolean | GenericNode[];
+export declare type ArgDefinition = {
+    type: ParseTypesEnum;
+    required?: boolean;
+    doc?: string;
+};
+declare type BodyDefinition = ArgDefinition;
+declare type OptionDefinition = ArgDefinition;
+export declare type DirectiveData = {
+    name: string;
+    arg?: ParseTypes;
+    options?: Record<string, ParseTypes>;
+    body?: ParseTypes;
+};
+export declare type RoleData = {
+    name: string;
+    body?: ParseTypes;
+};
+export declare type DirectiveSpec = {
+    name: string;
+    alias?: string | string[];
+    doc?: string;
+    arg?: ArgDefinition;
+    options?: Record<string, OptionDefinition>;
+    body?: BodyDefinition;
+    validate?: (data: DirectiveData, vfile: VFile) => DirectiveData;
+    run: (data: DirectiveData, vfile: VFile) => GenericNode[];
+};
+export declare type RoleSpec = {
+    name: string;
+    alias?: string | string[];
+    body?: BodyDefinition;
+    validate?: (data: RoleData, vfile: VFile) => RoleData;
+    run: (data: RoleData, vfile: VFile) => GenericNode[];
+};
+export {};
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "myst-common",
   "sideEffects": false,
-  "version": "0.0.12",
+  "version": "0.0.13",
   "main": "./dist/cjs/index.js",
@@ -6,0 +6,0 @@ "module": "./dist/esm/index.js",

No alert changes

Improved metrics

Total package byte prevSize

28654

increased by14.49%

Lines of code

566

increased by12.52%

No dependency changes