@endevops/effect-codec-xml 0.0.1 → 0.1.0-beta.1

package/src/xml-error.ts

@@ -6,38 +6,38 @@
  *
  * ## Why one error with a `reason`, and not one error per cause
  *
- * The causes would mean a class each, and a caller handling "any of these" would need `catchTags` with all of them. The causes are not independent
- * decisions a caller usually wants to make separately — they are all "this XML input was not acceptable", and the useful split is coarse: a bad
- * _configuration_ versus a bad _document_. So there is one error, and `reason` narrows to the specific cause. Recovery is a `catchReason` away:
+ * The causes would mean a class each, and a caller handling "any of these" would need `catchTags` with all of them. A caller does not usually want to
+ * decide between the causes separately. They are all "this XML input was not acceptable", and the useful split is coarse: a bad _configuration_
+ * versus a bad _document_. So there is one error, and `reason` narrows to the specific cause. Recovery is a `catchReason` away:
  *
  * @example
  *   ```typescript
  *   import { Effect } from 'effect';
- *   import { EntityDecoder, XmlError } from '@endevops/effect-xml-codec';
+ *   import { EntityDecoder, XmlError } from '@endevops/effect-codec-xml';
  *
  *   const limited = new EntityDecoder({ limit: { maxTotalExpansions: 2 } }).decode('&&&').pipe(
  *   Effect.catchReason('XmlError', 'ExpansionLimitExceeded', reason => Effect.succeed(`gave up after ${reason.actual}`)),
  *   );
  *   ```;
  *
