@ddd-tool/domain-designer-cli 0.0.0-alpha.8 → 0.1.0-beta.0

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

@@ -1,172 +1,306 @@
-export interface DomainDesignDescProvider {
-    (temp: undefined): undefined;
-    (temp: string): DomainDesignDesc;
-    (temp: DomainDesignDesc): DomainDesignDesc;
-    (temp: TemplateStringsArray, ...values: DomainDesignDescValue[]): DomainDesignDesc;
+export declare class DomainObjectSet<T extends DomainDesignObject> implements Iterable<T> {
+    private record;
+    add(item: T): void;
+    has(item: T): boolean;
+    getById(__id: string): T;
+    delete(item: T): boolean;
+    [Symbol.iterator](): Iterator<T>;
+}
+export type DomainDesignRule = 'Note' | 'Info' | 'Actor' | 'Command' | 'FacadeCommand' | 'Event' | 'Agg' | 'System' | 'Policy' | 'Service' | 'ReadModel';
+export interface DomainDesignObject {
+    readonly _attributes: {
+        readonly rule: DomainDesignRule;
+        readonly __id: string;
+        readonly name: string;
+        readonly note?: DomainDesignNote;
+    };
 }
-export type DomainDesignDesc = Readonly<{
+export type DomainDesignNoteProvider = {
+    (temp: undefined): undefined;
+    (temp: string): DomainDesignNote;
+    (temp: DomainDesignNote): DomainDesignNote;
+    (temp: TemplateStringsArray, ...values: DomainDesignNoteInject[]): DomainDesignNote;
+};
+export type DomainDesignNote = Readonly<{
     readonly _attributes: {
-        rule: 'Desc';
+        rule: Extract<DomainDesignRule, 'Note'>;
         readonly template: TemplateStringsArray;
-        readonly values: DomainDesignDescValue[];
+        readonly inject: DomainDesignNoteInject[];
     };
 }>;
-export type DomainDesignDescValue = DomainDesignInfo<any, any> | DomainDesignCommand<any> | DomainDesignFacadeCommand<any> | DomainDesignEvent<any> | DomainDesignAgg<any> | DomainDesignActor | DomainDesignSystem | DomainDesignPolicy | DomainDesignService;
+export type DomainDesignNoteInject = DomainDesignInfo<any, any> | DomainDesignCommand<any> | DomainDesignFacadeCommand<any> | DomainDesignEvent<any> | DomainDesignAgg<any> | DomainDesignActor | DomainDesignSystem | DomainDesignPolicy | DomainDesignService;
 export type DomainDesignInfoProvider = () => {
-    any: <NAME extends string>(name: NAME, desc?: string | DomainDesignDesc) => DomainDesignInfo<'Any', NAME>;
-    entity: <NAME extends string, ARR extends Array<DomainDesignInfo<DomainDesignInfoType, string> | string>>(name: NAME, infos?: ARR, desc?: string | DomainDesignDesc) => DomainDesignInfo<'Entity', NAME>;
-    func: <NAME extends string>(name: NAME, dependsOn: NonEmptyArray<DomainDesignInfoFuncDependsOn | string>, desc?: string | DomainDesignDesc) => DomainDesignInfo<'Function', NAME>;
-    field: DomainDesignInfoFieldProvider;
+    document<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Document', NAME>;
+    func<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Function', NAME>;
+    func<NAME extends string>(name: NAME, dependsOn: NonEmptyArray<DomainDesignInfoFuncDependsOn | string | [string, string | DomainDesignNote]>, note?: string | DomainDesignNote): DomainDesignInfo<'Function', NAME>;
+    id<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Id', NAME>;
+    valueObj<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'ValueObject', NAME>;
+    version<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Version', NAME>;
 };
-export type DomainDesignInfoType = 'Field' | 'Entity' | 'Function' | 'Any';
-export type DomainDesignInfoSubtype<TYPE extends DomainDesignInfoType> = TYPE extends 'Field' ? 'Id' | 'Time' | 'Enum' | 'Number' | 'String' | 'Boolean' | 'Any' : TYPE extends 'Document' ? 'None' : TYPE extends 'Function' ? DomainDesignInfoFuncDependsOn[] : TYPE extends 'Entity' ? DomainDesignInfo<DomainDesignInfoType, string>[] : TYPE extends 'Any' ? 'None' : never;
-export type DomainDesignInfo<TYPE extends DomainDesignInfoType, NAME extends string> = Readonly<{
-    _attributes: {
-        __code: string;
-        rule: 'Info';
-        type: TYPE;
-        subtype: DomainDesignInfoSubtype<TYPE>;
-        name: NAME;
-        description?: DomainDesignDesc;
+export type DomainDesignInfoType = 'Document' | 'Function' | 'Id' | 'ValueObject' | 'Version';
+export type DomainDesignInfoSimplify<NAME extends string> = NAME | [NAME, string | DomainDesignNote];
+export type DomainDesignInfoSubtype<TYPE extends DomainDesignInfoType> = TYPE extends 'Document' | 'Id' | 'Version' | 'ValueObject' ? 'None' : TYPE extends 'Function' ? DomainDesignInfoFuncDependsOn[] : never;
+export interface DomainDesignInfo<TYPE extends DomainDesignInfoType, NAME extends string> extends DomainDesignObject {
+    readonly _attributes: {
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Info'>;
+        readonly type: TYPE;
+        readonly subtype: DomainDesignInfoSubtype<TYPE>;
+        readonly name: NAME;
+        readonly note?: DomainDesignNote;
     };
-}>;
+    toFormat(): string;
+}
 export type DomainDesignInfoFuncDependsOn = DomainDesignInfo<Exclude<DomainDesignInfoType, 'Function'>, string>;
-export type DomainDesignInfoObject = NonEmptyObject<Record<string, DomainDesignInfo<DomainDesignInfoType, string>>>;
-export type CustomInfoArrayToInfoObject<ARR extends Array<DomainDesignInfo<any, any> | string>> = {
-    [K in ARR[number] as K extends DomainDesignInfo<any, infer U> ? U : K extends string ? K : never]: K extends DomainDesignInfo<any, any> ? K : K extends string ? DomainDesignInfo<'Any', K> : never;
+export type DomainDesignInfoRecord = NonEmptyObject<Record<string, DomainDesignInfo<DomainDesignInfoType, string>>>;
+export type CustomInfo<G_NAME extends string> = DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME | [G_NAME, string | DomainDesignNote];
+export type CustomInfoArrayToInfoObject<ARR extends Array<DomainDesignInfo<any, any> | string | [string, string | DomainDesignNote]>> = {
+    [K in ARR[number] as K extends DomainDesignInfo<any, infer U> ? U : K extends string ? K : K extends [infer U, any] ? U : never]: K extends DomainDesignInfo<any, any> ? K : K extends string ? DomainDesignInfo<'ValueObject', K> : K extends [infer U extends string, any] ? DomainDesignInfo<'ValueObject', U> : never;
 };
-export interface DomainDesignInfoFieldProvider {
-    any<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-    id<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-    time<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-    enum<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-    num<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-    str<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-    bool<NAME extends string>(name: NAME, desc?: string | DomainDesignDesc): DomainDesignInfo<'Field', NAME>;
-}
-export type DomainDesignActorProvider = (name: string, desc?: string | DomainDesignDesc) => DomainDesignActor;
-export type DomainDesignActor = Readonly<{
+export type DomainDesignActorProvider = {
+    (name: string, note?: string | DomainDesignNote): DomainDesignActor;
+};
+export interface DomainDesignActor extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'Actor';
-        name: string;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Actor'>;
+        readonly name: string;
+        readonly note?: DomainDesignNote;
     };
     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 | DomainDesignDesc): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
+    command<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, note?: string | DomainDesignNote): 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 | DomainDesignDesc): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
+    facadeCmd<G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR, note?: string | DomainDesignNote): 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 | NonEmptyInitFunc<() => ARR>): DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
-}>;
-export type DomainDesignCommandProvider = <G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, desc?: string | DomainDesignDesc) => DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
-export type DomainDesignCommand<INFOS extends DomainDesignInfoObject> = Readonly<{
+    toFormat(): string;
+}
+export type DomainDesignCommandProvider = {
+    <G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, note?: string | DomainDesignNote): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
+};
+export interface DomainDesignCommand<INFOS extends DomainDesignInfoRecord> extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'Command';
-        name: string;
-        infos: INFOS;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Command'>;
+        readonly name: string;
+        readonly infos: INFOS;
+        readonly note?: DomainDesignNote;
     };
