graphile-search-plugin 0.1.2 → 0.1.3

package/LICENSE

@@ -1,6 +1,8 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Hyperweb <developers@hyperweb.io>
+Copyright (c) 2020-present, Interweb, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/index.js

@@ -0,0 +1,59 @@
+"use strict";
+// plugins/PgSearchPlugin.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PgSearchPlugin = void 0;
+/**
+ * PgSearchPlugin - Generates search conditions for tsvector columns
+ */
+const PgSearchPlugin = (builder, options = {}) => {
+    const { pgSearchPrefix = 'tsv' } = options;
+    builder.hook('GraphQLInputObjectType:fields', (fields, build, context) => {
+        const { inflection } = build;
+        const { scope: { isPgCondition, pgIntrospection: table }, fieldWithHooks } = context;
+        if (!isPgCondition || !table || table.kind !== 'class')
+            return fields;
+        const tsvs = table.attributes.filter((attr) => attr.type.name === 'tsvector');
+        if (!tsvs.length)
+            return fields;
+        return build.extend(fields, tsvs.reduce((memo, attr) => {
+            const fieldName = inflection.camelCase(`${pgSearchPrefix}_${attr.name}`);
+            memo[fieldName] = fieldWithHooks(fieldName, { type: build.graphql.GraphQLString }, {});
+            return memo;
+        }, {}));
+    });
+    builder.hook('GraphQLObjectType:fields:field:args', (args, build, context) => {
+        const { pgSql: sql, inflection } = build;
+        const { scope: { isPgFieldConnection, isPgFieldSimpleCollection, pgFieldIntrospection: procOrTable, pgFieldIntrospectionTable: tableIfProc, }, addArgDataGenerator, } = context;
+        const table = tableIfProc || procOrTable;
+        if ((!isPgFieldConnection && !isPgFieldSimpleCollection) ||
+            !table ||
+            table.kind !== 'class') {
+            return args;
+        }
+        const tsvs = table.attributes.filter((attr) => attr.type.name === 'tsvector');
+        if (!tsvs.length)
+            return args;
+        tsvs.forEach((tsv) => {
+            const conditionFieldName = inflection.camelCase(`${pgSearchPrefix}_${tsv.name}`);
+            addArgDataGenerator(function addSearchCondition({ condition }) {
+                if (!condition || !(conditionFieldName in condition))
+                    return {};
+                const value = condition[conditionFieldName];
+                if (value == null)
+                    return {};
+                return {
+                    pgQuery: (queryBuilder) => {
+                        const tsquery = sql.fragment `websearch_to_tsquery('english', ${sql.value(value)})`;
+                        const tableAlias = queryBuilder.getTableAlias();
+                        // WHERE condition
+                        queryBuilder.where(sql.fragment `${tableAlias}.${sql.identifier(tsv.name)} @@ ${tsquery}`);
+                        // Automatically add ordering by relevance (descending)
+                        queryBuilder.orderBy(sql.fragment `ts_rank(${tableAlias}.${sql.identifier(tsv.name)}, ${tsquery})`, false);
+                    },
+                };
+            });
+        });
+        return args;
+    }, [], ['PgConnectionArgOrderBy']);
+};
+exports.PgSearchPlugin = PgSearchPlugin;

package/package.json

@@ -1,34 +1,33 @@
 {
   "name": "graphile-search-plugin",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "generate search conditions for your tsvector columns",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/pyramation/graphile-search-plugin#readme",
   "license": "SEE LICENSE IN LICENSE",
-  "main": "main/index.js",
-  "module": "module/index.js",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
   "directories": {
     "lib": "src",
     "test": "__tests__"
   },
   "files": [
-    "main",
-    "module"
+    "dist"
   ],
   "scripts": {
-    "build:main": "cross-env BABEL_ENV=production babel src --out-dir main --delete-dir-on-start",
-    "build:module": "cross-env MODULE=true babel src --out-dir module --delete-dir-on-start",
-    "build": "npm run build:module && npm run build:main",
-    "prepublish": "npm run build",
-    "dev": "cross-env NODE_ENV=development babel-node src/index",
-    "watch": "cross-env NODE_ENV=development babel-watch src/index",
-    "lint": "eslint src --fix",
+    "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
+    "clean": "rimraf dist/**",
+    "prepack": "pnpm run build",
+    "build": "pnpm run clean; tsc -p tsconfig.json; tsc -p tsconfig.esm.json; pnpm run copy",
+    "build:dev": "pnpm run clean; tsc -p tsconfig.json --declarationMap; tsc -p tsconfig.esm.json; pnpm run copy",
+    "lint": "eslint . --fix",
     "test": "jest",
-    "test:watch": "jest --watch",
-    "test:debug": "node --inspect node_modules/.bin/jest --runInBand"
+    "test:watch": "jest --watch"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "directory": "dist"
   },
   "repository": {
     "type": "git",
@@ -46,33 +45,15 @@
     "url": "https://github.com/pyramation/graphile-search-plugin/issues"
   },
   "devDependencies": {
-    "@babel/cli": "7.11.6",
-    "@babel/core": "7.11.6",
-    "@babel/node": "^7.10.5",
-    "@babel/plugin-proposal-class-properties": "7.10.4",
-    "@babel/plugin-proposal-export-default-from": "7.10.4",
-    "@babel/plugin-proposal-object-rest-spread": "7.11.0",
-    "@babel/plugin-transform-runtime": "7.11.5",
-    "@babel/preset-env": "7.11.5",
     "@pyramation/postgraphile-plugin-fulltext-filter": "2.0.0",
-    "babel-core": "7.0.0-bridge.0",
-    "babel-eslint": "10.1.0",
-    "babel-jest": "25.1.0",
-    "babel-watch": "^7.0.0",
-    "cross-env": "^7.0.2",
-    "envalid": "^6.0.2",
-    "eslint": "6.8.0",
-    "eslint-config-prettier": "^6.10.0",
-    "eslint-plugin-prettier": "^3.1.2",
     "graphile-simple-inflector": "^0.1.1",
-    "graphile-test": "^0.1.1",
-    "jest": "^24.5.0",
-    "jest-in-case": "^1.0.2",
-    "postgraphile-plugin-connection-filter": "^2.0.0",
-    "prettier": "^2.1.2",
-    "regenerator-runtime": "^0.13.7"
+    "graphile-test": "^2.8.0",
+    "pgsql-test": "^2.14.3",
+    "postgraphile-plugin-connection-filter": "^2.0.0"
   },
   "dependencies": {
-    "@babel/runtime": "^7.11.2"
-  }
+    "graphile-build": "^4.14.1",
+    "graphql-tag": "2.12.6"
+  },
+  "gitHead": "da2bd9606bd5e1d4e63b7d74f08920975980e541"
 }

