@constructive-io/graphql-codegen 4.6.1 → 4.7.0

package/core/meta-object/convert.js

@@ -1,63 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertFromMetaSchema = convertFromMetaSchema;
+exports.convertFromMetaSchema = void 0;
 /**
- * Convert from raw _meta schema response to internal MetaObject format
+ * Re-export meta-object conversion from @constructive-io/graphql-query.
  */
-function convertFromMetaSchema(metaSchema) {
-    const { _meta: { tables }, } = metaSchema;
-    const result = {
-        tables: [],
-    };
-    for (const table of tables) {
-        result.tables.push({
-            name: table.name,
-            fields: table.fields.map((f) => pickField(f)),
-            primaryConstraints: pickArrayConstraint(table.primaryKeyConstraints),
-            uniqueConstraints: pickArrayConstraint(table.uniqueConstraints),
-            foreignConstraints: pickForeignConstraint(table.foreignKeyConstraints, table.relations),
-        });
-    }
-    return result;
-}
-function pickArrayConstraint(constraints) {
-    if (constraints.length === 0)
-        return [];
-    const c = constraints[0];
-    return c.fields.map((field) => pickConstraintField(field));
-}
-function pickForeignConstraint(constraints, relations) {
-    if (constraints.length === 0)
-        return [];
-    const { belongsTo } = relations;
-    return constraints.map((c) => {
-        const { fields, refFields, refTable } = c;
-        const fromKey = pickField(fields[0]);
-        const toKey = pickField(refFields[0]);
-        const matchingBelongsTo = belongsTo.find((belongsToItem) => {
-            const field = pickField(belongsToItem.keys[0]);
-            return field.name === fromKey.name;
-        });
-        // Ex: 'ownerId' will have an alias of 'owner', which has further selection of 'User' type
-        if (matchingBelongsTo) {
-            fromKey.alias = matchingBelongsTo.fieldName;
-        }
-        return {
-            refTable: refTable.name,
-            fromKey,
-            toKey,
-        };
-    });
-}
-function pickField(field) {
-    return {
-        name: field.name,
-        type: field.type,
-    };
-}
-function pickConstraintField(field) {
-    return {
-        name: field.name,
-        type: field.type,
-    };
-}
+var graphql_query_1 = require("@constructive-io/graphql-query");
+Object.defineProperty(exports, "convertFromMetaSchema", { enumerable: true, get: function () { return graphql_query_1.convertFromMetaSchema; } });

package/core/meta-object/validate.d.ts

@@ -1,9 +1,4 @@
-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
+ * Re-export meta-object validation from @constructive-io/graphql-query.
  */
-export declare function validateMetaObject(obj: unknown): true | ValidationResult;
+export { validateMetaObject, type ValidationResult, } from '@constructive-io/graphql-query';

package/core/meta-object/validate.js

@@ -1,34 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 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,
-    };
-}
+exports.validateMetaObject = void 0;
 /**
- * Validate a MetaObject against the JSON schema
- * @returns true if valid, or an object with errors and message if invalid
+ * Re-export meta-object validation from @constructive-io/graphql-query.
  */
-function validateMetaObject(obj) {
-    const { ajv, validator } = getValidator();
-    const valid = validator(obj);
-    if (valid)
-        return true;
-    return {
-        errors: validator.errors,
-        message: ajv.errorsText(validator.errors, { separator: '\n' }),
-    };
-}
+var graphql_query_1 = require("@constructive-io/graphql-query");
+Object.defineProperty(exports, "validateMetaObject", { enumerable: true, get: function () { return graphql_query_1.validateMetaObject; } });

package/core/query-builder.d.ts

