@sdcorejs/angular 20.3.1 → 20.3.2

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 (187) hide show
  1. package/assets/STYLE-GUIDE.md +25 -5
  2. package/assets/THEME.md +237 -5
  3. package/assets/licenses/tiptap-oss-NOTICES.txt +332 -0
  4. package/assets/scss/ckeditor5.scss +2 -88
  5. package/assets/scss/core/_control.scss +39 -0
  6. package/assets/scss/core/form.scss +156 -45
  7. package/assets/scss/core/view.scss +24 -0
  8. package/assets/scss/editor-content.scss +173 -0
  9. package/assets/scss/sd-core.scss +1 -0
  10. package/assets/scss/themes/_component-tokens.scss +93 -31
  11. package/assets/scss/themes/_material-tokens.scss +112 -0
  12. package/assets/scss/themes/_presets.scss +25 -0
  13. package/assets/scss/themes/_scales.scss +10 -0
  14. package/assets/scss/themes/_semantic.scss +13 -0
  15. package/assets/scss/themes/default.scss +8 -2
  16. package/components/avatar/index.d.ts +67 -2
  17. package/components/badge/index.d.ts +188 -6
  18. package/components/button/index.d.ts +20 -1
  19. package/components/ckeditor-styles/index.d.ts +3 -18
  20. package/components/editor/index.d.ts +20 -17
  21. package/components/editor-engine/index.d.ts +246 -0
  22. package/components/file-explorer/index.d.ts +4 -2
  23. package/components/form-generic/index.d.ts +246 -35
  24. package/components/index.d.ts +1 -0
  25. package/components/mini-editor/index.d.ts +33 -70
  26. package/components/modal-resizable/index.d.ts +1 -124
  27. package/components/operator/index.d.ts +137 -8
  28. package/components/tab-router/index.d.ts +31 -18
  29. package/components/table/index.d.ts +84 -6
  30. package/components/window/index.d.ts +81 -0
  31. package/configurations/index.d.ts +8 -1
  32. package/fesm2022/sdcorejs-angular-components-api-contract-builder.mjs +5 -5
  33. package/fesm2022/sdcorejs-angular-components-api-contract-builder.mjs.map +1 -1
  34. package/fesm2022/sdcorejs-angular-components-avatar.mjs +142 -11
  35. package/fesm2022/sdcorejs-angular-components-avatar.mjs.map +1 -1
  36. package/fesm2022/sdcorejs-angular-components-badge.mjs +548 -24
  37. package/fesm2022/sdcorejs-angular-components-badge.mjs.map +1 -1
  38. package/fesm2022/sdcorejs-angular-components-button.mjs +33 -3
  39. package/fesm2022/sdcorejs-angular-components-button.mjs.map +1 -1
  40. package/fesm2022/sdcorejs-angular-components-ckeditor-styles.mjs +5 -20
  41. package/fesm2022/sdcorejs-angular-components-ckeditor-styles.mjs.map +1 -1
  42. package/fesm2022/sdcorejs-angular-components-data-state.mjs +1 -1
  43. package/fesm2022/sdcorejs-angular-components-data-state.mjs.map +1 -1
  44. package/fesm2022/sdcorejs-angular-components-editor-engine.mjs +1872 -0
  45. package/fesm2022/sdcorejs-angular-components-editor-engine.mjs.map +1 -0
  46. package/fesm2022/sdcorejs-angular-components-editor.mjs +457 -756
  47. package/fesm2022/sdcorejs-angular-components-editor.mjs.map +1 -1
  48. package/fesm2022/sdcorejs-angular-components-file-explorer.mjs +68 -37
  49. package/fesm2022/sdcorejs-angular-components-file-explorer.mjs.map +1 -1
  50. package/fesm2022/sdcorejs-angular-components-form-generic.mjs +2115 -1156
  51. package/fesm2022/sdcorejs-angular-components-form-generic.mjs.map +1 -1
  52. package/fesm2022/sdcorejs-angular-components-history.mjs +5 -2
  53. package/fesm2022/sdcorejs-angular-components-history.mjs.map +1 -1
  54. package/fesm2022/sdcorejs-angular-components-image-editor.mjs +1 -1
  55. package/fesm2022/sdcorejs-angular-components-image-editor.mjs.map +1 -1
  56. package/fesm2022/sdcorejs-angular-components-import-excel.mjs +21 -6
  57. package/fesm2022/sdcorejs-angular-components-import-excel.mjs.map +1 -1
  58. package/fesm2022/sdcorejs-angular-components-inform.mjs +1 -1
  59. package/fesm2022/sdcorejs-angular-components-inform.mjs.map +1 -1
  60. package/fesm2022/sdcorejs-angular-components-kanban.mjs +12 -2
  61. package/fesm2022/sdcorejs-angular-components-kanban.mjs.map +1 -1
  62. package/fesm2022/sdcorejs-angular-components-mini-editor.mjs +177 -283
  63. package/fesm2022/sdcorejs-angular-components-mini-editor.mjs.map +1 -1
  64. package/fesm2022/sdcorejs-angular-components-modal-resizable.mjs +1 -308
  65. package/fesm2022/sdcorejs-angular-components-modal-resizable.mjs.map +1 -1
  66. package/fesm2022/sdcorejs-angular-components-modal.mjs +2 -2
  67. package/fesm2022/sdcorejs-angular-components-modal.mjs.map +1 -1
  68. package/fesm2022/sdcorejs-angular-components-operator.mjs +262 -43
  69. package/fesm2022/sdcorejs-angular-components-operator.mjs.map +1 -1
  70. package/fesm2022/sdcorejs-angular-components-query-bar.mjs +12 -12
  71. package/fesm2022/sdcorejs-angular-components-query-bar.mjs.map +1 -1
  72. package/fesm2022/sdcorejs-angular-components-query-builder.mjs +1 -1
  73. package/fesm2022/sdcorejs-angular-components-query-builder.mjs.map +1 -1
  74. package/fesm2022/sdcorejs-angular-components-section.mjs +2 -2
  75. package/fesm2022/sdcorejs-angular-components-section.mjs.map +1 -1
  76. package/fesm2022/sdcorejs-angular-components-side-drawer.mjs +2 -2
  77. package/fesm2022/sdcorejs-angular-components-side-drawer.mjs.map +1 -1
  78. package/fesm2022/sdcorejs-angular-components-tab-router.mjs +192 -42
  79. package/fesm2022/sdcorejs-angular-components-tab-router.mjs.map +1 -1
  80. package/fesm2022/sdcorejs-angular-components-table.mjs +564 -110
  81. package/fesm2022/sdcorejs-angular-components-table.mjs.map +1 -1
  82. package/fesm2022/sdcorejs-angular-components-tree.mjs +1 -1
  83. package/fesm2022/sdcorejs-angular-components-tree.mjs.map +1 -1
  84. package/fesm2022/sdcorejs-angular-components-upload-file.mjs +1 -1
  85. package/fesm2022/sdcorejs-angular-components-upload-file.mjs.map +1 -1
  86. package/fesm2022/sdcorejs-angular-components-view.mjs +2 -2
  87. package/fesm2022/sdcorejs-angular-components-view.mjs.map +1 -1
  88. package/fesm2022/sdcorejs-angular-components-window.mjs +486 -0
  89. package/fesm2022/sdcorejs-angular-components-window.mjs.map +1 -0
  90. package/fesm2022/sdcorejs-angular-components.mjs +1 -0
  91. package/fesm2022/sdcorejs-angular-components.mjs.map +1 -1
  92. package/fesm2022/sdcorejs-angular-configurations.mjs.map +1 -1
  93. package/fesm2022/sdcorejs-angular-directives.mjs +18 -1
  94. package/fesm2022/sdcorejs-angular-directives.mjs.map +1 -1
  95. package/fesm2022/sdcorejs-angular-forms-autocomplete.mjs +15 -2
  96. package/fesm2022/sdcorejs-angular-forms-autocomplete.mjs.map +1 -1
  97. package/fesm2022/sdcorejs-angular-forms-checkbox.mjs +2 -2
  98. package/fesm2022/sdcorejs-angular-forms-checkbox.mjs.map +1 -1
  99. package/fesm2022/sdcorejs-angular-forms-chip-calendar.mjs +460 -125
  100. package/fesm2022/sdcorejs-angular-forms-chip-calendar.mjs.map +1 -1
  101. package/fesm2022/sdcorejs-angular-forms-date-range.mjs +75 -13
  102. package/fesm2022/sdcorejs-angular-forms-date-range.mjs.map +1 -1
  103. package/fesm2022/sdcorejs-angular-forms-date.mjs +71 -18
  104. package/fesm2022/sdcorejs-angular-forms-date.mjs.map +1 -1
  105. package/fesm2022/sdcorejs-angular-forms-datetime.mjs +75 -16
  106. package/fesm2022/sdcorejs-angular-forms-datetime.mjs.map +1 -1
  107. package/fesm2022/sdcorejs-angular-forms-directives.mjs +82 -2
  108. package/fesm2022/sdcorejs-angular-forms-directives.mjs.map +1 -1
  109. package/fesm2022/sdcorejs-angular-forms-entity-picker.mjs +2 -2
  110. package/fesm2022/sdcorejs-angular-forms-entity-picker.mjs.map +1 -1
  111. package/fesm2022/sdcorejs-angular-forms-input-color.mjs +1 -1
  112. package/fesm2022/sdcorejs-angular-forms-input-color.mjs.map +1 -1
  113. package/fesm2022/sdcorejs-angular-forms-input-number.mjs +40 -5
  114. package/fesm2022/sdcorejs-angular-forms-input-number.mjs.map +1 -1
  115. package/fesm2022/sdcorejs-angular-forms-input.mjs +50 -7
  116. package/fesm2022/sdcorejs-angular-forms-input.mjs.map +1 -1
  117. package/fesm2022/sdcorejs-angular-forms-models.mjs +88 -5
  118. package/fesm2022/sdcorejs-angular-forms-models.mjs.map +1 -1
  119. package/fesm2022/sdcorejs-angular-forms-radio.mjs +2 -2
  120. package/fesm2022/sdcorejs-angular-forms-radio.mjs.map +1 -1
  121. package/fesm2022/sdcorejs-angular-forms-segmented.mjs +5 -4
  122. package/fesm2022/sdcorejs-angular-forms-segmented.mjs.map +1 -1
  123. package/fesm2022/sdcorejs-angular-forms-select.mjs +63 -15
  124. package/fesm2022/sdcorejs-angular-forms-select.mjs.map +1 -1
  125. package/fesm2022/sdcorejs-angular-forms-switch.mjs +2 -2
  126. package/fesm2022/sdcorejs-angular-forms-switch.mjs.map +1 -1
  127. package/fesm2022/sdcorejs-angular-forms-textarea.mjs +2 -2
  128. package/fesm2022/sdcorejs-angular-forms-textarea.mjs.map +1 -1
  129. package/fesm2022/sdcorejs-angular-forms-time.mjs +2 -2
  130. package/fesm2022/sdcorejs-angular-forms-time.mjs.map +1 -1
  131. package/fesm2022/sdcorejs-angular-forms-tree-select.mjs +1 -1
  132. package/fesm2022/sdcorejs-angular-forms-tree-select.mjs.map +1 -1
  133. package/fesm2022/sdcorejs-angular-i18n.mjs +1535 -22
  134. package/fesm2022/sdcorejs-angular-i18n.mjs.map +1 -1
  135. package/fesm2022/sdcorejs-angular-interceptors.mjs +1 -1
  136. package/fesm2022/sdcorejs-angular-interceptors.mjs.map +1 -1
  137. package/fesm2022/sdcorejs-angular-modules-generic-generic-configuration.page-DnbDCdcz.mjs +478 -0
  138. package/fesm2022/sdcorejs-angular-modules-generic-generic-configuration.page-DnbDCdcz.mjs.map +1 -0
  139. package/fesm2022/sdcorejs-angular-modules-generic-generic-form-host.page-EBHM4kx2.mjs +214 -0
  140. package/fesm2022/sdcorejs-angular-modules-generic-generic-form-host.page-EBHM4kx2.mjs.map +1 -0
  141. package/fesm2022/sdcorejs-angular-modules-generic-generic-list.page-BtHe8YIW.mjs +277 -0
  142. package/fesm2022/sdcorejs-angular-modules-generic-generic-list.page-BtHe8YIW.mjs.map +1 -0
  143. package/fesm2022/sdcorejs-angular-modules-generic-sdcorejs-angular-modules-generic-eFshU7ew.mjs +1556 -0
  144. package/fesm2022/sdcorejs-angular-modules-generic-sdcorejs-angular-modules-generic-eFshU7ew.mjs.map +1 -0
  145. package/fesm2022/sdcorejs-angular-modules-generic.mjs +2 -0
  146. package/fesm2022/sdcorejs-angular-modules-generic.mjs.map +1 -0
  147. package/fesm2022/sdcorejs-angular-modules-icon.mjs +96 -3
  148. package/fesm2022/sdcorejs-angular-modules-icon.mjs.map +1 -1
  149. package/fesm2022/sdcorejs-angular-modules-layout.mjs +1825 -62
  150. package/fesm2022/sdcorejs-angular-modules-layout.mjs.map +1 -1
  151. package/fesm2022/sdcorejs-angular-modules.mjs +1 -0
  152. package/fesm2022/sdcorejs-angular-modules.mjs.map +1 -1
  153. package/fesm2022/sdcorejs-angular-pipes.mjs +27 -7
  154. package/fesm2022/sdcorejs-angular-pipes.mjs.map +1 -1
  155. package/fesm2022/sdcorejs-angular-services-confirm.mjs +1 -1
  156. package/fesm2022/sdcorejs-angular-services-confirm.mjs.map +1 -1
  157. package/fesm2022/sdcorejs-angular-services-date-time.mjs +143 -0
  158. package/fesm2022/sdcorejs-angular-services-date-time.mjs.map +1 -0
  159. package/fesm2022/sdcorejs-angular-services-storage.mjs +44 -8
  160. package/fesm2022/sdcorejs-angular-services-storage.mjs.map +1 -1
  161. package/fesm2022/sdcorejs-angular-services.mjs +1 -0
  162. package/fesm2022/sdcorejs-angular-services.mjs.map +1 -1
  163. package/fesm2022/sdcorejs-angular-utilities-read-state.mjs +4 -0
  164. package/fesm2022/sdcorejs-angular-utilities-read-state.mjs.map +1 -1
  165. package/fesm2022/sdcorejs-angular-utilities-theme.mjs +10 -0
  166. package/fesm2022/sdcorejs-angular-utilities-theme.mjs.map +1 -1
  167. package/forms/autocomplete/index.d.ts +5 -0
  168. package/forms/chip-calendar/index.d.ts +163 -18
  169. package/forms/date/index.d.ts +23 -2
  170. package/forms/date-range/index.d.ts +24 -2
  171. package/forms/directives/index.d.ts +47 -2
  172. package/forms/input/index.d.ts +23 -2
  173. package/forms/input-number/index.d.ts +23 -2
  174. package/forms/models/index.d.ts +38 -3
  175. package/forms/select/index.d.ts +32 -2
  176. package/i18n/index.d.ts +302 -2
  177. package/modules/generic/index.d.ts +316 -0
  178. package/modules/icon/index.d.ts +37 -6
  179. package/modules/index.d.ts +1 -0
  180. package/modules/layout/index.d.ts +536 -86
  181. package/package.json +41 -8
  182. package/pipes/index.d.ts +2 -0
  183. package/services/date-time/index.d.ts +57 -0
  184. package/services/index.d.ts +1 -0
  185. package/services/storage/index.d.ts +8 -1
  186. package/utilities/read-state/index.d.ts +2 -0
  187. package/utilities/theme/index.d.ts +1 -1
