@lcap/nasl 2.16.1 → 2.17.1

package/out/concepts/basics/stdlib/nasl.util.js

@@ -14,6 +14,7 @@ const NumericLiteral__1 = __importDefault(require("../../NumericLiteral__"));
 const Identifier__1 = __importDefault(require("../../Identifier__"));
 const BooleanLiteral__1 = __importDefault(require("../../BooleanLiteral__"));
 const StringLiteral__1 = __importDefault(require("../../StringLiteral__"));
+const AnonymousFunction__1 = __importDefault(require("../../AnonymousFunction__"));
 exports.default = new Namespace__1.default({
     name: 'util',
     logics: [
@@ -213,7 +214,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Split',
-            description: '将字符串参数，用分割符分割成字符串集合，并返回',
+            description: '将字符串参数，用分割符分割成字符串列表，并返回',
             params: [
                 new Param__1.default({
                     name: 'str',
@@ -234,7 +235,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Join',
-            description: '将集合的项，用连接符连接成一个字符串，并返回',
+            description: '将列表的项，用连接符连接成一个字符串，并返回',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -319,7 +320,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Trim',
-            description: '返回删除前后空格的字符串',
+            description: '删除字符串的前后空格并返回',
             params: [
                 new Param__1.default({
                     name: 'str1',
@@ -334,7 +335,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Get',
-            description: '获得集合指定索引的项',
+            description: '获得列表位于指定索引处的项',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -355,7 +356,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Set',
-            description: '为集合指定索引赋值（覆盖原索引项）',
+            description: '为列表的指定索引项赋值（覆盖原索引项）',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -380,7 +381,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Contains',
-            description: '返回集合是否包含某一项',
+            description: '测试列表是否包含某一项，返回测试结果',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -401,7 +402,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Add',
-            description: '为集合末尾添加项，并返回集合长度',
+            description: '在列表末尾追加项',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -417,7 +418,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'AddAll',
-            description: '为集合添加多项内容，并返回集合长度',
+            description: '为一个列表添加另一列表中的多项内容，并返回新列表的长度',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -440,7 +441,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Insert',
-            description: '为集合指定索引插入项（原索引项依次后推）',
+            description: '在列表的指定索引处插入新项（原索引项依次后推）',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -460,7 +461,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'Remove',
-            description: '删除集合的项',
+            description: '删除列表的某项',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -476,7 +477,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'RemoveAt',
-            description: '删除集合位于某个索引的项',
+            description: '在列表中删除位于指定索引的项',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -495,6 +496,183 @@ exports.default = new Namespace__1.default({
                 }),
             ],
         }),
+        new Function__1.default({
+            name: 'ListHead',
+            description: '返回列表的首项',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListLast',
+            description: '返回列表的末项',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListFlatten',
+            description: '将嵌套列表摊平一层并返回（List<List<T>> 变为 List<T>）',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
+                        typeArguments: [TypeAnnotation__1.default.createTypeParam('T')],
+                    }),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListToMap',
+            description: '选取列表项的某些属性，根据这些属性将列表变为 Map 并返回',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+                new Param__1.default({
+                    name: 'by',
+                    description: `<div>(\${0}) → Boolean | Integer | Long | Decimal | String</div>
+                                  <div>(\${0}) → V</div>`,
+                    defaultExpression: new AnonymousFunction__1.default({
+                        params: [
+                            new Param__1.default({
+                                name: 'item',
+                                typeAnnotation: null,
+                            }),
+                        ],
+                        body: new Identifier__1.default(),
+                    }),
+                }),
+                new Param__1.default({
+                    name: 'byVal',
+                    defaultExpression: new AnonymousFunction__1.default({
+                        params: [
+                            new Param__1.default({
+                                name: 'item',
+                                typeAnnotation: null,
+                            }),
+                        ],
+                        body: new Identifier__1.default(),
+                    }),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListTransform',
+            description: '对列表的每一项调用函数 by，得到新项；最终返回新项构成的列表',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+                new Param__1.default({
+                    name: 'by',
+                    description: '(${0}) → T',
+                    defaultExpression: new AnonymousFunction__1.default({
+                        params: [
+                            new Param__1.default({
+                                name: 'item',
+                                typeAnnotation: null,
+                            }),
+                        ],
+                    }),
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
+                        typeArguments: [TypeAnnotation__1.default.createTypeParam('T')],
+                    }),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListSum',
+            description: '返回数值列表中所有项的和',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListProduct',
+            description: '返回数值列表中所有项的积',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListAverage',
+            description: '返回数值列表中所有项的平均值',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListMax',
+            description: '返回数值列表中所有项的最大值',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'ListMin',
+            description: '返回数值列表中所有项的最小值',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+            ],
+            returns: [
+                new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
+                }),
+            ],
+        }),
         new Function__1.default({
             name: 'MapGet',
             description: '查询出Map中key为指定值的value值列表',
@@ -631,10 +809,32 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'MapFilter',
-            description: '在指定Map中过滤出符合条件参数的Map集合',
+            description: '在指定Map中过滤出符合条件参数的Map列表',
             params: [
                 new Param__1.default({
                     name: 'map',
+                }),
+                new Param__1.default({
+                    name: 'by',
+                    description: '(${0},${1}) → Boolean',
+                    defaultExpression: new AnonymousFunction__1.default({
+                        name: '',
+                        description: '',
+                        params: [
+                            new Param__1.default({
+                                name: 'key',
+                                typeAnnotation: null,
+                            }),
+                            new Param__1.default({
+                                name: 'value',
+                                typeAnnotation: null,
+                            }),
+                        ],
+                    }),
+                }),
+            ],
+            returns: [
+                new Return__1.default({
                     typeAnnotation: TypeAnnotation__1.default.createGeneric('map', {
                         typeArguments: [
                             TypeAnnotation__1.default.createTypeParam('K'),
@@ -642,25 +842,43 @@ exports.default = new Namespace__1.default({
                         ],
                     }),
                 }),
+            ],
+        }),
+        new Function__1.default({
+            name: 'MapTransform',
+            description: '对 Map 的每一项调用函数 by，得到新项，并返回新项构成的 Map。（Map 的每一项从 (K0, V0) 变为 (K, V)。）',
+            params: [
+                new Param__1.default({
+                    name: 'map',
+                }),
                 new Param__1.default({
-                    name: 'byKey',
-                    defaultExpression: new Function__1.default({
-                        name: 'byKey',
-                        description: '',
+                    name: 'by',
+                    description: `<div>(\${0}, \${1}) → Boolean | Integer | Long | Decimal | String</div>
+                                  <div>(\${0}, \${1}) → V</div>`,
+                    defaultExpression: new AnonymousFunction__1.default({
                         params: [
                             new Param__1.default({
                                 name: 'key',
                                 typeAnnotation: null,
                             }),
+                            new Param__1.default({
+                                name: 'value',
+                                typeAnnotation: null,
+                            }),
                         ],
+                        body: new Identifier__1.default({
+                            name: 'key',
+                        }),
                     }),
                 }),
                 new Param__1.default({
-                    name: 'byValue',
-                    defaultExpression: new Function__1.default({
-                        name: 'byValue',
-                        description: '',
+                    name: 'byVal',
+                    defaultExpression: new AnonymousFunction__1.default({
                         params: [
+                            new Param__1.default({
+                                name: 'key',
+                                typeAnnotation: null,
+                            }),
                             new Param__1.default({
                                 name: 'value',
                                 typeAnnotation: null,
@@ -671,8 +889,8 @@ exports.default = new Namespace__1.default({
             ],
             returns: [
                 new Return__1.default({
-                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
-                        typeArguments: [TypeAnnotation__1.default.createTypeParam('K')],
+                    typeAnnotation: TypeAnnotation__1.default.createGeneric('Map', {
+                        typeArguments: [TypeAnnotation__1.default.createTypeParam('K'), TypeAnnotation__1.default.createTypeParam('V')],
                     }),
                 }),
             ],
@@ -928,8 +1146,8 @@ exports.default = new Namespace__1.default({
             ],
         }),
         new Function__1.default({
-            name: 'CreatePageOf',
-            description: '将List<T>集合转换为分页集合PageOf<T>',
+            name: 'CreateListPage',
+            description: '将List<T>列表转换为列表分页',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -937,14 +1155,6 @@ exports.default = new Namespace__1.default({
                         typeArguments: [TypeAnnotation__1.default.createTypeParam('T')],
                     }),
                 }),
-                new Param__1.default({
-                    name: 'page',
-                    typeAnnotation: TypeAnnotation__1.default.createPrimitive('Integer'),
-                }),
-                new Param__1.default({
-                    name: 'size',
-                    typeAnnotation: TypeAnnotation__1.default.createPrimitive('Integer'),
-                }),
                 new Param__1.default({
                     name: 'total',
                     typeAnnotation: TypeAnnotation__1.default.createPrimitive('Integer'),
@@ -960,7 +1170,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'ListSort',
-            description: '为集合按规则排序',
+            description: '为列表按指定规则排序',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -997,7 +1207,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'ListFind',
-            description: '筛选符合条件的第一个项',
+            description: '返回列表中第一个符合条件的项',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -1021,15 +1231,13 @@ exports.default = new Namespace__1.default({
             ],
             returns: [
                 new Return__1.default({
-                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
-                        typeArguments: [TypeAnnotation__1.default.createTypeParam('T')],
-                    }),
+                    typeAnnotation: TypeAnnotation__1.default.createTypeParam('T'),
                 }),
             ],
         }),
         new Function__1.default({
             name: 'ListFindIndex',
-            description: '筛选符合条件的第一个项的索引值',
+            description: '返回列表中第一个符合条件的项的索引值',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -1058,20 +1266,16 @@ exports.default = new Namespace__1.default({
             ],
         }),
         new Function__1.default({
-            name: 'ListFindAll',
-            description: '筛选符合条件的所有项',
+            name: 'ListFilter',
+            description: '返回列表中符合条件的所有项',
             params: [
                 new Param__1.default({
                     name: 'list',
-                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
-                        typeArguments: [TypeAnnotation__1.default.createTypeParam('T')],
-                    }),
                 }),
                 new Param__1.default({
                     name: 'by',
-                    defaultExpression: new Function__1.default({
-                        name: '',
-                        description: '',
+                    description: '(${0}) → Boolean',
+                    defaultExpression: new AnonymousFunction__1.default({
                         params: [
                             new Param__1.default({
                                 name: 'item',
@@ -1083,13 +1287,16 @@ exports.default = new Namespace__1.default({
             ],
             returns: [
                 new Return__1.default({
-                    typeAnnotation: TypeAnnotation__1.default.createPrimitive('Integer'),
+                    name: 'list',
+                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
+                        typeArguments: [TypeAnnotation__1.default.createTypeParam('T')],
+                    }),
                 }),
             ],
         }),
         new Function__1.default({
             name: 'ListReverse',
-            description: '为集合反向排序',
+            description: '将列表的所有项反向排列（例如第一项变为最后一项）',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -1102,7 +1309,7 @@ exports.default = new Namespace__1.default({
         }),
         new Function__1.default({
             name: 'ListDistinct',
-            description: '为集合去除重复项',
+            description: '为列表去除重复项',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -1113,9 +1320,70 @@ exports.default = new Namespace__1.default({
             ],
             returns: [],
         }),
+        new Function__1.default({
+            name: 'ListDistinctBy',
+            description: '按某个属性为列表去除重复项',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+                new Param__1.default({
+                    name: 'by',
+                    description: '(${0}) → T',
+                    defaultExpression: new AnonymousFunction__1.default({
+                        params: [
+                            new Param__1.default({
+                                name: 'item',
+                                typeAnnotation: null,
+                            }),
+                        ],
+                        body: new Identifier__1.default(),
+                    }),
+                }),
+            ],
+            returns: [new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createGeneric('List', {
+                        typeArguments: [
+                            TypeAnnotation__1.default.createTypeParam('T'),
+                        ],
+                    }),
+                })],
+        }),
+        new Function__1.default({
+            name: 'ListGroupBy',
+            description: '按某个属性为列表分组。以选中的属性为 key 建立 Map 并返回。',
+            params: [
+                new Param__1.default({
+                    name: 'list',
+                }),
+                new Param__1.default({
+                    name: 'by',
+                    description: '(${0}) → Boolean | Integer | Long | Decimal | String',
+                    defaultExpression: new AnonymousFunction__1.default({
+                        params: [
+                            new Param__1.default({
+                                name: 'item',
+                                typeAnnotation: null,
+                            }),
+                        ],
+                        body: new Identifier__1.default(),
+                    }),
+                }),
+            ],
+            returns: [new Return__1.default({
+                    typeAnnotation: TypeAnnotation__1.default.createGeneric('map', {
+                        typeArguments: [
+                            TypeAnnotation__1.default.createTypeParam('K'),
+                            TypeAnnotation__1.default.createGeneric('List', {
+                                typeArguments: [TypeAnnotation__1.default.createTypeParam('A')],
+                            }),
+                        ],
+                    }),
+                })],
+        }),
         new Function__1.default({
             name: 'ListSlice',
-            description: '将集合按照规则切片，返回切片后的子集合',
+            description: '将列表按照规则切片，返回切片后的子列表',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -1141,8 +1409,8 @@ exports.default = new Namespace__1.default({
             ],
         }),
         new Function__1.default({
-            name: 'ListSliceToPageOf',
-            description: '将集合按照规则切片，返回切片后的PageOf集合',
+            name: 'SliceToListPage',
+            description: '将列表按照规则切片，返回切片后的列表分页',
             params: [
                 new Param__1.default({
                     name: 'list',
@@ -1182,37 +1450,6 @@ exports.default = new Namespace__1.default({
                 }),
             ],
         }),
-        // new Function({
-        //     name: 'CreatePageOf',
-        //     description: '将List<T>集合转换为分页集合PageOf<T>',
-        //     params: [
-        //         new Param({
-        //             name: 'list',
-        //             typeAnnotation: TypeAnnotation.createGeneric('List', {
-        //                 typeArguments: [TypeAnnotation.createTypeParam('T')],
-        //             }),
-        //         }),
-        //         new Param({
-        //             name: 'page',
-        //             typeAnnotation: TypeAnnotation.createPrimitive('Integer'),
-        //         }),
-        //         new Param({
-        //             name: 'size',
-        //             typeAnnotation: TypeAnnotation.createPrimitive('Integer'),
-        //         }),
-        //         new Param({
-        //             name: 'total',
-        //             typeAnnotation: TypeAnnotation.createPrimitive('Integer'),
-        //         }),
-        //     ],
-        //     returns: [
-        //         new Return({
-        //             typeAnnotation: TypeAnnotation.createPrimitive('PageOf', {
-        //                 typeArguments: [TypeAnnotation.createTypeParam('T')],
-        //             }),
-        //         }),
-        //     ],
-        // }),
     ],
 });
 //# sourceMappingURL=nasl.util.js.map