@@ -1,46 +1,7 @@
-import type { IntrospectionSchema, MetaObject, QueryBuilderOptions, QueryBuilderResult, QueryDefinition, QueryFieldSelection, QuerySelectionOptions } from './types';
-export * as MetaObject from './meta-object';
-export declare class QueryBuilder {
-    _introspection: IntrospectionSchema;
-    _meta: MetaObject;
-    private _models;
-    private _model;
-    private _key;
-    private _queryName;
-    private _ast;
-    _edges: boolean;
-    private _op;
-    private _mutation;
-    private _select;
-    constructor({ meta, introspection }: QueryBuilderOptions);
-    initModelMap(): void;
-    clear(): void;
-    query(model: string): QueryBuilder;
-    _findQuery(): string;
-    _findMutation(): string;
-    select(selection?: QuerySelectionOptions | null): QueryBuilder;
-    edges(useEdges: boolean): QueryBuilder;
-    getMany({ select }?: {
-        select?: QuerySelectionOptions;
-    }): QueryBuilder;
-    all({ select }?: {
-        select?: QuerySelectionOptions;
-    }): QueryBuilder;
-    count(): QueryBuilder;
-    getOne({ select }?: {
-        select?: QuerySelectionOptions;
-    }): QueryBuilder;
-    create({ select }?: {
-        select?: QuerySelectionOptions;
-    }): QueryBuilder;
-    delete({ select }?: {
-        select?: QuerySelectionOptions;
-    }): QueryBuilder;
-    update({ select }?: {
-        select?: QuerySelectionOptions;
-    }): QueryBuilder;
-    queryName(name: string): QueryBuilder;
-    print(): QueryBuilderResult;
-    pickScalarFields: (selection: QuerySelectionOptions | null, defn: QueryDefinition) => QueryFieldSelection[];
-    pickAllFields: (selection: QuerySelectionOptions, defn: QueryDefinition) => QueryFieldSelection[];
-}
+/**
+ * Re-export QueryBuilder from @constructive-io/graphql-query.
+ *
+ * The QueryBuilder class and MetaObject namespace now live in graphql-query.
+ * Re-exported here for backward compatibility.
+ */
+export { QueryBuilder, MetaObject } from '@constructive-io/graphql-query';

package/core/query-builder.js

@@ -1,412 +1,12 @@
 "use strict";
