@nixxie-cms/core 1.0.3 → 1.1.0

package/src/types/config/access-control.ts

@@ -1,186 +1,186 @@
-import type { NixxieContext } from '../context'
-import type { BaseListTypeInfo } from '../type-info'
-import type { MaybePromise } from '../utils'
-
-export type BaseAccessArgs<ListTypeInfo extends BaseListTypeInfo> = {
-  context: NixxieContext<ListTypeInfo['all']>
-  session?: ListTypeInfo['all']['session'] // TODO: use context.session, remove in breaking change
-  listKey: ListTypeInfo['key']
-}
-
-export type AccessOperation = 'create' | 'query' | 'update' | 'delete'
-export type FilterOperation = 'query' | 'update' | 'delete'
-export type ItemOperation = 'create' | 'update' | 'delete'
-
-export type ListOperationAccessControl<
-  Operation extends AccessOperation,
-  ListTypeInfo extends BaseListTypeInfo,
-> = (args: BaseAccessArgs<ListTypeInfo> & { operation: Operation }) => MaybePromise<boolean>
-
-export type ListFilterAccessControl<
-  Operation extends FilterOperation,
-  ListTypeInfo extends BaseListTypeInfo,
-> = (
-  args: BaseAccessArgs<ListTypeInfo> & { operation: Operation }
-) => MaybePromise<boolean | ListTypeInfo['inputs']['where']>
-
-export type ListItemAccessControl<
-  Operation extends ItemOperation,
-  ListTypeInfo extends BaseListTypeInfo,
-> = (
-  args: BaseAccessArgs<ListTypeInfo> &
-    {
-      create: {
-        operation: 'create'
-
-        /**
-         * The input passed in from the GraphQL API
-         */
-        inputData: ListTypeInfo['inputs']['create']
-      }
-      update: {
-        operation: 'update'
-
-        /**
-         * The input passed in from the GraphQL API
-         */
-        inputData: ListTypeInfo['inputs']['update']
-
-        /**
-         * The item being updated
-         */
-        item: ListTypeInfo['item']
-      }
-      delete: {
-        operation: 'delete'
-
-        /**
-         * The item being deleted
-         */
-        item: ListTypeInfo['item']
-      }
-    }[Operation]
-) => MaybePromise<boolean>
-
-export type CreateListItemAccessControl<ListTypeInfo extends BaseListTypeInfo> =
-  ListItemAccessControl<'create', ListTypeInfo>
-export type UpdateListItemAccessControl<ListTypeInfo extends BaseListTypeInfo> =
-  ListItemAccessControl<'update', ListTypeInfo>
-export type DeleteListItemAccessControl<ListTypeInfo extends BaseListTypeInfo> =
-  ListItemAccessControl<'delete', ListTypeInfo>
-
-type ListAccessControlFunction<ListTypeInfo extends BaseListTypeInfo> = (
-  args: BaseAccessArgs<ListTypeInfo> & { operation: AccessOperation }
-) => MaybePromise<boolean>
-
-type ListAccessControlObject<ListTypeInfo extends BaseListTypeInfo> = {
-  // these functions should return `true` if access is allowed or `false` if access is denied.
-  operation:
-    | ListOperationAccessControl<AccessOperation, ListTypeInfo>
-    | {
-        query: ListOperationAccessControl<'query', ListTypeInfo>
-        create: ListOperationAccessControl<'create', ListTypeInfo>
-        update: ListOperationAccessControl<'update', ListTypeInfo>
-        delete: ListOperationAccessControl<'delete', ListTypeInfo>
-      }
-
-  // The 'filter' rules can return either:
-  // - a filter. In this case, the operation can proceed, but the filter will be additionally applied when updating/reading/deleting
-  //   which may make it appear that some of the items don't exist.
-  // - boolean true/false. If false, treated as a filter that never matches.
-  filter?: {
-    query?: ListFilterAccessControl<'query', ListTypeInfo>
-    // create?: not supported
-    update?: ListFilterAccessControl<'update', ListTypeInfo>
-    delete?: ListFilterAccessControl<'delete', ListTypeInfo>
-  }
-
-  // These rules are applied to each item being operated on individually. They return `true` or `false`,
-  // and if false, an access denied error will be returned for the individual operation.
-  item?: {
-    // read?: not supported // TODO: why not
-    create?: ListItemAccessControl<'create', ListTypeInfo>
-    update?: ListItemAccessControl<'update', ListTypeInfo>
-    delete?: ListItemAccessControl<'delete', ListTypeInfo>
-  }
-}
-
-// List level access control lets you set permissions on the autogenerated CRUD API for each list.
-//
-// * `operation` access lets you check the information in the `context` and `session` objects to decide if the
-// user is allow to access the list.
-// * `filter` access lets you provide a GraphQL filter which defines the items the user is allowed to access.
-// * `item` access lets you write a function which inspects the provided input data and the existing object (if it exists)
-// and make a decision based on this extra data.
-//
-// If access is denied due to any of the access control methods then the following response will be returned from the GraphQL API:
-//   Mutations:
-//     - Single operations will return `null` and return an access denied error
-//     - Multi operations will return a data array with `null` values for the items which have access denied.
-//       Access denied errors will be return for each `null` items.
-//   Queries:
-//     - Single item queries will return `null` with no errors.
-//     - Many item queries will filter out those items which have access denied, with no errors.
-//     - Count queries will only count those items for which access is not denied, with no errors.
-//
-export type ListAccessControl<ListTypeInfo extends BaseListTypeInfo> =
-  | ListAccessControlFunction<ListTypeInfo>
-  | ListAccessControlObject<ListTypeInfo>
-
-// Field Access
-export type FieldAccessControlFunction<Args> = (args: Args) => MaybePromise<boolean>
-
-export type FieldCreateItemAccessArgs<ListTypeInfo extends BaseListTypeInfo> =
-  BaseAccessArgs<ListTypeInfo> & {
-    operation: 'create'
-    fieldKey: string
-    /**
-     * The input passed in from the GraphQL API
-     */
-    inputData: ListTypeInfo['inputs']['create']
-  }
-
-export type FieldReadItemAccessArgs<ListTypeInfo extends BaseListTypeInfo> =
-  BaseAccessArgs<ListTypeInfo> & {
-    operation: 'read'
-    fieldKey: string
-    /**
-     * The item being read
-     */
-    item: ListTypeInfo['item']
-  }
-
-export type FieldUpdateItemAccessArgs<ListTypeInfo extends BaseListTypeInfo> =
-  BaseAccessArgs<ListTypeInfo> & {
-    operation: 'update'
-    fieldKey: string
-    /**
-     * The item being updated
-     */
-    item: ListTypeInfo['item']
-    /**
-     * The input passed in from the GraphQL API
-     */
-    inputData: ListTypeInfo['inputs']['update']
-  }
-
-export type FieldAccessControl<ListTypeInfo extends BaseListTypeInfo> =
-  | FieldAccessControlFunction<
-      | FieldReadItemAccessArgs<ListTypeInfo>
-      | FieldCreateItemAccessArgs<ListTypeInfo>
-      | FieldUpdateItemAccessArgs<ListTypeInfo>
-      // delete: not supported
-    >
-  | {
-      read?: FieldAccessControlFunction<FieldReadItemAccessArgs<ListTypeInfo>>
-      create?: FieldAccessControlFunction<FieldCreateItemAccessArgs<ListTypeInfo>>
-      update?: FieldAccessControlFunction<FieldUpdateItemAccessArgs<ListTypeInfo>>
-      // delete: not supported
-    }
-
-// Action Access
-export type ActionAccessControlFunction<ListTypeInfo extends BaseListTypeInfo> = (
-  args: BaseAccessArgs<ListTypeInfo> & {
-    actionKey: string
-  }
-) => MaybePromise<boolean>
+import type { NixxieContext } from '../context'
+import type { BaseCollectionTypeInfo } from '../type-info'
+import type { MaybePromise } from '../utils'
+
+export type BaseAccessArgs<CollectionTypeInfo extends BaseCollectionTypeInfo> = {
+  context: NixxieContext<CollectionTypeInfo['all']>
+  session?: CollectionTypeInfo['all']['session'] // TODO: use context.session, remove in breaking change
+  listKey: CollectionTypeInfo['key']
+}
+
+export type AccessOperation = 'create' | 'query' | 'update' | 'delete'
+export type FilterOperation = 'query' | 'update' | 'delete'
+export type ItemOperation = 'create' | 'update' | 'delete'
+
+export type CollectionOperationAccessControl<
+  Operation extends AccessOperation,
+  CollectionTypeInfo extends BaseCollectionTypeInfo,
+> = (args: BaseAccessArgs<CollectionTypeInfo> & { operation: Operation }) => MaybePromise<boolean>
+
+export type CollectionFilterAccessControl<
+  Operation extends FilterOperation,
+  CollectionTypeInfo extends BaseCollectionTypeInfo,
+> = (
+  args: BaseAccessArgs<CollectionTypeInfo> & { operation: Operation }
+) => MaybePromise<boolean | CollectionTypeInfo['inputs']['where']>
+
+export type CollectionItemAccessControl<
+  Operation extends ItemOperation,
+  CollectionTypeInfo extends BaseCollectionTypeInfo,
+> = (
+  args: BaseAccessArgs<CollectionTypeInfo> &
+    {
+      create: {
+        operation: 'create'
+
+        /**
+         * The input passed in from the GraphQL API
+         */
+        inputData: CollectionTypeInfo['inputs']['create']
+      }
+      update: {
+        operation: 'update'
+
+        /**
+         * The input passed in from the GraphQL API
+         */
+        inputData: CollectionTypeInfo['inputs']['update']
+
+        /**
+         * The item being updated
+         */
+        item: CollectionTypeInfo['item']
+      }
+      delete: {
+        operation: 'delete'
+
+        /**
+         * The item being deleted
+         */
+        item: CollectionTypeInfo['item']
+      }
+    }[Operation]
+) => MaybePromise<boolean>
+
+export type CreateCollectionItemAccessControl<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  CollectionItemAccessControl<'create', CollectionTypeInfo>
+export type UpdateCollectionItemAccessControl<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  CollectionItemAccessControl<'update', CollectionTypeInfo>
+export type DeleteCollectionItemAccessControl<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  CollectionItemAccessControl<'delete', CollectionTypeInfo>
+
+type CollectionAccessControlFunction<CollectionTypeInfo extends BaseCollectionTypeInfo> = (
+  args: BaseAccessArgs<CollectionTypeInfo> & { operation: AccessOperation }
+) => MaybePromise<boolean>
+
+type CollectionAccessControlObject<CollectionTypeInfo extends BaseCollectionTypeInfo> = {
+  // these functions should return `true` if access is allowed or `false` if access is denied.
+  operation:
+    | CollectionOperationAccessControl<AccessOperation, CollectionTypeInfo>
+    | {
+        query: CollectionOperationAccessControl<'query', CollectionTypeInfo>
+        create: CollectionOperationAccessControl<'create', CollectionTypeInfo>
+        update: CollectionOperationAccessControl<'update', CollectionTypeInfo>
+        delete: CollectionOperationAccessControl<'delete', CollectionTypeInfo>
+      }
+
+  // The 'filter' rules can return either:
+  // - a filter. In this case, the operation can proceed, but the filter will be additionally applied when updating/reading/deleting
+  //   which may make it appear that some of the items don't exist.
+  // - boolean true/false. If false, treated as a filter that never matches.
+  filter?: {
+    query?: CollectionFilterAccessControl<'query', CollectionTypeInfo>
+    // create?: not supported
+    update?: CollectionFilterAccessControl<'update', CollectionTypeInfo>
+    delete?: CollectionFilterAccessControl<'delete', CollectionTypeInfo>
+  }
+
+  // These rules are applied to each item being operated on individually. They return `true` or `false`,
+  // and if false, an access denied error will be returned for the individual operation.
+  item?: {
+    // read?: not supported // TODO: why not
+    create?: CollectionItemAccessControl<'create', CollectionTypeInfo>
+    update?: CollectionItemAccessControl<'update', CollectionTypeInfo>
+    delete?: CollectionItemAccessControl<'delete', CollectionTypeInfo>
+  }
+}
+
+// List level access control lets you set permissions on the autogenerated CRUD API for each list.
+//
+// * `operation` access lets you check the information in the `context` and `session` objects to decide if the
+// user is allow to access the list.
+// * `filter` access lets you provide a GraphQL filter which defines the items the user is allowed to access.
+// * `item` access lets you write a function which inspects the provided input data and the existing object (if it exists)
+// and make a decision based on this extra data.
+//
+// If access is denied due to any of the access control methods then the following response will be returned from the GraphQL API:
+//   Mutations:
+//     - Single operations will return `null` and return an access denied error
+//     - Multi operations will return a data array with `null` values for the items which have access denied.
+//       Access denied errors will be return for each `null` items.
+//   Queries:
+//     - Single item queries will return `null` with no errors.
+//     - Many item queries will filter out those items which have access denied, with no errors.
+//     - Count queries will only count those items for which access is not denied, with no errors.
+//
+export type CollectionAccessControl<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  | CollectionAccessControlFunction<CollectionTypeInfo>
+  | CollectionAccessControlObject<CollectionTypeInfo>
+
+// Field Access
+export type FieldAccessControlFunction<Args> = (args: Args) => MaybePromise<boolean>
+
+export type FieldCreateItemAccessArgs<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  BaseAccessArgs<CollectionTypeInfo> & {
+    operation: 'create'
+    fieldKey: string
+    /**
+     * The input passed in from the GraphQL API
+     */
+    inputData: CollectionTypeInfo['inputs']['create']
+  }
+
+export type FieldReadItemAccessArgs<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  BaseAccessArgs<CollectionTypeInfo> & {
+    operation: 'read'
+    fieldKey: string
+    /**
+     * The item being read
+     */
+    item: CollectionTypeInfo['item']
+  }
+
+export type FieldUpdateItemAccessArgs<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  BaseAccessArgs<CollectionTypeInfo> & {
+    operation: 'update'
+    fieldKey: string
+    /**
+     * The item being updated
+     */
+    item: CollectionTypeInfo['item']
+    /**
+     * The input passed in from the GraphQL API
+     */
+    inputData: CollectionTypeInfo['inputs']['update']
+  }
+
+export type FieldAccessControl<CollectionTypeInfo extends BaseCollectionTypeInfo> =
+  | FieldAccessControlFunction<
+      | FieldReadItemAccessArgs<CollectionTypeInfo>
+      | FieldCreateItemAccessArgs<CollectionTypeInfo>
+      | FieldUpdateItemAccessArgs<CollectionTypeInfo>
+      // delete: not supported
+    >
+  | {
+      read?: FieldAccessControlFunction<FieldReadItemAccessArgs<CollectionTypeInfo>>
+      create?: FieldAccessControlFunction<FieldCreateItemAccessArgs<CollectionTypeInfo>>
+      update?: FieldAccessControlFunction<FieldUpdateItemAccessArgs<CollectionTypeInfo>>
+      // delete: not supported
+    }
+
+// Action Access
+export type ActionAccessControlFunction<CollectionTypeInfo extends BaseCollectionTypeInfo> = (
+  args: BaseAccessArgs<CollectionTypeInfo> & {
+    actionKey: string
+  }
+) => MaybePromise<boolean>

