@12-apps/fiscal 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/README.md +164 -7
  2. package/dist/chunk-2LBQRYPV.js +21 -0
  3. package/dist/chunk-2LBQRYPV.js.map +1 -0
  4. package/dist/chunk-3SDXLSG4.js +24 -0
  5. package/dist/chunk-3SDXLSG4.js.map +1 -0
  6. package/dist/chunk-5S2PJHAE.js +85 -0
  7. package/dist/chunk-5S2PJHAE.js.map +1 -0
  8. package/dist/chunk-G3V7IYNF.js +192 -0
  9. package/dist/chunk-G3V7IYNF.js.map +1 -0
  10. package/dist/chunk-JVQKJNOC.js +14 -0
  11. package/dist/chunk-JVQKJNOC.js.map +1 -0
  12. package/dist/chunk-N5DCKYFR.js +610 -0
  13. package/dist/chunk-N5DCKYFR.js.map +1 -0
  14. package/dist/chunk-NVRYAAQ4.js +212 -0
  15. package/dist/chunk-NVRYAAQ4.js.map +1 -0
  16. package/dist/chunk-PNTKG3DZ.js +47 -0
  17. package/dist/chunk-PNTKG3DZ.js.map +1 -0
  18. package/dist/chunk-WTGASIZE.js +247 -0
  19. package/dist/chunk-WTGASIZE.js.map +1 -0
  20. package/dist/chunk-XQGW5HUG.js +30 -0
  21. package/dist/chunk-XQGW5HUG.js.map +1 -0
  22. package/dist/context-ChnWR4Kb.d.ts +455 -0
  23. package/dist/danfe/en-US.d.ts +12 -0
  24. package/dist/danfe/en-US.js +51 -0
  25. package/dist/danfe/en-US.js.map +1 -0
  26. package/dist/danfe/index.d.ts +50 -0
  27. package/dist/danfe/index.js +18 -0
  28. package/dist/danfe/index.js.map +1 -0
  29. package/dist/danfe/pt-BR.d.ts +11 -0
  30. package/dist/danfe/pt-BR.js +51 -0
  31. package/dist/danfe/pt-BR.js.map +1 -0
  32. package/dist/documents/index.d.ts +181 -0
  33. package/dist/documents/index.js +1234 -0
  34. package/dist/documents/index.js.map +1 -0
  35. package/dist/engine/index.d.ts +3 -246
  36. package/dist/http.d.ts +75 -0
  37. package/dist/http.js +16 -0
  38. package/dist/http.js.map +1 -0
  39. package/dist/issuer/index.d.ts +43 -0
  40. package/dist/issuer/index.js +131 -0
  41. package/dist/issuer/index.js.map +1 -0
  42. package/dist/jobs.d.ts +74 -0
  43. package/dist/jobs.js +22 -0
  44. package/dist/jobs.js.map +1 -0
  45. package/dist/labels-BNvflT0h.d.ts +44 -0
  46. package/dist/manifest/index.d.ts +30 -16
  47. package/dist/manifest/index.js +11 -17
  48. package/dist/manifest/index.js.map +1 -1
  49. package/dist/manifest/server.d.ts +57 -0
  50. package/dist/manifest/server.js +25 -0
  51. package/dist/manifest/server.js.map +1 -0
  52. package/dist/notifications.d.ts +93 -0
  53. package/dist/notifications.js +41 -0
  54. package/dist/notifications.js.map +1 -0
  55. package/dist/port-DpRFK56U.d.ts +238 -0
  56. package/dist/sale/index.d.ts +269 -0
  57. package/dist/sale/index.js +1 -0
  58. package/dist/sale/index.js.map +1 -0
  59. package/dist/service-KTjH7AxW.d.ts +139 -0
  60. package/dist/sidecar/index.d.ts +218 -0
  61. package/dist/sidecar/index.js +8 -0
  62. package/dist/sidecar/index.js.map +1 -0
  63. package/dist/types-B1b8LIWX.d.ts +247 -0
  64. package/package.json +63 -5
  65. package/prisma/fiscal.prisma +158 -0
  66. package/prisma/migrations/20261113220000_fiscal_documents/migration.sql +201 -0
  67. package/sidecar/.dockerignore +5 -0
  68. package/sidecar/Dockerfile +68 -0
  69. package/sidecar/README.md +162 -0
  70. package/sidecar/composer.json +30 -0
  71. package/sidecar/composer.lock +2224 -0
  72. package/sidecar/docker/apache.conf +14 -0
  73. package/sidecar/docker/icp-brasil.pem +8031 -0
  74. package/sidecar/docker/mpm.conf +17 -0
  75. package/sidecar/docker/openssl.cnf +16 -0
  76. package/sidecar/docker/php.ini +19 -0
  77. package/sidecar/public/index.php +15 -0
  78. package/sidecar/schema/sale-for-document.schema.json +422 -0
  79. package/sidecar/src/ErrorClass.php +31 -0
  80. package/sidecar/src/Http/Request.php +48 -0
  81. package/sidecar/src/Http/Response.php +32 -0
  82. package/sidecar/src/Http/Router.php +59 -0
  83. package/sidecar/src/Kernel.php +99 -0
  84. package/sidecar/src/Module.php +31 -0
  85. package/sidecar/src/Nfe/Classifier.php +89 -0
  86. package/sidecar/src/Nfe/Credentials.php +52 -0
  87. package/sidecar/src/Nfe/DocumentMapper.php +428 -0
  88. package/sidecar/src/Nfe/DocumentSchema.php +39 -0
  89. package/sidecar/src/Nfe/Input.php +125 -0
  90. package/sidecar/src/Nfe/Model.php +17 -0
  91. package/sidecar/src/Nfe/NfeModule.php +62 -0
  92. package/sidecar/src/Nfe/NfeService.php +504 -0
  93. package/sidecar/src/Nfe/Sefaz.php +49 -0
  94. package/sidecar/src/Nfe/SefazReply.php +81 -0
  95. package/sidecar/src/Nfe/Transport/CurlTransport.php +198 -0
  96. package/sidecar/src/Nfe/Transport/SoapAdapter.php +57 -0
  97. package/sidecar/src/Nfe/Transport/Transport.php +20 -0
  98. package/sidecar/src/Nfe/Transport/TransportFailure.php +42 -0
  99. package/sidecar/src/RequestLog.php +54 -0
  100. package/sidecar/src/ServiceError.php +69 -0
  101. package/src/danfe/en-US.ts +53 -0
  102. package/src/danfe/index.ts +11 -0
  103. package/src/danfe/labels.ts +49 -0
  104. package/src/danfe/pt-BR.ts +52 -0
  105. package/src/danfe/render.ts +265 -0
  106. package/src/danfe/xml.ts +45 -0
  107. package/src/documents/context.ts +260 -0
  108. package/src/documents/errors.ts +48 -0
  109. package/src/documents/helpers.ts +177 -0
  110. package/src/documents/index.ts +40 -0
  111. package/src/documents/lines.ts +63 -0
  112. package/src/documents/machine-steps.ts +260 -0
  113. package/src/documents/machine.ts +128 -0
  114. package/src/documents/memory.ts +138 -0
  115. package/src/documents/nfe-proc.ts +51 -0
  116. package/src/documents/ports.ts +130 -0
  117. package/src/documents/profile-input.ts +168 -0
  118. package/src/documents/profile.ts +98 -0
  119. package/src/documents/service-profile.ts +104 -0
  120. package/src/documents/service.ts +299 -0
  121. package/src/documents/settle.ts +121 -0
  122. package/src/documents/signing.ts +61 -0
  123. package/src/documents/sql-rows.ts +180 -0
  124. package/src/documents/sql-store.ts +242 -0
  125. package/src/documents/sql.ts +18 -0
  126. package/src/documents/steps.ts +173 -0
  127. package/src/documents/tests/integration/pglite.ts +73 -0
  128. package/src/documents/types.ts +193 -0
  129. package/src/http.ts +266 -0
  130. package/src/issuer/index.ts +9 -0
  131. package/src/issuer/port.ts +109 -0
  132. package/src/issuer/sidecar.ts +171 -0
  133. package/src/jobs.ts +115 -0
  134. package/src/manifest/index.ts +25 -16
  135. package/src/manifest/server.ts +20 -0
  136. package/src/notifications.ts +120 -0
  137. package/src/sale/index.ts +8 -0
  138. package/src/sale/types.ts +318 -0
  139. package/src/sidecar/index.ts +9 -0
  140. package/src/sidecar/types.ts +245 -0
