appos 0.2.1-0 → 0.2.2-0

package/build/exports/server/index.d.mts

@@ -1,327 +0,0 @@
-import { CustomTypeOptions, InitOptions, InitOptions as InitI18nOptions, i18n, i18n as i18n$1 } from "i18next";
-import { z } from "zod";
-import pino, { LoggerOptions } from "pino";
-import * as nodemailer_lib_dkim0 from "nodemailer/lib/dkim";
-import * as nodemailer_lib_smtp_transport0 from "nodemailer/lib/smtp-transport";
-import * as nodemailer0 from "nodemailer";
-import * as nodemailer_lib_shared0 from "nodemailer/lib/shared";
-import * as nodemailer_lib_mailer_mail_message0 from "nodemailer/lib/mailer/mail-message";
-import Mail from "nodemailer/lib/mailer/index.ts";
-import { JSX } from "react";
-import * as _keyv_redis0 from "@keyv/redis";
-import { KeyvRedisOptions, RedisClientOptions, RedisClientType } from "@keyv/redis";
-import * as drizzle_orm_node_postgres0 from "drizzle-orm/node-postgres";
-import { AnyRelations, EmptyRelations } from "drizzle-orm";
-import { Pool, PoolConfig } from "pg";
-import { Span } from "@opentelemetry/api";
-
-//#region src/server/config.d.ts
-/**
- * The config base schema.
- */
-declare const baseSchema: z.ZodObject<{
-  APP_NAME: z.ZodDefault<z.ZodString>;
-  APP_DESC: z.ZodDefault<z.ZodString>;
-}, z.core.$strip>;
-/**
- * Creates a configuration object by merging base config with user-defined schema.
- *
- * Variables in default values are expanded after defaults are applied.
- * For example: `DATABASE_URL: z.string().default("postgres://{{DB_HOST}}:5432")`
- *
- * @param userSchema User-defined Zod schema to merge with base config.
- * @returns Parsed and validated configuration object.
- */
-declare function defineConfig<T extends z.ZodRawShape = {}>(userSchema: z.ZodObject<T>): Config<T>;
-/**
- * The configuration type inferred from the merged schema.
- */
-type Config<T extends z.ZodRawShape = {}> = z.infer<ReturnType<typeof baseSchema.extend<T>>>;
-//#endregion
-//#region src/server/logger.d.ts
-/**
- * Extended logger options with OpenTelemetry support.
- */
-interface DefineLoggerOptions extends LoggerOptions {}
-/**
- * The logger instance type.
- */
-type Logger = Awaited<ReturnType<typeof defineLogger>>;
-/**
- * Define the logger instance.
- *
- * @param opts - The options.
- * @returns The logger.
- */
-declare function defineLogger(opts: DefineLoggerOptions): Promise<pino.Logger<never, boolean>>;
-//#endregion
-//#region src/server/mailer.d.ts
-/**
- * The mailer type.
- */
-type Mailer = ReturnType<typeof defineMailer>;
-/**
- * The mailer payload type with React component.
- */
-type MailerPayloadReact = Omit<Mail.Options, "from" | "html" | "text"> & {
-  /**
-   * The email address to send the email from.
-   */
-  from?: string;
-  /**
-   * The React component to render as the email body.
-   */
-  react: JSX.Element;
-};
-/**
- * The mailer payload type with direct HTML and text.
- */
-type MailerPayloadHtml = Omit<Mail.Options, "from"> & {
-  /**
-   * The email address to send the email from.
-   */
-  from?: string;
-  /**
-   * The HTML content of the email.
-   */
-  html: string;
-  /**
-   * The plain text content of the email.
-   */
-  text: string;
-};
-/**
- * The mailer payload type - supports either React component or direct HTML+text.
- */
-type MailerPayload = MailerPayloadReact | MailerPayloadHtml;
-/**
- * Define the options for the mailer.
- */
-interface DefineMailerOptions {
-  /**
-   * The default email address to use as the sender.
-   */
-  from: string;
-  /**
-   * The SMTP URL to use for sending emails.
-   */
-  smtpUrl: string;
-}
-/**
- * Define the mailer.
- *
- * @param env - The environment variables.
- * @returns The mailer.
- */
-declare function defineMailer({
-  from,
-  smtpUrl
-}: DefineMailerOptions): {
-  send(payload: MailerPayload): Promise<void>;
-  options: Mail.Options;
-  meta: Map<string, any>;
-  dkim: nodemailer_lib_dkim0;
-  transporter: nodemailer0.Transport<nodemailer_lib_smtp_transport0.SentMessageInfo, nodemailer0.TransportOptions>;
-  logger: nodemailer_lib_shared0.Logger;
-  MailMessage: nodemailer_lib_mailer_mail_message0<nodemailer_lib_smtp_transport0.SentMessageInfo>;
-  _defaults: nodemailer_lib_smtp_transport0.Options;
-  removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): nodemailer0.Transporter<nodemailer_lib_smtp_transport0.SentMessageInfo, nodemailer_lib_smtp_transport0.Options>;
-  off<K>(eventName: string | symbol, listener: (...args: any[]) => void): nodemailer0.Transporter<nodemailer_lib_smtp_transport0.SentMessageInfo, nodemailer_lib_smtp_transport0.Options>;
-  removeAllListeners(eventName?: string | symbol | undefined): nodemailer0.Transporter<nodemailer_lib_smtp_transport0.SentMessageInfo, nodemailer_lib_smtp_transport0.Options>;
-  setMaxListeners(n: number): nodemailer0.Transporter<nodemailer_lib_smtp_transport0.SentMessageInfo, nodemailer_lib_smtp_transport0.Options>;
-  getMaxListeners(): number;
-  rawListeners<K>(eventName: string | symbol): Function[];
-  listenerCount<K>(eventName: string | symbol, listener?: Function | undefined): number;
-  eventNames(): (string | symbol)[];
-};
-//#endregion
-//#region src/store/cache.d.ts
-/**
- * The cache instance type.
- */
-type Cache = Awaited<ReturnType<typeof defineCache>>;
-/**
- * Options for defining the cache.
- */
-type DefineCacheOptions = {
-  /**
-   * The connection string or Redis client options.
-   */
-  connect: string | RedisClientOptions | RedisClientType;
-  /**
-   * The logger instance.
-   */
-  logger: Logger;
-  /**
-   * The Keyv Redis options.
-   */
-  options?: KeyvRedisOptions;
-};
-/**
- * Define the cache instance.
- *
- * @param opts - The options for defining the cache.
- * @returns The cache instance.
- */
-declare function defineCache({
-  connect,
-  logger,
-  options
-}: DefineCacheOptions): Promise<_keyv_redis0.Keyv<any>>;
-//#endregion
-//#region src/store/database.d.ts
-/**
- * Options for defining the database.
- */
-interface DefineDatabaseOptions<TSchema extends Record<string, unknown> = Record<string, never>, TRelations extends AnyRelations = EmptyRelations> {
-  logger: Logger;
-  poolConfig: PoolConfig;
-  relations?: TRelations;
-  schema?: TSchema;
-}
-/**
- * The database type.
- */
-type Database = Awaited<ReturnType<typeof defineDatabase>>;
-/**
- * Define the database with the provided options.
- *
- * @param opts The options for defining the database, including pool configuration, relations, and schema.
- * @template TSchema The schema type for the database.
- * @template TRelations The relations type for the database.
- * @returns
- */
-declare function defineDatabase<TSchema extends Record<string, unknown> = Record<string, never>, TRelations extends AnyRelations = EmptyRelations>(opts: DefineDatabaseOptions<TSchema, TRelations>): Promise<drizzle_orm_node_postgres0.NodePgDatabase<TSchema, TRelations> & {
-  $client: Pool;
-}>;
-//#endregion
-//#region src/server/container.d.ts
-/**
- * The base application container type that holds required services like
- * config, databases, and caches.
- */
-interface AppContainer {
-  /**
-   * The application configuration.
-   */
-  config: Config;
-  /**
-   * A map of caches available in the application.
-   */
-  cache: Record<string, Cache>;
-  /**
-   * A map of databases available in the application.
-   */
-  db: Record<string, Database>;
-  /**
-   * The i18n instance for internationalization.
-   */
-  i18n: i18n$1;
-  /**
-   * The logger instance for logging messages.
-   */
-  logger: Logger;
-  /**
-   * The mailer instance for sending emails.
-   */
-  mailer: Mailer;
-}
-/**
- * Global namespace for user container augmentation.
- * Users can extend Container interface in their container.ts file.
- */
-declare global {
-  namespace AppOS {
-    interface Container {}
-  }
-}
-/**
- * The container type used throughout the application.
- * Merges base AppContainer with user's custom Container augmentations.
- */
-type Container = AppContainer & AppOS.Container;
-/**
- * Defines an application container with type-safe validation and inference.
- *
- * This helper function ensures that:
- * 1. All required base fields (config, cache, db) are provided
- * 2. Custom fields are fully preserved in the inferred type
- * 3. TypeScript provides autocomplete for all fields in commands/routes
- *
- * @template T - The container type extending AppContainer
- * @param container - The container object with required and custom fields
- * @returns The same container object with full type inference
- *
- * @example
- * ```typescript
- * // In your container.ts file:
- * export async function defineContainer() {
- *   const config = defineConfig(z.object({
- *     API_KEY: z.string(),
- *   }));
- *
- *   return defineAppContainer({
- *     cache: {},
- *     config,
- *     db: {},
- *     // Add custom field - they'll be fully typed!
- *     test: "hello",
- *   });
- * }
- *
- * // In your commands:
- * defineCommand({
- *   async run(args, opts, container) {
- *     console.log(container.test); // Autocompletes "test" field
- *   }
- * });
- * ```
- */
-declare function defineAppContainer<T extends AppContainer>(container: T): T;
-//#endregion
-//#region src/server/i18n.d.ts
-/**
- * Initializes i18next instance with the provided options.
- *
- * @param opts Initialization options for i18next.
- * @returns A promise that resolves to the initialized i18next instance.
- */
-declare function defineI18n(opts: InitOptions): Promise<i18n$1>;
-//#endregion
-//#region src/server/otel.d.ts
-/**
- * Wraps an async function with an OpenTelemetry span for distributed tracing.
- *
- * Automatically handles span lifecycle (start/end), error recording, and context propagation.
- * The span will appear as a child of the currently active span (if any).
- *
- * @param tracerName - Fully qualified module path (e.g., "api/routes/payouts", "packages/primitives/mailer")
- * @param spanName - Operation name following {verb} {object} pattern (e.g., "fetch payouts", "send email")
- * @param fn - The async function to execute within the span context. Receives span for custom attributes.
- * @param attributes - Optional span attributes for high-cardinality data (IDs, counts, etc.).
- *                     Use semantic conventions: https://opentelemetry.io/docs/specs/semconv/
- * @returns Promise resolving to the function's return value.
- *
- * @example
- * // Basic usage - simple business operation
- * await withOtelSpan("api/routes/payouts", "fetch payouts", async () => {
- *   return await db.query.payouts.findMany();
- * });
- *
- * @example
- * // With attributes and custom span data
- * const payouts = await withOtelSpan(
- *   "api/routes/payouts",
- *   "fetch payouts",
- *   async (span) => {
- *     const results = await db.query.payouts.findMany();
- *     span.setAttribute("payouts.count", results.length);
- *     span.addEvent("cache.miss");
- *     return results;
- *   },
- *   { "payouts.limit": 100, "payouts.offset": 0 }
- * );
- */
-declare function withOtelSpan<T>(fn: (span: Span) => Promise<T>, attributes?: Record<string, string | number | boolean>): Promise<T>;
-//#endregion
-export { AppContainer, Config, Container, type CustomTypeOptions, DefineLoggerOptions, DefineMailerOptions, type InitI18nOptions, Logger, Mailer, MailerPayload, MailerPayloadHtml, MailerPayloadReact, baseSchema, defineAppContainer, defineConfig, defineI18n, defineLogger, defineMailer, type i18n, withOtelSpan };