Merge pull request #38 from dfpc-coe/flow

Add Flow Stripping

Author: ingalls

.github/workflows/doc.yml

@@ -25,10 +25,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Setup Pages
         uses: actions/configure-pages@v5
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
             node-version: 22
             registry-url: https://registry.npmjs.org/
@@ -37,7 +37,7 @@ jobs:
       - name: npm run doc
         run: npm run doc
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           path: './docs/'
       - name: Deploy to GitHub Pages

.github/workflows/release.yml

@@ -31,12 +31,8 @@ jobs:
       - name: npm publish
         run: npm publish --provenance --access public
 
-      - name: Get tag
-        id: tag
-        uses: dawidd6/action-get-tag@v1
-
       - name: Generate CHANGELOG
-        run: grep -Pzo "### ${{steps.tag.outputs.tag}}(?s).*?(?=###)" CHANGELOG.md > RELEASE
+        run: grep -Pzo "### ${{ github.ref_name }}(?s).*?(?=###)" CHANGELOG.md > RELEASE
 
       - name: Github Release
         uses: softprops/action-gh-release@v2

.github/workflows/test.yml

@@ -16,11 +16,11 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event.pull_request.draft == false
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version: 22
           registry-url: https://registry.npmjs.org/

index.ts

@@ -86,9 +86,25 @@ export type TAKOptions = {
     socketBatchSize?: number;
 };
 
+export type WriteOptions = {
+    /** Remove any existing flow tags and replace them with a fresh
+     *  `NodeCoT-*` entry before serializing to XML.
+     *  Useful when re-submitting CoTs back to TAK Server over 8089.
+     *  @default false */
+    stripFlow?: boolean;
+};
+
 const DEFAULT_WRITE_QUEUE_SIZE = 10_000;
 const DEFAULT_SOCKET_BATCH_SIZE = 64;
 
+function cloneCoT(cot: CoT): CoT {
+    const cloned = new CoT(JSON.parse(JSON.stringify(cot.raw)));
+    cloned.metadata = JSON.parse(JSON.stringify(cot.metadata));
+    cloned.path = cot.path;
+
+    return cloned;
+}
+
 export default class TAK extends EventEmitter {
     id: number | string;
     type: string;
@@ -394,14 +410,17 @@ export default class TAK extends EventEmitter {
      *
      * @param cots Array of CoT objects to send
      */
-    async write(cots: CoT[]): Promise<void> {
+    async write(cots: CoT[], opts: WriteOptions = {}): Promise<void> {
         for (let i = 0; i < cots.length; ) {
             if (this.destroyed) return;
 
             // Serialize upfront and push XML strings into the ring buffer
             while (
                 i < cots.length &&
-                this.queue.push(CoTParser.to_xml(cots[i]))
+                this.queue.push(CoTParser.to_xml(
+                    opts.stripFlow ? cloneCoT(cots[i]) : cots[i],
+                    opts.stripFlow ? { resetFlow: true } : undefined,
+                ))
             ) {
                 i++;
             }