@drhomet/mithaq

中文文档
0.3.10发布于 2026/11/01MITES Module近 30 天下载 1963

npm

此软件包已被标记为弃用

Moved to a private registry; no longer published on npm.

中文使用文档
文档目录7 节
  1. 为什么它存在
  2. 快开始
  3. 一个小例子
  4. 盒子里的东西
  5. 所需资源
  6. 文档
  7. 地位和执照

米萨克语name

npm

mithaq是一种TypeScript语言,用于一次声明后端及其管理员,并构建数据库,API,验证,访问规则和从该一次声明开始的管理员屏幕.

软件包是 @drhomet/mithaq。它是1.0前的,因此API在发布之间仍然可能有所改变.

约名为阿拉伯语. API中的其他词也是阿拉伯语,每个词都定义在下面的最初位置.

为什么它存在

  • 一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一一. 一个kayan的字段,类型和规则成为了Postgres表(通过细雨),输入计划(通过zod),HTTP操作以及管理员表和列表. 没有被宣布两次, 所以没有漂移.
  • 词汇被冻结. 密塔克船的种类、规则和目标仅由维护者的明确决定而改变。 一个项目也可以用签名的方式封存自己的语言 mithaq.lock。 。 。 . mithaq lock --check,应用程序运行之前 dev, (中文(简体) ), build 财务报告和审定财务报表 preview,然后当词汇与锁不匹配时失败。 签名更改需要弹出时显示的代码, 绝不在命令的输出中, 因此脚本或代理运行 mithaq lock 无法认可它.
  • 房客的隔离是核心的. 将租地放入租地的卡扬人属于一个组织. Core为每一项业务增加了租户范围,并将其与项目本身的准入与And合并,因此任何准入规则都无法扩大. 在活跃的组织中写作土地 unique 每个组织建立规则和指数组.
  • 默认是明确的. 项目名称 :defaultOperations, (中文(简体) ), defaultFields, (中文(简体) ), defaultAuthorize在它自己的代码。 核心不会回到它自己的默认状态: 将需要的配置留出就是类型错误或拒绝 buildAsas。 。 。 .
  • 管理员是你的代码 当你想要的. 屏幕是阴影组件,项目从 mithaq-admin 以自己的原始人画像; mithaq eject 将其中任何一个像其他文件一样放入项目编辑中 .

快开始

bun create mithaq my-app --full

