@anephenix/objection-relations 0.0.2 → 0.0.3

package/README.md

@@ -1,5 +1,7 @@
 # objection-relations
 
+[![Node.js CI](https://github.com/anephenix/objection-relations/actions/workflows/node.js.yml/badge.svg)](https://github.com/anephenix/objection-relations/actions/workflows/node.js.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/33642d97558a57dc7c1d/maintainability)](https://codeclimate.com/github/anephenix/objection-relations/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/33642d97558a57dc7c1d/test_coverage)](https://codeclimate.com/github/anephenix/objection-relations/test_coverage)
+
 A relations helper for Objection.js. This provides a convenient way to define
 relations in the `relationMappings` function on an Objection.js model.
 
@@ -256,4 +258,4 @@ npm t
 
 ## Licence and credits
 
-©2022 Anephenix OÜ. Objection-relations is licenced under the MIT Licence.
+©2025 Anephenix OÜ. Objection-relations is licenced under the MIT Licence.

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -17,25 +17,27 @@
   },
   "devDependencies": {
     "@size-limit/preset-small-lib": "^7.0.8",
-    "@types/jest": "^27.4.0",
+    "@types/jest": "^29.5.14",
     "@types/lodash.snakecase": "^4.1.6",
-    "@types/pluralize": "^0.0.29",
-    "husky": "^7.0.4",
+    "@types/pluralize": "^0.0.33",
+    "husky": "^9.1.7",
     "npm-upgrade": "^3.1.0",
     "size-limit": "^7.0.8",
     "tsdx": "^0.14.1",
-    "tslib": "^1.14.1",
-    "typescript": "^4.5.5"
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.3"
   },
   "author": "Paul Jensen <paul@anephenix.com>",
   "scripts": {
-    "start": "tsdx watch --target node",
+    "analyze": "size-limit --why",
     "build": "tsdx build --target node",
-    "test": "tsdx test --collectCoverage",
     "lint": "tsdx lint --fix",
-    "prepare": "tsdx build --target node",
+    "prepare-patch-release": "npm run update-changelog && git add CHANGELOG.md && git commit -m \"Updated changelog\" && npm version patch",
+    "publish-patch-release": "npm run prepare-patch-release && git push origin main && git push --tags",
     "size": "size-limit",
-    "analyze": "size-limit --why"
+    "start": "tsdx watch --target node",
+    "test": "tsdx test --collectCoverage",
+    "update-changelog": "node scripts/update-changelog.js"
   },
   "husky": {
     "hooks": {

package/dist/helpers.d.ts

@@ -1,15 +0,0 @@
-import { CommonRelationOrTableOrForeignKeyProps } from './global';
-declare type SubjectProps = CommonRelationOrTableOrForeignKeyProps & {
-    subject: string;
-};
-declare type ObjectProps = CommonRelationOrTableOrForeignKeyProps & {
-    object: string;
-};
-declare type ViaProps = string | undefined;
-export declare function getSubjectTable({ subject, options }: SubjectProps): string;
-export declare function getObjectTable({ object, options }: ObjectProps): string;
-export declare function getSubjectForeignKey({ subject, options }: SubjectProps): string;
-export declare function getObjectForeignKey({ object, options }: ObjectProps): string;
-export declare function getModelClass({ object, options }: ObjectProps): string;
-export declare function getViaTable(via: ViaProps): string | null;
-export {};

package/dist/index.d.ts

@@ -1,43 +0,0 @@
-import { OptionsProps } from './global';
-declare type ObjectionRelationProps = {
-    subject: string;
-    modelPath: string;
-};
-export declare class ObjectionRelation {
-    subject: string;
-    modelPath: string;
-    constructor({ subject, modelPath }: ObjectionRelationProps);
-    belongsTo(object: string, options?: OptionsProps): {
-        relation: import("objection").RelationType;
-        modelClass: string;
-        join: {
-            from: string;
-            to: string;
-        };
-    };
-    hasOne(object: string, options?: OptionsProps): {
-        relation: import("objection").RelationType;
-        modelClass: string;
-        join: {
-            from: string;
-            to: string;
-        };
-    };
-    hasMany(object: string, options?: OptionsProps): {
-        relation: import("objection").RelationType;
-        modelClass: string;
-        join: {
-            from: string;
-            to: string;
-        };
-    };
-    hasManyThrough(object: string, via: string, options?: OptionsProps): {
-        relation: import("objection").RelationType;
-        modelClass: string;
-        join: {
-            from: string;
-            to: string;
-        };
-    };
-}
-export {};

package/dist/index.js

@@ -1,8 +0,0 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./objection-relations.cjs.production.min.js')
-} else {
-  module.exports = require('./objection-relations.cjs.development.js')
-}

package/dist/objection-relations.cjs.development.js

@@ -1,292 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var objection = require('objection');
-var snakeCase = _interopDefault(require('lodash.snakecase'));
-var pluralize = _interopDefault(require('pluralize'));
-var path = require('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 ? path.join(options.modelPath, object) : object;
-}
-function getViaTable(via) {
-  return via ? pluralize(snakeCase(via)) : null;
-}
-
-// Dependencies
-const {
-  HasOneRelation,
-  BelongsToOneRelation,
-  HasManyRelation,
-  ManyToManyRelation
-} = objection.Model;
-/*
-    Defines a relationship where a record in one model can belong to a record in
-    another model.
-*/
-
-function belongsRelation({
-  modelClass,
-  from,
-  to
-}) {
-  return {
-    relation: BelongsToOneRelation,
-    modelClass,
-    join: {
-      from,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship where a record in one model can own a record in another
-    model.
-*/
-
-function hasOneRelation({
-  modelClass,
-  from,
-  to
-}) {
-  return {
-    relation: HasOneRelation,
-    modelClass,
-    join: {
-      from,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship where a record in one model can own many records in
-    another model.
-*/
-
-function hasManyRelation({
-  modelClass,
-  from,
-  to
-}) {
-  return {
-    relation: HasManyRelation,
-    modelClass,
-    join: {
-      from,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship where a record in one model can own many records in
-    another model, via a join table
-*/
-
-function hasManyThroughRelation({
-  modelClass,
-  from,
-  through,
-  to
-}) {
-  return {
-    relation: ManyToManyRelation,
-    modelClass,
-    join: {
-      from,
-      through,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship by passing the subject, the predicate, and the object,
-    along with an optional via model.
-*/
-
-function relation({
-  subject,
-  relType,
-  object,
-  via,
-  options
-}) {
-  const subjectTable = getSubjectTable({
-    subject,
-    options
-  });
-  const objectTable = getObjectTable({
-    object,
-    options
-  });
-  const subjectForeignKey = getSubjectForeignKey({
-    subject,
-    options
-  });
-  const objectForeignKey = getObjectForeignKey({
-    object,
-    options
-  });
-  const modelClass = getModelClass({
-    object,
-    options
-  });
-  const viaTable = getViaTable(via);
-
-  switch (relType) {
-    case 'hasOne':
-      return hasOneRelation({
-        modelClass,
-        from: `${subjectTable}.id`,
-        to: `${objectTable}.${subjectForeignKey}`
-      });
-
-    case 'hasMany':
-      return hasManyRelation({
-        modelClass,
-        from: `${subjectTable}.id`,
-        to: `${objectTable}.${subjectForeignKey}`
-      });
-
-    case 'hasManyThrough':
-      return hasManyThroughRelation({
-        modelClass,
-        from: `${subjectTable}.id`,
-        through: {
-          from: `${viaTable}.${subjectForeignKey}`,
-          to: `${viaTable}.${objectForeignKey}`
-        },
-        to: `${objectTable}.id`
-      });
-
-    case 'belongsTo':
-      return belongsRelation({
-        modelClass,
-        from: `${subjectTable}.${objectForeignKey}`,
-        to: `${objectTable}.id`
-      });
-
-    default:
-      throw new Error('No valid relationship type specified');
-  }
-}
-
-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
-    });
-  }
-
-}
-
-exports.ObjectionRelation = ObjectionRelation;
-//# sourceMappingURL=objection-relations.cjs.development.js.map

package/dist/objection-relations.cjs.development.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"objection-relations.cjs.development.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,SAAI,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,eALJ;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/objection-relations.cjs.production.min.js

@@ -1,2 +0,0 @@
-"use strict";function o(o){return o&&"object"==typeof o&&"default"in o?o.default:o}Object.defineProperty(exports,"__esModule",{value:!0});var t=require("objection"),e=o(require("lodash.snakecase")),n=o(require("pluralize")),s=require("path");const{HasOneRelation:l,BelongsToOneRelation:r,HasManyRelation:a,ManyToManyRelation:i}=t.Model;function u({subject:o,relType:t,object:u,via:h,options:c}){const d=function({subject:o,options:t}){return(null==t?void 0:t.subjectTable)||n(e(o))}({subject:o,options:c}),m=function({object:o,options:t}){return(null==t?void 0:t.objectTable)||n(e(o))}({object:u,options:c}),b=function({subject:o,options:t}){return(null==t?void 0:t.subjectForeignKey)||e(o)+"_id"}({subject:o,options:c}),j=function({object:o,options:t}){return(null==t?void 0:t.objectForeignKey)||e(o)+"_id"}({object:u,options:c}),f=function({object:o,options:t}){return null!=t&&t.modelPath?s.join(t.modelPath,o):o}({object:u,options:c}),p=function(o){return o?n(e(o)):null}(h);switch(t){case"hasOne":return function({modelClass:o,from:t,to:e}){return{relation:l,modelClass:o,join:{from:t,to:e}}}({modelClass:f,from:d+".id",to:`${m}.${b}`});case"hasMany":return function({modelClass:o,from:t,to:e}){return{relation:a,modelClass:o,join:{from:t,to:e}}}({modelClass:f,from:d+".id",to:`${m}.${b}`});case"hasManyThrough":return function({modelClass:o,from:t,through:e,to:n}){return{relation:i,modelClass:o,join:{from:t,through:e,to:n}}}({modelClass:f,from:d+".id",through:{from:`${p}.${b}`,to:`${p}.${j}`},to:m+".id"});case"belongsTo":return function({modelClass:o,from:t,to:e}){return{relation:r,modelClass:o,join:{from:t,to:e}}}({modelClass:f,from:`${d}.${j}`,to:m+".id"});default:throw new Error("No valid relationship type specified")}}exports.ObjectionRelation=class{constructor({subject:o,modelPath:t}){this.subject=o,this.modelPath=t}belongsTo(o,t){return t||(t={modelPath:this.modelPath}),t.modelPath||(t.modelPath=this.modelPath),u({subject:this.subject,relType:"belongsTo",object:o,options:t})}hasOne(o,t){return t||(t={modelPath:this.modelPath}),t.modelPath||(t.modelPath=this.modelPath),u({subject:this.subject,relType:"hasOne",object:o,options:t})}hasMany(o,t){return t||(t={modelPath:this.modelPath}),t.modelPath||(t.modelPath=this.modelPath),u({subject:this.subject,relType:"hasMany",object:o,options:t})}hasManyThrough(o,t,e){return e||(e={modelPath:this.modelPath}),e.modelPath||(e.modelPath=this.modelPath),u({subject:this.subject,relType:"hasManyThrough",object:o,via:t,options:e})}};
-//# sourceMappingURL=objection-relations.cjs.production.min.js.map

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

@@ -1 +0,0 @@
-{"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,286 +0,0 @@
-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 {
-  HasOneRelation,
-  BelongsToOneRelation,
-  HasManyRelation,
-  ManyToManyRelation
-} = Model;
-/*
-    Defines a relationship where a record in one model can belong to a record in
-    another model.
-*/
-
-function belongsRelation({
-  modelClass,
-  from,
-  to
-}) {
-  return {
-    relation: BelongsToOneRelation,
-    modelClass,
-    join: {
-      from,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship where a record in one model can own a record in another
-    model.
-*/
-
-function hasOneRelation({
-  modelClass,
-  from,
-  to
-}) {
-  return {
-    relation: HasOneRelation,
-    modelClass,
-    join: {
-      from,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship where a record in one model can own many records in
-    another model.
-*/
-
-function hasManyRelation({
-  modelClass,
-  from,
-  to
-}) {
-  return {
-    relation: HasManyRelation,
-    modelClass,
-    join: {
-      from,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship where a record in one model can own many records in
-    another model, via a join table
-*/
-
-function hasManyThroughRelation({
-  modelClass,
-  from,
-  through,
-  to
-}) {
-  return {
-    relation: ManyToManyRelation,
-    modelClass,
-    join: {
-      from,
-      through,
-      to
-    }
-  };
-}
-/*
-    Defines a relationship by passing the subject, the predicate, and the object,
-    along with an optional via model.
-*/
-
-function relation({
-  subject,
-  relType,
-  object,
-  via,
-  options
-}) {
-  const subjectTable = getSubjectTable({
-    subject,
-    options
-  });
-  const objectTable = getObjectTable({
-    object,
-    options
-  });
-  const subjectForeignKey = getSubjectForeignKey({
-    subject,
-    options
-  });
-  const objectForeignKey = getObjectForeignKey({
-    object,
-    options
-  });
-  const modelClass = getModelClass({
-    object,
-    options
-  });
-  const viaTable = getViaTable(via);
-
-  switch (relType) {
-    case 'hasOne':
-      return hasOneRelation({
-        modelClass,
-        from: `${subjectTable}.id`,
-        to: `${objectTable}.${subjectForeignKey}`
-      });
-
-    case 'hasMany':
-      return hasManyRelation({
-        modelClass,
-        from: `${subjectTable}.id`,
-        to: `${objectTable}.${subjectForeignKey}`
-      });
-
-    case 'hasManyThrough':
-      return hasManyThroughRelation({
-        modelClass,
-        from: `${subjectTable}.id`,
-        through: {
-          from: `${viaTable}.${subjectForeignKey}`,
-          to: `${viaTable}.${objectForeignKey}`
-        },
-        to: `${objectTable}.id`
-      });
-
-    case 'belongsTo':
-      return belongsRelation({
-        modelClass,
-        from: `${subjectTable}.${objectForeignKey}`,
-        to: `${objectTable}.id`
-      });
-
-    default:
-      throw new Error('No valid relationship type specified');
-  }
-}
-
-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 +0,0 @@
-{"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

@@ -1,58 +0,0 @@
-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 {};