@coopenomics/docs-templates 1.2.0 → 1.3.0

package/dist/index.d.mts

@@ -1,34 +1,596 @@
-import { Cooperative, Interfaces } from 'cooptypes';
-
 declare let version: string;
 
 /**
- * Типы данных документа, которыми пользуются шаблоны реестра.
+ * Утверждение редакций шаблонов документов советом кооператива.
+ *
+ * Перечисления общие для контроллера и рабочего стола: контроллер вычисляет
+ * состояние документа в кооперативе, рабочий стол показывает его во вкладке
+ * «Шаблоны документов» и в карточках подключения приложений.
+ */
+/** Род документа в реестре шаблонов кооператива. */
+declare enum DocumentKind {
+    /** Подписывают пайщики: политика, оферты ЦПП, соглашение о кошельке. Новая редакция требует переподписания. */
+    Agreement = "agreement",
+    /** Утверждает совет, пайщики не подписывают: положения ЦПП, шаблоны договоров. */
+    Provision = "provision",
+    /** Заявления, акты, накладные: утверждается как форма, экземпляры порождаются по событиям. */
+    Form = "form",
+    /** Повестка, протоколы, бюллетени: форма задана уставом или законом, утверждение не требуется. */
+    Service = "service"
+}
+/** Нужно ли решение совета, чтобы редакция документа действовала в кооперативе. */
+declare enum DocumentApprovalRequirement {
+    Required = "required",
+    None = "none"
+}
+/** Состояние документа в кооперативе относительно редакции в сети. */
+declare enum DocumentApprovalState {
+    /** Утверждение не требуется (служебный документ). */
+    NotRequired = "not_required",
+    /** Совет ещё ни одной редакции не утверждал. */
+    NotApproved = "not_approved",
+    /** Проект решения об утверждении в повестке совета. */
+    Pending = "pending",
+    /** Утверждённая редакция совпадает с редакцией в сети. */
+    Approved = "approved",
+    /** В сети вышла редакция новее утверждённой, решения совета ещё нет. */
+    Outdated = "outdated"
+}
+
+/**
+ * Модель документа: мета, вход сборщика, параметры сборки, собранный
+ * документ и общие части моделей шаблонов. Перенесено из `cooptypes`
+ * (`cooperative/document`) 30.10.2026 — шаг 6б фабрики v2. Типы подписанного
+ * документа в цепи (`IChainDocument2`, `ISignedDocument2`, канонизация
+ * подписи) остаются в `cooptypes` и берут мету из этого пакета.
+ */
+
+interface IGenerationOptions {
+    skip_save?: boolean;
+    lang?: string;
+    /**
+     * Собрать только HTML, без PDF и без хэша. Для публичного показа положения
+     * на сайте: страница берёт тот же документ, что направляется на подпись, но не
+     * платит за рендер PDF на каждый заход. Документ без хэша не сохраняется.
+     */
+    skip_pdf?: boolean;
+    /**
+     * Публичный показ: подписант ещё не известен, на его месте остаётся прочерк
+     * под рукописное заполнение. Отдельный флаг, а не пустой username: meta
+     * требует имя того, от кого сформирован документ (при публичном показе — сам
+     * кооператив), и по нему подписанта уже не отличить.
+     */
+    blank_signer?: boolean;
+}
+type LangType = 'ru';
+interface IMetaDocument {
+    title: string;
+    registry_id: number;
+    lang: string;
+    generator: string;
+    version: string;
+    coopname: string;
+    username: string;
+    /**
+     * Момент генерации документа в ISO 8601, UTC, до миллисекунд
+     * (`2026-09-24T11:05:31.123Z`). Вид для человека («ДД.ММ.ГГГГ ЧЧ:ММ» в поясе
+     * `timezone`) собирает рендер: шаблон выводит его переменной `created_at`.
+     * Документы до 28.09.2026 хранят здесь дату уже в виде для человека.
+     */
+    created_at: string;
+    block_num: number;
+    timezone: string;
+    links: string[];
+    /**
+     * Версия сборщика документа `major.minor` (фабрика v2, шаг 7). Пишется в
+     * каждый новый документ; пересборка берёт сборщик ровно этой версии.
+     * Документы до 29.10.2026 поля не имеют — их пересобирает версия `1.0`.
+     */
+    builder?: string;
+}
+interface IGeneratedDocument<T = any> {
+    full_title: string;
+    html: string;
+    hash: string;
+    meta: IMetaDocument & T;
+    binary: Uint8Array;
+}
+interface ZGeneratedDocument<T = any> {
+    full_title: string;
+    html: string;
+    hash: string;
+    meta: IMetaDocument & T;
+    binary: string;
+}
+/**
+ * Общий интерфейс для генерации/регенерации документа
+ */
+interface IGenerate extends Omit<Partial<IMetaDocument>, 'title'> {
+    registry_id: number;
+    coopname: string;
+    username: string;
+    [key: string]: any;
+}
+/**
+ * Зарезервированная ссылка на приватный payload документа.
+ * Action конкретного документа расширяет этот интерфейс, если хочет
+ * хранить персональные/приватные данные off-chain — payload лежит в
+ * коллекции `doc_private_data` фабрики, on-chain публикуется только
+ * `doc_data_hash`. См. раздел «Document Generation Pattern: doc_data»
+ * в архитектуре.
+ */
+interface IDocDataRef {
+    doc_data_hash?: string;
+}
+/**
+ * Интерфейс генерации заявления на вступление в кооператив
+ */
+interface IGenerateJoinCoop extends IGenerate {
+    signature: string;
+    skip_save: boolean;
+}
+/**
+ * Интерфейс генерации решения совета
+ */
+interface IGenerateJoinCoopDecision extends IGenerate {
+    decision_id: number;
+}
+/**
+ * Интерфейс генерации соглашения
+ */
+interface IGenerateWalletAgreement extends IGenerate {
+    registry_id: number;
+}
+interface IDecisionData {
+    id: number;
+    date: string;
+    time: string;
+    votes_for: number;
+    votes_against: number;
+    votes_abstained: number;
+    voters_percent: number;
+}
+interface IProjectData {
+    id: string;
+    title?: string;
+    question: string;
+    decision: string;
+}
+interface IIntellectualResult {
+    quantity: number;
+    name: string;
+    currency: string;
+    unit_price: number;
+    total_price: number;
+    description: string;
+}
+interface IUHDContract {
+    number: string;
+    date: string;
+}
+interface IContributionAmount {
+    amount: number;
+    currency: string;
+    words: string;
+}
+
+/**
+ * Данные цепи в том виде, в каком они входят в модель документа.
  *
- * Модель документа, субъекты и реквизиты пока живут в `cooptypes` (решение
- * владельца 30.10.2026: из `cooptypes` выносится только реестр шаблонов).
- * Пакет шаблонов берёт их из `cooptypes` только как типы: исполняемой зависимости от
- * `cooptypes` у пакета нет, и в собранном коде `cooptypes` не подключается.
+ * Модель документа — снимок данных на блок документа, замороженный вместе с
+ * шаблоном: смена ABI контракта не должна молча менять модель уже выпущенного
+ * шаблона. Поэтому пакет шаблонов описывает эти данные сам и от `cooptypes`
+ * не зависит (решение владельца 30.10.2026). Поля повторяют таблицы и
+ * структуры контрактов на дату выноса: `registrator::coops`,
+ * `soviet::boards`, `meet::meets`, `meet::questions`.
  */
