@nocobase/plugin-flow-engine 2.1.0-alpha.20 → 2.1.0-alpha.22

package/dist/swagger/flow-surfaces.examples.d.ts

@@ -1,11 +1,3 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
 export declare const flowSurfaceExamples: {
     catalog: {
         target: {
@@ -71,15 +63,38 @@ export declare const flowSurfaceExamples: {
                     }[])[];
                 };
                 actions: string[];
+                defaultFilter?: undefined;
             } | {
                 key: string;
                 type: string;
                 collection: string;
+                defaultFilter: {
+                    logic: string;
+                    items: {
+                        path: string;
+                        operator: string;
+                        value: string;
+                    }[];
+                };
                 fields: string[];
-                actions: {
+                actions: ({
                     key: string;
                     type: string;
-                }[];
+                    settings: {
+                        defaultFilter: {
+                            logic: string;
+                            items: {
+                                path: string;
+                                operator: string;
+                                value: string;
+                            }[];
+                        };
+                    };
+                } | {
+                    key: string;
+                    type: string;
+                    settings?: undefined;
+                })[];
                 fieldsLayout?: undefined;
             })[];
             layout: {
@@ -335,6 +350,7 @@ export declare const flowSurfaceExamples: {
                 }[][];
             };
             actions: string[];
+            defaultFilter?: undefined;
             recordActions?: undefined;
         } | {
             key: string;
@@ -343,10 +359,30 @@ export declare const flowSurfaceExamples: {
                 dataSourceKey: string;
                 collectionName: string;
             };
+            defaultFilter: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                }[];
+            };
             fields: (string | {
                 fieldPath: string;
             })[];
-            actions: string[];
+            actions: (string | {
+                type: string;
+                settings: {
+                    defaultFilter: {
+                        logic: string;
+                        items: {
+                            path: string;
+                            operator: string;
+                            value: string;
+                        }[];
+                    };
+                };
+            })[];
             recordActions: (string | {
                 type: string;
                 popup: {
@@ -424,6 +460,14 @@ export declare const flowSurfaceExamples: {
                 dataSourceKey: string;
                 collectionName: string;
             };
+            defaultFilter: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                }[];
+            };
             fields: (string | {
                 fieldPath: string;
             })[];
@@ -460,6 +504,14 @@ export declare const flowSurfaceExamples: {
                 dataSourceKey: string;
                 collectionName: string;
             };
+            defaultFilter: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                }[];
+            };
             fields: (string | {
                 fieldPath: string;
             })[];
@@ -819,6 +871,37 @@ export declare const flowSurfaceExamples: {
             binding: string;
         };
     };