package/package.json CHANGED
@@ -1,18 +1,63 @@
1
1
  {
2
2
  "name": "@12-apps/fiscal",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
- "description": "Brazilian consumption-tax machinery for any host that sells. Its first module is the IBS/CBS engine (./engine): a pure function from priced lines, the seller's regime, the destination, the exclusions, a versioned rate table and the date of the supply to a per-line and per-order breakdown, with the NF-e layout's per-item rounding and an injected official-calculator port for running it as an oracle. Rate tables are versioned data (./tables/*). Implements @12-apps/wiring (./manifest).",
6
+ "description": "Brazilian consumption-tax machinery and fiscal documents for any host that sells. The IBS/CBS engine (./engine): a pure function from priced lines, the seller's regime, the destination, the exclusions, a versioned rate table and the date of the supply to a per-line and per-order breakdown. The neutral sale document (./sale) and a stateless HTTP service over sped-nfe that issues NF-e and NFC-e, shipped with its Dockerfile in sidecar/ (./sidecar types its wire contract). The fiscal document module (./documents): the state machine, the per-series number counters, the issuer port and its sidecar adapter (./issuer), the signing identity, and the DANFE NFC-e as ESC/POS-ready lines (./danfe). Implements @12-apps/wiring (./manifest): db, http, jobs, permissions.",
7
7
  "exports": {
8
+ "./danfe": {
9
+ "types": "./dist/danfe/index.d.ts",
10
+ "default": "./dist/danfe/index.js"
11
+ },
12
+ "./danfe/en-US": {
13
+ "types": "./dist/danfe/en-US.d.ts",
14
+ "default": "./dist/danfe/en-US.js"
15
+ },
16
+ "./danfe/pt-BR": {
17
+ "types": "./dist/danfe/pt-BR.d.ts",
18
+ "default": "./dist/danfe/pt-BR.js"
19
+ },
20
+ "./documents": {
21
+ "types": "./dist/documents/index.d.ts",
22
+ "default": "./dist/documents/index.js"
23
+ },
8
24
  "./engine": {
9
25
  "types": "./dist/engine/index.d.ts",
10
26
  "default": "./dist/engine/index.js"
11
27
  },
28
+ "./http": {
29
+ "types": "./dist/http.d.ts",
30
+ "default": "./dist/http.js"
31
+ },
32
+ "./issuer": {
33
+ "types": "./dist/issuer/index.d.ts",
34
+ "default": "./dist/issuer/index.js"
35
+ },
36
+ "./jobs": {
37
+ "types": "./dist/jobs.d.ts",
38
+ "default": "./dist/jobs.js"
39
+ },
12
40
  "./manifest": {
13
41
  "types": "./dist/manifest/index.d.ts",
14
42
  "default": "./dist/manifest/index.js"
15
43
  },
44
+ "./manifest/server": {
45
+ "types": "./dist/manifest/server.d.ts",
46
+ "default": "./dist/manifest/server.js"
47
+ },
48
+ "./notifications": {
49
+ "types": "./dist/notifications.d.ts",
50
+ "default": "./dist/notifications.js"
51
+ },
52
+ "./sale": {
53
+ "types": "./dist/sale/index.d.ts",
54
+ "default": "./dist/sale/index.js"
55
+ },
56
+ "./sidecar": {
57
+ "types": "./dist/sidecar/index.d.ts",
58
+ "default": "./dist/sidecar/index.js"
59
+ },
60
+ "./sidecar/schema/*": "./sidecar/schema/*",
16
61
  "./tables/*": "./tables/*",
17
62
  "./package.json": "./package.json"
18
63
  },
@@ -26,7 +71,7 @@
26
71
  "typecheck": "tsc --noEmit"
27
72
  },
