@cuongph.dev/dbdocgen 0.1.0 → 0.1.1
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.
- package/README.md +97 -37
- package/dist/cli/index.cjs +1080 -163
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.js +1090 -172
- package/dist/cli/index.js.map +1 -1
- package/dist/index.cjs +1086 -198
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +1095 -206
- package/dist/index.js.map +1 -1
- package/package.json +15 -11
package/dist/index.d.cts
CHANGED
|
@@ -24,12 +24,17 @@ type ReviewTodo = {
|
|
|
24
24
|
type ColumnDoc = {
|
|
25
25
|
name: string;
|
|
26
26
|
type: string;
|
|
27
|
+
size?: string;
|
|
27
28
|
nullable: boolean;
|
|
28
29
|
defaultValue?: string;
|
|
30
|
+
minValue?: string;
|
|
31
|
+
maxValue?: string;
|
|
32
|
+
isUnique: boolean;
|
|
29
33
|
isPrimaryKey: boolean;
|
|
30
34
|
isForeignKey: boolean;
|
|
31
35
|
comment?: string;
|
|
32
36
|
description?: EnrichedText;
|
|
37
|
+
constraintNotes?: string[];
|
|
33
38
|
};
|
|
34
39
|
type ForeignKeyDoc = {
|
|
35
40
|
name?: string;
|
|
@@ -101,8 +106,12 @@ declare const databaseDocSchema: z.ZodObject<{
|
|
|
101
106
|
columns: z.ZodArray<z.ZodObject<{
|
|
102
107
|
name: z.ZodString;
|
|
103
108
|
type: z.ZodString;
|
|
109
|
+
size: z.ZodOptional<z.ZodString>;
|
|
104
110
|
nullable: z.ZodBoolean;
|
|
105
111
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
112
|
+
minValue: z.ZodOptional<z.ZodString>;
|
|
113
|
+
maxValue: z.ZodOptional<z.ZodString>;
|
|
114
|
+
isUnique: z.ZodBoolean;
|
|
106
115
|
isPrimaryKey: z.ZodBoolean;
|
|
107
116
|
isForeignKey: z.ZodBoolean;
|
|
108
117
|
comment: z.ZodOptional<z.ZodString>;
|
|
@@ -120,6 +129,7 @@ declare const databaseDocSchema: z.ZodObject<{
|
|
|
120
129
|
}>;
|
|
121
130
|
needsReview: z.ZodBoolean;
|
|
122
131
|
}, z.core.$strip>>;
|
|
132
|
+
constraintNotes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
123
133
|
}, z.core.$strip>>;
|
|
124
134
|
primaryKeys: z.ZodArray<z.ZodString>;
|
|
125
135
|
foreignKeys: z.ZodArray<z.ZodObject<{
|
package/dist/index.d.ts
CHANGED
|
@@ -24,12 +24,17 @@ type ReviewTodo = {
|
|
|
24
24
|
type ColumnDoc = {
|
|
25
25
|
name: string;
|
|
26
26
|
type: string;
|
|
27
|
+
size?: string;
|
|
27
28
|
nullable: boolean;
|
|
28
29
|
defaultValue?: string;
|
|
30
|
+
minValue?: string;
|
|
31
|
+
maxValue?: string;
|
|
32
|
+
isUnique: boolean;
|
|
29
33
|
isPrimaryKey: boolean;
|
|
30
34
|
isForeignKey: boolean;
|
|
31
35
|
comment?: string;
|
|
32
36
|
description?: EnrichedText;
|
|
37
|
+
constraintNotes?: string[];
|
|
33
38
|
};
|
|
34
39
|
type ForeignKeyDoc = {
|
|
35
40
|
name?: string;
|
|
@@ -101,8 +106,12 @@ declare const databaseDocSchema: z.ZodObject<{
|
|
|
101
106
|
columns: z.ZodArray<z.ZodObject<{
|
|
102
107
|
name: z.ZodString;
|
|
103
108
|
type: z.ZodString;
|
|
109
|
+
size: z.ZodOptional<z.ZodString>;
|
|
104
110
|
nullable: z.ZodBoolean;
|
|
105
111
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
112
|
+
minValue: z.ZodOptional<z.ZodString>;
|
|
113
|
+
maxValue: z.ZodOptional<z.ZodString>;
|
|
114
|
+
isUnique: z.ZodBoolean;
|
|
106
115
|
isPrimaryKey: z.ZodBoolean;
|
|
107
116
|
isForeignKey: z.ZodBoolean;
|
|
108
117
|
comment: z.ZodOptional<z.ZodString>;
|
|
@@ -120,6 +129,7 @@ declare const databaseDocSchema: z.ZodObject<{
|
|
|
120
129
|
}>;
|
|
121
130
|
needsReview: z.ZodBoolean;
|
|
122
131
|
}, z.core.$strip>>;
|
|
132
|
+
constraintNotes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
123
133
|
}, z.core.$strip>>;
|
|
124
134
|
primaryKeys: z.ZodArray<z.ZodString>;
|
|
125
135
|
foreignKeys: z.ZodArray<z.ZodObject<{
|