@@ -0,0 +1,316 @@
1
+ import { Operator, Order, PagingReq, PagingRes, Filter } from '@sdcorejs/utils/models';
2
+ import { SdFormGenericSchema } from '@sdcorejs/angular/components/form-generic';
3
+ import { Type, EnvironmentProviders } from '@angular/core';
4
+ import { Routes } from '@angular/router';
5
+
6
+ /** Backend-neutral data type of a property. It decides the list column and the form field. */
7
+ type SdGenericDataType = 'string' | 'text' | 'number' | 'boolean' | 'date' | 'datetime' | 'time' | 'enum' | 'relation' | 'json' | 'file';
8
+ /** Input preset of a `string` property. */
9
+ type SdGenericStringFormat = 'email' | 'phone' | 'url' | 'password';
10
+ /** Display preset of a `number` property. */
11
+ type SdGenericNumberFormat = 'integer' | 'decimal' | 'currency' | 'percent';
12
+ /** One option of an `enum` property. `value` is structural (owned by the backend); the rest is display. */
13
+ interface SdGenericEnumOption {
14
+ value: string;
15
+ label: string;
16
+ /** Badge color in the list (a Core UI color token or CSS color). */
17
+ color?: string;
18
+ /** Material icon shown next to the badge. */
19
+ icon?: string;
20
+ }
21
+ /** Link of a `relation` property to another entity, resolved through that entity's adapter. */
22
+ interface SdGenericRelation {
23
+ /** Module of the related entity; defaults to the module of the schema. */
24
+ module?: string;
25
+ entity: string;
26
+ /** Field stored in this record; defaults to `'id'`. */
27
+ valueField?: string;
28
+ /** Field shown for a related record when `display` is absent. */
29
+ displayField?: string;
30
+ /** Text template such as `'${code} - ${name}'`; rendered as plain text. */
31
+ display?: string;
32
+ /** Fields searched by the relation select; defaults to `[displayField]`. */
33
+ searchFields?: string[];
34
+ }
35
+ interface SdGenericPropertyValidation {
36
+ required?: boolean;
37
+ min?: number;
38
+ max?: number;
39
+ minLength?: number;
40
+ maxLength?: number;
41
+ /** Regular expression source. */
42
+ pattern?: string;
43
+ }
44
+ /** One field of an entity. `general.properties` is the only source of field data. */
45
+ interface SdGenericProperty {
46
+ key: string;
47
+ label: string;
48
+ dataType: SdGenericDataType;
49
+ /** Several values: chips for `string`, multi-select for `enum` / `relation`, several files for `file`. */
50
+ multiple?: boolean;
51
+ format?: SdGenericStringFormat | SdGenericNumberFormat;
52
+ enums?: SdGenericEnumOption[];
53
+ relation?: SdGenericRelation;
54
+ validation?: SdGenericPropertyValidation;
55
+ defaultValue?: unknown;
56
+ /** Defaults to `true`. */
57
+ insertable?: boolean;
58
+ /** Defaults to `true`. */
59
+ updatable?: boolean;
60
+ /** Server field such as `id` or `createdAt`: shown in the list and detail, never in create / update. */
61
+ system?: boolean;
62
+ }
63
+ interface SdGenericGeneral {
64
+ /** Name of the entity, used by the default titles. */
65
+ label: string;
66
+ /** Defaults to `'id'`. */
67
+ primaryKey?: string;
68
+ properties: SdGenericProperty[];
69
+ }
70
+ interface SdGenericListColumn {
71
+ key: string;
72
+ width?: number;
73
+ /** `false` hides the column by default; the user can show it again from the column settings. */
74
+ visible?: boolean;
75
+ sortable?: boolean;
76
+ filterable?: boolean;
77
+ }
78
+ interface SdGenericExternalFilter {
79
+ key: string;
80
+ operator?: Operator;
81
+ default?: unknown;
82
+ required?: boolean;
83
+ }
84
+ interface SdGenericListSection {
85
+ /** Plain text title; placeholders are not allowed. */
86
+ title?: string;
87
+ /** Absent: every property except `json` and `file`. */
88
+ columns?: SdGenericListColumn[];
89
+ /**
90
+ * Filters shown above the table; the filter toolbar (clear / pick filters) stays hidden. Declared in code only: the backend
91
+ * schema or the `provideSdGenericEntity` schema adjustment. A stored configuration never carries them (save
92
+ * drops them, load ignores them), and the configuration screen does not edit them.
93
+ */
94
+ externalFilters?: SdGenericExternalFilter[];
95
+ /** Default sort. */
96
+ orders?: Order[];
97
+ /** Defaults to 20. */
98
+ pageSize?: number;
99
+ /** Client-side Excel export of the table. */
100
+ export?: boolean;
101
+ }
102
+ interface SdGenericFormSection {
103
+ /** Title template; `${key}` placeholders are allowed only in detail / update. */
104
+ title?: string;
105
+ /** Layout only: fields reference properties by `key` and get their data from `general`. */
106
+ form?: SdFormGenericSchema;
107
+ }
108
+ interface SdGenericImportColumn {
109
+ key: string;
110
+ /** Relation column: field of the related record matched against the cell; defaults to `relation.displayField`. */
111
+ matchField?: string;
112
+ }
113
+ interface SdGenericImportSection {
114
+ /** Absent: every insertable property except `system`, `json` and `file`. */
115
+ columns?: SdGenericImportColumn[];
116
+ /** Existing records matching this key are updated; the others are created. Absent: always create. */
117
+ upsertKey?: string;
118
+ }
119
+ /** Schema of one entity of one module. Version 1 is plain JSON so it can be stored by `schemaStore.set`. */
120
+ interface SdGenericSchema {
121
+ version: 1;
122
+ module: string;
123
+ entity: string;
124
+ general: SdGenericGeneral;
125
+ list?: SdGenericListSection;
126
+ detail?: SdGenericFormSection;
127
+ /** `form` absent: the detail layout, then a generated one. */
128
+ create?: SdGenericFormSection;
129
+ /** `form` absent: the detail layout, then a generated one. */
130
+ update?: SdGenericFormSection;
131
+ import?: SdGenericImportSection;
132
+ }
133
+ /** Actions guarded by a permission code. */
134
+ type SdGenericAction = 'list' | 'detail' | 'create' | 'update' | 'delete' | 'import' | 'configuration';
135
+ /** Actions that open a form. */
136
+ type SdGenericFormAction = 'create' | 'update' | 'detail';
137
+
138
+ /** A record as the adapter returns it. */
139
+ type SdGenericRecord = Record<string, unknown>;
140
+ /** Request of a relation search: by `term`, or by `values` to resolve the labels of selected values. */
141
+ interface SdGenericSearchReq {
142
+ term?: string;
143
+ values?: unknown[];
144
+ /** Fields searched with `term`. */
145
+ fields: string[];
146
+ /** Field matched by `values`. */
147
+ valueField: string;
148
+ filters?: Filter[];
149
+ limit?: number;
150
+ }
151
+ /** How a create / update / detail form is shown. */
152
+ type SdGenericDisplay = 'page' | 'side-drawer';
153
+ interface SdGenericDisplayArgs {
154
+ schema: SdGenericSchema;
155
+ action: SdGenericFormAction;
156
+ }
157
+ /**
158
+ * Storage of the customized schema of an entity, edited on the configuration screen (server-wide or per user, as
159
+ * the adapter decides). `get` returns `null` when nothing is stored yet.
160
+ */
161
+ interface SdGenericSchemaStore {
162
+ get(entity: string): Promise<SdGenericSchema | null>;
163
+ set(entity: string, schema: SdGenericSchema): Promise<void>;
164
+ }
165
+ /**
166
+ * Connects one backend (`module`) to the generic module. The library never calls HTTP itself: every
167
+ * request goes through the adapter, so transport, URLs and authentication stay in the consumer.
168
+ */
169
+ interface SdGenericAdapter {
170
+ readonly module: string;
171
+ /** Schema of an entity as the backend describes it (`general` is required). */
172
+ schema(entity: string): Promise<SdGenericSchema>;
173
+ query(entity: string, req: PagingReq): Promise<PagingRes<SdGenericRecord>>;
174
+ detail(entity: string, id: string): Promise<SdGenericRecord>;
175
+ create(entity: string, data: SdGenericRecord): Promise<SdGenericRecord>;
176
+ update(entity: string, id: string, data: SdGenericRecord): Promise<SdGenericRecord>;
177
+ delete(entity: string, id: string): Promise<void>;
178
+ /** Dedicated search API; absent: `query` with `CONTAIN` / `IN` filters. */
179
+ search?(entity: string, req: SdGenericSearchReq): Promise<SdGenericRecord[]>;
180
+ /** Where customized schemas are stored. Absent: `localStorage` of this browser. */
181
+ schemaStore?: SdGenericSchemaStore;
182
+ /** Absent: `'page'`. */
183
+ display?(args: SdGenericDisplayArgs): SdGenericDisplay;
184
+ }
185
+
186
+ /** Context handed to a custom action. */
187
+ interface SdGenericActionContext {
188
+ schema: SdGenericSchema;
189
+ /** The row of a row command or the record of a detail action. */
190
+ row?: SdGenericRecord;
191
+ /** The selected rows of a bulk action. */
192
+ rows?: SdGenericRecord[];
193
+ /** Reloads the list (and the detail record when shown). */
194
+ reload(): void;
195
+ }
196
+ /** A custom button declared by code; JSON configuration can only hide it by `id`. */
197
+ interface SdGenericCustomAction {
198
+ id: string;
199
+ label: string;
200
+ icon?: string;
201
+ /** Permission code checked with `SdPermissionService`. */
202
+ permission?: string;
203
+ visible?(context: SdGenericActionContext): boolean;
204
+ run(context: SdGenericActionContext): void | Promise<void>;
205
+ }
206
+ interface SdGenericSaveContext {
207
+ action: 'create' | 'update';
208
+ /** Payload about to be sent to the adapter. */
209
+ data: SdGenericRecord;
210
+ schema: SdGenericSchema;
211
+ /** Id of the updated record. */
212
+ id?: string;
213
+ }
214
+ interface SdGenericAfterSaveContext extends SdGenericSaveContext {
215
+ /** Record returned by the adapter. */
216
+ result: SdGenericRecord;
217
+ }
218
+ interface SdGenericHooks {
219
+ /** Returns the payload sent to the adapter. */
220
+ beforeSave?(context: SdGenericSaveContext): SdGenericRecord | Promise<SdGenericRecord>;
221
+ /** Runs once after a successful save. */
222
+ afterSave?(context: SdGenericAfterSaveContext): void | Promise<void>;
223
+ }
224
+ /** Built-in actions that `hiddenDefaults` can hide. */
225
+ type SdGenericDefaultAction = 'create' | 'import' | 'export' | 'detail' | 'update' | 'delete';
226
+ /** What the consumer configures for one entity through `provideSdGenericEntity`: code-level customization. */
227
+ interface SdGenericEntityConfiguration {
228
+ module: string;
229
+ entity: string;
230
+ /** Adjusts the schema returned by the adapter; the result is the default configuration of the entity. */
231
+ schema?(base: SdGenericSchema): SdGenericSchema | Promise<SdGenericSchema>;
232
+ /** Dedicated search API of this entity; wins over the adapter search. */
233
+ search?(req: SdGenericSearchReq): Promise<SdGenericRecord[]>;
234
+ /** Wins over the adapter `display`. */
235
+ display?(args: SdGenericDisplayArgs): SdGenericDisplay;
236
+ hooks?: SdGenericHooks;
237
+ /** Header buttons of the list. */
238
+ listActions?: SdGenericCustomAction[];
239
+ /** Commands of each row. */
240
+ rowCommands?: SdGenericCustomAction[];
241
+ /** Actions on the selected rows. */
242
+ bulkActions?: SdGenericCustomAction[];
243
+ /** Buttons of the detail page or drawer. */
244
+ detailActions?: SdGenericCustomAction[];
245
+ hiddenDefaults?: SdGenericDefaultAction[];
246
+ }
247
+ /** What the consumer configures for the generic module through `provideSdGeneric`: adapters and the permission switch. */
248
+ interface SdGenericConfiguration {
249
+ /** Adapter classes (created by DI, so they can inject the HTTP client of the app) or instances. */
250
+ adapters: (Type<SdGenericAdapter> | SdGenericAdapter)[];
251
+ /** `false` turns every permission check off (development). Defaults to `true`. */
252
+ permission?: boolean;
253
+ }
254
+
255
+ /** Problems reported by `validateSdGenericSchema`. */
256
+ type SdGenericSchemaIssueCode =
257
+ /** Not an object, or a required member is missing or has the wrong type. */
258
+ 'shape'
259
+ /** `version` is not 1. */
260
+ | 'version' | 'module-mismatch' | 'entity-mismatch' | 'property-key-duplicate'
261
+ /** `dataType` is not one of the supported data types. */
262
+ | 'property-type'
263
+ /** A list column, filter, order, import column, upsert key or layout field points to a property that does not exist. */
264
+ | 'reference-dangling'
265
+ /** A form layout breaks the form-generic grammar (pages, then groups or fields). */
266
+ | 'layout-grammar'
267
+ /** A layout field type does not match the data type of its property. */
268
+ | 'layout-type-mismatch' | 'upsert-key-multiple'
269
+ /** The upsert key is not one of the import columns, so no row could ever match an existing record. */
270
+ | 'upsert-key-not-imported' | 'create-not-insertable' | 'update-not-updatable'
271
+ /** The list and create titles cannot contain `${...}` placeholders. */
272
+ | 'title-placeholder-forbidden'
273
+ /** A detail or update title references a property that does not exist. */
274
+ | 'title-placeholder-unknown';
275
+ /** Every issue is an `error` for a save; `sdGenericBlocksLoad` decides which ones a load tolerates. */
276
+ type SdGenericSchemaIssueSeverity = 'error' | 'warning';
277
+ interface SdGenericSchemaIssue {
278
+ code: SdGenericSchemaIssueCode;
279
+ severity: SdGenericSchemaIssueSeverity;
280
+ /** JSON path such as `list.columns[2].key`. */
281
+ path: string;
282
+ message: string;
283
+ }
284
+
285
+ /**
286
+ * Registers backend adapters for the generic module. Call it at the root and/or in the `providers` of lazy
287
+ * routes: lookups use the nearest injector first, then its parents. Adapter classes are created by DI.
288
+ *
289
+ * @example
290
+ * provideSdGeneric({ adapters: [TmsAdapter] });
291
+ */
292
+ declare function provideSdGeneric(configuration: SdGenericConfiguration): EnvironmentProviders;
293
+ /**
294
+ * Code-level customization of one entity: schema adjustments, dedicated search, display mode, save hooks and
295
+ * custom actions. Same scoping rules as `provideSdGeneric`.
296
+ */
297
+ declare function provideSdGenericEntity(configuration: SdGenericEntityConfiguration): EnvironmentProviders;
298
+
299
+ /**
300
+ * Routes of the generic module:
301
+ * `generic/:module/:entity` (list), `create`, `:id/detail`, `:id/update` (page or side drawer over the list)
302
+ * and `configuration`. Mount them where the adapters of the module are provided (root or the lazy route).
303
+ *
304
+ * @example
305
+ * { path: 'tms', providers: [provideSdGeneric({ adapters: [TmsAdapter] })], children: sdGenericRoutes() }
306
+ */
307
+ declare function sdGenericRoutes(): Routes;
308
+
309
+ /**
310
+ * Validates a stored configuration against the current schema of the entity (INV-003). The same function guards
311
+ * the load and the configuration screen; an empty list means valid.
312
+ */
313
+ declare function validateSdGenericSchema(stored: unknown, base: SdGenericSchema): SdGenericSchemaIssue[];
314
+
315
+ export { provideSdGeneric, provideSdGenericEntity, sdGenericRoutes, validateSdGenericSchema };
316
+ export type { SdGenericAction, SdGenericActionContext, SdGenericAdapter, SdGenericAfterSaveContext, SdGenericConfiguration, SdGenericCustomAction, SdGenericDataType, SdGenericDefaultAction, SdGenericDisplay, SdGenericDisplayArgs, SdGenericEntityConfiguration, SdGenericEnumOption, SdGenericExternalFilter, SdGenericFormAction, SdGenericFormSection, SdGenericGeneral, SdGenericHooks, SdGenericImportColumn, SdGenericImportSection, SdGenericListColumn, SdGenericListSection, SdGenericNumberFormat, SdGenericProperty, SdGenericPropertyValidation, SdGenericRecord, SdGenericRelation, SdGenericSaveContext, SdGenericSchema, SdGenericSchemaIssue, SdGenericSchemaIssueCode, SdGenericSchemaIssueSeverity, SdGenericSchemaStore, SdGenericSearchReq, SdGenericStringFormat };
@@ -1,9 +1,9 @@
1
- import * as _angular_core from '@angular/core';
2
- import { InjectionToken, EnvironmentProviders } from '@angular/core';
1
+ import { LucideConfig, LucideIcon, LucideIconData } from '@lucide/angular';
3
2
  import { Size } from '@sdcorejs/utils/models';