28
73
  "peerDependencies": {
29
- "@12-apps/wiring": ">=1.0.0"
74
+ "@12-apps/wiring": ">=1.3.0"
30
75
  },
31
76
  "peerDependenciesMeta": {
32
77
  "@12-apps/wiring": {
@@ -37,6 +82,7 @@
37
82
  "@12-apps/eslint-config": "^1.22.0",
38
83
  "@12-apps/typescript-config": "^1.21.0",
39
84
  "@12-apps/wiring": "^1.17.0",
85
+ "@electric-sql/pglite": "0.2.17",
40
86
  "@types/node": "^22.10.6",
41
87
  "eslint": "^9.39.1",
42
88
  "eslint-plugin-test-flakiness": "^1.4.0",
@@ -61,10 +107,22 @@
61
107
  "src",
62
108
  "dist",
63
109
  "tables",
110
+ "sidecar",
111
+ "prisma",
64
112
  "*.md",
65
113
  "!eslint.config.js",
66
114
  "!tsup.config.ts",
67
115
  "!**/__tests__/**",
68
- "!**/*.test.*"
69
- ]
116
+ "!**/*.test.*",
117
+ "!sidecar/vendor",
118
+ "!sidecar/tests",
119
+ "!sidecar/phpunit.xml",
120
+ "!sidecar/.phpunit.cache"
121
+ ],
122
+ "wiring": {
123
+ "db": {
124
+ "partial": "prisma/fiscal.prisma",
125
+ "migrations": "prisma/migrations"
126
+ }
127
+ }
70
128
  }
