@meridianjs/types 0.1.6 → 0.1.8

package/README.md

@@ -0,0 +1,101 @@
+# @meridianjs/types
+
+Shared TypeScript interfaces and types for the MeridianJS ecosystem. This package is a pure type declaration library — no runtime code, no dependencies.
+
+## Installation
+
+```bash
+npm install @meridianjs/types
+```
+
+## Overview
+
+All public contracts between MeridianJS packages live here. Consuming packages import from `@meridianjs/types` rather than from each other, keeping the dependency graph flat and preventing circular imports.
+
+## Exported Types
+
+### Container & DI
+
+```typescript
+import type { MeridianContainer } from "@meridianjs/types"
+
+// The DI container interface — resolve tokens, register values, create child scopes
+interface MeridianContainer {
+  resolve<T = unknown>(token: string): T
+  register(registrations: Record<string, unknown>): void
+  createScope(): MeridianContainer
+  dispose?(): Promise<void>
+}
+```
+
+### Module System
+
+```typescript
+import type { ModuleDefinition, LoaderFn, LoaderOptions, LinkableConfig } from "@meridianjs/types"
+```
+
+### Configuration
+
+```typescript
+import type { MeridianConfig, ProjectConfig, ModuleConfig, PluginConfig } from "@meridianjs/types"
+```
+
+### Event Bus
+
+```typescript
+import type { IEventBus, EventMessage, SubscriberFn, SubscriberArgs, SubscriberConfig } from "@meridianjs/types"
+```
+
+### Scheduler
+
+```typescript
+import type { IScheduler, ScheduledJobConfig } from "@meridianjs/types"
+```
+
+### HTTP / Auth
+
+```typescript
+import type { AuthenticatedUser, MeridianRequestBase } from "@meridianjs/types"
+
+// JWT payload shape attached to req.user
+interface AuthenticatedUser {
+  id: string
+  workspaceId: string
+  roles: string[]
+  permissions: string[]
+}
+```
+
+### Logger
+
+```typescript
+import type { ILogger } from "@meridianjs/types"
+```
+
+### Domain Enums
+
+```typescript
+import type {
+  IssueType,       // "bug" | "feature" | "task" | "epic" | "story"
+  IssuePriority,   // "urgent" | "high" | "medium" | "low" | "none"
+  SprintStatus,    // "planned" | "active" | "completed"
+  ProjectVisibility,
+  WorkspacePlan,
+} from "@meridianjs/types"
+```
+
+### Storage & Email
+
+```typescript
+import type { IStorageProvider, IEmailService, EmailSendOptions } from "@meridianjs/types"
+```
+
+### Plugin System
+
+```typescript
+import type { PluginRegistrationContext, PluginRegisterFn } from "@meridianjs/types"
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -54,6 +54,7 @@ interface ModuleConfig {
 interface PluginConfig {
     resolve: string;
     options?: Record<string, unknown>;
+    disableSubscribers?: string[];
 }
 interface AdminConfig {
     disable?: boolean;
@@ -189,6 +190,15 @@ interface EmailSendOptions {
 interface IEmailService {
     send(options: EmailSendOptions): Promise<void>;
 }
+interface EmailTemplateOverride {
+    subject?: string;
+    text?: string;
+    html?: string;
+}
+interface IEmailTemplateService {
+    /** Return an override object for the given event + contextual data, or null to use defaults. */
+    render(event: string, data: unknown): EmailTemplateOverride | null;
+}
 interface PluginRegistrationContext {
     container: MeridianContainer;
     pluginOptions: Record<string, unknown>;
@@ -196,4 +206,4 @@ interface PluginRegistrationContext {
 }
 type PluginRegisterFn = (ctx: PluginRegistrationContext) => Promise<void>;
 
-export type { AdminConfig, AuthenticatedUser, EmailSendOptions, EventMessage, IEmailService, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IStorageProvider, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };
+export type { AdminConfig, AuthenticatedUser, EmailSendOptions, EmailTemplateOverride, EventMessage, IEmailService, IEmailTemplateService, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IStorageProvider, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };

package/dist/index.d.ts

@@ -54,6 +54,7 @@ interface ModuleConfig {
 interface PluginConfig {
     resolve: string;
     options?: Record<string, unknown>;
+    disableSubscribers?: string[];
 }
 interface AdminConfig {
     disable?: boolean;
@@ -189,6 +190,15 @@ interface EmailSendOptions {
 interface IEmailService {
     send(options: EmailSendOptions): Promise<void>;
 }
+interface EmailTemplateOverride {
+    subject?: string;
+    text?: string;
+    html?: string;
+}
+interface IEmailTemplateService {
+    /** Return an override object for the given event + contextual data, or null to use defaults. */
+    render(event: string, data: unknown): EmailTemplateOverride | null;
+}
 interface PluginRegistrationContext {
     container: MeridianContainer;
     pluginOptions: Record<string, unknown>;
@@ -196,4 +206,4 @@ interface PluginRegistrationContext {
 }
 type PluginRegisterFn = (ctx: PluginRegistrationContext) => Promise<void>;
 
-export type { AdminConfig, AuthenticatedUser, EmailSendOptions, EventMessage, IEmailService, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IStorageProvider, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };
+export type { AdminConfig, AuthenticatedUser, EmailSendOptions, EmailTemplateOverride, EventMessage, IEmailService, IEmailTemplateService, IEventBus, ILogger, IModuleService, IQuery, IScheduler, IStorageProvider, IssuePriority, IssueStatus, IssueType, LinkDefinition, LinkEndpoint, LinkableConfig, LinkableEntry, LoaderFn, LoaderOptions, MeridianConfig, MeridianContainer, MeridianRequestBase, ModuleConfig, ModuleDefinition, NotificationChannel, PluginConfig, PluginRegisterFn, PluginRegistrationContext, ProjectConfig, ProjectStatus, ProjectVisibility, QueryGraphOptions, ScheduledJobConfig, ScheduledJobFn, SprintStatus, StepConfig, StepContext, SubscriberArgs, SubscriberConfig, SubscriberFn, TeamRole, WorkerMode, WorkflowConfig, WorkspacePlan };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meridianjs/types",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "Shared TypeScript types and interfaces for Meridian",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",