@anephenix/objection-relations 0.0.13 → 0.0.17

package/README.md

@@ -1,6 +1,6 @@
 # objection-relations
 
-[![npm version](https://badge.fury.io/js/%40anephenix%2Fobjection-relations.svg)](https://badge.fury.io/js/%40anephenix%2Fobjection-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) [![Socket Badge](https://socket.dev/api/badge/npm/package/@anephenix/objection-relations)](https://socket.dev/npm/package/@anephenix/objection-relations)
+[![npm version](https://badge.fury.io/js/%40anephenix%2Fobjection-relations.svg)](https://badge.fury.io/js/%40anephenix%2Fobjection-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) [![Socket Badge](https://socket.dev/api/badge/npm/package/@anephenix/objection-relations)](https://socket.dev/npm/package/@anephenix/objection-relations)
 
 A relations helper for Objection.js. This provides a convenient way to define
 relations in the `relationMappings` function on an Objection.js model.

package/package.json

@@ -1,67 +1,74 @@
 {
-  "version": "0.0.13",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "src"
-  ],
-  "engines": {
-    "node": ">=10"
-  },
-  "dependencies": {
-    "lodash.snakecase": "^4.1.1",
-    "objection": "^3.1.5",
-    "pluralize": "^8.0.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.27.0",
-    "@types/jest": "^29.5.14",
-    "@types/lodash.snakecase": "^4.1.9",
-    "@types/pluralize": "^0.0.33",
-    "eslint": "^9.27.0",
-    "globals": "^16.2.0",
-    "husky": "^9.1.7",
-    "mocha": "^11.5.0",
-    "nyc": "^17.1.0",
-    "size-limit": "^11.2.0",
-    "size-limit-preset-node-lib": "^0.4.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.32.1"
-  },
-  "author": "Paul Jensen <paul@anephenix.com>",
-  "scripts": {
-    "analyze": "size-limit --why",
-    "build": "tsc --project tsconfig.json",
-    "cover": "NODE_ENV=test npx nyc --reporter=lcov npm t",
-    "lint": "npx eslint .",
-    "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",
-    "start": "tsdx watch --target node",
-    "test": "NODE_ENV=test npx mocha --require ts-node/register --extensions ts test/**/*",
-    "update-changelog": "npx ts-node scripts/update-changelog.ts",
-    "prepare": "husky"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint && npm test"
-    }
-  },
-  "name": "@anephenix/objection-relations",
-  "module": "dist/objection-relations.esm.js",
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "es5"
-  },
-  "size-limit": [
-    {
-      "path": "dist/*.js",
-      "limit": "10 KB"
-    }
-  ]
+	"version": "0.0.17",
+	"license": "MIT",
+	"main": "dist/index.js",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"require": "./dist/index.js"
+		}
+	},
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist",
+		"README.md"
+	],
+	"engines": {
+		"node": ">=10"
+	},
+	"dependencies": {
+		"lodash.snakecase": "^4.1.1",
+		"objection": "^3.1.5",
+		"pluralize": "^8.0.0"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "2.2.5",
+		"@types/lodash.snakecase": "^4.1.9",
+		"@types/node": "^24.7.0",
+		"@types/pluralize": "^0.0.33",
+		"@vitest/coverage-v8": "^3.2.4",
+		"globals": "^16.4.0",
+		"husky": "^9.1.7",
+		"size-limit": "^11.2.0",
+		"size-limit-preset-node-lib": "^0.4.0",
+		"typescript": "^5.9.3",
+		"vitest": "^3.2.4"
+	},
+	"author": "Paul Jensen <paul@anephenix.com>",
+	"scripts": {
+		"analyze": "size-limit --why",
+		"build": "tsc --project tsconfig.json",
+		"cover": "NODE_ENV=test vitest --coverage --run",
+		"lint": "npx @biomejs/biome check --write src test scripts",
+		"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",
+		"start": "tsdx watch --target node",
+		"test": "NODE_ENV=test vitest --run",
+		"test:build:commonjs": "node e2e/test-commonjs.cjs",
+		"test:build:esm": "node e2e/test-esm.js",
+		"test:e2e": "npm run build && npm run test:build:commonjs && npm run test:build:esm",
+		"update-changelog": "node --experimental-strip-types scripts/update-changelog.ts",
+		"prepare": "husky"
+	},
+	"husky": {
+		"hooks": {
+			"pre-commit": "npm run lint && npm test"
+		}
+	},
+	"name": "@anephenix/objection-relations",
+	"module": "dist/objection-relations.esm.js",
+	"prettier": {
+		"printWidth": 80,
+		"semi": true,
+		"singleQuote": true,
+		"trailingComma": "es5"
+	},
+	"size-limit": [
+		{
+			"path": "dist/*.js",
+			"limit": "10 KB"
+		}
+	]
 }

