@fugood/bricks-project 2.24.4 → 2.24.5

package/types/data-calc-command/collection.ts

@@ -0,0 +1,418 @@
+/* Auto generated by build script */
+import type { DataCalculationData, DataCommand, DataCalcInput, DataCalcOutput } from './base'
+
+/* Compact — Remove false, undefined, 0, "", undefined, NaN in array */
+export type DataCommandCollectionCompact = DataCommand & {
+  __commandName: 'COLLECTION_COMPACT'
+  inputs?: Array<DataCalcInput<'collection', Array<any>> /* default: [] */>
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Concat — Concat object or array. Return empty array if no var provided. */
+export type DataCommandCollectionConcat = DataCommand & {
+  __commandName: 'COLLECTION_CONCAT'
+  inputs?: Array<
+    | DataCalcInput<'var1', any> /* default: [] */
+    | DataCalcInput<'var2', any> /* default: [] */
+    | DataCalcInput<'var3', any> /* default: [] */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Count — Group the contents of arrays or objects and output individual counts.
+If group_by_path provided, it will use value from path to group, use whole value as key if path is empty string, then output to result.
+If group_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_group, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionCount = DataCommand & {
+  __commandName: 'COLLECTION_COUNT'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'group_by_path', string> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_group',
+        string
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: object */
+  >
+}
+
+/* Difference — Creates an array of array values not included in the other given arrays. */
+export type DataCommandCollectionDifference = DataCommand & {
+  __commandName: 'COLLECTION_DIFFERENCE'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'values', Array<any>> /* default: [] */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Drop — Drop values with number in array or object. */
+export type DataCommandCollectionDrop = DataCommand & {
+  __commandName: 'COLLECTION_DROP'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'number', any> /* default: 1 */
+    | DataCalcInput<'forward', boolean> /* default: true */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Every — Whether all the contents in the array or object meet the conditions.
+If predicate provided, it will use LOGICTYPE_EQUAL_VALUE to compare, then output to result.
+If predicate not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_valid, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionEvery = DataCommand & {
+  __commandName: 'COLLECTION_EVERY'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'predicate', object> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_valid',
+        boolean
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: boolean */
+  >
+}
+
+/* Fill — Fill value in array with length.  Example: COLLECTION_FILL(start=2, length=2, value='A')  Result：[undefined, undefined, 'A', 'A'] */
+export type DataCommandCollectionFill = DataCommand & {
+  __commandName: 'COLLECTION_FILL'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'start', any> /* default: 0 */
+    | DataCalcInput<'length', any> /* default: length to end of array */
+    | DataCalcInput<'value', any> /* default: undefined */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Filter — Filter the content that meets the conditions in the array or object.
+If predicate provided, it will use LOGICTYPE_EQUAL_VALUE to compare, then output to result.
+If predicate not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_valid, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionFilter = DataCommand & {
+  __commandName: 'COLLECTION_FILTER'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'predicate', object> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_valid',
+        boolean
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Find — Find first value by condition in array.
+If predicate provided, it will use LOGICTYPE_EQUAL_VALUE to compare, then output to result.
+If predicate not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_valid, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionFind = DataCommand & {
+  __commandName: 'COLLECTION_FIND'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'predicate', object> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_valid',
+        boolean
+      > /* iteratee callback input */ /* default: undefined */
+    | DataCalcInput<'forward', boolean> /* default: true */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Find Key — Find key of first value by condition in array.
+If predicate provided, it will use LOGICTYPE_EQUAL_VALUE to compare, then output to result.
+If predicate not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_valid, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionFindKey = DataCommand & {
+  __commandName: 'COLLECTION_FIND_KEY'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'predicate', object> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_valid',
+        boolean
+      > /* iteratee callback input */ /* default: undefined */
+    | DataCalcInput<'forward', boolean> /* default: true */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* First — Get first value in array */
+export type DataCommandCollectionFirst = DataCommand & {
+  __commandName: 'COLLECTION_FIRST'
+  inputs?: Array<DataCalcInput<'array', Array<any>> /* default: [] */>
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Flatten — Flatten a single level deep or recursively deep. */
+export type DataCommandCollectionFlatten = DataCommand & {
+  __commandName: 'COLLECTION_FLATTEN'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'deep', boolean> /* default: true */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Group By — Group array elements or object attributes into groups and generate objects.
+If group_by_path provided, it will use value from path to group, use whole value as key if path is empty string, then output to result.
+If group_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_group, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionGroupBy = DataCommand & {
+  __commandName: 'COLLECTION_GROUP_BY'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'group_by_path', string> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_group',
+        string
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: object */
+  >
+}
+
+/* Includes — Check value in array. */
+export type DataCommandCollectionIncludes = DataCommand & {
+  __commandName: 'COLLECTION_INCLUDES'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'value', any> /* default: undefined */
+    | DataCalcInput<'from_index', any> /* default: 0 */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: boolean */>
+}
+
+/* Intersection — Get arrays intersection.
+If intersection_by_path provided, it will use value from path to intersect, use whole value as key if path is empty string, then output to result.
+If intersection_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_value, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionIntersection = DataCommand & {
+  __commandName: 'COLLECTION_INTERSECTION'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'intersection_by_path', string> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_value',
+        any
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Key By — Use the specified value as the property name of the new object.
+If key_by_path provided, it will use value from path as key, use whole value as key if path is empty string, then output to result.
+If key_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_key, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionKeyBy = DataCommand & {
+  __commandName: 'COLLECTION_KEY_BY'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'key_by_path', string> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_key',
+        string
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: object */
+  >
+}
+
+/* Last — Get last value of array. */
+export type DataCommandCollectionLast = DataCommand & {
+  __commandName: 'COLLECTION_LAST'
+  inputs?: Array<DataCalcInput<'array', Array<any>> /* default: [] */>
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Map — Map to new array.
+If map_by_path provided, it will use value from path, use whole value if path is empty string, then output to result.
+If map_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_value, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionMap = DataCommand & {
+  __commandName: 'COLLECTION_MAP'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'map_by_path', string> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_value',
+        any
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Nth — Get N th value of array. */
+export type DataCommandCollectionNth = DataCommand & {
+  __commandName: 'COLLECTION_NTH'
+  inputs?: Array<
+    DataCalcInput<'array', Array<any>> /* default: [] */ | DataCalcInput<'n', any> /* default: 0 */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Push — Push value into array. */
+export type DataCommandCollectionPush = DataCommand & {
+  __commandName: 'COLLECTION_PUSH'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'forward', boolean> /* default: true */
+    | DataCalcInput<'var1', any> /* default: undefined */
+    | DataCalcInput<'var2', any> /* default: undefined */
+    | DataCalcInput<'var3', any> /* default: undefined */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Reduce — Reduce the array to a single result.
+It will trigger iteratee_input callback for every property (With { result, key, value }).  After the calculation triggered iteratee_result, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionReduce = DataCommand & {
+  __commandName: 'COLLECTION_REDUCE'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'initial_value', any> /* default: undefined */
+    | DataCalcInput<'iteratee_result', any> /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Reverse — Reverse array */
+export type DataCommandCollectionReverse = DataCommand & {
+  __commandName: 'COLLECTION_REVERSE'
+  inputs?: Array<DataCalcInput<'array', Array<any>> /* default: [] */>
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Sample — Get N th value of array randomly. */
+export type DataCommandCollectionSample = DataCommand & {
+  __commandName: 'COLLECTION_SAMPLE'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'n', any> /* default: 0 */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Shuffie — Shuffie array order. */
+export type DataCommandCollectionShuffle = DataCommand & {
+  __commandName: 'COLLECTION_SHUFFLE'
+  inputs?: Array<DataCalcInput<'array', Array<any>> /* default: [] */>
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Size — Get array size. */
+export type DataCommandCollectionSize = DataCommand & {
+  __commandName: 'COLLECTION_SIZE'
+  inputs?: Array<DataCalcInput<'collection', Array<any> | object> /* default: [] */>
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Slice — Slice array. */
+export type DataCommandCollectionSlice = DataCommand & {
+  __commandName: 'COLLECTION_SLICE'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'start', any> /* default: 0 */
+    | DataCalcInput<'end', any> /* default: Array length */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Some — Check whether any of the array or object property meets the conditions.
+If predicate provided, it will use LOGICTYPE_EQUAL_VALUE to compare, then output to result.
+If predicate not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_valid, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionSome = DataCommand & {
+  __commandName: 'COLLECTION_SOME'
+  inputs?: Array<
+    | DataCalcInput<'collection', Array<any> | object> /* default: [] */
+    | DataCalcInput<'predicate', object> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_valid',
+        boolean
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: boolean */
+  >
+}
+
+/* Sort — Sort array.
+If sort_by_path provided, it will use value from path to sort, use whole value if path is empty string, then output to result.
+If sort_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_value, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionSort = DataCommand & {
+  __commandName: 'COLLECTION_SORT'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'sort_by_path', string | Array<any>> /* default: undefined */
+    | DataCalcInput<
+        'iteratee_result_value',
+        any
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Take — Creates a slice of array with n elements taken from the beginning. */
+export type DataCommandCollectionTake = DataCommand & {
+  __commandName: 'COLLECTION_TAKE'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'n', any> /* default: 1 */
+    | DataCalcInput<'forward', boolean> /* default: true */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}
+
+/* Union — Creates an array of unique values, in order, from all given arrays.
+If union_by_path provided, it will use path to compare, then output to result.
+If union_by_path not provided, it will trigger iteratee_input callback for every property (With { key, value }).  After the calculation triggered iteratee_result_value, it will confirm whether to continue the next trigger of iteratee_input. Finally, it will trigger result output. */
+export type DataCommandCollectionUnion = DataCommand & {
+  __commandName: 'COLLECTION_UNION'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'union_by_path', string> /* default: "" */
+    | DataCalcInput<
+        'iteratee_result_value',
+        any
+      > /* iteratee callback input */ /* default: undefined */
+  >
+  outputs?: Array<
+    | DataCalcOutput<'iteratee_input'> /* iteratee callback */ /* target: object */
+    | DataCalcOutput<'result'> /* target: any */
+  >
+}
+
+/* Without — Creates an array excluding all given values. */
+export type DataCommandCollectionWithout = DataCommand & {
+  __commandName: 'COLLECTION_WITHOUT'
+  inputs?: Array<
+    | DataCalcInput<'array', Array<any>> /* default: [] */
+    | DataCalcInput<'exclude', Array<any>> /* default: [] */
+  >
+  outputs?: Array<DataCalcOutput<'result'> /* target: any */>
+}