adminforth 2.4.0-next.31 → 2.4.0-next.310

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.
Files changed (176) hide show
  1. package/commands/callTsProxy.js +14 -4
  2. package/commands/createApp/templates/api.ts.hbs +10 -0
  3. package/commands/createApp/templates/custom/tsconfig.json.hbs +2 -3
  4. package/commands/createApp/templates/index.ts.hbs +12 -1
  5. package/commands/createApp/templates/package.json.hbs +1 -1
  6. package/commands/createApp/templates/prisma.config.ts.hbs +8 -0
  7. package/commands/createApp/templates/schema.prisma.hbs +0 -1
  8. package/commands/createApp/utils.js +10 -0
  9. package/commands/createCustomComponent/configLoader.js +17 -4
  10. package/commands/createCustomComponent/main.js +13 -7
  11. package/commands/createCustomComponent/templates/customCrud/beforeActionButtons.vue.hbs +38 -0
  12. package/commands/createCustomComponent/templates/customCrud/saveButton.vue.hbs +28 -0
  13. package/commands/createPlugin/templates/custom/tsconfig.json.hbs +2 -5
  14. package/commands/createPlugin/templates/package.json.hbs +1 -1
  15. package/commands/generateModels.js +30 -22
  16. package/dist/auth.d.ts +9 -1
  17. package/dist/auth.d.ts.map +1 -1
  18. package/dist/auth.js +21 -2
  19. package/dist/auth.js.map +1 -1
  20. package/dist/dataConnectors/baseConnector.d.ts +1 -1
  21. package/dist/dataConnectors/baseConnector.d.ts.map +1 -1
  22. package/dist/dataConnectors/baseConnector.js +69 -17
  23. package/dist/dataConnectors/baseConnector.js.map +1 -1
  24. package/dist/dataConnectors/clickhouse.d.ts.map +1 -1
  25. package/dist/dataConnectors/clickhouse.js +15 -0
  26. package/dist/dataConnectors/clickhouse.js.map +1 -1
  27. package/dist/dataConnectors/mongo.d.ts.map +1 -1
  28. package/dist/dataConnectors/mongo.js +50 -15
  29. package/dist/dataConnectors/mongo.js.map +1 -1
  30. package/dist/dataConnectors/mysql.d.ts.map +1 -1
  31. package/dist/dataConnectors/mysql.js +11 -0
  32. package/dist/dataConnectors/mysql.js.map +1 -1
  33. package/dist/dataConnectors/postgres.d.ts.map +1 -1
  34. package/dist/dataConnectors/postgres.js +43 -14
  35. package/dist/dataConnectors/postgres.js.map +1 -1
  36. package/dist/dataConnectors/sqlite.d.ts.map +1 -1
  37. package/dist/dataConnectors/sqlite.js +11 -0
  38. package/dist/dataConnectors/sqlite.js.map +1 -1
  39. package/dist/index.d.ts +12 -2
  40. package/dist/index.d.ts.map +1 -1
  41. package/dist/index.js +45 -22
  42. package/dist/index.js.map +1 -1
  43. package/dist/modules/codeInjector.d.ts +2 -0
  44. package/dist/modules/codeInjector.d.ts.map +1 -1
  45. package/dist/modules/codeInjector.js +62 -6
  46. package/dist/modules/codeInjector.js.map +1 -1
  47. package/dist/modules/configValidator.d.ts +6 -0
  48. package/dist/modules/configValidator.d.ts.map +1 -1
  49. package/dist/modules/configValidator.js +202 -25
  50. package/dist/modules/configValidator.js.map +1 -1
  51. package/dist/modules/restApi.d.ts +1 -1
  52. package/dist/modules/restApi.d.ts.map +1 -1
  53. package/dist/modules/restApi.js +172 -31
  54. package/dist/modules/restApi.js.map +1 -1
  55. package/dist/modules/styles.d.ts +499 -13
  56. package/dist/modules/styles.d.ts.map +1 -1
  57. package/dist/modules/styles.js +555 -31
  58. package/dist/modules/styles.js.map +1 -1
  59. package/dist/modules/utils.d.ts +7 -15
  60. package/dist/modules/utils.d.ts.map +1 -1
  61. package/dist/modules/utils.js +45 -68
  62. package/dist/modules/utils.js.map +1 -1
  63. package/dist/servers/express.d.ts +5 -0
  64. package/dist/servers/express.d.ts.map +1 -1
  65. package/dist/servers/express.js +40 -1
  66. package/dist/servers/express.js.map +1 -1
  67. package/dist/spa/index.html +1 -1
  68. package/dist/spa/package-lock.json +1208 -708
  69. package/dist/spa/package.json +34 -34
  70. package/dist/spa/src/App.vue +59 -174
  71. package/dist/spa/src/adminforth.ts +42 -18
  72. package/dist/spa/src/afcl/AreaChart.vue +0 -1
  73. package/dist/spa/src/afcl/BarChart.vue +2 -2
  74. package/dist/spa/src/afcl/Button.vue +6 -6
  75. package/dist/spa/src/afcl/ButtonGroup.vue +91 -0
  76. package/dist/spa/src/afcl/Card.vue +25 -0
  77. package/dist/spa/src/afcl/Checkbox.vue +21 -13
  78. package/dist/spa/src/afcl/CountryFlag.vue +4 -1
  79. package/dist/spa/src/{components/CustomDatePicker.vue → afcl/DatePicker.vue} +95 -9
  80. package/dist/spa/src/afcl/Dialog.vue +47 -27
  81. package/dist/spa/src/afcl/Dropzone.vue +127 -48
  82. package/dist/spa/src/afcl/Input.vue +14 -6
  83. package/dist/spa/src/afcl/JsonViewer.vue +25 -0
  84. package/dist/spa/src/afcl/LinkButton.vue +3 -3
  85. package/dist/spa/src/afcl/PieChart.vue +5 -5
  86. package/dist/spa/src/afcl/ProgressBar.vue +7 -7
  87. package/dist/spa/src/afcl/Select.vue +82 -34
  88. package/dist/spa/src/afcl/Skeleton.vue +6 -6
  89. package/dist/spa/src/afcl/Table.vue +315 -73
  90. package/dist/spa/src/afcl/Textarea.vue +31 -0
  91. package/dist/spa/src/afcl/Toggle.vue +32 -0
  92. package/dist/spa/src/afcl/Tooltip.vue +28 -18
  93. package/dist/spa/src/afcl/VerticalTabs.vue +16 -7
  94. package/dist/spa/src/afcl/index.ts +6 -3
  95. package/dist/spa/src/components/AcceptModal.vue +48 -14
  96. package/dist/spa/src/components/Breadcrumbs.vue +5 -5
  97. package/dist/spa/src/components/CallActionWrapper.vue +15 -0
  98. package/dist/spa/src/components/ColumnValueInput.vue +38 -18
  99. package/dist/spa/src/components/ColumnValueInputWrapper.vue +4 -3
  100. package/dist/spa/src/components/CustomDateRangePicker.vue +9 -8
  101. package/dist/spa/src/components/CustomRangePicker.vue +37 -21
  102. package/dist/spa/src/components/ErrorMessage.vue +21 -0
  103. package/dist/spa/src/components/Filters.vue +195 -132
  104. package/dist/spa/src/components/GroupsTable.vue +9 -8
  105. package/dist/spa/src/components/MenuLink.vue +90 -23
  106. package/dist/spa/src/components/ResourceForm.vue +94 -51
  107. package/dist/spa/src/components/ResourceListTable.vue +115 -85
  108. package/dist/spa/src/components/ResourceListTableVirtual.vue +114 -80
  109. package/dist/spa/src/components/ShowTable.vue +21 -15
  110. package/dist/spa/src/components/Sidebar.vue +470 -0
  111. package/dist/spa/src/components/SingleSkeletLoader.vue +6 -6
  112. package/dist/spa/src/components/SkeleteLoader.vue +3 -3
  113. package/dist/spa/src/components/ThreeDotsMenu.vue +84 -15
  114. package/dist/spa/src/components/Toast.vue +40 -29
  115. package/dist/spa/src/components/UserMenuSettingsButton.vue +69 -0
  116. package/dist/spa/src/components/ValueRenderer.vue +44 -17
  117. package/dist/spa/src/controls/BoolToggle.vue +34 -0
  118. package/dist/spa/src/i18n.ts +5 -3
  119. package/dist/spa/src/main.ts +1 -1
  120. package/dist/spa/src/renderers/CompactField.vue +1 -1
  121. package/dist/spa/src/renderers/CompactUUID.vue +1 -1
  122. package/dist/spa/src/router/index.ts +8 -0
  123. package/dist/spa/src/shims-vue.d.ts +5 -0
  124. package/dist/spa/src/spa_types/core.ts +13 -1
  125. package/dist/spa/src/stores/core.ts +13 -1
  126. package/dist/spa/src/stores/filters.ts +33 -2
  127. package/dist/spa/src/stores/modal.ts +6 -1
  128. package/dist/spa/src/stores/toast.ts +22 -3
  129. package/dist/spa/src/types/Back.ts +163 -23
  130. package/dist/spa/src/types/Common.ts +91 -32
  131. package/dist/spa/src/types/FrontendAPI.ts +31 -5
  132. package/dist/spa/src/types/adapters/CaptchaAdapter.ts +34 -0
  133. package/dist/spa/src/types/adapters/EmailAdapter.ts +2 -2
  134. package/dist/spa/src/types/adapters/ImageVisionAdapter.ts +30 -0
  135. package/dist/spa/src/types/adapters/KeyValueAdapter.ts +16 -0
  136. package/dist/spa/src/types/adapters/index.ts +8 -0
  137. package/dist/spa/src/utils.ts +291 -11
  138. package/dist/spa/src/views/CreateView.vue +63 -21
  139. package/dist/spa/src/views/EditView.vue +55 -22
  140. package/dist/spa/src/views/ListView.vue +144 -87
  141. package/dist/spa/src/views/LoginView.vue +26 -35
  142. package/dist/spa/src/views/ResourceParent.vue +2 -2
  143. package/dist/spa/src/views/SettingsView.vue +121 -0
  144. package/dist/spa/src/views/ShowView.vue +83 -53
  145. package/dist/spa/src/websocket.ts +6 -1
  146. package/dist/spa/tsconfig.app.json +1 -1
  147. package/dist/spa/vite.config.ts +45 -2
  148. package/dist/types/Back.d.ts +146 -14
  149. package/dist/types/Back.d.ts.map +1 -1
  150. package/dist/types/Back.js +15 -0
  151. package/dist/types/Back.js.map +1 -1
  152. package/dist/types/Common.d.ts +106 -29
  153. package/dist/types/Common.d.ts.map +1 -1
  154. package/dist/types/Common.js.map +1 -1
  155. package/dist/types/FrontendAPI.d.ts +31 -3
  156. package/dist/types/FrontendAPI.d.ts.map +1 -1
  157. package/dist/types/FrontendAPI.js.map +1 -1
  158. package/dist/types/adapters/CaptchaAdapter.d.ts +30 -0
  159. package/dist/types/adapters/CaptchaAdapter.d.ts.map +1 -0
  160. package/dist/types/adapters/CaptchaAdapter.js +5 -0
  161. package/dist/types/adapters/CaptchaAdapter.js.map +1 -0
  162. package/dist/types/adapters/EmailAdapter.d.ts +1 -1
  163. package/dist/types/adapters/ImageVisionAdapter.d.ts +25 -0
  164. package/dist/types/adapters/ImageVisionAdapter.d.ts.map +1 -0
  165. package/dist/types/adapters/ImageVisionAdapter.js +2 -0
  166. package/dist/types/adapters/ImageVisionAdapter.js.map +1 -0
  167. package/dist/types/adapters/KeyValueAdapter.d.ts +10 -0
  168. package/dist/types/adapters/KeyValueAdapter.d.ts.map +1 -0
  169. package/dist/types/adapters/KeyValueAdapter.js +2 -0
  170. package/dist/types/adapters/KeyValueAdapter.js.map +1 -0
  171. package/dist/types/adapters/index.d.ts +9 -0
  172. package/dist/types/adapters/index.d.ts.map +1 -0
  173. package/dist/types/adapters/index.js +2 -0
  174. package/dist/types/adapters/index.js.map +1 -0
  175. package/package.json +4 -2
  176. package/dist/spa/src/types/adapters/index.js +0 -5
