alepha 0.13.0 → 0.13.2

package/dist/server-swagger/index.d.ts

@@ -1,81 +1,17 @@
-import * as alepha17 from "alepha";
-import { Alepha, Descriptor, KIND, Static, TObject } from "alepha";
-import { JwtProvider, SecurityProvider, UserAccount, UserAccountToken } from "alepha/security";
-import { ActionDescriptor, FetchOptions, RequestConfigSchema, ServerHandler, ServerProvider, ServerRouterProvider } from "alepha/server";
-import * as alepha_logger2 from "alepha/logger";
-import { DateTimeProvider, DurationLike } from "alepha/datetime";
-import { FileDetector, FileSystemProvider } from "alepha/file";
+import "alepha/server/security";
+import * as alepha1 from "alepha";
+import { Alepha, KIND, Primitive, Static, TObject } from "alepha";
+import { ActionPrimitive, RequestConfigSchema, ServerProvider, ServerRouterProvider } from "alepha/server";
+import { ServerStaticProvider } from "alepha/server/static";
+import { FileSystemProvider } from "alepha/file";
+import * as alepha_logger0 from "alepha/logger";
 
-//#region src/server-security/providers/ServerBasicAuthProvider.d.ts
-interface BasicAuthOptions {
-  username: string;
-  password: string;
-}
-//#endregion
-//#region src/server-security/providers/ServerSecurityProvider.d.ts
+//#region src/server-swagger/primitives/$swagger.d.ts
 
-type ServerRouteSecure = {
-  realm?: string;
-  basic?: BasicAuthOptions;
-};
-//#endregion
-//#region src/server-security/index.d.ts
-declare module "alepha" {
-  interface State {
-    /**
-     * Real (or fake) user account, used for internal actions.
-     *
-     * If you define this, you assume that all actions are executed by this user by default.
-     * > To force a different user, you need to pass it explicitly in the options.
-     */
-    "alepha.server.security.system.user"?: UserAccountToken;
-    /**
-     * The authenticated user account attached to the server request state.
-     *
-     * @internal
-     */
-    "alepha.server.request.user"?: UserAccount;
-  }
-}
-declare module "alepha/server" {
-  interface ServerRequest<TConfig> {
-    user?: UserAccountToken;
-  }
-  interface ServerActionRequest<TConfig> {
-    user: UserAccountToken;
-  }
-  interface ServerRoute {
-    /**
-     * If true, the route will be protected by the security provider.
-     * All actions are secure by default, but you can disable it for specific actions.
-     */
-    secure?: boolean | ServerRouteSecure;
-  }
-  interface ClientRequestOptions extends FetchOptions {
-    /**
-     * Forward user from the previous request.
-     * If "system", use system user. @see {ServerSecurityProvider.localSystemUser}
-     * If "context", use the user from the current context (e.g. request).
-     *
-     * @default "system" if provided, else "context" if available.
-     */
-    user?: UserAccountToken | "system" | "context";
-  }
-}
 /**
- * Plugin for Alepha Server that provides security features. Based on the Alepha Security module.
- *
- * By default, all $action will be guarded by a permission check.
+ * Creates an OpenAPI/Swagger documentation primitive with interactive UI.
  *
- * @see {@link ServerSecurityProvider}
- * @module alepha.server.security
- */
-//#endregion
-//#region src/server-swagger/descriptors/$swagger.d.ts
-/**
- * Creates an OpenAPI/Swagger documentation descriptor with interactive UI.
- *
- * Automatically generates API documentation from your $action descriptors and serves
+ * Automatically generates API documentation from your $action primitives and serves
  * an interactive Swagger UI for testing endpoints. Supports customization, tag filtering,
  * and OAuth configuration.
  *
@@ -96,10 +32,10 @@ declare module "alepha/server" {
  * ```
  */
 declare const $swagger: {
-  (options?: SwaggerDescriptorOptions): SwaggerDescriptor;
-  [KIND]: typeof SwaggerDescriptor;
+  (options?: SwaggerPrimitiveOptions): SwaggerPrimitive;
+  [KIND]: typeof SwaggerPrimitive;
 };
