@nixxie-cms/core 1.0.0 → 1.0.1

package/src/admin-ui/templates/app.ts

@@ -1,60 +1,60 @@
-import Path from 'node:path'
-import resolve from 'resolve'
-
-import type { AdminMetaSource } from '../../lib/admin-meta'
-import type { NixxieConfig } from '../../types'
-
-function doesConfigExist(path: string[]) {
-  try {
-    const configPath = Path.join(process.cwd(), ...path)
-    resolve.sync(configPath, {
-      extensions: ['.ts', '.tsx', '.js'],
-      preserveSymlinks: false,
-    })
-    return true
-  } catch (err: any) {
-    if (err.code === 'MODULE_NOT_FOUND') return false
-    throw err
-  }
-}
-
-export function appTemplate(config: NixxieConfig, adminMeta: AdminMetaSource) {
-  const allViews = adminMeta.views.map(viewRelativeToProject => {
-    const isRelativeToFile =
-      viewRelativeToProject.startsWith('./') || viewRelativeToProject.startsWith('../')
-    const viewRelativeToAppFile = isRelativeToFile
-      ? '../../../' + viewRelativeToProject
-      : viewRelativeToProject
-
-    // we're not using serializePathForImport here because we want the thing you write for a view
-    // to be exactly what you would put in an import in the project directory.
-    // we're still using JSON.stringify to escape anything that might need to be though
-    return JSON.stringify(viewRelativeToAppFile)
-  })
-  // -- TEMPLATE START
-  return `import { getApp } from '@nixxie-cms/core/___internal-do-not-use-will-break-in-patch/admin-ui/pages/App'
-
-${allViews.map((views, i) => `import * as view${i} from ${views}`).join('\n')}
-
-${
-  doesConfigExist(['.nixxie', 'admin', 'config'])
-    ? `import * as packageAdminConfig from "../../../.nixxie/admin/config"`
-    : 'let packageAdminConfig = {}'
-}
-
-${
-  doesConfigExist(['admin', 'config'])
-    ? `import * as userAdminConfig from "../../../admin/config"`
-    : 'let userAdminConfig = {}'
-}
-
-export default getApp({
-  adminConfig: {
-    ...packageAdminConfig,
-    ...userAdminConfig
-  },
-  apiPath: "${config.graphql.path}",
-  fieldViews: [${allViews.map((_, i) => `view${i}`)}],
-})
-`
-}
+import Path from 'node:path'
+import resolve from 'resolve'
+
+import type { AdminMetaSource } from '../../lib/admin-meta'
+import type { NixxieConfig } from '../../types'
+
+function doesConfigExist(path: string[]) {
+  try {
+    const configPath = Path.join(process.cwd(), ...path)
+    resolve.sync(configPath, {
+      extensions: ['.ts', '.tsx', '.js'],
+      preserveSymlinks: false,
+    })
+    return true
+  } catch (err: any) {
+    if (err.code === 'MODULE_NOT_FOUND') return false
+    throw err
+  }
+}
+
+export function appTemplate(config: NixxieConfig, adminMeta: AdminMetaSource) {
+  const allViews = adminMeta.views.map(viewRelativeToProject => {
+    const isRelativeToFile =
+      viewRelativeToProject.startsWith('./') || viewRelativeToProject.startsWith('../')
+    const viewRelativeToAppFile = isRelativeToFile
+      ? '../../../' + viewRelativeToProject
+      : viewRelativeToProject
+
+    // we're not using serializePathForImport here because we want the thing you write for a view
+    // to be exactly what you would put in an import in the project directory.
+    // we're still using JSON.stringify to escape anything that might need to be though
+    return JSON.stringify(viewRelativeToAppFile)
+  })
+  // -- TEMPLATE START
+  return `import { getApp } from '@nixxie-cms/core/internal-unstable/admin-ui/pages/App'
+
+${allViews.map((views, i) => `import * as view${i} from ${views}`).join('\n')}
+
+${
+  doesConfigExist(['.nixxie', 'admin', 'config'])
+    ? `import * as packageAdminConfig from "../../../.nixxie/admin/config"`
+    : 'let packageAdminConfig = {}'
+}
+
+${
+  doesConfigExist(['admin', 'config'])
+    ? `import * as userAdminConfig from "../../../admin/config"`
+    : 'let userAdminConfig = {}'
+}
+
+export default getApp({
+  adminConfig: {
+    ...packageAdminConfig,
+    ...userAdminConfig
+  },
+  apiPath: "${config.graphql.path}",
+  fieldViews: [${allViews.map((_, i) => `view${i}`)}],
+})
+`
+}

