biz-a-cli 2.3.80-15419 → 2.3.80

package/engine/fina/routes/recurring.js

@@ -1,27 +0,0 @@
-/*
- * Doc 8 M4 — `fina/recurring/*`: recurring detail lines, shared with FINA desktop (T-33–T-38, D8).
- *
- * `list { document }` and `get { document, id }`: any mapped FINA user (T-36). `save { document, name, rows }`: the
- * create right; the name is new (T-34). `remove { document, id }`: the edit right (D4). There is no edit (T-37).
- *
- * ⚠️ Registered as an engine target: export routes only. `remove`, because `delete` is a reserved word.
- */
-import { runFinaRoute } from "../route.js";
-import { createIdentity } from "../identity.js";
-import { createRecurringService } from "../recurring.js";
-
-const service = (deps) => createRecurringService({ client: deps.client, identity: createIdentity(deps) });
-
-export const list = (payload, _argv, context) =>
-	runFinaRoute({ name: "recurring/list", context }, ({ deps, principal }) => service(deps).list(principal, payload?.document));
-
-export const get = (payload, _argv, context) =>
-	runFinaRoute({ name: "recurring/get", context }, ({ deps, principal }) => service(deps).get(principal, payload?.document, payload?.id));
-
-export const save = (payload, _argv, context) =>
-	runFinaRoute({ name: "recurring/save", context }, ({ deps, principal }) =>
-		service(deps).save(principal, payload?.document, { name: payload?.name, rows: payload?.rows }),
-	);
-
-export const remove = (payload, _argv, context) =>
-	runFinaRoute({ name: "recurring/remove", context }, ({ deps, principal }) => service(deps).remove(principal, payload?.document, payload?.id));

package/engine/fina/routes/session.js

@@ -1,23 +0,0 @@
-/*
- * Doc 8 — `fina/session/*`: for any signed-in user of a FINA Cloud company.
- *
- * `me` says who the caller is in FINA and what they may do (S-02), so screens can hide what is not allowed (S-04),
- * plus the date lock, the FINA features and the module settings (M4: the JV's default template, rate editable,
- * mandatory dimensions) the screens depend on. The server enforces all of it again on every
- * write; this answer is for the UI only.
- *
- * ⚠️ Registered as an engine target: export routes only.
- */
-import { runFinaRoute } from "../route.js";
-import { createIdentity } from "../identity.js";
-import { createSettingsStore } from "../settings.js";
-import { createFeatures } from "../features.js";
-
-export const me = (_payload, _argv, context) =>
-	runFinaRoute({ name: "session/me", context }, async ({ deps, principal, config }) => {
-		const identity = await createIdentity(deps).resolve(principal);
-		const settings = await createSettingsStore(deps).read();
-		const features = await createFeatures({ client: deps.client }).read();
-		/* Doc 8 M3: dbIndex = the FINA database the master lists read (the operator flag), so no config hard-codes it. */
-		return { ...identity, lockUpTo: settings.lock.upTo, features, dbIndex: config?.dbIndex ?? null, settings: { jv: settings.jv } };
-	});

package/engine/fina/routes/setup.js

@@ -1,58 +0,0 @@
-/*
- * Doc 8 M1 — `fina/setup/*`: the server side of the FINA Cloud setup console (spec §3). ADMINISTRATORS only.
- *
- * ⚠️ Registered as an engine target (bin/hubEvent.js EngineRegistry), so EVERY export here is callable from a
- * browser. Export routes only; the work lives in the modules beside this folder.
- */
-import { runFinaRoute } from "../route.js";
-import { createFeatures } from "../features.js";
-import { createSettingsStore } from "../settings.js";
-import { createUserMap } from "../userMap.js";
-import { listTemplates, TEMPLATE_TYPE } from "../template.js";
-import { publishApproval } from "../approval.js";
-
-const admin = (name, context, work) => runFinaRoute({ name: `setup/${name}`, context, admin: true }, work);
-
-/* Everything the console shows on load (C-04, C-05, §3.4, C-14). */
-export const state = (_payload, _argv, context) =>
-	admin("state", context, async ({ deps, config }) => ({
-		finaDbIndex: config.dbIndex,
-		features: await createFeatures({ client: deps.client }).read(),
-		settings: await createSettingsStore(deps).read(),
-		templates: await listTemplates(deps.client, TEMPLATE_TYPE.JV),
-	}));
-
-/* C-05: Multi Department / Multi Project, written to FINA itself. C-12 refuses switching one off while used. */
-export const saveFeatures = (payload, _argv, context) =>
-	admin("saveFeatures", context, async ({ deps }) =>
-		createFeatures({ client: deps.client }).save({ multiDept: payload?.multiDept, multiProject: payload?.multiProject }),
-	);
-
-/* §3.4 / C-14: `{ jv?: {...}, lock?: {...} }`, only the keys being changed. Answers every section as stored. */
-export const saveSettings = (payload, _argv, context) =>
-	admin("saveSettings", context, async ({ deps, principal }) => createSettingsStore(deps).write(payload, principal.userId));
-
-/* S-01: the Biz-A users, the active FINA users and the current map. */
-export const users = (_payload, _argv, context) => admin("users", context, async ({ deps }) => createUserMap(deps).list());
-
-/* S-01: `{ rows: [{ bizaUserId, finaUserId | null }] }`. */
-export const saveUserMap = (payload, _argv, context) =>
-	admin("saveUserMap", context, async ({ deps, principal }) => createUserMap(deps).save(payload, principal.userId));
-
-/*
- * Doc 8 M7 (A-02, A-04): the console Publish with Need Approval on — the JV approval workflow and its two effect
- * scripts, on this hub's database. A definition someone changed in the BPM module is kept (A-03); the same one is not
- * published again.
- */
-export const approval = (_payload, _argv, context) =>
-	admin("approval", context, async ({ deps, principal, config }) => {
-		const workflow = deps.workflow ?? (await import("../../bpm/workflow.js"));
-		const apiConfig = { dbIndex: config.tenantDbIndex };
-		return publishApproval({
-			exec: deps.exec,
-			execStatements: deps.execStatements,
-			save: (p) => workflow.save({ ...p, apiConfig }),
-			publish: (p) => workflow.publish({ ...p, apiConfig }),
-			userId: principal.userId,
-		});
-	});

package/engine/fina/routes/submission.js

@@ -1,46 +0,0 @@
-/*
- * Doc 8 M7 — JV submissions (pengajuan), with Need Approval on (submission.js).
- *
- * - `fina/submission/get` `{ id }`: its JV (master, lines), number, status, the FINA JV it became, why posting failed,
- *   and — while it waits — what would stop its posting now (A-18). Any mapped FINA user.
- * - `fina/submission/save` `{ id|null, master, lines, requestId }`: a new one (the create right) gets its number and
- *   its approval workflow; a waiting one is edited (the edit right, A-17). The JV rules, the Biz-A lock and FINA's
- *   period are checked as for a JV. Answers `{ id, number }`.
- * - `fina/submission/remove` `{ id, requestId }`: a waiting one only (M-20) — its workflow ended, its files and the row
- *   gone.
- * - `fina/submission/compare` `{ id }` (Doc 8 M7b, L-02 / L-09 / A-16): the submission next to the JV it became in
- *   FINA — both sides with FINA's display values, `jvState` POSTED / NOT_FOUND / NOT_POSTED, and the differences.
- *   Any mapped FINA user.
- *
- * Setujui / Tolak are the workflow's transitions (bpm/workflowRT, the approver role); their effects post or close it.
- *
- * ⚠️ Registered as an engine target: export routes only.
- */
-import { runFinaRoute } from "../route.js";
-import { submissionServiceOf } from "../approvalService.js";
-import { compareSubmission } from "../submissionCompare.js";
-import { createIdentity } from "../identity.js";
-import { createSubmissionRepo } from "../submissionRepo.js";
-
-export const get = (payload, _argv, context) =>
-	runFinaRoute({ name: "submission/get", context }, ({ deps, principal, config }) => submissionServiceOf(deps, config).get(principal, payload?.id));
-
-export const save = (payload, _argv, context) =>
-	runFinaRoute({ name: "submission/save", context }, ({ deps, principal, config }) =>
-		submissionServiceOf(deps, config).save(
-			principal,
-			{ id: payload?.id, master: payload?.master, lines: payload?.lines, requestId: payload?.requestId },
-			{ dbIndex: config?.dbIndex },
-		),
-	);
-
-/* `remove` because `delete` is a reserved word (as for documents). */
-export const remove = (payload, _argv, context) =>
-	runFinaRoute({ name: "submission/remove", context }, ({ deps, principal, config }) =>
-		submissionServiceOf(deps, config).remove(principal, { id: payload?.id, requestId: payload?.requestId }, { dbIndex: config?.dbIndex }),
-	);
-
-export const compare = (payload, _argv, context) =>
-	runFinaRoute({ name: "submission/compare", context }, ({ deps, principal }) =>
-		compareSubmission({ client: deps.client, identity: createIdentity(deps), repo: createSubmissionRepo({ exec: deps.exec }) }, principal, payload?.id),
-	);

