@platforma-sdk/workflow-tengo 2.9.5 → 2.9.7

package/dist/tengo/lib/assets.lib.tengo

@@ -1,4 +1,4 @@
-
+/** API to retrieve assets packed with template code (like other templates). */
 
 plapi := import("plapi")
 json := import("json")
@@ -7,67 +7,67 @@ smart := import("@platforma-sdk/workflow-tengo:smart")
 swinfo := import("@platforma-sdk/workflow-tengo:assets.swinfo")
 maps := import("@platforma-sdk/workflow-tengo:maps")
 
-
-
-
-
-
-
-
-
-
-
+/**
+ * Returns resource of template available in current execution context.
+ *
+ * @param tplName: string - full name of a template, including namespace (package name).
+ * Local templates (within the same package) can omit namespace part and start the name with colon:
+ *  - "@company/package:someTemplateName"
+ *  - ":myLocalTemplate"
+ *
+ * @return template: smart.resource - resource of tengo template with given name.
+ */
 importTemplate := func(tplName) {
-return smart.resource(plapi.getTemplateId(tplName))
+	return smart.resource(plapi.getTemplateId(tplName))
 }
 
-
-
-
-
-
-
-
-
-
-
+/**
+ * Returns asset description suitable for 'exec' operations.
+ * Asset is the way to put static files into working directory before execution of the command.
+ *
+ * @param assetName: string - full name of asset entrypoint, including namespace (NPM package name).
+ *                            Local software entrypoints (within the same package) can omit namespace
+ *                            part and start the name with colon:
+ *                              - "@company/package:some-software"
+ *                              - ":my-local-software"
+ */
 importAsset := func(assetName) {
-asset := plapi.getSoftwareInfo(assetName)
-return ll.toStrict({
-_type: "assetDescriptor",
-_id: asset.id,
-
-resource: smart.resource(asset.id),
-name: asset.name,
-version: asset.version,
-blobRef: asset.blobRef,
-descriptor: ll.toStrict(json.decode(asset.descriptor)) // raw sw.json data with asset entrypoint descriptor
-})
+	asset := plapi.getSoftwareInfo(assetName)
+	return ll.toStrict({
+		_type: "assetDescriptor",
+		_id: asset.id,
+
+		resource: smart.resource(asset.id),
+		name: asset.name,
+		version: asset.version,
+		blobRef: asset.blobRef,
+		descriptor: ll.toStrict(json.decode(asset.descriptor)) // raw sw.json data with asset entrypoint descriptor
+	})
 }
 
-
-
-
-
-
-
-
+/**
+ * Checks if given item is an asset info
+ *
+ * @param toCheck: any - item to check
+ *
+ * @return isAsset: boolean - true for asset info, loaded with importAsset()
+ */
 isAssetInfo := func(toCheck) {
-if !ll.isMap(toCheck) {
-return false
-}
+	if !ll.isMap(toCheck) {
+		return false
+	}
 
-if !maps.containsKey(toCheck, "_type") {
-return false
-}
+	if !maps.containsKey(toCheck, "_type") {
+		return false
+	}
 
-return toCheck._type == "assetDescriptor"
+	return toCheck._type == "assetDescriptor"
 }
 
 export ll.toStrict({
-importTemplate      : importTemplate,
-importSoftware      : swinfo.importSoftware,
-isSoftwareInfo      : swinfo.isSoftwareInfo,
-importAsset         : importAsset,
-isAssetInfo         : isAssetInfo
+	importTemplate      : importTemplate,
+	importSoftware      : swinfo.importSoftware,
+	isSoftwareInfo      : swinfo.isSoftwareInfo,
+	importAsset         : importAsset,
+	isAssetInfo         : isAssetInfo
 })

package/dist/tengo/lib/assets.swinfo.lib.tengo

@@ -1,6 +1,6 @@
-
-
-
+/**
+ * A file that contains software info constructors and related functions.
+ */
 
 plapi := import("plapi")
 ll := import("@platforma-sdk/workflow-tengo:ll")
@@ -8,58 +8,58 @@ maps := import("@platforma-sdk/workflow-tengo:maps")
 smart := import("@platforma-sdk/workflow-tengo:smart")
 json := import("json")
 
