@meridianjs/types 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,170 @@
+interface MeridianContainer {
+    resolve<T = unknown>(token: string): T;
+    register(registrations: Record<string, unknown>): void;
+    createScope(): MeridianContainer;
+}
+interface ModuleDefinition {
+    key: string;
+    service: new (...args: any[]) => IModuleService;
+    models?: unknown[];
+    loaders?: LoaderFn[];
+    linkable?: LinkableConfig;
+}
+interface IModuleService {
+    [method: string]: any;
+}
+type LoaderFn = (options: LoaderOptions) => Promise<void>;
+interface LoaderOptions {
+    container: MeridianContainer;
+    options?: Record<string, unknown>;
+    logger: ILogger;
+}
+interface LinkableConfig {
+    [modelName: string]: {
+        tableName: string;
+        primaryKey: string;
+    };
+}
+type WorkerMode = "shared" | "worker" | "server";
+interface ProjectConfig {
+    databaseUrl: string;
+    redisUrl?: string;
+    httpPort?: number;
+    jwtSecret: string;
+    cookieSecret?: string;
+    workerMode?: WorkerMode;
+    cors?: {
+        origin: string | string[];
+        credentials?: boolean;
+    };
+}
+interface MeridianConfig {
+    projectConfig: ProjectConfig;
+    modules?: ModuleConfig[];
+    plugins?: PluginConfig[];
+    admin?: AdminConfig;
+}
+interface ModuleConfig {
+    resolve: string | ModuleDefinition;
+    options?: Record<string, unknown>;
+}
+interface PluginConfig {
+    resolve: string;
+    options?: Record<string, unknown>;
+}
+interface AdminConfig {
+    disable?: boolean;
+    path?: string;
+}
+interface EventMessage<T = unknown> {
+    name: string;
+    data: T;
+    metadata?: Record<string, unknown>;
+}
+interface IEventBus {
+    emit<T>(event: EventMessage<T> | EventMessage<T>[]): Promise<void>;
+    subscribe(eventName: string, handler: SubscriberFn): void;
+    unsubscribe(eventName: string, handler: SubscriberFn): void;
+    close?(): Promise<void>;
+}
+type SubscriberFn<T = unknown> = (args: SubscriberArgs<T>) => Promise<void>;
+interface SubscriberArgs<T = unknown> {
+    event: EventMessage<T>;
+    container: MeridianContainer;
+}
+interface SubscriberConfig {
+    event: string | string[];
+    context?: Record<string, unknown>;
+}
+interface StepConfig {
+    name: string;
+    async?: boolean;
+    retries?: number;
+    timeout?: number;
+}
+interface StepContext {
+    container: MeridianContainer;
+    metadata?: Record<string, unknown>;
+}
+interface WorkflowConfig {
+    name: string;
+    retentionTime?: number;
+}
+interface ScheduledJobConfig {
+    name: string;
+    schedule: string | {
+        interval: number;
+    };
+    numberOfExecutions?: number;
+}
+type ScheduledJobFn = (container: MeridianContainer) => Promise<void>;
+interface IScheduler {
+    register(config: ScheduledJobConfig, fn: () => Promise<void>): Promise<void>;
+    close(): Promise<void>;
+}
+interface AuthenticatedUser {
+    id: string;
+    workspaceId: string;
+    roles: string[];
+}
+interface MeridianRequestBase {
+    scope: MeridianContainer;
+    user?: AuthenticatedUser;
+}
+interface ILogger {
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, meta?: Record<string, unknown>): void;
+    debug(message: string, meta?: Record<string, unknown>): void;
+}
+type IssueType = "bug" | "feature" | "task" | "epic" | "story";
+type IssuePriority = "urgent" | "high" | "medium" | "low" | "none";
+type IssueStatus = "backlog" | "todo" | "in_progress" | "in_review" | "done" | "cancelled";
+type ProjectVisibility = "private" | "public" | "workspace";
+type ProjectStatus = "active" | "archived" | "paused";
+type SprintStatus = "planned" | "active" | "completed";
+type NotificationChannel = "in_app" | "email" | "push";
+type WorkspacePlan = "free" | "pro" | "enterprise";
+type TeamRole = "admin" | "member" | "guest";
+interface LinkableEntry {
+    tableName: string;
+    primaryKey: string;
+}
+interface LinkEndpoint {
+    linkable: LinkableEntry;
+    isList?: boolean;
+    deleteCascades?: boolean;
+    field?: string;
+}
+interface LinkDefinition {
+    left: LinkEndpoint;
+    right: LinkEndpoint;
+    extraColumns?: Record<string, {
+        type: string;
+    }>;
+    readOnly?: boolean;
+    linkTableName: string;
+    entryPoint: string;
+}
+interface QueryGraphOptions {
+    entity: string;
+    fields: string[];
+    filters?: Record<string, unknown>;
+    pagination?: {
+        limit?: number;
+        offset?: number;
+    };
+}
+interface IQuery {
+    graph<T = unknown>(options: QueryGraphOptions): Promise<{
+        data: T[];
+    }>;
+}
+interface PluginRegistrationContext {
+    container: MeridianContainer;
+    pluginOptions: Record<string, unknown>;
+    addModule(config: ModuleConfig): Promise<void>;
+}
+type PluginRegisterFn = (ctx: PluginRegistrationContext) => Promise<void>;
+
+export type { AdminConfig, AuthenticatedUser, EventMessage, IEventBus, ILogger, IModuleService, IQuery, IScheduler, 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

@@ -0,0 +1,170 @@
+interface MeridianContainer {
+    resolve<T = unknown>(token: string): T;
+    register(registrations: Record<string, unknown>): void;
+    createScope(): MeridianContainer;
+}
+interface ModuleDefinition {
+    key: string;
+    service: new (...args: any[]) => IModuleService;
+    models?: unknown[];
+    loaders?: LoaderFn[];
+    linkable?: LinkableConfig;
+}
+interface IModuleService {
+    [method: string]: any;
+}
+type LoaderFn = (options: LoaderOptions) => Promise<void>;
+interface LoaderOptions {
+    container: MeridianContainer;
+    options?: Record<string, unknown>;
+    logger: ILogger;
+}
+interface LinkableConfig {
+    [modelName: string]: {
+        tableName: string;
+        primaryKey: string;
+    };
+}
+type WorkerMode = "shared" | "worker" | "server";
+interface ProjectConfig {
+    databaseUrl: string;
+    redisUrl?: string;
+    httpPort?: number;
+    jwtSecret: string;
+    cookieSecret?: string;
+    workerMode?: WorkerMode;
+    cors?: {
+        origin: string | string[];
+        credentials?: boolean;
+    };
+}
+interface MeridianConfig {
+    projectConfig: ProjectConfig;
+    modules?: ModuleConfig[];
+    plugins?: PluginConfig[];
+    admin?: AdminConfig;
+}
+interface ModuleConfig {
+    resolve: string | ModuleDefinition;
+    options?: Record<string, unknown>;
+}
+interface PluginConfig {
+    resolve: string;
+    options?: Record<string, unknown>;
+}
+interface AdminConfig {
+    disable?: boolean;
+    path?: string;
+}
+interface EventMessage<T = unknown> {
+    name: string;
+    data: T;
+    metadata?: Record<string, unknown>;
+}
+interface IEventBus {
+    emit<T>(event: EventMessage<T> | EventMessage<T>[]): Promise<void>;
+    subscribe(eventName: string, handler: SubscriberFn): void;
+    unsubscribe(eventName: string, handler: SubscriberFn): void;
+    close?(): Promise<void>;
+}
+type SubscriberFn<T = unknown> = (args: SubscriberArgs<T>) => Promise<void>;
+interface SubscriberArgs<T = unknown> {
+    event: EventMessage<T>;
+    container: MeridianContainer;
+}
+interface SubscriberConfig {
+    event: string | string[];
+    context?: Record<string, unknown>;
+}
+interface StepConfig {
+    name: string;
+    async?: boolean;
+    retries?: number;
+    timeout?: number;
+}
+interface StepContext {
+    container: MeridianContainer;
+    metadata?: Record<string, unknown>;
+}
+interface WorkflowConfig {
+    name: string;
+    retentionTime?: number;
+}
+interface ScheduledJobConfig {
+    name: string;
+    schedule: string | {
+        interval: number;
+    };
+    numberOfExecutions?: number;
+}
+type ScheduledJobFn = (container: MeridianContainer) => Promise<void>;
+interface IScheduler {
+    register(config: ScheduledJobConfig, fn: () => Promise<void>): Promise<void>;
+    close(): Promise<void>;
+}
+interface AuthenticatedUser {
+    id: string;
+    workspaceId: string;
+    roles: string[];
+}
+interface MeridianRequestBase {
+    scope: MeridianContainer;
+    user?: AuthenticatedUser;
+}
+interface ILogger {
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, meta?: Record<string, unknown>): void;
+    debug(message: string, meta?: Record<string, unknown>): void;
+}
+type IssueType = "bug" | "feature" | "task" | "epic" | "story";
+type IssuePriority = "urgent" | "high" | "medium" | "low" | "none";
+type IssueStatus = "backlog" | "todo" | "in_progress" | "in_review" | "done" | "cancelled";
+type ProjectVisibility = "private" | "public" | "workspace";
+type ProjectStatus = "active" | "archived" | "paused";
+type SprintStatus = "planned" | "active" | "completed";
+type NotificationChannel = "in_app" | "email" | "push";
+type WorkspacePlan = "free" | "pro" | "enterprise";
+type TeamRole = "admin" | "member" | "guest";
+interface LinkableEntry {
+    tableName: string;
+    primaryKey: string;
+}
+interface LinkEndpoint {
+    linkable: LinkableEntry;
+    isList?: boolean;
+    deleteCascades?: boolean;
+    field?: string;
+}
+interface LinkDefinition {
+    left: LinkEndpoint;
+    right: LinkEndpoint;
+    extraColumns?: Record<string, {
+        type: string;
+    }>;
+    readOnly?: boolean;
+    linkTableName: string;
+    entryPoint: string;
+}
+interface QueryGraphOptions {
+    entity: string;
+    fields: string[];
+    filters?: Record<string, unknown>;
+    pagination?: {
+        limit?: number;
+        offset?: number;
+    };
+}
+interface IQuery {
+    graph<T = unknown>(options: QueryGraphOptions): Promise<{
+        data: T[];
+    }>;
+}
+interface PluginRegistrationContext {
+    container: MeridianContainer;
+    pluginOptions: Record<string, unknown>;
+    addModule(config: ModuleConfig): Promise<void>;
+}
+type PluginRegisterFn = (ctx: PluginRegistrationContext) => Promise<void>;
+
+export type { AdminConfig, AuthenticatedUser, EventMessage, IEventBus, ILogger, IModuleService, IQuery, IScheduler, 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.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@meridianjs/types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types and interfaces for Meridian",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "*"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}