@ottochain/sdk 2.0.0 → 2.2.0

package/dist/types/apps/corporate/state-machines/corp-entity.d.ts

@@ -0,0 +1,970 @@
+/**
+ * Master corporate record tracking the lifecycle of a business entity from incorporation through dissolution.
+ * Manages legal identity, share structure, and corporate status.
+ */
+export declare const corpEntityDef: {
+    metadata: {
+        name: string;
+        app: string;
+        type: string;
+        version: string;
+        description: string;
+        crossReferences: {
+            board: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            officers: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            bylaws: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            shareholders: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            securities: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+            compliance: {
+                machine: string;
+                description: string;
+                foreignKey: string;
+            };
+        };
+    };
+    createSchema: {
+        required: readonly ["entityId", "legalName", "entityType", "jurisdiction"];
+        properties: {
+            entityId: {
+                type: "string";
+                description: string;
+                immutable: true;
+            };
+            legalName: {
+                type: "string";
+                description: string;
+            };
+            tradeName: {
+                type: "string";
+                nullable: true;
+                description: string;
+            };
+            entityType: {
+                type: "string";
+                enum: readonly ["C_CORP", "S_CORP", "B_CORP", "LLC", "LP", "LLP"];
+                description: string;
+            };
+            jurisdiction: {
+                type: "object";
+                properties: {
+                    state: {
+                        type: "string";
+                        description: string;
+                    };
+                    country: {
+                        type: "string";
+                        default: string;
+                    };
+                    foreignQualifications: {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        description: string;
+                    };
+                };
+            };
+            fiscalYearEnd: {
+                type: "string";
+                description: string;
+            };
+            registeredAgent: {
+                type: "object";
+                properties: {
+                    name: {
+                        type: "string";
+                    };
+                    address: {
+                        type: "object";
+                    };
+                    phone: {
+                        type: "string";
+                    };
+                    email: {
+                        type: "string";
+                    };
+                    effectiveDate: {
+                        type: "string";
+                        format: string;
+                    };
+                };
+            };
+            principalOffice: {
+                type: "object";
+                properties: {
+                    street: {
+                        type: "string";
+                    };
+                    city: {
+                        type: "string";
+                    };
+                    state: {
+                        type: "string";
+                    };
+                    zip: {
+                        type: "string";
+                    };
+                    country: {
+                        type: "string";
+                        default: string;
+                    };
+                };
+            };
+            shareStructure: {
+                type: "object";
+                properties: {
+                    classes: {
+                        type: "array";
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                    totalAuthorized: {
+                        type: "integer";
+                        description: string;
+                    };
+                    totalIssued: {
+                        type: "integer";
+                    };
+                    totalOutstanding: {
+                        type: "integer";
+                    };
+                };
+            };
+            incorporators: {
+                type: "array";
+                items: {
+                    $ref: string;
+                };
+            };
+            ein: {
+                type: "string";
+                nullable: true;
+                description: string;
+            };
+            stateIds: {
+                type: "object";
+                additionalProperties: {
+                    type: "string";
+                };
+                description: string;
+            };
+        };
+    };
+    stateSchema: {
+        properties: {
+            entityId: {
+                type: "string";
+                immutable: true;
+            };
+            legalName: {
+                type: "string";
+            };
+            tradeName: {
+                type: "string";
+                nullable: true;
+            };
+            entityType: {
+                type: "string";
+            };
+            jurisdiction: {
+                type: "object";
+            };
+            formationDate: {
+                type: "string";
+                format: string;
+                computed: true;
+            };
+            fiscalYearEnd: {
+                type: "string";
+            };
+            registeredAgent: {
+                type: "object";
+            };
+            principalOffice: {
+                type: "object";
+            };
+            shareStructure: {
+                type: "object";
+            };
+            incorporators: {
+                type: "array";
+            };
+            ein: {
+                type: "string";
+                nullable: true;
+            };
+            stateIds: {
+                type: "object";
+            };
+            status: {
+                type: "string";
+                enum: readonly ["INCORPORATING", "ACTIVE", "SUSPENDED", "DISSOLVED"];
+                computed: true;
+            };
+            suspensionReason: {
+                type: "string";
+                nullable: true;
+                computed: true;
+            };
+            suspensionDate: {
+                type: "string";
+                format: string;
+                nullable: true;
+                computed: true;
+            };
+            dissolutionDate: {
+                type: "string";
+                format: string;
+                nullable: true;
+                computed: true;
+            };
+            dissolutionReason: {
+                type: "string";
+                nullable: true;
+                computed: true;
+            };
+            charterAmendments: {
+                type: "array";
+                items: {
+                    $ref: string;
+                };
+                computed: true;
+            };
+            createdAt: {
+                type: "timestamp";
+                computed: true;
+            };
+            updatedAt: {
+                type: "timestamp";
+                computed: true;
+            };
+        };
+    };
+    eventSchemas: {
+        incorporate: {
+            description: string;
+            required: readonly ["approvalDate", "stateFileNumber"];
+            properties: {
+                approvalDate: {
+                    type: "string";
+                    format: string;
+                };
+                stateFileNumber: {
+                    type: "string";
+                };
+                certificateOfIncorporation: {
+                    type: "string";
+                    description: string;
+                };
+            };
+        };
+        amend_charter: {
+            description: string;
+            required: readonly ["amendmentId", "description", "amendmentType", "resolutionRef", "effectiveDate", "filedDate"];
+            properties: {
+                amendmentId: {
+                    type: "string";
+                };
+                description: {
+                    type: "string";
+                };
+                amendmentType: {
+                    type: "string";
+                    enum: readonly ["NAME_CHANGE", "SHARE_AUTHORIZATION", "PURPOSE_CHANGE", "OTHER"];
+                };
+                resolutionRef: {
+                    type: "string";
+                    description: string;
+                };
+                effectiveDate: {
+                    type: "string";
+                    format: string;
+                };
+                filedDate: {
+                    type: "string";
+                    format: string;
+                };
+                newShareAuthorization: {
+                    type: "object";
+                    nullable: true;
+                    description: string;
+                };
+                newLegalName: {
+                    type: "string";
+                    nullable: true;
+                };
+            };
+        };
+        update_share_class: {
+            description: string;
+            required: readonly ["classId", "className", "authorized", "parValue", "votingRights", "charterAmendmentRef"];
+            properties: {
+                classId: {
+                    type: "string";
+                };
+                className: {
+                    type: "string";
+                };
+                authorized: {
+                    type: "integer";
+                };
+                parValue: {
+                    type: "number";
+                };
+                votingRights: {
+                    type: "boolean";
+                };
+                votesPerShare: {
+                    type: "number";
+                    default: number;
+                };
+                liquidationPreference: {
+                    type: "number";
+                    nullable: true;
+                };
+                dividendRate: {
+                    type: "number";
+                    nullable: true;
+                };
+                convertible: {
+                    type: "boolean";
+                    default: boolean;
+                };
+                charterAmendmentRef: {
+                    type: "string";
+                };
+            };
+        };
+        update_registered_agent: {
+            description: string;
+            required: readonly ["name", "address", "effectiveDate"];
+            properties: {
+                name: {
+                    type: "string";
+                };
+                address: {
+                    type: "object";
+                };
+                phone: {
+                    type: "string";
+                };
+                email: {
+                    type: "string";
+                };
+                effectiveDate: {
+                    type: "string";
+                    format: string;
+                };
+                filingConfirmation: {
+                    type: "string";
+                    description: string;
+                };
+            };
+        };
+        suspend: {
+            description: string;
+            required: readonly ["reason", "suspensionDate"];
+            properties: {
+                reason: {
+                    type: "string";
+                    enum: readonly ["FRANCHISE_TAX_DELINQUENT", "ANNUAL_REPORT_MISSING", "REGISTERED_AGENT_LAPSE", "ADMINISTRATIVE", "OTHER"];
+                };
+                suspensionDate: {
+                    type: "string";
+                    format: string;
+                };
+                stateNotice: {
+                    type: "string";
+                    description: string;
+                };
+                cureDeadline: {
+                    type: "string";
+                    format: string;
+                    nullable: true;
+                };
+            };
+        };
+        reinstate: {
+            description: string;
+            required: readonly ["reinstatementDate", "curativeActions", "stateConfirmation"];
+            properties: {
+                reinstatementDate: {
+                    type: "string";
+                    format: string;
+                };
+                curativeActions: {
+                    type: "array";
+                    items: {
+                        type: "string";
+                    };
+                    description: string;
+                };
+                stateConfirmation: {
+                    type: "string";
+                };
+                penaltiesPaid: {
+                    type: "number";
+                    nullable: true;
+                };
+            };
+        };
+        dissolve_voluntary: {
+            description: string;
+            required: readonly ["dissolutionDate", "boardResolutionRef", "shareholderResolutionRef"];
+            properties: {
+                dissolutionDate: {
+                    type: "string";
+                    format: string;
+                };
+                boardResolutionRef: {
+                    type: "string";
+                };
+                shareholderResolutionRef: {
+                    type: "string";
+                };
+                windingUpPlan: {
+                    type: "string";
+                    description: string;
+                };
+                certificateOfDissolution: {
+                    type: "string";
+                };
+            };
+        };
+        dissolve_administrative: {
+            description: string;
+            required: readonly ["dissolutionDate", "stateOrder", "reason"];
+            properties: {
+                dissolutionDate: {
+                    type: "string";
+                    format: string;
+                };
+                stateOrder: {
+                    type: "string";
+                };
+                reason: {
+                    type: "string";
+                };
+            };
+        };
+    };
+    definitions: {
+        ShareClass: {
+            type: "object";
+            properties: {
+                className: {
+                    type: "string";
+                    description: string;
+                };
+                classId: {
+                    type: "string";
+                };
+                authorized: {
+                    type: "integer";
+                    description: string;
+                };
+                issued: {
+                    type: "integer";
+                    description: string;
+                };
+                outstanding: {
+                    type: "integer";
+                    description: string;
+                };
+                treasury: {
+                    type: "integer";
+                    description: string;
+                };
+                parValue: {
+                    type: "number";
+                    description: string;
+                };
+                votingRights: {
+                    type: "boolean";
+                    description: string;
+                };
+                votesPerShare: {
+                    type: "number";
+                    default: number;
+                };
+                liquidationPreference: {
+                    type: "number";
+                    nullable: true;
+                    description: string;
+                };
+                dividendRate: {
+                    type: "number";
+                    nullable: true;
+                    description: string;
+                };
+                convertible: {
+                    type: "boolean";
+                    default: boolean;
+                };
+                conversionRatio: {
+                    type: "number";
+                    nullable: true;
+                };
+                antidilution: {
+                    type: "string";
+                    enum: readonly ["NONE", "BROAD_BASED", "NARROW_BASED", "FULL_RATCHET"];
+                    nullable: true;
+                };
+            };
+        };
+        Incorporator: {
+            type: "object";
+            properties: {
+                name: {
+                    type: "string";
+                };
+                address: {
+                    type: "object";
+                };
+                signatureDate: {
+                    type: "string";
+                    format: string;
+                };
+            };
+        };
+        CharterAmendment: {
+            type: "object";
+            properties: {
+                amendmentId: {
+                    type: "string";
+                };
+                description: {
+                    type: "string";
+                };
+                effectiveDate: {
+                    type: "string";
+                    format: string;
+                };
+                resolutionRef: {
+                    type: "string";
+                    description: string;
+                };
+                filedDate: {
+                    type: "string";
+                    format: string;
+                };
+            };
+        };
+    };
+    states: {
+        INCORPORATING: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        ACTIVE: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        SUSPENDED: {
+            id: string;
+            isFinal: false;
+            description: string;
+        };
+        DISSOLVED: {
+            id: string;
+            isFinal: true;
+            description: string;
+        };
+    };
+    initialState: "INCORPORATING";
+    transitions: ({
+        from: "INCORPORATING";
+        to: "ACTIVE";
+        eventName: "incorporate";
+        guard: {
+            and: ({
+                "!=": ({
+                    var: string;
+                } | null)[];
+                ">"?: undefined;
+            } | {
+                ">": (number | {
+                    var: string;
+                })[];
+                "!="?: undefined;
+            })[];
+            "!="?: undefined;
+            some?: undefined;
+            "=="?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                formationDate?: undefined;
+                updatedAt?: undefined;
+            } | {
+                status: string;
+                formationDate: {
+                    var: string;
+                };
+                updatedAt: {
+                    var: string;
+                };
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "ACTIVE";
+        to: "ACTIVE";
+        eventName: "amend_charter";
+        guard: {
+            "!=": ({
+                var: string;
+            } | null)[];
+            and?: undefined;
+            some?: undefined;
+            "=="?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                charterAmendments?: undefined;
+                legalName?: undefined;
+                updatedAt?: undefined;
+            } | {
+                charterAmendments: {
+                    cat: ({
+                        var: string;
+                    } | {
+                        amendmentId: {
+                            var: string;
+                        };
+                        description: {
+                            var: string;
+                        };
+                        effectiveDate: {
+                            var: string;
+                        };
+                        resolutionRef: {
+                            var: string;
+                        };
+                        filedDate: {
+                            var: string;
+                        };
+                    }[])[];
+                };
+                legalName: {
+                    if: ({
+                        "!=": ({
+                            var: string;
+                        } | null)[];
+                        var?: undefined;
+                    } | {
+                        var: string;
+                        "!="?: undefined;
+                    })[];
+                };
+                updatedAt: {
+                    var: string;
+                };
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+    } | {
+        from: "ACTIVE";
+        to: "ACTIVE";
+        eventName: "update_share_class";
+        guard: {
+            some: ({
+                var: string;
+                "=="?: undefined;
+            } | {
+                "==": {
+                    var: string;
+                }[];
+                var?: undefined;
+            })[];
+            and?: undefined;
+            "!="?: undefined;
+            "=="?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                shareStructure?: undefined;
+            } | {
+                shareStructure: {
+                    merge: ({
+                        var: string;
+                        classes?: undefined;
+                    } | {
+                        classes: {
+                            map: ({
+                                var: string;
+                                if?: undefined;
+                            } | {
+                                if: ({
+                                    "==": {
+                                        var: string;
+                                    }[];
+                                    classId?: undefined;
+                                    className?: undefined;
+                                    authorized?: undefined;
+                                    issued?: undefined;
+                                    outstanding?: undefined;
+                                    treasury?: undefined;
+                                    parValue?: undefined;
+                                    votingRights?: undefined;
+                                    votesPerShare?: undefined;
+                                    liquidationPreference?: undefined;
+                                    dividendRate?: undefined;
+                                    convertible?: undefined;
+                                    var?: undefined;
+                                } | {
+                                    classId: {
+                                        var: string;
+                                    };
+                                    className: {
+                                        var: string;
+                                    };
+                                    authorized: {
+                                        var: string;
+                                    };
+                                    issued: number;
+                                    outstanding: number;
+                                    treasury: number;
+                                    parValue: {
+                                        var: string;
+                                    };
+                                    votingRights: {
+                                        var: string;
+                                    };
+                                    votesPerShare: {
+                                        var: string;
+                                    };
+                                    liquidationPreference: {
+                                        var: string;
+                                    };
+                                    dividendRate: {
+                                        var: string;
+                                    };
+                                    convertible: {
+                                        var: string;
+                                    };
+                                    "=="?: undefined;
+                                    var?: undefined;
+                                } | {
+                                    var: string;
+                                    "=="?: undefined;
+                                    classId?: undefined;
+                                    className?: undefined;
+                                    authorized?: undefined;
+                                    issued?: undefined;
+                                    outstanding?: undefined;
+                                    treasury?: undefined;
+                                    parValue?: undefined;
+                                    votingRights?: undefined;
+                                    votesPerShare?: undefined;
+                                    liquidationPreference?: undefined;
+                                    dividendRate?: undefined;
+                                    convertible?: undefined;
+                                })[];
+                                var?: undefined;
+                            })[];
+                        };
+                        var?: undefined;
+                    })[];
+                };
+                var?: undefined;
+            })[];
+        };
+        emits?: undefined;
+        dependencies?: undefined;
+    } | {
+        from: "ACTIVE";
+        to: "ACTIVE";
+        eventName: "update_registered_agent";
+        guard: {
+            "==": number[];
+            and?: undefined;
+            "!="?: undefined;
+            some?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                registeredAgent?: undefined;
+            } | {
+                registeredAgent: {
+                    name: {
+                        var: string;
+                    };
+                    address: {
+                        var: string;
+                    };
+                    phone: {
+                        var: string;
+                    };
+                    email: {
+                        var: string;
+                    };
+                    effectiveDate: {
+                        var: string;
+                    };
+                };
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "ACTIVE";
+        to: "SUSPENDED";
+        eventName: "suspend";
+        guard: {
+            "==": number[];
+            and?: undefined;
+            "!="?: undefined;
+            some?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                suspensionReason?: undefined;
+                suspensionDate?: undefined;
+            } | {
+                status: string;
+                suspensionReason: {
+                    var: string;
+                };
+                suspensionDate: {
+                    var: string;
+                };
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "SUSPENDED";
+        to: "ACTIVE";
+        eventName: "reinstate";
+        guard: {
+            "==": number[];
+            and?: undefined;
+            "!="?: undefined;
+            some?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                suspensionReason?: undefined;
+                suspensionDate?: undefined;
+            } | {
+                status: string;
+                suspensionReason: null;
+                suspensionDate: null;
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+        dependencies?: undefined;
+    } | {
+        from: "ACTIVE";
+        to: "DISSOLVED";
+        eventName: "dissolve_voluntary";
+        guard: {
+            "==": number[];
+            and?: undefined;
+            "!="?: undefined;
+            some?: undefined;
+        };
+        dependencies: {
+            machine: string;
+            instanceRef: {
+                var: string;
+            };
+            requiredState: string;
+        }[];
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                dissolutionDate?: undefined;
+                dissolutionReason?: undefined;
+            } | {
+                status: string;
+                dissolutionDate: {
+                    var: string;
+                };
+                dissolutionReason: string;
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+    } | {
+        from: "SUSPENDED";
+        to: "DISSOLVED";
+        eventName: "dissolve_administrative";
+        guard: {
+            "==": number[];
+            and?: undefined;
+            "!="?: undefined;
+            some?: undefined;
+        };
+        effect: {
+            merge: ({
+                var: string;
+                status?: undefined;
+                dissolutionDate?: undefined;
+                dissolutionReason?: undefined;
+            } | {
+                status: string;
+                dissolutionDate: {
+                    var: string;
+                };
+                dissolutionReason: {
+                    cat: (string | {
+                        var: string;
+                    })[];
+                };
+                var?: undefined;
+            })[];
+        };
+        emits: string[];
+        dependencies?: undefined;
+    })[];
+};
+export type CorpEntityState = keyof typeof corpEntityDef.states;
+export type CorpEntityEvent = (typeof corpEntityDef.transitions)[number]["eventName"];