package/src/admin-ui/templates/create-item.ts

@@ -1,5 +1,5 @@
-export const createItemTemplate = (listKey: string) =>
-  `import { getCreateItemPage } from '@nixxie-cms/core/___internal-do-not-use-will-break-in-patch/admin-ui/pages/CreateItemPage';
-
-export default getCreateItemPage(${JSON.stringify({ listKey })})
-`
+export const createItemTemplate = (listKey: string) =>
+  `import { getCreateItemPage } from '@nixxie-cms/core/internal-unstable/admin-ui/pages/CreateItemPage';
+
+export default getCreateItemPage(${JSON.stringify({ listKey })})
+`

package/src/admin-ui/templates/home.ts

@@ -1,2 +1,2 @@
-export const homeTemplate = `export { HomePage as default } from '@nixxie-cms/core/___internal-do-not-use-will-break-in-patch/admin-ui/pages/HomePage';
-`
+export const homeTemplate = `export { HomePage as default } from '@nixxie-cms/core/internal-unstable/admin-ui/pages/HomePage';
+`

package/src/admin-ui/templates/item.tsx

@@ -1,5 +1,5 @@
-export const itemTemplate = (listKey: string) =>
-  `import { getItemPage } from '@nixxie-cms/core/___internal-do-not-use-will-break-in-patch/admin-ui/pages/ItemPage';
-
-export default getItemPage(${JSON.stringify({ listKey })})
-`
+export const itemTemplate = (listKey: string) =>
+  `import { getItemPage } from '@nixxie-cms/core/internal-unstable/admin-ui/pages/ItemPage';
+
+export default getItemPage(${JSON.stringify({ listKey })})
+`

package/src/admin-ui/templates/list.tsx

@@ -1,5 +1,5 @@
-export const listTemplate = (listKey: string) =>
-  `import { getListPage } from '@nixxie-cms/core/___internal-do-not-use-will-break-in-patch/admin-ui/pages/ListPage';
-
-export default getListPage(${JSON.stringify({ listKey })});
-`
+export const listTemplate = (listKey: string) =>
+  `import { getListPage } from '@nixxie-cms/core/internal-unstable/admin-ui/pages/ListPage';
+
+export default getListPage(${JSON.stringify({ listKey })});
+`

package/src/admin-ui/templates/no-access.ts

@@ -1,7 +1,7 @@
-import type { NixxieConfig } from '../../types'
-
-export const noAccessTemplate = (session: NixxieConfig['session']) =>
-  `import { getNoAccessPage } from '@nixxie-cms/core/___internal-do-not-use-will-break-in-patch/admin-ui/pages/NoAccessPage';
-
-export default getNoAccessPage(${JSON.stringify({ sessionsEnabled: !!session })})
-`
+import type { NixxieConfig } from '../../types'
+
+export const noAccessTemplate = (session: NixxieConfig['session']) =>
+  `import { getNoAccessPage } from '@nixxie-cms/core/internal-unstable/admin-ui/pages/NoAccessPage';
+
+export default getNoAccessPage(${JSON.stringify({ sessionsEnabled: !!session })})
+`

package/src/fields/types/bigInt/index.ts

