@acodeninja/persist 3.0.0-next.26 → 3.0.0-next.28

package/README.md

@@ -41,10 +41,10 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.dateOfBirth = Persist.Property.Date.required;
-        this.height = Persist.Property.Number.required;
-        this.isStudent = Persist.Property.Boolean.required;
+        Person.name = Persist.Property.String.required;
+        Person.dateOfBirth = Persist.Property.Date.required;
+        Person.height = Persist.Property.Number.required;
+        Person.isStudent = Persist.Property.Boolean.required;
     }
 }
 ```

package/docs/code-quirks.md

@@ -14,10 +14,10 @@ To avoid this problem, you have two options:
 ```javascript
 import Persist from "@acodeninja/persist";
 
-export class Person extends Persist.Type.Model {
+export class Person extends Persist.Model {
     static {
-        this.withName('Person');
-        this.name = Persist.Type.String.required;
+        Person.withName('Person');
+        Person.name = Persist.Property.String.required;
     }
 }
 ```
@@ -37,17 +37,17 @@ To avoid these errors, always define model relationships using arrow functions.
 ```javascript
 import Persist from "@acodeninja/persist";
 
-export class Person extends Persist.Type.Model {
+export class Person extends Persist.Model {
     static {
-        this.address = () => Address;
+        Person.address = () => Address;
     }
 }
 
-export class Address extends Persist.Type.Model {
+export class Address extends Persist.Model {
     static {
-        this.person = () => Person;
-        this.address = Persist.Type.String.required;
-        this.postcode = Persist.Type.String.required;
+        Address.person = () => Person;
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```

package/docs/defining-models.md

@@ -28,10 +28,10 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.dateOfBirth = Persist.Property.Date.required;
-        this.height = Persist.Property.Number.required;
-        this.isStudent = Persist.Property.Boolean.required;
+        Person.name = Persist.Property.String.required;
+        Person.dateOfBirth = Persist.Property.Date.required;
+        Person.height = Persist.Property.Number.required;
+        Person.isStudent = Persist.Property.Boolean.required;
     }
 }
 ```
@@ -45,15 +45,15 @@ Models can be linked to other models by declaring them as properties.
 ```javascript
 class Address extends Persist.Model {
     static {
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 
 class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.address = Address;
+        Person.name = Persist.Property.String.required;
+        Person.address = Address;
     }
 }
 ```

package/docs/model-properties.md

@@ -13,8 +13,8 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.firstName = Persist.Property.String;
-        this.lastName = Persist.Property.String;
+        Person.firstName = Persist.Property.String;
+        Person.lastName = Persist.Property.String;
     }
 }
 ```
@@ -30,8 +30,8 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.firstName = Persist.Property.String;
-        this.lastName = Persist.Property.String.required;
+        Person.firstName = Persist.Property.String;
+        Person.lastName = Persist.Property.String.required;
     }
 }
 ```
@@ -45,8 +45,8 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.markettingEmailsActive = Persist.Property.Boolean;
-        this.accountActive = Persist.Property.Boolean.required;
+        Person.marketingEmailsActive = Persist.Property.Boolean;
+        Person.accountActive = Persist.Property.Boolean.required;
     }
 }
 ```
@@ -60,8 +60,8 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.loginToken = Persist.Property.Number;
-        this.accountId = Persist.Property.Number.required;
+        Person.loginToken = Persist.Property.Number;
+        Person.accountId = Persist.Property.Number.required;
     }
 }
 ```
@@ -77,8 +77,8 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.lastLogin = Persist.Property.Date;
-        this.createdAt = Persist.Property.Date.required;
+        Person.lastLogin = Persist.Property.Date;
+        Person.createdAt = Persist.Property.Date.required;
     }
 }
 ```
@@ -94,8 +94,8 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.failedLoginAttempts = Persist.Property.Array.of(Persist.Property.Date);
-        this.fullName = Persist.Property.Array.of(Persist.Property.String).required;
+        Person.failedLoginAttempts = Persist.Property.Array.of(Persist.Property.Date);
+        Person.fullName = Persist.Property.Array.of(Persist.Property.String).required;
     }
 }
 ```
