@platforma-sdk/workflow-tengo 2.9.6 → 2.9.8

package/dist/tengo/lib/path.lib.tengo

@@ -3,163 +3,163 @@ text := import("text")
 slices := import("@platforma-sdk/workflow-tengo:slices")
 validation := import("@platforma-sdk/workflow-tengo:validation")
 
-
-
-
-
-
+/**
+ * Joins path elements into a single path.
+ *
+ * @param elems: ...string - any number of elements.
+ */
 join := func(...elems) {
-validation.assertJsonSchema(elems, ["string"])
-return ll.filepathJoin(elems...)
+	validation.assertJsonSchema(elems, ["string"])
+	return ll.filepathJoin(elems...)
 }
 
-
-
-
-
-
-
+/**
+ * Like join, joins elements to a single path,
+ * but can be used safely in regexps.
+ *
+ * @param elems: ...string - any number of elements.
+ */
 regexpJoin := func(...elems) {
-validation.assertJsonSchema(elems, ["string"])
-return ll.filepathRegexpJoin(elems...)
+	validation.assertJsonSchema(elems, ["string"])
+	return ll.filepathRegexpJoin(elems...)
 }
 
-
-
-
-
-
-
-
+/**
+ * Joins elements of the filepath and canonizes it, i.e.
+ * semantically resolves ../ and ./ and changes slash
+ * to a pathSeparator.
+ *
+ * @param elems: ...string - any number of elements.
+ */
 canonize := func(...elems) {
-validation.assertJsonSchema(elems, ["string"])
-return ll.filepathCanonize(elems...)
+	validation.assertJsonSchema(elems, ["string"])
+	return ll.filepathCanonize(elems...)
 }
 
-
-
-
-
-
+/**
+ * Returns a path separator. "/" on Unix-like systems, "\\" on Windows.
+ *
+ * @return separator: string
+ */
 separator := ll.pathSeparator
 
-
-
-
-
-
-
-
+/**
+ * Trims a beginning of the file path following by a path separator.
+ *
+ * @param path: string - a file path
+ * @param prefix: string - the beginning of the file path
+ * @return trimmed path: string - a path without the beginning and a path separator.
+ */
 trimPrefix := func(path, prefix) {
-validation.assertJsonSchema([path, prefix], ["string"])
-return text.trim_prefix(path, prefix+separator)
+	validation.assertJsonSchema([path, prefix], ["string"])
+	return text.trim_prefix(path, prefix+separator)
 }
 
 _sepOrDefault := func(...sep) {
-validation.assertJsonSchema(sep, [["or", "string", "char", "null"]])
+	validation.assertJsonSchema(sep, [["or", "string", "char", "null"]])
 
-if slices.length(sep) == 0 {
-return separator
-}
+	if slices.length(sep) == 0 {
+		return separator
+	}
 
-return sep[0]
+	return sep[0]
 }
 
-
-
-
-
-
-
-
-
+/**
+ * Splits a path to path components.
+ * If it was a file name, the last component will be this name.
+ *
+ * @param path: string - the path
+ * @param sep: string - an optional path separator.
+ * @return components: []string - all directories and a file name at the end.
+ */
 split := func(path, ...sep) {
-sep = _sepOrDefault(sep...)
+	sep = _sepOrDefault(sep...)
 
-return text.split(path, sep)
+	return text.split(path, sep)
 }
 
-
-
-
-
-
-
-
-
-
+/**
+ * Gets all directories with their ancestors from the root.
+ * For example, for dir1/dir2/dir3/abc.txt it gives:
+ * ["dir1", "dir1/dir2", "dir1/dir2/dir3", "dir1/dir2/dir3/abc.txt"]
+ *
+ * @param path: string - the path
+ * @param separator: string - an optional separator.
+ * @return components: []string - all directories and a file name at the end from their root.
+ */
 getBasenameDirs := func(path, ...sep) {
-validation.assertJsonSchema(path, "string")
-sep = _sepOrDefault(sep...)
+	validation.assertJsonSchema(path, "string")
+	sep = _sepOrDefault(sep...)
 
-dirs := split(path, sep)
+	dirs := split(path, sep)
 
-dirTails := []
-for i := 1; i <= len(dirs); i++ {
-dirTails = append(dirTails, text.join(dirs[:i], sep))
-}
+	dirTails := []
+	for i := 1; i <= len(dirs); i++ {
+		dirTails = append(dirTails, text.join(dirs[:i], sep))
+	}
 
-return dirTails
+	return dirTails
 }
 
