486 lines
14 KiB
TypeScript
486 lines
14 KiB
TypeScript
import { processString, processObject, isValid } from "../src/index"
|
|
import tableJson from "./examples/table.json"
|
|
import dayjs from "dayjs"
|
|
import { UUID_REGEX } from "./constants"
|
|
|
|
describe("test the custom helpers we have applied", () => {
|
|
it("should be able to use the object helper", async () => {
|
|
const output = await processString("object is {{ object obj }}", {
|
|
obj: { a: 1 },
|
|
})
|
|
expect(output).toBe('object is {"a":1}')
|
|
})
|
|
})
|
|
|
|
describe("test that it can run without helpers", () => {
|
|
it("should be able to run without helpers", async () => {
|
|
const output = await processString(
|
|
"{{ avg 1 1 1 }}",
|
|
{},
|
|
{ noHelpers: true }
|
|
)
|
|
const valid = await processString("{{ avg 1 1 1 }}", {})
|
|
expect(valid).toBe("1")
|
|
expect(output).toBe("")
|
|
})
|
|
})
|
|
|
|
describe("test the math helpers", () => {
|
|
it("should be able to produce an absolute", async () => {
|
|
const output = await processString("{{abs a}}", {
|
|
a: -10,
|
|
})
|
|
expect(parseInt(output)).toBe(10)
|
|
})
|
|
|
|
it("should be able to add", async () => {
|
|
const output = await processString("{{add a b}}", {
|
|
a: 10,
|
|
b: 10,
|
|
})
|
|
expect(parseInt(output)).toBe(20)
|
|
})
|
|
|
|
it("should be able to average", async () => {
|
|
const output = await processString("{{avg a b c}}", {
|
|
a: 1,
|
|
b: 2,
|
|
c: 3,
|
|
})
|
|
expect(parseInt(output)).toBe(2)
|
|
})
|
|
})
|
|
|
|
describe("test the array helpers", () => {
|
|
const array = ["hi", "person", "how", "are", "you"]
|
|
it("should allow use of the after helper", async () => {
|
|
const output = await processString("{{after array 1}}", {
|
|
array,
|
|
})
|
|
expect(output).toBe("person,how,are,you")
|
|
})
|
|
|
|
it("should allow use of the before helper", async () => {
|
|
const output = await processString("{{before array 3}}", {
|
|
array,
|
|
})
|
|
expect(output).toBe("hi,person")
|
|
})
|
|
|
|
it("should allow use of the filter helper", async () => {
|
|
const output = await processString(
|
|
'{{#filter array "person"}}THING{{else}}OTHER{{/filter}}',
|
|
{
|
|
array,
|
|
}
|
|
)
|
|
expect(output).toBe("THING")
|
|
})
|
|
|
|
it("should allow use of the itemAt helper", async () => {
|
|
const output = await processString("{{itemAt array 1}}", {
|
|
array,
|
|
})
|
|
expect(output).toBe("person")
|
|
})
|
|
|
|
it("should allow use of the join helper", async () => {
|
|
const output = await processString('{{join array "-"}}', {
|
|
array,
|
|
})
|
|
expect(output).toBe("hi-person-how-are-you")
|
|
})
|
|
|
|
it("should allow use of the sort helper", async () => {
|
|
const output = await processString("{{sort array}}", {
|
|
array: ["d", "a", "c", "e"],
|
|
})
|
|
expect(output).toBe("a,c,d,e")
|
|
})
|
|
|
|
it("should allow use of the unique helper", async () => {
|
|
const output = await processString("{{unique array}}", {
|
|
array: ["a", "a", "b"],
|
|
})
|
|
expect(output).toBe("a,b")
|
|
})
|
|
})
|
|
|
|
describe("test the number helpers", () => {
|
|
it("should allow use of the addCommas helper", async () => {
|
|
const output = await processString("{{ addCommas number }}", {
|
|
number: 10000000,
|
|
})
|
|
expect(output).toBe("10,000,000")
|
|
})
|
|
|
|
it("should allow use of the phoneNumber helper", async () => {
|
|
const output = await processString("{{ phoneNumber number }}", {
|
|
number: 4490102030,
|
|
})
|
|
expect(output).toBe("(449) 010-2030")
|
|
})
|
|
|
|
it("should allow use of the toPrecision helper", async () => {
|
|
const output = await processString("{{ toPrecision number 2 }}", {
|
|
number: 1.222222222,
|
|
})
|
|
expect(output).toBe("1.2")
|
|
})
|
|
|
|
it("should allow use of the bytes helper", async () => {
|
|
const output = await processString("{{ bytes number }}", {
|
|
number: 1000000,
|
|
})
|
|
expect(output).toBe("1 MB")
|
|
})
|
|
})
|
|
|
|
describe("test the url helpers", () => {
|
|
const url = "http://example.com?query=1"
|
|
it("should allow use of the stripQueryString helper", async () => {
|
|
const output = await processString("{{stripQuerystring url }}", {
|
|
url,
|
|
})
|
|
expect(output).toBe("http://example.com")
|
|
})
|
|
|
|
it("should allow use of the stripProtocol helper", async () => {
|
|
const output = await processString("{{ stripProtocol url }}", {
|
|
url,
|
|
})
|
|
expect(output).toBe("//example.com/?query=1")
|
|
})
|
|
|
|
it("should allow use of the urlParse helper", async () => {
|
|
const output = await processString("{{ object ( urlParse url ) }}", {
|
|
url,
|
|
})
|
|
expect(output).toBe(
|
|
'{"protocol":"http:","slashes":true,"auth":null,"host":"example.com",' +
|
|
'"port":null,"hostname":"example.com","hash":null,"search":"?query=1",' +
|
|
'"query":"query=1","pathname":"/","path":"/?query=1",' +
|
|
'"href":"http://example.com/?query=1"}'
|
|
)
|
|
})
|
|
})
|
|
|
|
describe("test the date helpers", () => {
|
|
it("should allow use of the date helper", async () => {
|
|
const date = new Date(1611577535000)
|
|
const output = await processString("{{ date time 'YYYY-MM-DD' }}", {
|
|
time: date.toUTCString(),
|
|
})
|
|
expect(output).toBe("2021-01-25")
|
|
})
|
|
|
|
it("should allow use of the date helper with now time", async () => {
|
|
const date = new Date()
|
|
const output = await processString("{{ date now 'DD' }}", {})
|
|
expect(parseInt(output)).toBe(date.getDate())
|
|
})
|
|
|
|
it("should test the timezone capabilities", async () => {
|
|
const date = new Date(1611577535000)
|
|
const output = await processString(
|
|
"{{ date time 'HH-mm-ss Z' 'America/New_York' }}",
|
|
{
|
|
time: date.toUTCString(),
|
|
}
|
|
)
|
|
const formatted = dayjs(date).tz("America/New_York").format("HH-mm-ss Z")
|
|
expect(output).toBe(formatted)
|
|
})
|
|
|
|
it("should guess the users timezone when not specified", async () => {
|
|
const date = new Date()
|
|
const output = await processString("{{ date time 'Z' }}", {
|
|
time: date.toUTCString(),
|
|
})
|
|
const timezone = dayjs.tz.guess()
|
|
const offset = dayjs(date).tz(timezone).format("Z")
|
|
expect(output).toBe(offset)
|
|
})
|
|
})
|
|
|
|
describe("test the string helpers", () => {
|
|
it("should allow use of the append helper", async () => {
|
|
const output = await processString("{{ append filename '.txt' }}", {
|
|
filename: "yummy",
|
|
})
|
|
expect(output).toBe("yummy.txt")
|
|
})
|
|
|
|
it("should allow use of the camelcase helper", async () => {
|
|
const output = await processString("{{ camelcase camel }}", {
|
|
camel: "testing this thing",
|
|
})
|
|
expect(output).toBe("testingThisThing")
|
|
})
|
|
|
|
it("should allow use of the capitalize helper", async () => {
|
|
const output = await processString("{{ capitalize string }}", {
|
|
string: "this is a string",
|
|
})
|
|
expect(output).toBe("This is a string")
|
|
})
|
|
|
|
it("should allow use of the capitalizeAll helper", async () => {
|
|
const output = await processString("{{ capitalizeAll string }}", {
|
|
string: "this is a string",
|
|
})
|
|
expect(output).toBe("This Is A String")
|
|
})
|
|
|
|
it("should allow use of the replace helper", async () => {
|
|
const output = await processString("{{ replace string 'Mike' name }}", {
|
|
string: "Hello my name is Mike",
|
|
name: "David",
|
|
})
|
|
expect(output).toBe("Hello my name is David")
|
|
})
|
|
|
|
it("should allow use of the split helper", async () => {
|
|
const output = await processString("{{ first ( split string ' ' ) }}", {
|
|
string: "this is a string",
|
|
})
|
|
expect(output).toBe("this")
|
|
})
|
|
|
|
it("should allow use of the remove helper", async () => {
|
|
const output = await processString("{{ remove string 'string' }}", {
|
|
string: "this is a string",
|
|
})
|
|
expect(output).toBe("this is a ")
|
|
})
|
|
|
|
it("should allow use of the startsWith helper", async () => {
|
|
const output = await processString(
|
|
"{{ #startsWith 'Hello' string }}Hi!{{ else }}Goodbye!{{ /startsWith }}",
|
|
{
|
|
string: "Hello my name is Mike",
|
|
}
|
|
)
|
|
expect(output).toBe("Hi!")
|
|
})
|
|
|
|
it("should allow use of the ellipsis helper", async () => {
|
|
const output = await processString('{{ ellipsis "adfasdfasdfasf" 7 }}', {})
|
|
expect(output).toBe("adfasdf…")
|
|
})
|
|
})
|
|
|
|
describe("test the comparison helpers", () => {
|
|
async function compare(func, a, b) {
|
|
const output = await processString(
|
|
`{{ #${func} a b }}Success{{ else }}Fail{{ /${func} }}`,
|
|
{
|
|
a,
|
|
b,
|
|
}
|
|
)
|
|
expect(output).toBe("Success")
|
|
}
|
|
|
|
it("should allow use of the lt helper", async () => {
|
|
await compare("lt", 10, 15)
|
|
})
|
|
|
|
it("should allow use of the gt helper", async () => {
|
|
await compare("gt", 15, 10)
|
|
})
|
|
|
|
it("should allow use of the and helper", async () => {
|
|
await compare("and", true, true)
|
|
})
|
|
|
|
it("should allow use of the or helper", async () => {
|
|
await compare("or", false, true)
|
|
})
|
|
|
|
it("should allow use of gte with a literal value", async () => {
|
|
const output = await processString(
|
|
`{{ #gte a "50" }}s{{ else }}f{{ /gte }}`,
|
|
{
|
|
a: 51,
|
|
}
|
|
)
|
|
expect(output).toBe("s")
|
|
})
|
|
})
|
|
|
|
describe("Test the object/array helper", () => {
|
|
it("should allow plucking from an array of objects", async () => {
|
|
const context = {
|
|
items: [{ price: 20 }, { price: 30 }],
|
|
}
|
|
const output = await processString(
|
|
"{{ literal ( sum ( pluck items 'price' ) ) }}",
|
|
context
|
|
)
|
|
expect(output).toBe(50)
|
|
})
|
|
|
|
it("should allow use of the length helper", async () => {
|
|
const array = [1, 2, 3]
|
|
const output = await processString("{{ length array }}", { array })
|
|
expect(output).toBe("3")
|
|
})
|
|
|
|
it("should allow use of the length helper inline", async () => {
|
|
const output = await processString(`{{ length '[1, 2, 3]' }}`, {})
|
|
expect(output).toBe("3")
|
|
})
|
|
})
|
|
|
|
describe("Test the literal helper", () => {
|
|
it("should allow use of the literal specifier for a number", async () => {
|
|
const output = await processString(`{{literal a}}`, {
|
|
a: 51,
|
|
})
|
|
expect(output).toBe(51)
|
|
})
|
|
|
|
it("should allow use of the literal specifier for an object", async () => {
|
|
const output = await processString(`{{literal a}}`, {
|
|
a: { b: 1 },
|
|
})
|
|
expect(output.b).toBe(1)
|
|
})
|
|
|
|
it("should allow use of the literal specifier for an object with dashes", async () => {
|
|
const output = await processString(`{{literal a}}`, {
|
|
a: { b: "i-have-dashes" },
|
|
})
|
|
expect(output.b).toBe("i-have-dashes")
|
|
})
|
|
})
|
|
|
|
describe("Test that JSONpase helper", () => {
|
|
it("should state that the JSONparse helper is valid", async () => {
|
|
const output = isValid(`{{ JSONparse input }}`)
|
|
expect(output).toBe(true)
|
|
})
|
|
})
|
|
|
|
describe("Cover a few complex use cases", () => {
|
|
it("should allow use of three different collection helpers", async () => {
|
|
const output = await processString(
|
|
`{{ join ( after ( split "My name is: Joe Smith" " " ) 3 ) " " }}`,
|
|
{}
|
|
)
|
|
expect(output).toBe("Joe Smith")
|
|
})
|
|
|
|
it("should allow a complex array case", async () => {
|
|
const output = await processString("{{ last ( sort ( unique array ) ) }}", {
|
|
array: ["a", "a", "d", "c", "e"],
|
|
})
|
|
expect(output).toBe("e")
|
|
})
|
|
|
|
it("should allow a complex forIn case", async () => {
|
|
const input = `{{#forIn (JSONparse '{"a":1, "b":2, "c":3}' )}}number: {{.}}\n{{/forIn}}`
|
|
const output = await processString(input, {})
|
|
expect(output).toBe("number: 1\nnumber: 2\nnumber: 3\n")
|
|
})
|
|
|
|
it("should make sure case is valid", () => {
|
|
const validity = isValid(
|
|
"{{ avg [c355ec2b422e54f988ae553c8acd811ea].[a] [c355ec2b422e54f988ae553c8acd811ea].[b] }}"
|
|
)
|
|
expect(validity).toBe(true)
|
|
})
|
|
|
|
it("should make sure object functions check out valid", () => {
|
|
const validity = isValid("{{ JSONstringify obj }}")
|
|
expect(validity).toBe(true)
|
|
})
|
|
|
|
it("should be able to solve an example from docs", async () => {
|
|
const output = await processString(`{{first ( split "a-b-c" "-") 2}}`, {})
|
|
expect(output).toBe(`a,b`)
|
|
})
|
|
|
|
it("should confirm a subtraction validity", () => {
|
|
const validity = isValid(
|
|
"{{ subtract [c390c23a7f1b6441c98d2fe2a51248ef3].[total profit] [c390c23a7f1b6441c98d2fe2a51248ef3].[total revenue] }}"
|
|
)
|
|
expect(validity).toBe(true)
|
|
})
|
|
|
|
it("should test a case of attempting to get a UTC ISO back out after processing", async () => {
|
|
const date = new Date()
|
|
const input = `{{ date (subtract (date dateThing "x") 300000) "" }}`
|
|
const output = await processString(input, {
|
|
dateThing: date.toISOString(),
|
|
})
|
|
expect(output).toEqual(new Date(date.getTime() - 300000).toISOString())
|
|
})
|
|
|
|
it("test a very complex duration output", async () => {
|
|
const currentTime = new Date(1612432082000).toISOString(),
|
|
eventTime = new Date(1612432071000).toISOString()
|
|
const input = `{{duration ( subtract (date currentTime "X")(date eventTime "X")) "seconds"}}`
|
|
const output = await processString(input, {
|
|
currentTime,
|
|
eventTime,
|
|
})
|
|
expect(output).toBe("a few seconds")
|
|
})
|
|
|
|
it("should confirm a bunch of invalid strings", () => {
|
|
const invalids = ["{{ awd )", "{{ awdd () ", "{{ awdwad ", "{{ awddawd }"]
|
|
for (let invalid of invalids) {
|
|
const validity = isValid(invalid)
|
|
expect(validity).toBe(false)
|
|
}
|
|
})
|
|
|
|
it("input a garbage string, expect it to be returned", async () => {
|
|
const input = `{{{{{{ } {{ ]] ] ] }}} {{ ] {{ { } { dsa { dddddd }}}}}}} }DDD`
|
|
const output = await processString(input, {})
|
|
expect(output).toBe(input)
|
|
})
|
|
|
|
it("getting a nice date from the user", async () => {
|
|
const input = { text: `{{ date user.subscriptionDue "DD-MM" }}` }
|
|
const context = JSON.parse(
|
|
`{"user":{"email":"test@example.com","roleId":"ADMIN","type":"user","tableId":"ta_users","subscriptionDue":"2021-01-12T12:00:00.000Z","_id":"ro_ta_users_us_test@example.com","_rev":"2-24cc794985eb54183ecb93e148563f3d"}}`
|
|
)
|
|
const output = await processObject(input, context)
|
|
expect(output.text).toBe("12-01")
|
|
})
|
|
|
|
it("should only invalidate a single string in an object", async () => {
|
|
const input = {
|
|
dataProvider: "{{ literal [c670254c9e74e40518ee5becff53aa5be] }}",
|
|
theme: "spectrum--lightest",
|
|
showAutoColumns: false,
|
|
quiet: true,
|
|
size: "spectrum--medium",
|
|
rowCount: 8,
|
|
}
|
|
const output = await processObject(input, tableJson)
|
|
expect(output.dataProvider).not.toBe("Invalid binding")
|
|
})
|
|
|
|
it("should be able to handle external ids", async () => {
|
|
const input = {
|
|
dataProvider: "{{ literal [_id] }}",
|
|
}
|
|
const context = {
|
|
_id: "%5B%221%22%2C%221%22%5D",
|
|
}
|
|
const output = await processObject(input, context)
|
|
expect(output.dataProvider).toBe("%5B%221%22%2C%221%22%5D")
|
|
})
|
|
})
|
|
|
|
describe("uuid", () => {
|
|
it("should be able to generate a UUID", async () => {
|
|
const output = await processString("{{ uuid }}", {})
|
|
expect(output).toMatch(UUID_REGEX)
|
|
})
|
|
})
|