@based/schema 4.1.1 → 5.0.0-alpha.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 (123) hide show
  1. package/README.md +152 -0
  2. package/dist/index.d.ts +2 -0
  3. package/dist/index.js +2 -0
  4. package/dist/lang.d.ts +152 -0
  5. package/dist/lang.js +149 -0
  6. package/dist/mermaid.d.ts +3 -0
  7. package/dist/mermaid.js +24 -0
  8. package/dist/parse/assert.d.ts +1 -1
  9. package/dist/parse/assert.js +2 -2
  10. package/dist/parse/errors.d.ts +2 -0
  11. package/dist/parse/errors.js +2 -0
  12. package/dist/parse/index.d.ts +5 -4
  13. package/dist/parse/index.js +43 -41
  14. package/dist/parse/props.js +159 -75
  15. package/dist/parse/utils.d.ts +2 -2
  16. package/dist/parse/utils.js +11 -2
  17. package/dist/types.d.ts +66 -23
  18. package/dist/types.js +93 -0
  19. package/package.json +4 -3
  20. package/dist/parsePayload/index.d.ts +0 -3
  21. package/dist/parsePayload/index.js +0 -2
  22. package/dist/parseSchema/assert.d.ts +0 -6
  23. package/dist/parseSchema/assert.js +0 -27
  24. package/dist/parseSchema/errors.d.ts +0 -19
  25. package/dist/parseSchema/errors.js +0 -19
  26. package/dist/parseSchema/index.d.ts +0 -20
  27. package/dist/parseSchema/index.js +0 -132
  28. package/dist/parseSchema/props.d.ts +0 -7
  29. package/dist/parseSchema/props.js +0 -256
  30. package/dist/parseSchema/utils.d.ts +0 -3
  31. package/dist/parseSchema/utils.js +0 -29
  32. package/dist/src/compat/index.d.ts +0 -6
  33. package/dist/src/compat/index.js +0 -217
  34. package/dist/src/compat/oldSchemaType.d.ts +0 -93
  35. package/dist/src/compat/oldSchemaType.js +0 -2
  36. package/dist/src/display/index.d.ts +0 -2
  37. package/dist/src/display/index.js +0 -16
  38. package/dist/src/display/number.d.ts +0 -4
  39. package/dist/src/display/number.js +0 -97
  40. package/dist/src/display/string.d.ts +0 -5
  41. package/dist/src/display/string.js +0 -26
  42. package/dist/src/display/timestamp.d.ts +0 -5
  43. package/dist/src/display/timestamp.js +0 -134
  44. package/dist/src/error.d.ts +0 -21
  45. package/dist/src/error.js +0 -23
  46. package/dist/src/index.d.ts +0 -6
  47. package/dist/src/index.js +0 -7
  48. package/dist/src/languages.d.ts +0 -188
  49. package/dist/src/languages.js +0 -188
  50. package/dist/src/set/fields/array.d.ts +0 -2
  51. package/dist/src/set/fields/array.js +0 -119
  52. package/dist/src/set/fields/index.d.ts +0 -3
  53. package/dist/src/set/fields/index.js +0 -85
  54. package/dist/src/set/fields/number.d.ts +0 -4
  55. package/dist/src/set/fields/number.js +0 -123
  56. package/dist/src/set/fields/object.d.ts +0 -3
  57. package/dist/src/set/fields/object.js +0 -28
  58. package/dist/src/set/fields/references.d.ts +0 -3
  59. package/dist/src/set/fields/references.js +0 -136
  60. package/dist/src/set/fields/set.d.ts +0 -2
  61. package/dist/src/set/fields/set.js +0 -59
  62. package/dist/src/set/fields/string.d.ts +0 -3
  63. package/dist/src/set/fields/string.js +0 -289
  64. package/dist/src/set/index.d.ts +0 -3
  65. package/dist/src/set/index.js +0 -205
  66. package/dist/src/set/isValidId.d.ts +0 -2
  67. package/dist/src/set/isValidId.js +0 -17
  68. package/dist/src/types.d.ts +0 -205
  69. package/dist/src/types.js +0 -113
  70. package/dist/src/updateSchema.d.ts +0 -2
  71. package/dist/src/updateSchema.js +0 -12
  72. package/dist/src/validateSchema/basedSchemaTypeValidator.d.ts +0 -3
  73. package/dist/src/validateSchema/basedSchemaTypeValidator.js +0 -45
  74. package/dist/src/validateSchema/fieldValidators.d.ts +0 -27
  75. package/dist/src/validateSchema/fieldValidators.js +0 -360
  76. package/dist/src/validateSchema/index.d.ts +0 -17
  77. package/dist/src/validateSchema/index.js +0 -109
  78. package/dist/src/validateSchema/utils.d.ts +0 -25
  79. package/dist/src/validateSchema/utils.js +0 -61
  80. package/dist/src/walker/args.d.ts +0 -36
  81. package/dist/src/walker/args.js +0 -158
  82. package/dist/src/walker/index.d.ts +0 -6
  83. package/dist/src/walker/index.js +0 -31
  84. package/dist/src/walker/parse.d.ts +0 -3
  85. package/dist/src/walker/parse.js +0 -182
  86. package/dist/src/walker/types.d.ts +0 -45
  87. package/dist/src/walker/types.js +0 -7
  88. package/dist/test/array.d.ts +0 -1
  89. package/dist/test/array.js +0 -342
  90. package/dist/test/compat.d.ts +0 -1
  91. package/dist/test/compat.js +0 -97
  92. package/dist/test/data/newSchemas.d.ts +0 -2
  93. package/dist/test/data/newSchemas.js +0 -489
  94. package/dist/test/data/oldSchemas.d.ts +0 -2
  95. package/dist/test/data/oldSchemas.js +0 -5058
  96. package/dist/test/display.d.ts +0 -1
  97. package/dist/test/display.js +0 -103
  98. package/dist/test/json.d.ts +0 -1
  99. package/dist/test/json.js +0 -40
  100. package/dist/test/number.d.ts +0 -1
  101. package/dist/test/number.js +0 -374
  102. package/dist/test/reference.d.ts +0 -1
  103. package/dist/test/reference.js +0 -188
  104. package/dist/test/rest.d.ts +0 -1
  105. package/dist/test/rest.js +0 -168
  106. package/dist/test/set.d.ts +0 -1
  107. package/dist/test/set.js +0 -95
  108. package/dist/test/string.d.ts +0 -1
  109. package/dist/test/string.js +0 -120
  110. package/dist/test/text.d.ts +0 -1
  111. package/dist/test/text.js +0 -324
  112. package/dist/test/utils/index.d.ts +0 -11
  113. package/dist/test/utils/index.js +0 -17
  114. package/dist/test/validateSchema/basic.d.ts +0 -1
  115. package/dist/test/validateSchema/basic.js +0 -94
  116. package/dist/test/validateSchema/fields.d.ts +0 -1
  117. package/dist/test/validateSchema/fields.js +0 -436
  118. package/dist/test/validateSchema/languages.d.ts +0 -1
  119. package/dist/test/validateSchema/languages.js +0 -124
  120. package/dist/test/validateSchema/realWorld.d.ts +0 -1
  121. package/dist/test/validateSchema/realWorld.js +0 -13
  122. package/dist/test/walker.d.ts +0 -1
  123. package/dist/test/walker.js +0 -289
