@appweaver/common

Shared configuration, logger, types, and utilities of Appweaver.

Description

@appweaver/common holds what every other Appweaver package builds on:

• Configuration – defineConfig, declaring the config sections every package and application reads by their short key names (appConfig.ENV), each validated by its TypeBox schema, from appweaver.json with its environments sections, the optional appweaver.<env>.json overlay, .env files, and environment variables, and the config accessors (config.str(), config.int(), ...) reading any flattened key as it is.
• Logger – the logger instance, a configured Pino logger.
• Types – the resource model, query filter, sort, aggregate, policy, and route types, and the ResourceRegistry that weaver generate fills so the factories infer the model types from a model name.
• Infrastructure contracts – the abstract Database, Cache, Memory, Queue, Scheduler, Storage, Mailer, Events, TemplateEngine, ImageProcessor, and SecurityStore classes the drivers implement.
• Modules – defineModule, the manifest of a module declaring its contracts, providers, services, setup, resources and startup code, the same format for the framework's own modules, npm packages, and the src/modules/ of an app.
• Lifecycle – the OnInit, OnReady, OnShutdown, and OnDestroy hooks of the application services.
• Utilities – string, object, date, and version helpers such as randomString and compareVersions.

Installation

It is installed with @appweaver/core, and is rarely added on its own:

npm install @appweaver/common

Usage

import { appConfig, logger, randomString } from '@appweaver/common';

logger.info({ env: appConfig.ENV }, 'Starting the application');

const token = randomString(32);

Documentation

• Appweaver README – getting started, configuration, and the overview of every package
• Agent skill – the complete framework reference shipped to every scaffolded project

License

Appweaver is MIT licensed.