create-protobase 0.23.13 → 0.24.0

package/dist/templates/erp/config/users/ui.ts

@@ -0,0 +1,9 @@
+import { view } from '@protobase/schema'
+import type { users } from './data'
+
+export const usersView = view<typeof users>('users')
+  .names({ singular: 'User', plural: 'Users' })
+  // Reached from the records that name a user; the profile menu's Users is the accounts page.
+  .nav({ hidden: true })
+  .fields((r) => ({ role: r.role.valueLabels({ admin: 'Admin', sales: 'Sales', finance: 'Finance', warehouse: 'Warehouse' }) }))
+  .list((r) => ({ columns: [r.email, r.name, r.role, r.active] }))

package/dist/templates/erp/config/warehouses/data.ts

@@ -0,0 +1,19 @@
+import { f, resource } from '@protobase/schema'
+import { erpAccess } from '../roles'
+
+/** inventory.warehouses. Unique: (organization_id, code) */
+export const warehouses = resource('warehouses')
+  .table('inventory.warehouses')
+  .fields({
+    id: f.integer().readOnly().filterable().sortable().dbDefault(),
+    organization_id: f.relation('organizations').filterable().sortable(),
+    code: f.text().filterable().sortable(),
+    name: f.text(),
+    city: f.text(),
+    country_code: f.relation('countries').filterable().sortable(),
+    created_at: f.timestamp().readOnly().dbDefault(),
+    updated_at: f.timestamp().readOnly().dbDefault(),
+  })
+  .primaryKey((r) => r.id)
+  .tenant((r) => r.organization_id)
+  .access(erpAccess('warehouses'))

package/dist/templates/erp/config/warehouses/ui.ts

@@ -0,0 +1,6 @@
+import { view } from '@protobase/schema'
+import type { warehouses } from './data'
+
+export const warehousesView = view<typeof warehouses>('warehouses')
+  .names({ singular: 'Warehouse', plural: 'Warehouses' })
+  .list((r) => ({ columns: [r.code, r.name, r.city] }))

package/dist/templates/erp/data.ts

@@ -0,0 +1,3 @@
+import type { ResourceModel } from '@protobase/schema'
+
+export type ErpResource = ResourceModel

package/dist/templates/erp/db/connection.ts

@@ -0,0 +1,7 @@
+import postgres from 'postgres'
+
+export const databaseUrl = process.env.DATABASE_URL ?? 'postgres://protobase:protobase@localhost:55432/protobase'
+
+export const connect = (options: postgres.Options<{}> = {}) => postgres(databaseUrl, { onnotice: () => {}, ...options })
+
+export type Db = ReturnType<typeof connect>

package/dist/templates/erp/db/drop.ts

@@ -0,0 +1,9 @@
+import { connect } from './connection'
+
+const sql = connect({ max: 1 })
+
+await sql.unsafe('drop schema if exists core, crm, catalog, sales, inventory, hr cascade')
+await sql.unsafe('drop table if exists public.schema_migrations, public.seed_info')
+console.log('dropped all erp schemas')
+
+await sql.end()

package/dist/templates/erp/db/kysely.ts

@@ -0,0 +1,13 @@
+import { Kysely, PostgresDialect } from 'kysely'
+import pg from 'pg'
+import { databaseUrl } from './connection'
+
+// date and timestamp (without zone) stay text; the API formats them itself
+const types = {
+  getTypeParser: (oid: number, format?: 'text' | 'binary') =>
+    oid === 1082 || oid === 1114 ? (value: string) => value : pg.types.getTypeParser(oid, format as 'text'),
+}
+
+/** Kysely over node-postgres, the way a deployment of the API would connect. */
+export const createDb = (max = 10) =>
+  new Kysely<any>({ dialect: new PostgresDialect({ pool: new pg.Pool({ connectionString: databaseUrl, max, types }) }) })

package/dist/templates/erp/db/migrations/001_core.sql

