@ddd-tool/domain-designer-cli 0.0.0-alpha.9 → 0.1.0-beta.1

package/templates/node_modules/@ddd-tool/domain-designer-core/common.d.ts

@@ -1,10 +1,11 @@
-import { NonEmptyArray, DomainDesignAgg, DomainDesignAggProvider, DomainDesignCommand, DomainDesignCommandProvider, DomainDesignDescProvider, DomainDesignEvent, DomainDesignEventProvider, DomainDesignFacadeCommand, DomainDesignFacadeCommandProvider, DomainDesignInfoProvider, DomainDesignActor, DomainDesignActorProvider, DomainDesignPolicy, DomainDesignPolicyProvider, DomainDesignService, DomainDesignServiceProvider, DomainDesignSystem, DomainDesignSystemProvider, DomainDesignReadModel, DomainDesignReadModelProvider, CustomInfoArrayToInfoObject, DomainDesignInfo, DomainDesignInfoType } from '@ddd-tool/domain-designer-core/define';
+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 './define';
 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;
-    createDesc: DomainDesignDescProvider;
+    options: DomainDesignOptions;
+    createNote: DomainDesignNoteProvider;
     createInfo: DomainDesignInfoProvider;
     createActor: DomainDesignActorProvider;
     createCommand: DomainDesignCommandProvider;
@@ -16,160 +17,29 @@ type ContextInitializer = () => {
     createSystem: DomainDesignSystemProvider;
     createReadModel: DomainDesignReadModelProvider;
 };
+export declare function defaultOptions(): Required<DomainDesignOptions>;
 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, srcCode: string, targetRule: Rule, targetCode: string, linkType?: LinkType): void;
