@constructive-io/graphql-query 3.2.4 → 3.3.0

package/meta-object/format.json

@@ -5,44 +5,27 @@
     "definitions": {
         "field": {
             "type": "object",
-            "required": [
-                "name",
-                "type"
-            ],
+            "required": ["name", "type"],
             "additionalProperties": true,
             "properties": {
                 "name": {
                     "type": "string",
                     "default": "id",
-                    "examples": [
-                        "id"
-                    ]
+                    "examples": ["id"]
                 },
                 "type": {
                     "type": "object",
-                    "required": [
-                        "pgType",
-                        "gqlType"
-                    ],
+                    "required": ["pgType", "gqlType"],
                     "additionalProperties": true,
                     "properties": {
                         "gqlType": {
-                            "type": [
-                                "string",
-                                "null"
-                            ]
+                            "type": ["string", "null"]
                         },
                         "pgType": {
-                            "type": [
-                                "string",
-                                "null"
-                            ]
+                            "type": ["string", "null"]
                         },
                         "subtype": {
-                            "type": [
-                                "string",
-                                "null"
-                            ]
+                            "type": ["string", "null"]
                         }
                     }
                 }
@@ -58,9 +41,7 @@
                     "name": {
                         "type": "string",
                         "default": "User",
-                        "examples": [
-                            "User"
-                        ]
+                        "examples": ["User"]
                     },
                     "fields": {
                         "type": "array",
@@ -88,9 +69,7 @@
                                 "refTable": {
                                     "type": "string",
                                     "default": "User",
-                                    "examples": [
-                                        "User"
-                                    ]
+                                    "examples": ["User"]
                                 },
                                 "fromKey": {
                                     "$ref": "#/definitions/field"
@@ -99,25 +78,16 @@
                                     "$ref": "#/definitions/field"
                                 }
                             },
-                            "required": [
-                                "refTable",
-                                "fromKey",
-                                "toKey"
-                            ],
+                            "required": ["refTable", "fromKey", "toKey"],
                             "additionalProperties": false
                         }
                     }
                 },
-                "required": [
-                    "name",
-                    "fields"
-                ],
+                "required": ["name", "fields"],
                 "additionalProperties": false
             }
         }
     },
-    "required": [
-        "tables"
-    ],
+    "required": ["tables"],
     "additionalProperties": false
 }

package/meta-object/validate.d.ts

@@ -1,4 +1,9 @@
-export declare function validateMetaObject(obj: any): true | {
-    errors: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+export interface ValidationResult {
+    errors: unknown[] | null | undefined;
     message: string;
-};
+}
+/**
+ * Validate a MetaObject against the JSON schema
+ * @returns true if valid, or an object with errors and message if invalid
+ */
+export declare function validateMetaObject(obj: unknown): true | ValidationResult;

package/meta-object/validate.js

@@ -6,13 +6,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateMetaObject = validateMetaObject;
 const ajv_1 = __importDefault(require("ajv"));
 const format_json_1 = __importDefault(require("./format.json"));