@@ -1,342 +0,0 @@
1
- import test from 'ava';
2
- import { setWalker } from '../src/index.js';
3
- import { errorCollect, resultCollect } from './utils/index.js';
4
- const schema = {
5
- types: {
6
- bla: {
7
- prefix: 'bl',
8
- fields: {
9
- arrNum: {
10
- type: 'array',
11
- items: {
12
- type: 'number',
13
- },
14
- },
15
- objArray: {
16
- type: 'array',
17
- items: {
18
- type: 'object',
19
- properties: {
20
- snurp: {
21
- type: 'string',
22
- },
23
- },
24
- },
25
- },
26
- arrStr: {
27
- type: 'array',
28
- items: {
29
- type: 'string',
30
- },
31
- },
32
- intarray: {
33
- type: 'array',
34
- items: {
35
- type: 'integer',
36
- },
37
- },
38
- },
39
- },
40
- },
41
- $defs: {},
42
- language: 'en',
43
- root: {
44
- fields: {},
45
- },
46
- prefixToTypeMapping: {
47
- bl: 'bla',
48
- },
49
- };
50
- test('arrayNum', async (t) => {
51
- const err = await setWalker(schema, {
52
- $id: 'bl1',
53
- arrNum: ['1', '2'],
54
- });
55
- const err1 = await setWalker(schema, {
56
- $id: 'bla',
57
- ref: 1,
58
- });
59
- const res = await setWalker(schema, {
60
- $id: 'bla',
61
- arrNum: [1, 2],
62
- });
63
- t.true(errorCollect(err, err1).length > 0);
64
- t.deepEqual(resultCollect(res), [
65
- { path: ['arrNum'], value: { $delete: true } },
66
- { path: ['arrNum', 0], value: 1 },
67
- { path: ['arrNum', 1], value: 2 },
68
- ]);
69
- });
70
- test('value arr', async (t) => {
71
- const err = await setWalker(schema, {
72
- $id: 'bl1',
73
- arrNum: { $value: ['1', '2'] },
74
- });
75
- t.true(err.errors.length > 1);
76
- const res = await setWalker(schema, {
77
- $id: 'bla',
78
- arrNum: [{ $value: 1 }, { $value: 2 }],
79
- });
80
- const res1 = await setWalker(schema, {
81
- $id: 'bla',
82
- arrNum: { $value: [1, 2] },
83
- });
84
- t.deepEqual(resultCollect(res, res1), [
85
- { path: ['arrNum'], value: { $delete: true } },
86
- { path: ['arrNum', 0], value: 1 },
87
- { path: ['arrNum', 1], value: 2 },
88
- { path: ['arrNum'], value: { $delete: true } },
89
- { path: ['arrNum', 0], value: 1 },
90
- { path: ['arrNum', 1], value: 2 },
91
- ]);
92
- });
93
- test.only('default arr', async (t) => {
94
- const err = await setWalker(schema, {
95
- $id: 'bl1',
96
- arrNum: ['1', '2'],
97
- });
98
- const err1 = await setWalker(schema, {
99
- $id: 'bla',
100
- ref: 1,
101
- });
102
- const res = await setWalker(schema, {
103
- $id: 'bla',
104
- arrNum: [{ $default: 1 }, { $default: 2 }],
105
- });
106
- const res1 = await setWalker(schema, {
107
- $id: 'bla',
108
- arrNum: { $default: [1, 2] },
109
- });
110
- t.true(errorCollect(err, err1).length > 0);
111
- t.deepEqual(resultCollect(res, res1), [
112
- { path: ['arrNum'], value: { $delete: true } },
113
- { path: ['arrNum', 0], value: { $default: 1 } },
114
- { path: ['arrNum', 1], value: { $default: 2 } },
115
- // TODO bit sketchy needs some work
116
- { path: ['arrNum'], value: { $default: [1, 2] } },
117
- ]);
118
- });
119
- let r;
120
- test('assign idx value', async (t) => {
121
- r = await setWalker(schema, {
122
- $id: 'bl120',
123
- intarray: {
124
- $assign: {
125
- $idx: 0,
126
- $value: 6,
127
- },
128
- },
129
- });
130
- t.deepEqual(resultCollect(r), [{ path: ['intarray', 0], value: 6 }]);
131
- });
132
- test('push ints', async (t) => {
133
- r = await setWalker(schema, {
134
- $id: 'bl120',
135
- intarray: {
136
- $push: [1, 2, 3, 4, 5],
137
- },
138
- });
139
- t.deepEqual(resultCollect(r), [
140
- { path: ['intarray'], value: { $push: [1, 2, 3, 4, 5] } },
141
- ]);
142
- });
143
- test('push objs', async (t) => {
144
- r = await setWalker(schema, {
145
- $id: 'bl120',
146
- objArray: {
147
- $push: [{ snurp: 'a' }, { snurp: 'b' }, { snurp: 'c' }],
148
- },
149
- });
150
- t.deepEqual(resultCollect(r), [
151
- {
152
- path: ['objArray'],
153
- value: {
154
- $push: [{ snurp: 'a' }, { snurp: 'b' }, { snurp: 'c' }],
155
- },
156
- },
157
- { path: ['objArray', -3, 'snurp'], value: 'a' },
158
- { path: ['objArray', -2, 'snurp'], value: 'b' },
159
- { path: ['objArray', -1, 'snurp'], value: 'c' },
160
- { path: ['objArray', -3], value: { snurp: 'a' } },
161
- { path: ['objArray', -2], value: { snurp: 'b' } },
162
- { path: ['objArray', -1], value: { snurp: 'c' } },
163
- ]);
164
- });
165
- test('unshift ints', async (t) => {
166
- r = await setWalker(schema, {
167
- $id: 'bl120',
168
- intarray: {
169
- $unshift: [1, 2, 3, 4, 5],
170
- },
171
- });
172
- t.deepEqual(resultCollect(r), [
173
- { path: ['intarray'], value: { $unshift: [1, 2, 3, 4, 5] } },
174
- ]);
175
- t.true(true);
176
- });
177
- test('nested default unshift', async (t) => {
178
- r = await setWalker(schema, {
179
- $id: 'bl120',
180
- intarray: {
181
- $unshift: [{ $value: 1 }, { $default: 2 }, 3, 4, 5],
182
- },
183
- });
184
- t.is(r.errors.length, 0);
185
- t.deepEqual(resultCollect(r), [
186
- {
187
- path: ['intarray'],
188
- value: { $unshift: [1, { $default: 2 }, 3, 4, 5] },
189
- },
190
- ]);
191
- });
192
- test('nested default in push', async (t) => {
193
- r = await setWalker(schema, {
194
- $id: 'bl120',
195
- intarray: {
196
- $push: [{ $value: 1 }, { $default: 2 }, 3, 4, 5],
197
- },
198
- });
199
- t.is(r.errors.length, 0);
200
- t.deepEqual(resultCollect(r), [
201
- {
202
- path: ['intarray'],
203
- value: { $push: [1, { $default: 2 }, 3, 4, 5] },
204
- },
205
- ]);
206
- });
207
- test('assign idx default value error', async (t) => {
208
- r = await setWalker(schema, {
209
- $id: 'bl120',
210
- intarray: {
211
- $assign: {
212
- $idx: { $default: 0 },
213
- $value: 6,
214
- },
215
- },
216
- });
217
- t.true(r.errors.length > 0);
218
- });
219
- test('assign idx no value', async (t) => {
220
- r = await setWalker(schema, {
221
- $id: 'bl120',
222
- intarray: {
223
- $assign: {
224
- $idx: { $default: 0 },
225
- },
226
- },
227
- });
228
- t.true(r.errors.length > 0);
229
- });
230
- test('assign idx value spelled wrong', async (t) => {
231
- r = await setWalker(schema, {
232
- $id: 'bl120',
233
- intarray: {
234
- $assign: {
235
- $idx: 0,
236
- value: 5,
237
- },
238
- },
239
- });
240
- t.true(r.errors.length > 0);
241
- });
242
- test('assign idx value wrong type', async (t) => {
243
- r = await setWalker(schema, {
244
- $id: 'bl120',
245
- intarray: {
246
- $assign: {
247
- $idx: 0,
248
- $value: 5.6,
249
- },
250
- },
251
- });
252
- t.true(r.errors.length > 0);
253
- });
254
- test('assign idx value value wrong type', async (t) => {
255
- r = await setWalker(schema, {
256
- $id: 'bl120',
257
- intarray: {
258
- $assign: {
259
- $idx: 0,
260
- $value: { $value: 5.6 },
261
- },
262
- },
263
- });
264
- t.true(r.errors.length > 0);
265
- });
266
- test('assign idx default value', async (t) => {
267
- r = await setWalker(schema, {
268
- $id: 'bl120',
269
- intarray: {
270
- $assign: {
271
- $idx: 0,
272
- $value: { $default: 5 },
273
- },
274
- },
275
- });
276
- t.deepEqual(resultCollect(r), [
277
- { path: ['intarray', 0], value: { $default: 5 } },
278
- ]);
279
- });
280
- test('assign idx value value error', async (t) => {
281
- r = await setWalker(schema, {
282
- $id: 'bl120',
283
- intarray: {
284
- $assign: {
285
- $idx: { $value: 0 },
286
- $value: 6,
287
- },
288
- },
289
- });
290
- t.true(r.errors.length > 0);
291
- });
292
- test('insert idx intarray', async (t) => {
293
- r = await setWalker(schema, {
294
- $id: 'bl120',
295
- intarray: {
296
- $insert: {
297
- $idx: 10,
298
- $value: 1212,
299
- },
300
- },
301
- });
302
- t.true(r.errors.length === 0);
303
- t.deepEqual(resultCollect(r), [
304
- {
305
- path: ['intarray'],
306
- value: { $insert: { $idx: 10, $value: [1212] } },
307
- },
308
- ]);
309
- });
310
- test('unshift array', async (t) => {
311
- r = await setWalker(schema, {
312
- $id: 'bl120',
313
- intarray: {
314
- $unshift: { $value: [-10, -20, -30] },
315
- },
316
- });
317
- t.true(r.errors.length === 0);
318
- t.deepEqual(resultCollect(r), [
319
- { path: ['intarray'], value: { $unshift: [-10, -20, -30] } },
320
- ]);
321
- });
322
- test('assign + $delete', async (t) => {
323
- r = await setWalker(schema, {
324
- $id: 'bl120',
325
- objArray: {
326
- $assign: {
327
- $idx: 3,
328
- $value: {
329
- snurp: {
330
- $delete: true,
331
- },
332
- },
333
- },
334
- },
335
- });
336
- t.is(r.errors.length, 0);
337
- t.deepEqual(resultCollect(r), [
338
- { path: ['objArray', 3, 'snurp'], value: { $delete: true } },
339
- { path: ['objArray', 3], value: { snurp: { $delete: true } } },
340
- ]);
341
- });
342
- //# sourceMappingURL=array.js.map
@@ -1 +0,0 @@
1
- export {};
@@ -1,97 +0,0 @@
1
- import test from 'ava';
2
- import { newSchemas } from './data/newSchemas.js';
3
- import { oldSchemas } from './data/oldSchemas.js';
4
- import { convertNewToOld, convertOldToNew, validateSchema, } from '../src/index.js';
5
- const addStandardMetaToOld = (obj) => {
6
- if (obj && typeof obj === 'object') {
7
- if (obj.type === 'id') {
8
- obj.meta ??= {};
9
- obj.meta.format = 'basedId';
10
- }
11
- else if (obj.type === 'email') {
12
- obj.meta ??= {};
13
- obj.meta.format = 'email';
14
- }
15
- else if (obj.type === 'digest') {
16
- obj.meta ??= {};
17
- obj.meta.format = 'strongPassword';
18
- }
19
- else if (obj.type === 'url') {
20
- obj.meta ??= {};
21
- obj.meta.format = 'URL';
22
- }
23
- else if (obj.type === 'phone') {
24
- obj.meta ??= {};
25
- obj.meta.format = 'mobilePhone';
26
- }
27
- for (const i in obj) {
28
- addStandardMetaToOld(obj[i]);
29
- }
30
- }
31
- };
32
- test('refTypes', async (t) => {
33
- const newSchema = convertOldToNew({
34
- types: {
35
- youzi: {
36
- fields: {
37
- image: {
38
- type: 'reference',
39
- meta: {
40
- refTypes: ['youzi'],
41
- },
42
- },
43
- },
44
- },
45
- },
46
- });
47
- // @ts-ignore
48
- t.is(newSchema.types.youzi.fields.image.allowedType, 'youzi');
49
- const oldSchema = convertNewToOld(newSchema);
50
- // @ts-ignore
51
- t.is(oldSchema.types.youzi.fields.image.meta.refTypes[0], 'youzi');
52
- });
53
- test('bidirectional', async (t) => {
54
- const newSchema = convertOldToNew({
55
- types: {
56
- youzi: {
57
- fields: {
58
- image: {
59
- type: 'reference',
60
- bidirectional: {
61
- fromField: 'success',
62
- },
63
- meta: {
64
- refTypes: ['youzi'],
65
- },
66
- },
67
- },
68
- },
69
- },
70
- });
71
- console.log(newSchema.types.youzi.fields.image);
72
- // @ts-ignore
73
- t.is(newSchema.types.youzi.fields.image.bidirectional.fromField, 'success');
74
- const oldSchema = convertNewToOld(newSchema);
75
- // @ts-ignore
76
- t.is(oldSchema.types.youzi.fields.image.bidirectional.fromField, 'success');
77
- });
78
- test('old schema compat mode', async (t) => {
79
- for (let i = 0; i < oldSchemas.length - 1; i++) {
80
- const oldSchema = oldSchemas[i];
81
- const newSchema = convertOldToNew(oldSchema);
82
- const validation = await validateSchema(newSchema);
83
- t.true(validation.valid);
84
- addStandardMetaToOld(oldSchema);
85
- t.deepEqual(oldSchema, convertNewToOld(newSchema), `Schema conversion oldSchemas index ${i}`);
86
- }
87
- });
88
- test('new schema compat mode', async (t) => {
89
- for (let i = 0; i < newSchemas.length - 1; i++) {
90
- const newSchema = newSchemas[i];
91
- const validation = await validateSchema(newSchema);
92
- const oldSchema = convertNewToOld(newSchema);
93
- t.true(validation.valid);
94
- t.deepEqual(newSchema, convertOldToNew(oldSchema), `Schema conversion newSchemas index ${i}`);
95
- }
96
- });
97
- //# sourceMappingURL=compat.js.map
@@ -1,2 +0,0 @@
1
- import { BasedSchemaPartial } from '../../src/types.js';
2
- export declare const newSchemas: BasedSchemaPartial[];