alepha 0.7.4 → 0.7.6

package/server/swagger.d.ts

@@ -1,108 +1,122 @@
-import * as _alepha_core from '@alepha/core';
-import { KIND, OPTIONS, Alepha, TObject, Module } from '@alepha/core';
-import { OpenAPIV3 } from 'openapi-types';
-import { ServerActionDescriptorProvider, ServerRouterProvider, ServerRouteAction } from '@alepha/server';
-import { ServerStaticProvider } from '@alepha/server-static';
+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 { OpenAPIV3 } from "openapi-types";
 
+//#region src/descriptors/$swagger.d.ts
 interface SwaggerDescriptorOptions {
-    info: OpenAPIV3.InfoObject;
+  info: OpenAPIV3.InfoObject;
+  /**
+   * @default: "/docs"
+   */
+  prefix?: string;
+  /**
+   * If true, docs will be disabled.
+   */
+  disabled?: boolean;
+  excludeTags?: string[];
+  ui?: boolean | SwaggerUiOptions;
+  rewrite?: (doc: OpenAPIV3.Document) => void;
+}
+interface SwaggerUiOptions {
+  root?: string;
+  initOAuth?: {
     /**
-     * @default: "/docs"
+     * Default clientId.
      */
-    prefix?: string;
+    clientId?: string;
     /**
-     * If true, docs will be disabled.
+     * realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
      */
-    disabled?: boolean;
-    excludeTags?: string[];
-    ui?: boolean | SwaggerUiOptions;
-    rewrite?: (doc: OpenAPIV3.Document) => void;
-}
-interface SwaggerUiOptions {
-    root?: string;
-    initOAuth?: {
-        /**
-         * Default clientId.
-         */
-        clientId?: string;
-        /**
-         * realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
-         */
-        realm?: string;
-        /**
-         * 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 ' '
-         */
-        scopeSeparator?: string;
-        /**
-         * 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
-         */
-        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
-         */
-        useBasicAuthenticationWithAccessCodeGrant?: boolean;
-        /**
-         * Only applies to Authorization Code flows. Proof Key for Code Exchange
-         * brings enhanced security for OAuth public clients.
-         *
-         * @default false
-         */
-        usePkceWithAuthorizationCodeGrant?: boolean;
+    realm?: string;
+    /**
+     * 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 ' '
+     */
+    scopeSeparator?: string;
+    /**
+     * 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
+     */
+    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
+     */
+    useBasicAuthenticationWithAccessCodeGrant?: boolean;
+    /**
+     * Only applies to Authorization Code flows. Proof Key for Code Exchange
+     * brings enhanced security for OAuth public clients.
+     *
+     * @default false
+     */
+    usePkceWithAuthorizationCodeGrant?: boolean;
+  };
 }
 interface SwaggerDescriptor {
-    [KIND]: "SWAGGER";
-    [OPTIONS]: SwaggerDescriptorOptions;
-    json(): OpenAPIV3.Document;
+  [KIND]: "SWAGGER";
+  [OPTIONS]: SwaggerDescriptorOptions;
+  json(): OpenAPIV3.Document;
 }
 declare const $swagger: {
-    (options: SwaggerDescriptorOptions): SwaggerDescriptor;
-    [KIND]: string;
+  (options: SwaggerDescriptorOptions): SwaggerDescriptor;
+  [KIND]: string;
 };
-
+//#endregion
+//#region src/ServerSwaggerProvider.d.ts
 declare class ServerSwaggerProvider {
-    protected readonly serverActionProvider: ServerActionDescriptorProvider;
-    protected readonly serverStaticProvider: ServerStaticProvider;
-    protected readonly serverRouterProvider: ServerRouterProvider;
-    protected readonly alepha: Alepha;
-    protected readonly configure: _alepha_core.HookDescriptor<"configure">;
-    protected configureOpenApi(doc: SwaggerDescriptorOptions): any;
-    isBodyMultipart(schema: TObject): boolean;
-    replacePathParams(url: string): string;
-    getResponseSchema(route: ServerRouteAction): {
-        type?: string;
-        schema?: any;
-        status: number;
-    } | undefined;
-    protected configureSwaggerApi(prefix: string, json: OpenAPIV3.Document): Promise<void>;
-    protected configureSwaggerUi(prefix: string, options: SwaggerDescriptorOptions): Promise<void>;
+  protected readonly serverActionProvider: ServerActionDescriptorProvider;
+  protected readonly serverStaticProvider: ServerStaticProvider;
+  protected readonly serverRouterProvider: ServerRouterProvider;
+  protected readonly alepha: Alepha;
+  protected readonly configure: _alepha_core0.HookDescriptor<"configure">;
+  protected configureOpenApi(doc: SwaggerDescriptorOptions): any;
+  isBodyMultipart(schema: TObject): boolean;
+  replacePathParams(url: string): string;
+  getResponseSchema(route: ServerRouteAction): {
+    type?: string;
+    schema?: any;
+    status: number;
+  } | undefined;
+  protected configureSwaggerApi(prefix: string, json: OpenAPIV3.Document): Promise<void>;
+  protected configureSwaggerUi(prefix: string, options: SwaggerDescriptorOptions): Promise<void>;
 }
-
+//#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
+ */
 declare class AlephaServerSwagger implements Module {
-    readonly name = "alepha.server.swagger";
-    readonly $services: (alepha: Alepha) => Alepha;
+  readonly name = "alepha.server.swagger";
+  readonly $services: (alepha: Alepha) => Alepha;
 }
-
-export { $swagger, AlephaServerSwagger, ServerSwaggerProvider, type SwaggerDescriptor, type SwaggerDescriptorOptions, type SwaggerUiOptions };
+//#endregion
+export { $swagger, AlephaServerSwagger, ServerSwaggerProvider, SwaggerDescriptor, SwaggerDescriptorOptions, SwaggerUiOptions };
+//# sourceMappingURL=index.d.ts.map

package/server/swagger.js

@@ -1 +1 @@
-export * from '@alepha/server-swagger';
+export * from '@alepha/server-swagger'

package/server.cjs

@@ -1,12 +1,8 @@
 'use strict';
-
-var server = require('@alepha/server');
-
-
-
-Object.keys(server).forEach(function (k) {
+var m = require('@alepha/server');
+Object.keys(m).forEach(function (k) {
 	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
 		enumerable: true,
-		get: function () { return server[k]; }
+		get: function () { return m[k]; }
 	});
-});
+});