diff --git a/.eslintrc.json b/.eslintrc.json
deleted file mode 100644
index c8b93e9..0000000
--- a/.eslintrc.json
+++ /dev/null
@@ -1,17 +0,0 @@
-{
- "extends": ["standard-with-typescript", "standard-jsdoc"],
- "parserOptions": {
- "project": "./tsconfig.json"
- },
- "rules": {
- "@typescript-eslint/strict-boolean-expressions": ["off"],
- "@typescript-eslint/no-this-alias": ["off"],
- "@typescript-eslint/prefer-includes": ["off"],
- "@typescript-eslint/restrict-template-expressions": ["off"],
- "@typescript-eslint/indent": ["off"],
- "jsdoc/require-property-description": ["off"]
- },
- "globals": {
- "mocha": "readonly"
- }
-}
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 8c3444c..d69775c 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,26 +1,20 @@
---
-name: Bug report
-about: Create a report to help us improve
-title: '[BUG]'
-labels: ''
-assignees: ''
----**Describe the bug**
-A clear and concise description of what the bug is.
+name: Bug report about: Create a report to help us improve title: '[BUG]'
+labels: '' assignees: '' ---**Describe the bug** A clear and concise description
+of what the bug is.
-**To Reproduce**
-Steps to reproduce the behavior:
+**To Reproduce** Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Expected behavior** A clear and concise description of what you expected to
+happen.
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots** If applicable, add screenshots to help explain your problem.
**Environment (please complete the following information):**
@@ -28,5 +22,4 @@ If applicable, add screenshots to help explain your problem.
- Version [e.g. 22]
- Executor [e.g. server, cloud]
-**Additional context**
-Add any other context about the problem here.
+**Additional context** Add any other context about the problem here.
diff --git a/.github/workflows/code_quality.yml b/.github/workflows/code_quality.yml
new file mode 100644
index 0000000..203edbb
--- /dev/null
+++ b/.github/workflows/code_quality.yml
@@ -0,0 +1,45 @@
+name: Run Code Quality
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - 'src/**/*.ts'
+ - 'mod.ts'
+ - 'deps.ts'
+ pull_request_target:
+ types:
+ - opened
+ - ready_for_review
+ branches:
+ - main
+ - prerelease
+ - release
+jobs:
+ cover:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ - name: Setup Deno
+ uses: denoland/setup-deno@v1
+ with:
+ deno-version: v1.x
+ - name: Setup Node (required for SonarCloud)
+ uses: actions/setup-node@v3
+ with:
+ node-version: '17.x'
+ registry-url: 'https://registry.npmjs.org'
+ - name: Setup LCOV
+ run: sudo apt install -y lcov
+ - name: Run tests and coverage
+ run: deno task cover
+ - name: Fix LCOV output for SonarCloud
+ run: sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage/report.lcov
+ - name: SonarCloud Scan
+ uses: SonarSource/sonarcloud-github-action@master
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 0000000..e6a5a65
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,90 @@
+name: Cut release
+on:
+ pull_request_target:
+ branches:
+ - prerelease
+ - release
+ types:
+ - closed
+env:
+ VERSION_FLAG: ''
+ VERSION_NUM: ''
+ VERSION_TAG: latest
+jobs:
+ release:
+ if: github.event.pull_request.merged
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v3
+ - name: Setup Deno
+ uses: denoland/setup-deno@v1
+ with:
+ deno-version: v1.x
+ - name: Setup Node (required for dnt)
+ uses: actions/setup-node@v3
+ with:
+ node-version: '17.x'
+ registry-url: 'https://registry.npmjs.org'
+ - name: Check major version
+ if: contains(github.event.pull_request.labels.*.name, 'version_major')
+ run: |
+ echo "VERSION_FLAG=major" >> $GITHUB_ENV
+ - name: Check minor version
+ if: contains(github.event.pull_request.labels.*.name, 'version_minor')
+ run: |
+ echo "VERSION_FLAG=minor" >> $GITHUB_ENV
+ - name: Check patch version
+ if: contains(github.event.pull_request.labels.*.name, 'version_patch')
+ run: |
+ echo "VERSION_FLAG=patch" >> $GITHUB_ENV
+ - name: Check premajor version
+ if: contains(github.event.pull_request.labels.*.name, 'version_premajor')
+ run: |
+ echo "VERSION_FLAG=premajor" >> $GITHUB_ENV
+ - name: Check preminor version
+ if: contains(github.event.pull_request.labels.*.name, 'version_preminor')
+ run: |
+ echo "VERSION_FLAG=preminor" >> $GITHUB_ENV
+ - name: Check prepatch version
+ if: contains(github.event.pull_request.labels.*.name, 'version_prepatch')
+ run: |
+ echo "VERSION_FLAG=prepatch" >> $GITHUB_ENV
+ - name: Check prerelease version
+ if: contains(github.event.pull_request.labels.*.name, 'version_prerelease')
+ run: |
+ echo "VERSION_FLAG=prerelease" >> $GITHUB_ENV
+ - name: Build for NPM using dnt
+ if: env.VERSION_FLAG != ''
+ run: |
+ deno task build -- --${{ env.VERSION_FLAG }}
+ echo "VERSION_NUM=$(cat .version)" >> $GITHUB_ENV
+ - name: Setup NPM tag
+ if: env.VERSION_FLAG == 'premajor' || env.VERSION_FLAG == 'preminor' || env.VERSION_FLAG == 'prepatch' || env.VERSION_FLAG == 'prerelease'
+ run: |
+ echo "VERSION_TAG=prerelease" >> $GITHUB_ENV
+ - name: Add NPMRC file
+ if: env.VERSION_FLAG != '' && env.VERSION_NUM != ''
+ run: |
+ echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ./npm/.npmrc
+ - name: Publish code to NPM
+ if: env.VERSION_FLAG != '' && env.VERSION_NUM != ''
+ run: |
+ cd ./npm
+ npm publish --tag=${{ env.VERSION_TAG }}
+ env:
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+ - name: Commit new version number to ${{ github.event.pull_request.base.ref }}
+ if: env.VERSION_FLAG != '' && env.VERSION_NUM != ''
+ uses: stefanzweifel/git-auto-commit-action@v4
+ with:
+ branch: ${{ github.event.pull_request.base.ref }}
+ tagging_message: ${{ env.VERSION_NUM }}
+ - name: Merge branch ${{ github.event.pull_request.base.ref }} into main
+ if: env.VERSION_FLAG != '' && env.VERSION_NUM != ''
+ uses: devmasx/merge-branch@1.4.0
+ with:
+ type: now
+ from_branch: ${{ github.event.pull_request.base.ref }}
+ target_branch: main
+ github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
index f1e0003..0b54e3f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,43 +1,15 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Directory used for nyc output
+npm/
+bower_components
+.scannerwork
.nyc_output
-
-# Coverage directory used by tools like istanbul
coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-*.tgz
-*.zip
-
-# Dependency directory
node_modules
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history
-
-# compiled typescript
-dist/**
-index.js
-index.d.ts
+dist
+esm
+es5
+
+cbor-js.zip
+cbor.min.js
+sauce_connect.log
+debug.log
+**/debug.log
\ No newline at end of file
diff --git a/.mocharc.json b/.mocharc.json
deleted file mode 100644
index 7008ee1..0000000
--- a/.mocharc.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "recursive": "./test",
- "extension": ["ts"],
- "require": ["ts-node/register", "source-map-support/register"],
- "reporter": ["spec"],
- "full-trace": true,
- "bail": true
-}
diff --git a/.nycrc.json b/.nycrc.json
deleted file mode 100644
index 3df9559..0000000
--- a/.nycrc.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "extends": "@istanbuljs/nyc-config-typescript",
- "all": true,
- "include": ["core.ts", "src/**"],
- "require": ["source-map-support/register"],
- "check-coverage": false,
- "reporter": "lcov"
-}
diff --git a/.prettierrc b/.prettierrc
deleted file mode 100644
index 963354f..0000000
--- a/.prettierrc
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "printWidth": 120
-}
diff --git a/.sonarcloud.properties b/.sonarcloud.properties
deleted file mode 100644
index eed40d6..0000000
--- a/.sonarcloud.properties
+++ /dev/null
@@ -1 +0,0 @@
-sonar.exclusions=test/*Suite.ts,gulpfile.js
\ No newline at end of file
diff --git a/.sonarcloud.ts.json b/.sonarcloud.ts.json
new file mode 100644
index 0000000..b066fc0
--- /dev/null
+++ b/.sonarcloud.ts.json
@@ -0,0 +1,14 @@
+{
+ "files": [
+ "mod.ts",
+ "src/**/*.ts"
+ ],
+ "include": [
+ "mod.ts",
+ "src/**"
+ ],
+ "exclude": [
+ "scripts/**",
+ "test/**"
+ ]
+}
diff --git a/.version b/.version
new file mode 100644
index 0000000..536af61
--- /dev/null
+++ b/.version
@@ -0,0 +1 @@
+1.8.0-1
\ No newline at end of file
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 81adc2b..73f04fa 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -6,5 +6,19 @@
"**/*.js": {
"when": "$(basename).ts"
}
+ },
+ "editor.tabSize": 2,
+ "deno.enable": true,
+ "deno.codeLens.test": true,
+ "deno.codeLens.testArgs": [
+ "--allow-all"
+ ],
+ "deno.lint": true,
+ "deno.suggest.autoImports": true,
+ "deno.suggest.imports.autoDiscover": true,
+ "deno.suggest.paths": true,
+ "deno.unstable": true,
+ "deno.suggest.imports.hosts": {
+ "https://deno.land": true
}
}
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 96e2f0a..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 TrueCommerce
-Copyright (c) 2019 Net Health Shops LLC
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE 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 AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS 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 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..272b6d4
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TrueCommerce Copyright (c) 2019 Net Health Shops LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE 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 AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS 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 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index 5e53468..3cb1041 100644
--- a/README.md
+++ b/README.md
@@ -1,43 +1,30 @@
# Node-X12
-An ASC X12 parser, generator, query engine, and mapper written for NodeJS. Parsing supports reading from streams to conserve resources in memory-intensive operations.
-
-[](https://github.com/standard/eslint-config-standard-with-typescript)
-[](https://codecov.io/gh/ahuggins-nhs/node-x12)
-
-
-string
- - [.toJSEDINotation()](#X12FatInterchange+toJSEDINotation) ⇒ Array.<JSEDINotation>
+ - [.toJSEDINotation()](#X12FatInterchange+toJSEDINotation) ⇒
+ Array.<JSEDINotation>
- [.toJSON()](#X12FatInterchange+toJSON) ⇒ Array.<object>
Serialize fat interchange to EDI string.
-**Kind**: instance method of [X12FatInterchange](#X12FatInterchange)
-**Returns**: string - This fat interchange converted to EDI string.
+**Kind**: instance method of
+[X12FatInterchange](#X12FatInterchange)\
+**Returns**: string - This fat interchange converted to EDI
+string.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | --------------------------------------------------- |
@@ -96,16 +99,20 @@
Serialize interchange to JS EDI Notation object.
-**Kind**: instance method of [X12FatInterchange](#X12FatInterchange)
-**Returns**: Array.<JSEDINotation> - This fat interchange converted to an array of JS EDI notation.
+**Kind**: instance method of
+[X12FatInterchange](#X12FatInterchange)\
+**Returns**: Array.<JSEDINotation> - This fat interchange
+converted to an array of JS EDI notation.
\
Array.<object>
Serialize interchange to JSON object.
-**Kind**: instance method of [X12FatInterchange](#X12FatInterchange)
-**Returns**: Array.<object> - This fat interchange converted to an array of objects.
+**Kind**: instance method of
+[X12FatInterchange](#X12FatInterchange)\
+**Returns**: Array.<object> - This fat interchange
+converted to an array of objects.
\
X12Transaction](#X12Transaction)
+ - [.addTransaction()](#X12FunctionalGroup+addTransaction) ⇒
+ [X12Transaction](#X12Transaction)
- [.toString([options])](#X12FunctionalGroup+toString) ⇒ string
- [.toJSON()](#X12FunctionalGroup+toJSON) ⇒ object
@@ -135,7 +143,8 @@
Set a GS header on this functional group.
-**Kind**: instance method of [X12FunctionalGroup](#X12FunctionalGroup)
+**Kind**: instance method of
+[X12FunctionalGroup](#X12FunctionalGroup)
| Param | Type | Description |
| -------- | --------------------------------- | -------------------------------------------- |
@@ -147,16 +156,20 @@
Add a transaction set to this functional group.
-**Kind**: instance method of [X12FunctionalGroup](#X12FunctionalGroup)
-**Returns**: [X12Transaction](#X12Transaction) - The transaction which was added to this functional group.
+**Kind**: instance method of
+[X12FunctionalGroup](#X12FunctionalGroup)\
+**Returns**: [X12Transaction](#X12Transaction) - The transaction
+which was added to this functional group.
\
string
Serialize functional group to EDI string.
-**Kind**: instance method of [X12FunctionalGroup](#X12FunctionalGroup)
-**Returns**: string - This functional group converted to EDI string.
+**Kind**: instance method of
+[X12FunctionalGroup](#X12FunctionalGroup)\
+**Returns**: string - This functional group converted to EDI
+string.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ------------------------------------------- |
@@ -168,8 +181,10 @@
Serialize functional group to JSON object.
-**Kind**: instance method of [X12FunctionalGroup](#X12FunctionalGroup)
-**Returns**: object - This functional group converted to an object.
+**Kind**: instance method of
+[X12FunctionalGroup](#X12FunctionalGroup)\
+**Returns**: object - This functional group converted to an
+object.
\
JSEDINotation
+ - [.getJSEDINotation()](#X12Generator+getJSEDINotation) ⇒
+ JSEDINotation
- [.setOptions([options])](#X12Generator+setOptions)
- - [.getOptions()](#X12Generator+getOptions) ⇒ [X12SerializationOptions](#X12SerializationOptions)
- - [.validate()](#X12Generator+validate) ⇒ [X12Interchange](#X12Interchange)
+ - [.getOptions()](#X12Generator+getOptions) ⇒
+ [X12SerializationOptions](#X12SerializationOptions)
+ - [.validate()](#X12Generator+validate) ⇒
+ [X12Interchange](#X12Interchange)
- [.toString()](#X12Generator+toString) ⇒ string
Get the JS EDI Notation for this instance.
-**Kind**: instance method of [X12Generator](#X12Generator)
-**Returns**: JSEDINotation - The JS EDI Notation for this instance.
+**Kind**: instance method of [X12Generator](#X12Generator)\
+**Returns**: JSEDINotation - The JS EDI Notation for this
+instance.
\
Get the serialization options for this instance.
-**Kind**: instance method of [X12Generator](#X12Generator)
-**Returns**: [X12SerializationOptions](#X12SerializationOptions) - The serialization options for this instance.
+**Kind**: instance method of [X12Generator](#X12Generator)\
+**Returns**: [X12SerializationOptions](#X12SerializationOptions) -
+
+The serialization options for this instance.
\
X12Interchange](#X12Interchange)
Validate the EDI in this instance.
-**Kind**: instance method of [X12Generator](#X12Generator)
-**Returns**: [X12Interchange](#X12Interchange) - This instance converted to an interchange.
+**Kind**: instance method of [X12Generator](#X12Generator)\
+**Returns**: [X12Interchange](#X12Interchange) - This instance
+converted to an interchange.
\
string
Serialize the EDI in this instance.
-**Kind**: instance method of [X12Generator](#X12Generator)
-**Returns**: string - This instance converted to an EDI string.
+**Kind**: instance method of [X12Generator](#X12Generator)\
+**Returns**: string - This instance converted to an EDI
+string.
\
X12FunctionalGroup](#X12FunctionalGroup)
+ - [.addFunctionalGroup([options])](#X12Interchange+addFunctionalGroup) ⇒
+ [X12FunctionalGroup](#X12FunctionalGroup)
- [.toString([options])](#X12Interchange+toString) ⇒ string
- - [.toJSEDINotation()](#X12Interchange+toJSEDINotation) ⇒ JSEDINotation
+ - [.toJSEDINotation()](#X12Interchange+toJSEDINotation) ⇒
+ JSEDINotation
- [.toJSON()](#X12Interchange+toJSON) ⇒ object
Add a functional group to this interchange.
-**Kind**: instance method of [X12Interchange](#X12Interchange)
-**Returns**: [X12FunctionalGroup](#X12FunctionalGroup) - The functional group added to this interchange.
+**Kind**: instance method of [X12Interchange](#X12Interchange)\
+**Returns**: [X12FunctionalGroup](#X12FunctionalGroup) - The
+functional group added to this interchange.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ------------------------------------------- |
@@ -309,8 +335,9 @@
Serialize interchange to EDI string.
-**Kind**: instance method of [X12Interchange](#X12Interchange)
-**Returns**: string - This interchange converted to an EDI string.
+**Kind**: instance method of [X12Interchange](#X12Interchange)\
+**Returns**: string - This interchange converted to an EDI
+string.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ------------------------------------------- |
@@ -322,16 +349,18 @@
Serialize interchange to JS EDI Notation object.
-**Kind**: instance method of [X12Interchange](#X12Interchange)
-**Returns**: JSEDINotation - This interchange converted to JS EDI Notation object.
+**Kind**: instance method of [X12Interchange](#X12Interchange)\
+**Returns**: JSEDINotation - This interchange converted to JS
+EDI Notation object.
\
object
Serialize interchange to JSON object.
-**Kind**: instance method of [X12Interchange](#X12Interchange)
-**Returns**: object - This interchange converted to an object.
+**Kind**: instance method of [X12Interchange](#X12Interchange)\
+**Returns**: object - This interchange converted to an
+object.
\
X12Interchange](#X12Interchange) \| [X12FatInterchange](#X12FatInterchange)
- - [.getInterchangeFromSegments(segments, [options])](#X12Parser+getInterchangeFromSegments) ⇒ [X12Interchange](#X12Interchange) \| [X12FatInterchange](#X12FatInterchange)
+ - [.parse(edi, [options])](#X12Parser+parse) ⇒
+ [X12Interchange](#X12Interchange) \|
+ [X12FatInterchange](#X12FatInterchange)
+ - [.getInterchangeFromSegments(segments, [options])](#X12Parser+getInterchangeFromSegments)
+ ⇒ [X12Interchange](#X12Interchange) \|
+ [X12FatInterchange](#X12FatInterchange)
- [.\_flush(callback)](#X12Parser+_flush)
- [.\_transform(chunk, encoding, callback)](#X12Parser+_transform)
@@ -363,8 +396,10 @@
Parse an EDI document.
-**Kind**: instance method of [X12Parser](#X12Parser)
-**Returns**: [X12Interchange](#X12Interchange) \| [X12FatInterchange](#X12FatInterchange) - An interchange or fat interchange.
+**Kind**: instance method of [X12Parser](#X12Parser)\
+**Returns**: [X12Interchange](#X12Interchange) \|
+[X12FatInterchange](#X12FatInterchange) - An interchange or fat
+interchange.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ----------------------------------------------- |
@@ -377,8 +412,10 @@
Method for processing an array of segments into the node-x12 object model; typically used with the finished output of a stream.
-**Kind**: instance method of [X12Parser](#X12Parser)
-**Returns**: [X12Interchange](#X12Interchange) \| [X12FatInterchange](#X12FatInterchange) - An interchange or fat interchange.
+**Kind**: instance method of [X12Parser](#X12Parser)\
+**Returns**: [X12Interchange](#X12Interchange) \|
+[X12FatInterchange](#X12FatInterchange) - An interchange or fat
+interchange.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ---------------------------------------- |
@@ -419,8 +456,10 @@
- [X12QueryEngine](#X12QueryEngine)
- [new X12QueryEngine([parser])](#new_X12QueryEngine_new)
- - [.query(rawEdi, reference, [defaultValue])](#X12QueryEngine+query) ⇒ [Array.<X12QueryResult>](#X12QueryResult)
- - [.querySingle(rawEdi, reference, [defaultValue])](#X12QueryEngine+querySingle) ⇒ [X12QueryResult](#X12QueryResult)
+ - [.query(rawEdi, reference, [defaultValue])](#X12QueryEngine+query) ⇒
+ [Array.<X12QueryResult>](#X12QueryResult)
+ - [.querySingle(rawEdi, reference, [defaultValue])](#X12QueryEngine+querySingle)
+ ⇒ [X12QueryResult](#X12QueryResult)
Query all references in an EDI document.
-**Kind**: instance method of [X12QueryEngine](#X12QueryEngine)
-**Returns**: [Array.<X12QueryResult>](#X12QueryResult) - An array of results from the EDI document.
+**Kind**: instance method of [X12QueryEngine](#X12QueryEngine)\
+**Returns**: [Array.<X12QueryResult>](#X12QueryResult) -
+
+An array of results from the EDI document.
| Param | Type | Default | Description |
| -------------- | --------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------ |
@@ -453,8 +494,9 @@
Query all references in an EDI document and return the first result.
-**Kind**: instance method of [X12QueryEngine](#X12QueryEngine)
-**Returns**: [X12QueryResult](#X12QueryResult) - A result from the EDI document.
+**Kind**: instance method of [X12QueryEngine](#X12QueryEngine)\
+**Returns**: [X12QueryResult](#X12QueryResult) - A result from
+the EDI document.
| Param | Type | Default | Description |
| -------------- | --------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------ |
@@ -472,11 +514,16 @@
- [new X12Segment(tag, [options])](#new_X12Segment_new)
- [.setTag(tag)](#X12Segment+setTag)
- [.setElements(values)](#X12Segment+setElements) ⇒ this
- - [.addElement(value)](#X12Segment+addElement) ⇒ [X12Element](#X12Element)
- - [.replaceElement(value, segmentPosition)](#X12Segment+replaceElement) ⇒ [X12Element](#X12Element)
- - [.insertElement(value, segmentPosition)](#X12Segment+insertElement) ⇒ [X12Element](#X12Element)
- - [.removeElement(segmentPosition)](#X12Segment+removeElement) ⇒ boolean
- - [.valueOf(segmentPosition, [defaultValue])](#X12Segment+valueOf) ⇒ string
+ - [.addElement(value)](#X12Segment+addElement) ⇒
+ [X12Element](#X12Element)
+ - [.replaceElement(value, segmentPosition)](#X12Segment+replaceElement) ⇒
+ [X12Element](#X12Element)
+ - [.insertElement(value, segmentPosition)](#X12Segment+insertElement) ⇒
+ [X12Element](#X12Element)
+ - [.removeElement(segmentPosition)](#X12Segment+removeElement) ⇒
+ boolean
+ - [.valueOf(segmentPosition, [defaultValue])](#X12Segment+valueOf) ⇒
+ string
- [.toString([options])](#X12Segment+toString) ⇒ string
- [.toJSON()](#X12Segment+toJSON) ⇒ object
@@ -509,7 +556,7 @@
Set the elements of this segment.
-**Kind**: instance method of [X12Segment](#X12Segment)
+**Kind**: instance method of [X12Segment](#X12Segment)\
**Returns**: this - The current instance of X12Segment.
| Param | Type | Description |
@@ -522,8 +569,9 @@
Add an element to this segment.
-**Kind**: instance method of [X12Segment](#X12Segment)
-**Returns**: [X12Element](#X12Element) - The element that was added to this segment.
+**Kind**: instance method of [X12Segment](#X12Segment)\
+**Returns**: [X12Element](#X12Element) - The element that was
+added to this segment.
| Param | Type | Description |
| ----- | ------------------- | ---------------------- |
@@ -535,8 +583,9 @@
Replace an element at a position in the segment.
-**Kind**: instance method of [X12Segment](#X12Segment)
-**Returns**: [X12Element](#X12Element) - The new element if successful, or a null if failed.
+**Kind**: instance method of [X12Segment](#X12Segment)\
+**Returns**: [X12Element](#X12Element) - The new element if
+successful, or a null if failed.
| Param | Type | Description |
| --------------- | ------------------- | --------------------------------------------------------------- |
@@ -549,8 +598,9 @@
Insert an element at a position in the segment.
-**Kind**: instance method of [X12Segment](#X12Segment)
-**Returns**: [X12Element](#X12Element) - The new element if successful, or a null if failed.
+**Kind**: instance method of [X12Segment](#X12Segment)\
+**Returns**: [X12Element](#X12Element) - The new element if
+successful, or a null if failed.
| Param | Type | Default | Description |
| --------------- | ------------------- | -------------- | --------------------------------------------------------------- |
@@ -563,7 +613,7 @@
Remove an element at a position in the segment.
-**Kind**: instance method of [X12Segment](#X12Segment)
+**Kind**: instance method of [X12Segment](#X12Segment)\
**Returns**: boolean - True if successful.
| Param | Type | Description |
@@ -576,8 +626,9 @@
Get the value of an element in this segment.
-**Kind**: instance method of [X12Segment](#X12Segment)
-**Returns**: string - If no element is at this position, null or the default value will be returned.
+**Kind**: instance method of [X12Segment](#X12Segment)\
+**Returns**: string - If no element is at this position, null or
+the default value will be returned.
| Param | Type | Description |
| --------------- | ------------------- | --------------------------------------------------------------- |
@@ -590,8 +641,9 @@
Serialize segment to EDI string.
-**Kind**: instance method of [X12Segment](#X12Segment)
-**Returns**: string - This segment converted to an EDI string.
+**Kind**: instance method of [X12Segment](#X12Segment)\
+**Returns**: string - This segment converted to an EDI
+string.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ------------------------------------------- |
@@ -603,15 +655,15 @@
Serialize transaction set to JSON object.
-**Kind**: instance method of [X12Segment](#X12Segment)
-**Returns**: object - This segment converted to an object.
+**Kind**: instance method of [X12Segment](#X12Segment)\
+**Returns**: object - This segment converted to an object.
\
Class instance wrapper for serialization options.
-**Kind**: global class
+**Kind**: global class\
X12Segment](#X12Segment)
+ - [.addSegment(tag, elements)](#X12Transaction+addSegment) ⇒
+ [X12Segment](#X12Segment)
- [.fromObject(input, map, [macro])](#X12Transaction+fromObject)
- [.toObject(map, helper)](#X12Transaction+toObject) ⇒ object
- [.toString([options])](#X12Transaction+toString) ⇒ string
@@ -655,8 +708,9 @@
Add a segment to this transaction set.
-**Kind**: instance method of [X12Transaction](#X12Transaction)
-**Returns**: [X12Segment](#X12Segment) - The segment added to this transaction set.
+**Kind**: instance method of [X12Transaction](#X12Transaction)\
+**Returns**: [X12Segment](#X12Segment) - The segment added to
+this transaction set.
| Param | Type | Description |
| -------- | --------------------------------- | --------------------------------------------- |
@@ -683,8 +737,9 @@
Map data from a transaction set to a javascript object.
-**Kind**: instance method of [X12Transaction](#X12Transaction)
-**Returns**: object - An object containing resolved values mapped to object keys.
+**Kind**: instance method of [X12Transaction](#X12Transaction)\
+**Returns**: object - An object containing resolved values
+mapped to object keys.
| Param | Type | Description |
| ------ | --------------------- | ------------------------------------------------------------------------------ |
@@ -697,8 +752,9 @@
Serialize transaction set to EDI string.
-**Kind**: instance method of [X12Transaction](#X12Transaction)
-**Returns**: string - This transaction set converted to an EDI string.
+**Kind**: instance method of [X12Transaction](#X12Transaction)\
+**Returns**: string - This transaction set converted to an EDI
+string.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ------------------------------------------- |
@@ -710,8 +766,9 @@
Serialize transaction set to JSON object.
-**Kind**: instance method of [X12Transaction](#X12Transaction)
-**Returns**: object - This transaction set converted to an object.
+**Kind**: instance method of [X12Transaction](#X12Transaction)\
+**Returns**: object - This transaction set converted to an
+object.
\
X12Transaction](#X12Transaction)
- - [.toObject([map], [callback])](#X12TransactionMap+toObject) ⇒ object \| Array.<object>
- - [.fromObject(input, [map], [macroObj])](#X12TransactionMap+fromObject) ⇒ [X12Transaction](#X12Transaction)
+ - [.getTransaction()](#X12TransactionMap+getTransaction) ⇒
+ [X12Transaction](#X12Transaction)
+ - [.toObject([map], [callback])](#X12TransactionMap+toObject) ⇒
+ object \| Array.<object>
+ - [.fromObject(input, [map], [macroObj])](#X12TransactionMap+fromObject) ⇒
+ [X12Transaction](#X12Transaction)
Set the transaction set to map and optionally a helper function.
-**Kind**: instance method of [X12TransactionMap](#X12TransactionMap)
+**Kind**: instance method of
+[X12TransactionMap](#X12TransactionMap)
| Param | Type | Description |
| ----------- | ---------------------------------------------- | ------------------------------------------------------------------------------ |
@@ -757,16 +818,20 @@
Set the transaction set to map and optionally a helper function.
-**Kind**: instance method of [X12TransactionMap](#X12TransactionMap)
-**Returns**: [X12Transaction](#X12Transaction) - The transaction from this instance.
+**Kind**: instance method of
+[X12TransactionMap](#X12TransactionMap)\
+**Returns**: [X12Transaction](#X12Transaction) - The transaction
+from this instance.
\
object \| Array.<object>
Map data from the transaction set to a javascript object.
-**Kind**: instance method of [X12TransactionMap](#X12TransactionMap)
-**Returns**: object \| Array.<object> - The transaction set mapped to an object or an array of objects.
+**Kind**: instance method of
+[X12TransactionMap](#X12TransactionMap)\
+**Returns**: object \| Array.<object> - The
+transaction set mapped to an object or an array of objects.
| Param | Type | Description |
| ---------- | --------------------- | ----------------------------------------------------------------------- |
@@ -779,8 +844,10 @@
Map data from a javascript object to the transaction set.
-**Kind**: instance method of [X12TransactionMap](#X12TransactionMap)
-**Returns**: [X12Transaction](#X12Transaction) - The transaction created from the object values.
+**Kind**: instance method of
+[X12TransactionMap](#X12TransactionMap)\
+**Returns**: [X12Transaction](#X12Transaction) - The transaction
+created from the object values.
| Param | Type | Default | Description |
| ---------- | ------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
@@ -794,8 +861,10 @@
Set default values for any missing X12SerializationOptions in an options object.
-**Kind**: global variable
-**Returns**: [X12SerializationOptions](#X12SerializationOptions) - Serialization options with defaults filled in.
+**Kind**: global variable\
+**Returns**: [X12SerializationOptions](#X12SerializationOptions) -
+
+Serialization options with defaults filled in.
| Param | Type | Description |
| --------- | ---------------------------------------------------------------- | ----------------------------------------------- |
@@ -807,7 +876,7 @@
A result as resolved by the query engine.
-**Kind**: global typedef
+**Kind**: global typedef\
**Properties**
| Name | Type | Default |
diff --git a/docs/JSEDINotation.md b/docs/JSEDINotation.md
index 4136bb0..b064722 100644
--- a/docs/JSEDINotation.md
+++ b/docs/JSEDINotation.md
@@ -1,14 +1,23 @@
## JavaScript EDI Notation
-Node-X12 defines a simplified hierarchical object model for EDI objects called **JavaScript EDI Notation**. This object model is used for generating valid EDI in the `X12Generator` class, and for calling `JSON.stringify` on members of the X12 object model. The major difference is that the X12 object model is a **complete** description of an EDI file, while this notation only retains the data necessary to exchange EDI to and from JSON.
+Node-X12 defines a simplified hierarchical object model for EDI objects called
+**JavaScript EDI Notation**. This object model is used for generating valid EDI
+in the `X12Generator` class, and for calling `JSON.stringify` on members of the
+X12 object model. The major difference is that the X12 object model is a
+**complete** description of an EDI file, while this notation only retains the
+data necessary to exchange EDI to and from JSON.
-A complete interface for this notation can be found at [src/JSEDINotation.ts](/src/JSEDINotation.ts).
+A complete interface for this notation can be found at
+[src/JSEDINotation.ts](/src/JSEDINotation.ts).
### Format
-Each level in the hierarchy has two properties. A container object will have two array properties. At the bottom level of the hierarchy are the segments of a transaction set; these segments have a tag and a string array.
+Each level in the hierarchy has two properties. A container object will have two
+array properties. At the bottom level of the hierarchy are the segments of a
+transaction set; these segments have a tag and a string array.
-The top level of the hierarchy also optionally allows to define the control characters.
+The top level of the hierarchy also optionally allows to define the control
+characters.
### Hierarchy
@@ -36,7 +45,8 @@ The hierarchy of JavaScript EDI Notation closely follows the X12 object model.
### ASC X12 Headers and Trailers
-The following ASC X12 headers are interpreted to and from headers in the hierarchy. Trailers are dynamically generated based on properties of the level.
+The following ASC X12 headers are interpreted to and from headers in the
+hierarchy. Trailers are dynamically generated based on properties of the level.
- ISA: Root level
- GS: FunctionalGroup level
@@ -75,7 +85,16 @@ A sample 856 generated from test [document](/test/test-data/856.edi).
},
"functionalGroups": [
{
- "header": ["SH", "4405197800", "999999999", "20111206", "1045", "49", "X", "004060"],
+ "header": [
+ "SH",
+ "4405197800",
+ "999999999",
+ "20111206",
+ "1045",
+ "49",
+ "X",
+ "004060"
+ ],
"transactions": [
{
"header": ["856", "0008"],
diff --git a/docs/QueryLanguage.md b/docs/QueryLanguage.md
index e4afebd..f78153a 100644
--- a/docs/QueryLanguage.md
+++ b/docs/QueryLanguage.md
@@ -1,10 +1,15 @@
# Query Language
-The query language makes it possible to directly select values from the class object model. This also drives the transaction mapping functionality; in fact, the `FOREACH()` macro was added specifically to support this feature.
+The query language makes it possible to directly select values from the class
+object model. This also drives the transaction mapping functionality; in fact,
+the `FOREACH()` macro was added specifically to support this feature.
## Basics
-The basic query functionality is extremely simple: provide an EDI document as a string or as an `X12Interchange` and query the object model of that document. EDI is not really an object model format; however, the parser takes the rules of the EDI spec and populates JavaScript class objects.
+The basic query functionality is extremely simple: provide an EDI document as a
+string or as an `X12Interchange` and query the object model of that document.
+EDI is not really an object model format; however, the parser takes the rules of
+the EDI spec and populates JavaScript class objects.
### Object Model
@@ -19,23 +24,36 @@ X12Interchange
┗╸ etc.
```
-The query engine will take raw EDI and convert it to an interchange, so it is always using this model.
+The query engine will take raw EDI and convert it to an interchange, so it is
+always using this model.
### Engine Behavior
-Due to the sequential nature of EDI, all look ups eventually are steps in an array. Although ASC X12 defines loops, the object model does not directly implement these loops. Therefore, the engine will actually step through each segment, checking the tag, and then attempting to return the value of the element at a specific psoition.
+Due to the sequential nature of EDI, all look ups eventually are steps in an
+array. Although ASC X12 defines loops, the object model does not directly
+implement these loops. Therefore, the engine will actually step through each
+segment, checking the tag, and then attempting to return the value of the
+element at a specific psoition.
When no element can be found for a particular query, no result will be returned.
### Reference Lookups
-References can be looked up using the tag name and position, using the traditional EDI reference name. In order to support parent-child segments, queries can refer to known values. When the known value of the reference is found, then each segment is stepped through to find the child segment.
+References can be looked up using the tag name and position, using the
+traditional EDI reference name. In order to support parent-child segments,
+queries can refer to known values. When the known value of the reference is
+found, then each segment is stepped through to find the child segment.
## Macros
-The query language has been extended with a concept of macros; the idea is that sometimes it is necessary to operate against more than one value at a time. This was especially relevant to how the `X12TransactionMap` class is designed, as it was necessary to be able to query for EDI loops.
+The query language has been extended with a concept of macros; the idea is that
+sometimes it is necessary to operate against more than one value at a time. This
+was especially relevant to how the `X12TransactionMap` class is designed, as it
+was necessary to be able to query for EDI loops.
-Macros cannot be nested. If a nested macro appears to work then consider it to be unreliable, subject to misbehavior and breaking changes in future API updates/bugfixes.
+Macros cannot be nested. If a nested macro appears to work then consider it to
+be unreliable, subject to misbehavior and breaking changes in future API
+updates/bugfixes.
### Supported Macros
@@ -54,17 +72,14 @@ Macros cannot be nested. If a nested macro appears to work then consider it to b
| **Element Reference** | `REF02` | Defines an element by position. |
| **Value** | `"DP"` | Defines a value to be checked when evaluating qualifiers.",
- "repository": {
- "type": "git",
- "url": "https://github.com/aaronhuggins/node-x12.git"
- },
- "eslintIgnore": [
- "typings/*"
- ],
- "scripts": {
- "test": "gulp test",
- "test:local": "gulp test:local",
- "tsc": "tsc",
- "prepack": "gulp compile",
- "postpack": "gulp clean"
- },
- "dependencies": {},
- "devDependencies": {
- "@babel/cli": "^7.17.6",
- "@babel/core": "^7.17.9",
- "@babel/plugin-proposal-class-properties": "^7.16.7",
- "@babel/preset-env": "^7.16.11",
- "@babel/preset-typescript": "^7.16.7",
- "@istanbuljs/nyc-config-typescript": "^1.0.2",
- "@types/mocha": "^9.1.1",
- "@types/node": "^17.0.25",
- "@typescript-eslint/eslint-plugin": "^5.20.0",
- "codecov": "^3.8.2",
- "del-cli": "^4.0.1",
- "dts-bundle-webpack": "^1.0.2",
- "eslint": "^8.13.0",
- "eslint-config-standard-jsdoc": "^9.3.0",
- "eslint-config-standard-with-typescript": "^21.0.1",
- "eslint-plugin-import": "^2.26.0",
- "eslint-plugin-jsdoc": "^39.2.7",
- "eslint-plugin-node": "^11.1.0",
- "eslint-plugin-promise": "^6.0.0",
- "eslint-plugin-standard": "^4.1.0",
- "gulp": "^4.0.2",
- "gulp-mocha": "^8.0.0",
- "gulp-shell": "^0.8.0",
- "gulp-zip": "^5.1.0",
- "jsdoc-babel": "^0.5.0",
- "jsdoc-to-markdown": "^7.1.1",
- "liquidjs": "^9.37.0",
- "mocha": "^9.2.2",
- "mocha-lcov-reporter": "^1.3.0",
- "nyc": "^15.1.0",
- "source-map-support": "^0.5.21",
- "ts-loader": "^9.2.8",
- "ts-node": "^10.7.0",
- "typescript": "^4.6.3",
- "webpack": "^5.72.0",
- "webpack-cli": "^4.9.2"
- }
-}
diff --git a/scripts/build_npm.ts b/scripts/build_npm.ts
new file mode 100644
index 0000000..4ad0dec
--- /dev/null
+++ b/scripts/build_npm.ts
@@ -0,0 +1,122 @@
+import {
+ parse,
+ ParseOptions,
+} from "https://deno.land/std@0.136.0/flags/mod.ts";
+import { copy } from "https://deno.land/std@0.136.0/fs/mod.ts";
+import { inc as increment } from "https://deno.land/x/semver@v1.4.0/mod.ts";
+import { build, emptyDir } from "https://deno.land/x/dnt@0.22.0/mod.ts";
+
+const NPM_NAME = "node-x12";
+
+await emptyDir("./npm");
+await copy("test/test-data", "npm/esm/test/test-data", { overwrite: true });
+await copy("test/test-data", "npm/script/test/test-data", { overwrite: true });
+
+function versionHandler(): string {
+ switch (true) {
+ case args.major:
+ return increment(version, "major") ?? version;
+ case args.minor:
+ return increment(version, "minor") ?? version;
+ case args.patch:
+ return increment(version, "patch") ?? version;
+ case args.premajor:
+ return increment(version, "premajor") ?? version;
+ case args.preminor:
+ return increment(version, "preminor") ?? version;
+ case args.prepatch:
+ return increment(version, "prepatch") ?? version;
+ case args.prerelease:
+ return increment(version, "prerelease") ?? version;
+ }
+
+ return version;
+}
+
+const versionFile = "./.version";
+const version = await Deno.readTextFile(versionFile);
+const argsOpts: ParseOptions = {
+ boolean: true,
+ default: {
+ major: false,
+ minor: false,
+ patch: false,
+ premajor: false,
+ preminor: false,
+ prepatch: false,
+ prerelease: false,
+ },
+};
+const args = parse(Deno.args, argsOpts);
+const newVersion = versionHandler();
+
+await build({
+ entryPoints: ["./mod.ts"],
+ outDir: "./npm",
+ shims: {
+ deno: true,
+ },
+ mappings: {
+ "https://deno.land/std@0.136.0/node/stream.ts": "stream",
+ "https://deno.land/std@0.136.0/node/string_decoder.ts": "string_decoder",
+ "https://deno.land/std@0.136.0/node/crypto.ts": "crypto",
+ "https://cdn.skypack.dev/pin/liquidjs@v9.37.0-dA2YkE2JlVe1VjIZ5g3G/mode=imports/optimized/liquidjs.js":
+ {
+ name: "liquidjs",
+ version: "^9.37.0",
+ },
+ },
+ package: {
+ name: NPM_NAME,
+ version: newVersion,
+ description:
+ "ASC X12 parser, generator, query engine, and mapper; now with support for streams.",
+ keywords: [
+ "x12",
+ "edi",
+ "ansi",
+ "asc",
+ "ecommerce",
+ ],
+ homepage: `https://github.com/aaronhuggins/${NPM_NAME}#readme`,
+ bugs: `https://github.com/aaronhuggins/${NPM_NAME}/issues`,
+ license: "MIT",
+ author: "Aaron Huggins ",
+ repository: {
+ type: "git",
+ url: `https://github.com/aaronhuggins/${NPM_NAME}.git`,
+ },
+ },
+});
+
+// post build steps
+class Appender {
+ encoder = new TextEncoder();
+ file: Promise;
+ constructor(file: string) {
+ this.file = Deno.open(file, { append: true });
+ }
+ async write(line: string) {
+ (await this.file).write(this.encoder.encode(line + "\n"));
+ }
+ async close() {
+ (await this.file).close();
+ }
+}
+
+const npmignore = new Appender("npm/.npmignore");
+await npmignore.write("esm/test/test-data/**");
+await npmignore.write("script/test/test-data/**");
+await npmignore.close();
+
+await Deno.copyFile("LICENSE.md", "npm/LICENSE.md");
+await Deno.copyFile("README.md", "npm/README.md");
+
+if (newVersion === version) {
+ console.log(
+ `[build_npm] Version did not change; nothing to deploy. ${NPM_NAME} v${version}`,
+ );
+} else {
+ await Deno.writeTextFile(versionFile, newVersion);
+ console.log(`[build_npm] ${NPM_NAME} v${newVersion} ready to deploy!`);
+}
diff --git a/scripts/create_labels.ts b/scripts/create_labels.ts
new file mode 100644
index 0000000..a576d89
--- /dev/null
+++ b/scripts/create_labels.ts
@@ -0,0 +1,42 @@
+const color = "17f384";
+const names = [
+ "version_major",
+ "version_minor",
+ "version_patch",
+ "version_premajor",
+ "version_preminor",
+ "version_prepatch",
+ "version_prerelease",
+];
+const GITHUB_TOKEN = Deno.env.get("GITHUB_TOKEN");
+const user = Deno.env.get("GITHUB_USER");
+const repo = Deno.env.get("GITHUB_REPO");
+
+console.log(`Creating labels for: ${user}/${repo}`);
+
+if (GITHUB_TOKEN) {
+ for (const name of names) {
+ const label = JSON.stringify({ name, color });
+ const response = await fetch(
+ `https://api.github.com/repos/${user}/${repo}/labels`,
+ {
+ method: "POST",
+ body: label,
+ headers: {
+ "content-type": "application/json",
+ "Authorization": `token ${GITHUB_TOKEN}`,
+ },
+ },
+ );
+
+ if (response.ok && response.status === 201) {
+ console.log(`Label success: ${label}`);
+ } else {
+ console.log(
+ `Label failed (status ${response.status} ${response.statusText}): ${label}`,
+ );
+ }
+ }
+} else {
+ console.log("Labels all failed: Github token empty");
+}
diff --git a/sonar-project.properties b/sonar-project.properties
new file mode 100644
index 0000000..51456de
--- /dev/null
+++ b/sonar-project.properties
@@ -0,0 +1,8 @@
+sonar.projectKey=aaronhuggins_node-x12
+sonar.organization=aaronhuggins
+sonar.source=src/**,mod.ts
+sonar.exclusions=scripts/**,test/**
+sonar.typescript.tsconfigPath=.sonarcloud.ts.json
+sonar.javascript.lcov.reportPaths=coverage/report.lcov
+sonar.pullrequest.provider=GitHub
+sonar.pullrequest.github.repository=aaronhuggins/node-x12
\ No newline at end of file
diff --git a/src/Errors.ts b/src/Errors.ts
index 82dd452..19a20d0 100644
--- a/src/Errors.ts
+++ b/src/Errors.ts
@@ -1,37 +1,37 @@
-'use strict'
+"use strict";
export class ArgumentNullError extends Error {
- constructor (argumentName: string) {
- super(`The argument, '${argumentName}', cannot be null.`)
- this.name = 'ArgumentNullError'
+ constructor(argumentName: string) {
+ super(`The argument, '${argumentName}', cannot be null.`);
+ this.name = "ArgumentNullError";
}
- name: string
+ name: string;
}
export class GeneratorError extends Error {
- constructor (message?: string) {
- super(message)
- this.name = 'GeneratorError'
+ constructor(message?: string) {
+ super(message);
+ this.name = "GeneratorError";
}
- name: string
+ name: string;
}
export class ParserError extends Error {
- constructor (message?: string) {
- super(message)
- this.name = 'ParserError'
+ constructor(message?: string) {
+ super(message);
+ this.name = "ParserError";
}
- name: string
+ name: string;
}
export class QuerySyntaxError extends Error {
- constructor (message?: string) {
- super(message)
- this.name = 'QuerySyntaxError'
+ constructor(message?: string) {
+ super(message);
+ this.name = "QuerySyntaxError";
}
- name: string
+ name: string;
}
diff --git a/src/JSEDINotation.ts b/src/JSEDINotation.ts
index 97523ae..beceb23 100644
--- a/src/JSEDINotation.ts
+++ b/src/JSEDINotation.ts
@@ -1,69 +1,69 @@
-'use strict'
+"use strict";
-import { X12SerializationOptions } from './X12SerializationOptions'
+import { X12SerializationOptions } from "./X12SerializationOptions.ts";
export class JSEDINotation {
- constructor (header?: string[], options?: X12SerializationOptions) {
- this.header = header === undefined ? new Array() : header
- this.options = options === undefined ? {} : options
- this.functionalGroups = new Array()
+ constructor(header?: string[], options?: X12SerializationOptions) {
+ this.header = header === undefined ? new Array() : header;
+ this.options = options === undefined ? {} : options;
+ this.functionalGroups = new Array();
}
- options?: X12SerializationOptions
- header: string[]
- functionalGroups: JSEDIFunctionalGroup[]
+ options?: X12SerializationOptions;
+ header: string[];
+ functionalGroups: JSEDIFunctionalGroup[];
- addFunctionalGroup (header: string[]): JSEDIFunctionalGroup {
- const functionalGroup = new JSEDIFunctionalGroup(header)
+ addFunctionalGroup(header: string[]): JSEDIFunctionalGroup {
+ const functionalGroup = new JSEDIFunctionalGroup(header);
- this.functionalGroups.push(functionalGroup)
+ this.functionalGroups.push(functionalGroup);
- return functionalGroup
+ return functionalGroup;
}
}
export class JSEDIFunctionalGroup {
- constructor (header?: string[]) {
- this.header = header === undefined ? new Array() : header
- this.transactions = new Array()
+ constructor(header?: string[]) {
+ this.header = header === undefined ? new Array() : header;
+ this.transactions = new Array();
}
- header: string[]
- transactions: JSEDITransaction[]
+ header: string[];
+ transactions: JSEDITransaction[];
- addTransaction (header: string[]): JSEDITransaction {
- const transaction = new JSEDITransaction(header)
+ addTransaction(header: string[]): JSEDITransaction {
+ const transaction = new JSEDITransaction(header);
- this.transactions.push(transaction)
+ this.transactions.push(transaction);
- return transaction
+ return transaction;
}
}
export class JSEDITransaction {
- constructor (header?: string[]) {
- this.header = header === undefined ? new Array() : header
- this.segments = new Array()
+ constructor(header?: string[]) {
+ this.header = header === undefined ? new Array() : header;
+ this.segments = new Array();
}
- header: string[]
- segments: JSEDISegment[]
+ header: string[];
+ segments: JSEDISegment[];
- addSegment (tag: string, elements: string[]): JSEDISegment {
- const segment = new JSEDISegment(tag, elements)
+ addSegment(tag: string, elements: string[]): JSEDISegment {
+ const segment = new JSEDISegment(tag, elements);
- this.segments.push(segment)
+ this.segments.push(segment);
- return segment
+ return segment;
}
}
export class JSEDISegment {
- constructor (tag: string, elements: string[]) {
- this.tag = tag
- this.elements = elements
+ constructor(tag: string, elements: string[]) {
+ this.tag = tag;
+ this.elements = elements;
}
- tag: string
- elements: string[]
+ tag: string;
+ elements: string[];
}
diff --git a/src/Positioning.ts b/src/Positioning.ts
index 89b46d0..8c69a57 100644
--- a/src/Positioning.ts
+++ b/src/Positioning.ts
@@ -1,30 +1,35 @@
-'use strict'
+"use strict";
export class Position {
- constructor (line?: number, character?: number) {
- if (typeof line === 'number' && typeof character === 'number') {
- this.line = line
- this.character = character
+ constructor(line?: number, character?: number) {
+ if (typeof line === "number" && typeof character === "number") {
+ this.line = line;
+ this.character = character;
}
}
- line: number
- character: number
+ line!: number;
+ character!: number;
}
export class Range {
- constructor (startLine?: number, startChar?: number, endLine?: number, endChar?: number) {
+ constructor(
+ startLine?: number,
+ startChar?: number,
+ endLine?: number,
+ endChar?: number,
+ ) {
if (
- typeof startLine === 'number' &&
- typeof startChar === 'number' &&
- typeof endLine === 'number' &&
- typeof endChar === 'number'
+ typeof startLine === "number" &&
+ typeof startChar === "number" &&
+ typeof endLine === "number" &&
+ typeof endChar === "number"
) {
- this.start = new Position(startLine, startChar)
- this.end = new Position(endLine, endChar)
+ this.start = new Position(startLine, startChar);
+ this.end = new Position(endLine, endChar);
}
}
- start: Position
- end: Position
+ start!: Position;
+ end!: Position;
}
diff --git a/src/X12Diagnostic.ts b/src/X12Diagnostic.ts
index a8b1999..cecb61f 100644
--- a/src/X12Diagnostic.ts
+++ b/src/X12Diagnostic.ts
@@ -1,21 +1,21 @@
-'use strict'
+"use strict";
-import { Range } from './Positioning'
+import { Range } from "./Positioning.ts";
export enum X12DiagnosticLevel {
Info = 0,
Warning = 1,
- Error = 2
+ Error = 2,
}
export class X12Diagnostic {
- constructor (level?: X12DiagnosticLevel, message?: string, range?: Range) {
- this.level = level === undefined ? X12DiagnosticLevel.Error : level
- this.message = message === undefined ? '' : message
- this.range = range
+ constructor(level?: X12DiagnosticLevel, message?: string, range?: Range) {
+ this.level = level === undefined ? X12DiagnosticLevel.Error : level;
+ this.message = message === undefined ? "" : message;
+ this.range = range ?? new Range();
}
- level: X12DiagnosticLevel
- message: string
- range: Range
+ level: X12DiagnosticLevel;
+ message: string;
+ range: Range;
}
diff --git a/src/X12Element.ts b/src/X12Element.ts
index 52e0a29..7a33c39 100644
--- a/src/X12Element.ts
+++ b/src/X12Element.ts
@@ -1,17 +1,17 @@
-'use strict'
+"use strict";
-import { Range } from './Positioning'
+import { Range } from "./Positioning.ts";
export class X12Element {
/**
* @description Create an element.
* @param {string} value - A value for this element.
*/
- constructor (value: string = '') {
- this.range = new Range()
- this.value = value
+ constructor(value: string = "") {
+ this.range = new Range();
+ this.value = value;
}
- range: Range
- value: string
+ range: Range;
+ value: string;
}
diff --git a/src/X12FatInterchange.ts b/src/X12FatInterchange.ts
index 2ed0e38..9d48fee 100644
--- a/src/X12FatInterchange.ts
+++ b/src/X12FatInterchange.ts
@@ -1,8 +1,12 @@
-'use strict'
+// deno-lint-ignore-file ban-types
+"use strict";
-import { JSEDINotation } from './JSEDINotation'
-import { X12Interchange } from './X12Interchange'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
+import { JSEDINotation } from "./JSEDINotation.ts";
+import { X12Interchange } from "./X12Interchange.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
export class X12FatInterchange extends Array {
/**
@@ -10,62 +14,67 @@ export class X12FatInterchange extends Array {
* @param {X12Interchange[] | X12SerializationOptions} [items] - The items for this array or options for this interchange.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- constructor (items?: X12Interchange[] | X12SerializationOptions, options?: X12SerializationOptions) {
+ constructor(
+ items?: X12Interchange[] | X12SerializationOptions,
+ options?: X12SerializationOptions,
+ ) {
+ super();
if (Array.isArray(items)) {
- super(...items)
+ super.push(...items);
} else {
- super()
- options = items
+ options = items;
}
- this.options = defaultSerializationOptions(options)
+ this.options = defaultSerializationOptions(options);
- this.interchanges = this
+ this.interchanges = this;
}
- interchanges: X12Interchange[]
- options: X12SerializationOptions
+ interchanges: X12Interchange[];
+ options: X12SerializationOptions;
/**
* @description Serialize fat interchange to EDI string.
* @param {X12SerializationOptions} [options] - Options to override serializing back to EDI.
* @returns {string} This fat interchange converted to EDI string.
*/
- toString (options?: X12SerializationOptions): string {
- options = options !== undefined ? defaultSerializationOptions(options) : this.options
+ toString(options?: X12SerializationOptions): string {
+ options = options !== undefined
+ ? defaultSerializationOptions(options)
+ : this.options;
- let edi = ''
+ let edi = "";
for (let i = 0; i < this.interchanges.length; i++) {
- edi += this.interchanges[i].toString(options)
+ edi += this.interchanges[i].toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
}
- return edi
+ return edi;
}
/**
* @description Serialize interchange to JS EDI Notation object.
* @returns {JSEDINotation[]} This fat interchange converted to an array of JS EDI notation.
*/
- toJSEDINotation (): JSEDINotation[] {
- const jsen = new Array()
+ toJSEDINotation(): JSEDINotation[] {
+ const jsen = new Array();
- this.interchanges.forEach(interchange => {
- jsen.push(interchange.toJSEDINotation())
- })
+ this.interchanges.forEach((interchange) => {
+ jsen.push(interchange.toJSEDINotation());
+ });
- return jsen
+ return jsen;
}
/**
* @description Serialize interchange to JSON object.
* @returns {object[]} This fat interchange converted to an array of objects.
*/
- toJSON (): object[] {
- return this.toJSEDINotation()
+ toJSON(): object[] {
+ return this.toJSEDINotation();
}
}
diff --git a/src/X12FunctionalGroup.ts b/src/X12FunctionalGroup.ts
index 7f5807c..ba785e9 100644
--- a/src/X12FunctionalGroup.ts
+++ b/src/X12FunctionalGroup.ts
@@ -1,52 +1,56 @@
-'use strict'
-
-import { JSEDIFunctionalGroup } from './JSEDINotation'
-import { X12Segment } from './X12Segment'
-import { GSSegmentHeader } from './X12SegmentHeader'
-import { X12Transaction } from './X12Transaction'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
+// deno-lint-ignore-file ban-types
+"use strict";
+
+import { JSEDIFunctionalGroup } from "./JSEDINotation.ts";
+import { X12Segment } from "./X12Segment.ts";
+import { GSSegmentHeader } from "./X12SegmentHeader.ts";
+import { X12Transaction } from "./X12Transaction.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
export class X12FunctionalGroup {
/**
* @description Create a functional group.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- constructor (options?: X12SerializationOptions) {
- this.transactions = new Array()
- this.options = defaultSerializationOptions(options)
+ constructor(options?: X12SerializationOptions) {
+ this.transactions = new Array();
+ this.options = defaultSerializationOptions(options);
}
- header: X12Segment
- trailer: X12Segment
+ header!: X12Segment;
+ trailer!: X12Segment;
- transactions: X12Transaction[]
+ transactions: X12Transaction[];
- options: X12SerializationOptions
+ options: X12SerializationOptions;
/**
* @description Set a GS header on this functional group.
* @param {string[]} elements - An array of elements for a GS header.
*/
- setHeader (elements: string[]): void {
- this.header = new X12Segment(GSSegmentHeader.tag, this.options)
+ setHeader(elements: string[]): void {
+ this.header = new X12Segment(GSSegmentHeader.tag, this.options);
- this.header.setElements(elements)
+ this.header.setElements(elements);
- this._setTrailer()
+ this._setTrailer();
}
/**
* @description Add a transaction set to this functional group.
* @returns {X12Transaction} The transaction which was added to this functional group.
*/
- addTransaction (): X12Transaction {
- const transaction = new X12Transaction(this.options)
+ addTransaction(): X12Transaction {
+ const transaction = new X12Transaction(this.options);
- this.transactions.push(transaction)
+ this.transactions.push(transaction);
- this.trailer.replaceElement(`${this.transactions.length}`, 1)
+ this.trailer.replaceElement(`${this.transactions.length}`, 1);
- return transaction
+ return transaction;
}
/**
@@ -54,56 +58,65 @@ export class X12FunctionalGroup {
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
* @returns {string} This functional group converted to EDI string.
*/
- toString (options?: X12SerializationOptions): string {
- options = options !== undefined ? defaultSerializationOptions(options) : this.options
+ toString(options?: X12SerializationOptions): string {
+ options = options !== undefined
+ ? defaultSerializationOptions(options)
+ : this.options;
- let edi = this.header.toString(options)
+ let edi = this.header.toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
for (let i = 0; i < this.transactions.length; i++) {
- edi += this.transactions[i].toString(options)
+ edi += this.transactions[i].toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
}
- edi += this.trailer.toString(options)
+ edi += this.trailer.toString(options);
- return edi
+ return edi;
}
/**
* @description Serialize functional group to JSON object.
* @returns {object} This functional group converted to an object.
*/
- toJSON (): object {
- const jsen = new JSEDIFunctionalGroup(this.header.elements.map(x => x.value))
+ toJSON(): object {
+ const jsen = new JSEDIFunctionalGroup(
+ this.header.elements.map((x) => x.value),
+ );
- this.transactions.forEach(transaction => {
- const jsenTransaction = jsen.addTransaction(transaction.header.elements.map(x => x.value))
+ this.transactions.forEach((transaction) => {
+ const jsenTransaction = jsen.addTransaction(
+ transaction.header.elements.map((x) => x.value),
+ );
- transaction.segments.forEach(segment => {
+ transaction.segments.forEach((segment) => {
jsenTransaction.addSegment(
segment.tag,
- segment.elements.map(x => x.value)
- )
- })
- })
+ segment.elements.map((x) => x.value),
+ );
+ });
+ });
- return jsen as object
+ return jsen as object;
}
/**
* @private
* @description Set a GE trailer on this functional group.
*/
- private _setTrailer (): void {
- this.trailer = new X12Segment(GSSegmentHeader.trailer, this.options)
+ private _setTrailer(): void {
+ this.trailer = new X12Segment(GSSegmentHeader.trailer, this.options);
- this.trailer.setElements([`${this.transactions.length}`, this.header.valueOf(6)])
+ this.trailer.setElements([
+ `${this.transactions.length}`,
+ this.header.valueOf(6) ?? "",
+ ]);
}
}
diff --git a/src/X12Generator.ts b/src/X12Generator.ts
index 1e44aa6..10a2116 100644
--- a/src/X12Generator.ts
+++ b/src/X12Generator.ts
@@ -1,9 +1,12 @@
-'use strict'
+"use strict";
-import { JSEDINotation } from './JSEDINotation'
-import { X12Interchange } from './X12Interchange'
-import { X12Parser } from './X12Parser'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
+import { JSEDINotation } from "./JSEDINotation.ts";
+import { X12Interchange } from "./X12Interchange.ts";
+import { X12Parser } from "./X12Parser.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
export class X12Generator {
/**
@@ -11,99 +14,102 @@ export class X12Generator {
* @param {JSEDINotation} [jsen] - Javascript EDI Notation object to serialize.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- constructor (jsen?: JSEDINotation, options?: X12SerializationOptions) {
- this.jsen = jsen === undefined ? new JSEDINotation() : jsen
-
- if (typeof jsen === 'object' && jsen.options !== undefined) {
- this.options = defaultSerializationOptions(jsen.options)
- }
-
- if (options !== undefined || this.options === undefined) {
- this.options = defaultSerializationOptions(options)
+ constructor(jsen?: JSEDINotation, options?: X12SerializationOptions) {
+ this.jsen = jsen === undefined ? new JSEDINotation() : jsen;
+
+ if (
+ typeof jsen === "object" && jsen.options !== undefined &&
+ options === undefined
+ ) {
+ this.options = defaultSerializationOptions(jsen.options);
+ } else {
+ this.options = defaultSerializationOptions(options);
}
- this.interchange = new X12Interchange(this.options)
+ this.interchange = new X12Interchange(this.options);
}
- private jsen: JSEDINotation
- private interchange: X12Interchange
- private options: X12SerializationOptions
+ private jsen: JSEDINotation;
+ private interchange: X12Interchange;
+ private options: X12SerializationOptions;
/**
* @description Set the JS EDI Notation for this instance.
* @param {JSEDINotation} [jsen] - Javascript EDI Notation object to serialize.
*/
- setJSEDINotation (jsen: JSEDINotation): void {
- this.jsen = jsen
+ setJSEDINotation(jsen: JSEDINotation): void {
+ this.jsen = jsen;
}
/**
* @description Get the JS EDI Notation for this instance.
* @returns {JSEDINotation} The JS EDI Notation for this instance.
*/
- getJSEDINotation (): JSEDINotation {
- return this.jsen
+ getJSEDINotation(): JSEDINotation {
+ return this.jsen;
}
/**
* @description Set the serialization options for this instance.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- setOptions (options: X12SerializationOptions): void {
- this.options = defaultSerializationOptions(options)
+ setOptions(options: X12SerializationOptions): void {
+ this.options = defaultSerializationOptions(options);
}
/**
* @description Get the serialization options for this instance.
* @returns {X12SerializationOptions} The serialization options for this instance.
*/
- getOptions (): X12SerializationOptions {
- return this.options
+ getOptions(): X12SerializationOptions {
+ return this.options;
}
/**
* @description Validate the EDI in this instance.
* @returns {X12Interchange} This instance converted to an interchange.
*/
- validate (): X12Interchange {
- this._generate()
+ validate(): X12Interchange {
+ this._generate();
- return new X12Parser(true).parse(this.interchange.toString(this.options)) as X12Interchange
+ return new X12Parser(true).parse(
+ this.interchange.toString(this.options),
+ ) as X12Interchange;
}
/**
* @description Serialize the EDI in this instance.
* @returns {string} This instance converted to an EDI string.
*/
- toString (): string {
- return this.validate().toString(this.options)
+ toString(): string {
+ return this.validate().toString(this.options);
}
/**
* @private
* @description Generate an interchange from the JS EDI Notation in this instance.
*/
- private _generate (): void {
- const genInterchange = new X12Interchange(this.options)
+ private _generate(): void {
+ const genInterchange = new X12Interchange(this.options);
- genInterchange.setHeader(this.jsen.header)
+ genInterchange.setHeader(this.jsen.header);
- this.jsen.functionalGroups.forEach(functionalGroup => {
- const genFunctionalGroup = genInterchange.addFunctionalGroup()
+ this.jsen.functionalGroups.forEach((functionalGroup) => {
+ const genFunctionalGroup = genInterchange.addFunctionalGroup();
- genFunctionalGroup.setHeader(functionalGroup.header)
+ genFunctionalGroup.setHeader(functionalGroup.header);
- functionalGroup.transactions.forEach(transaction => {
- const genTransaction = genFunctionalGroup.addTransaction()
+ functionalGroup.transactions.forEach((transaction) => {
+ const genTransaction = genFunctionalGroup.addTransaction();
- genTransaction.setHeader(transaction.header)
+ genTransaction.setHeader(transaction.header);
- transaction.segments.forEach(segment => {
- genTransaction.addSegment(segment.tag, segment.elements)
- })
- })
- })
+ transaction.segments.forEach((segment) => {
+ genTransaction.addSegment(segment.tag, segment.elements);
+ });
+ });
+ });
- this.interchange = genInterchange
+ this.interchange = genInterchange;
}
}
diff --git a/src/X12Interchange.ts b/src/X12Interchange.ts
index 868cb19..879e14c 100644
--- a/src/X12Interchange.ts
+++ b/src/X12Interchange.ts
@@ -1,10 +1,14 @@
-'use strict'
-
-import { JSEDINotation } from './JSEDINotation'
-import { X12FunctionalGroup } from './X12FunctionalGroup'
-import { X12Segment } from './X12Segment'
-import { ISASegmentHeader } from './X12SegmentHeader'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
+// deno-lint-ignore-file ban-types
+"use strict";
+
+import { JSEDINotation } from "./JSEDINotation.ts";
+import { X12FunctionalGroup } from "./X12FunctionalGroup.ts";
+import { X12Segment } from "./X12Segment.ts";
+import { ISASegmentHeader } from "./X12SegmentHeader.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
export class X12Interchange {
/**
@@ -13,50 +17,53 @@ export class X12Interchange {
* @param {string} [elementDelimiter] - A character to separate elements when serializing; only required when segmentTerminator is a character.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- constructor (
+ constructor(
segmentTerminator?: string | X12SerializationOptions,
elementDelimiter?: string,
- options?: X12SerializationOptions
+ options?: X12SerializationOptions,
) {
- this.functionalGroups = new Array()
+ this.functionalGroups = new Array();
- if (typeof segmentTerminator === 'string') {
- this.segmentTerminator = segmentTerminator
- if (typeof elementDelimiter === 'string') {
- this.elementDelimiter = elementDelimiter
+ if (typeof segmentTerminator === "string") {
+ this.segmentTerminator = segmentTerminator;
+ if (typeof elementDelimiter === "string") {
+ this.elementDelimiter = elementDelimiter;
} else {
- throw new TypeError('Parameter "elementDelimiter" must be type of string.')
+ throw new TypeError(
+ 'Parameter "elementDelimiter" must be type of string.',
+ );
}
+ this.options = defaultSerializationOptions(options);
+ } else if (typeof segmentTerminator === "object") {
+ this.options = defaultSerializationOptions(segmentTerminator);
+ this.segmentTerminator = this.options.segmentTerminator as string;
+ this.elementDelimiter = this.options.elementDelimiter as string;
} else {
- this.options = defaultSerializationOptions(segmentTerminator)
- this.segmentTerminator = this.options.segmentTerminator
- this.elementDelimiter = this.options.elementDelimiter
- }
-
- if (this.options === undefined) {
- this.options = defaultSerializationOptions(options)
+ this.options = defaultSerializationOptions(options);
+ this.segmentTerminator = this.options.segmentTerminator as string;
+ this.elementDelimiter = this.options.elementDelimiter as string;
}
}
- header: X12Segment
- trailer: X12Segment
+ header!: X12Segment;
+ trailer!: X12Segment;
- functionalGroups: X12FunctionalGroup[]
+ functionalGroups: X12FunctionalGroup[];
- segmentTerminator: string
- elementDelimiter: string
- options: X12SerializationOptions
+ segmentTerminator: string;
+ elementDelimiter: string;
+ options: X12SerializationOptions;
/**
* @description Set an ISA header on this interchange.
* @param {string[]} elements - An array of elements for an ISA header.
*/
- setHeader (elements: string[]): void {
- this.header = new X12Segment(ISASegmentHeader.tag, this.options)
+ setHeader(elements: string[]): void {
+ this.header = new X12Segment(ISASegmentHeader.tag, this.options);
- this.header.setElements(elements)
+ this.header.setElements(elements);
- this._setTrailer()
+ this._setTrailer();
}
/**
@@ -64,16 +71,18 @@ export class X12Interchange {
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
* @returns {X12FunctionalGroup} The functional group added to this interchange.
*/
- addFunctionalGroup (options?: X12SerializationOptions): X12FunctionalGroup {
- options = options !== undefined ? defaultSerializationOptions(options) : this.options
+ addFunctionalGroup(options?: X12SerializationOptions): X12FunctionalGroup {
+ options = options !== undefined
+ ? defaultSerializationOptions(options)
+ : this.options;
- const functionalGroup = new X12FunctionalGroup(options)
+ const functionalGroup = new X12FunctionalGroup(options);
- this.functionalGroups.push(functionalGroup)
+ this.functionalGroups.push(functionalGroup);
- this.trailer.replaceElement(`${this.functionalGroups.length}`, 1)
+ this.trailer.replaceElement(`${this.functionalGroups.length}`, 1);
- return functionalGroup
+ return functionalGroup;
}
/**
@@ -81,71 +90,80 @@ export class X12Interchange {
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
* @returns {string} This interchange converted to an EDI string.
*/
- toString (options?: X12SerializationOptions): string {
- options = options !== undefined ? defaultSerializationOptions(options) : this.options
+ toString(options?: X12SerializationOptions): string {
+ options = options !== undefined
+ ? defaultSerializationOptions(options)
+ : this.options;
- let edi = this.header.toString(options)
+ let edi = this.header.toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
for (let i = 0; i < this.functionalGroups.length; i++) {
- edi += this.functionalGroups[i].toString(options)
+ edi += this.functionalGroups[i].toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
}
- edi += this.trailer.toString(options)
+ edi += this.trailer.toString(options);
- return edi
+ return edi;
}
/**
* @description Serialize interchange to JS EDI Notation object.
* @returns {JSEDINotation} This interchange converted to JS EDI Notation object.
*/
- toJSEDINotation (): JSEDINotation {
+ toJSEDINotation(): JSEDINotation {
const jsen = new JSEDINotation(
- this.header.elements.map(x => x.value.trim()),
- this.options
- )
+ this.header.elements.map((x) => x.value.trim()),
+ this.options,
+ );
- this.functionalGroups.forEach(functionalGroup => {
- const jsenFunctionalGroup = jsen.addFunctionalGroup(functionalGroup.header.elements.map(x => x.value))
+ this.functionalGroups.forEach((functionalGroup) => {
+ const jsenFunctionalGroup = jsen.addFunctionalGroup(
+ functionalGroup.header.elements.map((x) => x.value),
+ );
- functionalGroup.transactions.forEach(transaction => {
- const jsenTransaction = jsenFunctionalGroup.addTransaction(transaction.header.elements.map(x => x.value))
+ functionalGroup.transactions.forEach((transaction) => {
+ const jsenTransaction = jsenFunctionalGroup.addTransaction(
+ transaction.header.elements.map((x) => x.value),
+ );
- transaction.segments.forEach(segment => {
+ transaction.segments.forEach((segment) => {
jsenTransaction.addSegment(
segment.tag,
- segment.elements.map(x => x.value)
- )
- })
- })
- })
+ segment.elements.map((x) => x.value),
+ );
+ });
+ });
+ });
- return jsen
+ return jsen;
}
/**
* @description Serialize interchange to JSON object.
* @returns {object} This interchange converted to an object.
*/
- toJSON (): object {
- return this.toJSEDINotation() as object
+ toJSON(): object {
+ return this.toJSEDINotation() as object;
}
/**
* @private
* @description Set an ISA trailer on this interchange.
*/
- private _setTrailer (): void {
- this.trailer = new X12Segment(ISASegmentHeader.trailer, this.options)
+ private _setTrailer(): void {
+ this.trailer = new X12Segment(ISASegmentHeader.trailer, this.options);
- this.trailer.setElements([`${this.functionalGroups.length}`, this.header.valueOf(13)])
+ this.trailer.setElements([
+ `${this.functionalGroups.length}`,
+ this.header.valueOf(13) ?? "",
+ ]);
}
}
diff --git a/src/X12Parser.ts b/src/X12Parser.ts
index efd8f8f..40b500c 100644
--- a/src/X12Parser.ts
+++ b/src/X12Parser.ts
@@ -1,24 +1,27 @@
-'use strict'
-
-import { Transform } from 'stream'
-import { StringDecoder } from 'string_decoder'
-import { ArgumentNullError, ParserError } from './Errors'
-import { Range, Position } from './Positioning'
-import { X12Diagnostic, X12DiagnosticLevel } from './X12Diagnostic'
-import { X12FatInterchange } from './X12FatInterchange'
-import { X12Interchange } from './X12Interchange'
-import { X12FunctionalGroup } from './X12FunctionalGroup'
-import { X12Transaction } from './X12Transaction'
-import { X12Segment } from './X12Segment'
-import { X12Element } from './X12Element'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
-
-const DOCUMENT_MIN_LENGTH: number = 113 // ISA = 106, IEA > 7
-const SEGMENT_TERMINATOR_POS: number = 105
-const END_OF_LINE_POS: number = 106
-const ELEMENT_DELIMITER_POS: number = 3
-const SUBELEMENT_DELIMITER_POS: number = 104
-const REPETITION_DELIMITER_POS: number = 82
+// deno-lint-ignore-file no-inferrable-types no-explicit-any ban-types
+"use strict";
+
+import { StringDecoder, Transform } from "../deps.ts";
+import { ArgumentNullError, ParserError } from "./Errors.ts";
+import { Position, Range } from "./Positioning.ts";
+import { X12Diagnostic, X12DiagnosticLevel } from "./X12Diagnostic.ts";
+import { X12FatInterchange } from "./X12FatInterchange.ts";
+import { X12Interchange } from "./X12Interchange.ts";
+import { X12FunctionalGroup } from "./X12FunctionalGroup.ts";
+import { X12Transaction } from "./X12Transaction.ts";
+import { X12Segment } from "./X12Segment.ts";
+import { X12Element } from "./X12Element.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
+
+const DOCUMENT_MIN_LENGTH: number = 113; // ISA = 106, IEA > 7
+const SEGMENT_TERMINATOR_POS: number = 105;
+const END_OF_LINE_POS: number = 106;
+const ELEMENT_DELIMITER_POS: number = 3;
+const SUBELEMENT_DELIMITER_POS: number = 104;
+const REPETITION_DELIMITER_POS: number = 82;
// Legacy note: const INTERCHANGE_CACHE_SIZE: number = 10
export class X12Parser extends Transform {
@@ -28,51 +31,51 @@ export class X12Parser extends Transform {
* @param {string|X12SerializationOptions} [encoding] - The encoding to use for this instance when parsing a stream; defaults to UTF-8.
* @param {X12SerializationOptions} [options] - The options to use when parsing a stream.
*/
- constructor (
+ constructor(
strict?: boolean | X12SerializationOptions,
- encoding?: 'ascii' | 'utf8' | X12SerializationOptions,
- options?: X12SerializationOptions
+ encoding?: "ascii" | "utf8" | X12SerializationOptions,
+ options?: X12SerializationOptions,
) {
if (strict === undefined) {
- strict = false
- } else if (typeof strict !== 'boolean') {
- options = strict
- strict = false
+ strict = false;
+ } else if (typeof strict !== "boolean") {
+ options = strict;
+ strict = false;
}
if (encoding === undefined) {
- encoding = 'utf8'
- } else if (typeof encoding !== 'string') {
- options = encoding
- encoding = 'utf8'
+ encoding = "utf8";
+ } else if (typeof encoding !== "string") {
+ options = encoding;
+ encoding = "utf8";
}
super({
readableObjectMode: true,
writableObjectMode: true,
objectMode: true,
- defaultEncoding: encoding
- })
- this.diagnostics = new Array()
- this._strict = strict
- this._options = options
- this._decoder = new StringDecoder(encoding)
- this._parsedISA = false
- this._flushing = false
- this._dataCache = ''
- this._segmentCounter = 0
+ defaultEncoding: encoding,
+ });
+ this.diagnostics = new Array();
+ this._strict = strict;
+ this._options = options as any;
+ this._decoder = new StringDecoder(encoding);
+ this._parsedISA = false;
+ this._flushing = false;
+ this._dataCache = "";
+ this._segmentCounter = 0;
}
- private readonly _strict: boolean
- private readonly _decoder: StringDecoder
- private _options: X12SerializationOptions
- private _dataCache: string
- private _parsedISA: boolean
- private _flushing: boolean
- private _fatInterchange: X12FatInterchange
- private _interchange: X12Interchange
- private _group: X12FunctionalGroup
- private _transaction: X12Transaction
- private _segmentCounter: number
- diagnostics: X12Diagnostic[]
+ private readonly _strict: boolean;
+ private readonly _decoder: StringDecoder;
+ private _options: Required;
+ private _dataCache: string;
+ private _parsedISA: boolean;
+ private _flushing: boolean;
+ private _fatInterchange!: X12FatInterchange;
+ private _interchange!: X12Interchange;
+ private _group!: X12FunctionalGroup;
+ private _transaction!: X12Transaction;
+ private _segmentCounter: number;
+ diagnostics: X12Diagnostic[];
/**
* @description Parse an EDI document.
@@ -80,30 +83,39 @@ export class X12Parser extends Transform {
* @param {X12SerializationOptions} [options] - Options for serializing from EDI.
* @returns {X12Interchange|X12FatInterchange} An interchange or fat interchange.
*/
- parse (edi: string, options?: X12SerializationOptions): X12Interchange | X12FatInterchange {
+ parse(
+ edi: string,
+ options?: X12SerializationOptions,
+ ): X12Interchange | X12FatInterchange {
if (edi === undefined) {
- throw new ArgumentNullError('edi')
+ throw new ArgumentNullError("edi");
}
- this.diagnostics.splice(0)
+ this.diagnostics.splice(0);
- this._validateEdiLength(edi)
+ this._validateEdiLength(edi);
- this._detectOptions(edi, options)
+ this._detectOptions(edi, options);
- this._validateIsaLength(edi, this._options.elementDelimiter)
+ this._validateIsaLength(edi, this._options.elementDelimiter);
- const segments = this._parseSegments(edi, this._options.segmentTerminator, this._options.elementDelimiter)
+ const segments = this._parseSegments(
+ edi,
+ this._options.segmentTerminator,
+ this._options.elementDelimiter,
+ );
if (segments.length > 2) {
- segments.forEach(segment => {
- this._processSegment(segment)
- })
+ segments.forEach((segment) => {
+ this._processSegment(segment);
+ });
} else {
- this._validateEdiSegmentCount()
+ this._validateEdiSegmentCount();
}
- return this._fatInterchange === undefined ? this._interchange : this._fatInterchange
+ return this._fatInterchange === undefined
+ ? this._interchange
+ : this._fatInterchange;
}
/**
@@ -112,74 +124,95 @@ export class X12Parser extends Transform {
* @param {X12SerializationOptions} [options] - Options for serializing from EDI.
* @returns {X12Interchange|X12FatInterchange} An interchange or fat interchange.
*/
- getInterchangeFromSegments (
+ getInterchangeFromSegments(
segments: X12Segment[],
- options?: X12SerializationOptions
+ options?: X12SerializationOptions,
): X12Interchange | X12FatInterchange {
- this._options = options === undefined ? this._options : defaultSerializationOptions(options)
+ this._options = options === undefined
+ ? this._options
+ : defaultSerializationOptions(options) as any;
- segments.forEach(segment => {
- this._processSegment(segment)
- })
+ segments.forEach((segment) => {
+ this._processSegment(segment);
+ });
- return this._fatInterchange === undefined ? this._interchange : this._fatInterchange
+ return this._fatInterchange === undefined
+ ? this._interchange
+ : this._fatInterchange;
}
- private _validateEdiSegmentCount (): void {
+ private _validateEdiSegmentCount(): void {
const errorMessage =
- 'X12 Standard: An EDI document must contain at least one functional group; verify the document contains valid control characters.'
+ "X12 Standard: An EDI document must contain at least one functional group; verify the document contains valid control characters.";
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, new Range(0, 0, 0, 1)))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ new Range(0, 0, 0, 1),
+ ),
+ );
}
- private _validateEdiLength (edi: string): void {
+ private _validateEdiLength(edi: string): void {
if (edi.length < DOCUMENT_MIN_LENGTH) {
- const errorMessage = `X12 Standard: Document is too short. Document must be at least ${DOCUMENT_MIN_LENGTH} characters long to be well-formed X12.`
+ const errorMessage =
+ `X12 Standard: Document is too short. Document must be at least ${DOCUMENT_MIN_LENGTH} characters long to be well-formed X12.`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
this.diagnostics.push(
- new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, new Range(0, 0, 0, edi.length - 1))
- )
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ new Range(0, 0, 0, edi.length - 1),
+ ),
+ );
}
}
- private _validateIsaLength (edi: string, elementDelimiter: string): void {
+ private _validateIsaLength(edi: string, elementDelimiter: string): void {
if (edi.charAt(103) !== elementDelimiter) {
const errorMessage =
- 'X12 Standard: The ISA segment is not the correct length (106 characters, including segment terminator).'
+ "X12 Standard: The ISA segment is not the correct length (106 characters, including segment terminator).";
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, new Range(0, 0, 0, 2)))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ new Range(0, 0, 0, 2),
+ ),
+ );
}
}
- private _detectOptions (edi: string, options?: X12SerializationOptions): void {
- const segmentTerminator = edi.charAt(SEGMENT_TERMINATOR_POS)
- const elementDelimiter = edi.charAt(ELEMENT_DELIMITER_POS)
- const subElementDelimiter = edi.charAt(SUBELEMENT_DELIMITER_POS)
- const repetitionDelimiter = edi.charAt(REPETITION_DELIMITER_POS)
- let endOfLine = edi.charAt(END_OF_LINE_POS)
- let format = false
+ private _detectOptions(edi: string, options?: X12SerializationOptions): void {
+ const segmentTerminator = edi.charAt(SEGMENT_TERMINATOR_POS);
+ const elementDelimiter = edi.charAt(ELEMENT_DELIMITER_POS);
+ const subElementDelimiter = edi.charAt(SUBELEMENT_DELIMITER_POS);
+ const repetitionDelimiter = edi.charAt(REPETITION_DELIMITER_POS);
+ let endOfLine: string | undefined = edi.charAt(END_OF_LINE_POS);
+ let format = false;
if (options === undefined) {
- if (endOfLine !== '\r' && endOfLine !== '\n') {
- endOfLine = undefined
+ if (endOfLine !== "\r" && endOfLine !== "\n") {
+ endOfLine = undefined;
} else {
- format = true
+ format = true;
}
- if (endOfLine === '\r' && edi.charAt(END_OF_LINE_POS + 1) === '\n') {
- endOfLine = '\r\n'
+ if (endOfLine === "\r" && edi.charAt(END_OF_LINE_POS + 1) === "\n") {
+ endOfLine = "\r\n";
}
this._options = defaultSerializationOptions({
@@ -188,314 +221,401 @@ export class X12Parser extends Transform {
subElementDelimiter,
repetitionDelimiter,
endOfLine,
- format
- })
+ format,
+ }) as any;
} else {
- this._options = defaultSerializationOptions(options)
+ this._options = defaultSerializationOptions(options) as any;
}
}
- private _parseSegments (edi: string, segmentTerminator: string, elementDelimiter: string): X12Segment[] {
- const segments = new Array()
-
- let tagged = false
- let currentSegment: X12Segment
- let currentElement: X12Element
+ private _parseSegments(
+ edi: string,
+ segmentTerminator: string,
+ elementDelimiter: string,
+ ): X12Segment[] {
+ const segments = new Array();
- currentSegment = new X12Segment()
+ let tagged = false;
+ let currentSegment: X12Segment = new X12Segment();
+ let currentElement: X12Element = new X12Element();
for (let i = 0, l = 0, c = 0; i < edi.length; i++) {
// segment not yet named and not whitespace or delimiter - begin naming segment
- if (!tagged && edi[i].search(/\s/) === -1 && edi[i] !== elementDelimiter && edi[i] !== segmentTerminator) {
- currentSegment.tag += edi[i]
+ if (
+ !tagged && edi[i].search(/\s/) === -1 && edi[i] !== elementDelimiter &&
+ edi[i] !== segmentTerminator
+ ) {
+ currentSegment.tag += edi[i];
if (currentSegment.range.start === undefined) {
- currentSegment.range.start = new Position(l, c)
+ currentSegment.range.start = new Position(l, c);
}
// trailing line breaks - consume them and increment line number
} else if (!tagged && edi[i].search(/\s/) > -1) {
- if (edi[i] === '\n') {
- l++
- c = -1
+ if (edi[i] === "\n") {
+ l++;
+ c = -1;
}
// segment tag/name is completed - mark as tagged
} else if (!tagged && edi[i] === elementDelimiter) {
- tagged = true
+ tagged = true;
- currentElement = new X12Element()
- currentElement.range.start = new Position(l, c)
+ currentElement = new X12Element();
+ currentElement.range.start = new Position(l, c);
// segment terminator
} else if (edi[i] === segmentTerminator) {
- currentElement.range.end = new Position(l, c - 1)
- currentSegment.elements.push(currentElement)
-
- if (currentSegment.tag === 'IEA' && currentSegment.elements.length === 2) {
- currentSegment.elements[1].value = `${parseInt(currentSegment.elements[1].value, 10)}`
+ currentElement.range.end = new Position(l, c - 1);
+ currentSegment.elements.push(currentElement);
+
+ if (
+ currentSegment.tag === "IEA" && currentSegment.elements.length === 2
+ ) {
+ currentSegment.elements[1].value = `${
+ parseInt(currentSegment.elements[1].value, 10)
+ }`;
}
- currentSegment.range.end = new Position(l, c)
+ currentSegment.range.end = new Position(l, c);
- segments.push(currentSegment)
+ segments.push(currentSegment);
- currentSegment = new X12Segment()
- tagged = false
+ currentSegment = new X12Segment();
+ tagged = false;
- if (segmentTerminator === '\n') {
- l++
- c = -1
+ if (segmentTerminator === "\n") {
+ l++;
+ c = -1;
}
// element delimiter
} else if (tagged && edi[i] === elementDelimiter) {
- currentElement.range.end = new Position(l, c - 1)
- currentSegment.elements.push(currentElement)
-
- if (currentSegment.tag === 'ISA' && currentSegment.elements.length === 13) {
- currentSegment.elements[12].value = `${parseInt(currentSegment.elements[12].value, 10)}`
+ currentElement.range.end = new Position(l, c - 1);
+ currentSegment.elements.push(currentElement);
+
+ if (
+ currentSegment.tag === "ISA" && currentSegment.elements.length === 13
+ ) {
+ currentSegment.elements[12].value = `${
+ parseInt(currentSegment.elements[12].value, 10)
+ }`;
}
- currentElement = new X12Element()
- currentElement.range.start = new Position(l, c + 1)
+ currentElement = new X12Element();
+ currentElement.range.start = new Position(l, c + 1);
// element data
} else {
- currentElement.value += edi[i]
+ currentElement.value += edi[i];
}
- c++
+ c++;
}
- return segments
+ return segments;
}
- private _processSegment (seg: X12Segment): void {
- if (seg.tag === 'ISA') {
- if (this._strict && this._interchange !== undefined && this._interchange.header !== undefined) {
+ private _processSegment(seg: X12Segment): void {
+ if (seg.tag === "ISA") {
+ if (
+ this._strict && this._interchange !== undefined &&
+ this._interchange.header !== undefined
+ ) {
if (this._fatInterchange === undefined) {
- this._fatInterchange = new X12FatInterchange(this._options)
- this._fatInterchange.interchanges.push(this._interchange)
+ this._fatInterchange = new X12FatInterchange(this._options);
+ this._fatInterchange.interchanges.push(this._interchange);
}
- this._interchange = new X12Interchange(this._options)
+ this._interchange = new X12Interchange(this._options);
}
if (this._interchange === undefined) {
- this._interchange = new X12Interchange(this._options)
+ this._interchange = new X12Interchange(this._options);
}
- this._processISA(this._interchange, seg)
- this._parsedISA = true
- } else if (seg.tag === 'IEA') {
- this._processIEA(this._interchange, seg)
+ this._processISA(this._interchange, seg);
+ this._parsedISA = true;
+ } else if (seg.tag === "IEA") {
+ this._processIEA(this._interchange, seg);
if (this._fatInterchange !== undefined) {
- this._fatInterchange.interchanges.push(this._interchange)
+ this._fatInterchange.interchanges.push(this._interchange);
}
- } else if (seg.tag === 'GS') {
- this._group = new X12FunctionalGroup(this._options)
+ } else if (seg.tag === "GS") {
+ this._group = new X12FunctionalGroup(this._options);
- this._processGS(this._group, seg)
- this._interchange.functionalGroups.push(this._group)
- } else if (seg.tag === 'GE') {
+ this._processGS(this._group, seg);
+ this._interchange.functionalGroups.push(this._group);
+ } else if (seg.tag === "GE") {
if (this._group === undefined) {
- const errorMessage = 'X12 Standard: Missing GS segment!'
+ const errorMessage = "X12 Standard: Missing GS segment!";
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range))
+ this.diagnostics.push(
+ new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range),
+ );
}
- this._processGE(this._group, seg)
- this._group = undefined
- } else if (seg.tag === 'ST') {
+ this._processGE(this._group, seg);
+ this._group = undefined as any;
+ } else if (seg.tag === "ST") {
if (this._group === undefined) {
- const errorMessage = `X12 Standard: ${seg.tag} segment cannot appear outside of a functional group.`
+ const errorMessage =
+ `X12 Standard: ${seg.tag} segment cannot appear outside of a functional group.`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range))
+ this.diagnostics.push(
+ new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range),
+ );
}
- this._transaction = new X12Transaction(this._options)
+ this._transaction = new X12Transaction(this._options);
- this._processST(this._transaction, seg)
- this._group.transactions.push(this._transaction)
- } else if (seg.tag === 'SE') {
+ this._processST(this._transaction, seg);
+ this._group.transactions.push(this._transaction);
+ } else if (seg.tag === "SE") {
if (this._group === undefined) {
- const errorMessage = `X12 Standard: ${seg.tag} segment cannot appear outside of a functional group.`
+ const errorMessage =
+ `X12 Standard: ${seg.tag} segment cannot appear outside of a functional group.`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range))
+ this.diagnostics.push(
+ new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range),
+ );
}
if (this._transaction === undefined) {
- const errorMessage = 'X12 Standard: Missing ST segment!'
+ const errorMessage = "X12 Standard: Missing ST segment!";
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range))
+ this.diagnostics.push(
+ new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range),
+ );
}
- this._processSE(this._transaction, seg)
- this._transaction = undefined
+ this._processSE(this._transaction, seg);
+ this._transaction = undefined as any;
} else {
if (this._group === undefined) {
- const errorMessage = `X12 Standard: ${seg.tag} segment cannot appear outside of a functional group.`
+ const errorMessage =
+ `X12 Standard: ${seg.tag} segment cannot appear outside of a functional group.`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range))
+ this.diagnostics.push(
+ new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range),
+ );
}
if (this._transaction === undefined) {
- const errorMessage = `X12 Standard: ${seg.tag} segment cannot appear outside of a transaction.`
+ const errorMessage =
+ `X12 Standard: ${seg.tag} segment cannot appear outside of a transaction.`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range))
+ this.diagnostics.push(
+ new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, seg.range),
+ );
} else {
- this._transaction.segments.push(seg)
+ this._transaction.segments.push(seg);
}
}
}
- private _processISA (interchange: X12Interchange, segment: X12Segment): void {
- interchange.header = segment
+ private _processISA(interchange: X12Interchange, segment: X12Segment): void {
+ interchange.header = segment;
}
- private _processIEA (interchange: X12Interchange, segment: X12Segment): void {
- interchange.trailer = segment
+ private _processIEA(interchange: X12Interchange, segment: X12Segment): void {
+ interchange.trailer = segment;
- if (parseInt(segment.valueOf(1)) !== interchange.functionalGroups.length) {
- const errorMessage = `X12 Standard: The value in IEA01 (${segment.valueOf(
- 1
- )}) does not match the number of GS segments in the interchange (${interchange.functionalGroups.length}).`
+ if (
+ parseInt(segment.valueOf(1) ?? "") !== interchange.functionalGroups.length
+ ) {
+ const errorMessage = `X12 Standard: The value in IEA01 (${
+ segment.valueOf(
+ 1,
+ )
+ }) does not match the number of GS segments in the interchange (${interchange.functionalGroups.length}).`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, segment.elements[0].range))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ segment.elements[0].range,
+ ),
+ );
}
if (segment.valueOf(2) !== interchange.header.valueOf(13)) {
- const errorMessage = `X12 Standard: The value in IEA02 (${segment.valueOf(
- 2
- )}) does not match the value in ISA13 (${interchange.header.valueOf(13)}).`
+ const errorMessage = `X12 Standard: The value in IEA02 (${
+ segment.valueOf(
+ 2,
+ )
+ }) does not match the value in ISA13 (${
+ interchange.header.valueOf(13)
+ }).`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, segment.elements[1].range))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ segment.elements[1].range,
+ ),
+ );
}
}
- private _processGS (group: X12FunctionalGroup, segment: X12Segment): void {
- group.header = segment
+ private _processGS(group: X12FunctionalGroup, segment: X12Segment): void {
+ group.header = segment;
}
- private _processGE (group: X12FunctionalGroup, segment: X12Segment): void {
- group.trailer = segment
+ private _processGE(group: X12FunctionalGroup, segment: X12Segment): void {
+ group.trailer = segment;
- if (parseInt(segment.valueOf(1)) !== group.transactions.length) {
- const errorMessage = `X12 Standard: The value in GE01 (${segment.valueOf(
- 1
- )}) does not match the number of ST segments in the functional group (${group.transactions.length}).`
+ if (parseInt(segment.valueOf(1) ?? "") !== group.transactions.length) {
+ const errorMessage = `X12 Standard: The value in GE01 (${
+ segment.valueOf(
+ 1,
+ )
+ }) does not match the number of ST segments in the functional group (${group.transactions.length}).`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, segment.elements[0].range))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ segment.elements[0].range,
+ ),
+ );
}
if (segment.valueOf(2) !== group.header.valueOf(6)) {
- const errorMessage = `X12 Standard: The value in GE02 (${segment.valueOf(
- 2
- )}) does not match the value in GS06 (${group.header.valueOf(6)}).`
+ const errorMessage = `X12 Standard: The value in GE02 (${
+ segment.valueOf(
+ 2,
+ )
+ }) does not match the value in GS06 (${group.header.valueOf(6)}).`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, segment.elements[1].range))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ segment.elements[1].range,
+ ),
+ );
}
}
- private _processST (transaction: X12Transaction, segment: X12Segment): void {
- transaction.header = segment
+ private _processST(transaction: X12Transaction, segment: X12Segment): void {
+ transaction.header = segment;
}
- private _processSE (transaction: X12Transaction, segment: X12Segment): void {
- transaction.trailer = segment
+ private _processSE(transaction: X12Transaction, segment: X12Segment): void {
+ transaction.trailer = segment;
- const expectedNumberOfSegments = transaction.segments.length + 2
+ const expectedNumberOfSegments = transaction.segments.length + 2;
- if (parseInt(segment.valueOf(1)) !== expectedNumberOfSegments) {
- const errorMessage = `X12 Standard: The value in SE01 (${segment.valueOf(
- 1
- )}) does not match the number of segments in the transaction (${expectedNumberOfSegments}).`
+ if (parseInt(segment.valueOf(1) ?? "") !== expectedNumberOfSegments) {
+ const errorMessage = `X12 Standard: The value in SE01 (${
+ segment.valueOf(
+ 1,
+ )
+ }) does not match the number of segments in the transaction (${expectedNumberOfSegments}).`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, segment.elements[0].range))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ segment.elements[0].range,
+ ),
+ );
}
if (segment.valueOf(2) !== transaction.header.valueOf(2)) {
- const errorMessage = `X12 Standard: The value in SE02 (${segment.valueOf(
- 2
- )}) does not match the value in ST02 (${transaction.header.valueOf(2)}).`
+ const errorMessage = `X12 Standard: The value in SE02 (${
+ segment.valueOf(
+ 2,
+ )
+ }) does not match the value in ST02 (${transaction.header.valueOf(2)}).`;
if (this._strict) {
- throw new ParserError(errorMessage)
+ throw new ParserError(errorMessage);
}
- this.diagnostics.push(new X12Diagnostic(X12DiagnosticLevel.Error, errorMessage, segment.elements[1].range))
+ this.diagnostics.push(
+ new X12Diagnostic(
+ X12DiagnosticLevel.Error,
+ errorMessage,
+ segment.elements[1].range,
+ ),
+ );
}
}
- private _consumeChunk (chunk: string): void {
- chunk = this._dataCache + chunk
- let rawSegments: string[]
+ private _consumeChunk(chunk: string): void {
+ chunk = this._dataCache + chunk;
+ let rawSegments: string[] | undefined;
if (!this._parsedISA && chunk.length >= DOCUMENT_MIN_LENGTH) {
- this._detectOptions(chunk, this._options)
+ this._detectOptions(chunk, this._options);
- this._validateIsaLength(chunk, this._options.elementDelimiter)
+ this._validateIsaLength(chunk, this._options.elementDelimiter);
- rawSegments = chunk.split(this._options.segmentTerminator)
+ rawSegments = chunk.split(this._options.segmentTerminator);
if (chunk.charAt(chunk.length - 1) !== this._options.segmentTerminator) {
- this._dataCache = rawSegments[rawSegments.length - 1]
- rawSegments.splice(rawSegments.length - 1, 1)
+ this._dataCache = rawSegments[rawSegments.length - 1];
+ rawSegments.splice(rawSegments.length - 1, 1);
}
}
if (this._parsedISA) {
- rawSegments = chunk.split(this._options.segmentTerminator)
-
- if (chunk.charAt(chunk.length - 1) !== this._options.segmentTerminator && !this._flushing) {
- this._dataCache = rawSegments[rawSegments.length - 1]
- rawSegments.splice(rawSegments.length - 1, 1)
+ rawSegments = chunk.split(this._options.segmentTerminator);
+
+ if (
+ chunk.charAt(chunk.length - 1) !== this._options.segmentTerminator &&
+ !this._flushing
+ ) {
+ this._dataCache = rawSegments[rawSegments.length - 1];
+ rawSegments.splice(rawSegments.length - 1, 1);
}
}
@@ -505,13 +625,13 @@ export class X12Parser extends Transform {
const segments = this._parseSegments(
rawSegments[i] + this._options.segmentTerminator,
this._options.segmentTerminator,
- this._options.elementDelimiter
- )
+ this._options.elementDelimiter,
+ );
- segments.forEach(segment => {
- this.push(segment)
- this._segmentCounter += 1
- })
+ segments.forEach((segment) => {
+ this.push(segment);
+ this._segmentCounter += 1;
+ });
}
}
}
@@ -521,14 +641,14 @@ export class X12Parser extends Transform {
* @description Flush method for Node API Transform stream.
* @param {Function} callback - Callback to execute when finished.
*/
- public _flush (callback: Function): void {
- this._flushing = true
- this._consumeChunk(this._dataCache)
- this._flushing = false
+ public _flush(callback: Function): void {
+ this._flushing = true;
+ this._consumeChunk(this._dataCache);
+ this._flushing = false;
- callback()
+ callback();
- this._validateEdiSegmentCount()
+ this._validateEdiSegmentCount();
}
/**
@@ -537,9 +657,9 @@ export class X12Parser extends Transform {
* @param {string} encoding - Chunk enoding.
* @param {Function} callback - Callback signalling chunk is processed and instance is ready for next chunk.
*/
- public _transform (chunk: any, encoding: string, callback: Function): void {
- this._consumeChunk(this._decoder.write(chunk))
+ public _transform(chunk: any, _encoding: string, callback: Function): void {
+ this._consumeChunk(this._decoder.write(chunk));
- callback()
+ callback();
}
}
diff --git a/src/X12QueryEngine.ts b/src/X12QueryEngine.ts
index 50d259e..40f678e 100644
--- a/src/X12QueryEngine.ts
+++ b/src/X12QueryEngine.ts
@@ -1,14 +1,15 @@
-'use strict'
+// deno-lint-ignore-file no-explicit-any
+"use strict";
-import { QuerySyntaxError } from './Errors'
-import { X12Parser } from './X12Parser'
-import { X12Interchange } from './X12Interchange'
-import { X12FunctionalGroup } from './X12FunctionalGroup'
-import { X12Transaction } from './X12Transaction'
-import { X12Segment } from './X12Segment'
-import { X12Element } from './X12Element'
+import { QuerySyntaxError } from "./Errors.ts";
+import { X12Parser } from "./X12Parser.ts";
+import { X12Interchange } from "./X12Interchange.ts";
+import { X12FunctionalGroup } from "./X12FunctionalGroup.ts";
+import { X12Transaction } from "./X12Transaction.ts";
+import { X12Segment } from "./X12Segment.ts";
+import { X12Element } from "./X12Element.ts";
-export type X12QueryMode = 'strict' | 'loose'
+export type X12QueryMode = "strict" | "loose";
export class X12QueryEngine {
/**
@@ -16,15 +17,18 @@ export class X12QueryEngine {
* @param {X12Parser|boolean} [parser] - Pass an external parser or set the strictness of the internal parser.
* @param {'strict'|'loose'} [mode='strict'] - Sets the mode of the query engine, defaults to classic 'strict'; adds new behavior of 'loose', which will return an empty value for a missing element so long as the segment exists.
*/
- constructor (parser: X12Parser | boolean = true, mode: X12QueryMode = 'strict') {
- this._parser = typeof parser === 'boolean' ? new X12Parser(parser) : parser
- this._mode = mode
+ constructor(
+ parser: X12Parser | boolean = true,
+ mode: X12QueryMode = "strict",
+ ) {
+ this._parser = typeof parser === "boolean" ? new X12Parser(parser) : parser;
+ this._mode = mode;
}
- private readonly _parser: X12Parser
- private readonly _mode: X12QueryMode
- private readonly _forEachPattern: RegExp = /FOREACH\([A-Z0-9]{2,3}\)=>.+/g
- private readonly _concatPattern: RegExp = /CONCAT\(.+,.+\)=>.+/g
+ private readonly _parser: X12Parser;
+ private readonly _mode: X12QueryMode;
+ private readonly _forEachPattern: RegExp = /FOREACH\([A-Z0-9]{2,3}\)=>.+/g;
+ private readonly _concatPattern: RegExp = /CONCAT\(.+,.+\)=>.+/g;
/**
* @description Query all references in an EDI document.
@@ -33,74 +37,87 @@ export class X12QueryEngine {
* @param {string} [defaultValue=null] - A default value to return if result not found.
* @returns {X12QueryResult[]} An array of results from the EDI document.
*/
- query (rawEdi: string | X12Interchange, reference: string, defaultValue: string = null): X12QueryResult[] {
- const interchange = typeof rawEdi === 'string' ? (this._parser.parse(rawEdi) as X12Interchange) : rawEdi
+ query(
+ rawEdi: string | X12Interchange,
+ reference: string,
+ defaultValue: string | null = null,
+ ): X12QueryResult[] {
+ const interchange = typeof rawEdi === "string"
+ ? (this._parser.parse(rawEdi) as X12Interchange)
+ : rawEdi;
- const forEachMatch = reference.match(this._forEachPattern) // ex. FOREACH(LX)=>MAN02
+ const forEachMatch = reference.match(this._forEachPattern); // ex. FOREACH(LX)=>MAN02
if (forEachMatch !== null) {
- reference = this._evaluateForEachQueryPart(forEachMatch[0])
+ reference = this._evaluateForEachQueryPart(forEachMatch[0]);
}
- const concathMatch = reference.match(this._concatPattern) // ex. CONCAT(MAN01,-)=>MAN02
- let concat: any
+ const concathMatch = reference.match(this._concatPattern); // ex. CONCAT(MAN01,-)=>MAN02
+ let concat: any;
if (concathMatch !== null) {
- concat = this._evaluateConcatQueryPart(interchange, concathMatch[0])
- reference = concat.query
+ concat = this._evaluateConcatQueryPart(interchange, concathMatch[0]);
+ reference = concat.query;
}
- const hlPathMatch = reference.match(/HL\+(\w\+?)+[+-]/g) // ex. HL+O+P+I
- const segPathMatch = reference.match(/((?()
+ const results = new Array();
for (const group of interchange.functionalGroups) {
for (const txn of group.transactions) {
- let segments = txn.segments
+ let segments = txn.segments;
if (hlPathMatch !== null) {
- segments = this._evaluateHLQueryPart(txn, hlPathMatch[0])
+ segments = this._evaluateHLQueryPart(txn, hlPathMatch[0]);
}
if (segPathMatch !== null) {
- segments = this._evaluateSegmentPathQueryPart(segments, segPathMatch[0])
+ segments = this._evaluateSegmentPathQueryPart(
+ segments,
+ segPathMatch[0],
+ );
}
if (elmRefMatch === null) {
- throw new QuerySyntaxError('Element reference queries must contain an element reference!')
+ throw new QuerySyntaxError(
+ "Element reference queries must contain an element reference!",
+ );
}
const txnResults = this._evaluateElementReferenceQueryPart(
interchange,
group,
txn,
- [].concat(segments, [
+ ([] as X12Segment[]).concat(segments, [
interchange.header,
group.header,
txn.header,
txn.trailer,
group.trailer,
- interchange.trailer
+ interchange.trailer,
]),
elmRefMatch[0],
- qualMatch,
- defaultValue
- )
+ qualMatch as string[],
+ defaultValue,
+ );
- txnResults.forEach(res => {
+ txnResults.forEach((res) => {
if (concat !== undefined) {
- res.value = `${concat.value}${concat.separator}${res.value}`
+ res.value = `${concat.value}${concat.separator}${res.value}`;
}
- results.push(res)
- })
+ results.push(res);
+ });
}
}
- return results
+ return results;
}
/**
@@ -110,211 +127,256 @@ export class X12QueryEngine {
* @param {string} [defaultValue=null] - A default value to return if result not found.
* @returns {X12QueryResult} A result from the EDI document.
*/
- querySingle (rawEdi: string | X12Interchange, reference: string, defaultValue: string = null): X12QueryResult {
- const results = this.query(rawEdi, reference)
+ querySingle(
+ rawEdi: string | X12Interchange,
+ reference: string,
+ _defaultValue: string | null = null,
+ ): X12QueryResult | null {
+ const results = this.query(rawEdi, reference);
if (reference.match(this._forEachPattern) !== null) {
- const values = results.map(result => result.value)
+ const values = results.map((result) => result.value);
if (values.length !== 0) {
- results[0].value = null
- results[0].values = values
+ results[0].value = null;
+ results[0].values = values;
}
}
- return results.length === 0 ? null : results[0]
+ return results.length === 0 ? null : results[0];
}
- private _getMacroParts (macroQuery: string): any {
- const macroPart = macroQuery.substr(0, macroQuery.indexOf('=>'))
- const queryPart = macroQuery.substr(macroQuery.indexOf('=>') + 2)
- const parameters = macroPart.substr(macroPart.indexOf('(') + 1, macroPart.length - macroPart.indexOf('(') - 2)
+ private _getMacroParts(macroQuery: string): any {
+ const macroPart = macroQuery.substr(0, macroQuery.indexOf("=>"));
+ const queryPart = macroQuery.substr(macroQuery.indexOf("=>") + 2);
+ const parameters = macroPart.substr(
+ macroPart.indexOf("(") + 1,
+ macroPart.length - macroPart.indexOf("(") - 2,
+ );
return {
macroPart,
queryPart,
- parameters
- }
+ parameters,
+ };
}
- private _evaluateForEachQueryPart (forEachSegment: string): string {
- const { queryPart, parameters } = this._getMacroParts(forEachSegment)
+ private _evaluateForEachQueryPart(forEachSegment: string): string {
+ const { queryPart, parameters } = this._getMacroParts(forEachSegment);
- return `${parameters}-${queryPart}`
+ return `${parameters}-${queryPart}`;
}
- private _evaluateConcatQueryPart (interchange: X12Interchange, concatSegment: string): any {
- const { queryPart, parameters } = this._getMacroParts(concatSegment)
+ private _evaluateConcatQueryPart(
+ interchange: X12Interchange,
+ concatSegment: string,
+ ): any {
+ const { queryPart, parameters } = this._getMacroParts(concatSegment);
- let value = ''
+ let value = "";
- const expandedParams = parameters.split(',')
+ const expandedParams = parameters.split(",");
if (expandedParams.length === 3) {
- expandedParams[1] = ','
+ expandedParams[1] = ",";
}
- const result = this.querySingle(interchange, expandedParams[0])
+ const result = this.querySingle(interchange, expandedParams[0]);
if (result !== null) {
if (result.value !== null && result.value !== undefined) {
- value = result.value
+ value = result.value;
} else if (Array.isArray(result.values)) {
- value = result.values.join(expandedParams[1])
+ value = result.values.join(expandedParams[1]);
}
}
return {
value,
separator: expandedParams[1],
- query: queryPart
- }
+ query: queryPart,
+ };
}
- private _evaluateHLQueryPart (transaction: X12Transaction, hlPath: string): X12Segment[] {
- let qualified = false
+ private _evaluateHLQueryPart(
+ transaction: X12Transaction,
+ hlPath: string,
+ ): X12Segment[] {
+ let qualified = false;
const pathParts = hlPath
- .replace('-', '')
- .split('+')
- .filter((value, index, array) => {
- return value !== 'HL' && value !== '' && value !== null
- })
- const matches = new Array()
+ .replace("-", "")
+ .split("+")
+ .filter((value) => {
+ return value !== "HL" && value !== "" && value !== null;
+ });
+ const matches = new Array();
- let lastParentIndex = -1
+ let lastParentIndex = -1;
for (let i = 0, j = 0; i < transaction.segments.length; i++) {
- const segment = transaction.segments[i]
+ const segment = transaction.segments[i];
- if (qualified && segment.tag === 'HL') {
- const parentIndex = parseInt(segment.valueOf(2, '-1'))
+ if (qualified && segment.tag === "HL") {
+ const parentIndex = parseInt(segment.valueOf(2, "-1") ?? "-1");
if (parentIndex !== lastParentIndex) {
- j = 0
- qualified = false
+ j = 0;
+ qualified = false;
}
}
- if (!qualified && transaction.segments[i].tag === 'HL' && transaction.segments[i].valueOf(3) === pathParts[j]) {
- lastParentIndex = parseInt(segment.valueOf(2, '-1'))
- j++
+ if (
+ !qualified && transaction.segments[i].tag === "HL" &&
+ transaction.segments[i].valueOf(3) === pathParts[j]
+ ) {
+ lastParentIndex = parseInt(segment.valueOf(2, "-1") ?? "-1");
+ j++;
if (j === pathParts.length) {
- qualified = true
+ qualified = true;
}
}
if (qualified) {
- matches.push(transaction.segments[i])
+ matches.push(transaction.segments[i]);
}
}
- return matches
+ return matches;
}
- private _evaluateSegmentPathQueryPart (segments: X12Segment[], segmentPath: string): X12Segment[] {
- let qualified = false
- const pathParts = segmentPath.split('-').filter((value, index, array) => {
+ private _evaluateSegmentPathQueryPart(
+ segments: X12Segment[],
+ segmentPath: string,
+ ): X12Segment[] {
+ let qualified = false;
+ const pathParts = segmentPath.split("-").filter((value) => {
// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
- return !!value
- })
- const matches = new Array()
+ return !!value;
+ });
+ const matches = new Array();
for (let i = 0, j = 0; i < segments.length; i++) {
- if (qualified && (segments[i].tag === 'HL' || pathParts.indexOf(segments[i].tag) > -1)) {
- j = 0
- qualified = false
+ if (
+ qualified &&
+ (segments[i].tag === "HL" || pathParts.indexOf(segments[i].tag) > -1)
+ ) {
+ j = 0;
+ qualified = false;
}
if (!qualified && segments[i].tag === pathParts[j]) {
- j++
+ j++;
if (j === pathParts.length) {
- qualified = true
+ qualified = true;
}
}
if (qualified) {
- matches.push(segments[i])
+ matches.push(segments[i]);
}
}
- return matches
+ return matches;
}
- private _evaluateElementReferenceQueryPart (
+ private _evaluateElementReferenceQueryPart(
interchange: X12Interchange,
functionalGroup: X12FunctionalGroup,
transaction: X12Transaction,
segments: X12Segment[],
elementReference: string,
qualifiers: string[],
- defaultValue: string = null
+ defaultValue: string | null = null,
): X12QueryResult[] {
- const reference = elementReference.replace(':', '')
- const tag = reference.substr(0, reference.length - 2)
- const pos = reference.substr(reference.length - 2, 2)
- const posint = parseInt(pos)
+ const reference = elementReference.replace(":", "");
+ const tag = reference.substr(0, reference.length - 2);
+ const pos = reference.substr(reference.length - 2, 2);
+ const posint = parseInt(pos);
- const results = new Array()
+ const results = new Array();
for (const segment of segments) {
if (segment === null || segment === undefined) {
- continue
+ continue;
}
if (segment.tag !== tag) {
- continue
+ continue;
}
- const value = segment.valueOf(posint, defaultValue)
+ const value = segment.valueOf(posint, defaultValue ?? undefined);
if (this._testQualifiers(transaction, segment, qualifiers)) {
- if ((typeof value !== 'undefined' && value !== null)) {
+ if ((typeof value !== "undefined" && value !== null)) {
results.push(
- new X12QueryResult(interchange, functionalGroup, transaction, segment, segment.elements[posint - 1], value)
- )
- } else if (this._mode === 'loose') {
+ new X12QueryResult(
+ interchange,
+ functionalGroup,
+ transaction,
+ segment,
+ segment.elements[posint - 1],
+ value,
+ ),
+ );
+ } else if (this._mode === "loose") {
results.push(
- new X12QueryResult(interchange, functionalGroup, transaction, segment, new X12Element(), undefined)
- )
+ new X12QueryResult(
+ interchange,
+ functionalGroup,
+ transaction,
+ segment,
+ new X12Element(),
+ undefined,
+ ),
+ );
}
}
}
- return results
+ return results;
}
- private _testQualifiers (transaction: X12Transaction, segment: X12Segment, qualifiers: string[]): boolean {
+ private _testQualifiers(
+ transaction: X12Transaction,
+ segment: X12Segment,
+ qualifiers: string[],
+ ): boolean {
if (qualifiers === undefined || qualifiers === null) {
- return true
+ return true;
}
for (const qualifierValue of qualifiers) {
- const qualifier = qualifierValue.substr(1)
- const elementReference = qualifier.substring(0, qualifier.indexOf('['))
- const elementValue = qualifier.substring(qualifier.indexOf('[') + 2, qualifier.lastIndexOf(']') - 1)
- const tag = elementReference.substr(0, elementReference.length - 2)
- const pos = elementReference.substr(elementReference.length - 2, 2)
- const posint = parseInt(pos)
+ const qualifier = qualifierValue.substr(1);
+ const elementReference = qualifier.substring(0, qualifier.indexOf("["));
+ const elementValue = qualifier.substring(
+ qualifier.indexOf("[") + 2,
+ qualifier.lastIndexOf("]") - 1,
+ );
+ const tag = elementReference.substr(0, elementReference.length - 2);
+ const pos = elementReference.substr(elementReference.length - 2, 2);
+ const posint = parseInt(pos);
for (let j = transaction.segments.indexOf(segment); j > -1; j--) {
- const seg = transaction.segments[j]
- const value = seg.valueOf(posint)
+ const seg = transaction.segments[j];
+ const value = seg.valueOf(posint);
- if (seg.tag === tag && seg.tag === segment.tag && value !== elementValue) {
- return false
+ if (
+ seg.tag === tag && seg.tag === segment.tag && value !== elementValue
+ ) {
+ return false;
} else if (seg.tag === tag && value === elementValue) {
- break
+ break;
}
if (j === 0) {
- return false
+ return false;
}
}
}
- return true
+ return true;
}
}
@@ -331,28 +393,30 @@ export class X12QueryEngine {
*/
export class X12QueryResult {
- constructor (
+ constructor(
interchange?: X12Interchange,
functionalGroup?: X12FunctionalGroup,
transaction?: X12Transaction,
segment?: X12Segment,
element?: X12Element,
- value?: string
+ value?: string,
) {
- this.interchange = interchange
- this.functionalGroup = functionalGroup
- this.transaction = transaction
- this.segment = segment
- this.element = element
- this.value = value === null || value === undefined ? element.value : value
- this.values = new Array()
+ this.interchange = interchange;
+ this.functionalGroup = functionalGroup;
+ this.transaction = transaction;
+ this.segment = segment;
+ this.element = element;
+ this.value = value === null || value === undefined
+ ? element?.value ?? null
+ : value;
+ this.values = new Array();
}
- interchange: X12Interchange
- functionalGroup: X12FunctionalGroup
- transaction: X12Transaction
- segment: X12Segment
- element: X12Element
- value: string
- values: Array
+ interchange?: X12Interchange;
+ functionalGroup?: X12FunctionalGroup;
+ transaction?: X12Transaction;
+ segment?: X12Segment;
+ element?: X12Element;
+ value: string | null;
+ values: Array;
}
diff --git a/src/X12Segment.ts b/src/X12Segment.ts
index 93bfaec..77f4d30 100644
--- a/src/X12Segment.ts
+++ b/src/X12Segment.ts
@@ -1,11 +1,15 @@
-'use strict'
-
-import { JSEDISegment } from './JSEDINotation'
-import { Range } from './Positioning'
-import { X12Element } from './X12Element'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
-import { ISASegmentHeader } from './X12SegmentHeader'
-import { GeneratorError } from './Errors'
+// deno-lint-ignore-file ban-types no-explicit-any
+"use strict";
+
+import { JSEDISegment } from "./JSEDINotation.ts";
+import { Range } from "./Positioning.ts";
+import { X12Element } from "./X12Element.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
+import { ISASegmentHeader } from "./X12SegmentHeader.ts";
+import { GeneratorError } from "./Errors.ts";
export class X12Segment {
/**
@@ -13,24 +17,24 @@ export class X12Segment {
* @param {string} tag - The tag for this segment.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- constructor (tag: string = '', options?: X12SerializationOptions) {
- this.tag = tag
- this.elements = new Array()
- this.range = new Range()
- this.options = defaultSerializationOptions(options)
+ constructor(tag: string = "", options?: X12SerializationOptions) {
+ this.tag = tag;
+ this.elements = new Array();
+ this.range = new Range();
+ this.options = defaultSerializationOptions(options);
}
- tag: string
- elements: X12Element[]
- range: Range
- options: X12SerializationOptions
+ tag: string;
+ elements: X12Element[];
+ range: Range;
+ options: X12SerializationOptions;
/**
* @description Set the tag name for the segment if not provided when constructed.
* @param {string} tag - The tag for this segment.
*/
- setTag (tag: string): void {
- this.tag = tag
+ setTag(tag: string): void {
+ this.tag = tag;
}
/**
@@ -38,14 +42,14 @@ export class X12Segment {
* @param {string[]} values - An array of element values.
* @returns {X12Segment} The current instance of X12Segment.
*/
- setElements (values: string[]): X12Segment {
- this._formatValues(values)
- this.elements = new Array()
- values.forEach(value => {
- this.elements.push(new X12Element(value))
- })
-
- return this
+ setElements(values: string[]): X12Segment {
+ this._formatValues(values);
+ this.elements = new Array();
+ values.forEach((value) => {
+ this.elements.push(new X12Element(value));
+ });
+
+ return this;
}
/**
@@ -53,12 +57,12 @@ export class X12Segment {
* @param {string} value - A string value.
* @returns {X12Element} The element that was added to this segment.
*/
- addElement (value: string = ''): X12Element {
- const element = new X12Element(value)
+ addElement(value = ""): X12Element {
+ const element = new X12Element(value);
- this.elements.push(element)
+ this.elements.push(element);
- return element
+ return element;
}
/**
@@ -67,32 +71,32 @@ export class X12Segment {
* @param {number} segmentPosition - A 1-based number indicating the position in the segment.
* @returns {X12Element} The new element if successful, or a null if failed.
*/
- replaceElement (value: string, segmentPosition: number): X12Element {
- const index = segmentPosition - 1
+ replaceElement(value: string, segmentPosition: number): X12Element | null {
+ const index = segmentPosition - 1;
if (this.elements.length <= index) {
- return null
+ return null;
} else {
- this.elements[index] = new X12Element(value)
+ this.elements[index] = new X12Element(value);
}
- return this.elements[index]
+ return this.elements[index];
}
/**
* @description Insert an element at a position in the segment.
* @param {string} value - A string value.
* @param {number} segmentPosition - A 1-based number indicating the position in the segment.
- * @returns {X12Element} The new element if successful, or a null if failed.
+ * @returns {boolean} True if successful, or false if failed.
*/
- insertElement (value: string = '', segmentPosition: number = 1): boolean {
- const index = segmentPosition - 1
+ insertElement(value = "", segmentPosition = 1): boolean {
+ const index = segmentPosition - 1;
if (this.elements.length <= index) {
- return null
+ return false;
}
- return this.elements.splice(index, 0, new X12Element(value)).length === 1
+ return this.elements.splice(index, 0, new X12Element(value)).length === 1;
}
/**
@@ -100,14 +104,14 @@ export class X12Segment {
* @param {number} segmentPosition - A 1-based number indicating the position in the segment.
* @returns {boolean} True if successful.
*/
- removeElement (segmentPosition: number): boolean {
- const index = segmentPosition - 1
+ removeElement(segmentPosition: number): boolean {
+ const index = segmentPosition - 1;
if (this.elements.length <= index) {
- return false
+ return false;
}
- return this.elements.splice(index, 1).length === 1
+ return this.elements.splice(index, 1).length === 1;
}
/**
@@ -116,18 +120,16 @@ export class X12Segment {
* @param {string} [defaultValue] - A default value to return if there is no element found.
* @returns {string} If no element is at this position, null or the default value will be returned.
*/
- valueOf (segmentPosition: number, defaultValue?: string): string {
- const index = segmentPosition - 1
+ valueOf(segmentPosition: number, defaultValue?: string): string | null {
+ const index = segmentPosition - 1;
if (this.elements.length <= index) {
- return defaultValue === undefined ? null : defaultValue
+ return defaultValue === undefined ? null : defaultValue;
}
return this.elements[index].value === undefined
- ? defaultValue === undefined
- ? null
- : defaultValue
- : this.elements[index].value
+ ? defaultValue === undefined ? null : defaultValue
+ : this.elements[index].value;
}
/**
@@ -135,34 +137,40 @@ export class X12Segment {
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
* @returns {string} This segment converted to an EDI string.
*/
- toString (options?: X12SerializationOptions): string {
- options = options !== undefined ? defaultSerializationOptions(options) : this.options
+ toString(options?: X12SerializationOptions): string {
+ options = options !== undefined
+ ? defaultSerializationOptions(options)
+ : this.options;
- let edi = this.tag
+ let edi = this.tag;
for (let i = 0; i < this.elements.length; i++) {
- edi += options.elementDelimiter
- if ((this.tag === 'ISA' && i === 12) || (this.tag === 'IEA' && i === 1)) {
- edi += String.prototype.padStart.call(this.elements[i].value, 9, '0') as string
+ edi += options.elementDelimiter;
+ if ((this.tag === "ISA" && i === 12) || (this.tag === "IEA" && i === 1)) {
+ edi += String.prototype.padStart.call(
+ this.elements[i].value,
+ 9,
+ "0",
+ ) as string;
} else {
- edi += this.elements[i].value
+ edi += this.elements[i].value;
}
}
- edi += options.segmentTerminator
+ edi += options.segmentTerminator;
- return edi
+ return edi;
}
/**
* @description Serialize transaction set to JSON object.
* @returns {object} This segment converted to an object.
*/
- toJSON (): object {
+ toJSON(): object {
return new JSEDISegment(
this.tag,
- this.elements.map(x => x.value)
- ) as object
+ this.elements.map((x) => x.value),
+ ) as object;
}
/**
@@ -170,12 +178,12 @@ export class X12Segment {
* @description Check to see if segment is predefined.
* @returns {boolean} True if segment is predefined.
*/
- private _checkSupportedSegment (): boolean {
+ private _checkSupportedSegment(): boolean {
return (
- this.options.segmentHeaders.findIndex(sh => {
- return sh.tag === this.tag
- }) > -1
- )
+ (this.options.segmentHeaders?.findIndex((sh) => {
+ return sh.tag === this.tag;
+ }) ?? -1) > -1
+ );
}
/**
@@ -183,15 +191,17 @@ export class X12Segment {
* @description Get the definition of this segment.
* @returns {object} The definition of this segment.
*/
- private _getX12Enumerable (): any {
- const match = this.options.segmentHeaders.find(sh => {
- return sh.tag === this.tag
- })
+ private _getX12Enumerable(): any {
+ const match = this.options.segmentHeaders?.find((sh) => {
+ return sh.tag === this.tag;
+ });
if (match !== undefined) {
- return match.layout
+ return match.layout;
} else {
- throw Error(`Unable to find segment header for tag '${this.tag}' even though it should be supported.`)
+ throw Error(
+ `Unable to find segment header for tag '${this.tag}' even though it should be supported.`,
+ );
}
}
@@ -200,51 +210,66 @@ export class X12Segment {
* @description Format and validate the element values according the segment definition.
* @param {string[]} values - An array of element values.
*/
- private _formatValues (values: string[]): void {
+ private _formatValues(values: string[]): void {
if (this._checkSupportedSegment()) {
- const enumerable = this._getX12Enumerable()
+ const enumerable = this._getX12Enumerable();
- if (this.tag === ISASegmentHeader.tag && this.options.subElementDelimiter.length === 1) {
- values[15] = this.options.subElementDelimiter
+ if (
+ this.tag === ISASegmentHeader.tag &&
+ (this.options as any).subElementDelimiter.length === 1
+ ) {
+ values[15] = (this.options as any).subElementDelimiter;
}
- if (values.length === enumerable.COUNT || values.length === enumerable.COUNT_MIN) {
+ if (
+ values.length === enumerable.COUNT ||
+ values.length === enumerable.COUNT_MIN
+ ) {
for (let i = 0; i < values.length; i++) {
- const name = `${this.tag}${String.prototype.padStart.call(i + 1, 2, '0')}`
- const max = enumerable[name]
- const min = enumerable[`${name}_MIN`] === undefined ? 0 : enumerable[`${name}_MIN`]
+ const name = `${this.tag}${
+ String.prototype.padStart.call(i + 1, 2, "0")
+ }`;
+ const max = enumerable[name];
+ const min = enumerable[`${name}_MIN`] === undefined
+ ? 0
+ : enumerable[`${name}_MIN`];
- values[i] = `${values[i]}`
+ values[i] = `${values[i]}`;
if (values[i].length > max && values[i].length !== 0) {
throw new GeneratorError(
- `Segment element "${name}" with value of "${values[i]}" exceeds maximum of ${max} characters.`
- )
+ `Segment element "${name}" with value of "${
+ values[i]
+ }" exceeds maximum of ${max} characters.`,
+ );
}
if (values[i].length < min && values[i].length !== 0) {
throw new GeneratorError(
- `Segment element "${name}" with value of "${values[i]}" does not meet minimum of ${min} characters.`
- )
+ `Segment element "${name}" with value of "${
+ values[i]
+ }" does not meet minimum of ${min} characters.`,
+ );
}
if (
(enumerable.PADDING as boolean) &&
- ((values[i].length < max && values[i].length > min) || values[i].length === 0)
+ ((values[i].length < max && values[i].length > min) ||
+ values[i].length === 0)
) {
- if (name === 'ISA13') {
- values[i] = String.prototype.padStart.call(values[i], max, '0')
+ if (name === "ISA13") {
+ values[i] = String.prototype.padStart.call(values[i], max, "0");
} else {
- values[i] = String.prototype.padEnd.call(values[i], max, ' ')
+ values[i] = String.prototype.padEnd.call(values[i], max, " ");
}
}
}
} else {
throw new GeneratorError(
- typeof enumerable.COUNT_MIN === 'number'
+ typeof enumerable.COUNT_MIN === "number"
? `Segment "${this.tag}" with ${values.length} elements does not meet the required count of min ${enumerable.COUNT_MIN} or max ${enumerable.COUNT}.`
- : `Segment "${this.tag}" with ${values.length} elements does not meet the required count of ${enumerable.COUNT}.`
- )
+ : `Segment "${this.tag}" with ${values.length} elements does not meet the required count of ${enumerable.COUNT}.`,
+ );
}
}
}
diff --git a/src/X12SegmentHeader.ts b/src/X12SegmentHeader.ts
index eb8c371..fea9ce8 100644
--- a/src/X12SegmentHeader.ts
+++ b/src/X12SegmentHeader.ts
@@ -1,14 +1,15 @@
-'use strict'
+// deno-lint-ignore-file no-explicit-any
+"use strict";
export interface X12SegmentHeader {
- tag: string
- trailer?: string
- layout: any
+ tag: string;
+ trailer?: string;
+ layout: any;
}
export const ISASegmentHeader: X12SegmentHeader = {
- tag: 'ISA',
- trailer: 'IEA',
+ tag: "ISA",
+ trailer: "IEA",
layout: {
ISA01: 2,
ISA02: 10,
@@ -27,13 +28,13 @@ export const ISASegmentHeader: X12SegmentHeader = {
ISA15: 1,
ISA16: 1,
COUNT: 16,
- PADDING: true
- }
-}
+ PADDING: true,
+ },
+};
export const GSSegmentHeader: X12SegmentHeader = {
- tag: 'GS',
- trailer: 'GE',
+ tag: "GS",
+ trailer: "GE",
layout: {
GS01: 2,
GS02: 15,
@@ -50,13 +51,13 @@ export const GSSegmentHeader: X12SegmentHeader = {
GS08: 12,
GS08_MIN: 1,
COUNT: 8,
- PADDING: false
- }
-}
+ PADDING: false,
+ },
+};
export const STSegmentHeader: X12SegmentHeader = {
- tag: 'ST',
- trailer: 'SE',
+ tag: "ST",
+ trailer: "SE",
layout: {
ST01: 3,
ST02: 9,
@@ -65,6 +66,6 @@ export const STSegmentHeader: X12SegmentHeader = {
ST03_MIN: 1,
COUNT: 3,
COUNT_MIN: 2,
- PADDING: false
- }
-}
+ PADDING: false,
+ },
+};
diff --git a/src/X12SerializationOptions.ts b/src/X12SerializationOptions.ts
index 1ffe264..2c87619 100644
--- a/src/X12SerializationOptions.ts
+++ b/src/X12SerializationOptions.ts
@@ -1,7 +1,12 @@
-'use strict'
-import { X12SegmentHeader, GSSegmentHeader, ISASegmentHeader, STSegmentHeader } from './X12SegmentHeader'
+"use strict";
+import {
+ GSSegmentHeader,
+ ISASegmentHeader,
+ STSegmentHeader,
+ X12SegmentHeader,
+} from "./X12SegmentHeader.ts";
-export type TxEngine = 'liquidjs' | 'internal'
+export type TxEngine = "liquidjs" | "internal";
/**
* @description Options for serializing to and from EDI.
@@ -19,32 +24,41 @@ export type TxEngine = 'liquidjs' | 'internal'
* Class instance wrapper for serialization options.
*/
export class X12SerializationOptions {
- constructor (options: X12SerializationOptions = {}) {
- this.elementDelimiter = options.elementDelimiter === undefined ? '*' : options.elementDelimiter
- this.endOfLine = options.endOfLine === undefined ? '\n' : options.endOfLine
- this.format = options.format === undefined ? false : options.format
- this.segmentTerminator = options.segmentTerminator === undefined ? '~' : options.segmentTerminator
- this.subElementDelimiter = options.subElementDelimiter === undefined ? '>' : options.subElementDelimiter
- this.repetitionDelimiter = options.repetitionDelimiter === undefined ? '^' : options.repetitionDelimiter
- this.segmentHeaders =
- options.segmentHeaders === undefined
- ? [GSSegmentHeader, ISASegmentHeader, STSegmentHeader]
- : options.segmentHeaders
- this.txEngine = options.txEngine === undefined ? 'internal' : options.txEngine
+ constructor(options: X12SerializationOptions = {}) {
+ this.elementDelimiter = options.elementDelimiter === undefined
+ ? "*"
+ : options.elementDelimiter;
+ this.endOfLine = options.endOfLine === undefined ? "\n" : options.endOfLine;
+ this.format = options.format === undefined ? false : options.format;
+ this.segmentTerminator = options.segmentTerminator === undefined
+ ? "~"
+ : options.segmentTerminator;
+ this.subElementDelimiter = options.subElementDelimiter === undefined
+ ? ">"
+ : options.subElementDelimiter;
+ this.repetitionDelimiter = options.repetitionDelimiter === undefined
+ ? "^"
+ : options.repetitionDelimiter;
+ this.segmentHeaders = options.segmentHeaders === undefined
+ ? [GSSegmentHeader, ISASegmentHeader, STSegmentHeader]
+ : options.segmentHeaders;
+ this.txEngine = options.txEngine === undefined
+ ? "internal"
+ : options.txEngine;
- if (this.segmentTerminator === '\n') {
- this.endOfLine = ''
+ if (this.segmentTerminator === "\n") {
+ this.endOfLine = "";
}
}
- elementDelimiter?: string
- endOfLine?: string
- format?: boolean
- segmentTerminator?: string
- subElementDelimiter?: string
- repetitionDelimiter?: string
- segmentHeaders?: X12SegmentHeader[]
- txEngine?: TxEngine
+ elementDelimiter?: string;
+ endOfLine?: string;
+ format?: boolean;
+ segmentTerminator?: string;
+ subElementDelimiter?: string;
+ repetitionDelimiter?: string;
+ segmentHeaders?: X12SegmentHeader[];
+ txEngine?: TxEngine;
}
/**
@@ -52,6 +66,8 @@ export class X12SerializationOptions {
* @param {X12SerializationOptions} [options] - Options for serializing to and from EDI.
* @returns {X12SerializationOptions} Serialization options with defaults filled in.
*/
-export function defaultSerializationOptions (options?: X12SerializationOptions): X12SerializationOptions {
- return new X12SerializationOptions(options)
+export function defaultSerializationOptions(
+ options?: X12SerializationOptions,
+): X12SerializationOptions {
+ return new X12SerializationOptions(options);
}
diff --git a/src/X12Transaction.ts b/src/X12Transaction.ts
index f5e9a25..a1fdd28 100644
--- a/src/X12Transaction.ts
+++ b/src/X12Transaction.ts
@@ -1,39 +1,43 @@
-'use strict'
-
-import { JSEDITransaction } from './JSEDINotation'
-import { X12Segment } from './X12Segment'
-import { STSegmentHeader } from './X12SegmentHeader'
-import { X12TransactionMap } from './X12TransactionMap'
-import { defaultSerializationOptions, X12SerializationOptions } from './X12SerializationOptions'
-import type { X12QueryMode } from './X12QueryEngine'
+// deno-lint-ignore-file no-explicit-any ban-types
+"use strict";
+
+import { JSEDITransaction } from "./JSEDINotation.ts";
+import { X12Segment } from "./X12Segment.ts";
+import { STSegmentHeader } from "./X12SegmentHeader.ts";
+import { X12TransactionMap } from "./X12TransactionMap.ts";
+import {
+ defaultSerializationOptions,
+ X12SerializationOptions,
+} from "./X12SerializationOptions.ts";
+import type { X12QueryMode } from "./X12QueryEngine.ts";
export class X12Transaction {
/**
* @description Create a transaction set.
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
*/
- constructor (options?: X12SerializationOptions) {
- this.segments = new Array()
- this.options = defaultSerializationOptions(options)
+ constructor(options?: X12SerializationOptions) {
+ this.segments = new Array();
+ this.options = defaultSerializationOptions(options);
}
- header: X12Segment
- trailer: X12Segment
+ header!: X12Segment;
+ trailer!: X12Segment;
- segments: X12Segment[]
+ segments: X12Segment[];
- options: X12SerializationOptions
+ options: X12SerializationOptions;
/**
* @description Set a ST header on this transaction set.
* @param {string[]} elements - An array of elements for a ST header.
*/
- setHeader (elements: string[]): void {
- this.header = new X12Segment(STSegmentHeader.tag, this.options)
+ setHeader(elements: string[]): void {
+ this.header = new X12Segment(STSegmentHeader.tag, this.options);
- this.header.setElements(elements)
+ this.header.setElements(elements);
- this._setTrailer()
+ this._setTrailer();
}
/**
@@ -42,16 +46,16 @@ export class X12Transaction {
* @param {string[]} elements - An array of elements for this segment.
* @returns {X12Segment} The segment added to this transaction set.
*/
- addSegment (tag: string, elements: string[]): X12Segment {
- const segment = new X12Segment(tag, this.options)
+ addSegment(tag: string, elements: string[]): X12Segment {
+ const segment = new X12Segment(tag, this.options);
- segment.setElements(elements)
+ segment.setElements(elements);
- this.segments.push(segment)
+ this.segments.push(segment);
- this.trailer.replaceElement(`${this.segments.length + 2}`, 1)
+ this.trailer.replaceElement(`${this.segments.length + 2}`, 1);
- return segment
+ return segment;
}
/**
@@ -60,10 +64,10 @@ export class X12Transaction {
* @param {object} map - The javascript object containing keys and querys to resolve.
* @param {object} [macro] - A macro object to add or override methods for the macro directive; properties 'header' and 'segments' are reserved words.
*/
- fromObject (input: any, map: any, macro?: any): void {
- const mapper = new X12TransactionMap(map, this, this.options.txEngine)
+ fromObject(input: any, map: any, macro?: any): void {
+ const mapper = new X12TransactionMap(map, this, this.options.txEngine);
- mapper.fromObject(input, macro)
+ mapper.fromObject(input, macro);
}
/**
@@ -73,10 +77,14 @@ export class X12Transaction {
* @param {'strict'|'loose'} [mode] - The mode for the query engine when performing the transform.
* @returns {object} An object containing resolved values mapped to object keys.
*/
- toObject (map: object, helper?: Function | X12QueryMode, mode?: X12QueryMode): object {
- const mapper = new X12TransactionMap(map, this, helper as Function, mode)
-
- return mapper.toObject()
+ toObject(
+ map: object,
+ helper?: Function | X12QueryMode,
+ mode?: X12QueryMode,
+ ): object {
+ const mapper = new X12TransactionMap(map, this, helper as Function, mode);
+
+ return mapper.toObject();
}
/**
@@ -84,52 +92,57 @@ export class X12Transaction {
* @param {X12SerializationOptions} [options] - Options for serializing back to EDI.
* @returns {string} This transaction set converted to an EDI string.
*/
- toString (options?: X12SerializationOptions): string {
- options = options !== undefined ? defaultSerializationOptions(options) : this.options
+ toString(options?: X12SerializationOptions): string {
+ options = options !== undefined
+ ? defaultSerializationOptions(options)
+ : this.options;
- let edi = this.header.toString(options)
+ let edi = this.header.toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
for (const segment of this.segments) {
- edi += segment.toString(options)
+ edi += segment.toString(options);
if (options.format) {
- edi += options.endOfLine
+ edi += options.endOfLine;
}
}
- edi += this.trailer.toString(options)
+ edi += this.trailer.toString(options);
- return edi
+ return edi;
}
/**
* @description Serialize transaction set to JSON object.
* @returns {object} This transaction set converted to an object.
*/
- toJSON (): object {
- const jsen = new JSEDITransaction(this.header.elements.map(x => x.value))
+ toJSON(): object {
+ const jsen = new JSEDITransaction(this.header.elements.map((x) => x.value));
- this.segments.forEach(segment => {
+ this.segments.forEach((segment) => {
jsen.addSegment(
segment.tag,
- segment.elements.map(x => x.value)
- )
- })
+ segment.elements.map((x) => x.value),
+ );
+ });
- return jsen as object
+ return jsen as object;
}
/**
* @private
* @description Set a SE trailer on this transaction set.
*/
- private _setTrailer (): void {
- this.trailer = new X12Segment(STSegmentHeader.trailer, this.options)
+ private _setTrailer(): void {
+ this.trailer = new X12Segment(STSegmentHeader.trailer, this.options);
- this.trailer.setElements([`${this.segments.length + 2}`, this.header.valueOf(2)])
+ this.trailer.setElements([
+ `${this.segments.length + 2}`,
+ this.header?.valueOf(2) ?? "",
+ ]);
}
}
diff --git a/src/X12TransactionMap.ts b/src/X12TransactionMap.ts
index 100a9f7..dfc6914 100644
--- a/src/X12TransactionMap.ts
+++ b/src/X12TransactionMap.ts
@@ -1,13 +1,12 @@
-'use strict'
+// deno-lint-ignore-file no-explicit-any ban-types
+"use strict";
-import { QuerySyntaxError } from './Errors'
-import { X12Interchange } from './X12Interchange'
-import { X12QueryEngine, X12QueryMode } from './X12QueryEngine'
-import { X12Transaction } from './X12Transaction'
-import { TxEngine } from './X12SerializationOptions'
-// @ts-expect-error
-import * as nodeRequire from '../nodeRequire.js'
-import * as crypto from 'crypto'
+import { QuerySyntaxError } from "./Errors.ts";
+import { X12Interchange } from "./X12Interchange.ts";
+import { X12QueryEngine, X12QueryMode } from "./X12QueryEngine.ts";
+import { X12Transaction } from "./X12Transaction.ts";
+import { TxEngine } from "./X12SerializationOptions.ts";
+import { crypto, Liquid } from "../deps.ts";
/**
* @private
@@ -15,11 +14,11 @@ import * as crypto from 'crypto'
* @param {any} val - A value to check.
* @returns {boolean} Whether the value is empty.
*/
-function isEmpty (val: any): boolean {
- if (val === undefined || val === null) return true
- if (typeof val === 'string' && val.trim() === '') return true
+function isEmpty(val: any): boolean {
+ if (val === undefined || val === null) return true;
+ if (typeof val === "string" && val.trim() === "") return true;
- return false
+ return false;
}
/**
@@ -28,8 +27,8 @@ function isEmpty (val: any): boolean {
* @param {any} str - The string to check.
* @returns {boolean} Whether the string is a query mode.
*/
-function isX12QueryMode (str: any): str is X12QueryMode {
- return str === 'loose' || str === 'strict'
+function isX12QueryMode(str: any): str is X12QueryMode {
+ return str === "loose" || str === "strict";
}
/**
@@ -38,8 +37,8 @@ function isX12QueryMode (str: any): str is X12QueryMode {
* @param {any} str - The string to check.
* @returns {boolean} Whether the string is a query mode.
*/
- function isTxEngine (str: any): str is TxEngine {
- return str === 'internal' || str === 'liquidjs'
+function isTxEngine(str: any): str is TxEngine {
+ return str === "internal" || str === "liquidjs";
}
export class X12TransactionMap {
@@ -51,60 +50,93 @@ export class X12TransactionMap {
* @param {'liquidjs'|'internal'|'strict'|'loose'} [txEngine] - A macro engine to use; either 'internal' or 'liquidjs'; defaults to internal for backwords compatibility, or the mode.
* @param {'strict'|'loose'} [mode='strict'] - The mode for transforming, passed to the query engine, and defaults to 'strict'; may be set to 'loose' for new behavior with missing elements in the dom.
*/
- constructor (map: any, transaction?: X12Transaction, mode?: X12QueryMode)
- constructor (map: any, transaction?: X12Transaction, txEngine?: TxEngine)
- constructor (map: any, transaction?: X12Transaction, txEngine?: TxEngine, mode?: X12QueryMode)
- constructor (map: any, transaction?: X12Transaction, helper?: Function, mode?: X12QueryMode)
- constructor (map: any, transaction?: X12Transaction, helper?: Function, txEngine?: TxEngine)
- constructor (map: any, transaction?: X12Transaction, helper?: Function, txEngine?: TxEngine, mode?: X12QueryMode)
- constructor (map: any, transaction?: X12Transaction, helper?: Function | TxEngine | X12QueryMode, txEngine?: TxEngine | X12QueryMode, mode?: X12QueryMode) {
- this._map = map
- this._transaction = transaction
- this.helper = typeof helper === 'function' ? helper : this._helper
-
- if (typeof helper === 'string' && (typeof txEngine === 'undefined' || typeof mode === 'undefined')) {
+ constructor(map: any, transaction?: X12Transaction, mode?: X12QueryMode);
+ constructor(map: any, transaction?: X12Transaction, txEngine?: TxEngine);
+ constructor(
+ map: any,
+ transaction?: X12Transaction,
+ txEngine?: TxEngine,
+ mode?: X12QueryMode,
+ );
+ constructor(
+ map: any,
+ transaction?: X12Transaction,
+ helper?: Function,
+ mode?: X12QueryMode,
+ );
+ constructor(
+ map: any,
+ transaction?: X12Transaction,
+ helper?: Function,
+ txEngine?: TxEngine,
+ );
+ constructor(
+ map: any,
+ transaction?: X12Transaction,
+ helper?: Function,
+ txEngine?: TxEngine,
+ mode?: X12QueryMode,
+ );
+ constructor(
+ map: any,
+ transaction?: X12Transaction,
+ helper?: Function | TxEngine | X12QueryMode,
+ txEngine?: TxEngine | X12QueryMode,
+ mode?: X12QueryMode,
+ ) {
+ this._map = map;
+ if (transaction) this._transaction = transaction;
+ this.helper = typeof helper === "function" ? helper : this._helper;
+
+ if (
+ typeof helper === "string" &&
+ (typeof txEngine === "undefined" || typeof mode === "undefined")
+ ) {
if (isTxEngine(helper)) {
if (isX12QueryMode(txEngine)) {
- mode = txEngine
+ mode = txEngine;
}
- txEngine = helper
+ txEngine = helper;
} else if (isX12QueryMode(helper)) {
- mode = helper
+ mode = helper;
}
}
- if (typeof txEngine === 'string' && typeof mode === 'undefined' && isX12QueryMode(txEngine)) {
- mode = txEngine
+ if (
+ typeof txEngine === "string" && typeof mode === "undefined" &&
+ isX12QueryMode(txEngine)
+ ) {
+ mode = txEngine;
}
- this.txEngine = isTxEngine(txEngine) ? txEngine : 'internal'
- this._mode = isX12QueryMode(mode) ? mode : 'strict'
+ this.txEngine = isTxEngine(txEngine) ? txEngine : "internal";
+ this._mode = isX12QueryMode(mode) ? mode : "strict";
}
- protected _map: any
- protected _transaction: X12Transaction
- protected _object: any
- protected _mode: X12QueryMode
- helper: Function
- txEngine: TxEngine
+ protected _map: any;
+ protected _transaction!: X12Transaction;
+ protected _object: any;
+ protected _mode: X12QueryMode;
+ helper: Function;
+ txEngine: TxEngine;
/**
* @description Set the transaction set to map and optionally a helper function.
* @param {X12Transaction} transaction - A transaction set to map.
* @param {Function} helper - A helper function which will be executed on every resolved query value.
*/
- setTransaction (transaction: X12Transaction, helper?: Function): void {
- this._transaction = transaction
- this.helper = helper === undefined ? this._helper : helper
+ setTransaction(transaction: X12Transaction, helper?: Function): void {
+ this._transaction = transaction;
+ this.helper = helper === undefined ? this._helper : helper;
}
/**
* @description Set the transaction set to map and optionally a helper function.
* @returns {X12Transaction} The transaction from this instance.
*/
- getTransaction (): X12Transaction {
- return this._transaction
+ getTransaction(): X12Transaction {
+ return this._transaction;
}
/**
@@ -113,113 +145,131 @@ export class X12TransactionMap {
* @param {Function} [callback] - A callback function which will be passed to the helper function.
* @returns {object|object[]} The transaction set mapped to an object or an array of objects.
*/
- toObject (map?: any, callback?: Function): any {
- map = map === undefined ? this._map : map
+ toObject(map?: any, callback?: Function): any {
+ map = map === undefined ? this._map : map;
- const clone = JSON.parse(JSON.stringify(map))
- let clones: object[] = null
- const engine = new X12QueryEngine(false, this._mode)
- const interchange = new X12Interchange()
+ const clone = JSON.parse(JSON.stringify(map));
+ let clones: any = null;
+ const engine = new X12QueryEngine(false, this._mode);
+ const interchange = new X12Interchange();
interchange.setHeader([
- '00',
- '',
- '00',
- '',
- 'ZZ',
- '00000000',
- '01',
- '00000000',
- '000000',
- '0000',
- '|',
- '00000',
- '00000000',
- '0',
- 'P',
- '>'
- ])
- interchange.addFunctionalGroup().transactions = [this._transaction]
-
- Object.keys(map).forEach(key => {
+ "00",
+ "",
+ "00",
+ "",
+ "ZZ",
+ "00000000",
+ "01",
+ "00000000",
+ "000000",
+ "0000",
+ "|",
+ "00000",
+ "00000000",
+ "0",
+ "P",
+ ">",
+ ]);
+ interchange.addFunctionalGroup().transactions = [this._transaction];
+
+ Object.keys(map).forEach((key) => {
if (Object.prototype.hasOwnProperty.call(map, key) as boolean) {
- if (Array.isArray(map[key]) && typeof map[key][0] === 'string') {
- const typedArray: string[] = map[key] as string[]
- const newArray = new Array()
+ if (Array.isArray(map[key]) && typeof map[key][0] === "string") {
+ const typedArray: string[] = map[key] as string[];
+ const newArray = new Array();
- typedArray.forEach(query => {
+ typedArray.forEach((query) => {
try {
- const result = engine.querySingle(interchange, query, '')
+ const result = engine.querySingle(interchange, query, "");
if (result === null) {
- newArray.push(null)
- } else if (result.value === null || Array.isArray(clone[key][0])) {
+ newArray.push(null);
+ } else if (
+ result.value === null || Array.isArray(clone[key][0])
+ ) {
if (result.value !== null) {
clone[key].forEach((array: string[]) => {
- array.push(this.helper(key, result.value, query, callback))
- })
+ array.push(this.helper(key, result.value, query, callback));
+ });
} else {
- let superArray = new Array()
+ let superArray = new Array();
if (Array.isArray(clone[key][0])) {
- superArray = clone[key]
+ superArray = clone[key];
}
- result.values.forEach((value: string, index: number) => {
+ result.values.forEach((value, index) => {
if (!Array.isArray(superArray[index])) {
- superArray[index] = new Array()
+ superArray[index] = new Array();
}
- superArray[index].push(this.helper(key, value, query, callback))
- })
+ superArray[index].push(
+ this.helper(key, value, query, callback),
+ );
+ });
- newArray.push(...superArray)
+ newArray.push(...superArray);
}
} else {
- newArray.push(this.helper(key, result.value, query, callback))
+ newArray.push(this.helper(key, result.value, query, callback));
}
} catch (err) {
- throw new QuerySyntaxError(`${err.message}; bad query in ${map[key]}`)
+ throw new QuerySyntaxError(
+ `${err.message}; bad query in ${map[key]}`,
+ );
}
- })
+ });
- clone[key] = newArray
- } else if (typeof map[key] === 'string') {
+ clone[key] = newArray;
+ } else if (typeof map[key] === "string") {
try {
- const result = engine.querySingle(interchange, map[key], '')
+ const result = engine.querySingle(interchange, map[key], "");
if (result === null) {
- clone[key] = null
+ clone[key] = null;
} else if (result.value === null || Array.isArray(clones)) {
if (result.value !== null) {
- clones.forEach((cloned: object[]) => {
- cloned[key as unknown as number] = this.helper(key, result.value, map[key], callback)
- })
+ clones.forEach((cloned: any) => {
+ cloned[key as unknown as number] = this.helper(
+ key,
+ result.value,
+ map[key],
+ callback,
+ );
+ });
} else {
if (!Array.isArray(clones)) {
- clones = new Array()
+ clones = [];
}
- result.values.forEach((value: string, index: number) => {
+ result.values.forEach((value, index) => {
if (clones[index] === undefined) {
- clones[index] = JSON.parse(JSON.stringify(clone))
+ clones[index] = JSON.parse(JSON.stringify(clone));
}
- clones[index][key] = this.helper(key, value, map[key], callback)
- })
+ (clones as any)[index][key] = this.helper(
+ key,
+ value,
+ map[key],
+ callback,
+ );
+ });
}
} else {
- clone[key] = this.helper(key, result.value, map[key], callback)
+ clone[key] = this.helper(key, result.value, map[key], callback);
}
} catch (err) {
- throw new QuerySyntaxError(`${err.message}; bad query in ${map[key]}`)
+ throw new QuerySyntaxError(
+ `${err.message}; bad query in ${map[key]}`,
+ );
}
} else {
- clone[key] = this.toObject(map[key])
+ clone[key] = this.toObject(map[key]);
}
}
- })
+ });
- return Array.isArray(clones) ? clones : clone
+ return Array.isArray(clones) ? clones : clone;
}
/**
@@ -229,283 +279,299 @@ export class X12TransactionMap {
* @param {object} [macroObj={}] - A macro object to add or override methods for the macro directive; properties 'header' and 'segments' are reserved words.
* @returns {X12Transaction} The transaction created from the object values.
*/
- fromObject (input: any, map?: any, macroObj: any = {}): X12Transaction {
- const counter: { [key: string]: number } = {}
- const levels: { [key: string]: number[] } = {}
- let liquidjs: any
+ fromObject(input: any, map?: any, macroObj: any = {}): X12Transaction {
+ const counter: { [key: string]: number } = {};
+ const levels: { [key: string]: number[] } = {};
+ let liquidjs: any;
const macro: {
- counter: { [key: string]: number }
- [key: string]: any
+ counter: { [key: string]: number };
+ [key: string]: any;
} = {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
counter: {},
- currentDate: `${new Date().getFullYear()}${(new Date().getMonth() + 1).toString().padStart(2, '0')}${new Date()
- .getDate()
- .toString()
- .padStart(2, '0')}`,
- sequence: function sequence (value: string) {
+ currentDate: `${new Date().getFullYear()}${
+ (new Date().getMonth() + 1).toString().padStart(2, "0")
+ }${
+ new Date()
+ .getDate()
+ .toString()
+ .padStart(2, "0")
+ }`,
+ sequence: function sequence(value: string) {
if (macro.counter[value] === undefined) {
- macro.counter[value] = 1
+ macro.counter[value] = 1;
} else {
- macro.counter[value] += 1
+ macro.counter[value] += 1;
}
return {
- val: macro.counter[value]
- }
+ val: macro.counter[value],
+ };
},
- json: function json (value: string) {
+ json: function json(value: string) {
return {
- val: JSON.parse(value)
- }
+ val: JSON.parse(value),
+ };
},
- length: function length (value: any[]) {
+ length: function length(value: any[]) {
return {
- val: value.length
- }
+ val: value.length,
+ };
},
map: function (value: any[], property: string) {
return {
- val: value.map(item => item[property])
- }
+ val: value.map((item) => item[property]),
+ };
},
sum: function (value: any[], property: string, dec: number) {
- let sum = 0
+ let sum = 0;
value.forEach((item: { [key: string]: number }) => {
- sum += item[property]
- })
+ sum += item[property];
+ });
return {
- val: sum.toFixed(dec === undefined ? 0 : dec)
- }
+ val: sum.toFixed(dec === undefined ? 0 : dec),
+ };
},
- random: function random () {
+ random: function random() {
return {
- val: Math.floor(1000 + Math.random() * 10000)
- }
+ val: Math.floor(1000 + Math.random() * 10000),
+ };
},
- truncate: function truncate (value: string | string[], maxChars: number) {
+ truncate: function truncate(value: string | string[], maxChars: number) {
if (Array.isArray(value)) {
- value = value.map(str => str.substring(0, maxChars))
+ value = value.map((str) => str.substring(0, maxChars));
} else {
- value = `${value}`.substring(0, maxChars)
+ value = `${value}`.substring(0, maxChars);
}
return {
- val: value
- }
- }
- }
+ val: value,
+ };
+ },
+ };
const LIQUID_FILTERS: {
- [name: string]: (...args: any[]) => any
+ [name: string]: (...args: any[]) => any;
} = {
- hl_root: (value: string, depth: number = 0) => {
+ hl_root: (value: string, depth = 0) => {
if (counter[value] === undefined) {
- counter[value] = 0
+ counter[value] = 0;
}
- counter[value] += 1
- levels[value][depth] = counter[value]
+ counter[value] += 1;
+ levels[value][depth] = counter[value];
- return counter[value]
+ return counter[value];
},
hl_parent: (value: string, depth: number) => {
if (levels[value][depth] === undefined) {
- return 1
+ return 1;
}
- return levels[value][depth]
+ return levels[value][depth];
},
sequence: (value: string) => {
if (counter[value] === undefined) {
- counter[value] = 1
+ counter[value] = 1;
} else {
- counter[value] += 1
+ counter[value] += 1;
}
- return counter[value]
+ return counter[value];
},
sum_array: (value: any[]) => {
- if (typeof value === 'undefined') return 0
- let sum = 0
+ if (typeof value === "undefined") return 0;
+ let sum = 0;
value.forEach((item: number) => {
- sum += item
- })
+ sum += item;
+ });
- return sum
+ return sum;
},
in_loop: (value: any) => {
- return LIQUID_FILTERS.json_stringify(value)
+ return LIQUID_FILTERS.json_stringify(value);
},
json_stringify: (value: any) => {
- return JSON.stringify(value)
+ return JSON.stringify(value);
},
json_parse: (value: string) => {
- if (typeof value === 'undefined') return ''
+ if (typeof value === "undefined") return "";
- return JSON.parse(value)
+ return JSON.parse(value);
},
truncate: (value: string | string[], maxChars: number) => {
- if (typeof value === 'undefined') return ''
+ if (typeof value === "undefined") return "";
if (Array.isArray(value)) {
- return value.map(str => {
- if (typeof str === 'undefined') return ''
+ return value.map((str) => {
+ if (typeof str === "undefined") return "";
- return str.substring(0, maxChars)
- })
+ return str.substring(0, maxChars);
+ });
}
- return `${value}`.substring(0, maxChars)
+ return `${value}`.substring(0, maxChars);
},
- random: (val: string, maxLength: number = 4) => {
- const bytes = Math.ceil(maxLength / 2)
- const buffer = crypto.randomBytes(bytes)
- const hex = buffer.toString('hex')
+ random: (_val: string, maxLength = 4) => {
+ const bytes = Math.ceil(maxLength / 2);
+ const buffer = crypto.randomBytes(bytes);
+ const hex = buffer.toString("hex");
return parseInt(hex, 16)
.toString()
- .substring(0, maxLength)
+ .substring(0, maxLength);
},
- edi_date: (val: string, length: string = 'long') => {
- const date = !isEmpty(val) ? new Date(val) : new Date()
- const ediDate = `${date.getUTCFullYear()}${(date.getUTCMonth() + 1).toString().padStart(2, '0')}${date
- .getUTCDate()
- .toString()
- .padStart(2, '0')}`
-
- if (length !== 'long') {
- return ediDate.substring(2, ediDate.length)
+ edi_date: (val: string, length = "long") => {
+ const date = !isEmpty(val) ? new Date(val) : new Date();
+ const ediDate = `${date.getUTCFullYear()}${
+ (date.getUTCMonth() + 1).toString().padStart(2, "0")
+ }${
+ date
+ .getUTCDate()
+ .toString()
+ .padStart(2, "0")
+ }`;
+
+ if (length !== "long") {
+ return ediDate.substring(2, ediDate.length);
}
- return ediDate
+ return ediDate;
},
edi_time: (val: string) => {
- const date = !isEmpty(val) ? new Date(val) : new Date()
-
- return `${date
- .getUTCHours()
- .toString()
- .padStart(2, '0')}${date
- .getUTCMinutes()
- .toString()
- .padStart(2, '0')}`
- }
- }
+ const date = !isEmpty(val) ? new Date(val) : new Date();
+
+ return `${
+ date
+ .getUTCHours()
+ .toString()
+ .padStart(2, "0")
+ }${
+ date
+ .getUTCMinutes()
+ .toString()
+ .padStart(2, "0")
+ }`;
+ },
+ };
- const resolveKey = function resolveKey (key: string): any {
- if (typeof liquidjs !== 'undefined') {
- const result: any = liquidjs.parseAndRenderSync(key, { input })
+ const resolveKey = function resolveKey(key: string): any {
+ if (typeof liquidjs !== "undefined") {
+ const result: any = liquidjs.parseAndRenderSync(key, { input });
- return key.indexOf('in_loop }}') > -1 ? JSON.parse(result) : result
+ return key.indexOf("in_loop }}") > -1 ? JSON.parse(result) : result;
} else {
- const clean = /(^(`\${)*(input|macro)\[.*(}`)*$)/g
+ const clean = /(^(`\${)*(input|macro)\[.*(}`)*$)/g;
if (clean.test(key)) {
// eslint-disable-next-line no-eval
- const result: any = eval(key)
+ const result: any = eval(key);
- return result === undefined ? '' : result
+ return result === undefined ? "" : result;
} else {
- return key
+ return key;
}
}
- }
+ };
- const resolveLoop = function resolveLoop (lp: any[], tx: X12Transaction): void {
- const start = lp[0]
- const length = parseFloat(resolveKey(start.loopLength))
+ const resolveLoop = function resolveLoop(
+ lp: any[],
+ tx: X12Transaction,
+ ): void {
+ const start = lp[0];
+ const length = parseFloat(resolveKey(start.loopLength));
for (let i = 0; i < length; i += 1) {
- lp.forEach(segment => {
- const elements = []
+ lp.forEach((segment) => {
+ const elements = [];
for (const segElement of segment.elements) {
- const resolved = resolveKey(segElement)
+ const resolved = resolveKey(segElement);
if (Array.isArray(resolved)) {
- elements.push(resolved[i])
+ elements.push(resolved[i]);
} else {
- elements.push(resolved)
+ elements.push(resolved);
}
}
- tx.addSegment(segment.tag, elements)
- })
+ tx.addSegment(segment.tag, elements);
+ });
}
- }
+ };
if (map !== undefined) {
if (map.header === undefined || map.segments === undefined) {
- macroObj = map
- map = undefined
+ macroObj = map;
+ map = undefined;
}
}
- map = map === undefined ? this._map : map
+ map = map === undefined ? this._map : map;
- if (this.txEngine === 'liquidjs') {
- const { Liquid } = nodeRequire('liquidjs')
- const engine = new Liquid({ strictFilters: true })
+ if (this.txEngine === "liquidjs") {
+ const engine = new Liquid({ strictFilters: true });
for (const [name, func] of Object.entries(LIQUID_FILTERS)) {
- engine.registerFilter(name, func)
+ engine.registerFilter(name, func);
}
- if (typeof macroObj === 'object') {
+ if (typeof macroObj === "object") {
for (const [name, func] of Object.entries(macroObj)) {
- if (typeof name === 'string' && typeof func === 'function') {
- engine.registerFilter(name, func)
+ if (typeof name === "string" && typeof func === "function") {
+ engine.registerFilter(name, func as any);
}
}
}
- liquidjs = engine
+ liquidjs = engine;
} else {
- Object.assign(macro, macroObj)
+ Object.assign(macro, macroObj);
}
- const transaction = this._transaction === undefined ? new X12Transaction() : this._transaction
- const header = []
- let looper: any[] = []
- let loop = false
+ const transaction = this._transaction === undefined
+ ? new X12Transaction()
+ : this._transaction;
+ const header = [];
+ let looper: any[] = [];
+ let loop = false;
for (const headerElement of map.header) {
- header.push(resolveKey(headerElement))
+ header.push(resolveKey(headerElement));
}
- transaction.setHeader(header)
+ transaction.setHeader(header);
for (const segment of map.segments) {
- const elements = []
+ const elements = [];
if (segment.loopStart as boolean) {
- looper.push(segment)
- loop = true
+ looper.push(segment);
+ loop = true;
} else if (loop) {
- looper.push(segment)
+ looper.push(segment);
}
if (!loop) {
for (const segElement of segment.elements) {
- elements.push(resolveKey(segElement))
+ elements.push(resolveKey(segElement));
}
- transaction.addSegment(segment.tag, elements)
+ transaction.addSegment(segment.tag, elements);
}
if (segment.loopEnd as boolean) {
- resolveLoop(looper, transaction)
- looper = []
- loop = false
+ resolveLoop(looper, transaction);
+ looper = [];
+ loop = false;
}
}
- this._transaction = transaction
+ this._transaction = transaction;
- return transaction
+ return transaction;
}
/**
@@ -517,11 +583,16 @@ export class X12TransactionMap {
* @param {Function} [callback] - A callback function for signalling back from the helper function.
* @returns {string} The value as resolved by the query engine; custom helpers may modify this value further.
*/
- private _helper (key: string, value: string, query?: string, callback?: Function): string {
+ private _helper(
+ key: string,
+ value: string,
+ query?: string,
+ callback?: Function,
+ ): string {
if (callback !== undefined) {
- callback(key, value, query)
+ callback(key, value, query);
}
- return value
+ return value;
}
}
diff --git a/src/X12ValidationEngine/Interfaces.ts b/src/X12ValidationEngine/Interfaces.ts
index f9a8fd6..910afb7 100644
--- a/src/X12ValidationEngine/Interfaces.ts
+++ b/src/X12ValidationEngine/Interfaces.ts
@@ -1,54 +1,60 @@
-import { X12Segment } from '../X12Segment'
-import { X12SerializationOptions } from '../X12SerializationOptions'
+import { X12Segment } from "../X12Segment.ts";
+import { X12SerializationOptions } from "../X12SerializationOptions.ts";
-export type GroupResponseCode = 'A' | 'E' | 'P' | 'R' | 'M' | 'W' | 'X'
+export type GroupResponseCode = "A" | "E" | "P" | "R" | "M" | "W" | "X";
-export type ValidationType = 'element' | 'segment' | 'transaction' | 'group' | 'interchange'
+export type ValidationType =
+ | "element"
+ | "segment"
+ | "transaction"
+ | "group"
+ | "interchange";
export interface ValidationEngineOptions {
acknowledgement?: {
- isa: X12Segment
- gs: X12Segment
- options?: X12SerializationOptions
- handling?: 'reject' | 'note_errors' | 'allow_partial'
- }
- throwError?: boolean
- ackMap?: any
+ isa: X12Segment;
+ gs: X12Segment;
+ options?: X12SerializationOptions;
+ handling?: "reject" | "note_errors" | "allow_partial";
+ };
+ throwError?: boolean;
+ // deno-lint-ignore no-explicit-any
+ ackMap?: any;
}
export interface ValidationReport {
interchange?: {
- header?: ValidationReport
- trailer?: ValidationReport
- }
+ header?: ValidationReport;
+ trailer?: ValidationReport;
+ };
group?: {
- groupId: string
- groupNumber: number
- groupResponse?: GroupResponseCode
- transactionCount: number
- responseLevel?: 'reject' | 'note_errors' | 'allow_partial'
- errors: ValidationError[]
- }
+ groupId: string;
+ groupNumber: number;
+ groupResponse?: GroupResponseCode;
+ transactionCount: number;
+ responseLevel?: "reject" | "note_errors" | "allow_partial";
+ errors: ValidationError[];
+ };
transaction?: {
- transactionId: string
- transactionNumber: number
- errors: ValidationError[]
- }
+ transactionId: string;
+ transactionNumber: number;
+ errors: ValidationError[];
+ };
segment?: {
- tag: string
- position: number
- errors: ValidationError[]
- }
- groups?: ValidationReport[]
- transactions?: ValidationReport[]
- segments?: ValidationReport[]
- elements?: ValidationError[]
+ tag: string;
+ position: number;
+ errors: ValidationError[];
+ };
+ groups?: ValidationReport[];
+ transactions?: ValidationReport[];
+ segments?: ValidationReport[];
+ elements?: ValidationError[];
}
export interface ValidationError {
- description: string
- codeType: ValidationType
- code: string
- position?: number
- dataSample?: string
+ description: string;
+ codeType: ValidationType;
+ code: string;
+ position?: number;
+ dataSample?: string;
}
diff --git a/src/X12ValidationEngine/X12ValidationEngine.ts b/src/X12ValidationEngine/X12ValidationEngine.ts
index 66cd33f..31389b1 100644
--- a/src/X12ValidationEngine/X12ValidationEngine.ts
+++ b/src/X12ValidationEngine/X12ValidationEngine.ts
@@ -1,184 +1,240 @@
-import { X12Segment } from '../X12Segment'
-import { X12Element } from '../X12Element'
-import { X12Transaction } from '../X12Transaction'
-import { X12FunctionalGroup } from '../X12FunctionalGroup'
-import { X12Interchange } from '../X12Interchange'
-import { X12SerializationOptions } from '../X12SerializationOptions'
-import { ValidationEngineOptions, ValidationReport, GroupResponseCode } from './Interfaces'
+import { X12Segment } from "../X12Segment.ts";
+import { X12Element } from "../X12Element.ts";
+import { X12Transaction } from "../X12Transaction.ts";
+import { X12FunctionalGroup } from "../X12FunctionalGroup.ts";
+import { X12Interchange } from "../X12Interchange.ts";
+import { X12SerializationOptions } from "../X12SerializationOptions.ts";
+import {
+ GroupResponseCode,
+ ValidationEngineOptions,
+ ValidationReport,
+} from "./Interfaces.ts";
import {
X12ElementRule,
- X12SegmentRule,
- X12TransactionRule,
X12GroupRule,
X12InterchangeRule,
- X12ValidationRule
-} from './X12ValidationRule'
+ X12SegmentRule,
+ X12TransactionRule,
+ X12ValidationRule,
+} from "./X12ValidationRule.ts";
const simpleAckMap = {
- header: ['997', '{{ macro | random }}'],
+ header: ["997", "{{ macro | random }}"],
segments: [
- { tag: 'AK1', elements: ['{{ input.group.groupId }}', '{{ input.group.groupNumber }}'] },
{
- tag: 'AK2',
+ tag: "AK1",
+ elements: ["{{ input.group.groupId }}", "{{ input.group.groupNumber }}"],
+ },
+ {
+ tag: "AK2",
elements: [
'{{ input.transactions | map: "transactionId" | in_loop }}',
- '{{ input.transactions | map: "transactionNumber" | in_loop }}'
+ '{{ input.transactions | map: "transactionNumber" | in_loop }}',
],
loopStart: true,
- loopLength: '{{ input.transactions | size }}'
+ loopLength: "{{ input.transactions | size }}",
},
{
- tag: 'AK5',
+ tag: "AK5",
elements: [
'{% assign len = input.transactions | size %}{% if len > 0 %}{% if input.group.responseLevel == "note_errors" %}E{% else %}R{% endif %}{% endif %}',
- '{{ input.transactions | map: "transaction.errors.0.code" }}'
+ '{{ input.transactions | map: "transaction.errors.0.code" }}',
],
- loopEnd: true
+ loopEnd: true,
},
{
- tag: 'AK9',
+ tag: "AK9",
elements: [
- '{{ input.group.groupResponse }}',
- '{{ input.group.transactionCount }}',
- '{{ input.group.transactionCount }}',
- '{% assign errors = input.transactions | size %}{{ input.group.transactionCount | minus: errors }}'
- ]
- }
- ]
-}
+ "{{ input.group.groupResponse }}",
+ "{{ input.group.transactionCount }}",
+ "{{ input.group.transactionCount }}",
+ "{% assign errors = input.transactions | size %}{{ input.group.transactionCount | minus: errors }}",
+ ],
+ },
+ ],
+};
export class ValidationEngineError extends Error {
- constructor (message: string, report: ValidationReport) {
- super(message)
+ constructor(message: string, report: ValidationReport) {
+ super(message);
- Object.setPrototypeOf(this, ValidationEngineError.prototype)
+ Object.setPrototypeOf(this, ValidationEngineError.prototype);
- this.report = report
+ this.report = report;
}
- report: ValidationReport
+ report: ValidationReport;
}
export class X12ValidationEngine {
- constructor (options: ValidationEngineOptions = {}) {
- const { acknowledgement, throwError, ackMap } = options
- this.pass = true
- this.throwError = false
- this.ackMap = typeof ackMap === 'object' ? ackMap : simpleAckMap
+ constructor(options: ValidationEngineOptions = {}) {
+ const { acknowledgement, throwError, ackMap } = options;
+ this.pass = true;
+ this.throwError = false;
+ this.ackMap = typeof ackMap === "object" ? ackMap : simpleAckMap;
- if (typeof acknowledgement === 'object') {
- const { isa, gs, options: x12options } = acknowledgement
+ if (typeof acknowledgement === "object") {
+ const { isa, gs, options: x12options } = acknowledgement;
- this.setAcknowledgement(isa, gs, { ...x12options, txEngine: 'liquidjs' })
+ this.setAcknowledgement(isa, gs, { ...x12options, txEngine: "liquidjs" });
}
- if (throwError) this.throwError = true
+ if (throwError) this.throwError = true;
}
- pass: boolean
- report?: ValidationReport
- acknowledgement?: X12Interchange
- hardErrors?: Error[]
- throwError: boolean
- private readonly ackMap: any
-
- private setAcknowledgement (isa?: X12Segment, gs?: X12Segment, options?: X12SerializationOptions): void {
+ pass: boolean;
+ report?: ValidationReport;
+ acknowledgement?: X12Interchange;
+ hardErrors?: Error[];
+ throwError: boolean;
+ // deno-lint-ignore no-explicit-any
+ private readonly ackMap: any;
+
+ private setAcknowledgement(
+ isa?: X12Segment,
+ gs?: X12Segment,
+ options?: X12SerializationOptions,
+ ): void {
if (isa instanceof X12Segment && gs instanceof X12Segment) {
- this.acknowledgement = new X12Interchange(options)
-
- this.acknowledgement.setHeader(isa.elements.map(element => element.value))
- this.acknowledgement.addFunctionalGroup().setHeader(gs.elements.map(element => element.value))
+ this.acknowledgement = new X12Interchange(options);
+
+ this.acknowledgement.setHeader(
+ isa.elements.map((element) => element.value),
+ );
+ this.acknowledgement.addFunctionalGroup().setHeader(
+ gs.elements.map((element) => element.value),
+ );
}
}
- assert (actual: X12Element, expected: X12ElementRule): true | ValidationReport
- assert (actual: X12Segment, expected: X12SegmentRule): true | ValidationReport
- assert (actual: X12Transaction, expected: X12TransactionRule): true | ValidationReport
- assert (
+ assert(actual: X12Element, expected: X12ElementRule): true | ValidationReport;
+ assert(actual: X12Segment, expected: X12SegmentRule): true | ValidationReport;
+ assert(
+ actual: X12Transaction,
+ expected: X12TransactionRule,
+ ): true | ValidationReport;
+ assert(
actual: X12FunctionalGroup,
expected: X12GroupRule,
- groupResponse?: GroupResponseCode
- ): true | ValidationReport
- assert (
+ groupResponse?: GroupResponseCode,
+ ): true | ValidationReport;
+ assert(
actual: X12Interchange,
expected: X12InterchangeRule,
- groupResponse?: GroupResponseCode
- ): true | ValidationReport
- assert (actual: any, expected: X12ValidationRule, groupResponse?: GroupResponseCode): true | ValidationReport {
+ groupResponse?: GroupResponseCode,
+ ): true | ValidationReport;
+ // deno-lint-ignore no-explicit-any
+ assert(
+ actual: any,
+ expected: X12ValidationRule,
+ _groupResponse?: GroupResponseCode,
+ ): true | ValidationReport {
const setReport = (results: true | ValidationReport): void => {
if (results !== true) {
- this.pass = false
- this.report = results
+ this.pass = false;
+ this.report = results;
}
- }
- const passingReport = function (groupId: string, groupNumber: number, transactionCount: number): ValidationReport {
+ };
+ const passingReport = function (
+ groupId: string,
+ groupNumber: number,
+ transactionCount: number,
+ ): ValidationReport {
return {
- group: { groupId, groupNumber, transactionCount, groupResponse: 'A', errors: [] },
- transactions: []
- }
- }
+ group: {
+ groupId,
+ groupNumber,
+ transactionCount,
+ groupResponse: "A",
+ errors: [],
+ },
+ transactions: [],
+ };
+ };
- if (actual instanceof X12Interchange && expected instanceof X12InterchangeRule) {
- const groupId = actual.functionalGroups[0].header.valueOf(1)
- const groupNumber = parseFloat(actual.functionalGroups[0].header.valueOf(6, '0'))
- const transactionCount = actual.functionalGroups[0].transactions.length
+ if (
+ actual instanceof X12Interchange && expected instanceof X12InterchangeRule
+ ) {
+ const groupId = actual.functionalGroups[0].header.valueOf(1) ?? "";
+ const groupNumber = parseFloat(
+ actual.functionalGroups[0].header.valueOf(6, "0") ?? "0",
+ );
+ const transactionCount = actual.functionalGroups[0].transactions.length;
- setReport(expected.assert(actual))
+ setReport(expected.assert?.(actual) ?? {});
if (this.pass) {
this.report = {
- groups: [passingReport(groupId, groupNumber, transactionCount)]
- }
+ groups: [passingReport(groupId, groupNumber, transactionCount)],
+ };
}
}
- if (actual instanceof X12FunctionalGroup && expected instanceof X12GroupRule) {
- const groupId = actual.header.valueOf(1)
- const groupNumber = parseFloat(actual.header.valueOf(6, '0'))
- const transactionCount = actual.transactions.length
+ if (
+ actual instanceof X12FunctionalGroup && expected instanceof X12GroupRule
+ ) {
+ const groupId = actual.header.valueOf(1) ?? "";
+ const groupNumber = parseFloat(actual.header.valueOf(6, "0") ?? "0");
+ const transactionCount = actual.transactions.length;
- setReport(expected.assert(actual, groupNumber))
+ setReport(expected.assert?.(actual, groupNumber) ?? {});
- if (this.pass) this.report = passingReport(groupId, groupNumber, transactionCount)
+ if (this.pass) {
+ this.report = passingReport(groupId, groupNumber, transactionCount);
+ }
}
- if (actual instanceof X12Transaction && expected instanceof X12TransactionRule) {
- const transactionNumber = parseFloat(actual.header.valueOf(2, '0'))
+ if (
+ actual instanceof X12Transaction && expected instanceof X12TransactionRule
+ ) {
+ const transactionNumber = parseFloat(
+ actual.header.valueOf(2, "0") ?? "0",
+ );
- setReport(expected.assert(actual, transactionNumber))
+ setReport(expected.assert?.(actual, transactionNumber) ?? {});
}
if (actual instanceof X12Segment && expected instanceof X12SegmentRule) {
- setReport(expected.assert(actual))
+ setReport(expected.assert?.(actual) ?? {});
}
if (actual instanceof X12Element && expected instanceof X12ElementRule) {
- setReport(expected.assert(actual))
+ setReport(expected.assert?.(actual) ?? {});
}
if (this.throwError && !this.pass) {
- throw new ValidationEngineError('The actual X12 document did not meet the expected validation.', this.report)
+ throw new ValidationEngineError(
+ "The actual X12 document did not meet the expected validation.",
+ this.report ?? {},
+ );
}
- return this.pass || this.report
+ return this.pass || (this.report ?? {});
}
- acknowledge (isa?: X12Segment, gs?: X12Segment, options?: X12SerializationOptions): X12Interchange {
- this.setAcknowledgement(isa, gs, options)
+ acknowledge(
+ isa?: X12Segment,
+ gs?: X12Segment,
+ options?: X12SerializationOptions,
+ ): X12Interchange | undefined {
+ this.setAcknowledgement(isa, gs, options);
if (
this.acknowledgement instanceof X12Interchange &&
- typeof this.report === 'object' &&
- (Array.isArray(this.report.groups) || typeof this.report.group === 'object')
+ typeof this.report === "object" &&
+ (Array.isArray(this.report.groups) ||
+ typeof this.report.group === "object")
) {
this.acknowledgement.functionalGroups[0].addTransaction().fromObject(
{
- group: typeof this.report.groups === 'object' ? this.report.groups[0].group : this.report.group
+ group: typeof this.report.groups === "object"
+ ? this.report.groups[0].group
+ : this.report.group,
},
- this.ackMap
- )
+ this.ackMap,
+ );
- return this.acknowledgement
+ return this.acknowledgement;
}
}
}
diff --git a/src/X12ValidationEngine/X12ValidationErrorCode.ts b/src/X12ValidationEngine/X12ValidationErrorCode.ts
index 3c090a2..4a0bfb6 100644
--- a/src/X12ValidationEngine/X12ValidationErrorCode.ts
+++ b/src/X12ValidationEngine/X12ValidationErrorCode.ts
@@ -1,52 +1,60 @@
-import { ValidationType, ValidationError } from './Interfaces'
+// deno-lint-ignore-file no-explicit-any
+import { ValidationError, ValidationType } from "./Interfaces.ts";
// Error codes taken from publicly available documentation
// at https://docs.microsoft.com/en-us/biztalk/core/x12-997-acknowledgment-error-codes
// and at https://support.edifabric.com/hc/en-us/articles/360000380131-X12-997-Acknowledgment-Error-Codes
-export const X12ValidationErrorCode: Record ValidationError> = {
- element (code: string, position?: number, dataSample?: string): ValidationError {
- const codeType = 'element'
- let description
+export const X12ValidationErrorCode: Record<
+ string,
+ (...args: any[]) => ValidationError
+> = {
+ element(
+ code: string,
+ position?: number,
+ dataSample?: string,
+ ): ValidationError {
+ const codeType = "element";
+ let description;
switch (code) {
- case '1':
- description = 'Mandatory data element missing'
- break
- case '2':
- description = 'Conditional and required data element missing'
- break
- case '3': // Return this for any elements outside the validation range.
- description = 'Too many data elements'
- break
- case '4':
- description = 'The data element is too short'
- break
- case '5':
- description = 'The data element is too long'
- break
- case '6':
- description = 'Invalid character in data element'
- break
- case '8':
- description = 'Invalid date'
- break
- case '9':
- description = 'Invalid time'
- break
- case '10':
- description = 'Exclusion condition violated'
- break
- case '11':
- description = 'Too many repetitions'
- break
- case '12':
- description = 'Too many components'
- break
- case '7':
+ case "1":
+ description = "Mandatory data element missing";
+ break;
+ case "2":
+ description = "Conditional and required data element missing";
+ break;
+ case "3": // Return this for any elements outside the validation range.
+ description = "Too many data elements";
+ break;
+ case "4":
+ description = "The data element is too short";
+ break;
+ case "5":
+ description = "The data element is too long";
+ break;
+ case "6":
+ description = "Invalid character in data element";
+ break;
+ case "8":
+ description = "Invalid date";
+ break;
+ case "9":
+ description = "Invalid time";
+ break;
+ case "10":
+ description = "Exclusion condition violated";
+ break;
+ case "11":
+ description = "Too many repetitions";
+ break;
+ case "12":
+ description = "Too many components";
+ break;
+ case "7":
default:
- description = 'Invalid code value'
- code = '7'
- break
+ description = "Invalid code value";
+ code = "7";
+ break;
}
return {
@@ -54,167 +62,194 @@ export const X12ValidationErrorCode: Record Validati
codeType,
code,
position,
- dataSample
- }
+ dataSample,
+ };
},
- segment (code: string, position?: number): ValidationError {
- const codeType = 'segment'
- let description
+ segment(code: string, position?: number): ValidationError {
+ const codeType = "segment";
+ let description;
switch (code) {
- case '1':
- description = 'Unrecognized segment ID'
- break
- case '2':
- description = 'Unexpected segment'
- break
- case '3':
- description = 'Mandatory segment missing'
- break
- case '4':
- description = 'A loop occurs over maximum times'
- break
- case '5':
- description = 'Segment exceeds maximum use'
- break
- case '6':
- description = 'Segment not in a defined transaction set'
- break
- case '7':
- description = 'Segment not in proper sequence'
- break
- case '8':
+ case "1":
+ description = "Unrecognized segment ID";
+ break;
+ case "2":
+ description = "Unexpected segment";
+ break;
+ case "3":
+ description = "Mandatory segment missing";
+ break;
+ case "4":
+ description = "A loop occurs over maximum times";
+ break;
+ case "5":
+ description = "Segment exceeds maximum use";
+ break;
+ case "6":
+ description = "Segment not in a defined transaction set";
+ break;
+ case "7":
+ description = "Segment not in proper sequence";
+ break;
+ case "8":
default:
- description = 'The segment has data element errors'
- code = '8'
- break
+ description = "The segment has data element errors";
+ code = "8";
+ break;
}
return {
description,
codeType,
code,
- position
- }
+ position,
+ };
},
- transaction (code: string, position?: number): ValidationError {
- const codeType = 'transaction'
- let description
+ transaction(code: string, position?: number): ValidationError {
+ const codeType = "transaction";
+ let description;
switch (code) {
- case '1':
- description = 'The transaction set not supported'
- break
- case '2':
- description = 'Transaction set trailer missing'
- break
- case '3':
- description = 'The transaction set control number in header and trailer do not match'
- break
- case '4':
- description = 'Number of included segments does not match actual count'
- break
- case '5':
- description = 'One or more segments in error'
- break
- case '6':
- description = 'Missing or invalid transaction set identifier'
- break
- case '7':
+ case "1":
+ description = "The transaction set not supported";
+ break;
+ case "2":
+ description = "Transaction set trailer missing";
+ break;
+ case "3":
+ description =
+ "The transaction set control number in header and trailer do not match";
+ break;
+ case "4":
+ description = "Number of included segments does not match actual count";
+ break;
+ case "5":
+ description = "One or more segments in error";
+ break;
+ case "6":
+ description = "Missing or invalid transaction set identifier";
+ break;
+ case "7":
default:
description =
- 'Missing or invalid transaction set control number (a duplicate transaction number may have occurred)'
- code = '7'
- break
+ "Missing or invalid transaction set control number (a duplicate transaction number may have occurred)";
+ code = "7";
+ break;
}
return {
description,
codeType,
code,
- position
- }
+ position,
+ };
},
- group (code: string, position?: number): ValidationError {
- const codeType = 'group'
- let description
+ group(code: string, position?: number): ValidationError {
+ const codeType = "group";
+ let description;
switch (code) {
- case '1':
- description = 'The functional group not supported'
- break
- case '2':
- description = 'Functional group version not supported'
- break
- case '3':
- description = 'Functional group trailer missing'
- break
- case '4':
- description = 'Group control number in the functional group header and trailer do not agree'
- break
- case '5':
- description = 'Number of included transaction sets does not match actual count'
- break
- case '6':
+ case "1":
+ description = "The functional group not supported";
+ break;
+ case "2":
+ description = "Functional group version not supported";
+ break;
+ case "3":
+ description = "Functional group trailer missing";
+ break;
+ case "4":
+ description =
+ "Group control number in the functional group header and trailer do not agree";
+ break;
+ case "5":
+ description =
+ "Number of included transaction sets does not match actual count";
+ break;
+ case "6":
default:
- description = 'Group control number violates syntax (a duplicate group control number may have occurred)'
- code = '6'
- break
+ description =
+ "Group control number violates syntax (a duplicate group control number may have occurred)";
+ code = "6";
+ break;
}
return {
description,
codeType,
code,
- position
- }
+ position,
+ };
},
- acknowledgement (codeType: ValidationType, code: string, position?: number): ValidationError {
- let description
+ acknowledgement(
+ codeType: ValidationType,
+ code: string,
+ position?: number,
+ ): ValidationError {
+ let description;
switch (code) {
- case 'A':
- description = 'Accepted'
- break
- case 'M':
- description = 'Rejected, message authentication code (MAC) failed'
- break
- case 'P':
- description = 'Partially accepted, at least one transaction set was rejected'
- break
- case 'R':
- description = 'Rejected'
- break
- case 'W':
- description = 'Rejected, assurance failed validity tests'
- break
- case 'X':
- description = 'Rejected, content after decryption could not be analyzed'
- break
- case 'E':
+ case "A":
+ description = "Accepted";
+ break;
+ case "M":
+ description = "Rejected, message authentication code (MAC) failed";
+ break;
+ case "P":
+ description =
+ "Partially accepted, at least one transaction set was rejected";
+ break;
+ case "R":
+ description = "Rejected";
+ break;
+ case "W":
+ description = "Rejected, assurance failed validity tests";
+ break;
+ case "X":
+ description =
+ "Rejected, content after decryption could not be analyzed";
+ break;
+ case "E":
default:
- description = 'Accepted but errors were noted'
- code = 'E'
- break
+ description = "Accepted but errors were noted";
+ code = "E";
+ break;
}
return {
description,
codeType,
code,
- position
- }
- }
-}
+ position,
+ };
+ },
+};
-export function errorLookup (codeType: 'group', code: string, position?: number): ValidationError
-export function errorLookup (codeType: 'transaction', code: string, position?: number): ValidationError
-export function errorLookup (codeType: 'segment', code: string, position?: number): ValidationError
-export function errorLookup (codeType: 'element', code: string, position?: number, dataSample?: string): ValidationError
+export function errorLookup(
+ codeType?: "group",
+ code?: string,
+ position?: number,
+): ValidationError;
+export function errorLookup(
+ codeType?: "transaction",
+ code?: string,
+ position?: number,
+): ValidationError;
+export function errorLookup(
+ codeType?: "segment",
+ code?: string,
+ position?: number,
+): ValidationError;
+export function errorLookup(
+ codeType?: "element",
+ code?: string,
+ position?: number,
+ dataSample?: string,
+): ValidationError;
/**
* @description Look up a validation error by type and code.
* @param {ValidationType} codeType - The type of validation being performed.
@@ -223,11 +258,15 @@ export function errorLookup (codeType: 'element', code: string, position?: numbe
* @param {string} [dataSample] - A sample of data assciated with the error.
* @returns {ValidationError} The validation error for the lookup.
*/
-export function errorLookup (
- codeType: ValidationType,
- code: string,
+export function errorLookup(
+ codeType?: ValidationType,
+ code?: string,
position?: number,
- dataSample?: string
+ dataSample?: string,
): ValidationError {
- return X12ValidationErrorCode[codeType](code, position, dataSample)
+ return X12ValidationErrorCode[codeType ?? "segment"](
+ code,
+ position,
+ dataSample,
+ );
}
diff --git a/src/X12ValidationEngine/X12ValidationRule.ts b/src/X12ValidationEngine/X12ValidationRule.ts
index 55ed366..21668af 100644
--- a/src/X12ValidationEngine/X12ValidationRule.ts
+++ b/src/X12ValidationEngine/X12ValidationRule.ts
@@ -1,448 +1,537 @@
-import { X12Segment } from '../X12Segment'
-import { X12Element } from '../X12Element'
-import { X12Transaction } from '../X12Transaction'
-import { X12FunctionalGroup } from '../X12FunctionalGroup'
-import { X12Interchange } from '../X12Interchange'
-import { ValidationError, ValidationType, ValidationReport } from './Interfaces'
-import { errorLookup } from './X12ValidationErrorCode'
+// deno-lint-ignore-file no-explicit-any
+import { X12Segment } from "../X12Segment.ts";
+import { X12Element } from "../X12Element.ts";
+import { X12Transaction } from "../X12Transaction.ts";
+import { X12FunctionalGroup } from "../X12FunctionalGroup.ts";
+import { X12Interchange } from "../X12Interchange.ts";
+import {
+ ValidationError,
+ ValidationReport,
+ ValidationType,
+} from "./Interfaces.ts";
+import { errorLookup } from "./X12ValidationErrorCode.ts";
export class X12ValidationRule {
- constructor (options: X12ValidationRule) {
- this.ruleType = options.ruleType
- this.engine = options.engine
-
- if (typeof options.engine === 'string' && options.engine.toLowerCase() !== 'rule') {
- this.engine = new RegExp(options.engine, 'gu')
+ constructor(options: X12ValidationRule) {
+ this.ruleType = options.ruleType;
+ this.engine = options.engine;
+
+ if (
+ typeof options.engine === "string" &&
+ options.engine.toLowerCase() !== "rule"
+ ) {
+ this.engine = new RegExp(options.engine, "gu");
} else if (options.engine instanceof RegExp) {
- this.engine = options.engine
+ this.engine = options.engine;
} else {
- this.engine = 'rule'
+ this.engine = "rule";
}
}
- engine?: RegExp | 'rule' | string
- ruleType?: ValidationType
- failureCode?: string
+ engine?: RegExp | "rule" | string;
+ ruleType?: ValidationType;
+ failureCode?: string;
- assert? (value: any, position?: number): true | ValidationReport {
- const errors: ValidationError[] = []
+ assert?(value: any, position?: number): true | ValidationReport {
+ const errors: ValidationError[] = [];
if (this.engine instanceof RegExp) {
if (!this.engine.test(`${value}`)) {
- errors.push(errorLookup(this.ruleType as any, this.failureCode, position, value))
+ errors.push(
+ errorLookup(this.ruleType as any, this.failureCode, position, value),
+ );
}
}
- return errors.length === 0 || { elements: errors }
+ return errors.length === 0 || { elements: errors };
}
- toJSON? (): this {
+ toJSON?(): this {
if (this.engine instanceof RegExp) {
return {
...this,
- engine: this.engine.source
- }
+ engine: this.engine.source,
+ };
}
- return { ...this }
+ return { ...this };
}
}
export class X12InterchangeRule extends X12ValidationRule {
- constructor (options: X12InterchangeRule) {
- super({ ...options, engine: 'rule', ruleType: 'interchange' })
-
- if (options.header instanceof X12SegmentRule || typeof options.header === 'object') {
- this.header = new X12SegmentRule(options.header)
+ constructor(options: X12InterchangeRule) {
+ super({ ...options, engine: "rule", ruleType: "interchange" });
+
+ if (
+ options.header instanceof X12SegmentRule ||
+ typeof options.header === "object"
+ ) {
+ this.header = new X12SegmentRule(options.header);
} else {
this.header = new X12SegmentRule({
- tag: 'ISA',
+ tag: "ISA",
mandatory: true,
elements: [
- { mandatory: true, minMax: [2, 2], checkType: 'id' },
- { mandatory: true, allowBlank: true, minMax: [10, 10], checkType: 'alphanumeric' },
- { mandatory: true, minMax: [2, 2], checkType: 'id' },
- { mandatory: true, allowBlank: true, minMax: [10, 10], checkType: 'alphanumeric' },
- { mandatory: true, minMax: [2, 2], checkType: 'id' },
- { mandatory: true, minMax: [15, 15], checkType: 'alphanumeric' },
- { mandatory: true, minMax: [2, 2], checkType: 'id' },
- { mandatory: true, minMax: [15, 15], checkType: 'alphanumeric' },
- { mandatory: true, checkType: 'dateshort' },
- { mandatory: true, checkType: 'timeshort' },
- { mandatory: true, minMax: [1, 1], checkType: 'id' },
- { mandatory: true, minMax: [5, 5], checkType: 'id' },
- { mandatory: true, minMax: [9, 9], padLength: true, checkType: 'number' },
- { mandatory: true, minMax: [1, 1], checkType: 'id' },
- { mandatory: true, minMax: [1, 1], checkType: 'id' },
- { mandatory: true, minMax: [1, 1], checkType: 'alphanumeric' }
- ]
- })
+ { mandatory: true, minMax: [2, 2], checkType: "id" },
+ {
+ mandatory: true,
+ allowBlank: true,
+ minMax: [10, 10],
+ checkType: "alphanumeric",
+ },
+ { mandatory: true, minMax: [2, 2], checkType: "id" },
+ {
+ mandatory: true,
+ allowBlank: true,
+ minMax: [10, 10],
+ checkType: "alphanumeric",
+ },
+ { mandatory: true, minMax: [2, 2], checkType: "id" },
+ { mandatory: true, minMax: [15, 15], checkType: "alphanumeric" },
+ { mandatory: true, minMax: [2, 2], checkType: "id" },
+ { mandatory: true, minMax: [15, 15], checkType: "alphanumeric" },
+ { mandatory: true, checkType: "dateshort" },
+ { mandatory: true, checkType: "timeshort" },
+ { mandatory: true, minMax: [1, 1], checkType: "id" },
+ { mandatory: true, minMax: [5, 5], checkType: "id" },
+ {
+ mandatory: true,
+ minMax: [9, 9],
+ padLength: true,
+ checkType: "number",
+ },
+ { mandatory: true, minMax: [1, 1], checkType: "id" },
+ { mandatory: true, minMax: [1, 1], checkType: "id" },
+ { mandatory: true, minMax: [1, 1], checkType: "alphanumeric" },
+ ],
+ });
}
- this.group = new X12GroupRule(options.group)
+ this.group = new X12GroupRule(options.group);
- if (options.trailer instanceof X12SegmentRule || typeof options.trailer === 'object') {
- this.trailer = new X12SegmentRule(options.trailer)
+ if (
+ options.trailer instanceof X12SegmentRule ||
+ typeof options.trailer === "object"
+ ) {
+ this.trailer = new X12SegmentRule(options.trailer);
} else {
this.trailer = new X12SegmentRule({
- tag: 'IEA',
+ tag: "IEA",
elements: [
- { mandatory: true, maxLength: 5, checkType: 'number' },
- { mandatory: true, minMax: [9, 9], padLength: true, checkType: 'number' }
- ]
- })
+ { mandatory: true, maxLength: 5, checkType: "number" },
+ {
+ mandatory: true,
+ minMax: [9, 9],
+ padLength: true,
+ checkType: "number",
+ },
+ ],
+ });
}
}
- engine?: 'rule'
- ruleType?: 'interchange'
- group: X12GroupRule
- header?: X12SegmentRule
- trailer?: X12SegmentRule
+ declare engine?: "rule";
+ declare ruleType?: "interchange";
+ group: X12GroupRule;
+ header: X12SegmentRule;
+ trailer: X12SegmentRule;
- assert? (interchange: X12Interchange): true | ValidationReport {
- const report: ValidationReport = {}
- const headerResult = this.header.assert(interchange.header)
- let pass = true
+ assert?(interchange: X12Interchange): true | ValidationReport {
+ const report: ValidationReport = {};
+ const headerResult = this.header.assert?.(interchange.header);
+ let pass = true;
if (headerResult !== true) {
- pass = false
- report.interchange = { header: headerResult }
+ pass = false;
+ report.interchange = { header: headerResult };
}
- const groupNumber = parseFloat(interchange.functionalGroups[0].header.valueOf(6, '0'))
- const groupReport = this.group.assert(interchange.functionalGroups[0], groupNumber)
+ const groupNumber = parseFloat(
+ interchange.functionalGroups[0].header.valueOf(6, "0") ?? "0",
+ );
+ const groupReport =
+ this.group.assert?.(interchange.functionalGroups[0], groupNumber) ?? {};
if (groupReport !== true) {
- pass = false
- report.groups = [groupReport]
+ pass = false;
+ report.groups = [groupReport];
}
- const trailerResult = this.trailer.assert(interchange.trailer)
+ const trailerResult = this.trailer.assert?.(interchange.trailer);
if (trailerResult !== true) {
- pass = false
+ pass = false;
report.interchange = {
...report.interchange,
- trailer: trailerResult
- }
+ trailer: trailerResult,
+ };
}
- return pass || report
+ return pass || report;
}
}
export class X12GroupRule extends X12ValidationRule {
- constructor (options: X12GroupRule) {
- super({ ...options, engine: 'rule', ruleType: 'group' })
-
- if (options.header instanceof X12SegmentRule || typeof options.header === 'object') {
- this.header = new X12SegmentRule(options.header)
+ constructor(options: X12GroupRule) {
+ super({ ...options, engine: "rule", ruleType: "group" });
+
+ if (
+ options.header instanceof X12SegmentRule ||
+ typeof options.header === "object"
+ ) {
+ this.header = new X12SegmentRule(options.header);
} else {
this.header = new X12SegmentRule({
- tag: 'GS',
+ tag: "GS",
mandatory: true,
elements: [
- { checkType: 'gs01' },
- { minMax: [2, 15], checkType: 'alphanumeric' },
- { minMax: [2, 15], checkType: 'alphanumeric' },
- { checkType: 'date' },
- { checkType: 'time' },
- { minMax: [1, 9], checkType: 'number' },
- { minMax: [1, 2], checkType: 'alphanumeric' },
- { minMax: [1, 12], checkType: 'alphanumeric' }
- ]
- })
+ { checkType: "gs01" },
+ { minMax: [2, 15], checkType: "alphanumeric" },
+ { minMax: [2, 15], checkType: "alphanumeric" },
+ { checkType: "date" },
+ { checkType: "time" },
+ { minMax: [1, 9], checkType: "number" },
+ { minMax: [1, 2], checkType: "alphanumeric" },
+ { minMax: [1, 12], checkType: "alphanumeric" },
+ ],
+ });
}
- this.transaction = new X12TransactionRule(options.transaction)
+ this.transaction = new X12TransactionRule(options.transaction);
- if (options.trailer instanceof X12SegmentRule || typeof options.trailer === 'object') {
- this.trailer = new X12SegmentRule(options.trailer)
+ if (
+ options.trailer instanceof X12SegmentRule ||
+ typeof options.trailer === "object"
+ ) {
+ this.trailer = new X12SegmentRule(options.trailer);
} else {
this.trailer = new X12SegmentRule({
- tag: 'GE',
+ tag: "GE",
mandatory: true,
elements: [
- { minMax: [1, 6], checkType: 'number' },
- { minMax: [1, 9], checkType: 'number' }
- ]
- })
+ { minMax: [1, 6], checkType: "number" },
+ { minMax: [1, 9], checkType: "number" },
+ ],
+ });
}
}
- engine?: 'rule'
- ruleType?: 'group'
- transaction: X12TransactionRule
- header?: X12SegmentRule
- trailer?: X12SegmentRule
+ declare engine?: "rule";
+ declare ruleType?: "group";
+ transaction: X12TransactionRule;
+ header: X12SegmentRule;
+ trailer: X12SegmentRule;
- assert? (group: X12FunctionalGroup, controlNumber: number): true | ValidationReport {
- const errors: ValidationError[] = []
- const transactionReports: ValidationReport[] = []
- const headerResult = this.header.assert(group.header)
+ assert?(
+ group: X12FunctionalGroup,
+ controlNumber: number,
+ ): true | ValidationReport {
+ const errors: ValidationError[] = [];
+ const transactionReports: ValidationReport[] = [];
+ const headerResult = this.header.assert?.(group.header);
if (headerResult !== true) {
- const groupIdResult = headerResult.elements.find(error => error.position === 1)
- const groupNumberResult = headerResult.elements.find(error => error.position === 6)
-
- if (typeof groupIdResult === 'object') {
- errors.push(errorLookup(this.ruleType, '1', controlNumber))
+ const groupIdResult = headerResult?.elements?.find((error) =>
+ error.position === 1
+ );
+ const groupNumberResult = headerResult?.elements?.find((error) =>
+ error.position === 6
+ );
+
+ if (typeof groupIdResult === "object") {
+ errors.push(errorLookup(this.ruleType, "1", controlNumber));
}
- if (typeof groupNumberResult === 'object') {
- errors.push(errorLookup(this.ruleType, '6', controlNumber))
+ if (typeof groupNumberResult === "object") {
+ errors.push(errorLookup(this.ruleType, "6", controlNumber));
}
}
for (const transaction of group.transactions) {
- const transactionNumber = parseFloat(transaction.header.valueOf(2, '0'))
- const report = this.transaction.assert(transaction, transactionNumber)
+ const transactionNumber = parseFloat(
+ transaction.header.valueOf(2, "0") ?? "0",
+ );
+ const report = this.transaction.assert?.(transaction, transactionNumber);
- if (report !== true) transactionReports.push(report)
+ if (report !== true) transactionReports.push(report ?? {});
}
- const trailerResult = this.trailer.assert(group.trailer)
+ const trailerResult = this.trailer.assert?.(group.trailer);
if (trailerResult === true) {
- const transactionCount = parseFloat(group.trailer.valueOf(1, '0'))
- const trailerControlNumber = parseFloat(group.trailer.valueOf(2, '0'))
+ const transactionCount = parseFloat(group.trailer.valueOf(1, "0") ?? "0");
+ const trailerControlNumber = parseFloat(
+ group.trailer.valueOf(2, "0") ?? "0",
+ );
if (trailerControlNumber !== controlNumber) {
- errors.push(errorLookup(this.ruleType, '4', controlNumber))
+ errors.push(errorLookup(this.ruleType, "4", controlNumber));
}
if (transactionCount !== group.transactions.length) {
- errors.push(errorLookup(this.ruleType, '5', controlNumber))
+ errors.push(errorLookup(this.ruleType, "5", controlNumber));
}
}
if (transactionReports.length > 0 || errors.length > 0) {
return {
group: {
- groupId: group.header.valueOf(1),
+ groupId: group.header.valueOf(1) ?? "",
groupNumber: controlNumber,
transactionCount: group.transactions.length,
- errors
+ errors,
},
- transactions: transactionReports
- }
+ transactions: transactionReports,
+ };
}
- return true
+ return true;
}
}
export class X12TransactionRule extends X12ValidationRule {
- constructor (options: X12TransactionRule) {
- super({ ...options, engine: 'rule', ruleType: 'transaction' })
-
- if (options.header instanceof X12SegmentRule || typeof options.header === 'object') {
- this.header = new X12SegmentRule(options.header)
+ constructor(options: X12TransactionRule) {
+ super({ ...options, engine: "rule", ruleType: "transaction" });
+
+ if (
+ options.header instanceof X12SegmentRule ||
+ typeof options.header === "object"
+ ) {
+ this.header = new X12SegmentRule(options.header);
} else {
this.header = new X12SegmentRule({
- tag: 'ST',
+ tag: "ST",
mandatory: true,
- elements: [{ checkType: 'st01' }, { minMax: [4, 9], checkType: 'number' }]
- })
+ elements: [{ checkType: "st01" }, {
+ minMax: [4, 9],
+ checkType: "number",
+ }],
+ });
}
- this.segments = options.segments.map(segmentRule => new X12SegmentRule(segmentRule))
+ this.segments = options.segments.map((segmentRule) =>
+ new X12SegmentRule(segmentRule)
+ );
- if (options.trailer instanceof X12SegmentRule || typeof options.trailer === 'object') {
- this.trailer = new X12SegmentRule(options.trailer)
+ if (
+ options.trailer instanceof X12SegmentRule ||
+ typeof options.trailer === "object"
+ ) {
+ this.trailer = new X12SegmentRule(options.trailer);
} else {
this.trailer = new X12SegmentRule({
- tag: 'SE',
+ tag: "SE",
mandatory: true,
elements: [
- { mandatory: true, maxLength: 10, checkType: 'number' },
- { minMax: [4, 9], checkType: 'number' }
- ]
- })
+ { mandatory: true, maxLength: 10, checkType: "number" },
+ { minMax: [4, 9], checkType: "number" },
+ ],
+ });
}
}
- engine?: 'rule'
- ruleType?: 'transaction'
- segments: X12SegmentRule[]
- header?: X12SegmentRule
- trailer?: X12SegmentRule
-
- assert? (transaction: X12Transaction, controlNumber: number): true | ValidationReport {
- const errors: ValidationError[] = []
- const segmentReports: ValidationReport[] = []
- const _this = this
- const handleLoop = function handleLoop (
+ declare engine?: "rule";
+ declare ruleType?: "transaction";
+ segments: X12SegmentRule[];
+ header: X12SegmentRule;
+ trailer: X12SegmentRule;
+
+ assert?(
+ transaction: X12Transaction,
+ controlNumber: number,
+ ): true | ValidationReport {
+ const errors: ValidationError[] = [];
+ const segmentReports: ValidationReport[] = [];
+ // deno-lint-ignore no-this-alias
+ const _this = this;
+ const handleLoop = function handleLoop(
index: number,
- ruleIndex: number
+ ruleIndex: number,
): {
- index: number
- ruleIndex: number
+ index: number;
+ ruleIndex: number;
} {
- const segmentLoop: X12SegmentRule[] = []
+ const segmentLoop: X12SegmentRule[] = [];
// Gather segment rules for loop.
for (let ri = ruleIndex; ri < _this.segments.length; ri += 1) {
- const loopRule = _this.segments[ri]
+ const loopRule = _this.segments[ri];
- segmentLoop.push(loopRule)
+ segmentLoop.push(loopRule);
if (loopRule.loopEnd) {
- ruleIndex = ri + 1
- break
+ ruleIndex = ri + 1;
+ break;
}
}
// Iterate over segments by segment loop
- for (let i = index, loopPosition = 0; i < transaction.segments.length; i += 1) {
- const loopSegment = transaction.segments[i]
- const segmentRule = segmentLoop[loopPosition]
- const segmentPosition = i + 2 // This is because the transaction header is segment position 1.
+ for (
+ let i = index, loopPosition = 0;
+ i < transaction.segments.length;
+ i += 1
+ ) {
+ const loopSegment = transaction.segments[i];
+ const segmentRule = segmentLoop[loopPosition];
+ const segmentPosition = i + 2; // This is because the transaction header is segment position 1.
if (loopSegment.tag === segmentRule.tag) {
- const report = segmentRule.assert(loopSegment, segmentPosition)
+ const report = segmentRule.assert?.(loopSegment, segmentPosition);
- if (report !== true) segmentReports.push(report)
+ if (report !== true) segmentReports.push(report ?? {});
if (segmentLoop.length === loopPosition + 1) {
- loopPosition = 0
+ loopPosition = 0;
} else {
- loopPosition += 1
+ loopPosition += 1;
}
} else {
- index = i // Set i to equal j to present new position in evaluating segments.
- break // Break out of loop, as we should be done comparing segments.
+ index = i; // Set i to equal j to present new position in evaluating segments.
+ break; // Break out of loop, as we should be done comparing segments.
}
}
- return _this.segments[ruleIndex].loopStart ? handleLoop(index, ruleIndex) : { index, ruleIndex }
- }
- const headerResult = this.header.assert(transaction.header, 1)
+ return _this.segments[ruleIndex].loopStart
+ ? handleLoop(index, ruleIndex)
+ : { index, ruleIndex };
+ };
+ const headerResult = this.header.assert?.(transaction.header, 1);
if (headerResult !== true) {
- const transactionIdResult = headerResult.elements.find(error => error.position === 1)
- const transactionNumberResult = headerResult.elements.find(error => error.position === 2)
+ const transactionIdResult = headerResult?.elements?.find((error) =>
+ error.position === 1
+ );
+ const transactionNumberResult = headerResult?.elements?.find((error) =>
+ error.position === 2
+ );
- segmentReports.push(headerResult)
+ segmentReports.push(headerResult ?? {});
- if (typeof transactionIdResult === 'object') {
- errors.push(errorLookup(this.ruleType, '6', controlNumber))
+ if (typeof transactionIdResult === "object") {
+ errors.push(errorLookup(this.ruleType, "6", controlNumber));
}
- if (typeof transactionNumberResult === 'object') {
- errors.push(errorLookup(this.ruleType, '7', controlNumber))
+ if (typeof transactionNumberResult === "object") {
+ errors.push(errorLookup(this.ruleType, "7", controlNumber));
}
}
for (let i = 0, ri = 0; i < transaction.segments.length; i += 1, ri += 1) {
// Handle segment loops, including if followed by additional segment loops
// Currently can only handle loop depth of 0; loops within segment loops are not currently handled.
- if (typeof this.segments[ri] === 'undefined') {
+ if (typeof this.segments[ri] === "undefined") {
segmentReports.push({
segment: {
tag: transaction.segments[i].tag,
position: i,
- errors: [errorLookup('segment', '2', i)]
- }
- })
- continue
+ errors: [errorLookup("segment", "2", i)],
+ },
+ });
+ continue;
}
if (this.segments[ri].loopStart) {
- const { index, ruleIndex } = handleLoop(i, ri)
- i = index
- ri = ruleIndex
+ const { index, ruleIndex } = handleLoop(i, ri);
+ i = index;
+ ri = ruleIndex;
}
- const segment = transaction.segments[i]
- const segmentRule = this.segments[ri]
- const segmentPosition = i + 2 // This is because the transaction header is segment position 1.
- const report = segmentRule.assert(segment, segmentPosition)
+ const segment = transaction.segments[i];
+ const segmentRule = this.segments[ri];
+ const segmentPosition = i + 2; // This is because the transaction header is segment position 1.
+ const report = segmentRule.assert?.(segment, segmentPosition);
- if (report !== true) segmentReports.push(report)
+ if (report !== true) segmentReports.push(report ?? {});
}
- const trailerResult = this.trailer.assert(transaction.trailer, transaction.segments.length + 2)
+ const trailerResult = this.trailer.assert?.(
+ transaction.trailer,
+ transaction.segments.length + 2,
+ );
if (trailerResult === true) {
- const segmentCount = parseFloat(transaction.trailer.valueOf(1, '0'))
- const trailerControlNumber = parseFloat(transaction.trailer.valueOf(2, '0'))
+ const segmentCount = parseFloat(
+ transaction.trailer.valueOf(1, "0") ?? "0",
+ );
+ const trailerControlNumber = parseFloat(
+ transaction.trailer.valueOf(2, "0") ?? "0",
+ );
if (trailerControlNumber !== controlNumber) {
- errors.push(errorLookup(this.ruleType, '3', controlNumber))
+ errors.push(errorLookup(this.ruleType, "3", controlNumber));
}
if (segmentCount !== transaction.segments.length + 2) {
- errors.push(errorLookup(this.ruleType, '4', controlNumber))
+ errors.push(errorLookup(this.ruleType, "4", controlNumber));
}
} else {
- segmentReports.push(trailerResult)
+ segmentReports.push(trailerResult ?? {});
}
if (segmentReports.length > 0) {
- errors.push(errorLookup(this.ruleType, '5', controlNumber))
+ errors.push(errorLookup(this.ruleType, "5", controlNumber));
}
return (
errors.length === 0 || {
transaction: {
- transactionId: transaction.header.valueOf(1),
+ transactionId: transaction.header.valueOf(1) ?? "",
transactionNumber: controlNumber,
- errors
+ errors,
},
- segments: segmentReports
+ segments: segmentReports,
}
- )
+ );
}
}
export class X12SegmentRule extends X12ValidationRule {
- constructor (options: X12SegmentRule) {
- super({ ...options, engine: 'rule', ruleType: 'segment' })
-
- this.tag = options.tag
- this.elements =
- typeof options.elements === 'string'
- ? options.elements
- : options.elements.map(elementRule => new X12ElementRule(elementRule))
- this.loopStart = options.loopStart
- this.loopEnd = options.loopEnd
- this.mandatory = options.mandatory
+ constructor(options: X12SegmentRule) {
+ super({ ...options, engine: "rule", ruleType: "segment" });
+
+ this.tag = options.tag;
+ this.elements = typeof options.elements === "string"
+ ? options.elements
+ : options.elements.map((elementRule) => new X12ElementRule(elementRule));
+ this.loopStart = options.loopStart;
+ this.loopEnd = options.loopEnd;
+ this.mandatory = options.mandatory;
}
- engine?: 'rule'
- ruleType?: 'segment'
- tag: string
- elements: X12ElementRule[] | 'skip'
- loopStart?: boolean
- loopEnd?: boolean
- mandatory?: boolean
+ declare engine?: "rule";
+ declare ruleType?: "segment";
+ tag: string;
+ elements: X12ElementRule[] | "skip";
+ loopStart?: boolean;
+ loopEnd?: boolean;
+ mandatory?: boolean;
- assert? (segment: X12Segment, position?: number): true | ValidationReport {
- const errors: ValidationError[] = []
- const elements: ValidationError[] = []
+ assert?(segment: X12Segment, position = 1): true | ValidationReport {
+ const errors: ValidationError[] = [];
+ const elements: ValidationError[] = [];
if (segment.tag !== this.tag) {
- errors.push(errorLookup(this.ruleType, '2', position))
+ errors.push(errorLookup(this.ruleType, "2", position));
- if (this.mandatory) errors.push(errorLookup(this.ruleType, '3', position))
+ if (this.mandatory) {
+ errors.push(errorLookup(this.ruleType, "3", position));
+ }
}
- if (typeof this.elements !== 'string' && Array.isArray(this.elements)) {
+ if (typeof this.elements !== "string" && Array.isArray(this.elements)) {
for (let i = 0; i < this.elements.length; i += 1) {
- const element = segment.elements[i]
- const elementRule = this.elements[i]
- const elementPosition = i + 1
- const report = elementRule.assert(element, elementPosition)
+ const element = segment.elements[i];
+ const elementRule = this.elements[i];
+ const elementPosition = i + 1;
+ const report = elementRule.assert?.(element, elementPosition);
- if (report !== true) elements.push(...report.elements)
+ if (report !== true) elements.push(...(report?.elements ?? []));
}
if (segment.elements.length > this.elements.length) {
- elements.push(errorLookup('element', '3', position))
+ elements.push(errorLookup("element", "3", position));
}
if (elements.length > 0) {
- errors.push(errorLookup(this.ruleType, '8', position))
+ errors.push(errorLookup(this.ruleType, "8", position));
}
}
@@ -451,183 +540,192 @@ export class X12SegmentRule extends X12ValidationRule {
segment: {
tag: segment.tag,
position,
- errors
+ errors,
},
- elements
+ elements,
}
- )
+ );
}
}
export class X12ElementRule extends X12ValidationRule {
- constructor (options: X12ElementRule) {
- super({ ...options, ruleType: 'element' })
-
- this.expect = options.expect
- this.allowBlank = options.allowBlank
- this.minLength = options.minLength
- this.maxLength = options.maxLength
- this.minMax = options.minMax
- this.padLength = options.padLength
- this.mandatory = options.mandatory
- this.skip = options.skip
- this.checkType = options.checkType
+ constructor(options: X12ElementRule) {
+ super({ ...options, ruleType: "element" });
+
+ this.expect = options.expect;
+ this.allowBlank = options.allowBlank;
+ this.minLength = options.minLength;
+ this.maxLength = options.maxLength;
+ this.minMax = options.minMax;
+ this.padLength = options.padLength;
+ this.mandatory = options.mandatory;
+ this.skip = options.skip;
+ this.checkType = options.checkType;
}
- engine?: RegExp | 'rule'
- ruleType?: 'element'
- expect?: string
- allowBlank?: boolean
- minLength?: number
- maxLength?: number
- minMax?: [number, number]
- padLength?: boolean
- mandatory?: boolean
- skip?: boolean
+ declare engine?: RegExp | "rule";
+ declare ruleType?: "element";
+ expect?: string;
+ allowBlank?: boolean;
+ minLength?: number;
+ maxLength?: number;
+ minMax?: [number, number];
+ padLength?: boolean;
+ mandatory?: boolean;
+ skip?: boolean;
checkType?:
- | 'date'
- | 'datelong'
- | 'dateshort'
- | 'time'
- | 'timelong'
- | 'timeshort'
- | 'number'
- | 'decimal'
- | 'alphanumeric'
- | 'id'
- | 'gs01'
- | 'st01'
-
- assert? (element: X12Element, position?: number): true | ValidationReport {
- if (this.skip) return true
- if (typeof element === 'undefined') {
- return { elements: [errorLookup(this.ruleType, '2', position, '')] }
+ | "date"
+ | "datelong"
+ | "dateshort"
+ | "time"
+ | "timelong"
+ | "timeshort"
+ | "number"
+ | "decimal"
+ | "alphanumeric"
+ | "id"
+ | "gs01"
+ | "st01";
+
+ assert?(element: X12Element, position?: number): true | ValidationReport {
+ if (this.skip) return true;
+ if (typeof element === "undefined") {
+ return { elements: [errorLookup(this.ruleType, "2", position, "")] };
}
- const value = element.value
- const errors: ValidationError[] = []
- const _this = this
- const isLessThanMin = function isLessThanMin (val: string): boolean {
- if (_this.padLength) return false
+ const value = element.value;
+ const errors: ValidationError[] = [];
+ // deno-lint-ignore no-this-alias
+ const _this = this;
+ const isLessThanMin = function isLessThanMin(val: string): boolean {
+ if (_this.padLength) return false;
return (
- (typeof _this.minLength === 'number' && val.length < _this.minLength) ||
+ (typeof _this.minLength === "number" && val.length < _this.minLength) ||
(Array.isArray(_this.minMax) && val.length < _this.minMax[0])
- )
- }
- const isGreaterThanMax = function isGreaterThanMax (val: string): boolean {
+ );
+ };
+ const isGreaterThanMax = function isGreaterThanMax(val: string): boolean {
return (
- (typeof _this.minLength === 'number' && val.length > _this.maxLength) ||
+ (typeof _this.maxLength === "number" && val.length > _this.maxLength) ||
(Array.isArray(_this.minMax) && val.length > _this.minMax[1])
- )
- }
+ );
+ };
if (this.engine instanceof RegExp) {
- return super.assert(value)
+ return super.assert?.(value) ?? {};
} else {
- if (typeof this.expect === 'string') {
+ if (typeof this.expect === "string") {
if (value.toString().trim() === this.expect.trim()) {
- return true
+ return true;
} else {
- errors.push(errorLookup(this.ruleType, '2', position, value))
+ errors.push(errorLookup(this.ruleType, "2", position, value));
}
}
- if (value.toString().trim() === '') {
- if (this.allowBlank) return true
+ if (value.toString().trim() === "") {
+ if (this.allowBlank) return true;
if (this.mandatory) {
- errors.push(errorLookup(this.ruleType, '1', position, value))
+ errors.push(errorLookup(this.ruleType, "1", position, value));
} else {
- return true
+ return true;
}
}
if (isLessThanMin(value)) {
- errors.push(errorLookup(this.ruleType, '4', position, value))
+ errors.push(errorLookup(this.ruleType, "4", position, value));
}
if (isGreaterThanMax(value)) {
- errors.push(errorLookup(this.ruleType, '5', position, value))
+ errors.push(errorLookup(this.ruleType, "5", position, value));
}
- if (typeof this.checkType === 'string') {
- const AN = /^[a-zA-Z0-9!&()*+,-./:;?= '"%@[\]_{}|<>~#$]+$/gu
- const N0 = /^[0-9]+$/gu
- const R = /^[-]{0,1}[.0-9]+$/gu
- const DT = /^[0-9]{6,8}$/gu
- const TM = /^[0-2][0-9][0-5][0-9][0-5][0-9]$|^[0-2][0-9][0-5][0-9]$/gu
- const GS01 = /^[A-Z]{2}$/gu
- const ST01 = /^[0-9]{3}$/gu
+ if (typeof this.checkType === "string") {
+ const AN = /^[a-zA-Z0-9!&()*+,-./:;?= '"%@[\]_{}|<>~#$]+$/gu;
+ const N0 = /^[0-9]+$/gu;
+ const R = /^[-]{0,1}[.0-9]+$/gu;
+ const DT = /^[0-9]{6,8}$/gu;
+ const TM = /^[0-2][0-9][0-5][0-9][0-5][0-9]$|^[0-2][0-9][0-5][0-9]$/gu;
+ const GS01 = /^[A-Z]{2}$/gu;
+ const ST01 = /^[0-9]{3}$/gu;
switch (this.checkType) {
- case 'number':
+ case "number":
if (!N0.test(value)) {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'decimal':
+ break;
+ case "decimal":
if (!R.test(value)) {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'datelong':
+ break;
+ case "datelong":
if (DT.test(value)) {
- if (value.length < 8) errors.push(errorLookup(this.ruleType, '4', position, value))
+ if (value.length < 8) {
+ errors.push(errorLookup(this.ruleType, "4", position, value));
+ }
} else {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'dateshort':
+ break;
+ case "dateshort":
if (DT.test(value)) {
- if (value.length > 6) errors.push(errorLookup(this.ruleType, '5', position, value))
+ if (value.length > 6) {
+ errors.push(errorLookup(this.ruleType, "5", position, value));
+ }
} else {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'date':
+ break;
+ case "date":
if (!DT.test(value)) {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'timelong':
+ break;
+ case "timelong":
if (TM.test(value)) {
- if (value.length < 6) errors.push(errorLookup(this.ruleType, '4', position, value))
+ if (value.length < 6) {
+ errors.push(errorLookup(this.ruleType, "4", position, value));
+ }
} else {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'timeshort':
+ break;
+ case "timeshort":
if (TM.test(value)) {
- if (value.length > 4) errors.push(errorLookup(this.ruleType, '5', position, value))
+ if (value.length > 4) {
+ errors.push(errorLookup(this.ruleType, "5", position, value));
+ }
} else {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'time':
+ break;
+ case "time":
if (!TM.test(value)) {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
- case 'gs01':
+ break;
+ case "gs01":
if (!GS01.test(value)) {
- errors.push(errorLookup(this.ruleType, '7', position, value))
+ errors.push(errorLookup(this.ruleType, "7", position, value));
}
- break
- case 'st01':
+ break;
+ case "st01":
if (!ST01.test(value)) {
- errors.push(errorLookup(this.ruleType, '7', position, value))
+ errors.push(errorLookup(this.ruleType, "7", position, value));
}
- break
- case 'alphanumeric':
- case 'id':
+ break;
+ case "alphanumeric":
+ case "id":
default:
if (!AN.test(value)) {
- errors.push(errorLookup(this.ruleType, '6', position, value))
+ errors.push(errorLookup(this.ruleType, "6", position, value));
}
- break
+ break;
}
}
}
- return errors.length === 0 || { elements: errors }
+ return errors.length === 0 || { elements: errors };
}
}
diff --git a/src/X12ValidationEngine/index.ts b/src/X12ValidationEngine/index.ts
index 7391004..d1d2a8b 100644
--- a/src/X12ValidationEngine/index.ts
+++ b/src/X12ValidationEngine/index.ts
@@ -1,4 +1,4 @@
-export * from './Interfaces'
-export * from './X12ValidationEngine'
-export * from './X12ValidationErrorCode'
-export * from './X12ValidationRule'
+export * from "./Interfaces.ts";
+export * from "./X12ValidationEngine.ts";
+export * from "./X12ValidationErrorCode.ts";
+export * from "./X12ValidationRule.ts";
diff --git a/test/CoreSuite.ts b/test/CoreSuite.ts
deleted file mode 100644
index e3a0f82..0000000
--- a/test/CoreSuite.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { ArgumentNullError, GeneratorError, ParserError, QuerySyntaxError } from '../src/Errors'
-import { X12Diagnostic } from '../src/X12Diagnostic'
-import * as core from '../core'
-
-describe('X12Core', () => {
- it('should export members', () => {
- if (!Object.keys(core).includes('X12Parser')) {
- throw new Error('X12 core is missing X12Parser.')
- }
- })
-
- it('should create ArgumentNullError', () => {
- const error = new ArgumentNullError('test')
-
- if (error.message !== "The argument, 'test', cannot be null.") {
- throw new Error('ArgumentNullError did not return the correct message.')
- }
- })
-
- it('should create GeneratorError', () => {
- const error = new GeneratorError('test')
-
- if (error.message !== 'test') {
- throw new Error('GeneratorError did not return the correct message.')
- }
- })
-
- it('should create ParserError', () => {
- const error = new ParserError('test')
-
- if (error.message !== 'test') {
- throw new Error('ParserError did not return the correct message.')
- }
- })
-
- it('should create QuerySyntaxError', () => {
- const error = new QuerySyntaxError('test')
-
- if (error.message !== 'test') {
- throw new Error('QuerySyntaxError did not return the correct message.')
- }
- })
-
- it('should create X12Diagnostic', () => {
- const diag = new X12Diagnostic()
-
- if (!(diag instanceof X12Diagnostic)) {
- throw new Error('Could not create X12Diagnostic.')
- }
- })
-})
diff --git a/test/CoreSuite_test.ts b/test/CoreSuite_test.ts
new file mode 100644
index 0000000..f577181
--- /dev/null
+++ b/test/CoreSuite_test.ts
@@ -0,0 +1,59 @@
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import {
+ ArgumentNullError,
+ GeneratorError,
+ ParserError,
+ QuerySyntaxError,
+} from "../src/Errors.ts";
+import { X12Diagnostic } from "../src/X12Diagnostic.ts";
+import * as core from "../mod.ts";
+
+describe("X12Core", () => {
+ it("should export members", () => {
+ if (!Object.keys(core).includes("X12Parser")) {
+ throw new Error("X12 core is missing X12Parser.");
+ }
+ });
+
+ it("should create ArgumentNullError", () => {
+ const error = new ArgumentNullError("test");
+
+ if (error.message !== "The argument, 'test', cannot be null.") {
+ throw new Error("ArgumentNullError did not return the correct message.");
+ }
+ });
+
+ it("should create GeneratorError", () => {
+ const error = new GeneratorError("test");
+
+ if (error.message !== "test") {
+ throw new Error("GeneratorError did not return the correct message.");
+ }
+ });
+
+ it("should create ParserError", () => {
+ const error = new ParserError("test");
+
+ if (error.message !== "test") {
+ throw new Error("ParserError did not return the correct message.");
+ }
+ });
+
+ it("should create QuerySyntaxError", () => {
+ const error = new QuerySyntaxError("test");
+
+ if (error.message !== "test") {
+ throw new Error("QuerySyntaxError did not return the correct message.");
+ }
+ });
+
+ it("should create X12Diagnostic", () => {
+ const diag = new X12Diagnostic();
+
+ if (!(diag instanceof X12Diagnostic)) {
+ throw new Error("Could not create X12Diagnostic.");
+ }
+ });
+});
diff --git a/test/FormattingSuite.ts b/test/FormattingSuite.ts
deleted file mode 100644
index 1df638d..0000000
--- a/test/FormattingSuite.ts
+++ /dev/null
@@ -1,37 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { X12FatInterchange } from '../src/X12FatInterchange'
-import { X12Interchange, X12Parser, X12SerializationOptions } from '../core'
-import * as fs from 'fs'
-
-describe('X12Formatting', () => {
- it('should replicate the source data unless changes are made', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const interchange = parser.parse(edi) as X12Interchange
-
- const edi2 = interchange.toString()
-
- if (edi !== edi2) {
- throw new Error(`Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`)
- }
- })
-
- it('should replicate the source data for a fat interchange unless changes are made', () => {
- const edi = fs.readFileSync('test/test-data/850_fat.edi', 'utf8')
- const parser = new X12Parser(true)
- const interchange = parser.parse(edi) as X12FatInterchange
-
- const options: X12SerializationOptions = {
- format: true,
- endOfLine: '\n'
- }
-
- const edi2 = interchange.toString(options)
-
- if (edi !== edi2) {
- throw new Error(`Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`)
- }
- })
-})
diff --git a/test/FormattingSuite_test.ts b/test/FormattingSuite_test.ts
new file mode 100644
index 0000000..998959f
--- /dev/null
+++ b/test/FormattingSuite_test.ts
@@ -0,0 +1,40 @@
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import { X12FatInterchange } from "../src/X12FatInterchange.ts";
+import { X12Interchange, X12Parser, X12SerializationOptions } from "../mod.ts";
+
+describe("X12Formatting", () => {
+ it("should replicate the source data unless changes are made", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const interchange = parser.parse(edi) as X12Interchange;
+
+ const edi2 = interchange.toString();
+
+ if (edi !== edi2) {
+ throw new Error(
+ `Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`,
+ );
+ }
+ });
+
+ it("should replicate the source data for a fat interchange unless changes are made", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850_fat.edi");
+ const parser = new X12Parser(true);
+ const interchange = parser.parse(edi) as X12FatInterchange;
+
+ const options: X12SerializationOptions = {
+ format: true,
+ endOfLine: "\n",
+ };
+
+ const edi2 = interchange.toString(options);
+
+ if (edi !== edi2) {
+ throw new Error(
+ `Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`,
+ );
+ }
+ });
+});
diff --git a/test/GeneratorSuite.ts b/test/GeneratorSuite.ts
deleted file mode 100644
index a69fc9c..0000000
--- a/test/GeneratorSuite.ts
+++ /dev/null
@@ -1,160 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { JSEDINotation, X12Generator, X12Parser, ISASegmentHeader, GSSegmentHeader, X12Interchange } from '../core'
-import * as fs from 'fs'
-
-describe('X12Generator', () => {
- it('should create X12Generator', () => {
- const generator = new X12Generator()
- const notation = generator.getJSEDINotation()
- const options = generator.getOptions()
-
- generator.setJSEDINotation(new JSEDINotation())
- generator.setOptions({})
-
- if (!(notation instanceof JSEDINotation) || typeof options !== 'object') {
- throw new Error('Could not correctly create instance of X12Generator.')
- }
- })
-
- it('should replicate the source data unless changes are made', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const notation: JSEDINotation = parser.parse(edi).toJSEDINotation() as JSEDINotation
-
- const generator = new X12Generator(notation)
-
- const edi2 = generator.toString()
-
- if (edi !== edi2) {
- throw new Error(`Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`)
- }
- })
-
- it('should replicate the source data to and from JSON unless changes are made', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const interchange = parser.parse(edi)
-
- const json = JSON.stringify(interchange)
-
- const generator = new X12Generator(JSON.parse(json))
-
- const edi2 = generator.toString()
-
- if (edi !== edi2) {
- throw new Error(`Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`)
- }
- })
-
- it('should not generate 271 with 4 ST elements using default segment headers', () => {
- const fileEdi = fs.readFileSync('test/test-data/271.edi', 'utf8').split('~')
-
- const i = new X12Interchange()
-
- i.setHeader(fileEdi[0].split('*').slice(1))
-
- const fg = i.addFunctionalGroup()
-
- fg.setHeader(fileEdi[1].split('*').slice(1))
-
- const t = fg.addTransaction()
-
- let error
- try {
- t.setHeader([...fileEdi[2].split('*').slice(1), 'N'])
- } catch (err) {
- error = err.message
- }
-
- if (error !== 'Segment "ST" with 4 elements does not meet the required count of min 2 or max 3.') {
- throw new Error('271 with 4 ST elements parsing succeed which should not happen')
- }
- })
-
- it('should generate 271 with 3 ST elements using custom segment headers', () => {
- const fileEdi = fs.readFileSync('test/test-data/271.edi', 'utf8').split('~')
-
- const i = new X12Interchange({
- segmentHeaders: [
- ISASegmentHeader,
- GSSegmentHeader,
- {
- tag: 'ST',
- layout: {
- ST01: 3,
- ST02: 9,
- ST02_MIN: 4,
- ST03: 35,
- ST03_MIN: 1,
- COUNT: 3,
- PADDING: false
- }
- }
- ]
- })
-
- i.setHeader(fileEdi[0].split('*').slice(1))
-
- const fg = i.addFunctionalGroup()
-
- fg.setHeader(fileEdi[1].split('*').slice(1))
-
- const t = fg.addTransaction()
-
- t.setHeader(fileEdi[2].split('*').slice(1))
- })
-
- it('should validate custom segment headers', () => {
- const edi = fs.readFileSync('test/test-data/271.edi', 'utf8')
-
- const options = {
- segmentHeaders: [
- ISASegmentHeader,
- GSSegmentHeader,
- {
- tag: 'ST',
- layout: {
- ST01: 3,
- ST02: 9,
- ST02_MIN: 4,
- ST03: 35,
- ST03_MIN: 1,
- COUNT: 3,
- PADDING: false
- }
- },
- {
- tag: 'HL',
- layout: {
- HL01: 3,
- HL02: 9,
- HL02_MIN: 4,
- HL03: 35,
- HL03_MIN: 1,
- COUNT: 3,
- PADDING: false
- }
- }
- ]
- }
-
- const parser = new X12Parser(true)
- const interchange = parser.parse(edi)
-
- const json = JSON.stringify(interchange)
-
- let error
- try {
- const generator = new X12Generator(JSON.parse(json), options)
- generator.toString()
- } catch (err) {
- error = err.message
- }
-
- if (error !== 'Segment "HL" with 4 elements does not meet the required count of 3.') {
- throw new Error('271 with custom segment headers parsing succeed which should not happen')
- }
- })
-})
diff --git a/test/GeneratorSuite_test.ts b/test/GeneratorSuite_test.ts
new file mode 100644
index 0000000..5ff82ec
--- /dev/null
+++ b/test/GeneratorSuite_test.ts
@@ -0,0 +1,181 @@
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import {
+ GSSegmentHeader,
+ ISASegmentHeader,
+ JSEDINotation,
+ X12Generator,
+ X12Interchange,
+ X12Parser,
+} from "../mod.ts";
+
+describe("X12Generator", () => {
+ it("should create X12Generator", () => {
+ const generator = new X12Generator();
+ const notation = generator.getJSEDINotation();
+ const options = generator.getOptions();
+
+ generator.setJSEDINotation(new JSEDINotation());
+ generator.setOptions({});
+
+ if (!(notation instanceof JSEDINotation) || typeof options !== "object") {
+ throw new Error("Could not correctly create instance of X12Generator.");
+ }
+ });
+
+ it("should replicate the source data unless changes are made", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const notation: JSEDINotation = parser.parse(edi)
+ .toJSEDINotation() as JSEDINotation;
+
+ const generator = new X12Generator(notation);
+
+ const edi2 = generator.toString();
+
+ if (edi !== edi2) {
+ throw new Error(
+ `Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`,
+ );
+ }
+ });
+
+ it("should replicate the source data to and from JSON unless changes are made", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const interchange = parser.parse(edi);
+
+ const json = JSON.stringify(interchange);
+
+ const generator = new X12Generator(JSON.parse(json));
+
+ const edi2 = generator.toString();
+
+ if (edi !== edi2) {
+ throw new Error(
+ `Formatted EDI does not match source. Found ${edi2}, expected ${edi}.`,
+ );
+ }
+ });
+
+ it("should not generate 271 with 4 ST elements using default segment headers", () => {
+ const fileEdi = Deno.readTextFileSync("test/test-data/271.edi").split("~");
+
+ const i = new X12Interchange();
+
+ i.setHeader(fileEdi[0].split("*").slice(1));
+
+ const fg = i.addFunctionalGroup();
+
+ fg.setHeader(fileEdi[1].split("*").slice(1));
+
+ const t = fg.addTransaction();
+
+ let error;
+ try {
+ t.setHeader([...fileEdi[2].split("*").slice(1), "N"]);
+ } catch (err) {
+ error = err.message;
+ }
+
+ if (
+ error !==
+ 'Segment "ST" with 4 elements does not meet the required count of min 2 or max 3.'
+ ) {
+ throw new Error(
+ "271 with 4 ST elements parsing succeed which should not happen",
+ );
+ }
+ });
+
+ it("should generate 271 with 3 ST elements using custom segment headers", () => {
+ const fileEdi = Deno.readTextFileSync("test/test-data/271.edi").split("~");
+
+ const i = new X12Interchange({
+ segmentHeaders: [
+ ISASegmentHeader,
+ GSSegmentHeader,
+ {
+ tag: "ST",
+ layout: {
+ ST01: 3,
+ ST02: 9,
+ ST02_MIN: 4,
+ ST03: 35,
+ ST03_MIN: 1,
+ COUNT: 3,
+ PADDING: false,
+ },
+ },
+ ],
+ });
+
+ i.setHeader(fileEdi[0].split("*").slice(1));
+
+ const fg = i.addFunctionalGroup();
+
+ fg.setHeader(fileEdi[1].split("*").slice(1));
+
+ const t = fg.addTransaction();
+
+ t.setHeader(fileEdi[2].split("*").slice(1));
+ });
+
+ it("should validate custom segment headers", () => {
+ const edi = Deno.readTextFileSync("test/test-data/271.edi");
+
+ const options = {
+ segmentHeaders: [
+ ISASegmentHeader,
+ GSSegmentHeader,
+ {
+ tag: "ST",
+ layout: {
+ ST01: 3,
+ ST02: 9,
+ ST02_MIN: 4,
+ ST03: 35,
+ ST03_MIN: 1,
+ COUNT: 3,
+ PADDING: false,
+ },
+ },
+ {
+ tag: "HL",
+ layout: {
+ HL01: 3,
+ HL02: 9,
+ HL02_MIN: 4,
+ HL03: 35,
+ HL03_MIN: 1,
+ COUNT: 3,
+ PADDING: false,
+ },
+ },
+ ],
+ };
+
+ const parser = new X12Parser(true);
+ const interchange = parser.parse(edi);
+
+ const json = JSON.stringify(interchange);
+
+ let error;
+ try {
+ const generator = new X12Generator(JSON.parse(json), options);
+ generator.toString();
+ } catch (err) {
+ error = err.message;
+ }
+
+ if (
+ error !==
+ 'Segment "HL" with 4 elements does not meet the required count of 3.'
+ ) {
+ throw new Error(
+ "271 with custom segment headers parsing succeed which should not happen",
+ );
+ }
+ });
+});
diff --git a/test/MappingSuite.ts b/test/MappingSuite.ts
deleted file mode 100644
index f3c2b95..0000000
--- a/test/MappingSuite.ts
+++ /dev/null
@@ -1,75 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { X12Parser, X12Transaction, X12TransactionMap, X12Interchange } from '../core'
-import * as fs from 'fs'
-import * as assert from 'assert'
-
-const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
-const edi855 = fs.readFileSync('test/test-data/855.edi', 'utf8')
-const mapJson = fs.readFileSync('test/test-data/850_map.json', 'utf8')
-const resultJson = fs.readFileSync('test/test-data/850_map_result.json', 'utf8')
-const transactionJson = fs.readFileSync('test/test-data/Transaction_map.json', 'utf8')
-const transactionJsonLiquid = fs.readFileSync('test/test-data/Transaction_map_liquidjs.json', 'utf8')
-const transactionData = fs.readFileSync('test/test-data/Transaction_data.json', 'utf8')
-
-describe('X12Mapping', () => {
- it('should map transaction to data', () => {
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
- const transaction = interchange.functionalGroups[0].transactions[0]
- const mapper = new X12TransactionMap(JSON.parse(mapJson), transaction)
-
- assert.deepStrictEqual(mapper.toObject(), JSON.parse(resultJson))
- })
-
- it('should map data to transaction with custom macro', () => {
- const transaction = new X12Transaction()
- const mapper = new X12TransactionMap(JSON.parse(transactionJson), transaction)
- const data = JSON.parse(transactionData)
- const result = mapper.fromObject(data, {
- toFixed: function toFixed (key: string, places: number) {
- return {
- val: parseFloat(key).toFixed(places)
- }
- }
- })
-
- if (!(result instanceof X12Transaction)) {
- throw new Error('An error occured when mapping an object to a transaction.')
- }
- })
-
- it('should map data to transaction with LiquidJS', () => {
- const transaction = new X12Transaction()
- const mapper = new X12TransactionMap(JSON.parse(transactionJsonLiquid), transaction, 'liquidjs')
- const data = JSON.parse(transactionData)
- const result = mapper.fromObject(data, {
- to_fixed: (value: string, places: number) => parseFloat(value).toFixed(places)
- })
-
- if (!(result instanceof X12Transaction)) {
- throw new Error('An error occured when mapping an object to a transaction.')
- }
- })
-
- it('should map empty data when element missing from qualified segment', () => {
- // Addresses issue https://github.com/ahuggins-nhs/node-x12/issues/23
- const mapObject = { author: 'FOREACH(PO1)=>PO109:PO103["UN"]' }
- const parser = new X12Parser()
- const interchange = parser.parse(edi855) as X12Interchange
- const transaction = interchange.functionalGroups[0].transactions[0]
- const mapperLoose = new X12TransactionMap(mapObject, transaction, 'loose')
- const mapperStrict = new X12TransactionMap(mapObject, transaction, 'strict')
-
- const resultLoose: any[] = mapperLoose.toObject()
- const resultStrict: any[] = mapperStrict.toObject()
-
- assert.strictEqual(Array.isArray(resultLoose), true)
- assert.strictEqual(Array.isArray(resultStrict), true)
- assert.strictEqual(resultLoose.length, 4)
- assert.strictEqual(resultStrict.length, 3)
- assert.deepStrictEqual(resultLoose[2], { author: '' })
- assert.deepStrictEqual(resultStrict[2], { author: 'NOT APPLICABLE' })
- })
-})
diff --git a/test/MappingSuite_test.ts b/test/MappingSuite_test.ts
new file mode 100644
index 0000000..f133ae0
--- /dev/null
+++ b/test/MappingSuite_test.ts
@@ -0,0 +1,102 @@
+// deno-lint-ignore-file no-explicit-any
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import {
+ X12Interchange,
+ X12Parser,
+ X12Transaction,
+ X12TransactionMap,
+} from "../mod.ts";
+import * as assert from "https://deno.land/std@0.133.0/node/assert.ts";
+
+const edi = Deno.readTextFileSync("test/test-data/850.edi");
+const edi855 = Deno.readTextFileSync("test/test-data/855.edi");
+const mapJson = Deno.readTextFileSync("test/test-data/850_map.json");
+const resultJson = Deno.readTextFileSync("test/test-data/850_map_result.json");
+const transactionJson = Deno.readTextFileSync(
+ "test/test-data/Transaction_map.json",
+);
+const transactionJsonLiquid = Deno.readTextFileSync(
+ "test/test-data/Transaction_map_liquidjs.json",
+);
+const transactionData = Deno.readTextFileSync(
+ "test/test-data/Transaction_data.json",
+);
+
+describe("X12Mapping", () => {
+ it("should map transaction to data", () => {
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+ const transaction = interchange.functionalGroups[0].transactions[0];
+ const mapper = new X12TransactionMap(JSON.parse(mapJson), transaction);
+
+ assert.deepStrictEqual(mapper.toObject(), JSON.parse(resultJson));
+ });
+
+ it("should map data to transaction with custom macro", () => {
+ const transaction = new X12Transaction();
+ const mapper = new X12TransactionMap(
+ JSON.parse(transactionJson),
+ transaction,
+ );
+ const data = JSON.parse(transactionData);
+ const result = mapper.fromObject(data, {
+ toFixed: function toFixed(key: string, places: number) {
+ return {
+ val: parseFloat(key).toFixed(places),
+ };
+ },
+ });
+
+ if (!(result instanceof X12Transaction)) {
+ throw new Error(
+ "An error occured when mapping an object to a transaction.",
+ );
+ }
+ });
+
+ it("should map data to transaction with LiquidJS", () => {
+ const transaction = new X12Transaction();
+ const mapper = new X12TransactionMap(
+ JSON.parse(transactionJsonLiquid),
+ transaction,
+ "liquidjs",
+ );
+ const data = JSON.parse(transactionData);
+ const result = mapper.fromObject(data, {
+ to_fixed: (value: string, places: number) =>
+ parseFloat(value).toFixed(places),
+ });
+
+ if (!(result instanceof X12Transaction)) {
+ throw new Error(
+ "An error occured when mapping an object to a transaction.",
+ );
+ }
+ });
+
+ it("should map empty data when element missing from qualified segment", () => {
+ // Addresses issue https://github.com/ahuggins-nhs/node-x12/issues/23
+ const mapObject = { author: 'FOREACH(PO1)=>PO109:PO103["UN"]' };
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi855) as X12Interchange;
+ const transaction = interchange.functionalGroups[0].transactions[0];
+ const mapperLoose = new X12TransactionMap(mapObject, transaction, "loose");
+ const mapperStrict = new X12TransactionMap(
+ mapObject,
+ transaction,
+ "strict",
+ );
+
+ const resultLoose: any[] = mapperLoose.toObject();
+ const resultStrict: any[] = mapperStrict.toObject();
+
+ assert.strictEqual(Array.isArray(resultLoose), true);
+ assert.strictEqual(Array.isArray(resultStrict), true);
+ assert.strictEqual(resultLoose.length, 4);
+ assert.strictEqual(resultStrict.length, 3);
+ assert.deepStrictEqual(resultLoose[2], { author: "" });
+ assert.deepStrictEqual(resultStrict[2], { author: "NOT APPLICABLE" });
+ });
+});
diff --git a/test/ObjectModelSuite.ts b/test/ObjectModelSuite.ts
deleted file mode 100644
index fbf1831..0000000
--- a/test/ObjectModelSuite.ts
+++ /dev/null
@@ -1,101 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { JSEDINotation, X12Parser, X12Interchange, X12FatInterchange, X12Segment } from '../core'
-import { JSEDIFunctionalGroup, JSEDITransaction } from '../src/JSEDINotation'
-import * as fs from 'fs'
-
-const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
-
-describe('X12ObjectModel', () => {
- it('should create X12Interchange with string delimiters', () => {
- const interchange = new X12Interchange('~', '*')
-
- if (interchange.elementDelimiter !== '*') {
- throw new Error('Instance of X12Interchange not successfully created.')
- }
- })
-
- it('should create X12FatInterchange', () => {
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
- const fatInterchange = new X12FatInterchange([interchange])
- const str = fatInterchange.toString()
- const json = fatInterchange.toJSON()
-
- if (!Array.isArray(json) || typeof str !== 'string') {
- throw new Error('Instance of X12FatInterchange not successfully created.')
- }
- })
-
- it('should create X12Segment', () => {
- const segment = new X12Segment()
- const noElement = segment.replaceElement('1', 1)
- const noInsert = segment.insertElement('1', 1)
- const noneToRemove = segment.removeElement(1)
- const defaultVal = segment.valueOf(1, '2')
-
- segment.setTag('WX')
- segment.addElement('1')
- segment.insertElement('2', 1)
- segment.removeElement(2)
-
- if (
- noElement !== null ||
- noInsert !== null ||
- typeof noneToRemove !== 'boolean' ||
- defaultVal !== '2' ||
- segment.elements.length !== 1 ||
- segment.elements[0].value !== '2'
- ) {
- throw new Error('Instance of segment or methods did not execute as expected.')
- }
- })
-
- it('should cast functional group to JSON', () => {
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
- const functionalGroup = interchange.functionalGroups[0]
-
- if (typeof functionalGroup.toJSON() !== 'object') {
- throw new Error('Instance of X12FunctionalGroup not cast to JSON.')
- }
- })
-
- it('should cast transaction set to JSON', () => {
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
- const functionalGroup = interchange.functionalGroups[0]
- const transaction = functionalGroup.transactions[0]
-
- if (typeof transaction.toJSON() !== 'object') {
- throw new Error('Instance of X12FunctionalGroup not cast to JSON.')
- }
- })
-
- it('should cast segment to JSON', () => {
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
- const functionalGroup = interchange.functionalGroups[0]
- const transaction = functionalGroup.transactions[0]
- const segment = transaction.segments[0]
-
- if (typeof segment.toJSON() !== 'object') {
- throw new Error('Instance of X12FunctionalGroup not cast to JSON.')
- }
- })
-
- it('should construct JSEDINotation objects', () => {
- const notation = new JSEDINotation()
- const group = new JSEDIFunctionalGroup()
- const transaction = new JSEDITransaction()
-
- if (
- !(notation instanceof JSEDINotation) ||
- !(group instanceof JSEDIFunctionalGroup) ||
- !(transaction instanceof JSEDITransaction)
- ) {
- throw new Error('One or more JS EDI Notation objects could not be constructed.')
- }
- })
-})
diff --git a/test/ObjectModelSuite_test.ts b/test/ObjectModelSuite_test.ts
new file mode 100644
index 0000000..ac8775d
--- /dev/null
+++ b/test/ObjectModelSuite_test.ts
@@ -0,0 +1,115 @@
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import {
+ JSEDINotation,
+ X12FatInterchange,
+ X12Interchange,
+ X12Parser,
+ X12Segment,
+} from "../mod.ts";
+import {
+ JSEDIFunctionalGroup,
+ JSEDITransaction,
+} from "../src/JSEDINotation.ts";
+
+const edi = Deno.readTextFileSync("test/test-data/850.edi");
+
+describe("X12ObjectModel", () => {
+ it("should create X12Interchange with string delimiters", () => {
+ const interchange = new X12Interchange("~", "*");
+
+ if (interchange.elementDelimiter !== "*") {
+ throw new Error("Instance of X12Interchange not successfully created.");
+ }
+ });
+
+ it("should create X12FatInterchange", () => {
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+ const fatInterchange = new X12FatInterchange([interchange]);
+ const str = fatInterchange.toString();
+ const json = fatInterchange.toJSON();
+
+ if (!Array.isArray(json) || typeof str !== "string") {
+ throw new Error(
+ "Instance of X12FatInterchange not successfully created.",
+ );
+ }
+ });
+
+ it("should create X12Segment", () => {
+ const segment = new X12Segment();
+ const noElement = segment.replaceElement("1", 1);
+ const noInsert = segment.insertElement("1", 1);
+ const noneToRemove = segment.removeElement(1);
+ const defaultVal = segment.valueOf(1, "2");
+
+ segment.setTag("WX");
+ segment.addElement("1");
+ segment.insertElement("2", 1);
+ segment.removeElement(2);
+
+ if (
+ noElement !== null ||
+ noInsert !== false ||
+ typeof noneToRemove !== "boolean" ||
+ defaultVal !== "2" ||
+ segment.elements.length !== 1 ||
+ segment.elements[0].value !== "2"
+ ) {
+ throw new Error(
+ "Instance of segment or methods did not execute as expected.",
+ );
+ }
+ });
+
+ it("should cast functional group to JSON", () => {
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+ const functionalGroup = interchange.functionalGroups[0];
+
+ if (typeof functionalGroup.toJSON() !== "object") {
+ throw new Error("Instance of X12FunctionalGroup not cast to JSON.");
+ }
+ });
+
+ it("should cast transaction set to JSON", () => {
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+ const functionalGroup = interchange.functionalGroups[0];
+ const transaction = functionalGroup.transactions[0];
+
+ if (typeof transaction.toJSON() !== "object") {
+ throw new Error("Instance of X12FunctionalGroup not cast to JSON.");
+ }
+ });
+
+ it("should cast segment to JSON", () => {
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+ const functionalGroup = interchange.functionalGroups[0];
+ const transaction = functionalGroup.transactions[0];
+ const segment = transaction.segments[0];
+
+ if (typeof segment.toJSON() !== "object") {
+ throw new Error("Instance of X12FunctionalGroup not cast to JSON.");
+ }
+ });
+
+ it("should construct JSEDINotation objects", () => {
+ const notation = new JSEDINotation();
+ const group = new JSEDIFunctionalGroup();
+ const transaction = new JSEDITransaction();
+
+ if (
+ !(notation instanceof JSEDINotation) ||
+ !(group instanceof JSEDIFunctionalGroup) ||
+ !(transaction instanceof JSEDITransaction)
+ ) {
+ throw new Error(
+ "One or more JS EDI Notation objects could not be constructed.",
+ );
+ }
+ });
+});
diff --git a/test/ParserSuite.ts b/test/ParserSuite.ts
deleted file mode 100644
index 6175701..0000000
--- a/test/ParserSuite.ts
+++ /dev/null
@@ -1,124 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { X12Parser, X12Interchange, X12Segment } from '../core'
-import * as fs from 'fs'
-
-describe('X12Parser', () => {
- it('should parse a valid X12 document without throwing an error', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser()
- parser.parse(edi)
- })
-
- it('should parse a fat X12 document without throwing an error', () => {
- const edi = fs.readFileSync('test/test-data/850_fat.edi', 'utf8')
- const parser = new X12Parser(true)
- parser.parse(edi)
- })
-
- it('should parse and reconstruct a valid X12 stream without throwing an error', async () => {
- return await new Promise((resolve, reject) => {
- const ediStream = fs.createReadStream('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser()
- const segments: X12Segment[] = []
-
- ediStream.on('error', error => {
- reject(error)
- })
-
- parser.on('error', error => {
- reject(error)
- })
-
- ediStream
- .pipe(parser)
- .on('data', data => {
- segments.push(data)
- })
- .on('end', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const interchange = parser.getInterchangeFromSegments(segments)
-
- if (interchange.toString() !== edi) {
- reject(new Error('Expected parsed EDI stream to match raw EDI document.'))
- }
- resolve()
- })
- })
- })
-
- it('should produce accurate line numbers for files with line breaks', () => {
- const edi = fs.readFileSync('test/test-data/850_3.edi', 'utf8')
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
-
- const segments = [].concat(
- [
- interchange.header,
- interchange.functionalGroups[0].header,
- interchange.functionalGroups[0].transactions[0].header
- ],
- interchange.functionalGroups[0].transactions[0].segments,
- [
- interchange.functionalGroups[0].transactions[0].trailer,
- interchange.functionalGroups[0].trailer,
- interchange.trailer
- ]
- )
-
- for (let i = 0; i < segments.length; i++) {
- const segment: X12Segment = segments[i]
-
- if (i !== segment.range.start.line) {
- throw new Error(`Segment line number incorrect. Expected ${i}, found ${segment.range.start.line}.`)
- }
- }
- })
-
- it('should throw an ArgumentNullError', () => {
- const parser = new X12Parser()
- let error
-
- try {
- parser.parse(undefined)
- } catch (err) {
- error = err
- }
-
- if (error.name !== 'ArgumentNullError') {
- throw new Error('ArgumentNullError expected when first argument to X12Parser.parse() is undefined.')
- }
- })
-
- it('should throw an ParserError', () => {
- const parser = new X12Parser(true)
- let error
-
- try {
- parser.parse('')
- } catch (err) {
- error = err
- }
-
- if (error.name !== 'ParserError') {
- throw new Error('ParserError expected when document length is too short and parser is strict.')
- }
- })
-
- it('should find mismatched elementDelimiter', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- let error
-
- try {
- parser.parse(edi, { elementDelimiter: '+' })
- } catch (err) {
- error = err
- }
-
- if (error.name !== 'ParserError') {
- throw new Error('ParserError expected when elementDelimiter in document does not match and parser is strict.')
- }
- })
-})
diff --git a/test/ParserSuite_test.ts b/test/ParserSuite_test.ts
new file mode 100644
index 0000000..f5eb1fb
--- /dev/null
+++ b/test/ParserSuite_test.ts
@@ -0,0 +1,137 @@
+// deno-lint-ignore-file no-explicit-any
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import { X12Interchange, X12Parser, X12Segment } from "../mod.ts";
+import fs from "https://deno.land/std@0.136.0/node/fs.ts";
+
+describe("X12Parser", () => {
+ it("should parse a valid X12 document without throwing an error", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser();
+ parser.parse(edi);
+ });
+
+ it("should parse a fat X12 document without throwing an error", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850_fat.edi");
+ const parser = new X12Parser(true);
+ parser.parse(edi);
+ });
+
+ it("should parse and reconstruct a valid X12 stream without throwing an error", async () => {
+ return await new Promise((resolve, reject) => {
+ const ediStream = fs.createReadStream("test/test-data/850.edi"); // TODO: Replicate utf8 encoding mode
+ const parser = new X12Parser();
+ const segments: X12Segment[] = [];
+
+ ediStream.on("error", (error) => {
+ reject(error);
+ });
+
+ parser.on("error", (error) => {
+ reject(error);
+ });
+
+ ediStream
+ .pipe(parser)
+ .on("data", (data) => {
+ segments.push(data);
+ })
+ .on("end", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const interchange = parser.getInterchangeFromSegments(segments);
+
+ if (interchange.toString() !== edi) {
+ reject(
+ new Error(
+ "Expected parsed EDI stream to match raw EDI document.",
+ ),
+ );
+ }
+ resolve();
+ });
+ });
+ });
+
+ it("should produce accurate line numbers for files with line breaks", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850_3.edi");
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+
+ const segments = ([] as X12Segment[]).concat(
+ [
+ interchange.header,
+ interchange.functionalGroups[0].header,
+ interchange.functionalGroups[0].transactions[0].header,
+ ],
+ interchange.functionalGroups[0].transactions[0].segments,
+ [
+ interchange.functionalGroups[0].transactions[0].trailer,
+ interchange.functionalGroups[0].trailer,
+ interchange.trailer,
+ ],
+ );
+
+ for (let i = 0; i < segments.length; i++) {
+ const segment: X12Segment = segments[i];
+
+ if (i !== segment.range.start.line) {
+ throw new Error(
+ `Segment line number incorrect. Expected ${i}, found ${segment.range.start.line}.`,
+ );
+ }
+ }
+ });
+
+ it("should throw an ArgumentNullError", () => {
+ const parser = new X12Parser();
+ let error;
+
+ try {
+ parser.parse(undefined as any);
+ } catch (err) {
+ error = err;
+ }
+
+ if (error.name !== "ArgumentNullError") {
+ throw new Error(
+ "ArgumentNullError expected when first argument to X12Parser.parse() is undefined.",
+ );
+ }
+ });
+
+ it("should throw an ParserError", () => {
+ const parser = new X12Parser(true);
+ let error;
+
+ try {
+ parser.parse("");
+ } catch (err) {
+ error = err;
+ }
+
+ if (error.name !== "ParserError") {
+ throw new Error(
+ "ParserError expected when document length is too short and parser is strict.",
+ );
+ }
+ });
+
+ it("should find mismatched elementDelimiter", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ let error;
+
+ try {
+ parser.parse(edi, { elementDelimiter: "+" });
+ } catch (err) {
+ error = err;
+ }
+
+ if (error.name !== "ParserError") {
+ throw new Error(
+ "ParserError expected when elementDelimiter in document does not match and parser is strict.",
+ );
+ }
+ });
+});
diff --git a/test/QuerySuite.ts b/test/QuerySuite.ts
deleted file mode 100644
index 8c98d2c..0000000
--- a/test/QuerySuite.ts
+++ /dev/null
@@ -1,170 +0,0 @@
-'use strict'
-
-import 'mocha'
-import { X12Parser, X12QueryEngine } from '../core'
-import * as fs from 'fs'
-
-describe('X12QueryEngine', () => {
- it('should handle basic element references', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'REF02')
-
- if (results.length !== 2) {
- throw new Error('Expected two matching elements for REF02.')
- }
- })
-
- it('should handle qualified element references', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'REF02:REF01["DP"]')
-
- if (results.length !== 1) {
- throw new Error('Expected one matching element for REF02:REF01["DP"].')
- } else if (results[0].value !== '038') {
- throw new Error('Expected REF02 to be "038".')
- }
- })
-
- it('should handle segment path element references', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'PO1-PID05:PID01["F"]')
-
- if (results.length !== 6) {
- throw new Error(`Expected six matching elements for PO1-PID05:PID01["F"]; received ${results.length}.`)
- }
- })
-
- it('should handle HL path element references', () => {
- const edi = fs.readFileSync('test/test-data/856.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'HL+S+O+I-LIN03')
-
- if (results[0].value !== '87787D' || results[1].value !== '99887D') {
- throw new Error('Expected two matching elements for HL+S+O+I-LIN03.')
- }
- })
-
- it('should handle HL paths where HL03 is a number', () => {
- const edi = fs.readFileSync('test/test-data/271.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'HL+20+21+22-NM101')
-
- if (results.length !== 2) {
- throw new Error('Expected two matching elements for HL+20+21+22-NM101.')
- }
- })
-
- it('should handle FOREACH macro references', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const result = engine.querySingle(edi, 'FOREACH(PO1)=>PID05:PID01["F"]')
-
- if (result.values.length !== 6) {
- throw new Error(
- `Expected six matching elements for FOREACH(PO1)=>PID05:PID01["F"]; received ${result.values.length}.`
- )
- }
- })
-
- it('should handle CONCAT macro references', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const result = engine.querySingle(edi, 'CONCAT(REF02:REF01["DP"], & )=>REF02:REF01["PS"]')
-
- if (result.value !== '038 & R') {
- throw new Error(`Expected '038 & R'; received '${result.value}'.`)
- }
- })
-
- it('should return valid range information for segments and elements', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const result = engine.querySingle(edi, 'BEG03')
-
- if (result.segment.range.start.line !== 3) {
- throw new Error(`Start line for segment is incorrect; found ${result.segment.range.start.line}, expected 3.`)
- }
-
- if (result.segment.range.start.character !== 0) {
- throw new Error(`Start char for segment is incorrect; found ${result.segment.range.start.character}, expected 0.`)
- }
-
- if (result.element.range.start.line !== 3) {
- throw new Error(`Start line for element is incorrect; found ${result.element.range.start.line}, expected 3.`)
- }
-
- if (result.element.range.start.character !== 10) {
- throw new Error(
- `Start char for element is incorrect; found ${result.element.range.start.character}, expected 10.`
- )
- }
-
- if (result.segment.range.end.line !== 3) {
- throw new Error(`End line for segment is incorrect; found ${result.segment.range.end.line}, expected 3.`)
- }
-
- if (result.segment.range.end.character !== 41) {
- throw new Error(`End char for segment is incorrect; found ${result.segment.range.end.character}, expected 41.`)
- }
-
- if (result.element.range.end.line !== 3) {
- throw new Error(`End line for element is incorrect; found ${result.element.range.end.line}, expected 3.`)
- }
-
- if (result.element.range.end.character !== 20) {
- throw new Error(`End char for element is incorrect; found ${result.element.range.end.character}, expected 20.`)
- }
- })
-
- it('should handle envelope queries', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'ISA06')
-
- if (results.length === 1) {
- if (results[0].value.trim() !== '4405197800') {
- throw new Error(`Expected 4405197800, found ${results[0].value}.`)
- }
- } else {
- throw new Error(`Expected exactly one result. Found ${results.length}.`)
- }
- })
-
- it('should handle queries for files with line feed segment terminators', () => {
- const edi = fs.readFileSync('test/test-data/850_2.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const result = engine.querySingle(edi, 'REF02:REF01["DP"]')
-
- if (result.value.trim() !== '038') {
- throw new Error(`Expected 038, found ${result.value}.`)
- }
- })
-
- it('should handle chained qualifiers', () => {
- const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
- const parser = new X12Parser(true)
- const engine = new X12QueryEngine(parser)
- const results = engine.query(edi, 'REF02:REF01["DP"]:BEG02["SA"]')
-
- if (results.length === 1) {
- if (results[0].value.trim() !== '038') {
- throw new Error(`Expected 038, found ${results[0].value}.`)
- }
- } else {
- throw new Error(`Expected exactly one result. Found ${results.length}.`)
- }
- })
-})
diff --git a/test/QuerySuite_test.ts b/test/QuerySuite_test.ts
new file mode 100644
index 0000000..c60528a
--- /dev/null
+++ b/test/QuerySuite_test.ts
@@ -0,0 +1,194 @@
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import { X12Parser, X12QueryEngine } from "../mod.ts";
+
+describe("X12QueryEngine", () => {
+ it("should handle basic element references", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, "REF02");
+
+ if (results.length !== 2) {
+ throw new Error("Expected two matching elements for REF02.");
+ }
+ });
+
+ it("should handle qualified element references", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, 'REF02:REF01["DP"]');
+
+ if (results.length !== 1) {
+ throw new Error('Expected one matching element for REF02:REF01["DP"].');
+ } else if (results[0].value !== "038") {
+ throw new Error('Expected REF02 to be "038".');
+ }
+ });
+
+ it("should handle segment path element references", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, 'PO1-PID05:PID01["F"]');
+
+ if (results.length !== 6) {
+ throw new Error(
+ `Expected six matching elements for PO1-PID05:PID01["F"]; received ${results.length}.`,
+ );
+ }
+ });
+
+ it("should handle HL path element references", () => {
+ const edi = Deno.readTextFileSync("test/test-data/856.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, "HL+S+O+I-LIN03");
+
+ if (results[0].value !== "87787D" || results[1].value !== "99887D") {
+ throw new Error("Expected two matching elements for HL+S+O+I-LIN03.");
+ }
+ });
+
+ it("should handle HL paths where HL03 is a number", () => {
+ const edi = Deno.readTextFileSync("test/test-data/271.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, "HL+20+21+22-NM101");
+
+ if (results.length !== 2) {
+ throw new Error("Expected two matching elements for HL+20+21+22-NM101.");
+ }
+ });
+
+ it("should handle FOREACH macro references", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const result = engine.querySingle(edi, 'FOREACH(PO1)=>PID05:PID01["F"]');
+
+ if (result?.values.length !== 6) {
+ throw new Error(
+ `Expected six matching elements for FOREACH(PO1)=>PID05:PID01["F"]; received ${
+ result?.values.length
+ }.`,
+ );
+ }
+ });
+
+ it("should handle CONCAT macro references", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const result = engine.querySingle(
+ edi,
+ 'CONCAT(REF02:REF01["DP"], & )=>REF02:REF01["PS"]',
+ );
+
+ if (result?.value !== "038 & R") {
+ throw new Error(`Expected '038 & R'; received '${result?.value}'.`);
+ }
+ });
+
+ it("should return valid range information for segments and elements", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const result = engine.querySingle(edi, "BEG03");
+
+ if (result?.segment?.range.start.line !== 3) {
+ throw new Error(
+ `Start line for segment is incorrect; found ${
+ result?.segment?.range.start.line
+ }, expected 3.`,
+ );
+ }
+
+ if (result.segment.range.start.character !== 0) {
+ throw new Error(
+ `Start char for segment is incorrect; found ${result.segment.range.start.character}, expected 0.`,
+ );
+ }
+
+ if (result?.element?.range.start.line !== 3) {
+ throw new Error(
+ `Start line for element is incorrect; found ${
+ result?.element?.range.start.line
+ }, expected 3.`,
+ );
+ }
+
+ if (result.element.range.start.character !== 10) {
+ throw new Error(
+ `Start char for element is incorrect; found ${result.element.range.start.character}, expected 10.`,
+ );
+ }
+
+ if (result.segment.range.end.line !== 3) {
+ throw new Error(
+ `End line for segment is incorrect; found ${result.segment.range.end.line}, expected 3.`,
+ );
+ }
+
+ if (result.segment.range.end.character !== 41) {
+ throw new Error(
+ `End char for segment is incorrect; found ${result.segment.range.end.character}, expected 41.`,
+ );
+ }
+
+ if (result.element.range.end.line !== 3) {
+ throw new Error(
+ `End line for element is incorrect; found ${result.element.range.end.line}, expected 3.`,
+ );
+ }
+
+ if (result.element.range.end.character !== 20) {
+ throw new Error(
+ `End char for element is incorrect; found ${result.element.range.end.character}, expected 20.`,
+ );
+ }
+ });
+
+ it("should handle envelope queries", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, "ISA06");
+
+ if (results.length === 1) {
+ if (results[0]?.value?.trim() !== "4405197800") {
+ throw new Error(`Expected 4405197800, found ${results[0].value}.`);
+ }
+ } else {
+ throw new Error(`Expected exactly one result. Found ${results.length}.`);
+ }
+ });
+
+ it("should handle queries for files with line feed segment terminators", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850_2.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const result = engine.querySingle(edi, 'REF02:REF01["DP"]');
+
+ if (result?.value?.trim() !== "038") {
+ throw new Error(`Expected 038, found ${result?.value}.`);
+ }
+ });
+
+ it("should handle chained qualifiers", () => {
+ const edi = Deno.readTextFileSync("test/test-data/850.edi");
+ const parser = new X12Parser(true);
+ const engine = new X12QueryEngine(parser);
+ const results = engine.query(edi, 'REF02:REF01["DP"]:BEG02["SA"]');
+
+ if (results.length === 1) {
+ if (results[0]?.value?.trim() !== "038") {
+ throw new Error(`Expected 038, found ${results[0].value}.`);
+ }
+ } else {
+ throw new Error(`Expected exactly one result. Found ${results.length}.`);
+ }
+ });
+});
diff --git a/test/ValidationSuite.ts b/test/ValidationSuite.ts
deleted file mode 100644
index 3b4285b..0000000
--- a/test/ValidationSuite.ts
+++ /dev/null
@@ -1,149 +0,0 @@
-'use strict'
-
-import 'mocha'
-import * as fs from 'fs'
-import * as assert from 'assert'
-import {
- X12Parser,
- X12ValidationEngine,
- X12Interchange,
- X12Segment,
- errorLookup,
- X12ValidationErrorCode
-} from '../core'
-import {
- X12GroupRule,
- X12InterchangeRule,
- X12ValidationRule,
- X12TransactionRule,
- X12SegmentRule,
- X12ElementRule
-} from '../src/X12ValidationEngine'
-
-const edi = fs.readFileSync('test/test-data/850.edi', 'utf8')
-const edi2 = fs.readFileSync('test/test-data/856.edi', 'utf8')
-const validationRule850 = fs.readFileSync('test/test-data/850_validation.rule.json', 'utf8')
-const validationRuleSimple850 = fs.readFileSync('test/test-data/850_validation_simple.rule.json', 'utf8')
-const validationRuleNoHeader850 = fs.readFileSync('test/test-data/850_validation_no_headers.rule.json', 'utf8')
-
-describe('X12ValidationEngine', () => {
- it('should create validation rule', () => {
- const rule = new X12ValidationRule({ engine: /ab+c/gu })
-
- assert.deepStrictEqual(rule instanceof X12ValidationRule, true)
- })
-
- it('should create validation rule from JSON', () => {
- const ruleJson = JSON.parse(validationRule850)
- const rule = new X12InterchangeRule(ruleJson)
- const stringJson = JSON.stringify(rule)
-
- assert.deepStrictEqual(JSON.parse(stringJson), ruleJson)
- // fs.writeFileSync('test/test-data/850_validation.rule.json', JSON.stringify(rule, null, 2))
- })
-
- it('should create validation rule regardless of header or trailer', () => {
- const ruleJson = JSON.parse(validationRuleNoHeader850)
- const rule = new X12InterchangeRule(ruleJson)
-
- assert.deepStrictEqual(rule instanceof X12InterchangeRule, true)
- // fs.writeFileSync('test/test-data/850_validation.rule.json', JSON.stringify(rule, null, 2))
- })
-
- it('should validate X12 document', () => {
- const ruleJson = JSON.parse(validationRuleSimple850)
- const parser = new X12Parser()
- const interchange = parser.parse(edi) as X12Interchange
- const validator = new X12ValidationEngine()
- let rule: any = new X12InterchangeRule(ruleJson)
- let report = validator.assert(interchange, rule)
-
- assert.strictEqual(report, true)
-
- rule = new X12GroupRule(ruleJson.group)
- report = validator.assert(interchange.functionalGroups[0], rule)
-
- assert.strictEqual(report, true)
-
- rule = new X12TransactionRule(ruleJson.group.transaction)
- report = validator.assert(interchange.functionalGroups[0].transactions[0], rule)
-
- assert.strictEqual(report, true)
-
- rule = new X12SegmentRule(ruleJson.group.transaction.segments[0])
- report = validator.assert(interchange.functionalGroups[0].transactions[0].segments[0], rule)
-
- assert.strictEqual(report, true)
-
- rule = new X12ElementRule(ruleJson.group.transaction.segments[0].elements[0])
- report = validator.assert(interchange.functionalGroups[0].transactions[0].segments[0].elements[0], rule)
-
- assert.strictEqual(report, true)
- })
-
- it('should invalidate X12 document', () => {
- const ruleJson = JSON.parse(validationRuleSimple850)
- const parser = new X12Parser()
- const interchange = parser.parse(edi2) as X12Interchange
- const rule = new X12InterchangeRule(ruleJson)
- const validator = new X12ValidationEngine({
- throwError: true,
- acknowledgement: {
- isa: new X12Segment('ISA').setElements([
- '00',
- '',
- '00',
- '',
- 'ZZ',
- 'TEST1',
- 'ZZ',
- 'TEST2',
- '200731',
- '0430',
- 'U',
- '00401',
- '1',
- '1',
- 'P',
- '>'
- ]),
- gs: new X12Segment('GS').setElements(['FA', 'TEST1', 'TEST2', '20200731', '0430', '1', 'X', '004010'])
- }
- })
-
- try {
- validator.assert(interchange, rule)
- } catch (error) {
- const { report } = error
-
- assert.strictEqual(typeof report, 'object')
- }
-
- const acknowledgement = validator.acknowledge()
-
- assert.strictEqual(acknowledgement instanceof X12Interchange, true)
- })
-
- it('should resolve error codes', () => {
- const errorTypes = ['element', 'segment', 'transaction', 'group']
- const ackCodes = 'AMPRWXE'
-
- for (const errorType of errorTypes) {
- for (let i = 1, j = 1; i <= j; i += 1) {
- const result = errorLookup(errorType as any, j.toString())
-
- assert.strictEqual(typeof result, 'object')
-
- if (parseFloat(result.code) > i - 1) {
- j += 1
- }
- }
- }
-
- for (const char of ackCodes) {
- const result = X12ValidationErrorCode.acknowledgement('group', char)
-
- assert.strictEqual(typeof result, 'object')
- }
- })
-})
diff --git a/test/ValidationSuite_test.ts b/test/ValidationSuite_test.ts
new file mode 100644
index 0000000..341d4d4
--- /dev/null
+++ b/test/ValidationSuite_test.ts
@@ -0,0 +1,175 @@
+// deno-lint-ignore-file no-explicit-any
+"use strict";
+
+import "https://raw.githubusercontent.com/aaronhuggins/deno_mocha/e6c179156821c626354a8c792518958625078a82/global_mocha.ts";
+import * as assert from "https://deno.land/std@0.133.0/node/assert.ts";
+import {
+ errorLookup,
+ X12Interchange,
+ X12Parser,
+ X12Segment,
+ X12ValidationEngine,
+ X12ValidationErrorCode,
+} from "../mod.ts";
+import {
+ X12ElementRule,
+ X12GroupRule,
+ X12InterchangeRule,
+ X12SegmentRule,
+ X12TransactionRule,
+ X12ValidationRule,
+} from "../src/X12ValidationEngine/index.ts";
+
+const edi = Deno.readTextFileSync("test/test-data/850.edi");
+const edi2 = Deno.readTextFileSync("test/test-data/856.edi");
+const validationRule850 = Deno.readTextFileSync(
+ "test/test-data/850_validation.rule.json",
+);
+const validationRuleSimple850 = Deno.readTextFileSync(
+ "test/test-data/850_validation_simple.rule.json",
+);
+const validationRuleNoHeader850 = Deno.readTextFileSync(
+ "test/test-data/850_validation_no_headers.rule.json",
+);
+
+describe("X12ValidationEngine", () => {
+ it("should create validation rule", () => {
+ const rule = new X12ValidationRule({ engine: /ab+c/gu });
+
+ assert.deepStrictEqual(rule instanceof X12ValidationRule, true);
+ });
+
+ it("should create validation rule from JSON", () => {
+ const ruleJson = JSON.parse(validationRule850);
+ const rule = new X12InterchangeRule(ruleJson);
+ const stringJson = JSON.stringify(rule);
+
+ assert.deepStrictEqual(JSON.parse(stringJson), ruleJson);
+ // fs.writeFileSync('test/test-data/850_validation.rule.json', JSON.stringify(rule, null, 2))
+ });
+
+ it("should create validation rule regardless of header or trailer", () => {
+ const ruleJson = JSON.parse(validationRuleNoHeader850);
+ const rule = new X12InterchangeRule(ruleJson);
+
+ assert.deepStrictEqual(rule instanceof X12InterchangeRule, true);
+ // fs.writeFileSync('test/test-data/850_validation.rule.json', JSON.stringify(rule, null, 2))
+ });
+
+ it("should validate X12 document", () => {
+ const ruleJson = JSON.parse(validationRuleSimple850);
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi) as X12Interchange;
+ const validator = new X12ValidationEngine();
+ let rule: any = new X12InterchangeRule(ruleJson);
+ let report = validator.assert(interchange, rule);
+
+ assert.strictEqual(report, true);
+
+ rule = new X12GroupRule(ruleJson.group);
+ report = validator.assert(interchange.functionalGroups[0], rule);
+
+ assert.strictEqual(report, true);
+
+ rule = new X12TransactionRule(ruleJson.group.transaction);
+ report = validator.assert(
+ interchange.functionalGroups[0].transactions[0],
+ rule,
+ );
+
+ assert.strictEqual(report, true);
+
+ rule = new X12SegmentRule(ruleJson.group.transaction.segments[0]);
+ report = validator.assert(
+ interchange.functionalGroups[0].transactions[0].segments[0],
+ rule,
+ );
+
+ assert.strictEqual(report, true);
+
+ rule = new X12ElementRule(
+ ruleJson.group.transaction.segments[0].elements[0],
+ );
+ report = validator.assert(
+ interchange.functionalGroups[0].transactions[0].segments[0].elements[0],
+ rule,
+ );
+
+ assert.strictEqual(report, true);
+ });
+
+ it("should invalidate X12 document", () => {
+ const ruleJson = JSON.parse(validationRuleSimple850);
+ const parser = new X12Parser();
+ const interchange = parser.parse(edi2) as X12Interchange;
+ const rule = new X12InterchangeRule(ruleJson);
+ const validator = new X12ValidationEngine({
+ throwError: true,
+ acknowledgement: {
+ isa: new X12Segment("ISA").setElements([
+ "00",
+ "",
+ "00",
+ "",
+ "ZZ",
+ "TEST1",
+ "ZZ",
+ "TEST2",
+ "200731",
+ "0430",
+ "U",
+ "00401",
+ "1",
+ "1",
+ "P",
+ ">",
+ ]),
+ gs: new X12Segment("GS").setElements([
+ "FA",
+ "TEST1",
+ "TEST2",
+ "20200731",
+ "0430",
+ "1",
+ "X",
+ "004010",
+ ]),
+ },
+ });
+
+ try {
+ validator.assert(interchange, rule);
+ } catch (error) {
+ const { report } = error;
+
+ assert.strictEqual(typeof report, "object");
+ }
+
+ const acknowledgement = validator.acknowledge();
+
+ assert.strictEqual(acknowledgement instanceof X12Interchange, true);
+ });
+
+ it("should resolve error codes", () => {
+ const errorTypes = ["element", "segment", "transaction", "group"];
+ const ackCodes = "AMPRWXE";
+
+ for (const errorType of errorTypes) {
+ for (let i = 1, j = 1; i <= j; i += 1) {
+ const result = errorLookup(errorType as any, j.toString());
+
+ assert.strictEqual(typeof result, "object");
+
+ if (parseFloat(result.code) > i - 1) {
+ j += 1;
+ }
+ }
+ }
+
+ for (const char of ackCodes) {
+ const result = X12ValidationErrorCode.acknowledgement("group", char);
+
+ assert.strictEqual(typeof result, "object");
+ }
+ });
+});
diff --git a/test/test-data/Transaction_map.json b/test/test-data/Transaction_map.json
index 8ebfcce..3899656 100644
--- a/test/test-data/Transaction_map.json
+++ b/test/test-data/Transaction_map.json
@@ -1,9 +1,21 @@
{
"header": ["940", "macro['random']()['val']"],
"segments": [
- { "tag": "W05", "elements": ["N", "input['internalOrderId']", "input['orderId']"] },
- { "tag": "N1", "elements": ["ST", "`${input['shippingFirstName']} ${input['shippingLastName']}`"] },
- { "tag": "N3", "elements": ["input['shippingStreet1']", "input['shippingStreet2']"] },
+ {
+ "tag": "W05",
+ "elements": ["N", "input['internalOrderId']", "input['orderId']"]
+ },
+ {
+ "tag": "N1",
+ "elements": [
+ "ST",
+ "`${input['shippingFirstName']} ${input['shippingLastName']}`"
+ ]
+ },
+ {
+ "tag": "N3",
+ "elements": ["input['shippingStreet1']", "input['shippingStreet2']"]
+ },
{
"tag": "N4",
"elements": [
@@ -22,7 +34,10 @@
{ "tag": "N9", "elements": ["12", "987654321"] },
{ "tag": "N9", "elements": ["23", "12345"] },
{ "tag": "G62", "elements": ["37", "macro['currentDate']"] },
- { "tag": "W66", "elements": ["PP", "M", "", "", "GR", "", "", "", "", "UPSN"] },
+ {
+ "tag": "W66",
+ "elements": ["PP", "M", "", "", "GR", "", "", "", "", "UPSN"]
+ },
{
"tag": "LX",
"elements": ["macro['sequence']('LX')['val']"],
diff --git a/test/test-data/Transaction_map_liquidjs.json b/test/test-data/Transaction_map_liquidjs.json
index df02117..c1e108d 100644
--- a/test/test-data/Transaction_map_liquidjs.json
+++ b/test/test-data/Transaction_map_liquidjs.json
@@ -1,9 +1,21 @@
{
"header": ["940", "{{ macro | random }}"],
"segments": [
- { "tag": "W05", "elements": ["N", "{{ input.internalOrderId }}", "{{ input.orderId }}"] },
- { "tag": "N1", "elements": ["ST", "{{ input.shippingFirstName }} {{ input.shippingLastName }}"] },
- { "tag": "N3", "elements": ["{{ input.shippingStreet1 }}", "{{ input.shippingStreet2 }}"] },
+ {
+ "tag": "W05",
+ "elements": ["N", "{{ input.internalOrderId }}", "{{ input.orderId }}"]
+ },
+ {
+ "tag": "N1",
+ "elements": [
+ "ST",
+ "{{ input.shippingFirstName }} {{ input.shippingLastName }}"
+ ]
+ },
+ {
+ "tag": "N3",
+ "elements": ["{{ input.shippingStreet1 }}", "{{ input.shippingStreet2 }}"]
+ },
{
"tag": "N4",
"elements": [
@@ -22,7 +34,10 @@
{ "tag": "N9", "elements": ["12", "987654321"] },
{ "tag": "N9", "elements": ["23", "12345"] },
{ "tag": "G62", "elements": ["37", "{{ macro | edi_date }}"] },
- { "tag": "W66", "elements": ["PP", "M", "", "", "GR", "", "", "", "", "UPSN"] },
+ {
+ "tag": "W66",
+ "elements": ["PP", "M", "", "", "GR", "", "", "", "", "UPSN"]
+ },
{
"tag": "LX",
"elements": ["{{ 'LX' | sequence }}"],
@@ -41,7 +56,9 @@
},
{
"tag": "G69",
- "elements": ["{{ input.orderItems | json_parse | map: 'title' | truncate: 45 | in_loop }}"],
+ "elements": [
+ "{{ input.orderItems | json_parse | map: 'title' | truncate: 45 | in_loop }}"
+ ],
"loopEnd": true
},
{
diff --git a/tsconfig.json b/tsconfig.json
deleted file mode 100644
index 7559cfd..0000000
--- a/tsconfig.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "compilerOptions": {
- "module": "commonjs",
- "moduleResolution": "node",
- "allowSyntheticDefaultImports": true,
- "noImplicitAny": true,
- "removeComments": false,
- "suppressImplicitAnyIndexErrors": true,
- "target": "es2017",
- "experimentalDecorators": true,
- "outDir": "dist",
- "declaration": true,
- "sourceMap": true,
- "types": ["mocha", "node"]
- },
-
- "exclude": ["node_modules", "dist"]
-}
diff --git a/webpack.config.js b/webpack.config.js
deleted file mode 100644
index 0baefd1..0000000
--- a/webpack.config.js
+++ /dev/null
@@ -1,32 +0,0 @@
-const DtsBundleWebpack = require('dts-bundle-webpack')
-
-module.exports = {
- mode: 'production',
- entry: './core.ts',
- output: {
- libraryTarget: 'commonjs',
- filename: 'index.js',
- path: __dirname
- },
- externals: {
- '../nodeRequire.js': './nodeRequire.js'
- },
- resolve: {
- extensions: ['.ts']
- },
- module: {
- rules: [{ test: /\.tsx?$/, loader: 'ts-loader' }]
- },
- target: 'node',
- optimization: {
- minimize: false
- },
- plugins: [
- new DtsBundleWebpack({
- name: 'node-x12',
- baseDir: './',
- main: 'dist/core.d.ts',
- out: 'index.d.ts'
- })
- ]
-}