@ddd-tool/domain-designer-cli 0.3.0 → 0.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ddd-tool/domain-designer-cli",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "private": false,
   "description": "",
   "type": "module",
@@ -9,7 +9,9 @@
   },
   "files": [
     "./bin",
+    "./packages/core/dist",
     "./packages/playground",
+    "./packages/ui-component/dist",
     "./scripts",
     "./templates",
     "./tsconfig.json"
@@ -59,7 +61,7 @@
     "dev:ui": "pnpm -F @ddd-tool/domain-designer-ui-component dev",
     "dev:page": "pnpm -F github-pages dev",
     "build": "pnpm syncver && pnpm -r build && pnpm fmt",
-    "fmt": "pnpm exec prettier --write \"**/*.{vue,ts}\"",
+    "fmt": "pnpm exec prettier --write \"**/*.{vue,ts,mjs}\"",
     "test": "pnpm -r test",
     "test:cli": "pnpm -F cli test",
     "verify": "pnpm -r verify",

package/packages/core/dist/README.md

@@ -0,0 +1,43 @@
+# domain-designer-core
+
+领域设计器核心库
+
+## 关于 api 命名
+
+- 多个单词能表示同一个意思时，选择使用频次高的
+
+- 遵循 ts 命名规范，函数名尽量保持在 8 个字母内，保留前缀，对后缀进行缩写
+
+- 如果缩写后的名称有明显歧义，那么干脆就不缩写了
+
+## 功能设计
+
+- [x] 提供一个 `createDomainDesigner` 函数，通过该函数能够实现用户在设计时的各种需求
+
+  - [x] 内部提供可链式调用的函数
+
+- [x] 提供一个 `checkDesigner` 函数，用于辅助检查完备性
+
+  - [x] 内置字符串相似性算法，用于辅助检查完备性
+
+## 关于 LinkType
+
+- Association: 关联关系。默认实线连线，表示稳定的关系，从一个节点到下一个节点
+
+- Dependency: 依赖关系。虚线连线，表示弱依赖关系。
+
+- Aggregation: 聚合关系。空心菱形箭头连线，表示从部分组成整体（部分可单独存在）
+
+- Composition: 组合关系。实心菱形箭头连线，表示从部分组成整体（部分不可单独存在，没有整体就没有部分）
+
+## 关于 wasm
+
+- 使用 rust 构建
+
+```shell
+cd wasm/
+
+wasm-pack build
+
+# -t, --target <TARGET> Sets the target environment. [possible values: bundler, nodejs, web, no-modules, deno] [default: bundler]
+```

package/packages/core/dist/actor.d.ts

@@ -0,0 +1,2 @@
+import { DomainDesignActorProvider } from './types'
+export declare function createActorProvider(designId: string): DomainDesignActorProvider

package/packages/core/dist/agg.d.ts

@@ -0,0 +1,2 @@
+import { DomainDesignAggProvider } from './types'
+export declare function createAggProvider(designId: string): DomainDesignAggProvider

package/packages/core/dist/command.d.ts

@@ -0,0 +1,3 @@
+import { DomainDesignCommandProvider, DomainDesignFacadeCommandProvider } from './types'
+export declare function createCommandProvider(designId: string): DomainDesignCommandProvider
+export declare function createFacadeCmdProvider(designId: string): DomainDesignFacadeCommandProvider

package/packages/core/dist/common.d.ts

@@ -0,0 +1,158 @@
+import {
+  NonEmptyArray,
+  DomainDesignAgg,
+  DomainDesignAggProvider,
+  DomainDesignCommand,
+  DomainDesignCommandProvider,
+  DomainDesignNoteProvider,
+  DomainDesignEvent,
+  DomainDesignEventProvider,
+  DomainDesignFacadeCommand,
+  DomainDesignFacadeCommandProvider,
+  DomainDesignInfoProvider,
+  DomainDesignActor,
+  DomainDesignActorProvider,
+  DomainDesignPolicy,
+  DomainDesignPolicyProvider,
+  DomainDesignService,
+  DomainDesignServiceProvider,
+  DomainDesignSystem,
+  DomainDesignSystemProvider,
+  DomainDesignReadModel,
+  DomainDesignReadModelProvider,
+  CustomInfoArrayToInfoObject,
+  DomainDesignInfo,
+  DomainDesignInfoType,
+  CustomInfo,
+  DomainDesignOptions,
+  DomainObjectSet,
+  DomainDesignObject,
+} from './types'
+export type LinkType = 'Association' | 'Dependency' | 'Aggregation' | 'Composition'
+type Rule =
+  | 'Info'
+  | 'Actor'
+  | 'Command'
+  | 'FacadeCommand'
+  | 'Agg'
+  | 'Event'
+  | 'Policy'
+  | 'Service'
+  | 'System'
+  | 'ReadModel'
+export declare function genId(): string
+type ContextInitializer = () => {
+  id: string
+  options: DomainDesignOptions
+  createNote: DomainDesignNoteProvider
+  createInfo: DomainDesignInfoProvider
+  createActor: DomainDesignActorProvider
+  createCommand: DomainDesignCommandProvider
+  createFacadeCommand: DomainDesignFacadeCommandProvider
+  createAgg: DomainDesignAggProvider
+  createEvent: DomainDesignEventProvider
+  createPolicy: DomainDesignPolicyProvider
+  createService: DomainDesignServiceProvider
+  createSystem: DomainDesignSystemProvider
+  createReadModel: DomainDesignReadModelProvider
+}
+export type DomainDesignInternalContext = ReturnType<typeof createInternalContext>
+declare function createInternalContext(initFn: ContextInitializer): {
+  startWorkflow(name: string): string
+  defineUserStory(name: string, workflowNames: NonEmptyArray<string>): void
+  linkTo(
+    srcRule: Rule,
+    srcId: string,
+    targetRule: Rule,
+    targetId: string,
+    linkType?: LinkType,
+  ): void
+  getDesignerId(): string
+  getDesignerOptions(): Required<DomainDesignOptions>
+  getWorkflows(): Record<string, string[]>
+  getUserStories(): Record<string, string[]>
+  getLinks(): Record<string, LinkType>
+  getIdMap(): Record<string, DomainDesignObject>
+  getAssociationMap(): Record<string, DomainObjectSet<DomainDesignObject>>
+  getCommands(): DomainDesignCommand<any>[]
+  getFacadeCommands(): DomainDesignFacadeCommand<any>[]
+  getActors(): DomainDesignActor[]
+  getEvents(): DomainDesignEvent<any>[]
+  getPolicies(): DomainDesignPolicy[]
+  getServices(): DomainDesignService[]
+  getSystems(): DomainDesignSystem[]
+  getAggs(): DomainDesignAgg<any>[]
+  getReadModels(): DomainDesignReadModel<any>[]
+  registerInfo(info: DomainDesignInfo<any, any>): void
+  registerCommand(command: DomainDesignCommand<any>): void
+  registerFacadeCommand(command: DomainDesignFacadeCommand<any>): void
+  registerActor(actor: DomainDesignActor): void
+  registerEvent(event: DomainDesignEvent<any>): void
+  registerPolicy(policy: DomainDesignPolicy): void
+  registerService(service: DomainDesignService): void
+  registerSystem(system: DomainDesignSystem): void
+  registerAgg(agg: DomainDesignAgg<any>): void
+  registerReadModel(readModel: DomainDesignReadModel<any>): void
+  customInfoArrToInfoObj<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(
+    arr: ARR,
+  ): CustomInfoArrayToInfoObject<ARR>
+  customInfoArrToInfoArr<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(
+    arr: ARR,
+  ): DomainDesignInfo<DomainDesignInfoType, string>[]
+  toFormat<
+    OBJ extends {
+      _attributes: {
+        __id: string
+        name: string
+      }
+    },
+  >(
+    obj: OBJ,
+  ): string
+  createNote: DomainDesignNoteProvider
+  info: {
+    document<NAME extends string>(
+      name: NAME,
+      note?: string | import('./types').DomainDesignNote,
+    ): DomainDesignInfo<'Document', NAME>
+    func<NAME extends string>(
+      name: NAME,
+      note?: string | import('./types').DomainDesignNote,
+    ): DomainDesignInfo<'Function', NAME>
+    func<NAME extends string>(
+      name: NAME,
+      dependsOn: NonEmptyArray<
+        | import('./types').DomainDesignInfoFuncDependsOn
+        | string
+        | [string, string | import('./types').DomainDesignNote]
+      >,
+      note?: string | import('./types').DomainDesignNote,
+    ): DomainDesignInfo<'Function', NAME>
+    id<NAME extends string>(
+      name: NAME,
+      note?: string | import('./types').DomainDesignNote,
+    ): DomainDesignInfo<'Id', NAME>
+    valueObj<NAME extends string>(
+      name: NAME,
+      note?: string | import('./types').DomainDesignNote,
+    ): DomainDesignInfo<'ValueObject', NAME>
+    version<NAME extends string>(
+      name: NAME,
+      note?: string | import('./types').DomainDesignNote,
+    ): DomainDesignInfo<'Version', NAME>
+  }
+  createPersion: DomainDesignActorProvider
+  createCommand: DomainDesignCommandProvider
+  createFacadeCommand: DomainDesignFacadeCommandProvider
+  createAgg: DomainDesignAggProvider
+  createEvent: DomainDesignEventProvider
+  createPolicy: DomainDesignPolicyProvider
+  createService: DomainDesignServiceProvider
+  createSystem: DomainDesignSystemProvider
+  createReadModel: DomainDesignReadModelProvider
+}
+export declare function useInternalContext(
+  designId: string,
+  initFn?: ContextInitializer,
+): DomainDesignInternalContext
+export {}

package/packages/core/dist/event.d.ts

@@ -0,0 +1,2 @@
+import { DomainDesignEventProvider } from './types'
+export declare function eventProvider(designId: string): DomainDesignEventProvider

package/packages/core/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { DomainDesigner, DomainDesignOptions } from './types'
+export declare function defaultOptions(): Required<DomainDesignOptions>
+export declare function createDomainDesigner(opts?: DomainDesignOptions): DomainDesigner
+export {
+  type DomainDesigner,
+  type DomainDesignAgg,
+  type DomainDesignCommand,
+  type DomainDesignFacadeCommand,
+  type DomainDesignNote,
+  type DomainDesignEvent,
+  type DomainDesignInfo,
+  type DomainDesignInfoType,
+  type DomainDesignActor,
+  type DomainDesignSystem,
+  type DomainDesignService,
+  type DomainDesignPolicy,
+  type DomainDesignInfoRecord,
+  type DomainDesignReadModel,
+  type DomainDesignObject,
+  DomainDesignRule,
+  isDomainDesignInfo,
+  isDomainDesignInfoFunc,
+  isDomainDesignActor,
+  isDomainDesignAgg,
+  isDomainDesignCommand,
+  isDomainDesignFacadeCommand,
+  isDomainDesignEvent,
+  isDomainDesignPolicy,
+  isDomainDesignReadModel,
+  isDomainDesignService,
+  isDomainDesignSystem,
+  isDomainDesigner,
+} from './types'