package/engine/fina/routes/template.js

@@ -1,31 +0,0 @@
-/*
- * Doc 8 M4 — `fina/template/get`: what a document's form is laid out from (T-01–T-16, T-22, T-23).
- *
- * Payload `{ document, templateId? }`. Answers the type's templates (for the selector), the chosen one (asked → the
- * console's default → FINA's default → the first), its elements, and the extended fields mapped onto the document's
- * tables. Any mapped FINA user (D4: view).
- *
- * ⚠️ Registered as an engine target: export routes only.
- */
-import { runFinaRoute } from "../route.js";
-import { createIdentity, requireRight } from "../identity.js";
-import { createSettingsStore } from "../settings.js";
-import { documentOf } from "../documents/index.js";
-import { listTemplates, chooseTemplateId, assertTemplateOfType, readTemplateElements, readMappings } from "../template.js";
-
-export const get = (payload, _argv, context) =>
-	runFinaRoute({ name: "template/get", context }, async ({ deps, principal }) => {
-		const document = documentOf(payload?.document);
-		requireRight(await createIdentity(deps).resolve(principal), document.rights, null);
-		const templates = await listTemplates(deps.client, document.templateType);
-		const asked = payload?.templateId;
-		const requested = asked === null || asked === undefined || asked === "" ? null : assertTemplateOfType(templates, asked);
-		const settings = await createSettingsStore(deps).read();
-		const templateId = chooseTemplateId({ templates, requested, settingDefault: settings?.[document.name]?.defaultTemplateId });
-		return {
-			templates,
-			templateId,
-			elements: await readTemplateElements(deps.client, templateId),
-			mappings: await readMappings(deps.client, document.extended),
-		};
-	});

package/engine/fina/settings.js

