@flowselections/layout-maker

中文文档
1.69.48发布于 2026/11/15TypeScriptES Module近 30 天下载 7968

blank project start

原始使用文档
文档目录4 节
  1. Build with Lovable
  2. Development
  3. Installeren in een andere shell
  4. Printen vanuit een andere module

Layout maker (pakbonnen, verzendbrieven, ectra)

blank project start

This project was built with Lovable.

Build with Lovable

  • Ship faster: describe what you want to build and Lovable handles the code.
  • Stay in sync: every change made in Lovable is committed straight to this repository.
  • Full ownership: this code is yours. Push to main on GitHub and your changes sync back into Lovable, ready for your next prompt.

Development

Prefer working locally? You need Node.js and npm — install with nvm.

git clone <this-repository-url>
cd <repository-name>
npm i
npm run dev

Installeren in een andere shell

  1. Het schema zit in het pakket: node_modules/@flowselections/layout-maker/sql/print-schema.sql. Draai het in de database van die shell (via de schema-update van de shell of de SQL editor), bij installeren én na elke update. Het script is idempotent (mag vaker) en zet keuzelijsten, tabellen, kolommen, sleutels, functies, indexen, triggers, rechten, RLS en policies, realtime, de geplande taken (zonder adres of sleutel) en de opslagmap layout-logos klaar. Zorg dat de extensies pg_cron, pg_net en vault aan staan. Het schema wordt gegenereerd met scripts/bouw-schema.py. Floriday-systeemlayouts maakt de module daarna zelf aan bij de eerste wachtrijronde of het openen van Layouts.

  2. Zet in de omgeving van de shell:

    • SUPABASE_URL en SERVICE_ROLE_KEY — nodig voor achtergrondprinten
    • CENTRAL_AUTH_URL en CENTRAL_AUTH_SECRET — nodig voor de printdienst
  3. Zorg dat de shell het tick-eindpunt host. De setup-CLI doet dit automatisch op basis van flowselections.serverRoutes in package.json. Handmatig opgezette shells maken zelf dit bestand aan:

    // src/routes/api/public/print/queue-tick.ts
    import { createFileRoute } from "@tanstack/react-router";
    import { behandelQueueTick } from "@flowselections/layout-maker/print";
    
    export const Route = createFileRoute("/api/public/print/queue-tick")({
      server: {
        handlers: {
          POST: async ({ request }) => {
            // De shell levert de databaseverbinding; de module maakt er nooit zelf een.
            const { supabaseAdmin } = await import(
              "../../../../integrations/supabase/client.server"
            );
            return behandelQueueTick(request, supabaseAdmin);
          },
        },
      },
    });
    

    Het eindpunt accepteert drie toegangsbewijzen: een runner-sleutel uit print_queue_runners.tick_sleutel, SUPABASE_PUBLISHABLE_KEY (de cron) of het sessietoken van een ingelogde gebruiker (de knop in de Printwachtrij).

  4. Klaar. Zodra de module in de shell draait meldt hij zichzelf aan als verwerker van de printwachtrij. Een nieuwe printopdracht wordt meteen opgepakt; daarnaast verwerkt de geplande taak print-queue-tick elke minuut de wachtende opdrachten. Reageert een shell een uur lang niet, dan wordt hij automatisch op inactief gezet. De taak print-queue-cleanup ruimt dagelijks oude opdrachten en bestanden op.

Printen vanuit een andere module

Andere modules in dezelfde shell gebruiken uitsluitend de print-API van deze module; zij hoeven de printtabellen niet te kennen en mogen er ook niet zelf in schrijven (dan blijft de opdracht wachten tot de volgende cronronde).

import {
  printDocument, printPdf, printHtml,
  printerVoorWerkplek, printerVoorDocumenttype, volgJobStatus,
} from "@flowselections/layout-maker";

// 1. Document dat via een ontwerp uit deze module wordt opgemaakt
const { jobId } = await printDocument({
  documenttype: "pakbon",          // moet een bestaande documentsoort zijn
  documentnaam: "PB-2601284",
  payload: { order, order_id: order.id }, // order_id: verplicht kenmerk
});

// 2. Kant-en-klare PDF (Floriday-document, klantsticker, externe factuur)
//    Zonder printerId wordt de printer bepaald via de gekoppelde layout van
//    de documentsoort (of de koppeling op papierformaat).
await printPdf({
  documenttype: "factuur",
  documentnaam: "F-2026-00123",
  pdfBase64,                       // met of zonder data:-voorvoegsel
  payload: { order_id: factuur.id },
});

// Geef in payload altijd een order-kenmerk mee: queue_item_id, order_id of
// ordernummer. De wachtrij gebruikt dat om dubbele aanvragen te herkennen;
// zonder kenmerk kunnen twee orders met dezelfde documentnaam binnen tien
// minuten als dubbel worden gezien.


// Of expliciet per werkplek:
const printerId = await printerVoorWerkplek("PICKSTATION-1", "A4");
await printPdf({
  documenttype: "afleverbrief",
  documentnaam: "AFL-12345",
  pdfBase64,
  printerId: printerId!,
});


// 3. Eigen opmaak afdrukken (geen layout, anders wint de layout)
await printHtml({
  documenttype: "controlelijst",
  documentnaam: "Controlelijst kar 12",
  html,
  printerId: printerId!,
});

// Status live volgen (realtime staat aan op print_jobs)
const stop = volgJobStatus(jobId, (s) => console.log(s.status, s.foutmelding));

Belangrijk:

  • Documentsoorten liggen vast in de database: pakbon, factuur, offerte, orderbevestiging, etiket, verzendlabel, productlabel, barcode_label, magazijnlijst, controlelijst, transportdocument, sticker, productiebon, veilingbon, afleverbrief, veilingbrief en vrij.
  • Beslisvolgorde bij het afdrukken: kant-en-klare PDF > gekoppelde layout > meegestuurde opmaak > actieve layout van de documentsoort.
  • Dubbelbeveiliging: een identieke aanvraag binnen 10 minuten wordt genegeerd; de aanroep werpt dan DubbeleAanvraagFout. Geef bij bulkprints per document een eigen documentnaam zodat elke opdracht uniek is.

版本与发布记录

@flowselections/layout-maker 共发布 89 个版本,首次发布于 2026/08/12;过去 12 个月发布了 89 个版本。

版本发布日期距今
1.69.48latest2026/11/151 天前
1.69.472026/11/132 天前
1.69.462026/11/132 天前
1.69.452026/11/114 天前
1.69.442026/11/096 天前
1.69.432026/11/096 天前

关于 @flowselections/layout-maker 的常见问题

@flowselections/layout-maker 是什么?

blank project start

如何安装 @flowselections/layout-maker?

在项目目录运行 npm install @flowselections/layout-maker,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18 || ^19)、sonner(^2.0.0)、react-dom(^18 || ^19)、lucide-react(^0.400.0)、@flowselections/core(*)、@tanstack/react-query(^5.0.0)、@tanstack/react-start(^1.0.0)、@tanstack/react-router(^1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@flowselections/layout-maker 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@flowselections/layout-maker 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@flowselections/layout-maker 可以商用吗?

@flowselections/layout-maker 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@flowselections/layout-maker 的下载量有多少?

根据 npm 官方下载统计,@flowselections/layout-maker 在 2026/10/15 – 2026/11/13 这 30 天内被下载 7,968 次,日均约 266 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@flowselections/layout-maker 还在维护吗?

最新版本 1.69.48 发布于 2026/11/15(1 天前);至今共发布 89 个版本,其中过去 12 个月发布了 89 个;首次发布于 2026/08/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。