Merge pull request #17 from contentstack/bugs/asset-reference

Asset reference resolve without include embed

Author: uttamukkoji

.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Publish package to NPM repository
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:  
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  publish-git:  
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@contentstack'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

__test__/reference-to-html.test.ts

@@ -4,12 +4,13 @@ import { findEmbeddedItems } from '../src/helper/find-embeded-object'
 import { Metadata } from '../src/Models/metadata-model'
 import Node from '../src/nodes/node'
 import NodeType from '../src/nodes/node-type'
+import { Next, RenderOption } from '../src/options'
 import { defaultOptions } from '../src/options/default-options'
 import { assetReferenceJson, embeddedAssetJsonEntry, embeddedEntryJsonEntry, entryReferenceBlockJson, entryReferenceInlineJson, entryReferenceLinkJson } from './mock/json-element-mock'
 import { embeddedAssetWithRenderOption, embeddedObjectDefaultRender, embeddedObjectWithRenderOption } from './mock/render-options'
 describe('Reference Node To HTML', () => {
     it('Should return blank for undefined entry', done => {
-        const node = assetReferenceJson.children[0] as undefined as Node
+        const node = assetReferenceJson.children[0] as unknown as Node
         const renderOption = {}
 
         const resultHTML = referenceToHTML(node, renderOption)
@@ -47,7 +48,7 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return HTML for embedded asset', done => {
-        const node = assetReferenceJson.children[0] as undefined as Node
+        const node = assetReferenceJson.children[0] as unknown as Node
         const renderOption = {}
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
@@ -59,7 +60,7 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return HTML for embedded block entry', done => {
-        const node = entryReferenceBlockJson.children[0] as undefined as Node
+        const node = entryReferenceBlockJson.children[0] as unknown as Node
         const renderOption = {}
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
@@ -70,7 +71,7 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return HTML for embedded link entry', done => {
-        const node = entryReferenceLinkJson.children[0] as undefined as Node
+        const node = entryReferenceLinkJson.children[0] as unknown as Node
         const renderOption = {}
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
@@ -81,7 +82,7 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return HTML for embedded inline entry', done => {
-        const node = entryReferenceInlineJson.children[0] as undefined as Node
+        const node = entryReferenceInlineJson.children[0] as unknown as Node
         const renderOption = {}
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
@@ -93,8 +94,8 @@ describe('Reference Node To HTML', () => {
 
     // Custom render option
     it('Should return custom HTML for embedded asset', done => {
-        const node = assetReferenceJson.children[0] as undefined as Node
-        const renderOption = embeddedAssetWithRenderOption.renderOption
+        const node = assetReferenceJson.children[0] as unknown as Node
+        const renderOption = embeddedAssetWithRenderOption.renderOption as RenderOption
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
             return findEmbeddedItems(metadata, embeddedAssetJsonEntry)[0]
@@ -104,8 +105,8 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return custom HTML for embedded block entry', done => {
-        const node = entryReferenceBlockJson.children[0] as undefined as Node
-        const renderOption = embeddedObjectWithRenderOption.renderOption
+        const node = entryReferenceBlockJson.children[0] as unknown as Node
+        const renderOption = embeddedObjectWithRenderOption.renderOption as RenderOption
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
             return findEmbeddedItems(metadata, embeddedEntryJsonEntry)[0]
@@ -115,8 +116,8 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return custom HTML for embedded inline entry', done => {
-        const node = entryReferenceInlineJson.children[0] as undefined as Node
-        const renderOption = embeddedObjectWithRenderOption.renderOption
+        const node = entryReferenceInlineJson.children[0] as unknown as Node
+        const renderOption = embeddedObjectWithRenderOption.renderOption as RenderOption
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
             return findEmbeddedItems(metadata, embeddedEntryJsonEntry)[0]
@@ -126,8 +127,8 @@ describe('Reference Node To HTML', () => {
     })
 
     it('Should return custom default HTML for embedded inline entry', done => {
-        const node = entryReferenceBlockJson.children[0] as undefined as Node
-        const renderOption = embeddedObjectDefaultRender.renderOption
+        const node = entryReferenceBlockJson.children[0] as unknown as Node
+        const renderOption = embeddedObjectDefaultRender.renderOption as RenderOption
 
         const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
             return findEmbeddedItems(metadata, embeddedEntryJsonEntry)[0]
@@ -138,4 +139,32 @@ describe('Reference Node To HTML', () => {
             </div>`)
         done()
     })
+
+    it('Should return image for undefined node asset', done => {
+        const node = assetReferenceJson.children[0] as unknown as Node
+        const renderOption = {
+            'reference' : (node: Node, next: Next) => {
+                return `<img src=${node.attrs['asset-link']}>`;
+            }
+        }
+
+        const resultHTML = referenceToHTML(node, renderOption)
+        expect(resultHTML).toEqual('<img src=https://image.url/11.jpg>')
+        done()
+    })
+    
+    it('Should return HTML for embedded link entry', done => {
+        const node = entryReferenceLinkJson.children[0] as unknown as Node
+        const renderOption = {
+            'reference' : (node: Node, next: Next) => {
+                return `<a href=\"${node.attrs['entry-uid']}\">${node.attrs.href}</a>`;
+            }
+        }
+
+        const resultHTML = referenceToHTML(node, renderOption, (metadata: Metadata) => {
+            return findEmbeddedItems(metadata, { uid: 'uid' })[0]
+        })
+        expect(resultHTML).toEqual('<a href=\"entry_uid_20\">/copy-of-entry-final-02</a>')
+        done()
+    })
 })

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/utils",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Contentstack utilities for Javascript",
   "main": "dist/index.es.js",
   "types": "dist/types/index.d.ts",
@@ -58,7 +58,7 @@
     "typescript": "^4.6.3"
   },
   "dependencies": {
-    "node-html-parser": "^1.4.9"
+    "node-html-parser": "^5.4.1"
   },
   "babel": {
     "presets": [

package.json

@@ -6,7 +6,7 @@ export function addTags(entry: EntryModel, contentTypeUid: string, tagsAsObject:
 }
 
 function getTag(content: object, prefix: string, tagsAsObject: boolean, locale: string): object {
-    let tags: any = {}
+    const tags: any = {}
     Object.entries(content).forEach(([key, value]) => {      
         switch (typeof value) {
             case "object":

src/entry-editable.ts

@@ -70,11 +70,20 @@ export function referenceToHTML(node: Node,
     renderOption: RenderOption,
     renderEmbed?: (metadata: Metadata) => EmbeddedItem | EntryNode
 ): string {
+    function sendToRenderOption(referenceNode: Node): string {
+        return (renderOption[referenceNode.type] as RenderNode)(referenceNode, undefined)
+    }
+    if (!renderEmbed && renderOption[node.type] !== undefined) {
+        return sendToRenderOption(node)
+    }
     if (!renderEmbed) {
         return ''
     }
     const metadata = nodeToMetadata(node.attrs, ((node.children && node.children.length > 0) ? node.children[0]: {}) as unknown as TextNode)
-    const item = renderEmbed(metadata)
+    const item = renderEmbed(metadata)    
+    if (!item && renderOption[node.type] !== undefined) {
+        return sendToRenderOption(node)
+    }
     return findRenderString(item, metadata, renderOption)
 }