shutro-erp 0.2.0 → 0.3.0

package/README.md

@@ -40,31 +40,38 @@ npm install shutro-erp      # Shutro, the ORM, comes with it
 npx kosh init
 ```
 
-The setup asks for what the installation needs. Press **Enter** to keep the value in `[brackets]`:
+The setup asks for what the installation needs, one question at a time: type an answer or press **Enter** for
+the default shown, pick from lists with **↑ ↓** and **Enter**, tick apps with **Space**, stop with **Ctrl+C**
+(piped or scripted, the same questions are asked line by line):
 
 | Question | Example | Notes |
 |---|---|---|
-| PostgreSQL | `1` your server, `2` start one in Docker | `2` needs Docker Desktop running; it writes `compose.yaml` and starts the `db` service |
+| PostgreSQL | your server, or start one in Docker | Docker needs Docker Desktop running; it writes `compose.yaml` and starts the `db` service |
 | Username, password, port, host, database name | `postgres`, (hidden), `5432`, `localhost`, `my_erp` | for `1`; a missing database is created after you confirm; if nothing answers, it offers Docker instead |
-| Company name, currency | `Padma Traders`, `BDT` | the first company; more companies later |
+| Company name, currency, country | `Padma Traders`, `BDT`, Bangladesh | the first company; a country with a localization gets its taxes, chart and returns |
 | Language, time zone | `bn`, `Asia/Dhaka` | the administrator's |
 | Administrator login, name, email, password | `admin`, …, 12+ characters | the password is typed hidden and stored only as a hash |
-| Apps | `permissions,reporting,messaging` | roles and approvals, reports and documents, chatter and attachments |
-| File storage | `1` a folder, `2` S3-compatible | S3, SeaweedFS, MinIO; the bucket is created |
+| Apps | all ticked; untick what you do not need | roles and approvals, reports, chatter, the business apps |
+| File storage | a folder, or S3-compatible | S3, SeaweedFS, MinIO; the bucket is created |
 | Valkey/Redis URL | empty | optional: rate limits and caches shared by several servers |
-| API port | `3000` | |
+| API port, back-office (web) port | `3000`, `5173` | the next free ones are proposed |
 | Authenticator code | `123456` | scan the printed secret, type a code; **keep the recovery codes** it prints |
 
 Then it writes the project, creates the database tables (`migrations/0001_init.sql`), the company and the
-administrator, and loads the apps' default data. Run `npm install` once in the project, then start it:
+administrator, and loads the apps' default data. **Then it starts Kosh for you**: it installs the project's
+dependencies (with the package manager you ran it with: npm, pnpm, yarn or bun), starts the API and the
+back-office, waits until both answer, and opens the back-office in your browser on the web port. Both keep
+running in that terminal; **Ctrl+C** stops them. Sign in with the administrator's login, password and a code from
+the authenticator app.
+
+To start it again later (or after `--no-start`, which only sets up):
 
 ```sh
+cd my-erp
 npm start            # the API on http://localhost:3000
 npm run web          # the back-office on http://localhost:5173, in a second terminal
 ```
 
-Sign in with the administrator's login, password and a code from the authenticator app.
-
 **Without questions** (scripts, CI): pass the answers as flags.
 
 ```sh
@@ -74,7 +81,7 @@ npx kosh init --yes \
   --database-url postgres://postgres:postgres@localhost:5432/my_erp --create-database \
   --company "Padma Traders" --currency BDT --lang bn --tz Asia/Dhaka \
   --admin-login admin --admin-password "a long passphrase here" \
-  --apps permissions,reporting,messaging --storage-dir ./var/attachments --port 3000
+  --apps permissions,reporting,messaging --storage-dir ./var/attachments --port 3000 --web-port 5173
 ```
 
 With `--yes` nothing is asked, so the authenticator is not enrolled: run `npx kosh init` again in a terminal to

package/dist/account_portal/.kosh/bindings.d.ts

@@ -0,0 +1,22 @@
+export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
+import { type DefinitionHelpers } from '../../server/orm.js';
+import type { DefaultLoaded, Env as CoreEnv, RecordSet as CoreRecordSet, Shutro as CoreShutro } from '../../server/orm.js';
+import type { SchemaView } from './schema.js';
+export type { SchemaView };
+/** Every model visible in this view. */
+export type ModelName = keyof SchemaView & string;
+/** `Env` typed to this view. */
+export type Env = CoreEnv<SchemaView>;
+/** `Shutro` typed to this view. */
+export type Shutro = CoreShutro<SchemaView>;
+/** A recordset of `M`, with the default loaded shape unless `L` is given. */
+export type Records<M extends ModelName, L = DefaultLoaded<SchemaView, M>> = CoreRecordSet<SchemaView, M, L>;
+export declare const compute: DefinitionHelpers<SchemaView>['compute'];
+export declare const check: DefinitionHelpers<SchemaView>['check'];
+export declare const onchange: DefinitionHelpers<SchemaView>['onchange'];
+export declare const records: DefinitionHelpers<SchemaView>['records'];
+export declare const method: DefinitionHelpers<SchemaView>['method'];
+/** Module data (RFC 0017): records, overrides of dependencies' records, and references, typed like creates. */
+export declare const record: DefinitionHelpers<SchemaView>['record'];
+export declare const override: DefinitionHelpers<SchemaView>['override'];
+export declare const ref: DefinitionHelpers<SchemaView>['ref'];

package/dist/account_portal/.kosh/bindings.js

@@ -0,0 +1,15 @@
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: d1607b05570077f9
+// Bindings of module `account_portal`: import the definition API from here to get types scoped to what it can see.
+export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
+import { definitions } from '../../server/orm.js';
+/** Definition callbacks typed against this module's view: no casts in computes, checks, onchange, methods. */
+const helpers = definitions();
+export const compute = helpers.compute;
+export const check = helpers.check;
+export const onchange = helpers.onchange;
+export const records = helpers.records;
+export const method = helpers.method;
+/** Module data (RFC 0017): records, overrides of dependencies' records, and references, typed like creates. */
+export const record = helpers.record;
+export const override = helpers.override;
+export const ref = helpers.ref;