@platforma-sdk/workflow-tengo 2.9.6 → 2.9.8

package/dist/tengo/lib/exec.R.lib.tengo

@@ -15,174 +15,174 @@ _OUTPUT_RUN_ENV       := "runEnv"
 createRenvTpl := assets.importTemplate("@platforma-sdk/workflow-tengo:exec.R.create-renv")
 
 rVenvBuilder := func() {
-self := undefined
-
-opMode := "remote"
-toolset := "renv"
-rDescriptor := undefined
-softwareRef := undefined
-dependencies := undefined
-cache := 0
-
-self = {
-operationMode: func(mode) {
-validation.assertJsonSchema(mode, "string",
-"exec.R.operationMode: <mode> must be string")
-
-ll.assert(mode == "remote" || mode == "dev-local",
-"exec.R.operationMode: unsupported operation mode: 'remote', 'dev-local' are valid in this version of workflow-tengo SDK")
-
-opMode = mode
-return self
-},
-
-useToolset: func(name) {
-validation.assertJsonSchema(name, "string",
-"exec.R.useToolset: <name> must be valid name of R packaging toolset (i.e. 'renv')")
-ll.assert(name != "", "exec.R.useToolset: toolset name must not be empty")
-
-toolset = name
-return self
-},
-
-runEnvDescriptor: func(descriptor) {
-validation.assertJsonSchema(descriptor, desc.runEnvScheme, "exec.R.runEnvDescriptor: <descriptor> must be run environment specification")
-ll.assert(descriptor.type == "R", "exec.R.runEnvDescriptor: not a 'R' run environment: %q", descriptor.type)
-
-rDescriptor = ll.fromStrict(descriptor)
-return self
-},
-
-software: func(pkgRef) {
-validation.assertJsonSchema(pkgRef, validation.reference, "exec.R.software: <pkgRef> must be a reference to software package")
-
-softwareRef = pkgRef
-return self
-},
-
-dependencies: func(deps) {
-validation.assertJsonSchema(deps, { "any": "string" }, "exec.R.dependencies: <deps> must be map of reference file paths")
-
-dependencies = deps
-return self
-},
-
-
-
-
-
-
-cacheMillis: func(millis) {
-ll.assert(is_int(millis) && millis > 0, "exec.R.cacheMillis: cache time must be a number of milliseconds")
-cache = millis * times.millisecond
-return self
-},
-
-
-
-
-
-
-cacheSeconds: func(seconds) {
-ll.assert(is_int(seconds) && seconds > 0, "exec.R.cacheSeconds: cache time must be a number of seconds")
-cache = seconds * times.second
-return self
-},
-
-
-
-
-
-
-cacheMinutes: func(minutes) {
-ll.assert(is_int(minutes) && minutes > 0, "exec.R.cacheMinutes: cache time must be a number of minutes")
-cache = minutes * times.minute
-return self
-},
-
-
-
-
-
-
-cacheHours: func(hours) {
-ll.assert(is_int(hours) && hours > 0, "exec.R.cacheHours: cache time must be a number of hours")
-cache = hours * times.hour
-return self
-},
-
-
-
-
-
-
-cacheDays: func(days) {
-ll.assert(is_int(days) && days > 0, "exec.R.cacheDays: cache time must be a number of days")
-cache = days * times.hour * 24
-return self
-},
-
-
-
-
-
-
-
-cache: func(time) {
-ll.assert(
-is_int(time) && time > times.millisecond,
-"exec.R.cache: cache time must be an integer. " +
-"Did you forget to import a standard tengo library 'times'?")
-cache = time
-return self
-},
-
-build: func() {
-archive := pkg.get(rDescriptor.registry, rDescriptor.package).archive()
-rPkg := pkg.install(archive).package()
-
-rVenvInputs := {
-operationMode: opMode,
-toolset: toolset,
-dependencies: dependencies,
-software: softwareRef,
-rDescriptor: rDescriptor,
-R: rPkg
-}
-
-validation.assertJsonSchema(rVenvInputs, internal.rVenvInputSchema, "incomplete R runenv configuration")
-
-tpl := render.create(createRenvTpl, rVenvInputs)
-
-self := undefined
-self = ll.toStrict(oop.inherit(tpl, {
-
-
-
-
-
-venv: func() {
-return tpl.output(_OUTPUT_RUN_ENV, cache)
-},
-
-
-
-
-
-
-R: func() {
-return rPkg
-}
-}))
-
-return self
-}
-}
-
-return self
+	self := undefined
+
+	opMode := "remote"
+	toolset := "renv"
+	rDescriptor := undefined
+	softwareRef := undefined
+	dependencies := undefined
+	cache := 0
+
+	self = {
+		operationMode: func(mode) {
+			validation.assertJsonSchema(mode, "string",
+				"exec.R.operationMode: <mode> must be string")
+
+			ll.assert(mode == "remote" || mode == "dev-local",
+				"exec.R.operationMode: unsupported operation mode: 'remote', 'dev-local' are valid in this version of workflow-tengo SDK")
+
+			opMode = mode
+			return self
+		},
+
+		useToolset: func(name) {
+			validation.assertJsonSchema(name, "string",
+				"exec.R.useToolset: <name> must be valid name of R packaging toolset (i.e. 'renv')")
+			ll.assert(name != "", "exec.R.useToolset: toolset name must not be empty")
+
+			toolset = name
+			return self
+		},
+
+		runEnvDescriptor: func(descriptor) {
+			validation.assertJsonSchema(descriptor, desc.runEnvScheme, "exec.R.runEnvDescriptor: <descriptor> must be run environment specification")
+			ll.assert(descriptor.type == "R", "exec.R.runEnvDescriptor: not a 'R' run environment: %q", descriptor.type)
+
+			rDescriptor = ll.fromStrict(descriptor)
+			return self
+		},
+
+		software: func(pkgRef) {
+			validation.assertJsonSchema(pkgRef, validation.reference, "exec.R.software: <pkgRef> must be a reference to software package")
+
+			softwareRef = pkgRef
+			return self
+		},
+
+		dependencies: func(deps) {
+			validation.assertJsonSchema(deps, { "any": "string" }, "exec.R.dependencies: <deps> must be map of reference file paths")
+
+			dependencies = deps
+			return self
+		},
+
+		/**
+		 * Sets the cache time in milliseconds.
+		 *
+		 * @param millis: number
+		 */
+		cacheMillis: func(millis) {
+			ll.assert(is_int(millis) && millis > 0, "exec.R.cacheMillis: cache time must be a number of milliseconds")
+			cache = millis * times.millisecond
+			return self
+		},
+
+		/**
+		 * Sets the cache time in seconds.
+		 *
+		 * @param seconds: number
+		 */
+		cacheSeconds: func(seconds) {
+			ll.assert(is_int(seconds) && seconds > 0, "exec.R.cacheSeconds: cache time must be a number of seconds")
+			cache = seconds * times.second
+			return self
+		},
+
+		/**
+		 * Sets the cache time in minutes.
+		 *
+		 * @param minutes: number
+		 */
+		cacheMinutes: func(minutes) {
+			ll.assert(is_int(minutes) && minutes > 0, "exec.R.cacheMinutes: cache time must be a number of minutes")
+			cache = minutes * times.minute
+			return self
+		},
+
+		/**
+		 * Sets the cache time in hours.
+		 *
+		 * @param hours: number
+		 */
+		cacheHours: func(hours) {
+			ll.assert(is_int(hours) && hours > 0, "exec.R.cacheHours: cache time must be a number of hours")
+			cache = hours * times.hour
+			return self
+		},
+
+		/**
+		 * Sets the cache time in days
+		 *
+		 * @param days: number
+		 */
+		cacheDays: func(days) {
+			ll.assert(is_int(days) && days > 0, "exec.R.cacheDays: cache time must be a number of days")
+			cache = days * times.hour * 24
+			return self
+		},
+
+		/**
+		 * @deprecated, use cacheMillis, cacheSeconds, cacheMinutes, cacheHours and cacheDays instead.
+		 * Sets the cache time.
+		 *
+		 * @param time: duration - the cache time from 'times' library.
+		 */
+		cache: func(time) {
+			ll.assert(
+				is_int(time) && time > times.millisecond,
+				"exec.R.cache: cache time must be an integer. " +
+					"Did you forget to import a standard tengo library 'times'?")
+			cache = time
+			return self
+		},
+
+		build: func() {
+			archive := pkg.get(rDescriptor.registry, rDescriptor.package).archive()
+			rPkg := pkg.install(archive).package()
+
+			rVenvInputs := {
+				operationMode: opMode,
+				toolset: toolset,
+				dependencies: dependencies,
+				software: softwareRef,
+				rDescriptor: rDescriptor,
+				R: rPkg
+			}
+
+			validation.assertJsonSchema(rVenvInputs, internal.rVenvInputSchema, "incomplete R runenv configuration")
+
+			tpl := render.create(createRenvTpl, rVenvInputs)
+
+			self := undefined
+			self = ll.toStrict(oop.inherit(tpl, {
+				/**
+				 * R virtual environment with all dependencies installed.
+				 *
+				 * @return renv: smart.field - a reference to the R portable run environment.
+				 */
+				venv: func() {
+					return tpl.output(_OUTPUT_RUN_ENV, cache)
+				},
+
+				/**
+				 * R runtime used for R virtual environment creation.
+				 *
+				 * @return R: smart.Field - a reference to the R runtime.
+				 */
+				R: func() {
+					return rPkg
+				}
+			}))
+
+			return self
+		}
+	}
+
+	return self
 }
 
 
 export ll.toStrict({
-rVenvBuilder                        : rVenvBuilder
+	rVenvBuilder                        : rVenvBuilder
 })

