Doc enhancement: Custom validations in v3.0

[SukantGujar]

How can I setup custom validations for a Model in v3?

Thanks

[jmdobry]

Is this what you're looking for?

class MyModel extends Mapper {
  validate (...args) {
    // do something custom
    return super.validate(...args);
}

[SukantGujar]

Thanks. Did I miss this in the documentation somewhere?

[jmdobry]

I'm not sure it is documented specifically like what I showed. My example just takes advantage of the fact that all of the components in JSData 3.x are just classes that can be extended and customized to meet your needs.

[jmdobry]

Do you have any specific feedback on how this guide could be improved? http://www.js-data.io/v3.0/docs/validation

[SukantGujar]

At first I was looking at Schema for the ability to add custom validations as somehow it felt more natural to me that all validation needs would be its responsibility. Maybe having a hint about Mapper extension for this purpose would make it more clear.

Thanks

[jmdobry]

Will do

[jrdn91]

I'm having trouble implementing a custom validator, I've pasted this validate override method in all the places I can think and none of them ever get called. Where am I intended to override the validate method?

[crobinson42]

@jrdn91 are you extending the Mapper class and using the examples above ?

[jrdn91]

class UserMapper extends Mapper {
  validate(...args) {
    console.log("user validate args: ", { args })
    // do something custom
    return super.validate(...args)
  }
  authenticate(data) {
    return store2
      .getAdapter("http")
      .http({
        url: "auth",
        method: "POST",
        headers: {
          "Content-Type": "application/json"
        },
        data
      })
      .then(response => {
        store2.getAdapter("http").http.defaults.headers.common[
          "Authorization"
        ] = response.data.token
        const data = (this.loggedInUser = response.data)
        return store2.find("user", data.id).catch(err => {
          console.log(err.message)
          console.log(err.errors)
        })
      })
  }
}

store2.defineMapper("user", {
  endpoint: "users",
  schema: userSchema,
  recordClass: User,
  mapperClass: UserMapper
})

When I call

store2
.getMapper("user")
.authenticate(data)
.then(res => {
  console.log(res)
  resolve(res)
})

This works fine, I can override other mapper methods such as beforeFind and afterFind and they seem to be overrideable

[crobinson42]

I think the validate override works in the recordClass… but I’d have to check, I’ll look into this later when I have time and try to help.

…

On Nov 11, 2019, at 2:33 PM, Jordan ***@***.***> wrote: class UserMapper extends Mapper { validate(...args) { console.log("user validate args: ", { args }) // do something custom return super.validate(...args) } authenticate(data) { return store2 .getAdapter("http") .http({ url: "auth", method: "POST", headers: { "Content-Type": "application/json" }, data }) .then(response => { store2.getAdapter("http").http.defaults.headers.common[ "Authorization" ] = response.data.token const data = (this.loggedInUser = response.data) return store2.find("user", data.id).catch(err => { console.log(err.message) console.log(err.errors) }) }) } } store2.defineMapper("user", { endpoint: "users", schema: userSchema, recordClass: User, mapperClass: UserMapper }) When I call store2 .getMapper("user") .authenticate(data) .then(res => { console.log(res) resolve(res) }) This works fine, I can override other mapper methods such as beforeFind and afterFind and they seem to be overrideable — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#424?email_source=notifications&email_token=ABNSMS2US4642ZTDUSWCER3QTHMUXA5CNFSM4CYU6G72YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEDYLXAI#issuecomment-552647553>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABNSMS7EVE4VZ5J6UNNPAV3QTHMUXANCNFSM4CYU6G7Q>.

[jrdn91]

Trying this also doesn't seem to override

// Custom class
class User extends Record {
  constructor(props) {
    super(props)
  }
  get formattedPhone() {
    const phoneNumber = parsePhoneNumberFromString(this.phone)
    return phoneNumber.formatNational()
  }
  validate(...args) {
    // do some custom validation
    console.log({ args })
    // if (/* some condition */) {
    //   return [{ expected: 'some expectation', actual: 'actual value' }];
    // }
    // resume default behavior
    return super.validate(...args)
  }
}

[jrdn91]

This is the authenticate function I'm actually using which sets the user returned from the .find method on the user mapper which is what is triggering validator

authenticate(data) {
    if (this.loggedInUser) {
      return utils.resolve(this.loggedInUser)
    }
    return store2
      .getAdapter("http")
      .http({
        url: "auth",
        method: "POST",
        headers: {
          "Content-Type": "application/json"
        },
        data
      })
      .then(response => {
        store2.getAdapter("http").http.defaults.headers.common[
          "Authorization"
        ] = response.data.token
        const data = (this.loggedInUser = response.data)
        store2
          .find("user", data.id)
          .then(res => {
            const user = res.data
            if (user) {
              this.loggedInUser = store2.add("user", user)
            }
            return this.loggedInUser
          })
          .catch(err => {
            console.log(err.message)
            console.log(err.errors)
          })
      })
  }

[crobinson42]

@jrdn91 you need to declare validate override in the mapper definition:

const Ajv = require('ajv')
const schema = require('./index').schema
const v = new Ajv().compile(schema)

const validate = function (...args) {
   console.log('args[0]', args[0])

   const valid = v(...args)

   if (!valid) return v.errors

   console.log('**** valid', )

   return undefined
 }

// define the mapper
store.defineMapper('user', { validate })