+    addTableBlockWithDefaultFilters: {
+        target: {
+            uid: string;
+        };
+        type: string;
+        defaultFilter: {
+            logic: string;
+            items: {
+                path: string;
+                operator: string;
+                value: string;
+            }[];
+        };
+        resourceInit: {
+            dataSourceKey: string;
+            collectionName: string;
+        };
+        defaultActionSettings: {
+            filter: {
+                filterableFieldNames: string[];
+                defaultFilter: {
+                    logic: string;
+                    items: {
+                        path: string;
+                        operator: string;
+                        value: string;
+                    }[];
+                };
+            };
+        };
+    };
     addPopupAssociatedBlock: {
         target: {
             uid: string;
@@ -1120,6 +1203,14 @@ export declare const flowSurfaceExamples: {
         blocks: ({
             key: string;
             type: string;
+            defaultFilter: {
+                logic: string;
+                items: {
+                    path: string;
+                    operator: string;
+                    value: string;
+                }[];
+            };
             resourceInit: {
                 dataSourceKey: string;
                 collectionName: string;
@@ -1129,6 +1220,19 @@ export declare const flowSurfaceExamples: {
                 pageSize: number;
                 content?: undefined;
             };
+            defaultActionSettings: {
+                filter: {
+                    filterableFieldNames: string[];
+                    defaultFilter: {
+                        logic: string;
+                        items: {
+                            path: string;
+                            operator: string;
+                            value: string;
+                        }[];
+                    };
+                };
+            };
         } | {
             key: string;
             type: string;
@@ -1137,7 +1241,9 @@ export declare const flowSurfaceExamples: {
                 title?: undefined;
                 pageSize?: undefined;
             };
+            defaultFilter?: undefined;
             resourceInit?: undefined;
+            defaultActionSettings?: undefined;
         })[];
     };
     addFields: {

package/dist/swagger/flow-surfaces.examples.js

@@ -29,6 +29,26 @@ __export(flow_surfaces_examples_exports, {
   flowSurfaceExamples: () => flowSurfaceExamples
 });
 module.exports = __toCommonJS(flow_surfaces_examples_exports);
+const makePublicBlockDefaultFilter = (items = [
+  {
+    path: "username",
+    operator: "$includes",
+    value: ""
+  },
+  {
+    path: "email",
+    operator: "$includes",
+    value: ""
+  },
+  {
+    path: "status",
+    operator: "$eq",
+    value: ""
+  }
+]) => ({
+  logic: "$and",
+  items
+});
 const flowSurfaceExamples = {
   catalog: {
     target: {
@@ -113,8 +133,33 @@ const flowSurfaceExamples = {
             key: "employeesTable",
             type: "table",
             collection: "employees",
+            defaultFilter: makePublicBlockDefaultFilter([
+              {
+                path: "nickname",
+                operator: "$includes",
+                value: ""
+              },
+              {
+                path: "status",
+                operator: "$eq",
+                value: ""
+              }
+            ]),
             fields: ["nickname", "status", "total"],
             actions: [
+              {
+                key: "filterAction",
+                type: "filter",
+                settings: {
+                  defaultFilter: makePublicBlockDefaultFilter([
+                    {
+                      path: "status",
+                      operator: "$eq",
+                      value: "active"
+                    }
+                  ])
+                }
+              },
               {
                 key: "refreshAction",
                 type: "refresh"
@@ -473,8 +518,26 @@ const flowSurfaceExamples = {
           dataSourceKey: "main",
           collectionName: "users"
         },
+        defaultFilter: makePublicBlockDefaultFilter(),
         fields: ["username", "nickname", { fieldPath: "roles.title" }],
-        actions: ["filter", "addNew", "refresh", "bulkDelete", "link"],
+        actions: [
+          {
+            type: "filter",
+            settings: {
+              defaultFilter: makePublicBlockDefaultFilter([
+                {
+                  path: "status",
+                  operator: "$eq",
+                  value: "active"
+                }
+              ])
+            }
+          },
+          "addNew",
+          "refresh",
+          "bulkDelete",
+          "link"
+        ],
         recordActions: [
           "view",
           "edit",
@@ -561,6 +624,13 @@ const flowSurfaceExamples = {
           dataSourceKey: "main",
           collectionName: "employees"
         },
+        defaultFilter: makePublicBlockDefaultFilter([
+          {
+            path: "nickname",
+            operator: "$includes",
+            value: ""
+          }
+        ]),
         fields: [
           "nickname",
           {
@@ -609,6 +679,13 @@ const flowSurfaceExamples = {
           dataSourceKey: "main",
           collectionName: "employees"
         },
+        defaultFilter: makePublicBlockDefaultFilter([
+          {
+            path: "nickname",
+            operator: "$includes",
+            value: ""
+          }
+        ]),
         fields: [
           "nickname",
           {
@@ -988,6 +1065,48 @@ const flowSurfaceExamples = {
       binding: "currentRecord"
     }
   },
+  addTableBlockWithDefaultFilters: {
+    target: {
+      uid: "page-grid-uid"
+    },
+    type: "table",
+    defaultFilter: makePublicBlockDefaultFilter([
+      {
+        path: "username",
+        operator: "$includes",
+        value: "staff"
+      }
+    ]),
+    resourceInit: {
+      dataSourceKey: "main",
+      collectionName: "users"
+    },
+    defaultActionSettings: {
+      filter: {
+        filterableFieldNames: ["username", "email", "status"],
+        defaultFilter: {
+          logic: "$and",
+          items: [
+            {
+              path: "username",
+              operator: "$includes",
+              value: ""
+            },
+            {
+              path: "email",
+              operator: "$includes",
+              value: ""
+            },
+            {
+              path: "status",
+              operator: "$eq",
+              value: ""
+            }
+          ]
+        }
+      }
+    }
+  },
   addPopupAssociatedBlock: {
     target: {
       uid: "association-popup-action-uid"
@@ -1300,6 +1419,13 @@ const flowSurfaceExamples = {
       {
         key: "usersTable",
         type: "table",
+        defaultFilter: makePublicBlockDefaultFilter([
+          {
+            path: "username",
+            operator: "$includes",
+            value: "staff"
+          }
+        ]),
         resourceInit: {
           dataSourceKey: "main",
           collectionName: "users"
@@ -1307,6 +1433,31 @@ const flowSurfaceExamples = {
         settings: {
           title: "Users table",
           pageSize: 50
+        },
+        defaultActionSettings: {
+          filter: {
+            filterableFieldNames: ["username", "email", "status"],
+            defaultFilter: {
+              logic: "$and",
+              items: [
+                {
+                  path: "username",
+                  operator: "$includes",
+                  value: ""
+                },
+                {
+                  path: "email",
+                  operator: "$includes",
+                  value: ""
+                },
+                {
+                  path: "status",
+                  operator: "$eq",
+                  value: ""
+                }
+              ]
+            }
+          }
         }
       },
       {