ekwo-os 0.4.1

package/dist/bootstrap.d.ts

@@ -0,0 +1,236 @@
+/**
+ * The six steps of the installation sequence, in SQL.
+ *
+ * They are the same six the README spells out, in the same order, and they
+ * run over the Postgres connection as the database owner. Row level security
+ * is bypassed rather than satisfied there, which is exactly why the first
+ * administrator has to be created through Supabase Auth first (see `auth.ts`)
+ * — the id written into `instance_admins` and `company_members` must be one a
+ * signed-in user will later present as `auth.uid()`.
+ *
+ * Every step is check-then-act, so `ekwo init` can be run twice on the same
+ * project without creating a second company or a second financial year. Each
+ * one reports whether it did the work or found it already done.
+ */
+import type { SqlClient } from './sql.js';
+export type StepOutcome = 'created' | 'already';
+export interface Step {
+    name: string;
+    outcome: StepOutcome;
+    detail?: string;
+}
+export interface BankAccountOptions {
+    /** The only field that is required to create one; without it, none is. */
+    iban: string;
+    bic?: string | undefined;
+    bankName?: string | undefined;
+    /** What it is called in the books. Defaults to the bank name, then to `Compte courant`. */
+    label?: string | undefined;
+}
+export interface BootstrapOptions {
+    organization: string;
+    country: string;
+    company: string;
+    /** Calendar year the first financial year opens in. */
+    fiscalYear: number;
+    /**
+     * First day of that year, as YYYY-MM-DD. Left out, the month comes from
+     * `country_defaults.fiscal_year_default` — and a pack that declares none
+     * produces a refusal naming the flag, never a January nobody chose.
+     */
+    fiscalYearStart?: string | undefined;
+    /** `auth.users.id` of the first administrator. */
+    adminUserId: string;
+    /** ISO 4217 code. Left out, the country model decides; it is `EUR` for both countries shipped. */
+    currencyCode?: string | undefined;
+    /** Two letters. Left out, the country model decides. Chooses which label of the pack lands in `accounts.name`. */
+    language?: string | undefined;
+    /** Chart of accounts to install. Left out, the pack's default chart. */
+    chartCode?: string | undefined;
+    /**
+     * How often the company files its periodic return. Left out, the cadence
+     * the pack proposes; left out by the pack too, the column stays null and
+     * nothing here invents one.
+     */
+    vatPeriod?: string | undefined;
+    /**
+     * How often the company files each declaration it is subject to, keyed on
+     * the code of the form. `vatPeriod` above is the same fact for the country's
+     * periodic return and is folded into this; a form named here and nowhere
+     * recorded simply gets no row, because a cadence nobody chose is not one.
+     */
+    filingPeriods?: Record<string, string> | undefined;
+    /** The main bank account, when the operator has one to give. */
+    bankAccount?: BankAccountOptions | undefined;
+}
+export interface BootstrapResult {
+    instanceId: string;
+    companyId: string;
+    fiscalYearName: string;
+    /** The first and last day the financial year was opened on. */
+    fiscalYearStart: string;
+    fiscalYearEnd: string;
+    /** The currency the company was created with. */
+    currencyCode: string;
+    /** The language the chart of accounts was copied in. */
+    language: string;
+    /** Version of the country pack the company copied, from `company_packs`. */
+    packVersion?: string | undefined;
+    /** Chart of accounts the company was installed on. */
+    chartCode?: string | undefined;
+    /** The cadence recorded on the company, when one was settled. */
+    vatPeriod?: string | undefined;
+    /** Every cadence recorded, by the code of the form it was recorded for. */
+    filingPeriods: Record<string, string>;
+    /** The bank account, when one was asked for. */
+    bankAccountId?: string | undefined;
+    steps: Step[];
+}
+/**
+ * The currency the country model proposes.
+ *
+ * `companies.currency_code` is not null and has a default, so the value has to
+ * be chosen *before* the insert — after it there is nothing empty left to
+ * fill, which is why `install_country_template` could never be the place for
+ * this. It is the reader `country_defaults.currency_code` never had.
+ */
+export declare function countryCurrency(db: SqlClient, country: string): Promise<string | undefined>;
+/**
+ * The language the country model proposes, for the same reason as the
+ * currency: the column has a default, so the choice has to be made before the
+ * insert. It is what `country_defaults.language_default` is for.
+ */
+export declare function countryLanguage(db: SqlClient, country: string): Promise<string | undefined>;
+/** One language a country pack publishes every label in. */
+export interface LanguageChoice {
+    /** ISO 639-1, two letters. */
+    code: string;
+    /** The country's own name in that language, which is a hint anyone can read. */
+    label: string;
+    /** True of the language the pack itself is written in. */
+    isPackLanguage: boolean;
+}
+/**
+ * The languages this country's pack publishes, the pack's own first.
+ *
+ * `ekwo init` asks rather than assumes: a Belgian company may keep its books
+ * in French, Dutch or German, and which one it is is not something a country
+ * code answers. The list comes from the database — `country_defaults` — and
+ * not from the pack folder, because an installation has the compiled seeds
+ * and no pack to read.
+ */
+export declare function countryLanguages(db: SqlClient, country: string): Promise<LanguageChoice[]>;
+/**
+ * The cadences the periodic return of this country is filed on.
+ *
+ * Read from the form rather than from a list in this file, because how often a
+ * return is filed is part of the return. An empty list means the installation
+ * carries no form for that country, and `ekwo init` then asks nothing: there
+ * is no cadence to choose between.
+ */
+export declare function countryVatPeriods(db: SqlClient, country: string): Promise<string[]>;
+/** A declaration form of a country, as an installation carries it. */
+export interface FilingForm {
+    code: string;
+    name: string;
+    /** The cadences the form is filed on. */
+    periods: string[];
+    /** The cadence the law of that country gives everybody, when it gives one. */
+    periodDefault?: string | undefined;
+    /** Whether this is the periodic return, which is what `--vat-period` names. */
+    isPeriodicReturn: boolean;
+}
+/**
+ * Every declaration form this country files, with what each one accepts and
+ * what it proposes.
+ *
+ * `ekwo init` asks once per form, because a company is subject to several
+ * declarations and each has a cadence of its own: the recapitulative statement
+ * of intra-Community supplies is not filed on the cadence of the return in any
+ * country read so far. An empty list means the installation carries no form for
+ * that country, and then there is nothing to ask.
+ */
+export declare function countryFilingForms(db: SqlClient, country: string): Promise<FilingForm[]>;
+/**
+ * The cadence the pack proposes, or nothing.
+ *
+ * Nothing is the answer for three of the four packs here: Belgium, France and
+ * Luxembourg each make the cadence follow turnover, so the pack has no way to
+ * know and says so by staying silent. Estonia's taxable period is the calendar
+ * month for everybody, so it proposes one. It is
+ * `country_defaults.vat_period_default`.
+ */
+export declare function countryVatPeriod(db: SqlClient, country: string): Promise<string | undefined>;
+/**
+ * The month the country model opens a financial year on, or nothing.
+ *
+ * `ekwo init` reads it to know whether it has to ask. The dates themselves
+ * are never computed here: `fiscal_year_bounds()` in the schema is the one
+ * place that turns a month into two days.
+ */
+export declare function countryFiscalYearOpening(db: SqlClient, country: string): Promise<string | undefined>;
+/** One chart a country pack offers. */
+export interface ChartChoice {
+    code: string;
+    name: string;
+    isDefault: boolean;
+    audience: string | null;
+    certificationStatus: string | null;
+    accounts: number;
+}
+/**
+ * The charts a country offers, the default one first.
+ *
+ * `ekwo init` asks only when there are two or more, and preselects nothing:
+ * the question whose wrong answer is a chart of accounts has no right default
+ * beyond the one the pack itself declares.
+ */
+export declare function countryCharts(db: SqlClient, country: string): Promise<ChartChoice[]>;
+/** What a pack says about itself: version and how much anyone has read it. */
+export interface PackSummary {
+    country: string;
+    name: string;
+    version: string;
+    certificationStatus: string;
+    certifiedBy: string | null;
+    certifiedAt: string | null;
+}
+export declare function countryPack(db: SqlClient, country: string): Promise<PackSummary | undefined>;
+/** Countries with a chart of accounts seeded in this database. */
+export declare function availableCountries(db: SqlClient): Promise<string[]>;
+/** A country offered at install time: its code, and what the pack calls it. */
+export interface InstalledPack {
+    country: string;
+    name: string;
+}
+/**
+ * What this installation can install a company on, in the order it is
+ * offered: the packs it holds, by name.
+ *
+ * The name comes from the pack — `country_packs.name` — so no list of
+ * countries and no label for one is ever written in this code. A database
+ * seeded before `country_packs` existed still has charts, so the codes of
+ * `account_templates` are the fallback, each standing as its own label.
+ */
+export declare function installedPacks(db: SqlClient): Promise<InstalledPack[]>;
+/** Whether the schema has been installed at all. */
+export declare function schemaIsInstalled(db: SqlClient): Promise<boolean>;
+export declare function bootstrap(db: SqlClient, options: BootstrapOptions): Promise<BootstrapResult>;
+interface BankAccountOutcome {
+    id: string;
+    outcome: StepOutcome;
+    label: string;
+    accountCode?: string | undefined;
+}
+/**
+ * The company's first bank account, wired to the bank journal and its ledger
+ * account.
+ *
+ * `install_country_template` already points the bank journal at 550000 or
+ * 512000, so the ledger side is known and this step does not ask for it. The
+ * IBAN is the natural key — `bank_accounts_company_iban_idx` — so running
+ * `init` again with the same one finds it rather than creating a second.
+ */
+export declare function ensureBankAccount(db: SqlClient, companyId: string, currencyCode: string, options: BankAccountOptions): Promise<BankAccountOutcome>;
+export {};
+//# sourceMappingURL=bootstrap.d.ts.map