+/** Подпись документа в цепи. */
+interface IChainSignature {
+    id: number;
+    signed_hash: string;
+    signer: string;
+    public_key: string;
+    signature: string;
+    signed_at: string;
+    meta: string;
+}
+/** Документ в цепи (структура `document2` контрактов). */
+interface IChainDocument {
+    version: string;
+    hash: string;
+    doc_hash: string;
+    meta_hash: string;
+    meta: string;
+    signatures: IChainSignature[];
+}
+/** Кооператив из реестра (`registrator::coops`). */
+interface IChainCooperative {
+    username: string;
+    parent_username: string;
+    announce: string;
+    description: string;
+    is_cooperative: boolean;
+    is_branched: boolean;
+    is_enrolled: boolean;
+    coop_type: string;
+    registration: string;
+    initial: string;
+    minimum: string;
+    org_registration: string;
+    org_initial: string;
+    org_minimum: string;
+    status: string;
+    created_at: string;
+    document: IChainDocument;
+    active_participants_count: number | string;
+}
+/** Член совета (`soviet::boards`). */
+interface IBoardMember {
+    username: string;
+    is_voting: boolean;
+    position_title: string;
+    position: string;
+}
+/** Собрание пайщиков (`meet::meets`). */
+interface IMeet {
+    id: number | string;
+    hash: string;
+    coopname: string;
+    type: string;
+    level: string;
+    initiator: string;
+    presider: string;
+    secretary: string;
+    status: string;
+    created_at: string;
+    open_at: string;
+    close_at: string;
+    notified_users: string[];
+    quorum_percent: number;
+    signed_ballots: number | string;
+    current_quorum_percent: number;
+    cycle: number | string;
+    quorum_passed: boolean;
+    proposal: IChainDocument;
+    authorization: IChainDocument;
+    decision1: IChainDocument;
+    decision2: IChainDocument;
+}
+/** Пункт повестки собрания. */
+interface IMeetPoint {
+    context: string;
+    title: string;
+    decision: string;
+}
+/** Вопрос собрания (`meet::questions`). */
+interface IQuestion$2 {
+    id: number | string;
+    number: number | string;
+    coopname: string;
+    meet_id: number | string;
+    title: string;
+    context: string;
+    decision: string;
+    counter_votes_for: number | string;
+    counter_votes_against: number | string;
+    counter_votes_abstained: number | string;
+    voters_for: string[];
+    voters_against: string[];
+    voters_abstained: string[];
+}
+
+interface IPassportData {
+    series: number;
+    number: number;
+    issued_by: string;
+    issued_at: string;
+    code: string;
+}
+interface IIndividualData {
+    username: string;
+    first_name: string;
+    last_name: string;
+    middle_name: string;
+    birthdate: string;
+    full_address: string;
+    phone: string;
+    email: string;
+    passport?: IPassportData;
+    block_num?: number;
+    deleted?: boolean;
+}
+interface IOrganizationData {
+    username: string;
+    type: string;
+    short_name: string;
+    full_name: string;
+    represented_by: {
+        first_name: string;
+        last_name: string;
+        middle_name: string;
+        position: string;
+        based_on: string;
+    };
+    country: string;
+    city: string;
+    full_address: string;
+    fact_address: string;
+    phone: string;
+    email: string;
+    details: {
+        inn: string;
+        ogrn: string;
+        kpp: string;
+    };
+    block_num?: number;
+    deleted?: boolean;
+}
+interface IEntrepreneurData {
+    username: string;
+    first_name: string;
+    last_name: string;
+    middle_name: string;
+    birthdate: string;
+    phone: string;
+    email: string;
+    country: string;
+    city: string;
+    full_address: string;
+    details: {
+        inn: string;
+        ogrn: string;
+    };
+    block_num?: number;
+    deleted?: boolean;
+}
+type IUserData = IIndividualData | IOrganizationData | IEntrepreneurData;
+interface IAccountMeta {
+    phone: string;
+    email: string;
+}
 
