@postxl/schema 0.0.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 (75) hide show
  1. package/LICENSE +50 -0
  2. package/README.md +320 -0
  3. package/dist/enum/enum.brands.d.ts +11 -0
  4. package/dist/enum/enum.brands.js +19 -0
  5. package/dist/enum/enum.d.ts +49 -0
  6. package/dist/enum/enum.defaults.d.ts +41 -0
  7. package/dist/enum/enum.defaults.js +105 -0
  8. package/dist/enum/enum.js +6 -0
  9. package/dist/enum/enum.json-decoder.d.ts +61 -0
  10. package/dist/enum/enum.json-decoder.js +51 -0
  11. package/dist/enum/enum.transformer.d.ts +12 -0
  12. package/dist/enum/enum.transformer.js +76 -0
  13. package/dist/enum/enum.types.d.ts +14 -0
  14. package/dist/enum/enum.types.js +2 -0
  15. package/dist/enum/index.d.ts +6 -0
  16. package/dist/enum/index.js +22 -0
  17. package/dist/field/defaults.d.ts +12 -0
  18. package/dist/field/defaults.js +78 -0
  19. package/dist/field/discriminated-union.d.ts +125 -0
  20. package/dist/field/discriminated-union.js +207 -0
  21. package/dist/field/enum.d.ts +65 -0
  22. package/dist/field/enum.js +111 -0
  23. package/dist/field/field.d.ts +483 -0
  24. package/dist/field/field.js +68 -0
  25. package/dist/field/id.d.ts +152 -0
  26. package/dist/field/id.js +104 -0
  27. package/dist/field/index.d.ts +11 -0
  28. package/dist/field/index.js +27 -0
  29. package/dist/field/relation.d.ts +88 -0
  30. package/dist/field/relation.js +138 -0
  31. package/dist/field/scalar.d.ts +179 -0
  32. package/dist/field/scalar.js +197 -0
  33. package/dist/field/shared/brands.d.ts +38 -0
  34. package/dist/field/shared/brands.js +109 -0
  35. package/dist/field/shared/decoders.d.ts +17 -0
  36. package/dist/field/shared/decoders.js +88 -0
  37. package/dist/field/shared/seed.d.ts +32 -0
  38. package/dist/field/shared/seed.js +63 -0
  39. package/dist/field/shared/types.d.ts +73 -0
  40. package/dist/field/shared/types.js +2 -0
  41. package/dist/field/shared/utils.d.ts +26 -0
  42. package/dist/field/shared/utils.js +52 -0
  43. package/dist/index.d.ts +12 -0
  44. package/dist/index.js +25 -0
  45. package/dist/model/index.d.ts +5 -0
  46. package/dist/model/index.js +21 -0
  47. package/dist/model/model.brands.d.ts +7 -0
  48. package/dist/model/model.brands.js +10 -0
  49. package/dist/model/model.defaults.d.ts +28 -0
  50. package/dist/model/model.defaults.js +304 -0
  51. package/dist/model/model.json-decoder.d.ts +94 -0
  52. package/dist/model/model.json-decoder.js +107 -0
  53. package/dist/model/model.transformer.d.ts +93 -0
  54. package/dist/model/model.transformer.js +183 -0
  55. package/dist/model/model.types.d.ts +37 -0
  56. package/dist/model/model.types.js +2 -0
  57. package/dist/project-schema/project-schema.brands.d.ts +10 -0
  58. package/dist/project-schema/project-schema.brands.js +17 -0
  59. package/dist/project-schema/project-schema.defaults.d.ts +16 -0
  60. package/dist/project-schema/project-schema.defaults.js +53 -0
  61. package/dist/project-schema/project-schema.json-decoder.d.ts +285 -0
  62. package/dist/project-schema/project-schema.json-decoder.js +145 -0
  63. package/dist/project-schema/project-schema.transformer.d.ts +284 -0
  64. package/dist/project-schema/project-schema.transformer.js +444 -0
  65. package/dist/project-schema/project-schema.types.d.ts +77 -0
  66. package/dist/project-schema/project-schema.types.js +2 -0
  67. package/dist/samples/la.schema.json +2055 -0
  68. package/dist/samples/mca.schema.json +830 -0
  69. package/dist/samples/ring.schema.json +879 -0
  70. package/dist/samples/sample-schemas.d.ts +1896 -0
  71. package/dist/samples/sample-schemas.js +20 -0
  72. package/dist/samples/simple.schema.json +250 -0
  73. package/dist/samples/subex.schema.json +1188 -0
  74. package/dist/samples/usp-msm.schema.json +2515 -0
  75. package/package.json +57 -0
