@platforma-sdk/workflow-tengo 2.9.5 → 2.9.7

package/dist/tengo/lib/workdir.proc.lib.tengo

@@ -1,158 +1,158 @@
-
+/** Library for workdir processor templates */
 
 tpl := import("@platforma-sdk/workflow-tengo:tpl")
 ll := import("@platforma-sdk/workflow-tengo:ll")
 wdSave := import("@platforma-sdk/workflow-tengo:workdir.save")
 
-
+// the template has a defined outputs
 tpl.defineOutputs(["result", "workdir"])
 
 proc := func() {
-self := undefined
-
-self = {
-
-_wdBefore: undefined,
-
-
-
-wdBefore: func() {
-if is_undefined(self._wdBefore) {
-self._wdBefore = tpl.inputs().workdir
-}
-return self._wdBefore
-},
-
-_filesInWd: undefined,
-
-
-
-filesInWd: func() {
-if is_undefined(self._filesInWd) {
-self._filesInWd = self.wdBefore().getDataAsJson().files
-}
-
-return self._filesInWd
-},
-
-_wdAfterReadFiles: undefined,
-
-
-
-wdAfterReadFiles: func() {
-if is_undefined(self._wdAfterReadFiles) {
-
-if !is_undefined(tpl.inputs().wdAfterReadFiles) {
-
-
-
-
-
-self._wdAfterReadFiles = tpl.inputs().wdAfterReadFiles
-} else {
-
-
-self._wdAfterReadFiles = self.wdBefore()
-}
-}
-
-return self._wdAfterReadFiles
-},
-
-
-
-
-
-
-
-
-readFiles: func(cb) {
-tpl.prepare(func(inputs){
-inputs.files = self.filesInWd()
-
-files := cb(inputs)
-
-wdBuilder := wdSave.builder(self.wdBefore())
-for _, fName in files {
-wdBuilder.saveFileContent(fName)
-}
-wd := wdBuilder.build()
-
-
-preps := {}
-for key, fName in files {
-preps[key] = wd.getSavedFileContent(fName)
-}
-
-preps.wdAfterReadFiles = wd.getWorkdirAfter()
-
-return preps
-})
-},
-
-_wdFinalBuilder: undefined,
-
-
-
-wdFinalBuilder: func() {
-if is_undefined(self._wdFinalBuilder) {
-self._wdFinalBuilder = wdSave.builder(self.wdAfterReadFiles())
-}
-return self._wdFinalBuilder
-},
-
-
-
-
-
-
-saveFile: func(fName) {
-self.wdFinalBuilder().saveFile(fName)
-return self.wdFinalBuilder().getSavedFile(fName)
-},
-
-
-
-
-
-
-saveFileContent: func(fName) {
-self.wdFinalBuilder().saveFileContent(fName)
-return self.wdFinalBuilder().getSavedFileContent(fName)
-},
-
-
-
-
-
-
-
-
-
-body: func(cb) {
-tpl.body(func(inputs) {
-
-inputs.files = self.filesInWd()
-result := cb(inputs)
-wd := self.wdFinalBuilder().build()
-
-return {
-result: result,
-workdir: wd.getWorkdirAfter()
-}
-})
-}
+	self := undefined
+
+	self = {
+
+		_wdBefore: undefined,
+		/**
+		 * @return wd: resource - initial working directory resource
+		 */
+		wdBefore: func() {
+			if is_undefined(self._wdBefore) {
+				self._wdBefore = tpl.inputs().workdir
+			}
+			return self._wdBefore
+		},
+
+		_filesInWd: undefined,
+		/**
+		 * @return fileNames: string[] - list of file paths currently existing in the working directory
+		 */
+		filesInWd: func() {
+			if is_undefined(self._filesInWd) {
+				self._filesInWd = self.wdBefore().getDataAsJson().files
+			}
+
+			return self._filesInWd
+		},
+
+		_wdAfterReadFiles: undefined,
+		/**
+		 * @return wd: resource - working directory resource after "readFiles" is done
+		 */
+		wdAfterReadFiles: func() {
+			if is_undefined(self._wdAfterReadFiles) {
+
+				if !is_undefined(tpl.inputs().wdAfterReadFiles) {
+
+					//
+					// this means readFiles was used and we are actually
+					// in the 'prepare' render
+					//
+					self._wdAfterReadFiles = tpl.inputs().wdAfterReadFiles
+				} else {
+
+					// no readFiles
+					self._wdAfterReadFiles = self.wdBefore()
+				}
+			}
+
+			return self._wdAfterReadFiles
+		},
+
+		/**
+		 * Select files to read their content and pass it to the body function
+		 *
+		 * @param cb: callback - a callback which takes a list of file names (paths) existing in the working directory and
+		 *  returning a map of key -> file name containing files to get content from; each file content will be available in
+		 *  the body inputs with the corresponding key
+		 */
+		readFiles: func(cb) {
+			tpl.prepare(func(inputs){
+				inputs.files = self.filesInWd()
+				// key -> file name
+				files := cb(inputs)
+
+				wdBuilder := wdSave.builder(self.wdBefore())
+				for _, fName in files {
+					wdBuilder.saveFileContent(fName)
+				}
+				wd := wdBuilder.build()
+
+				// run prepare to get file contents in the inputs
+				preps := {}
+				for key, fName in files {
+					preps[key] = wd.getSavedFileContent(fName)
+				}
+
+				preps.wdAfterReadFiles = wd.getWorkdirAfter()
+
+				return preps
+			})
+		},
+
+		_wdFinalBuilder: undefined,
+		/**
+		 * Final workdir builder, after prepare
+		 */
+		wdFinalBuilder: func() {
+			if is_undefined(self._wdFinalBuilder) {
+				self._wdFinalBuilder = wdSave.builder(self.wdAfterReadFiles())
+			}
+			return self._wdFinalBuilder
+		},
+
+		/**
+		 * Save given file.
+		 *
+		 * @return ref: reference - a reference to saved file resource
+		 */
+		saveFile: func(fName) {
+			self.wdFinalBuilder().saveFile(fName)
+			return self.wdFinalBuilder().getSavedFile(fName)
+		},
+
+		/**
+		 * Save content of a given file.
+		 *
+		 * @return ref: reference - a reference to saved file content value resource
+		 */
+		saveFileContent: func(fName) {
+			self.wdFinalBuilder().saveFileContent(fName)
+			return self.wdFinalBuilder().getSavedFileContent(fName)
+		},
+
+		/**
+		 * Template body function
+		 *
+		 * @param cb: func - a callback function to run in template body; the inputs passed to the body will have the following fields:
+		 *   files: string[] - list of files in workdir
+		 *   args: map - additional arguments of the template processor
+		 *   ...filesContent: resources - fields with the content of files specified in 'readFiles'
+		 */
+		body: func(cb) {
+			tpl.body(func(inputs) {
+
+				inputs.files = self.filesInWd()
+				result := cb(inputs)
+				wd := self.wdFinalBuilder().build()
+
+				return {
+					result: result,
+					workdir: wd.getWorkdirAfter()
+				}
+			})
+		}
+	}
+
+	return ll.toStrict(self)
 }
 
-return ll.toStrict(self)
-}
-
-
+/** singleton instance  */
 instance := proc()
 
 export ll.toStrict({
-readFiles: instance.readFiles,
-saveFile: instance.saveFile,
-saveFileContent: instance.saveFileContent,
-body: instance.body
+	readFiles: instance.readFiles,
+	saveFile: instance.saveFile,
+	saveFileContent: instance.saveFileContent,
+	body: instance.body
 })