package/main/index.js

@@ -1,158 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = exports.PgSearchPlugin = void 0;
-
-var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
-
-function _templateObject3() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["", ".", " @@ ", ""]);
-
-  _templateObject3 = function _templateObject3() {
-    return data;
-  };
-
-  return data;
-}
-
-function _templateObject2() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["ts_rank ( ", ".", ", ", " )"]);
-
-  _templateObject2 = function _templateObject2() {
-    return data;
-  };
-
-  return data;
-}
-
-function _templateObject() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["websearch_to_tsquery('english', ", ")"]);
-
-  _templateObject = function _templateObject() {
-    return data;
-  };
-
-  return data;
-}
-
-function _createForOfIteratorHelper(o, allowArrayLike) { var it; if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-var PgSearchPlugin = function PgSearchPlugin(builder, _ref) {
-  var _ref$pgSearchPrefix = _ref.pgSearchPrefix,
-      pgSearchPrefix = _ref$pgSearchPrefix === void 0 ? 'tsv' : _ref$pgSearchPrefix;
-  builder.hook('GraphQLInputObjectType:fields', function addConditionInputField(fields, build, context) {
-    var inflection = build.inflection;
-    var _context$scope = context.scope,
-        isPgCondition = _context$scope.isPgCondition,
-        table = _context$scope.pgIntrospection,
-        fieldWithHooks = context.fieldWithHooks;
-
-    if (!isPgCondition || !table || table.kind !== 'class') {
-      return fields;
-    }
-
-    var tsvs = table.attributes.filter(function (attr) {
-      return attr.type.name === 'tsvector';
-    });
-    if (!tsvs.length) return fields;
-    return build.extend(fields, tsvs.reduce(function (m, v) {
-      var key = inflection.camelCase("".concat(pgSearchPrefix, "_").concat(v.name));
-      m[key] = fieldWithHooks(key, {
-        type: build.graphql.GraphQLString
-      }, {});
-      return m;
-    }, {}));
-  });
-  builder.hook('GraphQLObjectType:fields:field:args', function addSqlWhereClause(args, build, context) {
-    var sql = build.pgSql,
-        inflection = build.inflection;
-    var _context$scope2 = context.scope,
-        isPgFieldConnection = _context$scope2.isPgFieldConnection,
-        isPgFieldSimpleCollection = _context$scope2.isPgFieldSimpleCollection,
-        procOrTable = _context$scope2.pgFieldIntrospection,
-        tableIfProc = _context$scope2.pgFieldIntrospectionTable,
-        addArgDataGenerator = context.addArgDataGenerator;
-    var table = tableIfProc || procOrTable;
-
-    if (!isPgFieldConnection && !isPgFieldSimpleCollection || !table || table.kind !== 'class') {
-      return args;
-    }
-
-    var tsvs = table.attributes.filter(function (attr) {
-      return attr.type.name === 'tsvector';
-    });
-    if (!tsvs.length) return args;
-
-    var _iterator = _createForOfIteratorHelper(tsvs),
-        _step;
-
-    try {
-      var _loop = function _loop() {
-        var tsv = _step.value;
-        var conditionFieldName = inflection.camelCase(pgSearchPrefix + '_' + tsv.name);
-
-        var conditionGenerator = function conditionGenerator(value, _ref2) {
-          var queryBuilder = _ref2.queryBuilder,
-              sql = _ref2.sql,
-              sqlTableAlias = _ref2.sqlTableAlias;
-
-          if (value == null) {
-            return;
-          }
-
-          var tsquery = sql.fragment(_templateObject(), sql.value(value));
-          queryBuilder.orderBy(sql.fragment(_templateObject2(), sqlTableAlias, sql.identifier(tsv.name), tsquery), false, false);
-          return sql.fragment(_templateObject3(), sqlTableAlias, sql.identifier(tsv.name), tsquery);
-        };
-
-        addArgDataGenerator(function conditionSQLBuilder(_ref3) {
-          var condition = _ref3.condition;
-
-          if (!condition || !(conditionFieldName in condition)) {
-            return {};
-          }
-
-          var conditionValue = condition[conditionFieldName];
-          return {
-            pgQuery: function pgQuery(queryBuilder) {
-              var sqlCondition = conditionGenerator(conditionValue, {
-                queryBuilder: queryBuilder,
-                sql: sql,
-                sqlTableAlias: queryBuilder.getTableAlias()
-              }, build);
-
-              if (sqlCondition) {
-                queryBuilder.where(sqlCondition);
-              }
-            }
-          };
-        });
-      };
-
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        _loop();
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-
-    return args;
-  }, [], // Make sure we're loaded before PgConnectionArgOrderBy, otherwise
-  // ordering added by conditions will be overridden by the default
-  // ordering.
-  ['PgConnectionArgOrderBy'], []);
-};
-
-exports.PgSearchPlugin = PgSearchPlugin;
-var _default = PgSearchPlugin;
-exports["default"] = _default;

package/module/index.js

@@ -1,102 +0,0 @@
-export const PgSearchPlugin = (builder, {
-  pgSearchPrefix = 'tsv'
-}) => {
-  builder.hook('GraphQLInputObjectType:fields', function addConditionInputField(fields, build, context) {
-    const {
-      inflection
-    } = build;
-    const {
-      scope: {
-        isPgCondition,
-        pgIntrospection: table
-      },
-      fieldWithHooks
-    } = context;
-
-    if (!isPgCondition || !table || table.kind !== 'class') {
-      return fields;
-    }
-
-    const tsvs = table.attributes.filter(attr => attr.type.name === 'tsvector');
-    if (!tsvs.length) return fields;
-    return build.extend(fields, tsvs.reduce((m, v) => {
-      const key = inflection.camelCase(`${pgSearchPrefix}_${v.name}`);
-      m[key] = fieldWithHooks(key, {
-        type: build.graphql.GraphQLString
-      }, {});
-      return m;
-    }, {}));
-  });
-  builder.hook('GraphQLObjectType:fields:field:args', function addSqlWhereClause(args, build, context) {
-    const {
-      pgSql: sql,
-      inflection
-    } = build;
-    const {
-      scope: {
-        isPgFieldConnection,
-        isPgFieldSimpleCollection,
-        pgFieldIntrospection: procOrTable,
-        pgFieldIntrospectionTable: tableIfProc
-      },
-      addArgDataGenerator
-    } = context;
-    const table = tableIfProc || procOrTable;
-
-    if (!isPgFieldConnection && !isPgFieldSimpleCollection || !table || table.kind !== 'class') {
-      return args;
-    }
-
-    const tsvs = table.attributes.filter(attr => attr.type.name === 'tsvector');
-    if (!tsvs.length) return args;
-
-    for (const tsv of tsvs) {
-      const conditionFieldName = inflection.camelCase(pgSearchPrefix + '_' + tsv.name);
-
-      const conditionGenerator = (value, {
-        queryBuilder,
-        sql,
-        sqlTableAlias
-      }) => {
-        if (value == null) {
-          return;
-        }
-
-        const tsquery = sql.fragment`websearch_to_tsquery('english', ${sql.value(value)})`;
-        queryBuilder.orderBy(sql.fragment`ts_rank ( ${sqlTableAlias}.${sql.identifier(tsv.name)}, ${tsquery} )`, false, false);
-        return sql.fragment`${sqlTableAlias}.${sql.identifier(tsv.name)} @@ ${tsquery}`;
-      };
-
-      addArgDataGenerator(function conditionSQLBuilder({
-        condition
-      }) {
-        if (!condition || !(conditionFieldName in condition)) {
-          return {};
-        }
-
-        const {
-          [conditionFieldName]: conditionValue
-        } = condition;
-        return {
-          pgQuery: queryBuilder => {
-            const sqlCondition = conditionGenerator(conditionValue, {
-              queryBuilder,
-              sql,
-              sqlTableAlias: queryBuilder.getTableAlias()
-            }, build);
-
-            if (sqlCondition) {
-              queryBuilder.where(sqlCondition);
-            }
-          }
-        };
-      });
-    }
-
-    return args;
-  }, [], // Make sure we're loaded before PgConnectionArgOrderBy, otherwise
-  // ordering added by conditions will be overridden by the default
-  // ordering.
-  ['PgConnectionArgOrderBy'], []);
-};
-export default PgSearchPlugin;