@fayz-ai/plugin-orders 0.13.0 → 0.14.0

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAsB9C,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAeD,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAWD,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpC,QAAQ,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IACjC,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAClC,6EAA6E;IAC7E,OAAO,CAAC,EAAE,YAAY,GAAG,YAAY,CAAA;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IACxC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IACvC;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAA;CACvD;AA8BD,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CA0NhF;AAED,cAAc,gBAAgB,CAAA;AAO9B,cAAc,SAAS,CAAA;AAEvB,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACtD,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,YAAY,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAA;AAGhE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,YAAY,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAC7F,YAAY,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAuB9C,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB;AAeD,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAWD,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpC,QAAQ,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IACjC,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAClC,6EAA6E;IAC7E,OAAO,CAAC,EAAE,YAAY,GAAG,YAAY,CAAA;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IACxC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAA;IACvC;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAA;CACvD;AA8BD,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAmOhF;AAED,cAAc,gBAAgB,CAAA;AAO9B,cAAc,SAAS,CAAA;AAEvB,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACtD,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,YAAY,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAA;AAGhE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,YAAY,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAC7F,YAAY,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAA;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAA;AAC7D,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/index.js

@@ -599,6 +599,214 @@ var ordersRegistries = [
   }
 ];
 
+// src/migrations/index.ts
+var MIGRATION_001_AN_ORDER_ARRIVES_FROM_A_MARKETPLACE = `-- ============================================================================
+-- 001 \u2014 an order arrives from a marketplace
+--
+-- The V2 sink of ADR 0003: the ONE door through which the integration service
+-- hands a canonical delivery order to this product, and the two beside it to
+-- apply a later status and to read the current one. No rule lives in the
+-- service; what an order IS here is decided here, in one transaction.
+--
+-- There is no person behind these calls \u2014 the actor is the service, acting
+-- for the tenant it names, which is why \`p_tenant\` is explicit and no
+-- \`app.has_permission\` is asked (the same reasoning as service_authorize_for).
+-- The functions are therefore closed to every signed-in user and opened only
+-- to the service's own role, \`fayz_integration\`, when that role exists on the
+-- cluster. Creating the role is an operator step; the grant below is guarded.
+--
+-- The order shape is @fayz-ai/contracts' CanonicalOrder v1: money in
+-- centavos, items with options, totals that close. Everything that this
+-- product has no column for travels in orders.metadata.external, so nothing
+-- the marketplace said is lost.
+-- ============================================================================
+
+CREATE OR REPLACE FUNCTION public.orders_ingest_external(
+  p_tenant uuid,
+  p_unit   uuid,
+  p_order  jsonb,
+  p_status text
+) RETURNS uuid
+LANGUAGE plpgsql SECURITY DEFINER
+SET search_path TO ''
+AS $$
+DECLARE
+  v_provider text := p_order ->> 'provider';
+  v_external text := p_order ->> 'externalId';
+  v_ref      text;
+  v_kind     text;
+  v_channel  text;
+  v_order    uuid;
+  v_item     jsonb;
+  v_n        integer := 0;
+  v_qty      numeric;
+  v_unit     numeric;
+  v_total    numeric;
+  v_sub      numeric;
+  v_disc     numeric;
+  v_ship     numeric;
+BEGIN
+  IF p_tenant IS NULL THEN
+    RAISE EXCEPTION 'orders_ingest_external: tenant is required' USING ERRCODE = '22023';
+  END IF;
+  IF v_provider IS NULL OR v_external IS NULL THEN
+    RAISE EXCEPTION 'orders_ingest_external: order needs provider and externalId' USING ERRCODE = '22023';
+  END IF;
+  IF p_unit IS NOT NULL AND NOT EXISTS (
+       SELECT 1 FROM public.companies c WHERE c.id = p_unit AND c.tenant_id = p_tenant) THEN
+    RAISE EXCEPTION 'orders_ingest_external: unit % is not of tenant %', p_unit, p_tenant USING ERRCODE = '22023';
+  END IF;
+
+  -- Once per (provider, externalId) within the tenant: a replay returns the
+  -- order it already made. The key lives in metadata, as order_create's does.
+  v_ref := v_provider || ':' || v_external;
+  SELECT o.id INTO v_order FROM public.orders o
+   WHERE o.tenant_id = p_tenant AND o.metadata ->> 'externalRef' = v_ref
+   LIMIT 1;
+  IF v_order IS NOT NULL THEN
+    RETURN v_order;
+  END IF;
+
+  -- The contract's kinds are this product's kinds; the channel is where the
+  -- order came in, in this product's vocabulary.
+  v_kind := CASE p_order ->> 'kind'
+              WHEN 'delivery' THEN 'delivery'
+              WHEN 'takeout'  THEN 'takeout'
+              WHEN 'dine_in'  THEN 'dine_in'
+              ELSE 'delivery' END;
+  v_channel := CASE v_kind WHEN 'delivery' THEN 'delivery' WHEN 'dine_in' THEN 'dine_in' ELSE 'balcao' END;
+
+  IF p_status IS NULL OR NOT EXISTS (
+       SELECT 1 FROM public.order_kinds k WHERE k.kind = v_kind AND p_status = ANY (k.statuses)) THEN
+    RAISE EXCEPTION 'orders_ingest_external: % is not a status of kind %', p_status, v_kind USING ERRCODE = '22023';
+  END IF;
+
+  v_sub  := round(coalesce((p_order -> 'totals' ->> 'subtotal')::numeric, 0) / 100, 2);
+  v_disc := round(coalesce((p_order -> 'totals' ->> 'discount')::numeric, 0) / 100, 2);
+  v_ship := round(coalesce((p_order -> 'totals' ->> 'deliveryFee')::numeric, 0) / 100, 2);
+
+  INSERT INTO public.orders (tenant_id, unit_id, kind, channel, status, reference_number,
+                             subtotal, discount, shipping, total, currency, notes, metadata)
+  VALUES (p_tenant, p_unit, v_kind, v_channel, p_status,
+          nullif(p_order ->> 'displayId', ''),
+          v_sub, v_disc, v_ship,
+          round(coalesce((p_order -> 'totals' ->> 'total')::numeric, 0) / 100, 2),
+          coalesce(p_order -> 'totals' ->> 'currency', 'BRL'),
+          nullif(p_order ->> 'notes', ''),
+          jsonb_build_object(
+            'externalRef', v_ref,
+            'idempotencyKey', v_ref,
+            'external', jsonb_build_object(
+              'provider',    v_provider,
+              'externalId',  v_external,
+              'displayId',   p_order -> 'displayId',
+              'merchantRef', p_order -> 'merchantRef',
+              'placedAt',    p_order -> 'placedAt',
+              'timing',      p_order -> 'timing',
+              'customer',    p_order -> 'customer',
+              'payment',     p_order -> 'payment',
+              'fulfillment', p_order -> 'fulfillment',
+              'totals',      p_order -> 'totals',
+              'lastStatusAt', NULL)))
+  RETURNING id INTO v_order;
+
+  FOR v_item IN SELECT * FROM jsonb_array_elements(coalesce(p_order -> 'items', '[]'::jsonb)) LOOP
+    v_n     := v_n + 1;
+    v_qty   := coalesce((v_item ->> 'quantity')::numeric, 1);
+    v_unit  := round(coalesce((v_item ->> 'unitPrice')::numeric, 0) / 100, 2);
+    v_total := round(coalesce((v_item ->> 'total')::numeric, 0) / 100, 2);
+    INSERT INTO public.items (tenant_id, unit_id, order_id, name, description, quantity,
+                              unit_price, discount, total, sort_order, metadata)
+    VALUES (p_tenant, p_unit, v_order,
+            coalesce(nullif(btrim(coalesce(v_item ->> 'name', '')), ''), 'Item'),
+            nullif(v_item ->> 'notes', ''),
+            v_qty, v_unit, 0, v_total, v_n - 1,
+            jsonb_build_object(
+              'externalId',   v_item -> 'externalId',
+              'externalCode', v_item -> 'externalCode',
+              'unit',         v_item -> 'unit',
+              'options',      coalesce(v_item -> 'options', '[]'::jsonb)));
+  END LOOP;
+
+  RETURN v_order;
+END $$;
+
+COMMENT ON FUNCTION public.orders_ingest_external(uuid, uuid, jsonb, text) IS
+  'The integration service hands a canonical marketplace order to this product, once per (provider, externalId). Actor: the service, for the named tenant.';
+
+-- A later status for an order the service ingested. Monotonic on the
+-- service side already; here the only rules are "this order is yours" and
+-- "that status exists for its kind".
+CREATE OR REPLACE FUNCTION public.orders_apply_external_status(
+  p_tenant      uuid,
+  p_order       uuid,
+  p_status      text,
+  p_occurred_at timestamptz
+) RETURNS void
+LANGUAGE plpgsql SECURITY DEFINER
+SET search_path TO ''
+AS $$
+DECLARE
+  v_kind text;
+BEGIN
+  SELECT o.kind INTO v_kind FROM public.orders o
+   WHERE o.id = p_order AND o.tenant_id = p_tenant AND o.metadata ? 'externalRef';
+  IF v_kind IS NULL THEN
+    RAISE EXCEPTION 'orders_apply_external_status: order % is not an external order of tenant %', p_order, p_tenant
+      USING ERRCODE = '22023';
+  END IF;
+  IF NOT EXISTS (SELECT 1 FROM public.order_kinds k WHERE k.kind = v_kind AND p_status = ANY (k.statuses)) THEN
+    RAISE EXCEPTION 'orders_apply_external_status: % is not a status of kind %', p_status, v_kind USING ERRCODE = '22023';
+  END IF;
+
+  UPDATE public.orders
+     SET status = p_status,
+         completed_at = CASE WHEN p_status IN ('completed', 'delivered') THEN coalesce(p_occurred_at, now()) ELSE completed_at END,
+         metadata = jsonb_set(metadata, '{external,lastStatusAt}', to_jsonb(coalesce(p_occurred_at, now())), true),
+         updated_at = now()
+   WHERE id = p_order;
+END $$;
+
+COMMENT ON FUNCTION public.orders_apply_external_status(uuid, uuid, text, timestamptz) IS
+  'A later status from the marketplace for an order the service ingested. Actor: the service, for the named tenant.';
+
+CREATE OR REPLACE FUNCTION public.orders_external_status(p_tenant uuid, p_order uuid)
+RETURNS jsonb
+LANGUAGE sql STABLE SECURITY DEFINER
+SET search_path TO ''
+AS $$
+  SELECT jsonb_build_object('status', o.status, 'updatedAt', o.updated_at)
+    FROM public.orders o
+   WHERE o.id = p_order AND o.tenant_id = p_tenant AND o.metadata ? 'externalRef';
+$$;
+
+COMMENT ON FUNCTION public.orders_external_status(uuid, uuid) IS
+  'What this product thinks an external order is now. Actor: the service, for the named tenant.';
+
+-- Closed to people, open to the service. The pools grant EXECUTE to
+-- \`authenticated\` on every new public function by default; a definer function
+-- that takes the tenant as a parameter must not be reachable by a session.
+REVOKE ALL ON FUNCTION public.orders_ingest_external(uuid, uuid, jsonb, text) FROM PUBLIC, anon, authenticated;
+REVOKE ALL ON FUNCTION public.orders_apply_external_status(uuid, uuid, text, timestamptz) FROM PUBLIC, anon, authenticated;
+REVOKE ALL ON FUNCTION public.orders_external_status(uuid, uuid) FROM PUBLIC, anon, authenticated;
+GRANT EXECUTE ON FUNCTION public.orders_ingest_external(uuid, uuid, jsonb, text) TO service_role;
+GRANT EXECUTE ON FUNCTION public.orders_apply_external_status(uuid, uuid, text, timestamptz) TO service_role;
+GRANT EXECUTE ON FUNCTION public.orders_external_status(uuid, uuid) TO service_role;
+
+DO $$
+BEGIN
+  IF EXISTS (SELECT 1 FROM pg_roles WHERE rolname = 'fayz_integration') THEN
+    GRANT USAGE ON SCHEMA public TO fayz_integration;
+    GRANT EXECUTE ON FUNCTION public.orders_ingest_external(uuid, uuid, jsonb, text) TO fayz_integration;
+    GRANT EXECUTE ON FUNCTION public.orders_apply_external_status(uuid, uuid, text, timestamptz) TO fayz_integration;
+    GRANT EXECUTE ON FUNCTION public.orders_external_status(uuid, uuid) TO fayz_integration;
+  END IF;
+END $$;
+`;
+var MIGRATIONS = [
+  { id: "001_an_order_arrives_from_a_marketplace", sql: MIGRATION_001_AN_ORDER_ARRIVES_FROM_A_MARKETPLACE }
+];
+
 // src/locales/en.ts
 var en = {
   "orders.title": "Orders",
@@ -2396,6 +2604,15 @@ function createOrdersPlugin(options) {
     // No `menu`: a sale is not a restaurant's, and a dependency lights up by
     // drag — every account with Orders would grow a Cardápio line.
     dependencies: [],
+    // What installing this provisions, byte-for-byte the files under
+    // src/migrations (embed barrel). The spine holds the orders tables; this
+    // list holds the doors the plugin adds on top of them.
+    migrations: MIGRATIONS.map((m) => ({
+      id: `orders-${m.id}`,
+      version: "1.0.0",
+      sql: m.sql,
+      description: m.id
+    })),
     events: [
       {
         name: "orders.order_completed",