@anephenix/objection-relations 0.0.1 → 0.0.2

package/dist/objection-relations.cjs.production.min.js.map

@@ -1 +1 @@
-{"version":3,"file":"objection-relations.cjs.production.min.js","sources":["../src/index.ts"],"sourcesContent":["// Dependencies\nimport { Model } from 'objection';\nconst {\n\tHasOneRelation,\n\tBelongsToOneRelation,\n\tHasManyRelation,\n\tManyToManyRelation,\n} = Model;\nimport snakeCase from 'lodash.snakecase';\nimport pluralize from 'pluralize';\n\ntype CommonRelationOrTableOrForeignKeyProps = {\n    options?: {\n        subjectTable?: string;\n        objectTable?: string;\n        subjectForeignKey?: string;\n        objectForeignKey?: string;\n    }\n}\n\ntype RelationProps = CommonRelationOrTableOrForeignKeyProps & {\n    subject: string;\n    relType: 'hasOne' | 'hasMany' | 'hasManyThrough' | 'belongsTo';\n    object: string;\n    via?: string;\n}\n\ntype RelationTypeProps = {\n    modelClass: string;\n    from: string;\n    to: string;\n};\n\ntype AdvancedRelationTypeProps = RelationTypeProps & {\n    through: {\n        from: string;\n        to: string;\n    };\n}\n\ntype SubjectProps = CommonRelationOrTableOrForeignKeyProps & {\n    subject: string;\n}\n\ntype ObjectProps = CommonRelationOrTableOrForeignKeyProps & {\n    object: string;\n}\n\n/*\n    Defines a relationship where a record in one model can belong to a record in\n    another model.\n*/\nexport function belongsRelation({ modelClass, from, to }:RelationTypeProps) {\n\treturn {\n\t\trelation: BelongsToOneRelation,\n\t\tmodelClass,\n\t\tjoin: { from, to },\n\t};\n};\n\n/*\n\tDefines a relationship where a record in one model can own a record in another\n\tmodel.\n*/\nexport function hasOneRelation({ modelClass, from, to }:RelationTypeProps) {\n\treturn {\n\t\trelation: HasOneRelation,\n\t\tmodelClass,\n\t\tjoin: { from, to },\n\t};\n};\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model.\n*/\nexport function hasManyRelation({ modelClass, from, to }:RelationTypeProps) {\n\treturn {\n\t\trelation: HasManyRelation,\n        modelClass,\n\t\tjoin: { from, to },\n\t};\n};\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model, via a join table\n*/\nexport function hasManyThroughRelation({ modelClass, from, through, to }:AdvancedRelationTypeProps) {\n\treturn {\n\t\trelation: ManyToManyRelation,\n        modelClass,\n\t\tjoin: { from, through, to },\n\t};\n};\n\n/*\n    Gets the SQL table for the subject, either from the options object or the\n    plural version of the subject model.\n*/\nexport function getSubjectTable({ subject, options }:SubjectProps) {\n    return options?.subjectTable || pluralize(snakeCase(subject));\n}\n\n/*\n    Gets the SQL table for the object, either from the options object or the\n    plural version of the object model.\n*/\nexport function getObjectTable({ object, options }:ObjectProps) { \n    return options?.objectTable || pluralize(snakeCase(object));\n}\n\n/*\n    Gets the SQL foreign key for the subject, either from the options object \n    or the snake case of the subject model.\n*/\nexport function getSubjectForeignKey({ subject, options }:SubjectProps) {\n    return options?.subjectForeignKey || snakeCase(subject) + '_id';\n}\n\n/*\n    Gets the SQL foreign key for the object, either from the options object \n    or the snake case of the object model.\n*/\nexport function getObjectForeignKey({ object, options }:ObjectProps) {\n    return options?.objectForeignKey || snakeCase(object) + '_id';\n}\n\n/*\n\tDefines a relationship by passing the subject, the predicate, and the object,\n\talong with an optional via model.\n*/\nexport function relation({subject, relType, object, via, options}:RelationProps) {\n\tconst subjectTable = getSubjectTable({subject, options});\n\tconst objectTable = getObjectTable({object, options});\n\tconst subjectForeignKey = getSubjectForeignKey({subject, options});\n\tconst objectForeignKey = getObjectForeignKey({object, options});\n\tlet viaTable;\n\tif (via) viaTable = pluralize(snakeCase(via));\n\tswitch (relType) {\n\t\tcase 'hasOne':\n\t\t\treturn hasOneRelation({\n                modelClass: object,\n\t\t\t\tfrom: `${subjectTable}.id`,\n\t\t\t\tto: `${objectTable}.${subjectForeignKey}`\n            });\n\t\tcase 'hasMany':\n\t\t\treturn hasManyRelation({\n\t\t\t\tmodelClass: object,\n\t\t\t\tfrom: `${subjectTable}.id`,\n\t\t\t\tto: `${objectTable}.${subjectForeignKey}`\n\t\t\t});\n\t\tcase 'hasManyThrough':\n\t\t\treturn hasManyThroughRelation({\n\t\t\t\tmodelClass: object,\n\t\t\t\tfrom: `${subjectTable}.id`,\n\t\t\t\tthrough: {\n\t\t\t\t\tfrom: `${viaTable}.${subjectForeignKey}`,\n\t\t\t\t\tto: `${viaTable}.${objectForeignKey}`,\n\t\t\t\t},\n\t\t\t\tto: `${objectTable}.id`\n            });\n\t\tcase 'belongsTo':\n\t\t\treturn belongsRelation({\n\t\t\t\tmodelClass: object,\n\t\t\t\tfrom: `${subjectTable}.${objectForeignKey}`,\n\t\t\t\tto: `${objectTable}.id`\n            });\n\t\tdefault:\n\t\t\tthrow new Error('No valid relationship type specified');\n\t}\n};"],"names":["HasOneRelation","BelongsToOneRelation","HasManyRelation","ManyToManyRelation","Model","belongsRelation","modelClass","from","to","relation","join","hasOneRelation","hasManyRelation","hasManyThroughRelation","through","getSubjectTable","subject","options","subjectTable","pluralize","snakeCase","getObjectTable","object","objectTable","getSubjectForeignKey","subjectForeignKey","getObjectForeignKey","objectForeignKey","relType","via","viaTable","Error"],"mappings":"gOAEA,MAAMA,eACLA,EADKC,qBAELA,EAFKC,gBAGLA,EAHKC,mBAILA,GACGC,iBA6CYC,GAAgBC,WAAEA,EAAFC,KAAcA,EAAdC,GAAoBA,UAC5C,CACNC,SAAUR,EACVK,WAAAA,EACAI,KAAM,CAAEH,KAAAA,EAAMC,GAAAA,aAQAG,GAAeL,WAAEA,EAAFC,KAAcA,EAAdC,GAAoBA,UAC3C,CACNC,SAAUT,EACVM,WAAAA,EACAI,KAAM,CAAEH,KAAAA,EAAMC,GAAAA,aAQAI,GAAgBN,WAAEA,EAAFC,KAAcA,EAAdC,GAAoBA,UAC5C,CACNC,SAAUP,EACJI,WAAAA,EACNI,KAAM,CAAEH,KAAAA,EAAMC,GAAAA,aAQAK,GAAuBP,WAAEA,EAAFC,KAAcA,EAAdO,QAAoBA,EAApBN,GAA6BA,UAC5D,CACNC,SAAUN,EACJG,WAAAA,EACNI,KAAM,CAAEH,KAAAA,EAAMO,QAAAA,EAASN,GAAAA,aAQTO,GAAgBC,QAAEA,EAAFC,QAAWA,iBAChCA,SAAAA,EAASC,eAAgBC,EAAUC,EAAUJ,aAOxCK,GAAeC,OAAEA,EAAFL,QAAUA,iBAC9BA,SAAAA,EAASM,cAAeJ,EAAUC,EAAUE,aAOvCE,GAAqBR,QAAEA,EAAFC,QAAWA,iBACrCA,SAAAA,EAASQ,oBAAqBL,EAAUJ,GAAW,eAO9CU,GAAoBJ,OAAEA,EAAFL,QAAUA,iBACnCA,SAAAA,EAASU,mBAAoBP,EAAUE,GAAU,+PAOnCN,QAACA,EAADY,QAAUA,EAAVN,OAAmBA,EAAnBO,IAA2BA,EAA3BZ,QAAgCA,UAClDC,EAAeH,EAAgB,CAACC,QAAAA,EAASC,QAAAA,IACzCM,EAAcF,EAAe,CAACC,OAAAA,EAAQL,QAAAA,IACtCQ,EAAoBD,EAAqB,CAACR,QAAAA,EAASC,QAAAA,IACnDU,EAAmBD,EAAoB,CAACJ,OAAAA,EAAQL,QAAAA,QAClDa,SACAD,IAAKC,EAAWX,EAAUC,EAAUS,KAChCD,OACF,gBACGjB,EAAe,CACTL,WAAYgB,EACxBf,KAASW,QACTV,MAAOe,KAAeE,UAEnB,iBACGb,EAAgB,CACtBN,WAAYgB,EACZf,KAASW,QACTV,MAAOe,KAAeE,UAEnB,wBACGZ,EAAuB,CAC7BP,WAAYgB,EACZf,KAASW,QACTJ,QAAS,CACRP,QAASuB,KAAYL,IACrBjB,MAAOsB,KAAYH,KAEpBnB,GAAOe,cAEJ,mBACGlB,EAAgB,CACtBC,WAAYgB,EACZf,QAASW,KAAgBS,IACzBnB,GAAOe,wBAGF,IAAIQ,MAAM"}
+{"version":3,"file":"objection-relations.cjs.production.min.js","sources":["../src/relations.ts","../src/helpers.ts","../src/index.ts"],"sourcesContent":["// Dependencies\nimport { Model } from 'objection';\nimport {\n  RelationTypeProps,\n  CommonRelationOrTableOrForeignKeyProps,\n} from './global';\nimport {\n  getSubjectTable,\n  getSubjectForeignKey,\n  getObjectTable,\n  getObjectForeignKey,\n  getModelClass,\n  getViaTable,\n} from './helpers';\n\nconst {\n  HasOneRelation,\n  BelongsToOneRelation,\n  HasManyRelation,\n  ManyToManyRelation,\n} = Model;\n\n// Types\n\ntype AdvancedRelationTypeProps = RelationTypeProps & {\n  through: {\n    from: string;\n    to: string;\n  };\n};\n\n/*\n    Defines a relationship where a record in one model can belong to a record in\n    another model.\n*/\nexport function belongsRelation({ modelClass, from, to }: RelationTypeProps) {\n  return {\n    relation: BelongsToOneRelation,\n    modelClass,\n    join: { from, to },\n  };\n}\n\n/*\n\tDefines a relationship where a record in one model can own a record in another\n\tmodel.\n*/\nexport function hasOneRelation({ modelClass, from, to }: RelationTypeProps) {\n  return {\n    relation: HasOneRelation,\n    modelClass,\n    join: { from, to },\n  };\n}\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model.\n*/\nexport function hasManyRelation({ modelClass, from, to }: RelationTypeProps) {\n  return {\n    relation: HasManyRelation,\n    modelClass,\n    join: { from, to },\n  };\n}\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model, via a join table\n*/\nexport function hasManyThroughRelation({\n  modelClass,\n  from,\n  through,\n  to,\n}: AdvancedRelationTypeProps) {\n  return {\n    relation: ManyToManyRelation,\n    modelClass,\n    join: { from, through, to },\n  };\n}\n\ntype RelationProps = CommonRelationOrTableOrForeignKeyProps & {\n  subject: string;\n  relType: 'hasOne' | 'hasMany' | 'hasManyThrough' | 'belongsTo';\n  object: string;\n  via?: string;\n};\n\n/*\n\tDefines a relationship by passing the subject, the predicate, and the object,\n\talong with an optional via model.\n*/\nexport function relation({\n  subject,\n  relType,\n  object,\n  via,\n  options,\n}: RelationProps) {\n  const subjectTable = getSubjectTable({ subject, options });\n  const objectTable = getObjectTable({ object, options });\n  const subjectForeignKey = getSubjectForeignKey({ subject, options });\n  const objectForeignKey = getObjectForeignKey({ object, options });\n  const modelClass = getModelClass({ object, options });\n  const viaTable = getViaTable(via);\n  switch (relType) {\n    case 'hasOne':\n      return hasOneRelation({\n        modelClass,\n        from: `${subjectTable}.id`,\n        to: `${objectTable}.${subjectForeignKey}`,\n      });\n    case 'hasMany':\n      return hasManyRelation({\n        modelClass,\n        from: `${subjectTable}.id`,\n        to: `${objectTable}.${subjectForeignKey}`,\n      });\n    case 'hasManyThrough':\n      return hasManyThroughRelation({\n        modelClass,\n        from: `${subjectTable}.id`,\n        through: {\n          from: `${viaTable}.${subjectForeignKey}`,\n          to: `${viaTable}.${objectForeignKey}`,\n        },\n        to: `${objectTable}.id`,\n      });\n    case 'belongsTo':\n      return belongsRelation({\n        modelClass,\n        from: `${subjectTable}.${objectForeignKey}`,\n        to: `${objectTable}.id`,\n      });\n    default:\n      throw new Error('No valid relationship type specified');\n  }\n}\n","import snakeCase from 'lodash.snakecase';\nimport pluralize from 'pluralize';\nimport { join } from 'path';\nimport { CommonRelationOrTableOrForeignKeyProps } from './global';\n\n// Types\n\ntype SubjectProps = CommonRelationOrTableOrForeignKeyProps & {\n  subject: string;\n};\n\ntype ObjectProps = CommonRelationOrTableOrForeignKeyProps & {\n  object: string;\n};\n\ntype ViaProps = string | undefined;\n\n/*\n    Gets the SQL table for the subject, either from the options object or the\n    plural version of the subject model.\n*/\nexport function getSubjectTable({ subject, options }: SubjectProps) {\n  return options?.subjectTable || pluralize(snakeCase(subject));\n}\n\n/*\n    Gets the SQL table for the object, either from the options object or the\n    plural version of the object model.\n*/\nexport function getObjectTable({ object, options }: ObjectProps) {\n  return options?.objectTable || pluralize(snakeCase(object));\n}\n\n/*\n    Gets the SQL foreign key for the subject, either from the options object \n    or the snake case of the subject model.\n*/\nexport function getSubjectForeignKey({ subject, options }: SubjectProps) {\n  return options?.subjectForeignKey || snakeCase(subject) + '_id';\n}\n\n/*\n    Gets the SQL foreign key for the object, either from the options object \n    or the snake case of the object model.\n*/\nexport function getObjectForeignKey({ object, options }: ObjectProps) {\n  return options?.objectForeignKey || snakeCase(object) + '_id';\n}\n\n/*\n\tAllows you to define the model path for a model\n*/\nexport function getModelClass({ object, options }: ObjectProps) {\n  return options?.modelPath ? join(options.modelPath, object) : object;\n}\n\nexport function getViaTable(via: ViaProps) {\n  return via ? pluralize(snakeCase(via)) : null;\n}\n","// Dependencies\nimport { OptionsProps } from './global';\nimport { relation } from './relations';\n\n// Types\n\ntype ObjectionRelationProps = {\n  subject: string;\n  modelPath: string;\n};\n\nexport class ObjectionRelation {\n  subject: string;\n  modelPath: string;\n  constructor({ subject, modelPath }: ObjectionRelationProps) {\n    this.subject = subject;\n    this.modelPath = modelPath;\n  }\n\n  belongsTo(object: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'belongsTo',\n      object,\n      options,\n    });\n  }\n\n  hasOne(object: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'hasOne',\n      object,\n      options,\n    });\n  }\n\n  hasMany(object: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'hasMany',\n      object,\n      options,\n    });\n  }\n\n  hasManyThrough(object: string, via: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'hasManyThrough',\n      object,\n      via,\n      options,\n    });\n  }\n}\n"],"names":["HasOneRelation","BelongsToOneRelation","HasManyRelation","ManyToManyRelation","Model","relation","subject","relType","object","via","options","subjectTable","pluralize","snakeCase","getSubjectTable","objectTable","getObjectTable","subjectForeignKey","getSubjectForeignKey","objectForeignKey","getObjectForeignKey","modelClass","modelPath","join","getModelClass","viaTable","getViaTable","from","to","hasOneRelation","hasManyRelation","through","hasManyThroughRelation","belongsRelation","Error","constructor","belongsTo","this","hasOne","hasMany","hasManyThrough"],"mappings":"kPAeA,MAAMA,eACJA,EADIC,qBAEJA,EAFIC,gBAGJA,EAHIC,mBAIJA,GACEC,QA2EJ,SAAgBC,GAASC,QACvBA,EADuBC,QAEvBA,EAFuBC,OAGvBA,EAHuBC,IAIvBA,EAJuBC,QAKvBA,UAEMC,YCjFwBL,QAAEA,EAAFI,QAAWA,iBAClCA,SAAAA,EAASC,eAAgBC,EAAUC,EAAUP,IDgF/BQ,CAAgB,CAAER,QAAAA,EAASI,QAAAA,IAC1CK,YC1EuBP,OAAEA,EAAFE,QAAUA,iBAChCA,SAAAA,EAASK,cAAeH,EAAUC,EAAUL,IDyE/BQ,CAAe,CAAER,OAAAA,EAAQE,QAAAA,IACvCO,YCnE6BX,QAAEA,EAAFI,QAAWA,iBACvCA,SAAAA,EAASO,oBAAqBJ,EAAUP,GAAW,MDkEhCY,CAAqB,CAAEZ,QAAAA,EAASI,QAAAA,IACpDS,YC5D4BX,OAAEA,EAAFE,QAAUA,iBACrCA,SAAAA,EAASS,mBAAoBN,EAAUL,GAAU,MD2D/BY,CAAoB,CAAEZ,OAAAA,EAAQE,QAAAA,IACjDW,YCtDsBb,OAAEA,EAAFE,QAAUA,iBAC/BA,GAAAA,EAASY,UAAYC,OAAKb,EAAQY,UAAWd,GAAUA,EDqD3CgB,CAAc,CAAEhB,OAAAA,EAAQE,QAAAA,IACrCe,WCnDoBhB,UACnBA,EAAMG,EAAUC,EAAUJ,IAAQ,KDkDxBiB,CAAYjB,UACrBF,OACD,gBA9DT,UAA+Bc,WAAEA,EAAFM,KAAcA,EAAdC,GAAoBA,UAC1C,CACLvB,SAAUL,EACVqB,WAAAA,EACAE,KAAM,CAAEI,KAAAA,EAAMC,GAAAA,IA2DLC,CAAe,CACpBR,WAAAA,EACAM,KAAShB,QACTiB,MAAOb,KAAeE,UAErB,iBAxDT,UAAgCI,WAAEA,EAAFM,KAAcA,EAAdC,GAAoBA,UAC3C,CACLvB,SAAUH,EACVmB,WAAAA,EACAE,KAAM,CAAEI,KAAAA,EAAMC,GAAAA,IAqDLE,CAAgB,CACrBT,WAAAA,EACAM,KAAShB,QACTiB,MAAOb,KAAeE,UAErB,wBAlDT,UAAuCI,WACrCA,EADqCM,KAErCA,EAFqCI,QAGrCA,EAHqCH,GAIrCA,UAEO,CACLvB,SAAUF,EACVkB,WAAAA,EACAE,KAAM,CAAEI,KAAAA,EAAMI,QAAAA,EAASH,GAAAA,IA0CdI,CAAuB,CAC5BX,WAAAA,EACAM,KAAShB,QACToB,QAAS,CACPJ,QAASF,KAAYR,IACrBW,MAAOH,KAAYN,KAErBS,GAAOb,cAEN,mBAhGT,UAAgCM,WAAEA,EAAFM,KAAcA,EAAdC,GAAoBA,UAC3C,CACLvB,SAAUJ,EACVoB,WAAAA,EACAE,KAAM,CAAEI,KAAAA,EAAMC,GAAAA,IA6FLK,CAAgB,CACrBZ,WAAAA,EACAM,QAAShB,KAAgBQ,IACzBS,GAAOb,wBAGH,IAAImB,MAAM,yEE5HpBC,aAAY7B,QAAEA,EAAFgB,UAAWA,SAChBhB,QAAUA,OACVgB,UAAYA,EAGnBc,UAAU5B,EAAgBE,UACnBA,IAASA,EAAU,CAAEY,UAAWe,KAAKf,YACrCZ,EAAQY,YAAWZ,EAAQY,UAAYe,KAAKf,WAC1CjB,EAAS,CACdC,QAAS+B,KAAK/B,QACdC,QAAS,YACTC,OAAAA,EACAE,QAAAA,IAIJ4B,OAAO9B,EAAgBE,UAChBA,IAASA,EAAU,CAAEY,UAAWe,KAAKf,YACrCZ,EAAQY,YAAWZ,EAAQY,UAAYe,KAAKf,WAC1CjB,EAAS,CACdC,QAAS+B,KAAK/B,QACdC,QAAS,SACTC,OAAAA,EACAE,QAAAA,IAIJ6B,QAAQ/B,EAAgBE,UACjBA,IAASA,EAAU,CAAEY,UAAWe,KAAKf,YACrCZ,EAAQY,YAAWZ,EAAQY,UAAYe,KAAKf,WAC1CjB,EAAS,CACdC,QAAS+B,KAAK/B,QACdC,QAAS,UACTC,OAAAA,EACAE,QAAAA,IAIJ8B,eAAehC,EAAgBC,EAAaC,UACrCA,IAASA,EAAU,CAAEY,UAAWe,KAAKf,YACrCZ,EAAQY,YAAWZ,EAAQY,UAAYe,KAAKf,WAC1CjB,EAAS,CACdC,QAAS+B,KAAK/B,QACdC,QAAS,iBACTC,OAAAA,EACAC,IAAAA,EACAC,QAAAA"}