-    inner: INFOS;
+    readonly inner: INFOS;
     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 | DomainDesignDesc): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
-}>;
-export type DomainDesignFacadeCommandProvider = <G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, desc?: string | DomainDesignDesc) => DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
-export type DomainDesignFacadeCommand<INFOS extends DomainDesignInfoObject> = Readonly<{
+    agg<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, agg: ARR, note?: string | DomainDesignNote): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
+    toFormat(): string;
+}
+export type DomainDesignFacadeCommandProvider = {
+    <G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, note?: string | DomainDesignNote): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
+};
+export interface DomainDesignFacadeCommand<INFOS extends DomainDesignInfoRecord> extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'FacadeCommand';
-        name: string;
-        infos: INFOS;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'FacadeCommand'>;
+        readonly name: string;
+        readonly infos: INFOS;
+        readonly note?: DomainDesignNote;
     };
-    inner: INFOS;
+    readonly inner: INFOS;
     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 | DomainDesignDesc): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
+    agg<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, agg: ARR, note?: string | DomainDesignNote): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
     service(service: DomainDesignService): DomainDesignService;
-    service(name: string, desc?: string | DomainDesignDesc): DomainDesignService;
-}>;
-export type DomainDesignEventProvider = <G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, desc?: string | DomainDesignDesc) => DomainDesignEvent<CustomInfoArrayToInfoObject<ARR>>;
-export type DomainDesignEvent<INFOS extends DomainDesignInfoObject> = Readonly<{
+    service(name: string, note?: string | DomainDesignNote): DomainDesignService;
+    toFormat(): string;
+}
+export type DomainDesignEventProvider = {
+    <G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, note?: string | DomainDesignNote): DomainDesignEvent<CustomInfoArrayToInfoObject<ARR>>;
+};
+export interface DomainDesignEvent<INFOS extends DomainDesignInfoRecord> extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'Event';
-        name: string;
-        infos: INFOS;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Event'>;
+        readonly name: string;
+        readonly infos: INFOS;
+        readonly note?: DomainDesignNote;
     };
