@nixxie-cms/core 1.0.3 → 2.0.0

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

@@ -1,6 +1,6 @@
 import type { SimpleFieldTypeInfo } from '../../../types'
 import {
-  type BaseListTypeInfo,
+  type BaseCollectionTypeInfo,
   type CommonFieldConfig,
   type FieldTypeFunc,
   fieldType,
@@ -12,8 +12,8 @@ import { filters } from '../../filters'
 import { makeValidateHook, defaultIsRequired } from '../../non-null-graphql'
 import type { controller } from './views'
 
-export type DecimalFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type DecimalFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   SimpleFieldTypeInfo<'Decimal'>
 > & {
   isIndexed?: boolean | 'unique'
@@ -40,9 +40,9 @@ function safeParseDecimal(value: string | null | undefined) {
 }
 
 // TODO: https://github.com/Nixxie/keystatic/blob/main/design-system/pkg/src/number-field/NumberField.tsx
-export function decimal<ListTypeInfo extends BaseListTypeInfo>(
-  config: DecimalFieldConfig<ListTypeInfo> = {}
-): FieldTypeFunc<ListTypeInfo> {
+export function decimal<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: DecimalFieldConfig<CollectionTypeInfo> = {}
+): FieldTypeFunc<CollectionTypeInfo> {
   const {
     defaultValue: defaultValue_,
     isIndexed,

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

@@ -1,6 +1,6 @@
 import type {
   BaseNixxieTypeInfo,
-  BaseListTypeInfo,
+  BaseCollectionTypeInfo,
   CommonFieldConfig,
   FieldHooks,
   FieldTypeFunc,
@@ -29,11 +29,11 @@ export type FieldTypeInfo = {
   }
 }
 
-export type FileFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type FileFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   FieldTypeInfo
 > & {
-  storage: StorageStrategy<ListTypeInfo['all']>
+  storage: StorageStrategy<CollectionTypeInfo['all']>
   transformName?: (originalFilename: string) => MaybePromise<string>
   db?: {
     extendPrismaSchema?: (field: string) => string
@@ -81,9 +81,9 @@ async function inputResolver(
   return { filename, filesize }
 }
 
-export function file<ListTypeInfo extends BaseListTypeInfo>(
-  config: FileFieldConfig<ListTypeInfo>
-): FieldTypeFunc<ListTypeInfo> {
+export function file<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: FileFieldConfig<CollectionTypeInfo>
+): FieldTypeFunc<CollectionTypeInfo> {
   const { transformName = defaultTransformName } = config
   return meta => {
     const { fieldKey } = meta
@@ -93,7 +93,7 @@ export function file<ListTypeInfo extends BaseListTypeInfo>(
     }
 
     const afterOperationResolver: Extract<
-      FieldHooks<BaseListTypeInfo, FieldTypeInfo>['afterOperation'],
+      FieldHooks<BaseCollectionTypeInfo, FieldTypeInfo>['afterOperation'],
       (args: any) => any
     > = async function afterOperationResolver(args) {
       if (args.operation === 'update' || args.operation === 'delete') {

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

@@ -1,6 +1,6 @@
 import type { SimpleFieldTypeInfo } from '../../../types'
 import {
-  type BaseListTypeInfo,
+  type BaseCollectionTypeInfo,
   type FieldTypeFunc,
   type CommonFieldConfig,
   fieldType,
@@ -11,8 +11,8 @@ import { filters } from '../../filters'
 import { makeValidateHook, defaultIsRequired } from '../../non-null-graphql'
 import type { controller } from './views'
 
-export type FloatFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type FloatFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   SimpleFieldTypeInfo<'Float'>
 > & {
   isIndexed?: boolean | 'unique'
@@ -29,9 +29,9 @@ export type FloatFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFiel
   }
 }
 
-export function float<ListTypeInfo extends BaseListTypeInfo>(
-  config: FloatFieldConfig<ListTypeInfo> = {}
-): FieldTypeFunc<ListTypeInfo> {
+export function float<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: FloatFieldConfig<CollectionTypeInfo> = {}
+): FieldTypeFunc<CollectionTypeInfo> {
   const { defaultValue: defaultValue_, isIndexed, validation = {} } = config
 
   const { isRequired = false, min, max } = validation

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

@@ -1,5 +1,5 @@
 import type {
-  BaseListTypeInfo,
+  BaseCollectionTypeInfo,
   FieldTypeFunc,
   CommonFieldConfig,
   NixxieContext,
@@ -32,11 +32,11 @@ export type FieldTypeInfo = {
   }
 }
 
-export type ImageFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type ImageFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   FieldTypeInfo
 > & {
-  storage: StorageStrategy<ListTypeInfo['all']>
+  storage: StorageStrategy<CollectionTypeInfo['all']>
   transformName?: (originalFilename: string, extension: string) => MaybePromise<string>
   db?: {
     extendPrismaSchema?: (field: string) => string
@@ -149,9 +149,9 @@ function isValidImageExtension(extension: string): extension is ImageExtension {
   return extensionsSet.has(extension)
 }
 
-export function image<ListTypeInfo extends BaseListTypeInfo>(
-  config: ImageFieldConfig<ListTypeInfo>
-): FieldTypeFunc<ListTypeInfo> {
+export function image<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: ImageFieldConfig<CollectionTypeInfo>
+): FieldTypeFunc<CollectionTypeInfo> {
   const { transformName = defaultTransformName } = config
   return meta => {
     const { fieldKey } = meta
@@ -161,7 +161,7 @@ export function image<ListTypeInfo extends BaseListTypeInfo>(
     }
 
     const afterOperationResolver: Extract<
-      FieldHooks<BaseListTypeInfo, FieldTypeInfo>['afterOperation'],
+      FieldHooks<BaseCollectionTypeInfo, FieldTypeInfo>['afterOperation'],
       (args: any) => any
     > = async function afterOperationResolver(args) {
       if (args.operation === 'update' || args.operation === 'delete') {

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

@@ -1,7 +1,7 @@
 import { g } from '../../..'
 import type { SimpleFieldTypeInfo } from '../../../types'
 import {
-  type BaseListTypeInfo,
+  type BaseCollectionTypeInfo,
   type CommonFieldConfig,
   type FieldTypeFunc,
   fieldType,
@@ -11,8 +11,8 @@ import { filters } from '../../filters'
 import { defaultIsRequired, makeValidateHook } from '../../non-null-graphql'
 import type { controller } from './views'
 
-export type IntegerFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type IntegerFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   SimpleFieldTypeInfo<'Int'>
 > & {
   isIndexed?: boolean | 'unique'
@@ -33,9 +33,9 @@ export type IntegerFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFi
 const MAX_INT = 0x7fffffff
 const MIN_INT = -0x80000000
 
-export function integer<ListTypeInfo extends BaseListTypeInfo>(
-  config: IntegerFieldConfig<ListTypeInfo> = {}
-): FieldTypeFunc<ListTypeInfo> {
+export function integer<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: IntegerFieldConfig<CollectionTypeInfo> = {}
+): FieldTypeFunc<CollectionTypeInfo> {
   const { defaultValue: defaultValue_, isIndexed, validation = {} } = config
 
   const { isRequired = false, min, max } = validation

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

@@ -1,6 +1,6 @@
 import { g } from '../../..'
 import {
-  type BaseListTypeInfo,
+  type BaseCollectionTypeInfo,
   type CommonFieldConfig,
   fieldType,
   type FieldTypeFunc,
@@ -22,18 +22,18 @@ type FieldTypeInfo = {
   }
 }
 
-export type JsonFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type JsonFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   FieldTypeInfo
 > & {
   defaultValue?: JSONValue
   db?: { map?: string; extendPrismaSchema?: (field: string) => string }
 }
 
-export function json<ListTypeInfo extends BaseListTypeInfo>({
+export function json<CollectionTypeInfo extends BaseCollectionTypeInfo>({
   defaultValue = null,
   ...config
-}: JsonFieldConfig<ListTypeInfo> = {}): FieldTypeFunc<ListTypeInfo> {
+}: JsonFieldConfig<CollectionTypeInfo> = {}): FieldTypeFunc<CollectionTypeInfo> {
   return meta => {
     if ((config as any).isIndexed === 'unique') {
       throw Error("isIndexed: 'unique' is not a supported option for field type json")

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

@@ -2,7 +2,7 @@ import { g } from '../../..'
 import { humanize } from '../../../lib/utils'
 import type { JSONValue } from '../../../types'
 import {
-  type BaseListTypeInfo,
+  type BaseCollectionTypeInfo,
   type CommonFieldConfig,
   type FieldData,
   fieldType,
@@ -26,8 +26,8 @@ type FieldTypeInfo = {
   }
 }
 
-export type MultiselectFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type MultiselectFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   FieldTypeInfo
 > &
   (
@@ -63,9 +63,9 @@ export type MultiselectFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Comm
 const MAX_INT = 2147483647
 const MIN_INT = -2147483648
 
-export function multiselect<ListTypeInfo extends BaseListTypeInfo>(
-  config: MultiselectFieldConfig<ListTypeInfo>
-): FieldTypeFunc<ListTypeInfo> {
+export function multiselect<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: MultiselectFieldConfig<CollectionTypeInfo>
+): FieldTypeFunc<CollectionTypeInfo> {
   const { defaultValue: defaultValue_, ui: { displayMode = 'select', ...ui } = {} } = config
 
   config.db ??= {}
@@ -165,7 +165,7 @@ export function multiselect<ListTypeInfo extends BaseListTypeInfo>(
 }
 
 function configToOptionsAndGraphQLType(
-  config: MultiselectFieldConfig<BaseListTypeInfo>,
+  config: MultiselectFieldConfig<BaseCollectionTypeInfo>,
   meta: FieldData
 ) {
   if (config.type === 'integer') {

package/src/fields/types/multiselect/views/index.tsx

@@ -1,151 +1,149 @@
-import { useState } from 'react'
-import { useFilter, useListFormatter } from '@react-aria/i18n'
-
-import { Checkbox, CheckboxGroup } from '@keystar/ui/checkbox'
-import { Combobox, Item } from '@keystar/ui/combobox'
-import { VStack } from '@keystar/ui/layout'
-import { TagGroup } from '@keystar/ui/tag'
-import { Text } from '@keystar/ui/typography'
-
-import type {
-  CellComponent,
-  FieldController,
-  FieldControllerConfig,
-  FieldProps,
-} from '../../../../types'
-
-export function Field(props: FieldProps<typeof controller>) {
-  if (props.field.displayMode === 'checkboxes') return <CheckboxesModeField {...props} />
-  return <SelectModeField {...props} />
-}
-
-function SelectModeField(props: FieldProps<typeof controller>) {
-  const { field, onChange, value } = props
-  const [filterText, setFilterText] = useState('')
-  const { contains } = useFilter({ sensitivity: 'base' })
-  const items = field.options.filter(option => !value.some(x => x.value === option.value))
-  const filteredItems = filterText ? items.filter(item => contains(item.label, filterText)) : items
-
-  return (
-    <VStack gap="regular">
-      <Combobox
-        label={field.label}
-        description={field.description}
-        isReadOnly={onChange === undefined}
-        items={filteredItems}
-        loadingState="idle"
-        onInputChange={setFilterText}
-        inputValue={filterText}
-        // selectedKey={null}
-        onSelectionChange={key => {
-          if (key == null) return
-          onChange?.([...value, field.valuesToOptionsWithStringValues[key]])
-        }}
-        width="auto"
-      >
-        {item => <Item key={item.value}>{item.label}</Item>}
-      </Combobox>
-
-      <TagGroup
-        aria-label={`${field.label} selected items`}
-        items={value}
-        maxRows={2}
-        onRemove={keys => {
-          const key = keys.values().next().value
-          onChange?.(value.filter(x => x.value !== key))
-        }}
-        renderEmptyState={() => (
-          <Text color="neutralSecondary" size="small">
-            No items…
-          </Text>
-        )}
-      >
-        {item => <Item key={item.value}>{item.label}</Item>}
-      </TagGroup>
-    </VStack>
-  )
-}
-
-function CheckboxesModeField(props: FieldProps<typeof controller>) {
-  const { field, onChange, value } = props
-  return (
-    <CheckboxGroup
-      label={field.label}
-      description={field.description}
-      isReadOnly={onChange === undefined}
-      value={value.map(x => x.value)}
-      onChange={keys => {
-        onChange?.(keys.map(key => field.valuesToOptionsWithStringValues[key]))
-      }}
-    >
-      {field.options.map(option => (
-        <Checkbox key={option.value} value={option.value}>
-          {option.label}
-        </Checkbox>
-      ))}
-    </CheckboxGroup>
-  )
-}
-
-export const Cell: CellComponent<typeof controller> = ({ value = [], field }) => {
-  const listFormatter = useListFormatter({ style: 'short', type: 'conjunction' })
-  const labels = (value as string[]).map(x => field.valuesToOptionsWithStringValues[x].label)
-
-  let cellContent = null
-  if (value.length > 3) {
-    cellContent = listFormatter.format([labels[0], `${value.length - 1} more`])
-  } else {
-    cellContent = listFormatter.format(labels)
-  }
-
-  return <Text>{cellContent}</Text>
-}
-
-export type AdminMultiSelectFieldMeta = {
-  options: readonly { label: string; value: string | number }[]
-  type: 'string' | 'integer' | 'enum'
-  displayMode: 'checkboxes' | 'select'
-  defaultValue: string[] | number[]
-}
-
-type Config = FieldControllerConfig<AdminMultiSelectFieldMeta>
-type Option = { label: string; value: string }
-type Value = readonly Option[]
-
-export function controller(config: Config): FieldController<Value, Option[]> & {
-  displayMode: 'checkboxes' | 'select'
-  options: Option[]
-  type: 'string' | 'integer' | 'enum'
-  valuesToOptionsWithStringValues: Record<string, Option>
-} {
-  const optionsWithStringValues = config.fieldMeta.options.map(x => ({
-    label: x.label,
-    value: x.value.toString(),
-  }))
-
-  const valuesToOptionsWithStringValues = Object.fromEntries(
-    optionsWithStringValues.map(option => [option.value, option])
-  )
-  const parseValue = (value: string) =>
-    config.fieldMeta.type === 'integer' ? parseInt(value) : value
-
-  return {
-    fieldKey: config.fieldKey,
-    label: config.label,
-    description: config.description,
-    displayMode: config.fieldMeta.displayMode,
-    type: config.fieldMeta.type,
-    options: optionsWithStringValues,
-    valuesToOptionsWithStringValues,
-    defaultValue: config.fieldMeta.defaultValue.map(x => valuesToOptionsWithStringValues[x]),
-    deserialize: data => {
-      // if we get null from the GraphQL API (which will only happen if field read access control failed)
-      // we'll just show it as nothing being selected for now.
-      const values: readonly string[] | readonly number[] = data[config.fieldKey] ?? []
-      const selectedOptions = values.map(x => valuesToOptionsWithStringValues[x])
-      return selectedOptions
-    },
-    serialize: value => ({ [config.fieldKey]: value.map(x => parseValue(x.value)) }),
-    graphqlSelection: config.fieldKey,
-  }
-}
+import { useState } from 'react'
+import { useFilter, useListFormatter } from '@react-aria/i18n'
+
+import { Checkbox, CheckboxGroup } from '@keystar/ui/checkbox'
+import { Combobox, Item } from '@keystar/ui/combobox'
+import { VStack } from '@keystar/ui/layout'
+import { TagGroup } from '@keystar/ui/tag'
+import { Text } from '@keystar/ui/typography'
+
+import type {
+  CellComponent,
+  FieldController,
+  FieldControllerConfig,
+  FieldProps,
+} from '../../../../types'
+
+export function Field(props: FieldProps<typeof controller>) {
+  if (props.field.displayMode === 'checkboxes') return <CheckboxesModeField {...props} />
+  return <SelectModeField {...props} />
+}
+
+function SelectModeField(props: FieldProps<typeof controller>) {
+  const { field, onChange, value } = props
+  const [filterText, setFilterText] = useState('')
+  const { contains } = useFilter({ sensitivity: 'base' })
+  const items = field.options.filter(option => !value.some(x => x.value === option.value))
+  const filteredItems = filterText ? items.filter(item => contains(item.label, filterText)) : items
+
+  return (
+    <VStack gap="regular">
+      <Combobox
+        label={field.label}
+        description={field.description}
+        isReadOnly={onChange === undefined}
+        items={filteredItems}
+        loadingState="idle"
+        onInputChange={setFilterText}
+        inputValue={filterText}
+        // selectedKey={null}
+        onSelectionChange={key => {
+          if (key == null) return
+          onChange?.([...value, field.valuesToOptionsWithStringValues[key]])
+        }}
+        width="auto"
+      >
+        {item => <Item key={item.value}>{item.label}</Item>}
+      </Combobox>
+
+      <TagGroup
+        aria-label={`${field.label} selected items`}
+        items={value}
+        maxRows={2}
+        onRemove={keys => {
+          const key = keys.values().next().value
+          onChange?.(value.filter(x => x.value !== key))
+        }}
+        renderEmptyState={() => (
+          <Text color="neutralSecondary" size="small">
+            No items…
+          </Text>
+        )}
+      >
+        {item => <Item key={item.value}>{item.label}</Item>}
+      </TagGroup>
+    </VStack>
+  )
+}
+
+function CheckboxesModeField(props: FieldProps<typeof controller>) {
+  const { field, onChange, value } = props
+  return (
+    <CheckboxGroup
+      label={field.label}
+      description={field.description}
+      isReadOnly={onChange === undefined}
+      value={value.map(x => x.value)}
+      onChange={keys => {
+        onChange?.(keys.map(key => field.valuesToOptionsWithStringValues[key]))
+      }}
+    >
+      {field.options.map(option => (
+        <Checkbox key={option.value} value={option.value}>
+          {option.label}
+        </Checkbox>
+      ))}
+    </CheckboxGroup>
+  )
+}
+
+export const Cell: CellComponent<typeof controller> = ({ value = [], field }) => {
+  const listFormatter = useListFormatter({ style: 'short', type: 'conjunction' })
+  const labels = (value as string[]).map(x => field.valuesToOptionsWithStringValues[x].label)
+
+  const cellContent =
+    value.length > 3
+      ? listFormatter.format([labels[0], `${value.length - 1} more`])
+      : listFormatter.format(labels)
+
+  return <Text>{cellContent}</Text>
+}
+
+export type AdminMultiSelectFieldMeta = {
+  options: readonly { label: string; value: string | number }[]
+  type: 'string' | 'integer' | 'enum'
+  displayMode: 'checkboxes' | 'select'
+  defaultValue: string[] | number[]
+}
+
+type Config = FieldControllerConfig<AdminMultiSelectFieldMeta>
+type Option = { label: string; value: string }
+type Value = readonly Option[]
+
+export function controller(config: Config): FieldController<Value, Option[]> & {
+  displayMode: 'checkboxes' | 'select'
+  options: Option[]
+  type: 'string' | 'integer' | 'enum'
+  valuesToOptionsWithStringValues: Record<string, Option>
+} {
+  const optionsWithStringValues = config.fieldMeta.options.map(x => ({
+    label: x.label,
+    value: x.value.toString(),
+  }))
+
+  const valuesToOptionsWithStringValues = Object.fromEntries(
+    optionsWithStringValues.map(option => [option.value, option])
+  )
+  const parseValue = (value: string) =>
+    config.fieldMeta.type === 'integer' ? parseInt(value) : value
+
+  return {
+    fieldKey: config.fieldKey,
+    label: config.label,
+    description: config.description,
+    displayMode: config.fieldMeta.displayMode,
+    type: config.fieldMeta.type,
+    options: optionsWithStringValues,
+    valuesToOptionsWithStringValues,
+    defaultValue: config.fieldMeta.defaultValue.map(x => valuesToOptionsWithStringValues[x]),
+    deserialize: data => {
+      // if we get null from the GraphQL API (which will only happen if field read access control failed)
+      // we'll just show it as nothing being selected for now.
+      const values: readonly string[] | readonly number[] = data[config.fieldKey] ?? []
+      const selectedOptions = values.map(x => valuesToOptionsWithStringValues[x])
+      return selectedOptions
+    },
+    serialize: value => ({ [config.fieldKey]: value.map(x => parseValue(x.value)) }),
+    graphqlSelection: config.fieldKey,
+  }
+}

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

@@ -3,7 +3,7 @@ import bcryptjs from 'bcryptjs'
 import dumbPasswords from 'dumb-passwords'
 import { userInputError } from '../../../lib/core/graphql-errors'
 import {
-  type BaseListTypeInfo,
+  type BaseCollectionTypeInfo,
   type CommonFieldConfig,
   type FieldTypeFunc,
   fieldType,
@@ -29,8 +29,8 @@ type FieldTypeInfo = {
   }
 }
 
-export type PasswordFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
+export type PasswordFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = CommonFieldConfig<
+  CollectionTypeInfo,
   FieldTypeInfo
 > & {
   validation?: {
@@ -70,9 +70,9 @@ const PasswordFilter = g.inputObject({
   },
 })
 
-export function password<ListTypeInfo extends BaseListTypeInfo>(
-  config: PasswordFieldConfig<ListTypeInfo> = {}
-): FieldTypeFunc<ListTypeInfo> {
+export function password<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: PasswordFieldConfig<CollectionTypeInfo> = {}
+): FieldTypeFunc<CollectionTypeInfo> {
   const {
     kdf = {
       hash: secret => {