@technicity/data-service-generator 0.14.1 → 0.14.2

package/dist/runtime/lib/addNullFallbacks.test.js

@@ -0,0 +1,206 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const addNullFallbacks_1 = require("./addNullFallbacks");
+(0, globals_1.describe)("addNullFallbacks", () => {
+    // The actual AST has other fields like `args` that
+    // aren't relevant to the function
+    const sqlAST = {
+        type: "table",
+        name: "Session",
+        as: "Session",
+        fieldName: "session",
+        grabMany: false,
+        children: [
+            {
+                type: "column",
+                name: "id",
+                fieldName: "id",
+                as: "a"
+            },
+            {
+                type: "table",
+                name: "SessionPlan",
+                as: "SessionPlan",
+                fieldName: "sessionPlan",
+                grabMany: false,
+                children: [
+                    {
+                        type: "column",
+                        name: "id",
+                        fieldName: "id",
+                        as: "a"
+                    },
+                    {
+                        type: "column",
+                        name: "uuid",
+                        fieldName: "uuid",
+                        as: "c"
+                    },
+                    {
+                        type: "column",
+                        name: "id",
+                        fieldName: "id",
+                        as: "a"
+                    }
+                ]
+            }
+        ]
+    };
+    (0, globals_1.test)("should work for object", () => {
+        const data = {
+            id: 1,
+            sessionPlanId: null,
+            sessionPlan: undefined
+        };
+        (0, addNullFallbacks_1.addNullFallbacks)(sqlAST, data);
+        strict_1.default.deepEqual(data, {
+            id: 1,
+            sessionPlanId: null,
+            sessionPlan: null
+        });
+    });
+    (0, globals_1.test)("should work for array", () => {
+        const data = [
+            {
+                id: 1,
+                sessionPlanId: null,
+                sessionPlan: undefined
+            },
+            {
+                id: 2,
+                sessionPlanId: null,
+                sessionPlan: undefined
+            }
+        ];
+        (0, addNullFallbacks_1.addNullFallbacks)(sqlAST, data);
+        strict_1.default.deepEqual(data, [
+            {
+                id: 1,
+                sessionPlanId: null,
+                sessionPlan: null
+            },
+            {
+                id: 2,
+                sessionPlanId: null,
+                sessionPlan: null
+            }
+        ]);
+    });
+    (0, globals_1.test)("should work for nested array", () => {
+        const sqlAST = {
+            type: "table",
+            name: "Session",
+            as: "Session",
+            fieldName: "session",
+            grabMany: false,
+            children: [
+                {
+                    type: "column",
+                    name: "id",
+                    fieldName: "id",
+                    as: "a"
+                },
+                {
+                    type: "table",
+                    name: "SessionPlan",
+                    as: "SessionPlan",
+                    fieldName: "sessionPlan",
+                    grabMany: false,
+                    children: [
+                        {
+                            type: "column",
+                            name: "id",
+                            fieldName: "id",
+                            as: "a"
+                        },
+                        {
+                            type: "column",
+                            name: "uuid",
+                            fieldName: "uuid",
+                            as: "c"
+                        },
+                        {
+                            type: "column",
+                            name: "id",
+                            fieldName: "id",
+                            as: "a"
+                        },
+                        {
+                            type: "table",
+                            name: "SessionPlan",
+                            as: "SessionPlan",
+                            fieldName: "sessionPlan",
+                            grabMany: false,
+                            children: [
+                                {
+                                    type: "column",
+                                    name: "id",
+                                    fieldName: "id",
+                                    as: "a"
+                                },
+                                {
+                                    type: "column",
+                                    name: "uuid",
+                                    fieldName: "uuid",
+                                    as: "c"
+                                },
+                                {
+                                    type: "column",
+                                    name: "id",
+                                    fieldName: "id",
+                                    as: "a"
+                                }
+                            ]
+                        }
+                    ]
+                }
+            ]
+        };
+        const data = [
+            {
+                id: 1,
+                sessionPlanId: 1,
+                sessionPlan: {
+                    id: 1,
+                    uuid: "stub",
+                    sessionPlan: undefined
+                }
+            },
+            {
+                id: 2,
+                sessionPlanId: 2,
+                sessionPlan: {
+                    id: 2,
+                    uuid: "stub",
+                    sessionPlan: undefined
+                }
+            }
+        ];
+        (0, addNullFallbacks_1.addNullFallbacks)(sqlAST, data);
+        strict_1.default.deepEqual(data, [
+            {
+                id: 1,
+                sessionPlanId: 1,
+                sessionPlan: {
+                    id: 1,
+                    uuid: "stub",
+                    sessionPlan: null
+                }
+            },
+            {
+                id: 2,
+                sessionPlanId: 2,
+                sessionPlan: {
+                    id: 2,
+                    uuid: "stub",
+                    sessionPlan: null
+                }
+            }
+        ]);
+    });
+});