@@ -1,4 +1,4 @@
1
- import type { Express } from 'express';
1
+ import type { Express, Request } from 'express';
2
2
  import type { Writable } from 'stream';
3
3
 
4
4
  import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections, AllowedActionsEnum,
@@ -8,12 +8,12 @@ import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections,
8
8
  type AdminForthBulkActionCommon,
9
9
  type AdminForthForeignResourceCommon,
10
10
  type AdminForthResourceColumnCommon,
11
- AdminForthResourceInputCommon,
12
- AdminForthComponentDeclarationFull,
13
- AdminForthConfigMenuItem,
14
- AnnouncementBadgeResponse,
11
+ type AdminForthResourceInputCommon,
12
+ type AdminForthComponentDeclarationFull,
13
+ type AdminForthConfigMenuItem,
14
+ type AnnouncementBadgeResponse,
15
15
  AdminForthResourcePages,
16
- AdminForthResourceColumnInputCommon,
16
+ type AdminForthResourceColumnInputCommon,
17
17
  } from './Common.js';
18
18
 
19
19
  export interface ICodeInjector {
@@ -22,12 +22,13 @@ export interface ICodeInjector {
22
22
  devServerPort: number;
23
23
 
24
24
  getServeDir(): string;
25
-
25
+ registerCustomComponent(filePath: string): void;
26
26
  spaTmpPath(): string;
27
27
  }
28
28
 
29
29
  export interface IConfigValidator {
30
30
  validateConfig(): void;
31
+ validateAfterPluginsActivation(): void;
31
32
  postProcessAfterDiscover(resource: AdminForthResource): void;
32
33
  }
33
34
 
@@ -92,19 +93,36 @@ export interface IExpressHttpServer extends IHttpServer {
92
93
  * Adds adminUser to request object if user is authorized. Drops request with 401 status if user is not authorized.
93
94
  * @param callable : Function which will be called if user is authorized.
94
95
  *
95
- * Example:
96
96
  *
97
+ * @example
97
98
  * ```ts
98
- * expressApp.get('/myApi', authorize((req, res) => \{
99
+ * expressApp.get('/myApi', authorize((req, res) => {
99
100
  * console.log('User is authorized', req.adminUser);
100
- * res.json(\{ message: 'Hello World' \});
101
- * \}));
102
- * ``
101
+ * res.json({ message: 'Hello World' });
102
+ * }));
103
+ * ```
103
104
  *
104
- */
105
+ */
105
106
  authorize(callable: Function): void;
106
107
  }
107
108
 
109
+ export interface ITranslateFunction {
110
+ (
111
+ msg: string,
112
+ category: string,
113
+ params: any,
114
+ pluralizationNumber?: number
115
+ ): Promise<string>;
116
+ }
117
+
118
+ // Omit <Request, 'param'> is used to remove 'param' method from Request type for correct docs generation
119
+ export interface IAdminUserExpressRequest extends Omit<Request, 'protocol' | 'param' | 'unshift'> {
120
+ adminUser: AdminUser;
121
+ }
122
+
123
+ export interface ITranslateExpressRequest extends Omit<Request, 'protocol' | 'param' | 'unshift'> {
124
+ tr: ITranslateFunction;
125
+ }
108
126
 
109
127
  export interface IAdminForthSingleFilter {
110
128
  field?: string;
@@ -113,7 +131,9 @@ export interface IAdminForthSingleFilter {
113
131
  | AdminForthFilterOperators.LTE | AdminForthFilterOperators.LIKE | AdminForthFilterOperators.ILIKE
114
132
  | AdminForthFilterOperators.IN | AdminForthFilterOperators.NIN;
115
133
  value?: any;
134
+ rightField?: string;
116
135
  insecureRawSQL?: string;
136
+ insecureRawNoSQL?: any;
117
137
  }
118
138
  export interface IAdminForthAndOrFilter {
119
139
  operator: AdminForthFilterOperators.AND | AdminForthFilterOperators.OR;
@@ -287,6 +307,10 @@ export interface IAdminForthAuth {
287
307
 
288
308
  removeCustomCookie({response, name}: {response: any, name: string}): void;
289
309
 
310
+ setCustomCookie({response, payload}: {response: any, payload: {name: string, value: string, expiry: number, expirySeconds: number, httpOnly: boolean}}): void;
311
+
312
+ getCustomCookie({cookies, name}: {cookies: {key: string, value: string}[], name: string}): string | null;
313
+
290
314
  setAuthCookie({expireInDays, response, username, pk,}: {expireInDays?: number, response: any, username: string, pk: string}): void;
291
315
 
292
316
  removeAuthCookie(response: any): void;
@@ -336,10 +360,11 @@ export interface IAdminForth {
336
360
 
337
361
  createResourceRecord(
338
362
  params: { resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra }
339
- ): Promise<{ error?: string, createdRecord?: any }>;
363
+ ): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }>;
340
364
 
341
365
  updateResourceRecord(
342
- params: { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra }
366
+ params: { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra, updates?: never }
367
+ | { resource: AdminForthResource, recordId: any, record?: never, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra, updates: any }
343
368
  ): Promise<{ error?: string }>;
344
369
 
345
370
  deleteResourceRecord(
@@ -474,7 +499,7 @@ export type BeforeDataSourceRequestFunction = (params: {
474
499
  requestUrl: string,
475
500
  },
476
501
  adminforth: IAdminForth,
477
- }) => Promise<{ok: boolean, error?: string}>;
502
+ }) => Promise<{ok: boolean, error?: string, newRecordId?: string}>;
478
503
 
479
504
  /**
480
505
  * Modify response to change how data is returned after fetching from database.
@@ -525,7 +550,7 @@ export type BeforeEditSaveFunction = (params: {
525
550
  oldRecord: any,
526
551
  adminforth: IAdminForth,
527
552
  extra?: HttpExtra,
528
- }) => Promise<{ok: boolean, error?: string}>;
553
+ }) => Promise<{ok: boolean, error?: string | null}>;
529
554
 
530
555
 
531
556
 
@@ -535,7 +560,7 @@ export type BeforeCreateSaveFunction = (params: {
535
560
  record: any,
536
561
  adminforth: IAdminForth,
537
562
  extra?: HttpExtra,
538
- }) => Promise<{ok: boolean, error?: string}>;
563
+ }) => Promise<{ok: boolean, error?: string | null, newRecordId?: string}>;
539
564
 
540
565
  export type AfterCreateSaveFunction = (params: {
541
566
  resource: AdminForthResource,
@@ -543,6 +568,7 @@ export type AfterCreateSaveFunction = (params: {
543
568
  adminUser: AdminUser,
544
569
  record: any,
545
570
  adminforth: IAdminForth,
571
+ recordWithVirtualColumns?: any,
546
572
  extra?: HttpExtra,
547
573
  }) => Promise<{ok: boolean, error?: string}>;
548
574
 
@@ -579,6 +605,7 @@ export type BeforeLoginConfirmationFunction = (params?: {
579
605
  response: IAdminForthHttpResponse,
580
606
  adminforth: IAdminForth,
581
607
  extra?: HttpExtra,
608
+ rememberMeDays?: number,
582
609
  }) => Promise<{
583
610
  error?: string,
584
611
  body: {
@@ -587,6 +614,19 @@ export type BeforeLoginConfirmationFunction = (params?: {
587
614
  }
588
615
  }>;
589
616
 
617
+ /**
618
+ * Allow to make extra authorization
619
+ */
620
+ export type AdminUserAuthorizeFunction = ((params?: {
621
+ adminUser: AdminUser,
622
+ response: IAdminForthHttpResponse,
623
+ adminforth: IAdminForth,
624
+ extra?: HttpExtra,
625
+ }) => Promise<{
626
+ error?: string,
627
+ allowed?: boolean,
628
+ }>);
629
+
590
630
 
591
631
  /**
592
632
  * Data source describes database connection which will be used to fetch data for resources.
@@ -619,12 +659,23 @@ interface AdminForthInputConfigCustomization {
619
659
  */
620
660
  brandName?: string,
621
661
 
662
+ /**
663
+ * Whether to use single theme for the app
664
+ */
665
+ singleTheme?: 'light' | 'dark',
666
+
622
667
  /**
623
668
  * Whether to show brand name in sidebar
624
669
  * default is true
625
670
  */
626
671
  showBrandNameInSidebar?: boolean,
627
672
 
673
+ /**
674
+ * Whether to show brand logo in sidebar
675
+ * default is true
676
+ */
677
+ showBrandLogoInSidebar?: boolean,
678
+
628
679
  /**
629
680
  * Path to your app logo
630
681
  *
@@ -638,6 +689,19 @@ interface AdminForthInputConfigCustomization {
638
689
  */
639
690
  brandLogo?: string,
640
691
 
692
+
693
+ /**
694
+ * Path to your app logo for icon only sidebar
695
+ *
696
+ * Example:
697
+ * Place file `logo.svg` to `./custom` folder and set this option:
698
+ *
699
+ */
700
+ iconOnlySidebar?: {
701
+ logo?: string,
702
+ enabled?: boolean,
703
+ },
704
+
641
705
  /**
642
706
  * Path to your app favicon
643
707
  *
@@ -747,6 +811,7 @@ interface AdminForthInputConfigCustomization {
747
811
  */
748
812
  loginPageInjections?: {
749
813
  underInputs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
814
+ underLoginButton?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
750
815
  panelHeader?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
751
816
  }
752
817
 
@@ -757,8 +822,20 @@ interface AdminForthInputConfigCustomization {
757
822
  userMenu?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
758
823
  header?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
759
824
  sidebar?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
825
+ sidebarTop?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
760
826
  everyPageBottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
761
827
  }
828
+
829
+ /**
830
+ * Allows adding custom elements (e.g., &lt;link&gt;, &lt;script&gt;, &lt;meta&gt;) to the &lt;head&gt; of the HTML document.
831
+ * Each item must include a tag name and a set of attributes.
832
+ */
833
+ customHeadItems?: {
834
+ tagName: string;
835
+ attributes: Record<string, string | boolean>;
836
+ innerCode?: string;
837
+ }[];
838
+
762
839
  }
