alepha 0.8.1 → 0.9.0

package/server/static.d.ts

@@ -1,91 +1,89 @@
-import { Alepha, HookDescriptor, KIND, Logger, OPTIONS } from "alepha";
+import * as _alepha_core0$1 from "alepha";
+import * as _alepha_core0 from "alepha";
+import { Alepha, Descriptor, KIND, Logger } from "alepha";
 import { ServerHandler, ServerRouterProvider } from "alepha/server";
 import { DateTimeProvider, DurationLike } from "alepha/datetime";
 
 //#region src/descriptors/$serve.d.ts
-declare const KEY = "SERVE";
 /**
-* Create a new static file handler.
-*/
+ * Create a new static file handler.
+ */
 declare const $serve: {
   (options?: ServeDescriptorOptions): ServeDescriptor;
-  [KIND]: string;
+  [KIND]: typeof ServeDescriptor;
 };
 interface ServeDescriptorOptions {
   /**
-  * Prefix for the served path.
-  *
-  * @default "/"
-  */
+   * Prefix for the served path.
+   *
+   * @default "/"
+   */
   path?: string;
   /**
-  * Path to the directory to serve.
-  *
-  * @default process.cwd()
-  */
+   * Path to the directory to serve.
+   *
+   * @default process.cwd()
+   */
   root?: string;
   /**
-  * If true, descriptor will be ignored.
-  *
-  * @default false
-  */
+   * If true, descriptor will be ignored.
+   *
+   * @default false
+   */
   disabled?: boolean;
   /**
-  * Whether to keep dot files (e.g. `.gitignore`, `.env`) in the served directory.
-  *
-  * @default true
-  */
+   * Whether to keep dot files (e.g. `.gitignore`, `.env`) in the served directory.
+   *
+   * @default true
+   */
   ignoreDotEnvFiles?: boolean;
   /**
-  * Whether to use the index.html file when the path is a directory.
-  *
-  * @default true
-  */
+   * Whether to use the index.html file when the path is a directory.
+   *
+   * @default true
+   */
   indexFallback?: boolean;
   /**
-  * Force all requests "not found" to be served with the index.html file.
-  * This is useful for single-page applications (SPAs) that use client-side only routing.
-  */
+   * Force all requests "not found" to be served with the index.html file.
+   * This is useful for single-page applications (SPAs) that use client-side only routing.
+   */
   historyApiFallback?: boolean;
   /**
-  * Optional name of the descriptor.
-  * This is used for logging and debugging purposes.
-  *
-  * @default Key name.
-  */
+   * Optional name of the descriptor.
+   * This is used for logging and debugging purposes.
+   *
+   * @default Key name.
+   */
   name?: string;
   /**
-  * Whether to use cache control headers.
-  *
-  * @default {}
-  */
+   * Whether to use cache control headers.
+   *
+   * @default {}
+   */
   cacheControl?: Partial<CacheControlOptions> | false;
 }
 interface CacheControlOptions {
   /**
-  * Whether to use cache control headers.
-  *
-  * @default [.js, .css]
-  */
+   * Whether to use cache control headers.
+   *
+   * @default [.js, .css]
+   */
   fileTypes: string[];
   /**
-  * The maximum age of the cache in seconds.
-  *
-  * @default 60 * 60 * 24 * 2 // 2 days
-  */
+   * The maximum age of the cache in seconds.
+   *
+   * @default 60 * 60 * 24 * 2 // 2 days
+   */
   maxAge: DurationLike;
   /**
-  * Whether to use immutable cache control headers.
-  *
-  * @default true
-  */
+   * Whether to use immutable cache control headers.
+   *
+   * @default true
+   */
   immutable: boolean;
 }
