@nixxie-cms/core 1.0.0 → 1.0.1

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

@@ -1,168 +1,168 @@
-import type {
-  BaseNixxieTypeInfo,
-  BaseListTypeInfo,
-  CommonFieldConfig,
-  FieldHooks,
-  FieldTypeFunc,
-  NixxieContext,
-  MaybePromise,
-  StorageStrategy,
-} from '../../../types'
-import { fieldType } from '../../../types'
-import { g } from '../../..'
-import { merge } from '../../resolve-hooks'
-import type { InferValueFromArg, InferValueFromInputType } from '@graphql-ts/schema'
-import { randomBytes } from 'node:crypto'
-
-export type FieldTypeInfo = {
-  item: undefined
-  inputs: {
-    create: InferValueFromInputType<typeof FileFieldInput> | null | undefined
-    update: InferValueFromInputType<typeof FileFieldInput> | null | undefined
-    where: undefined
-    uniqueWhere: undefined
-    orderBy: undefined
-  }
-  prisma: {
-    create: undefined
-    update: undefined
-  }
-}
-
-export type FileFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
-  FieldTypeInfo
-> & {
-  storage: StorageStrategy<ListTypeInfo['all']>
-  transformName?: (originalFilename: string) => MaybePromise<string>
-  db?: {
-    extendPrismaSchema?: (field: string) => string
-  }
-}
-
-const FileFieldInput = g.inputObject({
-  name: 'FileFieldInput',
-  fields: {
-    upload: g.arg({ type: g.nonNull(g.Upload) }),
-  },
-})
-
-const inputArg = g.arg({ type: FileFieldInput })
-
-const FileFieldOutput = g.object<{
-  filename: string
-  filesize: number
-  url: (_args: {}, context: NixxieContext) => Promise<string>
-}>()({
-  name: 'FileFieldOutput',
-  fields: {
-    filename: g.field({ type: g.nonNull(g.String) }),
-    filesize: g.field({ type: g.nonNull(g.Int) }),
-    url: g.field({ type: g.nonNull(g.String) }),
-  },
-})
-
-async function inputResolver(
-  storage: StorageStrategy<BaseNixxieTypeInfo>,
-  transformName: (originalFilename: string) => Promise<string> | string,
-  context: NixxieContext,
-  data: InferValueFromArg<typeof inputArg>
-) {
-  if (data === null || data === undefined) return { filename: data, filesize: data }
-  const upload = await data.upload
-  const stream = upload.createReadStream()
-  let filesize = 0
-  stream.on('data', data => {
-    filesize += data.length
-  })
-
-  const filename = await transformName(upload.filename)
-  await storage.put(filename, stream, { contentType: 'application/octet-stream' }, context)
-  return { filename, filesize }
-}
-
-export function file<ListTypeInfo extends BaseListTypeInfo>(
-  config: FileFieldConfig<ListTypeInfo>
-): FieldTypeFunc<ListTypeInfo> {
-  const { transformName = defaultTransformName } = config
-  return meta => {
-    const { fieldKey } = meta
-
-    if ('isIndexed' in config) {
-      throw Error("isIndexed: 'unique' is not a supported option for field type file")
-    }
-
-    const afterOperationResolver: Extract<
-      FieldHooks<BaseListTypeInfo, FieldTypeInfo>['afterOperation'],
-      (args: any) => any
-    > = async function afterOperationResolver(args) {
-      if (args.operation === 'update' || args.operation === 'delete') {
-        const filenameKey = `${fieldKey}_filename`
-        const oldFilename = args.originalItem[filenameKey] as string | null | undefined
-        const newFilename = args.item?.[filenameKey] as string | null | undefined
-
-        // this will occur on an update where a file already existed but has been
-        // changed, or on a delete, where there is no longer an item
-        // but not when the old and new filenames are the same (in that case, presumably the file has been overwritten)
-        if (typeof oldFilename === 'string' && oldFilename !== newFilename) {
-          await config.storage.delete(oldFilename, args.context)
-        }
-      }
-    }
-
-    return fieldType({
-      kind: 'multi',
-      extendPrismaSchema: config.db?.extendPrismaSchema,
-      fields: {
-        filesize: { kind: 'scalar', scalar: 'Int', mode: 'optional' },
-        filename: { kind: 'scalar', scalar: 'String', mode: 'optional' },
-      },
-    })({
-      ...config,
-      hooks: {
-        ...config.hooks,
-        afterOperation: merge(config.hooks?.afterOperation, {
-          update: afterOperationResolver,
-          delete: afterOperationResolver,
-        }),
-      },
-      input: {
-        create: {
-          arg: inputArg,
-          resolve: (data, context) => inputResolver(config.storage, transformName, context, data),
-        },
-        update: {
-          arg: inputArg,
-          resolve: (data, context) => inputResolver(config.storage, transformName, context, data),
-        },
-      },
-      output: g.field({
-        type: FileFieldOutput,
-        resolve({ value: { filesize, filename } }) {
-          if (filename === null) return null
-          if (filesize === null) return null
-          return {
-            filename,
-            filesize,
-            url: async (_, context) => config.storage.url(filename, context),
-          }
-        },
-      }),
-      __ksTelemetryFieldTypeName: '@nixxie-cms/file',
-      views: '@nixxie-cms/core/fields/types/file/views',
-    })
-  }
-}
-
-// appends a 128-bit random identifier to the filename to prevent guessing
-function defaultTransformName(path: string) {
-  // this regex lazily matches for any characters that aren't a new line
-  // it then optionally matches the last instance of a "." symbol
-  // followed by any alphanumerical character before the end of the string
-  const [, name, ext] = path.match(/^([^:\n].*?)(\.[A-Za-z0-9]{0,10})?$/) as RegExpMatchArray
-
-  const id = randomBytes(16).toString('base64url')
-  const urlSafeName = name.replace(/[^A-Za-z0-9]/g, '-')
-  if (ext) return `${urlSafeName}-${id}${ext}`
-  return `${urlSafeName}-${id}`
-}
+import type {
+  BaseNixxieTypeInfo,
+  BaseListTypeInfo,
+  CommonFieldConfig,
+  FieldHooks,
+  FieldTypeFunc,
+  NixxieContext,
+  MaybePromise,
+  StorageStrategy,
+} from '../../../types'
+import { fieldType } from '../../../types'
+import { g } from '../../..'
+import { merge } from '../../resolve-hooks'
+import type { InferValueFromArg, InferValueFromInputType } from '@graphql-ts/schema'
+import { randomBytes } from 'node:crypto'
+
+export type FieldTypeInfo = {
+  item: undefined
+  inputs: {
+    create: InferValueFromInputType<typeof FileFieldInput> | null | undefined
+    update: InferValueFromInputType<typeof FileFieldInput> | null | undefined
+    where: undefined
+    uniqueWhere: undefined
+    orderBy: undefined
+  }
+  prisma: {
+    create: undefined
+    update: undefined
+  }
+}
+
+export type FileFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
+  ListTypeInfo,
+  FieldTypeInfo
+> & {
+  storage: StorageStrategy<ListTypeInfo['all']>
+  transformName?: (originalFilename: string) => MaybePromise<string>
+  db?: {
+    extendPrismaSchema?: (field: string) => string
+  }
+}
+
+const FileFieldInput = g.inputObject({
+  name: 'FileFieldInput',
+  fields: {
+    upload: g.arg({ type: g.nonNull(g.Upload) }),
+  },
+})
+
+const inputArg = g.arg({ type: FileFieldInput })
+
+const FileFieldOutput = g.object<{
+  filename: string
+  filesize: number
+  url: (_args: {}, context: NixxieContext) => Promise<string>
+}>()({
+  name: 'FileFieldOutput',
+  fields: {
+    filename: g.field({ type: g.nonNull(g.String) }),
+    filesize: g.field({ type: g.nonNull(g.Int) }),
+    url: g.field({ type: g.nonNull(g.String) }),
+  },
+})
+
+async function inputResolver(
+  storage: StorageStrategy<BaseNixxieTypeInfo>,
+  transformName: (originalFilename: string) => Promise<string> | string,
+  context: NixxieContext,
+  data: InferValueFromArg<typeof inputArg>
+) {
+  if (data === null || data === undefined) return { filename: data, filesize: data }
+  const upload = await data.upload
+  const stream = upload.createReadStream()
+  let filesize = 0
+  stream.on('data', data => {
+    filesize += data.length
+  })
+
+  const filename = await transformName(upload.filename)
+  await storage.put(filename, stream, { contentType: 'application/octet-stream' }, context)
+  return { filename, filesize }
+}
+
+export function file<ListTypeInfo extends BaseListTypeInfo>(
+  config: FileFieldConfig<ListTypeInfo>
+): FieldTypeFunc<ListTypeInfo> {
+  const { transformName = defaultTransformName } = config
+  return meta => {
+    const { fieldKey } = meta
+
+    if ('isIndexed' in config) {
+      throw Error("isIndexed: 'unique' is not a supported option for field type file")
+    }
+
+    const afterOperationResolver: Extract<
+      FieldHooks<BaseListTypeInfo, FieldTypeInfo>['afterOperation'],
+      (args: any) => any
+    > = async function afterOperationResolver(args) {
+      if (args.operation === 'update' || args.operation === 'delete') {
+        const filenameKey = `${fieldKey}_filename`
+        const oldFilename = args.originalItem[filenameKey] as string | null | undefined
+        const newFilename = args.item?.[filenameKey] as string | null | undefined
+
+        // this will occur on an update where a file already existed but has been
+        // changed, or on a delete, where there is no longer an item
+        // but not when the old and new filenames are the same (in that case, presumably the file has been overwritten)
+        if (typeof oldFilename === 'string' && oldFilename !== newFilename) {
+          await config.storage.delete(oldFilename, args.context)
+        }
+      }
+    }
+
+    return fieldType({
+      kind: 'multi',
+      extendPrismaSchema: config.db?.extendPrismaSchema,
+      fields: {
+        filesize: { kind: 'scalar', scalar: 'Int', mode: 'optional' },
+        filename: { kind: 'scalar', scalar: 'String', mode: 'optional' },
+      },
+    })({
+      ...config,
+      hooks: {
+        ...config.hooks,
+        afterOperation: merge(config.hooks?.afterOperation, {
+          update: afterOperationResolver,
+          delete: afterOperationResolver,
+        }),
+      },
+      input: {
+        create: {
+          arg: inputArg,
+          resolve: (data, context) => inputResolver(config.storage, transformName, context, data),
+        },
+        update: {
+          arg: inputArg,
+          resolve: (data, context) => inputResolver(config.storage, transformName, context, data),
+        },
+      },
+      output: g.field({
+        type: FileFieldOutput,
+        resolve({ value: { filesize, filename } }) {
+          if (filename === null) return null
+          if (filesize === null) return null
+          return {
+            filename,
+            filesize,
+            url: async (_, context) => config.storage.url(filename, context),
+          }
+        },
+      }),
+      __nxTelemetryFieldTypeName: '@nixxie-cms/file',
+      views: '@nixxie-cms/core/fields/types/file/views',
+    })
+  }
+}
+
+// appends a 128-bit random identifier to the filename to prevent guessing
+function defaultTransformName(path: string) {
+  // this regex lazily matches for any characters that aren't a new line
+  // it then optionally matches the last instance of a "." symbol
+  // followed by any alphanumerical character before the end of the string
+  const [, name, ext] = path.match(/^([^:\n].*?)(\.[A-Za-z0-9]{0,10})?$/) as RegExpMatchArray
+
+  const id = randomBytes(16).toString('base64url')
+  const urlSafeName = name.replace(/[^A-Za-z0-9]/g, '-')
+  if (ext) return `${urlSafeName}-${id}${ext}`
+  return `${urlSafeName}-${id}`
+}

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