-
-
-
+/**
+ * Creates a software info by sw that is got from backend.
+ */
 newSoftwareInfo := func(sw) {
-return ll.toStrict({
-_type: "softwareDescriptor",
-_id: sw.id,
-
-resource: smart.resource(sw.id),
-name: sw.name,
-version: sw.version,
-blobRef: sw.blobRef,
-descriptor: ll.toStrict(json.decode(sw.descriptor)) // raw sw.json data with software entrypoint descriptor
-})
+	return ll.toStrict({
+		_type: "softwareDescriptor",
+		_id: sw.id,
+
+		resource: smart.resource(sw.id),
+		name: sw.name,
+		version: sw.version,
+		blobRef: sw.blobRef,
+		descriptor: ll.toStrict(json.decode(sw.descriptor)) // raw sw.json data with software entrypoint descriptor
+	})
 }
 
-
-
-
-
-
-
-
-
-
-
-
+/**
+ * Returns software description suitable for 'exec' operations.
+ *
+ * @param swName: string - full name of the software entrypoint, including namespace (NPM package name).
+ *                         Local software entrypoints (within the same package) can omit namespace part
+ *                         and start the name with colon:
+ *                           - "@company/package:some-oftware"
+ *                           - ":my-local-software"
+ *
+ * @return softwareInfo: softwareInfo - structure with software info.
+ */
 importSoftware := func(swName) {
-return newSoftwareInfo(plapi.getSoftwareInfo(swName))
+	return newSoftwareInfo(plapi.getSoftwareInfo(swName))
 }
 
-
-
-
-
-
-
-
+/**
+ * Checks if given item is a software info
+ *
+ * @param toCheck: any - item to check
+ *
+ * @return isSoftware: boolean - true for software info, loaded with importSoftware()
+ */
 isSoftwareInfo := func(toCheck) {
-if !ll.isMap(toCheck) {
-return false
-}
+	if !ll.isMap(toCheck) {
+		return false
+	}
 
-if !maps.containsKey(toCheck, "_type") {
-return false
-}
+	if !maps.containsKey(toCheck, "_type") {
+		return false
+	}
 
-return toCheck._type == "softwareDescriptor"
+	return toCheck._type == "softwareDescriptor"
 }
 
 export ll.toStrict({
-newSoftwareInfo: newSoftwareInfo,
-importSoftware: importSoftware,
-isSoftwareInfo: isSoftwareInfo
+	newSoftwareInfo: newSoftwareInfo,
+	importSoftware: importSoftware,
+	isSoftwareInfo: isSoftwareInfo
 })

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

@@ -1,11 +1,11 @@
-
+// constants
 
 ll := import("@platforma-sdk/workflow-tengo:ll")
 
 RTYPE_JSON                := { Name: "json/object",       Version: "1" }
 
 RTYPE_MAP                 := { Name: "std/map",           Version: "1" }
-
+// @TODO this should be deleted once we align on map type name
 RTYPE_MAP_ALT             := { Name: "StdMap",            Version: "1" }
 RTYPE_MAP_EPH             := { Name: "EphStdMap",         Version: "1" }
 
@@ -33,7 +33,7 @@ RTYPE_WORKDIR_FILL_RULES  := { Name: "WorkdirFill/rules", Version: "1" }
 RTYPE_WORKDIR_SAVE        := { Name: "WorkdirSave",       Version: "1" }
 RTYPE_WORKDIR_SAVE_RULES  := { Name: "WorkdirSave/rules", Version: "1" }
 
-
+/** Main resource type of representing a PL error */
 RTYPE_JSON_ERROR          := { Name: "json/resourceError", Version: "1"}
 
 FTYPE_OTW                 := "OTW" // Generic one-time writable field. The value of this field can be set only once.