@@ -0,0 +1,48 @@
+create extension if not exists pg_trgm;
+create extension if not exists ltree;
+
+create table public.seed_info (
+  scale text not null,
+  seeded_at timestamptz not null default now()
+);
+
+create schema core;
+
+create table core.countries (
+  code text primary key,
+  name text not null,
+  eu_member boolean not null default false
+);
+
+create table core.currencies (
+  code text primary key,
+  name text not null,
+  symbol text not null,
+  decimals smallint not null default 2
+);
+
+create table core.organizations (
+  id integer generated by default as identity primary key,
+  name text not null,
+  slug text not null unique,
+  country_code text not null references core.countries (code),
+  currency_code text not null references core.currencies (code),
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now()
+);
+
+create table core.users (
+  id integer generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  email text not null,
+  name text not null,
+  role text not null check (role in ('admin', 'sales', 'finance', 'warehouse')),
+  active boolean not null default true,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, email)
+);
+
+create index users_role_idx on core.users (organization_id, role);
+create index organizations_country_idx on core.organizations (country_code);
+create index organizations_currency_idx on core.organizations (currency_code);

package/dist/templates/erp/db/migrations/002_crm.sql

@@ -0,0 +1,59 @@
+create schema crm;
+
+create table crm.companies (
+  id bigint generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  name text not null,
+  country_code text not null references core.countries (code),
+  city text not null,
+  vat_number text,
+  email text,
+  phone text,
+  status text not null default 'active' check (status in ('lead', 'active', 'dormant')),
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now()
+);
+
+create index companies_organization_idx on crm.companies (organization_id, created_at);
+create index companies_country_idx on crm.companies (country_code);
+create index companies_status_idx on crm.companies (organization_id, status);
+create index companies_name_trgm_idx on crm.companies using gin (name gin_trgm_ops);
+
+create table crm.people (
+  id bigint generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  company_id bigint not null references crm.companies (id),
+  first_name text not null,
+  last_name text not null,
+  email text,
+  phone text,
+  job_title text,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now()
+);
+
+create index people_company_idx on crm.people (company_id);
+create index people_organization_idx on crm.people (organization_id, created_at);
+
+create table crm.tags (
+  id integer generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  name text not null,
+  color text not null,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, name)
+);
+
+create table crm.company_tags (
+  company_id bigint not null references crm.companies (id),
+  tag_id integer not null references crm.tags (id),
+  organization_id integer not null references core.organizations (id),
+  added_by integer references core.users (id),
+  added_at timestamptz not null default now(),
+  primary key (company_id, tag_id)
+);
+
+create index company_tags_tag_idx on crm.company_tags (tag_id);
+create index company_tags_organization_idx on crm.company_tags (organization_id);
+create index company_tags_added_by_idx on crm.company_tags (added_by);

package/dist/templates/erp/db/migrations/003_catalog.sql

@@ -0,0 +1,38 @@
+create schema catalog;
+
+create table catalog.categories (
+  id integer generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  parent_id integer references catalog.categories (id),
+  name text not null,
+  slug text not null,
+  position integer not null default 0,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, slug)
+);
+
+create index categories_parent_idx on catalog.categories (parent_id, position);
+
+create table catalog.products (
+  id bigint generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  category_id integer not null references catalog.categories (id),
+  sku text not null,
+  name text not null,
+  description text,
+  price numeric(12, 2) not null check (price >= 0),
+  currency_code text not null references core.currencies (code),
+  attributes jsonb not null default '{}',
+  active boolean not null default true,
+  deleted_at timestamptz,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, sku)
+);
+
+create index products_category_idx on catalog.products (category_id);
+create index products_organization_idx on catalog.products (organization_id, created_at);
+create index products_name_trgm_idx on catalog.products using gin (name gin_trgm_ops);
+create index products_attributes_idx on catalog.products using gin (attributes jsonb_path_ops);
+create index products_live_idx on catalog.products (organization_id) where deleted_at is null;

package/dist/templates/erp/db/migrations/004_sales.sql