这为模板的三个步骤,即语言(packages/mithaq),每个特性的软件包(packages/features/*和他们所建造的房屋packages/asas),和两个应用: 租户应用(:apps/asas-tanstack它为仪表板和门户以及后台控制台提供服务(apps/asas-backoffice),适用于在各组织工作的工作人员。 它写着一个 .env 带着新的秘密和运行 bun install。 。 。 . --full 取每个加法,整个实例;没有它,项目是最小的, 认证和 a tags 实例,以及 --with roles,courses 选取加词.

然后,与PostgreSQL 15 或后来为数据库服务 DATABASE_URL 名称在 packages/asas/.env数字 :

cd my-app
cd packages/asas
# push the schema, make the dev admin and fill its organization, development only
bun run dev:setup --seed
cd ../..
bun run --cwd apps/asas-tanstack dev   # the tenant app, http://localhost:5173
bun run --cwd apps/asas-backoffice dev   # in a second terminal: the backoffice console, http://localhost:5174

签名到两个应用程序 DEV_ADMIN_EMAIL 财务报告和审定财务报表 DEV_ADMIN_PASSWORD 从 packages/asas/.env: dev 管理员拥有"Dev 管理员"的工作空间,它 --seed 满了,是后台的 super_admin。 。 。 .

在生产中, connect() 不推动计划;而是检查迁移文件. 正在生产 解释如何应用它们.

一个小例子

一种语言来自 defineMithaq. 其arkan (singular rukn,"柱")是可插接部件,能带来种类和规则; base 把运来的东西拿来 其目标就是每项宣言所包含的内容.

// src/mithaq.ts
import {
  base, defaultAuthorize, defaultBulkLimit, defaultDepth, defaultJoinLimit, defaultLimit, defaultMaxLimit,
  defineMithaq, drizzleAdapter, drizzleKinds, drizzleRules, drizzleIdKinds, serviceTarget, zodKinds, zodRules, zodIdKinds, zodTarget,
} from 'mithaq'

export const { defineKayan, buildAsas } = defineMithaq({
  locales: ['en', 'ar'] as const,
  arkan: [base],
  targets: {
    drizzle: drizzleAdapter({ connectionString: process.env.DATABASE_URL!, kinds: drizzleKinds, rules: drizzleRules, idKinds: drizzleIdKinds }),
    zod: zodTarget({ kinds: zodKinds, rules: zodRules, idKinds: zodIdKinds }),
    service: serviceTarget({
      authorize: defaultAuthorize,
      depth: defaultDepth,
      defaultLimit,
      maxLimit: defaultMaxLimit,
      joinLimit: defaultJoinLimit,
      bulkLimit: defaultBulkLimit,
      store: 'drizzle',
      schema: 'zod',
    }),
  },
})

一个kayan ("实体")是一个数据类型: 它的字段,它们的种类和规则,它的存取和操作. 每个标签每个语言所申报的地块都带有一个字符串,一个缺失的就是类型错误.

// src/tags.ts
import { defaultFields, defaultOperations } from 'mithaq'
import { defineKayan } from './mithaq.ts'

export const tags = defineKayan({
  name: 'tags',
  access: { read: () => true },
  targets: { service: { operations: defaultOperations } },
  fields: {
    ...defaultFields,
    name: {
      kind: 'text',
      label: { en: 'Name', ar: 'الاسم' },
      rules: { required: true, unique: true, trim: true, maxLength: 60 },
    },
  },
})

buildAsas 构建as("建立"),运行时间 :

// src/asas.ts
import { defaultMaxBodyBytes, fetchHttp } from 'mithaq'
import { buildAsas } from './mithaq.ts'
import { tags } from './tags.ts'

export const asas = buildAsas({ kayan: [tags], http: [fetchHttp({ maxBodyBytes: defaultMaxBodyBytes, onError: console.error })] })

asas.handler(request) 回复 a Request 带有 Response; 将其挂入 /api 在任何服务器上。 与 fetchHttp, (中文(简体) ), POST /api/tags/create 用JSON机体创建标签 POST /api/tags/find 列出他们。 在发展中, asas.connect() 把计划推到Postgres。 一个宣布不访问的卡扬人只回答管理构建的名称,所以这个打开的卡扬人向所有人宣读.

为了让kayan属于一个组织,在语言中加入租户目标,并将其领域:

// in defineMithaq's targets:
tenant: betterAuthTenant({ relationTo: 'organization', onDelete: 'restrict', newRows: 'active', organizations: 'many' }),

// in a kayan's fields, with `tenant` taken from the language's `targets`:
organization: tenant.field,

unique: true 然后每个组织都独一无二 indexes: [{ within: 'organization', unique: [['code', 'term']] }] 宣布一个复合体. 租赁 拥有完整的规则.

盒子里的东西

  • 存储 : 通过细雨(drizzleAdapter),在发展和移民档案方面有计划推动,编写者: mithaq migrate 用于生产.
  • 验证 : 源自每个卡扬的zod计划(zodTarget) (中文(简体) ). 一个字段可以携带自己的zod形状取而代之.
  • 运行时间 : 操作跑者(serviceTarget)与默认操作(创建,更新,删除,查找,查找ByID,计数,更新Many,删除Many)相接相接,每写一行相接,审计步骤,软删除和批量限制.
  • HTTP : (韩语) 平面获取路径( e)fetchHttp),或一个通过 ORPC 输入的客户端和 OpenAPI (mithaq/orpc) (中文(简体) ).
  • 访问 : 基于角色的访问,每个操作和每个字段都有许可密钥(rbacTarget, (中文(简体) ), betterAuthTarget 将角色保留在Better Auth自己的表格中,或 memberRoleTarget auth自己的成员角色).
  • 租赁: betterAuthTenant超过更好的奥特组织.
  • 认证 : 更好的奥特( E)betterAuth)或当地账户(local),与 mithaq generate auth 写更好的奥斯卡扬.
  • 版本和草案: 页:1 versions rukn保存一行过去的版本,有草稿,自动保存并恢复.
  • 文件 : 页:1 storage 鲁克恩和 upload 有点 用于本地磁盘的模板船适配器Cloudflare R2,S3兼容服务并上传Thing作为项目文件.
  • 丰富文本 : 页:1 richText 鲁克恩,在莱克西克。 共享节点、 JSON 阅读器、 政策和登记簿 @drhomet/mithaq-rich-text,用于没有mithaq服务器的应用程序.
  • 管理屏幕 : screenTarget 描述每个屏幕; mithaq generate screens 将其路由写入主机应用程序, React 组件来自 mithaq-admin 软件包,用应用程序本身的 shadcn 原始物绘制,并且一个工程抛出它想要拥有的. mithaq upgrade --check 比较它持有的文件和已安装的版本.
  • 复制 : mithaq generate messages 将工程的标签和信件写入每个kayan一个文件,并拒绝丢失一个地方的标签.

mithaq --help 列出每个命令.

所需资源

  • npm,pnpm 10.6 或以后,Yarn 1 或 阿宝 1.3,以运行为准 create mithaq. Yarn 2 并随后为一单列波的每个工作空间安装了 mithaq 复制件,建筑拒绝,所以单列波尚未取出.
  • 节点.js 24或后.
  • PostgreSQL 15 或晚点.
  • TypeScript,由项目安装.

文档

每个向导是 README.md 它描述的文件夹.

  • 在Mithaq项目中工作: 开始,每个文件生活的地方,增加一个kayan,一个特性或一个步骤,并运行在制作中. 它在每一个创造出来的项目中都有船.
  • 密萨克语:语言,种类,规则,kayan,目标,跑道和访问,并添加了rukn,一种,目标或可配置的特征.
  • 租赁:每个组织卡扬,核心执行,以及每个组织指数.
  • 这个 mithaq 命令:每个命令,旗帜和退出代码.
  • 生产移徙数字 : pending: 'refuse' 或者说 'run',咨询锁,并用手进行迁移.
  • 管理软件包:屏幕组件,弹出一个, mithaq upgrade --check,迁移一个保存副本的项目,并增加登记项目.
  • 捐款:设置,检查,寄存器布局,并发送拉出请求.

地位和执照

mithaq 是前1.0。 (笑声) 这个模板 bun create mithaq 创建是实例, 和所有的文件都会被评论.

麻省理工学院许可证;见 自由主义改编的代码来自波克,Openstatus的取时器, 阴影编辑器 财务报告和审定财务报表 语法他们的麻省理工学院通知 液压/负载.txt, (中文(简体) ), LICENSES/开放状态-时间选择器.txt, (中文(简体) ), 密码/阴影编辑.txt 财务报告和审定财务报表 液态/液态.txt。 。 。 .

SQL 设备上 覆盖本地独有的kayan,注入了数据库,捆绑了迁移和电话接线.

版本与发布记录

@drhomet/mithaq 共发布 15 个版本,首次发布于 2026/10/12;过去 12 个月发布了 15 个版本。

版本发布日期距今
0.3.10latest2026/11/0114 天前
0.3.92026/11/0115 天前
0.3.72026/10/2720 天前
0.3.62026/10/2224 天前
0.3.52026/10/2224 天前
0.3.42026/10/2225 天前

关于 @drhomet/mithaq 的常见问题

如何安装 @drhomet/mithaq?

在项目目录运行 npm install @drhomet/mithaq,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:better-auth(1.7.4)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 mithaq、mithaq-check-rich-text,可以用 npx mithaq 直接运行。

@drhomet/mithaq 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/drhomet__mithaq 是否存在。

@drhomet/mithaq 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@drhomet/mithaq 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@drhomet/mithaq 可以商用吗?

@drhomet/mithaq 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@drhomet/mithaq 的下载量有多少?

根据 npm 官方下载统计,@drhomet/mithaq 在 2026/10/13 – 2026/11/11 这 30 天内被下载 1,963 次,日均约 65 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@drhomet/mithaq 还在维护吗?

最新版本 0.3.10 发布于 2026/11/01(14 天前);至今共发布 15 个版本,其中过去 12 个月发布了 15 个;首次发布于 2026/10/12。作者已将其标记为弃用,新项目建议寻找替代方案。