-
-
-
-
-
-
-
-
+/**
+ * Gets an extension to the last "." symbol,
+ * or, if the name contains ".gz" or any other archive suffix,
+ * then till the next from the last "." symbol.
+ *
+ * @param path: string - a path
+ * @return extension: string - the extension without the leading "."
+ */
 getExtension := func(path, ...sep) {
-validation.assertJsonSchema(path, "string")
-ext := ""
-sep = _sepOrDefault(sep...)
-
-nPoints := 1
-if text.re_match(`\.(gz|xz|bzip|zstd)$`, path) {
-nPoints = 2
-}
-
-for i := len(path) - 1; i >= 0 && path[i] != sep; i-- {
-if path[i] == '.' {
-ext = path[i:]
-nPoints--
-if nPoints == 0 {
-break
-}
-}
-}
-
-if len(ext) > 0 {
-ext = ext[1:] // remove leading "."
-}
-
-return ext
-}
-
-
-
-
-
-
+	validation.assertJsonSchema(path, "string")
+	ext := ""
+	sep = _sepOrDefault(sep...)
+
+	nPoints := 1
+	if text.re_match(`\.(gz|xz|bzip|zstd)$`, path) {
+		nPoints = 2
+	}
+
+	for i := len(path) - 1; i >= 0 && path[i] != sep; i-- {
+		if path[i] == '.' {
+			ext = path[i:]
+			nPoints--
+			if nPoints == 0 {
+				break
+			}
+		}
+	}
+
+	if len(ext) > 0 {
+		ext = ext[1:] // remove leading "."
+	}
+
+	return ext
+}
+
+/**
+ * Checks if the path is correct.
+ *
+ * @param path: string - a path
+ */
 assertIsValid := func(path) {
-validation.assertJsonSchema(path, "string")
-if text.contains(path, "/") {
-ll.assert(
-text.contains(path, separator),
-"path to a file must be separated by OS's specific path separator. " +
-"Did you forget to use 'path.join' or 'path.regexpJoin'?")
-}
+	validation.assertJsonSchema(path, "string")
+	if text.contains(path, "/") {
+		ll.assert(
+			text.contains(path, separator),
+			"path to a file must be separated by OS's specific path separator. " +
+				"Did you forget to use 'path.join' or 'path.regexpJoin'?")
+	}
 }
 
 export ll.toStrict({
-join: join,
-regexpJoin: regexpJoin,
-canonize: canonize,
-separator: separator,
-trimPrefix: trimPrefix,
-split: split,
-getBasenameDirs: getBasenameDirs,
-getExtension: getExtension,
-assertIsValid: assertIsValid
+	join: join,
+	regexpJoin: regexpJoin,
+	canonize: canonize,
+	separator: separator,
+	trimPrefix: trimPrefix,
+	split: split,
+	getBasenameDirs: getBasenameDirs,
+	getExtension: getExtension,
+	assertIsValid: assertIsValid
 })

package/dist/tengo/lib/pframes.constants.lib.tengo

@@ -1,20 +1,20 @@
-
-
-
-
+/**
+ * Contain field names and other constant used in PFrames
+ * libraries and templates.
+ */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 
-
-
-
-
+/**
+ * Name of the field under which the iteration value like in "map" and "aggregate" is passed
+ * to the iteration body template.
+ */
 VALUE_FIELD_NAME := "__value__"
 
-
-
-
-
+/**
+ * Name of the field under which the iteration key like in "map" and "aggregate" is passed
+ * to the iteration body template.
+ */
 KEY_FIELD_NAME := "__key__"
 
 RTYPE_P_FRAME :=  { Name: "PFrame", Version: "1" }
