Skip to content

feat(intent): first-class document numbering DSL — number: {} field attribute (N1)#6382

Merged
delchev merged 1 commit into
masterfrom
feat/intent-first-class-numbering-n1
Jul 22, 2026
Merged

feat(intent): first-class document numbering DSL — number: {} field attribute (N1)#6382
delchev merged 1 commit into
masterfrom
feat/intent-first-class-numbering-n1

Conversation

@delchev

@delchev delchev commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

N1 of first-class document numbering (kf-catalog UPSTREAM_PLAN #11a) — the DSL surface + model + parse + validation. A string field declares its numbering declaratively, replacing the hand-written placeholder action + generateNumber service-task delegate + per-suite Number entity every document re-implements today.

- name: number
  type: string
  number: { series: SalesInvoice, format: "SI-{seq:07}", scope: [Company, year], resetOn: year, stampOn: issue }

This PR (N1)

  • NumberIntent model (series, format, scope, resetOn, stampOn); FieldIntent.number (Gson binds it by name, like dependsOn).
  • Validation: number only on a non-key string field; series required; stampOncreate|issue; scope entries are year or sibling field/relation names; resetOn supports only year and needs year in scope.
  • IntentParserTest#firstClassNumberingParsesAndValidates (valid parse + the four rejections).

Following increments

  • N2 — platform per-tenant counter store + allocation/format runtime (SDK-callable).
  • N3stampOn: create (insert stamp) + stampOn: issue (a generated stamp step the process references) + create-time placeholder + idempotency.
  • N4scope/resetOn (year + field partitioning).

Design + decisions (field-level attribute; platform per-tenant counter table; both stampOn modes) in PROPOSAL_NUMBERING.md. Purely additive (a new optional field attribute) — no behavior change until N2/N3 generate against it.

🤖 Generated with Claude Code

…ttribute (N1)

N1 of first-class document numbering (kf-catalog UPSTREAM_PLAN #11a): the DSL surface + model +
parse + validation. Lets a string field declare its numbering declaratively instead of the
hand-written placeholder action + generateNumber service-task delegate + per-suite Number entity.

    - name: number
      type: string
      number: { series: SalesInvoice, format: "SI-{seq:07}", scope: [Company, year], resetOn: year, stampOn: issue }

- NumberIntent model (series, format, scope, resetOn, stampOn); FieldIntent.number (Gson binds it by
  name, like dependsOn).
- Validation: number sits only on a non-key string field; series is required; stampOn is
  create|issue; scope entries are `year` or sibling field/relation names; resetOn supports only
  `year` and needs `year` in scope.

Runtime + generation are the following increments: N2 the per-tenant counter store + allocation/
format service, N3 the create/issue stamping + placeholder + idempotency, N4 scope/resetOn. See
PROPOSAL_NUMBERING.md. Decisions locked 2026-07-22: field-level attribute, platform per-tenant
counter table, both stampOn modes.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@delchev
delchev merged commit 25521ac into master Jul 22, 2026
10 checks passed
@delchev
delchev deleted the feat/intent-first-class-numbering-n1 branch July 22, 2026 14:49
delchev added a commit that referenced this pull request Jul 22, 2026
… shell settings (N2) (#6384)

N2 of first-class document numbering (kf-catalog UPSTREAM_PLAN #11a): the runtime the DSL (N1,
#6382) will generate against, plus the application-shell settings surface.

New module components/engine/engine-numbering:
- DocumentNumberStore — a per-tenant DIRIGIBLE_DOCUMENT_NUMBERS table (via the tenant-routed default
  datasource + SqlFactory, like DIRIGIBLE_CONFIGURATIONS), keyed by (series, scope). allocate() is
  gap-free: the increment takes a row lock so concurrent allocations of the same counter serialize;
  the row is created on first use.
- DocumentNumberService — allocate + the format grammar ({seq}/{seq:0N} zero-pad, {series}, and scope
  tokens {year}/{<Field>}) + scope-key derivation; plus list()/setNext() for management.
- DocumentNumberEndpoint — /services/core/numbering (ADMINISTRATOR/OPERATOR): GET the tenant's
  counters, PUT the next value a (series, scope) counter will allocate.

Application shell (resources-application) — a built-in "Document Numbering" Settings entry (next to
Region & Language / Tenant Configuration): lists the counters and lets an admin set each series'
next value (reset/seed a sequence, e.g. start invoices at 1000); read-only on a 403.

Verified on a booted instance: GET [] then PUT {series:SalesInvoice,next:1000} (204) then GET shows
counter 999 (next allocate = 1000); the settings page + appShell.js serve the new entry.
DocumentNumberServiceTest covers the format renderer + scope-key. The SDK entry + generated stamping
+ idempotency are N3.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
delchev added a commit that referenced this pull request Jul 22, 2026
)

* feat(numbering): per-tenant document-number counter store + runtime + shell settings (N2)

N2 of first-class document numbering (kf-catalog UPSTREAM_PLAN #11a): the runtime the DSL (N1,
#6382) will generate against, plus the application-shell settings surface.

New module components/engine/engine-numbering:
- DocumentNumberStore — a per-tenant DIRIGIBLE_DOCUMENT_NUMBERS table (via the tenant-routed default
  datasource + SqlFactory, like DIRIGIBLE_CONFIGURATIONS), keyed by (series, scope). allocate() is
  gap-free: the increment takes a row lock so concurrent allocations of the same counter serialize;
  the row is created on first use.
- DocumentNumberService — allocate + the format grammar ({seq}/{seq:0N} zero-pad, {series}, and scope
  tokens {year}/{<Field>}) + scope-key derivation; plus list()/setNext() for management.
- DocumentNumberEndpoint — /services/core/numbering (ADMINISTRATOR/OPERATOR): GET the tenant's
  counters, PUT the next value a (series, scope) counter will allocate.

Application shell (resources-application) — a built-in "Document Numbering" Settings entry (next to
Region & Language / Tenant Configuration): lists the counters and lets an admin set each series'
next value (reset/seed a sequence, e.g. start invoices at 1000); read-only on a 403.

Verified on a booted instance: GET [] then PUT {series:SalesInvoice,next:1000} (204) then GET shows
counter 999 (next allocate = 1000); the settings page + appShell.js serve the new entry.
DocumentNumberServiceTest covers the format renderer + scope-key. The SDK entry + generated stamping
+ idempotency are N3.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* feat(numbering): sdk.numbering.DocumentNumbers — client SDK for first-class numbering (N3a)

The SDK bridge from client-Java to the per-tenant counter runtime (N2, #6384): allocate the next
gap-free number for a series and render it through the format. Both hand-written custom/ code and
the forthcoming generated stamping (N3b) share one engine + one sequence + the same counter the
application shell's Document Numbering settings manage.

- DocumentNumbers.next(series, format, scope) / next(series, format) → the formatted number, via
  Beans.get(DocumentNumberService).
- api-modules-java depends on engine-numbering (same precedent as engine-document for sdk.print).

Verified: NumberingSdkIT drops a client-Java @controller calling DocumentNumbers.next and asserts a
gap-free formatted sequence over HTTP (T-0001, T-0002) in the caller's tenant scope.

N3b (generation): turn a `number: {}` field (N1, #6382) into the create-time stamp/placeholder + the
issue-step stamp delegate + idempotency, calling this SDK. Depends on #6384.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant