@innet/server 2.0.0-beta.6 → 2.0.0-beta.7

package/README.md

@@ -1556,6 +1556,34 @@ export default (
 )
 ```
 
+#### group
+
+You can organize tags into groups using the `group` property.
+This adds tag groups support to the OpenAPI specification,
+which is displayed in documentation viewers.
+
+*src/app.tsx*
+```typescript jsx
+export default (
+  <server>
+    <api>
+      <tag group='Authentication' name='auth'>
+        <endpoint method='post' path='/login' />
+        <endpoint method='post' path='/logout' />
+      </tag>
+      <tag group='Users' name='users'>
+        <endpoint method='get' path='/users' />
+        <endpoint method='post' path='/users' />
+      </tag>
+    </api>
+  </server>
+)
+```
+
+This will create tag groups in your OpenAPI documentation:
+- **Authentication** group containing the `auth` tag
+- **Users** group containing the `users` tag
+
 ### \<param>
 
 [← back](#endpoints)

package/index.es6.js

@@ -49,7 +49,7 @@ export { preset } from './plugins/main/preset/preset.es6.js';
 export { response, statuses } from './plugins/main/response/response.es6.js';
 export { returnPlugin } from './plugins/main/return/return.es6.js';
 export { server } from './plugins/main/server/server.es6.js';
-export { tag } from './plugins/main/tag/tag.es6.js';
+export { TAG_GROUP_NAME, tag } from './plugins/main/tag/tag.es6.js';
 export { variable } from './plugins/main/variable/variable.es6.js';
 export { cms } from './plugins/request/cms/cms.es6.js';
 export { cookie } from './plugins/request/cookie/cookie.es6.js';

package/index.js

@@ -196,6 +196,7 @@ exports.response = response.response;
 exports.statuses = response.statuses;
 exports.returnPlugin = _return.returnPlugin;
 exports.server = server.server;
+exports.TAG_GROUP_NAME = tag.TAG_GROUP_NAME;
 exports.tag = tag.tag;
 exports.variable = variable.variable;
 exports.cms = cms.cms;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@innet/server",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0-beta.7",
   "description": "Create server-side application with innet",
   "main": "index.js",
   "module": "index.es6.js",

package/plugins/main/tag/index.es6.js

@@ -1 +1 @@
-export { tag } from './tag.es6.js';
+export { TAG_GROUP_NAME, tag } from './tag.es6.js';

package/plugins/main/tag/index.js

@@ -6,4 +6,5 @@ var tag = require('./tag.js');
 
 
 
+exports.TAG_GROUP_NAME = tag.TAG_GROUP_NAME;
 exports.tag = tag.tag;

package/plugins/main/tag/tag.d.ts

@@ -1,4 +1,9 @@
 import { type HandlerPlugin } from 'innet';
+export interface TagGroup {
+    name: string;
+    tags: string[];
+}
+export declare const TAG_GROUP_NAME = "x-tagGroups";
 export interface TagProps {
     children?: any;
     /**
@@ -6,7 +11,9 @@ export interface TagProps {
      * [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
      * */
     description?: string;
-    /** The name of the tag. */
+    /** A name of the tag group. */
+    group?: string;
+    /** A name of the tag. */
     name: string;
 }
 export declare const tag: HandlerPlugin;

package/plugins/main/tag/tag.es6.js

@@ -4,11 +4,12 @@ import '../../../hooks/index.es6.js';
 import { tagContext } from '../../../hooks/useTag/useTag.es6.js';
 import { useApi } from '../../../hooks/useApi/useApi.es6.js';
 
+const TAG_GROUP_NAME = 'x-tagGroups';
 const tag = () => {
     if (useContext(tagContext)) {
         throw Error('You cannot use a <tag> inside another one');
     }
-    const { children, description, name, } = useProps();
+    const { children, description, group, name, } = useProps();
     const { docs } = useApi();
     const tag = { name };
     if (description) {
@@ -23,9 +24,25 @@ const tag = () => {
     else {
         throw Error(`You cannot use two tags with the same name (${name})`);
     }
+    if (group) {
+        if (docs[TAG_GROUP_NAME]) {
+            const groups = docs[TAG_GROUP_NAME];
+            const tagGroup = groups.find(({ name }) => name === group);
+            if (tagGroup) {
+                tagGroup.tags.push(name);
+            }
+            else {
+                groups.push({ name: group, tags: [name] });
+            }
+        }
+        else {
+            // @ts-expect-error Custom field
+            docs[TAG_GROUP_NAME] = [{ name: group, tags: [name] }];
+        }
+    }
     const handler = useNewHandler();
     handler[tagContext.key] = tag;
     innet(children, handler);
 };
 
-export { tag };
+export { TAG_GROUP_NAME, tag };

package/plugins/main/tag/tag.js

@@ -8,11 +8,12 @@ require('../../../hooks/index.js');
 var useTag = require('../../../hooks/useTag/useTag.js');
 var useApi = require('../../../hooks/useApi/useApi.js');
 
+const TAG_GROUP_NAME = 'x-tagGroups';
 const tag = () => {
     if (jsx.useContext(useTag.tagContext)) {
         throw Error('You cannot use a <tag> inside another one');
     }
-    const { children, description, name, } = jsx.useProps();
+    const { children, description, group, name, } = jsx.useProps();
     const { docs } = useApi.useApi();
     const tag = { name };
     if (description) {
@@ -27,9 +28,26 @@ const tag = () => {
     else {
         throw Error(`You cannot use two tags with the same name (${name})`);
     }
+    if (group) {
+        if (docs[TAG_GROUP_NAME]) {
+            const groups = docs[TAG_GROUP_NAME];
+            const tagGroup = groups.find(({ name }) => name === group);
+            if (tagGroup) {
+                tagGroup.tags.push(name);
+            }
+            else {
+                groups.push({ name: group, tags: [name] });
+            }
+        }
+        else {
+            // @ts-expect-error Custom field
+            docs[TAG_GROUP_NAME] = [{ name: group, tags: [name] }];
+        }
+    }
     const handler = innet.useNewHandler();
     handler[useTag.tagContext.key] = tag;
     innet.innet(children, handler);
 };
 
+exports.TAG_GROUP_NAME = TAG_GROUP_NAME;
 exports.tag = tag;