@@ -1,181 +1,181 @@
-import type { SimpleFieldTypeInfo } from '../../../types'
-import {
-  type BaseListTypeInfo,
-  type CommonFieldConfig,
-  type FieldTypeFunc,
-  fieldType,
-  orderDirectionEnum,
-} from '../../../types'
-import { g } from '../../..'
-import { filters } from '../../filters'
-import { resolveDbNullable, makeValidateHook, defaultIsRequired } from '../../non-null-graphql'
-import type { controller } from './views'
-
-export type BigIntFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
-  SimpleFieldTypeInfo<'BigInt'>
-> & {
-  isIndexed?: boolean | 'unique'
-  defaultValue?: bigint | null | { kind: 'autoincrement' }
-  validation?: {
-    isRequired?: boolean
-    min?: bigint
-    max?: bigint
-  }
-  db?: {
-    isNullable?: boolean
-    map?: string
-    extendPrismaSchema?: (field: string) => string
-  }
-}
-
-// for a signed 64-bit integer
-const MAX_INT = 9223372036854775807n
-const MIN_INT = -9223372036854775808n
-
-// TODO: https://github.com/Nixxie/keystatic/blob/main/design-system/pkg/src/number-field/NumberField.tsx
-export function bigInt<ListTypeInfo extends BaseListTypeInfo>(
-  config: BigIntFieldConfig<ListTypeInfo> = {}
-): FieldTypeFunc<ListTypeInfo> {
-  const { defaultValue: defaultValue_ = null, isIndexed, validation = {} } = config
-
-  const { isRequired = false, min, max } = validation
-  const defaultValue =
-    typeof defaultValue_ === 'bigint' ? defaultValue_ : (defaultValue_?.kind ?? null)
-
-  return meta => {
-    if (defaultValue === 'autoincrement') {
-      if (meta.provider === 'sqlite' || meta.provider === 'mysql') {
-        throw new Error(
-          `${meta.listKey}.${meta.fieldKey} specifies defaultValue: { kind: 'autoincrement' }, this is not supported on ${meta.provider}`
-        )
-      }
-      const isNullable = resolveDbNullable(validation, config.db)
-      if (isNullable !== false) {
-        throw new Error(
-          `${meta.listKey}.${meta.fieldKey} specifies defaultValue: { kind: 'autoincrement' } but doesn't specify db.isNullable: false.\n` +
-            `Having nullable autoincrements on Prisma currently incorrectly creates a non-nullable column so it is not allowed.\n` +
-            `https://github.com/prisma/prisma/issues/8663`
-        )
-      }
-      if (isRequired) {
-        throw new Error(
-          `${meta.listKey}.${meta.fieldKey} defaultValue: { kind: 'autoincrement' } conflicts with validation.isRequired: true`
-        )
-      }
-    }
-    if (
-      // TODO: prefer typescript only?
-      defaultValue !== null &&
-      defaultValue !== 'autoincrement' &&
-      typeof defaultValue !== 'bigint'
-    ) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies a default value of: ${defaultValue} but it must be a valid finite number`
-      )
-    }
-    if (min !== undefined && !Number.isInteger(min)) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies validation.min: ${min} but it must be an integer`
-      )
-    }
-    if (max !== undefined && !Number.isInteger(max)) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies validation.max: ${max} but it must be an integer`
-      )
-    }
-    if (min !== undefined && (min > MAX_INT || min < MIN_INT)) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies validation.min: ${min} which is outside of the range of a 64-bit signed integer`
-      )
-    }
-    if (max !== undefined && (max > MAX_INT || max < MIN_INT)) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies validation.max: ${max} which is outside of the range of a 64-bit signed integer`
-      )
-    }
-    if (min !== undefined && max !== undefined && min > max) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies a validation.max that is less than the validation.min, and therefore has no valid options`
-      )
-    }
-
-    const hasAdditionalValidation = min !== undefined || max !== undefined
-    const { mode, validate } = makeValidateHook(
-      meta,
-      config,
-      hasAdditionalValidation
-        ? ({ resolvedData, operation, addValidationError }) => {
-            if (operation === 'delete') return
-
-            const value = resolvedData[meta.fieldKey]
-            if (typeof value === 'number') {
-              if (min !== undefined && value < min) {
-                addValidationError(`value must be greater than or equal to ${min}`)
-              }
-
-              if (max !== undefined && value > max) {
-                addValidationError(`value must be less than or equal to ${max}`)
-              }
-            }
-          }
-        : undefined
-    )
-
-    return fieldType({
-      kind: 'scalar',
-      mode,
-      scalar: 'BigInt',
-      index: isIndexed === true ? 'index' : isIndexed || undefined,
-      default:
-        typeof defaultValue === 'bigint'
-          ? { kind: 'literal', value: defaultValue }
-          : defaultValue === 'autoincrement'
-            ? { kind: 'autoincrement' }
-            : undefined,
-      map: config.db?.map,
-      extendPrismaSchema: config.db?.extendPrismaSchema,
-    })({
-      ...config,
-      ...defaultIsRequired(config, isRequired),
-      hooks: {
-        ...config.hooks,
-        validate,
-      },
-      input: {
-        uniqueWhere: isIndexed === 'unique' ? { arg: g.arg({ type: g.BigInt }) } : undefined,
-        where: {
-          arg: g.arg({ type: filters[meta.provider].BigInt[mode] }),
-          resolve: mode === 'optional' ? filters.resolveCommon : undefined,
-        },
-        create: {
-          arg: g.arg({
-            type: g.BigInt,
-            defaultValue: typeof defaultValue === 'bigint' ? defaultValue : undefined,
-          }),
-          resolve(value) {
-            if (value === undefined) {
-              if (defaultValue === 'autoincrement') return null
-              return defaultValue
-            }
-            return value
-          },
-        },
-        update: { arg: g.arg({ type: g.BigInt }) },
-        orderBy: { arg: g.arg({ type: orderDirectionEnum }) },
-      },
-      output: g.field({ type: g.BigInt }),
-      __ksTelemetryFieldTypeName: '@nixxie-cms/bigInt',
-      views: '@nixxie-cms/core/fields/types/bigInt/views',
-      getAdminMeta(): Parameters<typeof controller>[0]['fieldMeta'] {
-        return {
-          validation: {
-            min: min?.toString() ?? `${MIN_INT}`,
-            max: max?.toString() ?? `${MAX_INT}`,
-          },
-          defaultValue: typeof defaultValue === 'bigint' ? defaultValue.toString() : defaultValue,
-        }
-      },
-    })
-  }
-}
+import type { SimpleFieldTypeInfo } from '../../../types'
+import {
+  type BaseListTypeInfo,
+  type CommonFieldConfig,
+  type FieldTypeFunc,
+  fieldType,
+  orderDirectionEnum,
+} from '../../../types'
+import { g } from '../../..'
+import { filters } from '../../filters'
+import { resolveDbNullable, makeValidateHook, defaultIsRequired } from '../../non-null-graphql'
+import type { controller } from './views'
+
+export type BigIntFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
+  ListTypeInfo,
+  SimpleFieldTypeInfo<'BigInt'>
+> & {
+  isIndexed?: boolean | 'unique'
+  defaultValue?: bigint | null | { kind: 'autoincrement' }
+  validation?: {
+    isRequired?: boolean
+    min?: bigint
+    max?: bigint
+  }
+  db?: {
+    isNullable?: boolean
+    map?: string
+    extendPrismaSchema?: (field: string) => string
+  }
+}
+
+// for a signed 64-bit integer
+const MAX_INT = 9223372036854775807n
+const MIN_INT = -9223372036854775808n
+
+// TODO: https://github.com/Nixxie/keystatic/blob/main/design-system/pkg/src/number-field/NumberField.tsx
+export function bigInt<ListTypeInfo extends BaseListTypeInfo>(
+  config: BigIntFieldConfig<ListTypeInfo> = {}
+): FieldTypeFunc<ListTypeInfo> {
+  const { defaultValue: defaultValue_ = null, isIndexed, validation = {} } = config
+
+  const { isRequired = false, min, max } = validation
+  const defaultValue =
+    typeof defaultValue_ === 'bigint' ? defaultValue_ : (defaultValue_?.kind ?? null)
+
+  return meta => {
+    if (defaultValue === 'autoincrement') {
+      if (meta.provider === 'sqlite' || meta.provider === 'mysql') {
+        throw new Error(
+          `${meta.listKey}.${meta.fieldKey} specifies defaultValue: { kind: 'autoincrement' }, this is not supported on ${meta.provider}`
+        )
+      }
+      const isNullable = resolveDbNullable(validation, config.db)
+      if (isNullable !== false) {
+        throw new Error(
+          `${meta.listKey}.${meta.fieldKey} specifies defaultValue: { kind: 'autoincrement' } but doesn't specify db.isNullable: false.\n` +
+            `Having nullable autoincrements on Prisma currently incorrectly creates a non-nullable column so it is not allowed.\n` +
+            `https://github.com/prisma/prisma/issues/8663`
+        )
+      }
+      if (isRequired) {
+        throw new Error(
+          `${meta.listKey}.${meta.fieldKey} defaultValue: { kind: 'autoincrement' } conflicts with validation.isRequired: true`
+        )
+      }
+    }
+    if (
+      // TODO: prefer typescript only?
+      defaultValue !== null &&
+      defaultValue !== 'autoincrement' &&
+      typeof defaultValue !== 'bigint'
+    ) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies a default value of: ${defaultValue} but it must be a valid finite number`
+      )
+    }
+    if (min !== undefined && !Number.isInteger(min)) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies validation.min: ${min} but it must be an integer`
+      )
+    }
+    if (max !== undefined && !Number.isInteger(max)) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies validation.max: ${max} but it must be an integer`
+      )
+    }
+    if (min !== undefined && (min > MAX_INT || min < MIN_INT)) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies validation.min: ${min} which is outside of the range of a 64-bit signed integer`
+      )
+    }
+    if (max !== undefined && (max > MAX_INT || max < MIN_INT)) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies validation.max: ${max} which is outside of the range of a 64-bit signed integer`
+      )
+    }
+    if (min !== undefined && max !== undefined && min > max) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies a validation.max that is less than the validation.min, and therefore has no valid options`
+      )
+    }
+
+    const hasAdditionalValidation = min !== undefined || max !== undefined
+    const { mode, validate } = makeValidateHook(
+      meta,
+      config,
+      hasAdditionalValidation
+        ? ({ resolvedData, operation, addValidationError }) => {
+            if (operation === 'delete') return
+
+            const value = resolvedData[meta.fieldKey]
+            if (typeof value === 'number') {
+              if (min !== undefined && value < min) {
+                addValidationError(`value must be greater than or equal to ${min}`)
+              }
+
+              if (max !== undefined && value > max) {
+                addValidationError(`value must be less than or equal to ${max}`)
+              }
+            }
+          }
+        : undefined
+    )
+
+    return fieldType({
+      kind: 'scalar',
+      mode,
+      scalar: 'BigInt',
+      index: isIndexed === true ? 'index' : isIndexed || undefined,
+      default:
+        typeof defaultValue === 'bigint'
+          ? { kind: 'literal', value: defaultValue }
+          : defaultValue === 'autoincrement'
+            ? { kind: 'autoincrement' }
+            : undefined,
+      map: config.db?.map,
+      extendPrismaSchema: config.db?.extendPrismaSchema,
+    })({
+      ...config,
+      ...defaultIsRequired(config, isRequired),
+      hooks: {
+        ...config.hooks,
+        validate,
+      },
+      input: {
+        uniqueWhere: isIndexed === 'unique' ? { arg: g.arg({ type: g.BigInt }) } : undefined,
+        where: {
+          arg: g.arg({ type: filters[meta.provider].BigInt[mode] }),
+          resolve: mode === 'optional' ? filters.resolveCommon : undefined,
+        },
+        create: {
+          arg: g.arg({
+            type: g.BigInt,
+            defaultValue: typeof defaultValue === 'bigint' ? defaultValue : undefined,
+          }),
+          resolve(value) {
+            if (value === undefined) {
+              if (defaultValue === 'autoincrement') return null
+              return defaultValue
+            }
+            return value
+          },
+        },
+        update: { arg: g.arg({ type: g.BigInt }) },
+        orderBy: { arg: g.arg({ type: orderDirectionEnum }) },
+      },
+      output: g.field({ type: g.BigInt }),
+      __nxTelemetryFieldTypeName: '@nixxie-cms/bigInt',
+      views: '@nixxie-cms/core/fields/types/bigInt/views',
+      getAdminMeta(): Parameters<typeof controller>[0]['fieldMeta'] {
+        return {
+          validation: {
+            min: min?.toString() ?? `${MIN_INT}`,
+            max: max?.toString() ?? `${MAX_INT}`,
+          },
+          defaultValue: typeof defaultValue === 'bigint' ? defaultValue.toString() : defaultValue,
+        }
+      },
+    })
+  }
+}