package/dist/objection-relations.esm.js

@@ -1,6 +1,65 @@
 import { Model } from 'objection';
 import snakeCase from 'lodash.snakecase';
 import pluralize from 'pluralize';
+import { join } from 'path';
+
+/*
+    Gets the SQL table for the subject, either from the options object or the
+    plural version of the subject model.
+*/
+
+function getSubjectTable({
+  subject,
+  options
+}) {
+  return (options == null ? void 0 : options.subjectTable) || pluralize(snakeCase(subject));
+}
+/*
+    Gets the SQL table for the object, either from the options object or the
+    plural version of the object model.
+*/
+
+function getObjectTable({
+  object,
+  options
+}) {
+  return (options == null ? void 0 : options.objectTable) || pluralize(snakeCase(object));
+}
+/*
+    Gets the SQL foreign key for the subject, either from the options object
+    or the snake case of the subject model.
+*/
+
+function getSubjectForeignKey({
+  subject,
+  options
+}) {
+  return (options == null ? void 0 : options.subjectForeignKey) || snakeCase(subject) + '_id';
+}
+/*
+    Gets the SQL foreign key for the object, either from the options object
+    or the snake case of the object model.
+*/
+
+function getObjectForeignKey({
+  object,
+  options
+}) {
+  return (options == null ? void 0 : options.objectForeignKey) || snakeCase(object) + '_id';
+}
+/*
+    Allows you to define the model path for a model
+*/
+
+function getModelClass({
+  object,
+  options
+}) {
+  return options != null && options.modelPath ? join(options.modelPath, object) : object;
+}
+function getViaTable(via) {
+  return via ? pluralize(snakeCase(via)) : null;
+}
 
 // Dependencies
 const {
@@ -87,50 +146,6 @@ function hasManyThroughRelation({
     }
   };
 }
