@innet/server 2.0.0-alpha.9 → 2.0.0-beta.10

package/plugins/main/body/body.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var innet = require('innet');
 var jsx = require('@innet/jsx');
-var utils = require('@innet/utils');
 var constants = require('../../../constants.js');
 require('../../../hooks/index.js');
 require('../../../utils/index.js');
@@ -13,10 +12,7 @@ var useSchemaContext = require('../../../hooks/useSchemaContext/useSchemaContext
 var getOrAdd = require('../../../utils/getOrAdd/getOrAdd.js');
 var useBodyFile = require('../../../hooks/useBodyFile/useBodyFile.js');
 var useRule = require('../../../hooks/useRule/useRule.js');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var innet__default = /*#__PURE__*/_interopDefaultLegacy(innet);
+var useEffect = require('../../../hooks/useEffect/useEffect.js');
 
 const body = () => {
     const endpoint = jsx.useContext(useEndpoint.endpointContext);
@@ -47,8 +43,8 @@ const body = () => {
     useRule.ruleContext.set(handler, rule => {
         rules.body = rule;
     });
-    innet__default["default"](children, handler);
-    innet__default["default"](() => {
+    innet.innet(children, handler);
+    useEffect.useEffect(() => {
         if (fileUsed) {
             requestBody.content['multipart/form-data'] = { schema };
         }
@@ -57,7 +53,7 @@ const body = () => {
                 requestBody.content[type] = { schema };
             }
         }
-    }, utils.callHandler);
+    });
 };
 
 exports.body = body;

package/plugins/main/contact/contact.d.ts

@@ -1,10 +1,10 @@
 import { type HandlerPlugin } from 'innet';
 export interface ContactProps {
+    /** The email address of the contact person/organization. This MUST be in the form of an email address. */
+    email?: string;
     /** The identifying name of the contact person/organization. */
     name?: string;
     /** The URL pointing to the contact information. This MUST be in the form of a URL. */
     url?: string;
-    /** The email address of the contact person/organization. This MUST be in the form of an email address. */
-    email?: string;
 }
 export declare const contact: HandlerPlugin;

package/plugins/main/endpoint/endpoint.d.ts

@@ -1,10 +1,27 @@
 import { type HandlerPlugin } from 'innet';
 import { type EndpointsMethods } from '../../../types';
 export interface EndpointProps {
+    children?: any;
+    /**
+     * Declares this operation to be deprecated.
+     * Consumers SHOULD refrain from usage of the declared operation.
+     * Default value is false.
+     * */
+    deprecated?: boolean;
+    /**
+     * An optional, string description, intended to apply to all operations in this path.
+     * [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
+     * */
+    description?: string;
     /**
      * A method of the endpoint.
      * */
     method: EndpointsMethods;
+    /**
+     * `operationId` is an optional unique string used to identify an operation.
+     * If provided, these IDs must be unique among all operations described in your API.
+     * */
+    operationId?: string;
     /**
      * A relative path to an individual endpoint.
      * The property MUST begin with a forward slash (/).
@@ -13,25 +30,14 @@ export interface EndpointProps {
      * Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical.
      * */
     path: string;
-    /**
-     * An optional, string summary, intended to apply to all operations in this path.
-     * */
-    summary?: string;
-    /**
-     * An optional, string description, intended to apply to all operations in this path.
-     * [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
-     * */
-    description?: string;
-    /**
-     * Declares this operation to be deprecated.
-     * Consumers SHOULD refrain from usage of the declared operation.
-     * Default value is false.
-     * */
-    deprecated?: boolean;
     /**
      * Declares this operation to make an endpoint private.
      * That means the endpoint should not be described and will not be shown in the Open API documentation.
      * */
     private?: boolean;
+    /**
+     * An optional, string summary, intended to apply to all operations in this path.
+     * */
+    summary?: string;
 }
 export declare const endpoint: HandlerPlugin;

package/plugins/main/endpoint/endpoint.es6.js

@@ -1,30 +1,32 @@
-import innet, { useNewHandler } from 'innet';
-import { useProps, useChildren } from '@innet/jsx';
+import { useNewHandler, innet } from 'innet';
+import { useProps } from '@innet/jsx';
 import '../../../hooks/index.es6.js';
 import '../../../utils/index.es6.js';
 import { useTag } from '../../../hooks/useTag/useTag.es6.js';
 import { useApi } from '../../../hooks/useApi/useApi.es6.js';
 import { getEndpoint } from '../../../utils/getEndpoint/getEndpoint.es6.js';
 import { endpointContext } from '../../../hooks/useEndpoint/useEndpoint.es6.js';
+import { serverPlugins } from '../../../hooks/useServerPlugins/useServerPlugins.es6.js';
 
 const endpoint = () => {
     const handler = useNewHandler();
     const tag = useTag();
-    const { docs, endpoints } = useApi();
     const props = useProps();
-    const { path, summary, description, deprecated, method, private: privateMode } = props;
-    const children = useChildren();
+    const { docs, endpoints, } = useApi();
+    const { children, deprecated, description, method, operationId, path, private: privateMode, summary, } = props;
     const { paths } = docs;
     if (!paths)
         throw Error('cannot find paths in docs');
     if (!paths[path]) {
         paths[path] = {};
     }
-    // @ts-expect-error: it's always an object
     if (paths[path][method]) {
         throw Error(`You cannot use the same endpoints ${method}:${path}`);
     }
     const operation = {};
+    if (operationId) {
+        operation.operationId = operationId;
+    }
     if (summary) {
         operation.summary = summary;
     }
@@ -38,16 +40,16 @@ const endpoint = () => {
         operation.tags = [tag.name];
     }
     if (!privateMode) {
-        // @ts-expect-error: it's always an object
         paths[path][method] = operation;
     }
     if (!endpoints[method]) {
-        endpoints[method] = { key: '' };
+        endpoints[method] = { key: '', plugins: new Set() };
     }
-    // @ts-expect-error: it's always an object
     const endpoint = getEndpoint(path, endpoints[method]);
     // @ts-expect-error: it's always an object
-    endpointContext.set(handler, { operation, props, endpoint });
+    endpointContext.set(handler, { endpoint, operation, props });
+    // @ts-expect-error: it's always an object
+    serverPlugins.set(handler, endpoint.plugins);
     innet(children, handler);
 };
 

package/plugins/main/endpoint/endpoint.js

@@ -10,29 +10,27 @@ var useTag = require('../../../hooks/useTag/useTag.js');
 var useApi = require('../../../hooks/useApi/useApi.js');
 var getEndpoint = require('../../../utils/getEndpoint/getEndpoint.js');
 var useEndpoint = require('../../../hooks/useEndpoint/useEndpoint.js');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var innet__default = /*#__PURE__*/_interopDefaultLegacy(innet);
+var useServerPlugins = require('../../../hooks/useServerPlugins/useServerPlugins.js');
 
 const endpoint = () => {
     const handler = innet.useNewHandler();
     const tag = useTag.useTag();
-    const { docs, endpoints } = useApi.useApi();
     const props = jsx.useProps();
-    const { path, summary, description, deprecated, method, private: privateMode } = props;
-    const children = jsx.useChildren();
+    const { docs, endpoints, } = useApi.useApi();
+    const { children, deprecated, description, method, operationId, path, private: privateMode, summary, } = props;
     const { paths } = docs;
     if (!paths)
         throw Error('cannot find paths in docs');
     if (!paths[path]) {
         paths[path] = {};
     }
-    // @ts-expect-error: it's always an object
     if (paths[path][method]) {
         throw Error(`You cannot use the same endpoints ${method}:${path}`);
     }
     const operation = {};
+    if (operationId) {
+        operation.operationId = operationId;
+    }
     if (summary) {
         operation.summary = summary;
     }
@@ -46,17 +44,17 @@ const endpoint = () => {
         operation.tags = [tag.name];
     }
     if (!privateMode) {
-        // @ts-expect-error: it's always an object
         paths[path][method] = operation;
     }
     if (!endpoints[method]) {
-        endpoints[method] = { key: '' };
+        endpoints[method] = { key: '', plugins: new Set() };
     }
-    // @ts-expect-error: it's always an object
     const endpoint = getEndpoint.getEndpoint(path, endpoints[method]);
     // @ts-expect-error: it's always an object
-    useEndpoint.endpointContext.set(handler, { operation, props, endpoint });
-    innet__default["default"](children, handler);
+    useEndpoint.endpointContext.set(handler, { endpoint, operation, props });
+    // @ts-expect-error: it's always an object
+    useServerPlugins.serverPlugins.set(handler, endpoint.plugins);
+    innet.innet(children, handler);
 };
 
 exports.endpoint = endpoint;

package/plugins/main/host/host.d.ts

@@ -1,5 +1,10 @@
 import { type HandlerPlugin } from 'innet';
 export interface HostProps {
+    /**
+     * An optional string describing the host designated by the URL.
+     * [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
+     * */
+    description?: string;
     /**
      * A URL to the target host.
      * This URL supports Server Variables and MAY be relative,
@@ -7,10 +12,5 @@ export interface HostProps {
      * Variable substitutions will be made when a variable is named in {brackets}.
      * */
     url: string;
-    /**
-     * An optional string describing the host designated by the URL.
-     * [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
-     * */
-    description?: string;
 }
 export declare const host: HandlerPlugin;

package/plugins/main/host/host.es6.js

@@ -1,4 +1,4 @@
-import innet, { useNewHandler } from 'innet';
+import { useNewHandler, innet } from 'innet';
 import { useProps, useChildren, useContext } from '@innet/jsx';
 import '../../../hooks/index.es6.js';
 import { useApi } from '../../../hooks/useApi/useApi.es6.js';
@@ -16,7 +16,9 @@ const host = () => {
         target.servers = [];
     }
     const { servers } = operation || docs;
-    const server = Object.assign({}, props);
+    const server = {
+        ...props,
+    };
     // @ts-expect-error: FIXME
     servers.push(server);
     handler[hostContext.key] = { server };

package/plugins/main/host/host.js

@@ -9,10 +9,6 @@ var useApi = require('../../../hooks/useApi/useApi.js');
 var useEndpoint = require('../../../hooks/useEndpoint/useEndpoint.js');
 var useHost = require('../../../hooks/useHost/useHost.js');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var innet__default = /*#__PURE__*/_interopDefaultLegacy(innet);
-
 const host = () => {
     const handler = innet.useNewHandler();
     const { docs } = useApi.useApi();
@@ -24,11 +20,13 @@ const host = () => {
         target.servers = [];
     }
     const { servers } = operation || docs;
-    const server = Object.assign({}, props);
+    const server = {
+        ...props,
+    };
     // @ts-expect-error: FIXME
     servers.push(server);
     handler[useHost.hostContext.key] = { server };
-    innet__default["default"](children, handler);
+    innet.innet(children, handler);
 };
 
 exports.host = host;

package/plugins/main/index.d.ts

@@ -1,13 +1,13 @@
-export * from './server';
 export * from './api';
+export * from './body';
 export * from './contact';
-export * from './license';
-export * from './host';
-export * from './variable';
-export * from './tag';
 export * from './endpoint';
-export * from './response';
-export * from './request';
+export * from './host';
+export * from './license';
 export * from './param';
-export * from './body';
-export * from './fallback';
+export * from './preset';
+export * from './response';
+export * from './return';
+export * from './server';
+export * from './tag';
+export * from './variable';

package/plugins/main/index.es6.js

@@ -1,13 +1,13 @@
-import './server/index.es6.js';
 import './api/index.es6.js';
+import './body/index.es6.js';
 import './contact/index.es6.js';
-import './license/index.es6.js';
-import './host/index.es6.js';
-import './variable/index.es6.js';
-import './tag/index.es6.js';
 import './endpoint/index.es6.js';
-import './response/index.es6.js';
-import './request/index.es6.js';
+import './host/index.es6.js';
+import './license/index.es6.js';
 import './param/index.es6.js';
-import './body/index.es6.js';
-import './fallback/index.es6.js';
+import './preset/index.es6.js';
+import './response/index.es6.js';
+import './return/index.es6.js';
+import './server/index.es6.js';
+import './tag/index.es6.js';
+import './variable/index.es6.js';

package/plugins/main/index.js

@@ -1,16 +1,16 @@
 'use strict';
 
-require('./server/index.js');
 require('./api/index.js');
+require('./body/index.js');
 require('./contact/index.js');
-require('./license/index.js');
-require('./host/index.js');
-require('./variable/index.js');
-require('./tag/index.js');
 require('./endpoint/index.js');
-require('./response/index.js');
-require('./request/index.js');
+require('./host/index.js');
+require('./license/index.js');
 require('./param/index.js');
-require('./body/index.js');
-require('./fallback/index.js');
+require('./preset/index.js');
+require('./response/index.js');
+require('./return/index.js');
+require('./server/index.js');
+require('./tag/index.js');
+require('./variable/index.js');
 

package/plugins/main/license/license.d.ts

@@ -1,16 +1,16 @@
 import { type HandlerPlugin } from 'innet';
 export interface LicenseProps {
-    /**
-     * The license name used for the API.
-     * @example: Apache 2.0
-     * */
-    name: string;
     /**
      * An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API.
      * The `identifier` field is mutually exclusive of the `url` field.
      * @example: Apache-2.0
      * */
     identifier?: string;
+    /**
+     * The license name used for the API.
+     * @example: Apache 2.0
+     * */
+    name: string;
     /**
      * A URL to the license used for the API.
      * This MUST be in the form of a URL.

package/plugins/main/param/param.d.ts

@@ -1,6 +1,18 @@
 import { type HandlerPlugin } from 'innet';
 import { type InParam } from '../../../types';
 export interface ParamProps {
+    children?: any;
+    /**
+     * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
+     * Default value is `false`.
+     * */
+    deprecated?: boolean;
+    /**
+     * A brief description of the parameter.
+     * This could contain examples of use.
+     * [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
+     * */
+    description?: string;
     /**
      * The location of the parameter.
      * Possible values are "query", "header", "path" or "cookie".
@@ -14,22 +26,11 @@ export interface ParamProps {
      * - For all other cases, the `name` corresponds to the parameter name used by the `in` property.
      * */
     name: string;
-    /**
-     * A brief description of the parameter.
-     * This could contain examples of use.
-     * [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
-     * */
-    description?: string;
     /**
      * Determines whether this parameter is mandatory.
      * If the parameter location is "path", this property is `true` and its value MUST be `true`.
      * Otherwise, the property MAY be included and its default value is `false`.
      * */
     required?: boolean;
-    /**
-     * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
-     * Default value is `false`.
-     * */
-    deprecated?: boolean;
 }
 export declare const param: HandlerPlugin;

package/plugins/main/param/param.es6.js

@@ -1,5 +1,5 @@
-import innet, { useNewHandler } from 'innet';
-import { useChildren, useProps } from '@innet/jsx';
+import { useNewHandler, innet } from 'innet';
+import { useProps } from '@innet/jsx';
 import '../../../hooks/index.es6.js';
 import '../../../utils/index.es6.js';
 import '../../../utils/rules/index.es6.js';
@@ -13,20 +13,19 @@ import { required } from '../../../utils/rules/required/required.es6.js';
 import { oneOf } from '../../../utils/rules/oneOf/oneOf.es6.js';
 
 const inMap = {
-    query: 'search',
-    path: 'path',
     cookie: 'cookie',
     header: 'header',
+    path: 'path',
+    query: 'search',
 };
 const param = () => {
     var _a;
-    const { operation, endpoint } = useEndpoint();
+    const { endpoint, operation, } = useEndpoint();
     if (!operation.parameters) {
         operation.parameters = [];
     }
-    const children = useChildren();
-    const props = useProps();
-    const params = Object.assign({}, props);
+    const { children, ...props } = useProps();
+    const params = { ...props };
     if (props.in === 'path') {
         params.required = (_a = params.required) !== null && _a !== void 0 ? _a : true;
     }

package/plugins/main/param/param.js

@@ -16,25 +16,20 @@ var useRule = require('../../../hooks/useRule/useRule.js');
 var required = require('../../../utils/rules/required/required.js');
 var oneOf = require('../../../utils/rules/oneOf/oneOf.js');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var innet__default = /*#__PURE__*/_interopDefaultLegacy(innet);
-
 const inMap = {
-    query: 'search',
-    path: 'path',
     cookie: 'cookie',
     header: 'header',
+    path: 'path',
+    query: 'search',
 };
 const param = () => {
     var _a;
-    const { operation, endpoint } = useEndpoint.useEndpoint();
+    const { endpoint, operation, } = useEndpoint.useEndpoint();
     if (!operation.parameters) {
         operation.parameters = [];
     }
-    const children = jsx.useChildren();
-    const props = jsx.useProps();
-    const params = Object.assign({}, props);
+    const { children, ...props } = jsx.useProps();
+    const params = { ...props };
     if (props.in === 'path') {
         params.required = (_a = params.required) !== null && _a !== void 0 ? _a : true;
     }
@@ -65,7 +60,7 @@ const param = () => {
             rulesMap[key] = override(rule);
         }
     });
-    innet__default["default"](children, handler);
+    innet.innet(children, handler);
 };
 
 exports.param = param;

