Skip to content

Asset reference resolve without include embed #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -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 }}
55 changes: 42 additions & 13 deletions __test__/reference-to-html.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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) => {
Expand All @@ -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) => {
Expand All @@ -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) => {
Expand All @@ -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) => {
Expand All @@ -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]
Expand All @@ -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]
Expand All @@ -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]
Expand All @@ -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]
Expand All @@ -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()
})
})
75 changes: 69 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -58,7 +58,7 @@
"typescript": "^4.6.3"
},
"dependencies": {
"node-html-parser": "^1.4.9"
"node-html-parser": "^5.4.1"
},
"babel": {
"presets": [
Expand Down
2 changes: 1 addition & 1 deletion src/entry-editable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
11 changes: 10 additions & 1 deletion src/helper/enumerate-entries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}

Expand Down