@gmb/bitmark-parser-generator 4.1.2 → 4.3.0

package/dist/index.cjs

@@ -70,7 +70,24 @@ var BitType = (0, import_superenum.superenum)({
   // Used to indicate a bit is commented out
   _standard: "_standard",
   // Not to be used as a bit, but as a base for other bit types
+  advertising: "advertising",
+  advertisingAdvertorial: "advertising-advertorial",
+  advertisingCallToAction: "advertising-call-to-action",
+  advertisingCallToActionMeeting: "advertising-call-to-action-meeting",
+  advertisingBanner: "advertising-banner",
+  advertisingSkyscraper: "advertising-skyscraper",
+  advertisingRectangle: "advertising-rectangle",
+  advertisingFullPage: "advertising-full-page",
+  advertisingHalfPage: "advertising-half-page",
+  advertisingQuarterPage: "advertising-quarter-page",
+  advertisingClassifiedPage: "advertising-classified-page",
+  advertisingLandscape: "advertising-landscape",
+  advertisingPortrait: "advertising-portrait",
+  aiChat: "ai-chat",
+  aiEditor: "ai-editor",
   aiPrompt: "ai-prompt",
+  aiTutor: "ai-tutor",
+  aiWbt: "ai-wbt",
   anchor: "anchor",
   appAiPrompt: "app-ai-prompt",
   appBitmarkFromEditor: "app-bitmark-from-editor",
@@ -88,6 +105,7 @@ var BitType = (0, import_superenum.superenum)({
   articleAi: "article-ai",
   articleAlt: "article-alt",
   articleAttachment: "article-attachment",
+  articleAuthor: "article-author",
   articleEmbed: "article-embed",
   articleLink: "article-link",
   articleResponsive: "article-responsive",
@@ -98,6 +116,8 @@ var BitType = (0, import_superenum.superenum)({
   audioEmbed: "audio-embed",
   audioLink: "audio-link",
   audioTranscript: "audio-transcript",
+  author: "author",
+  authorContentBitGenerator: "author-content-bit-generator",
   bitAlias: "bit-alias",
   bitBookEnding: "bit-book-ending",
   bitBookSummary: "bit-book-summary",
@@ -110,6 +130,7 @@ var BitType = (0, import_superenum.superenum)({
   bookAlias: "book-alias",
   bookAppendix: "book-appendix",
   bookArticle: "book-article",
+  bookAuthor: "book-author",
   bookAutherBio: "book-author-bio",
   bookBibliography: "book-bibliography",
   bookClose: "book-close",
@@ -278,6 +299,8 @@ var BitType = (0, import_superenum.superenum)({
   extractorAiChat: "extractor-ai-chat",
   extractorBlock: "extractor-block",
   extractorConfiguration: "extractor-configuration",
+  extractorEmbeddedImage: "extractor-embedded-image",
+  extractorEmbeddedImageCollapsible: "extractor-embedded-image-collapsible",
   extractorInformation: "extractor-information",
   extractorPage: "extractor-page",
   extractorPageCollapsible: "extractor-page-collapsible",
@@ -1176,6 +1199,7 @@ var propertyKeys = {
   property_disableCalculation: "@disableCalculation",
   property_disableFeedback: "@disableFeedback",
   property_duration: "@duration",
+  property_isEditable: "@isEditable",
   property_emphasis: "@emphasis",
   property_example: "@example",
   property_externalId: "@externalId",
@@ -1187,6 +1211,7 @@ var propertyKeys = {
   property_focusX: "@focusX",
   property_focusY: "@focusY",
   property_format: "@format",
+  property_fullName: "@fullName",
   property_groupTag: "@groupTag",
   property_handInAcceptFileType: "@handInAcceptFileType",
   property_handInInstruction: "@handInInstruction",
@@ -1207,6 +1232,7 @@ var propertyKeys = {
   property_isTemplate: "@isTemplate",
   property_isTemplateStripTheme: "@isTemplateStripTheme",
   property_isTracked: "@isTracked",
+  property_jobTitle: "@jobTitle",
   property_jupyterExecutionCount: "@jupyterExecutionCount",
   property_jupyterId: "@jupyterId",
   property_kind: "@kind",
@@ -1251,6 +1277,7 @@ var propertyKeys = {
   property_productId: "@productId",
   property_productVideo: "@productVideo",
   property_progress: "@progress",
+  property_pseudonym: "@pseudonym",
   property_publications: "@publications",
   property_publisher: "@publisher",
   property_publisherName: "@publisherName",
@@ -3153,6 +3180,12 @@ var GROUPS = {
         format: TagFormat.boolean,
         defaultValue: "false"
       },
+      {
+        key: ConfigKey.property_isEditable,
+        description: "If true, the book is editable",
+        format: TagFormat.boolean,
+        defaultValue: "false"
+      },
       {
         key: ConfigKey.property_chatWithBook,
         description: "If true, the user can chat about the book with an AI assistant",
@@ -4165,6 +4198,40 @@ var BITS = {
     ],
     resourceAttachmentAllowed: false
   },
+  [BitType.author]: {
+    since: "4.2.0",
+    baseBitType: BitType._standard,
+    description: "Represents an author of something",
+    tags: [
+      {
+        key: ConfigKey.property_fullName,
+        description: "Full name of the author"
+      },
+      {
+        key: ConfigKey.property_pseudonym,
+        description: "A pseudonym of the author, if any"
+      },
+      {
+        key: ConfigKey.property_title,
+        description: 'The title of the author, e.g. "Dr.", "Prof.", etc.',
+        jsonKey: "title"
+      },
+      {
+        key: ConfigKey.property_jobTitle,
+        description: 'The job title of the author, e.g. "Software Engineer", "Professor", etc.'
+      }
+    ]
+  },
+  [BitType.bookAuthor]: {
+    since: "4.2.0",
+    baseBitType: BitType.author,
+    description: "Represents an author of a book"
+  },
+  [BitType.articleAuthor]: {
+    since: "4.2.0",
+    baseBitType: BitType.author,
+    description: "Represents an author of a book"
+  },
   [BitType.article]: {
     since: "1.3.0",
     baseBitType: BitType._standard,
@@ -5140,6 +5207,71 @@ var BITS = {
     baseBitType: BitType.conversationLeft1,
     description: "Cloze and multiple choice text conversation right thought bit, used for conversations with cloze and multiple choice text and a thought on the right side of the screen"
   },
+  [BitType.advertising]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "General advertising content bit"
+  },
+  [BitType.advertisingAdvertorial]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "Advertorial content bit (sponsored article)"
+  },
+  [BitType.advertisingCallToAction]: {
+    since: "4.2.0",
+    baseBitType: BitType.callToAction,
+    description: "Call-to-action for advertising"
+  },
+  [BitType.advertisingCallToActionMeeting]: {
+    since: "4.2.0",
+    baseBitType: BitType.callToAction,
+    description: "Call-to-action for meeting or appointment"
+  },
+  [BitType.advertisingBanner]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Banner advertisement bit"
+  },
+  [BitType.advertisingSkyscraper]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Skyscraper (vertical) advertisement bit"
+  },
+  [BitType.advertisingRectangle]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Rectangle advertisement bit"
+  },
+  [BitType.advertisingFullPage]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Full-page advertisement bit"
+  },
+  [BitType.advertisingHalfPage]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Half-page advertisement bit"
+  },
+  [BitType.advertisingQuarterPage]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Quarter-page advertisement bit"
+  },
+  [BitType.advertisingClassifiedPage]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Classifieds advertisement page bit"
+  },
+  [BitType.advertisingLandscape]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Landscape format advertisement bit"
+  },
+  [BitType.advertisingPortrait]: {
+    since: "4.2.0",
+    baseBitType: BitType.image,
+    description: "Portrait format advertisement bit"
+  },
   [BitType.cookPreparation]: {
     since: "1.3.0",
     baseBitType: BitType.article,
@@ -5429,6 +5561,19 @@ var BITS = {
     baseBitType: BitType.smartStandardExampleNonNormative,
     description: "Smart standard non-normative example collapsible bit, used to provide non-normative examples in smart standards that can be collapsed"
   },
+  [BitType.authorContentBitGenerator]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "Body contains the content of one or more bits to be created by the bit generator",
+    tags: [
+      {
+        key: ConfigKey.property_classification,
+        description: "Classification for the created bits",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity
+      }
+    ]
+  },
   [BitType.appAiPrompt]: {
     since: "1.3.0",
     baseBitType: BitType.article,
@@ -5439,6 +5584,26 @@ var BITS = {
     baseBitType: BitType.article,
     description: "AI prompt bit, used to create AI prompts in articles or books"
   },
+  [BitType.aiChat]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "AI chat bit, used to create an AI chat"
+  },
+  [BitType.aiEditor]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "AI editor bit, used to create an AI editor"
+  },
+  [BitType.aiTutor]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "AI tutor bit, used to create an AI tutor"
+  },
+  [BitType.aiWbt]: {
+    since: "4.2.0",
+    baseBitType: BitType.article,
+    description: "AI WBT bit, used to create an AI WBT (Web-Based Training)"
+  },
   [BitType.articleAi]: {
     since: "1.3.0",
     baseBitType: BitType.article,
@@ -6156,6 +6321,18 @@ var BITS = {
     description: "Extractor configuration bit, used to configure extractors in articles or books",
     textFormatDefault: TextFormat.plainText
   },
+  [BitType.extractorEmbeddedImage]: {
+    since: "4.3.0",
+    baseBitType: BitType.image,
+    description: "Extractor embedded image bit, used for embedded images extracted from PDFs",
+    textFormatDefault: TextFormat.plainText
+  },
+  [BitType.extractorEmbeddedImageCollapsible]: {
+    since: "4.3.0",
+    baseBitType: BitType.extractorEmbeddedImage,
+    description: "Collapsible extractor embedded image bit, used for embedded images extracted from PDFs",
+    textFormatDefault: TextFormat.plainText
+  },
   [BitType.extractorInformation]: {
     since: "3.8.0",
     baseBitType: BitType._standard,
@@ -8939,7 +9116,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "4.1.2",
+  "version": "4.3.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -9465,6 +9642,8 @@ var NodeType = (0, import_superenum20.superenum)({
   format: "format",
   forValues: "forValues",
   forValuesValue: "forValuesValue",
+  fullName: "fullName",
+  fullNameValue: "fullNameValue",
   gap: "gap",
   groupTag: "groupTag",
   groupTagValue: "groupTagValue",
@@ -9509,6 +9688,8 @@ var NodeType = (0, import_superenum20.superenum)({
   isCaseSensitive: "isCaseSensitive",
   isCommented: "isCommented",
   isCorrect: "isCorrect",
+  isEditable: "isEditable",
+  isEditableValue: "isEditableValue",
   isExample: "isExample",
   isInfoOnly: "isInfoOnly",
   isInfoOnlyValue: "isInfoOnlyValue",
@@ -9523,6 +9704,8 @@ var NodeType = (0, import_superenum20.superenum)({
   isTrackedValue: "isTrackedValue",
   item: "item",
   itemLead: "itemLead",
+  jobTitle: "jobTitle",
+  jobTitleValue: "jobTitleValue",
   jupyterExecutionCount: "jupyterExecutionCount",
   jupyterExecutionCountValue: "jupyterExecutionCountValue",
   jupyterId: "jupyterId",
@@ -9638,6 +9821,8 @@ var NodeType = (0, import_superenum20.superenum)({
   propertyValue: "propertyValue",
   propertyValues: "propertyValues",
   provider: "provider",
+  pseudonym: "pseudonym",
+  pseudonymValue: "pseudonymValue",
   publications: "publications",
   publicationsValue: "publicationsValue",
   publisher: "publisher",
@@ -9785,6 +9970,7 @@ var NodeType = (0, import_superenum20.superenum)({
   thumbnails: "thumbnails",
   thumbnailsValue: "thumbnailsValue",
   title: "title",
+  titleString: "titleString",
   toc: "toc",
   tocContent: "tocContent",
   tocContentValue: "tocContentValue",
@@ -20643,62 +20829,99 @@ var NodeValidator = class {
   validateResource(resource) {
     if (!resource) return void 0;
     const ret = resource;
-    let valid = false;
+    let valid = true;
     switch (resource.type) {
-      case ResourceType.image:
-        valid = !!resource.image.src;
+      case ResourceType.image: {
+        const imageResource = resource.image;
+        if (!stringUtils.isString(imageResource.src)) imageResource.src = "";
         break;
-      case ResourceType.imageLink:
-        valid = !!resource.imageLink.url;
+      }
+      case ResourceType.imageLink: {
+        const imageLink = resource.imageLink;
+        if (!stringUtils.isString(imageLink.url)) imageLink.url = "";
         break;
-      case ResourceType.audio:
-        valid = !!resource.audio.src;
+      }
+      case ResourceType.audio: {
+        const audio = resource.audio;
+        if (!stringUtils.isString(audio.src)) audio.src = "";
         break;
-      case ResourceType.audioEmbed:
-        valid = !!resource.audioEmbed.src;
+      }
+      case ResourceType.audioEmbed: {
+        const audioEmbed = resource.audioEmbed;
+        if (!stringUtils.isString(audioEmbed.src)) audioEmbed.src = "";
         break;
-      case ResourceType.audioLink:
-        valid = !!resource.audioLink.url;
+      }
+      case ResourceType.audioLink: {
+        const audioLink = resource.audioLink;
+        if (!stringUtils.isString(audioLink.url)) audioLink.url = "";
         break;
-      case ResourceType.video:
-        valid = !!resource.video.src;
+      }
+      case ResourceType.video: {
+        const video = resource.video;
+        if (!stringUtils.isString(video.src)) video.src = "";
         break;
-      case ResourceType.videoEmbed:
-        valid = !!resource.videoEmbed.url;
+      }
+      case ResourceType.videoEmbed: {
+        const videoEmbed = resource.videoEmbed;
+        if (!stringUtils.isString(videoEmbed.url)) videoEmbed.url = "";
         break;
-      case ResourceType.videoLink:
-        valid = !!resource.videoLink.url;
+      }
+      case ResourceType.videoLink: {
+        const videoLink = resource.videoLink;
+        if (!stringUtils.isString(videoLink.url)) videoLink.url = "";
         break;
-      case ResourceType.stillImageFilm:
-        valid = !!resource.image.src && !!resource.audio.src;
+      }
+      case ResourceType.stillImageFilm: {
+        const stillImageFilm = resource;
+        if (!stringUtils.isString(stillImageFilm.image.src)) stillImageFilm.image.src = "";
+        if (!stringUtils.isString(stillImageFilm.audio.src)) stillImageFilm.audio.src = "";
         break;
-      case ResourceType.stillImageFilmEmbed:
-        valid = !!resource.stillImageFilmEmbed.url;
+      }
+      case ResourceType.stillImageFilmEmbed: {
+        const stillImageFilmEmbed = resource.stillImageFilmEmbed;
+        if (!stringUtils.isString(stillImageFilmEmbed.url)) stillImageFilmEmbed.url = "";
         break;
-      case ResourceType.stillImageFilmLink:
-        valid = !!resource.stillImageFilmLink.url;
+      }
+      case ResourceType.stillImageFilmLink: {
+        const stillImageFilmLink = resource.stillImageFilmLink;
+        if (!stringUtils.isString(stillImageFilmLink.url)) stillImageFilmLink.url = "";
         break;
-      case ResourceType.article:
-        valid = !!resource.article.body;
+      }
+      case ResourceType.article: {
+        const article = resource.article;
+        if (!stringUtils.isString(article.body)) article.body = "";
         break;
-      case ResourceType.document:
-        valid = !!resource.document.url;
+      }
+      case ResourceType.document: {
+        const document2 = resource.document;
+        if (!stringUtils.isString(document2.url)) document2.url = "";
         break;
-      case ResourceType.documentEmbed:
-        valid = !!resource.documentEmbed.url;
+      }
+      case ResourceType.documentEmbed: {
+        const documentEmbed = resource.documentEmbed;
+        if (!stringUtils.isString(documentEmbed.url)) documentEmbed.url = "";
         break;
-      case ResourceType.documentLink:
-        valid = !!resource.documentLink.url;
+      }
+      case ResourceType.documentLink: {
+        const documentLink = resource.documentLink;
+        if (!stringUtils.isString(documentLink.url)) documentLink.url = "";
         break;
-      case ResourceType.documentDownload:
-        valid = !!resource.documentDownload.url;
+      }
+      case ResourceType.documentDownload: {
+        const documentDownload = resource.documentDownload;
+        if (!stringUtils.isString(documentDownload.url)) documentDownload.url = "";
         break;
-      case ResourceType.appLink:
-        valid = !!resource.appLink.url;
+      }
+      case ResourceType.appLink: {
+        const appLink = resource.appLink;
+        if (!stringUtils.isString(appLink.url)) appLink.url = "";
         break;
-      case ResourceType.websiteLink:
-        valid = !!resource.websiteLink.url;
+      }
+      case ResourceType.websiteLink: {
+        const websiteLink = resource.websiteLink;
+        if (!stringUtils.isString(websiteLink.url)) websiteLink.url = "";
         break;
+      }
       default:
         valid = false;
     }
@@ -21928,6 +22151,12 @@ var Builder = class extends BaseBuilder {
         data.isTemplateStripTheme,
         options
       ),
+      isEditable: this.toAstProperty(
+        bitType,
+        ConfigKey.property_isEditable,
+        data.isEditable,
+        options
+      ),
       aiGenerated: this.toAstProperty(
         bitType,
         ConfigKey.property_aiGenerated,
@@ -22530,6 +22759,11 @@ var Builder = class extends BaseBuilder {
         data.referenceProperty,
         options
       ),
+      // Author data
+      fullName: this.toAstProperty(bitType, ConfigKey.property_fullName, data.fullName, options),
+      pseudonym: this.toAstProperty(bitType, ConfigKey.property_pseudonym, data.pseudonym, options),
+      titleString: this.toAstProperty(bitType, ConfigKey.property_title, data.titleString, options),
+      jobTitle: this.toAstProperty(bitType, ConfigKey.property_jobTitle, data.jobTitle, options),
       // Book data
       title: this.handleJsonText(context, TextLocation.tag, data.title),
       subtitle: this.handleJsonText(context, TextLocation.tag, data.subtitle),
@@ -25636,6 +25870,18 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     }
     return false;
   }
+  // bitmarkAst -> bits -> bitsValue -> titleString
+  leaf_titleString(node, route) {
+    const parent = this.getParentNode(route);
+    if (parent?.key !== NodeType.bitsValue) return true;
+    if (node.value) {
+      this.writeNL();
+      this.writeProperty("title", node.value, route, {
+        format: TagFormat.plainText
+      });
+    }
+    return false;
+  }
   //  bitmarkAst -> bits -> title
   enter_title(node, route) {
     const parent = this.getParentNode(route);
@@ -26844,6 +27090,15 @@ var JsonGenerator = class extends AstWalkerGenerator {
   enter_instruction(node, route) {
     return this.standardHandler(node, route, NodeType.bitsValue, { array: true });
   }
+  // bitmarkAst -> bits -> bitsValue -> titleString
+  leaf_titleString(node, route) {
+    const parent = this.getParentNode(route);
+    if (parent?.key !== NodeType.bitsValue) return true;
+    return this.standardHandler(node, route, [NodeType.bitsValue], {
+      array: false,
+      keyOverride: "title"
+    });
+  }
   // bitmarkAst -> bits -> bitsValue -> title
   enter_title(node, route) {
     return this.standardHandler(node, route, [NodeType.bitsValue, NodeType.cardNode], {
@@ -27552,7 +27807,6 @@ var JsonGenerator = class extends AstWalkerGenerator {
    */
   cleanBitJson(bitJson) {
     const bitType = instance2.getBitType(bitJson.type);
-    const bitConfig = instance2.getBitConfig(bitType);
     if (bitJson.originalType == null) bitJson.originalType = void 0;
     if (!bitJson.item) bitJson.item = void 0;
     if (instance2.isOfBitType(bitType, [BitType._error, BitType._comment])) {
@@ -27788,9 +28042,6 @@ var JsonGenerator = class extends AstWalkerGenerator {
       if (instance2.isOfBitType(bitType, BitType.container)) {
         if (bitJson.allowedBit == null) bitJson.allowedBit = [];
       }
-      if (bitConfig.quizBit) {
-        if (bitJson.revealSolutions == null) bitJson.revealSolutions = false;
-      }
       if (instance2.isOfBitType(bitType, BitType.platformPath)) {
         if (bitJson.path == null) bitJson.path = "";
       }
@@ -28093,6 +28344,7 @@ var JsonParser = class {
       resourceType: this.getResourceType(bit.resource),
       isCommented,
       internalComment: internalComments,
+      ...this.processTitle(bitType, bit.title),
       ...this.processReference(referenceBit),
       // reference and referenceProperty
       ...this.parseExample(bit.example),
@@ -28193,6 +28445,17 @@ var JsonParser = class {
       footer: footerText
     };
   }
+  processTitle(bitType, title) {
+    if (instance2.isOfBitType(bitType, BitType.author))
+      return {
+        titleString: title,
+        title: void 0
+      };
+    return {
+      titleString: void 0,
+      title
+    };
+  }
   processReference(reference) {
     if (Array.isArray(reference) && reference.length > 0) {
       return {
@@ -31373,12 +31636,21 @@ function buildTitles(_context, bitType, title) {
       level: title.length > 0 ? title.length - 1 : void 0
     };
   } else {
-    return {
-      title: title[1]?.titleAst ?? void 0,
-      titleString: title[1]?.titleString ?? void 0,
-      subtitle: title[2]?.titleAst ?? void 0,
-      subtitleString: title[2]?.titleString ?? void 0
-    };
+    if (Array.isArray(title)) {
+      return {
+        title: title[1]?.titleAst ?? void 0,
+        titleString: title[1]?.titleString ?? void 0,
+        subtitle: title[2]?.titleAst ?? void 0,
+        subtitleString: title[2]?.titleString ?? void 0
+      };
+    } else {
+      return {
+        title: void 0,
+        titleString: title ?? void 0,
+        subtitle: void 0,
+        subtitleString: void 0
+      };
+    }
   }
 }