@tsdmarc/opensearch 0.0.0-stage → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @tsdmarc/opensearch
+
+## 1.0.0
+
+### Major Changes
+
+- a1c5fad: First release: a 1:1 TypeScript port of parsedmarc 11.2.1 and of the parts of mailsuite 2.3.4 it uses, for Node.js 24+, Bun and Deno.
+
+### Patch Changes
+
+- Updated dependencies [a1c5fad]
+  - tsdmarc@1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,61 @@
+tsdmarc
+Copyright 2026 tsdmarc contributors
+
+This product is a TypeScript port of parsedmarc
+(https://github.com/domainaware/parsedmarc), Copyright Sean Whalen and
+parsedmarc contributors, licensed under the Apache License, Version 2.0.
+Ported from parsedmarc 11.2.1, commit 7bbc405c01a1c4c37811b2a3746e8881c00cda39.
+
+The mailbox connection and SMTP code is a port of mailsuite
+(https://github.com/seanthegeek/mailsuite), Copyright Sean Whalen,
+licensed under the Apache License, Version 2.0.
+Ported from mailsuite 2.3.4, commit 3bd62831d137c9aa7884be33b83323ca3a1bd1de.
+
+All source files were translated from Python to TypeScript; this is a
+modification of the original works within the meaning of section 4(b) of
+the Apache License.
+
+Third-party data files in resources/:
+- ipinfo_lite.mmdb: IPinfo Lite, (c) IPinfo (https://ipinfo.io/lite),
+  licensed under CC BY-SA 4.0.
+- base_reverse_dns_map.csv: from parsedmarc, derived in part from IPinfo
+  Lite data, licensed under CC BY-SA 4.0.
+
+Ported third-party code in packages/tsdmarc/src (behavior reimplemented in
+TypeScript to reproduce parsedmarc's output exactly):
+- xml/expat.ts, xml/expat-names.ts: port of parts of Expat 2.9.0
+  (https://libexpat.github.io/), Copyright (c) 1997-2000 Thai Open Source
+  Software Center Ltd and Copyright (c) 2000-2026 Expat development team,
+  licensed under the MIT License.
+- xml/xmltodict.ts: port of xmltodict (https://github.com/martinblech/xmltodict),
+  Copyright (c) 2012 Martin Blech, licensed under the MIT License.
+- xml/recover.ts: emulates the observable recovery behavior of libxml2
+  (https://gitlab.gnome.org/GNOME/libxml2), MIT License.
+- utils/py-email/, utils/py-codecs*.ts, utils/py-binascii.ts, utils/py-str.ts,
+  csv.ts, utils/csv-reader.ts, utils/url-split.ts: ports of parts of the
+  CPython standard library (https://github.com/python/cpython), Copyright (c)
+  2001 Python Software Foundation, licensed under the PSF License Agreement.
+- utils/mailparser/: port of mail-parser 4.8.0
+  (https://github.com/SpamScope/mail-parser), Copyright Fedele Mantuano,
+  licensed under the Apache License, Version 2.0.
+- utils/dns*.ts: port of parts of dnspython (https://www.dnspython.org/),
+  Copyright (c) Dnspython Contributors, licensed under the ISC License.
+- utils/timestamps.ts: date parsing compatible with python-dateutil
+  (https://github.com/dateutil/dateutil), Apache License 2.0 / BSD 3-Clause.
+- internal/zipfile.ts and the decompressor wrappers in internal/bz2.ts,
+  internal/lzma.ts, internal/zstd.ts and internal/zlib.ts: ports of parts of
+  the CPython standard library (zipfile, bz2, lzma, compression.zstd, zlib
+  modules), Copyright (c) 2001 Python Software Foundation, licensed under the
+  PSF License Agreement.
+- internal/zlib.ts: port of the inflate code of zlib 1.3 (https://zlib.net/),
+  Copyright (C) 1995-2023 Jean-loup Gailly and Mark Adler, licensed under the
+  zlib License.
+- internal/bz2.ts: port of the libbzip2 1.0.8 decompressor
+  (https://sourceware.org/bzip2/), Copyright (C) 1996-2019 Julian R Seward,
+  licensed under the bzip2 license (BSD-style).
+- internal/lzma.ts: port of the LZMA1 decoder of liblzma 5.8
+  (https://tukaani.org/xz/), by Igor Pavlov and Lasse Collin, licensed under
+  the BSD Zero Clause License (0BSD).
+- internal/zstd.ts: port of the libzstd 1.5.7 decoder
+  (https://github.com/facebook/zstd), Copyright (c) Meta Platforms, Inc. and
+  affiliates, licensed under the BSD 3-Clause License.

package/README.md

@@ -1,3 +1,178 @@
-# Temporary Holding Version
+# @tsdmarc/opensearch
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Save tsdmarc reports to OpenSearch (self-managed or Amazon OpenSearch Service). Port of parsedmarc's `opensearch.py`, on [`@opensearch-project/opensearch`](https://www.npmjs.com/package/@opensearch-project/opensearch): same index names, documents, duplicate checks and migrations, so parsedmarc's OpenSearch Dashboards and Grafana dashboards ([`dashboards/`](https://github.com/helixnebulatech/tsdmarc/tree/main/dashboards)) work unchanged.
+
+## Install
+
+```sh
+npm install tsdmarc @tsdmarc/opensearch
+```
+
+`tsdmarc` is a peer dependency. Node.js 24 or later, Bun or Deno.
+
+## Usage
+
+```ts
+import {
+  AlreadySaved,
+  getDefaultConnection,
+  migrateIndexes,
+  saveAggregateReportToOpenSearch,
+  saveFailureReportToOpenSearch,
+  saveSmtpTlsReportToOpenSearch,
+  setDefaultConnection,
+  setHosts,
+} from '@tsdmarc/opensearch';
+import { parseReportFile } from 'tsdmarc';
+
+await setHosts('search.example.com:9200', {
+  useSsl: true,
+  username: process.env.OPENSEARCH_USER,
+  password: process.env.OPENSEARCH_PASSWORD,
+});
+await migrateIndexes({
+  aggregateIndexes: ['dmarc_aggregate'],
+  smtpTlsIndexes: ['smtp_tls'],
+});
+
+try {
+  const parsed = await parseReportFile('report.xml.gz');
+  if (parsed.reportType === 'aggregate') {
+    await saveAggregateReportToOpenSearch(parsed.report);
+  } else if (parsed.reportType === 'failure') {
+    await saveFailureReportToOpenSearch(parsed.report);
+  } else {
+    await saveSmtpTlsReportToOpenSearch(parsed.report);
+  }
+} catch (error) {
+  if (!(error instanceof AlreadySaved)) {
+    throw error;
+  }
+} finally {
+  await getDefaultConnection()?.close();
+  setDefaultConnection(null);
+}
+```
+
+`setHosts()` registers a module-wide default client that the other functions use, like parsedmarc's DSL connection. The save functions create the index if needed and throw `AlreadySaved` when the report is already stored.
+
+### Several clusters
+
+The default connection is module state, shared by everything in the process: a later `setHosts()` or `setDefaultConnection()` redirects the requests of saves still in progress. One connection at a time is supported that way. An application that writes to several clusters at once (one per tenant, say) creates a client per cluster with `createClient()`, which takes the same options as `setHosts()` but registers nothing, and passes it as `client`:
+
+```ts
+import {
+  createClient,
+  saveAggregateReportToOpenSearch,
+} from '@tsdmarc/opensearch';
+
+const tenantClient = await createClient('https://tenant-a.example.com:9200', {
+  username: 'tsdmarc',
+  password: process.env.TENANT_A_PASSWORD,
+});
+await saveAggregateReportToOpenSearch(report, { client: tenantClient });
+await tenantClient.close();
+```
+
+`client` is accepted by the save functions, `createIndexes()` (fourth argument, `{ client }`) and `migrateIndexes()`. A client from anywhere else works too, with its own settings.
+
+Documents go to `[indexPrefix]<base>[_indexSuffix]-YYYY-MM-DD` (or `-YYYY-MM` with `monthlyIndexes`), with `<base>` one of `dmarc_aggregate`, `dmarc_failure` and `smtp_tls`. Field names are snake_case, as in parsedmarc. Every document carries an `@timestamp`: the record's begin date for aggregate reports, the arrival date for failure reports and the begin date for SMTP TLS reports.
+
+### Data streams
+
+With `useDataStreams: true`, each report type goes to one data stream named like the index without the date (`[indexPrefix]<base>[_indexSuffix]`), and `monthlyIndexes` is ignored. The save functions put an index template named after the stream, whose `index_patterns` is the exact name, and create the stream; an ISM policy attaches itself to the backing indices through its `ism_template`. tsdmarc puts its template again in every process, so edit the policy, not the template. Retention is up to you. Dated indexes saved before the switch stay where they are, and the duplicate search covers both. If an index or alias already holds a stream's name (such as an undated index from parsedmarc before 5.0.0), saving fails with `OpenSearchError`.
+
+## Amazon OpenSearch Service
+
+`authType: 'awssigv4'` signs requests with AWS Signature Version 4. Credentials come from the AWS SDK's default provider chain (environment, shared config files, SSO, instance or container roles), and are checked when `setHosts()` runs. The AWS SDK is loaded only in this mode.
+
+```ts
+await setHosts('search-domain.eu-west-1.es.amazonaws.com:443', {
+  useSsl: true,
+  authType: 'awssigv4',
+  awsRegion: 'eu-west-1',
+  awsService: 'es', // 'aoss' for OpenSearch Serverless
+});
+```
+
+## API
+
+| Function | Description |
+| --- | --- |
+| `setHosts(hosts, options?)` | Create the client for one host or an array of hosts and register it as the default connection. Returns the client. |
+| `createClient(hosts, options?)` | Create a client like `setHosts()` without registering it, to pass as `client` (see [Several clusters](#several-clusters)). |
+| `saveAggregateReportToOpenSearch(report, options?)` | Save an aggregate report, one document per record. |
+| `saveFailureReportToOpenSearch(report, options?)` | Save a failure report. `saveForensicReportToOpenSearch` is a backward-compatible alias. |
+| `saveSmtpTlsReportToOpenSearch(report, options?)` | Save an SMTP TLS report. |
+| `migrateIndexes(options?)` | Run parsedmarc's index migrations and backfills. Logs warnings instead of throwing. |
+| `createIndexes(names, settings?, mappings?, { client }?)` | Create indexes that don't exist yet (default settings: 1 shard, 0 replicas). |
+| `createDataStreams(names, settings?, mappings?, { client }?)` | Put the index template of each data stream and create the streams that don't exist yet (see [Data streams](#data-streams)). |
+| `getDefaultConnection()` / `setDefaultConnection(client)` | Read or replace the registered client (`null` removes it). |
+| `AlreadySaved`, `OpenSearchError`, `BulkIndexError`, `ScanError` | Errors. |
+| `DOCUMENT_MAPPINGS`, `BACKFILL` | The mappings parsedmarc's document classes declare, and the backfill queries/scripts `migrateIndexes()` submits. |
+
+### `setHosts()` options
+
+Hosts without a scheme default to port 9200; `https://` hosts default to port 443.
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `useSsl` | `boolean \| null` | `false` | Use HTTPS for every host. |
+| `sslCertPath` | `string \| null` | `null` | Path to the CA certificate chain (with `useSsl`). |
+| `skipCertificateVerification` | `boolean` | `false` | Skip certificate verification (with `useSsl`). |
+| `username` | `string \| null` | `null` | Basic auth user name (used only with `password`). |
+| `password` | `string \| null` | `null` | Basic auth password. |
+| `apiKey` | `string \| null` | `null` | Accepted but not sent, like parsedmarc (opensearch-py ignores a client-level `api_key`). |
+| `timeout` | `number \| null` | `60` | Request timeout in seconds. `null` disables it; `0` or less throws `ValueError`. |
+| `authType` | `string` | `'basic'` | `'basic'` or `'awssigv4'`. |
+| `awsRegion` | `string \| null` | `null` | AWS region; required with `awssigv4`. |
+| `awsService` | `string` | `'es'` | Service name to sign for; `'aoss'` for OpenSearch Serverless. |
+
+### Save options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `indexSuffix` | `string \| null` | — | Appended to the index name as `_<suffix>`. |
+| `indexPrefix` | `string \| null` | — | Prepended to the index name as is. |
+| `monthlyIndexes` | `boolean \| null` | `false` | Monthly indexes instead of daily ones (ignored with `useDataStreams`). |
+| `useDataStreams` | `boolean` | `false` | Save to a data stream instead of dated indexes (see [Data streams](#data-streams)). |
+| `numberOfShards` | `number` | `1` | Shards for a new index. |
+| `numberOfReplicas` | `number` | `0` | Replicas for a new index. |
+| `maxIndexesPerReport` | `number` | `31` | Most indexes one aggregate report may spread over; later records go to its first index. `0` removes the limit. tsdmarc only. |
+| `client` | `Client \| null` | default connection | The OpenSearch client to use (see [Several clusters](#several-clusters)). |
+
+### `migrateIndexes()` options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `aggregateIndexes` | `string[] \| null` | — | Aggregate index names, backfilled as `name*`. |
+| `failureIndexes` | `string[] \| null` | — | Accepted for API compatibility; unused. |
+| `smtpTlsIndexes` | `string[] \| null` | — | SMTP TLS index names, backfilled as `name*`. |
+| `legacyFoIndexes` | `string[] \| null` | — | Exact index names to check for the pre-5.0.0 `published_policy.fo` `long` mapping. |
+| `client` | `Client \| null` | default connection | The client to use. |
+
+## CLI
+
+With [`@tsdmarc/cli`](https://github.com/helixnebulatech/tsdmarc/tree/main/packages/cli#readme), use the `[opensearch]` section of the configuration file (the same as parsedmarc's): `hosts`, `user`, `password`, `api_key`, `ssl`, `cert_path`, `skip_certificate_verification`, `timeout`, `index_suffix`, `index_prefix`, `monthly_indexes`, `number_of_shards`, `number_of_replicas`, `auth_type` (or `authentication_type`), `aws_region` and `aws_service`.
+
+## Notes
+
+Differences from parsedmarc (full list in [architecture/README.md](https://github.com/helixnebulatech/tsdmarc/blob/main/architecture/README.md#differences-from-parsedmarc)):
+
+- Functions are `async` and take an options object.
+- Retries follow opensearch-py: 3 retries on connection errors and HTTP 502/503/504, none on a timeout (opensearch-js alone would also resend timed-out requests).
+- The JavaScript client sends `/{index}/_mapping` as POST where the Python client uses PUT; servers accept both.
+- `setHosts()` replaces the default connection without closing the previous client, like the Python DSL registry. On shutdown, call `await getDefaultConnection()?.close()` and `setDefaultConnection(null)`.
+- Logged host URLs show the password as `***` (`user:***@`), as in parsedmarc 11.2; tsdmarc also masks everything up to the last `@` of a malformed URL.
+- Error messages that include an SDK error carry the JavaScript client's message.
+- Like parsedmarc, `createIndexes()` does not install `DOCUMENT_MAPPINGS`. The save functions, however, create new indexes with `date_detection: false` and mappings for the date fields only (`@timestamp`, `date_range`, `date_begin`, `date_end`, `arrival_date`, `sample.date`), so a text value that looks like a date can't map its field as `date`. parsedmarc creates bare indexes. Existing indexes are not changed.
+- Data stream templates carry the same date mappings and `sample.headers` mapping as the indexes the save functions create (parsedmarc's map only `@timestamp`), and their description names tsdmarc. A data stream created by another writer between the checks, or an alias holding the name, is told apart from a name collision.
+- One aggregate report spreads over at most `maxIndexesPerReport` (31) indexes: its sender picks the `date_range`, and in parsedmarc a few KB can create more than 1,000 daily indexes and use up `cluster.max_shards_per_node`. Records past the limit go to the report's first index with their dates intact.
+- Dots in failure sample header names become `_`, so a `Subject.x` header can't turn `sample.headers.subject` into an object.
+- New failure indexes map only a fixed list of `sample.headers` fields (those the shipped dashboards use, plus a few such as `cc` and `received-spf`) and set `dynamic: false` on the rest: every header stays in `_source` and shows in Discover, but the others cannot be searched. parsedmarc maps every header name a sender invents, which can use up `index.mapping.total_fields.limit` and get the samples of the rest of that day (or month) rejected. Indexes that already exist keep their mapping.
+
+---
+
+Part of [tsdmarc](https://github.com/helixnebulatech/tsdmarc#readme), a TypeScript port of [parsedmarc](https://github.com/domainaware/parsedmarc). Licensed under Apache-2.0.
+
+Created by [HelixNebula](https://helixnebula.tech).