feat(rest): add simple rest documentation (#81)

tenseijs · Mar 4, 2021 · 8f30635 · 8f30635
1 parent 40e35d0
commit 8f30635
Show file tree

Hide file tree

Showing 57 changed files with 3,215 additions and 2,038 deletions.
diff --git a/examples/blog/index.js b/examples/blog/index.js
@@ -68,7 +68,6 @@ tensei()
     ])
     .databaseConfig({
         type: 'sqlite',
-        debug: true,
         dbName: 'tensei'
     })
     .start()

diff --git a/examples/blog/package.json b/examples/blog/package.json
@@ -14,7 +14,7 @@
         "marked": "^2.0.1"
     },
     "scripts": {
-        "example:dev": "nodemon src/index"
+        "example:dev": "nodemon --watch node_modules/ src/index"
     },
     "devDependencies": {
         "nodemon": "^2.0.7"

diff --git a/packages/auth/src/index.ts b/packages/auth/src/index.ts
diff --git a/packages/cms/detail/ID/ID.tsx b/packages/cms/detail/ID/ID.tsx
@@ -3,12 +3,10 @@ import { DetailComponentProps } from '@tensei/components'
 
 import Text from '../Text'
 
-const ID: React.FC<
-    DetailComponentProps & {
-        className?: string
-        onClick?: EventHandler<SyntheticEvent<HTMLParagraphElement>>
-    }
-> = ({ value, values, field, resource, className = '' }) => {
+const ID: React.FC<DetailComponentProps & {
+    className?: string
+    onClick?: EventHandler<SyntheticEvent<HTMLParagraphElement>>
+}> = ({ value, values, field, resource, className = '' }) => {
     return (
         <>
             <Text

diff --git a/packages/cms/form/ManyToMany/ManyToMany.tsx b/packages/cms/form/ManyToMany/ManyToMany.tsx
@@ -9,11 +9,9 @@ import {
     Pulse
 } from '@tensei/components'
 
-const ManyToMany: React.FC<
-    FormComponentProps & {
-        customQuery?: (parameters: AbstractData) => AbstractData
-    }
-> = ({
+const ManyToMany: React.FC<FormComponentProps & {
+    customQuery?: (parameters: AbstractData) => AbstractData
+}> = ({
     field,
     name,
     id,

diff --git a/packages/cms/index/ID/ID.tsx b/packages/cms/index/ID/ID.tsx
@@ -5,11 +5,9 @@ import IDDetail from '../../detail/ID'
 
 import { IndexComponentProps } from '@tensei/components'
 
-const ID: React.FC<
-    IndexComponentProps & {
-        noLink?: boolean
-    }
-> = ({ value, values, field, resource, noLink }) => {
+const ID: React.FC<IndexComponentProps & {
+    noLink?: boolean
+}> = ({ value, values, field, resource, noLink }) => {
     const detail = (
         <IDDetail
             value={value}

diff --git a/packages/cms/pages/ResourceDetail/ResourceDetail.tsx b/packages/cms/pages/ResourceDetail/ResourceDetail.tsx
@@ -18,12 +18,10 @@ import PageWrapper from '../../components/PageWrapper'
 
 export interface ResourceDetailProps {}
 
-const ResourceDetail: React.FC<
-    ResourceDetailProps &
-        RouteComponentProps<{
-            id: string
-        }>
-> = () => {
+const ResourceDetail: React.FC<ResourceDetailProps &
+    RouteComponentProps<{
+        id: string
+    }>> = () => {
     const history = useHistory()
     const [data, setData] = useState<any>({})
     const [loading, setLoading] = useState(true)

diff --git a/packages/cms/plugin/index.ts b/packages/cms/plugin/index.ts
@@ -343,7 +343,9 @@ class CmsPlugin {
     private permissionResource() {
         return resource(this.config.permissionResource)
             .fields([
-                text('Name').searchable().rules('required'),
+                text('Name')
+                    .searchable()
+                    .rules('required'),
                 text('Slug')
                     .rules('required')
                     .unique()
@@ -388,7 +390,9 @@ class CmsPlugin {
                     .sortable()
                     .searchable()
                     .rules('required'),
-                text('Description').nullable().rules('max:255'),
+                text('Description')
+                    .nullable()
+                    .rules('max:255'),
                 belongsToMany(this.config.userResource),
                 belongsToMany(this.config.permissionResource).owner()
             ])
@@ -573,7 +577,6 @@ class CmsPlugin {
                         const path = route.config.path.startsWith('/')
                             ? route.config.path
                             : `/${route.config.path}`
-
                         ;(this.router as any)[route.config.type.toLowerCase()](
                             path,
 

diff --git a/packages/common/src/api/Route.ts b/packages/common/src/api/Route.ts
@@ -3,6 +3,7 @@ import {
     RouteConfig,
     AuthorizeFunction,
     RouteContract,
+    RouteParameter,
     ResourceContract,
     RouteExtendContract
 } from '@tensei/common'
@@ -17,13 +18,31 @@ export class Route implements RouteContract {
         name: '',
         cms: false,
         type: 'GET',
+        group: 'Misc',
+        groupSlug: 'misc',
         internal: false,
         middleware: [],
+        parameters: [],
         snakeCaseName: '',
         paramCaseName: '',
         authorize: [],
+        description: '',
         handler: async () => {},
-        extend: {}
+        extend: {},
+        sampleRequest: '',
+        sampleResponse: ''
+    }
+
+    sampleRequest(sample: string) {
+        this.config.sampleRequest = sample
+
+        return this
+    }
+
+    sampleResponse(sample: string) {
+        this.config.sampleResponse = sample
+
+        return this
     }
 
     constructor(name?: string) {
@@ -36,6 +55,25 @@ export class Route implements RouteContract {
         this.config.snakeCaseName = snakeCase(name)
     }
 
+    group(name: string) {
+        this.config.group = name
+        this.config.groupSlug = paramCase(name)
+
+        return this
+    }
+
+    parameters(parameters: RouteParameter[]) {
+        this.config.parameters = [...this.config.parameters, ...parameters]
+
+        return this
+    }
+
+    description(description: string) {
+        this.config.description = description
+
+        return this
+    }
+
     path(path: string) {
         this.config.path = path.startsWith('/') ? path.substring(1) : path
 
@@ -119,6 +157,42 @@ export class Route implements RouteContract {
 
         return this
     }
+
+    serialize() {
+        const {
+            id,
+            path,
+            name,
+            type,
+            snakeCaseName,
+            middleware,
+            paramCaseName,
+            authorize,
+            group,
+            groupSlug,
+            parameters,
+            description,
+            sampleRequest,
+            sampleResponse
+        } = this.config
+
+        return {
+            id,
+            path,
+            name,
+            type,
+            group,
+            groupSlug,
+            parameters,
+            description,
+            snakeCaseName,
+            paramCaseName,
+            sampleRequest,
+            sampleResponse,
+            middleware: middleware.length,
+            authorize: authorize.length
+        }
+    }
 }
 
 export const route = (name?: string) => new Route(name)
diff --git a/packages/common/src/fields/Number.ts b/packages/common/src/fields/Number.ts
@@ -16,6 +16,7 @@ export class NumberField extends Text {
         this.htmlAttributes({
             type: 'number'
         })
+        this.rules('number')
     }
 
     /**

diff --git a/packages/common/src/fields/Select.ts b/packages/common/src/fields/Select.ts
@@ -21,6 +21,8 @@ export class Select extends Field {
         this.defaultFormValue('')
         this.property.enum = true
         this.property.items = []
+
+        this.rules('string')
     }
 
     /**
@@ -41,6 +43,8 @@ export class Select extends Field {
 
         this.property.items = this.selectOptions.map(option => option.value)
 
+        this.rules(`in:${this.property.items.join(',')}`)
+
         return this
     }
 

diff --git a/packages/common/src/fields/Text.ts b/packages/common/src/fields/Text.ts
@@ -19,6 +19,7 @@ export class Text extends Field {
         super(name, databaseField)
 
         this.defaultFormValue('')
+        this.rules('string')
         this.property.columnTypes = ['varchar(255)']
     }
 

diff --git a/packages/common/src/fields/Textarea.ts b/packages/common/src/fields/Textarea.ts
@@ -12,6 +12,7 @@ export class Textarea extends Text {
     public constructor(name: string, databaseField?: string) {
         super(name, databaseField)
 
+        this.rules('string')
         this.property.columnTypes = ['text']
         this.hideOnIndex()
     }

diff --git a/packages/common/src/fields/Timestamp.ts b/packages/common/src/fields/Timestamp.ts
@@ -27,6 +27,8 @@ export class Timestamp extends DateField {
         this.property.columnTypes = ['timestamp']
         this.property.reference = ReferenceType.SCALAR
 
+        this.rules('date')
+
         this.defaultFormValue(Dayjs().format(this.config.dateFormat))
     }
 

diff --git a/packages/common/typings/config.d.ts b/packages/common/typings/config.d.ts
@@ -59,12 +59,18 @@ declare module '@tensei/common/config' {
         delete(): this
         internal(): this
         id(id: string): this
+        group(name: string): this
+        description(description: string): this
+        sampleRequest(sample: string): this
+        sampleResponse(sample: string): this
+        parameters(parameters: RouteParameter[]): this
         extend(extend: RouteExtendContract): this
         resource(resource: ResourceContract): this
         middleware(middleware: RequestHandler[]): this
         resource(resource: ResourceContract): this
         authorize(authorize: AuthorizeFunction): this
         handle(handler: RouteConfig['handler']): this
+        serialize(): DataPayload
     }
 
     interface UtilsContract {
@@ -128,15 +134,29 @@ declare module '@tensei/common/config' {
         middleware(...middleware: GraphQlMiddleware[]): this
     }
 
+    interface RouteParameter {
+        name: string
+        type: string | number
+        description: string
+        validation?: string[]
+        in: 'header' | 'body' | 'query' | 'path'
+    }
+
     interface RouteConfig {
         path: string
         name: string
         cms: boolean
         internal: boolean
         id: string
+        group: string
+        groupSlug: string
+        sampleRequest: string
+        sampleResponse: string
+        parameters: RouteParameter[]
         type: EndpointTypes
         snakeCaseName: string
         paramCaseName: string
+        description: string
         resource?: ResourceContract
         middleware: RequestHandler[]
         authorize: AuthorizeFunction[]

diff --git a/packages/components/src/Button/Button.tsx b/packages/components/src/Button/Button.tsx
@@ -62,33 +62,28 @@ const Button: React.FC<ButtonProps> = ({
     }
 
     if (clear) {
-        props.className = `font-bold h-9 flex items-center ${
-            props.className || ''
-        } ${classes.clear}`
+        props.className = `font-bold h-9 flex items-center ${props.className ||
+            ''} ${classes.clear}`
     }
 
     if (primary) {
-        props.className = `font-bold h-9 flex items-center ${
-            props.className || ''
-        } ${classes.primary}`
+        props.className = `font-bold h-9 flex items-center ${props.className ||
+            ''} ${classes.primary}`
     }
 
     if (danger) {
-        props.className = `font-bold h-9 flex items-center ${
-            props.className || ''
-        } ${classes.danger}`
+        props.className = `font-bold h-9 flex items-center ${props.className ||
+            ''} ${classes.danger}`
     }
 
     if (success) {
-        props.className = `font-bold h-9 flex items-center ${
-            props.className || ''
-        } ${classes.success}`
+        props.className = `font-bold h-9 flex items-center ${props.className ||
+            ''} ${classes.success}`
     }
 
     if (secondary) {
-        props.className = `font-bold h-9 flex items-center ${
-            props.className || ''
-        } ${classes.secondary}`
+        props.className = `font-bold h-9 flex items-center ${props.className ||
+            ''} ${classes.secondary}`
     }
 
     return (

diff --git a/packages/components/src/Checkbox/Checkbox.tsx b/packages/components/src/Checkbox/Checkbox.tsx
@@ -57,9 +57,8 @@ const Checkbox: React.FC<CheckboxProps> = ({
             <input
                 {...props}
                 disabled={disabled}
-                className={`rounded-sm border border-tensei-gray-500 ${
-                    checkboxClassName || ''
-                } ${disabled ? 'opacity-80 cursor-not-allowed' : ''}`}
+                className={`rounded-sm border border-tensei-gray-500 ${checkboxClassName ||
+                    ''} ${disabled ? 'opacity-80 cursor-not-allowed' : ''}`}
             />
 
             {error ? (

diff --git a/packages/components/src/Modal/Modal.tsx b/packages/components/src/Modal/Modal.tsx
@@ -81,9 +81,8 @@ const Modal: React.FC<ModalProps> = ({
                                 aria-labelledby="modal-headline"
                                 className={`inline-block bg-white rounded-lg ${
                                     noPadding ? '' : 'px-4 pt-5 pb-4 sm:p-6'
-                                } text-left overflow-visible shadow-xl transform transition-all w-full ${
-                                    className || ''
-                                }`}
+                                } text-left overflow-visible shadow-xl transform transition-all w-full ${className ||
+                                    ''}`}
                             >
                                 {title ? (
                                     <div className="w-full flex py-5 px-8 justify-between border-b border-tensei-gray-500">

diff --git a/packages/core/Tensei.ts b/packages/core/Tensei.ts
@@ -301,7 +301,6 @@ export class Tensei implements TenseiContract {
             const path = route.config.path.startsWith('/')
                 ? route.config.path
                 : `/${route.config.path}`
-
             ;(this.app as any)[route.config.type.toLowerCase()](
                 path,
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ export class NumberField extends Text { @@
             this.htmlAttributes({
                 type: 'number'
             })
+            this.rules('number')
         }
         /**
@@ Expand Down @@