-/*
-    Gets the SQL table for the subject, either from the options object or the
-    plural version of the subject model.
-*/
-
-function getSubjectTable({
-  subject,
-  options
-}) {
-  return (options == null ? void 0 : options.subjectTable) || pluralize(snakeCase(subject));
-}
-/*
-    Gets the SQL table for the object, either from the options object or the
-    plural version of the object model.
-*/
-
-function getObjectTable({
-  object,
-  options
-}) {
-  return (options == null ? void 0 : options.objectTable) || pluralize(snakeCase(object));
-}
-/*
-    Gets the SQL foreign key for the subject, either from the options object
-    or the snake case of the subject model.
-*/
-
-function getSubjectForeignKey({
-  subject,
-  options
-}) {
-  return (options == null ? void 0 : options.subjectForeignKey) || snakeCase(subject) + '_id';
-}
-/*
-    Gets the SQL foreign key for the object, either from the options object
-    or the snake case of the object model.
-*/
-
-function getObjectForeignKey({
-  object,
-  options
-}) {
-  return (options == null ? void 0 : options.objectForeignKey) || snakeCase(object) + '_id';
-}
 /*
     Defines a relationship by passing the subject, the predicate, and the object,
     along with an optional via model.
@@ -159,27 +174,30 @@ function relation({
     object,
     options
   });
-  let viaTable;
-  if (via) viaTable = pluralize(snakeCase(via));
+  const modelClass = getModelClass({
+    object,
+    options
+  });
+  const viaTable = getViaTable(via);
 
   switch (relType) {
     case 'hasOne':
       return hasOneRelation({
-        modelClass: object,
+        modelClass,
         from: `${subjectTable}.id`,
         to: `${objectTable}.${subjectForeignKey}`
       });
 
     case 'hasMany':
       return hasManyRelation({
-        modelClass: object,
+        modelClass,
         from: `${subjectTable}.id`,
         to: `${objectTable}.${subjectForeignKey}`
       });
 
     case 'hasManyThrough':
       return hasManyThroughRelation({
-        modelClass: object,
+        modelClass,
         from: `${subjectTable}.id`,
         through: {
           from: `${viaTable}.${subjectForeignKey}`,
@@ -190,7 +208,7 @@ function relation({
 
     case 'belongsTo':
       return belongsRelation({
-        modelClass: object,
+        modelClass,
         from: `${subjectTable}.${objectForeignKey}`,
         to: `${objectTable}.id`
       });
@@ -200,5 +218,69 @@ function relation({
   }
 }
 
-export { belongsRelation, getObjectForeignKey, getObjectTable, getSubjectForeignKey, getSubjectTable, hasManyRelation, hasManyThroughRelation, hasOneRelation, relation };
+class ObjectionRelation {
+  constructor({
+    subject,
+    modelPath
+  }) {
+    this.subject = subject;
+    this.modelPath = modelPath;
+  }
+
+  belongsTo(object, options) {
+    if (!options) options = {
+      modelPath: this.modelPath
+    };
+    if (!options.modelPath) options.modelPath = this.modelPath;
+    return relation({
+      subject: this.subject,
+      relType: 'belongsTo',
+      object,
+      options
+    });
+  }
+
+  hasOne(object, options) {
+    if (!options) options = {
+      modelPath: this.modelPath
+    };
+    if (!options.modelPath) options.modelPath = this.modelPath;
+    return relation({
+      subject: this.subject,
+      relType: 'hasOne',
+      object,
+      options
+    });
+  }
+
+  hasMany(object, options) {
+    if (!options) options = {
+      modelPath: this.modelPath
+    };
+    if (!options.modelPath) options.modelPath = this.modelPath;
+    return relation({
+      subject: this.subject,
+      relType: 'hasMany',
+      object,
+      options
+    });
+  }
+
+  hasManyThrough(object, via, options) {
+    if (!options) options = {
+      modelPath: this.modelPath
+    };
+    if (!options.modelPath) options.modelPath = this.modelPath;
+    return relation({
+      subject: this.subject,
+      relType: 'hasManyThrough',
+      object,
+      via,
+      options
+    });
+  }
+
+}
+
+export { ObjectionRelation };
 //# sourceMappingURL=objection-relations.esm.js.map

package/dist/objection-relations.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"objection-relations.esm.js","sources":["../src/index.ts"],"sourcesContent":["// Dependencies\nimport { Model } from 'objection';\nconst {\n\tHasOneRelation,\n\tBelongsToOneRelation,\n\tHasManyRelation,\n\tManyToManyRelation,\n} = Model;\nimport snakeCase from 'lodash.snakecase';\nimport pluralize from 'pluralize';\n\ntype CommonRelationOrTableOrForeignKeyProps = {\n    options?: {\n        subjectTable?: string;\n        objectTable?: string;\n        subjectForeignKey?: string;\n        objectForeignKey?: string;\n    }\n}\n\ntype RelationProps = CommonRelationOrTableOrForeignKeyProps & {\n    subject: string;\n    relType: 'hasOne' | 'hasMany' | 'hasManyThrough' | 'belongsTo';\n    object: string;\n    via?: string;\n}\n\ntype RelationTypeProps = {\n    modelClass: string;\n    from: string;\n    to: string;\n};\n\ntype AdvancedRelationTypeProps = RelationTypeProps & {\n    through: {\n        from: string;\n        to: string;\n    };\n}\n\ntype SubjectProps = CommonRelationOrTableOrForeignKeyProps & {\n    subject: string;\n}\n\ntype ObjectProps = CommonRelationOrTableOrForeignKeyProps & {\n    object: string;\n}\n\n/*\n    Defines a relationship where a record in one model can belong to a record in\n    another model.\n*/\nexport function belongsRelation({ modelClass, from, to }:RelationTypeProps) {\n\treturn {\n\t\trelation: BelongsToOneRelation,\n\t\tmodelClass,\n\t\tjoin: { from, to },\n\t};\n};\n\n/*\n\tDefines a relationship where a record in one model can own a record in another\n\tmodel.\n*/\nexport function hasOneRelation({ modelClass, from, to }:RelationTypeProps) {\n\treturn {\n\t\trelation: HasOneRelation,\n\t\tmodelClass,\n\t\tjoin: { from, to },\n\t};\n};\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model.\n*/\nexport function hasManyRelation({ modelClass, from, to }:RelationTypeProps) {\n\treturn {\n\t\trelation: HasManyRelation,\n        modelClass,\n\t\tjoin: { from, to },\n\t};\n};\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model, via a join table\n*/\nexport function hasManyThroughRelation({ modelClass, from, through, to }:AdvancedRelationTypeProps) {\n\treturn {\n\t\trelation: ManyToManyRelation,\n        modelClass,\n\t\tjoin: { from, through, to },\n\t};\n};\n\n/*\n    Gets the SQL table for the subject, either from the options object or the\n    plural version of the subject model.\n*/\nexport function getSubjectTable({ subject, options }:SubjectProps) {\n    return options?.subjectTable || pluralize(snakeCase(subject));\n}\n\n/*\n    Gets the SQL table for the object, either from the options object or the\n    plural version of the object model.\n*/\nexport function getObjectTable({ object, options }:ObjectProps) { \n    return options?.objectTable || pluralize(snakeCase(object));\n}\n\n/*\n    Gets the SQL foreign key for the subject, either from the options object \n    or the snake case of the subject model.\n*/\nexport function getSubjectForeignKey({ subject, options }:SubjectProps) {\n    return options?.subjectForeignKey || snakeCase(subject) + '_id';\n}\n\n/*\n    Gets the SQL foreign key for the object, either from the options object \n    or the snake case of the object model.\n*/\nexport function getObjectForeignKey({ object, options }:ObjectProps) {\n    return options?.objectForeignKey || snakeCase(object) + '_id';\n}\n\n/*\n\tDefines a relationship by passing the subject, the predicate, and the object,\n\talong with an optional via model.\n*/\nexport function relation({subject, relType, object, via, options}:RelationProps) {\n\tconst subjectTable = getSubjectTable({subject, options});\n\tconst objectTable = getObjectTable({object, options});\n\tconst subjectForeignKey = getSubjectForeignKey({subject, options});\n\tconst objectForeignKey = getObjectForeignKey({object, options});\n\tlet viaTable;\n\tif (via) viaTable = pluralize(snakeCase(via));\n\tswitch (relType) {\n\t\tcase 'hasOne':\n\t\t\treturn hasOneRelation({\n                modelClass: object,\n\t\t\t\tfrom: `${subjectTable}.id`,\n\t\t\t\tto: `${objectTable}.${subjectForeignKey}`\n            });\n\t\tcase 'hasMany':\n\t\t\treturn hasManyRelation({\n\t\t\t\tmodelClass: object,\n\t\t\t\tfrom: `${subjectTable}.id`,\n\t\t\t\tto: `${objectTable}.${subjectForeignKey}`\n\t\t\t});\n\t\tcase 'hasManyThrough':\n\t\t\treturn hasManyThroughRelation({\n\t\t\t\tmodelClass: object,\n\t\t\t\tfrom: `${subjectTable}.id`,\n\t\t\t\tthrough: {\n\t\t\t\t\tfrom: `${viaTable}.${subjectForeignKey}`,\n\t\t\t\t\tto: `${viaTable}.${objectForeignKey}`,\n\t\t\t\t},\n\t\t\t\tto: `${objectTable}.id`\n            });\n\t\tcase 'belongsTo':\n\t\t\treturn belongsRelation({\n\t\t\t\tmodelClass: object,\n\t\t\t\tfrom: `${subjectTable}.${objectForeignKey}`,\n\t\t\t\tto: `${objectTable}.id`\n            });\n\t\tdefault:\n\t\t\tthrow new Error('No valid relationship type specified');\n\t}\n};"],"names":["HasOneRelation","BelongsToOneRelation","HasManyRelation","ManyToManyRelation","Model","belongsRelation","modelClass","from","to","relation","join","hasOneRelation","hasManyRelation","hasManyThroughRelation","through","getSubjectTable","subject","options","subjectTable","pluralize","snakeCase","getObjectTable","object","objectTable","getSubjectForeignKey","subjectForeignKey","getObjectForeignKey","objectForeignKey","relType","via","viaTable","Error"],"mappings":";;;;AAAA;AAEA,MAAM;AACLA,EAAAA,cADK;AAELC,EAAAA,oBAFK;AAGLC,EAAAA,eAHK;AAILC,EAAAA;AAJK,IAKFC,KALJ;AA8CA;;;;;SAIgBC,gBAAgB;AAAEC,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBC,EAAAA;AAApB;AAC/B,SAAO;AACNC,IAAAA,QAAQ,EAAER,oBADJ;AAENK,IAAAA,UAFM;AAGNI,IAAAA,IAAI,EAAE;AAAEH,MAAAA,IAAF;AAAQC,MAAAA;AAAR;AAHA,GAAP;AAKA;AAED;;;;;SAIgBG,eAAe;AAAEL,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBC,EAAAA;AAApB;AAC9B,SAAO;AACNC,IAAAA,QAAQ,EAAET,cADJ;AAENM,IAAAA,UAFM;AAGNI,IAAAA,IAAI,EAAE;AAAEH,MAAAA,IAAF;AAAQC,MAAAA;AAAR;AAHA,GAAP;AAKA;AAED;;;;;SAIgBI,gBAAgB;AAAEN,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBC,EAAAA;AAApB;AAC/B,SAAO;AACNC,IAAAA,QAAQ,EAAEP,eADJ;AAEAI,IAAAA,UAFA;AAGNI,IAAAA,IAAI,EAAE;AAAEH,MAAAA,IAAF;AAAQC,MAAAA;AAAR;AAHA,GAAP;AAKA;AAED;;;;;SAIgBK,uBAAuB;AAAEP,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBO,EAAAA,OAApB;AAA6BN,EAAAA;AAA7B;AACtC,SAAO;AACNC,IAAAA,QAAQ,EAAEN,kBADJ;AAEAG,IAAAA,UAFA;AAGNI,IAAAA,IAAI,EAAE;AAAEH,MAAAA,IAAF;AAAQO,MAAAA,OAAR;AAAiBN,MAAAA;AAAjB;AAHA,GAAP;AAKA;AAED;;;;;SAIgBO,gBAAgB;AAAEC,EAAAA,OAAF;AAAWC,EAAAA;AAAX;AAC5B,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEC,YAAT,KAAyBC,SAAS,CAACC,SAAS,CAACJ,OAAD,CAAV,CAAzC;AACH;AAED;;;;;SAIgBK,eAAe;AAAEC,EAAAA,MAAF;AAAUL,EAAAA;AAAV;AAC3B,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEM,WAAT,KAAwBJ,SAAS,CAACC,SAAS,CAACE,MAAD,CAAV,CAAxC;AACH;AAED;;;;;SAIgBE,qBAAqB;AAAER,EAAAA,OAAF;AAAWC,EAAAA;AAAX;AACjC,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEQ,iBAAT,KAA8BL,SAAS,CAACJ,OAAD,CAAT,GAAqB,KAA1D;AACH;AAED;;;;;SAIgBU,oBAAoB;AAAEJ,EAAAA,MAAF;AAAUL,EAAAA;AAAV;AAChC,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEU,gBAAT,KAA6BP,SAAS,CAACE,MAAD,CAAT,GAAoB,KAAxD;AACH;AAED;;;;;SAIgBb,SAAS;AAACO,EAAAA,OAAD;AAAUY,EAAAA,OAAV;AAAmBN,EAAAA,MAAnB;AAA2BO,EAAAA,GAA3B;AAAgCZ,EAAAA;AAAhC;AACxB,QAAMC,YAAY,GAAGH,eAAe,CAAC;AAACC,IAAAA,OAAD;AAAUC,IAAAA;AAAV,GAAD,CAApC;AACA,QAAMM,WAAW,GAAGF,cAAc,CAAC;AAACC,IAAAA,MAAD;AAASL,IAAAA;AAAT,GAAD,CAAlC;AACA,QAAMQ,iBAAiB,GAAGD,oBAAoB,CAAC;AAACR,IAAAA,OAAD;AAAUC,IAAAA;AAAV,GAAD,CAA9C;AACA,QAAMU,gBAAgB,GAAGD,mBAAmB,CAAC;AAACJ,IAAAA,MAAD;AAASL,IAAAA;AAAT,GAAD,CAA5C;AACA,MAAIa,QAAJ;AACA,MAAID,GAAJ,EAASC,QAAQ,GAAGX,SAAS,CAACC,SAAS,CAACS,GAAD,CAAV,CAApB;;AACT,UAAQD,OAAR;AACC,SAAK,QAAL;AACC,aAAOjB,cAAc,CAAC;AACTL,QAAAA,UAAU,EAAEgB,MADH;AAErBf,QAAAA,IAAI,KAAKW,iBAFY;AAGrBV,QAAAA,EAAE,KAAKe,eAAeE;AAHD,OAAD,CAArB;;AAKD,SAAK,SAAL;AACC,aAAOb,eAAe,CAAC;AACtBN,QAAAA,UAAU,EAAEgB,MADU;AAEtBf,QAAAA,IAAI,KAAKW,iBAFa;AAGtBV,QAAAA,EAAE,KAAKe,eAAeE;AAHA,OAAD,CAAtB;;AAKD,SAAK,gBAAL;AACC,aAAOZ,sBAAsB,CAAC;AAC7BP,QAAAA,UAAU,EAAEgB,MADiB;AAE7Bf,QAAAA,IAAI,KAAKW,iBAFoB;AAG7BJ,QAAAA,OAAO,EAAE;AACRP,UAAAA,IAAI,KAAKuB,YAAYL,mBADb;AAERjB,UAAAA,EAAE,KAAKsB,YAAYH;AAFX,SAHoB;AAO7BnB,QAAAA,EAAE,KAAKe;AAPsB,OAAD,CAA7B;;AASD,SAAK,WAAL;AACC,aAAOlB,eAAe,CAAC;AACtBC,QAAAA,UAAU,EAAEgB,MADU;AAEtBf,QAAAA,IAAI,KAAKW,gBAAgBS,kBAFH;AAGtBnB,QAAAA,EAAE,KAAKe;AAHe,OAAD,CAAtB;;AAKD;AACC,YAAM,IAAIQ,KAAJ,CAAU,sCAAV,CAAN;AA9BF;AAgCA;;;;"}
+{"version":3,"file":"objection-relations.esm.js","sources":["../src/helpers.ts","../src/relations.ts","../src/index.ts"],"sourcesContent":["import snakeCase from 'lodash.snakecase';\nimport pluralize from 'pluralize';\nimport { join } from 'path';\nimport { CommonRelationOrTableOrForeignKeyProps } from './global';\n\n// Types\n\ntype SubjectProps = CommonRelationOrTableOrForeignKeyProps & {\n  subject: string;\n};\n\ntype ObjectProps = CommonRelationOrTableOrForeignKeyProps & {\n  object: string;\n};\n\ntype ViaProps = string | undefined;\n\n/*\n    Gets the SQL table for the subject, either from the options object or the\n    plural version of the subject model.\n*/\nexport function getSubjectTable({ subject, options }: SubjectProps) {\n  return options?.subjectTable || pluralize(snakeCase(subject));\n}\n\n/*\n    Gets the SQL table for the object, either from the options object or the\n    plural version of the object model.\n*/\nexport function getObjectTable({ object, options }: ObjectProps) {\n  return options?.objectTable || pluralize(snakeCase(object));\n}\n\n/*\n    Gets the SQL foreign key for the subject, either from the options object \n    or the snake case of the subject model.\n*/\nexport function getSubjectForeignKey({ subject, options }: SubjectProps) {\n  return options?.subjectForeignKey || snakeCase(subject) + '_id';\n}\n\n/*\n    Gets the SQL foreign key for the object, either from the options object \n    or the snake case of the object model.\n*/\nexport function getObjectForeignKey({ object, options }: ObjectProps) {\n  return options?.objectForeignKey || snakeCase(object) + '_id';\n}\n\n/*\n\tAllows you to define the model path for a model\n*/\nexport function getModelClass({ object, options }: ObjectProps) {\n  return options?.modelPath ? join(options.modelPath, object) : object;\n}\n\nexport function getViaTable(via: ViaProps) {\n  return via ? pluralize(snakeCase(via)) : null;\n}\n","// Dependencies\nimport { Model } from 'objection';\nimport {\n  RelationTypeProps,\n  CommonRelationOrTableOrForeignKeyProps,\n} from './global';\nimport {\n  getSubjectTable,\n  getSubjectForeignKey,\n  getObjectTable,\n  getObjectForeignKey,\n  getModelClass,\n  getViaTable,\n} from './helpers';\n\nconst {\n  HasOneRelation,\n  BelongsToOneRelation,\n  HasManyRelation,\n  ManyToManyRelation,\n} = Model;\n\n// Types\n\ntype AdvancedRelationTypeProps = RelationTypeProps & {\n  through: {\n    from: string;\n    to: string;\n  };\n};\n\n/*\n    Defines a relationship where a record in one model can belong to a record in\n    another model.\n*/\nexport function belongsRelation({ modelClass, from, to }: RelationTypeProps) {\n  return {\n    relation: BelongsToOneRelation,\n    modelClass,\n    join: { from, to },\n  };\n}\n\n/*\n\tDefines a relationship where a record in one model can own a record in another\n\tmodel.\n*/\nexport function hasOneRelation({ modelClass, from, to }: RelationTypeProps) {\n  return {\n    relation: HasOneRelation,\n    modelClass,\n    join: { from, to },\n  };\n}\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model.\n*/\nexport function hasManyRelation({ modelClass, from, to }: RelationTypeProps) {\n  return {\n    relation: HasManyRelation,\n    modelClass,\n    join: { from, to },\n  };\n}\n\n/*\n\tDefines a relationship where a record in one model can own many records in\n\tanother model, via a join table\n*/\nexport function hasManyThroughRelation({\n  modelClass,\n  from,\n  through,\n  to,\n}: AdvancedRelationTypeProps) {\n  return {\n    relation: ManyToManyRelation,\n    modelClass,\n    join: { from, through, to },\n  };\n}\n\ntype RelationProps = CommonRelationOrTableOrForeignKeyProps & {\n  subject: string;\n  relType: 'hasOne' | 'hasMany' | 'hasManyThrough' | 'belongsTo';\n  object: string;\n  via?: string;\n};\n\n/*\n\tDefines a relationship by passing the subject, the predicate, and the object,\n\talong with an optional via model.\n*/\nexport function relation({\n  subject,\n  relType,\n  object,\n  via,\n  options,\n}: RelationProps) {\n  const subjectTable = getSubjectTable({ subject, options });\n  const objectTable = getObjectTable({ object, options });\n  const subjectForeignKey = getSubjectForeignKey({ subject, options });\n  const objectForeignKey = getObjectForeignKey({ object, options });\n  const modelClass = getModelClass({ object, options });\n  const viaTable = getViaTable(via);\n  switch (relType) {\n    case 'hasOne':\n      return hasOneRelation({\n        modelClass,\n        from: `${subjectTable}.id`,\n        to: `${objectTable}.${subjectForeignKey}`,\n      });\n    case 'hasMany':\n      return hasManyRelation({\n        modelClass,\n        from: `${subjectTable}.id`,\n        to: `${objectTable}.${subjectForeignKey}`,\n      });\n    case 'hasManyThrough':\n      return hasManyThroughRelation({\n        modelClass,\n        from: `${subjectTable}.id`,\n        through: {\n          from: `${viaTable}.${subjectForeignKey}`,\n          to: `${viaTable}.${objectForeignKey}`,\n        },\n        to: `${objectTable}.id`,\n      });\n    case 'belongsTo':\n      return belongsRelation({\n        modelClass,\n        from: `${subjectTable}.${objectForeignKey}`,\n        to: `${objectTable}.id`,\n      });\n    default:\n      throw new Error('No valid relationship type specified');\n  }\n}\n","// Dependencies\nimport { OptionsProps } from './global';\nimport { relation } from './relations';\n\n// Types\n\ntype ObjectionRelationProps = {\n  subject: string;\n  modelPath: string;\n};\n\nexport class ObjectionRelation {\n  subject: string;\n  modelPath: string;\n  constructor({ subject, modelPath }: ObjectionRelationProps) {\n    this.subject = subject;\n    this.modelPath = modelPath;\n  }\n\n  belongsTo(object: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'belongsTo',\n      object,\n      options,\n    });\n  }\n\n  hasOne(object: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'hasOne',\n      object,\n      options,\n    });\n  }\n\n  hasMany(object: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'hasMany',\n      object,\n      options,\n    });\n  }\n\n  hasManyThrough(object: string, via: string, options?: OptionsProps) {\n    if (!options) options = { modelPath: this.modelPath };\n    if (!options.modelPath) options.modelPath = this.modelPath;\n    return relation({\n      subject: this.subject,\n      relType: 'hasManyThrough',\n      object,\n      via,\n      options,\n    });\n  }\n}\n"],"names":["getSubjectTable","subject","options","subjectTable","pluralize","snakeCase","getObjectTable","object","objectTable","getSubjectForeignKey","subjectForeignKey","getObjectForeignKey","objectForeignKey","getModelClass","modelPath","join","getViaTable","via","HasOneRelation","BelongsToOneRelation","HasManyRelation","ManyToManyRelation","Model","belongsRelation","modelClass","from","to","relation","hasOneRelation","hasManyRelation","hasManyThroughRelation","through","relType","viaTable","Error","ObjectionRelation","constructor","belongsTo","hasOne","hasMany","hasManyThrough"],"mappings":";;;;;AAiBA;;;;;SAIgBA,gBAAgB;AAAEC,EAAAA,OAAF;AAAWC,EAAAA;AAAX;AAC9B,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEC,YAAT,KAAyBC,SAAS,CAACC,SAAS,CAACJ,OAAD,CAAV,CAAzC;AACD;AAED;;;;;SAIgBK,eAAe;AAAEC,EAAAA,MAAF;AAAUL,EAAAA;AAAV;AAC7B,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEM,WAAT,KAAwBJ,SAAS,CAACC,SAAS,CAACE,MAAD,CAAV,CAAxC;AACD;AAED;;;;;SAIgBE,qBAAqB;AAAER,EAAAA,OAAF;AAAWC,EAAAA;AAAX;AACnC,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEQ,iBAAT,KAA8BL,SAAS,CAACJ,OAAD,CAAT,GAAqB,KAA1D;AACD;AAED;;;;;SAIgBU,oBAAoB;AAAEJ,EAAAA,MAAF;AAAUL,EAAAA;AAAV;AAClC,SAAO,CAAAA,OAAO,QAAP,YAAAA,OAAO,CAAEU,gBAAT,KAA6BP,SAAS,CAACE,MAAD,CAAT,GAAoB,KAAxD;AACD;AAED;;;;SAGgBM,cAAc;AAAEN,EAAAA,MAAF;AAAUL,EAAAA;AAAV;AAC5B,SAAOA,OAAO,QAAP,IAAAA,OAAO,CAAEY,SAAT,GAAqBC,IAAI,CAACb,OAAO,CAACY,SAAT,EAAoBP,MAApB,CAAzB,GAAuDA,MAA9D;AACD;SAEeS,YAAYC;AAC1B,SAAOA,GAAG,GAAGb,SAAS,CAACC,SAAS,CAACY,GAAD,CAAV,CAAZ,GAA+B,IAAzC;AACD;;AC1DD;AACA,AAcA,MAAM;AACJC,EAAAA,cADI;AAEJC,EAAAA,oBAFI;AAGJC,EAAAA,eAHI;AAIJC,EAAAA;AAJI,IAKFC,KALJ;AAgBA;;;;;AAIA,SAAgBC,gBAAgB;AAAEC,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBC,EAAAA;AAApB;AAC9B,SAAO;AACLC,IAAAA,QAAQ,EAAER,oBADL;AAELK,IAAAA,UAFK;AAGLT,IAAAA,IAAI,EAAE;AAAEU,MAAAA,IAAF;AAAQC,MAAAA;AAAR;AAHD,GAAP;AAKD;AAED;;;;;AAIA,SAAgBE,eAAe;AAAEJ,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBC,EAAAA;AAApB;AAC7B,SAAO;AACLC,IAAAA,QAAQ,EAAET,cADL;AAELM,IAAAA,UAFK;AAGLT,IAAAA,IAAI,EAAE;AAAEU,MAAAA,IAAF;AAAQC,MAAAA;AAAR;AAHD,GAAP;AAKD;AAED;;;;;AAIA,SAAgBG,gBAAgB;AAAEL,EAAAA,UAAF;AAAcC,EAAAA,IAAd;AAAoBC,EAAAA;AAApB;AAC9B,SAAO;AACLC,IAAAA,QAAQ,EAAEP,eADL;AAELI,IAAAA,UAFK;AAGLT,IAAAA,IAAI,EAAE;AAAEU,MAAAA,IAAF;AAAQC,MAAAA;AAAR;AAHD,GAAP;AAKD;AAED;;;;;AAIA,SAAgBI,uBAAuB;AACrCN,EAAAA,UADqC;AAErCC,EAAAA,IAFqC;AAGrCM,EAAAA,OAHqC;AAIrCL,EAAAA;AAJqC;AAMrC,SAAO;AACLC,IAAAA,QAAQ,EAAEN,kBADL;AAELG,IAAAA,UAFK;AAGLT,IAAAA,IAAI,EAAE;AAAEU,MAAAA,IAAF;AAAQM,MAAAA,OAAR;AAAiBL,MAAAA;AAAjB;AAHD,GAAP;AAKD;AASD;;;;;AAIA,SAAgBC,SAAS;AACvB1B,EAAAA,OADuB;AAEvB+B,EAAAA,OAFuB;AAGvBzB,EAAAA,MAHuB;AAIvBU,EAAAA,GAJuB;AAKvBf,EAAAA;AALuB;AAOvB,QAAMC,YAAY,GAAGH,eAAe,CAAC;AAAEC,IAAAA,OAAF;AAAWC,IAAAA;AAAX,GAAD,CAApC;AACA,QAAMM,WAAW,GAAGF,cAAc,CAAC;AAAEC,IAAAA,MAAF;AAAUL,IAAAA;AAAV,GAAD,CAAlC;AACA,QAAMQ,iBAAiB,GAAGD,oBAAoB,CAAC;AAAER,IAAAA,OAAF;AAAWC,IAAAA;AAAX,GAAD,CAA9C;AACA,QAAMU,gBAAgB,GAAGD,mBAAmB,CAAC;AAAEJ,IAAAA,MAAF;AAAUL,IAAAA;AAAV,GAAD,CAA5C;AACA,QAAMsB,UAAU,GAAGX,aAAa,CAAC;AAAEN,IAAAA,MAAF;AAAUL,IAAAA;AAAV,GAAD,CAAhC;AACA,QAAM+B,QAAQ,GAAGjB,WAAW,CAACC,GAAD,CAA5B;;AACA,UAAQe,OAAR;AACE,SAAK,QAAL;AACE,aAAOJ,cAAc,CAAC;AACpBJ,QAAAA,UADoB;AAEpBC,QAAAA,IAAI,KAAKtB,iBAFW;AAGpBuB,QAAAA,EAAE,KAAKlB,eAAeE;AAHF,OAAD,CAArB;;AAKF,SAAK,SAAL;AACE,aAAOmB,eAAe,CAAC;AACrBL,QAAAA,UADqB;AAErBC,QAAAA,IAAI,KAAKtB,iBAFY;AAGrBuB,QAAAA,EAAE,KAAKlB,eAAeE;AAHD,OAAD,CAAtB;;AAKF,SAAK,gBAAL;AACE,aAAOoB,sBAAsB,CAAC;AAC5BN,QAAAA,UAD4B;AAE5BC,QAAAA,IAAI,KAAKtB,iBAFmB;AAG5B4B,QAAAA,OAAO,EAAE;AACPN,UAAAA,IAAI,KAAKQ,YAAYvB,mBADd;AAEPgB,UAAAA,EAAE,KAAKO,YAAYrB;AAFZ,SAHmB;AAO5Bc,QAAAA,EAAE,KAAKlB;AAPqB,OAAD,CAA7B;;AASF,SAAK,WAAL;AACE,aAAOe,eAAe,CAAC;AACrBC,QAAAA,UADqB;AAErBC,QAAAA,IAAI,KAAKtB,gBAAgBS,kBAFJ;AAGrBc,QAAAA,EAAE,KAAKlB;AAHc,OAAD,CAAtB;;AAKF;AACE,YAAM,IAAI0B,KAAJ,CAAU,sCAAV,CAAN;AA9BJ;AAgCD;;MCjIYC;AAGXC,EAAAA,YAAY;AAAEnC,IAAAA,OAAF;AAAWa,IAAAA;AAAX;AACV,SAAKb,OAAL,GAAeA,OAAf;AACA,SAAKa,SAAL,GAAiBA,SAAjB;AACD;;AAEDuB,EAAAA,SAAS,CAAC9B,MAAD,EAAiBL,OAAjB;AACP,QAAI,CAACA,OAAL,EAAcA,OAAO,GAAG;AAAEY,MAAAA,SAAS,EAAE,KAAKA;AAAlB,KAAV;AACd,QAAI,CAACZ,OAAO,CAACY,SAAb,EAAwBZ,OAAO,CAACY,SAAR,GAAoB,KAAKA,SAAzB;AACxB,WAAOa,QAAQ,CAAC;AACd1B,MAAAA,OAAO,EAAE,KAAKA,OADA;AAEd+B,MAAAA,OAAO,EAAE,WAFK;AAGdzB,MAAAA,MAHc;AAIdL,MAAAA;AAJc,KAAD,CAAf;AAMD;;AAEDoC,EAAAA,MAAM,CAAC/B,MAAD,EAAiBL,OAAjB;AACJ,QAAI,CAACA,OAAL,EAAcA,OAAO,GAAG;AAAEY,MAAAA,SAAS,EAAE,KAAKA;AAAlB,KAAV;AACd,QAAI,CAACZ,OAAO,CAACY,SAAb,EAAwBZ,OAAO,CAACY,SAAR,GAAoB,KAAKA,SAAzB;AACxB,WAAOa,QAAQ,CAAC;AACd1B,MAAAA,OAAO,EAAE,KAAKA,OADA;AAEd+B,MAAAA,OAAO,EAAE,QAFK;AAGdzB,MAAAA,MAHc;AAIdL,MAAAA;AAJc,KAAD,CAAf;AAMD;;AAEDqC,EAAAA,OAAO,CAAChC,MAAD,EAAiBL,OAAjB;AACL,QAAI,CAACA,OAAL,EAAcA,OAAO,GAAG;AAAEY,MAAAA,SAAS,EAAE,KAAKA;AAAlB,KAAV;AACd,QAAI,CAACZ,OAAO,CAACY,SAAb,EAAwBZ,OAAO,CAACY,SAAR,GAAoB,KAAKA,SAAzB;AACxB,WAAOa,QAAQ,CAAC;AACd1B,MAAAA,OAAO,EAAE,KAAKA,OADA;AAEd+B,MAAAA,OAAO,EAAE,SAFK;AAGdzB,MAAAA,MAHc;AAIdL,MAAAA;AAJc,KAAD,CAAf;AAMD;;AAEDsC,EAAAA,cAAc,CAACjC,MAAD,EAAiBU,GAAjB,EAA8Bf,OAA9B;AACZ,QAAI,CAACA,OAAL,EAAcA,OAAO,GAAG;AAAEY,MAAAA,SAAS,EAAE,KAAKA;AAAlB,KAAV;AACd,QAAI,CAACZ,OAAO,CAACY,SAAb,EAAwBZ,OAAO,CAACY,SAAR,GAAoB,KAAKA,SAAzB;AACxB,WAAOa,QAAQ,CAAC;AACd1B,MAAAA,OAAO,EAAE,KAAKA,OADA;AAEd+B,MAAAA,OAAO,EAAE,gBAFK;AAGdzB,MAAAA,MAHc;AAIdU,MAAAA,GAJc;AAKdf,MAAAA;AALc,KAAD,CAAf;AAOD;;;;;;"}

