@smartive/graphql-magic 15.4.1 → 16.0.0

package/.gqmrc.json

@@ -2,5 +2,7 @@
   "modelsPath": "tests/utils/models.ts",
   "generatedFolderPath": "tests/generated",
   "graphqlQueriesPath": "tests",
-  "gqlModule": "../../../src"
-}
+  "gqlModule": "../../../src",
+  "knexfilePath": "knexfile.ts",
+  "dateLibrary": "luxon"
+}

package/CHANGELOG.md

@@ -1,6 +1 @@
-## [15.4.1](https://github.com/smartive/graphql-magic/compare/v15.4.0...v15.4.1) (2024-04-05)
-
-
-### Bug Fixes
-
-* **deps:** update docusaurus monorepo to v3.2.1 ([359211a](https://github.com/smartive/graphql-magic/commit/359211a0cd45951ea7a744066d7be5b3f9a990df))
+# [16.0.0](https://github.com/smartive/graphql-magic/compare/v15.4.1...v16.0.0) (2024-04-30)

package/dist/bin/gqm.cjs

@@ -504,7 +504,9 @@ var getLabel = (s) => (0, import_lodash3.startCase)((0, import_lodash3.camelCase
 var and = (...predicates) => (field) => predicates.every((predicate) => predicate(field));
 var not = (predicate) => (field) => !predicate(field);
 var isRootModel = (model) => model.root;
+var isCreatableModel = (model) => model.creatable && model.fields.some(isCreatableField);
 var isUpdatableModel = (model) => model.updatable && model.fields.some(isUpdatableField);
+var isCreatableField = (field) => !field.inherited && !!field.creatable;
 var isUpdatableField = (field) => !field.inherited && !!field.updatable;
 var modelNeedsTable = (model) => model.fields.some((field) => !field.inherited);
 var isRelation = (field) => field.kind === "relation";
@@ -546,22 +548,35 @@ var get = (object2, key) => {
 
 // src/db/generate.ts
 var import_code_block_writer = __toESM(require("code-block-writer"), 1);
+
+// src/utils/dates.ts
+var import_dayjs = require("dayjs");
+var import_luxon = require("luxon");
+var DATE_CLASS = {
+  luxon: "DateTime",
+  dayjs: "Dayjs"
+};
+var DATE_CLASS_IMPORT = {
+  luxon: `import { DateTime } from 'luxon';`,
+  dayjs: `import { Dayjs } from 'dayjs';`
+};
+
+// src/db/generate.ts
 var PRIMITIVE_TYPES = {
   ID: "string",
   Boolean: "boolean",
   Upload: "string",
   Int: "number",
   Float: "number",
-  String: "string",
-  DateTime: "DateTime | string"
+  String: "string"
 };
 var OPTIONAL_SEED_FIELDS = ["createdAt", "createdById", "updatedAt", "updatedById", "deletedAt", "deletedById"];
-var generateDBModels = (models) => {
+var generateDBModels = (models, dateLibrary) => {
   const writer = new import_code_block_writer.default["default"]({
     useSingleQuote: true,
     indentNumberOfSpaces: 2
   });
-  writer.write(`import { DateTime } from 'luxon';`).blankLine();
+  writer.write(DATE_CLASS_IMPORT[dateLibrary]).blankLine();
   for (const enm2 of models.enums) {
     writer.write(`export type ${enm2.name} = ${enm2.values.map((v) => `'${v}'`).join(" | ")};`).blankLine();
   }
@@ -569,14 +584,16 @@ var generateDBModels = (models) => {
     const fields2 = model.relations.some((relation) => relation.field.foreignKey === "id") ? model.fields.filter((field) => field.name !== "id") : model.fields;
     writer.write(`export type ${model.name} = `).inlineBlock(() => {
       for (const field of fields2.filter(not(isCustomField))) {
-        writer.write(`'${getColumnName(field)}': ${getFieldType(field)}${field.nonNull ? "" : " | null"};`).newLine();
+        writer.write(`'${getColumnName(field)}': ${getFieldType(field, dateLibrary)}${field.nonNull ? "" : " | null"};`).newLine();
       }
     }).blankLine();
     writer.write(`export type ${model.name}Initializer = `).inlineBlock(() => {
       for (const field of fields2.filter(not(isCustomField)).filter(isInTable)) {
         writer.write(
           `'${getColumnName(field)}'${field.nonNull && field.defaultValue === void 0 ? "" : "?"}: ${getFieldType(
-            field
+            field,
+            dateLibrary,
+            true
           )}${field.list ? " | string" : ""}${field.nonNull ? "" : " | null"};`
         ).newLine();
       }
@@ -584,7 +601,7 @@ var generateDBModels = (models) => {
     writer.write(`export type ${model.name}Mutator = `).inlineBlock(() => {
       for (const field of fields2.filter(not(isCustomField)).filter(isInTable)) {
         writer.write(
-          `'${getColumnName(field)}'?: ${getFieldType(field)}${field.list ? " | string" : ""}${field.nonNull ? "" : " | null"};`
+          `'${getColumnName(field)}'?: ${getFieldType(field, dateLibrary, true)}${field.list ? " | string" : ""}${field.nonNull ? "" : " | null"};`
         ).newLine();
       }
     }).blankLine();
@@ -596,7 +613,7 @@ var generateDBModels = (models) => {
           }
           const fieldName = getColumnName(field);
           writer.write(
-            `'${getColumnName(field)}'${field.nonNull && field.defaultValue === void 0 && !OPTIONAL_SEED_FIELDS.includes(fieldName) ? "" : "?"}: ${field.kind === "enum" ? field.list ? "string[]" : "string" : getFieldType(field)}${field.list ? " | string" : ""}${field.nonNull ? "" : " | null"};`
+            `'${getColumnName(field)}'${field.nonNull && field.defaultValue === void 0 && !OPTIONAL_SEED_FIELDS.includes(fieldName) ? "" : "?"}: ${field.kind === "enum" ? field.list ? "string[]" : "string" : getFieldType(field, dateLibrary, true)}${field.list ? " | string" : ""}${field.nonNull ? "" : " | null"};`
           ).newLine();
         }
       }).blankLine();
@@ -609,7 +626,7 @@ var generateDBModels = (models) => {
   });
   return writer.toString();
 };
-var getFieldType = (field) => {
+var getFieldType = (field, dateLibrary, input2) => {
   const kind = field.kind;
   switch (kind) {
     case "json":
@@ -622,6 +639,9 @@ var getFieldType = (field) => {
       throw new Error(`Custom fields are not in the db.`);
     case "primitive":
     case void 0:
+      if (field.type === "DateTime") {
+        return (input2 ? `(${DATE_CLASS[dateLibrary]} | string)` : DATE_CLASS[dateLibrary]) + (field.list ? "[]" : "");
+      }
       return get(PRIMITIVE_TYPES, field.type) + (field.list ? "[]" : "");
     default: {
       const exhaustiveCheck = kind;
@@ -758,15 +778,13 @@ var MigrationGenerator = class {
           this.createFields(
             model,
             model.fields.filter(not(isInherited)).filter(
-              ({ name: name2, ...field }) => field.kind !== "custom" && !this.columns[model.name].some(
-                (col) => col.name === (field.kind === "relation" ? field.foreignKey || `${name2}Id` : name2)
-              )
+              ({ name: name2, ...field }) => field.kind !== "custom" && !this.getColumn(model.name, field.kind === "relation" ? field.foreignKey || `${name2}Id` : name2)
             ),
             up,
             down
           );
           const existingFields = model.fields.filter(({ name: name2, kind, nonNull: nonNull2 }) => {
-            const col = this.columns[model.name].find((col2) => col2.name === (kind === "relation" ? `${name2}Id` : name2));
+            const col = this.getColumn(model.name, kind === "relation" ? `${name2}Id` : name2);
             if (!col) {
               return false;
             }
@@ -808,15 +826,11 @@ var MigrationGenerator = class {
           } else {
             const revisionTable = `${model.name}Revision`;
             const missingRevisionFields = model.fields.filter(isUpdatableField).filter(
-              ({ name: name2, ...field }) => field.kind !== "custom" && !this.columns[revisionTable].some(
-                (col) => col.name === (field.kind === "relation" ? field.foreignKey || `${name2}Id` : name2)
-              )
+              ({ name: name2, ...field }) => field.kind !== "custom" && !this.getColumn(revisionTable, field.kind === "relation" ? field.foreignKey || `${name2}Id` : name2)
             );
             this.createRevisionFields(model, missingRevisionFields, up, down);
             const revisionFieldsToRemove = model.fields.filter(
-              ({ name: name2, updatable, generated, ...field }) => !generated && field.kind !== "custom" && !updatable && !(field.kind === "relation" && field.foreignKey === "id") && this.columns[revisionTable].some(
-                (col) => col.name === (field.kind === "relation" ? field.foreignKey || `${name2}Id` : name2)
-              )
+              ({ name: name2, updatable, generated, ...field }) => !generated && field.kind !== "custom" && !updatable && !(field.kind === "relation" && field.foreignKey === "id") && this.getColumn(revisionTable, field.kind === "relation" ? field.foreignKey || `${name2}Id` : name2)
             );
             this.createRevisionFields(model, revisionFieldsToRemove, down, up);
           }
@@ -825,12 +839,26 @@ var MigrationGenerator = class {
     }
     for (const model of models.entities) {
       if (tables.includes(model.name)) {
-        this.createFields(
-          model,
-          model.fields.filter(({ name: name2, deleted }) => deleted && this.columns[model.name].some((col) => col.name === name2)),
-          down,
-          up
-        );
+        const fieldsToDelete = model.fields.filter(({ name: name2, deleted }) => deleted && this.getColumn(model.name, name2));
+        if (!isCreatableModel(model)) {
+          if (this.getColumn(model.name, "createdAt")) {
+            fieldsToDelete.push({ name: "createdAt", type: "DateTime", nonNull: true });
+          }
+          if (this.getColumn(model.name, "createdBy")) {
+            fieldsToDelete.push({ name: "createdBy", kind: "relation", type: "User", nonNull: true });
+          }
+        }
+        if (!isUpdatableModel(model)) {
+          if (this.getColumn(model.name, "updatedAt")) {
+            fieldsToDelete.push({ name: "updatedAt", type: "DateTime", nonNull: true });
+          }
+          if (this.getColumn(model.name, "updatedBy")) {
+            fieldsToDelete.push({ name: "updatedBy", kind: "relation", type: "User", nonNull: true });
+          }
+        }
+        if (fieldsToDelete.length) {
+          this.createFields(model, fieldsToDelete, down, up);
+        }
         if (isUpdatableModel(model)) {
           this.createRevisionFields(
             model,
@@ -1166,6 +1194,9 @@ var MigrationGenerator = class {
       }
     }
   }
+  getColumn(tableName, columnName) {
+    return this.columns[tableName].find((col) => col.name === columnName);
+  }
 };
 var getMigrationDate = () => {
   const date = /* @__PURE__ */ new Date();
@@ -1200,7 +1231,8 @@ var import_flatMap = __toESM(require("lodash/flatMap"), 1);
 var import_graphql5 = require("graphql");
 
 // src/schema/utils.ts
-var import_luxon = require("luxon");
+var import_dayjs2 = require("dayjs");
+var import_luxon2 = require("luxon");
 var document = (definitions) => ({
   kind: "Document",
   definitions
@@ -1319,10 +1351,13 @@ var value = (val = null) => val === null ? {
 } : Array.isArray(val) ? {
   kind: "ListValue",
   values: val.map(value)
-} : val instanceof import_luxon.DateTime ? {
+} : val instanceof import_luxon2.DateTime ? {
   kind: "StringValue",
   value: val.toString()
-} : {
+} : val instanceof import_dayjs2.Dayjs ? {
+  kind: "StringValue",
+  value: val.toISOString()
+} : typeof val === "object" ? {
   kind: "ObjectValue",
   fields: Object.keys(val).map(
     (nme) => ({
@@ -1331,6 +1366,9 @@ var value = (val = null) => val === null ? {
       value: value(val[nme])
     })
   )
+} : doThrow(`Unsupported value ${val}`);
+var doThrow = (message) => {
+  throw new Error(message);
 };
 
 // src/schema/generate.ts
@@ -1614,14 +1652,9 @@ const modelDefinitions: ModelDefinitions = [
 
 export const models = new Models(modelDefinitions);
 `;
-var KNEXFILE = `import { DateTime } from 'luxon';
+var KNEXFILE = `
 import { types } from 'pg';
 
-const dateOids = { date: 1082, timestamptz: 1184, timestamp: 1114 };
-for (const oid of Object.values(dateOids)) {
-  types.setTypeParser(oid, (val) => DateTime.fromSQL(val));
-}
-
 const numberOids = { int8: 20, float8: 701, numeric: 1700 };
 for (const oid of Object.values(numberOids)) {
   types.setTypeParser(oid, Number);
@@ -1646,6 +1679,22 @@ const knexConfig = {
 
 export default knexConfig;
 `;
+var KNEXFILE_LUXON_TYPE_PARSERS = (timeZone) => `
+import { DateTime } from 'luxon';
+
+const dateOids = { date: 1082, timestamptz: 1184, timestamp: 1114 };
+for (const oid of Object.values(dateOids)) {
+  types.setTypeParser(oid, (val) => DateTime.fromSQL(val, { zone: "${timeZone}" }));
+}
+`;
+var KNEXFILE_DAYJS_TYPE_PARSERS = `
+import { dayjs } from 'dayjs';
+
+const dateOids = { date: 1082, timestamptz: 1184, timestamp: 1114 };
+for (const oid of Object.values(dateOids)) {
+  types.setTypeParser(oid, (val) => dayjs(val));
+}
+`;
 var GET_ME = `import { gql } from '@smartive/graphql-magic';
 
 export const GET_ME = gql\`
@@ -1661,7 +1710,6 @@ import knexConfig from "@/knexfile";
 import { Context, User, execute } from "@smartive/graphql-magic";
 import { randomUUID } from "crypto";
 import { knex } from 'knex';
-import { DateTime } from "luxon";
 import { models } from "../config/models";
 
 export const executeGraphql = async <T, V = undefined>(
@@ -1684,7 +1732,6 @@ export const executeGraphql = async <T, V = undefined>(
     user,
     models: models,
     permissions: { ADMIN: true, UNAUTHENTICATED: true },
-    now: DateTime.local(),
   });
   await db.destroy();
 
@@ -1741,12 +1788,37 @@ var DEFAULTS = {
   },
   gqlModule: {
     defaultValue: "@smartive/graphql-magic"
+  },
+  dateLibrary: {
+    question: "Which date library to use (dayjs|luxon)?",
+    defaultValue: "dayjs",
+    init: async (dateLibrary) => {
+      const knexfilePath = await getSetting("knexfilePath");
+      switch (dateLibrary) {
+        case "luxon": {
+          const timeZone = await getSetting("timeZone");
+          ensureFileContains(knexfilePath, "luxon", KNEXFILE_LUXON_TYPE_PARSERS(timeZone));
+          break;
+        }
+        case "dayjs":
+          ensureFileContains(knexfilePath, "dayjs", KNEXFILE_DAYJS_TYPE_PARSERS);
+          break;
+        default:
+          throw new Error("Invalid or unsupported date library.");
+      }
+    }
+  },
+  timeZone: {
+    question: "Which time zone to use?",
+    defaultValue: "Europe/Zurich",
+    init: () => {
+    }
   }
 };
 var initSetting = async (name2) => {
   const { question, defaultValue, init } = DEFAULTS[name2];
   const value2 = await readLine(`${question} (${defaultValue})`) || defaultValue;
-  init(value2);
+  await init(value2);
   return value2;
 };
 var initSettings = async () => {
@@ -1825,7 +1897,7 @@ var writeToFile = (filePath, content) => {
 };
 
 // src/bin/gqm/codegen.ts
-var generateGraphqlApiTypes = async () => {
+var generateGraphqlApiTypes = async (dateLibrary) => {
   const generatedFolderPath = await getSetting("generatedFolderPath");
   await (0, import_cli.generate)({
     overwrite: true,
@@ -1833,12 +1905,12 @@ var generateGraphqlApiTypes = async () => {
     documents: void 0,
     generates: {
       [`${generatedFolderPath}/api/index.ts`]: {
-        plugins: ["typescript", "typescript-resolvers", { add: { content: `import { DateTime } from 'luxon';` } }]
+        plugins: ["typescript", "typescript-resolvers", { add: { content: DATE_CLASS_IMPORT[dateLibrary] } }]
       }
     },
     config: {
       scalars: {
-        DateTime: "DateTime"
+        DateTime: DATE_CLASS[dateLibrary]
       }
     }
   });
@@ -2165,9 +2237,10 @@ import_commander.program.command("generate").description("Generate all the thing
   const gqlModule = await getSetting("gqlModule");
   writeToFile(`${generatedFolderPath}/schema.graphql`, printSchemaFromModels(models));
   writeToFile(`${generatedFolderPath}/client/mutations.ts`, generateMutations(models, gqlModule));
-  writeToFile(`${generatedFolderPath}/db/index.ts`, generateDBModels(models));
+  const dateLibrary = await getSetting("dateLibrary");
+  writeToFile(`${generatedFolderPath}/db/index.ts`, generateDBModels(models, dateLibrary));
   writeToFile(`${generatedFolderPath}/db/knex.ts`, generateKnexTables(models));
-  await generateGraphqlApiTypes();
+  await generateGraphqlApiTypes(dateLibrary);
   await generateGraphqlClientTypes();
 });
 import_commander.program.command("generate-migration [<name>] [<date>]").description("Generate Migration").action(async (name2, date) => {