add basic design for allowing to set letterCase

Author: jannishuebl

src/model.ts

@@ -47,6 +47,7 @@ export interface ModelConfiguration {
   jwt: string
   jwtStorage: string | false
   camelizeKeys: boolean
+  letterCase: string
   strictAttributes: boolean
   logger: ILogger
 }
@@ -129,6 +130,7 @@ export class JSORMBase {
   static isBaseClass: boolean
   static jwt?: string
   static camelizeKeys: boolean = true
+  static letterCase: string = "underscore"
   static strictAttributes: boolean = false
   static logger: ILogger = defaultLogger
 
@@ -408,7 +410,7 @@ export class JSORMBase {
     this.reset()
   }
 
-  reset() : void {
+  reset(): void {
     this._originalAttributes = cloneDeep(this._attributes)
     this._originalRelationships = this.relationshipResourceIdentifiers(
       Object.keys(this.relationships)

src/util/write-payload.ts

@@ -2,7 +2,7 @@ import { JSORMBase, ModelRecord } from "../model"
 import { IncludeDirective, IncludeScopeHash } from "./include-directive"
 import { IncludeScope } from "../scope"
 import { tempId } from "./temp-id"
-import { underscore } from "inflected"
+import { underscore, dasherize } from "inflected"
 import {
   JsonapiRequestDoc,
   JsonapiResourceIdentifier,
@@ -33,10 +33,8 @@ export class WritePayload<T extends JSORMBase> {
     const attrs: ModelRecord<T> = {}
 
     this._eachAttribute((key, value) => {
-      const snakeKey = underscore(key)
-
       if (!this.model.isPersisted || this.model.changes()[key]) {
-        attrs[snakeKey] = value
+        attrs[this._letterCaseKey(key)] = value
       }
     })
 
@@ -88,8 +86,8 @@ export class WritePayload<T extends JSORMBase> {
       const nested = (<any>this.includeDirective)[key]
 
       let idOnly = false
-      if (key.indexOf('.') > -1) {
-        key = key.split('.')[0]
+      if (key.indexOf(".") > -1) {
+        key = key.split(".")[0]
         idOnly = true
       }
 
@@ -101,8 +99,8 @@ export class WritePayload<T extends JSORMBase> {
           relatedModels.forEach(relatedModel => {
             if (
               idOnly ||
-                this.model.hasDirtyRelation(key, relatedModel) ||
-                relatedModel.isDirty(nested)
+              this.model.hasDirtyRelation(key, relatedModel) ||
+              relatedModel.isDirty(nested)
             ) {
               data.push(this._processRelatedModel(relatedModel, nested, idOnly))
             }
@@ -115,15 +113,15 @@ export class WritePayload<T extends JSORMBase> {
           // (maybe the "department" is not dirty, but the employee changed departments
           if (
             idOnly ||
-              this.model.hasDirtyRelation(key, relatedModels) ||
-              relatedModels.isDirty(nested)
+            this.model.hasDirtyRelation(key, relatedModels) ||
+            relatedModels.isDirty(nested)
           ) {
             data = this._processRelatedModel(relatedModels, nested, idOnly)
           }
         }
 
         if (data) {
-          _relationships[underscore(key)] = { data }
+          _relationships[this._letterCaseKey(key)] = { data }
         }
       }
     })
@@ -169,7 +167,11 @@ export class WritePayload<T extends JSORMBase> {
 
   // private
 
-  private _processRelatedModel(model: T, nested: IncludeScopeHash, idOnly: boolean) {
+  private _processRelatedModel(
+    model: T,
+    nested: IncludeScopeHash,
+    idOnly: boolean
+  ) {
     model.clearErrors()
 
     if (!model.isPersisted) {
@@ -252,4 +254,11 @@ export class WritePayload<T extends JSORMBase> {
       }
     })
   }
+
+  private _letterCaseKey(key): string {
+    if (this.model.klass.letterCase == "dasherized") {
+      return dasherize(key)
+    }
+    return underscore(key)
+  }
 }

test/fixtures.ts

@@ -35,6 +35,9 @@ export class PersonWithoutCamelizedKeys extends Person {
   @Attr first_name: string
 }
 
+@Model({ letterCase: "dasherized" })
+export class PersonWithDasherizedKeys extends Person {}
+
 @Model({
   endpoint: "/v1/authors",
   jsonapiType: "authors"

test/unit/model-attributes.test.ts

@@ -20,6 +20,11 @@ describe("Model attributes", () => {
     expect(person.firstName).to.eq("Joe")
   })
 
+  xit("camelizes dasherized strings", function() {
+    const person = new Person({ "first-name": "Joe" })
+    expect(person.firstName).to.eq("Joe")
+  })
+
   it("does not camlize underscored strings if camelization is disabled", () => {
     const person = new PersonWithoutCamelizedKeys({ first_name: "Joe" })
     expect(person.firstName).to.eq(undefined)

test/unit/write-payload.test.ts

@@ -0,0 +1,31 @@
+import { sinon, expect } from "../test-helper"
+import { WritePayload } from "../../src/util/write-payload"
+import { Person, PersonWithDasherizedKeys } from "../fixtures"
+
+describe("WritePayload", () => {
+  it("underscores attributes", function() {
+    let person = new Person({ first_name: "Joe" })
+    let payload = new WritePayload(person, true)
+    expect(payload.asJSON()).to.deep.equal({
+      data: {
+        type: "people",
+        attributes: {
+          first_name: "Joe"
+        }
+      }
+    })
+  })
+
+  xit("dasherizes attributes", function() {
+    let person = new PersonWithDasherizedKeys({ first_name: "Joe" })
+    let payload = new WritePayload(person, true)
+    expect(payload.asJSON()).to.deep.equal({
+      data: {
+        type: "people",
+        attributes: {
+          "first-name": "Joe"
+        }
+      }
+    })
+  })
+})