package/dist/tengo/lib/exec.constants.lib.tengo

@@ -4,8 +4,8 @@ ARG_TYPE_VAR        := "variableRef" // TODO: deprecated, remove after 15 Mar 20
 ARG_TYPES := [ARG_TYPE_STRING, ARG_TYPE_EXPRESSION, ARG_TYPE_VAR]
 
 export {
-ARG_TYPE_STRING: ARG_TYPE_STRING,
-ARG_TYPE_EXPRESSION: ARG_TYPE_EXPRESSION,
-ARG_TYPE_VAR: ARG_TYPE_VAR,
-ARG_TYPES: ARG_TYPES
+	ARG_TYPE_STRING: ARG_TYPE_STRING,
+	ARG_TYPE_EXPRESSION: ARG_TYPE_EXPRESSION,
+	ARG_TYPE_VAR: ARG_TYPE_VAR,
+	ARG_TYPES: ARG_TYPES
 }

package/dist/tengo/lib/exec.descriptor.lib.tengo

@@ -1,54 +1,54 @@
-
-
-
+/** Everything about software descriptors
+ * The scheme is here:
+ * https://github.com/milaboratory/platforma/blob/main/tools/package-builder/src/core/renderer.ts#L161 */
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 
 runEnvScheme := {
-registry: "string",
-package: "string",
-type: "string",
-binDir: "string"
+	registry: "string",
+	package: "string",
+	type: "string",
+	binDir: "string"
 }
 
 binaryScheme := {
-registry: "string",
-package: "string",
-cmd: ["string"],
-"runEnv,?": runEnvScheme
+	registry: "string",
+	package: "string",
+	cmd: ["string"],
+	"runEnv,?": runEnvScheme
 }
 
 assetScheme := {
-registry: "string",
-package: "string",
-url: "string"
+	registry: "string",
+	package: "string",
+	url: "string"
 }
 
 localScheme := {
-hash: "string",
-path: "string",
-cmd: ["string"],
-runEnv: runEnvScheme
+	hash: "string",
+	path: "string",
+	cmd: ["string"],
+	runEnv: runEnvScheme
 }
 
 scheme := {
-"isDev,?": "bool",
-"schemaVersion,?": "number",
-"binary,?": binaryScheme,
-"asset,?": assetScheme,
-"local,?": localScheme
+	"isDev,?": "bool",
+	"schemaVersion,?": "number",
+	"binary,?": binaryScheme,
+	"asset,?": assetScheme,
+	"local,?": localScheme
 }
 
-
+/** True if Platforma Backend supports expression refs. */
 canBackendUseExpressions := func() {
-return ll.apiVersion() >= 2
+	return ll.apiVersion() >= 2
 }
 
 export {
-runEnvScheme: runEnvScheme,
-binaryScheme: binaryScheme,
-assetScheme: assetScheme,
-localScheme: localScheme,
-scheme: scheme,
-canBackendUseExpressions: canBackendUseExpressions
+	runEnvScheme: runEnvScheme,
+	binaryScheme: binaryScheme,
+	assetScheme: assetScheme,
+	localScheme: localScheme,
+	scheme: scheme,
+	canBackendUseExpressions: canBackendUseExpressions
 }