-interface SwaggerDescriptorOptions {
+interface SwaggerPrimitiveOptions {
   info?: OpenApiDocument["info"];
   /**
    * @default: "/docs"
@@ -178,7 +114,7 @@ interface SwaggerUiOptions {
     usePkceWithAuthorizationCodeGrant?: boolean;
   };
 }
-declare class SwaggerDescriptor extends Descriptor<SwaggerDescriptorOptions> {}
+declare class SwaggerPrimitive extends Primitive<SwaggerPrimitiveOptions> {}
 interface OpenApiDocument {
   openapi: string;
   info: {
@@ -220,107 +156,12 @@ interface OpenApiOperation {
   security?: Array<Record<string, any[]>>;
 }
 //#endregion
-//#region src/server-static/descriptors/$serve.d.ts
-interface ServeDescriptorOptions {
-  /**
-   * Prefix for the served path.
-   *
-   * @default "/"
-   */
-  path?: string;
-  /**
-   * Path to the directory to serve.
-   *
-   * @default process.cwd()
-   */
-  root?: string;
-  /**
-   * 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
-   */
-  ignoreDotEnvFiles?: boolean;
-  /**
-   * 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.
-   */
-  historyApiFallback?: boolean;
-  /**
-   * 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 {}
-   */
-  cacheControl?: Partial<CacheControlOptions> | false;
-}
-interface CacheControlOptions {
-  /**
-   * 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
-   */
-  maxAge: DurationLike;
-  /**
-   * Whether to use immutable cache control headers.
-   *
-   * @default true
-   */
-  immutable: boolean;
-}
-//#endregion
-//#region src/server-static/providers/ServerStaticProvider.d.ts
-declare class ServerStaticProvider {
-  protected readonly alepha: Alepha;
-  protected readonly routerProvider: ServerRouterProvider;
-  protected readonly dateTimeProvider: DateTimeProvider;
-  protected readonly fileDetector: FileDetector;
-  protected readonly log: alepha_logger2.Logger;
-  protected readonly directories: ServeDirectory[];
-  protected readonly configure: alepha17.HookDescriptor<"configure">;
-  createStaticServer(options: ServeDescriptorOptions): Promise<void>;
-  createFileHandler(filepath: string, options: ServeDescriptorOptions): Promise<ServerHandler>;
-  protected getCacheFileTypes(): string[];
-  protected getCacheControl(filename: string, options: ServeDescriptorOptions): {
-    maxAge: number;
-    immutable: boolean;
-  } | undefined;
-  getAllFiles(dir: string, ignoreDotEnvFiles?: boolean): Promise<string[]>;
-}
-interface ServeDirectory {
-  options: ServeDescriptorOptions;
-  files: string[];
-}
-//#endregion
 //#region src/server-swagger/providers/ServerSwaggerProvider.d.ts
 /**
  * Swagger provider configuration atom
  */
-declare const swaggerOptions: alepha17.Atom<TObject<{
-  excludeKeys: alepha17.TOptional<alepha17.TArray<alepha17.TString>>;
+declare const swaggerOptions: alepha1.Atom<TObject<{
+  excludeKeys: alepha1.TOptional<alepha1.TArray<alepha1.TString>>;
 }>, "alepha.server.swagger.options">;
 type ServerSwaggerProviderOptions = Static<typeof swaggerOptions.schema>;
 declare module "alepha" {
@@ -333,31 +174,31 @@ declare class ServerSwaggerProvider {
   protected readonly serverRouterProvider: ServerRouterProvider;
   protected readonly serverProvider: ServerProvider;
   protected readonly alepha: Alepha;
-  protected readonly log: alepha_logger2.Logger;
+  protected readonly log: alepha_logger0.Logger;
   protected readonly options: Readonly<{
     excludeKeys?: string[] | undefined;
   }>;
   protected readonly fs: FileSystemProvider;
   json?: OpenApiDocument;
-  protected readonly configure: alepha17.HookDescriptor<"configure">;
-  createSwagger(options: SwaggerDescriptorOptions): Promise<OpenApiDocument | undefined>;
-  protected configureOpenApi(actions: ActionDescriptor<RequestConfigSchema>[], doc: SwaggerDescriptorOptions): OpenApiDocument;
+  protected readonly configure: alepha1.HookPrimitive<"configure">;
+  createSwagger(options: SwaggerPrimitiveOptions): Promise<OpenApiDocument | undefined>;
+  protected configureOpenApi(actions: ActionPrimitive<RequestConfigSchema>[], doc: SwaggerPrimitiveOptions): OpenApiDocument;
   isBodyMultipart(schema: TObject): boolean;
   replacePathParams(url: string): string;
-  getResponseSchema(route: ActionDescriptor<RequestConfigSchema>): {
+  getResponseSchema(route: ActionPrimitive<RequestConfigSchema>): {
     type?: string;
     schema?: any;
     status: number;
   } | undefined;
   protected configureSwaggerApi(prefix: string, json: OpenApiDocument): void;
-  protected configureSwaggerUi(prefix: string, options: SwaggerDescriptorOptions): Promise<void>;
+  protected configureSwaggerUi(prefix: string, options: SwaggerPrimitiveOptions): Promise<void>;
   protected getAssetPath(...paths: (string | undefined)[]): Promise<string | undefined>;
   removePrivateFields<T extends Record<string, any>>(obj: T, excludeList: string[]): T;
 }
 //#endregion
 //#region src/server-swagger/index.d.ts
 declare module "alepha/server" {
-  interface ActionDescriptorOptions<TConfig extends RequestConfigSchema> {
+  interface ActionPrimitiveOptions<TConfig extends RequestConfigSchema> {
     /**
      * Short description of the route.
      */
@@ -376,7 +217,7 @@ declare module "alepha/server" {
  * @see {@link ServerSwaggerProvider}
  * @module alepha.server.swagger
  */
-declare const AlephaServerSwagger: alepha17.Service<alepha17.Module>;
+declare const AlephaServerSwagger: alepha1.Service<alepha1.Module>;
 //#endregion
-export { $swagger, AlephaServerSwagger, OpenApiDocument, OpenApiOperation, ServerSwaggerProvider, ServerSwaggerProviderOptions, SwaggerDescriptor, SwaggerDescriptorOptions, SwaggerUiOptions, swaggerOptions };
+export { $swagger, AlephaServerSwagger, OpenApiDocument, OpenApiOperation, ServerSwaggerProvider, ServerSwaggerProviderOptions, SwaggerPrimitive, SwaggerPrimitiveOptions, SwaggerUiOptions, swaggerOptions };
 //# sourceMappingURL=index.d.ts.map