alepha 0.10.5 → 0.10.7

package/core.d.ts

@@ -28,13 +28,13 @@ declare const MODULE: unique symbol;
 /**
  * In Alepha, a service is a class that can be instantiated or an abstract class. Nothing more, nothing less...
  */
-type Service<T extends object = any> = InstantiableClass<T> | AbstractClass<T>;
-type InstantiableClass<T extends object = any> = new (...args: any[]) => T;
+type Service<T$1 extends object = any> = InstantiableClass<T$1> | AbstractClass<T$1>;
+type InstantiableClass<T$1 extends object = any> = new (...args: any[]) => T$1;
 /**
  * Abstract class is a class that cannot be instantiated directly!
  * It widely used for defining interfaces.
  */
-type AbstractClass<T extends object = any> = abstract new (...args: any[]) => T;
+type AbstractClass<T$1 extends object = any> = abstract new (...args: any[]) => T$1;
 /**
  * Service substitution allows you to register a class as a different class.
  * Providing class A, but using class B instead.
@@ -42,17 +42,17 @@ type AbstractClass<T extends object = any> = abstract new (...args: any[]) => T;
  *
  * class A is mostly an AbstractClass, while class B is an InstantiableClass.
  */
-interface ServiceSubstitution<T extends object = any> {
+interface ServiceSubstitution<T$1 extends object = any> {
   /**
    * Every time someone asks for this class, it will be provided with the 'use' class.
    */
-  provide: Service<T>;
+  provide: Service<T$1>;
   /**
    * Service to use instead of the 'provide' service.
    *
    * Syntax is inspired by Angular's DI system.
    */
-  use: Service<T>;
+  use: Service<T$1>;
   /**
    * If true, if the service already exists -> just ignore the substitution and do not throw an error.
    * Mostly used for plugins to enforce a substitution without throwing an error.
@@ -68,11 +68,11 @@ interface ServiceSubstitution<T extends object = any> {
  *
  * And yes, you declare the *type* of the service, not the *instance*.
  */
-type ServiceEntry<T extends object = any> = Service<T> | ServiceSubstitution<T>;
+type ServiceEntry<T$1 extends object = any> = Service<T$1> | ServiceSubstitution<T$1>;
 //#endregion
 //#region src/helpers/descriptor.d.ts
-interface DescriptorArgs<T extends object = {}> {
-  options: T;
+interface DescriptorArgs<T$1 extends object = {}> {
+  options: T$1;
   alepha: Alepha;
   service: InstantiableClass<Service>;
   module?: Service;
@@ -82,22 +82,22 @@ interface DescriptorConfig {
   service: InstantiableClass<Service>;
   module?: Service;
 }
-declare abstract class Descriptor<T extends object = {}> {
+declare abstract class Descriptor<T$1 extends object = {}> {
   protected readonly alepha: Alepha;
-  readonly options: T;
+  readonly options: T$1;
   readonly config: DescriptorConfig;
-  constructor(args: DescriptorArgs<T>);
+  constructor(args: DescriptorArgs<T$1>);
   /**
    * Called automatically by Alepha after the descriptor is created.
    */
   protected onInit(): void;
 }
-type DescriptorFactory<TDescriptor extends Descriptor = Descriptor> = {
-  (options: TDescriptor["options"]): TDescriptor;
-  [KIND]: InstantiableClass<TDescriptor>;
+type DescriptorFactory<TDescriptor$1 extends Descriptor = Descriptor> = {
+  (options: TDescriptor$1["options"]): TDescriptor$1;
+  [KIND]: InstantiableClass<TDescriptor$1>;
 };
-type DescriptorFactoryLike<T extends object = any> = {
-  (options: T): any;
+type DescriptorFactoryLike<T$1 extends object = any> = {
+  (options: T$1): any;
   [KIND]: any;
 };
 declare const createDescriptor: <TDescriptor extends Descriptor>(descriptor: InstantiableClass<TDescriptor> & {
@@ -117,7 +117,7 @@ declare const createDescriptor: <TDescriptor extends Descriptor>(descriptor: Ins
  */
 declare const $inject: <T extends object>(type: Service<T>, opts?: InjectOptions<T>) => T;
 declare class InjectDescriptor extends Descriptor {}
-interface InjectOptions<T extends object = any> {
+interface InjectOptions<T$1 extends object = any> {
   /**
    * - 'transient' → Always a new instance on every inject. Zero caching.
    * - 'singleton' → One instance per Alepha runtime (per-thread). Never disposed until Alepha shuts down. (default)
@@ -132,7 +132,7 @@ interface InjectOptions<T extends object = any> {
   /**
    * Constructor arguments to pass when creating a new instance.
    */
-  args?: ConstructorParameters<InstantiableClass<T>>;
+  args?: ConstructorParameters<InstantiableClass<T$1>>;
   /**
    * Parent that requested the instance.
    *
@@ -190,7 +190,7 @@ interface InjectOptions<T extends object = any> {
  * If we speak with `$actions`, a module should be used when you have more than 30 actions in a single module.
  */
 declare const $module: <T extends object = {}>(options: ModuleDescriptorOptions<T>) => Service<Module<T>>;
-interface ModuleDescriptorOptions<T extends object> {
+interface ModuleDescriptorOptions<T$1 extends object> {
   /**
    * Name of the module.
    *
@@ -210,16 +210,16 @@ interface ModuleDescriptorOptions<T extends object> {
    * You can override this behavior by providing a register function.
    * It's useful when you want to register services conditionally or in a specific order.
    */
-  register?: (alepha: Alepha, options: T) => void;
+  register?: (alepha: Alepha, options: T$1) => void;
 }
 /**
  * Base class for all modules.
  */
-declare abstract class Module<T extends object = {}> {
-  abstract readonly config: ModuleDescriptorOptions<T>;
+declare abstract class Module<T$1 extends object = {}> {
+  abstract readonly config: ModuleDescriptorOptions<T$1>;
   abstract register(alepha: Alepha): void;
   static NAME_REGEX: RegExp;
-  options: T;
+  options: T$1;
   /**
    * Check if a Service is a Module.
    */
@@ -229,7 +229,7 @@ declare abstract class Module<T extends object = {}> {
    */
   static of(ctor: Service): Service<Module> | undefined;
 }
-type WithModule<T extends object = any> = T & {
+type WithModule<T$1 extends object = any> = T$1 & {
   [MODULE]?: Service;
 };
 //#endregion
@@ -237,7 +237,7 @@ type WithModule<T extends object = any> = T & {
 /**
  * Represents a value that can be either a value or a promise of value.
  */
-type Async<T> = T | Promise<T>;
+type Async<T$1> = T$1 | Promise<T$1>;
 /**
  * Represents a function that returns an async value.
  */
@@ -245,7 +245,7 @@ type AsyncFn = (...args: any[]) => Async<any>;
 /**
  * Transforms a type T into a promise if it is not already a promise.
  */
-type MaybePromise<T> = T extends Promise<any> ? T : Promise<T>;
+type MaybePromise<T$1> = T$1 extends Promise<any> ? T$1 : Promise<T$1>;
 //#endregion
 //#region src/interfaces/LoggerInterface.d.ts
 type LogLevel = "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE" | "SILENT";
@@ -273,7 +273,7 @@ declare class EventManager {
   /**
    * Emits the specified event with the given payload.
    */
-  emit<T extends keyof Hooks>(func: keyof Hooks, payload: Hooks[T], options?: {
+  emit<T extends keyof Hooks>(func: T, payload: Hooks[T], options?: {
     /**
      * If true, the hooks will be executed in reverse order.
      * This is useful for "stop" hooks that should be executed in reverse order.
@@ -630,10 +630,26 @@ declare class TypeProvider {
    * @experimental
    */
   stream(): TStream;
+  email(options?: TStringOptions$1): TString$1;
+  e164(options?: TStringOptions$1): TString$1;
+  bcp47(options?: TStringOptions$1): TString$1;
+  /**
+   * Create a schema for short text, such as names or titles.
+   * Default max length is 64 characters.
+   */
+  shortText(options?: TStringOptions$1): TString$1;
+  /**
+   * Create a schema for long text, such as descriptions or comments.
+   * Default max length is 1024 characters.
+   */
+  longText(options?: TStringOptions$1): TString$1;
+  /**
+   * Create a schema for rich text, such as HTML or Markdown.
+   * Default max length is 65535 characters.
+   */
+  richText(options?: TStringOptions$1): TString$1;
   /**
    * Create a schema for a string enum e.g. LIKE_THIS.
-   *
-   * @param options
    */
   snakeCase: (options?: TStringOptions$1) => TString$1;
   /**
@@ -935,12 +951,14 @@ declare class Alepha {
    * True if the App is running in a browser environment.
    */
   isBrowser(): boolean;
+  /**
+   * Returns whether the App is running in Vite dev mode.
+   */
+  isViteDev(): boolean;
   /**
    * Returns whether the App is running in a serverless environment.
-   *
-   * > Vite developer mode is also considered serverless.
    */
-  isServerless(): boolean | "vite" | "vercel";
+  isServerless(): boolean | "vercel";
   /**
    * Returns whether the App is in test mode. (Running in a test environment)
    *
@@ -1126,20 +1144,20 @@ declare class Alepha {
   protected new<T extends object>(service: Service<T>, args?: any[]): T;
   protected processDescriptor(value: Descriptor, propertyKey?: string): void;
 }
-interface Hook<T extends keyof Hooks = any> {
+interface Hook<T$1 extends keyof Hooks = any> {
   caller?: Service;
   priority?: "first" | "last";
-  callback: (payload: Hooks[T]) => Async<void>;
+  callback: (payload: Hooks[T$1]) => Async<void>;
 }
 /**
  * This is how we store services in the Alepha container.
  */
-interface ServiceDefinition<T extends object = any> {
+interface ServiceDefinition<T$1 extends object = any> {
   /**
    * The instance of the class or type definition.
    * Mostly used for caching / singleton but can be used for other purposes like forcing the instance.
    */
-  instance: T;
+  instance: T$1;
   /**
    * List of classes which use this class.
    */
@@ -1211,6 +1229,9 @@ interface Hooks {
     prevValue: any;
   };
 }
+interface Configurable<T$1 extends object = any> {
+  options: T$1;
+}
 //#endregion
 //#region src/interfaces/Run.d.ts
 interface RunOptions {
@@ -1366,15 +1387,15 @@ declare const $hook: {
   <T extends keyof Hooks>(options: HookOptions<T>): HookDescriptor<T>;
   [KIND]: typeof HookDescriptor;
 };
-interface HookOptions<T extends keyof Hooks> {
+interface HookOptions<T$1 extends keyof Hooks> {
   /**
    * The name of the hook. "configure", "start", "ready", "stop", ...
    */
-  on: T;
+  on: T$1;
   /**
    * The handler to run when the hook is triggered.
    */
-  handler: (args: Hooks[T]) => Async<any>;
+  handler: (args: Hooks[T$1]) => Async<any>;
   /**
    * Force the hook to run first or last on the list of hooks.
    */
@@ -1388,7 +1409,7 @@ interface HookOptions<T extends keyof Hooks> {
    */
   after?: object | Array<object>;
 }
-declare class HookDescriptor<T extends keyof Hooks> extends Descriptor<HookOptions<T>> {
+declare class HookDescriptor<T$1 extends keyof Hooks> extends Descriptor<HookOptions<T$1>> {
   called: number;
   protected onInit(): void;
 }
@@ -1447,5 +1468,5 @@ declare global {
  */
 declare const run: (entry: Alepha | Service | Array<Service>, opts?: RunOptions) => void;
 //#endregion
-export { $cursor, $env, $hook, $inject, $module, AbstractClass, Alepha, AlephaError, AlsProvider, AppNotStartedError, Async, AsyncFn, AsyncLocalStorageData, CircularDependencyError, ContainerLockedError, CursorDescriptor, Descriptor, DescriptorArgs, DescriptorConfig, DescriptorFactory, DescriptorFactoryLike, Env, FileLike, Hook, HookDescriptor, HookOptions, Hooks, InjectDescriptor, InjectOptions, InstantiableClass, KIND, LogLevel, LoggerInterface, MaybePromise, Module, ModuleDescriptorOptions, OPTIONS, Service, ServiceEntry, ServiceSubstitution, State, StateManager, type Static, type StaticDecode, type StaticEncode, StreamLike, type TAny, type TArray, type TBigInt, type TBoolean, TFile, type TInteger, type TKeysToIndexer, type TNull, type TNumber, type TNumberOptions, type TObject, type TObjectOptions, type TOptional, type TOptionalAdd, type TPick, type TProperties, type TRecord, type TSchema, TStream, type TString, type TStringOptions, TTextOptions, type TTuple, type TUnion, type TVoid, TextLength, TooLateSubstitutionError, TypeBox, TypeBoxError, TypeBoxFormat, TypeBoxValue, TypeGuard, TypeProvider, WithModule, __alephaRef, createDescriptor, isDate, isDateTime, isEmail, isFileLike, isTypeFile, isURL, isUUID, run, t };
+export { $cursor, $env, $hook, $inject, $module, AbstractClass, Alepha, AlephaError, AlsProvider, AppNotStartedError, Async, AsyncFn, AsyncLocalStorageData, CircularDependencyError, Configurable, ContainerLockedError, CursorDescriptor, Descriptor, DescriptorArgs, DescriptorConfig, DescriptorFactory, DescriptorFactoryLike, Env, FileLike, Hook, HookDescriptor, HookOptions, Hooks, InjectDescriptor, InjectOptions, InstantiableClass, KIND, LogLevel, LoggerInterface, MaybePromise, Module, ModuleDescriptorOptions, OPTIONS, Service, ServiceEntry, ServiceSubstitution, State, StateManager, type Static, type StaticDecode, type StaticEncode, StreamLike, type TAny, type TArray, type TBigInt, type TBoolean, TFile, type TInteger, type TKeysToIndexer, type TNull, type TNumber, type TNumberOptions, type TObject, type TObjectOptions, type TOptional, type TOptionalAdd, type TPick, type TProperties, type TRecord, type TSchema, TStream, type TString, type TStringOptions, TTextOptions, type TTuple, type TUnion, type TVoid, TextLength, TooLateSubstitutionError, TypeBox, TypeBoxError, TypeBoxFormat, TypeBoxValue, TypeGuard, TypeProvider, WithModule, __alephaRef, createDescriptor, isDate, isDateTime, isEmail, isFileLike, isTypeFile, isURL, isUUID, run, t };
 //# sourceMappingURL=index.d.ts.map