@@ -0,0 +1,86 @@
+create schema sales;
+
+create type sales.invoice_status as enum ('draft', 'sent', 'paid', 'overdue');
+
+create table sales.orders (
+  id uuid primary key default uuidv7(),
+  organization_id integer not null references core.organizations (id),
+  number text not null,
+  company_id bigint not null references crm.companies (id),
+  person_id bigint references crm.people (id),
+  owner_id integer not null references core.users (id),
+  status text not null check (status in ('draft', 'confirmed', 'picking', 'shipped', 'delivered', 'cancelled')),
+  currency_code text not null references core.currencies (code),
+  discount_percent numeric(5, 2) not null default 0,
+  total numeric(14, 2) not null default 0,
+  paid boolean not null default false,
+  notes text,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, number)
+);
+
+create index orders_organization_idx on sales.orders (organization_id, created_at);
+create index orders_company_idx on sales.orders (company_id);
+create index orders_person_idx on sales.orders (person_id);
+create index orders_owner_idx on sales.orders (owner_id);
+create index orders_status_idx on sales.orders (organization_id, status);
+create index orders_created_idx on sales.orders (created_at);
+
+create table sales.order_lines (
+  order_id uuid not null references sales.orders (id),
+  line_no integer not null,
+  organization_id integer not null references core.organizations (id),
+  product_id bigint not null references catalog.products (id),
+  description text not null,
+  quantity integer not null check (quantity > 0),
+  unit_price numeric(12, 2) not null,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  primary key (order_id, line_no)
+);
+
+create index order_lines_product_idx on sales.order_lines (product_id);
+create index order_lines_organization_idx on sales.order_lines (organization_id);
+
+create table sales.invoices (
+  id bigint generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  number text not null,
+  order_id uuid references sales.orders (id),
+  company_id bigint not null references crm.companies (id),
+  status sales.invoice_status not null default 'draft',
+  issued_at date not null,
+  due_at date not null,
+  vat_rate numeric(4, 2) not null default 21,
+  subtotal numeric(14, 2) not null,
+  vat numeric(14, 2) not null,
+  total numeric(14, 2) not null,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, number)
+);
+
+create index invoices_organization_idx on sales.invoices (organization_id, created_at);
+create index invoices_company_idx on sales.invoices (company_id);
+create index invoices_order_idx on sales.invoices (order_id);
+create index invoices_status_idx on sales.invoices (organization_id, status);
+create index invoices_due_idx on sales.invoices (due_at) where status in ('sent', 'overdue');
+
+create table sales.invoice_lines (
+  id bigint generated by default as identity primary key,
+  invoice_id bigint not null references sales.invoices (id),
+  organization_id integer not null references core.organizations (id),
+  position integer not null,
+  product_id bigint references catalog.products (id),
+  description text not null,
+  quantity integer not null check (quantity > 0),
+  unit_price numeric(12, 2) not null,
+  line_total numeric(14, 2) generated always as (quantity * unit_price) stored,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (invoice_id, position)
+);
+
+create index invoice_lines_product_idx on sales.invoice_lines (product_id);
+create index invoice_lines_organization_idx on sales.invoice_lines (organization_id);

package/dist/templates/erp/db/migrations/005_inventory.sql

@@ -0,0 +1,65 @@
+create schema inventory;
+
+create table inventory.warehouses (
+  id integer generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  code text not null,
+  name text not null,
+  city text not null,
+  country_code text not null references core.countries (code),
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (organization_id, code)
+);
+
+create index warehouses_country_idx on inventory.warehouses (country_code);
+
+create table inventory.locations (
+  id integer generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  warehouse_id integer not null references inventory.warehouses (id),
+  path ltree not null,
+  name text not null,
+  created_at timestamptz not null default now(),
+  updated_at timestamptz not null default now(),
+  unique (warehouse_id, path)
+);
+
+create index locations_organization_idx on inventory.locations (organization_id);
+create index locations_path_idx on inventory.locations using gist (path);
+
+-- Append-only ledger: rows are never updated, so there is no updated_at.
+create table inventory.stock_moves (
+  id bigint generated by default as identity primary key,
+  organization_id integer not null references core.organizations (id),
+  product_id bigint not null references catalog.products (id),
+  warehouse_id integer not null references inventory.warehouses (id),
+  location_id integer not null references inventory.locations (id),
+  kind text not null check (kind in ('receipt', 'issue', 'transfer', 'adjustment')),
+  quantity integer not null check (quantity <> 0),
+  unit_cost numeric(12, 2) not null,
+  reference text,
+  moved_at timestamptz not null,
+  user_id integer references core.users (id)
+);
+
+create index stock_moves_moved_at_idx on inventory.stock_moves (moved_at);
+create index stock_moves_organization_idx on inventory.stock_moves (organization_id, moved_at);
+create index stock_moves_product_idx on inventory.stock_moves (product_id, moved_at);
+create index stock_moves_warehouse_idx on inventory.stock_moves (warehouse_id);
+create index stock_moves_location_idx on inventory.stock_moves (location_id);
+create index stock_moves_user_idx on inventory.stock_moves (user_id);
+create index stock_moves_kind_idx on inventory.stock_moves (kind);
+
+-- Derived from stock_moves: on-hand quantity per product and location.
+create table inventory.stock_levels (
+  product_id bigint not null references catalog.products (id),
+  location_id integer not null references inventory.locations (id),
+  organization_id integer not null references core.organizations (id),
+  quantity integer not null,
+  updated_at timestamptz not null default now(),
+  primary key (product_id, location_id)
+);
+
+create index stock_levels_location_idx on inventory.stock_levels (location_id);
+create index stock_levels_organization_idx on inventory.stock_levels (organization_id);