763
840
 
764
841
  export interface AdminForthActionInput {
@@ -787,6 +864,7 @@ export interface AdminForthActionInput {
787
864
  }>;
788
865
  icon?: string;
789
866
  id?: string;
867
+ customComponent?: AdminForthComponentDeclaration;
790
868
  }
791
869
 
792
870
  export interface AdminForthResourceInput extends Omit<NonNullable<AdminForthResourceInputCommon>, 'columns' | 'hooks' | 'options'> {
@@ -935,12 +1013,24 @@ export interface AdminForthInputConfig {
935
1013
  */
936
1014
  loginBackgroundPosition?: 'over' | '1/2' | '1/3' | '2/3' | '3/4' | '2/5' | '3/5',
937
1015
 
1016
+ /**
1017
+ * If true, background blend mode will be removed from login background image when position is 'over'
1018
+ *
1019
+ * Default: false
1020
+ */
1021
+ removeBackgroundBlendMode?: boolean,
1022
+
938
1023
  /**
939
1024
  * Function or functions which will be called before user try to login.
940
1025
  * Each function will resive User object as an argument
941
1026
  */
942
1027
  beforeLoginConfirmation?: BeforeLoginConfirmationFunction | Array<BeforeLoginConfirmationFunction>,
943
1028
 
1029
+ /**
1030
+ * Array of functions which will be called before any request to AdminForth API.
1031
+ */
1032
+ adminUserAuthorize?: AdminUserAuthorizeFunction | Array<AdminUserAuthorizeFunction>,
1033
+
944
1034
  /**
945
1035
  * Optionally if your users table has a field(column) with full name, you can set it here.
946
1036
  * This field will be used to display user name in the top right corner of the admin panel.
@@ -956,7 +1046,7 @@ export interface AdminForthInputConfig {
956
1046
  /**
957
1047
  * Any prompt to show users on login. Supports HTML.
958
1048
  */
959
- loginPromptHTML?: string,
1049
+ loginPromptHTML?: string | (() => string | void | undefined | Promise<string | void | undefined>) | undefined
960
1050
 
961
1051
  /**
962
1052
  * Remember me days for "Remember Me" checkbox on login page.
@@ -988,6 +1078,16 @@ export interface AdminForthInputConfig {
988
1078
  * If you are using Cloudflare, set this to 'CF-Connecting-IP'. Case-insensitive.
989
1079
  */
990
1080
  clientIpHeader?: string,
1081
+
1082
+ /**
1083
+ * Add custom page to the settings page
1084
+ */
1085
+ userMenuSettingsPages: {
1086
+ icon?: string,
1087
+ pageLabel: string,
1088
+ slug?: string,
1089
+ component: string
1090
+ }[],
991
1091
  },
992
1092
 
993
1093
  /**
@@ -1055,6 +1155,7 @@ export interface AdminForthConfigCustomization extends Omit<AdminForthInputConfi
1055
1155
 
1056
1156
  loginPageInjections: {
1057
1157
  underInputs: Array<AdminForthComponentDeclarationFull>,
1158
+ underLoginButton?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
1058
1159
  panelHeader: Array<AdminForthComponentDeclarationFull>,
1059
1160
  },
1060
1161
 
@@ -1062,8 +1163,16 @@ export interface AdminForthConfigCustomization extends Omit<AdminForthInputConfi
1062
1163
  userMenu: Array<AdminForthComponentDeclarationFull>,
1063
1164
  header: Array<AdminForthComponentDeclarationFull>,
1064
1165
  sidebar: Array<AdminForthComponentDeclarationFull>,
1166
+ sidebarTop: Array<AdminForthComponentDeclarationFull>,
1065
1167
  everyPageBottom: Array<AdminForthComponentDeclarationFull>,
1066
1168
  },
1169
+
1170
+ customHeadItems?: {
1171
+ tagName: string;
1172
+ attributes: Record<string, string | boolean>;
1173
+ innerCode?: string;
1174
+ }[];
1175
+
1067
1176
  }
1068
1177
 
1069
1178
  export interface AdminForthConfig extends Omit<AdminForthInputConfig, 'customization' | 'resources'> {
@@ -1111,6 +1220,21 @@ export class Filters {
1111
1220
  static LIKE(field: string, value: any): IAdminForthSingleFilter {
1112
1221
  return { field, operator: AdminForthFilterOperators.LIKE, value };
1113
1222
  }
1223
+ static ILIKE(field: string, value: any): IAdminForthSingleFilter {
1224
+ return { field, operator: AdminForthFilterOperators.ILIKE, value };
1225
+ }
1226
+ static GT_FIELD(leftField: string, rightField: string): IAdminForthSingleFilter {
1227
+ return { field: leftField, operator: AdminForthFilterOperators.GT, rightField };
1228
+ }
1229
+ static GTE_FIELD(leftField: string, rightField: string): IAdminForthSingleFilter {
1230
+ return { field: leftField, operator: AdminForthFilterOperators.GTE, rightField };
1231
+ }
1232
+ static LT_FIELD(leftField: string, rightField: string): IAdminForthSingleFilter {
1233
+ return { field: leftField, operator: AdminForthFilterOperators.LT, rightField };
1234
+ }
1235
+ static LTE_FIELD(leftField: string, rightField: string): IAdminForthSingleFilter {
1236
+ return { field: leftField, operator: AdminForthFilterOperators.LTE, rightField };
1237
+ }
1114
1238
  static AND(
1115
1239
  ...args: (IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>)[]
1116
1240
  ): IAdminForthAndOrFilter {
@@ -1318,9 +1442,13 @@ export interface AdminForthResource extends Omit<AdminForthResourceInput, 'optio
1318
1442
  },
1319
1443
  create?: {
1320
1444
  /**
1445
+ * Should return `ok: true` to continue saving pipeline and allow creating record in database, and `ok: false` to interrupt pipeline and prevent record creation.
1446
+ * If you need to show error on UI, set `error: \<error message\>` in response.
1447
+ *
1321
1448
  * Typical use-cases:
1322
- * - Validate record before saving to database and interrupt execution if validation failed (`allowedActions.create` should be preferred in most cases)
1323
- * - fill-in adminUser as creator of record
1449
+ * - Create record by custom code (return `{ ok: false, newRecordId: <id of created record from custom code> }`)
1450
+ * - Validate record before saving to database and interrupt execution if validation failed (return `{ ok: false, error: <validation error> }`), though `allowedActions.create` should be preferred in most cases
1451
+ * - fill-in adminUser as creator of record (set `record.<some field> = x; return \{ ok: true \}`)
1324
1452
  * - Attach additional data to record before saving to database (mostly fillOnCreate should be used instead)
1325
1453
  */
1326
1454
  beforeSave?: Array<BeforeCreateSaveFunction>,
@@ -1471,15 +1599,27 @@ export type ShowInInput = ShowInModernInput | ShowInLegacyInput;
1471
1599
  export type ShowIn = {
1472
1600
  [key in AdminForthResourcePages]: AllowedActionValue
1473
1601
  }
1602
+ export type BackendOnlyInput =
1603
+ | boolean
1604
+ | ((p: {
1605
+ adminUser: AdminUser;
1606
+ resource: AdminForthResource;
1607
+ meta: any;
1608
+ source: ActionCheckSource;
1609
+ adminforth: IAdminForth;
1610
+ }) => boolean | Promise<boolean>);
1611
+
1474
1612
 
1475
- export interface AdminForthResourceColumnInput extends Omit<AdminForthResourceColumnInputCommon, 'showIn'> {
1613
+ export interface AdminForthResourceColumnInput extends Omit<AdminForthResourceColumnInputCommon, 'showIn' | 'backendOnly'> {
1476
1614
  showIn?: ShowInInput,
1477
1615
  foreignResource?: AdminForthForeignResource,
1616
+ backendOnly?: BackendOnlyInput;
1478
1617
  }
1479
1618
 
1480
- export interface AdminForthResourceColumn extends Omit<AdminForthResourceColumnCommon, 'showIn'> {
1619
+ export interface AdminForthResourceColumn extends Omit<AdminForthResourceColumnCommon, 'showIn' | 'backendOnly'> {
1481
1620
  showIn?: ShowIn,
1482
1621
  foreignResource?: AdminForthForeignResource,
1622
+ backendOnly?: BackendOnlyInput;
1483
1623
  }
1484
1624
 
1485
1625
  export interface IWebSocketClient {
@@ -1,4 +1,3 @@
1
-
2
1
  /**
3
2
  * Types that are common for both frontend side (SPA) and backend side (server).
4
3
  */
@@ -68,6 +67,11 @@ export type AllowedActionsResolved = {
68
67
  [key in AllowedActionsEnum]: boolean
69
68
  }
70
69
 
70
+ // conditional operators for predicates
71
+ type Value = any;
72
+ type Operators = { $eq: Value } | { $not: Value } | { $gt: Value } | { $gte: Value } | { $lt: Value } | { $lte: Value } | { $in: Value[] } | { $nin: Value[] } | { $includes: Value } | { $nincludes: Value };
73
+ export type Predicate = { $and: Predicate[] } | { $or: Predicate[] } | { [key: string]: Operators | Value };
74
+
71
75
  export interface AdminUser {
72
76
  /**
73
77
  * primaryKey field value of user in table which is defined by {@link AdminForthConfig.auth.usersResourceId}
@@ -95,12 +99,9 @@ export interface AdminForthBulkActionCommon {
95
99
  label: string,
96
100
 
97
101
  /**
98
- * Bulk Action button state 'danger'|success|'active',
99
- * * 'danger' - red button
100
- * * 'success' - green button
101
- * * 'active' - blue button
102
+ * Add custom class
102
103
  **/
103
- state?: 'danger' | 'success' | 'active';
104
+ buttonCustomCssClass?: string;
104
105
 
105
106
  /**
106
107
  * Optional small badge for button which will be displayed in the list view
@@ -122,6 +123,10 @@ export interface AdminForthBulkActionCommon {
122
123
  */
123
124
  successMessage?: string,
124
125
 
126
+ /**
127
+ * Show in three dots dropdown menu in list view.
128
+ */
129
+ showInThreeDotsDropdown?: boolean,
125
130
  }
126
131
 
127
132
  export interface AdminForthFieldComponents {
@@ -261,11 +266,29 @@ export interface AdminForthComponentDeclarationFull {
261
266
  * </script>
262
267
  *
263
268
  */
264
- meta?: any,
269
+ meta?: {
270
+ /**
271
+ * Controls sidebar and header visibility for custom pages
272
+ * - 'default': Show both sidebar and header (default behavior)
273
+ * - 'none': Hide both sidebar and header (full custom layout)
274
+ * - 'preferIconOnly': Show header but prefer icon-only sidebar
275
+ */
276
+ sidebarAndHeader?: 'default' | 'none' | 'preferIconOnly',
277
+
278
+ [key: string]: any,
279
+ }
265
280
  }
281
+ import { type AdminForthActionInput } from './Back.js'
282
+ export { type AdminForthActionInput } from './Back.js'
266
283
 
267
284
  export type AdminForthComponentDeclaration = AdminForthComponentDeclarationFull | string;
268
285
 
286
+ export type FieldGroup = {
287
+ groupName: string;
288
+ columns: string[];
289
+ noTitle?: boolean;
290
+ };
291
+
269
292
  /**
270
293
  * Resource describes one table or collection in database.
271
294
  * AdminForth generates set of pages for 'list', 'show', 'edit', 'create', 'filter' operations for each resource.
@@ -347,6 +370,11 @@ export interface AdminForthResourceInputCommon {
347
370
  direction: AdminForthSortDirections | string,
348
371
  }
349
372
 
373
+ /*
374
+ * Custom actions list. Actions available in show, edit and create views.
375
+ */
376
+ actions?: AdminForthActionInput[],
377
+
350
378
  /**
351
379
  * Custom bulk actions list. Bulk actions available in list view when user selects multiple records by
352
380
  * using checkboxes.
@@ -374,26 +402,10 @@ export interface AdminForthResourceInputCommon {
374
402
  /**
375
403
  * Allows to make groups of columns in show, create and edit resource pages.
376
404
  */
377
- fieldGroups?: {
378
- groupName: string;
379
- columns: string[];
380
- noTitle?: boolean;
381
- }[];
382
- createFieldGroups?: {
383
- groupName: string;
384
- columns: string[];
385
- noTitle?: boolean;
386
- }[];
387
- editFieldGroups?: {
388
- groupName: string;
389
- columns: string[];
390
- noTitle?: boolean;
391
- }[];
392
- showFieldGroups?: {
393
- groupName: string;
394
- columns: string[];
395
- noTitle?: boolean;
396
- }[];
405
+ fieldGroups?: FieldGroup[];
406
+ createFieldGroups?: FieldGroup[];
407
+ editFieldGroups?: FieldGroup[];
408
+ showFieldGroups?: FieldGroup[];
397
409
 
398
410
  /**
399
411
  * Page size for list view
@@ -471,6 +483,7 @@ export interface AdminForthResourceInputCommon {
471
483
  list?: {
472
484
  beforeBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
473
485
  afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
486
+ beforeActionButtons?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
474
487
  bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
475
488
  threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
476
489
  customActionIcons?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
@@ -499,6 +512,11 @@ export interface AdminForthResourceInputCommon {
499
512
  afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
500
513
  bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
501
514
  threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
515
+ /**
516
+ * Custom Save button component for Edit page.
517
+ * Accepts props: [record, resource, adminUser, meta, saving, validating, isValid, disabled, saveRecord]
518
+ */
519
+ saveButton?: AdminForthComponentDeclaration,
502
520
  },
503
521
 
504
522
  /**
@@ -511,6 +529,11 @@ export interface AdminForthResourceInputCommon {
511
529
  afterBreadcrumbs?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
512
530
  bottom?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
513
531
  threeDotsDropdownItems?: AdminForthComponentDeclaration | Array<AdminForthComponentDeclaration>,
532
+ /**
533
+ * Custom Save button component for Create page.
534
+ * Accepts props: [record, resource, adminUser, meta, saving, validating, isValid, disabled, saveRecord]
535
+ */
536
+ saveButton?: AdminForthComponentDeclaration,
514
537
  },
515
538
  }
516
539
  },
@@ -584,6 +607,8 @@ export interface AdminForthForeignResourceCommon {
584
607
  polymorphicResources?: Array<AdminForthPolymorphicForeignResource>,
585
608
  polymorphicOn?: string,
586
609
  unsetLabel?: string,
610
+ searchableFields?: string | string[],
611
+ searchIsCaseSensitive?: boolean,
587
612
  }
588
613
 
589
614
  export type FillOnCreateFunction = (params: {
@@ -810,9 +835,6 @@ export interface AdminForthResourceColumnInputCommon {
810
835
  */
811
836
  minLength?: number,
812
837
 
813
- min?: number,
814
- max?: number,
815
-
816
838
  /**
817
839
  * Minimum value that can be entered in this field.
818
840
  */
@@ -865,6 +887,15 @@ export interface AdminForthResourceColumnInputCommon {
865
887
  */
866
888
  masked?: boolean,
867
889
 
890
+ /**
891
+ * Sticky position for column
892
+ */
893
+ listSticky?: boolean;
894
+
895
+ /**
896
+ * Show field only if certain conditions are met.
897
+ */
898
+ showIf?: Predicate;
868
899
  }
869
900
 
870
901
  export interface AdminForthResourceColumnCommon extends AdminForthResourceColumnInputCommon {
@@ -878,6 +909,15 @@ export interface AdminForthResourceColumnCommon extends AdminForthResourceColumn
878
909
 
879
910
  editingNote?: { create?: string, edit?: string },
880
911
 
912
+ /**
913
+ * Minimal value stored in this field.
914
+ */
915
+ min?: number,
916
+
917
+ /**
918
+ * Maximum value stored in this field.
919
+ */
920
+ max?: number,
881
921
  }
882
922
 
883
923
  export enum AdminForthMenuTypes {
@@ -1055,16 +1095,23 @@ export interface AdminForthConfigForFrontend {
1055
1095
  usernameFieldName: string,
1056
1096
  loginBackgroundImage: string,
1057
1097
  loginBackgroundPosition: string,
1098
+ removeBackgroundBlendMode: boolean,
1058
1099
  title?: string,
1059
1100
  demoCredentials?: string,
1060
- loginPromptHTML?: string,
1101
+ loginPromptHTML?: string | (() => string | Promise<string> | void | Promise<void> | Promise<undefined>) | undefined
1061
1102
  loginPageInjections: {
1062
1103
  underInputs: Array<AdminForthComponentDeclaration>,
1063
1104
  panelHeader: Array<AdminForthComponentDeclaration>,
1064
1105
  },
1065
1106
  rememberMeDays: number,
1066
1107
  showBrandNameInSidebar: boolean,
1108
+ showBrandLogoInSidebar: boolean,
1067
1109
  brandLogo?: string,
1110
+ iconOnlySidebar?: {
1111
+ logo?: string,
1112
+ enabled?: boolean,
1113
+ },
1114
+ singleTheme?: 'light' | 'dark',
1068
1115
  datesFormat: string,
1069
1116
  timeFormat: string,
1070
1117
  auth: any,
@@ -1079,8 +1126,20 @@ export interface AdminForthConfigForFrontend {
1079
1126
  userMenu: Array<AdminForthComponentDeclarationFull>,
1080
1127
  header: Array<AdminForthComponentDeclarationFull>,
1081
1128
  sidebar: Array<AdminForthComponentDeclarationFull>,
1129
+ sidebarTop: Array<AdminForthComponentDeclarationFull>,
1082
1130
  everyPageBottom: Array<AdminForthComponentDeclarationFull>,
1083
- }
1131
+ },
1132
+ customHeadItems?: {
1133
+ tagName: string;
1134
+ attributes: Record<string, string | boolean>;
1135
+ innerCode?: string;
1136
+ }[],
1137
+ settingPages?:{
1138
+ icon?: string,
1139
+ pageLabel: string,
1140
+ slug?: string,
1141
+ component: string,
1142
+ }[],
1084
1143
  }
1085
1144
 
1086
1145
  export interface GetBaseConfigResponse {