WIP: Add more decorators

package.json

@@ -38,6 +38,7 @@
     "@vuex-orm/core": "^0.33.0"
   },
   "devDependencies": {
+    "@testdeck/jest": "0.0.6",
     "@types/jest": "^24.0.23",
     "codecov": "^3.5.0",
     "jest": "^24.8.0",

src/decorators/Attribute.ts

@@ -1,9 +1,12 @@
 import PropertyDecorator from '../contracts/PropertyDecorator'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
 import Field from './Field'
 
 /**
  * Create a attribute decorator.
  */
-export default function Attribute (value: any = null): PropertyDecorator {
-  return Field(model => model.attr(value))
+export function Attribute (value: FunctorOrValue<any> = null): PropertyDecorator {
+  return Field(model => model.attr(unwrapFunctorOrValue(value)))
 }
+
+export default Attribute

src/decorators/BelongsTo.ts

@@ -0,0 +1,13 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function BelongsTo (
+  parent: FunctorOrValue<typeof Model | string>,
+  foreignKey: FunctorOrValue<string>, ownerKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.belongsTo as any)(...[parent, foreignKey, ownerKey].map(unwrapFunctorOrValue)))
+}
+
+export default BelongsTo

src/decorators/BelongsToMany.ts

@@ -0,0 +1,15 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function BelongsToMany (
+  related: FunctorOrValue<typeof Model | string>,
+  pivot: FunctorOrValue<typeof Model | string>,
+  foreignPivotKey: FunctorOrValue<string>, relatedPivotKey: FunctorOrValue<string>,
+  parentKey?: FunctorOrValue<string>, relatedKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.belongsToMany as any)(...[related, pivot, foreignPivotKey, relatedPivotKey, parentKey, relatedKey].map(unwrapFunctorOrValue)))
+}
+
+export default BelongsToMany

src/decorators/Bool.ts

@@ -1,10 +1,13 @@
 import PropertyDecorator from '../contracts/PropertyDecorator'
 import { TypeOptions } from '../options/Options'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
 import Primitive from './Primitive'
 
 /**
  * Create a bool decorator.
  */
-export default function Bool (value: boolean | null, options?: TypeOptions): PropertyDecorator {
-  return Primitive(model => model.boolean(value), options)
+export function Bool (value?: FunctorOrValue<boolean> | null, options?: TypeOptions): PropertyDecorator {
+  return Primitive(model => model.boolean(unwrapFunctorOrValue(value)), options)
 }
+
+export default Bool

src/decorators/DecoratedModel.ts

@@ -0,0 +1,41 @@
+import { Model } from '@vuex-orm/core'
+import InheritanceTypes from '@vuex-orm/core/lib/model/contracts/InheritanceTypes'
+
+// Creates an optional class decorator to be used as means to add static fields
+export function DecoratedModel (
+  entityName: string,
+  options?: {
+    parentEntity?: string,
+    types?: InheritanceTypes,
+    typeKey?: string
+  }
+): (target: any) => any | void {
+  return (target: any): any | void => {
+    const model = target.constructor as typeof Model
+
+    // Do this temporarily until upstream vuex-orm declare this field officially
+    // I want to use this to notify hot reloader in the future
+    ;(model as any).isDecorated = true
+
+    model.entity = entityName
+
+    // generate base entity key assignment
+    if (options?.parentEntity) {
+      model.baseEntity = options.parentEntity
+    }
+
+    // generate type discriminator
+    if (options?.types) {
+      model.types = () => options.types!
+
+      // assignment type key for this entity
+      if (options?.typeKey) {
+        model.typeKey = options.typeKey
+      }
+    }
+
+    return target
+  }
+}
+
+export default DecoratedModel

src/decorators/Field.ts

@@ -1,12 +1,12 @@
-import { Model, Attribute } from '@vuex-orm/core'
+import { Attribute, Model } from '@vuex-orm/core'
 import PropertyDecorator from '../contracts/PropertyDecorator'
 
-type Callback = (model: typeof Model) => Attribute
+type Callback = (model: typeof Model, propertyKey: string) => Attribute
 
 /**
  * Create a generic field decorator.
  */
-export default function Field (callback: Callback): PropertyDecorator {
+export function Field (callback: Callback): PropertyDecorator {
   return (target: Model, propertyKey: string): void => {
     const model = target.constructor as typeof Model
 
@@ -18,6 +18,8 @@ export default function Field (callback: Callback): PropertyDecorator {
       model.cachedFields[model.entity] = {}
     }
 
-    model.cachedFields[model.entity][propertyKey] = callback(model)
+    model.cachedFields[model.entity][propertyKey] = callback(model, propertyKey)
   }
 }
+
+export default Field

src/decorators/HasMany.ts

@@ -0,0 +1,13 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function HasMany (
+  related: FunctorOrValue<typeof Model | string>, foreignKey: FunctorOrValue<string>,
+  localKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.hasMany as any)(...[related, foreignKey, localKey].map(unwrapFunctorOrValue)))
+}
+
+export default HasMany

