@ontemper/edi 1.2.0-beta.2 → 1.2.0-beta.3

package/README.md

@@ -356,75 +356,46 @@ The SDK manages ISA13 and GS06 control numbers for each sender and receiver pair
 empty or all-zero ISA13, GS06, and ST02 fields. It preserves valid non-zero values. ISA13 and GS06 use the
 centralized counters. ST02 is assigned `"0001"`.
 
-**By default, every environment draws from one shared sequence per trading partner. No setup is required.**
-Separating test traffic onto its own sequence is an optional, per-partner opt-in for agreements that demand it.
-
-### Separate test counters (optional)
-
-Skip this section unless a trading-partner agreement requires test traffic on an independent sequence. To opt in,
-configure the trading partner once, then seed and verify the lanes before sending test traffic. A seeded value is the
-last-used number, so the next allocation returns the seed plus one. To make the next ISA13 value 4601, seed 4600:
-
-```typescript
-import {
-  getControlNumberPolicy,
-  getCurrentControlNumber,
-  setControlNumber,
-  setControlNumberPolicy,
-} from '@ontemper/edi';
-
-const senderId = 'ZZ:SENDER';
-const receiverId = 'ZZ:RECEIVER';
-
-await setControlNumberPolicy(senderId, receiverId, { separateCounters: true });
-
-// Seed the production lane explicitly before it starts.
-await setControlNumber('ISA13', senderId, receiverId, 4600, 9, { lane: 'production' });
-
-const policy = await getControlNumberPolicy(senderId, receiverId);
-const production = await getCurrentControlNumber('ISA13', senderId, receiverId, 9, { lane: 'production' });
-const test = await getCurrentControlNumber('ISA13', senderId, receiverId, 9, { lane: 'test' });
-```
-
-`getControlNumberPolicy()` returns `configured` and `separateCounters`. After test traffic starts, you cannot turn
-separate counters off. `setControlNumberPolicy()` reports this as a `ControlNumberError` with the
-`counter_policy_locked` code.
+Each Temper environment now has its own ISA13 and GS06 counter ledger.
 
 ### Automatic environment routing
 
-The SDK reads `UNNBOUND_ENVIRONMENT` and sends it with counter operations only when its value is `sandbox`,
-`staging`, or `production`. The service selects the lane:
-
-| Policy | Production environment | Sandbox or staging |
-| --- | --- | --- |
-| No policy row | Production lane | Production lane |
-| `separateCounters: false` | Production lane | Production lane |
-| `separateCounters: true` | Production lane | Test lane |
+Automatic allocation reads `UNNBOUND_ENVIRONMENT`. Its value must be exactly `sandbox`, `staging`, or
+`production`. If the variable is missing or invalid, the SDK throws a `ControlNumberError` with the
+`control_number_environment_missing` code before making an HTTP request. This fail-closed behavior prevents an
+automatic allocation from using the wrong environment.
 
-Older SDK versions do not send the environment, so their operations use the production lane. This is the historical
-sequence that all environments use when separation is off. ISA15
-(`UsageIndicator_15`) never selects a counter. Set ISA15 independently to the value required by the interchange.
-`toX12()` does not change it.
+`getNextControlNumber()` and `toX12()` always use this ambient environment. ISA15 (`UsageIndicator_15`) does not
+select a counter, and `toX12()` does not change it.
 
 ### Manage counters directly
 
 ```typescript
 import { getCurrentControlNumber, getNextControlNumber, setControlNumber } from '@ontemper/edi';
 
-const next = await getNextControlNumber('ISA13', 'ZZ:SENDER', 'ZZ:RECEIVER');
-const current = await getCurrentControlNumber('ISA13', 'ZZ:SENDER', 'ZZ:RECEIVER');
-// The seed is last-used. To allocate 4601 next, seed 4600.
-await setControlNumber('ISA13', 'ZZ:SENDER', 'ZZ:RECEIVER', 4600, 9, { lane: 'production' });
+const senderId = 'ZZ:SENDER';
+const receiverId = 'ZZ:RECEIVER';
+
+const next = await getNextControlNumber('ISA13', senderId, receiverId);
+const current = await getCurrentControlNumber('ISA13', senderId, receiverId);
+
+// A sandbox onboarding workflow can inspect and seed the production ledger explicitly.
+const productionCurrent = await getCurrentControlNumber('ISA13', senderId, receiverId, 9, {
+  environment: 'production',
+});
+await setControlNumber('ISA13', senderId, receiverId, 4600, 9, {
+  environment: 'production',
+});
 ```
 