package/dist/templates/erp/db/migrations/006_hr_legacy.sql

@@ -0,0 +1,16 @@
+create schema hr;
+
+-- Legacy payroll import: uppercase identifiers, kept as-is on purpose.
+create table hr."EMP_MASTER" (
+  "EMP_ID" integer primary key,
+  "ORGANIZATION_ID" integer not null references core.organizations (id),
+  "EMP_NAME" varchar(60) not null,
+  "DEPT_CD" char(3) not null,
+  "HIRE_DT" date not null,
+  "SAL_AMT" numeric(10, 2),
+  "MGR_ID" integer references hr."EMP_MASTER" ("EMP_ID"),
+  "ACTIVE_FLG" char(1) not null default 'Y' check ("ACTIVE_FLG" in ('Y', 'N'))
+);
+
+create index "EMP_MASTER_ORG_IDX" on hr."EMP_MASTER" ("ORGANIZATION_ID");
+create index "EMP_MASTER_MGR_IDX" on hr."EMP_MASTER" ("MGR_ID");

package/dist/templates/erp/db/migrations/007_filter_indexes.sql

@@ -0,0 +1,4 @@
+create index orders_total_idx on sales.orders (organization_id, total);
+create index orders_paid_idx on sales.orders (organization_id, paid);
+create index invoices_issued_at_idx on sales.invoices (organization_id, issued_at);
+create index stock_moves_quantity_idx on inventory.stock_moves (organization_id, quantity);

package/dist/templates/erp/db/migrations/008_calculated_totals.sql

