@platforma-sdk/workflow-tengo 2.9.6 → 2.9.8

package/dist/tengo/lib/render.lib.tengo

@@ -1,6 +1,6 @@
-
-
-
+/*
+ * Create renderer objects to render templates from the code
+ */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 assets := import("@platforma-sdk/workflow-tengo:assets")
@@ -14,87 +14,87 @@ times := import("times")
 
 _SUBSCRIPTION_FIELD := "subscription"
 
-
-
-
-
-
-
-
-
+/**
+ * Creates a render template resource.
+ *
+ * @param tpl: template resource (see assets.importTemplate())
+ * @param isEph: whether template is ephemeral
+ * @param inputs: a map of inputs to be passed to the template
+ * @return renderer: a smart resource with additional output("name") method
+ */
 createUniversal := func(tpl, isEph, inputs) {
 
-
-rbuilder := undefined
-if isEph {
-rbuilder = smart.ephemeralBuilder(constants.RTYPE_RENDER_EPH_TEMPLATE)
-}  else {
-rbuilder = smart.structBuilder(constants.RTYPE_RENDER_TEMPLATE)
-}
-
-if isEph {
-
-rbuilder.createField(_SUBSCRIPTION_FIELD, "OTW")
-}
-
-
-rbuilder.createInputField(tplutil.TEMPLATE_FIELD).set(tpl)
-
-
-inputsMap := isEph ? smart.ephemeralMapBuilder() : smart.mapBuilder()
-for name, value in inputs {
-inputsMap.add(name, value)
-}
-
-rbuilder.createInputField(tplutil.INPUTS_MAP_FIELD).set(inputsMap.build())
-
-renderer := rbuilder.lockInputsAndBuild()
-
-self := undefined
-self = ll.toStrict(oop.inherit(renderer, {
-
-
-
-
-output: func(name, ...cache) {
-ll.assert(len(cache) == 0 || is_int(cache[0]), "cache should be a number (use 'times' tengo library), got: %v", cache)
-out := renderer.getFutureOutputField(tplutil.TEMPLATE_OUTPUT_PREFIX + name, isEph)
-if len(cache) > 0 && cache[0] > 0 {
-cache = cache[0]
-tx.cacheSetToField(out.id, cache)
-}
-
-return out
-}
-}))
-
-return self
+	// build renderer resource
+	rbuilder := undefined
+	if isEph {
+		rbuilder = smart.ephemeralBuilder(constants.RTYPE_RENDER_EPH_TEMPLATE)
+	}  else {
+		rbuilder = smart.structBuilder(constants.RTYPE_RENDER_TEMPLATE)
+	}
+
+	if isEph {
+		// create internal subscription field
+		rbuilder.createField(_SUBSCRIPTION_FIELD, "OTW")
+	}
+
+	// template input
+	rbuilder.createInputField(tplutil.TEMPLATE_FIELD).set(tpl)
+
+	// inputs input
+	inputsMap := isEph ? smart.ephemeralMapBuilder() : smart.mapBuilder()
+	for name, value in inputs {
+		inputsMap.add(name, value)
+	}
+
+	rbuilder.createInputField(tplutil.INPUTS_MAP_FIELD).set(inputsMap.build())
+	// build
+	renderer := rbuilder.lockInputsAndBuild()
+
+	self := undefined
+	self = ll.toStrict(oop.inherit(renderer, {
+
+		/**
+		 * Returns an output field with a given name
+		 */
+		output: func(name, ...cache) {
+			ll.assert(len(cache) == 0 || is_int(cache[0]), "cache should be a number (use 'times' tengo library), got: %v", cache)
+			out := renderer.getFutureOutputField(tplutil.TEMPLATE_OUTPUT_PREFIX + name, isEph)
+			if len(cache) > 0 && cache[0] > 0 {
+				cache = cache[0]
+				tx.cacheSetToField(out.id, cache)
+			}
+
+			return out
+		}
+	}))
+
+	return self
 }
 
-
-
-
-
-
-
-
+/**
+ * Creates a render template resource.
+ *
+ * @param tpl: template resource (see assets.importTemplate())
+ * @param inputs: a map of inputs to be passed to the template
+ * @return renderer: a smart resource with additional output("name") method
+ */
 create := func(tpl, inputs) {
-return createUniversal(tpl, false, inputs)
+	return createUniversal(tpl, false, inputs)
 }
 
-
-
-
-
-
-
-
+/**
+ * Creates ephemeral render template resource.
+ *
+ * @param tpl: template resource (see assets.importTemplate())
+ * @param inputs: a map of inputs to be passed to the template
+ * @return renderer: a smart resource with additional output("name") method
+ */
 createEphemeral := func(tpl, inputs) {
-return createUniversal(tpl, true, inputs)
+	return createUniversal(tpl, true, inputs)
 }
 
 export ll.toStrict({
-createUniversal: createUniversal,
-create: create,
-createEphemeral: createEphemeral
+	createUniversal: createUniversal,
+	create: create,
+	createEphemeral: createEphemeral
 })

package/dist/tengo/lib/sets.lib.tengo

@@ -1,93 +1,93 @@
-
-
-
-
-
+/**
+ * Functions for working with sets of elements,
+ * in Tengo they are just maps with truthy values.
+ * Keys of the map can be only either strings or numbers.
+ */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 maps := import("@platforma-sdk/workflow-tengo:maps")
 
-
-
-
-
-
-
+/**
+ * Turns a slice to a set of values.
+ *
+ * @param slice: slice<string|number>
+ * @return result: set<string|number>
+ */
 fromSlice := func(slice) {
-set := {}
-for _, elem in slice {
-set[elem] = true
-}
-return set
+	set := {}
+	for _, elem in slice {
+		set[elem] = true
+	}
+	return set
 }
 
-
-
-
-
-
-
+/**
+ * Convert given set to slice
+ *
+ * @param set: set - a set of values to be converted to slice
+ * @return slice: []<string|number>
+ */
 toSlice := func(set) {
-sl := []
-for v, _ in set {
-sl = append(sl, v)
+	sl := []
+	for v, _ in set {
+		sl = append(sl, v)
+	}
+	return sl
 }
-return sl
-}
-
-
-
-
-
-
-
 
+/**
+ * Checks if a set has an element.
+ *
+ * @param set a set of any elements
+ * @param element any
+ * @return found: bool
+ */
 hasElement := func(set, element) {
-return !is_undefined(set[element])
+	return !is_undefined(set[element])
 }
 
-
-
-
-
-
-
-
+/**
+ * Adds elements to the set.
+ *
+ * @param set a set
+ * @param elements a slice of elements
+ * @return: result: set<string|number> - a changed old set with all old and new elements.
+ */
 add := func(set, ...elements) {
-for _, elem in elements {
-set[elem] = true
-}
+	for _, elem in elements {
+		set[elem] = true
+	}
 
-return set
+	return set
 }
 
-
-
-
-
-
-
+/**
+ * Returns a set of key of the map.
+ *
+ * @param map a map
+ * @return result: set<string|number>
+ */
 fromMapKeys := func(map) {
-keys := maps.getKeys(map)
-return fromSlice(keys)
+	keys := maps.getKeys(map)
+	return fromSlice(keys)
 }
 
-
-
-
-
-
-
-
+/**
+ * Transforms all keys of the map with a function and returns a new map with these keys.
+ *
+ * @param set: set
+ * @param fn: func(elem): newElem - a function that gets an element and returns a new element.
+ * @return new set: map[newElem]any - a transformed set
+ */
 map := func(set, fn) {
-return maps.mapKeys(set, fn)
+	return maps.mapKeys(set, fn)
 }
 
 export ll.toStrict({
-fromSlice: fromSlice,
-toSlice: toSlice,
-hasElement: hasElement,
-add: add,
-fromMapKeys: fromMapKeys,
-map: map
+	fromSlice: fromSlice,
+	toSlice: toSlice,
+	hasElement: hasElement,
+	add: add,
+	fromMapKeys: fromMapKeys,
+	map: map
 })