-    getId(): string;
+    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, object>;
-    getCommands(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "Command";
-            name: string;
-            infos: any;
-            description?: Readonly<{
-                readonly _attributes: {
-                    rule: "Desc";
-                    readonly template: TemplateStringsArray;
-                    readonly values: import("@ddd-tool/domain-designer-core/define").DomainDesignDescValue[];
-                };
-            }> | undefined;
-        };
-        inner: any;
-        agg<AGG extends DomainDesignAgg<any>>(agg: AGG): AGG;
-        agg<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, agg: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
-    }>[];
-    getFacadeCommands(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "FacadeCommand";
-            name: string;
-            infos: any;
-            description?: Readonly<{
-                readonly _attributes: {
-                    rule: "Desc";
-                    readonly template: TemplateStringsArray;
-                    readonly values: import("@ddd-tool/domain-designer-core/define").DomainDesignDescValue[];
-                };
-            }> | undefined;
-        };
-        inner: any;
-        agg<AGG extends DomainDesignAgg<any>>(agg: AGG): AGG;
-        agg<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, agg: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
-        service(service: DomainDesignService): DomainDesignService;
-        service(name: string, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignService;
-    }>[];
-    getActors(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "Actor";
-            name: string;
-            description?: import("@ddd-tool/domain-designer-core/define").DomainDesignDesc;
-        };
-        command<COMMAND extends DomainDesignCommand<any>>(command: COMMAND): COMMAND;
-        command<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
-        facadeCmd<FACADECMD extends DomainDesignFacadeCommand<any>>(command: FACADECMD): FACADECMD;
-        facadeCmd<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
-        readModel<READ_MODEL extends DomainDesignReadModel<any>>(readModel: READ_MODEL): READ_MODEL;
-        readModel<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | import("@ddd-tool/domain-designer-core/define").NonEmptyInitFunc<() => ARR>): DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
-    }>[];
-    getEvents(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "Event";
-            name: string;
-            infos: any;
-            description?: Readonly<{
-                readonly _attributes: {
-                    rule: "Desc";
-                    readonly template: TemplateStringsArray;
-                    readonly values: import("@ddd-tool/domain-designer-core/define").DomainDesignDescValue[];
-                };
-            }> | undefined;
-        };
-        inner: any;
-        policy(policy: DomainDesignPolicy): DomainDesignPolicy;
-        policy(name: string, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignPolicy;
-        system(system: DomainDesignSystem): DomainDesignSystem;
-        system(name: string, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignSystem;
-        readModel<READ_MODEL extends DomainDesignReadModel<any>>(readModel: READ_MODEL): READ_MODEL;
-        readModel<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | import("@ddd-tool/domain-designer-core/define").NonEmptyInitFunc<() => ARR>): DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
-    }>[];
-    getPolicies(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "Policy";
-            name: string;
-            description?: import("@ddd-tool/domain-designer-core/define").DomainDesignDesc;
-        };
-        service(service: DomainDesignService): DomainDesignService;
-        service(name: string, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignService;
-    }>[];
-    getServices(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "Service";
-            name: string;
-            description?: import("@ddd-tool/domain-designer-core/define").DomainDesignDesc;
-        };
-        command<COMMAND extends DomainDesignCommand<any>>(command: COMMAND): COMMAND;
-        command<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
-        facadeCmd<FACADECMD extends DomainDesignFacadeCommand<any>>(facadeCmd: FACADECMD): FACADECMD;
-        facadeCmd<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
-        agg<AGG extends DomainDesignAgg<any>>(agg: AGG): AGG;
-        agg<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, agg: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
-    }>[];
-    getSystems(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "System";
-            name: string;
-            description?: import("@ddd-tool/domain-designer-core/define").DomainDesignDesc;
-        };
-        command<COMMAND extends DomainDesignCommand<any>>(command: COMMAND): COMMAND;
-        command<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
-        facadeCmd<FACADECMD extends DomainDesignFacadeCommand<any>>(facadeCmd: FACADECMD): FACADECMD;
-        facadeCmd<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
-    }>[];
-    getAggs(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "Agg";
-            name: string;
-            infos: any;
-            description?: Readonly<{
-                readonly _attributes: {
-                    rule: "Desc";
-                    readonly template: TemplateStringsArray;
-                    readonly values: import("@ddd-tool/domain-designer-core/define").DomainDesignDescValue[];
-                };
-            }> | undefined;
-        };
-        inner: any;
-        event<EVENT extends DomainDesignEvent<any>>(event: EVENT): EVENT;
-        event<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc): DomainDesignEvent<CustomInfoArrayToInfoObject<ARR>>;
-    }>[];
-    getReadModels(): Readonly<{
-        readonly _attributes: {
-            __code: string;
-            rule: "ReadModel";
-            name: string;
-            infos: any;
-            description?: Readonly<{
-                readonly _attributes: {
-                    rule: "Desc";
-                    readonly template: TemplateStringsArray;
-                    readonly values: import("@ddd-tool/domain-designer-core/define").DomainDesignDescValue[];
-                };
-            }> | undefined;
-        };
-        inner: any;
-    }>[];
+    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;
@@ -179,13 +49,22 @@ declare function createInternalContext(initFn: ContextInitializer): {
     registerSystem(system: DomainDesignSystem): void;
     registerAgg(agg: DomainDesignAgg<any>): void;
     registerReadModel(readModel: DomainDesignReadModel<any>): void;
-    customInfoArrToInfoObj<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<any, G_NAME> | G_NAME>>(arr: ARR): CustomInfoArrayToInfoObject<ARR>;
-    createDesc: DomainDesignDescProvider;
+    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: {
-        any: <NAME extends string>(name: NAME, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc) => DomainDesignInfo<"Any", NAME>;
-        entity: <NAME extends string, ARR extends Array<DomainDesignInfo<DomainDesignInfoType, string> | string>>(name: NAME, infos?: ARR, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc) => DomainDesignInfo<"Entity", NAME>;
-        func: <NAME extends string>(name: NAME, dependsOn: NonEmptyArray<import("@ddd-tool/domain-designer-core/define").DomainDesignInfoFuncDependsOn | string>, desc?: string | import("@ddd-tool/domain-designer-core/define").DomainDesignDesc) => DomainDesignInfo<"Function", NAME>;
-        field: import("@ddd-tool/domain-designer-core/define").DomainDesignInfoFieldProvider;
+        document<NAME extends string>(name: NAME, note?: string | import("./define").DomainDesignNote): DomainDesignInfo<"Document", NAME>;
+        func<NAME extends string>(name: NAME, note?: string | import("./define").DomainDesignNote): DomainDesignInfo<"Function", NAME>;
+        func<NAME extends string>(name: NAME, dependsOn: NonEmptyArray<import("./define").DomainDesignInfoFuncDependsOn | string | [string, string | import("./define").DomainDesignNote]>, note?: string | import("./define").DomainDesignNote): DomainDesignInfo<"Function", NAME>;
+        id<NAME extends string>(name: NAME, note?: string | import("./define").DomainDesignNote): DomainDesignInfo<"Id", NAME>;
+        valueObj<NAME extends string>(name: NAME, note?: string | import("./define").DomainDesignNote): DomainDesignInfo<"ValueObject", NAME>;
+        version<NAME extends string>(name: NAME, note?: string | import("./define").DomainDesignNote): DomainDesignInfo<"Version", NAME>;
     };
     createPersion: DomainDesignActorProvider;
     createCommand: DomainDesignCommandProvider;