@zintrust/core 0.1.18 → 0.1.20

package/src/templates/project/basic/config/storage.ts.tpl

@@ -1,141 +1,23 @@
 /**
- * Storage Configuration
- * File storage and cloud storage settings
- * Sealed namespace for immutability
+ * Storage Configuration (template)
+ *
+ * Keep this file declarative:
+ * - Core owns env parsing/default logic.
+ * - Projects can override values by editing `drivers` and `storageConfigObj`.
  */
 
-import { Env } from './env';
-import type { StorageConfigRuntime, StorageDriverConfig, StorageDrivers } from './type';
-import { ErrorFactory } from '@zintrust/core';
+import { storageConfig as coreStorageConfig } from '@zintrust/core';
 
-const hasOwn = <T extends object>(obj: T, key: PropertyKey): key is keyof T => {
-  return Object.prototype.hasOwnProperty.call(obj, key);
-};
+type StorageConfigShape = typeof coreStorageConfig;
 
-const getStorageDriver = (config: StorageConfigRuntime, name?: string): StorageDriverConfig => {
-  const selected = String(name ?? config.default).trim();
-  const diskName = selected === 'default' ? String(config.default).trim() : selected;
-  const isExplicitSelection =
-    name !== undefined && String(name).trim().length > 0 && String(name).trim() !== 'default';
+export const drivers = {
+  ...coreStorageConfig.drivers,
+} satisfies StorageConfigShape['drivers'];
 
-  if (diskName !== '' && hasOwn(config.drivers, diskName)) {
-    const resolved = config.drivers[diskName];
-    if (resolved !== undefined) return resolved;
-  }
-
-  if (isExplicitSelection) {
-    throw ErrorFactory.createConfigError(`Storage disk not configured: ${diskName}`);
-  }
-
-  if (Object.keys(config.drivers ?? {}).length === 0) {
-    throw ErrorFactory.createConfigError('No storage disks are configured');
-  }
-
-  throw ErrorFactory.createConfigError(
-    `Storage default disk not configured: ${diskName || '<empty>'}`
-  );
-};
-
-const getDrivers = (): StorageDrivers => ({
-  local: {
-    driver: 'local' as const,
-    root: Env.get('STORAGE_PATH', 'storage'),
-    url: Env.get('STORAGE_URL', '/storage'),
-    visibility: Env.get('STORAGE_VISIBILITY', 'private'),
-  },
-  s3: {
-    driver: 's3' as const,
-    accessKeyId: Env.get('AWS_ACCESS_KEY_ID', ''),
-    secretAccessKey: Env.get('AWS_SECRET_ACCESS_KEY', ''),
-    region: Env.AWS_REGION,
-    bucket: Env.get('AWS_S3_BUCKET', ''),
-    url: Env.get('AWS_S3_URL', ''),
-    endpoint: Env.get('AWS_S3_ENDPOINT', ''),
-    usePathStyleUrl: Env.getBool('AWS_S3_USE_PATH_STYLE_URL', false),
-  },
-  r2: {
-    driver: 'r2' as const,
-    accessKeyId: Env.get('R2_ACCESS_KEY_ID', ''),
-    secretAccessKey: Env.get('R2_SECRET_ACCESS_KEY', ''),
-    region: Env.get('R2_REGION', ''),
-    bucket: Env.get('R2_BUCKET', ''),
-    endpoint: Env.get('R2_ENDPOINT', ''),
-    url: Env.get('R2_URL', ''),
-  },
-  gcs: {
-    driver: 'gcs' as const,
-    projectId: Env.get('GCS_PROJECT_ID', ''),
-    keyFile: Env.get('GCS_KEY_FILE', ''),
-    bucket: Env.get('GCS_BUCKET', ''),
-    url: Env.get('GCS_URL', ''),
-  },
-});
-
-const storageConfigObj = {
-  /**
-   * Default storage driver (dynamic; tests may mutate process.env)
-   */
-  get default(): string {
-    return Env.get('STORAGE_CONNECTION', Env.get('STORAGE_DRIVER', 'local')).trim().toLowerCase();
-  },
-
-  /**
-   * Storage drivers configuration (dynamic; tests may mutate process.env)
-   */
-  get drivers(): StorageDrivers {
-    return getDrivers();
-  },
-
-  /**
-   * Get storage driver config
-   */
-  getDriver(this: StorageConfigRuntime): StorageDriverConfig {
-    return getStorageDriver(this);
-  },
-
-  /**
-   * Get a storage disk configuration by name.
-   *
-   * - When `name` is provided and not configured, this throws.
-   * - When `name` is omitted, it resolves the configured default with a backwards-compatible fallback.
-   * - Reserved name `default` aliases the configured default.
-   */
-  getDriverConfig(this: StorageConfigRuntime, name?: string): StorageDriverConfig {
-    return getStorageDriver(this, name);
-  },
-
-  /**
-   * Temporary file settings
-   */
-  get temp(): { path: string; maxAge: number } {
-    return {
-      path: Env.get('TEMP_PATH', 'storage/temp'),
-      maxAge: Env.getInt('TEMP_FILE_MAX_AGE', 86400), // 24 hours
-    };
-  },
-
-  /**
-   * Uploads settings
-   */
-  get uploads(): { maxSize: string; allowedMimes: string; path: string } {
-    return {
-      maxSize: Env.get('MAX_UPLOAD_SIZE', '100mb'),
-      allowedMimes: Env.get('ALLOWED_UPLOAD_MIMES', 'jpg,jpeg,png,pdf,doc,docx'),
-      path: Env.get('UPLOADS_PATH', 'storage/uploads'),
-    };
-  },
-
-  /**
-   * Backups settings
-   */
-  get backups(): { path: string; driver: string } {
-    return {
-      path: Env.get('BACKUPS_PATH', 'storage/backups'),
-      driver: Env.get('BACKUP_DRIVER', 's3'),
-    };
-  },
-};
-
-export const storageConfig = Object.freeze(storageConfigObj);
+export const storageConfigObj = {
+  ...coreStorageConfig,
+  drivers,
+} satisfies StorageConfigShape;
 