- *   The message is kept alongside `reason` and is part of the schema, because the text is load-bearing: the
- *   `[EntityReplacer]` prefix in particular is documented as something callers match on, so it is reproduced exactly
- *   rather than reworded.
+ *   The message is kept alongside `reason` and is part of the schema, because callers depend on the text. The
+ *   `[EntityReplacer]` prefix in particular is documented as something callers match on, so the codec reproduces it exactly
+ *   rather than rewording it.
  */
 
 import { Schema } from 'effect';
 
 /**
  * @description The specific cause of an {@link XmlError}, as a tagged union. The `_tag` on each member is the discriminant `Effect.catchReason` matches on, and
- * the payload is what a handler needs in order to decide or to report. Every member is a case the decoder or the name validators actually raise —
- * there is no catch-all member, so an exhaustive `match` stays exhaustive as causes are added.
+ * the payload is what a handler needs in order to decide or to report. Every member is a case the decoder or the name validators actually raise.
+ * There is no catch-all member, so an exhaustive `match` stays exhaustive as causes are added.
  */
 export const XmlErrorReason = Schema.TaggedUnion({
   /**
    * @description A required argument was `null` or another non-value where the package requires a real one. Raised by the factories that take caller-supplied
-   * input — {@link EntityDecoder.make} among them — when they are handed `null` for an options object that has no meaningful default. It is a
-   * distinct case from the rest because the argument is not _wrong_, it is _absent_, and a caller who wrote `make(null)` meant something the type
-   * system does not allow: a decoder with every default is `make({})`, and saying so here is more useful than silently producing one.
+   * input, {@link EntityDecoder.make} among them, when they are handed `null` for an options object that has no meaningful default. It is a distinct
+   * case from the rest because the argument is not _wrong_, it is _absent_, and a caller who wrote `make(null)` meant something the type system does
+   * not allow. A decoder with every default is `make({})`, and saying so here is more useful than silently producing one.
    */
   MissingOptions: {
     /**
@@ -48,7 +48,7 @@ export const XmlErrorReason = Schema.TaggedUnion({
 
   /**
    * @description A name was checked against one of the five XML name productions and given a different one. Unreachable from TypeScript, where `Production` is a
-   * closed union — it is the guard for untyped JavaScript callers and for values that crossed a boundary as `unknown`.
+   * closed union. It is the guard for untyped JavaScript callers and for values that crossed a boundary as `unknown`.
    */
   InvalidProduction: {
     production: Schema.String,
@@ -78,7 +78,7 @@ export const XmlErrorReason = Schema.TaggedUnion({
    */
   EntityRejected: {
     /**
-     * @description Which registration was in progress. Both are runtime-injected, which is why they share a tier for limit accounting.
+     * @description Which registration was in progress. The runtime injects both, so they share a tier for limit accounting.
      */
     context: Schema.Literals(['external', 'input']),
     /**
@@ -93,7 +93,7 @@ export const XmlErrorReason = Schema.TaggedUnion({
    */
   ExpansionLimitExceeded: {
     /**
-     * @description The count that tripped the limit. Deliberately not reset on failure, so this is the real over-limit total rather than the ceiling.
+     * @description The count that tripped the limit. The counter is not reset on failure, so this is the real over-limit total rather than the ceiling.
      */
     actual: Schema.Number,
     /**
@@ -139,14 +139,14 @@ export const XmlErrorReason = Schema.TaggedUnion({
 export type XmlErrorReason = typeof XmlErrorReason.Type;
 
 /**
- * @description Every failure this package can report, in the `E` channel of the effects that can fail. Carries both a `reason` — the typed, matchable cause — and
+ * @description Every failure this package can report, in the `E` channel of the effects that can fail. Carries both a `reason`, the typed and matchable cause, and
  * a `message`, which is the human-readable form the package has always produced. Both are part of the schema, so an error survives a round-trip
  * through a serialised boundary without losing either.
  *
  * @example
  *   ```typescript
  *   import { Effect } from 'effect';
- *   import { EntityDecoder } from '@endevops/effect-xml-codec';
+ *   import { EntityDecoder } from '@endevops/effect-codec-xml';
  *
  *   const program = Effect.gen(function*() {
  *     const decoder = yield* EntityDecoder.make({});
@@ -162,7 +162,7 @@ export class XmlError extends Schema.TaggedError<XmlError>()('XmlError', {
 
   /**
    * @description Human-readable description. The `[EntityReplacer]` and `[EntityDecoder]` prefixes are reproduced verbatim from the original throw sites, because
-   * they are documented as load-bearing for anything matching on them.
+   * anything matching on them depends on them.
    */
   message: Schema.String,
 }) {}

package/src/xml-value.ts

@@ -11,10 +11,10 @@ export interface XmlRecord {
 
 /**
  * @description One value in an XML document: nothing at all, character data, a repeated run of children, or a record of attributes, text and child elements.
- * `undefined` is a value of its own rather than an omission, because that is how an absent optional field survives a round trip: a field with no
- * value stays distinguishable from a field whose value is the empty string, and the renderer writes neither of them. The shape is deliberately the
- * same one `Schema.toCodecStringTree` derives, which is what lets every schema feature Effect supports round-trip through this package without
- * re-implementing the derivation.
+ * `undefined` is a value of its own rather than an omission, because that is how an absent optional field survives a round trip. A field with no
+ * value stays distinguishable from a field whose value is the empty string, and the renderer writes neither of them. The shape is the same one
+ * `Schema.toCodecStringTree` derives, and sharing that shape is what lets every schema feature Effect supports round-trip through this package
+ * without re-implementing the derivation.
  */
 export type XmlValue = string | undefined | ReadonlyArray<XmlValue> | XmlRecord;
 
@@ -34,10 +34,9 @@ const MAX_GUARD_DEPTH = 512;
 export const isXmlValue = (input: unknown): input is XmlValue => check(input, 0);
 
 /**
- * @description One level of {@link isXmlValue}, with the depth it was reached at. The depth is the whole defence against a value built to be hostile: a
- * self-referential object would otherwise recurse until the stack gave out, and a value nested thousands deep would take it with it. Both are
- * rejected here instead, which is why this is a real recursion with a bound rather than a loop — the model is a tree, and a tree is walked by walking
- * it.
+ * @description One level of {@link isXmlValue}, with the depth it was reached at. The depth is the whole defence against a value built to be hostile. A
+ * self-referential object would otherwise recurse until the stack gave out, and a value nested thousands deep would take it with it. This rejects
+ * both, so it is a bounded recursion rather than a loop. The model is a tree, and walking a tree means walking it.
  *
  * @param input - The candidate value.
  * @param depth - How many levels down this value sits.
@@ -90,13 +89,13 @@ const everyFieldIs = (input: object, depth: number): boolean => {
 };
 
 /**
- * @description A schema for {@link XmlValue}, so a value can be validated on its own — when it arrives from a store or a queue rather than from {@link parseXml},
- * and the schema it belongs to is not in hand.
+ * @description A schema for {@link XmlValue}, so a value can be validated on its own. This helps when it arrives from a store or a queue rather than from
+ * {@link parseXml}, and the schema it belongs to is not in hand.
  *
  * @example
  *   ```typescript
  *   import { Schema } from 'effect';
- *   import { XmlValue } from '@endevops/effect-xml-codec';
+ *   import { XmlValue } from '@endevops/effect-codec-xml';
  *
  *   Schema.decodeUnknownSync(XmlValue)({ book: { '@id': '1', title: 'Dune' } }); // => { book: { '@id': '1', title: 'Dune' } }
  *   Schema.decodeUnknownSync(XmlValue)({ book: { title: 42 } }); // => throws XmlValue