@bedrockio/model 0.21.1 → 0.21.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.21.2
+
+- Export `loadDefinition` and readme updates.
+
 ## 0.21.1
 
 - Fixed issues with schema loading.

package/README.md

@@ -6,6 +6,7 @@ Bedrock utilities for model creation.
 - [Dependencies](#dependencies)
 - [Usage](#usage)
 - [Schemas](#schemas)
+  - [Schema Comments](#schema-comments)
 - [Schema Extensions](#schema-extensions)
   - [Attributes](#attributes)
   - [Scopes](#scopes)
@@ -58,14 +59,13 @@ const { loadModelDir } = require('@bedrockio/model');
 model.exports = loadModelDir('path/to/definitions/');
 ```
 
-Models that need to be extended can use the `createSchema` method with the
-definition and add to the schema as needed:
+Models that need to be extended can use the `loadSchema` method.
 
 ```js
 const mongoose = require('mongoose');
-const definition = require('./definitions/user.json');
+const { loadSchema } = require('@bedrockio/model')
 
-const schema = createSchema(definition);
+const schema = loadSchema('user');
 
 schema.virtual('name').get(function () {
   return [this.firstName, this.lastName].join(' ');
@@ -89,7 +89,7 @@ model.exports = {
 The `attributes` field of model definitions can be considered equivalent to
 Mongoose, but defined in JSON with extended features:
 
-```js
+```jsonc
 {
   "attributes": {
     // Shortcut for the syntax below.
@@ -129,6 +129,21 @@ Links:
 - [Validation](#validation)
 - [Access Control](#access-control)
 
+
+#### Schema Comments
+
+Schemas may be `.jsonc` which will allow comments in definitions:
+
+```jsonc
+// user.jsonc
+{
+  "attributes": {
+    // User name
+    "name": "String",
+  }
+}
+```
+
 ### Schema Extensions
 
 This module provides a number of extensions to assist schema creation outside

package/dist/cjs/load.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.loadDefinition = loadDefinition;
 exports.loadModel = loadModel;
 exports.loadModelDir = loadModelDir;
 exports.loadSchema = loadSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.21.1",
+  "version": "0.21.2",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {

package/src/load.js

@@ -64,7 +64,7 @@ export function loadSchema(name, dir) {
 const DEFINITION_DIR = 'src/models/definitions';
 const SCHEMA_EXTENSIONS = ['.json', '.jsonc'];
 
-function loadDefinition(name, dir) {
+export function loadDefinition(name, dir) {
   const { filepath, ext } = resolvePath(name, dir);
   const content = fs.readFileSync(filepath, 'utf-8');
   return ext === '.jsonc' ? parseWithComments(content) : JSON.parse(content);

package/types/generated/load.d.ts

@@ -33,5 +33,6 @@ export function loadSchema(name: string, dir?: string): mongoose.Schema<any, mon
 }> & {
     __v: number;
 }>;
+export function loadDefinition(name: any, dir: any): any;
 import mongoose from 'mongoose';
 //# sourceMappingURL=load.d.ts.map

package/types/generated/load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/load.js"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,sCAJW,MAAM,QACN,MAAM,OAahB;AAED;;;;GAIG;AACH,kCAFW,MAAM,mBAoBhB;AAED;;;;GAIG;AACH,iCAHW,MAAM,QACN,MAAM;;;;;;;;;;;;;;;;GAKhB;qBAvDoB,UAAU"}
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/load.js"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,sCAJW,MAAM,QACN,MAAM,OAahB;AAED;;;;GAIG;AACH,kCAFW,MAAM,mBAoBhB;AAED;;;;GAIG;AACH,iCAHW,MAAM,QACN,MAAM;;;;;;;;;;;;;;;;GAKhB;AAKD,yDAIC;qBAhEoB,UAAU"}