+export const storageConfig = storageConfigObj;
 export type StorageConfig = typeof storageConfig;

package/src/templates/project/basic/config/type.ts.tpl

@@ -1,445 +1,37 @@
-import { Env } from './env';
-import type { Middleware as MiddlewareFn } from '@zintrust/core';
-
-export type Environment =
-  | 'development'
-  | 'dev'
-  | 'production'
-  | 'prod'
-  | 'pro'
-  | 'testing'
-  | 'test';
-export type StartMode = 'development' | 'production' | 'testing';
-
-export type EnvGetValue = ReturnType<typeof Env.get>;
-export type EnvGetBoolValue = ReturnType<typeof Env.getBool>;
-
-export type LocalStorageDriverConfig = {
-  driver: 'local';
-  root: EnvGetValue;
-  url: EnvGetValue;
-  visibility: EnvGetValue;
-};
-
-export type S3StorageDriverConfig = {
-  driver: 's3';
-  accessKeyId: EnvGetValue;
-  secretAccessKey: EnvGetValue;
-  region: typeof Env.AWS_REGION;
-  bucket: EnvGetValue;
-  url: EnvGetValue;
-  endpoint: EnvGetValue;
-  usePathStyleUrl: EnvGetBoolValue;
-};
-
-export type R2StorageDriverConfig = {
-  driver: 'r2';
-  accessKeyId: EnvGetValue;
-  secretAccessKey: EnvGetValue;
-  region: EnvGetValue;
-  bucket: EnvGetValue;
-  endpoint: EnvGetValue;
-  url: EnvGetValue;
-};
-
-export type GcsStorageDriverConfig = {
-  driver: 'gcs';
-  projectId: EnvGetValue;
-  keyFile: EnvGetValue;
-  bucket: EnvGetValue;
-  url: EnvGetValue;
-};
-
-export type StorageDriverConfig =
-  | LocalStorageDriverConfig
-  | S3StorageDriverConfig
-  | R2StorageDriverConfig
-  | GcsStorageDriverConfig;
-
-export type StorageDrivers = Record<string, StorageDriverConfig>;
-
-export type StorageDriverName = keyof StorageDrivers;
-
-export type StorageConfigRuntime = {
-  readonly default: string;
-  readonly drivers: StorageDrivers;
-};
-
-export type StartupConfigValidationError = {
-  key: string;
-  value: unknown;
-  message: string;
-};
-
-export type StartupConfigValidationResult = {
-  valid: boolean;
-  errors: StartupConfigValidationError[];
-};
-
-export interface CloudflareKV {
-  get(key: string): Promise<string | null>;
-  put(key: string, value: string, options?: { expirationTtl?: number }): Promise<void>;
-  delete(key: string): Promise<void>;
-  list(options?: { prefix?: string }): Promise<{ keys: { name: string }[] }>;
-}
-
-export interface SecretConfig {
-  platform: 'aws' | 'cloudflare' | 'deno' | 'local';
-  region?: string;
-  kv?: CloudflareKV; // Cloudflare KV namespace
-}
-
-export interface SecretValue {
-  key: string;
-  value: string;
-  expiresAt?: number;
-  rotationEnabled?: boolean;
-}
-
-export interface GetSecretOptions {
-  cacheTtl?: number; // Cache time-to-live in milliseconds
-  throwIfMissing?: boolean;
-}
-
-export interface SetSecretOptions {
-  expirationTtl?: number; // Expiration time-to-live in seconds
-  metadata?: Record<string, unknown>;
-}
-
-export interface SecretsManagerInstance {
-  getSecret(key: string, options?: GetSecretOptions): Promise<string>;
-  setSecret(key: string, value: string, options?: SetSecretOptions): Promise<void>;
-  deleteSecret(key: string): Promise<void>;
-  rotateSecret(key: string): Promise<void>;
-  listSecrets(pattern?: string): Promise<string[]>;
-  clearCache(key?: string): void;
-}
-
-export type QueueDriverName = 'sync' | 'database' | 'redis' | 'rabbitmq' | 'sqs';
-
-export type SyncQueueDriverConfig = {
-  driver: 'sync';
-};
-
-export type DatabaseQueueDriverConfig = {
-  driver: 'database';
-  table: string;
-  connection: string;
-};
-
-export type RedisQueueDriverConfig = {
-  driver: 'redis';
-  host: string;
-  port: number;
-  password?: string;
-  database: number;
-};
-
-export type RabbitMqQueueDriverConfig = {
-  driver: 'rabbitmq';
-  host: string;
-  port: number;
-  username: string;
-  password: string;
-  vhost: string;
-};
-
-export type SqsQueueDriverConfig = {
-  driver: 'sqs';
-  key?: string;
-  secret?: string;
-  region: string;
-  queueUrl?: string;
-};
-
-export type QueueDriversConfig = {
-  sync: SyncQueueDriverConfig;
-  database: DatabaseQueueDriverConfig;
-  redis: RedisQueueDriverConfig;
-  rabbitmq: RabbitMqQueueDriverConfig;
-  sqs: SqsQueueDriverConfig;
-};
-
-export type QueueConfigWithDrivers = {
-  default: QueueDriverName;
-  drivers: QueueDriversConfig;
-};
-
-export type KnownNotificationDriverName = 'console' | 'termii' | 'twilio' | 'slack';
-
-export type ConsoleNotificationDriverConfig = { driver: 'console' };
-
-export type TermiiNotificationDriverConfig = {
-  driver: 'termii';
-  apiKey: string;
-  sender: string;
-  endpoint: string;
-};
-
-export type TwilioNotificationDriverConfig = {
-  driver: 'twilio';
-  accountSid: string;
-  authToken: string;
-  fromNumber: string;
-};
-
-export type SlackNotificationDriverConfig = {
-  driver: 'slack';
-  webhookUrl: string;
-};
-
-export type KnownNotificationDriverConfig =
-  | ConsoleNotificationDriverConfig
-  | TermiiNotificationDriverConfig
-  | TwilioNotificationDriverConfig
-  | SlackNotificationDriverConfig;
-
-export type NotificationDrivers = Record<string, KnownNotificationDriverConfig>;
-
-export type NotificationConfigInput = {
-  default: string;
-  drivers: NotificationDrivers;
-};
-
-export type NotificationProviders = {
-  console: ConsoleNotificationDriverConfig;
-  termii: TermiiNotificationDriverConfig;
-  twilio: TwilioNotificationDriverConfig;
-  slack: SlackNotificationDriverConfig;
-};
-
-export type MiddlewareConfigType = {
-  global: MiddlewareFn[];
-  route: Record<string, MiddlewareFn>;
-};
-
-export type MailDriverName = 'disabled' | 'sendgrid' | 'smtp' | 'ses' | 'mailgun' | 'nodemailer';
-
-export type DisabledMailDriverConfig = {
-  driver: 'disabled';
-};
-
-export type SendGridMailDriverConfig = {
-  driver: 'sendgrid';
-  apiKey: string;
-};
-
-export type MailgunMailDriverConfig = {
-  driver: 'mailgun';
-  apiKey: string;
-  domain: string;
-  baseUrl: string;
-};
-
-// Placeholders for future drivers (kept config-first)
-export type SmtpMailDriverConfig = {
-  driver: 'smtp';
-  host: string;
-  port: number;
-  username: string;
-  password: string;
-  secure: boolean | 'starttls';
-};
-
-export type NodemailerMailDriverConfig = {
-  driver: 'nodemailer';
-  host: string;
-  port: number;
-  username: string;
-  password: string;
-  secure: boolean | 'starttls';
-};
-
-export type SesMailDriverConfig = {
-  driver: 'ses';
-  region: string;
-};
-
-export type MailDriverConfig =
-  | DisabledMailDriverConfig
-  | SendGridMailDriverConfig
-  | MailgunMailDriverConfig
-  | SmtpMailDriverConfig
-  | NodemailerMailDriverConfig
-  | SesMailDriverConfig;
-
-export type MailDrivers = Record<string, MailDriverConfig>;
-
-export type MailConfigInput = {
-  /**
-   * Default mailer key name.
-   *
-   * This is intentionally a string to support named mailers (e.g. 'transactional', 'marketing').
-   * The underlying driver is selected by the `driver` field within each mailer config.
-   */
-  default: string;
-  from: {
-    address: string;
-    name: string;
-  };
-  drivers: MailDrivers;
-};
-
-export type ProcessLike = {
-  env?: Record<string, string | undefined>;
-  execPath?: string;
-  platform?: string;
-};
-
-export type SqliteConnectionConfig = {
-  driver: 'sqlite';
-  database: string;
-  migrations: string;
-};
-
-export type PostgresqlConnectionConfig = {
-  driver: 'postgresql';
-  host: string;
-  port: number;
-  database: string;
-  username: string;
-  password: string;
-  ssl: boolean;
-  pooling: {
-    enabled: boolean;
-    min: number;
-    max: number;
-    idleTimeout: number;
-    connectionTimeout: number;
-  };
-};
-
-export type MysqlConnectionConfig = {
-  driver: 'mysql';
-  host: string;
-  port: number;
-  database: string;
-  username: string;
-  password: string;
-  pooling: {
-    enabled: boolean;
-    min: number;
-    max: number;
-  };
-};
-
-export type DatabaseConnectionConfig =
-  | SqliteConnectionConfig
-  | PostgresqlConnectionConfig
-  | MysqlConnectionConfig;
-
 /**
- * Named database connection configs.
+ * Config Types (template)
  *
- * Keys represent connection names (e.g. 'default', 'auth', 'tasks', 'db1').
- */
-export type DatabaseConnections = Record<string, DatabaseConnectionConfig>;
-
-/**
- * Default connection name.
+ * Keep this file declarative:
+ * - Core owns canonical type definitions.
  */
