@nixxie-cms/core 1.0.0

package/dist/nixxie-cms-core.cjs.js

@@ -0,0 +1,522 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var resolveHooks = require('./resolve-hooks-66fe8a8e.cjs.js');
+var index = require('./index-ac01583b.cjs.js');
+var nextFields = require('./next-fields-49c025ef.cjs.js');
+require('pluralize');
+require('@graphql-ts/schema');
+require('@graphql-ts/extend');
+require('graphql');
+require('./non-null-graphql-17b83ddc.cjs.js');
+require('node:path');
+require('./admin-meta-18d0c276.cjs.js');
+require('decimal.js');
+require('graphql-upload/GraphQLUpload.js');
+
+function listsWithDefaults(config, defaultIdField) {
+  // some error checking
+  for (const [listKey, list] of Object.entries(config.lists)) {
+    var _list$db;
+    if (list.fields.id) {
+      throw new Error(`"fields.id" is reserved by Nixxie, use "db.idField" for the "${listKey}" list`);
+    }
+    if (list.isSingleton && (_list$db = list.db) !== null && _list$db !== void 0 && _list$db.idField) {
+      throw new Error(`"db.idField" on the "${listKey}" list conflicts with singleton defaults`);
+    }
+  }
+  return Object.fromEntries([...function* () {
+    for (const [listKey, list] of Object.entries(config.lists)) {
+      var _list$db$idField, _list$db2;
+      yield [listKey, {
+        listKey,
+        defaultIsFilterable: true,
+        // TODO: move to access control?
+        defaultIsOrderable: true,
+        // TODO: move to access control?
+        isSingleton: false,
+        ...list,
+        db: {
+          ...list.db
+        },
+        fields: {
+          ...(list.isSingleton ? {
+            id: resolveHooks.idFieldType({
+              kind: 'number',
+              type: 'Int'
+            }),
+            ...list.fields
+          } : {
+            id: resolveHooks.idFieldType((_list$db$idField = (_list$db2 = list.db) === null || _list$db2 === void 0 ? void 0 : _list$db2.idField) !== null && _list$db$idField !== void 0 ? _list$db$idField : defaultIdField),
+            ...list.fields
+          })
+        },
+        actions: {
+          ...list.actions
+        },
+        hooks: {
+          ...list.hooks
+        },
+        graphql: {
+          ...list.graphql
+        },
+        ui: {
+          ...list.ui
+        }
+      }];
+    }
+  }()]);
+}
+function defaultIsAccessAllowed({
+  session,
+  sessionStrategy
+}) {
+  if (!sessionStrategy) return true;
+  return session !== undefined;
+}
+async function noop() {}
+function identity(x) {
+  return x;
+}
+function config(config) {
+  var _config$db, _config$db$url, _config$db$idField, _config$server, _config$server2, _config$server$cors, _config$server3, _config$types$path, _config$types, _config$db$shadowData, _config$db2, _config$db$extendPris, _config$db3, _config$db$extendPris2, _config$db4, _config$db$onConnect, _config$db$prismaClie, _config$db5, _config$db$prismaSche, _config$db6, _config$db$idField2, _config$db7, _config$db$enableLogg, _config$graphql$path, _config$graphql, _config$graphql$playg, _config$graphql2, _config$graphql$schem, _config$graphql3, _config$graphql$exten, _config$graphql4, _config$server$maxFil, _config$server4, _config$server$extend, _config$server5, _config$server$extend2, _config$server6, _config$telemetry, _config$ui$basePath, _config$ui, _config$ui$isAccessAl, _config$ui2, _config$ui$isDisabled, _config$ui3, _config$ui$getAdditio, _config$ui4, _config$ui$pageMiddle, _config$ui5, _config$ui$publicPage, _config$ui6;
+  if (!['postgresql', 'sqlite', 'mysql'].includes(config.db.provider)) {
+    throw new TypeError(`"db.provider" only supports "sqlite", "postgresql" or "mysql"`);
+  }
+
+  // WARNING: Typescript should prevent this, but any string is useful for Prisma errors
+  (_config$db$url = (_config$db = config.db).url) !== null && _config$db$url !== void 0 ? _config$db$url : _config$db.url = 'postgres://';
+  const defaultIdField = (_config$db$idField = config.db.idField) !== null && _config$db$idField !== void 0 ? _config$db$idField : {
+    kind: 'cuid'
+  };
+  const cors = ((_config$server = config.server) === null || _config$server === void 0 ? void 0 : _config$server.cors) === true ? {
+    origin: true,
+    credentials: true
+  } : ((_config$server2 = config.server) === null || _config$server2 === void 0 ? void 0 : _config$server2.cors) === false ? null : (_config$server$cors = (_config$server3 = config.server) === null || _config$server3 === void 0 ? void 0 : _config$server3.cors) !== null && _config$server$cors !== void 0 ? _config$server$cors : null;
+  const httpOptions = {
+    port: 3000
+  };
+  if (config !== null && config !== void 0 && config.server && 'port' in config.server) {
+    httpOptions.port = config.server.port;
+  }
+  if (config !== null && config !== void 0 && config.server && 'options' in config.server && config.server.options) {
+    Object.assign(httpOptions, config.server.options);
+  }
+  return {
+    types: {
+      ...config.types,
+      path: (_config$types$path = (_config$types = config.types) === null || _config$types === void 0 ? void 0 : _config$types.path) !== null && _config$types$path !== void 0 ? _config$types$path : 'node_modules/.nixxie/types.ts'
+    },
+    db: {
+      ...config.db,
+      shadowDatabaseUrl: (_config$db$shadowData = (_config$db2 = config.db) === null || _config$db2 === void 0 ? void 0 : _config$db2.shadowDatabaseUrl) !== null && _config$db$shadowData !== void 0 ? _config$db$shadowData : '',
+      extendPrismaSchema: (_config$db$extendPris = (_config$db3 = config.db) === null || _config$db3 === void 0 ? void 0 : _config$db3.extendPrismaSchema) !== null && _config$db$extendPris !== void 0 ? _config$db$extendPris : identity,
+      extendPrismaClient: (_config$db$extendPris2 = (_config$db4 = config.db) === null || _config$db4 === void 0 ? void 0 : _config$db4.extendPrismaClient) !== null && _config$db$extendPris2 !== void 0 ? _config$db$extendPris2 : identity,
+      onConnect: (_config$db$onConnect = config.db.onConnect) !== null && _config$db$onConnect !== void 0 ? _config$db$onConnect : noop,
+      prismaClientPath: (_config$db$prismaClie = (_config$db5 = config.db) === null || _config$db5 === void 0 ? void 0 : _config$db5.prismaClientPath) !== null && _config$db$prismaClie !== void 0 ? _config$db$prismaClie : '@prisma/client',
+      prismaSchemaPath: (_config$db$prismaSche = (_config$db6 = config.db) === null || _config$db6 === void 0 ? void 0 : _config$db6.prismaSchemaPath) !== null && _config$db$prismaSche !== void 0 ? _config$db$prismaSche : 'schema.prisma',
+      idField: (_config$db$idField2 = (_config$db7 = config.db) === null || _config$db7 === void 0 ? void 0 : _config$db7.idField) !== null && _config$db$idField2 !== void 0 ? _config$db$idField2 : defaultIdField,
+      enableLogging: config.db.enableLogging === true ? ['query'] : config.db.enableLogging === false ? [] : (_config$db$enableLogg = config.db.enableLogging) !== null && _config$db$enableLogg !== void 0 ? _config$db$enableLogg : []
+    },
+    graphql: {
+      ...config.graphql,
+      path: (_config$graphql$path = (_config$graphql = config.graphql) === null || _config$graphql === void 0 ? void 0 : _config$graphql.path) !== null && _config$graphql$path !== void 0 ? _config$graphql$path : '/api/graphql',
+      playground: (_config$graphql$playg = (_config$graphql2 = config.graphql) === null || _config$graphql2 === void 0 ? void 0 : _config$graphql2.playground) !== null && _config$graphql$playg !== void 0 ? _config$graphql$playg : process.env.NODE_ENV !== 'production',
+      schemaPath: (_config$graphql$schem = (_config$graphql3 = config.graphql) === null || _config$graphql3 === void 0 ? void 0 : _config$graphql3.schemaPath) !== null && _config$graphql$schem !== void 0 ? _config$graphql$schem : 'schema.graphql',
+      extendGraphqlSchema: (_config$graphql$exten = (_config$graphql4 = config.graphql) === null || _config$graphql4 === void 0 ? void 0 : _config$graphql4.extendGraphqlSchema) !== null && _config$graphql$exten !== void 0 ? _config$graphql$exten : s => s
+    },
+    lists: listsWithDefaults(config, defaultIdField),
+    server: {
+      ...config.server,
+      maxFileSize: (_config$server$maxFil = (_config$server4 = config.server) === null || _config$server4 === void 0 ? void 0 : _config$server4.maxFileSize) !== null && _config$server$maxFil !== void 0 ? _config$server$maxFil : 200 * 1024 * 1024,
+      // 200 MiB
+      extendExpressApp: (_config$server$extend = (_config$server5 = config.server) === null || _config$server5 === void 0 ? void 0 : _config$server5.extendExpressApp) !== null && _config$server$extend !== void 0 ? _config$server$extend : noop,
+      extendHttpServer: (_config$server$extend2 = (_config$server6 = config.server) === null || _config$server6 === void 0 ? void 0 : _config$server6.extendHttpServer) !== null && _config$server$extend2 !== void 0 ? _config$server$extend2 : noop,
+      cors,
+      options: httpOptions
+    },
+    session: config.session,
+    email: config.email,
+    jobs: config.jobs,
+    cache: config.cache,
+    audit: config.audit,
+    webhooks: config.webhooks,
+    rateLimit: config.rateLimit,
+    health: config.health,
+    telemetry: (_config$telemetry = config.telemetry) !== null && _config$telemetry !== void 0 ? _config$telemetry : true,
+    ui: {
+      ...config.ui,
+      basePath: (_config$ui$basePath = (_config$ui = config.ui) === null || _config$ui === void 0 ? void 0 : _config$ui.basePath) !== null && _config$ui$basePath !== void 0 ? _config$ui$basePath : '',
+      isAccessAllowed: (_config$ui$isAccessAl = (_config$ui2 = config.ui) === null || _config$ui2 === void 0 ? void 0 : _config$ui2.isAccessAllowed) !== null && _config$ui$isAccessAl !== void 0 ? _config$ui$isAccessAl : defaultIsAccessAllowed,
+      isDisabled: (_config$ui$isDisabled = (_config$ui3 = config.ui) === null || _config$ui3 === void 0 ? void 0 : _config$ui3.isDisabled) !== null && _config$ui$isDisabled !== void 0 ? _config$ui$isDisabled : false,
+      getAdditionalFiles: (_config$ui$getAdditio = (_config$ui4 = config.ui) === null || _config$ui4 === void 0 ? void 0 : _config$ui4.getAdditionalFiles) !== null && _config$ui$getAdditio !== void 0 ? _config$ui$getAdditio : () => [],
+      pageMiddleware: (_config$ui$pageMiddle = (_config$ui5 = config.ui) === null || _config$ui5 === void 0 ? void 0 : _config$ui5.pageMiddleware) !== null && _config$ui$pageMiddle !== void 0 ? _config$ui$pageMiddle : noop,
+      publicPages: (_config$ui$publicPage = (_config$ui6 = config.ui) === null || _config$ui6 === void 0 ? void 0 : _config$ui6.publicPages) !== null && _config$ui$publicPage !== void 0 ? _config$ui$publicPage : []
+    }
+  };
+}
+let i = 0;
+function group(config) {
+  var _config$description;
+  const keys = Object.keys(config.fields);
+  if (keys.some(key => key.startsWith('__group'))) {
+    throw new Error('groups cannot be nested');
+  }
+  return {
+    [`__group${i++}`]: {
+      fields: keys,
+      label: config.label,
+      description: (_config$description = config.description) !== null && _config$description !== void 0 ? _config$description : '',
+      ui: config.ui
+    },
+    ...config.fields
+  }; // TODO: FIXME, see initialise-lists.ts:getListsWithInitialisedFields
+}
+function list(listConfig) {
+  return {
+    ...listConfig
+  };
+}
+function action(action) {
+  return {
+    ...action,
+    ___defineActionsWithActionFunction: true
+  };
+}
+
+// ================================================================
+// Validators — use inside field `validation` config
+// ================================================================
+
+const validators = {
+  /** Validates a string is a well-formed email address */
+  email: {
+    match: {
+      regex: /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/,
+      explanation: 'Must be a valid email address'
+    }
+  },
+  /** Validates a string starts with http:// or https:// */
+  url: {
+    match: {
+      regex: /^https?:\/\/.+/,
+      explanation: 'Must be a valid URL starting with http:// or https://'
+    }
+  },
+  /** Validates a string has at least `min` characters */
+  minLength: min => ({
+    length: {
+      min
+    }
+  }),
+  /** Validates a string has at most `max` characters */
+  maxLength: max => ({
+    length: {
+      max
+    }
+  }),
+  /** Validates a string has between `min` and `max` characters */
+  length: (min, max) => ({
+    length: {
+      min,
+      max
+    }
+  }),
+  /** Validates a string matches the given regex pattern */
+  regex: (regex, explanation) => ({
+    match: {
+      regex,
+      explanation: explanation !== null && explanation !== void 0 ? explanation : `Must match pattern ${regex}`
+    }
+  }),
+  /** Marks a field as required */
+  required: {
+    isRequired: true
+  }
+};
+
+// ================================================================
+// Mixin system
+// ================================================================
+
+/**
+ * Adds `createdAt` and `updatedAt` timestamp fields.
+ * Both are hidden on create forms and read-only in item views.
+ */
+function withTimestamps() {
+  return {
+    fields: {
+      createdAt: index.timestamp({
+        defaultValue: {
+          kind: 'now'
+        },
+        db: {
+          isNullable: false
+        },
+        ui: {
+          createView: {
+            fieldMode: 'hidden'
+          },
+          itemView: {
+            fieldMode: 'read'
+          },
+          listView: {
+            fieldMode: 'read'
+          }
+        }
+      }),
+      updatedAt: index.timestamp({
+        db: {
+          updatedAt: true,
+          isNullable: false
+        },
+        ui: {
+          createView: {
+            fieldMode: 'hidden'
+          },
+          itemView: {
+            fieldMode: 'read'
+          },
+          listView: {
+            fieldMode: 'read'
+          }
+        }
+      })
+    }
+  };
+}
+
+/**
+ * Adds a `deletedAt` field for soft-delete support.
+ * Items are not physically deleted — set `deletedAt` to the current time instead.
+ * Note: you must manually filter `deletedAt: null` in your queries/access control.
+ */
+function withSoftDelete() {
+  return {
+    fields: {
+      deletedAt: index.timestamp({
+        db: {
+          isNullable: true
+        },
+        ui: {
+          createView: {
+            fieldMode: 'hidden'
+          },
+          itemView: {
+            fieldMode: 'read'
+          },
+          listView: {
+            fieldMode: 'read'
+          }
+        }
+      })
+    }
+  };
+}
+
+/**
+ * Adds `createdBy` and `updatedBy` relationship fields that automatically
+ * track which user performed each write operation.
+ *
+ * Requires session to have an `itemId` (standard Nixxie auth).
+ *
+ * @param userListKey - The list key for your user model (default: 'User')
+ */
+function withAudit(userListKey = 'User') {
+  return {
+    fields: {
+      createdBy: index.relationship({
+        ref: userListKey,
+        ui: {
+          createView: {
+            fieldMode: 'hidden'
+          },
+          itemView: {
+            fieldMode: 'read'
+          }
+        }
+      }),
+      updatedBy: index.relationship({
+        ref: userListKey,
+        ui: {
+          createView: {
+            fieldMode: 'hidden'
+          },
+          itemView: {
+            fieldMode: 'read'
+          }
+        }
+      })
+    },
+    hooks: {
+      resolveInput: async ({
+        operation,
+        resolvedData,
+        context
+      }) => {
+        var _session;
+        const userId = (_session = context.session) === null || _session === void 0 ? void 0 : _session.itemId;
+        if (!userId) return resolvedData;
+        if (operation === 'create') {
+          return {
+            ...resolvedData,
+            createdBy: {
+              connect: {
+                id: userId
+              }
+            },
+            updatedBy: {
+              connect: {
+                id: userId
+              }
+            }
+          };
+        }
+        if (operation === 'update') {
+          return {
+            ...resolvedData,
+            updatedBy: {
+              connect: {
+                id: userId
+              }
+            }
+          };
+        }
+        return resolvedData;
+      }
+    }
+  };
+}
+
+/**
+ * Factory for building reusable field group mixins.
+ *
+ * @example
+ * const withAddress = createMixin({
+ *   street: text(),
+ *   city: text(),
+ *   postcode: text({ validation: validators.regex(/^\d{4}$/, 'Must be a 4-digit postcode') }),
+ * })
+ */
+function createMixin(fields, hooks) {
+  return {
+    fields,
+    hooks
+  };
+}
+
+// ================================================================
+// defineList — a typed wrapper around list() with mixin support
+// ================================================================
+
+/**
+ * Defines a list with optional mixins for reusable field groups and hooks.
+ *
+ * @example
+ * export const Post = defineList({
+ *   mixins: [withTimestamps()],
+ *   fields: {
+ *     title: text({ validation: validators.required }),
+ *     content: text(),
+ *   },
+ * })
+ */
+function defineList(config) {
+  const {
+    mixins = [],
+    ...listConfig
+  } = config;
+  const mixinFields = {};
+  const mixinHooksList = [];
+  for (const mixin of mixins) {
+    if (mixin.fields) Object.assign(mixinFields, mixin.fields);
+    if (mixin.hooks) mixinHooksList.push(mixin.hooks);
+  }
+  const mergedHooks = mergeMixinHooks(mixinHooksList, listConfig.hooks);
+  return list({
+    ...listConfig,
+    fields: {
+      ...mixinFields,
+      ...listConfig.fields
+    },
+    hooks: mergedHooks
+  });
+}
+function mergeMixinHooks(mixinHooks, listHooks) {
+  if (mixinHooks.length === 0) return listHooks !== null && listHooks !== void 0 ? listHooks : {};
+  const hookNames = ['resolveInput', 'validate', 'beforeOperation', 'afterOperation'];
+  const merged = {};
+  for (const hookName of hookNames) {
+    const fns = [...mixinHooks.map(h => h[hookName]).filter(Boolean), ...(listHooks !== null && listHooks !== void 0 && listHooks[hookName] ? [listHooks[hookName]] : [])];
+    if (fns.length === 0) continue;
+    if (fns.length === 1) {
+      merged[hookName] = fns[0];
+      continue;
+    }
+    // Run all hooks in sequence; for resolveInput, pass the output of each as input to the next
+    if (hookName === 'resolveInput') {
+      merged[hookName] = async args => {
+        let result = args.resolvedData;
+        for (const fn of fns) {
+          const out = await fn({
+            ...args,
+            resolvedData: result
+          });
+          if (out !== undefined) result = out;
+        }
+        return result;
+      };
+    } else {
+      merged[hookName] = async args => {
+        for (const fn of fns) await fn(args);
+      };
+    }
+  }
+  return merged;
+}
+
+// ================================================================
+// defineConfig — typed alias for config()
+// ================================================================
+
+/**
+ * Defines the Nixxie configuration. This is a typed alias for `config()` that
+ * provides the same functionality with a more declarative name.
+ *
+ * @example
+ * export default defineConfig({
+ *   db: { provider: 'sqlite', url: 'file:./nixxie.db' },
+ *   lists: { Post, User },
+ * })
+ */
+function defineConfig(nixxieConfig) {
+  return config(nixxieConfig);
+}
+
+// ================================================================
+// defineAction — typed alias for action()
+// ================================================================
+
+/**
+ * Defines a list action. Typed alias for `action()`.
+ */
+function defineAction(actionConfig) {
+  return action(actionConfig);
+}
+
+exports.g = nextFields.g;
+exports.gWithContext = nextFields.gWithContext;
+exports.graphql = nextFields.g;
+exports.action = action;
+exports.config = config;
+exports.createMixin = createMixin;
+exports.defineAction = defineAction;
+exports.defineConfig = defineConfig;
+exports.defineList = defineList;
+exports.group = group;
+exports.list = list;
+exports.validators = validators;
+exports.withAudit = withAudit;
+exports.withSoftDelete = withSoftDelete;
+exports.withTimestamps = withTimestamps;