@@ -34,20 +34,20 @@ RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED := { Name: P_COLUMN_SUPER_PARTITION
 KIND_P_COLUMN := "PColumn"
 
 export ll.toStrict({
-KIND_P_COLUMN                                 : KIND_P_COLUMN,
-KEY_FIELD_NAME                                : KEY_FIELD_NAME,
-VALUE_FIELD_NAME                              : VALUE_FIELD_NAME,
-P_COLUMN_DATA_TYPE_PREFIX                     : P_COLUMN_DATA_TYPE_PREFIX,
-P_COLUMN_SUPER_PARTITIONED_DATA_TYPE_PREFIX   : P_COLUMN_SUPER_PARTITIONED_DATA_TYPE_PREFIX,
-
-RTYPE_P_FRAME                                 : RTYPE_P_FRAME,
-
-RTYPE_P_COLUMN_DATA_JSON                      : RTYPE_P_COLUMN_DATA_JSON,
-RTYPE_P_COLUMN_DATA_BINARY                    : RTYPE_P_COLUMN_DATA_BINARY,
-RTYPE_P_COLUMN_DATA_RESOURCE_MAP              : RTYPE_P_COLUMN_DATA_RESOURCE_MAP,
-RTYPE_P_COLUMN_DATA_RESOURCE_MAP_PARTITIONED  : RTYPE_P_COLUMN_DATA_RESOURCE_MAP_PARTITIONED,
-RTYPE_P_COLUMN_DATA_JSON_PARTITIONED          : RTYPE_P_COLUMN_DATA_JSON_PARTITIONED,
-RTYPE_P_COLUMN_DATA_BINARY_PARTITIONED        : RTYPE_P_COLUMN_DATA_BINARY_PARTITIONED,
-RTYPE_P_COLUMN_DATA_JSON_SUPER_PARTITIONED    : RTYPE_P_COLUMN_DATA_JSON_SUPER_PARTITIONED,
-RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED  : RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED
+	KIND_P_COLUMN                                 : KIND_P_COLUMN,
+	KEY_FIELD_NAME                                : KEY_FIELD_NAME,
+	VALUE_FIELD_NAME                              : VALUE_FIELD_NAME,
+	P_COLUMN_DATA_TYPE_PREFIX                     : P_COLUMN_DATA_TYPE_PREFIX,
+	P_COLUMN_SUPER_PARTITIONED_DATA_TYPE_PREFIX   : P_COLUMN_SUPER_PARTITIONED_DATA_TYPE_PREFIX,
+
+	RTYPE_P_FRAME                                 : RTYPE_P_FRAME,
+
+	RTYPE_P_COLUMN_DATA_JSON                      : RTYPE_P_COLUMN_DATA_JSON,
+	RTYPE_P_COLUMN_DATA_BINARY                    : RTYPE_P_COLUMN_DATA_BINARY,
+	RTYPE_P_COLUMN_DATA_RESOURCE_MAP              : RTYPE_P_COLUMN_DATA_RESOURCE_MAP,
+	RTYPE_P_COLUMN_DATA_RESOURCE_MAP_PARTITIONED  : RTYPE_P_COLUMN_DATA_RESOURCE_MAP_PARTITIONED,
+	RTYPE_P_COLUMN_DATA_JSON_PARTITIONED          : RTYPE_P_COLUMN_DATA_JSON_PARTITIONED,
+	RTYPE_P_COLUMN_DATA_BINARY_PARTITIONED        : RTYPE_P_COLUMN_DATA_BINARY_PARTITIONED,
+	RTYPE_P_COLUMN_DATA_JSON_SUPER_PARTITIONED    : RTYPE_P_COLUMN_DATA_JSON_SUPER_PARTITIONED,
+	RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED  : RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED
 })

package/dist/tengo/lib/pframes.export-pcolumn.lib.tengo

@@ -5,43 +5,43 @@ file := import("@platforma-sdk/workflow-tengo:file")
 ll := import("@platforma-sdk/workflow-tengo:ll")
 assets := import("@platforma-sdk/workflow-tengo:assets")
 
-
+// reference to the template doing nested super-partitioned export
 nestedTpl := assets.importTemplate("@platforma-sdk/workflow-tengo:pframes.export-single-pcolumn")
 
-
+/** Implements core export logic for export-single-pcolumn and export-multiple-pcolumns templates */
 exportPColumnData := func(data) {
-if data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_RESOURCE_MAP_PARTITIONED) ||
-data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_JSON_SUPER_PARTITIONED) ||
-data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED) {
-
-
-newData := smart.structBuilder(data.info().Type, data.info().Data)
-for key, partData in data.inputs() {
-newData.createInputField(key).set(render.createEphemeral(nestedTpl, { data: partData }).output("result"))
-}
-return newData.lockAndBuild()
-
-} else if data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_RESOURCE_MAP) ||
-data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_JSON_PARTITIONED) ||
-data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_BINARY_PARTITIONED) {
-
-
-newData := smart.structBuilder(data.info().Type, data.info().Data)
-for key, partData in data.inputs() {
-newData.createInputField(key).set(file.exportFile(partData))
-}
-return newData.lockAndBuild()
-
-} else if data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_JSON) {
-
-
-return data
-
-} else {
-ll.panic("unknonw resource type: %v", data.info().Type)
-}
+	if data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_RESOURCE_MAP_PARTITIONED) ||
+		data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_JSON_SUPER_PARTITIONED) ||
+		data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_BINARY_SUPER_PARTITIONED) {
+		// super-partitioned data
+
+		newData := smart.structBuilder(data.info().Type, data.info().Data)
+		for key, partData in data.inputs() {
+			newData.createInputField(key).set(render.createEphemeral(nestedTpl, { data: partData }).output("result"))
+		}
+		return newData.lockAndBuild()
+
+	} else if data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_RESOURCE_MAP) ||
+		data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_JSON_PARTITIONED) ||
+		data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_BINARY_PARTITIONED) {
+		// data directly referencing blob objects
+
+		newData := smart.structBuilder(data.info().Type, data.info().Data)
+		for key, partData in data.inputs() {
+			newData.createInputField(key).set(file.exportFile(partData))
+		}
+		return newData.lockAndBuild()
+
+	} else if data.checkResourceType(pConstants.RTYPE_P_COLUMN_DATA_JSON) {
+		// data embeds all information and needs no special exporting procedure
+
+		return data
+
+	} else {
+		ll.panic("unknonw resource type: %v", data.info().Type)
+	}
 }
 
 export ll.toStrict({
-exportPColumnData: exportPColumnData
+	exportPColumnData: exportPColumnData
 })

