@memberjunction/codegen-lib 2.48.0 → 2.49.0

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 (78) hide show
  1. package/dist/Angular/angular-codegen.d.ts +164 -6
  2. package/dist/Angular/angular-codegen.d.ts.map +1 -1
  3. package/dist/Angular/angular-codegen.js +177 -13
  4. package/dist/Angular/angular-codegen.js.map +1 -1
  5. package/dist/Angular/join-grid-related-entity-component.d.ts +52 -3
  6. package/dist/Angular/join-grid-related-entity-component.d.ts.map +1 -1
  7. package/dist/Angular/join-grid-related-entity-component.js +58 -3
  8. package/dist/Angular/join-grid-related-entity-component.js.map +1 -1
  9. package/dist/Angular/related-entity-components.d.ts +99 -42
  10. package/dist/Angular/related-entity-components.d.ts.map +1 -1
  11. package/dist/Angular/related-entity-components.js +116 -26
  12. package/dist/Angular/related-entity-components.js.map +1 -1
  13. package/dist/Angular/timeline-related-entity-component.d.ts +46 -7
  14. package/dist/Angular/timeline-related-entity-component.d.ts.map +1 -1
  15. package/dist/Angular/timeline-related-entity-component.js +64 -7
  16. package/dist/Angular/timeline-related-entity-component.js.map +1 -1
  17. package/dist/Angular/user-view-grid-related-entity-component.d.ts +33 -1
  18. package/dist/Angular/user-view-grid-related-entity-component.d.ts.map +1 -1
  19. package/dist/Angular/user-view-grid-related-entity-component.js +33 -1
  20. package/dist/Angular/user-view-grid-related-entity-component.js.map +1 -1
  21. package/dist/Config/config.d.ts +369 -45
  22. package/dist/Config/config.d.ts.map +1 -1
  23. package/dist/Config/config.js +136 -2
  24. package/dist/Config/config.js.map +1 -1
  25. package/dist/Config/db-connection.d.ts +17 -3
  26. package/dist/Config/db-connection.d.ts.map +1 -1
  27. package/dist/Config/db-connection.js +31 -19
  28. package/dist/Config/db-connection.js.map +1 -1
  29. package/dist/Database/dbSchema.d.ts +44 -1
  30. package/dist/Database/dbSchema.d.ts.map +1 -1
  31. package/dist/Database/dbSchema.js +44 -1
  32. package/dist/Database/dbSchema.js.map +1 -1
  33. package/dist/Database/manage-metadata.d.ts +52 -46
  34. package/dist/Database/manage-metadata.d.ts.map +1 -1
  35. package/dist/Database/manage-metadata.js +221 -167
  36. package/dist/Database/manage-metadata.js.map +1 -1
  37. package/dist/Database/reorder-columns.d.ts +2 -2
  38. package/dist/Database/reorder-columns.d.ts.map +1 -1
  39. package/dist/Database/reorder-columns.js +23 -17
  40. package/dist/Database/reorder-columns.js.map +1 -1
  41. package/dist/Database/sql.d.ts +4 -4
  42. package/dist/Database/sql.d.ts.map +1 -1
  43. package/dist/Database/sql.js +2 -2
  44. package/dist/Database/sql.js.map +1 -1
  45. package/dist/Database/sql_codegen.d.ts +15 -15
  46. package/dist/Database/sql_codegen.d.ts.map +1 -1
  47. package/dist/Database/sql_codegen.js +184 -112
  48. package/dist/Database/sql_codegen.js.map +1 -1
  49. package/dist/Misc/advanced_generation.js +81 -81
  50. package/dist/Misc/advanced_generation.js.map +1 -1
  51. package/dist/Misc/entity_subclasses_codegen.d.ts +5 -5
  52. package/dist/Misc/entity_subclasses_codegen.d.ts.map +1 -1
  53. package/dist/Misc/entity_subclasses_codegen.js +10 -8
  54. package/dist/Misc/entity_subclasses_codegen.js.map +1 -1
  55. package/dist/Misc/graphql_server_codegen.d.ts.map +1 -1
  56. package/dist/Misc/graphql_server_codegen.js +33 -28
  57. package/dist/Misc/graphql_server_codegen.js.map +1 -1
  58. package/dist/Misc/sql_logging.d.ts +2 -2
  59. package/dist/Misc/sql_logging.d.ts.map +1 -1
  60. package/dist/Misc/sql_logging.js +4 -3
  61. package/dist/Misc/sql_logging.js.map +1 -1
  62. package/dist/Misc/status_logging.d.ts +37 -0
  63. package/dist/Misc/status_logging.d.ts.map +1 -1
  64. package/dist/Misc/status_logging.js +145 -3
  65. package/dist/Misc/status_logging.js.map +1 -1
  66. package/dist/Misc/system_integrity.d.ts +9 -9
  67. package/dist/Misc/system_integrity.d.ts.map +1 -1
  68. package/dist/Misc/system_integrity.js +23 -21
  69. package/dist/Misc/system_integrity.js.map +1 -1
  70. package/dist/index.d.ts +45 -7
  71. package/dist/index.d.ts.map +1 -1
  72. package/dist/index.js +51 -7
  73. package/dist/index.js.map +1 -1
  74. package/dist/runCodeGen.d.ts +84 -6
  75. package/dist/runCodeGen.d.ts.map +1 -1
  76. package/dist/runCodeGen.js +242 -82
  77. package/dist/runCodeGen.js.map +1 -1
  78. package/package.json +14 -14