4
3
  import { SdIconSet, SdMaterialIconSet } from '@sdcorejs/angular/utilities/models';
5
4
  export { SdIconSet, SdMaterialIconSet } from '@sdcorejs/angular/utilities/models';
6
- import { LucideConfig, LucideIcon, LucideIconData } from '@lucide/angular';
5
+ import * as _angular_core from '@angular/core';
6
+ import { InjectionToken, EnvironmentProviders } from '@angular/core';
7
7
 
8
8
  /** @deprecated Use `SdIconSet` instead. */
9
9
  type SdIconFontSet = SdIconSet;
@@ -21,8 +21,9 @@ type SdIconShape = 'square' | 'circle' | 'none';
21
21
  type SdLucideIconRegistration = LucideIcon | LucideIconData;
22
22
  /**
23
23
  * Danh sách đăng ký Lucide cho provider, hỗ trợ cả array và object map để app có thể giữ cấu trúc import riêng.
24
+ * Nhận cả bản readonly (vd `SD_DATA_TYPE_LUCIDE_ICONS`) mà không cần copy.
24
25
  */
25
- type SdLucideIconRegistrations = SdLucideIconRegistration[] | Record<string, SdLucideIconRegistration>;
26
+ type SdLucideIconRegistrations = readonly SdLucideIconRegistration[] | Readonly<Record<string, SdLucideIconRegistration>>;
26
27
  /**
27
28
  * Cấu hình app-level cho `SdIcon`.
28
29
  *
@@ -65,6 +66,36 @@ declare const SD_DEFAULT_MATERIAL_ALIASES: Record<string, string>;
65
66
  */