-type IDecisionData = Cooperative.Document.IDecisionData;
-type IDocDataRef = Cooperative.Document.IDocDataRef;
-type IGenerate = Cooperative.Document.IGenerate;
-type IMetaDocument = Cooperative.Document.IMetaDocument;
-type IProjectData = Cooperative.Document.IProjectData;
-type ICommonProgram = Cooperative.Model.ICommonProgram;
-type ICommonRequest = Cooperative.Model.ICommonRequest;
-type ICommonUser = Cooperative.Model.ICommonUser;
-type ICooperativeData = Cooperative.Model.ICooperativeData;
-type IFirstLastMiddleName = Cooperative.Model.IFirstLastMiddleName;
-type IMeetExtended = Cooperative.Model.IMeetExtended;
-type IQuestionExtended = Cooperative.Model.IQuestionExtended;
-type IVars = Cooperative.Model.IVars;
-type IEntrepreneurData = Cooperative.Users.IEntrepreneurData;
-type IIndividualData = Cooperative.Users.IIndividualData;
-type IOrganizationData = Cooperative.Users.IOrganizationData;
-type IBankAccount = Cooperative.Payments.IBankAccount;
-type IMeetPoint = Interfaces.Meet.IMeetPoint;
+interface IBankAccount {
+    currency: string;
+    card_number?: string;
+    bank_name: string;
+    account_number: string;
+    details: {
+        bik: string;
+        corr: string;
+    };
+}
+interface ISbpDetails {
+    phone: string;
+}
+type MethodTypes = 'sbp' | 'bank_transfer';
+interface IPaymentData {
+    username: string;
+    method_id: string;
+    method_type: MethodTypes;
+    is_default: boolean;
+    data: ISbpDetails | IBankAccount;
+    deleted?: boolean;
+    block_num?: number;
+}
+
+interface ICooperativeData extends IOrganizationData, IChainCooperative {
+    members: MembersData[];
+    chairman: IIndividualData;
+    totalMembers: number;
+    defaultBankAccount: IBankAccount;
+}
+interface MembersData extends IBoardMember, IIndividualData {
+    is_chairman: boolean;
+}
+interface IAnnounce {
+    phone: string;
+    email: string;
+}
+interface IContacts {
+    full_name: string;
+    full_address: string;
+    details: {
+        inn: string;
+        ogrn: string;
+        kpp: string;
+    };
+    phone: string;
+    email: string;
+    chairman: {
+        first_name: string;
+        last_name: string;
+        middle_name: string;
+    };
+}
+interface IVars {
+    block_num?: number;
+    deleted?: boolean;
+    coopname: string;
+    full_abbr: string;
+    full_abbr_genitive: string;
+    full_abbr_dative: string;
+    short_abbr: string;
+    website: string;
+    name: string;
+    confidential_link: string;
+    confidential_email: string;
+    contact_email: string;
+    passport_request: 'yes' | 'no';
+    wallet_agreement?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    signature_agreement?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    privacy_agreement?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    user_agreement?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    participant_application?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    coopenomics_agreement?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    blagorost_program?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    blagorost_offer_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    generator_program?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    generator_offer_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    generation_contract_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    marketplace_program?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    marketplace_offer_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    education_provision?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    education_parent_offer_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    education_teacher_offer_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+    education_contract_template?: {
+        protocol_number: string;
+        protocol_day_month_year: string;
+    };
+}
+/**
+ * Используется для генераций документов в кооплейсе
+ */
+interface ICommonRequest {
+    hash: string;
+    title: string;
+    unit_of_measurement: string;
+    units: number;
+    unit_cost: string;
+    total_cost: string;
+    currency: string;
+    type: string;
+    program_id: number;
+}
+interface ICommonUser {
+    full_name_or_short_name: string;
+    birthdate_or_ogrn: string;
+    abbr_full_name: string;
+    email: string;
+    phone: string;
+}
+interface IFirstLastMiddleName {
+    first_name: string;
+    last_name: string;
+    middle_name: string;
+}
+interface ICommonProgram {
+    name: string;
+}
+/**
+ * Расширенный интерфейс IMeet с полями для форматированных дат
+ */
+interface IMeetExtended extends IMeet {
+    close_at_datetime: string;
+    open_at_datetime: string;
+    presider_full_name: string;
+    secretary_full_name: string;
+}
+/**
+ * Расширенный интерфейс IQuestion с вычисленными результатами
+ */
+interface IQuestionExtended extends IQuestion$2 {
+    votes_total?: number;
+    votes_for_percent?: number;
+    votes_against_percent?: number;
+    votes_abstained_percent?: number;
+    is_accepted?: boolean;
+}
+/**
+ * Ключи для пользовательских данных кооператива
+ * Определяет типы данных, которые могут сохраняться для пользователей
+ */
+declare enum UdataKey {
+    /** Данные договора УХД участника */
+    BLAGOROST_CONTRIBUTOR_CONTRACT_NUMBER = "blagorost_contributor_contract_number",
+    /** Дата создания договора УХД участника */
+    BLAGOROST_CONTRIBUTOR_CONTRACT_CREATED_AT = "blagorost_contributor_contract_created_at",
+    /** Данные соглашения программы генератор */
+    GENERATOR_AGREEMENT_NUMBER = "generator_agreement_number",
+    /** Дата создания соглашения генератора */
+    GENERATOR_AGREEMENT_CREATED_AT = "generator_agreement_created_at",
+    /** Данные соглашения программы благороста */
+    BLAGOROST_AGREEMENT_NUMBER = "blagorost_agreement_number",
+    /** Дата создания соглашения благороста */
+    BLAGOROST_AGREEMENT_CREATED_AT = "blagorost_agreement_created_at",
+    /** Хеш дополнительного соглашения по хранению имущества */
+    BLAGOROST_STORAGE_AGREEMENT_NUMBER = "blagorost_storage_agreement_number",
+    /** Дата создания дополнительного соглашения по хранению имущества */
+    BLAGOROST_STORAGE_AGREEMENT_CREATED_AT = "blagorost_storage_agreement_created_at",
+    /** Номер оферты ЦПП «Стол заказов» (Эпик 1 / Story 1.7 / 1.11) */
+    MARKETPLACE_AGREEMENT_NUMBER = "marketplace_agreement_number",
+    /** Дата создания оферты ЦПП «Стол заказов» */
+    MARKETPLACE_AGREEMENT_CREATED_AT = "marketplace_agreement_created_at",
+    /** Номер оферты родителя-слушателя ЦПП «Образование» */
+    EDUCATION_PARENT_AGREEMENT_NUMBER = "education_parent_agreement_number",
+    /** Дата оферты родителя-слушателя ЦПП «Образование» */
+    EDUCATION_PARENT_AGREEMENT_CREATED_AT = "education_parent_agreement_created_at",
+    /** Номер оферты преподавателя ЦПП «Образование» */
+    EDUCATION_TEACHER_AGREEMENT_NUMBER = "education_teacher_agreement_number",
+    /** Дата оферты преподавателя ЦПП «Образование» */
+    EDUCATION_TEACHER_AGREEMENT_CREATED_AT = "education_teacher_agreement_created_at",
+    /** Номер договора участия в хозяйственной деятельности (образование) */
+    EDUCATION_CONTRACT_NUMBER = "education_contract_number",
+    /** Дата договора участия в хозяйственной деятельности (образование) */
+    EDUCATION_CONTRACT_CREATED_AT = "education_contract_created_at"
+}
+/**
+ * Пользовательские данные кооператива
+ * Хранит различные типы данных пользователей с версионностью по блокам
+ */
+interface IUdata {
+    /** Название кооператива */
+    coopname: string;
+    /** Имя пользователя */
+    username: string;
+    /** Ключ данных (определяет тип сохраняемой информации) */
+    key: UdataKey;
+    /** Строковое значение данных */
+    value: string;
+    /** Дополнительные метаданные (опционально) */
+    metadata?: Record<string, any>;
+    /** Флаг мягкого удаления */
+    deleted?: boolean;
+    /** Номер блока для версионности */
+    block_num?: number;
+}
 
 declare const registry_id$1r = 1;
 interface Action$1r extends IGenerate {
@@ -9566,5 +10128,5 @@ declare function decisionTypesForExtensions(installedExtensions: readonly string
 /** Расширения, от установки которых зависит хотя бы одно решение реестра. */
 declare function decisionTypeExtensions(): string[];
 
-export { version as DOCS_TEMPLATES_VERSION, index as Registry, decisionTypeExtensions, decisionTypesForExtensions, decisionTypesRegistry };
-export type { IDecisionTypeInfo };
+export { version as DOCS_TEMPLATES_VERSION, DocumentApprovalRequirement, DocumentApprovalState, DocumentKind, index as Registry, UdataKey, decisionTypeExtensions, decisionTypesForExtensions, decisionTypesRegistry };
+export type { IAccountMeta, IAnnounce, IBankAccount, ICommonProgram, ICommonRequest, ICommonUser, IContacts, IContributionAmount, ICooperativeData, IDecisionData, IDecisionTypeInfo, IDocDataRef, IEntrepreneurData, IFirstLastMiddleName, IGenerate, IGenerateJoinCoop, IGenerateJoinCoopDecision, IGenerateWalletAgreement, IGeneratedDocument, IGenerationOptions, IIndividualData, IIntellectualResult, IMeetExtended, IMetaDocument, IOrganizationData, IPassportData, IPaymentData, IProjectData, IQuestionExtended, ISbpDetails, IUHDContract, IUdata, IUserData, IVars, LangType, MembersData, MethodTypes, ZGeneratedDocument };