@cosmicdrift/kumiko-框架

Kumiko-发动机、管道、API、DB、事件存储和 每一分钱都能让久美子走.

Bun + Hono + 的多租户、基于命令、事件源应用程序框架 后发相. 定义特性、注册实体、写入命令——框架 电线发送、持久性、预测、同步用户和实时 交货.

见 单列波根 README 为了更大的投出 文件/计划 建筑目录,以及 样本/ 用于每个特性的可运行示例.

安装

bun add @cosmicdrift/kumiko-framework
# peers you probably already have:
bun add hono ioredis zod

Bun是预定的运行时间和测试跑者.

闪亮

import { createEntity, createTextField, defineFeature } from "@cosmicdrift/kumiko-framework/engine";

export const taskEntity = createEntity({
  table: "read_tasks",
  fields: {
    title: createTextField({ required: true, searchable: true }),
    done: createTextField(),
  },
  softDelete: true,
});

export const taskFeature = defineFeature("tasks", (r) => {
  // r.crud wires create/update/delete/restore + list/detail queries in one
  // call — events + projection in the same TX, optimistic locking, access
  // control, all explicit via the options below.
  r.crud("task", taskEntity, {
    write: { access: { roles: ["User"] } },
    read: {
      access: {
        openToAll: {
          reason: "any signed-in user may list and view tasks; only writes are role-gated",
        },
      },
    },
  });

  // Read-model fed from task events, rebuildable via the CLI
  r.projection({
    name: "tasks-per-day",
    source: "task",
    table: tasksPerDayTable,
    apply: {
      "task.created": async (event, tx) => {
        /* count++ */
      },
    },
  });

  // Async consumer — runs after commit via the event-dispatcher,
  // cursor-based, at-least-once, per-consumer dead-letter semantics.
  // Omit `table` for pure side-effect handlers (mail, webhooks, ...).
  r.multiStreamProjection({
    name: "notify-new-task",
    apply: {
      "task.created": async (event) => {
        // e.g. push to an external notification service
      },
    },
  });
});

软件包出口

核心概念

• 作为部署单位的特点. defineFeature 登记实体, 写作/处理器、预测、活动后用户、生命周期钩、, 和翻译.
• 指挥入,出州. 写作是通过HTTP发送的命令; 发送器验证,强制访问,运行生命周期钩,持续 并触发一个TX的预测.
• 事件来源默认. 每一个字都经过 createEventStoreExecutor ,并将一个域事件附加到聚合流中。 自动生成 CRUD 活动(<entity>.created/updated/deleted/restored记录下来, 明确 ctx.events.append 用于有意的域事件。 预测反馈 关闭流中用于同-TX读后写入一致性.
• Async 通过光标的副作用. SSE广播、搜索索引和 特性注册 r.multiStreamProjection 消费者单打独斗 基于光标的调度器( AsyncDeamon 模式) 。 消费者检查站, n重试之后的死信.
• 多租户范围界定. 每个事件、实体、投影和搜索 索引带 tenantId。 。 。 . TenantDb 是拒绝的 TX 扫描包 在租户外写作.
• 乐观的货币. UNIQUE(aggregate_id, version) 活动说明 给原子附件+冲突检测; VersionConflictError 表面 种族作为一等值.
• 同上,p.c.c.c.c.c.c.c.c.c.c.c.c.c.c.d.c.c.c.c.c.c.d.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c.c. . . . . . . . . ......................................................................................... 关于事件的请求- id 备份独有索引 表格将重试变为重放. IdempotencyGuard 缓存写入 每一房客的结果.

状态

这个框架是1.0前的,进取快. 每个特性都有可运行的 样本 samples/;路线图生活在 文件/计划/基准。 。 。 .

许可证

麻省理工学院,看 自由主义。 。 。 .