+let cachedAjv = null;
+let cachedValidator = null;
+function getValidator() {
+    if (!cachedAjv) {
+        cachedAjv = new ajv_1.default({ allErrors: true });
+        cachedValidator = cachedAjv.compile(format_json_1.default);
+    }
+    return {
+        ajv: cachedAjv,
+        validator: cachedValidator,
+    };
+}
+/**
+ * Validate a MetaObject against the JSON schema
+ * @returns true if valid, or an object with errors and message if invalid
+ */
 function validateMetaObject(obj) {
-    const ajv = new ajv_1.default({ allErrors: true });
-    const valid = ajv.validate(format_json_1.default, obj);
+    const { ajv, validator } = getValidator();
+    const valid = validator(obj);
     if (valid)
         return true;
     return {
-        errors: ajv.errors,
-        message: ajv.errorsText(ajv.errors, { separator: '\n' }),
+        errors: validator.errors,
+        message: ajv.errorsText(validator.errors, { separator: '\n' }),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-query",
-  "version": "3.2.4",
+  "version": "3.3.0",
   "description": "Constructive GraphQL Query",
   "author": "Constructive <developers@constructive.io>",
   "main": "index.js",
@@ -34,9 +34,10 @@
     "grafast": "1.0.0-rc.7",
     "graphile-build-pg": "5.0.0-rc.5",
     "graphile-config": "1.0.0-rc.5",
-    "graphile-settings": "^4.3.4",
+    "graphile-settings": "^4.5.0",
     "graphql": "^16.9.0",
     "inflection": "^3.0.0",
+    "inflekt": "^0.3.1",
     "lru-cache": "^10.4.3",
     "postgraphile": "5.0.0-rc.7"
   },
@@ -50,5 +51,5 @@
   "devDependencies": {
     "makage": "^0.1.10"
   },
-  "gitHead": "1b17d61b375abaa04310abe05c2a3ca5881ac650"
+  "gitHead": "1e0c774144be23a4c57a15ffe54ea0ec9fbd7c55"
 }

package/query-builder.d.ts