@@ -0,0 +1,158 @@
1
+ // @12-apps/fiscal — canonical host-agnostic Prisma partial (FUT-2237).
2
+ //
3
+ // The emitter profile, its issuing points, one number counter per issuing
4
+ // point and series, the fiscal documents and their events. Every host id (the
5
+ // profile's owner, a document's subject) is stored BY VALUE: what an owner or
6
+ // a subject is stays the host's to map, and the links to its orders live in
7
+ // the host. The package migration adds the CHECKs Prisma cannot express.
8
+ //
9
+ // Secrets are never stored in clear: the certificate, its password and the
10
+ // CSC token are ciphertext from the host's cipher.
11
+
12
+ model FiscalEmitterProfile {
13
+ ownerId String @id @map("owner_id")
14
+ cnpj String
15
+ stateRegistration String @map("state_registration")
16
+ municipalRegistration String? @map("municipal_registration")
17
+ cnae String?
18
+ legalName String @map("legal_name")
19
+ tradeName String? @map("trade_name")
20
+ // CRT on the document: SIMPLES | SIMPLES_EXCESS | NORMAL | MEI.
21
+ taxRegime String @map("tax_regime")
22
+ // The IBS/CBS engine's regime, and the day it took effect.
23
+ regime String
24
+ regimeEffectiveFrom DateTime @map("regime_effective_from") @db.Date
25
+ restaurantRegime Boolean @map("restaurant_regime")
26
+ // { street, number, complement, district, municipalityIbge, municipalityName, uf, postalCode, phone }
27
+ address Json
28
+ // homologacao | producao
29
+ environment String
30
+ // ISSUED_HERE | ISSUED_ELSEWHERE | NONE — the host sets the default.
31
+ documentPolicy String @map("document_policy")
32
+ // STORE_CERTIFICATE | PLATFORM (declared, NOT_SUPPORTED until FUT-2229 q4).
33
+ signingIdentity String @map("signing_identity")
34
+ certificateCiphertext String? @map("certificate_ciphertext")
35
+ certificatePasswordCiphertext String? @map("certificate_password_ciphertext")
36
+ certificateExpiresAt DateTime? @map("certificate_expires_at")
37
+ cscId String? @map("csc_id")
38
+ cscCiphertext String? @map("csc_ciphertext")
39
+ consentRecordedAt DateTime? @map("consent_recorded_at")
40
+ updatedAt DateTime @updatedAt @map("updated_at")
41
+
42
+ @@index([certificateExpiresAt])
43
+ @@map("fiscal_emitter_profiles")
44
+ }
45
+
46
+ // Where documents are issued from: an opaque id the host maps (a register, the
47
+ // online store). A register has an online and a contingency series.
48
+ model FiscalIssuingPoint {
49
+ id String @id
50
+ ownerId String @map("owner_id")
51
+ // NFE | NFCE
52
+ model String
53
+ onlineSeries Int @map("online_series")
54
+ contingencySeries Int? @map("contingency_series")
55
+ createdAt DateTime @default(now()) @map("created_at")
56
+
57
+ counters FiscalNumberCounter[]
58
+
59
+ @@index([ownerId])
60
+ @@map("fiscal_issuing_points")
61
+ }
62
+
63
+ // The ONE counter of a series. SEFAZ numbers by CNPJ, model and series, and
64
+ // one CNPJ can serve several owners, so the primary key is the CNPJ's: a
65
+ // series belongs to one issuing point. `nextNumber` is drawn with
66
+ // FISCAL_NEXT_NUMBER_SQL in the same transaction as the document's insert.
67
+ model FiscalNumberCounter {
68
+ issuerCnpj String @map("issuer_cnpj")
69
+ environment String
70
+ model String
71
+ series Int
72
+ issuingPointId String @map("issuing_point_id")
73
+ // ONLINE | CONTINGENCY
74
+ seriesKind String @map("series_kind")
75
+ nextNumber Int @map("next_number")
76
+ updatedAt DateTime @default(now()) @map("updated_at")
77
+ issuingPoint FiscalIssuingPoint @relation(fields: [issuingPointId], references: [id], onDelete: Restrict)
78
+
79
+ @@id([issuerCnpj, environment, model, series])
80
+ @@index([issuingPointId])
81
+ @@map("fiscal_number_counters")
82
+ }
83
+
84
+ model FiscalDocument {
85
+ id String @id
86
+ ownerId String @map("owner_id")
87
+ issuerCnpj String @map("issuer_cnpj")
88
+ // What the document is for, opaque: the host links it to its orders.
89
+ subjectId String @map("subject_id")
90
+ issuingPointId String @map("issuing_point_id")
91
+ model String
92
+ environment String
93
+ seriesKind String @map("series_kind")
94
+ series Int
95
+ number Int
96
+ keyCode String @map("key_code")
97
+ // PENDING | SUBMITTED | AUTHORIZED | REJECTED | DENIED | CONTINGENCY | CANCELLED | REPLACED
98
+ status String
99
+ // The SaleForDocument as sent. Never a secret.
100
+ sale Json
101
+ // { totalCents, discountCents, cbsCents, ibsUfCents, ibsMunCents }
102
+ totals Json
103
+ buyerTaxId String? @map("buyer_tax_id")
104
+ accessKey String? @unique @map("access_key")
105
+ protocol String?
106
+ statusCode String? @map("status_code")
107
+ statusReason String? @map("status_reason")
108
+ lastErrorClass String? @map("last_error_class")
109
+ outcomeUnknown Boolean @default(false) @map("outcome_unknown")
110
+ issuedAt String @map("issued_at")
111
+ authorizedAt String? @map("authorized_at")
112
+ // { since, reason } of a document signed offline.
113
+ contingency Json?
114
+ cancelledAt String? @map("cancelled_at")
115
+ cancelReason String? @map("cancel_reason")
116
+ cancelProtocol String? @map("cancel_protocol")
117
+ replacedById String? @map("replaced_by_id")
118
+ // LOOKUP_FIRST | INUTILIZE | CANCEL | INUTILIZED | CANCELLED | DENIED
119
+ numberVoid String? @map("number_void")
120
+ xmlKey String? @map("xml_key")
121
+ eventXmlKey String? @map("event_xml_key")
122
+ attempts Int @default(0)
123
+ // Failed steps in a row; the backoff and the person's flag follow from it.
124
+ failures Int @default(0)
125
+ nextAttemptAt DateTime? @map("next_attempt_at")
126
+ attention Boolean @default(false)
127
+ deadlineWarnedAt DateTime? @map("deadline_warned_at")
128
+ createdAt DateTime @map("created_at")
129
+ updatedAt DateTime @map("updated_at")
130
+
131
+ events FiscalDocumentEvent[]
132
+
133
+ // The per-subject guard (one live document) and the sweep's queue index are
134
+ // partial indexes, in the migration: Prisma cannot express them.
135
+ @@unique([issuerCnpj, environment, model, series, number], map: "fiscal_documents_number_key")
136
+ @@index([ownerId, subjectId, model])
137
+ @@map("fiscal_documents")
138
+ }
139
+
140
+ // One transition, with the fiscal service's raw answer (secret-named keys
141
+ // scrubbed). Append-only.
142
+ model FiscalDocumentEvent {
143
+ id String @id
144
+ // Insertion order: two events of one millisecond keep theirs.
145
+ seq BigInt @unique @default(autoincrement())
146
+ documentId String @map("document_id")
147
+ kind String
148
+ fromStatus String @map("from_status")
149
+ toStatus String @map("to_status")
150
+ at DateTime
151
+ errorClass String? @map("error_class")
152
+ code String?
153
+ answer Json?
154
+ document FiscalDocument @relation(fields: [documentId], references: [id], onDelete: Restrict)
155
+
156
+ @@index([documentId, at])
157
+ @@map("fiscal_document_events")
158
+ }
@@ -0,0 +1,201 @@
1
+ -- @12-apps/fiscal (FUT-2237): the emitter profile, issuing points, one number
2
+ -- counter per issuing point and series, fiscal documents and their events.
3
+ -- Additive only: five new tables. Host ids (owner, subject) are stored by
4
+ -- value, with no foreign key into the host's tables.
5
+
6
+ CREATE TABLE "fiscal_emitter_profiles" (
7
+ "owner_id" TEXT NOT NULL,
8
+ "cnpj" TEXT NOT NULL,
9
+ "state_registration" TEXT NOT NULL,
10
+ "municipal_registration" TEXT,
11
+ "cnae" TEXT,
12
+ "legal_name" TEXT NOT NULL,
13
+ "trade_name" TEXT,
14
+ "tax_regime" TEXT NOT NULL,
15
+ "regime" TEXT NOT NULL,
16
+ "regime_effective_from" DATE NOT NULL,
17
+ "restaurant_regime" BOOLEAN NOT NULL,
18
+ "address" JSONB NOT NULL,
19
+ "environment" TEXT NOT NULL,
20
+ "document_policy" TEXT NOT NULL,
21
+ "signing_identity" TEXT NOT NULL,
22
+ "certificate_ciphertext" TEXT,
23
+ "certificate_password_ciphertext" TEXT,
24
+ "certificate_expires_at" TIMESTAMP(3),
25
+ "csc_id" TEXT,
26
+ "csc_ciphertext" TEXT,
27
+ "consent_recorded_at" TIMESTAMP(3),
28
+ "updated_at" TIMESTAMP(3) NOT NULL,
29
+
30
+ CONSTRAINT "fiscal_emitter_profiles_pkey" PRIMARY KEY ("owner_id"),
31
+ CONSTRAINT "fiscal_emitter_profiles_cnpj_check" CHECK ("cnpj" ~ '^[0-9A-Z]{12}[0-9]{2}$'),
32
+ CONSTRAINT "fiscal_emitter_profiles_tax_regime_check"
33
+ CHECK ("tax_regime" IN ('SIMPLES', 'SIMPLES_EXCESS', 'NORMAL', 'MEI')),
34
+ CONSTRAINT "fiscal_emitter_profiles_regime_check"
35
+ CHECK ("regime" IN ('SIMPLES', 'SIMPLES_IBS_CBS_REGULAR', 'REGIME_REGULAR', 'MEI', 'NAO_CONTRIBUINTE')),
36
+ CONSTRAINT "fiscal_emitter_profiles_environment_check"
37
+ CHECK ("environment" IN ('homologacao', 'producao')),
38
+ CONSTRAINT "fiscal_emitter_profiles_document_policy_check"
39
+ CHECK ("document_policy" IN ('ISSUED_HERE', 'ISSUED_ELSEWHERE', 'NONE')),
40
+ CONSTRAINT "fiscal_emitter_profiles_signing_identity_check"
41
+ CHECK ("signing_identity" IN ('STORE_CERTIFICATE', 'PLATFORM')),
42
+ -- The certificate is both halves or neither, and its expiry comes with it.
43
+ CONSTRAINT "fiscal_emitter_profiles_certificate_check"
44
+ CHECK (
45
+ ("certificate_ciphertext" IS NULL AND "certificate_password_ciphertext" IS NULL AND "certificate_expires_at" IS NULL)
46
+ OR
47
+ ("certificate_ciphertext" IS NOT NULL AND "certificate_password_ciphertext" IS NOT NULL AND "certificate_expires_at" IS NOT NULL)
48
+ ),
49
+ CONSTRAINT "fiscal_emitter_profiles_csc_check"
50
+ CHECK ("csc_ciphertext" IS NULL OR "csc_id" IS NOT NULL)
51
+ );
52
+
53
+ CREATE INDEX "fiscal_emitter_profiles_certificate_expires_at_idx"
54
+ ON "fiscal_emitter_profiles"("certificate_expires_at");
55
+
56
+ CREATE TABLE "fiscal_issuing_points" (
57
+ "id" TEXT NOT NULL,
58
+ "owner_id" TEXT NOT NULL,
59
+ "model" TEXT NOT NULL,
60
+ "online_series" INTEGER NOT NULL,
61
+ "contingency_series" INTEGER,
62
+ "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
63
+
64
+ CONSTRAINT "fiscal_issuing_points_pkey" PRIMARY KEY ("id"),
65
+ CONSTRAINT "fiscal_issuing_points_model_check" CHECK ("model" IN ('NFE', 'NFCE')),
66
+ CONSTRAINT "fiscal_issuing_points_online_series_check" CHECK ("online_series" BETWEEN 0 AND 889),
67
+ -- No offline NF-e path in the fiscal service: only an NFC-e point has a contingency series.
68
+ CONSTRAINT "fiscal_issuing_points_contingency_series_check"
69
+ CHECK (
70
+ "contingency_series" IS NULL
71
+ OR ("model" = 'NFCE' AND "contingency_series" BETWEEN 0 AND 889 AND "contingency_series" <> "online_series")
72
+ )
73
+ );
74
+
75
+ CREATE INDEX "fiscal_issuing_points_owner_id_idx" ON "fiscal_issuing_points"("owner_id");
76
+
77
+ CREATE TABLE "fiscal_number_counters" (
78
+ "issuer_cnpj" TEXT NOT NULL,
79
+ "environment" TEXT NOT NULL,
80
+ "model" TEXT NOT NULL,
81
+ "series" INTEGER NOT NULL,
82
+ "issuing_point_id" TEXT NOT NULL,
83
+ "series_kind" TEXT NOT NULL,
84
+ "next_number" INTEGER NOT NULL,
85
+ "updated_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
86
+
87
+ -- One counter per series of a CNPJ, as SEFAZ numbers: a series belongs to
88
+ -- ONE issuing point, whichever owner (one CNPJ can serve several) holds it.
89
+ CONSTRAINT "fiscal_number_counters_pkey" PRIMARY KEY ("issuer_cnpj", "environment", "model", "series"),
90
+ CONSTRAINT "fiscal_number_counters_issuing_point_id_fkey"
91
+ FOREIGN KEY ("issuing_point_id") REFERENCES "fiscal_issuing_points"("id") ON DELETE RESTRICT ON UPDATE CASCADE,
92
+ CONSTRAINT "fiscal_number_counters_environment_check" CHECK ("environment" IN ('homologacao', 'producao')),
93
+ CONSTRAINT "fiscal_number_counters_model_check" CHECK ("model" IN ('NFE', 'NFCE')),
94
+ CONSTRAINT "fiscal_number_counters_series_kind_check" CHECK ("series_kind" IN ('ONLINE', 'CONTINGENCY')),
95
+ -- nNF is 1 to 999 999 999; the next number after the last one is the ceiling.
96
+ CONSTRAINT "fiscal_number_counters_next_number_check" CHECK ("next_number" BETWEEN 1 AND 1000000000)
97
+ );
98
+
99
+ CREATE INDEX "fiscal_number_counters_issuing_point_id_idx" ON "fiscal_number_counters"("issuing_point_id");
100
+
101
+ CREATE TABLE "fiscal_documents" (
102
+ "id" TEXT NOT NULL,
103
+ "owner_id" TEXT NOT NULL,
104
+ "issuer_cnpj" TEXT NOT NULL,
105
+ "subject_id" TEXT NOT NULL,
106
+ "issuing_point_id" TEXT NOT NULL,
107
+ "model" TEXT NOT NULL,
108
+ "environment" TEXT NOT NULL,
109
+ "series_kind" TEXT NOT NULL,
110
+ "series" INTEGER NOT NULL,
111
+ "number" INTEGER NOT NULL,
112
+ "key_code" TEXT NOT NULL,
113
+ "status" TEXT NOT NULL,
114
+ "sale" JSONB NOT NULL,
115
+ "totals" JSONB NOT NULL,
116
+ "buyer_tax_id" TEXT,
117
+ "access_key" TEXT,
118
+ "protocol" TEXT,
119
+ "status_code" TEXT,
120
+ "status_reason" TEXT,
121
+ "last_error_class" TEXT,
122
+ "outcome_unknown" BOOLEAN NOT NULL DEFAULT false,
123
+ "issued_at" TEXT NOT NULL,
124
+ "authorized_at" TEXT,
125
+ "contingency" JSONB,
126
+ "cancelled_at" TEXT,
127
+ "cancel_reason" TEXT,
128
+ "cancel_protocol" TEXT,
129
+ "replaced_by_id" TEXT,
130
+ "number_void" TEXT,
131
+ "xml_key" TEXT,
132
+ "event_xml_key" TEXT,
133
+ "attempts" INTEGER NOT NULL DEFAULT 0,
134
+ "failures" INTEGER NOT NULL DEFAULT 0,
135
+ "next_attempt_at" TIMESTAMP(3),
136
+ "attention" BOOLEAN NOT NULL DEFAULT false,
137
+ "deadline_warned_at" TIMESTAMP(3),
138
+ "created_at" TIMESTAMP(3) NOT NULL,
139
+ "updated_at" TIMESTAMP(3) NOT NULL,
140
+
141
+ CONSTRAINT "fiscal_documents_pkey" PRIMARY KEY ("id"),
142
+ CONSTRAINT "fiscal_documents_model_check" CHECK ("model" IN ('NFE', 'NFCE')),
143
+ CONSTRAINT "fiscal_documents_environment_check" CHECK ("environment" IN ('homologacao', 'producao')),
144
+ CONSTRAINT "fiscal_documents_series_kind_check" CHECK ("series_kind" IN ('ONLINE', 'CONTINGENCY')),
145
+ CONSTRAINT "fiscal_documents_number_check" CHECK ("number" BETWEEN 1 AND 999999999),
146
+ CONSTRAINT "fiscal_documents_failures_check" CHECK ("failures" >= 0),
147
+ CONSTRAINT "fiscal_documents_key_code_check" CHECK ("key_code" ~ '^[0-9]{8}$'),
148
+ CONSTRAINT "fiscal_documents_status_check"
149
+ CHECK ("status" IN ('PENDING', 'SUBMITTED', 'AUTHORIZED', 'REJECTED', 'DENIED', 'CONTINGENCY', 'CANCELLED', 'REPLACED')),
150
+ CONSTRAINT "fiscal_documents_number_void_check"
151
+ CHECK ("number_void" IS NULL OR "number_void" IN ('LOOKUP_FIRST', 'INUTILIZE', 'CANCEL', 'INUTILIZED', 'CANCELLED', 'DENIED')),
152
+ CONSTRAINT "fiscal_documents_last_error_class_check"
153
+ CHECK ("last_error_class" IS NULL OR "last_error_class" IN ('REJECTED', 'RETRYABLE', 'CONTINGENCY', 'AUTH', 'INVALID', 'INTERNAL')),
154
+ -- An authorised, denied or cancelled document carries its key and protocol.
155
+ CONSTRAINT "fiscal_documents_authorized_check"
156
+ CHECK ("status" NOT IN ('AUTHORIZED', 'DENIED', 'CANCELLED') OR ("access_key" IS NOT NULL AND "protocol" IS NOT NULL)),
157
+ CONSTRAINT "fiscal_documents_contingency_check"
158
+ CHECK ("status" <> 'CONTINGENCY' OR ("series_kind" = 'CONTINGENCY' AND "contingency" IS NOT NULL AND "xml_key" IS NOT NULL)),
159
+ CONSTRAINT "fiscal_documents_replaced_check"
160
+ CHECK ("status" <> 'REPLACED' OR ("replaced_by_id" IS NOT NULL AND "number_void" IS NOT NULL))
161
+ );
162
+
163
+ CREATE UNIQUE INDEX "fiscal_documents_access_key_key" ON "fiscal_documents"("access_key");
164
+ CREATE UNIQUE INDEX "fiscal_documents_number_key"
165
+ ON "fiscal_documents"("issuer_cnpj", "environment", "model", "series", "number");
166
+ CREATE INDEX "fiscal_documents_owner_id_subject_id_model_idx" ON "fiscal_documents"("owner_id", "subject_id", "model");
167
+ -- Prisma cannot express a partial unique index. This is the per-subject guard:
168
+ -- at most ONE live document per (owner, subject, model) — not a replaced one,
169
+ -- nor an online one SEFAZ rejected (its number is voided and the sale issued
170
+ -- again) unless a lookup had found it authorised (its protocol is kept); a
171
+ -- rejected contingency NFC-e stays live, for the store to resend.
172
+ CREATE UNIQUE INDEX "fiscal_documents_live_subject_key"
173
+ ON "fiscal_documents"("owner_id", "subject_id", "model")
174
+ WHERE "status" <> 'REPLACED'
175
+ AND NOT ("status" = 'REJECTED' AND "series_kind" = 'ONLINE' AND "protocol" IS NULL);
176
+ -- The sweep's and the transmission's queue: by next attempt, never a row waiting for a person.
177
+ CREATE INDEX "fiscal_documents_next_attempt_at_idx"
178
+ ON "fiscal_documents"("next_attempt_at") WHERE "attention" = false;
179
+
180
+ CREATE TABLE "fiscal_document_events" (
181
+ "id" TEXT NOT NULL,
182
+ "seq" BIGSERIAL NOT NULL,
183
+ "document_id" TEXT NOT NULL,
184
+ "kind" TEXT NOT NULL,
185
+ "from_status" TEXT NOT NULL,
186
+ "to_status" TEXT NOT NULL,
187
+ "at" TIMESTAMP(3) NOT NULL,
188
+ "error_class" TEXT,
189
+ "code" TEXT,
190
+ "answer" JSONB,
191
+
192
+ CONSTRAINT "fiscal_document_events_pkey" PRIMARY KEY ("id"),
193
+ CONSTRAINT "fiscal_document_events_document_id_fkey"
194
+ FOREIGN KEY ("document_id") REFERENCES "fiscal_documents"("id") ON DELETE RESTRICT ON UPDATE CASCADE,
195
+ CONSTRAINT "fiscal_document_events_kind_check"
196
+ CHECK ("kind" IN ('SUBMIT', 'AUTHORIZE', 'DENY', 'REJECT', 'RETRY', 'SIGN_OFFLINE', 'REPLACE', 'CANCEL', 'LOOKUP', 'INUTILIZE',
197
+ 'DEFER', 'RESIGN', 'RELEASE', 'WARN'))
198
+ );
199
+
200
+ CREATE UNIQUE INDEX "fiscal_document_events_seq_key" ON "fiscal_document_events"("seq");
201
+ CREATE INDEX "fiscal_document_events_document_id_at_idx" ON "fiscal_document_events"("document_id", "at");
@@ -0,0 +1,5 @@
1
+ vendor
2
+ tests
3
+ .phpunit.cache
4
+ phpunit.xml
5
+ .gitignore
@@ -0,0 +1,68 @@
1
+ # syntax=docker/dockerfile:1
2
+ #
3
+ # The fiscal service: PHP 8.3 + Apache over sped-nfe. Build context: this
4
+ # folder (`sidecar/`), as shipped inside the @12-apps/fiscal tarball.
5
+ #
6
+ # docker build -t fiscal-sidecar node_modules/@12-apps/fiscal/sidecar
7
+ #
8
+ # Both images are pinned BY DIGEST; the tag beside each digest is only a label.
9
+ # A digest is bumped on purpose, never by a rebuild.
10
+
11
+ # The dependencies are installed in Composer's own image (it has git and unzip)
12
+ # and only `vendor/` is carried over. The two requirements it cannot meet
13
+ # itself, PHP 8.3 and ext-soap, are the final image's, which has both.
14
+ FROM composer:2.8.12@sha256:5248900ab8b5f7f880c2d62180e40960cd87f60149ec9a1abfd62ac72a02577c AS vendor
15
+ WORKDIR /app
16
+ COPY composer.json composer.lock ./
17
+ # The service's own classes go into the authoritative classmap too.
18
+ COPY src ./src
19
+ RUN composer install \
20
+ --no-dev --no-interaction --no-progress --prefer-dist \
21
+ --classmap-authoritative --no-scripts \
22
+ --ignore-platform-req=php --ignore-platform-req=ext-soap
23
+
24
+ FROM php:8.3.36-apache-bookworm@sha256:a14446c32a3c8aeb9b4dac7fb73b03dfd8006e670d9b43ea7947e4030d3cbae6
25
+
26
+ # ext-soap is a declared requirement of sped-nfe (the service talks SOAP over
27
+ # its own cURL transport, but the library's constants come from the extension).
28
+ RUN set -eux; \
29
+ apt-get update; \
30
+ apt-get install -y --no-install-recommends libxml2-dev; \
31
+ docker-php-ext-install -j"$(nproc)" soap; \
32
+ apt-get purge -y --auto-remove libxml2-dev; \
33
+ rm -rf /var/lib/apt/lists/*
34
+
35
+ COPY docker/php.ini /usr/local/etc/php/conf.d/zz-fiscal-sidecar.ini
36
+ COPY docker/openssl.cnf /etc/ssl/fiscal-sidecar-openssl.cnf
37
+ COPY docker/apache.conf /etc/apache2/sites-available/000-default.conf
38
+ COPY docker/mpm.conf /etc/apache2/mods-available/mpm_prefork.conf
39
+ # The trust store SEFAZ's server certificate is verified against: the image's
40
+ # Mozilla bundle (ca-certificates) plus the ICP-Brasil chain, the public roots
41
+ # and intermediates ITI publishes (acraiz.icpbrasil.gov.br; see the PEM's own
42
+ # per-certificate comments). Some SEFAZ hosts present ICP-Brasil server
43
+ # certificates, others public ones, so both are needed. The PEM is checked
44
+ # against this sha256; replacing it means changing this line too.
45
+ COPY docker/icp-brasil.pem /tmp/icp-brasil.pem
46
+ RUN set -eux; \
47
+ echo "9374b11042655df7c226fa7de2b1321f4024263572419b491e7fbd5c76c09a99 /tmp/icp-brasil.pem" | sha256sum -c -; \
48
+ cat /etc/ssl/certs/ca-certificates.crt /tmp/icp-brasil.pem > /etc/ssl/fiscal-sidecar-ca.pem; \
49
+ rm /tmp/icp-brasil.pem
50
+ # A1 certificates issued before OpenSSL 3 are encrypted with RC2/3DES, which
51
+ # only the legacy provider reads. The config turns it on beside the default.
52
+ ENV OPENSSL_CONF=/etc/ssl/fiscal-sidecar-openssl.cnf
53
+ RUN set -eux; \
54
+ cp /usr/local/etc/php/php.ini-production /usr/local/etc/php/php.ini; \
55
+ sed -ri 's/^Listen 80$/Listen 8080/' /etc/apache2/ports.conf; \
56
+ printf 'ServerTokens Prod\nServerSignature Off\nTraceEnable Off\n' > /etc/apache2/conf-available/zz-fiscal-sidecar.conf; \
57
+ a2enconf zz-fiscal-sidecar
58
+
59
+ WORKDIR /app
60
+ COPY --from=vendor /app/vendor ./vendor
61
+ COPY public ./public
62
+ COPY src ./src
63
+ COPY schema ./schema
64
+
65
+ USER www-data
66
+ EXPOSE 8080
67
+ HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
68
+ CMD php -r 'exit(@file_get_contents("http://127.0.0.1:8080/health") === false ? 1 : 0);'