From 2755068edbcaefd8815cc386833e215e989f9480 Mon Sep 17 00:00:00 2001
From: chenos <chenlinxh@gmail.com>
Date: Tue, 16 Nov 2021 11:06:17 +0800
Subject: [PATCH] feat: update api doc

---
 .dumi/theme/components/Navbar.tsx |   2 +-
 .umirc.ts                         |   2 +-
 docs/reference/collection.md      |  54 ++--
 docs/reference/field-types.md     | 452 +++++++++++++++++++++++++++++-
 docs/reference/operators.md       |  38 ++-
 5 files changed, 502 insertions(+), 46 deletions(-)

diff --git a/.dumi/theme/components/Navbar.tsx b/.dumi/theme/components/Navbar.tsx
index e6734a1e5..3982d3e2b 100755
--- a/.dumi/theme/components/Navbar.tsx
+++ b/.dumi/theme/components/Navbar.tsx
@@ -30,7 +30,7 @@ const Navbar: FC<INavbarProps> = ({ onMobileMenuClick, navPrefix, location }) =>
         to={base}
         data-plaintext={logo === false || undefined}
       >
-        {title}
+        {/* {title} */}
       </Link>
       <nav>
         {navPrefix}
diff --git a/.umirc.ts b/.umirc.ts
index d95910411..9dd66e4f8 100644
--- a/.umirc.ts
+++ b/.umirc.ts
@@ -6,7 +6,7 @@ console.log('baseUrl', baseUrl);
 process.env.MFSU_AD = 'none';
 
 export default defineConfig({
-  title: ' ',
+  title: 'NocoBase',
   hash: true,
   define: {
     'process.env.API_URL': process.env.API_URL || `${baseUrl}api/`,
diff --git a/docs/reference/collection.md b/docs/reference/collection.md
index d2337c819..636d6ac5d 100644
--- a/docs/reference/collection.md
+++ b/docs/reference/collection.md
@@ -97,33 +97,6 @@ interface hasField {
 collection.hasField('name');
 ```
 
-## `collection.updateOptions()`
-
-更改当前 collection 的 options
-
-##### Definition
-
-```ts
-interface updateOptions {
-  (options: CollectionOptions): void;
-}
-```
-
-##### Examples
-
-```ts
-const collection = db.collection({
-  name: 'tests',
-});
-
-collection.updateOptions({
-  createdAt: true,
-  updatedAt: true,
-  sortable: true,
-  fields: [],
-});
-```
-
 ## `collection.removeField()`
 
 移除字段
@@ -235,3 +208,30 @@ const field = collection.updateField('name1', {
 });
 await field.sync();
 ```
+
+## `collection.updateOptions()`
+
+更改当前 collection 的 options
+
+##### Definition
+
+```ts
+interface updateOptions {
+  (options: CollectionOptions): void;
+}
+```
+
+##### Examples
+
+```ts
+const collection = db.collection({
+  name: 'tests',
+});
+
+collection.updateOptions({
+  createdAt: true,
+  updatedAt: true,
+  sortable: true,
+  fields: [],
+});
+```
diff --git a/docs/reference/field-types.md b/docs/reference/field-types.md
index 7408d9815..9c90ac346 100644
--- a/docs/reference/field-types.md
+++ b/docs/reference/field-types.md
@@ -4,27 +4,473 @@ toc: menu
 
 # Field Types
 
-## Field - abstract
-## RelationField - abstract
+## Field <Badge>abstract</Badge>
+## RelationField <Badge>abstract</Badge>
 ## HasOneField
+
+```ts
+interface HasOneFieldOptions {
+
+  type: 'hasOne';
+
+  /**
+   * The name of the field to use as the key for the association in the source table. Defaults to the primary
+   * key of the source table
+   */
+  sourceKey?: string;
+
+  /**
+   * A string or a data type to represent the identifier in the table
+   */
+  keyType?: DataType;
+
+  /**
+   * The alias of this model, in singular form. See also the `name` option passed to `sequelize.define`. If
+   * you create multiple associations between the same tables, you should provide an alias to be able to
+   * distinguish between them. If you provide an alias when creating the assocition, you should provide the
+   * same alias when eager loading and when getting associated models. Defaults to the singularized name of
+   * target
+   */
+  as?: string | { singular: string; plural: string };
+
+  /**
+   * The name of the foreign key in the target table or an object representing the type definition for the
+   * foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property
+   * to set the name of the column. Defaults to the name of source + primary key of source
+   */
+  foreignKey?: string | ForeignKeyOptions;
+
+  /**
+   * What happens when delete occurs.
+   *
+   * Cascade if this is a n:m, and set null if it is a 1:m
+   *
+   * @default 'SET NULL' or 'CASCADE'
+   */
+  onDelete?: string;
+
+  /**
+   * What happens when update occurs
+   *
+   * @default 'CASCADE'
+   */
+  onUpdate?: string;
+
+  /**
+   * Should on update and on delete constraints be enabled on the foreign key.
+   */
+  constraints?: boolean;
+  foreignKeyConstraint?: boolean;
+
+  scope?: AssociationScope;
+
+  /**
+   * If `false` the applicable hooks will not be called.
+   * The default value depends on the context.
+   */
+  hooks?: boolean;
+}
+```
+
 ## HasManyField
+
+```ts
+interface HasManyFieldOptions {
+
+  type: 'hasMany';
+
+  /**
+   * The name of the field to use as the key for the association in the source table. Defaults to the primary
+   * key of the source table
+   */
+  sourceKey?: string;
+
+  /**
+   * A string or a data type to represent the identifier in the table
+   */
+  keyType?: DataType;
+
+  /**
+   * The alias of this model, in singular form. See also the `name` option passed to `sequelize.define`. If
+   * you create multiple associations between the same tables, you should provide an alias to be able to
+   * distinguish between them. If you provide an alias when creating the assocition, you should provide the
+   * same alias when eager loading and when getting associated models. Defaults to the singularized name of
+   * target
+   */
+  as?: string | { singular: string; plural: string };
+
+  /**
+   * The name of the foreign key in the target table or an object representing the type definition for the
+   * foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property
+   * to set the name of the column. Defaults to the name of source + primary key of source
+   */
+  foreignKey?: string | ForeignKeyOptions;
+
+  /**
+   * What happens when delete occurs.
+   *
+   * Cascade if this is a n:m, and set null if it is a 1:m
+   *
+   * @default 'SET NULL' or 'CASCADE'
+   */
+  onDelete?: string;
+
+  /**
+   * What happens when update occurs
+   *
+   * @default 'CASCADE'
+   */
+  onUpdate?: string;
+
+  /**
+   * Should on update and on delete constraints be enabled on the foreign key.
+   */
+  constraints?: boolean;
+  foreignKeyConstraint?: boolean;
+
+  scope?: AssociationScope;
+
+  /**
+   * If `false` the applicable hooks will not be called.
+   * The default value depends on the context.
+   */
+  hooks?: boolean;
+}
+```
+
 ## BelongsToField
+
+```ts
+interface BelongsToFieldOptions {
+
+  type: 'belongsTo';
+
+  /**
+   * The name of the field to use as the key for the association in the target table. Defaults to the primary
+   * key of the target table
+   */
+  targetKey?: string;
+
+  /**
+   * A string or a data type to represent the identifier in the table
+   */
+  keyType?: DataType;
+
+  /**
+   * The alias of this model, in singular form. See also the `name` option passed to `sequelize.define`. If
+   * you create multiple associations between the same tables, you should provide an alias to be able to
+   * distinguish between them. If you provide an alias when creating the assocition, you should provide the
+   * same alias when eager loading and when getting associated models. Defaults to the singularized name of
+   * target
+   */
+  as?: string | { singular: string; plural: string };
+
+  /**
+   * The name of the foreign key in the target table or an object representing the type definition for the
+   * foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property
+   * to set the name of the column. Defaults to the name of source + primary key of source
+   */
+  foreignKey?: string | ForeignKeyOptions;
+
+  /**
+   * What happens when delete occurs.
+   *
+   * Cascade if this is a n:m, and set null if it is a 1:m
+   *
+   * @default 'SET NULL' or 'CASCADE'
+   */
+  onDelete?: string;
+
+  /**
+   * What happens when update occurs
+   *
+   * @default 'CASCADE'
+   */
+  onUpdate?: string;
+
+  /**
+   * Should on update and on delete constraints be enabled on the foreign key.
+   */
+  constraints?: boolean;
+  foreignKeyConstraint?: boolean;
+
+  scope?: AssociationScope;
+
+  /**
+   * If `false` the applicable hooks will not be called.
+   * The default value depends on the context.
+   */
+  hooks?: boolean;
+}
+```
+
 ## BelongsToManyField
+
+```ts
+interface BelongsToManyFieldOptions {
+
+  type: 'belongsToMany';
+
+  /**
+   * The name of the table that is used to join source and target in n:m associations. Can also be a
+   * sequelize model if you want to define the junction table yourself and add extra attributes to it.
+   */
+  through: ModelType | string | ThroughOptions;
+
+  /**
+   * The name of the foreign key in the join table (representing the target model) or an object representing
+   * the type definition for the other column (see `Sequelize.define` for syntax). When using an object, you
+   * can add a `name` property to set the name of the colum. Defaults to the name of target + primary key of
+   * target
+   */
+  otherKey?: string | ForeignKeyOptions;
+
+  /**
+   * The name of the field to use as the key for the association in the source table. Defaults to the primary
+   * key of the source table
+   */
+  sourceKey?: string;
+
+  /**
+   * The name of the field to use as the key for the association in the target table. Defaults to the primary
+   * key of the target table
+   */
+  targetKey?: string;
+
+  /**
+   * Should the join model have timestamps
+   */
+  timestamps?: boolean;
+
+  /**
+   * The unique key name to override the autogenerated one when primary key is not present on through model
+   */
+  uniqueKey?: string;
+
+  /**
+   * A key/value set that will be used for association create and find defaults on the target.
+   * (sqlite not supported for N:M)
+   */
+  scope?: AssociationScope;
+
+  /**
+   * The alias of this model, in singular form. See also the `name` option passed to `sequelize.define`. If
+   * you create multiple associations between the same tables, you should provide an alias to be able to
+   * distinguish between them. If you provide an alias when creating the assocition, you should provide the
+   * same alias when eager loading and when getting associated models. Defaults to the singularized name of
+   * target
+   */
+  as?: string | { singular: string; plural: string };
+
+  /**
+   * The name of the foreign key in the target table or an object representing the type definition for the
+   * foreign column (see `Sequelize.define` for syntax). When using an object, you can add a `name` property
+   * to set the name of the column. Defaults to the name of source + primary key of source
+   */
+  foreignKey?: string | ForeignKeyOptions;
+
+  /**
+   * What happens when delete occurs.
+   *
+   * Cascade if this is a n:m, and set null if it is a 1:m
+   *
+   * @default 'SET NULL' or 'CASCADE'
+   */
+  onDelete?: string;
+
+  /**
+   * What happens when update occurs
+   *
+   * @default 'CASCADE'
+   */
+  onUpdate?: string;
+
+  /**
+   * Should on update and on delete constraints be enabled on the foreign key.
+   */
+  constraints?: boolean;
+  foreignKeyConstraint?: boolean;
+
+  /**
+   * If `false` the applicable hooks will not be called.
+   * The default value depends on the context.
+   */
+  hooks?: boolean;
+}
+```
+
+## BooleanField
+
+```ts
+interface BooleanFieldOptions {
+  type: 'boolean';
+}
+```
+
 ## StringField
+
+```ts
+interface StringFieldOptions {
+  type: 'string';
+  length?: number;
+  binary?: boolean;
+}
+```
+
 ## TextField
+
+```ts
+type TextLength = 'tiny' | 'medium' | 'long';
+
+interface TextFieldOptions {
+  type: 'text';
+  length?: TextLength;
+}
+```
+
 ## IntegerField
+
+```ts
+interface IntegerFieldOptions {
+  type: 'integer';
+  length?: number;
+  zerofill?: boolean;
+  unsigned?: boolean;
+}
+```
+
 ## FloatField
+
+```ts
+interface FloatFieldOptions {
+  type: 'float';
+  length?: number;
+  decimals?: number;
+}
+```
+
 ## DoubleField
+
+```ts
+interface DoubleFieldOptions {
+  type: 'double';
+  length?: number;
+  decimals?: number;
+}
+```
+
 ## RealField
+
+```ts
+interface RealFieldOptions {
+  type: 'real';
+  length?: number;
+  decimals?: number;
+}
+```
+
 ## DecimalField
+
+```ts
+interface DecimalFieldOptions {
+  type: 'decimal';
+  precision?: number;
+  scale?: number;
+}
+```
+
 ## DateField
+
+```ts
+interface DateFieldOptions {
+  type: 'date';
+}
+```
+
 ## TimeField
+
+```ts
+interface TimeFieldOptions {
+  type: 'time';
+}
+```
+
 ## JsonField
+
+```ts
+interface JsonFieldOptions {
+  type: 'json';
+}
+```
+
 ## JsonbField
+
+```ts
+interface JsonbFieldOptions {
+  type: 'jsonb';
+}
+```
+
 ## VirtualField
+
+```ts
+interface VirtualFieldOptions {
+  type: 'virtual';
+}
+```
+
 ## SortField
+
+```ts
+interface SortFieldOptions {
+  type: 'sort';
+}
+```
+
 ## PasswordField
+
+```ts
+interface PasswordFieldOptions {
+  type: 'password';
+}
+```
+
 ## RadioField
-## UidField
+
+```ts
+interface RadioFieldOptions {
+  type: 'radio';
+}
+```
+
+## UIDField
+
+```ts
+interface UIDFieldOptions {
+  type: 'uid';
+}
+```
+
+## UUIDField
+
+```ts
+interface UUIDFieldOptions {
+  type: 'uuid';
+}
+```
+
 ## CreatedByField
+
+```ts
+interface CreatedByFieldOptions {
+  type: 'createdBy';
+}
+```
+
 ## UpdatedByField
+
+```ts
+interface UpdatedByFieldOptions {
+  type: 'updatedBy';
+}
+```
diff --git a/docs/reference/operators.md b/docs/reference/operators.md
index 3888e2c40..3f94edac6 100644
--- a/docs/reference/operators.md
+++ b/docs/reference/operators.md
@@ -5,13 +5,16 @@ toc: menu
 # Operators
 
 ## string
-- includes
-- notIncludes
+
 - eq
 - ne
-- null
-- notNull
+- includes
+- notInclude
+- empty
+- notEmpty
+
 ## number
+
 - eq
 - ne
 - gt
@@ -19,32 +22,39 @@ toc: menu
 - lt
 - lte
 - between
-- null
-- notNull
+- empty
+- notEmpty
+
 ## select
+
 - eq
 - ne
 - in
 - notIn
-- null
-- notNull
+- empty
+- notEmpty
+
 ## multipleSelect
+
 - match
 - notMatch
 - anyOf
 - noneOf
-- null
-- notNull
+- empty
+- notEmpty
+
 ## date
+
 - dateOn
 - dateNotOn
 - dateBefore
 - dateAfter
 - dateNotBefore
 - dateNotAfter
-- null
-- notNull
+- empty
+- notEmpty
+
 ## association
-- fieldName.$name
+
 - exists
-- notExists
\ No newline at end of file
+- notExists