@@ -43,33 +43,33 @@ FTYPE_OUTPUT              := "output"
 FTYPE_DYNAMIC             := "dynamic"
 
 export ll.toStrict({
-FTYPE_OTW                   : FTYPE_OTW,
-FTYPE_SERVICE               : FTYPE_SERVICE,
-FTYPE_INPUT                 : FTYPE_INPUT,
-FTYPE_OUTPUT                : FTYPE_OUTPUT,
-FTYPE_DYNAMIC               : FTYPE_DYNAMIC,
-
-RTYPE_BINARY_MAP            : RTYPE_BINARY_MAP,
-RTYPE_BINARY_VALUE          : RTYPE_BINARY_VALUE,
-RTYPE_BLOB_MAP              : RTYPE_BLOB_MAP,
-RTYPE_BOBJECT_SPEC          : RTYPE_BOBJECT_SPEC,
-RTYPE_BRESOLVE_CHOICE       : RTYPE_BRESOLVE_CHOICE,
-RTYPE_BRESOLVE_FIRST        : RTYPE_BRESOLVE_FIRST,
-RTYPE_BRESOLVE_NO_RESULT    : RTYPE_BRESOLVE_NO_RESULT,
-RTYPE_CONTEXT               : RTYPE_CONTEXT,
-RTYPE_CONTEXT_END           : RTYPE_CONTEXT_END,
-RTYPE_JSON                  : RTYPE_JSON,
-RTYPE_MAP                   : RTYPE_MAP,
-RTYPE_MAP_ALT               : RTYPE_MAP_ALT,
-RTYPE_MAP_EPH               : RTYPE_MAP_EPH,
-RTYPE_QUERY_RESULT          : RTYPE_QUERY_RESULT,
-RTYPE_OBJECT_SPEC           : RTYPE_OBJECT_SPEC,
-RTYPE_RENDER_EPH_TEMPLATE   : RTYPE_RENDER_EPH_TEMPLATE,
-RTYPE_RENDER_TEMPLATE       : RTYPE_RENDER_TEMPLATE,
-RTYPE_WORKDIR_CREATE        : RTYPE_WORKDIR_CREATE,
-RTYPE_WORKDIR_FILL          : RTYPE_WORKDIR_FILL,
-RTYPE_WORKDIR_FILL_RULES    : RTYPE_WORKDIR_FILL_RULES,
-RTYPE_WORKDIR_SAVE          : RTYPE_WORKDIR_SAVE,
-RTYPE_WORKDIR_SAVE_RULES    : RTYPE_WORKDIR_SAVE_RULES,
-RTYPE_JSON_ERROR            : RTYPE_JSON_ERROR
+	FTYPE_OTW                   : FTYPE_OTW,
+	FTYPE_SERVICE               : FTYPE_SERVICE,
+	FTYPE_INPUT                 : FTYPE_INPUT,
+	FTYPE_OUTPUT                : FTYPE_OUTPUT,
+	FTYPE_DYNAMIC               : FTYPE_DYNAMIC,
+
+	RTYPE_BINARY_MAP            : RTYPE_BINARY_MAP,
+	RTYPE_BINARY_VALUE          : RTYPE_BINARY_VALUE,
+	RTYPE_BLOB_MAP              : RTYPE_BLOB_MAP,
+	RTYPE_BOBJECT_SPEC          : RTYPE_BOBJECT_SPEC,
+	RTYPE_BRESOLVE_CHOICE       : RTYPE_BRESOLVE_CHOICE,
+	RTYPE_BRESOLVE_FIRST        : RTYPE_BRESOLVE_FIRST,
+	RTYPE_BRESOLVE_NO_RESULT    : RTYPE_BRESOLVE_NO_RESULT,
+	RTYPE_CONTEXT               : RTYPE_CONTEXT,
+	RTYPE_CONTEXT_END           : RTYPE_CONTEXT_END,
+	RTYPE_JSON                  : RTYPE_JSON,
+	RTYPE_MAP                   : RTYPE_MAP,
+	RTYPE_MAP_ALT               : RTYPE_MAP_ALT,
+	RTYPE_MAP_EPH               : RTYPE_MAP_EPH,
+	RTYPE_QUERY_RESULT          : RTYPE_QUERY_RESULT,
+	RTYPE_OBJECT_SPEC           : RTYPE_OBJECT_SPEC,
+	RTYPE_RENDER_EPH_TEMPLATE   : RTYPE_RENDER_EPH_TEMPLATE,
+	RTYPE_RENDER_TEMPLATE       : RTYPE_RENDER_TEMPLATE,
+	RTYPE_WORKDIR_CREATE        : RTYPE_WORKDIR_CREATE,
+	RTYPE_WORKDIR_FILL          : RTYPE_WORKDIR_FILL,
+	RTYPE_WORKDIR_FILL_RULES    : RTYPE_WORKDIR_FILL_RULES,
+	RTYPE_WORKDIR_SAVE          : RTYPE_WORKDIR_SAVE,
+	RTYPE_WORKDIR_SAVE_RULES    : RTYPE_WORKDIR_SAVE_RULES,
+	RTYPE_JSON_ERROR            : RTYPE_JSON_ERROR
 })

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