-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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueryBuilder = exports.MetaObject = void 0;
-const graphql_1 = require("graphql");
-const inflekt_1 = require("inflekt");
-const ast_1 = require("./ast");
-const meta_object_1 = require("./meta-object");
-exports.MetaObject = __importStar(require("./meta-object"));
-const isObject = (val) => val !== null && typeof val === 'object';
-class QueryBuilder {
-    _introspection;
-    _meta;
-    _models;
-    _model;
-    _key;
-    _queryName;
-    _ast;
-    _edges;
-    _op;
-    _mutation;
-    _select;
-    constructor({ meta = {}, introspection }) {
-        this._introspection = introspection;
-        this._meta = meta;
-        this.clear();
-        this.initModelMap();
-        this.pickScalarFields = pickScalarFields.bind(this);
-        this.pickAllFields = pickAllFields.bind(this);
-        const result = (0, meta_object_1.validateMetaObject)(this._meta);
-        if (typeof result === 'object' && result.errors) {
-            throw new Error(`QueryBuilder: meta object is invalid:\n${result.message}`);
-        }
-    }
-    /*
-     * Save all gql queries and mutations by model name for quicker lookup
-     */
-    initModelMap() {
-        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._key = null;
-        this._queryName = '';
-        this._ast = null;
-        this._edges = false;
-        this._op = '';
-        this._mutation = '';
-        this._select = [];
-    }
-    query(model) {
-        this.clear();
-        this._model = model;
-        return this;
-    }
-    _findQuery() {
-        // based on the op, finds the relevant GQL query
-        const queries = this._models[this._model];
-        if (!queries) {
-            throw new Error('No queries found for ' + this._model);
-        }
-        const matchQuery = Object.entries(queries).find(([_, defn]) => defn.qtype === this._op);
-        if (!matchQuery) {
-            throw new Error('No query found for ' + this._model + ':' + this._op);
-        }
-        const queryKey = matchQuery[0];
-        return queryKey;
-    }
-    _findMutation() {
-        // For mutation, there can be many defns that match the operation being requested
-        // .ie: deleteAction, deleteActionBySlug, deleteActionByName
-        const matchingDefns = Object.keys(this._introspection).reduce((arr, mutationKey) => {
-            const defn = this._introspection[mutationKey];
-            if (defn.model === this._model &&
-                defn.qtype === this._op &&
-                defn.qtype === 'mutation' &&
-                defn.mutationType === this._mutation) {
-                arr = [...arr, { defn, mutationKey }];
-            }
-            return arr;
-        }, []);
-        if (matchingDefns.length === 0) {
-            throw new Error('no mutation found for ' + this._model + ':' + this._mutation);
-        }
-        // We only need deleteAction from all of [deleteAction, deleteActionBySlug, deleteActionByName]
-        const getInputName = (mutationType) => {
-            switch (mutationType) {
-                case 'delete': {
-                    return `Delete${(0, inflekt_1.camelize)(this._model)}Input`;
-                }
-                case 'create': {
-                    return `Create${(0, inflekt_1.camelize)(this._model)}Input`;
-                }
-                case 'patch': {
-                    return `Update${(0, inflekt_1.camelize)(this._model)}Input`;
-                }
-                default:
-                    throw new Error('Unhandled mutation type' + mutationType);
-            }
-        };
-        const matchDefn = matchingDefns.find(({ defn }) => defn.properties.input.type === getInputName(this._mutation));
-        if (!matchDefn) {
-            throw new Error('no mutation found for ' + this._model + ':' + this._mutation);
-        }
-        return matchDefn.mutationKey;
-    }
-    select(selection) {
-        const defn = this._introspection[this._key];
-        // If selection not given, pick only scalar fields
-        if (selection == null) {
-            this._select = this.pickScalarFields(null, defn);
-            return this;
-        }
-        this._select = this.pickAllFields(selection, defn);
-        return this;
-    }
-    edges(useEdges) {
-        this._edges = useEdges;
-        return this;
-    }
-    getMany({ select } = {}) {
-        this._op = 'getMany';
-        this._key = this._findQuery();
-        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)({
-            builder: this,
-            queryName: this._queryName,
-            operationName: this._key,
-            query: defn,
-            selection: this._select,
-        });
-        return this;
-    }
-    all({ select } = {}) {
-        this._op = 'getMany';
-        this._key = this._findQuery();
-        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)({
-            queryName: this._queryName,
-            operationName: this._key,
-            query: defn,
-            selection: this._select,
-        });
-        return this;
-    }
-    count() {
-        this._op = 'getMany';
-        this._key = this._findQuery();
-        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,
-            operationName: this._key,
-            query: defn,
-        });
-        return this;
-    }
-    getOne({ select } = {}) {
-        this._op = 'getOne';
-        this._key = this._findQuery();
-        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)({
-            builder: this,
-            queryName: this._queryName,
-            operationName: this._key,
-            query: defn,
-            selection: this._select,
-        });
-        return this;
-    }
-    create({ select } = {}) {
-        this._op = 'mutation';
-        this._mutation = 'create';
-        this._key = this._findMutation();
-        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)({
-            operationName: this._key,
-            mutationName: this._queryName,
-            mutation: defn,
-            selection: this._select,
-        });
-        return this;
-    }
-    delete({ select } = {}) {
-        this._op = 'mutation';
-        this._mutation = 'delete';
-        this._key = this._findMutation();
-        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)({
-            operationName: this._key,
-            mutationName: this._queryName,
-            mutation: defn,
-        });
-        return this;
-    }
-    update({ select } = {}) {
-        this._op = 'mutation';
-        this._mutation = 'patch';
-        this._key = this._findMutation();
-        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)({
-            operationName: this._key,
-            mutationName: this._queryName,
-            mutation: defn,
-            selection: this._select,
-        });
-        return this;
-    }
-    queryName(name) {
-        this._queryName = name;
-        return this;
-    }
-    print() {
-        if (!this._ast) {
-            throw new Error('No AST generated. Please call a query method first.');
-        }
-        const _hash = (0, graphql_1.print)(this._ast);
-        return {
-            _hash,
-            _queryName: this._queryName,
-            _ast: this._ast,
-        };
-    }
-    // Bind methods that will be called with different this context
-    pickScalarFields;
-    pickAllFields;
-}
-exports.QueryBuilder = QueryBuilder;
+exports.MetaObject = exports.QueryBuilder = void 0;
 /**
- * Pick scalar fields of a query definition
- * @param {Object} defn Query definition
- * @param {Object} meta Meta object containing info about table relations
- * @returns {Array}
+ * Re-export QueryBuilder from @constructive-io/graphql-query.
+ *
+ * The QueryBuilder class and MetaObject namespace now live in graphql-query.
+ * Re-exported here for backward compatibility.
  */