-    inner: INFOS;
+    readonly inner: INFOS;
     policy(policy: DomainDesignPolicy): DomainDesignPolicy;
-    policy(name: string, desc?: string | DomainDesignDesc): DomainDesignPolicy;
+    policy(name: string, note?: string | DomainDesignNote): DomainDesignPolicy;
     system(system: DomainDesignSystem): DomainDesignSystem;
-    system(name: string, desc?: string | DomainDesignDesc): DomainDesignSystem;
+    system(name: string, note?: string | DomainDesignNote): 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 | NonEmptyInitFunc<() => ARR>): DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
-}>;
-export type DomainDesignAggProvider = <G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, desc?: string | DomainDesignDesc) => DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
-export type DomainDesignAgg<INFOS extends DomainDesignInfoObject> = Readonly<{
+    readModel<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>): DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
+    toFormat(): string;
+}
+export type DomainDesignAggProvider = {
+    <G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, note?: string | DomainDesignNote): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
+};
+export interface DomainDesignAgg<INFOS extends DomainDesignInfoRecord> extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'Agg';
-        name: string;
-        infos: INFOS;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Agg'>;
+        readonly name: string;
+        readonly infos: INFOS;
+        readonly note?: DomainDesignNote;
     };
-    inner: INFOS;
+    readonly inner: INFOS;
     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 | DomainDesignDesc): DomainDesignEvent<CustomInfoArrayToInfoObject<ARR>>;
-}>;
-export type DomainDesignPolicyProvider = (name: string, desc?: string | DomainDesignDesc) => DomainDesignPolicy;
-export type DomainDesignPolicy = Readonly<{
+    event<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR, note?: string | DomainDesignNote): DomainDesignEvent<CustomInfoArrayToInfoObject<ARR>>;
+    toFormat(): string;
+}
+export type DomainDesignPolicyProvider = {
+    (name: string, note?: string | DomainDesignNote): DomainDesignPolicy;
+};
+export interface DomainDesignPolicy extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'Policy';
-        name: string;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Policy'>;
+        readonly name: string;
+        readonly note?: DomainDesignNote;
     };
     service(service: DomainDesignService): DomainDesignService;