66
67
  declare const SD_ICON_DEFAULT_CONFIG: ISdIconResolvedConfiguration;
67
68
 
69
+ /**
70
+ * Khoá kiểu dữ liệu dùng chung cho icon: theo ngữ nghĩa dữ liệu, không theo widget của form.
71
+ *
72
+ * why: `modules/icon` là entry point lá mà generic, form-generic… cùng import, nên bộ khoá này không được
73
+ * phụ thuộc model của bất kỳ component nào — mỗi nơi tự quy dữ liệu của mình về một khoá.
74
+ * Kiểu giữ nhiều giá trị luôn dùng hậu tố `-multiple`, khớp cờ `multiple` của property generic và form-generic.
75
+ */
76
+ type SdDataTypeIconKey = 'string' | 'string-multiple' | 'email' | 'phone' | 'url' | 'password' | 'text' | 'number' | 'integer' | 'decimal' | 'currency' | 'percent' | 'boolean' | 'date' | 'date-multiple' | 'datetime' | 'time' | 'enum' | 'enum-multiple' | 'relation' | 'json' | 'file';
77
+ /**
78
+ * Tên icon Material của từng kiểu dữ liệu. `SdIcon` tự đổi sang Lucide qua `SD_DEFAULT_LUCIDE_ALIASES`.
79
+ *
80
+ * why: `number` dùng `numbers` chứ không dùng `tag` — `SD_DEFAULT_MATERIAL_ALIASES` đổi `tag` thành
81
+ * `local_offer` (hình nhãn giá).
82
+ * why: các hằng của file này đánh dấu `@__PURE__` — lời gọi `Object.freeze` ở top-level bị bundler coi là có side
83
+ * effect, nên nếu không đánh dấu thì app nào import `modules/icon` cũng phải tải chúng (kèm các class Lucide).
84
+ */
85
+ declare const SD_DATA_TYPE_ICON: Readonly<Record<SdDataTypeIconKey, string>>;
86
+ /** Khoá i18n tên kiểu dữ liệu (`core.data-type.<key>`), chưa dịch; component dùng tự dịch. */
87
+ declare const SD_DATA_TYPE_LABEL_KEY: Readonly<Record<SdDataTypeIconKey, string>>;
88
+ /**
89
+ * Đăng ký Lucide cho mọi icon của bộ kiểu dữ liệu.
90
+ *
91
+ * why: `@lucide/angular` chỉ render icon đã đăng ký và `provideSdIcon` chỉ đăng ký danh sách của app. Danh sách
92
+ * này là opt-in — app dùng Lucide truyền vào `provideSdIcon({ lucideIcons: [...SD_DATA_TYPE_LUCIDE_ICONS] })`, app
93
+ * Material không phải tải thêm icon nào.
94
+ */
95
+ declare const SD_DATA_TYPE_LUCIDE_ICONS: readonly SdLucideIconRegistration[];
96
+ /** Icon Material của một kiểu dữ liệu; khoá rỗng hoặc lạ trả về `'tune'` (cùng fallback với query-bar/query-builder). */
97
+ declare function sdDataTypeIcon(key: SdDataTypeIconKey | (string & {}) | null | undefined): string;
98
+
68
99
  /**
69
100
  * Facade icon dùng chung cho Core UI.
70
101
  *
@@ -196,5 +227,5 @@ declare function resolveSdIconConfig(config?: ISdIconConfiguration): ISdIconReso
196
227
  */
