chore: rename and unit tests

packages/timeline-state-resolver-types/src/index.ts

@@ -174,7 +174,7 @@ export enum ActionExecutionResultCode {
 }
 
 /** This resolves to a string, where parts can be defined by the datastore */
-export interface TemplateString{
+export interface TemplateString {
 	/** The string template. Example: "http://google.com?q={{searchString}}" */
 	key: string
 	/** Values for the arguments in the key string. Example: { searchString: "TSR" } */

packages/timeline-state-resolver-types/src/integrations/casparcg.ts

@@ -1,4 +1,4 @@
-import { DeviceType, StringInterpolation } from '..'
+import { DeviceType, TemplateString } from '..'
 
 export enum TimelineContentTypeCasparCg { //  CasparCG-state
 	MEDIA = 'media',
@@ -122,7 +122,7 @@ export interface TimelineContentCCGInput extends TimelineContentCasparCGBase, Ti
 export interface TimelineContentCCGHTMLPage extends TimelineContentCasparCGBase, TimelineContentCCGProducerBase {
 	type: TimelineContentTypeCasparCg.HTMLPAGE
 	/** The URL to load */
-	url: string | StringInterpolation
+	url: string | TemplateString
 }
 export interface TimelineContentCCGTemplate extends TimelineContentCasparCGBase, TimelineContentCCGProducerBase {
 	type: TimelineContentTypeCasparCg.TEMPLATE

packages/timeline-state-resolver-types/src/integrations/httpSend.ts

@@ -1,12 +1,12 @@
-import { DeviceType, HTTPSendCommandContent, StringInterpolation } from '..'
+import { DeviceType, HTTPSendCommandContent, TemplateString } from '..'
 
 export type TimelineContentHTTPSendAny = TimelineContentHTTPRequest
 export interface TimelineContentHTTPSendBase {
 	deviceType: DeviceType.HTTPSEND
 }
 
 export interface HTTPSendCommandContentExt extends Omit<HTTPSendCommandContent, 'url'> {
-	url: string | StringInterpolation
+	url: string | TemplateString
 }
 
 export type TimelineContentHTTPRequest = TimelineContentHTTPSendBase & HTTPSendCommandContentExt

packages/timeline-state-resolver-types/src/integrations/sofieChef.ts

@@ -1,4 +1,4 @@
-import { DeviceType, StringInterpolation } from '..'
+import { DeviceType, TemplateString } from '..'
 
 export enum TimelineContentTypeSofieChef {
 	URL = 'url',
@@ -13,5 +13,5 @@ export interface TimelineContentSofieChef {
 export interface TimelineContentSofieChefScene extends TimelineContentSofieChef {
 	type: TimelineContentTypeSofieChef.URL
 
-	url: string | StringInterpolation
+	url: string | TemplateString
 }

packages/timeline-state-resolver/src/__tests__/lib.spec.ts

@@ -0,0 +1,34 @@
+import { interpolateTemplateString, interpolateTemplateStringIfNeeded } from '../lib'
+
+describe('interpolateTemplateString', () => {
+	test('basic input', () => {
+		expect(interpolateTemplateString('Hello there {{name}}', { name: 'Bob' })).toEqual('Hello there Bob')
+	})
+
+	test('missing arg', () => {
+		expect(interpolateTemplateString('Hello there {{name}}', {})).toEqual('Hello there name')
+	})
+
+	test('repeated arg', () => {
+		expect(interpolateTemplateString('Hello there {{name}} {{name}} {{name}}', { name: 'Bob' })).toEqual(
+			'Hello there Bob Bob Bob'
+		)
+	})
+})
+
+describe('interpolateTemplateStringIfNeeded', () => {
+	test('string input', () => {
+		const input = 'Hello there'
+
+		expect(interpolateTemplateStringIfNeeded(input)).toEqual(input)
+	})
+
+	test('object input', () => {
+		expect(
+			interpolateTemplateStringIfNeeded({
+				key: 'Hello there {{name}}',
+				args: { name: 'Bob' },
+			})
+		).toEqual('Hello there Bob')
+	})
+})

packages/timeline-state-resolver/src/integrations/casparCG/index.ts

@@ -61,7 +61,7 @@ import {
 	actionNotFoundMessage,
 	deepMerge,
 	endTrace,
-	interpolateTranslationIfNeeded,
+	interpolateTemplateStringIfNeeded,
 	literal,
 	startTrace,
 	t,
@@ -396,7 +396,7 @@ export class CasparCGDevice extends DeviceWithState<State, DeviceOptionsCasparCG
 				cgStop: content.useStopCommand,
 			})
 		} else if (content.type === TimelineContentTypeCasparCg.HTMLPAGE) {
-			const commandUrl = interpolateTranslationIfNeeded(content.url)
+			const commandUrl = interpolateTemplateStringIfNeeded(content.url)
 
 			stateLayer = literal<HtmlPageLayer>({
 				id: layer.id,

packages/timeline-state-resolver/src/integrations/httpSend/index.ts

@@ -16,7 +16,7 @@ import {
 } from 'timeline-state-resolver-types'
 import _ = require('underscore')
 import got, { OptionsOfTextResponseBody, RequestError } from 'got'
-import { interpolateTranslationIfNeeded, t } from '../../lib'
+import { interpolateTemplateStringIfNeeded, t } from '../../lib'
 import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent'
 import CacheableLookup from 'cacheable-lookup'
 
@@ -221,7 +221,7 @@ export class HTTPSendDevice extends Device<HTTPSendOptions, HttpSendDeviceState,
 				headers: command.content.headers,
 			}
 
-			const commandUrl: string = interpolateTranslationIfNeeded(command.content.url)
+			const commandUrl: string = interpolateTemplateStringIfNeeded(command.content.url)
 
 			const parsedUrl = new URL(commandUrl)
 			if (!this.options.noProxy?.includes(parsedUrl.host)) {

packages/timeline-state-resolver/src/integrations/sofieChef/stateBuilder.ts

@@ -7,7 +7,7 @@ import {
 	DeviceType,
 } from 'timeline-state-resolver-types'
 import type { SofieChefState } from '.'
-import { interpolateTranslationIfNeeded } from '../../lib'
+import { interpolateTemplateStringIfNeeded } from '../../lib'
 
 export function buildSofieChefState(
 	timelineState: Timeline.TimelineState<TSRTimelineContent>,
@@ -23,7 +23,7 @@ export function buildSofieChefState(
 		const content = layerState.content
 
 		if (mapping && content.deviceType === DeviceType.SOFIE_CHEF) {
-			const commandUrl = interpolateTranslationIfNeeded(content.url)
+			const commandUrl = interpolateTemplateStringIfNeeded(content.url)
 
 			sofieChefState.windows[mapping.options.windowId] = {
 				url: commandUrl,

packages/timeline-state-resolver/src/lib.ts

@@ -8,7 +8,7 @@ import {
 	ActionExecutionResultCode,
 	TimelineDatastoreReferences,
 	ActionExecutionResult,
-	StringInterpolation,
+	TemplateString,
 } from 'timeline-state-resolver-types'
 import * as _ from 'underscore'
 import { PartialDeep } from 'type-fest'
@@ -312,7 +312,7 @@ export function cloneDeep<T>(input: T): T {
 /**
  * Interpolate a translation style string
  */
-export function interpolateTranslation(key: string, args: { [key: string]: any } | undefined): string {
+export function interpolateTemplateString(key: string, args: { [key: string]: any } | undefined): string {
 	if (!args || typeof key !== 'string') {
 		return String(key)
 	}
@@ -326,7 +326,7 @@ export function interpolateTranslation(key: string, args: { [key: string]: any }
 	return interpolated
 }
 
-export function interpolateTranslationIfNeeded(str: string | StringInterpolation): string {
+export function interpolateTemplateStringIfNeeded(str: string | TemplateString): string {
 	if (typeof str === 'string') return str
-	return interpolateTranslation(str.key, str.args)
+	return interpolateTemplateString(str.key, str.args)
 }