@@ -1,133 +1,133 @@
-import type { SimpleFieldTypeInfo } from '../../../types'
-import {
-  type BaseListTypeInfo,
-  type FieldTypeFunc,
-  type CommonFieldConfig,
-  fieldType,
-  orderDirectionEnum,
-} from '../../../types'
-import { g } from '../../..'
-import { filters } from '../../filters'
-import { makeValidateHook, defaultIsRequired } from '../../non-null-graphql'
-import type { controller } from './views'
-
-export type FloatFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
-  SimpleFieldTypeInfo<'Float'>
-> & {
-  isIndexed?: boolean | 'unique'
-  defaultValue?: number | null
-  validation?: {
-    isRequired?: boolean
-    min?: number
-    max?: number
-  }
-  db?: {
-    isNullable?: boolean
-    map?: string
-    extendPrismaSchema?: (field: string) => string
-  }
-}
-
-export function float<ListTypeInfo extends BaseListTypeInfo>(
-  config: FloatFieldConfig<ListTypeInfo> = {}
-): FieldTypeFunc<ListTypeInfo> {
-  const { defaultValue: defaultValue_, isIndexed, validation = {} } = config
-
-  const { isRequired = false, min, max } = validation
-  const defaultValue = defaultValue_ ?? null
-
-  return meta => {
-    if (defaultValue !== null && !Number.isFinite(defaultValue)) {
-      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.isFinite(min)) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies validation.min: ${min} but it must be a valid finite number`
-      )
-    }
-    if (max !== undefined && !Number.isFinite(max)) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} specifies validation.max: ${max} but it must be a valid finite number`
-      )
-    }
-    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: 'Float',
-      index: isIndexed === true ? 'index' : isIndexed || undefined,
-      default:
-        typeof defaultValue === 'number' ? { kind: 'literal', value: defaultValue } : 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.Float }) } : undefined,
-        where: {
-          arg: g.arg({ type: filters[meta.provider].Float[mode] }),
-          resolve: mode === 'optional' ? filters.resolveCommon : undefined,
-        },
-        create: {
-          arg: g.arg({
-            type: g.Float,
-            defaultValue: typeof defaultValue === 'number' ? defaultValue : undefined,
-          }),
-          resolve(value) {
-            if (value === undefined) return defaultValue
-            return value
-          },
-        },
-        update: { arg: g.arg({ type: g.Float }) },
-        orderBy: { arg: g.arg({ type: orderDirectionEnum }) },
-      },
-      output: g.field({ type: g.Float }),
-      __ksTelemetryFieldTypeName: '@nixxie-cms/float',
-      views: '@nixxie-cms/core/fields/types/float/views',
-      getAdminMeta(): Parameters<typeof controller>[0]['fieldMeta'] {
-        return {
-          validation: {
-            min: min ?? null,
-            max: max ?? null,
-          },
-          defaultValue: defaultValue === null ? null : defaultValue.toString(),
-        }
-      },
-    })
-  }
-}
+import type { SimpleFieldTypeInfo } from '../../../types'
+import {
+  type BaseListTypeInfo,
+  type FieldTypeFunc,
+  type CommonFieldConfig,
+  fieldType,
+  orderDirectionEnum,
+} from '../../../types'
+import { g } from '../../..'
+import { filters } from '../../filters'
+import { makeValidateHook, defaultIsRequired } from '../../non-null-graphql'
+import type { controller } from './views'
+
+export type FloatFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
+  ListTypeInfo,
+  SimpleFieldTypeInfo<'Float'>
+> & {
+  isIndexed?: boolean | 'unique'
+  defaultValue?: number | null
+  validation?: {
+    isRequired?: boolean
+    min?: number
+    max?: number
+  }
+  db?: {
+    isNullable?: boolean
+    map?: string
+    extendPrismaSchema?: (field: string) => string
+  }
+}
+
+export function float<ListTypeInfo extends BaseListTypeInfo>(
+  config: FloatFieldConfig<ListTypeInfo> = {}
+): FieldTypeFunc<ListTypeInfo> {
+  const { defaultValue: defaultValue_, isIndexed, validation = {} } = config
+
+  const { isRequired = false, min, max } = validation
+  const defaultValue = defaultValue_ ?? null
+
+  return meta => {
+    if (defaultValue !== null && !Number.isFinite(defaultValue)) {
+      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.isFinite(min)) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies validation.min: ${min} but it must be a valid finite number`
+      )
+    }
+    if (max !== undefined && !Number.isFinite(max)) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} specifies validation.max: ${max} but it must be a valid finite number`
+      )
+    }
+    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: 'Float',
+      index: isIndexed === true ? 'index' : isIndexed || undefined,
+      default:
+        typeof defaultValue === 'number' ? { kind: 'literal', value: defaultValue } : 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.Float }) } : undefined,
+        where: {
+          arg: g.arg({ type: filters[meta.provider].Float[mode] }),
+          resolve: mode === 'optional' ? filters.resolveCommon : undefined,
+        },
+        create: {
+          arg: g.arg({
+            type: g.Float,
+            defaultValue: typeof defaultValue === 'number' ? defaultValue : undefined,
+          }),
+          resolve(value) {
+            if (value === undefined) return defaultValue
+            return value
+          },
+        },
+        update: { arg: g.arg({ type: g.Float }) },
+        orderBy: { arg: g.arg({ type: orderDirectionEnum }) },
+      },
+      output: g.field({ type: g.Float }),
+      __nxTelemetryFieldTypeName: '@nixxie-cms/float',
+      views: '@nixxie-cms/core/fields/types/float/views',
+      getAdminMeta(): Parameters<typeof controller>[0]['fieldMeta'] {
+        return {
+          validation: {
+            min: min ?? null,
+            max: max ?? null,
+          },
+          defaultValue: defaultValue === null ? null : defaultValue.toString(),
+        }
+      },
+    })
+  }
+}