@@ -1,159 +0,0 @@
-/*
- * Doc 8 — the FINA Cloud settings the SERVER enforces, in engine/fina's own table FINA$SETTING (one JSON value per
- * section). The setup console writes them through `fina/setup/saveSettings`; nothing else may.
- *
- * - `lock`: the Biz-A date lock (C-14, D2a).
- * - `jv`: Need Approval (A-01), the default template (§3.4, T-22), rate editable (F-18), department / project
- *   mandatory (F-09, D5), attachment limits (F-35). Biz-A only, never written to FINA (C-13).
- *
- * ⚠️ CLOSED SCHEMA. An unknown section or key is refused, never stored: a misspelt setting that was silently kept
- * would leave the implementor believing a rule was on.
- */
-import { finaError } from "./errors.js";
-import { toDateOnly } from "./lock.js";
-import { logger } from "../../logger.js";
-
-export const SETTING_DEFAULTS = Object.freeze({
-	lock: Object.freeze({ upTo: null }),
-	jv: Object.freeze({
-		needApproval: false,
-		/* null = FINA's own default template (TEMPLATE.ISDEFTEMPLATE). */
-		defaultTemplateId: null,
-		/* FINA desktop always lets the rate be edited; Biz-A matches it until the implementor says otherwise. */
-		rateEditable: true,
-		deptMandatory: false,
-		projectMandatory: false,
-		attachments: Object.freeze({ maxFiles: 5, maxFileMb: 5, extensions: Object.freeze(["pdf", "jpg", "jpeg", "png"]) }),
-	}),
-});
-
-const isPlain = (v) => v !== null && typeof v === "object" && !Array.isArray(v);
-const clone = (v) => JSON.parse(JSON.stringify(v));
-
-/* One level of nesting is all the schema has (jv.attachments). */
-const lay = (base, over) => {
-	const out = clone(base);
-	if (!isPlain(over)) return out;
-	for (const [key, value] of Object.entries(over)) {
-		out[key] = isPlain(out[key]) && isPlain(value) ? { ...out[key], ...value } : value;
-	}
-	return out;
-};
-
-const EXTENSION = /^[a-z0-9]{1,10}$/;
-
-/* Each check answers null when the value is fine, or the reason. `normalise` turns an accepted value into what is
-   stored. */
-const SCHEMA = {
-	lock: {
-		upTo: {
-			normalise: (v) => (v === null || v === "" ? null : toDateOnly(v)),
-			check: (v) => (v === null || v === "" || (typeof v === "string" && toDateOnly(v) === v) ? null : "must be a date (YYYY-MM-DD) or empty"),
-		},
-	},
-	jv: {
-		needApproval: { check: (v) => (typeof v === "boolean" ? null : "must be true or false") },
-		defaultTemplateId: {
-			normalise: (v) => (v === null || v === "" ? null : Number(v)),
-			check: (v) => (v === null || v === "" || (Number.isInteger(Number(v)) && Number(v) > 0 && !/\D/.test(String(v))) ? null : "must be a positive whole number or empty"),
-		},
-		rateEditable: { check: (v) => (typeof v === "boolean" ? null : "must be true or false") },
-		deptMandatory: { check: (v) => (typeof v === "boolean" ? null : "must be true or false") },
-		projectMandatory: { check: (v) => (typeof v === "boolean" ? null : "must be true or false") },
-		attachments: {
-			nested: {
-				maxFiles: { check: (v) => (Number.isInteger(v) && v >= 0 && v <= 100 ? null : "must be a whole number from 0 to 100") },
-				maxFileMb: { check: (v) => (typeof v === "number" && Number.isFinite(v) && v > 0 && v <= 100 ? null : "must be a number above 0 and at most 100") },
-				extensions: {
-					normalise: (v) => [...new Set(v.map((e) => String(e).trim().toLowerCase().replace(/^\./, "")))],
-					check: (v) =>
-						Array.isArray(v) && v.length <= 30 && v.every((e) => EXTENSION.test(String(e).trim().toLowerCase().replace(/^\./, "")))
-							? null
-							: "must be a list of up to 30 file extensions (letters and digits, at most 10 each)",
-				},
-			},
-		},
-	},
-};
-
-/*
- * Validate a PATCH (only the sections and keys being changed) against the current settings. Answers
- * `{ ok: true, value: { <section>: <the whole merged section> } }` for the sections the patch names, or
- * `{ ok: false, problems: [...] }` listing every reason at once.
- */
-export const validateSettings = (patch, current = SETTING_DEFAULTS) => {
-	const problems = [];
-	const value = {};
-	if (!isPlain(patch)) return { ok: false, problems: ["the settings must be an object of sections"] };
-
-	const walk = (schema, input, prefix, out) => {
-		if (!isPlain(input)) {
-			problems.push(`${prefix} must be an object`);
-			return;
-		}
-		for (const [key, raw] of Object.entries(input)) {
-			const rule = schema[key];
-			const name = `${prefix}.${key}`;
-			if (!rule) {
-				problems.push(`${name} is not a setting`);
-				continue;
-			}
-			if (rule.nested) {
-				out[key] = isPlain(out[key]) ? out[key] : {};
-				walk(rule.nested, raw, name, out[key]);
-				continue;
-			}
-			const reason = rule.check(raw);
-			if (reason) problems.push(`${name} ${reason}`);
-			else out[key] = rule.normalise ? rule.normalise(raw) : raw;
-		}
-	};
-
-	for (const [section, input] of Object.entries(patch)) {
-		if (!SCHEMA[section]) {
-			problems.push(`unknown setting section "${section}"`);
-			continue;
-		}
-		const merged = lay(current?.[section] ?? SETTING_DEFAULTS[section], {});
-		walk(SCHEMA[section], input, section, merged);
-		value[section] = merged;
-	}
-	return problems.length > 0 ? { ok: false, problems } : { ok: true, value };
-};
-
-const quote = (s) => `'${String(s).replace(/'/g, "''")}'`;
-const actorSql = (actorId) => (Number.isInteger(actorId) ? String(actorId) : /^\d+$/.test(String(actorId ?? "")) ? String(Number(actorId)) : "NULL");
-
-export const createSettingsStore = ({ exec, execStatements }) => {
-	const read = async () => {
-		const rows = (await exec("SELECT KEY, VALUE FROM FINA$SETTING")) ?? [];
-		const stored = {};
-		for (const row of rows) {
-			const key = String(row?.key ?? "");
-			if (!SETTING_DEFAULTS[key]) continue;
-			try {
-				stored[key] = JSON.parse(String(row.value));
-			} catch {
-				/* Never fails the read: the defaults stand for that section, and the log says why. */
-				logger.warn(`[fina] FINA$SETTING "${key}" is not JSON; its defaults are used until it is saved again.`);
-			}
-		}
-		return Object.fromEntries(Object.keys(SETTING_DEFAULTS).map((key) => [key, lay(SETTING_DEFAULTS[key], stored[key])]));
-	};
-
-	const write = async (patch, actorId) => {
-		const current = await read();
-		const checked = validateSettings(patch, current);
-		if (!checked.ok) throw finaError("INVALID", checked.problems.join("; "));
-		const statements = Object.entries(checked.value).map(
-			([key, value]) =>
-				`INSERT INTO FINA$SETTING (KEY, VALUE, UPDATED_BY, UPDATED_AT) VALUES (${quote(key)}, ${quote(JSON.stringify(value))}, ${actorSql(actorId)}, now()) ` +
-				"ON CONFLICT (KEY) DO UPDATE SET VALUE = EXCLUDED.VALUE, UPDATED_BY = EXCLUDED.UPDATED_BY, UPDATED_AT = now()",
-		);
-		if (statements.length > 0) await execStatements(statements);
-		/* What is now stored: the sections written, the others as they were read. */
-		return { ...current, ...checked.value };
-	};
-
-	return { read, write };
-};