package/dist/tengo/lib/workdir.save.lib.tengo

@@ -1,4 +1,4 @@
-
+/** A library providing workdir save resource builder */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 oop := import("@platforma-sdk/workflow-tengo:oop")
@@ -15,144 +15,144 @@ _WORKDIR_AFTER_FIELD := "workdirOut"
 _PROGRESS_FIELD := "progress"
 
 
-
-
-
-
-
-
+/**
+ * Generates a file save rule for a given file name.
+ *
+ * @param fileName: string - the name of the file.
+ * @return rule: map - the file save rule.
+ */
 getFileSaveRule := func(fileName) {
-return {
-blobKey: fileName,
-type: "file",
-filePath: fileName
-}
+	return {
+		blobKey: fileName,
+		type: "file",
+		filePath: fileName
+	}
 }
 
-
-
-
-
-
-
+/**
+ * Generates a value save rule for a given file name.
+ *
+ * @param fileName: string - the name of the file.
+ * @return rule: map - the value save rule.
+ */
 getContentSaveRule := func(fileName) {
-return {
-blobKey: fileName,
-type: "content",
-contentPath: fileName
-}
+	return {
+		blobKey: fileName,
+		type: "content",
+		contentPath: fileName
+	}
 }
 
-
-
-
+/**
+ * Creates a builder for workdir save resource
+ */
 builder := func(wdBefore) {
 
-super := smart.ephemeralBuilder(constants.RTYPE_WORKDIR_SAVE)
-
-super.getField(_WORKDIR_IN_FIELD).set(wdBefore)
-
-
-fRules := {}
-
-cRules := {}
-
-self := undefined
-self = ll.toStrict(oop.inherit(super, {
-
-
-
-
-
-
-
-saveFile: func(fName) {
-fRules = sets.add(fRules, fName)
-return self
-},
-
-
-
-
-
-
-
-saveFileContent: func(fName) {
-cRules = sets.add(cRules, fName)
-return self
-},
-
-
-
-
-getSavedFiles: func() {
-return self.getField(_SAVED_FILES_FIELD)
-},
-
-
-
-
-getSavedFilesContent: func() {
-return self.getField(_SAVED_CONTENT_FIELD)
-},
-
-
-
-
-getWorkdirAfter: func() {
-return self.getField(_WORKDIR_AFTER_FIELD)
-},
-
-
-
-
-getProgress: func() {
-return self.getField(_PROGRESS_FIELD)
-},
-
-
-
-
-getSavedFile: func(fName) {
-return self.getSavedFiles().getFutureInputField(fName)
-},
-
-
-
-
-getSavedFileContent: func(fName) {
-return self.getSavedFilesContent().getFutureInputField(fName)
-},
-
-
-
-
-build: func() {
-rules := []
-for fName, _ in fRules {
-rules = append(rules, getFileSaveRule(fName))
-}
-for fName, _ in cRules {
-rules = append(rules, getContentSaveRule(fName))
-}
-
-super.getField(_RULES_FIELD).set(
-smart.createValueResource(
-constants.RTYPE_WORKDIR_SAVE_RULES,
-json.encode(rules)
-)
-)
-
-resource := super.lockAndBuild()
-
-
-return self
-}
-}))
-
-return self
+	super := smart.ephemeralBuilder(constants.RTYPE_WORKDIR_SAVE)
+	// set input wd
+	super.getField(_WORKDIR_IN_FIELD).set(wdBefore)
+
+	// file save rules
+	fRules := {}
+	// content save rules
+	cRules := {}
+
+	self := undefined
+	self = ll.toStrict(oop.inherit(super, {
+
+		/**
+		 * Save file.
+		 *
+		 * @param fName: string - file name
+		 *
+		 */
+		saveFile: func(fName) {
+			fRules = sets.add(fRules, fName)
+			return self
+		},
+
+		/**
+		 * Save file content.
+		 *
+		 * @param fName: string - file name
+		 *
+		 */
+		saveFileContent: func(fName) {
+			cRules = sets.add(cRules, fName)
+			return self
+		},
+
+		/**
+		 * Get field pointing to saved files map resource
+		 */
+		getSavedFiles: func() {
+			return self.getField(_SAVED_FILES_FIELD)
+		},
+
+		/**
+		 * Get field pointing to saved files content map resource
+		 */
+		getSavedFilesContent: func() {
+			return self.getField(_SAVED_CONTENT_FIELD)
+		},
+
+		/**
+		 * Get field pointing to workdir after resource
+		 */
+		getWorkdirAfter: func() {
+			return self.getField(_WORKDIR_AFTER_FIELD)
+		},
+
+		/**
+		 * Get field pointing to progress resource
+		 */
+		getProgress: func() {
+			return self.getField(_PROGRESS_FIELD)
+		},
+
+		/**
+		 * Get future field pointing to saved file resource
+		 */
+		getSavedFile: func(fName) {
+			return self.getSavedFiles().getFutureInputField(fName)
+		},
+
+		/**
+		 * Get future field pointing to saved file content value resource
+		 */
+		getSavedFileContent: func(fName) {
+			return self.getSavedFilesContent().getFutureInputField(fName)
+		},
+
+		/**
+		 * Build resource
+		 */
+		build: func() {
+			rules := []
+			for fName, _ in fRules {
+				rules = append(rules, getFileSaveRule(fName))
+			}
+			for fName, _ in cRules {
+				rules = append(rules, getContentSaveRule(fName))
+			}
+
+			super.getField(_RULES_FIELD).set(
+				smart.createValueResource(
+					constants.RTYPE_WORKDIR_SAVE_RULES,
+					json.encode(rules)
+				)
+			)
+
+			resource := super.lockAndBuild()
+
+			// still return self to have all the methods
+			return self
+		}
+	}))
+
+	return self
 }
 
 export ll.toStrict({
-builder: builder
+	builder: builder
 })

