Typescript version

[panigrah]

I tried to convert the plugin to typescript. Leaving it here for you to use if of value. Its missing the hashing overrides for now as I did not need them in my project as yet.

import HashId from 'hashids/cjs'
import memoize from 'nano-memoize'
import { Model } from "objection"

const memoizeHashId = memoize(
  (salt:string, minLength: number, alphabet?:string, seps?:string) =>
    new HashId(salt, minLength, alphabet, seps)
)

interface IConstructor extends Function {
  _hashIdInstance: {
    encode: (id: number) => string;
    decode: (hashId: string) => number;
  };
  hashIdField: string;
  hashedFields: string [];
}

class HashedQueryBuilder<M extends Model, R = M[]> extends Model.QueryBuilder<M, R> {

  findByHashId (hashId: string) {
    const id = (this.modelClass() as unknown as IConstructor)._hashIdInstance.decode(hashId)
    const compoundPK = Array.isArray(this.modelClass().idColumn)

    return this.findById(compoundPK ? id : id[0])
  }
}

export default <M extends typeof Model>(ModelClass: typeof Model): M => {
  return class extends ModelClass {
    static get hashIdSalt () {
      return this.name
    }

    static get hashIdMinLength () {
      return 6
    }

    static get _hashIdInstance () {
      return memoizeHashId(this.hashIdSalt, this.hashIdMinLength)
    }

    get hashId () {
      const conf = this.constructor as IConstructor;
      return conf._hashIdInstance.encode(this.$id())
    }

    get hashid () {
      return this.hashId
    }

    // This field indicates what property the hashid is written under.
    // By default, it overwrites id, but if you're using Algolia, for example,
    // it may be useful to set a custom id field as "ObjectID".
    static get hashIdField () {
      return 'id'
    }

    // These are all of the **non-id** fields that are hashed.
    // Useful if you have FK references that points to an id that is hashed.
    static get hashedFields () {
      return []
    }

    $formatJson (obj: {}) {
      let formattedJson = super.$formatJson(obj)
      const conf = this.constructor as IConstructor;

      // inject the hashed PK into the resulting JSON - a reminder
      // that hashId/hashid fields are virtual and do not get written to JSON.
      if (conf?.hashIdField) {
        formattedJson[conf.hashIdField] = this.hashId
      }

      // hash the rest of the fields
      conf.hashedFields.forEach(field => {
        formattedJson[field] = conf._hashIdInstance.encode(formattedJson[field])
      })

      return formattedJson
    }

    QueryBuilderType!: HashedQueryBuilder<this>
    static QueryBuilder = HashedQueryBuilder

  } as unknown as M
}

[issue-label-bot]

Issue Label Bot is not confident enough to auto-label this issue. See dashboard for more details.

[JaneJeon]

Like I said on the other issue, if you could make a PR with the tests passing I'd greatly appreciate it. Thanks!

[JaneJeon]

See #51 and #61 if you want to continue, thanks!