@nixxie-cms/core 1.0.0 → 1.0.1

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

@@ -1,108 +1,108 @@
-import { getNamedType, isLeafType } from 'graphql'
-import {
-  type BaseItem,
-  type BaseListTypeInfo,
-  type CommonFieldConfig,
-  type FieldTypeFunc,
-  type NixxieContext,
-  type ListGraphQLTypes,
-  fieldType,
-} from '../../../types'
-import { g } from '../../..'
-import type { GArg, GField, GInputType, GObjectType, GOutputType } from '@graphql-ts/schema'
-import { GNonNull } from '@graphql-ts/schema'
-import type { controller } from './views'
-
-type VirtualFieldGraphQLField<Item extends BaseItem, Context extends NixxieContext> = GField<
-  Item,
-  any,
-  GOutputType<Context>,
-  unknown,
-  Context
->
-
-type FieldTypeInfo = {
-  item: undefined
-  inputs: {
-    where: undefined
-    create: undefined
-    update: undefined
-    uniqueWhere: undefined
-    orderBy: undefined
-  }
-  prisma: {
-    create: undefined
-    update: undefined
-  }
-}
-
-export type VirtualFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
-  ListTypeInfo,
-  FieldTypeInfo
-> & {
-  field:
-    | VirtualFieldGraphQLField<ListTypeInfo['item'], NixxieContext<ListTypeInfo['all']>>
-    | ((lists: {
-        [Key in keyof ListTypeInfo['all']['lists']]: ListGraphQLTypes<
-          ListTypeInfo['all']['lists'][Key]
-        >
-      }) => VirtualFieldGraphQLField<ListTypeInfo['item'], NixxieContext<ListTypeInfo['all']>>)
-  unreferencedConcreteInterfaceImplementations?: readonly GObjectType<
-    any,
-    NixxieContext<ListTypeInfo['all']>
-  >[]
-  ui?: {
-    /**
-     * This can be used by the AdminUI to fetch the relevant sub-fields
-     *   or arguments on a non-scalar field GraphQL type
-     * ```graphql
-     * query {
-     *   ${list}(where: { id: "..." }) {
-     *     ${field}${ui.query}
-     *   }
-     * }
-     * ```
-     */
-    query?: string
-  }
-}
-
-export function virtual<ListTypeInfo extends BaseListTypeInfo>({
-  field,
-  ...config
-}: VirtualFieldConfig<ListTypeInfo>): FieldTypeFunc<ListTypeInfo> {
-  return meta => {
-    const usableField = typeof field === 'function' ? field(meta.lists) : field
-    const namedType = getNamedType(usableField.type)
-    const hasRequiredArgs =
-      usableField.args &&
-      Object.values(usableField.args as Record<string, GArg<GInputType, boolean>>).some(
-        x => x.type instanceof GNonNull && x.defaultValue === undefined
-      )
-
-    if (
-      (!isLeafType(namedType) || hasRequiredArgs) &&
-      !config.ui?.query &&
-      (config.ui?.itemView?.fieldMode !== 'hidden' || config.ui?.listView?.fieldMode !== 'hidden')
-    ) {
-      throw new Error(
-        `${meta.listKey}.${meta.fieldKey} requires ui.query, or ui.listView.fieldMode and ui.itemView.fieldMode to be set to 'hidden'`
-      )
-    }
-
-    return fieldType({ kind: 'none' })({
-      ...config,
-      output: g.field({
-        ...(usableField as any),
-        resolve({ item }, ...args) {
-          return usableField.resolve!(item, ...args)
-        },
-      }),
-      __ksTelemetryFieldTypeName: '@nixxie-cms/virtual',
-      views: '@nixxie-cms/core/fields/types/virtual/views',
-      getAdminMeta: (): Parameters<typeof controller>[0]['fieldMeta'] => ({
-        query: config.ui?.query ?? '',
-      }),
-    })
-  }
-}
+import { getNamedType, isLeafType } from 'graphql'
+import {
+  type BaseItem,
+  type BaseListTypeInfo,
+  type CommonFieldConfig,
+  type FieldTypeFunc,
+  type NixxieContext,
+  type ListGraphQLTypes,
+  fieldType,
+} from '../../../types'
+import { g } from '../../..'
+import type { GArg, GField, GInputType, GObjectType, GOutputType } from '@graphql-ts/schema'
+import { GNonNull } from '@graphql-ts/schema'
+import type { controller } from './views'
+
+type VirtualFieldGraphQLField<Item extends BaseItem, Context extends NixxieContext> = GField<
+  Item,
+  any,
+  GOutputType<Context>,
+  unknown,
+  Context
+>
+
+type FieldTypeInfo = {
+  item: undefined
+  inputs: {
+    where: undefined
+    create: undefined
+    update: undefined
+    uniqueWhere: undefined
+    orderBy: undefined
+  }
+  prisma: {
+    create: undefined
+    update: undefined
+  }
+}
+
+export type VirtualFieldConfig<ListTypeInfo extends BaseListTypeInfo> = CommonFieldConfig<
+  ListTypeInfo,
+  FieldTypeInfo
+> & {
+  field:
+    | VirtualFieldGraphQLField<ListTypeInfo['item'], NixxieContext<ListTypeInfo['all']>>
+    | ((lists: {
+        [Key in keyof ListTypeInfo['all']['lists']]: ListGraphQLTypes<
+          ListTypeInfo['all']['lists'][Key]
+        >
+      }) => VirtualFieldGraphQLField<ListTypeInfo['item'], NixxieContext<ListTypeInfo['all']>>)
+  unreferencedConcreteInterfaceImplementations?: readonly GObjectType<
+    any,
+    NixxieContext<ListTypeInfo['all']>
+  >[]
+  ui?: {
+    /**
+     * This can be used by the AdminUI to fetch the relevant sub-fields
+     *   or arguments on a non-scalar field GraphQL type
+     * ```graphql
+     * query {
+     *   ${list}(where: { id: "..." }) {
+     *     ${field}${ui.query}
+     *   }
+     * }
+     * ```
+     */
+    query?: string
+  }
+}
+
+export function virtual<ListTypeInfo extends BaseListTypeInfo>({
+  field,
+  ...config
+}: VirtualFieldConfig<ListTypeInfo>): FieldTypeFunc<ListTypeInfo> {
+  return meta => {
+    const usableField = typeof field === 'function' ? field(meta.lists) : field
+    const namedType = getNamedType(usableField.type)
+    const hasRequiredArgs =
+      usableField.args &&
+      Object.values(usableField.args as Record<string, GArg<GInputType, boolean>>).some(
+        x => x.type instanceof GNonNull && x.defaultValue === undefined
+      )
+
+    if (
+      (!isLeafType(namedType) || hasRequiredArgs) &&
+      !config.ui?.query &&
+      (config.ui?.itemView?.fieldMode !== 'hidden' || config.ui?.listView?.fieldMode !== 'hidden')
+    ) {
+      throw new Error(
+        `${meta.listKey}.${meta.fieldKey} requires ui.query, or ui.listView.fieldMode and ui.itemView.fieldMode to be set to 'hidden'`
+      )
+    }
+
+    return fieldType({ kind: 'none' })({
+      ...config,
+      output: g.field({
+        ...(usableField as any),
+        resolve({ item }, ...args) {
+          return usableField.resolve!(item, ...args)
+        },
+      }),
+      __nxTelemetryFieldTypeName: '@nixxie-cms/virtual',
+      views: '@nixxie-cms/core/fields/types/virtual/views',
+      getAdminMeta: (): Parameters<typeof controller>[0]['fieldMeta'] => ({
+        query: config.ui?.query ?? '',
+      }),
+    })
+  }
+}