@@ -0,0 +1,98 @@
+alter table sales.invoices
+  alter column subtotal set default 0,
+  alter column vat set default 0,
+  alter column total set default 0;
+alter table sales.orders alter column total set default 0;
+
+-- Invoice totals: subtotal from the lines, VAT from the invoice rate.
+create function sales.refresh_invoice_totals(ids bigint[]) returns void language sql as $$
+  update sales.invoices i
+  set subtotal = s.subtotal,
+      vat = round(s.subtotal * i.vat_rate / 100, 2),
+      total = s.subtotal + round(s.subtotal * i.vat_rate / 100, 2)
+  from (
+    select inv.id, coalesce((select sum(l.line_total) from sales.invoice_lines l where l.invoice_id = inv.id), 0) as subtotal
+    from sales.invoices inv
+    where inv.id = any (ids)
+  ) s
+  where i.id = s.id
+    and (i.subtotal, i.vat, i.total) is distinct from (s.subtotal, round(s.subtotal * i.vat_rate / 100, 2), s.subtotal + round(s.subtotal * i.vat_rate / 100, 2))
+$$;
+
+create function sales.invoice_lines_inserted() returns trigger language plpgsql as $$
+begin
+  perform sales.refresh_invoice_totals(array(select distinct invoice_id from new_rows));
+  return null;
+end $$;
+
+create function sales.invoice_lines_updated() returns trigger language plpgsql as $$
+begin
+  perform sales.refresh_invoice_totals(array(select invoice_id from old_rows union select invoice_id from new_rows));
+  return null;
+end $$;
+
+create function sales.invoice_lines_deleted() returns trigger language plpgsql as $$
+begin
+  perform sales.refresh_invoice_totals(array(select distinct invoice_id from old_rows));
+  return null;
+end $$;
+
+-- Transition tables cannot be combined with several events, so one trigger per event.
+create trigger invoice_lines_inserted after insert on sales.invoice_lines
+  referencing new table as new_rows for each statement execute function sales.invoice_lines_inserted();
+create trigger invoice_lines_updated after update on sales.invoice_lines
+  referencing old table as old_rows new table as new_rows for each statement execute function sales.invoice_lines_updated();
+create trigger invoice_lines_deleted after delete on sales.invoice_lines
+  referencing old table as old_rows for each statement execute function sales.invoice_lines_deleted();
+
+-- A new or re-rated invoice recomputes VAT and total from its current subtotal.
+create function sales.invoice_apply_vat() returns trigger language plpgsql as $$
+begin
+  new.vat := round(new.subtotal * new.vat_rate / 100, 2);
+  new.total := new.subtotal + new.vat;
+  return new;
+end $$;
+
+create trigger invoice_apply_vat before insert or update of vat_rate on sales.invoices
+  for each row execute function sales.invoice_apply_vat();
+
+-- Order totals: sum of the lines.
+create function sales.refresh_order_totals(ids uuid[]) returns void language sql as $$
+  update sales.orders o
+  set total = s.total
+  from (
+    select ord.id, coalesce((select sum(l.quantity * l.unit_price) from sales.order_lines l where l.order_id = ord.id), 0) as total
+    from sales.orders ord
+    where ord.id = any (ids)
+  ) s
+  where o.id = s.id and o.total is distinct from s.total
+$$;
+
+create function sales.order_lines_inserted() returns trigger language plpgsql as $$
+begin
+  perform sales.refresh_order_totals(array(select distinct order_id from new_rows));
+  return null;
+end $$;
+
+create function sales.order_lines_updated() returns trigger language plpgsql as $$
+begin
+  perform sales.refresh_order_totals(array(select order_id from old_rows union select order_id from new_rows));
+  return null;
+end $$;
+
+create function sales.order_lines_deleted() returns trigger language plpgsql as $$
+begin
+  perform sales.refresh_order_totals(array(select distinct order_id from old_rows));
+  return null;
+end $$;
+
+create trigger order_lines_inserted after insert on sales.order_lines
+  referencing new table as new_rows for each statement execute function sales.order_lines_inserted();
+create trigger order_lines_updated after update on sales.order_lines
+  referencing old table as old_rows new table as new_rows for each statement execute function sales.order_lines_updated();
+create trigger order_lines_deleted after delete on sales.order_lines
+  referencing old table as old_rows for each statement execute function sales.order_lines_deleted();
+
+-- Recalculate existing rows once.
+select sales.refresh_invoice_totals(array(select id from sales.invoices));
+select sales.refresh_order_totals(array(select id from sales.orders));

package/dist/templates/erp/db/migrations/011_auth_organizations.sql

@@ -0,0 +1,22 @@
+-- The auth schema changes this version of Protobase needs, written by `protobase auth migration`.
+-- Applied with the project's other migrations; edit or remove statements the project handles differently.
+
+create schema if not exists "auth";
+
+alter table "auth"."user" add column if not exists "last_organization_id" text;
+
+alter table "auth"."session" add column if not exists "active_organization_id" text;
+
+create table if not exists "auth"."organization" ("id" text not null primary key, "name" text not null, "slug" text not null unique, "logo" text, "created_at" timestamptz not null, "metadata" text);
+
+create table if not exists "auth"."member" ("id" text not null primary key, "organization_id" text not null references "auth"."organization" ("id") on delete cascade, "user_id" text not null references "auth"."user" ("id") on delete cascade, "role" text not null, "created_at" timestamptz not null, "app_roles" jsonb);
+
+create table if not exists "auth"."invitation" ("id" text not null primary key, "organization_id" text not null references "auth"."organization" ("id") on delete cascade, "email" text not null, "role" text, "status" text not null, "expires_at" timestamptz not null, "created_at" timestamptz default CURRENT_TIMESTAMP not null, "inviter_id" text not null references "auth"."user" ("id") on delete cascade, "app_roles" jsonb);
+
+create index if not exists "member_organization_id_idx" on "auth"."member" ("organization_id");
+
+create index if not exists "member_user_id_idx" on "auth"."member" ("user_id");
+
+create index if not exists "invitation_organization_id_idx" on "auth"."invitation" ("organization_id");
+
+create index if not exists "invitation_email_idx" on "auth"."invitation" ("email");