@@ -6,40 +6,40 @@ desc := import("@platforma-sdk/workflow-tengo:exec.descriptor")
 constants := import("@platforma-sdk/workflow-tengo:exec.constants")
 
 rVenvInputSchema := {
-operationMode: "string",
-toolset: "string",
-dependencies: {"any": "string"},
-software: validation.reference,
+	operationMode: "string",
+	toolset: "string",
+	dependencies: {"any": "string"},
+	software: validation.reference,
 
-rDescriptor: desc.runEnvScheme,
-R: validation.reference
+	rDescriptor: desc.runEnvScheme,
+	R: validation.reference
 }
 
 runRBuilder := func(operationMode, wd, rPackage, rDescriptor) {
-t := desc.canBackendUseExpressions() ? constants.ARG_TYPE_EXPRESSION : constants.ARG_TYPE_VAR
-rule := desc.canBackendUseExpressions() ? "R" : "{R}"
-
-builder := runcmd.builder(wd).
-ref("r-run-environment", rPackage).
-substitutionRule(rule, "r-run-environment").
-addToPath(t, path.join("{R}", rDescriptor.binDir)).
-envTyped("RHOME", t, "{R}").
-envTyped("R_HOME_DIR", t, "{R}").
-envTyped("RENV_PATHS_ROOT", t, path.join("{R}", "renv-root")).
-envTyped("RENV_PATHS_BINARY", t, path.join("{R}", "renv-root", "binaries")).
-envTyped("RENV_PATHS_SOURCE", t, path.join("{R}", "renv-root", "sources")).
-envTyped("RENV_PATHS_CACHE", t, path.join("{R}", "renv-root", "cache"))
-
-if (operationMode != "dev-local") {
-
-
-builder.envTyped("RENV_CONFIG_REPOS_OVERRIDE", t, path.join("{R}", "packages"))
-}
-
-return builder
+	t := desc.canBackendUseExpressions() ? constants.ARG_TYPE_EXPRESSION : constants.ARG_TYPE_VAR
+	rule := desc.canBackendUseExpressions() ? "R" : "{R}"
+
+	builder := runcmd.builder(wd).
+		ref("r-run-environment", rPackage).
+		substitutionRule(rule, "r-run-environment").
+		addToPath(t, path.join("{R}", rDescriptor.binDir)).
+		envTyped("RHOME", t, "{R}").
+		envTyped("R_HOME_DIR", t, "{R}").
+		envTyped("RENV_PATHS_ROOT", t, path.join("{R}", "renv-root")).
+		envTyped("RENV_PATHS_BINARY", t, path.join("{R}", "renv-root", "binaries")).
+		envTyped("RENV_PATHS_SOURCE", t, path.join("{R}", "renv-root", "sources")).
+		envTyped("RENV_PATHS_CACHE", t, path.join("{R}", "renv-root", "cache"))
+
+	if (operationMode != "dev-local") {
+		// In production we can use only locally cached packages: most of commercials have
+		// Platforma Backend executed in a very restricted environment with limited access to the internet.
+		builder.envTyped("RENV_CONFIG_REPOS_OVERRIDE", t, path.join("{R}", "packages"))
+	}
+
+	return builder
 }
 
 export ll.toStrict({
-rVenvInputSchema                   : rVenvInputSchema,
-runRBuilder                        : runRBuilder
+	rVenvInputSchema                   : rVenvInputSchema,
+	runRBuilder                        : runRBuilder
 })