package/dist/tengo/lib/workflow.bobject.lib.tengo

@@ -1,6 +1,6 @@
-
-
-
+/**
+ * Utility functions to work with export objects & p-frames
+ */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 constants := import("@platforma-sdk/workflow-tengo:constants")
@@ -9,43 +9,43 @@ smart := import("@platforma-sdk/workflow-tengo:smart")
 validation := import("@platforma-sdk/workflow-tengo:validation")
 
 
-
+//
 _pObjectSpecSchema := {
-"__options__,closed": "",
+	"__options__,closed": "",
 
-"kind": "string",
+	"kind": "string",
 
-"valueType,?": `string,regex=json|File|DynamicFile|String|Double|Long|Int`,
+	"valueType,?": `string,regex=json|File|DynamicFile|String|Double|Long|Int`,
 
-"name,?": {",any": "string"},
+	"name,?": {",any": "string"},
 
-"domain,?": {",any": "string"},
+	"domain,?": {",any": "string"},
 
-"axesSpec,?": [{
-"type": "string,regex=String",
-"name": "string",
-"domain,?": {",any": "string"},
-"annotations,?": {",any": "string"}
-}],
+	"axesSpec,?": [{
+		"type": "string,regex=String",
+		"name": "string",
+		"domain,?": {",any": "string"},
+		"annotations,?": {",any": "string"}
+	}],
 
-"annotations,?": {",any": "string"}
+	"annotations,?": {",any": "string"}
 }
 
 
-
-
-
-
-
+/**
+ * Creates export object spec from a given map
+ *
+ * @param spec: map
+ */
 createSpec := func(spec) {
-ll.assert(ll.isMap(spec), "expected map got %v", spec)
-
-
+	ll.assert(ll.isMap(spec), "expected map got %v", spec)
 
+	// @TODO fix validation
+	// validation.assertValidJson(spec, _pObjectSpecSchema)
 
-return smart.createValueResource(constants.RTYPE_BOBJECT_SPEC, json.encode(spec))
+	return smart.createValueResource(constants.RTYPE_BOBJECT_SPEC, json.encode(spec))
 }
 
 export ll.toStrict({
-createSpec: createSpec
+	createSpec: createSpec
 })