@platforma-sdk/workflow-tengo 2.14.0 → 2.15.0

package/dist/tengo/lib/exec.limits.lib.tengo

@@ -1,9 +1,9 @@
-/**
- * A library that creates Quota resource.
- * Shared with 'workdir' package.
- *
- * Was shaped as a separate lib to avoid recursive imports (exec -> workdir -> exec)
- */
+
+
+
+
+
+
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 oop := import("@platforma-sdk/workflow-tengo:oop")
@@ -14,11 +14,11 @@ json := import("json")
 
 _RTYPE_QUOTA := { Name: "Quota", Version: "1" }
 
-/**
- * Builder for quota resource.
- *
- * Creates 'Quota' resource used to request specific amount of CPU and RAM in a given queue
- */
+
+
+
+
+
 quotaBuilder := func() {
 	self := undefined
 
@@ -28,13 +28,13 @@ quotaBuilder := func() {
 
 
 	self = ll.toStrict({
-		/**
-		 * Create quota resource for specific execution queue.
-		 * This is the only method required for call before .build()
-		 *
-		 * @param name: string - name of the queue.
-		 * @return builder
-		 */
+
+
+
+
+
+
+
 		queue: func(name) {
 			validation.assertType(name, "string", "exec.quota.builder.queue: name of the queue should be a string")
 			queue_name = name
@@ -42,12 +42,12 @@ quotaBuilder := func() {
 			return self
 		},
 
-		/**
-		 * Amount of cores to request in quota.
-		 *
-		 * @param amount: number - number of cores.
-		 * @return builder
-		 */
+
+
+
+
+
+
 		cpu: func(amount) {
 			validation.assertType(amount, ["or", "number", "null"], "exec.quota.builder.cpu: CPU amount should be a number")
 			ll.assert(is_undefined(amount) || amount > 0, "exec.quota.builder.cpu: amount of cores should be greater than 0")
@@ -56,15 +56,15 @@ quotaBuilder := func() {
 			return self
 		},
 
-		/**
-		 * Amount of RAM to request.
-		 *
-		 * @param amount: number | string - amount of RAM in bytes or string with size suffix (case-insensitive):
-		 *                                    K,  KB,  M,  MB,  G,  GB for base-10 sizes (x1000)
-		 *                                   Ki, KiB, Mi, MiB, Gi, GiB for base-2 sizes (x1024)
-		 *
-		 * @return builder
-		 */
+
+
+
+
+
+
+
+
+
 		ram: func(amount) {
 			validation.assertType(amount, ["or", "number", "string", "null"], "exec.quota.builder.ram: RAM amount should be a number or string")
 			ll.assert(is_undefined(amount) || is_string(amount) || amount > 0, "exec.quota.builder.ram: amount in bytes should be greater than 0")
@@ -73,11 +73,11 @@ quotaBuilder := func() {
 			return self
 		},
 
-		/**
-		 * Create Quota resource.
-		 *
-		 * @return smart.resource - reference to the resulting value resource
-		 */
+
+
+
+
+
 		build: func() {
 			ll.assert(queue_name != "", "exec.quota.builder: queue name is mandatory and could not be empty string")
 
@@ -108,12 +108,12 @@ storageSpaceRequestBuilder := func() {
 	quota := undefined
 
 	self = ll.toStrict({
-		/**
-		 * Request for given resources
-		 *
-		 * @param ref: smart.reference - reference to Quota resource to be fulfilled by storage allocator
-		 * @return spaceRequestBuilder
-		 */
+
+
+
+
+
+
 		quota: func(ref) {
 			validation.assertType(ref, validation.reference, "workdir.limits.quota: quota must be a valid reference to Quota resource")
 			quota = ref
@@ -121,11 +121,11 @@ storageSpaceRequestBuilder := func() {
 			return self
 		},
 
-		/**
-		 * Build StorageSpaceRequest resource
-		 *
-		 * @return StorageSpaceRequest
-		 */
+
+
+
+
+
 		build: func() {
 			ll.assert(smart.isReference(quota), "workdir.limits.build: quota of StorageSpaceRequest must be a valid reference")
 

package/dist/tengo/lib/exec.monetization.lib.tengo

@@ -1,4 +1,4 @@
-/** Contains a builder for monetization when we need to run monetization without exec (e.g. in pre-run). */
+
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 monetization := import("@platforma-sdk/workflow-tengo:exec.monetization_internal")

package/dist/tengo/lib/exec.monetization_internal.lib.tengo

@@ -1,4 +1,4 @@
-/** The library provides all things to work with a monetization. */
+
 
 base64 := import("base64")
 json := import("json")
@@ -20,12 +20,12 @@ sets := import("@platforma-sdk/workflow-tengo:sets")
 
 _JWT_TOKEN_RESULT_ENV := "PLATFORMA_MNZ_JWT"
 
-/** mnz-client will print the response from milm to stdout as-is. */
+
 mnzClientStdoutSchema := ["or",
-	// run-spec response
+
 	{ jwtToken: "string" },
 
-	// dry-run response
+
 	{ mnz: {
 		details: {
 			spentRuns: "number",
@@ -40,19 +40,19 @@ mnzClientStdoutSchema := ["or",
 	}}
 	]
 
-/** Just creates a new monetization as a map of params. */
+
 init := func() {
 	return ll.toStrict({
 		enabled: false,
 
-		// product key of monetization
+
 		productKey: "",
 
-		// just returns a number of runs without the actual calculation.
-		// Also, returns a number of remaining runs, a number of total runs etc.
+
+
 		isDryRun: false,
 
-		// file name to the param, e.g. {fileName: { arg: "dataset", collect: ["size", "lines", "sha256"] }}
+
 		fileParams: {}
 	})
 }
@@ -69,8 +69,8 @@ schema := {
 	"fileParams": {"any": fileParamsSchema}
 }
 
-/** Same as validation.assertType(params, fileParamsSchema, ...),
- * but with prettier errors for clients. */
+
+
 _validateParams := func(params) {
 	ll.assert(ll.isMap(params), "monetization.validateParams(): mnz params must be a map")
 
@@ -93,12 +93,12 @@ _validateIsReady := func(mnz) {
 	ll.assert(len(mnz.productKey) > 0,
 		"monetization.assertIsReady(): product key must be set")
 
-	// We don't need it, since we could run software without file params
-	// ll.assert(len(mnz.fileParams) > 0,
-	// 	"monetization.assertIsReady(): at least 1 file param must be set")
+
+
+
 }
 
-/** Enables the monetization for a product. */
+
 enable := func(mnz, productKey) {
 	ll.assert(is_string(productKey),
 		"monetization.enable(): product key must be a string, got %v", productKey)
@@ -123,7 +123,7 @@ setDryRun := func(mnz, isDryRun) {
 	mnz.isDryRun = isDryRun
 }
 
-/** Is this monetization enabled and should run? */
+
 shouldRun := func(mnz) {
 	if mnz.enabled {
 		_validateIsReady(mnz)
@@ -140,7 +140,7 @@ toJson := func(mnz) {
 	return ll.fromStrict(mnz)
 }
 
-/** Adds monetization parameters by a file. */
+
 addFileParams := func(mnz, fileName, params) {
 	validation.assertType(mnz, schema,
 		"monetization.addFileParams(): monetization object does not fit json schema")
@@ -159,14 +159,14 @@ addFileParams := func(mnz, fileName, params) {
 	mnz.fileParams[fileName] = params
 }
 
-/**
- * Runs monetization binary on a workdir with all files, and returns a new workdir and a resulted jwt token.
- * All resources are ephemeral,
- * the deduplication should be above this level.
- *
- * @param: mnz: monetization -- see a beginning of this file.
- * @param: wd: workdir -- workdir where all files from mnz.fileParams already exist.
- * @param: queue: queue - in which queue we should run monetization. */
+
+
+
+
+
+
+
+
 run := func(mnz, wd, queue) {
 	_validateIsReady(mnz)
 
@@ -177,7 +177,7 @@ run := func(mnz, wd, queue) {
 	builder.envTyped("MI_LICENSE", exprType, "{secrets.MI_LICENSE}")
 
 	opts := internal.swToRunCmdOptions(mnzSw.name, mnzSw.version, mnzSw.descriptor)
-	// load pkg var that points to mnz-client location.
+
 	for _, varInfo in opts.variables {
 		builder.ref(varInfo.refName, varInfo.reference)
 		builder.substitutionRule(varInfo.varName, varInfo.refName)
@@ -185,7 +185,7 @@ run := func(mnz, wd, queue) {
 
 	builder.cmdTyped(exprType, opts.cmd.value)
 	for _, arg in opts.args {
-		// now mnz-client doesn't have additional args; this line is just in case.
+
 		builder.argTyped(exprType, arg)
 	}
 	if mnz.isDryRun {
@@ -193,9 +193,9 @@ run := func(mnz, wd, queue) {
 	}
 	builder.arg("-productKey").arg(mnz.productKey)
 
-	// load file params
+
 	for fileName, param in mnz.fileParams {
-		// param is of fileParamsSchema type
+
 		toCollect := text.join(param.collect, ",")
 		arg := fmt.sprintf("%s:file:%s:%s", param.arg, fileName, toCollect)
 		builder.arg(arg)
@@ -206,7 +206,7 @@ run := func(mnz, wd, queue) {
 	builder.stdout(stdoutName)
 	run := builder.build()
 
-	// save mnz_stdout.txt
+
 	savedWd := workdir.save(run.workdir).
 		saveFileContent(stdoutName).
 		build()
@@ -219,13 +219,13 @@ run := func(mnz, wd, queue) {
 	)
 
 	return ll.toStrict({
-		// other commands should run on this wd,
-		// or else they will run concurrently
-		// with monetization.
+
+
+
 		wdAfter: savedWd.workdir,
 
-		// mnz-client returns jwt token
-		// that we will pass to the next command as env.
+
+
 		jwtEnvName: _JWT_TOKEN_RESULT_ENV,
 		jwtEnvValue: result.output("jwtToken"),
 
@@ -233,18 +233,18 @@ run := func(mnz, wd, queue) {
 	})
 }
 
-/** Gets mnz key from opts or undefined. */
+
 _extractOption := func(...opts) {
 	if slices.length(opts) < 1 {
 		return undefined
 	}
 	opt := opts[0]["mnz"]
 
-	// readability if: we can return undefined here
+
 	return is_undefined(opt) ? undefined : opt
 }
 
-/** Adds a monetization option if it's defined into mnzFileParams. */
+
 addOption := func(mnz, fileName, ...opts) {
 	opt := _extractOption(opts...)
 	if !is_undefined(opt) {

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

@@ -1,6 +1,6 @@
-/**
- * A library for working with platforma packages
- */
+
+
+
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 smart := import("@platforma-sdk/workflow-tengo:smart")
@@ -32,11 +32,11 @@ get := func(registryName, pkgName) {
 
 	self := undefined
 	self = oop.inherit(res, {
-		/**
-		 * Reference to the software package archive downloaded by 'get'
-		 *
-		 * @return archive: field - output field, where info on downloaded archive will appear
-		 */
+
+
+
+
+
 		archive: func() {
 			return res.outputs()[_OUTPUT_ARCHIVE]
 		}
@@ -59,11 +59,11 @@ install := func(archive) {
 
 	self := undefined
 	self = oop.inherit(res, {
-		/**
-		 * Reference to installed package
-		 *
-		 * @return package: smart.field - output field, where installed package will appear
-		 */
+
+
+
+
+
 		package: func() {
 			return res.getField(_OUTPUT_PACKAGE)
 		}
@@ -96,11 +96,11 @@ use := func(settings) {
 
 	self := undefined
 	self = oop.inherit(res, {
-		/**
-		 * Reference to installed package
-		 *
-		 * @return package: field - output field, where installed package will appear
-		 */
+
+
+
+
+
 		package: func() {
 			return res.outputs()[_OUTPUT_PACKAGE]
 		}
@@ -114,13 +114,13 @@ _INPUT_PACKAGE := "package"
 _INPUT_WD_IN := "workdirIn"
 _OUTPUT_WD_OUT := "workdirOut"
 
-/**
- * Load static files from software package into working directory or value resources.
- *
- * @param pkg: package - installed package (usually from package.install(<archive>))
- *
- * @return loader: pkgFileLoader - builder that provides requested files and content after load() call
- */
+
+
+
+
+
+
+
 pkgFileLoader := func(pkg) {
 	ll.assert(smart.isReference(pkg),
 		"package.pkgFileLoader: <pkg> must be reference to installed package. It is usually obtained from package.install().package")
@@ -191,22 +191,22 @@ pkgFileLoader := func(pkg) {
 				filesContent: wdSave.filesContent,
 				progress: wdSave.progress,
 
-				/**
-				 * Retrieves selected asset file by its path (use saveFile() to provide asset as file)
-				 *
-				 * @param fileName: string
-				 * @return file: smart.field - a reference to the file resource.
-				 */
+
+
+
+
+
+
 				getFile: func(fileName) {
 					return wdSave.files.getFutureInputField(fileName)
 				},
 
-				/**
-				 * Retrieves selected asset data by its path (use saveFileContent() to provide asset's data)
-				 *
-				 * @param fileName: string
-				 * @return file: smart.field - a reference to the file resource.
-				 */
+
+
+
+
+
+
 				getFileContent: func(fileName) {
 					return wdSave.filesContent.getFutureInputField(fileName)
 				}
@@ -217,14 +217,14 @@ pkgFileLoader := func(pkg) {
 	return ll.toStrict(self)
 }
 
-/**
- * Load single asset by its path inside package, providing it as file.
- *
- * @param pkg: package - installed package (usually from package.install(<archive>))
- * @param assetPath: string - path to asset inside package <pkg>
- *
- * @return file: singleAsset - object with reference to the file resource and progress report
- */
+
+
+
+
+
+
+
+
 loadPackageFile := func(pkg, assetPath) {
 	assets := pkgFileLoader(pkg).
 		saveFile(assetPath).
@@ -236,14 +236,14 @@ loadPackageFile := func(pkg, assetPath) {
 	}
 }
 
-/**
- * Load single asset by its path inside package, providing its raw content.
- *
- * @param pkg: package - installed package (usually from package.install(<archive>))
- * @param assetPath: string - path to asset inside package <pkg>
- *
- * @return content: singleAsset - object with reference to the asset content resource and progress report
- */
+
+
+
+
+
+
+
+
 loadPackageFileContent := func(pkg, assetPath) {
 	assets := pkgFileLoader(pkg).
 		saveFileContent(assetPath).

package/dist/tengo/lib/exec.python.internal.lib.tengo

@@ -5,7 +5,7 @@ desc := import("@platforma-sdk/workflow-tengo:exec.descriptor")
 pythonVenvInputSchema := {
 	toolset: "string",
 	dependencies: {"any": validation.reference},
-	// software: validation.reference,
+
 
 	pythonDescriptor: desc.runEnvScheme,
 	python: validation.reference

package/dist/tengo/lib/exec.python.lib.tengo

@@ -56,67 +56,67 @@ pythonVenvBuilder := func() {
 			return self
 		},
 
-		/**
-		 * Sets the cache time in milliseconds.
-		 *
-		 * @param millis: number
-		 */
+
+
+
+
+
 		cacheMillis: func(millis) {
 			ll.assert(is_int(millis) && millis > 0, "exec.python.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.python.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.python.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.python.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.python.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),
@@ -135,7 +135,7 @@ pythonVenvBuilder := func() {
 			pyVenvInputs := {
 				toolset: toolset,
 				dependencies: depsMap,
-				// software: softwareRef,
+
 				pythonDescriptor: pythonDescriptor,
 				python: pythonPkg
 			}
@@ -146,11 +146,11 @@ pythonVenvBuilder := func() {
 
 			self := undefined
 			self = ll.toStrict(oop.inherit(tpl, {
-				/**
-				 * Python virtual environment with all dependencies installed.
-				 *
-				 * @return venv: smart.field - a reference to the runenv with python venv inside.
-				 */
+
+
+
+
+
 				venv: func() {
 					return tpl.output(_OUTPUT_RUN_ENV, cache)
 				}