-Use the optional `{ lane: 'production' | 'test' }` argument on `getCurrentControlNumber()` and `setControlNumber()`
-to inspect or seed a specific lane. `getNextControlNumber()` always uses automatic environment routing and does not
-accept a lane.
+`getCurrentControlNumber()` and `setControlNumber()` accept an optional
+`{ environment: 'sandbox' | 'staging' | 'production' }` argument for cross-environment inspection and seeding.
+An explicit environment takes precedence over `UNNBOUND_ENVIRONMENT`. Without this option, both methods require
+the ambient environment. `getNextControlNumber()` accepts no environment override.
 
-The seeded value is the last-used number, and the next allocation returns the seed plus one. For example, if you
-expect the next ISA13 value to be 4601, seed 4600. Set this value before the counter increments. The service treats a
-repeated seed with the same stored value as an idempotent operation. It rejects other updates after the counter
-starts with a `ControlNumberError` whose code is `counter_already_started`.
+A seed is the last-used value: seeding 4600 makes the next allocation 4601. Seed a counter only before its first
+increment. A repeated seed with the same stored value is idempotent; a different seed after the counter starts
+throws a `ControlNumberError` with the `counter_already_started` code.
 
 These helpers require `UNNBOUND_API_URL`, which is preconfigured in workflow environments.
 

package/dist/control-numbers.d.ts

@@ -1,27 +1,13 @@
 /** @public */
-export type ControlNumberCounterName = 'ISA13' | 'GS06';
-/** @public */
-export type ControlNumberLane = 'production' | 'test';
-/** @public */
-export interface ControlNumberLaneOptions {
-    readonly lane?: ControlNumberLane;
-}
-/** @public */
-export interface SetControlNumberPolicyOptions {
-    readonly separateCounters: boolean;
-}
+export type TemperEnvironment = 'sandbox' | 'staging' | 'production';
 /** @public */
-export interface SetControlNumberPolicyResponse {
-    readonly tradingPartnerKey: string;
-    readonly separateCounters: boolean;
-}
+export type ControlNumberCounterName = 'ISA13' | 'GS06';
 /** @public */