-    service(name: string, desc?: string | DomainDesignDesc): DomainDesignService;
-}>;
-export type DomainDesignSystemProvider = (name: string, desc?: string | DomainDesignDesc) => DomainDesignSystem;
-export type DomainDesignSystem = Readonly<{
+    service(name: string, note?: string | DomainDesignNote): DomainDesignService;
+    toFormat(): string;
+}
+export type DomainDesignSystemProvider = {
+    (name: string, note?: string | DomainDesignNote): DomainDesignSystem;
+};
+export interface DomainDesignSystem extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'System';
-        name: string;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'System'>;
+        readonly name: string;
+        readonly note?: DomainDesignNote;
     };
     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 | DomainDesignDesc): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
+    command<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR, note?: string | DomainDesignNote): 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 | DomainDesignDesc): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
-}>;
-export type DomainDesignServiceProvider = (name: string, desc?: string | DomainDesignDesc) => DomainDesignService;
-export type DomainDesignService = Readonly<{
+    facadeCmd<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR, note?: string | DomainDesignNote): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
+    toFormat(): string;
+}
+export type DomainDesignServiceProvider = (name: string, note?: string | DomainDesignNote) => DomainDesignService;
+export interface DomainDesignService extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'Service';
-        name: string;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'Service'>;
+        readonly name: string;
+        readonly note?: DomainDesignNote;
     };
     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 | DomainDesignDesc): DomainDesignCommand<CustomInfoArrayToInfoObject<ARR>>;
+    command<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR, note?: string | DomainDesignNote): 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 | DomainDesignDesc): DomainDesignFacadeCommand<CustomInfoArrayToInfoObject<ARR>>;
+    facadeCmd<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR, note?: string | DomainDesignNote): 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 | DomainDesignDesc): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
-}>;
-export type DomainDesignReadModelProvider = <G_NAME extends string, ARR extends NonEmptyArray<DomainDesignInfo<DomainDesignInfoType, G_NAME> | G_NAME>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, desc?: string | DomainDesignDesc) => DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
-export type DomainDesignReadModel<INFOS extends DomainDesignInfoObject> = Readonly<{
+    agg<G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, agg: ARR, note?: string | DomainDesignNote): DomainDesignAgg<CustomInfoArrayToInfoObject<ARR>>;
+    toFormat(): string;
+}
+export type DomainDesignReadModelProvider = {
+    <G_NAME extends string, ARR extends NonEmptyArray<CustomInfo<G_NAME>>>(name: string, infos: ARR | NonEmptyInitFunc<() => ARR>, note?: string | DomainDesignNote): DomainDesignReadModel<CustomInfoArrayToInfoObject<ARR>>;
+};
+export interface DomainDesignReadModel<INFOS extends DomainDesignInfoRecord> extends DomainDesignObject {
     readonly _attributes: {
-        __code: string;
-        rule: 'ReadModel';
-        name: string;
-        infos: INFOS;
-        description?: DomainDesignDesc;
+        readonly __id: string;
+        readonly rule: Extract<DomainDesignRule, 'ReadModel'>;
+        readonly name: string;
+        readonly infos: INFOS;
+        readonly note?: DomainDesignNote;
     };
-    inner: INFOS;
-}>;
+    readonly inner: INFOS;
+    toFormat(): string;
+}
+export type DomainDesignOptions = {
+    moduleName: string;
+    __toFormatType?: 'BngleBrackets' | 'JSON' | 'JSONPretty';
+};
 export type NonEmptyArray<T> = [T, ...T[]];
 export type NonEmptyObject<T extends object> = keyof T extends never ? never : T;
 export type NonEmptyInitFunc<T extends () => object> = keyof ReturnType<T> extends never ? never : T;
