nocobase/packages/plugins/@nocobase/plugin-api-keys/src/collections/apiKeys.ts

/**
 * 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 type { CollectionOptions } from '@nocobase/database';
import { generateNTemplate } from '../locale';

export default {
  dumpRules: {
    group: 'user',
  },
  migrationRules: ['schema-only', 'skip'],
  shared: true,
  name: 'apiKeys',
  sortable: 'sort',
  createdBy: true,
  updatedAt: false,
  updatedBy: false,
  logging: true,
  fields: [
    {
      name: 'id',
      type: 'bigInt',
      autoIncrement: true,
      primaryKey: true,
      allowNull: false,
      interface: 'id',
    },
    {
      type: 'string',
      name: 'name',
      interface: 'input',
      uiSchema: {
        type: 'string',
        title: '{{t("name")}}',
        'x-component': 'Input',
      },
    },
    {
      interface: 'obo',
      type: 'belongsTo',
      name: 'role',
      target: 'roles',
      foreignKey: 'roleName',
      uiSchema: {
        type: 'object',
        title: '{{t("Roles")}}',
        'x-component': 'Select',
        'x-component-props': {
          fieldNames: {
            label: 'title',
            value: 'name',
          },
          objectValue: true,
          options: '{{ currentRoles }}',
        },
      },
    },
    {
      name: 'expiresIn',
      type: 'string',
      uiSchema: {
        type: 'string',
        title: generateNTemplate('Expires'),
        'x-component': 'ExpiresSelect',
        enum: [
          {
            label: generateNTemplate('1 Day'),
            value: '1d',
          },
          {
            label: generateNTemplate('7 Days'),
            value: '7d',
          },
          {
            label: generateNTemplate('30 Days'),
            value: '30d',
          },
          {
            label: generateNTemplate('90 Days'),
            value: '90d',
          },
          {
            label: generateNTemplate('Custom'),
            value: 'custom',
          },
          {
            label: generateNTemplate('Never'),
            value: 'never',
          },
        ],
      },
    },
    {
      name: 'token',
      type: 'string',
      hidden: true,
    },
  ],
} as CollectionOptions;