package/src/types/config/fields.ts

@@ -1,96 +1,96 @@
-import type { CacheHint } from '@apollo/cache-control-types'
-import type { NixxieContext } from '..'
-import type { FieldTypeFunc } from '../next-fields'
-import type { BaseListTypeInfo } from '../type-info'
-import type { FieldAccessControl } from './access-control'
-import type { FieldHooks } from './hooks'
-import type {
-  MaybeBooleanSessionFunctionWithFilter,
-  MaybeFieldFunction,
-  MaybeItemFieldFunction,
-  MaybeItemFieldFunctionWithFilter,
-  MaybeSessionFunction,
-  MaybeSessionFunctionWithFilter,
-} from './lists'
-
-export type BaseFields<ListTypeInfo extends BaseListTypeInfo> = {
-  [key: string]: FieldTypeFunc<ListTypeInfo>
-}
-
-export type FilterOrderArgs<ListTypeInfo extends BaseListTypeInfo> = {
-  context: NixxieContext<ListTypeInfo['all']>
-  session?: ListTypeInfo['all']['session']
-  listKey: ListTypeInfo['key']
-  fieldKey: ListTypeInfo['fields']
-}
-
-export type BaseFieldTypeInfo = {
-  item: any
-  inputs: {
-    create: any
-    update: any
-    where: any
-    uniqueWhere: any
-    orderBy: any
-  }
-  prisma: {
-    create: any
-    update: any
-  }
-}
-
-export type CommonFieldConfig<
-  ListTypeInfo extends BaseListTypeInfo,
-  FieldTypeInfo extends BaseFieldTypeInfo,
-> = {
-  access?: FieldAccessControl<ListTypeInfo>
-  hooks?: FieldHooks<ListTypeInfo, FieldTypeInfo>
-  ui?: {
-    label?: string
-    description?: string
-    views?: string
-    createView?: {
-      fieldMode?: MaybeSessionFunctionWithFilter<'edit' | 'hidden', 'hidden', ListTypeInfo>
-      isRequired?: MaybeBooleanSessionFunctionWithFilter<ListTypeInfo>
-    }
-    itemView?: {
-      fieldMode?: MaybeItemFieldFunctionWithFilter<
-        'edit' | 'read' | 'hidden',
-        'read' | 'hidden',
-        ListTypeInfo,
-        FieldTypeInfo
-      >
-      fieldPosition?: MaybeItemFieldFunction<'form' | 'sidebar', ListTypeInfo, FieldTypeInfo>
-      isRequired?: MaybeBooleanSessionFunctionWithFilter<ListTypeInfo>
-    }
-    listView?: {
-      fieldMode?: MaybeSessionFunction<'read' | 'hidden', ListTypeInfo>
-    }
-  }
-  graphql?: {
-    cacheHint?: CacheHint
-    isNonNull?:
-      | boolean
-      | {
-          // whether this field is non-nullable on the {List} GraphQL type
-          read?: boolean
-          // whether this field is non-nullable on the {List}CreateInput GraphQL type
-          create?: boolean
-          // whether this field is non-nullable on the {List}UpdateInput GraphQL type
-          update?: boolean
-        }
-
-    omit?:
-      | boolean
-      | {
-          // whether this field is omitted from the {List} GraphQL type
-          read?: boolean
-          // whether this field is omitted from the {List}CreateInput GraphQL type
-          create?: boolean
-          // whether this field is omitted from the {List}UpdateInput GraphQL type
-          update?: boolean
-        }
-  }
-  isFilterable?: MaybeFieldFunction<ListTypeInfo>
-  isOrderable?: MaybeFieldFunction<ListTypeInfo>
-}
+import type { CacheHint } from '@apollo/cache-control-types'
+import type { NixxieContext } from '..'
+import type { FieldTypeFunc } from '../next-fields'
+import type { BaseCollectionTypeInfo } from '../type-info'
+import type { FieldAccessControl } from './access-control'
+import type { FieldHooks } from './hooks'
+import type {
+  MaybeBooleanSessionFunctionWithFilter,
+  MaybeFieldFunction,
+  MaybeItemFieldFunction,
+  MaybeItemFieldFunctionWithFilter,
+  MaybeSessionFunction,
+  MaybeSessionFunctionWithFilter,
+} from './lists'
+
+export type BaseFields<CollectionTypeInfo extends BaseCollectionTypeInfo> = {
+  [key: string]: FieldTypeFunc<CollectionTypeInfo>
+}
+
+export type FilterOrderArgs<CollectionTypeInfo extends BaseCollectionTypeInfo> = {
+  context: NixxieContext<CollectionTypeInfo['all']>
+  session?: CollectionTypeInfo['all']['session']
+  listKey: CollectionTypeInfo['key']
+  fieldKey: CollectionTypeInfo['fields']
+}
+
+export type BaseFieldTypeInfo = {
+  item: any
+  inputs: {
+    create: any
+    update: any
+    where: any
+    uniqueWhere: any
+    orderBy: any
+  }
+  prisma: {
+    create: any
+    update: any
+  }
+}
+
+export type CommonFieldConfig<
+  CollectionTypeInfo extends BaseCollectionTypeInfo,
+  FieldTypeInfo extends BaseFieldTypeInfo,
+> = {
+  access?: FieldAccessControl<CollectionTypeInfo>
+  hooks?: FieldHooks<CollectionTypeInfo, FieldTypeInfo>
+  ui?: {
+    label?: string
+    description?: string
+    views?: string
+    createView?: {
+      fieldMode?: MaybeSessionFunctionWithFilter<'edit' | 'hidden', 'hidden', CollectionTypeInfo>
+      isRequired?: MaybeBooleanSessionFunctionWithFilter<CollectionTypeInfo>
+    }
+    itemView?: {
+      fieldMode?: MaybeItemFieldFunctionWithFilter<
+        'edit' | 'read' | 'hidden',
+        'read' | 'hidden',
+        CollectionTypeInfo,
+        FieldTypeInfo
+      >
+      fieldPosition?: MaybeItemFieldFunction<'form' | 'sidebar', CollectionTypeInfo, FieldTypeInfo>
+      isRequired?: MaybeBooleanSessionFunctionWithFilter<CollectionTypeInfo>
+    }
+    listView?: {
+      fieldMode?: MaybeSessionFunction<'read' | 'hidden', CollectionTypeInfo>
+    }
+  }
+  graphql?: {
+    cacheHint?: CacheHint
+    isNonNull?:
+      | boolean
+      | {
+          // whether this field is non-nullable on the {List} GraphQL type
+          read?: boolean
+          // whether this field is non-nullable on the {List}CreateInput GraphQL type
+          create?: boolean
+          // whether this field is non-nullable on the {List}UpdateInput GraphQL type
+          update?: boolean
+        }
+
+    omit?:
+      | boolean
+      | {
+          // whether this field is omitted from the {List} GraphQL type
+          read?: boolean
+          // whether this field is omitted from the {List}CreateInput GraphQL type
+          create?: boolean
+          // whether this field is omitted from the {List}UpdateInput GraphQL type
+          update?: boolean
+        }
+  }
+  isFilterable?: MaybeFieldFunction<CollectionTypeInfo>
+  isOrderable?: MaybeFieldFunction<CollectionTypeInfo>
+}