@@ -0,0 +1,284 @@
1
+ import { z } from 'zod';
2
+ import { ProjectSchemaJSON } from './project-schema.json-decoder';
3
+ import { ProjectSchema } from './project-schema.types';
4
+ export declare function transformProjectSchemaJSON(input: ProjectSchemaJSON, ctx: z.RefinementCtx): ProjectSchema;
5
+ /**
6
+ * Zod decoder that converts JSON (see `ProjectSchemaJSON`) to a `ProjectSchema`
7
+ */
8
+ export declare const zProjectSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
9
+ name: z.ZodString;
10
+ slug: z.ZodString;
11
+ description: z.ZodOptional<z.ZodString>;
12
+ projectType: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
13
+ kind: z.ZodLiteral<"standalone">;
14
+ }, "strip", z.ZodTypeAny, {
15
+ kind: "standalone";
16
+ }, {
17
+ kind: "standalone";
18
+ }>, z.ZodObject<{
19
+ kind: z.ZodLiteral<"workspace">;
20
+ projectDirectory: z.ZodString;
21
+ }, "strip", z.ZodTypeAny, {
22
+ kind: "workspace";
23
+ projectDirectory: string;
24
+ }, {
25
+ kind: "workspace";
26
+ projectDirectory: string;
27
+ }>]>>;
28
+ version: z.ZodOptional<z.ZodString>;
29
+ schemas: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
30
+ defaultSchema: z.ZodOptional<z.ZodString>;
31
+ systemUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
32
+ standardModels: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
33
+ models: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
34
+ name: z.ZodEffects<z.ZodString, string, string>;
35
+ description: z.ZodOptional<z.ZodString>;
36
+ isReadonly: z.ZodOptional<z.ZodBoolean>;
37
+ schema: z.ZodOptional<z.ZodString>;
38
+ databaseName: z.ZodOptional<z.ZodString>;
39
+ excelName: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
40
+ fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
41
+ name: z.ZodString;
42
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
43
+ name: z.ZodString;
44
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
45
+ name: z.ZodString;
46
+ }, z.ZodTypeAny, "passthrough">>, "many">>;
47
+ standardFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
48
+ defaultField: z.ZodOptional<z.ZodString>;
49
+ labelField: z.ZodOptional<z.ZodString>;
50
+ indexes: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodBranded<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, "PXL.FieldName">, "many">, "many">>;
51
+ seed: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
52
+ source: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
53
+ faker: z.ZodOptional<z.ZodObject<{
54
+ items: z.ZodOptional<z.ZodNumber>;
55
+ seed: z.ZodOptional<z.ZodNumber>;
56
+ }, "strip", z.ZodTypeAny, {
57
+ seed?: number | undefined;
58
+ items?: number | undefined;
59
+ }, {
60
+ seed?: number | undefined;
61
+ items?: number | undefined;
62
+ }>>;
63
+ }, "strip", z.ZodTypeAny, {
64
+ name: string;
65
+ description?: string | undefined;
66
+ schema?: string | undefined;
67
+ databaseName?: string | undefined;
68
+ excelName?: string | undefined;
69
+ isReadonly?: boolean | undefined;
70
+ faker?: {
71
+ seed?: number | undefined;
72
+ items?: number | undefined;
73
+ } | undefined;
74
+ seed?: any[] | undefined;
75
+ fields?: z.objectOutputType<{
76
+ name: z.ZodString;
77
+ }, z.ZodTypeAny, "passthrough">[] | undefined;
78
+ standardFields?: string[] | undefined;
79
+ defaultField?: string | undefined;
80
+ labelField?: string | undefined;
81
+ indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
82
+ source?: Record<string, unknown> | undefined;
83
+ }, {
84
+ name: string;
85
+ description?: string | undefined;
86
+ schema?: string | undefined;
87
+ databaseName?: string | undefined;
88
+ excelName?: string | undefined;
89
+ isReadonly?: boolean | undefined;
90
+ faker?: {
91
+ seed?: number | undefined;
92
+ items?: number | undefined;
93
+ } | undefined;
94
+ seed?: any[] | undefined;
95
+ fields?: z.objectInputType<{
96
+ name: z.ZodString;
97
+ }, z.ZodTypeAny, "passthrough">[] | undefined;
98
+ standardFields?: string[] | undefined;
99
+ defaultField?: string | undefined;
100
+ labelField?: string | undefined;
101
+ indexes?: string[][] | undefined;
102
+ source?: Record<string, unknown> | undefined;
103
+ }>, {
104
+ name: string;
105
+ description?: string | undefined;
106
+ schema?: string | undefined;
107
+ databaseName?: string | undefined;
108
+ excelName?: string | undefined;
109
+ isReadonly?: boolean | undefined;
110
+ faker?: {
111
+ seed?: number | undefined;
112
+ items?: number | undefined;
113
+ } | undefined;
114
+ seed?: any[] | undefined;
115
+ fields?: z.objectOutputType<{
116
+ name: z.ZodString;
117
+ }, z.ZodTypeAny, "passthrough">[] | undefined;
118
+ standardFields?: string[] | undefined;
119
+ defaultField?: string | undefined;
120
+ labelField?: string | undefined;
121
+ indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
122
+ source?: Record<string, unknown> | undefined;
123
+ }, unknown>, "many">>;
124
+ standardEnums: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
125
+ enums: z.ZodOptional<z.ZodArray<z.ZodObject<{
126
+ name: z.ZodEffects<z.ZodString, string, string>;
127
+ description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
128
+ schema: z.ZodOptional<z.ZodString>;
129
+ databaseName: z.ZodOptional<z.ZodString>;
130
+ members: z.ZodArray<z.ZodUnion<[z.ZodObject<{
131
+ value: z.ZodString;
132
+ description: z.ZodOptional<z.ZodString>;
133
+ }, "strip", z.ZodTypeAny, {
134
+ value: string;
135
+ description?: string | undefined;
136
+ }, {
137
+ value: string;
138
+ description?: string | undefined;
139
+ }>, z.ZodString]>, "many">;
140
+ }, "strip", z.ZodTypeAny, {
141
+ description: string;
142
+ name: string;
143
+ members: (string | {
144
+ value: string;
145
+ description?: string | undefined;
146
+ })[];
147
+ schema?: string | undefined;
148
+ databaseName?: string | undefined;
149
+ }, {
150
+ name: string;
151
+ members: (string | {
152
+ value: string;
153
+ description?: string | undefined;
154
+ })[];
155
+ description?: string | undefined;
156
+ schema?: string | undefined;
157
+ databaseName?: string | undefined;
158
+ }>, "many">>;
159
+ source: z.ZodRecord<z.ZodString, z.ZodUnknown>;
160
+ }, "strip", z.ZodTypeAny, {
161
+ name: string;
162
+ source: Record<string, unknown>;
163
+ slug: string;
164
+ description?: string | undefined;
165
+ version?: string | undefined;
166
+ projectType?: {
167
+ kind: "standalone";
168
+ } | {
169
+ kind: "workspace";
170
+ projectDirectory: string;
171
+ } | undefined;
172
+ schemas?: string[] | undefined;
173
+ defaultSchema?: string | undefined;
174
+ systemUser?: Record<string, any> | undefined;
175
+ standardModels?: string[] | undefined;
176
+ models?: {
177
+ name: string;
178
+ description?: string | undefined;
179
+ schema?: string | undefined;
180
+ databaseName?: string | undefined;
181
+ excelName?: string | undefined;
182
+ isReadonly?: boolean | undefined;
183
+ faker?: {
184
+ seed?: number | undefined;
185
+ items?: number | undefined;
186
+ } | undefined;
187
+ seed?: any[] | undefined;
188
+ fields?: z.objectOutputType<{
189
+ name: z.ZodString;
190
+ }, z.ZodTypeAny, "passthrough">[] | undefined;
191
+ standardFields?: string[] | undefined;
192
+ defaultField?: string | undefined;
193
+ labelField?: string | undefined;
194
+ indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
195
+ source?: Record<string, unknown> | undefined;
196
+ }[] | undefined;
197
+ standardEnums?: string[] | undefined;
198
+ enums?: {
199
+ description: string;
200
+ name: string;
201
+ members: (string | {
202
+ value: string;
203
+ description?: string | undefined;
204
+ })[];
205
+ schema?: string | undefined;
206
+ databaseName?: string | undefined;
207
+ }[] | undefined;
208
+ }, {
209
+ name: string;
210
+ source: Record<string, unknown>;
211
+ slug: string;
212
+ description?: string | undefined;
213
+ version?: string | undefined;
214
+ projectType?: {
215
+ kind: "standalone";
216
+ } | {
217
+ kind: "workspace";
218
+ projectDirectory: string;
219
+ } | undefined;
220
+ schemas?: string[] | undefined;
221
+ defaultSchema?: string | undefined;
222
+ systemUser?: Record<string, any> | undefined;
223
+ standardModels?: string[] | undefined;
224
+ models?: unknown[] | undefined;
225
+ standardEnums?: string[] | undefined;
226
+ enums?: {
227
+ name: string;
228
+ members: (string | {
229
+ value: string;
230
+ description?: string | undefined;
231
+ })[];
232
+ description?: string | undefined;
233
+ schema?: string | undefined;
234
+ databaseName?: string | undefined;
235
+ }[] | undefined;
236
+ }>, {
237
+ name: string;
238
+ source: Record<string, unknown>;
239
+ slug: string;
240
+ description?: string | undefined;
241
+ version?: string | undefined;
242
+ projectType?: {
243
+ kind: "standalone";
244
+ } | {
245
+ kind: "workspace";
246
+ projectDirectory: string;
247
+ } | undefined;
248
+ schemas?: string[] | undefined;
249
+ defaultSchema?: string | undefined;
250
+ systemUser?: Record<string, any> | undefined;
251
+ standardModels?: string[] | undefined;
252
+ models?: {
253
+ name: string;
254
+ description?: string | undefined;
255
+ schema?: string | undefined;
256
+ databaseName?: string | undefined;
257
+ excelName?: string | undefined;
258
+ isReadonly?: boolean | undefined;
259
+ faker?: {
260
+ seed?: number | undefined;
261
+ items?: number | undefined;
262
+ } | undefined;
263
+ seed?: any[] | undefined;
264
+ fields?: z.objectOutputType<{
265
+ name: z.ZodString;
266
+ }, z.ZodTypeAny, "passthrough">[] | undefined;
267
+ standardFields?: string[] | undefined;
268
+ defaultField?: string | undefined;
269
+ labelField?: string | undefined;
270
+ indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
271
+ source?: Record<string, unknown> | undefined;
272
+ }[] | undefined;
273
+ standardEnums?: string[] | undefined;
274
+ enums?: {
275
+ description: string;
276
+ name: string;
277
+ members: (string | {
278
+ value: string;
279
+ description?: string | undefined;
280
+ })[];
281
+ schema?: string | undefined;
282
+ databaseName?: string | undefined;
283
+ }[] | undefined;
284
+ }, unknown>, ProjectSchema, unknown>;