package/dist/bootstrap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAG1C,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,CAAC;AAEhD,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,2FAA2F;IAC3F,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAC;IACpB,kGAAkG;IAClG,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,kHAAkH;IAClH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IACnD,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,2EAA2E;IAC3E,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,gDAAgD;IAChD,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAIjG;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAIjG;AAED,4DAA4D;AAC5D,MAAM,WAAW,cAAc;IAC7B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,KAAK,EAAE,MAAM,CAAC;IACd,0DAA0D;IAC1D,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAahG;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAWzF;AAED,sEAAsE;AACtE,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,8EAA8E;IAC9E,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,+EAA+E;IAC/E,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAsB9F;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAclG;AAED;;;;;;GAMG;AACH,wBAAsB,wBAAwB,CAC5C,EAAE,EAAE,SAAS,EACb,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAI7B;AAED,uCAAuC;AACvC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CA0B1F;AAED,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,wBAAsB,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAwBlG;AAED,kEAAkE;AAClE,wBAAsB,kBAAkB,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAKzE;AAED,+EAA+E;AAC/E,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAM5E;AAED,oDAAoD;AACpD,wBAAsB,iBAAiB,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CASvE;AAED,wBAAsB,SAAS,CAC7B,EAAE,EAAE,SAAS,EACb,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,eAAe,CAAC,CAgR1B;AAED,UAAU,kBAAkB;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,WAAW,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,EAAE,EAAE,SAAS,EACb,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,kBAAkB,CAAC,CA0E7B"}