package/dist/relations.d.ts

@@ -0,0 +1,58 @@
+import { RelationTypeProps, CommonRelationOrTableOrForeignKeyProps } from './global';
+declare type AdvancedRelationTypeProps = RelationTypeProps & {
+    through: {
+        from: string;
+        to: string;
+    };
+};
+export declare function belongsRelation({ modelClass, from, to }: RelationTypeProps): {
+    relation: import("objection").RelationType;
+    modelClass: string;
+    join: {
+        from: string;
+        to: string;
+    };
+};
+export declare function hasOneRelation({ modelClass, from, to }: RelationTypeProps): {
+    relation: import("objection").RelationType;
+    modelClass: string;
+    join: {
+        from: string;
+        to: string;
+    };
+};
+export declare function hasManyRelation({ modelClass, from, to }: RelationTypeProps): {
+    relation: import("objection").RelationType;
+    modelClass: string;
+    join: {
+        from: string;
+        to: string;
+    };
+};
+export declare function hasManyThroughRelation({ modelClass, from, through, to, }: AdvancedRelationTypeProps): {
+    relation: import("objection").RelationType;
+    modelClass: string;
+    join: {
+        from: string;
+        through: {
+            from: string;
+            to: string;
+        };
+        to: string;
+    };
+};
+declare type RelationProps = CommonRelationOrTableOrForeignKeyProps & {
+    subject: string;
+    relType: 'hasOne' | 'hasMany' | 'hasManyThrough' | 'belongsTo';
+    object: string;
+    via?: string;
+};
+export declare function relation({ subject, relType, object, via, options, }: RelationProps): {
+    relation: import("objection").RelationType;
+    modelClass: string;
+    join: {
+        from: string;
+        to: string;
+    };
+};
+export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -31,8 +31,8 @@
   "scripts": {
     "start": "tsdx watch --target node",
     "build": "tsdx build --target node",
-    "test": "tsdx test",
-    "lint": "tsdx lint",
+    "test": "tsdx test --collectCoverage",
+    "lint": "tsdx lint --fix",
     "prepare": "tsdx build --target node",
     "size": "size-limit",
     "analyze": "size-limit --why"

package/src/global.d.ts

@@ -0,0 +1,17 @@
+export type OptionsProps = {
+  subjectTable?: string;
+  objectTable?: string;
+  subjectForeignKey?: string;
+  objectForeignKey?: string;
+  modelPath?: string;
+};
+
+type CommonRelationOrTableOrForeignKeyProps = {
+  options?: OptionsProps;
+};
+
+type RelationTypeProps = {
+  modelClass: string;
+  from: string;
+  to: string;
+};

package/src/helpers.ts

@@ -0,0 +1,59 @@
+import snakeCase from 'lodash.snakecase';
+import pluralize from 'pluralize';
+import { join } from 'path';
+import { CommonRelationOrTableOrForeignKeyProps } from './global';
+
+// Types
+
+type SubjectProps = CommonRelationOrTableOrForeignKeyProps & {
+  subject: string;
+};
+
+type ObjectProps = CommonRelationOrTableOrForeignKeyProps & {
+  object: string;
+};
+
+type ViaProps = string | undefined;
+
+/*
+    Gets the SQL table for the subject, either from the options object or the
+    plural version of the subject model.
+*/
+export function getSubjectTable({ subject, options }: SubjectProps) {
+  return options?.subjectTable || pluralize(snakeCase(subject));
+}
+
+/*
+    Gets the SQL table for the object, either from the options object or the
+    plural version of the object model.
+*/
+export function getObjectTable({ object, options }: ObjectProps) {
+  return options?.objectTable || pluralize(snakeCase(object));
+}
+
+/*
+    Gets the SQL foreign key for the subject, either from the options object 
+    or the snake case of the subject model.
+*/
+export function getSubjectForeignKey({ subject, options }: SubjectProps) {
+  return options?.subjectForeignKey || snakeCase(subject) + '_id';
+}
+
+/*
+    Gets the SQL foreign key for the object, either from the options object 
+    or the snake case of the object model.
+*/
+export function getObjectForeignKey({ object, options }: ObjectProps) {
+  return options?.objectForeignKey || snakeCase(object) + '_id';
+}
+
+/*
+	Allows you to define the model path for a model
+*/
+export function getModelClass({ object, options }: ObjectProps) {
+  return options?.modelPath ? join(options.modelPath, object) : object;
+}
+
+export function getViaTable(via: ViaProps) {
+  return via ? pluralize(snakeCase(via)) : null;
+}