@galaxy-tool-util/schema 0.2.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +86 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +60 -2
- package/dist/index.js.map +1 -1
- package/dist/schema/parameter-defaults.d.ts +36 -0
- package/dist/schema/parameter-defaults.d.ts.map +1 -0
- package/dist/schema/parameter-defaults.js +128 -0
- package/dist/schema/parameter-defaults.js.map +1 -0
- package/dist/schema/parsed-tool.d.ts +47 -0
- package/dist/schema/parsed-tool.d.ts.map +1 -0
- package/dist/schema/parsed-tool.js +49 -0
- package/dist/schema/parsed-tool.js.map +1 -0
- package/dist/schema/type-guards.d.ts +14 -0
- package/dist/schema/type-guards.d.ts.map +1 -0
- package/dist/schema/type-guards.js +25 -0
- package/dist/schema/type-guards.js.map +1 -0
- package/dist/test-format/cross-check/check.d.ts +18 -0
- package/dist/test-format/cross-check/check.d.ts.map +1 -0
- package/dist/test-format/cross-check/check.js +89 -0
- package/dist/test-format/cross-check/check.js.map +1 -0
- package/dist/test-format/cross-check/extract-format2.d.ts +13 -0
- package/dist/test-format/cross-check/extract-format2.d.ts.map +1 -0
- package/dist/test-format/cross-check/extract-format2.js +98 -0
- package/dist/test-format/cross-check/extract-format2.js.map +1 -0
- package/dist/test-format/cross-check/extract-native.d.ts +4 -0
- package/dist/test-format/cross-check/extract-native.d.ts.map +1 -0
- package/dist/test-format/cross-check/extract-native.js +89 -0
- package/dist/test-format/cross-check/extract-native.js.map +1 -0
- package/dist/test-format/cross-check/extract.d.ts +9 -0
- package/dist/test-format/cross-check/extract.d.ts.map +1 -0
- package/dist/test-format/cross-check/extract.js +16 -0
- package/dist/test-format/cross-check/extract.js.map +1 -0
- package/dist/test-format/cross-check/index.d.ts +7 -0
- package/dist/test-format/cross-check/index.d.ts.map +1 -0
- package/dist/test-format/cross-check/index.js +6 -0
- package/dist/test-format/cross-check/index.js.map +1 -0
- package/dist/test-format/cross-check/type-compat.d.ts +23 -0
- package/dist/test-format/cross-check/type-compat.d.ts.map +1 -0
- package/dist/test-format/cross-check/type-compat.js +48 -0
- package/dist/test-format/cross-check/type-compat.js.map +1 -0
- package/dist/test-format/cross-check/types.d.ts +23 -0
- package/dist/test-format/cross-check/types.d.ts.map +1 -0
- package/dist/test-format/cross-check/types.js +10 -0
- package/dist/test-format/cross-check/types.js.map +1 -0
- package/dist/test-format/index.d.ts +3 -0
- package/dist/test-format/index.d.ts.map +1 -0
- package/dist/test-format/index.js +3 -0
- package/dist/test-format/index.js.map +1 -0
- package/dist/test-format/tests.schema.generated.d.ts +5610 -0
- package/dist/test-format/tests.schema.generated.d.ts.map +1 -0
- package/dist/test-format/tests.schema.generated.js +6899 -0
- package/dist/test-format/tests.schema.generated.js.map +1 -0
- package/dist/test-format/validate.d.ts +20 -0
- package/dist/test-format/validate.d.ts.map +1 -0
- package/dist/test-format/validate.js +41 -0
- package/dist/test-format/validate.js.map +1 -0
- package/dist/tool-state-validator.d.ts +30 -0
- package/dist/tool-state-validator.d.ts.map +1 -0
- package/dist/tool-state-validator.js +59 -0
- package/dist/tool-state-validator.js.map +1 -0
- package/dist/workflow/clean.d.ts +29 -3
- package/dist/workflow/clean.d.ts.map +1 -1
- package/dist/workflow/clean.js +199 -28
- package/dist/workflow/clean.js.map +1 -1
- package/dist/workflow/fill-defaults.d.ts +39 -0
- package/dist/workflow/fill-defaults.d.ts.map +1 -0
- package/dist/workflow/fill-defaults.js +53 -0
- package/dist/workflow/fill-defaults.js.map +1 -0
- package/dist/workflow/index.d.ts +17 -5
- package/dist/workflow/index.d.ts.map +1 -1
- package/dist/workflow/index.js +17 -3
- package/dist/workflow/index.js.map +1 -1
- package/dist/workflow/lint-profiles.d.ts +27 -0
- package/dist/workflow/lint-profiles.d.ts.map +1 -0
- package/dist/workflow/lint-profiles.js +49 -0
- package/dist/workflow/lint-profiles.js.map +1 -0
- package/dist/workflow/lint-rules.d.ts +15 -0
- package/dist/workflow/lint-rules.d.ts.map +1 -0
- package/dist/workflow/lint-rules.js +15 -0
- package/dist/workflow/lint-rules.js.map +1 -0
- package/dist/workflow/lint.d.ts +4 -18
- package/dist/workflow/lint.d.ts.map +1 -1
- package/dist/workflow/lint.js +9 -30
- package/dist/workflow/lint.js.map +1 -1
- package/dist/workflow/lint_profiles.yml +41 -0
- package/dist/workflow/linting.d.ts +54 -0
- package/dist/workflow/linting.d.ts.map +1 -0
- package/dist/workflow/linting.js +71 -0
- package/dist/workflow/linting.js.map +1 -0
- package/dist/workflow/mermaid.d.ts +11 -0
- package/dist/workflow/mermaid.d.ts.map +1 -0
- package/dist/workflow/mermaid.js +158 -0
- package/dist/workflow/mermaid.js.map +1 -0
- package/dist/workflow/minimal-tool-state.d.ts +15 -0
- package/dist/workflow/minimal-tool-state.d.ts.map +1 -0
- package/dist/workflow/minimal-tool-state.js +16 -0
- package/dist/workflow/minimal-tool-state.js.map +1 -0
- package/dist/workflow/param-navigation.d.ts +26 -0
- package/dist/workflow/param-navigation.d.ts.map +1 -0
- package/dist/workflow/param-navigation.js +60 -0
- package/dist/workflow/param-navigation.js.map +1 -0
- package/dist/workflow/raw/gxformat2.effect.d.ts +341 -117
- package/dist/workflow/raw/gxformat2.effect.d.ts.map +1 -1
- package/dist/workflow/raw/gxformat2.effect.js +107 -109
- package/dist/workflow/raw/gxformat2.effect.js.map +1 -1
- package/dist/workflow/raw/native.d.ts +2 -2
- package/dist/workflow/raw/native.d.ts.map +1 -1
- package/dist/workflow/raw/native.effect.d.ts +150 -3
- package/dist/workflow/raw/native.effect.d.ts.map +1 -1
- package/dist/workflow/raw/native.effect.js +3 -5
- package/dist/workflow/raw/native.effect.js.map +1 -1
- package/dist/workflow/report-models.d.ts +412 -0
- package/dist/workflow/report-models.d.ts.map +1 -0
- package/dist/workflow/report-models.js +342 -0
- package/dist/workflow/report-models.js.map +1 -0
- package/dist/workflow/roundtrip.d.ts +31 -8
- package/dist/workflow/roundtrip.d.ts.map +1 -1
- package/dist/workflow/roundtrip.js +107 -26
- package/dist/workflow/roundtrip.js.map +1 -1
- package/dist/workflow/schema-rules.d.ts +38 -0
- package/dist/workflow/schema-rules.d.ts.map +1 -0
- package/dist/workflow/schema-rules.js +28 -0
- package/dist/workflow/schema-rules.js.map +1 -0
- package/dist/workflow/schema_rules.yml +69 -0
- package/dist/workflow/serialize.d.ts +30 -0
- package/dist/workflow/serialize.d.ts.map +1 -0
- package/dist/workflow/serialize.js +37 -0
- package/dist/workflow/serialize.js.map +1 -0
- package/dist/workflow/state-merge.d.ts +15 -32
- package/dist/workflow/state-merge.d.ts.map +1 -1
- package/dist/workflow/state-merge.js +30 -207
- package/dist/workflow/state-merge.js.map +1 -1
- package/dist/workflow/stateful-validate.d.ts +21 -0
- package/dist/workflow/stateful-validate.d.ts.map +1 -1
- package/dist/workflow/stateful-validate.js +27 -0
- package/dist/workflow/stateful-validate.js.map +1 -1
- package/dist/workflow/step-skeleton.d.ts +29 -0
- package/dist/workflow/step-skeleton.d.ts.map +1 -0
- package/dist/workflow/step-skeleton.js +55 -0
- package/dist/workflow/step-skeleton.js.map +1 -0
- package/dist/workflow/strict-checks.d.ts +22 -0
- package/dist/workflow/strict-checks.d.ts.map +1 -0
- package/dist/workflow/strict-checks.js +95 -0
- package/dist/workflow/strict-checks.js.map +1 -0
- package/dist/workflow/tool-state-io.d.ts +14 -0
- package/dist/workflow/tool-state-io.d.ts.map +1 -0
- package/dist/workflow/tool-state-io.js +33 -0
- package/dist/workflow/tool-state-io.js.map +1 -0
- package/dist/workflow/validators.d.ts +34 -0
- package/dist/workflow/validators.d.ts.map +1 -0
- package/dist/workflow/validators.js +83 -0
- package/dist/workflow/validators.js.map +1 -0
- package/dist/workflow/walk-helpers.d.ts +29 -0
- package/dist/workflow/walk-helpers.d.ts.map +1 -0
- package/dist/workflow/walk-helpers.js +89 -0
- package/dist/workflow/walk-helpers.js.map +1 -0
- package/dist/workflow/walker.d.ts +12 -0
- package/dist/workflow/walker.d.ts.map +1 -1
- package/dist/workflow/walker.js +27 -8
- package/dist/workflow/walker.js.map +1 -1
- package/package.json +6 -7
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Utility for navigating a ToolParameterModel tree by path segments.
|
|
3
|
+
*
|
|
4
|
+
* Used by LSP language servers to resolve completion and hover context
|
|
5
|
+
* inside tool_state YAML, including conditional branch filtering.
|
|
6
|
+
*/
|
|
7
|
+
import { isConditionalParam, isRepeatParam, isSectionParam } from "../schema/type-guards.js";
|
|
8
|
+
import { selectWhichWhen } from "./walk-helpers.js";
|
|
9
|
+
/**
|
|
10
|
+
* Navigate a tool parameter tree by path segments.
|
|
11
|
+
*
|
|
12
|
+
* - Sections: recurse into `parameters`
|
|
13
|
+
* - Repeats: skip numeric path segments, recurse into `parameters`
|
|
14
|
+
* - Conditionals: call selectWhichWhen(conditional, stateAtCurrentLevel),
|
|
15
|
+
* fall back to all branches merged if no state provided or no match
|
|
16
|
+
*
|
|
17
|
+
* `state` is the full state dict at the top of the tree; the function
|
|
18
|
+
* navigates it in parallel with the param tree to resolve nested conditionals.
|
|
19
|
+
*/
|
|
20
|
+
export function findParamAtPath(params, path, state) {
|
|
21
|
+
if (path.length === 0)
|
|
22
|
+
return { param: undefined, availableParams: params };
|
|
23
|
+
const [head, ...tail] = path;
|
|
24
|
+
// Skip numeric segments (repeat instance indices)
|
|
25
|
+
if (typeof head === "number")
|
|
26
|
+
return findParamAtPath(params, tail, state);
|
|
27
|
+
const match = params.find((p) => p.name === head);
|
|
28
|
+
if (!match)
|
|
29
|
+
return { param: undefined, availableParams: params };
|
|
30
|
+
if (tail.length === 0)
|
|
31
|
+
return { param: match, availableParams: params };
|
|
32
|
+
if (isSectionParam(match)) {
|
|
33
|
+
return findParamAtPath(match.parameters, tail, _getSubState(state, head));
|
|
34
|
+
}
|
|
35
|
+
if (isRepeatParam(match)) {
|
|
36
|
+
return findParamAtPath(match.parameters, tail, _getSubState(state, head));
|
|
37
|
+
}
|
|
38
|
+
if (isConditionalParam(match)) {
|
|
39
|
+
const conditionalState = _getSubState(state, head);
|
|
40
|
+
// Only filter to a specific branch when the discriminator key is
|
|
41
|
+
// explicitly present in state. If state is absent OR the discriminator
|
|
42
|
+
// key hasn't been set yet, merge all branches so completions/hover
|
|
43
|
+
// aren't artificially restricted to a default branch the user may not
|
|
44
|
+
// have chosen.
|
|
45
|
+
const discriminatorSet = conditionalState !== undefined && match.test_parameter.name in conditionalState;
|
|
46
|
+
const activeWhen = discriminatorSet ? selectWhichWhen(match, conditionalState) : null;
|
|
47
|
+
const branchParams = activeWhen
|
|
48
|
+
? activeWhen.parameters
|
|
49
|
+
: match.whens.flatMap((w) => w.parameters);
|
|
50
|
+
return findParamAtPath([match.test_parameter, ...branchParams], tail, conditionalState);
|
|
51
|
+
}
|
|
52
|
+
return { param: undefined, availableParams: params };
|
|
53
|
+
}
|
|
54
|
+
function _getSubState(state, key) {
|
|
55
|
+
const val = state?.[key];
|
|
56
|
+
return val && typeof val === "object" && !Array.isArray(val)
|
|
57
|
+
? val
|
|
58
|
+
: undefined;
|
|
59
|
+
}
|
|
60
|
+
//# sourceMappingURL=param-navigation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"param-navigation.js","sourceRoot":"","sources":["../../src/workflow/param-navigation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASpD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA4B,EAC5B,IAAyB,EACzB,KAA+B;IAE/B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;IAE5E,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7B,kDAAkD;IAClD,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,eAAe,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAE1E,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAClD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;IAEjE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;IAExE,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,gBAAgB,GAAG,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnD,iEAAiE;QACjE,uEAAuE;QACvE,mEAAmE;QACnE,sEAAsE;QACtE,eAAe;QACf,MAAM,gBAAgB,GACpB,gBAAgB,KAAK,SAAS,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,IAAI,gBAAgB,CAAC;QAClF,MAAM,UAAU,GAAG,gBAAgB,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,gBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACvF,MAAM,YAAY,GAAG,UAAU;YAC7B,CAAC,CAAC,UAAU,CAAC,UAAU;YACvB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAC7C,OAAO,eAAe,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC1F,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;AACvD,CAAC;AAED,SAAS,YAAY,CACnB,KAA0C,EAC1C,GAAW;IAEX,MAAM,GAAG,GAAG,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IACzB,OAAO,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAC1D,CAAC,CAAE,GAA+B;QAClC,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC"}
|
|
@@ -40,6 +40,13 @@ export declare const DocumentedSchema: Schema.Struct<{
|
|
|
40
40
|
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
41
41
|
}>;
|
|
42
42
|
export type Documented = typeof DocumentedSchema.Type;
|
|
43
|
+
export declare const RecordSchemaSchema: Schema.Struct<{
|
|
44
|
+
/** Defines the fields of the record. */
|
|
45
|
+
fields: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<Schema.suspend<any, any, never>>]>>;
|
|
46
|
+
/** Must be `record` */
|
|
47
|
+
type: Schema.Literal<["record"]>;
|
|
48
|
+
}>;
|
|
49
|
+
export type RecordSchema = typeof RecordSchemaSchema.Type;
|
|
43
50
|
/**
|
|
44
51
|
* Define an enumerated type.
|
|
45
52
|
*/
|
|
@@ -50,13 +57,6 @@ export declare const EnumSchemaSchema: Schema.Struct<{
|
|
|
50
57
|
type: Schema.Literal<["enum"]>;
|
|
51
58
|
}>;
|
|
52
59
|
export type EnumSchema = typeof EnumSchemaSchema.Type;
|
|
53
|
-
export declare const RecordSchemaSchema: Schema.Struct<{
|
|
54
|
-
/** Defines the fields of the record. */
|
|
55
|
-
fields: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<Schema.suspend<any, any, never>>]>>;
|
|
56
|
-
/** Must be `record` */
|
|
57
|
-
type: Schema.Literal<["record"]>;
|
|
58
|
-
}>;
|
|
59
|
-
export type RecordSchema = typeof RecordSchemaSchema.Type;
|
|
60
60
|
export declare const ArraySchemaSchema: Schema.Struct<{
|
|
61
61
|
/** Defines the type of the array elements. */
|
|
62
62
|
items: Schema.Union<[Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string"]>, Schema.Struct<{
|
|
@@ -204,25 +204,6 @@ export declare const OutputParameterSchema: Schema.Struct<{
|
|
|
204
204
|
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
205
205
|
}>;
|
|
206
206
|
export type OutputParameter = typeof OutputParameterSchema.Type;
|
|
207
|
-
/**
|
|
208
|
-
* Describe an output parameter of a workflow. The parameter must be
|
|
209
|
-
connected to one parameter defined in the workflow that
|
|
210
|
-
will provide the value of the output parameter. It is legal to
|
|
211
|
-
connect a WorkflowInputParameter to a WorkflowOutputParameter.
|
|
212
|
-
*/
|
|
213
|
-
export declare const WorkflowOutputParameterSchema: Schema.Struct<{
|
|
214
|
-
/** The unique identifier for this object. */
|
|
215
|
-
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
216
|
-
/** A short, human-readable label of this object. */
|
|
217
|
-
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
218
|
-
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
219
|
-
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
220
|
-
/** Specifies workflow parameter that supply the value of to the output parameter. */
|
|
221
|
-
outputSource: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
222
|
-
/** Specify valid types of data that may be assigned to this parameter. */
|
|
223
|
-
type: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>]>>;
|
|
224
|
-
}>;
|
|
225
|
-
export type WorkflowOutputParameter = typeof WorkflowOutputParameterSchema.Type;
|
|
226
207
|
/**
|
|
227
208
|
* This field specifies the location of the step's node when rendered in the workflow editor.
|
|
228
209
|
*/
|
|
@@ -266,6 +247,25 @@ export declare const WorkflowInputParameterSchema: Schema.Struct<{
|
|
|
266
247
|
default: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Unknown]>>;
|
|
267
248
|
}>;
|
|
268
249
|
export type WorkflowInputParameter = typeof WorkflowInputParameterSchema.Type;
|
|
250
|
+
/**
|
|
251
|
+
* Describe an output parameter of a workflow. The parameter must be
|
|
252
|
+
connected to one parameter defined in the workflow that
|
|
253
|
+
will provide the value of the output parameter. It is legal to
|
|
254
|
+
connect a WorkflowInputParameter to a WorkflowOutputParameter.
|
|
255
|
+
*/
|
|
256
|
+
export declare const WorkflowOutputParameterSchema: Schema.Struct<{
|
|
257
|
+
/** The unique identifier for this object. */
|
|
258
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
259
|
+
/** A short, human-readable label of this object. */
|
|
260
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
261
|
+
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
262
|
+
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
263
|
+
/** Specifies workflow parameter that supply the value of to the output parameter. */
|
|
264
|
+
outputSource: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
265
|
+
/** Specify valid types of data that may be assigned to this parameter. */
|
|
266
|
+
type: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>]>>;
|
|
267
|
+
}>;
|
|
268
|
+
export type WorkflowOutputParameter = typeof WorkflowOutputParameterSchema.Type;
|
|
269
269
|
/**
|
|
270
270
|
* The base executable type in CWL is the `Process` object defined by the
|
|
271
271
|
document. Note that the `Process` object is abstract and cannot be
|
|
@@ -386,22 +386,45 @@ export declare const ReferencesToolSchema: Schema.Struct<{
|
|
|
386
386
|
tool_version: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
387
387
|
}>;
|
|
388
388
|
export type ReferencesTool = typeof ReferencesToolSchema.Type;
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
389
|
+
/**
|
|
390
|
+
* Definition of an invocation report for this workflow. Currently the only
|
|
391
|
+
field is 'markdown'.
|
|
392
|
+
*/
|
|
393
|
+
export declare const ReportSchema: Schema.Struct<{
|
|
394
|
+
/** Galaxy flavored Markdown to define an invocation report. */
|
|
395
|
+
markdown: typeof Schema.String;
|
|
392
396
|
}>;
|
|
393
|
-
export type
|
|
397
|
+
export type Report = typeof ReportSchema.Type;
|
|
394
398
|
/**
|
|
395
|
-
*
|
|
399
|
+
* Base fields shared by all comment types.
|
|
396
400
|
*/
|
|
397
|
-
export declare const
|
|
398
|
-
/**
|
|
399
|
-
|
|
401
|
+
export declare const BaseCommentSchema: Schema.Struct<{
|
|
402
|
+
/** Position of the comment on the editor canvas as ``[x, y]`` coordinates. */
|
|
403
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
404
|
+
/** Size of the comment as ``[width, height]``. */
|
|
405
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
406
|
+
/** Display color of the comment (e.g. ``"none"``, ``"blue"``). */
|
|
407
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
408
|
+
/** Optional label for referencing this comment from frame ``contains_comments`` fields or for use as a map key when comments are represented as a mapping. */
|
|
400
409
|
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
401
|
-
source: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
402
|
-
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
403
410
|
}>;
|
|
404
|
-
export type
|
|
411
|
+
export type BaseComment = typeof BaseCommentSchema.Type;
|
|
412
|
+
/**
|
|
413
|
+
* A freehand drawn line on the editor canvas.
|
|
414
|
+
*/
|
|
415
|
+
export declare const FreehandCommentSchema: Schema.Struct<{
|
|
416
|
+
/** Comment type (``freehand``). */
|
|
417
|
+
type: Schema.Literal<["freehand"]>;
|
|
418
|
+
/** Line thickness. */
|
|
419
|
+
thickness: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
420
|
+
/** Array of ``[x, y]`` coordinate pairs defining the freehand line path. */
|
|
421
|
+
line: Schema.optional<Schema.Union<[Schema.Array$<Schema.Array$<typeof Schema.Number>>, typeof Schema.Null]>>;
|
|
422
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
423
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
424
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
425
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
426
|
+
}>;
|
|
427
|
+
export type FreehandComment = typeof FreehandCommentSchema.Type;
|
|
405
428
|
/**
|
|
406
429
|
* Base fields shared by all creator types, corresponding to schema.org
|
|
407
430
|
Thing properties common to both Person and Organization.
|
|
@@ -428,12 +451,22 @@ export declare const BaseCreatorSchema: Schema.Struct<{
|
|
|
428
451
|
}>;
|
|
429
452
|
export type BaseCreator = typeof BaseCreatorSchema.Type;
|
|
430
453
|
/**
|
|
431
|
-
*
|
|
432
|
-
Corresponds to a `schema.org
|
|
454
|
+
* A person who created or contributed to the workflow.
|
|
455
|
+
Corresponds to a `schema.org Person <https://schema.org/Person>`_.
|
|
433
456
|
*/
|
|
434
|
-
export declare const
|
|
435
|
-
/** Creator type discriminator (``
|
|
436
|
-
class: Schema.Literal<["
|
|
457
|
+
export declare const CreatorPersonSchema: Schema.Struct<{
|
|
458
|
+
/** Creator type discriminator (``Person``). */
|
|
459
|
+
class: Schema.Literal<["Person"]>;
|
|
460
|
+
/** Given (first) name. */
|
|
461
|
+
givenName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
462
|
+
/** Family (last) name. */
|
|
463
|
+
familyName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
464
|
+
/** Honorific prefix (e.g. ``Dr``, ``Prof``). */
|
|
465
|
+
honorificPrefix: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
466
|
+
/** Honorific suffix (e.g. ``M.D.``, ``PhD``). */
|
|
467
|
+
honorificSuffix: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
468
|
+
/** Job title or role. */
|
|
469
|
+
jobTitle: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
437
470
|
name: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
438
471
|
identifier: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
439
472
|
url: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
@@ -444,44 +477,27 @@ export declare const CreatorOrganizationSchema: Schema.Struct<{
|
|
|
444
477
|
telephone: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
445
478
|
faxNumber: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
446
479
|
}>;
|
|
447
|
-
export type
|
|
448
|
-
/**
|
|
449
|
-
* Base fields shared by all comment types.
|
|
450
|
-
*/
|
|
451
|
-
export declare const BaseCommentSchema: Schema.Struct<{
|
|
452
|
-
/** Position of the comment on the editor canvas as ``[x, y]`` coordinates. */
|
|
453
|
-
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
454
|
-
/** Size of the comment as ``[width, height]``. */
|
|
455
|
-
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
456
|
-
/** Display color of the comment (e.g. ``"none"``, ``"blue"``). */
|
|
457
|
-
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
458
|
-
/** Optional label for referencing this comment from frame ``contains_comments`` fields or for use as a map key when comments are represented as a mapping. */
|
|
459
|
-
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
460
|
-
}>;
|
|
461
|
-
export type BaseComment = typeof BaseCommentSchema.Type;
|
|
480
|
+
export type CreatorPerson = typeof CreatorPersonSchema.Type;
|
|
462
481
|
/**
|
|
463
|
-
* A
|
|
482
|
+
* A plain text annotation in the workflow editor.
|
|
464
483
|
*/
|
|
465
|
-
export declare const
|
|
466
|
-
/** Comment type (``
|
|
467
|
-
type: Schema.Literal<["
|
|
468
|
-
/**
|
|
484
|
+
export declare const TextCommentSchema: Schema.Struct<{
|
|
485
|
+
/** Comment type (``text``). */
|
|
486
|
+
type: Schema.Literal<["text"]>;
|
|
487
|
+
/** The text content. */
|
|
469
488
|
text: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
489
|
+
/** Whether the text is displayed in bold. */
|
|
490
|
+
bold: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
491
|
+
/** Whether the text is displayed in italic. */
|
|
492
|
+
italic: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
493
|
+
/** Font size of the text. */
|
|
494
|
+
text_size: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
470
495
|
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
471
496
|
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
472
497
|
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
473
498
|
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
474
499
|
}>;
|
|
475
|
-
export type
|
|
476
|
-
/**
|
|
477
|
-
* Definition of an invocation report for this workflow. Currently the only
|
|
478
|
-
field is 'markdown'.
|
|
479
|
-
*/
|
|
480
|
-
export declare const ReportSchema: Schema.Struct<{
|
|
481
|
-
/** Galaxy flavored Markdown to define an invocation report. */
|
|
482
|
-
markdown: typeof Schema.String;
|
|
483
|
-
}>;
|
|
484
|
-
export type Report = typeof ReportSchema.Type;
|
|
500
|
+
export type TextComment = typeof TextCommentSchema.Type;
|
|
485
501
|
/**
|
|
486
502
|
* A rectangular grouping box that visually contains steps and other comments.
|
|
487
503
|
*/
|
|
@@ -501,42 +517,26 @@ export declare const FrameCommentSchema: Schema.Struct<{
|
|
|
501
517
|
}>;
|
|
502
518
|
export type FrameComment = typeof FrameCommentSchema.Type;
|
|
503
519
|
/**
|
|
504
|
-
* A
|
|
520
|
+
* A Markdown-rendered annotation in the workflow editor.
|
|
505
521
|
*/
|
|
506
|
-
export declare const
|
|
507
|
-
/** Comment type (``
|
|
508
|
-
type: Schema.Literal<["
|
|
509
|
-
/**
|
|
522
|
+
export declare const MarkdownCommentSchema: Schema.Struct<{
|
|
523
|
+
/** Comment type (``markdown``). */
|
|
524
|
+
type: Schema.Literal<["markdown"]>;
|
|
525
|
+
/** Markdown content. */
|
|
510
526
|
text: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
511
|
-
/** Whether the text is displayed in bold. */
|
|
512
|
-
bold: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
513
|
-
/** Whether the text is displayed in italic. */
|
|
514
|
-
italic: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
515
|
-
/** Font size of the text. */
|
|
516
|
-
text_size: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
517
527
|
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
518
528
|
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
519
529
|
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
520
530
|
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
521
531
|
}>;
|
|
522
|
-
export type
|
|
532
|
+
export type MarkdownComment = typeof MarkdownCommentSchema.Type;
|
|
523
533
|
/**
|
|
524
|
-
*
|
|
525
|
-
Corresponds to a `schema.org
|
|
534
|
+
* An organization that created or contributed to the workflow.
|
|
535
|
+
Corresponds to a `schema.org Organization <https://schema.org/Organization>`_.
|
|
526
536
|
*/
|
|
527
|
-
export declare const
|
|
528
|
-
/** Creator type discriminator (``
|
|
529
|
-
class: Schema.Literal<["
|
|
530
|
-
/** Given (first) name. */
|
|
531
|
-
givenName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
532
|
-
/** Family (last) name. */
|
|
533
|
-
familyName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
534
|
-
/** Honorific prefix (e.g. ``Dr``, ``Prof``). */
|
|
535
|
-
honorificPrefix: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
536
|
-
/** Honorific suffix (e.g. ``M.D.``, ``PhD``). */
|
|
537
|
-
honorificSuffix: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
538
|
-
/** Job title or role. */
|
|
539
|
-
jobTitle: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
537
|
+
export declare const CreatorOrganizationSchema: Schema.Struct<{
|
|
538
|
+
/** Creator type discriminator (``Organization``). */
|
|
539
|
+
class: Schema.Literal<["Organization"]>;
|
|
540
540
|
name: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
541
541
|
identifier: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
542
542
|
url: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
@@ -547,23 +547,7 @@ export declare const CreatorPersonSchema: Schema.Struct<{
|
|
|
547
547
|
telephone: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
548
548
|
faxNumber: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
549
549
|
}>;
|
|
550
|
-
export type
|
|
551
|
-
/**
|
|
552
|
-
* A freehand drawn line on the editor canvas.
|
|
553
|
-
*/
|
|
554
|
-
export declare const FreehandCommentSchema: Schema.Struct<{
|
|
555
|
-
/** Comment type (``freehand``). */
|
|
556
|
-
type: Schema.Literal<["freehand"]>;
|
|
557
|
-
/** Line thickness. */
|
|
558
|
-
thickness: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
559
|
-
/** Array of ``[x, y]`` coordinate pairs defining the freehand line path. */
|
|
560
|
-
line: Schema.optional<Schema.Union<[Schema.Array$<Schema.Array$<typeof Schema.Number>>, typeof Schema.Null]>>;
|
|
561
|
-
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
562
|
-
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
563
|
-
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
564
|
-
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
565
|
-
}>;
|
|
566
|
-
export type FreehandComment = typeof FreehandCommentSchema.Type;
|
|
550
|
+
export type CreatorOrganization = typeof CreatorOrganizationSchema.Type;
|
|
567
551
|
/**
|
|
568
552
|
* A Galaxy workflow description. This record corresponds to the description of a workflow that should be executable
|
|
569
553
|
on a Galaxy server that includes the contained tool definitions.
|
|
@@ -825,6 +809,22 @@ export declare const WorkflowStepOutputSchema: Schema.Struct<{
|
|
|
825
809
|
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
826
810
|
}>;
|
|
827
811
|
export type WorkflowStepOutput = typeof WorkflowStepOutputSchema.Type;
|
|
812
|
+
export declare const SinkSchema: Schema.Struct<{
|
|
813
|
+
/** Specifies one or more workflow parameters that will provide input to the underlying step parameter. */
|
|
814
|
+
source: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
815
|
+
}>;
|
|
816
|
+
export type Sink = typeof SinkSchema.Type;
|
|
817
|
+
/**
|
|
818
|
+
* TODO:
|
|
819
|
+
*/
|
|
820
|
+
export declare const WorkflowStepInputSchema: Schema.Struct<{
|
|
821
|
+
/** The default value for this parameter to use if either there is no `source` field, or the value produced by the `source` is `null`. The default must be applied prior to scattering or evaluating `va... */
|
|
822
|
+
default: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Unknown]>>;
|
|
823
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
824
|
+
source: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
825
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
826
|
+
}>;
|
|
827
|
+
export type WorkflowStepInput = typeof WorkflowStepInputSchema.Type;
|
|
828
828
|
/**
|
|
829
829
|
* This represents a non-input step a Galaxy Workflow.
|
|
830
830
|
|
|
@@ -884,7 +884,231 @@ export declare const WorkflowStepSchema: Schema.Struct<{
|
|
|
884
884
|
/** Workflow step module's type (defaults to 'tool'). */
|
|
885
885
|
type: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Literal<["tool", "subworkflow", "pause", "pick_value"]>]>>;
|
|
886
886
|
/** Specifies a subworkflow to run. May be an inline workflow definition, a URL string, or an @import reference dict. */
|
|
887
|
-
run: Schema.optional<Schema.Union<[Schema.
|
|
887
|
+
run: Schema.optional<Schema.Union<[Schema.Struct<{
|
|
888
|
+
/** The unique identifier for this object. */
|
|
889
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
890
|
+
class: Schema.Literal<["GalaxyWorkflow"]>;
|
|
891
|
+
/** A short, human-readable label of this object. */
|
|
892
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
893
|
+
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
894
|
+
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
895
|
+
/** The individual steps that make up the workflow. Each step is executed when all of its input data links are fulfilled. */
|
|
896
|
+
steps: Schema.Union<[Schema.Array$<Schema.suspend<any, any, never>>, Schema.Record$<typeof Schema.String, Schema.suspend<any, any, never>>]>;
|
|
897
|
+
/** Workflow invocation report template. */
|
|
898
|
+
report: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Struct<{
|
|
899
|
+
/** Galaxy flavored Markdown to define an invocation report. */
|
|
900
|
+
markdown: typeof Schema.String;
|
|
901
|
+
}>]>>;
|
|
902
|
+
/** Tags for the workflow. */
|
|
903
|
+
tags: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.String>, typeof Schema.Null]>>;
|
|
904
|
+
/** Visual annotations for the workflow editor canvas. Comments are non-functional and do not affect workflow execution. May be specified as a list or as a mapping keyed by label. */
|
|
905
|
+
comments: Schema.optional<Schema.Union<[Schema.Array$<Schema.Union<[Schema.Struct<{
|
|
906
|
+
/** Comment type (``text``). */
|
|
907
|
+
type: Schema.Literal<["text"]>;
|
|
908
|
+
/** The text content. */
|
|
909
|
+
text: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
910
|
+
/** Whether the text is displayed in bold. */
|
|
911
|
+
bold: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
912
|
+
/** Whether the text is displayed in italic. */
|
|
913
|
+
italic: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
914
|
+
/** Font size of the text. */
|
|
915
|
+
text_size: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
916
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
917
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
918
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
919
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
920
|
+
}>, Schema.Struct<{
|
|
921
|
+
/** Comment type (``markdown``). */
|
|
922
|
+
type: Schema.Literal<["markdown"]>;
|
|
923
|
+
/** Markdown content. */
|
|
924
|
+
text: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
925
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
926
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
927
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
928
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
929
|
+
}>, Schema.Struct<{
|
|
930
|
+
/** Comment type (``frame``). */
|
|
931
|
+
type: Schema.Literal<["frame"]>;
|
|
932
|
+
/** Title displayed on the frame header. */
|
|
933
|
+
title: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
934
|
+
/** Step labels or indices contained within this frame. */
|
|
935
|
+
contains_steps: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<Schema.Union<[typeof Schema.String, typeof Schema.Number]>>]>>;
|
|
936
|
+
/** Comment labels or indices contained within this frame. */
|
|
937
|
+
contains_comments: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<Schema.Union<[typeof Schema.String, typeof Schema.Number]>>]>>;
|
|
938
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
939
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
940
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
941
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
942
|
+
}>, Schema.Struct<{
|
|
943
|
+
/** Comment type (``freehand``). */
|
|
944
|
+
type: Schema.Literal<["freehand"]>;
|
|
945
|
+
/** Line thickness. */
|
|
946
|
+
thickness: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
947
|
+
/** Array of ``[x, y]`` coordinate pairs defining the freehand line path. */
|
|
948
|
+
line: Schema.optional<Schema.Union<[Schema.Array$<Schema.Array$<typeof Schema.Number>>, typeof Schema.Null]>>;
|
|
949
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
950
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
951
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
952
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
953
|
+
}>]>>, Schema.Record$<typeof Schema.String, Schema.Union<[Schema.Struct<{
|
|
954
|
+
/** Comment type (``text``). */
|
|
955
|
+
type: Schema.Literal<["text"]>;
|
|
956
|
+
/** The text content. */
|
|
957
|
+
text: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
958
|
+
/** Whether the text is displayed in bold. */
|
|
959
|
+
bold: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
960
|
+
/** Whether the text is displayed in italic. */
|
|
961
|
+
italic: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Boolean]>>;
|
|
962
|
+
/** Font size of the text. */
|
|
963
|
+
text_size: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
964
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
965
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
966
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
967
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
968
|
+
}>, Schema.Struct<{
|
|
969
|
+
/** Comment type (``markdown``). */
|
|
970
|
+
type: Schema.Literal<["markdown"]>;
|
|
971
|
+
/** Markdown content. */
|
|
972
|
+
text: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
973
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
974
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
975
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
976
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
977
|
+
}>, Schema.Struct<{
|
|
978
|
+
/** Comment type (``frame``). */
|
|
979
|
+
type: Schema.Literal<["frame"]>;
|
|
980
|
+
/** Title displayed on the frame header. */
|
|
981
|
+
title: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
982
|
+
/** Step labels or indices contained within this frame. */
|
|
983
|
+
contains_steps: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<Schema.Union<[typeof Schema.String, typeof Schema.Number]>>]>>;
|
|
984
|
+
/** Comment labels or indices contained within this frame. */
|
|
985
|
+
contains_comments: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<Schema.Union<[typeof Schema.String, typeof Schema.Number]>>]>>;
|
|
986
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
987
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
988
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
989
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
990
|
+
}>, Schema.Struct<{
|
|
991
|
+
/** Comment type (``freehand``). */
|
|
992
|
+
type: Schema.Literal<["freehand"]>;
|
|
993
|
+
/** Line thickness. */
|
|
994
|
+
thickness: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Number]>>;
|
|
995
|
+
/** Array of ``[x, y]`` coordinate pairs defining the freehand line path. */
|
|
996
|
+
line: Schema.optional<Schema.Union<[Schema.Array$<Schema.Array$<typeof Schema.Number>>, typeof Schema.Null]>>;
|
|
997
|
+
position: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
998
|
+
size: Schema.optional<Schema.Union<[Schema.Array$<typeof Schema.Number>, typeof Schema.Null]>>;
|
|
999
|
+
color: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1000
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1001
|
+
}>]>>, typeof Schema.Null]>>;
|
|
1002
|
+
/** Workflow creators. Can be schema.org Person (https://schema.org/Person) or Organization (https://schema.org/Organization) entities. */
|
|
1003
|
+
creator: Schema.optional<Schema.Union<[Schema.Array$<Schema.Union<[Schema.Struct<{
|
|
1004
|
+
/** Creator type discriminator (``Person``). */
|
|
1005
|
+
class: Schema.Literal<["Person"]>;
|
|
1006
|
+
/** Given (first) name. */
|
|
1007
|
+
givenName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1008
|
+
/** Family (last) name. */
|
|
1009
|
+
familyName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1010
|
+
/** Honorific prefix (e.g. ``Dr``, ``Prof``). */
|
|
1011
|
+
honorificPrefix: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1012
|
+
/** Honorific suffix (e.g. ``M.D.``, ``PhD``). */
|
|
1013
|
+
honorificSuffix: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1014
|
+
/** Job title or role. */
|
|
1015
|
+
jobTitle: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1016
|
+
name: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1017
|
+
identifier: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1018
|
+
url: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1019
|
+
email: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1020
|
+
image: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1021
|
+
address: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1022
|
+
alternateName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1023
|
+
telephone: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1024
|
+
faxNumber: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1025
|
+
}>, Schema.Struct<{
|
|
1026
|
+
/** Creator type discriminator (``Organization``). */
|
|
1027
|
+
class: Schema.Literal<["Organization"]>;
|
|
1028
|
+
name: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1029
|
+
identifier: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1030
|
+
url: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1031
|
+
email: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1032
|
+
image: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1033
|
+
address: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1034
|
+
alternateName: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1035
|
+
telephone: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1036
|
+
faxNumber: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1037
|
+
}>]>>, typeof Schema.Null]>>;
|
|
1038
|
+
/** Must be a valid license listed at https://spdx.org/licenses/ */
|
|
1039
|
+
license: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1040
|
+
/** If listed should correspond to the release of the workflow in its source reposiory. */
|
|
1041
|
+
release: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1042
|
+
uuid: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1043
|
+
inputs: Schema.Union<[Schema.Array$<Schema.Struct<{
|
|
1044
|
+
/** The unique identifier for this object. */
|
|
1045
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1046
|
+
/** A short, human-readable label of this object. */
|
|
1047
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1048
|
+
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
1049
|
+
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
1050
|
+
/** Specify valid types of data that may be assigned to this parameter. */
|
|
1051
|
+
type: Schema.optional<Schema.Union<[Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>, typeof Schema.Null, Schema.Array$<Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>>]>>;
|
|
1052
|
+
/** If set to true, `WorkflowInputParameter` is not required to submit the workflow. */
|
|
1053
|
+
optional: Schema.optional<Schema.Union<[typeof Schema.Boolean, typeof Schema.Null]>>;
|
|
1054
|
+
/** Specify datatype extension for valid input datasets. */
|
|
1055
|
+
format: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<typeof Schema.String>]>>;
|
|
1056
|
+
/** Collection type (defaults to `list` if `type` is `collection`). Nested collection types are separated with colons, e.g. `list:list:paired`. */
|
|
1057
|
+
collection_type: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1058
|
+
position: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Struct<{
|
|
1059
|
+
/** Relative vertical position of the step's node when rendered in the workflow editor. */
|
|
1060
|
+
top: typeof Schema.Number;
|
|
1061
|
+
/** Relative horizontal position of the step's node when rendered in the workflow editor. */
|
|
1062
|
+
left: typeof Schema.Number;
|
|
1063
|
+
}>]>>;
|
|
1064
|
+
default: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Unknown]>>;
|
|
1065
|
+
}>>, Schema.Record$<typeof Schema.String, Schema.Union<[Schema.Struct<{
|
|
1066
|
+
/** The unique identifier for this object. */
|
|
1067
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1068
|
+
/** A short, human-readable label of this object. */
|
|
1069
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1070
|
+
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
1071
|
+
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
1072
|
+
/** Specify valid types of data that may be assigned to this parameter. */
|
|
1073
|
+
type: Schema.optional<Schema.Union<[Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>, typeof Schema.Null, Schema.Array$<Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>>]>>;
|
|
1074
|
+
/** If set to true, `WorkflowInputParameter` is not required to submit the workflow. */
|
|
1075
|
+
optional: Schema.optional<Schema.Union<[typeof Schema.Boolean, typeof Schema.Null]>>;
|
|
1076
|
+
/** Specify datatype extension for valid input datasets. */
|
|
1077
|
+
format: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<typeof Schema.String>]>>;
|
|
1078
|
+
/** Collection type (defaults to `list` if `type` is `collection`). Nested collection types are separated with colons, e.g. `list:list:paired`. */
|
|
1079
|
+
collection_type: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1080
|
+
position: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Struct<{
|
|
1081
|
+
/** Relative vertical position of the step's node when rendered in the workflow editor. */
|
|
1082
|
+
top: typeof Schema.Number;
|
|
1083
|
+
/** Relative horizontal position of the step's node when rendered in the workflow editor. */
|
|
1084
|
+
left: typeof Schema.Number;
|
|
1085
|
+
}>]>>;
|
|
1086
|
+
default: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.Unknown]>>;
|
|
1087
|
+
}>, typeof Schema.String]>>, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>]>;
|
|
1088
|
+
outputs: Schema.Union<[Schema.Array$<Schema.Struct<{
|
|
1089
|
+
/** The unique identifier for this object. */
|
|
1090
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1091
|
+
/** A short, human-readable label of this object. */
|
|
1092
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1093
|
+
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
1094
|
+
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
1095
|
+
/** Specifies workflow parameter that supply the value of to the output parameter. */
|
|
1096
|
+
outputSource: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1097
|
+
/** Specify valid types of data that may be assigned to this parameter. */
|
|
1098
|
+
type: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>]>>;
|
|
1099
|
+
}>>, Schema.Record$<typeof Schema.String, Schema.Union<[Schema.Struct<{
|
|
1100
|
+
/** The unique identifier for this object. */
|
|
1101
|
+
id: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1102
|
+
/** A short, human-readable label of this object. */
|
|
1103
|
+
label: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1104
|
+
/** A documentation string for this object, or an array of strings which should be concatenated. */
|
|
1105
|
+
doc: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String, Schema.Array$<typeof Schema.String>]>>;
|
|
1106
|
+
/** Specifies workflow parameter that supply the value of to the output parameter. */
|
|
1107
|
+
outputSource: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|
|
1108
|
+
/** Specify valid types of data that may be assigned to this parameter. */
|
|
1109
|
+
type: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Literal<["null", "boolean", "int", "long", "float", "double", "string", "integer", "text", "File", "data", "collection"]>]>>;
|
|
1110
|
+
}>, typeof Schema.String]>>, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>]>;
|
|
1111
|
+
}>, typeof Schema.String, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>, typeof Schema.Null]>>;
|
|
888
1112
|
runtime_inputs: Schema.optional<Schema.Union<[typeof Schema.Null, Schema.Array$<typeof Schema.String>]>>;
|
|
889
1113
|
/** If defined, only run the step when the expression evaluates to `true`. If `false` the step is skipped. A skipped step produces a `null` on each output. Expression should be an ecma5.1 expression. */
|
|
890
1114
|
when: Schema.optional<Schema.Union<[typeof Schema.Null, typeof Schema.String]>>;
|