@gmb/bitmark-parser-generator 1.35.0 → 2.0.0

package/dist/esm/ast/ResourceBuilder.js

@@ -10,8 +10,11 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 import { Breakscape } from '../breakscaping/Breakscape';
+import { Config } from '../config/Config';
+import { BitType } from '../model/enum/BitType';
 import { ResourceTag } from '../model/enum/ResourceTag';
 import { ObjectUtils } from '../utils/ObjectUtils';
+import { StringUtils } from '../utils/StringUtils';
 import { UrlUtils } from '../utils/UrlUtils';
 import { BaseBuilder } from './BaseBuilder';
 import { NodeValidator } from './rules/NodeValidator';
@@ -19,13 +22,136 @@ import { NodeValidator } from './rules/NodeValidator';
  * Builder to build bitmark Resource AST nodes programmatically
  */
 class ResourceBuilder extends BaseBuilder {
+    /**
+     * Build and validate resource JSON object(s) from external resource JSON object(s)
+     *
+     * Note: a single input resource object can be converted to multiple resource objects
+     * (e.g. stillImageFilm -> image + audio)
+     *
+     * @param bitType
+     * @param resource
+     * @returns
+     */
+    resourceFromResourceJson(bitType, resource) {
+        if (!resource)
+            return undefined;
+        const nodes = [];
+        // Convert single resource to array
+        if (!Array.isArray(resource))
+            resource = [resource];
+        for (const thisResource of resource) {
+            // Validate we have a valid resource type
+            let type = ResourceTag.fromValue(thisResource.type);
+            if (!type)
+                return undefined;
+            // Get the resource key
+            const resourceKey = ResourceTag.keyFromValue(type);
+            if (!resourceKey)
+                return undefined;
+            // Override original type with type alias if present
+            const __typeAlias = ResourceTag.fromValue(thisResource.__typeAlias);
+            type = __typeAlias !== null && __typeAlias !== void 0 ? __typeAlias : type;
+            let data;
+            // TODO: This code should use the config to handle the combo resources. For now the logic is hardcoded
+            // Handle special cases for multiple resource bits (imageResponsive, stillImageFilm)
+            if (type === ResourceTag.imageResponsive) {
+                const r = thisResource;
+                const imagePortraitNode = this.resourceFromResourceDataJson(bitType, ResourceTag.imagePortrait, r.imagePortrait);
+                const imageLandscapeNode = this.resourceFromResourceDataJson(bitType, ResourceTag.imageLandscape, r.imageLandscape);
+                if (imagePortraitNode)
+                    nodes.push(imagePortraitNode);
+                if (imageLandscapeNode)
+                    nodes.push(imageLandscapeNode);
+            }
+            else if (type === ResourceTag.stillImageFilm) {
+                const r = thisResource;
+                const imageNode = this.resourceFromResourceDataJson(bitType, ResourceTag.image, r.image);
+                const audioNode = this.resourceFromResourceDataJson(bitType, ResourceTag.audio, r.audio);
+                if (imageNode)
+                    nodes.push(imageNode);
+                if (audioNode)
+                    nodes.push(audioNode);
+            }
+            else {
+                // Standard single resource case
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                data = thisResource[resourceKey];
+                if (!data)
+                    return undefined;
+                const node = this.resourceFromResourceDataJson(bitType, type, data);
+                if (node)
+                    nodes.push(node);
+            }
+        }
+        if (nodes.length === 0)
+            return undefined;
+        if (nodes.length === 1)
+            return nodes[0];
+        return nodes;
+    }
+    resourceFromResourceDataJson(bitType, type, data) {
+        var _a, _b, _c;
+        if (!data)
+            return undefined;
+        type = ResourceTag.fromValue(type);
+        if (!type)
+            return undefined;
+        const dataAsString = StringUtils.isString(data) ? data : undefined;
+        // url / src / href / app
+        const url = data.url || data.src || data.body || dataAsString;
+        // Sub resources
+        const posterImage = data.posterImage
+            ? (_a = this.resourceFromResourceDataJson(bitType, ResourceTag.image, data.posterImage)) === null || _a === void 0 ? void 0 : _a.image
+            : undefined;
+        const thumbnails = data.thumbnails
+            ? data.thumbnails.map((t) => {
+                var _a;
+                return (_a = this.resourceFromResourceDataJson(bitType, ResourceTag.image, t)) === null || _a === void 0 ? void 0 : _a.image;
+            })
+            : undefined;
+        // Resource
+        const node = this.resource(bitType, {
+            type,
+            // Generic (except Article / Document)
+            value: url,
+            // ImageLikeResource / AudioLikeResource / VideoLikeResource / Article / Document
+            format: data.format,
+            // ImageLikeResource
+            src1x: data.src1x,
+            src2x: data.src2x,
+            src3x: data.src3x,
+            src4x: data.src4x,
+            caption: this.handleJsonText(data.caption),
+            // ImageLikeResource / VideoLikeResource
+            width: (_b = data.width) !== null && _b !== void 0 ? _b : undefined,
+            height: (_c = data.height) !== null && _c !== void 0 ? _c : undefined,
+            alt: data.alt,
+            zoomDisabled: data.zoomDisabled,
+            // VideoLikeResource
+            duration: data.duration,
+            mute: data.mute,
+            autoplay: data.autoplay,
+            allowSubtitles: data.allowSubtitles,
+            showSubtitles: data.showSubtitles,
+            posterImage,
+            thumbnails,
+            // WebsiteLinkResource
+            siteName: undefined, //data.siteName,
+            // Generic Resource
+            license: data.license,
+            copyright: data.copyright,
+            showInIndex: data.showInIndex,
+            search: data.search,
+        });
+        return node;
+    }
     /**
      * Build resource node
      *
      * @param data - data for the node
      * @returns
      */
-    resource(data) {
+    /* private */ resource(bitType, data) {
         var _a;
         let node;
         const { type, value: valueIn, format: formatIn } = data, rest = __rest(data, ["type", "value", "format"]);
@@ -44,12 +170,12 @@ class ResourceBuilder extends BaseBuilder {
                     const dataAsAny = data;
                     const value = dataAsAny[k];
                     if (value) {
-                        const image = this.resource({
+                        const image = this.resource(bitType, {
                             type: ResourceTag.image,
                             value,
                         });
                         if (image)
-                            thumbnails.push(image);
+                            thumbnails.push(image.image);
                     }
                 }
                 // Merge with existing thumbnails
@@ -60,7 +186,7 @@ class ResourceBuilder extends BaseBuilder {
             case ResourceTag.image:
             case ResourceTag.imagePortrait:
             case ResourceTag.imageLandscape:
-                node = this.imageResource(finalData, type);
+                node = this.imageResource(bitType, finalData, type);
                 break;
             // case ResourceTag.imageResponsive: {
             //   node = this.imageResponsiveResource({
@@ -154,32 +280,47 @@ class ResourceBuilder extends BaseBuilder {
      * @param data - data for the node
      * @returns
      */
-    imageResource(data, typeAlias) {
+    imageResource(bitType, data, __typeAlias) {
+        var _a, _b;
         const { value, src1x, src2x, src3x, src4x, width, height, alt, zoomDisabled, license, copyright, showInIndex, caption, search, } = data;
+        let zoomDisabledDefault = false;
+        if (Config.isOfBitType(bitType, [
+            BitType.imageSeparator,
+            BitType.pageBanner,
+            BitType.imagesLogoGrave,
+            BitType.prototypeImages,
+        ])) {
+            zoomDisabledDefault = true;
+        }
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.image,
-            typeAlias: typeAlias !== null && typeAlias !== void 0 ? typeAlias : ResourceTag.image,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            src1x,
-            src2x,
-            src3x,
-            src4x,
-            width,
-            height,
-            alt,
-            zoomDisabled,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: __typeAlias !== null && __typeAlias !== void 0 ? __typeAlias : ResourceTag.image,
+            image: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                src: value !== null && value !== void 0 ? value : '',
+                src1x: (src1x !== null && src1x !== void 0 ? src1x : undefined),
+                src2x: (src2x !== null && src2x !== void 0 ? src2x : undefined),
+                src3x: (src3x !== null && src3x !== void 0 ? src3x : undefined),
+                src4x: (src4x !== null && src4x !== void 0 ? src4x : undefined),
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                zoomDisabled: zoomDisabled !== null && zoomDisabled !== void 0 ? zoomDisabled : zoomDisabledDefault,
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node, {
-            ignoreFalse: ['zoomDisabled'],
+        ObjectUtils.removeUnwantedProperties(node.image, {
+            ignoreFalse: ['zoomDisabled', 'showInIndex'],
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['src', 'alt', 'license', 'copyright'],
         });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
@@ -191,31 +332,38 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     imageLinkResource(data) {
+        var _a, _b;
         const { value, src1x, src2x, src3x, src4x, width, height, alt, zoomDisabled, license, copyright, showInIndex, caption, search, } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.imageLink,
-            typeAlias: ResourceTag.imageLink,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            src1x,
-            src2x,
-            src3x,
-            src4x,
-            zoomDisabled,
-            width,
-            height,
-            alt,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.imageLink,
+            imageLink: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                // src: value ?? '',
+                url: value !== null && value !== void 0 ? value : '',
+                src1x: (src1x !== null && src1x !== void 0 ? src1x : undefined),
+                src2x: (src2x !== null && src2x !== void 0 ? src2x : undefined),
+                src3x: (src3x !== null && src3x !== void 0 ? src3x : undefined),
+                src4x: (src4x !== null && src4x !== void 0 ? src4x : undefined),
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                zoomDisabled: zoomDisabled !== null && zoomDisabled !== void 0 ? zoomDisabled : false, // TODO: Default depends on the bit(!)
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node, {
-            ignoreFalse: ['zoomDisabled'],
+        ObjectUtils.removeUnwantedProperties(node.imageLink, {
+            ignoreFalse: ['zoomDisabled', 'showInIndex'],
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['url', 'alt', 'license', 'copyright'],
         });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
@@ -227,25 +375,32 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     audioResource(data) {
+        var _a, _b;
         const { value, duration, mute, autoplay, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.audio,
-            typeAlias: ResourceTag.audio,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            duration,
-            mute,
-            autoplay,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.audio,
+            audio: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                src: value !== null && value !== void 0 ? value : '',
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.audio, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['src', 'alt', 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -256,25 +411,32 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     audioEmbedResource(data) {
+        var _a, _b;
         const { value, duration, mute, autoplay, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.audioEmbed,
-            typeAlias: ResourceTag.audioEmbed,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            duration,
-            mute,
-            autoplay,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.audioEmbed,
+            audioEmbed: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                src: value !== null && value !== void 0 ? value : '',
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.audioEmbed, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['src', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -285,25 +447,32 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     audioLinkResource(data) {
+        var _a, _b;
         const { value, duration, mute, autoplay, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.audioLink,
-            typeAlias: ResourceTag.audioLink,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            duration,
-            mute,
-            autoplay,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.audioLink,
+            audioLink: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                // src: value ?? '',
+                url: value !== null && value !== void 0 ? value : '',
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.audioLink, {
+            // ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url' /*'alt', 'license', 'copyright'*/],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -314,32 +483,40 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     videoResource(data) {
+        var _a, _b;
         const { value, width, height, duration, mute, autoplay, allowSubtitles, showSubtitles, alt, posterImage, thumbnails, license, copyright, showInIndex, caption, search, } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.video,
-            typeAlias: ResourceTag.video,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            width,
-            height,
-            duration,
-            mute,
-            autoplay,
-            allowSubtitles,
-            showSubtitles,
-            alt,
-            posterImage,
-            thumbnails,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.video,
+            video: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                src: value !== null && value !== void 0 ? value : '',
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                allowSubtitles: (allowSubtitles !== null && allowSubtitles !== void 0 ? allowSubtitles : undefined),
+                showSubtitles: (showSubtitles !== null && showSubtitles !== void 0 ? showSubtitles : undefined),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                posterImage: (posterImage !== null && posterImage !== void 0 ? posterImage : undefined),
+                thumbnails: (thumbnails !== null && thumbnails !== void 0 ? thumbnails : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.video, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['src', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -350,32 +527,41 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     videoEmbedResource(data) {
+        var _a, _b;
         const { value, width, height, duration, mute, autoplay, allowSubtitles, showSubtitles, alt, posterImage, thumbnails, license, copyright, showInIndex, caption, search, } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.videoEmbed,
-            typeAlias: ResourceTag.videoEmbed,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            width,
-            height,
-            duration,
-            mute,
-            autoplay,
-            allowSubtitles,
-            showSubtitles,
-            alt,
-            posterImage,
-            thumbnails,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.videoEmbed,
+            videoEmbed: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                // src: value ?? '',
+                url: value !== null && value !== void 0 ? value : '',
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                allowSubtitles: (allowSubtitles !== null && allowSubtitles !== void 0 ? allowSubtitles : undefined),
+                showSubtitles: (showSubtitles !== null && showSubtitles !== void 0 ? showSubtitles : undefined),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                posterImage: (posterImage !== null && posterImage !== void 0 ? posterImage : undefined),
+                thumbnails: (thumbnails !== null && thumbnails !== void 0 ? thumbnails : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.videoEmbed, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['url', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -386,32 +572,41 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     videoLinkResource(data) {
+        var _a, _b;
         const { value, width, height, duration, mute, autoplay, allowSubtitles, showSubtitles, alt, posterImage, thumbnails, license, copyright, showInIndex, caption, search, } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.videoLink,
-            typeAlias: ResourceTag.videoLink,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            width,
-            height,
-            duration,
-            mute,
-            autoplay,
-            allowSubtitles,
-            showSubtitles,
-            alt,
-            posterImage,
-            thumbnails,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.videoLink,
+            videoLink: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                // src: value ?? '',
+                url: value !== null && value !== void 0 ? value : '',
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                allowSubtitles: (allowSubtitles !== null && allowSubtitles !== void 0 ? allowSubtitles : undefined),
+                showSubtitles: (showSubtitles !== null && showSubtitles !== void 0 ? showSubtitles : undefined),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                posterImage: (posterImage !== null && posterImage !== void 0 ? posterImage : undefined),
+                thumbnails: (thumbnails !== null && thumbnails !== void 0 ? thumbnails : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.videoLink, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['url', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -426,14 +621,14 @@ class ResourceBuilder extends BaseBuilder {
     //   // NOTE: Node order is important and is defined here
     //   const node: StillImageFilmResource = {
     //     type: ResourceTag.stillImageFilm,
-    //     typeAlias: ResourceTag.stillImageFilm,
+    //     __typeAlias: ResourceTag.stillImageFilm,
     //     image: image ?? this.imageResource({ format: '', value: '' }),
     //     audio: audio ?? this.audioResource({ format: '', value: '' }),
     //   };
     //   // Remove Unset Optionals
     //   ObjectUtils.removeUnwantedProperties(node);
     //   // Validate and correct invalid bits as much as possible
-    //   return NodeValidator.validateResource(node) as StillImageFilmResource;
+    //   return NodeValidator.validateResource(node) ;
     // }
     /**
      * Build stillImageFilmEmbedResource node
@@ -442,32 +637,41 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     stillImageFilmEmbedResource(data) {
+        var _a, _b;
         const { value, width, height, duration, mute, autoplay, allowSubtitles, showSubtitles, alt, posterImage, thumbnails, license, copyright, showInIndex, caption, search, } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.stillImageFilmEmbed,
-            typeAlias: ResourceTag.stillImageFilmEmbed,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            width,
-            height,
-            duration,
-            mute,
-            autoplay,
-            allowSubtitles,
-            showSubtitles,
-            alt,
-            posterImage,
-            thumbnails,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.stillImageFilmEmbed,
+            stillImageFilmEmbed: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                // src: value ?? '',
+                url: value !== null && value !== void 0 ? value : '',
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                allowSubtitles: (allowSubtitles !== null && allowSubtitles !== void 0 ? allowSubtitles : undefined),
+                showSubtitles: (showSubtitles !== null && showSubtitles !== void 0 ? showSubtitles : undefined),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                posterImage: (posterImage !== null && posterImage !== void 0 ? posterImage : undefined),
+                thumbnails: (thumbnails !== null && thumbnails !== void 0 ? thumbnails : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.stillImageFilmEmbed, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['url', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -478,32 +682,41 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     stillImageFilmLinkResource(data) {
+        var _a, _b;
         const { value, width, height, duration, mute, autoplay, allowSubtitles, showSubtitles, alt, posterImage, thumbnails, license, copyright, showInIndex, caption, search, } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.stillImageFilmLink,
-            typeAlias: ResourceTag.stillImageFilmLink,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            width,
-            height,
-            duration,
-            mute,
-            autoplay,
-            allowSubtitles,
-            showSubtitles,
-            alt,
-            posterImage,
-            thumbnails,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.stillImageFilmLink,
+            stillImageFilmLink: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                // src: value ?? '',
+                url: value !== null && value !== void 0 ? value : '',
+                width: (width !== null && width !== void 0 ? width : null),
+                height: (height !== null && height !== void 0 ? height : null),
+                duration: (duration !== null && duration !== void 0 ? duration : undefined),
+                mute: (mute !== null && mute !== void 0 ? mute : undefined),
+                autoplay: (autoplay !== null && autoplay !== void 0 ? autoplay : undefined),
+                allowSubtitles: (allowSubtitles !== null && allowSubtitles !== void 0 ? allowSubtitles : undefined),
+                showSubtitles: (showSubtitles !== null && showSubtitles !== void 0 ? showSubtitles : undefined),
+                alt: alt !== null && alt !== void 0 ? alt : '',
+                posterImage: (posterImage !== null && posterImage !== void 0 ? posterImage : undefined),
+                thumbnails: (thumbnails !== null && thumbnails !== void 0 ? thumbnails : undefined),
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.stillImageFilmLink, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreUndefined: ['width', 'height'],
+            ignoreEmptyString: ['url', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -514,22 +727,28 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     articleResource(data) {
+        var _a, _b;
         const { value, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.article,
-            typeAlias: ResourceTag.article,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.article,
+            article: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                body: value !== null && value !== void 0 ? value : '',
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.article, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['body', 'alt', 'license', 'copyright'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -540,22 +759,29 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     documentResource(data) {
+        var _a, _b;
         const { value, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.document,
-            typeAlias: ResourceTag.document,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.document,
+            document: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                url: value !== null && value !== void 0 ? value : '',
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.document, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url', 'alt', 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -566,22 +792,29 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     documentEmbedResource(data) {
+        var _a, _b;
         const { value, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.documentEmbed,
-            typeAlias: ResourceTag.documentEmbed,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.documentEmbed,
+            documentEmbed: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                url: value !== null && value !== void 0 ? value : '',
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.documentEmbed, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url', 'alt', 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -592,22 +825,29 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     documentLinkResource(data) {
+        var _a, _b;
         const { value, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.documentLink,
-            typeAlias: ResourceTag.documentLink,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.documentLink,
+            documentLink: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                url: value !== null && value !== void 0 ? value : '',
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.documentLink, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url', 'alt', 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -618,22 +858,29 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     documentDownloadResource(data) {
+        var _a, _b;
         const { value, license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.documentDownload,
-            typeAlias: ResourceTag.documentDownload,
-            format: UrlUtils.fileExtensionFromUrl(value),
-            provider: UrlUtils.domainFromUrl(value),
-            value,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.documentDownload,
+            documentDownload: {
+                format: ((_a = UrlUtils.fileExtensionFromUrl(value)) !== null && _a !== void 0 ? _a : undefined),
+                provider: ((_b = UrlUtils.domainFromUrl(value)) !== null && _b !== void 0 ? _b : undefined),
+                url: value !== null && value !== void 0 ? value : '',
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.documentDownload, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url', 'alt', 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -648,16 +895,25 @@ class ResourceBuilder extends BaseBuilder {
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.appLink,
-            typeAlias: ResourceTag.appLink,
-            value,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.appLink,
+            appLink: {
+                // format: (UrlUtils.fileExtensionFromUrl(value) ?? undefined) as string,
+                // provider: (UrlUtils.domainFromUrl(value) ?? undefined) as string,
+                provider: undefined,
+                url: value !== null && value !== void 0 ? value : '',
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.appLink, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url', /*'alt',*/ 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }
@@ -668,21 +924,29 @@ class ResourceBuilder extends BaseBuilder {
      * @returns
      */
     websiteLinkResource(data) {
-        const { value, siteName, license, copyright, showInIndex, caption, search } = data;
+        const { value, /*siteName,*/ license, copyright, showInIndex, caption, search } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: ResourceTag.websiteLink,
-            typeAlias: ResourceTag.websiteLink,
-            value,
-            siteName,
-            license,
-            copyright,
-            showInIndex,
-            caption,
-            search,
+            __typeAlias: ResourceTag.websiteLink,
+            websiteLink: {
+                // provider: (UrlUtils.domainFromUrl(value) ?? undefined) as string,
+                provider: undefined,
+                url: value !== null && value !== void 0 ? value : '',
+                // siteName,
+                license: license !== null && license !== void 0 ? license : '',
+                copyright: copyright !== null && copyright !== void 0 ? copyright : '',
+                showInIndex: showInIndex !== null && showInIndex !== void 0 ? showInIndex : false,
+                caption: this.handleJsonText(caption),
+                search: (search !== null && search !== void 0 ? search : undefined),
+            },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node.websiteLink, {
+            ignoreEmptyArrays: ['caption'],
+            ignoreEmptyString: ['url', 'alt', 'license', 'copyright'],
+            ignoreFalse: ['showInIndex'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateResource(node);
     }