Auto-gen docs from v6.0.1

Author: pankajvaghela

apps/sequelize-guard-docs/content/docs/api.mdx

@@ -0,0 +1,102 @@
+---
+title: API Reference
+description: Complete API reference for sequelize-guard
+icon: ShieldCheck
+---
+
+**sequelize-guard v6.0.1**
+
+***
+
+# sequelize-guard v6.0.1
+
+SequelizeGuard - Authorization Library for Sequelize
+
+## Classes
+
+- [SequelizeGuard](./classes/SequelizeGuard.mdx)
+
+## Interfaces
+
+- [RoleCreationResult](./interfaces/RoleCreationResult.mdx)
+- [AddPermsToRoleResult](./interfaces/AddPermsToRoleResult.mdx)
+- [RemovePermsFromRoleResult](./interfaces/RemovePermsFromRoleResult.mdx)
+- [CreatePermsOptions](./interfaces/CreatePermsOptions.mdx)
+- [CreateRolesOptions](./interfaces/CreateRolesOptions.mdx)
+- [FindRolesArgs](./interfaces/FindRolesArgs.mdx)
+- [FindPermsArgs](./interfaces/FindPermsArgs.mdx)
+- [BulkPermissionInput](./interfaces/BulkPermissionInput.mdx)
+- [PermissionData](./interfaces/PermissionData.mdx)
+- [RoleData](./interfaces/RoleData.mdx)
+- [GuardOptions](./interfaces/GuardOptions.mdx)
+- [GuardInternalOptions](./interfaces/GuardInternalOptions.mdx)
+
+## Type Aliases
+
+- [RoleCreationParam](./type-aliases/RoleCreationParam.mdx)
+- [GuardEventCallback](./type-aliases/GuardEventCallback.mdx)
+- [UnsubscribeFn](./type-aliases/UnsubscribeFn.mdx)
+
+## Variables
+
+### migration
+
+> **migration**: `object`
+
+Defined in: [migrations/guard-migrations.ts:108](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/migrations/guard-migrations.ts#L108)
+
+#### Type Declaration
+
+##### up()
+
+> **up**: (`queryInterface`, `_Sequelize`, `options`) => `Promise`\<`void`\>
+
+Run migrations to create Guard tables
+
+###### Parameters
+
+###### queryInterface
+
+`QueryInterface`
+
+###### \_Sequelize
+
+`Sequelize`
+
+###### options
+
+[`GuardOptions`](./interfaces/GuardOptions.mdx) = `{}`
+
+###### Returns
+
+`Promise`\<`void`\>
+
+##### down()
+
+> **down**: (`queryInterface`, `_Sequelize`, `options`) => `Promise`\<`void`\>
+
+Rollback migrations - drop Guard tables
+
+###### Parameters
+
+###### queryInterface
+
+`QueryInterface`
+
+###### \_Sequelize
+
+`Sequelize`
+
+###### options
+
+[`GuardOptions`](./interfaces/GuardOptions.mdx) = `{}`
+
+###### Returns
+
+`Promise`\<`void`\>
+
+## References
+
+### default
+
+Renames and re-exports [SequelizeGuard](./classes/SequelizeGuard.mdx)

apps/sequelize-guard-docs/content/docs/api/classes/SequelizeGuard.mdx

@@ -0,0 +1,31 @@
+---
+title: "Interface: AddPermsToRoleResult"
+---
+
+[**sequelize-guard v6.0.1**](../index.mdx)
+
+***
+
+[sequelize-guard](../index.mdx) / AddPermsToRoleResult
+
+# Interface: AddPermsToRoleResult
+
+Defined in: [types/api.ts:19](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L19)
+
+Result from adding permissions to role
+
+## Properties
+
+### role
+
+> **role**: `GuardRoleModel`
+
+Defined in: [types/api.ts:20](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L20)
+
+***
+
+### permissions
+
+> **permissions**: `GuardPermissionModel`[]
+
+Defined in: [types/api.ts:21](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L21)

apps/sequelize-guard-docs/content/docs/api/index.mdx

@@ -0,0 +1,39 @@
+---
+title: "Interface: BulkPermissionInput"
+---
+
+[**sequelize-guard v6.0.1**](../index.mdx)
+
+***
+
+[sequelize-guard](../index.mdx) / BulkPermissionInput
+
+# Interface: BulkPermissionInput
+
+Defined in: [types/api.ts:74](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L74)
+
+Bulk permission creation input
+
+## Properties
+
+### resource
+
+> **resource**: `string`
+
+Defined in: [types/api.ts:75](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L75)
+
+***
+
+### actions
+
+> **actions**: `string` \| `string`[]
+
+Defined in: [types/api.ts:76](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L76)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [types/api.ts:77](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L77)

apps/sequelize-guard-docs/content/docs/api/interfaces/AddPermsToRoleResult.mdx

@@ -0,0 +1,47 @@
+---
+title: "Interface: CreatePermsOptions"
+---
+
+[**sequelize-guard v6.0.1**](../index.mdx)
+
+***
+
+[sequelize-guard](../index.mdx) / CreatePermsOptions
+
+# Interface: CreatePermsOptions
+
+Defined in: [types/api.ts:36](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L36)
+
+Options for creating permissions
+
+## Properties
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [types/api.ts:37](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L37)
+
+***
+
+### names?
+
+> `optional` **names**: `string`[]
+
+Defined in: [types/api.ts:38](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L38)
+
+***
+
+### all?
+
+> `optional` **all**: `boolean`
+
+Defined in: [types/api.ts:39](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L39)
+
+***
+
+### json?
+
+> `optional` **json**: `boolean`
+
+Defined in: [types/api.ts:40](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L40)

apps/sequelize-guard-docs/content/docs/api/interfaces/BulkPermissionInput.mdx

@@ -0,0 +1,31 @@
+---
+title: "Interface: CreateRolesOptions"
+---
+
+[**sequelize-guard v6.0.1**](../index.mdx)
+
+***
+
+[sequelize-guard](../index.mdx) / CreateRolesOptions
+
+# Interface: CreateRolesOptions
+
+Defined in: [types/api.ts:46](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L46)
+
+Options for creating roles
+
+## Properties
+
+### json?
+
+> `optional` **json**: `boolean`
+
+Defined in: [types/api.ts:47](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L47)
+
+***
+
+### all?
+
+> `optional` **all**: `boolean`
+
+Defined in: [types/api.ts:48](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L48)

apps/sequelize-guard-docs/content/docs/api/interfaces/CreatePermsOptions.mdx

@@ -0,0 +1,47 @@
+---
+title: "Interface: FindPermsArgs"
+---
+
+[**sequelize-guard v6.0.1**](../index.mdx)
+
+***
+
+[sequelize-guard](../index.mdx) / FindPermsArgs
+
+# Interface: FindPermsArgs
+
+Defined in: [types/api.ts:64](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L64)
+
+Arguments for finding permissions
+
+## Properties
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [types/api.ts:65](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L65)
+
+***
+
+### resource?
+
+> `optional` **resource**: `string`
+
+Defined in: [types/api.ts:66](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L66)
+
+***
+
+### action?
+
+> `optional` **action**: `string`
+
+Defined in: [types/api.ts:67](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L67)
+
+***
+
+### search?
+
+> `optional` **search**: `boolean`
+
+Defined in: [types/api.ts:68](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L68)

apps/sequelize-guard-docs/content/docs/api/interfaces/CreateRolesOptions.mdx

@@ -0,0 +1,47 @@
+---
+title: "Interface: FindRolesArgs"
+---
+
+[**sequelize-guard v6.0.1**](../index.mdx)
+
+***
+
+[sequelize-guard](../index.mdx) / FindRolesArgs
+
+# Interface: FindRolesArgs
+
+Defined in: [types/api.ts:54](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L54)
+
+Arguments for finding roles
+
+## Properties
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [types/api.ts:55](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L55)
+
+***
+
+### names?
+
+> `optional` **names**: `string`[]
+
+Defined in: [types/api.ts:56](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L56)
+
+***
+
+### search?
+
+> `optional` **search**: `boolean`
+
+Defined in: [types/api.ts:57](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L57)
+
+***
+
+### withParent?
+
+> `optional` **withParent**: `boolean`
+
+Defined in: [types/api.ts:58](https://github.com/lotivo/sequelize-guard/blob/a09a0c94502546a7feeb95441ce15b47b8a10ac5/packages/sequelize-guard/src/types/api.ts#L58)