@forzalabs/remora 2.6.0 → 2.6.1

package/LICENCE.md

@@ -1,31 +1,66 @@
-Business Source License 1.1
+# Remora Licence
 
-Parameters
+Copyright (c) 2026 Forza Labs LLC. All rights reserved.
 
-Licensor: Forza Labs LLC
+**Licensor:** Forza Labs LLC
 
-Licensed Work: Remora
+**Licensed Work:** Remora, including the `@forzalabs/remora` and `@forzalabs/remora-preview`
+packages and the documentation and schemas distributed with them.
 
-Additional Use Grant: You may make use of the Licensed Work for any non-commercial purpose, including personal, academic, research, or open source projects.
+This is a proprietary licence. It is **not** an open source licence, and it does not convert
+into one. The Licensed Work is made available on the terms below and on no others.
 
-Change Date: 02/07/2025
+## 1. Non-commercial use
 
-Terms
+You may use, copy, modify and redistribute the Licensed Work free of charge for any
+non-commercial purpose, including personal, academic, research, evaluation and open source
+projects, provided you comply with sections 3 to 7.
 
-The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make other use of the Licensed Work. The rights granted are subject to the following conditions:
+Use is non-commercial where it is not carried out for, on behalf of, or for the benefit of a
+company or other organisation, and is not directed towards commercial advantage or monetary
+compensation.
 
-1. **Commercial Use**: Any use of the Licensed Work for or on behalf of a company, organization, or any commercial purpose requires a separate commercial license from the Licensor.
+## 2. Commercial use
 
-2. **Non-Commercial Use**: Non-commercial users may freely use, modify, and distribute the Licensed Work, provided that such use is not intended for commercial advantage or monetary compensation.
+Any other use requires a separate written commercial licence from the Licensor. This includes
+any use for, on behalf of, or for the benefit of a company or other organisation, and any use
+directed towards commercial advantage or monetary compensation.
 
-3. **Change Date**: On the Change Date, the terms of this license will change to the Change License specified above.
+Without such a licence, no right to use the Licensed Work for those purposes is granted. To
+obtain one, contact admin@forza-labs.com.
 
-4. **Other Conditions**:
-   - This license does not grant trademark rights.
-   - You must include this license text with any distribution of the Licensed Work.
-   - You may not remove or modify this license notice.
+## 3. Separate agreements take precedence
 
-Use Limitation: If your usage does not comply with the above terms (e.g., if it's for commercial purposes), you must contact the Licensor to purchase a commercial license.
+Where you have entered into a separate written agreement with the Licensor covering the
+Licensed Work, that agreement governs your use of it and supersedes this notice in full to the
+extent of any conflict.
 
-To inquire about commercial licensing, contact: admin@forza-labs.com
+## 4. Notices
 
+You must include this licence text, unmodified, with any copy or redistribution of the Licensed
+Work. You may not remove, alter or obscure this notice, or any copyright, licence or
+attribution notice contained in the Licensed Work.
+
+## 5. Trademarks
+
+This licence grants no right to use the names, logos or trademarks of the Licensor, including
+"Forza Labs" and "Remora", beyond the attribution section 4 requires.
+
+## 6. No warranty and limitation of liability
+
+THE LICENSED WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE, TITLE AND NONINFRINGEMENT. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO
+EVENT SHALL THE LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE LICENSED
+WORK OR THE USE OF OR OTHER DEALINGS IN IT.
+
+## 7. Termination
+
+If you use the Licensed Work other than as this notice permits, the rights granted to you end
+automatically. They are reinstated only once you cease the non-compliant use and the Licensor
+confirms reinstatement in writing.
+
+---
+
+Commercial licensing enquiries: admin@forza-labs.com

package/README.md

@@ -39,9 +39,19 @@ remora compile
 remora deploy
 ```
 
+## 📋 Release notes
+
+What changed in each release, and what to check before upgrading, is in
+[RELEASE_NOTES.md](RELEASE_NOTES.md), which ships with this package.
+
 ## 📄 License
 
-BSL
+Proprietary. Free for non-commercial use — personal, academic, research, evaluation and open source
+projects. Any use for, on behalf of, or for the benefit of a company or other organisation requires a
+separate written commercial licence.
+
+The full terms are in [LICENCE.md](LICENCE.md), which ships with this package. For commercial
+licensing, contact admin@forza-labs.com.
 
 ---
 

package/RELEASE_NOTES.md

@@ -0,0 +1,157 @@
+# Remora release notes
+
+What changed in each release, and what to check before upgrading. Newest first.
+
+Run `remora -v` to see the version you have installed.
+
+---
+
+## Unreleased
+
+## 2.6.1 — 2026-10-27
+
+**Changed**
+
+- Remora is distributed under a restated proprietary licence. What you may do is unchanged: free for
+  personal, academic, research, evaluation and open source use, with a written commercial licence
+  required for use by or on behalf of an organisation. Full text in `LICENCE.md`. `remora ui-preview`
+  carries the same licence and now states it in the package.
+- These release notes ship inside the package, so the record of what changed in the version you have
+  installed sits on disk beside it. The development changelog, which was included up to 2.6.0, is an
+  internal working record and is no longer part of the package.
+
+**Upgrading.** Nothing in a project needs changing. If anything of yours reads
+`node_modules/@forzalabs/remora/CHANGELOG.md`, point it at `RELEASE_NOTES.md` in the same folder.
+
+## 2.6.0 — 2026-10-26
+
+**Changed**
+
+- A `CSV` or `TXT` export quotes a field only where the quotes carry meaning — when the value holds the
+  delimiter, a `"`, a line break, or a space at either end. An empty string stays quoted, so it is still
+  distinct from a null. Exported files are around 15% smaller.
+
+**Upgrading.** Nothing in a project needs changing. Check any destination that compares exported files
+against a fixture, or that parses them by splitting on `","` rather than with a CSV reader.
+
+## 2.5.0 — 2026-10-26
+
+**Added**
+
+- `"format": "FIXED"`, a positional flat-file output: no delimiter, no quotes, no header. Each field
+  declares a `width`, with `align`, `pad`, `nullFill` and `overflow` controlling how it is filled.
+- `recordLength`, `defaults` and `lineEnding` on the output, and `layouts` for several record layouts in
+  one file. Column offsets are computed from the widths, so none are written by hand.
+- The full prose reference now ships with the CLI, so the documentation always matches your version.
+
+**Upgrading.** Nothing changes unless a consumer declares a `FIXED` output. A FIXED file leaves Remora as
+UTF-8 text, so a z/OS target still needs the ASCII→EBCDIC and `RECFM=FB` conversion on its own side.
+
+## 2.4.0 — 2026-10-19
+
+**Added**
+
+- `"format": "PARQUET"`, a fourth file output.
+
+**Changed**
+
+- A `CSV` or `TXT` export distinguishes a null from an empty string.
+- A value containing a newline no longer becomes two records.
+- A consumer declares exactly one output.
+
+**Removed**
+
+- `measures` on a producer. It never calculated anything, so a consumer naming one exported an empty
+  column.
+
+**Fixed**
+
+- A `hidden` field no longer shifts the columns after it.
+- A `pivot` now tells downstream passes that the shape changed, and runs on sources under 10 MB.
+- A boolean read from a text source is no longer always `true`.
+- A `lineCount` field is renumbered against the file it belongs to.
+- A clean exit no longer deletes a concurrent run's temporary folder.
+
+**Upgrading.** A producer carrying `measures` is refused at `compile` — delete the key, including an empty
+`"measures": []`. Run `remora compile` before upgrading in place.
+
+## 2.3.0 — 2026-10-15
+
+**Added**
+
+- `remora report [run-id]` packages a run — versions, redacted configuration, the run record and its slice
+  of the log — into a `.zip` you can send to someone else.
+
+**Changed**
+
+- A `CSV` or `TXT` export writes a header line naming its columns.
+- `remora package` and `remora deploy` refuse an archive containing a `.env` file.
+
+**Upgrading.** Every exported `CSV` and `TXT` file gains a first line. Check any receiver that expects data
+on line one.
+
+## 2.2.0 / 2.2.1 — 2026-10-15
+
+**Added**
+
+- `split` on a consumer: the output broken into several files by a field value, a size cap or a record
+  count.
+- `remora discover <producer> --replace`.
+- A consumer's filters and the run's record limit reach a SQL source as a `WHERE` and a `LIMIT`.
+- A `presigned-url` engine, usable as a source and as a destination.
+
+**Changed**
+
+- `nullable` on a producer dimension decides what a missing value becomes. It defaults to `true`, which
+  keeps a missing value as null.
+- The configuration archive is called `remora.zip`.
+- `settings.sql` on a producer, and the resource folder names in `project.json`, are removed.
+
+**Fixed**
+
+- `remora discover` no longer overwrites hand-authored dimension properties, and reports what it found on
+  a SQL source.
+- A NULL in a `number` column is no longer staged as `0`.
+- An export no longer loses its last row, and a failed export no longer finishes the run as a success.
+- `region` and `bucket` can be `{ENV_VAR}` references on an S3 or Redshift source.
+
+**Upgrading.** `nullable` now affects what a run produces — a `number` column holding NULLs stops emitting
+`0`. Remove `settings.sql` and the folder names from existing configurations.
+
+## 2.1.0 / 2.1.1 — 2026-09
+
+**Added**
+
+- SQL sources can be run directly.
+- Postgres authenticates with an RDS IAM auth token.
+
+**Changed**
+
+- A live run reports what it read without needing `REMORA_DEBUG_MODE`.
+
+**Fixed**
+
+- A delta-share producer no longer exhausts worker memory.
+- A ZIP producer no longer reads the whole archive into memory.
+- A multi-line error arrives as one log event rather than many unrelated ones.
+
+## 2.0.0 — 2026-09-01
+
+A performance release. A run shares one worker pool across every producer, file and chunk, per-record work
+and output serialization are compiled once rather than per record, and workers write in batches.
+
+**Fixed**
+
+- JSON schema validation runs when a project loads.
+- A filter on a `number`, `datetime` or `boolean` field matches.
+- A run's record limit applies to the whole run, not to each worker.
+- A masked producer dimension is no longer shown in the clear when sampled (2.0.3).
+
+**Upgrading.** A configuration that was silently schema-invalid now fails at `compile`. Run `remora compile`
+before upgrading in place.
+
+---
+
+Earlier 1.x releases are superseded by 2.0. Questions and bug reports:
+[@forzalabs/remora](https://www.npmjs.com/package/@forzalabs/remora) — `remora report` packages a run worth
+attaching.

package/docs/Remora - Code Sets.md

@@ -177,7 +177,7 @@ Remora ships built-in healthcare/payer-quality code sets that are applied **auto
 
 Because `measure_code` and `measure_name` both bind to the built-in `hedis_measures` set, they are automatically correlated on each row — with no configuration.
 
-A built-in set is only applied when it can produce the dimension's declared `type`. A numeric surrogate key such as `heb_quality_gaps_measure_code_sk` matches `measure_code` by name, but HEDIS codes are not numbers, so the binding is skipped and the field is generated from its own type instead. An **explicit** `synth.codeSet` or `synth.allowedValues` that cannot produce the declared type is a configuration error and fails the run by name.
+A built-in set is only applied when it can produce the dimension's declared `type`. A numeric surrogate key such as `quality_gaps_measure_code_sk` matches `measure_code` by name, but HEDIS codes are not numbers, so the binding is skipped and the field is generated from its own type instead. An **explicit** `synth.codeSet` or `synth.allowedValues` that cannot produce the declared type is a configuration error and fails the run by name.
 
 ### **Overriding a built-in set**
 

package/docs/Remora - Consumers.md

@@ -1271,7 +1271,7 @@ How it behaves:
 
 ### **How a Record Ends**
 
-`lineEnding` is `"lf"` (the default) or `"crlf"`, and it ends **every** record, the last one included. A real positional feed picks one and holds it: NASCO POD files, for instance, are CRLF throughout.
+`lineEnding` is `"lf"` (the default) or `"crlf"`, and it ends **every** record, the last one included. A real positional feed picks one and holds it: a POD-style transaction feed, for instance, may be CRLF throughout.
 
 A file with **no terminator at all** — fixed record framing, `RECFM=FB`, where the record length alone says where one record ends — is not expressible here, and asking for it is the signal that what is needed is byte-mode framing rather than a line-based file. Remora does not write one.
 

package/index.js

@@ -11761,7 +11761,7 @@ var CONSTANTS, Constants_default;
 var init_Constants = __esm({
   "../../packages/constants/src/Constants.ts"() {
     CONSTANTS = {
-      cliVersion: "2.6.0",
+      cliVersion: "2.6.1",
       backendVersion: 1,
       backendPort: 5088,
       workerVersion: 2,
@@ -11889,7 +11889,7 @@ var init_Constants = __esm({
         /**
          * Record layouts one FIXED output may write into a single file, which is also how many write
          * streams its block-ordering pass holds open. A copybook of this size is already unusual —
-         * the NASCO POD feed writes five transaction types — and the bound stops a generated config
+         * a POD-style transaction feed may write five transaction types — and the bound stops a generated config
          * from opening a descriptor per distinct value of the wrong field.
          */
         MAX_FIXED_LAYOUTS: 64,
@@ -34515,7 +34515,7 @@ var init_FixedWidthWriter = __esm({
          * `lf` output needs nothing here and a `crlf` one needs the `\r` that turns that newline into a
          * CRLF — which is exactly what a CRLF file looks like to anything that splits on `\n`.
          *
-         * A real positional feed picks one terminator and holds it: the NASCO POD files are CRLF on
+         * A real positional feed picks one terminator and holds it: some are CRLF on
          * every line including the last, and `lf` is the default everywhere else.
          */
         this.lineSuffix = (output) => {

package/json_schemas/consumer-schema.json

@@ -396,7 +396,7 @@
                     "lineEnding": {
                         "type": "string",
                         "enum": ["lf", "crlf"],
-                        "description": "'FIXED' only. What ends every record, the last one included. Defaults to 'lf'. A real positional feed picks one and holds it — the NASCO POD files are CRLF on every line. A file with no terminator at all is fixed record framing (RECFM=FB) and is not expressible here."
+                        "description": "'FIXED' only. What ends every record, the last one included. Defaults to 'lf'. A real positional feed picks one and holds it — some are CRLF on every line. A file with no terminator at all is fixed record framing (RECFM=FB) and is not expressible here."
                     },
                     "layouts": {
                         "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@forzalabs/remora",
-    "version": "2.6.0",
+    "version": "2.6.1",
     "description": "A powerful CLI tool for seamless data translation.",
     "main": "index.js",
     "private": false,
@@ -44,7 +44,7 @@
         "typescript"
     ],
     "author": "",
-    "license": "BSL",
+    "license": "SEE LICENSE IN LICENCE.md",
     "dependencies": {
         "@aws-sdk/client-redshift-data": "^3.699.0",
         "@aws-sdk/rds-signer": "^3.1136.0",

package/workers/ExecutorWorker.js

@@ -11809,7 +11809,7 @@ var CONSTANTS, Constants_default;
 var init_Constants = __esm({
   "../../packages/constants/src/Constants.ts"() {
     CONSTANTS = {
-      cliVersion: "2.6.0",
+      cliVersion: "2.6.1",
       backendVersion: 1,
       backendPort: 5088,
       workerVersion: 2,
@@ -11937,7 +11937,7 @@ var init_Constants = __esm({
         /**
          * Record layouts one FIXED output may write into a single file, which is also how many write
          * streams its block-ordering pass holds open. A copybook of this size is already unusual —
-         * the NASCO POD feed writes five transaction types — and the bound stops a generated config
+         * a POD-style transaction feed may write five transaction types — and the bound stops a generated config
          * from opening a descriptor per distinct value of the wrong field.
          */
         MAX_FIXED_LAYOUTS: 64,
@@ -34298,7 +34298,7 @@ var init_FixedWidthWriter = __esm({
          * `lf` output needs nothing here and a `crlf` one needs the `\r` that turns that newline into a
          * CRLF — which is exactly what a CRLF file looks like to anything that splits on `\n`.
          *
-         * A real positional feed picks one terminator and holds it: the NASCO POD files are CRLF on
+         * A real positional feed picks one terminator and holds it: some are CRLF on
          * every line including the last, and `lf` is the default everywhere else.
          */
         this.lineSuffix = (output) => {