+export declare function isDomainDesignInfo(param: any): param is DomainDesignInfo<any, any>;
+export declare function isDomainDesignInfoFunc<NAME extends string>(info: DomainDesignInfo<DomainDesignInfoType, NAME>): info is DomainDesignInfo<'Function', NAME>;
+export declare function isDomainDesignActor(param: any): param is DomainDesignActor;
+export declare function isDomainDesignAgg(param: any): param is DomainDesignAgg<any>;
+export declare function isDomainDesignCommand(param: any): param is DomainDesignCommand<any>;
+export declare function isDomainDesignFacadeCommand(param: any): param is DomainDesignFacadeCommand<any>;
+export declare function isDomainDesignEvent(param: any): param is DomainDesignEvent<any>;
+export declare function isDomainDesignPolicy(param: any): param is DomainDesignPolicy;
+export declare function isDomainDesignReadModel(param: any): param is DomainDesignReadModel<any>;
+export declare function isDomainDesignService(param: any): param is DomainDesignService;
+export declare function isDomainDesignSystem(param: any): param is DomainDesignSystem;
+export declare function isAnyDomainDesignObject(param: any): param is DomainDesignObject;
+export declare function isDomainDesigner(param: any): param is DomainDesigner;
+export type DomainDesigner = {
+    startWorkflow: (name: string) => string;
+    defineUserStory: (name: string, workflowNames: NonEmptyArray<string>) => void;
+    note: DomainDesignNoteProvider;
+    info: {
+        document<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Document', NAME>;
+        func<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Function', NAME>;
+        func<NAME extends string>(name: NAME, dependsOn: NonEmptyArray<DomainDesignInfoFuncDependsOn | string | [string, string | DomainDesignNote]>, note?: string | DomainDesignNote): DomainDesignInfo<'Function', NAME>;
+        id<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Id', NAME>;
+        valueObj<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'ValueObject', NAME>;
+        version<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Version', NAME>;
+    };
+    actor: DomainDesignActorProvider;
+    command: DomainDesignCommandProvider;
+    facadeCmd: DomainDesignFacadeCommandProvider;
+    agg: DomainDesignAggProvider;
+    event: DomainDesignEventProvider;
+    system: DomainDesignSystemProvider;
+    policy: DomainDesignPolicyProvider;
+    service: DomainDesignServiceProvider;
+    readModel: DomainDesignReadModelProvider;
+    _getContext: () => {
+        startWorkflow(name: string): string;
+        defineUserStory(name: string, workflowNames: NonEmptyArray<string>): void;
+        linkTo(srcRule: 'Info' | 'Actor' | 'Command' | 'FacadeCommand' | 'Agg' | 'Event' | 'Policy' | 'Service' | 'System' | 'ReadModel', srcId: string, targetRule: 'Info' | 'Actor' | 'Command' | 'FacadeCommand' | 'Agg' | 'Event' | 'Policy' | 'Service' | 'System' | 'ReadModel', targetId: string, linkType?: import('./common').LinkType): void;
+        getDesignerId(): string;
+        getModuleName(): string;
+        getWorkflows(): Record<string, string[]>;
+        getUserStories(): Record<string, string[]>;
+        getLinks(): Record<string, import('./common').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 | DomainDesignNote): DomainDesignInfo<'Document', NAME>;
+            func<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Function', NAME>;
+            func<NAME extends string>(name: NAME, dependsOn: NonEmptyArray<DomainDesignInfoFuncDependsOn | string | [string, string | DomainDesignNote]>, note?: string | DomainDesignNote): DomainDesignInfo<'Function', NAME>;
+            id<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Id', NAME>;
+            valueObj<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'ValueObject', NAME>;
+            version<NAME extends string>(name: NAME, note?: string | DomainDesignNote): DomainDesignInfo<'Version', NAME>;
+        };
+        createPersion: DomainDesignActorProvider;
+        createCommand: DomainDesignCommandProvider;
+        createFacadeCommand: DomainDesignFacadeCommandProvider;
+        createAgg: DomainDesignAggProvider;
+        createEvent: DomainDesignEventProvider;
+        createPolicy: DomainDesignPolicyProvider;
+        createService: DomainDesignServiceProvider;
+        createSystem: DomainDesignSystemProvider;
+        createReadModel: DomainDesignReadModelProvider;
+    };
+};