@@ -109,7 +109,7 @@ import Persist from '@acodeninja/persist';
 
 class Person extends Persist.Model {
     static {
-        this.address = Persist.Property.Custom.of({
+        Person.address = Persist.Property.Custom.of({
             type: 'object',
             additionalProperties: false,
             required: ['line1', 'city', 'postcode'],
@@ -140,8 +140,8 @@ import Persist from '@acodeninja/persist';
 
 class Page extends Persist.Model {
     static {
-        this.title = Persist.Property.String;
-        this.slug = Persist.Property.Resolved.Slug.of('title');
+        Page.title = Persist.Property.String;
+        Page.slug = Persist.Property.Resolved.Slug.of('title');
     }
 }
 
@@ -162,14 +162,45 @@ Most types support the `.required` modifier, which will alter validation to enfo
 ```javascript
 class RequiredStringModel extends Persist.Model {
     static {
-        this.requiredString = Type.String.required;
-        this.requiredNumber = Type.Number.required;
-        this.requiredBoolean = Type.Boolean.required;
-        this.requiredDate = Type.Date.required;
-        this.requiredArrayOfString = Type.Array.of(Type.String).required;
-        this.requiredArrayOfNumber = Type.Array.of(Type.Number).required;
-        this.requiredArrayOfBoolean = Type.Array.of(Type.Boolean).required;
-        this.requiredArrayOfDate = Type.Array.of(Type.Date).required;
+        RequiredStringModel.requiredString = Persist.Property.String.required;
+        RequiredStringModel.requiredNumber = Persist.Property.Number.required;
+        RequiredStringModel.requiredBoolean = Persist.Property.Boolean.required;
+        RequiredStringModel.requiredDate = Persist.Property.Date.required;
+        RequiredStringModel.requiredArrayOfString = Persist.Property.Array.of(Persist.Property.String).required;
+        RequiredStringModel.requiredArrayOfNumber = Persist.Property.Array.of(Persist.Property.Number).required;
+        RequiredStringModel.requiredArrayOfBoolean = Persist.Property.Array.of(Persist.Property.Boolean).required;
+        RequiredStringModel.requiredArrayOfDate = Persist.Property.Array.of(Persist.Property.Date).required;
     }
 }
 ```
+
+## Custom Property Types
+
+Under the hood, model validation uses the [ajv](https://ajv.js.org/) library with [ajv-formats](https://ajv.js.org/packages/ajv-formats.html) included. Because of this, you can create your own property types.
+
+Say you want to attach an IPv4 address to your models. The following type class can accomplish this.
+
+```javascript
+import Persist from '@acodeninja/persist';
+
+class IPv4Type extends Persist.Property.Type {
+    static {
+        // Set the type of the property to string
+        IPv4Type._type = 'string';
+        // Use the ajv extended format "ipv4"
+        IPv4Type._format = 'ipv4';
+        // Ensure that even when minified, the name of the constructor is IPv4
+        Object.defineProperty(IPv4Type, 'name', {value: 'IPv4'});
+    }
+}
+```
+
+This type can then be used in any model as needed.
+
+```javascript
+import Persist from '@acodeninja/persist';
+
+class StaticIP extends Persist.Model {
+    static ip = IPv4Type.required;
+}
+```

package/docs/models-as-properties.md

@@ -9,14 +9,14 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
+        Person.name = Persist.Property.String.required;
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```
@@ -30,15 +30,15 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.address = () => Address;
+        Person.name = Persist.Property.String.required;
+        Person.address = () => Address;
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```
@@ -57,16 +57,16 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.address = () => Address;
+        Person.name = Persist.Property.String.required;
+        Person.address = () => Address;
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.person = () => Person;
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.person = () => Person;
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```
@@ -80,16 +80,16 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.addresses = () => Persist.Property.Array.of(Address);
+        Person.name = Persist.Property.String.required;
+        Person.addresses = () => Persist.Property.Array.of(Address);
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.person = () => Person;
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.person = () => Person;
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```
@@ -105,16 +105,16 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.addresses = () => Persist.Property.Array.of(Address);
+        Person.name = Persist.Property.String.required;
+        Person.addresses = () => Persist.Property.Array.of(Address);
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.people = () => Persist.Property.Array.of(Person);
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.people = () => Persist.Property.Array.of(Person);
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```
@@ -130,24 +130,24 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.addresses = () => Persist.Property.Array.of(Abode);
+        Person.name = Persist.Property.String.required;
+        Person.addresses = () => Persist.Property.Array.of(Abode);
     }
 }
 
 export class Abode extends Persist.Model {
     static {
-        this.moveInDate = Persist.Property.Date.required;
-        this.address = () => Address;
-        this.person = () => Person;
+        Abode.moveInDate = Persist.Property.Date.required;
+        Abode.address = () => Address;
+        Abode.person = () => Person;
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.people = () => Persist.Property.Array.of(Person);
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
+        Address.people = () => Persist.Property.Array.of(Person);
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
     }
 }
 ```

package/docs/search-queries.md

@@ -11,19 +11,19 @@ Let's consider the following models:
 ```javascript
 import Persist from "@acodeninja/persist";
 
-export class Person extends Persist.Type.Model {
+export class Person extends Persist.Model {
     static {
-        this.name = Persist.Type.String.required;
-        this.address = () => Address;
-        this.searchProperties = () => ['name', 'address.address'];
+        Person.name = Persist.Property.String.required;
+        Person.address = () => Address;
+        Person.searchProperties = () => ['name', 'address.address'];
     }
 }
 
-export class Address extends Persist.Type.Model {
+export class Address extends Persist.Model {
     static {
-        this.address = Persist.Type.String.required;
-        this.postcode = Persist.Type.String.required;
-        this.searchProperties = () => ['address', 'postcode'];
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
+        Address.searchProperties = () => ['address', 'postcode'];
     }
 }
 ```

package/docs/structured-queries.md

@@ -4,7 +4,7 @@ Use structured queries when you need to filter a collection of models using a se
 
 ## Indexing Data
 
-To set index properties on a model, define the static function `indexProperties` as an arrow function that returns an array of fields that should be indexed for querying.
+To set index properties on a model, define the static function `indexedProperties` as an arrow function that returns an array of fields that should be indexed for querying.
 
 Let's consider the following models:
 
@@ -13,18 +13,18 @@ import Persist from "@acodeninja/persist";
 
 export class Person extends Persist.Model {
     static {
-        this.name = Persist.Property.String.required;
-        this.address = () => Address;
-        this.indexProperties = () => ['name', 'address.postcode'];
+        Person.name = Persist.Property.String.required;
+        Person.address = () => Address;
+        Person.indexedProperties = () => ['name', 'address.postcode'];
     }
 }
 
 export class Address extends Persist.Model {
     static {
-        this.address = Persist.Property.String.required;
-        this.postcode = Persist.Property.String.required;
-        this.people = () => Persist.Property.Array.of(Person)
-        this.indexProperties = () => ['postcode', 'people.[*].name'];
+        Address.address = Persist.Property.String.required;
+        Address.postcode = Persist.Property.String.required;
+        Address.people = () => Persist.Property.Array.of(Person)
+        Address.indexedProperties = () => ['postcode', 'people.[*].name'];
     }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.0.0-next.26",
+  "version": "3.0.0-next.28",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {