add typescript types

packages/markdown-cicero/index.d.ts

@@ -0,0 +1,32 @@
+export interface CiceroMarkOptions {
+    removeFormatting?: boolean;
+    unquoteVariables?: boolean;
+    [name: string]: unknown;
+}
+
+export declare class CiceroMarkTransformer {
+    constructor();
+    getClauseText(input: unknown): string;
+    getSerializer(): unknown;
+    fromCiceroEdit(input: string): unknown;
+    toCiceroMarkUnwrapped(input: unknown, options?: CiceroMarkOptions): unknown;
+    fromCommonMark(input: unknown): unknown;
+    fromMarkdown(markdown: string): unknown;
+    toMarkdown(input: unknown, options?: CiceroMarkOptions): string;
+    fromMarkdownCicero(markdown: string, options?: CiceroMarkOptions): unknown;
+    toMarkdownCicero(input: unknown): string;
+    toCommonMark(input: unknown, options?: CiceroMarkOptions): unknown;
+    unquote(input: unknown): unknown;
+    toTokens(input: string): unknown;
+    fromTokens(tokenStream: unknown): unknown;
+}
+
+export declare class FromCiceroEditVisitor {
+    constructor(...args: unknown[]);
+}
+
+export declare class ToCommonMarkVisitor {
+    constructor(...args: unknown[]);
+}
+
+export declare const Decorators: Record<string, unknown>;

packages/markdown-cicero/package.json