-function pickScalarFields(selection, defn) {
-    const model = defn.model;
-    const modelMeta = this._meta.tables.find((t) => t.name === model);
-    if (!modelMeta) {
-        throw new Error(`Model meta not found for ${model}`);
-    }
-    const isInTableSchema = (fieldName) => !!modelMeta.fields.find((field) => field.name === fieldName);
-    const pickFrom = (modelSelection) => modelSelection
-        .filter((fieldName) => {
-        // If not specified or not a valid selection list, allow all
-        if (selection == null || !Array.isArray(selection))
-            return true;
-        return Object.keys(selection).includes(fieldName);
-    })
-        .filter((fieldName) => !isRelationalField(fieldName, modelMeta) &&
-        isInTableSchema(fieldName))
-        .map((fieldName) => ({
-        name: fieldName,
-        isObject: false,
-        fieldDefn: modelMeta.fields.find((f) => f.name === fieldName),
-    }));
-    // This is for inferring the sub-selection of a mutation query
-    // from a definition model .eg UserSetting, find its related queries in the introspection object, and pick its selection fields
-    if (defn.qtype === 'mutation') {
-        const relatedQuery = this._introspection[`${modelNameToGetMany(defn.model)}`];
-        return pickFrom(relatedQuery.selection);
-    }
-    return pickFrom(defn.selection);
-}
-/**
- * Pick scalar fields and sub-selection fields of a query definition
- * @param {Object} selection Selection clause object
- * @param {Object} defn Query definition
- * @param {Object} meta Meta object containing info about table relations
- * @returns {Array}
- */
-function pickAllFields(selection, defn) {
-    const model = defn.model;
-    const modelMeta = this._meta.tables.find((t) => t.name === model);
-    if (!modelMeta) {
-        throw new Error(`Model meta not found for ${model}`);
-    }
-    const selectionEntries = Object.entries(selection);
-    let fields = [];
-    const isWhiteListed = (selectValue) => {
-        return typeof selectValue === 'boolean' && selectValue;
-    };
-    for (const entry of selectionEntries) {
-        const [fieldName, fieldOptions] = entry;
-        // Case
-        // {
-        //   goalResults: // fieldName
-        //    { select: { id: true }, variables: { first: 100 } } // fieldOptions
-        // }
-        if (isObject(fieldOptions)) {
-            if (!isFieldInDefinition(fieldName, defn, modelMeta)) {
-                continue;
-            }
-            const referencedForeignConstraint = modelMeta.foreignConstraints.find((constraint) => constraint.fromKey.name === fieldName ||
-                constraint.fromKey.alias === fieldName);
-            const selectOptions = fieldOptions;
-            const subFields = Object.keys(selectOptions.select).filter((subField) => {
-                return (!isRelationalField(subField, modelMeta) &&
-                    isWhiteListed(selectOptions.select[subField]));
-            });
-            const isBelongTo = !!referencedForeignConstraint;
-            const fieldSelection = {
-                name: fieldName,
-                isObject: true,
-                isBelongTo,
-                selection: subFields.map((name) => ({ name, isObject: false })),
-                variables: selectOptions.variables,
-            };
-            // Need to further expand selection of object fields,
-            // but only non-graphql-builtin, non-relation fields
-            // .ie action { id location }
-            // location is non-scalar and non-relational, thus need to further expand into { x y ... }
-            if (isBelongTo) {
-                const getManyName = modelNameToGetMany(referencedForeignConstraint.refTable);
-                const refDefn = this._introspection[getManyName];
-                fieldSelection.selection = pickScalarFields.call(this, { [fieldName]: true }, refDefn);
-            }
-            fields = [...fields, fieldSelection];
-        }
-        else {
-            // Case
-            // {
-            //   userId: true // [fieldName, fieldOptions]
-            // }
-            if (isWhiteListed(fieldOptions)) {
-                fields = [
-                    ...fields,
-                    {
-                        name: fieldName,
-                        isObject: false,
-                        fieldDefn: modelMeta.fields.find((f) => f.name === fieldName),
-                    },
-                ];
-            }
-        }
-    }
-    return fields;
-}
-function isFieldInDefinition(fieldName, defn, modelMeta) {
-    const isReferenced = !!modelMeta.foreignConstraints.find((constraint) => constraint.fromKey.name === fieldName ||
-        constraint.fromKey.alias === fieldName);
-    return (isReferenced ||
-        defn.selection.some((selectionItem) => {
-            if (typeof selectionItem === 'string') {
-                return fieldName === selectionItem;
-            }
-            if (isObject(selectionItem)) {
-                return selectionItem.name === fieldName;
-            }
-            return false;
-        }));
-}
-// TODO: see if there is a possibility of supertyping table (a key is both a foreign and primary key)
-// A relational field is a foreign key but not a primary key
-function isRelationalField(fieldName, modelMeta) {
-    return (!modelMeta.primaryConstraints.find((field) => field.name === fieldName) &&
-        !!modelMeta.foreignConstraints.find((constraint) => constraint.fromKey.name === fieldName));
-}
-// Get getMany op name from model
-// ie. UserSetting => userSettings
-function modelNameToGetMany(model) {
-    return (0, inflekt_1.camelize)((0, inflekt_1.pluralize)((0, inflekt_1.underscore)(model)), true);
-}
+var graphql_query_1 = require("@constructive-io/graphql-query");
+Object.defineProperty(exports, "QueryBuilder", { enumerable: true, get: function () { return graphql_query_1.QueryBuilder; } });
+Object.defineProperty(exports, "MetaObject", { enumerable: true, get: function () { return graphql_query_1.MetaObject; } });