/**
 * This file is part of the NocoBase (R) project.
 * Copyright (c) 2020-2024 NocoBase Co., Ltd.
 * Authors: NocoBase Team.
 *
 * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
 * For more information, please refer to: https://www.nocobase.com/agreement.
 */

import { Collection } from '@nocobase/database';
import { getTypeByField } from './field-type-map';

export default (collection: Collection) => {
  const primaryKey = collection.model.primaryKeyAttribute;

  const parameters = {};

  if (primaryKey) {
    const primaryKeyField = collection.fields.get(primaryKey);
    if (!primaryKeyField) {
      throw new Error(`primaryKeyField not found: ${primaryKey}, ${collection.name}`);
    }

    Object.assign(parameters, {
      collectionIndex: {
        required: true,
        name: 'collectionIndex',
        in: 'path',
        description: 'collection index',
        schema: getTypeByField(collection.fields.get(primaryKey)),
      },
      filterByTk: {
        name: 'filterByTk',
        in: 'query',
        description: 'filter by TK(default by ID)',
        schema: getTypeByField(collection.fields.get(primaryKey)),
      },

      filterByTks: {
        name: 'filterByTk',
        in: 'query',
        description: 'filter by TKs(default by ID), example: `1,2,3`',
        schema: {
          type: 'array',
          items: getTypeByField(collection.fields.get(primaryKey)),
        },
      },
    });
  }

  Object.assign(parameters, {
    filter: {
      name: 'filter',
      in: 'query',
      description: 'filter items',
      content: {
        'application/json': {
          schema: {
            type: 'object',
          },
        },
      },
    },
    sort: {
      name: 'sort',
      in: 'query',
      description: 'sort items by fields, example: `-field1,-field2,field3`',
      schema: {
        oneOf: [
          {
            type: 'array',
            items: {
              type: 'string',
            },
            example: ['-id', 'createdAt'],
          },
          {
            type: 'string',
            example: '-id,createdAt',
          },
        ],
      },
    },
    fields: {
      name: 'fields',
      in: 'query',
      description: 'select fields, example: `field1,field2`',
      schema: {
        oneOf: [
          {
            type: 'array',
            items: {
              type: 'string',
            },
            example: ['id', 'createdAt'],
          },
          {
            type: 'string',
            example: 'id,createdAt',
          },
        ],
      },
    },

    except: {
      name: 'except',
      in: 'query',
      description: 'except fields in results, example: `field1,field2`',
      schema: {
        oneOf: [
          {
            type: 'array',
            items: {
              type: 'string',
            },
            example: ['id', 'createdAt'],
          },
          {
            type: 'string',
            example: 'id,createdAt',
          },
        ],
      },
    },

    appends: {
      name: 'appends',
      in: 'query',
      description: 'append associations in results, example: `assoc1,assoc2`',
      schema: {
        oneOf: [
          {
            type: 'array',
            items: {
              type: 'string',
            },
            example: ['id', 'createdAt'],
          },
          {
            type: 'string',
            example: 'id,createdAt',
          },
        ],
      },
    },
    whitelist: {
      name: 'whitelist',
      in: 'query',
      description: 'whitelist for fields changes, example: `field1,field2`',
      schema: {
        oneOf: [
          {
            type: 'array',
            items: {
              type: 'string',
            },
            example: ['id', 'createdAt'],
          },
          {
            type: 'string',
            example: 'id,createdAt',
          },
        ],
      },
    },
    blacklist: {
      name: 'blacklist',
      in: 'query',
      description: 'blacklist for fields changes, example: `field1,field2`',
      schema: {
        oneOf: [
          {
            type: 'array',
            items: {
              type: 'string',
            },
            example: ['id', 'createdAt'],
          },
          {
            type: 'string',
            example: 'id,createdAt',
          },
        ],
      },
    },
  });

  return {
    parameters,
  };
};
