alepha 0.7.7 → 0.8.1

package/server/swagger.d.ts

@@ -1,19 +1,25 @@
-import * as _alepha_core0 from "@alepha/core";
-import { Alepha, KIND, Module, OPTIONS, TObject } from "@alepha/core";
-import { ServerActionDescriptorProvider, ServerRouteAction, ServerRouterProvider } from "@alepha/server";
-import { ServerStaticProvider } from "@alepha/server-static";
+import { Alepha, HookDescriptor, KIND, Module, OPTIONS, TObject } from "alepha";
+import { ServerActionDescriptorProvider, ServerRouteAction, ServerRouterProvider } from "alepha/server";
+import { ServerStaticProvider } from "alepha/server/static";
 import { OpenAPIV3 } from "openapi-types";
 
 //#region src/descriptors/$swagger.d.ts
+/**
+* Create a new OpenAPI.
+*/
+declare const $swagger: {
+  (options: SwaggerDescriptorOptions): SwaggerDescriptor;
+  [KIND]: string;
+};
 interface SwaggerDescriptorOptions {
   info: OpenAPIV3.InfoObject;
   /**
-   * @default: "/docs"
-   */
+  * @default: "/docs"
+  */
   prefix?: string;
   /**
-   * If true, docs will be disabled.
-   */
+  * If true, docs will be disabled.
+  */
   disabled?: boolean;
   excludeTags?: string[];
   ui?: boolean | SwaggerUiOptions;
@@ -23,53 +29,53 @@ interface SwaggerUiOptions {
   root?: string;
   initOAuth?: {
     /**
-     * Default clientId.
-     */
+    * Default clientId.
+    */
     clientId?: string;
     /**
-     * realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
-     */
+    * realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
+    */
     realm?: string;
     /**
-     * application name, displayed in authorization popup.
-     */
+    * application name, displayed in authorization popup.
+    */
     appName?: string;
     /**
-     * scope separator for passing scopes, encoded before calling, default
-     * value is a space (encoded value %20).
-     *
-     * @default ' '
-     */
+    * scope separator for passing scopes, encoded before calling, default
+    * value is a space (encoded value %20).
+    *
+    * @default ' '
+    */
     scopeSeparator?: string;
     /**
-     * string array or scope separator (i.e. space) separated string of
-     * initially selected oauth scopes
-     *
-     * @default []
-     */
+    * string array or scope separator (i.e. space) separated string of
+    * initially selected oauth scopes
+    *
+    * @default []
+    */
     scopes?: string | string[];
     /**
-     * Additional query parameters added to authorizationUrl and tokenUrl.
-     * MUST be an object
-     */
+    * Additional query parameters added to authorizationUrl and tokenUrl.
+    * MUST be an object
+    */
     additionalQueryStringParams?: {
       [key: string]: any;
     };
     /**
-     * Only activated for the accessCode flow. During the authorization_code
-     * request to the tokenUrl, pass the Client Password using the HTTP Basic
-     * Authentication scheme (Authorization header with Basic
-     * base64encode(client_id + client_secret)).
-     *
-     * @default false
-     */
+    * Only activated for the accessCode flow. During the authorization_code
+    * request to the tokenUrl, pass the Client Password using the HTTP Basic
+    * Authentication scheme (Authorization header with Basic
+    * base64encode(client_id + client_secret)).
+    *
+    * @default false
+    */
     useBasicAuthenticationWithAccessCodeGrant?: boolean;
     /**
-     * Only applies to Authorization Code flows. Proof Key for Code Exchange
-     * brings enhanced security for OAuth public clients.
-     *
-     * @default false
-     */
+    * Only applies to Authorization Code flows. Proof Key for Code Exchange
+    * brings enhanced security for OAuth public clients.
+    *
+    * @default false
+    */
     usePkceWithAuthorizationCodeGrant?: boolean;
   };
 }
@@ -78,10 +84,6 @@ interface SwaggerDescriptor {
   [OPTIONS]: SwaggerDescriptorOptions;
   json(): OpenAPIV3.Document;
 }
-declare const $swagger: {
-  (options: SwaggerDescriptorOptions): SwaggerDescriptor;
-  [KIND]: string;
-};
 //#endregion
 //#region src/ServerSwaggerProvider.d.ts
 declare class ServerSwaggerProvider {
@@ -89,8 +91,8 @@ declare class ServerSwaggerProvider {
   protected readonly serverStaticProvider: ServerStaticProvider;
   protected readonly serverRouterProvider: ServerRouterProvider;
   protected readonly alepha: Alepha;
-  protected readonly configure: _alepha_core0.HookDescriptor<"configure">;
-  protected configureOpenApi(doc: SwaggerDescriptorOptions): any;
+  protected readonly configure: HookDescriptor<"configure">;
+  protected configureOpenApi(doc: SwaggerDescriptorOptions): OpenAPIV3.Document;
   isBodyMultipart(schema: TObject): boolean;
   replacePathParams(url: string): string;
   getResponseSchema(route: ServerRouteAction): {
@@ -103,16 +105,15 @@ declare class ServerSwaggerProvider {
 }
 //#endregion
 //#region src/index.d.ts
+// ---------------------------------------------------------------------------------------------------------------------
 /**
- * Alepha Server Swagger Module
- *
- * Plugin for Alepha Server that provides Swagger documentation capabilities.
- * It generates OpenAPI v3 documentation for the server's endpoints ($action).
- * It also provides a Swagger UI for interactive API documentation.
- *
- * @see {@link ServerSwaggerProvider}
- * @module alepha.server.swagger
- */
+* Plugin for Alepha Server that provides Swagger documentation capabilities.
+* It generates OpenAPI v3 documentation for the server's endpoints ($action).
+* It also provides a Swagger UI for interactive API documentation.
+*
+* @see {@link ServerSwaggerProvider}
+* @module alepha.server.swagger
+*/
 declare class AlephaServerSwagger implements Module {
   readonly name = "alepha.server.swagger";
   readonly $services: (alepha: Alepha) => Alepha;