package/engine/fina/sql.js

@@ -1,34 +0,0 @@
-/*
- * Doc 8 M3 — Firebird literals for the statements engine/fina builds (client.executeSql / client.block).
- *
- * The FINA API takes SQL TEXT: there is no parameter binding on this path. Every value that reaches a statement goes
- * through here — a string quoted with its quotes doubled, a number as a finite number — so no value can carry SQL.
- * ⚠️ Single-line on purpose: a raw newline ends the command on the FINA transport (client.js).
- */
-import { finaError } from "./errors.js";
-
-export const sqlString = (value) => `'${String(value ?? "").replace(/[\r\n]+/g, " ").replace(/'/g, "''")}'`;
-
-export const sqlNumber = (value) => {
-	const n = Number(value);
-	if (value === null || value === undefined || value === "" || !Number.isFinite(n)) {
-		throw finaError("INVALID", `${JSON.stringify(value)} is not a number.`);
-	}
-	return String(n);
-};
-
-export const sqlInteger = (value) => {
-	const n = Number(value);
-	if (value === null || value === undefined || value === "" || !Number.isInteger(n)) {
-		throw finaError("INVALID", `${JSON.stringify(value)} is not a whole number.`);
-	}
-	return String(n);
-};
-
-/* A value of a column of `type` ('string' or a number type), or NULL. */
-export const sqlValue = (value, type) => {
-	if (value === null || value === undefined || value === "") return "NULL";
-	if (type === "string" || type === "date") return sqlString(value);
-	if (type === "integer" || type === "flag") return sqlInteger(value);
-	return sqlNumber(value);
-};