src/decorators/HasManyBy.ts

@@ -0,0 +1,13 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function HasManyBy (
+  parent: FunctorOrValue<typeof Model | string>, foreignKey: FunctorOrValue<string>,
+  ownerKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.hasManyBy as any)(...[parent, foreignKey, ownerKey].map(unwrapFunctorOrValue)))
+}
+
+export default HasManyBy

src/decorators/HasManyThrough.ts

@@ -0,0 +1,15 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function HasManyThrough (
+  related: FunctorOrValue<typeof Model | string>,
+  through: FunctorOrValue<typeof Model | string>,
+  firstKey: FunctorOrValue<string>, secondKey: FunctorOrValue<string>,
+  localKey?: FunctorOrValue<string>, secondLocalKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.hasManyThrough as any)(...[related, through, firstKey, secondKey, localKey, secondLocalKey].map(unwrapFunctorOrValue)))
+}
+
+export default HasManyThrough

src/decorators/HasOne.ts

@@ -0,0 +1,13 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function HasOne (
+  related: FunctorOrValue<typeof Model | string>, foreignKey: FunctorOrValue<string>,
+  localKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.hasOne as any)(...[related, foreignKey, localKey].map(unwrapFunctorOrValue)))
+}
+
+export default HasOne

src/decorators/Increment.ts

@@ -0,0 +1,8 @@
+import PropertyDecorator from '../contracts/PropertyDecorator'
+import Field from './Field'
+
+export function Increment (): PropertyDecorator {
+  return Field(model => model.increment())
+}
+
+export default Increment

src/decorators/MorphMany.ts

@@ -0,0 +1,13 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function MorphMany (
+  related: FunctorOrValue<typeof Model | string>,
+  id: FunctorOrValue<string>, type: FunctorOrValue<string>, localKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.morphMany as any)(...[related, id, type, localKey].map(unwrapFunctorOrValue)))
+}
+
+export default MorphMany

src/decorators/MorphOne.ts

@@ -0,0 +1,13 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function MorphOne (
+  related: FunctorOrValue<typeof Model | string>,
+  id: FunctorOrValue<string>, type: FunctorOrValue<string>, localKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.morphOne as any)(...[related, id, type, localKey].map(unwrapFunctorOrValue)))
+}
+
+export default MorphOne

src/decorators/MorphTo.ts

@@ -0,0 +1,11 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function MorphTo (
+  id: FunctorOrValue<string>, type: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.morphTo as any)(...[id, type].map(unwrapFunctorOrValue)))
+}
+
+export default MorphTo

src/decorators/MorphToMany.ts

@@ -0,0 +1,15 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function MorphToMany (
+  related: FunctorOrValue<typeof Model | string>,
+  pivot: FunctorOrValue<typeof Model | string>,
+  relatedId: FunctorOrValue<string>, id: FunctorOrValue<string>, type: FunctorOrValue<string>,
+  parentKey?: FunctorOrValue<string>, relatedKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.morphToMany as any)(...[related, pivot, relatedId, id, type, parentKey, relatedKey].map(unwrapFunctorOrValue)))
+}
+
+export default MorphToMany

src/decorators/MorphedByMany.ts

@@ -0,0 +1,15 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
+import Field from './Field'
+
+export function MorphedByMany (
+  related: FunctorOrValue<typeof Model | string>,
+  pivot: FunctorOrValue<typeof Model | string>,
+  relatedId: FunctorOrValue<string>, id: FunctorOrValue<string>, type: FunctorOrValue<string>,
+  parentKey?: FunctorOrValue<string>, relatedKey?: FunctorOrValue<string>
+): PropertyDecorator {
+  return Field(model => (model.morphedByMany as any)(...[related, pivot, relatedId, id, type, parentKey, relatedKey].map(unwrapFunctorOrValue)))
+}
+
+export default MorphedByMany