package/dist/tengo/lib/pframes.lib.tengo

@@ -1,6 +1,6 @@
-
-
-
+/**
+ * Working with p-frames
+ */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 oop := import("@platforma-sdk/workflow-tengo:oop")
@@ -9,57 +9,57 @@ assets := import("@platforma-sdk/workflow-tengo:assets")
 render := import("@platforma-sdk/workflow-tengo:render")
 constants := import("@platforma-sdk/workflow-tengo:pframes.constants")
 
-
-
-
-
+/**
+ * Given a reference to the p-frame, converts all inner resource files into resources that can be
+ * downloaded from the UI side.
+ */
 exportFrame := func(pf) {
-return render.createEphemeral(assets.importTemplate("@platforma-sdk/workflow-tengo:pframes.export-pframe"), { pf: pf }).output("result")
+	return render.createEphemeral(assets.importTemplate("@platforma-sdk/workflow-tengo:pframes.export-pframe"), { pf: pf }).output("result")
 }
 
-
-
-
+/**
+ * Export single PColumn data
+ */
 exportColumnData := func(data) {
-return render.createEphemeral(assets.importTemplate("@platforma-sdk/workflow-tengo:pframes.export-single-pcolumn"), { data: data }).output("result")
+	return render.createEphemeral(assets.importTemplate("@platforma-sdk/workflow-tengo:pframes.export-single-pcolumn"), { data: data }).output("result")
 }
 
-
-
-
+/**
+ * Creates a builder for p-frame resource.
+ */
 pFrameBuilder := func() {
-r := smart.structBuilder(constants.RTYPE_P_FRAME)
-
-self := undefined
-self = ll.toStrict(oop.inherit(r, {
-
-add: func(column, spec, data) {
-if (!is_undefined(spec)) {
-r.createInputField(column + ".spec").setRefOrJson(spec)
-}
-if (!is_undefined(data)) {
-r.createInputField(column + ".data").setRefOrJson(data)
+	r := smart.structBuilder(constants.RTYPE_P_FRAME)
+
+	self := undefined
+	self = ll.toStrict(oop.inherit(r, {
+
+		add: func(column, spec, data) {
+			if (!is_undefined(spec)) {
+				r.createInputField(column + ".spec").setRefOrJson(spec)
+			}
+			if (!is_undefined(data)) {
+				r.createInputField(column + ".data").setRefOrJson(data)
+			}
+			return self
+		},
+
+		build: func() {
+			return r.lockAndBuild()
+		}
+	}))
+	return self
 }
-return self
-},
-
-build: func() {
-return r.lockAndBuild()
-}
-}))
-return self
-}
-
-
-
 
+/**
+ * Creates a builder for a resource map p-column's data.
+ */
 pColumnResourceMapDataBuilder := func(keyLength) {
-ll.panic("pframes.pColumnResourceMapDataBuilder is not supported any more; use pcolumn.resourceMapBuilder")
+	ll.panic("pframes.pColumnResourceMapDataBuilder is not supported any more; use pcolumn.resourceMapBuilder")
 }
 
 export ll.toStrict({
-exportFrame: exportFrame,
-pFrameBuilder: pFrameBuilder,
-exportColumnData: exportColumnData,
-pColumnResourceMapDataBuilder: pColumnResourceMapDataBuilder
+	exportFrame: exportFrame,
+	pFrameBuilder: pFrameBuilder,
+	exportColumnData: exportColumnData,
+	pColumnResourceMapDataBuilder: pColumnResourceMapDataBuilder
 })