@bedrockio/model 0.1.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.
- package/CHANGELOG.md +60 -0
- package/README.md +932 -0
- package/babel.config.cjs +41 -0
- package/dist/cjs/access.js +66 -0
- package/dist/cjs/assign.js +50 -0
- package/dist/cjs/const.js +16 -0
- package/dist/cjs/errors.js +17 -0
- package/dist/cjs/include.js +222 -0
- package/dist/cjs/index.js +62 -0
- package/dist/cjs/load.js +40 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/references.js +104 -0
- package/dist/cjs/schema.js +277 -0
- package/dist/cjs/search.js +266 -0
- package/dist/cjs/serialization.js +55 -0
- package/dist/cjs/slug.js +47 -0
- package/dist/cjs/soft-delete.js +192 -0
- package/dist/cjs/testing.js +33 -0
- package/dist/cjs/utils.js +73 -0
- package/dist/cjs/validation.js +313 -0
- package/dist/cjs/warn.js +13 -0
- package/jest-mongodb-config.js +10 -0
- package/jest.config.js +8 -0
- package/package.json +53 -0
- package/src/access.js +60 -0
- package/src/assign.js +45 -0
- package/src/const.js +9 -0
- package/src/errors.js +9 -0
- package/src/include.js +209 -0
- package/src/index.js +5 -0
- package/src/load.js +37 -0
- package/src/references.js +101 -0
- package/src/schema.js +286 -0
- package/src/search.js +263 -0
- package/src/serialization.js +49 -0
- package/src/slug.js +45 -0
- package/src/soft-delete.js +234 -0
- package/src/testing.js +29 -0
- package/src/utils.js +63 -0
- package/src/validation.js +329 -0
- package/src/warn.js +7 -0
- package/test/assign.test.js +225 -0
- package/test/definitions/custom-model.json +9 -0
- package/test/definitions/special-category.json +18 -0
- package/test/include.test.js +896 -0
- package/test/load.test.js +47 -0
- package/test/references.test.js +71 -0
- package/test/schema.test.js +919 -0
- package/test/search.test.js +652 -0
- package/test/serialization.test.js +748 -0
- package/test/setup.js +27 -0
- package/test/slug.test.js +112 -0
- package/test/soft-delete.test.js +333 -0
- package/test/validation.test.js +1925 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
### Initial Migration
|
|
4
|
+
|
|
5
|
+
When coming from a previous version of Bedrock:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
rm src/utils/schema.js
|
|
9
|
+
rm src/utils/search.js
|
|
10
|
+
rm src/utils/validation.js
|
|
11
|
+
rm src/utils/__tests__/schema.test.js
|
|
12
|
+
rm src/utils/__tests__/validation.test.js
|
|
13
|
+
rm -r src/utils/__fixtures__
|
|
14
|
+
yarn add @bedrockio/yada
|
|
15
|
+
yarn add @bedrockio/logger
|
|
16
|
+
yarn add @bedrockio/model
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Replace all references to `src/utils/schema.js` and `src/utils/validation.js` to `@bedrockio/model`.
|
|
20
|
+
|
|
21
|
+
In the model definitions:
|
|
22
|
+
|
|
23
|
+
- Move `search` fields into a nested `fields`.
|
|
24
|
+
- Rename `readScopes` to `readAccess`.
|
|
25
|
+
- Rename `writeScopes` to `writeAccess`.
|
|
26
|
+
- Remove `skipValidation`.
|
|
27
|
+
- Change `Mixed` type to `Object`.
|
|
28
|
+
|
|
29
|
+
```js
|
|
30
|
+
{
|
|
31
|
+
"profile" {
|
|
32
|
+
"type": "String",
|
|
33
|
+
"readScopes": "none",
|
|
34
|
+
"writeScopes": "none",
|
|
35
|
+
"skipValidation": true,
|
|
36
|
+
},
|
|
37
|
+
"object": {
|
|
38
|
+
"type": "Mixed"
|
|
39
|
+
},
|
|
40
|
+
"search": ["firstName", "lastName"]
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
should be migrated to:
|
|
45
|
+
|
|
46
|
+
```js
|
|
47
|
+
{
|
|
48
|
+
"profile" {
|
|
49
|
+
"type": "String",
|
|
50
|
+
"readAccess": "none",
|
|
51
|
+
"writeAccess": "none",
|
|
52
|
+
},
|
|
53
|
+
"object": {
|
|
54
|
+
"type": "Object"
|
|
55
|
+
},
|
|
56
|
+
"search": {
|
|
57
|
+
"fields": ["firstName", "lastName"]
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|