package/plugins/main/preset/index.d.ts

@@ -0,0 +1 @@
+export * from './preset';

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

@@ -0,0 +1 @@
+export { preset } from './preset.es6.js';

package/plugins/{utils/prod → main/preset}/index.js

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var prod = require('./prod.js');
+var preset = require('./preset.js');
 
 
 
-exports.prod = prod.prod;
+exports.preset = preset.preset;

package/plugins/main/preset/preset.d.ts

@@ -0,0 +1,3 @@
+export interface PresetProps {
+}
+export declare function preset(): void;

package/plugins/main/preset/preset.es6.js

@@ -0,0 +1,13 @@
+import { innet, useHandler } from 'innet';
+import { useChildren } from '@innet/jsx';
+import '../../../hooks/index.es6.js';
+import { useServerPlugin } from '../../../hooks/useServerPlugin/useServerPlugin.es6.js';
+
+function preset() {
+    const children = useChildren();
+    useServerPlugin(() => {
+        innet(children, useHandler());
+    });
+}
+
+export { preset };

package/plugins/main/preset/preset.js

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var innet = require('innet');
+var jsx = require('@innet/jsx');
+require('../../../hooks/index.js');
+var useServerPlugin = require('../../../hooks/useServerPlugin/useServerPlugin.js');
+
+function preset() {
+    const children = jsx.useChildren();
+    useServerPlugin.useServerPlugin(() => {
+        innet.innet(children, innet.useHandler());
+    });
+}
+
+exports.preset = preset;

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

@@ -1 +1 @@
-export { response } from './response.es6.js';
+export { response, statuses } from './response.es6.js';

package/plugins/main/response/index.js

@@ -7,3 +7,4 @@ var response = require('./response.js');
 
 
 exports.response = response.response;
+exports.statuses = response.statuses;

package/plugins/main/response/response.d.ts

@@ -1,5 +1,8 @@
 import { type HandlerPlugin } from 'innet';
+import { type ErrorStatuses, type RedirectStatuses, type SuccessStatuses } from '../../request';
+export type StatusKey = ErrorStatuses | RedirectStatuses | SuccessStatuses;
 export interface ResponseProps {
+    children?: any;
     /**
      * A description of the response.
      * [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
@@ -11,6 +14,8 @@ export interface ResponseProps {
      * For example, 2XX represents all response codes between [200-299].
      * Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX.
      * */
-    status?: number | 'default';
+    status?: 'default' | `${1 | 2 | 3 | 4 | 5}XX` | StatusKey | number;
+    type?: string;
 }
+export declare const statuses: Record<StatusKey, number>;
 export declare const response: HandlerPlugin;