@@ -1,7 +1,17 @@
1
+ /**
2
+ * Configuration management module for MemberJunction CodeGen.
3
+ * Handles loading, parsing, and validation of configuration files using Zod schemas.
4
+ * Supports various configuration sources through cosmiconfig (package.json, .mjrc, etc.).
5
+ */
1
6
  import { z } from 'zod';
7
+ /**
8
+ * Represents a general configuration setting with name-value pairs
9
+ */
2
10
  export type SettingInfo = z.infer<typeof settingInfoSchema>;
3
11
  declare const settingInfoSchema: z.ZodObject<{
12
+ /** The name/key of the setting */
4
13
  name: z.ZodString;
14
+ /** The value of the setting (can be any type) */
5
15
  value: z.ZodAny;
6
16
  }, "strip", z.ZodTypeAny, {
7
17
  name: string;
@@ -10,10 +20,16 @@ declare const settingInfoSchema: z.ZodObject<{
10
20
  name: string;
11
21
  value?: any;
12
22
  }>;
23
+ /**
24
+ * Configuration for logging behavior during code generation
25
+ */
13
26
  export type LogInfo = z.infer<typeof logInfoSchema>;
14
27
  declare const logInfoSchema: z.ZodObject<{
28
+ /** Whether logging is enabled */
15
29
  log: z.ZodDefault<z.ZodBoolean>;
30
+ /** File path for log output */
16
31
  logFile: z.ZodDefault<z.ZodString>;
32
+ /** Whether to also log to console */
17
33
  console: z.ZodDefault<z.ZodBoolean>;
18
34
  }, "strip", z.ZodTypeAny, {
19
35
  log: boolean;
@@ -24,9 +40,14 @@ declare const logInfoSchema: z.ZodObject<{
24
40
  logFile?: string | undefined;
25
41
  console?: boolean | undefined;
26
42
  }>;
43
+ /**
44
+ * Configuration for custom SQL scripts to run at specific times during code generation
45
+ */
27
46
  export type CustomSQLScript = z.infer<typeof customSQLScriptSchema>;
28
47
  declare const customSQLScriptSchema: z.ZodObject<{
48
+ /** When to run the script (e.g., 'before-all', 'after-all') */
29
49
  when: z.ZodString;
50
+ /** Path to the SQL script file */
30
51
  scriptFile: z.ZodString;
31
52
  }, "strip", z.ZodTypeAny, {
32
53
  when: string;
@@ -35,29 +56,42 @@ declare const customSQLScriptSchema: z.ZodObject<{
35
56
  when: string;
36
57
  scriptFile: string;
37
58
  }>;
59
+ /**
60
+ * Configuration for external commands to run during code generation
61
+ */
38
62
  export type CommandInfo = z.infer<typeof commandInfoSchema>;
39
63
  declare const commandInfoSchema: z.ZodObject<{
64
+ /** Working directory to run the command from */
40
65
  workingDirectory: z.ZodString;
66
+ /** The command to execute */
41
67
  command: z.ZodString;
68
+ /** Command line arguments */
42
69
  args: z.ZodArray<z.ZodString, "many">;
70
+ /** Optional timeout in milliseconds */
43
71
  timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
72
+ /** When to run the command (e.g., 'before', 'after') */
44
73
  when: z.ZodString;
45
74
  }, "strip", z.ZodTypeAny, {
46
- args: string[];
47
75
  when: string;
48
76
  workingDirectory: string;
49
77
  command: string;
78
+ args: string[];
50
79
  timeout?: number | null | undefined;
51
80
  }, {
52
- args: string[];
53
81
  when: string;
54
82
  workingDirectory: string;
55
83
  command: string;
84
+ args: string[];
56
85
  timeout?: number | null | undefined;
57
86
  }>;
87
+ /**
88
+ * Configuration option for output generation
89
+ */
58
90
  export type OutputOptionInfo = z.infer<typeof outputOptionInfoSchema>;
59
91
  declare const outputOptionInfoSchema: z.ZodObject<{
92
+ /** Name of the output option */
60
93
  name: z.ZodString;
94
+ /** Value of the output option */
61
95
  value: z.ZodAny;
62
96
  }, "strip", z.ZodTypeAny, {
63
97
  name: string;
@@ -66,13 +100,22 @@ declare const outputOptionInfoSchema: z.ZodObject<{
66
100
  name: string;
67
101
  value?: any;
68
102
  }>;
103
+ /**
104
+ * Configuration for code generation output destinations and options
105
+ */
69
106
  export type OutputInfo = z.infer<typeof outputInfoSchema>;
70
107
  declare const outputInfoSchema: z.ZodObject<{
108
+ /** Type of output (e.g., 'SQL', 'Angular', 'GraphQLServer') */
71
109
  type: z.ZodString;
110
+ /** Directory path for output files */
72
111
  directory: z.ZodString;
112
+ /** Whether to append additional output code subdirectory */
73
113
  appendOutputCode: z.ZodOptional<z.ZodBoolean>;
114
+ /** Additional options for this output type */
74
115
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
116
+ /** Name of the output option */
75
117
  name: z.ZodString;
118
+ /** Value of the output option */
76
119
  value: z.ZodAny;
77
120
  }, "strip", z.ZodTypeAny, {
78
121
  name: string;
@@ -98,22 +141,34 @@ declare const outputInfoSchema: z.ZodObject<{
98
141
  }[] | undefined;
99
142
  appendOutputCode?: boolean | undefined;
100
143
  }>;
144
+ /**
145
+ * Information about a database table for exclusion or filtering
146
+ */
101
147
  export type TableInfo = z.infer<typeof tableInfoSchema>;
102
148
  declare const tableInfoSchema: z.ZodObject<{
149
+ /** Schema name (supports wildcards like '%') */
103
150
  schema: z.ZodString;
151
+ /** Table name (supports wildcards like 'sys%') */
104
152
  table: z.ZodString;
105
153
  }, "strip", z.ZodTypeAny, {
106
- table: string;
107
154
  schema: string;
108
- }, {
109
155
  table: string;
156
+ }, {
110
157
  schema: string;
158
+ table: string;
111
159
  }>;
160
+ /**
161
+ * Configuration bundle for generating database schema JSON output
162
+ */
112
163
  export type DBSchemaJSONOutputBundle = z.infer<typeof dbSchemaJSONOutputBundleSchema>;
113
164
  declare const dbSchemaJSONOutputBundleSchema: z.ZodObject<{
165
+ /** Name of the bundle */
114
166
  name: z.ZodString;
167
+ /** Schemas to include in this bundle */
115
168
  schemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
169
+ /** Schemas to exclude from this bundle */
116
170
  excludeSchemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
171
+ /** Entities to exclude from this bundle */
117
172
  excludeEntities: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
118
173
  }, "strip", z.ZodTypeAny, {
119
174
  name: string;
@@ -131,9 +186,13 @@ declare const dbSchemaJSONOutputSchema: z.ZodObject<{
131
186
  excludeEntities: z.ZodArray<z.ZodString, "many">;
132
187
  excludeSchemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
133
188
  bundles: z.ZodDefault<z.ZodArray<z.ZodObject<{
189
+ /** Name of the bundle */
134
190
  name: z.ZodString;
191
+ /** Schemas to include in this bundle */
135
192
  schemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
193
+ /** Schemas to exclude from this bundle */
136
194
  excludeSchemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
195
+ /** Entities to exclude from this bundle */
137
196
  excludeEntities: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
138
197
  }, "strip", z.ZodTypeAny, {
139
198
  name: string;
@@ -191,9 +250,14 @@ declare const newUserSetupSchema: z.ZodObject<{
191
250
  CreateUserApplicationRecords?: boolean | undefined;
192
251
  UserApplications?: string[] | undefined;
193
252
  }>;
253
+ /**
254
+ * Configuration option for an advanced generation feature
255
+ */
194
256
  export type AdvancedGenerationFeatureOption = z.infer<typeof advancedGenerationFeatureOptionSchema>;
195
257
  declare const advancedGenerationFeatureOptionSchema: z.ZodObject<{
258
+ /** Name of the option */
196
259
  name: z.ZodString;
260
+ /** Value of the option (can be any type) */
197
261
  value: z.ZodUnknown;
198
262
  }, "strip", z.ZodTypeAny, {
199
263
  name: string;
@@ -202,15 +266,26 @@ declare const advancedGenerationFeatureOptionSchema: z.ZodObject<{
202
266
  name: string;
203
267
  value?: unknown;
204
268
  }>;
269
+ /**
270
+ * Configuration for an AI-powered advanced generation feature
271
+ */
205
272
  export type AdvancedGenerationFeature = z.infer<typeof advancedGenerationFeatureSchema>;
206
273
  declare const advancedGenerationFeatureSchema: z.ZodObject<{
274
+ /** Name of the feature */
207
275
  name: z.ZodString;
276
+ /** Whether the feature is enabled */
208
277
  enabled: z.ZodBoolean;
278
+ /** Description for documentation (not used by code) */
209
279
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
280
+ /** System prompt for AI interaction */
210
281
  systemPrompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
282
+ /** User message template for AI interaction */
211
283
  userMessage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
284
+ /** Additional options for the feature */
212
285
  options: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
286
+ /** Name of the option */
213
287
  name: z.ZodString;
288
+ /** Value of the option (can be any type) */
214
289
  value: z.ZodUnknown;
215
290
  }, "strip", z.ZodTypeAny, {
216
291
  name: string;
@@ -246,13 +321,21 @@ declare const advancedGenerationSchema: z.ZodObject<{
246
321
  AIVendor: z.ZodDefault<z.ZodEnum<["openai", "anthropic", "mistral", "groq"]>>;
247
322
  AIModel: z.ZodDefault<z.ZodString>;
248
323
  features: z.ZodDefault<z.ZodArray<z.ZodObject<{
324
+ /** Name of the feature */
249
325
  name: z.ZodString;
326
+ /** Whether the feature is enabled */
250
327
  enabled: z.ZodBoolean;
328
+ /** Description for documentation (not used by code) */
251
329
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
330
+ /** System prompt for AI interaction */
252
331
  systemPrompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
332
+ /** User message template for AI interaction */
253
333
  userMessage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
334
+ /** Additional options for the feature */
254
335
  options: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
336
+ /** Name of the option */
255
337
  name: z.ZodString;
338
+ /** Value of the option (can be any type) */
256
339
  value: z.ZodUnknown;
257
340
  }, "strip", z.ZodTypeAny, {
258
341
  name: string;
@@ -324,6 +407,59 @@ declare const integrityCheckConfigSchema: z.ZodObject<{
324
407
  enabled: boolean;
325
408
  entityFieldsSequenceCheck: boolean;
326
409
  }>;
410
+ export type ForceRegenerationConfig = z.infer<typeof forceRegenerationConfigSchema>;
411
+ declare const forceRegenerationConfigSchema: z.ZodObject<{
412
+ /**
413
+ * Force regeneration of all SQL objects even if no schema changes are detected
414
+ */
415
+ enabled: z.ZodDefault<z.ZodBoolean>;
416
+ /**
417
+ * Force regeneration of base views
418
+ */
419
+ baseViews: z.ZodDefault<z.ZodBoolean>;
420
+ /**
421
+ * Force regeneration of spCreate procedures
422
+ */
423
+ spCreate: z.ZodDefault<z.ZodBoolean>;
424
+ /**
425
+ * Force regeneration of spUpdate procedures
426
+ */
427
+ spUpdate: z.ZodDefault<z.ZodBoolean>;
428
+ /**
429
+ * Force regeneration of spDelete procedures
430
+ */
431
+ spDelete: z.ZodDefault<z.ZodBoolean>;
432
+ /**
433
+ * Force regeneration of all stored procedures
434
+ */
435
+ allStoredProcedures: z.ZodDefault<z.ZodBoolean>;
436
+ /**
437
+ * Force regeneration of indexes for foreign keys
438
+ */
439
+ indexes: z.ZodDefault<z.ZodBoolean>;
440
+ /**
441
+ * Force regeneration of full text search components
442
+ */
443
+ fullTextSearch: z.ZodDefault<z.ZodBoolean>;
444
+ }, "strip", z.ZodTypeAny, {
445
+ enabled: boolean;
446
+ baseViews: boolean;
447
+ spCreate: boolean;
448
+ spUpdate: boolean;
449
+ spDelete: boolean;
450
+ allStoredProcedures: boolean;
451
+ indexes: boolean;
452
+ fullTextSearch: boolean;
453
+ }, {
454
+ enabled?: boolean | undefined;
455
+ baseViews?: boolean | undefined;
456
+ spCreate?: boolean | undefined;
457
+ spUpdate?: boolean | undefined;
458
+ spDelete?: boolean | undefined;
459
+ allStoredProcedures?: boolean | undefined;
460
+ indexes?: boolean | undefined;
461
+ fullTextSearch?: boolean | undefined;
462
+ }>;
327
463
  export type SQLOutputConfig = z.infer<typeof sqlOutputConfigSchema>;
328
464
  declare const sqlOutputConfigSchema: z.ZodObject<{
329
465
  /**
@@ -394,6 +530,9 @@ declare const entityPermissionSchema: z.ZodObject<{
394
530
  CanUpdate: boolean;
395
531
  CanDelete: boolean;
396
532
  }>;
533
+ /**
534
+ * Permission settings for an entity role
535
+ */
397
536
  export type EntityPermission = z.infer<typeof entityPermissionSchema>;
398
537
  declare const newEntityPermissionDefaultsSchema: z.ZodObject<{
399
538
  AutoAddPermissionsForNewEntities: z.ZodDefault<z.ZodBoolean>;
@@ -435,6 +574,9 @@ declare const newEntityPermissionDefaultsSchema: z.ZodObject<{
435
574
  CanDelete: boolean;
436
575
  }[] | undefined;
437
576
  }>;
577
+ /**
578
+ * Default permission settings for new entities
579
+ */
438
580
  export type NewEntityPermissionDefaults = z.infer<typeof newEntityPermissionDefaultsSchema>;
439
581
  export type EntityNameRulesBySchema = z.infer<typeof newEntityNameRulesBySchema>;
440
582
  declare const newEntityNameRulesBySchema: z.ZodObject<{
@@ -584,7 +726,13 @@ declare const newEntityRelationshipDefaultsSchema: z.ZodObject<{
584
726
  AutomaticallyCreateRelationships?: boolean | undefined;
585
727
  CreateOneToManyRelationships?: boolean | undefined;
586
728
  }>;
729
+ /**
730
+ * Default settings applied when creating new entities
731
+ */
587
732
  export type NewEntityDefaults = z.infer<typeof newEntityDefaultsSchema>;
733
+ /**
734
+ * Main configuration object containing all CodeGen settings
735
+ */
588
736
  export type ConfigInfo = z.infer<typeof configInfoSchema>;
589
737
  declare const configInfoSchema: z.ZodObject<{
590
738
  newUserSetup: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -613,7 +761,9 @@ declare const configInfoSchema: z.ZodObject<{
613
761
  UserApplications?: string[] | undefined;
614
762
  }>>>;
615
763
  settings: z.ZodDefault<z.ZodArray<z.ZodObject<{
764
+ /** The name/key of the setting */
616
765
  name: z.ZodString;
766
+ /** The value of the setting (can be any type) */
617
767
  value: z.ZodAny;
618
768
  }, "strip", z.ZodTypeAny, {
619
769
  name: string;
@@ -624,17 +774,21 @@ declare const configInfoSchema: z.ZodObject<{
624
774
  }>, "many">>;
625
775
  excludeSchemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
626
776
  excludeTables: z.ZodDefault<z.ZodArray<z.ZodObject<{
777
+ /** Schema name (supports wildcards like '%') */
627
778
  schema: z.ZodString;
779
+ /** Table name (supports wildcards like 'sys%') */
628
780
  table: z.ZodString;
629
781
  }, "strip", z.ZodTypeAny, {
630
- table: string;
631
782
  schema: string;
632
- }, {
633
783
  table: string;
784
+ }, {
634
785
  schema: string;
786
+ table: string;
635
787
  }>, "many">>;
636
788
  customSQLScripts: z.ZodDefault<z.ZodArray<z.ZodObject<{
789
+ /** When to run the script (e.g., 'before-all', 'after-all') */
637
790
  when: z.ZodString;
791
+ /** Path to the SQL script file */
638
792
  scriptFile: z.ZodString;
639
793
  }, "strip", z.ZodTypeAny, {
640
794
  when: string;
@@ -648,13 +802,21 @@ declare const configInfoSchema: z.ZodObject<{
648
802
  AIVendor: z.ZodDefault<z.ZodEnum<["openai", "anthropic", "mistral", "groq"]>>;
649
803
  AIModel: z.ZodDefault<z.ZodString>;
650
804
  features: z.ZodDefault<z.ZodArray<z.ZodObject<{
805
+ /** Name of the feature */
651
806
  name: z.ZodString;
807
+ /** Whether the feature is enabled */
652
808
  enabled: z.ZodBoolean;
809
+ /** Description for documentation (not used by code) */
653
810
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
811
+ /** System prompt for AI interaction */
654
812
  systemPrompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
813
+ /** User message template for AI interaction */
655
814
  userMessage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
815
+ /** Additional options for the feature */
656
816
  options: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
817
+ /** Name of the option */
657
818
  name: z.ZodString;
819
+ /** Value of the option (can be any type) */
658
820
  value: z.ZodUnknown;
659
821
  }, "strip", z.ZodTypeAny, {
660
822
  name: string;
@@ -726,11 +888,17 @@ declare const configInfoSchema: z.ZodObject<{
726
888
  entityFieldsSequenceCheck: boolean;
727
889
  }>>;
728
890
  output: z.ZodDefault<z.ZodArray<z.ZodObject<{
891
+ /** Type of output (e.g., 'SQL', 'Angular', 'GraphQLServer') */
729
892
  type: z.ZodString;
893
+ /** Directory path for output files */
730
894
  directory: z.ZodString;
895
+ /** Whether to append additional output code subdirectory */
731
896
  appendOutputCode: z.ZodOptional<z.ZodBoolean>;
897
+ /** Additional options for this output type */
732
898
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
899
+ /** Name of the output option */
733
900
  name: z.ZodString;
901
+ /** Value of the output option */
734
902
  value: z.ZodAny;
735
903
  }, "strip", z.ZodTypeAny, {
736
904
  name: string;
@@ -757,27 +925,35 @@ declare const configInfoSchema: z.ZodObject<{
757
925
  appendOutputCode?: boolean | undefined;
758
926
  }>, "many">>;
759
927
  commands: z.ZodDefault<z.ZodArray<z.ZodObject<{
928
+ /** Working directory to run the command from */
760
929
  workingDirectory: z.ZodString;
930
+ /** The command to execute */
761
931
  command: z.ZodString;
932
+ /** Command line arguments */
762
933
  args: z.ZodArray<z.ZodString, "many">;
934
+ /** Optional timeout in milliseconds */
763
935
  timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
936
+ /** When to run the command (e.g., 'before', 'after') */
764
937
  when: z.ZodString;
765
938
  }, "strip", z.ZodTypeAny, {
766
- args: string[];
767
939
  when: string;
768
940
  workingDirectory: string;
769
941
  command: string;
942
+ args: string[];
770
943
  timeout?: number | null | undefined;
771
944
  }, {
772
- args: string[];
773
945
  when: string;
774
946
  workingDirectory: string;
775
947
  command: string;
948
+ args: string[];
776
949
  timeout?: number | null | undefined;
777
950
  }>, "many">>;
778
951
  logging: z.ZodObject<{
952
+ /** Whether logging is enabled */
779
953
  log: z.ZodDefault<z.ZodBoolean>;
954
+ /** File path for log output */
780
955
  logFile: z.ZodDefault<z.ZodString>;
956
+ /** Whether to also log to console */
781
957
  console: z.ZodDefault<z.ZodBoolean>;
782
958
  }, "strip", z.ZodTypeAny, {
783
959
  log: boolean;
@@ -922,9 +1098,13 @@ declare const configInfoSchema: z.ZodObject<{
922
1098
  excludeEntities: z.ZodArray<z.ZodString, "many">;
923
1099
  excludeSchemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
924
1100
  bundles: z.ZodDefault<z.ZodArray<z.ZodObject<{
1101
+ /** Name of the bundle */
925
1102
  name: z.ZodString;
1103
+ /** Schemas to include in this bundle */
926
1104
  schemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
1105
+ /** Schemas to exclude from this bundle */
927
1106
  excludeSchemas: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
1107
+ /** Entities to exclude from this bundle */
928
1108
  excludeEntities: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
929
1109
  }, "strip", z.ZodTypeAny, {
930
1110
  name: string;
@@ -1008,35 +1188,78 @@ declare const configInfoSchema: z.ZodObject<{
1008
1188
  convertCoreSchemaToFlywayMigrationFile?: boolean | undefined;
1009
1189
  omitRecurringScriptsFromLog?: boolean | undefined;
1010
1190
  }>;
1191
+ forceRegeneration: z.ZodObject<{
1192
+ /**
1193
+ * Force regeneration of all SQL objects even if no schema changes are detected
1194
+ */
1195
+ enabled: z.ZodDefault<z.ZodBoolean>;
1196
+ /**
1197
+ * Force regeneration of base views
1198
+ */
1199
+ baseViews: z.ZodDefault<z.ZodBoolean>;
1200
+ /**
1201
+ * Force regeneration of spCreate procedures
1202
+ */
1203
+ spCreate: z.ZodDefault<z.ZodBoolean>;
1204
+ /**
1205
+ * Force regeneration of spUpdate procedures
1206
+ */
1207
+ spUpdate: z.ZodDefault<z.ZodBoolean>;
1208
+ /**
1209
+ * Force regeneration of spDelete procedures
1210
+ */
1211
+ spDelete: z.ZodDefault<z.ZodBoolean>;
1212
+ /**
1213
+ * Force regeneration of all stored procedures
1214
+ */
1215
+ allStoredProcedures: z.ZodDefault<z.ZodBoolean>;
1216
+ /**
1217
+ * Force regeneration of indexes for foreign keys
1218
+ */
1219
+ indexes: z.ZodDefault<z.ZodBoolean>;
1220
+ /**
1221
+ * Force regeneration of full text search components
1222
+ */
1223
+ fullTextSearch: z.ZodDefault<z.ZodBoolean>;
1224
+ }, "strip", z.ZodTypeAny, {
1225
+ enabled: boolean;
1226
+ baseViews: boolean;
1227
+ spCreate: boolean;
1228
+ spUpdate: boolean;
1229
+ spDelete: boolean;
1230
+ allStoredProcedures: boolean;
1231
+ indexes: boolean;
1232
+ fullTextSearch: boolean;
1233
+ }, {
1234
+ enabled?: boolean | undefined;
1235
+ baseViews?: boolean | undefined;
1236
+ spCreate?: boolean | undefined;
1237
+ spUpdate?: boolean | undefined;
1238
+ spDelete?: boolean | undefined;
1239
+ allStoredProcedures?: boolean | undefined;
1240
+ indexes?: boolean | undefined;
1241
+ fullTextSearch?: boolean | undefined;
1242
+ }>;
1011
1243
  dbHost: z.ZodString;
1012
1244
  dbPort: z.ZodDefault<z.ZodNumber>;
1013
1245
  codeGenLogin: z.ZodString;
1014
1246
  codeGenPassword: z.ZodString;
1015
1247
  dbDatabase: z.ZodString;
1016
1248
  dbInstanceName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1017
- dbTrustServerCertificate: z.ZodEffects<z.ZodDefault<z.ZodBoolean>, "N" | "Y", boolean | undefined>;
1249
+ dbTrustServerCertificate: z.ZodEffects<z.ZodDefault<z.ZodBoolean>, "Y" | "N", boolean | undefined>;
1018
1250
  outputCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1019
1251
  mjCoreSchema: z.ZodDefault<z.ZodString>;
1020
1252
  graphqlPort: z.ZodDefault<z.ZodNumber>;
1021
1253
  verboseOutput: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
1022
1254
  }, "strip", z.ZodTypeAny, {
1023
- output: {
1024
- type: string;
1025
- directory: string;
1026
- options?: {
1027
- name: string;
1028
- value?: any;
1029
- }[] | undefined;
1030
- appendOutputCode?: boolean | undefined;
1031
- }[];
1032
1255
  settings: {
1033
1256
  name: string;
1034
1257
  value?: any;
1035
1258
  }[];
1036
1259
  excludeSchemas: string[];
1037
1260
  excludeTables: {
1038
- table: string;
1039
1261
  schema: string;
1262
+ table: string;
1040
1263
  }[];
1041
1264
  customSQLScripts: {
1042
1265
  when: string;
@@ -1046,11 +1269,20 @@ declare const configInfoSchema: z.ZodObject<{
1046
1269
  enabled: boolean;
1047
1270
  entityFieldsSequenceCheck: boolean;
1048
1271
  };
1272
+ output: {
1273
+ type: string;
1274
+ directory: string;
1275
+ options?: {
1276
+ name: string;
1277
+ value?: any;
1278
+ }[] | undefined;
1279
+ appendOutputCode?: boolean | undefined;
1280
+ }[];
1049
1281
  commands: {
1050
- args: string[];
1051
1282
  when: string;
1052
1283
  workingDirectory: string;
1053
1284
  command: string;
1285
+ args: string[];
1054
1286
  timeout?: number | null | undefined;
1055
1287
  }[];
1056
1288
  logging: {
@@ -1112,12 +1344,22 @@ declare const configInfoSchema: z.ZodObject<{
1112
1344
  omitRecurringScriptsFromLog: boolean;
1113
1345
  fileName?: string | undefined;
1114
1346
  };
1347
+ forceRegeneration: {
1348
+ enabled: boolean;
1349
+ baseViews: boolean;
1350
+ spCreate: boolean;
1351
+ spUpdate: boolean;
1352
+ spDelete: boolean;
1353
+ allStoredProcedures: boolean;
1354
+ indexes: boolean;
1355
+ fullTextSearch: boolean;
1356
+ };
1115
1357
  dbHost: string;
1116
1358
  dbPort: number;
1117
1359
  codeGenLogin: string;
1118
1360
  codeGenPassword: string;
1119
1361
  dbDatabase: string;
1120
- dbTrustServerCertificate: "N" | "Y";
1362
+ dbTrustServerCertificate: "Y" | "N";
1121
1363
  mjCoreSchema: string;
1122
1364
  graphqlPort: number;
1123
1365
  verboseOutput: boolean;
@@ -1208,19 +1450,20 @@ declare const configInfoSchema: z.ZodObject<{
1208
1450
  convertCoreSchemaToFlywayMigrationFile?: boolean | undefined;
1209
1451
  omitRecurringScriptsFromLog?: boolean | undefined;
1210
1452
  };
1453
+ forceRegeneration: {
1454
+ enabled?: boolean | undefined;
1455
+ baseViews?: boolean | undefined;
1456
+ spCreate?: boolean | undefined;
1457
+ spUpdate?: boolean | undefined;
1458
+ spDelete?: boolean | undefined;
1459
+ allStoredProcedures?: boolean | undefined;
1460
+ indexes?: boolean | undefined;
1461
+ fullTextSearch?: boolean | undefined;
1462
+ };
1211
1463
  dbHost: string;
1212
1464
  codeGenLogin: string;
1213
1465
  codeGenPassword: string;
1214
1466
  dbDatabase: string;
1215
- output?: {
1216
- type: string;
1217
- directory: string;
1218
- options?: {
1219
- name: string;
1220
- value?: any;
1221
- }[] | undefined;
1222
- appendOutputCode?: boolean | undefined;
1223
- }[] | undefined;
1224
1467
  newUserSetup?: {
1225
1468
  UserName: string;
1226
1469
  FirstName: string;
@@ -1236,8 +1479,8 @@ declare const configInfoSchema: z.ZodObject<{
1236
1479
  }[] | undefined;
1237
1480
  excludeSchemas?: string[] | undefined;
1238
1481
  excludeTables?: {
1239
- table: string;
1240
1482
  schema: string;
1483
+ table: string;
1241
1484
  }[] | undefined;
1242
1485
  customSQLScripts?: {
1243
1486
  when: string;
@@ -1263,11 +1506,20 @@ declare const configInfoSchema: z.ZodObject<{
1263
1506
  enabled: boolean;
1264
1507
  entityFieldsSequenceCheck: boolean;
1265
1508
  } | undefined;
1509
+ output?: {
1510
+ type: string;
1511
+ directory: string;
1512
+ options?: {
1513
+ name: string;
1514
+ value?: any;
1515
+ }[] | undefined;
1516
+ appendOutputCode?: boolean | undefined;
1517
+ }[] | undefined;
1266
1518
  commands?: {
1267
- args: string[];
1268
1519
  when: string;
1269
1520
  workingDirectory: string;
1270
1521
  command: string;
1522
+ args: string[];
1271
1523
  timeout?: number | null | undefined;
1272
1524
  }[] | undefined;
1273
1525
  dbPort?: number | undefined;
@@ -1278,25 +1530,22 @@ declare const configInfoSchema: z.ZodObject<{
1278
1530
  graphqlPort?: number | undefined;
1279
1531
  verboseOutput?: boolean | undefined;
1280
1532
  }>;
1533
+ /**
1534
+ * Current working directory for the code generation process
1535
+ */
1281
1536
  export declare let currentWorkingDirectory: string;
1537
+ /**
1538
+ * Parsed configuration object with fallback to empty object if parsing fails
1539
+ */
1282
1540
  export declare const configInfo: {
1283
- output: {
1284
- type: string;
1285
- directory: string;
1286
- options?: {
1287
- name: string;
1288
- value?: any;
1289
- }[] | undefined;
1290
- appendOutputCode?: boolean | undefined;
1291
- }[];
1292
1541
  settings: {
1293
1542
  name: string;
1294
1543
  value?: any;
1295
1544
  }[];
1296
1545
  excludeSchemas: string[];
1297
1546
  excludeTables: {
1298
- table: string;
1299
1547
  schema: string;
1548
+ table: string;
1300
1549
  }[];
1301
1550
  customSQLScripts: {
1302
1551
  when: string;
@@ -1306,11 +1555,20 @@ export declare const configInfo: {
1306
1555
  enabled: boolean;
1307
1556
  entityFieldsSequenceCheck: boolean;
1308
1557
  };
1558
+ output: {
1559
+ type: string;
1560
+ directory: string;
1561
+ options?: {
1562
+ name: string;
1563
+ value?: any;
1564
+ }[] | undefined;
1565
+ appendOutputCode?: boolean | undefined;
1566
+ }[];
1309
1567
  commands: {
1310
- args: string[];
1311
1568
  when: string;
1312
1569
  workingDirectory: string;
1313
1570
  command: string;
1571
+ args: string[];
1314
1572
  timeout?: number | null | undefined;
1315
1573
  }[];
1316
1574
  logging: {
@@ -1372,12 +1630,22 @@ export declare const configInfo: {
1372
1630
  omitRecurringScriptsFromLog: boolean;
1373
1631
  fileName?: string | undefined;
1374
1632
  };
1633
+ forceRegeneration: {
1634
+ enabled: boolean;
1635
+ baseViews: boolean;
1636
+ spCreate: boolean;
1637
+ spUpdate: boolean;
1638
+ spDelete: boolean;
1639
+ allStoredProcedures: boolean;
1640
+ indexes: boolean;
1641
+ fullTextSearch: boolean;
1642
+ };
1375
1643
  dbHost: string;
1376
1644
  dbPort: number;
1377
1645
  codeGenLogin: string;
1378
1646
  codeGenPassword: string;
1379
1647
  dbDatabase: string;
1380
- dbTrustServerCertificate: "N" | "Y";
1648
+ dbTrustServerCertificate: "Y" | "N";
1381
1649
  mjCoreSchema: string;
1382
1650
  graphqlPort: number;
1383
1651
  verboseOutput: boolean;
@@ -1409,20 +1677,76 @@ export declare const configInfo: {
1409
1677
  dbInstanceName?: string | null | undefined;
1410
1678
  outputCode?: string | null | undefined;
1411
1679
  };
1680
+ /**
1681
+ * Destructured commonly used configuration values
1682
+ */
1412
1683
  export declare const mjCoreSchema: string, dbDatabase: string;
1684
+ /**
1685
+ * Initializes configuration from the specified working directory
1686
+ * @param cwd The current working directory to search for config files
1687
+ * @returns Parsed configuration object
1688
+ * @throws Error if no configuration is found
1689
+ */
1413
1690
  export declare function initializeConfig(cwd: string): ConfigInfo;
1691
+ /**
1692
+ * Gets the output directory for a specific generation type
1693
+ * @param type The type of output (e.g., 'SQL', 'Angular')
1694
+ * @param useLocalDirectoryIfMissing Whether to use a local directory if config is missing
1695
+ * @returns The output directory path or null if not found
1696
+ */
1414
1697
  export declare function outputDir(type: string, useLocalDirectoryIfMissing: boolean): string | null;
1698
+ /**
1699
+ * Gets the output options for a specific generation type
1700
+ * @param type The type of output
1701
+ * @returns Array of output options or null if not found
1702
+ */
1415
1703
  export declare function outputOptions(type: string): OutputOptionInfo[] | null;
1704
+ /**
1705
+ * Gets a specific output option value for a generation type
1706
+ * @param type The type of output
1707
+ * @param optionName The name of the option to retrieve
1708
+ * @param defaultValue Default value if option is not found
1709
+ * @returns The option value or default value
1710
+ */
1416
1711
  export declare function outputOptionValue(type: string, optionName: string, defaultValue?: any): any;
1712
+ /**
1713
+ * Gets commands configured to run at a specific time
1714
+ * @param when When the commands should run (e.g., 'before', 'after')
1715
+ * @returns Array of commands to execute
1716
+ */
1417
1717
  export declare function commands(when: string): CommandInfo[];
1718
+ /**
1719
+ * Gets custom SQL scripts configured to run at a specific time
1720
+ * @param when When the scripts should run
1721
+ * @returns Array of SQL scripts to execute
1722
+ */
1418
1723
  export declare function customSqlScripts(when: string): CustomSQLScript[];
1724
+ /**
1725
+ * Gets a specific setting by name
1726
+ * @param settingName The name of the setting to retrieve
1727
+ * @returns The setting object
1728
+ */
1419
1729
  export declare function getSetting(settingName: string): SettingInfo;
1730
+ /**
1731
+ * Gets the value of a specific setting
1732
+ * @param settingName The name of the setting
1733
+ * @param defaultValue Default value if setting is not found
1734
+ * @returns The setting value or default value
1735
+ */
1420
1736
  export declare function getSettingValue(settingName: string, defaultValue?: any): any;
1737
+ /**
1738
+ * Checks if automatic indexing of foreign keys is enabled
1739
+ * @returns True if auto-indexing is enabled, false otherwise
1740
+ */
1421
1741
  export declare function autoIndexForeignKeys(): boolean;
1422
1742
  /**
1423
- * Maximum length of the name of an index
1743
+ * Maximum length allowed for database index names
1424
1744
  */
1425
1745
  export declare const MAX_INDEX_NAME_LENGTH = 128;
1746
+ /**
1747
+ * Gets the MemberJunction core schema name from configuration
1748
+ * @returns The core schema name (typically '__mj')
1749
+ */
1426
1750
  export declare function mj_core_schema(): string;
1427
1751
  export {};
1428
1752
  //# sourceMappingURL=config.d.ts.map