-export interface GetControlNumberPolicyResponse {
-    readonly configured: boolean;
-    readonly separateCounters: boolean;
+export interface ControlNumberEnvironmentOptions {
+    readonly environment?: TemperEnvironment;
 }
 /** @public */
-export type ControlNumberErrorCode = 'counter_already_started' | 'counter_policy_locked' | 'control_number_bad_request' | 'control_number_unauthorized' | 'control_number_unknown_error';
+export type ControlNumberErrorCode = 'control_number_environment_missing' | 'counter_already_started' | 'control_number_bad_request' | 'control_number_unauthorized' | 'control_number_unknown_error';
 interface ControlNumberErrorOptions extends ErrorOptions {
     code: ControlNumberErrorCode;
     message: string;
@@ -50,14 +36,10 @@ export declare function getNextControlNumber(counterName: ControlNumberCounterNa
  * Get the current control number value without incrementing.
  */
 /** @public */
-export declare function getCurrentControlNumber(counterName: ControlNumberCounterName, senderId: string, receiverId: string, maxDigits?: number, options?: ControlNumberLaneOptions): Promise<string>;
+export declare function getCurrentControlNumber(counterName: ControlNumberCounterName, senderId: string, receiverId: string, maxDigits?: number, options?: ControlNumberEnvironmentOptions): Promise<string>;
 /**
  * Set a control number to a specific value before the counter starts (for migration/seeding).
  */
 /** @public */
-export declare function setControlNumber(counterName: ControlNumberCounterName, senderId: string, receiverId: string, value: number, maxDigits?: number, options?: ControlNumberLaneOptions): Promise<string>;
-/** @public */
-export declare function setControlNumberPolicy(senderId: string, receiverId: string, { separateCounters }: SetControlNumberPolicyOptions): Promise<SetControlNumberPolicyResponse>;
-/** @public */
-export declare function getControlNumberPolicy(senderId: string, receiverId: string): Promise<GetControlNumberPolicyResponse>;
+export declare function setControlNumber(counterName: ControlNumberCounterName, senderId: string, receiverId: string, value: number, maxDigits?: number, options?: ControlNumberEnvironmentOptions): Promise<string>;
 export {};

package/dist/control-numbers.js

@@ -37,8 +37,6 @@ exports.isControlNumberError = exports.ControlNumberError = void 0;
 exports.getNextControlNumber = getNextControlNumber;
 exports.getCurrentControlNumber = getCurrentControlNumber;
 exports.setControlNumber = setControlNumber;
-exports.setControlNumberPolicy = setControlNumberPolicy;
-exports.getControlNumberPolicy = getControlNumberPolicy;
 const axios_1 = __importStar(require("axios"));
 let _client = null;
 function getApiClient() {
@@ -80,23 +78,20 @@ exports.ControlNumberError = ControlNumberError;
 /** @public */
 const isControlNumberError = (error) => error instanceof ControlNumberError;
 exports.isControlNumberError = isControlNumberError;
-const getEnvironment = () => {
+const requireEnvironment = () => {
     const environment = process.env.UNNBOUND_ENVIRONMENT;
-    return environment === 'sandbox' || environment === 'staging' || environment === 'production'
-        ? environment
-        : undefined;
+    if (environment === 'sandbox' || environment === 'staging' || environment === 'production') {
+        return environment;
+    }
+    throw new ControlNumberError({
+        code: 'control_number_environment_missing',
+        message: "UNNBOUND_ENVIRONMENT must be set to 'sandbox', 'staging', or 'production' because automatic control-number routing needs it.",
+    });
 };
-function unwrapControlNumberError(error, operation) {
+function unwrapControlNumberError(error) {
     if (error instanceof ControlNumberError)
         throw error;
     if ((0, axios_1.isAxiosError)(error)) {
-        if (error.response?.status === 409 && operation === 'policy') {
-            throw new ControlNumberError({
-                code: 'counter_policy_locked',
-                message: 'Separate counters cannot be disabled after test traffic has started. Keep separate counters enabled or contact Temper support.',
-                cause: error,
-            });
-        }
         if (error.response?.status === 409) {
             throw new ControlNumberError({
                 code: 'counter_already_started',
@@ -125,9 +120,8 @@ function unwrapControlNumberError(error, operation) {
         cause: error,
     });
 }
-async function requestControlNumber(operation, input) {
-    const environment = getEnvironment();
-    const request = { ...input, ...(environment ? { environment } : {}) };
+async function requestControlNumber(operation, input, environment) {
+    const request = { ...input, environment: environment ?? requireEnvironment() };
     try {
         const response = operation === 'count'
             ? await getApiClient().get(`/api/v2/internal/edi/control-numbers/${operation}`, {
@@ -137,7 +131,7 @@ async function requestControlNumber(operation, input) {
         return response.data;
     }
     catch (error) {
-        return unwrapControlNumberError(error, operation);
+        return unwrapControlNumberError(error);
     }
 }
 /**
@@ -167,8 +161,7 @@ async function getCurrentControlNumber(counterName, senderId, receiverId, maxDig
     const data = await requestControlNumber('count', {
         tradingPartnerKey: `${senderId}:${receiverId}`,
         counterName,
-        ...(options?.lane ? { lane: options.lane } : {}),
-    });
+    }, options?.environment);
     return String(data.value).padStart(maxDigits, '0');
 }
 /**
@@ -180,35 +173,6 @@ async function setControlNumber(counterName, senderId, receiverId, value, maxDig
         tradingPartnerKey: `${senderId}:${receiverId}`,
         counterName,
         value,
-        ...(options?.lane ? { lane: options.lane } : {}),
-    });
+    }, options?.environment);
     return String(data.value).padStart(maxDigits, '0');
 }
-/** @public */
-async function setControlNumberPolicy(senderId, receiverId, { separateCounters }) {
-    try {
-        const response = await getApiClient().post('/api/v2/internal/edi/control-numbers/policy', {
-            tradingPartnerKey: `${senderId}:${receiverId}`,
-            separateCounters,
-        });
-        return response.data;
-    }
-    catch (error) {
-        return unwrapControlNumberError(error, 'policy');
-    }
-}
-/** @public */
-async function getControlNumberPolicy(senderId, receiverId) {
-    try {
-        const response = await getApiClient().get('/api/v2/internal/edi/control-numbers/policy', {
-            params: { tradingPartnerKey: `${senderId}:${receiverId}` },
-        });
-        return {
-            configured: response.data.configured,
-            separateCounters: response.data.separateCounters,
-        };
-    }
-    catch (error) {
-        return unwrapControlNumberError(error, 'policy');
-    }
-}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import type { X12Interchange } from './edination-client';
-export type { ControlNumberCounterName, ControlNumberErrorCode, ControlNumberLane, ControlNumberLaneOptions, GetControlNumberPolicyResponse, SetControlNumberPolicyOptions, SetControlNumberPolicyResponse, } from './control-numbers';
-export { ControlNumberError, getControlNumberPolicy, getCurrentControlNumber, getNextControlNumber, isControlNumberError, setControlNumber, setControlNumberPolicy, } from './control-numbers';
+export type { ControlNumberCounterName, ControlNumberEnvironmentOptions, ControlNumberErrorCode, } from './control-numbers';
+export { ControlNumberError, getCurrentControlNumber, getNextControlNumber, isControlNumberError, setControlNumber, } from './control-numbers';
 export * from './edination-client/model';
 interface UnnboundErrorOptions<C extends string = string> extends ErrorOptions {
     message: string;

package/dist/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemperEdiClient = exports.isEdiInfrastructureError = exports.EdiInfrastructureError = exports.isTemperEdiClientError = exports.TemperEdiClientError = exports.setControlNumberPolicy = exports.setControlNumber = exports.isControlNumberError = exports.getNextControlNumber = exports.getCurrentControlNumber = exports.getControlNumberPolicy = exports.ControlNumberError = void 0;
+exports.TemperEdiClient = exports.isEdiInfrastructureError = exports.EdiInfrastructureError = exports.isTemperEdiClientError = exports.TemperEdiClientError = exports.setControlNumber = exports.isControlNumberError = exports.getNextControlNumber = exports.getCurrentControlNumber = exports.ControlNumberError = void 0;
 const axios_1 = __importStar(require("axios"));
 const unnbound_logger_sdk_1 = require("unnbound-logger-sdk");
 const internal_1 = require("unnbound-logger-sdk/dist/internal");
@@ -44,12 +44,10 @@ const control_numbers_1 = require("./control-numbers");
 const edination_client_1 = require("./edination-client");
 var control_numbers_2 = require("./control-numbers");
 Object.defineProperty(exports, "ControlNumberError", { enumerable: true, get: function () { return control_numbers_2.ControlNumberError; } });
-Object.defineProperty(exports, "getControlNumberPolicy", { enumerable: true, get: function () { return control_numbers_2.getControlNumberPolicy; } });
 Object.defineProperty(exports, "getCurrentControlNumber", { enumerable: true, get: function () { return control_numbers_2.getCurrentControlNumber; } });
 Object.defineProperty(exports, "getNextControlNumber", { enumerable: true, get: function () { return control_numbers_2.getNextControlNumber; } });
 Object.defineProperty(exports, "isControlNumberError", { enumerable: true, get: function () { return control_numbers_2.isControlNumberError; } });
 Object.defineProperty(exports, "setControlNumber", { enumerable: true, get: function () { return control_numbers_2.setControlNumber; } });
-Object.defineProperty(exports, "setControlNumberPolicy", { enumerable: true, get: function () { return control_numbers_2.setControlNumberPolicy; } });
 __exportStar(require("./edination-client/model"), exports);
 class UnnboundError extends Error {
     code;
@@ -205,7 +203,9 @@ class TemperEdiClient {
             await this.stampControlNumbers(input);
         }
         catch (error) {
-            // Log but don't fail — workflows can still set control numbers manually
+            if (error instanceof control_numbers_1.ControlNumberError)
+                throw error;
+            // Workflows can still serialize documents whose control numbers were set manually.
             unnbound_logger_sdk_1.logger.warn({ err: error }, '[EDI SDK] Failed to auto-stamp control numbers, proceeding without');
         }
         return (0, unnbound_logger_sdk_1.startSpan)('JSON to X12', () => {

package/examples/node-edi.ts

@@ -1,5 +1,4 @@
 import { logger } from 'unnbound-logger-sdk';
-
 import { TemperEdiClient } from '../src';
 
 const run = async () => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ontemper/edi",
   "description": "An EDI client with structured logging.",
-  "version": "1.2.0-beta.2",
+  "version": "1.2.0-beta.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Unnbound Team",
@@ -37,8 +37,8 @@
     "build": "tsc",
     "test": "vitest run src",
     "typecheck": "tsc --noEmit",
-    "format": "biome format --write .",
-    "format:check": "biome format .",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt --check .",
     "start:example": "tsx watch examples/node-edi.ts",
     "version:bump": "npm version patch",
     "release": "pnpm run build && pnpm publish --access public",