create-nkvs-mongoose-hono 1.0.2 → 1.0.3

package/README.md

@@ -1,6 +1,6 @@
 # Package
 
-The logic of this package is not yet perfect, but you can try using it.
+The logic of this package is not yet perfect, but you can try to use it.
 
 Once you start the project, you can open http://localhost:3000/static/compass (default port is 3000).
 
@@ -15,3 +15,167 @@ Once you start the project, you can open http://localhost:3000/static/compass (d
 - npm run dev
 - npm run build
 - npm run start
+
+### Global Middleware
+
+```JavaScript
+import { cors } from 'hono/cors'
+import { prettyJSON } from 'hono/pretty-json'
+
+const { globalMiddleware } = store.get('app')
+globalMiddleware.push(cors(), prettyJSON())
+```
+
+### Middleware
+
+```JavaScript
+const { middleware } = store.get('app')
+middleware['test'] = async function (context, next) {
+  console.log(1)
+  await next()
+}
+```
+
+### Global Middleware & Middleware / middleware/_import.js
+
+```JavaScript
+import './global.js'
+import './test.js'
+```
+
+### Global Middleware - Dev
+
+```JavaScript
+const { globalMiddleware } = store.get('_app')
+globalMiddleware['cors'] = 'cors.'
+globalMiddleware['prettyJSON'] = 'pretty JSON.'
+```
+
+### Middleware - Dev
+
+```JavaScript
+const { middleware } = store.get('_app')
+middleware['test'] = 'console log 1.'
+```
+
+### Global Middleware - Dev & Middleware - Dev / middleware/_import.dev.js
+
+```JavaScript
+import './global.dev.js'
+import './test.dev.js'
+```
+
+### Router
+
+```JavaScript
+store.get('app').routers.push({
+  path: '/apples',
+  crud: {
+    model: 'Apple',
+    findAll: { count: true, populate: 'color', limit: 5 }
+    findOne: { populate: 'color' }
+  },
+  events: {
+    'GET /test': { middleware: ['test'], async handler({ json }) { return json({}) } }
+  }
+)}
+```
+
+### Router / findAll
+
+Boolean or Object
+
+| Name       | Type                             | Example                                                      |
+| :--------- | :------------------------------- | :----------------------------------------------------------- |
+| middleware | Array-String                     | ['test']                                                     |
+| filter     | Object                           | { 'age[gte]': 18 }                                           |
+| fields     | String                           | 'name color' ✅, 'name -createdAt' ❌, '-createdAt -upadtedAt' ❌ |
+| sort       | String                           | '-createdAt'                                                 |
+| page       | Number                           | 1                                                            |
+| limit      | Number or Boolean                | false, 10, If number > 300 then number = 300                 |
+| populate   | String or Object or Array-Object | 'color', { path: 'color', select: 'name', populate: {} }, [{ path: 'color' }] |
+| count      | Boolean                          | true                                                         |
+
+### Router / findOne
+
+Boolean or Object
+
+| Name       | Type                             | Example                                                      |
+| :--------- | :------------------------------- | :----------------------------------------------------------- |
+| middleware | Array-String                     | ['test']                                                     |
+| filter     | Object                           | { 'age[gte]': 18 }                                           |
+| fields     | String                           | 'name color' ✅, 'name -createdAt' ❌, '-createdAt -upadtedAt' ❌ |
+| populate   | String or Object or Array-Object | 'color', { path: 'color', select: 'name', populate: {} }, [{ path: 'color' }] |
+
+### Router / create
+
+Boolean or Object
+
+| Name       | Type         | Example  |
+| :--------- | :----------- | :------- |
+| middleware | Array-String | ['test'] |
+
+### Router / update
+
+Boolean or Object
+
+| Name         | Type         | Example       |
+| :----------- | :----------- | :------------ |
+| middleware   | Array-String | ['test']      |
+| ignoreFields | Array        | ['active']    |
+| options      | Object       | { new: true } |
+
+### Router / remove
+
+Boolean or Object
+
+| Name       | Type         | Example  |
+| :--------- | :----------- | :------- |
+| middleware | Array-String | ['test'] |
+
+### Router / _import.js
+
+```JavaScript
+import './apples.js'
+```
+
+### Router - Dev
+
+```JavaScript
+store.get('_app').routers['/apples'] = {
+  description: 'Apple',
+  events: {
+    'GET /test': { description: 'Apple test interface.' }
+  }
+}
+```
+
+### Router - Dev / _import.dev.js
+
+```JavaScript
+import './apples.dev.js'
+```
+
+### Model
+
+```JavaScript
+store.get('app').models.Apple = {
+  collection: 'apples',
+  documentName: 'apple',
+  schema: {
+    name: { type: 'String', required: true },
+    color: { type: 'ObjectId', ref: 'Color' },
+  },
+  options: { timestamps: true, methods: {}, statics: {} },
+  middleware: [{ hook: 'pre', 'method': 'save', async handler(doc) {} }]
+}
+```
+
+### Model / _import.js
+
+```JavaScript
+import './Apple.js'
+import './Color.js'
+```
+
+For more details: [Mongoose](https://mongoosejs.com/) and [Hono](https://hono.dev/).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nkvs-mongoose-hono",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Create a mongoose-hono project.",
   "bin": {
     "create-nkvs-mongoose-hono": "index.js"