@gmb/bitmark-parser-generator 5.38.0 → 5.40.0

package/dist/browser/esm/index.d.ts

@@ -1,10 +1,12 @@
 import { EnumType } from '@ncoderz/superenum';
+import { T as TranslationsData } from './TranslationsData-BZ_sE10e.js';
 import { PathLike } from 'node:fs';
 
 declare const BitType: {
     readonly _error: "_error";
     readonly _comment: "_comment";
     readonly _standard: "_standard";
+    readonly _standardLight: "_standard-light";
     readonly advertising: "advertising";
     readonly advertisingAdvertorial: "advertising-advertorial";
     readonly advertisingAdvertorialPage: "advertising-advertorial-page";
@@ -292,6 +294,7 @@ declare const BitType: {
     readonly handInSystemMedia: "hand-in-system-media";
     readonly handInVideo: "hand-in-video";
     readonly handInVoice: "hand-in-voice";
+    readonly h: "h";
     readonly help: "help";
     readonly helpAlt: "help-alt";
     readonly highlightText: "highlight-text";
@@ -377,6 +380,7 @@ declare const BitType: {
     readonly leWatchVideoEmbed: "le-watch-video-embed";
     readonly lifeSkillSticker: "life-skill-sticker";
     readonly list: "list";
+    readonly listAlt: "list-alt";
     readonly listItem: "list-item";
     readonly mark: "mark";
     readonly match: "match";
@@ -407,6 +411,8 @@ declare const BitType: {
     readonly notebookArticle: "notebook-article";
     readonly noteCollapsible: "note-collapsible";
     readonly output: "output";
+    readonly p: "p";
+    readonly pAlt: "p-alt";
     readonly page: "page";
     readonly pageAcademy: "page-academy";
     readonly pageArticle: "page-article";
@@ -529,6 +535,7 @@ declare const BitType: {
     readonly smartStandardNoteNonNormativeCollapsible: "smart-standard-note-non-normative-collapsible";
     readonly smartStandardNoteNormative: "smart-standard-note-normative";
     readonly smartStandardNoteNormativeCollapsible: "smart-standard-note-normative-collapsible";
+    readonly smartStandardP: "smart-standard-p";
     readonly smartStandardRemarkLegend: "smart-standard-remark-legend";
     readonly smartStandardRemarkLegendNonNormative: "smart-standard-remark-legend-non-normative";
     readonly smartStandardRemarkLegendNormative: "smart-standard-remark-legend-normative";
@@ -707,6 +714,8 @@ type BitTagConfigKeyTypeType = EnumType<typeof BitTagConfigKeyType>;
 declare const ConfigKey: {
     readonly group_accessibilityDecorative: "group_accessibilityDecorative";
     readonly group_standardAllBits: "group_standardAllBits";
+    readonly group_standardExample: "group_standardExample";
+    readonly group_standardItem: "group_standardItem";
     readonly group_standardItemLead: "group_standardItemLead";
     readonly group_standardItemLeadInstructionHint: "group_standardItemLeadInstructionHint";
     readonly group_standardInstructionHint: "group_standardInstructionHint";
@@ -3564,6 +3573,68 @@ declare class Ast {
     private isValue;
 }
 
+/**
+ * PLAN-020: Bit group keys.
+ *
+ * Bit groups are search/filter categories over bit types (a bit type can belong to several
+ * groups). The keys are adopted verbatim from the historical book-service `bit-types.js`
+ * lists so that existing `g=<key>` search queries keep working; renames are handled via the
+ * `aliases` field on the registry entries in `config/raw/bitGroups.ts`, never by changing a
+ * key.
+ *
+ * Not to be confused with tag groups (`GroupConfigType` / `config/raw/groups.ts`), which
+ * group tags for config reuse. See PLAN-020.
+ */
+declare const BitGroup: {
+    readonly assignment: "assignment";
+    readonly authors: "authors";
+    readonly botAction: "bot-action";
+    readonly bots: "bots";
+    readonly chat: "chat";
+    readonly cloze: "cloze";
+    readonly conversation: "conversation";
+    readonly cooking: "cooking";
+    readonly correction: "correction";
+    readonly documentUpload: "document-upload";
+    readonly essay: "essay";
+    readonly extractor: "extractor";
+    readonly flashcard: "flashcard";
+    readonly group: "group";
+    readonly highlightText: "highlight-text";
+    readonly interview: "interview";
+    readonly learningPath: "learning-path";
+    readonly mark: "mark";
+    readonly match: "match";
+    readonly message: "message";
+    readonly multipleChoice: "multiple-choice";
+    readonly multipleResponse: "multiple-response";
+    readonly nonProduction: "non-production";
+    readonly other: "other";
+    readonly pages: "pages";
+    readonly preparationNote: "preparation-note";
+    readonly quizzes: "quizzes";
+    readonly rating: "rating";
+    readonly recipes: "recipes";
+    readonly recordAudio: "record-audio";
+    readonly reviewErrors: "review-errors";
+    readonly reviews: "reviews";
+    readonly selfAssessment: "self-assessment";
+    readonly sequence: "sequence";
+    readonly set: "set";
+    readonly static: "static";
+    readonly steps: "steps";
+    readonly survey: "survey";
+    readonly surveyAnonymous: "survey-anonymous";
+    readonly surveys: "surveys";
+    readonly tables: "tables";
+    readonly takePicture: "take-picture";
+    readonly trueFalse: "true-false";
+    readonly vocabulary: "vocabulary";
+    readonly warning: "warning";
+    readonly whiteLabel: "white-label";
+};
+type BitGroupType = EnumType<typeof BitGroup>;
+
 declare const ExampleType: {
     readonly none: "none";
     readonly string: "string";
@@ -3601,7 +3672,7 @@ declare const TagFormat: {
     readonly boolean: "boolean";
     readonly invertedBoolean: "invertedBoolean";
     readonly enumeration: "enumeration";
-    readonly coordinates: "coordinates";
+    readonly numberList4: "numberList4";
 };
 type TagFormatType = EnumType<typeof TagFormat>;
 
@@ -3846,6 +3917,8 @@ interface ToStringOptions {
 declare class BitConfig {
     readonly since: string;
     readonly bitType: BitTypeType;
+    readonly title?: string;
+    readonly bitGroups: BitGroupType[];
     readonly inheritedBitTypes: BitTypeType[];
     readonly inheritedBitTypesSet: Set<BitTypeType>;
     readonly textFormatDefault: TextFormatType;
@@ -3863,6 +3936,8 @@ declare class BitConfig {
     constructor(config: {
         since: string;
         bitType: BitTypeType;
+        title: string | undefined;
+        bitGroups: BitGroupType[];
         inheritedBitTypes: BitTypeType[];
         textFormatDefault: TextFormatType;
         tags: TagsConfig;
@@ -6454,6 +6529,73 @@ declare class JsonGenerator extends AstWalkerGenerator<BitmarkAst, void> {
     writeWhiteSpace(): this;
 }
 
+/**
+ * PLAN-020: Resource group keys.
+ *
+ * Resource groups are search/filter categories over {@link ResourceType} values (canonical
+ * kebab-case values only — consumers normalize legacy camelCase spellings such as
+ * `imageLink` before matching). Keys are adopted verbatim from the historical book-service
+ * `bit-types.js` `resourceTypes` map.
+ */
+declare const ResourceGroup: {
+    readonly app: "app";
+    readonly article: "article";
+    readonly audio: "audio";
+    readonly document: "document";
+    readonly image: "image";
+    readonly stillImageFilm: "still-image-film";
+    readonly video: "video";
+    readonly website: "website";
+};
+type ResourceGroupType = EnumType<typeof ResourceGroup>;
+
+interface SupportedBitsOptions {
+    includeNonDeprecated?: boolean;
+    includeDeprecated?: boolean;
+}
+interface SupportedBit {
+    name: BitTypeType;
+    title?: string;
+    since: string;
+    deprecated?: string;
+    inheritedBitTypes?: BitTypeType[];
+    bitGroups?: BitGroupType[];
+}
+/**
+ * PLAN-020: Options for bit-group / resource-group queries.
+ */
+interface BitGroupsOptions {
+    language?: string;
+    subgroupOf?: BitGroupType | string;
+    includeDeprecated?: boolean;
+}
+interface ResourceGroupsOptions {
+    language?: string;
+}
+/**
+ * PLAN-020: A bit group with its resolved member bit types.
+ */
+interface BitGroupInfo {
+    key: BitGroupType;
+    aliases?: string[];
+    description: string;
+    title: string;
+    subgroupOf?: BitGroupType;
+    since: string;
+    bitTypes: BitTypeType[];
+}
+/**
+ * PLAN-020: A resource group with its member resource types (canonical values only).
+ */
+interface ResourceGroupInfo {
+    key: ResourceGroupType;
+    aliases?: string[];
+    description: string;
+    title: string;
+    since: string;
+    resourceTypes: ResourceTypeType[];
+}
+
 declare const BitmarkParserType: {
     readonly peggy: "peggy";
 };
@@ -6471,6 +6613,8 @@ declare const InfoType: {
     readonly deprecated: "deprecated";
     readonly all: "all";
     readonly bit: "bit";
+    readonly bitGroups: "bitGroups";
+    readonly resourceGroups: "resourceGroups";
 };
 type InfoTypeType = EnumType<typeof InfoType>;
 
@@ -6698,6 +6842,8 @@ interface InfoOptions {
      * - deprecated: list of deprecated bits
      * - all: list of supported bits and deprecated bits
      * - bit: configuration for a specific bit, or all bits
+     * - bitGroups: all bit groups with their member bit types (PLAN-020)
+     * - resourceGroups: all resource groups with their member resource types (PLAN-020)
      */
     type?: InfoTypeType;
     /**
@@ -7067,6 +7213,77 @@ declare class BitmarkParserGenerator {
      * Get information about the bitmark-parser-generator library
      */
     info(options?: InfoOptions): unknown;
+    /**
+     * PLAN-020: Register translated display names for bit types, bit groups, and resource
+     * groups.
+     *
+     * The data is provided by the `./translations` subpath export (kept out of the main
+     * bundle for size). Without registration, all name lookups fall back to the inline
+     * English titles / technical keys.
+     *
+     * ```ts
+     * import { TRANSLATIONS } from '@gmb/bitmark-parser-generator/translations';
+     * bpg.registerTranslations(TRANSLATIONS);
+     * ```
+     */
+    registerTranslations(data: TranslationsData): void;
+    /**
+     * PLAN-020: Get all known bit groups, each with its aliases, description, resolved
+     * title, subgroupOf metadata, and member bit types.
+     *
+     * @param options language (title resolution), subgroupOf (filter, e.g. 'quizzes' for
+     *        quiz categories), includeDeprecated (default: true)
+     */
+    getBitGroups(options?: BitGroupsOptions): BitGroupInfo[];
+    /**
+     * PLAN-020: Get all known resource groups, each with its member resource types
+     * (canonical kebab-case values only).
+     */
+    getResourceGroups(options?: ResourceGroupsOptions): ResourceGroupInfo[];
+    /**
+     * PLAN-020: Get all bit types belonging to one or more bit groups (union, deduped,
+     * sorted). Serves search queries such as `g=cloze&g=table`. Inputs may be canonical
+     * keys or aliases; unknown inputs are ignored.
+     *
+     * @param options includeDeprecated: include deprecated bit types (default: true —
+     *        stored legacy content must still be found by search)
+     */
+    getBitTypesForBitGroups(bitGroups: (BitGroupType | string)[], options?: {
+        includeDeprecated?: boolean;
+    }): BitTypeType[];
+    /**
+     * PLAN-020: Get the bit groups that one or more bit types belong to, with resolved
+     * titles and members. Unknown bit types are ignored.
+     */
+    getBitGroupsForBitTypes(bitTypes: (BitTypeType | string)[], options?: BitGroupsOptions): BitGroupInfo[];
+    /**
+     * PLAN-020: Get the resource types belonging to one or more resource groups (union,
+     * deduped, sorted; canonical kebab-case values only — normalize legacy camelCase
+     * spellings such as `imageLink` before matching).
+     */
+    getResourceTypesForResourceGroups(resourceGroups: (ResourceGroupType | string)[]): ResourceTypeType[];
+    /**
+     * PLAN-020: Get the resource groups that one or more resource types belong to.
+     */
+    getResourceGroupsForResourceTypes(resourceTypes: (ResourceTypeType | string)[]): ResourceGroupType[];
+    /**
+     * PLAN-020: Get the translated display name of a bit type.
+     *
+     * Fallback chain: requested BCP-47 tag (progressively stripping subtags:
+     * `de-CH` → `de`) → English title → technical key. Non-English languages require
+     * {@link registerTranslations}.
+     */
+    getBitTitle(bitType: BitTypeType | string, language?: string): string;
+    /**
+     * PLAN-020: Get the translated display name of a bit group (key or alias accepted).
+     * Fallback chain as {@link getBitTitle}.
+     */
+    getBitGroupTitle(bitGroup: BitGroupType | string, language?: string): string;
+    /**
+     * PLAN-020: Get the translated display name of a resource group (key or alias
+     * accepted). Fallback chain as {@link getBitTitle}.
+     */
+    getResourceGroupTitle(resourceGroup: ResourceGroupType | string, language?: string): string;
     /**
      * Generate the new configuration for the bitmark parser.
      */
@@ -7488,4 +7705,4 @@ declare class HtmlTableGenerator {
     private escapeAttr;
 }
 
-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 Bbox, 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 BoundingBoxEntry, BoundingBoxIndex, type BreakscapeOptions, type BreakscapedString, Builder, type CardBit, type CardNode, CardSetVersion, type CardSetVersionType, type ChoiceJson, type CodeBlockTextNode, type CodeBlockTextNodeAttributes, type CommentMark, type ConvertHtmlTableOptions, 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 ExtRefMark, type ExtRefMarkAttibutes, type ExtraProperties, type FeedbackChoiceJson, type FeedbackJson, type FeedbackReasonJson, type FileOptions, FileWriter, type FlashcardJson, type Footer, type FootnoteAttibutes, type FootnoteMark, type FromBitsOptions, type GapJson, type Generator, type GroupTagJson, type HeadingJson, type HeadingTextNode, type HeadingTextNodeAttributes, type HighlightJson, type HighlightTextJson, type HtmlTableFormat, HtmlTableGenerator, type HtmlTableParseOptions, HtmlTableParser, type ImageInlineTextNode, type ImageLinkResourceJson, type ImageLinkResourceWrapperJson, type ImageResourceJson, type ImageResourceWrapperJson, type ImageSourceJson, type ImageTextNode, type ImageTextNodeAttributes, InfoFormat, type InfoFormatType, type InfoOptions, InfoType, type InfoTypeType, type IngredientJson, Input, InputFormat, type InputFormatType, type InputType, JsonFileGenerator, JsonGenerator, type JsonOptions, JsonParser, JsonStringGenerator, type LatexTextNode, type LatexTextNodeAttributes, type LinkMark, type LinkMarkAttibutes, type ListItemJson, type ListTextNode, type ListTextNodeAttributes, type MarkConfigJson, type MarkJson, type MatrixCellJson, type MatrixJson, type MediaAttributes, 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, type RefMark, type RefMarkAttibutes, ResourceBuilder, type ResourceDataJson, type ResourceJson, type ResourceTypeType, type ResourceWrapperJson, type ResponseJson, type SectionTextNode, type SelectJson, type SelectOptionJson, type ServingsJson, type StatementJson, type StillImageFilmEmbedResourceJson, type StillImageFilmEmbedResourceWrapperJson, type StillImageFilmLinkResourceJson, type StillImageFilmLinkResourceWrapperJson, type StillImageFilmResourceJson, type StillImageFilmResourceWrapperJson, StreamWriter, StringWriter, type SymbolMark, type TableCellJson, type TableExtendedJson, type TableJson, type TableRowJson, type TableSectionJson, type TaskItemTextNode, type TaskItemTextNodeAttributes, type TechnicalTermJson, type JsonText as Text, type TextAndIconJson, type TextAst, type TextJsonOptions, type TextMark, type TextMarkAttibutes, TextMarkType, type TextMarkTypeType, type TextNode, type TextNodeAttibutes, TextNodeType, type TextNodeTypeType, type UnbreakscapeOptions, type UpgradeOptions, type VideoEmbedResourceJson, type VideoEmbedResourceWrapperJson, type VideoLinkResourceJson, type VideoLinkResourceWrapperJson, type VideoResourceJson, type VideoResourceWrapperJson, type WebsiteLinkResourceJson, type WebsiteLinkResourceWrapperJson, type Writer, type XRefMark, type XRefMarkAttibutes, parse as bitmarkTextParse };
+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 Bbox, type Bit, BitGroup, type BitGroupInfo, type BitGroupType, type BitGroupsOptions, 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 BoundingBoxEntry, BoundingBoxIndex, type BreakscapeOptions, type BreakscapedString, Builder, type CardBit, type CardNode, CardSetVersion, type CardSetVersionType, type ChoiceJson, type CodeBlockTextNode, type CodeBlockTextNodeAttributes, type CommentMark, type ConvertHtmlTableOptions, 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 ExtRefMark, type ExtRefMarkAttibutes, type ExtraProperties, type FeedbackChoiceJson, type FeedbackJson, type FeedbackReasonJson, type FileOptions, FileWriter, type FlashcardJson, type Footer, type FootnoteAttibutes, type FootnoteMark, type FromBitsOptions, type GapJson, type Generator, type GroupTagJson, type HeadingJson, type HeadingTextNode, type HeadingTextNodeAttributes, type HighlightJson, type HighlightTextJson, type HtmlTableFormat, HtmlTableGenerator, type HtmlTableParseOptions, HtmlTableParser, type ImageInlineTextNode, type ImageLinkResourceJson, type ImageLinkResourceWrapperJson, type ImageResourceJson, type ImageResourceWrapperJson, type ImageSourceJson, type ImageTextNode, type ImageTextNodeAttributes, InfoFormat, type InfoFormatType, type InfoOptions, InfoType, type InfoTypeType, type IngredientJson, Input, InputFormat, type InputFormatType, type InputType, JsonFileGenerator, JsonGenerator, type JsonOptions, JsonParser, JsonStringGenerator, type LatexTextNode, type LatexTextNodeAttributes, type LinkMark, type LinkMarkAttibutes, type ListItemJson, type ListTextNode, type ListTextNodeAttributes, type MarkConfigJson, type MarkJson, type MatrixCellJson, type MatrixJson, type MediaAttributes, 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, type RefMark, type RefMarkAttibutes, ResourceBuilder, type ResourceDataJson, ResourceGroup, type ResourceGroupInfo, type ResourceGroupType, type ResourceGroupsOptions, type ResourceJson, type ResourceTypeType, type ResourceWrapperJson, type ResponseJson, type SectionTextNode, type SelectJson, type SelectOptionJson, type ServingsJson, type StatementJson, type StillImageFilmEmbedResourceJson, type StillImageFilmEmbedResourceWrapperJson, type StillImageFilmLinkResourceJson, type StillImageFilmLinkResourceWrapperJson, type StillImageFilmResourceJson, type StillImageFilmResourceWrapperJson, StreamWriter, StringWriter, type SupportedBit, type SupportedBitsOptions, type SymbolMark, type TableCellJson, type TableExtendedJson, type TableJson, type TableRowJson, type TableSectionJson, type TaskItemTextNode, type TaskItemTextNodeAttributes, type TechnicalTermJson, type JsonText as Text, type TextAndIconJson, type TextAst, type TextJsonOptions, type TextMark, type TextMarkAttibutes, TextMarkType, type TextMarkTypeType, type TextNode, type TextNodeAttibutes, TextNodeType, type TextNodeTypeType, TranslationsData, type UnbreakscapeOptions, type UpgradeOptions, type VideoEmbedResourceJson, type VideoEmbedResourceWrapperJson, type VideoLinkResourceJson, type VideoLinkResourceWrapperJson, type VideoResourceJson, type VideoResourceWrapperJson, type WebsiteLinkResourceJson, type WebsiteLinkResourceWrapperJson, type Writer, type XRefMark, type XRefMarkAttibutes, parse as bitmarkTextParse };