@@ -1,11 +1,10 @@
-import type { FieldSelection, IntrospectionSchema, MetaObject, QueryBuilderOptions, QueryBuilderResult, QueryDefinition, SelectionOptions } from './types';
+import type { MetaObject, QueryBuilderOptions, QueryBuilderResult, QueryDefinition, QueryFieldSelection, QueryIntrospectionSchema, QuerySelectionOptions } from './types';
 export * as MetaObject from './meta-object';
 export declare class QueryBuilder {
-    _introspection: IntrospectionSchema;
+    _introspection: QueryIntrospectionSchema;
     _meta: MetaObject;
     private _models;
     private _model;
-    private _fields;
     private _key;
     private _queryName;
     private _ast;
@@ -19,29 +18,29 @@ export declare class QueryBuilder {
     query(model: string): QueryBuilder;
     _findQuery(): string;
     _findMutation(): string;
-    select(selection?: SelectionOptions | null): QueryBuilder;
+    select(selection?: QuerySelectionOptions | null): QueryBuilder;
     edges(useEdges: boolean): QueryBuilder;
     getMany({ select }?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): QueryBuilder;
     all({ select }?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): QueryBuilder;
     count(): QueryBuilder;
     getOne({ select }?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): QueryBuilder;
     create({ select }?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): QueryBuilder;
     delete({ select }?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): QueryBuilder;
     update({ select }?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): QueryBuilder;
     queryName(name: string): QueryBuilder;
     print(): QueryBuilderResult;
-    pickScalarFields: (selection: SelectionOptions | null, defn: QueryDefinition) => FieldSelection[];
-    pickAllFields: (selection: SelectionOptions, defn: QueryDefinition) => FieldSelection[];
+    pickScalarFields: (selection: QuerySelectionOptions | null, defn: QueryDefinition) => QueryFieldSelection[];
+    pickAllFields: (selection: QuerySelectionOptions, defn: QueryDefinition) => QueryFieldSelection[];
 }

package/query-builder.js

@@ -35,7 +35,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryBuilder = exports.MetaObject = void 0;
 const graphql_1 = require("graphql");
-const inflection_1 = require("inflection");
+const inflekt_1 = require("inflekt");
 const ast_1 = require("./ast");
 const meta_object_1 = require("./meta-object");
 exports.MetaObject = __importStar(require("./meta-object"));
@@ -45,7 +45,6 @@ class QueryBuilder {
     _meta;
     _models;
     _model;
-    _fields;
     _key;
     _queryName;
     _ast;
@@ -69,21 +68,16 @@ class QueryBuilder {
      * Save all gql queries and mutations by model name for quicker lookup
      */
     initModelMap() {
-        this._models = Object.keys(this._introspection).reduce((map, key) => {
-            const defn = this._introspection[key];
-            map = {
-                ...map,
-                [defn.model]: {
-                    ...map[defn.model],
-                    ...{ [key]: defn },
-                },
-            };
-            return map;
-        }, {});
+        this._models = {};
+        for (const [key, defn] of Object.entries(this._introspection)) {
+            if (!this._models[defn.model]) {
+                this._models[defn.model] = {};
+            }
+            this._models[defn.model][key] = defn;
+        }
     }
     clear() {
         this._model = '';
-        this._fields = [];
         this._key = null;
         this._queryName = '';
         this._ast = null;
@@ -130,13 +124,13 @@ class QueryBuilder {
         const getInputName = (mutationType) => {
             switch (mutationType) {
                 case 'delete': {
-                    return `Delete${(0, inflection_1.camelize)(this._model)}Input`;
+                    return `Delete${(0, inflekt_1.camelize)(this._model)}Input`;
                 }
                 case 'create': {
-                    return `Create${(0, inflection_1.camelize)(this._model)}Input`;
+                    return `Create${(0, inflekt_1.camelize)(this._model)}Input`;
                 }
                 case 'patch': {
-                    return `Update${(0, inflection_1.camelize)(this._model)}Input`;
+                    return `Update${(0, inflekt_1.camelize)(this._model)}Input`;
                 }
                 default:
                     throw new Error('Unhandled mutation type' + mutationType);
@@ -165,7 +159,7 @@ class QueryBuilder {
     getMany({ select } = {}) {
         this._op = 'getMany';
         this._key = this._findQuery();
-        this.queryName((0, inflection_1.camelize)(['get', (0, inflection_1.underscore)(this._key), 'query'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)(['get', (0, inflekt_1.underscore)(this._key), 'query'].join('_'), true));
         const defn = this._introspection[this._key];
         this.select(select);
         this._ast = (0, ast_1.getMany)({
@@ -180,7 +174,7 @@ class QueryBuilder {
     all({ select } = {}) {
         this._op = 'getMany';
         this._key = this._findQuery();
-        this.queryName((0, inflection_1.camelize)(['get', (0, inflection_1.underscore)(this._key), 'query', 'all'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)(['get', (0, inflekt_1.underscore)(this._key), 'query', 'all'].join('_'), true));
         const defn = this._introspection[this._key];
         this.select(select);
         this._ast = (0, ast_1.getAll)({
@@ -194,7 +188,7 @@ class QueryBuilder {
     count() {
         this._op = 'getMany';
         this._key = this._findQuery();
-        this.queryName((0, inflection_1.camelize)(['get', (0, inflection_1.underscore)(this._key), 'count', 'query'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)(['get', (0, inflekt_1.underscore)(this._key), 'count', 'query'].join('_'), true));
         const defn = this._introspection[this._key];
         this._ast = (0, ast_1.getCount)({
             queryName: this._queryName,
@@ -206,7 +200,7 @@ class QueryBuilder {
     getOne({ select } = {}) {
         this._op = 'getOne';
         this._key = this._findQuery();
-        this.queryName((0, inflection_1.camelize)(['get', (0, inflection_1.underscore)(this._key), 'query'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)(['get', (0, inflekt_1.underscore)(this._key), 'query'].join('_'), true));
         const defn = this._introspection[this._key];
         this.select(select);
         this._ast = (0, ast_1.getOne)({
@@ -222,7 +216,7 @@ class QueryBuilder {
         this._op = 'mutation';
         this._mutation = 'create';
         this._key = this._findMutation();
-        this.queryName((0, inflection_1.camelize)([(0, inflection_1.underscore)(this._key), 'mutation'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)([(0, inflekt_1.underscore)(this._key), 'mutation'].join('_'), true));
         const defn = this._introspection[this._key];
         this.select(select);
         this._ast = (0, ast_1.createOne)({
@@ -237,7 +231,7 @@ class QueryBuilder {
         this._op = 'mutation';
         this._mutation = 'delete';
         this._key = this._findMutation();
-        this.queryName((0, inflection_1.camelize)([(0, inflection_1.underscore)(this._key), 'mutation'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)([(0, inflekt_1.underscore)(this._key), 'mutation'].join('_'), true));
         const defn = this._introspection[this._key];
         this.select(select);
         this._ast = (0, ast_1.deleteOne)({
@@ -251,7 +245,7 @@ class QueryBuilder {
         this._op = 'mutation';
         this._mutation = 'patch';
         this._key = this._findMutation();
-        this.queryName((0, inflection_1.camelize)([(0, inflection_1.underscore)(this._key), 'mutation'].join('_'), true));
+        this.queryName((0, inflekt_1.camelize)([(0, inflekt_1.underscore)(this._key), 'mutation'].join('_'), true));
         const defn = this._introspection[this._key];
         this.select(select);
         this._ast = (0, ast_1.patchOne)({
@@ -302,7 +296,8 @@ function pickScalarFields(selection, defn) {
             return true;
         return Object.keys(selection).includes(fieldName);
     })
-        .filter((fieldName) => !isRelationalField(fieldName, modelMeta) && isInTableSchema(fieldName))
+        .filter((fieldName) => !isRelationalField(fieldName, modelMeta) &&
+        isInTableSchema(fieldName))
         .map((fieldName) => ({
         name: fieldName,
         isObject: false,
@@ -347,9 +342,10 @@ function pickAllFields(selection, defn) {
             }
             const referencedForeignConstraint = modelMeta.foreignConstraints.find((constraint) => constraint.fromKey.name === fieldName ||
                 constraint.fromKey.alias === fieldName);
-            const subFields = Object.keys(fieldOptions.select).filter((subField) => {
+            const selectOptions = fieldOptions;
+            const subFields = Object.keys(selectOptions.select).filter((subField) => {
                 return (!isRelationalField(subField, modelMeta) &&
-                    isWhiteListed(fieldOptions.select[subField]));
+                    isWhiteListed(selectOptions.select[subField]));
             });
             const isBelongTo = !!referencedForeignConstraint;
             const fieldSelection = {
@@ -357,7 +353,7 @@ function pickAllFields(selection, defn) {
                 isObject: true,
                 isBelongTo,
                 selection: subFields.map((name) => ({ name, isObject: false })),
-                variables: fieldOptions.variables,
+                variables: selectOptions.variables,
             };
             // Need to further expand selection of object fields,
             // but only non-graphql-builtin, non-relation fields
@@ -412,5 +408,5 @@ function isRelationalField(fieldName, modelMeta) {
 // Get getMany op name from model
 // ie. UserSetting => userSettings
 function modelNameToGetMany(model) {
-    return (0, inflection_1.camelize)((0, inflection_1.pluralize)((0, inflection_1.underscore)(model)), true);
+    return (0, inflekt_1.camelize)((0, inflekt_1.pluralize)((0, inflekt_1.underscore)(model)), true);
 }

package/{types.d.ts → types/core.d.ts}

@@ -1,4 +1,5 @@
 import type { DocumentNode, FieldNode, SelectionSetNode, VariableDefinitionNode } from 'graphql';
+import type { CleanField } from './schema';
 export type ASTNode = DocumentNode | FieldNode | SelectionSetNode | VariableDefinitionNode;
 export interface NestedProperties {
     [key: string]: QueryProperty | NestedProperties;
@@ -22,7 +23,12 @@ export interface MutationDefinition extends QueryDefinition {
     qtype: 'mutation';
     mutationType: 'create' | 'patch' | 'delete';
 }
-export interface IntrospectionSchema {
+/**
+ * Runtime QueryBuilder's internal schema map.
+ * Named with 'Query' prefix to avoid collision with the standard
+ * GraphQL IntrospectionSchema from ./introspection.ts
+ */
+export interface QueryIntrospectionSchema {
     [key: string]: QueryDefinition | MutationDefinition;
 }
 export interface MetaFieldType {
@@ -38,7 +44,6 @@ export interface MetaField {
     name: string;
     type: MetaFieldType;
 }
-export type CleanField = MetaField;
 export interface MetaConstraint {
     name: string;
     type: MetaFieldType;
@@ -63,22 +68,22 @@ export type GraphQLVariableValue = string | number | boolean | null;
 export interface GraphQLVariables {
     [key: string]: GraphQLVariableValue | GraphQLVariableValue[] | GraphQLVariables | GraphQLVariables[];
 }
-export interface FieldSelection {
+export interface QueryFieldSelection {
     name: string;
     isObject: boolean;
-    fieldDefn?: MetaField;
-    selection?: FieldSelection[];
+    fieldDefn?: MetaField | CleanField;
+    selection?: QueryFieldSelection[];
     variables?: GraphQLVariables;
     isBelongTo?: boolean;
 }
-export interface SelectionOptions {
+export interface QuerySelectionOptions {
     [fieldName: string]: boolean | {
         select: Record<string, boolean>;
         variables?: GraphQLVariables;
     };
 }
 export interface QueryBuilderInstance {
-    _introspection: IntrospectionSchema;
+    _introspection: QueryIntrospectionSchema;
     _meta: MetaObject;
     _edges?: boolean;
 }
@@ -86,18 +91,18 @@ export interface ASTFunctionParams {
     queryName: string;
     operationName: string;
     query: QueryDefinition;
-    selection: FieldSelection[];
+    selection: QueryFieldSelection[];
     builder?: QueryBuilderInstance;
 }
 export interface MutationASTParams {
     mutationName: string;
     operationName: string;
     mutation: MutationDefinition;
-    selection?: FieldSelection[];
+    selection?: QueryFieldSelection[];
 }
 export interface QueryBuilderOptions {
     meta: MetaObject;
-    introspection: IntrospectionSchema;
+    introspection: QueryIntrospectionSchema;
 }
 export interface QueryBuilderResult {
     _hash: string;
@@ -107,23 +112,23 @@ export interface QueryBuilderResult {
 export interface IQueryBuilder {
     query(model: string): IQueryBuilder;
     getMany(options?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): IQueryBuilder;
     getOne(options?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): IQueryBuilder;
     all(options?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): IQueryBuilder;
     count(): IQueryBuilder;
     create(options?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): IQueryBuilder;
     update(options?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): IQueryBuilder;
     delete(options?: {
-        select?: SelectionOptions;
+        select?: QuerySelectionOptions;
     }): IQueryBuilder;
     edges(useEdges: boolean): IQueryBuilder;
     print(): QueryBuilderResult;
@@ -158,6 +163,8 @@ export interface ExecutorCacheStats {
     maxSize: number;
 }
 /**
- * Re-export GraphQL execution types for convenience
+ * Re-export GraphQL execution types for convenience.
+ * Note: GraphQLError is NOT re-exported here to avoid collision with
+ * the client/error.ts GraphQLError interface (which is the PostGraphile-oriented one).
  */
-export type { ExecutionResult, GraphQLError, GraphQLSchema, } from 'graphql';
+export type { ExecutionResult, GraphQLSchema } from 'graphql';

package/types/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Barrel export for all types
+ *
+ * Re-exports both the original QueryBuilder runtime types (core.ts)
+ * and the codegen-style types (schema, introspection, query, mutation, selection)
+ */
+export * from './core';
+export * from './schema';
+export * from './introspection';
+export * from './query';
+export * from './mutation';
+export * from './selection';

package/types/index.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * Barrel export for all types
+ *
+ * Re-exports both the original QueryBuilder runtime types (core.ts)
+ * and the codegen-style types (schema, introspection, query, mutation, selection)
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Original QueryBuilder runtime types
+__exportStar(require("./core"), exports);
+// Codegen-style schema types (CleanTable, CleanField, etc.)
+__exportStar(require("./schema"), exports);
+// Introspection types
+__exportStar(require("./introspection"), exports);
+// Query types (QueryOptions, Filter, etc.)
+__exportStar(require("./query"), exports);
+// Mutation types
+__exportStar(require("./mutation"), exports);
+// Selection types (FieldSelection presets, SimpleFieldSelection, etc.)
+__exportStar(require("./selection"), exports);