-export type DatabaseConfigShape = {
-  default: string;
-  connections: DatabaseConnections;
-};
-
-export type WorkersEnv = Record<string, unknown>;
-
-export type KVNamespace = {
-  get(
-    key: string,
-    options?: { type: 'text' | 'json' | 'arrayBuffer' | 'stream' }
-  ): Promise<unknown>;
-  put(
-    key: string,
-    value: string | ReadableStream | ArrayBuffer | FormData,
-    options?: { expiration?: number; expirationTtl?: number; metadata?: unknown }
-  ): Promise<void>;
-  delete(key: string): Promise<void>;
-};
-
-export type MemoryCacheDriverConfig = {
-  driver: 'memory';
-  ttl: number;
-};
-
-export type RedisCacheDriverConfig = {
-  driver: 'redis';
-  host: string;
-  port: number;
-  ttl: number;
-};
-
-export type MongoCacheDriverConfig = {
-  driver: 'mongodb';
-  uri: string;
-  db: string;
-  ttl: number;
-};
-
-export type KvCacheDriverConfig = {
-  driver: 'kv';
-  ttl: number;
-};
-
-export type KvRemoteCacheDriverConfig = {
-  driver: 'kv-remote';
-  ttl: number;
-};
-
-export type CacheDriverConfig =
-  | MemoryCacheDriverConfig
-  | RedisCacheDriverConfig
-  | MongoCacheDriverConfig
-  | KvCacheDriverConfig
-  | KvRemoteCacheDriverConfig;
-
-export type CacheDrivers = Record<string, CacheDriverConfig>;
-
-export type CacheConfigInput = {
-  default: string;
-  drivers: CacheDrivers;
-};
-
-export type KnownBroadcastDriverName = 'inmemory' | 'pusher' | 'redis' | 'redishttps';
-
-export type InMemoryBroadcastDriverConfig = {
-  driver: 'inmemory';
-};
-
-export type PusherBroadcastDriverConfig = {
-  driver: 'pusher';
-  appId: string;
-  key: string;
-  secret: string;
-  cluster: string;
-  useTLS: boolean;
-};
-
-export type RedisBroadcastDriverConfig = {
-  driver: 'redis';
-  host: string;
-  port: number;
-  password: string;
-  channelPrefix: string;
-};
-
-export type RedisHttpsBroadcastDriverConfig = {
-  driver: 'redishttps';
-  endpoint: string;
-  token: string;
-  channelPrefix: string;
-};
-
-export type KnownBroadcastDriverConfig =
-  | InMemoryBroadcastDriverConfig
-  | PusherBroadcastDriverConfig
-  | RedisBroadcastDriverConfig
-  | RedisHttpsBroadcastDriverConfig;
-
-export type BroadcastDrivers = Record<string, KnownBroadcastDriverConfig>;
 
