shutro-erp 0.3.1 → 0.3.3

package/dist/modules-sdk/manifest.d.ts

@@ -97,6 +97,43 @@ export interface AutomationRuleSpec {
     /** Installed switched on (default) or off. */
     readonly enabled?: boolean;
 }
+/**
+ * An event a module emits through Shutro's outbox (`env.emit(topic, { id, … })`), which webhooks and integrations
+ * may subscribe to (RFC 0017 §5.3): the topic, the model whose record `id` names, and what it means.
+ */
+export interface EventSpec {
+    readonly topic: string;
+    readonly model: string;
+    readonly label: string;
+}
+/** A call received by an inbound webhook (RFC 0017 §5.4): the raw body (what signatures cover) and its JSON. */
+export interface InboundCall {
+    readonly headers: Readonly<Record<string, string | undefined>>;
+    readonly query: Readonly<Record<string, string | undefined>>;
+    /** The body as received. */
+    readonly body: string;
+    /** The body parsed as JSON, or null. */
+    readonly json: unknown;
+}
+/**
+ * An endpoint a module receives calls on from outside (RFC 0017 §5.4): a payment provider's callback, a shipping
+ * status. Companies switch it on in Integrations › Inbound webhooks (a URL and a secret each).
+ */
+export interface InboundWebhookSpec {
+    /** Unique within the module (`ipn`); the endpoint is `<module>.<key>`. */
+    readonly key: string;
+    readonly label: string;
+    /**
+     * Whether the call is genuine — the provider's signature, or an HMAC with the endpoint's secret — and its event
+     * id, by which repeated calls are recognised: the id, or null to refuse the call.
+     */
+    readonly verify: (call: InboundCall, secret: string) => string | null | Promise<string | null>;
+    /**
+     * Handles a verified call, once per event id, in a job (retried on failure): `env` is a system environment in
+     * the endpoint's company. Returns a short note for the log (a string; anything else is not kept).
+     */
+    readonly handle: (env: unknown, call: InboundCall) => Promise<unknown>;
+}
 /** A default document template of a module. */
 export interface DocumentSpec {
     /** Unique within the module (`purchase_order`); stored as `module.key`. */
@@ -175,6 +212,13 @@ export interface PortalDocumentSpec {
      * email with a link, once. The model's writes must reach the portal: list it in the module's `changeEvents`.
      */
     readonly announce?: Readonly<Record<string, unknown>>;
+    /**
+     * The customer may pay it online (RFC 0017 §5.5) while it is in this domain (`{ paymentState: 'not_paid' }`):
+     * the document's page offers Pay now when a payment module and a provider are there.
+     */
+    readonly payment?: {
+        readonly when: Readonly<Record<string, unknown>>;
+    };
 }
 /**
  * A country localization (RFC 0016 §5.2): what installing it sets up for a company, once — its chart of accounts,
@@ -367,6 +411,10 @@ export interface ModuleInput {
     readonly externalGroups?: readonly string[];
     /** The country this module localizes (RFC 0016): set up for each company when the module is installed. */
     readonly localization?: LocalizationSpec;
+    /** Events the module emits that webhooks may subscribe to (RFC 0017 §5.3). */
+    readonly events?: readonly EventSpec[];
+    /** Endpoints the module receives calls on from outside (RFC 0017 §5.4). */
+    readonly inboundWebhooks?: readonly InboundWebhookSpec[];
     /** What the module shows in the customer and vendor portal (RFC 0015), when `portal` is installed. */
     readonly portal?: {
         readonly documents: readonly PortalDocumentSpec[];

package/dist/payment/.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/payment/.kosh/bindings.js

@@ -0,0 +1,15 @@
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 3191ec61b2e1ad7f
+// Bindings of module `payment`: 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;