197
228
  declare function normalizeSdLucideIcons(registrations?: SdLucideIconRegistrations): SdLucideIconRegistration[];
198
229
 
199
- export { SD_DEFAULT_LUCIDE_ALIASES, SD_DEFAULT_MATERIAL_ALIASES, SD_ICON_CONFIGURATION, SD_ICON_DEFAULT_CONFIG, SD_ICON_SIZE_MAP, SdIcon, normalizeSdLucideIcons, provideSdIcon, resolveSdIconConfig };
200
- export type { ISdIconConfiguration, ISdIconResolvedConfiguration, SdIconFontSet, SdIconShape, SdLucideIconRegistration, SdLucideIconRegistrations };
230
+ export { SD_DATA_TYPE_ICON, SD_DATA_TYPE_LABEL_KEY, SD_DATA_TYPE_LUCIDE_ICONS, SD_DEFAULT_LUCIDE_ALIASES, SD_DEFAULT_MATERIAL_ALIASES, SD_ICON_CONFIGURATION, SD_ICON_DEFAULT_CONFIG, SD_ICON_SIZE_MAP, SdIcon, normalizeSdLucideIcons, provideSdIcon, resolveSdIconConfig, sdDataTypeIcon };
231
+ export type { ISdIconConfiguration, ISdIconResolvedConfiguration, SdDataTypeIconKey, SdIconFontSet, SdIconShape, SdLucideIconRegistration, SdLucideIconRegistrations };
@@ -3,3 +3,4 @@ export * from '@sdcorejs/angular/modules/permission';
3
3
  export * from '@sdcorejs/angular/modules/auth';
4
4
  export * from '@sdcorejs/angular/modules/layout';
5
5
  export * from '@sdcorejs/angular/modules/icon';
6
+ export * from '@sdcorejs/angular/modules/generic';