-interface ServeDescriptor {
-  [KIND]: typeof KEY;
-  [OPTIONS]: ServeDescriptorOptions;
-  list(): string[];
-}
+declare class ServeDescriptor extends Descriptor<ServeDescriptorOptions> {}
+//# sourceMappingURL=$serve.d.ts.map
 //#endregion
 //#region src/providers/ServerStaticProvider.d.ts
 declare class ServerStaticProvider {
@@ -94,9 +92,8 @@ declare class ServerStaticProvider {
   protected readonly dateTimeProvider: DateTimeProvider;
   protected readonly log: Logger;
   protected readonly directories: ServeDirectory[];
-  protected readonly configure: HookDescriptor<"configure">;
-  list(name: string): string[];
-  serve(options: ServeDescriptorOptions): Promise<void>;
+  protected readonly configure: _alepha_core0$1.HookDescriptor<"configure">;
+  createStaticServer(options: ServeDescriptorOptions): Promise<void>;
   createFileHandler(filepath: string, options: ServeDescriptorOptions): Promise<ServerHandler>;
   protected getCacheFileTypes(): string[];
   protected getCacheControl(filename: string, options: ServeDescriptorOptions): {
@@ -109,19 +106,18 @@ interface ServeDirectory {
   options: ServeDescriptorOptions;
   files: string[];
 }
+//# sourceMappingURL=ServerStaticProvider.d.ts.map
 //#endregion
 //#region src/index.d.ts
-// ---------------------------------------------------------------------------------------------------------------------
 /**
-* Create static file server with `$static()`.
-*
-* @see {@link ServerStaticProvider}
-* @module alepha.server.static
-*/
-declare class AlephaServerStatic {
-  readonly name = "alepha.server.static";
-  readonly $services: (alepha: Alepha) => void;
-}
+ * Create static file server with `$static()`.
+ *
+ * @see {@link ServerStaticProvider}
+ * @module alepha.server.static
+ */
+declare const AlephaServerStatic: _alepha_core0.ModuleDescriptor;
+//# sourceMappingURL=index.d.ts.map
+
 //#endregion
 export { $serve, AlephaServerStatic, CacheControlOptions, ServeDescriptor, ServeDescriptorOptions, ServeDirectory, ServerStaticProvider };
 //# sourceMappingURL=index.d.ts.map

package/server/swagger.d.ts

@@ -1,25 +1,27 @@
-import { Alepha, HookDescriptor, KIND, Module, OPTIONS, TObject } from "alepha";
-import { ServerActionDescriptorProvider, ServerRouteAction, ServerRouterProvider } from "alepha/server";
+import * as _alepha_core0$1 from "alepha";
+import * as _alepha_core0 from "alepha";
+import { Alepha, Descriptor, KIND, TObject } from "alepha";
+import { ActionDescriptor, RequestConfigSchema, 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.
-*/
+ * Create a new OpenAPI.
+ */
 declare const $swagger: {
   (options: SwaggerDescriptorOptions): SwaggerDescriptor;
-  [KIND]: string;
+  [KIND]: typeof SwaggerDescriptor;
 };
 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;
@@ -29,95 +31,104 @@ 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;
   };
 }
-interface SwaggerDescriptor {
-  [KIND]: "SWAGGER";
-  [OPTIONS]: SwaggerDescriptorOptions;
-  json(): OpenAPIV3.Document;
-}
+declare class SwaggerDescriptor extends Descriptor<SwaggerDescriptorOptions> {}
+//# sourceMappingURL=$swagger.d.ts.map
 //#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: HookDescriptor<"configure">;
-  protected configureOpenApi(doc: SwaggerDescriptorOptions): OpenAPIV3.Document;
+  json?: OpenAPIV3.Document;
+  protected readonly configure: _alepha_core0$1.HookDescriptor<"configure">;
+  createSwagger(options: SwaggerDescriptorOptions): Promise<OpenAPIV3.Document | undefined>;
+  protected configureOpenApi(actions: ActionDescriptor<RequestConfigSchema>[], doc: SwaggerDescriptorOptions): OpenAPIV3.Document;
   isBodyMultipart(schema: TObject): boolean;
   replacePathParams(url: string): string;
-  getResponseSchema(route: ServerRouteAction): {
+  getResponseSchema(route: ActionDescriptor<RequestConfigSchema>): {
     type?: string;
     schema?: any;
     status: number;
   } | undefined;
-  protected configureSwaggerApi(prefix: string, json: OpenAPIV3.Document): Promise<void>;
+  protected configureSwaggerApi(prefix: string, json: OpenAPIV3.Document): void;
   protected configureSwaggerUi(prefix: string, options: SwaggerDescriptorOptions): Promise<void>;
 }
+//# sourceMappingURL=ServerSwaggerProvider.d.ts.map
 //#endregion
 //#region src/index.d.ts
-// ---------------------------------------------------------------------------------------------------------------------
-/**
-* 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;
+declare module "alepha/server" {
+  interface ActionDescriptorOptions<TConfig extends RequestConfigSchema> {
+    /**
+     * Short description of the route.
+     */
+    summary?: string;
+    /**
+     * Don't include this action in the Swagger documentation.
+     */
+    hide?: boolean;
+  }
 }
+/**
+ * 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 const AlephaServerSwagger: _alepha_core0.ModuleDescriptor;
+//# sourceMappingURL=index.d.ts.map
+
 //#endregion
 export { $swagger, AlephaServerSwagger, ServerSwaggerProvider, SwaggerDescriptor, SwaggerDescriptorOptions, SwaggerUiOptions };
 //# sourceMappingURL=index.d.ts.map