-export type BroadcastConfigInput = {
-  default: string;
-  drivers: BroadcastDrivers;
-};
+export type {
+  BroadcastConfigInput,
+  BroadcastDrivers,
+  CacheConfigInput,
+  CacheDrivers,
+  DatabaseConfig,
+  DatabaseConfigShape,
+  DatabaseConnectionConfig,
+  DatabaseConnections,
+  KVNamespace,
+  KnownBroadcastDriverConfig,
+  KnownBroadcastDriverName,
+  MailConfig,
+  MailConfigInput,
+  MailDriverConfig,
+  MailDrivers,
+  MicroservicesConfig,
+  MiddlewareConfigType,
+  NotificationConfig,
+  NotificationConfigInput,
+  NotificationDrivers,
+  ProcessLike,
+  QueueConfig,
+  QueueConfigInput,
+  StorageConfig,
+  StorageConfigRuntime,
+  StorageDriverConfig,
+  StorageDrivers,
+  WorkersEnv,
+} from '@zintrust/core';

package/src/templates/project/basic/database/factories/UserFactory.ts.tpl

@@ -0,0 +1,80 @@
+import { faker } from '@faker-js/faker';
+
+interface UserFactoryData {
+  id: number;
+  name: string;
+  email: string;
+  password: string;
+  email_verified_at: string | null;
+  active: boolean;
+  created_at: string;
+  updated_at: string;
+  deleted_at?: string | null;
+}
+
+interface UserFactory {
+  data: (data: Record<string, unknown>) => UserFactory;
+  set: (key: string, value: unknown) => UserFactory;
+  state: (name: string) => UserFactory;
+  count: (n: number) => UserFactoryData[];
+  getActiveState: () => { active: boolean; deleted_at: null };
+  getInactiveState: () => { active: boolean };
+  getDeletedState: () => { deleted_at: string };
+  create: () => UserFactoryData;
+}
+
+const makeUserData = (): Omit<UserFactoryData, 'deleted_at'> => ({
+  id: faker.number.int({ min: 1, max: 1000 }),
+  name: faker.person.fullName(),
+  email: faker.internet.email(),
+  password: faker.internet.password(),
+  email_verified_at: faker.date.past().toISOString(),
+  active: true,
+  created_at: new Date().toISOString(),
+  updated_at: new Date().toISOString(),
+});
+
+let customData: Record<string, unknown> = {};
+let customStates: Record<string, Record<string, unknown>> = {};
+
+export const UserFactory = Object.freeze({
+  data(data: Record<string, unknown>): UserFactory {
+    customData = { ...data };
+    return UserFactory;
+  },
+
+  set(key: string, value: unknown): UserFactory {
+    customData[key] = value;
+    return UserFactory;
+  },
+
+  state(name: string): UserFactory {
+    customStates[name] = {};
+    return UserFactory;
+  },
+
+  count(n: number): UserFactoryData[] {
+    return Array.from({ length: n }, () => this.create());
+  },
+
+  getActiveState(): { active: boolean; deleted_at: null } {
+    return { active: true, deleted_at: null };
+  },
+
+  getInactiveState(): { active: boolean } {
+    return { active: false };
+  },
+
+  getDeletedState(): { deleted_at: string } {
+    return { deleted_at: new Date().toISOString() };
+  },
+
+  create(): UserFactoryData {
+    const base = makeUserData();
+    return {
+      ...base,
+      ...customData,
+      ...customStates,
+    } as UserFactoryData;
+  },
+}) as UserFactory;