package/src/global.d.ts

@@ -1,17 +0,0 @@
-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

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

package/src/index.ts

@@ -1,64 +0,0 @@
-// Dependencies
-import { OptionsProps } from './global';
-import { relation } from './relations';
-
-// Types
-
-type ObjectionRelationProps = {
-  subject: string;
-  modelPath: string;
-};
-
-export class ObjectionRelation {
-  subject: string;
-  modelPath: string;
-  constructor({ subject, modelPath }: ObjectionRelationProps) {
-    this.subject = subject;
-    this.modelPath = modelPath;
-  }
-
-  belongsTo(object: string, options?: OptionsProps) {
-    if (!options) options = { modelPath: this.modelPath };
-    if (!options.modelPath) options.modelPath = this.modelPath;
-    return relation({
-      subject: this.subject,
-      relType: 'belongsTo',
-      object,
-      options,
-    });
-  }
-
-  hasOne(object: string, options?: OptionsProps) {
-    if (!options) options = { modelPath: this.modelPath };
-    if (!options.modelPath) options.modelPath = this.modelPath;
-    return relation({
-      subject: this.subject,
-      relType: 'hasOne',
-      object,
-      options,
-    });
-  }
-
-  hasMany(object: string, options?: OptionsProps) {
-    if (!options) options = { modelPath: this.modelPath };
-    if (!options.modelPath) options.modelPath = this.modelPath;
-    return relation({
-      subject: this.subject,
-      relType: 'hasMany',
-      object,
-      options,
-    });
-  }
-
-  hasManyThrough(object: string, via: string, options?: OptionsProps) {
-    if (!options) options = { modelPath: this.modelPath };
-    if (!options.modelPath) options.modelPath = this.modelPath;
-    return relation({
-      subject: this.subject,
-      relType: 'hasManyThrough',
-      object,
-      via,
-      options,
-    });
-  }
-}

package/src/relations.ts

@@ -1,141 +0,0 @@
-// Dependencies
-import { Model } from 'objection';
-import {
-  RelationTypeProps,
-  CommonRelationOrTableOrForeignKeyProps,
-} from './global';
-import {
-  getSubjectTable,
-  getSubjectForeignKey,
-  getObjectTable,
-  getObjectForeignKey,
-  getModelClass,
-  getViaTable,
-} from './helpers';
-
-const {
-  HasOneRelation,
-  BelongsToOneRelation,
-  HasManyRelation,
-  ManyToManyRelation,
-} = Model;
-
-// Types
-
-type AdvancedRelationTypeProps = RelationTypeProps & {
-  through: {
-    from: string;
-    to: string;
-  };
-};
-
-/*
-    Defines a relationship where a record in one model can belong to a record in
-    another model.
-*/
-export function belongsRelation({ modelClass, from, to }: RelationTypeProps) {
-  return {
-    relation: BelongsToOneRelation,
-    modelClass,
-    join: { from, to },
-  };
-}
-
-/*
-	Defines a relationship where a record in one model can own a record in another
-	model.
-*/
-export function hasOneRelation({ modelClass, from, to }: RelationTypeProps) {
-  return {
-    relation: HasOneRelation,
-    modelClass,
-    join: { from, to },
-  };
-}
-
-/*
-	Defines a relationship where a record in one model can own many records in
-	another model.
-*/
-export function hasManyRelation({ modelClass, from, to }: RelationTypeProps) {
-  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
-*/
-export function hasManyThroughRelation({
-  modelClass,
-  from,
-  through,
-  to,
-}: AdvancedRelationTypeProps) {
-  return {
-    relation: ManyToManyRelation,
-    modelClass,
-    join: { from, through, to },
-  };
-}
-
-type RelationProps = CommonRelationOrTableOrForeignKeyProps & {
-  subject: string;
-  relType: 'hasOne' | 'hasMany' | 'hasManyThrough' | 'belongsTo';
-  object: string;
-  via?: string;
-};
-
-/*
-	Defines a relationship by passing the subject, the predicate, and the object,
-	along with an optional via model.
-*/
-export function relation({
-  subject,
-  relType,
-  object,
-  via,
-  options,
-}: RelationProps) {
-  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');
-  }
-}