src/decorators/Num.ts

@@ -1,10 +1,13 @@
 import PropertyDecorator from '../contracts/PropertyDecorator'
 import { TypeOptions } from '../options/Options'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
 import Primitive from './Primitive'
 
 /**
  * Create a num decorator.
  */
-export default function Num (value: number | null, options?: TypeOptions): PropertyDecorator {
-  return Primitive(model => model.number(value), options)
+export function Num (value?: FunctorOrValue<number> | null, options?: TypeOptions): PropertyDecorator {
+  return Primitive(model => model.number(unwrapFunctorOrValue(value)), options)
 }
+
+export default Num

src/decorators/PrimaryKey.ts

@@ -0,0 +1,21 @@
+import PropertyDecorator from '@/contracts/PropertyDecorator'
+import { Model } from '@vuex-orm/core'
+
+export function PrimaryKey (): PropertyDecorator {
+  return (target: Model, propertyKey: string): void => {
+    const model = target.constructor as typeof Model
+
+    // making the primary key values an array
+    // even if you have one and only one value there's no effect in functionality
+    if (!model.primaryKey) {
+      model.primaryKey = []
+    } else if (typeof model.primaryKey === 'string') {
+      const oldPrimaryKey = model.primaryKey
+      model.primaryKey = [oldPrimaryKey]
+    }
+
+    model.primaryKey.push(propertyKey)
+  }
+}
+
+export default PrimaryKey

src/decorators/Primitive.ts

@@ -8,20 +8,27 @@ type Callback = (model: typeof Model) => Type
 /**
  * Create a generic type decorator.
  */
-export default function Primitive (callback: Callback, options?: TypeOptions): PropertyDecorator {
-  return Field((model) => {
+export function Primitive (callback: Callback, options?: TypeOptions): PropertyDecorator {
+  return Field((model, propertyKey) => {
     const type = callback(model)
 
-    if (type.value === null && !options?.nullable) {
-      throw new Error(
-        "[Vuex ORM] You've defined the default value of a field as `null` " +
-        'without enabling `nullable` option. If you want the field to accept' +
-        '`null`, set `nullable` option to `true`.'
-      )
+    if (
+      typeof type?.value !== 'number' // if that number is 0, what will happen?! always remember it was coerced to false
+      && !(type?.value || options?.nullable)
+    ) {
+      throw new Error(`
+[Vuex ORM] You've defined the default value of a field as \`null\` without enabling \`nullable\` option.
+If you want the field to accept\`null\`, set \`nullable\` option to \`true\`.
+Problematic class name: ${model.name}; Related property key: ${propertyKey}
+      `)
     }
 
-    options?.nullable && type.nullable()
+    if (options?.nullable) {
+      type.nullable()
+    }
 
     return type
   })
 }
+
+export default Primitive

src/decorators/Str.ts

@@ -1,10 +1,13 @@
 import PropertyDecorator from '../contracts/PropertyDecorator'
 import { TypeOptions } from '../options/Options'
+import { FunctorOrValue, unwrapFunctorOrValue } from '../utils'
 import Primitive from './Primitive'
 
 /**
  * Create a str decorator.
  */
-export default function Str (value: string | null, options?: TypeOptions): PropertyDecorator {
-  return Primitive(model => model.string(value), options)
+export function Str (value?: FunctorOrValue<string> | null, options?: TypeOptions): PropertyDecorator {
+  return Primitive(model => model.string(unwrapFunctorOrValue(value)), options)
 }
+
+export default Str

src/decorators/index.ts

@@ -0,0 +1,20 @@
+export { Attribute } from './Attribute'
+export { BelongsTo } from './BelongsTo'
+export { BelongsToMany } from './BelongsToMany'
+export { Bool } from './Bool'
+export { DecoratedModel } from './DecoratedModel'
+export { Field } from './Field'
+export { HasMany } from './HasMany'
+export { HasManyBy } from './HasManyBy'
+export { HasManyThrough } from './HasManyThrough'
+export { HasOne } from './HasOne'
+export { Increment } from './Increment'
+export { MorphedByMany } from './MorphedByMany'
+export { MorphMany } from './MorphMany'
+export { MorphOne } from './MorphOne'
+export { MorphTo } from './MorphTo'
+export { MorphToMany } from './MorphToMany'
+export { Num } from './Num'
+export { PrimaryKey } from './PrimaryKey'
+export { Primitive } from './Primitive'
+export { Str } from './Str'