@gmb/bitmark-parser-generator 3.37.0 → 4.0.0

package/dist/index.d.cts

@@ -2175,6 +2175,7 @@ interface ResourceWrapperJson {
     type: ResourceTypeType;
     __typeAlias: ResourceTypeType;
     __configKey: ConfigKeyType;
+    __invalid?: boolean;
 }
 interface ImageResourceWrapperJson extends ResourceWrapperJson {
     type: 'image';
@@ -7521,7 +7522,7 @@ declare class BitmarkParserGenerator {
     /**
      * Generate the new configuration for the bitmark parser.
      */
-    generateConfig(options?: GenerateConfigOptions): Promise<unknown>;
+    generateConfig(options?: GenerateConfigOptions): void;
     /**
      * Convert bitmark from bitmark to JSON, or JSON to bitmark.
      *
@@ -7544,11 +7545,11 @@ declare class BitmarkParserGenerator {
      * @param input - bitmark or JSON or AST as a string, JSON or AST as plain JS object, or path to a file containing
      * bitmark, JSON, or AST.
      * @param options - the conversion options
-     * @returns Promise that resolves to string if converting to bitmark, a plain JS object if converting to JSON, or
+     * @returns A string if converting to bitmark, a plain JS object if converting to JSON, or
      * void if writing to a file
      * @throws Error if any error occurs
      */
-    convert(input: string | fs.PathLike | unknown, options?: ConvertOptions): Promise<string | unknown | void>;
+    convert(input: string | fs.PathLike | unknown, options?: ConvertOptions): string | unknown | void;
     /**
      * Upgrade bitmark or JSON, upgrading to the latest supported syntax, removing unrecognised data in the process.
      *
@@ -7574,7 +7575,7 @@ declare class BitmarkParserGenerator {
      * void if writing to a file
      * @throws Error if any error occurs
      */
-    upgrade(input: string | fs.PathLike | unknown, options?: UpgradeOptions): Promise<string | unknown | void>;
+    upgrade(input: string | fs.PathLike | unknown, options?: UpgradeOptions): string | unknown | void;
     /**
      * Create a bitmark AST (Abstract Syntax Tree) from bitmark or JSON or AST
      *
@@ -7609,7 +7610,7 @@ declare class BitmarkParserGenerator {
      * void if writing to a file
      * @throws Error if any error occurs
      */
-    convertText(input: string | fs.PathLike | unknown, options?: ConvertTextOptions): Promise<string | unknown | void>;
+    convertText(input: string | fs.PathLike | unknown, options?: ConvertTextOptions): string | unknown | void;
     /**
      * Breakscape bitmark text.
      *
@@ -7733,12 +7734,20 @@ interface BitmarkFileGeneratorOptions extends BitmarkGeneratorOptions {
      * The options for file output.
      */
     fileOptions?: FileOptions;
+    /**
+     * If true, the file will be generated asynchronously - generateSync() will throw an error.
+     * If false, the file will be generated synchronously.
+     *
+     * Defaults to false.
+     */
+    async?: boolean;
 }
 /**
  * Generate bitmark markup from a bitmark AST as a file
  */
 declare class BitmarkFileGenerator implements Generator<BitmarkAst> {
     private generator;
+    private async;
     /**
      * Generate bitmark markup from a bitmark AST as a file
      *
@@ -7757,7 +7766,7 @@ declare class BitmarkFileGenerator implements Generator<BitmarkAst> {
      *
      * @param ast bitmark AST
      */
-    generateSync(_ast: BitmarkAst): string;
+    generateSync(_ast: BitmarkAst): void;
 }
 
 /**
@@ -7768,14 +7777,21 @@ interface JsonFileGeneratorOptions extends JsonGeneratorOptions {
      * The options for file output.
      */
     fileOptions?: FileOptions;
+    /**
+     * If true, the file will be generated asynchronously - generateSync() will throw an error.
+     * If false, the file will be generated synchronously.
+     *
+     * Defaults to false.
+     */
+    async?: boolean;
 }
 /**
  * Generate bitmark JSON from a bitmark AST as a file
  *
- * TODO: NOT IMPLEMENTED!
  */
 declare class JsonFileGenerator implements Generator<BitmarkAst> {
     private generator;
+    private async;
     /**
      * Generate bitmark JSON from a bitmark AST as a file
      *
@@ -7796,7 +7812,7 @@ declare class JsonFileGenerator implements Generator<BitmarkAst> {
      *
      * @param ast bitmark AST
      */
-    generateSync(_ast: BitmarkAst): string;
+    generateSync(_ast: BitmarkAst): void;
 }
 
 export { type AppLinkResourceJson, type AppLinkResourceWrapperJson, type ArticleResourceJson, type ArticleResourceWrapperJson, Ast, type AstWalkCallbacks, type AudioEmbedResourceJson, type AudioEmbedResourceWrapperJson, type AudioLinkResourceJson, type AudioLinkResourceWrapperJson, type AudioResourceJson, type AudioResourceWrapperJson, type Bit, type BitJson, BitType, type BitTypeType, type BitWrapperJson, type BitmarkAst, BitmarkFileGenerator, BitmarkGenerator, type BitmarkOptions, BitmarkParser, BitmarkParserGenerator, BitmarkParserType, type BitmarkParserTypeType, BitmarkStringGenerator, BitmarkVersion, type BitmarkVersionType, type Body, type BodyBitJson, type BodyBitsJson, type BodyPart, BodyTextFormat, type BodyTextFormatType, type BookJson, type BookReferenceJson, type BotResponseJson, type BreakscapeOptions, type BreakscapedString, Builder, type CardBit, type CardNode, CardSetVersion, type CardSetVersionType, type ChoiceJson, type ConvertOptions, type ConvertTextOptions, type CreateAstOptions, type DefinitionListItemJson, type DocumentDownloadResourceJson, type DocumentDownloadResourceWrapperJson, type DocumentEmbedResourceJson, type DocumentEmbedResourceWrapperJson, type DocumentLinkResourceJson, type DocumentLinkResourceWrapperJson, type DocumentResourceJson, type DocumentResourceWrapperJson, type Example, type ExampleJson, type ExtraProperties, type FeedbackChoiceJson, type FeedbackJson, type FeedbackReasonJson, type FileOptions, FileWriter, type FlashcardJson, type Footer, type GapJson, type Generator, type HeadingJson, type HighlightJson, type HighlightTextJson, type ImageLinkResourceJson, type ImageLinkResourceWrapperJson, type ImageResourceJson, type ImageResourceWrapperJson, type ImageSourceJson, InfoFormat, type InfoFormatType, type InfoOptions, InfoType, type InfoTypeType, type IngredientJson, Input, type InputType, JsonFileGenerator, JsonGenerator, type JsonOptions, JsonParser, JsonStringGenerator, type ListItemJson, type MarkConfigJson, type MarkJson, type MatrixCellJson, type MatrixJson, type Node, type NodeInfo, NodeType, type NodeTypeType, Output, type OutputType, type PairJson, type ParserJson, type PersonJson, type UpgradeOptions as PrettifyOptions, type PronunciationTableCellJson, type PronunciationTableJson, type Property, type QuestionJson, type QuizJson, type RatingLevelStartEndJson, ResourceBuilder, type ResourceDataJson, type ResourceJson, type ResourceWrapperJson, type ResponseJson, type SelectJson, type SelectOptionJson, type ServingsJson, type StatementJson, type StillImageFilmEmbedResourceJson, type StillImageFilmEmbedResourceWrapperJson, type StillImageFilmLinkResourceJson, type StillImageFilmLinkResourceWrapperJson, type StillImageFilmResourceJson, type StillImageFilmResourceWrapperJson, StreamWriter, StringWriter, type TableJson, type TechnicalTermJson, type JsonText as Text, type TextAndIconJson, type TextAst, type TextJsonOptions, type UnbreakscapeOptions, type UpgradeOptions, type VideoEmbedResourceJson, type VideoEmbedResourceWrapperJson, type VideoLinkResourceJson, type VideoLinkResourceWrapperJson, type VideoResourceJson, type VideoResourceWrapperJson, type WebsiteLinkResourceJson, type WebsiteLinkResourceWrapperJson, type Writer, parse as bitmarkTextParse };

package/dist/index.d.ts

@@ -2175,6 +2175,7 @@ interface ResourceWrapperJson {
     type: ResourceTypeType;
     __typeAlias: ResourceTypeType;
     __configKey: ConfigKeyType;
+    __invalid?: boolean;
 }
 interface ImageResourceWrapperJson extends ResourceWrapperJson {
     type: 'image';
@@ -7521,7 +7522,7 @@ declare class BitmarkParserGenerator {
     /**
      * Generate the new configuration for the bitmark parser.
      */
-    generateConfig(options?: GenerateConfigOptions): Promise<unknown>;
+    generateConfig(options?: GenerateConfigOptions): void;
     /**
      * Convert bitmark from bitmark to JSON, or JSON to bitmark.
      *
@@ -7544,11 +7545,11 @@ declare class BitmarkParserGenerator {
      * @param input - bitmark or JSON or AST as a string, JSON or AST as plain JS object, or path to a file containing
      * bitmark, JSON, or AST.
      * @param options - the conversion options
-     * @returns Promise that resolves to string if converting to bitmark, a plain JS object if converting to JSON, or
+     * @returns A string if converting to bitmark, a plain JS object if converting to JSON, or
      * void if writing to a file
      * @throws Error if any error occurs
      */
-    convert(input: string | fs.PathLike | unknown, options?: ConvertOptions): Promise<string | unknown | void>;
+    convert(input: string | fs.PathLike | unknown, options?: ConvertOptions): string | unknown | void;
     /**
      * Upgrade bitmark or JSON, upgrading to the latest supported syntax, removing unrecognised data in the process.
      *
@@ -7574,7 +7575,7 @@ declare class BitmarkParserGenerator {
      * void if writing to a file
      * @throws Error if any error occurs
      */
-    upgrade(input: string | fs.PathLike | unknown, options?: UpgradeOptions): Promise<string | unknown | void>;
+    upgrade(input: string | fs.PathLike | unknown, options?: UpgradeOptions): string | unknown | void;
     /**
      * Create a bitmark AST (Abstract Syntax Tree) from bitmark or JSON or AST
      *
@@ -7609,7 +7610,7 @@ declare class BitmarkParserGenerator {
      * void if writing to a file
      * @throws Error if any error occurs
      */
-    convertText(input: string | fs.PathLike | unknown, options?: ConvertTextOptions): Promise<string | unknown | void>;
+    convertText(input: string | fs.PathLike | unknown, options?: ConvertTextOptions): string | unknown | void;
     /**
      * Breakscape bitmark text.
      *
@@ -7733,12 +7734,20 @@ interface BitmarkFileGeneratorOptions extends BitmarkGeneratorOptions {
      * The options for file output.
      */
     fileOptions?: FileOptions;
+    /**
+     * If true, the file will be generated asynchronously - generateSync() will throw an error.
+     * If false, the file will be generated synchronously.
+     *
+     * Defaults to false.
+     */
+    async?: boolean;
 }
 /**
  * Generate bitmark markup from a bitmark AST as a file
  */
 declare class BitmarkFileGenerator implements Generator<BitmarkAst> {
     private generator;
+    private async;
     /**
      * Generate bitmark markup from a bitmark AST as a file
      *
@@ -7757,7 +7766,7 @@ declare class BitmarkFileGenerator implements Generator<BitmarkAst> {
      *
      * @param ast bitmark AST
      */
-    generateSync(_ast: BitmarkAst): string;
+    generateSync(_ast: BitmarkAst): void;
 }
 
 /**
@@ -7768,14 +7777,21 @@ interface JsonFileGeneratorOptions extends JsonGeneratorOptions {
      * The options for file output.
      */
     fileOptions?: FileOptions;
+    /**
+     * If true, the file will be generated asynchronously - generateSync() will throw an error.
+     * If false, the file will be generated synchronously.
+     *
+     * Defaults to false.
+     */
+    async?: boolean;
 }
 /**
  * Generate bitmark JSON from a bitmark AST as a file
  *
- * TODO: NOT IMPLEMENTED!
  */
 declare class JsonFileGenerator implements Generator<BitmarkAst> {
     private generator;
+    private async;
     /**
      * Generate bitmark JSON from a bitmark AST as a file
      *
@@ -7796,7 +7812,7 @@ declare class JsonFileGenerator implements Generator<BitmarkAst> {
      *
      * @param ast bitmark AST
      */
-    generateSync(_ast: BitmarkAst): string;
+    generateSync(_ast: BitmarkAst): void;
 }
 
 export { type AppLinkResourceJson, type AppLinkResourceWrapperJson, type ArticleResourceJson, type ArticleResourceWrapperJson, Ast, type AstWalkCallbacks, type AudioEmbedResourceJson, type AudioEmbedResourceWrapperJson, type AudioLinkResourceJson, type AudioLinkResourceWrapperJson, type AudioResourceJson, type AudioResourceWrapperJson, type Bit, type BitJson, BitType, type BitTypeType, type BitWrapperJson, type BitmarkAst, BitmarkFileGenerator, BitmarkGenerator, type BitmarkOptions, BitmarkParser, BitmarkParserGenerator, BitmarkParserType, type BitmarkParserTypeType, BitmarkStringGenerator, BitmarkVersion, type BitmarkVersionType, type Body, type BodyBitJson, type BodyBitsJson, type BodyPart, BodyTextFormat, type BodyTextFormatType, type BookJson, type BookReferenceJson, type BotResponseJson, type BreakscapeOptions, type BreakscapedString, Builder, type CardBit, type CardNode, CardSetVersion, type CardSetVersionType, type ChoiceJson, type ConvertOptions, type ConvertTextOptions, type CreateAstOptions, type DefinitionListItemJson, type DocumentDownloadResourceJson, type DocumentDownloadResourceWrapperJson, type DocumentEmbedResourceJson, type DocumentEmbedResourceWrapperJson, type DocumentLinkResourceJson, type DocumentLinkResourceWrapperJson, type DocumentResourceJson, type DocumentResourceWrapperJson, type Example, type ExampleJson, type ExtraProperties, type FeedbackChoiceJson, type FeedbackJson, type FeedbackReasonJson, type FileOptions, FileWriter, type FlashcardJson, type Footer, type GapJson, type Generator, type HeadingJson, type HighlightJson, type HighlightTextJson, type ImageLinkResourceJson, type ImageLinkResourceWrapperJson, type ImageResourceJson, type ImageResourceWrapperJson, type ImageSourceJson, InfoFormat, type InfoFormatType, type InfoOptions, InfoType, type InfoTypeType, type IngredientJson, Input, type InputType, JsonFileGenerator, JsonGenerator, type JsonOptions, JsonParser, JsonStringGenerator, type ListItemJson, type MarkConfigJson, type MarkJson, type MatrixCellJson, type MatrixJson, type Node, type NodeInfo, NodeType, type NodeTypeType, Output, type OutputType, type PairJson, type ParserJson, type PersonJson, type UpgradeOptions as PrettifyOptions, type PronunciationTableCellJson, type PronunciationTableJson, type Property, type QuestionJson, type QuizJson, type RatingLevelStartEndJson, ResourceBuilder, type ResourceDataJson, type ResourceJson, type ResourceWrapperJson, type ResponseJson, type SelectJson, type SelectOptionJson, type ServingsJson, type StatementJson, type StillImageFilmEmbedResourceJson, type StillImageFilmEmbedResourceWrapperJson, type StillImageFilmLinkResourceJson, type StillImageFilmLinkResourceWrapperJson, type StillImageFilmResourceJson, type StillImageFilmResourceWrapperJson, StreamWriter, StringWriter, type TableJson, type TechnicalTermJson, type JsonText as Text, type TextAndIconJson, type TextAst, type TextJsonOptions, type UnbreakscapeOptions, type UpgradeOptions, type VideoEmbedResourceJson, type VideoEmbedResourceWrapperJson, type VideoLinkResourceJson, type VideoLinkResourceWrapperJson, type VideoResourceJson, type VideoResourceWrapperJson, type WebsiteLinkResourceJson, type WebsiteLinkResourceWrapperJson, type Writer, parse as bitmarkTextParse };