@@ -10,9 +10,11 @@
     "access": "public"
   },
   "files": [
-    "lib"
+    "lib",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",

packages/markdown-cli/index.d.ts

@@ -0,0 +1 @@
+export {};

packages/markdown-cli/package.json

@@ -15,9 +15,11 @@
   "files": [
     "bin",
     "lib",
-    "umd"
+    "umd",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",

packages/markdown-common/index.d.ts

@@ -0,0 +1,40 @@
+export interface ModelDefinition {
+    MODEL: string;
+    NAMESPACE: string;
+    [name: string]: unknown;
+}
+
+export declare class Stack<T = unknown> {
+    constructor(...args: unknown[]);
+}
+
+export declare const CommonMarkModel: ModelDefinition;
+export declare const CiceroMarkModel: ModelDefinition;
+export declare const ConcertoMetaModel: ModelDefinition;
+export declare const TemplateMarkModel: ModelDefinition;
+
+export declare const CommonMarkUtils: Record<string, unknown>;
+export declare const fromcommonmarkrules: Record<string, unknown>;
+
+export declare class FromCommonMarkVisitor {
+    constructor(...args: unknown[]);
+}
+
+export declare class ToMarkdownVisitor {
+    constructor(...args: unknown[]);
+}
+
+export declare class FromMarkdownIt {
+    constructor(...args: unknown[]);
+    toCommonMark(tokenStream: unknown): unknown;
+}
+
+export declare class CommonMarkTransformer {
+    constructor();
+    toMarkdown(input: unknown): string;
+    removeFormatting(input: unknown): unknown;
+    toTokens(markdown: string): unknown;
+    fromTokens(tokenStream: unknown): unknown;
+    fromMarkdown(markdown: string): unknown;
+    getSerializer(): unknown;
+}

packages/markdown-common/package.json

@@ -10,9 +10,11 @@
     "access": "public"
   },
   "files": [
-    "lib"
+    "lib",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",

packages/markdown-html/index.d.ts

@@ -0,0 +1,13 @@
+export interface HtmlTransformerOptions {
+    [name: string]: unknown;
+}
+
+export declare class HtmlTransformer {
+    constructor(options?: HtmlTransformerOptions);
+    toHtml(input: unknown): string;
+    toCiceroMark(input: string): unknown;
+}
+
+export declare class ToHtmlStringVisitor {
+    constructor(options?: HtmlTransformerOptions);
+}

packages/markdown-html/package.json

@@ -12,9 +12,11 @@
   "files": [
     "bin",
     "lib",
-    "umd"
+    "umd",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "browser": "umd/markdown-html.js",
   "scripts": {
     "webpack": "webpack --config webpack.config.js --mode production",

packages/markdown-it-cicero/index.d.ts

@@ -0,0 +1,24 @@
+export interface MarkdownItLike {
+    inline: {
+        ruler: {
+            before(name: string, ruleName: string, rule: (...args: unknown[]) => unknown): void;
+        };
+    };
+    block: {
+        ruler: {
+            before(
+                name: string,
+                ruleName: string,
+                rule: (...args: unknown[]) => unknown,
+                options?: Record<string, unknown>
+            ): void;
+        };
+    };
+    renderer: {
+        rules: Record<string, (...args: unknown[]) => unknown>;
+    };
+}
+
+declare function ciceroPlugin(md: MarkdownItLike): void;
+
+export = ciceroPlugin;

packages/markdown-it-cicero/package.json

@@ -12,9 +12,11 @@
   "files": [
     "bin",
     "lib",
-    "umd"
+    "umd",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",

packages/markdown-it-template/index.d.ts

@@ -0,0 +1,24 @@
+export interface MarkdownItLike {
+    inline: {
+        ruler: {
+            before(name: string, ruleName: string, rule: (...args: unknown[]) => unknown): void;
+        };
+    };
+    block: {
+        ruler: {
+            before(
+                name: string,
+                ruleName: string,
+                rule: (...args: unknown[]) => unknown,
+                options?: Record<string, unknown>
+            ): void;
+        };
+    };
+    renderer: {
+        rules: Record<string, (...args: unknown[]) => unknown>;
+    };
+}
+
+declare function templatePlugin(md: MarkdownItLike): void;
+
+export = templatePlugin;

packages/markdown-it-template/package.json

@@ -12,9 +12,11 @@
   "files": [
     "bin",
     "lib",
-    "umd"
+    "umd",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",

packages/markdown-template/index.d.ts

@@ -0,0 +1,39 @@
+export interface TemplateInput {
+    fileName?: string;
+    content: string;
+}
+
+export interface TemplateOptions {
+    verbose?: boolean;
+    [name: string]: unknown;
+}
+
+export declare const util: Record<string, unknown>;
+export declare const templatemarkutil: Record<string, unknown>;
+export declare const datetimeutil: Record<string, unknown>;
+
+export declare function normalizeNLs(input: string): string;
+
+export declare class TemplateException extends Error {
+    constructor(message?: string);
+}
+
+export declare class TemplateMarkTransformer {
+    toTokens(templateInput: TemplateInput): unknown;
+    tokensToMarkdownTemplate(
+        tokenStream: unknown,
+        modelManager: unknown,
+        templateKind: string,
+        options?: TemplateOptions,
+        conceptFullyQualifiedName?: string
+    ): unknown;
+    fromMarkdownTemplate(
+        templateInput: TemplateInput,
+        modelManager: unknown,
+        templateKind: string,
+        options?: TemplateOptions,
+        conceptFullyQualifiedName?: string
+    ): unknown;
+    toMarkdownTemplate(input: unknown): string;
+    getSerializer(): unknown;
+}

packages/markdown-template/package.json

@@ -12,9 +12,11 @@
   "files": [
     "bin",
     "lib",
-    "umd"
+    "umd",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "browser": "umd/markdown-template.js",
   "scripts": {
     "webpack": "webpack --config webpack.config.js --mode production",

packages/markdown-transform/index.d.ts

@@ -0,0 +1,74 @@
+export type FileFormat = 'utf8' | 'json' | 'binary' | string;
+
+export interface FormatDescriptor {
+    docs: string;
+    fileFormat: FileFormat;
+    [name: string]: unknown;
+}
+
+export interface TransformParameters {
+    inputFileName?: string;
+    model?: string[];
+    template?: unknown;
+    templateFileName?: string;
+    [name: string]: unknown;
+}
+
+export interface TransformOptions {
+    verbose?: boolean;
+    source?: unknown;
+    [name: string]: unknown;
+}
+
+export type TransformFunction = (
+    input: unknown,
+    parameters?: TransformParameters,
+    options?: TransformOptions
+) => unknown | Promise<unknown>;
+
+export interface TransformExtension {
+    format?: {
+        name: string;
+        docs: string;
+        fileFormat: FileFormat;
+    };
+    transforms?: Record<string, Record<string, TransformFunction>>;
+}
+
+export declare function formatDescriptor(format: string): FormatDescriptor;
+export declare function transform(
+    source: unknown,
+    sourceFormat: string,
+    destinationFormat: string[],
+    parameters?: TransformParameters,
+    options?: TransformOptions
+): Promise<unknown>;
+export declare function generateTransformationDiagram(): string;
+
+export declare const builtinTransformationGraph: Record<string, FormatDescriptor>;
+
+export declare class TransformEngine {
+    constructor(transformationGraph: Record<string, FormatDescriptor>);
+    generateTransformationDiagram(): string;
+    transformToDestination(
+        source: unknown,
+        sourceFormat: string,
+        destinationFormat: string,
+        parameters?: TransformParameters,
+        options?: TransformOptions
+    ): Promise<unknown>;
+    transform(
+        source: unknown,
+        sourceFormat: string,
+        destinationFormat: string[],
+        parameters?: TransformParameters,
+        options?: TransformOptions
+    ): Promise<unknown>;
+    formatDescriptor(format: string): FormatDescriptor;
+    getTransformationGraph(): Record<string, FormatDescriptor>;
+    getAllFormats(): string[];
+    getAllTargetFormats(sourceFormat: string): string[];
+    registerFormat(sourceFormat: string, docs: string, fileFormat: FileFormat): void;
+    registerTransformation(sourceFormat: string, targetFormat: string, transform: TransformFunction): void;
+    registerExtension(extension: TransformExtension): void;
+}

packages/markdown-transform/index.js

@@ -21,5 +21,6 @@
 
 module.exports.formatDescriptor = require('./lib/transform').formatDescriptor;
 module.exports.transform = require('./lib/transform').transform;
+module.exports.generateTransformationDiagram = require('./lib/transform').generateTransformationDiagram;
 module.exports.TransformEngine = require('./lib/transformEngine');
 module.exports.builtinTransformationGraph = require('./lib/builtinTransforms');

packages/markdown-transform/package.json

@@ -12,9 +12,11 @@
   "files": [
     "bin",
     "lib",
-    "umd"
+    "umd",
+    "index.d.ts"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "browser": "umd/markdown-transform.js",
   "scripts": {
     "webpack": "webpack --config webpack.config.js --mode production",