package/dist/runtime/lib/getSqlAst.js

@@ -1,21 +1,47 @@
 "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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSqlAst = void 0;
-const SqlString = require("sqlstring");
+const SqlString = __importStar(require("sqlstring"));
 // @ts-ignore
-const TSqlString = require("tsqlstring");
+const TSqlString = __importStar(require("tsqlstring"));
 // @ts-ignore
-const alias_namespace_1 = require("join-monster/dist/alias-namespace");
-const _ = require("lodash/fp");
+const alias_namespace_1 = __importDefault(require("join-monster/dist/alias-namespace"));
+const _ = __importStar(require("lodash/fp"));
 const getOrderBy_1 = require("./getOrderBy");
 const namespace = new alias_namespace_1.default(true);
 function getSqlAst(input) {
-    const { table, fieldName, fields, args, grabMany, sqlJoin, sqlBatch, junction, getWhere, artifacts, rowWithMatchingCursor, dialect, } = input;
+    const { table, fieldName, fields, args, grabMany, sqlJoin, sqlBatch, junction, getWhere, artifacts, rowWithMatchingCursor, dialect } = input;
     const tableArtifacts = artifacts[table];
     const primaryKey = tableArtifacts.primaryKey;
-    const format = dialect === "mysql"
-        ? SqlString.format.bind(SqlString)
-        : TSqlString.format.bind(TSqlString);
+    const format = dialect === "mssql"
+        ? TSqlString.format.bind(TSqlString)
+        : SqlString.format.bind(SqlString);
     const orderBy = input.orderBy ?? (0, getOrderBy_1.getOrderBy)(args, primaryKey)?.orderBy;
     let where = input.where;
     if (input.where == null) {
@@ -60,127 +86,138 @@ function getSqlAst(input) {
         args,
         where,
         orderBy,
-        children: children.concat(fields.map((x) => {
-            if (typeof x === "string") {
-                const mappedField = tableArtifacts.mappedFields?.[x];
-                if (mappedField != null) {
-                    return {
-                        type: "expression",
-                        sqlExpr: (table) => {
-                            const referencedTableAlias = namespace.generate("table", mappedField.referencedTable);
-                            return format(`(SELECT ?? FROM ?? AS ?? WHERE ??.?? = ${table}.??)`, [
-                                mappedField.name,
-                                mappedField.referencedTable,
-                                referencedTableAlias,
-                                referencedTableAlias,
-                                mappedField.referencedKey,
-                                mappedField.foreignKey,
-                            ]);
+        children: children.concat(Object.entries(fields)
+            .filter(([_, v]) => v !== false)
+            .map(([k, v]) => {
+            const mappedField = tableArtifacts.mappedFields?.[k];
+            const relationField = tableArtifacts.relationFields?.[k];
+            if (mappedField != null) {
+                return {
+                    type: "expression",
+                    sqlExpr: (table) => {
+                        const referencedTableAlias = namespace.generate("table", mappedField.referencedTable);
+                        return format(`(SELECT ?? FROM ?? AS ?? WHERE ??.?? = ${table}.??)`, [
+                            mappedField.name,
+                            mappedField.referencedTable,
+                            referencedTableAlias,
+                            referencedTableAlias,
+                            mappedField.referencedKey,
+                            mappedField.foreignKey
+                        ]);
+                    },
+                    name: k,
+                    fieldName: k,
+                    as: namespace.generate("column", k)
+                };
+            }
+            else if (relationField != null) {
+                const fields = typeof v === "object"
+                    ? v.$fields ??
+                        tableArtifacts.scalarFields.reduce((acc, x) => {
+                            acc[x] = true;
+                            return acc;
+                        }, {})
+                    : tableArtifacts.scalarFields.reduce((acc, x) => {
+                        acc[x] = true;
+                        return acc;
+                    }, {});
+                const args = typeof v === "object" ? v : {};
+                if (relationField.type === "many-to-many") {
+                    const asJunction = namespace.generate("table", relationField.junctionTable);
+                    const uniqueKey = artifacts[relationField.junctionTable].primaryKey;
+                    return getSqlAst({
+                        table: relationField.table,
+                        fieldName: k,
+                        fields,
+                        args,
+                        grabMany: relationField.grabMany,
+                        firstChild: {
+                            ...keyToASTChild(uniqueKey, namespace, asJunction),
+                            // There's either a bug in join-monster, or join-monster doesn't expect a junction table to have a primary key.
+                            // Work around by ensuring a unique name, to avoid e.g. SELECT `UserRole`.`id` AS `b`, `Role`.`id` AS `b`
+                            // Notice the duplicate names in the select. This results in missing rows because the
+                            // shape definition passed into NestHydrationJS will only have 1 `id`.
+                            fieldName: String(Date.now()),
+                            as: String(Date.now())
                         },
-                        name: x,
-                        fieldName: x,
-                        as: namespace.generate("column", x),
-                    };
+                        junction: {
+                            sqlTable: relationField.junctionTable,
+                            as: asJunction,
+                            uniqueKey,
+                            where: (table, args) => {
+                                if (typeof args?.$where !== "object" ||
+                                    typeof args?.$where == null ||
+                                    args.$where[relationField.junctionTable] == null) {
+                                    return undefined;
+                                }
+                                const argsMapped = _.cloneDeep(args);
+                                argsMapped.$where =
+                                    argsMapped.$where[relationField.junctionTable];
+                                const whereResult = getWhere(
+                                // table is escaped already
+                                table, argsMapped, dialect, orderBy, rowWithMatchingCursor);
+                                if (whereResult == null) {
+                                    return undefined;
+                                }
+                                return whereResult;
+                            },
+                            // Because we used the where in sqlJoin
+                            // where: () => undefined,
+                            // TODO - where
+                            // sqlJoins: [
+                            //   (t: string, junctionTable: string, args: any) =>
+                            //     `${t}.${relationField.relations[0].referencedKey} = ${junctionTable}.${relationField.relations[0].foreignKey}`,
+                            //   (junctionTable: string, t: string, args: any) =>
+                            //     `${junctionTable}.${relationField.relations[1].foreignKey} = ${t}.${relationField.relations[1].referencedKey}`,
+                            // ],
+                            // We have to use sqlBatch instead of sqlJoin because pagination is not
+                            // supported with `mysql` dialect, and LIMITing the root list means
+                            // sub lists are limited, too.
+                            sqlBatch: {
+                                thisKey: columnToASTChild(relationField.relations[0].foreignKey, namespace, asJunction),
+                                parentKey: columnToASTChild(relationField.relations[0].referencedKey, namespace),
+                                sqlJoin: (junctionTable, t, args) => `${junctionTable}.${relationField.relations[1].foreignKey} = ${t}.${relationField.relations[1].referencedKey}`
+                            }
+                        },
+                        getWhere,
+                        artifacts,
+                        dialect
+                    });
                 }
-                // TODO - validate in dev?
-                return columnToASTChild(x, namespace);
-            }
-            const relationField = tableArtifacts.relationFields?.[x.name];
-            if (relationField == null) {
-                throw new Error("Invalid field: " + table + "." + x.name);
-            }
-            if (relationField.type === "many-to-many") {
-                const asJunction = namespace.generate("table", relationField.junctionTable);
-                const uniqueKey = artifacts[relationField.junctionTable].primaryKey;
                 return getSqlAst({
                     table: relationField.table,
-                    fieldName: x.as ?? x.name,
-                    fields: x.fields,
-                    args: x.args,
+                    fieldName: k,
+                    fields,
+                    args,
                     grabMany: relationField.grabMany,
-                    firstChild: {
-                        ...keyToASTChild(uniqueKey, namespace, asJunction),
-                        // There's either a bug in join-monster, or join-monster doesn't expect a junction table to have a primary key.
-                        // Work around by ensuring a unique name, to avoid e.g. SELECT `UserRole`.`id` AS `b`, `Role`.`id` AS `b`
-                        // Notice the duplicate names in the select. This results in missing rows because the
-                        // shape definition passed into NestHydrationJS will only have 1 `id`.
-                        fieldName: String(Date.now()),
-                        as: String(Date.now()),
-                    },
-                    junction: {
-                        sqlTable: relationField.junctionTable,
-                        as: asJunction,
-                        uniqueKey,
-                        where: (table, args) => {
-                            if (typeof args?.$where !== "object" ||
-                                typeof args?.$where == null ||
-                                args.$where[relationField.junctionTable] == null) {
-                                return undefined;
-                            }
-                            const argsMapped = _.cloneDeep(args);
-                            argsMapped.$where =
-                                argsMapped.$where[relationField.junctionTable];
-                            const whereResult = getWhere(
-                            // table is escaped already
-                            table, argsMapped, dialect, orderBy, rowWithMatchingCursor);
-                            if (whereResult == null) {
-                                return undefined;
-                            }
-                            return whereResult;
-                        },
-                        // Because we used the where in sqlJoin
-                        // where: () => undefined,
-                        // TODO - where
-                        // sqlJoins: [
-                        //   (t: string, junctionTable: string, args: any) =>
-                        //     `${t}.${relationField.relations[0].referencedKey} = ${junctionTable}.${relationField.relations[0].foreignKey}`,
-                        //   (junctionTable: string, t: string, args: any) =>
-                        //     `${junctionTable}.${relationField.relations[1].foreignKey} = ${t}.${relationField.relations[1].referencedKey}`,
-                        // ],
-                        // We have to use sqlBatch instead of sqlJoin because pagination is not
-                        // supported with `mysql` dialect, and LIMITing the root list means
-                        // sub lists are limited, too.
-                        sqlBatch: {
-                            thisKey: columnToASTChild(relationField.relations[0].foreignKey, namespace, asJunction),
-                            parentKey: columnToASTChild(relationField.relations[0].referencedKey, namespace),
-                            sqlJoin: (junctionTable, t, args) => `${junctionTable}.${relationField.relations[1].foreignKey} = ${t}.${relationField.relations[1].referencedKey}`,
-                        },
+                    // Because we used the where in sqlJoin
+                    // where: () => undefined,
+                    // sqlJoin: (t1: string, t2: string, args: any) => {
+                    //   let sql = `${t1}.?? = ${t2}.??`;
+                    //   let values = [relationField.relation.foreignKey, relationField.relation.referencedKey];
+                    //   if (args?.$where != null) {
+                    //     const whereResult = getWhere(t2, args);
+                    //     sql += " and " + whereResult.sql;
+                    //     values.push(whereResult.values);
+                    //   }
+                    //   return s.format(sql, values);
+                    // },
+                    // We have to use sqlBatch instead of sqlJoin because pagination is not
+                    // supported with `mysql` dialect, and LIMITing the root list means
+                    // sub lists are limited, too.
+                    sqlBatch: {
+                        thisKey: columnToASTChild(relationField.relation.referencedKey, namespace),
+                        parentKey: columnToASTChild(relationField.relation.foreignKey, namespace)
                     },
                     getWhere,
                     artifacts,
-                    dialect,
+                    dialect
                 });
             }
-            return getSqlAst({
-                table: relationField.table,
-                fieldName: x.as ?? x.name,
-                fields: x.fields,
-                args: x.args,
-                grabMany: relationField.grabMany,
-                // Because we used the where in sqlJoin
-                // where: () => undefined,
-                // sqlJoin: (t1: string, t2: string, args: any) => {
-                //   let sql = `${t1}.?? = ${t2}.??`;
-                //   let values = [relationField.relation.foreignKey, relationField.relation.referencedKey];
-                //   if (args?.$where != null) {
-                //     const whereResult = getWhere(t2, args);
-                //     sql += " and " + whereResult.sql;
-                //     values.push(whereResult.values);
-                //   }
-                //   return s.format(sql, values);
-                // },
-                // We have to use sqlBatch instead of sqlJoin because pagination is not
-                // supported with `mysql` dialect, and LIMITing the root list means
-                // sub lists are limited, too.
-                sqlBatch: {
-                    thisKey: columnToASTChild(relationField.relation.referencedKey, namespace),
-                    parentKey: columnToASTChild(relationField.relation.foreignKey, namespace),
-                },
-                getWhere,
-                artifacts,
-                dialect,
-            });
-        })),
+            else {
+                return columnToASTChild(k, namespace);
+            }
+        }))
     };
 }
 exports.getSqlAst = getSqlAst;
@@ -192,7 +229,7 @@ function keyToASTChild(key, namespace, fromOtherTable) {
             name: key,
             fieldName: clumsyName,
             as: namespace.generate("column", clumsyName),
-            fromOtherTable,
+            fromOtherTable
         };
     }
     return columnToASTChild(key, namespace, fromOtherTable);
@@ -203,7 +240,7 @@ function columnToASTChild(columnName, namespace, fromOtherTable) {
         name: columnName,
         fieldName: columnName,
         as: namespace.generate("column", columnName),
-        fromOtherTable,
+        fromOtherTable
     };
 }
 function toClumsyName(keyArr) {

package/dist/runtime/lib/shared.d.ts

@@ -1,5 +1,4 @@
-import type { IGetSQLASTInput, IArtifacts, IDialect, TDbCall, TFormatQuery, TBeginTransaction, TContext } from "../IRuntime";
-import type { TMiddleware, TResolveParams } from "../IRuntime";
+import type { IGetSQLASTInput, IArtifacts, IDialect, TDbCall, TFormatQuery, TBeginTransaction, TContext, TMiddleware, TResolveParams } from "../IRuntime";
 import Cache from "../Cache";
 export declare function resolve(input: TResolveParams, dbCall: TDbCall, formatQuery: TFormatQuery, beginTransaction: TBeginTransaction, dialect: IDialect, middlewareHandler: MiddlewareHandler<TMiddleware>, context: TContext, cache?: Cache): Promise<any>;
 export declare class MiddlewareHandler<M extends Function> {