@effected/yaml 0.5.1 → 0.6.0

package/README.md

@@ -73,6 +73,17 @@ Effect.runPromise(Yaml.stringify({ port: 3000, hosts: ["a", "b"] })).then(consol
 // - b
 ```
 
+Both directions have a synchronous counterpart that returns a `Result` for callers that cannot await an Effect, a `vitest.config.ts` being the motivating case. `Yaml.parse` is defined in terms of `Yaml.parseResult`, so the two forms cannot disagree about what a document means:
+
+```ts
+import { Yaml } from "@effected/yaml";
+import { Result } from "effect";
+
+const result = Yaml.parseResult("port: 3000 # dev server");
+console.log(Result.isSuccess(result) ? result.success : result.failure);
+// { port: 3000 }
+```
+
 ## Hostile input fails typed
 
 An alias bomb — nested anchors whose expansion multiplies at every level — is bounded by an expansion budget and surfaces as a `YamlParseError`, not as an out-of-memory kill:
@@ -99,6 +110,7 @@ Collection nesting past the depth cap behaves the same way, yielding a `NestingD
 
 - `Yaml.parse` / `Yaml.parseAll` — error-recovery parsing of a single document or a `---`-separated stream into plain values, resolving anchors and aliases and aggregating every diagnostic into one `YamlParseError`.
 - `Yaml.stringify` — serialize a plain value back to YAML, failing typed with `YamlStringifyError` on circular references or on excessively deep nesting.
+- `Yaml.parseResult` / `Yaml.stringifyResult` — the pure synchronous counterparts, returning a `Result` instead of an `Effect` for config-time callers that cannot await; each runs the same engine call as its `Effect` variant, so the two forms cannot diverge, and a fatal diagnostic, a duplicate key, an alias bomb or a circular reference still fails typed rather than throwing.
 - `Yaml.stripComments` — quote-aware comment removal that keeps line numbers stable, or every byte offset stable when given a replacement character.
 - `Yaml.equals` / `Yaml.equalsValue` — semantic equality that ignores comments, whitespace, formatting and mapping key order while keeping sequence order significant.
 - `Yaml.schema` / `Yaml.fromString` / `Yaml.YamlFromString` / `Yaml.allFromString` — string→domain schema factories that decode a single document or a whole stream into a validated Effect `Schema` value.

package/index.d.ts

@@ -687,6 +687,35 @@ declare class YamlAlias extends YamlAlias_base {
   /** See `YamlScalar.toValue`. Pure and total. */
   toValue(anchors?: Map<string, YamlNode>): unknown;
 }
+/**
+ * The encoded (plain-object) form of a {@link YamlScalar} — the class fields
+ * without the instance methods. Named so the recursive {@link (YamlNode:variable)}
+ * codec can state its encoded side without a circular type annotation.
+ *
+ * @public
+ */
+interface YamlScalarEncoded extends Schema.Codec.Encoded<typeof YamlScalar> {}
+/**
+ * The encoded (plain-object) form of a {@link YamlMap}. See
+ * {@link YamlScalarEncoded} for why the encoded forms are named interfaces.
+ *
+ * @public
+ */
+interface YamlMapEncoded extends Schema.Codec.Encoded<typeof YamlMap> {}
+/**
+ * The encoded (plain-object) form of a {@link YamlSeq}. See
+ * {@link YamlScalarEncoded} for why the encoded forms are named interfaces.
+ *
+ * @public
+ */
+interface YamlSeqEncoded extends Schema.Codec.Encoded<typeof YamlSeq> {}
+/**
+ * The encoded (plain-object) form of a {@link YamlAlias}. See
+ * {@link YamlScalarEncoded} for why the encoded forms are named interfaces.
+ *
+ * @public
+ */
+interface YamlAliasEncoded extends Schema.Codec.Encoded<typeof YamlAlias> {}
 /**
  * A discriminated-union schema covering all four YAML AST value node types:
  * {@link YamlScalar}, {@link YamlMap}, {@link YamlSeq} and {@link YamlAlias}.
@@ -701,7 +730,7 @@ declare class YamlAlias extends YamlAlias_base {
  *
  * @public
  */
-declare const YamlNode: Schema.Schema<YamlScalar | YamlMap | YamlSeq | YamlAlias>;
+declare const YamlNode: Schema.Codec<YamlScalar | YamlMap | YamlSeq | YamlAlias, YamlScalarEncoded | YamlMapEncoded | YamlSeqEncoded | YamlAliasEncoded>;
 /**
  * The union of all YAML AST value node types.
  *
@@ -709,8 +738,8 @@ declare const YamlNode: Schema.Schema<YamlScalar | YamlMap | YamlSeq | YamlAlias
  */
 type YamlNode = YamlScalar | YamlMap | YamlSeq | YamlAlias;
 declare const YamlPair_base: Schema.Class<YamlPair, Schema.TaggedStruct<"YamlPair", {
-  readonly key: Schema.suspend<Schema.Schema<YamlNode>>;
-  readonly value: Schema.NullOr<Schema.suspend<Schema.Schema<YamlNode>>>;
+  readonly key: Schema.suspend<Schema.Codec<YamlAlias | YamlMap | YamlScalar | YamlSeq, YamlAliasEncoded | YamlMapEncoded | YamlScalarEncoded | YamlSeqEncoded, never, never>>;
+  readonly value: Schema.NullOr<Schema.suspend<Schema.Codec<YamlAlias | YamlMap | YamlScalar | YamlSeq, YamlAliasEncoded | YamlMapEncoded | YamlScalarEncoded | YamlSeqEncoded, never, never>>>;
   readonly comment: Schema.optionalKey<Schema.String>;
 }>, {}>;
 /**
@@ -721,7 +750,7 @@ declare const YamlPair_base: Schema.Class<YamlPair, Schema.TaggedStruct<"YamlPai
  */
 declare class YamlPair extends YamlPair_base {}
 declare const YamlMap_base: Schema.Class<YamlMap, Schema.TaggedStruct<"YamlMap", {
-  readonly items: Schema.$Array<Schema.suspend<Schema.Schema<YamlPair>>>;
+  readonly items: Schema.$Array<Schema.suspend<typeof YamlPair>>;
   readonly tag: Schema.optionalKey<Schema.String>;
   readonly anchor: Schema.optionalKey<Schema.String>;
   readonly style: Schema.Literals<readonly ["block", "flow"]>;
@@ -751,7 +780,7 @@ declare class YamlMap extends YamlMap_base {
   toValue(anchors?: Map<string, YamlNode>): unknown;
 }
 declare const YamlSeq_base: Schema.Class<YamlSeq, Schema.TaggedStruct<"YamlSeq", {
-  readonly items: Schema.$Array<Schema.suspend<Schema.Schema<YamlNode>>>;
+  readonly items: Schema.$Array<Schema.suspend<Schema.Codec<YamlAlias | YamlMap | YamlScalar | YamlSeq, YamlAliasEncoded | YamlMapEncoded | YamlScalarEncoded | YamlSeqEncoded, never, never>>>;
   readonly tag: Schema.optionalKey<Schema.String>;
   readonly anchor: Schema.optionalKey<Schema.String>;
   readonly style: Schema.Literals<readonly ["block", "flow"]>;
@@ -1588,5 +1617,5 @@ declare class YamlVisitor {
   static visit(text: string, options?: YamlParseOptions): Stream.Stream<YamlVisitorEvent>;
 }
 //#endregion
-export { CollectionStyle, QuoteStyle, ScalarChomp, ScalarStyle, Yaml, YamlAlias, type YamlBoundCodec, YamlComposerErrorCode, YamlDiagnostic, YamlDirective, YamlDocument, YamlEdit, YamlErrorCode, YamlFormat, YamlFormattingOptions, YamlLexErrorCode, YamlMap, YamlModificationError, YamlModifyErrorCode, YamlNode, YamlPair, YamlParseError, YamlParseErrorCode, YamlParseOptions, type YamlPath, YamlRange, type YamlRangeLike, YamlScalar, type YamlSegment, YamlSeq, YamlStringifyError, YamlStringifyErrorCode, YamlStringifyOptions, YamlVisitor, YamlVisitorEvent };
+export { CollectionStyle, QuoteStyle, ScalarChomp, ScalarStyle, Yaml, YamlAlias, type YamlAliasEncoded, type YamlBoundCodec, YamlComposerErrorCode, YamlDiagnostic, YamlDirective, YamlDocument, YamlEdit, YamlErrorCode, YamlFormat, YamlFormattingOptions, YamlLexErrorCode, YamlMap, type YamlMapEncoded, YamlModificationError, YamlModifyErrorCode, YamlNode, YamlPair, YamlParseError, YamlParseErrorCode, YamlParseOptions, type YamlPath, YamlRange, type YamlRangeLike, YamlScalar, type YamlScalarEncoded, type YamlSegment, YamlSeq, type YamlSeqEncoded, YamlStringifyError, YamlStringifyErrorCode, YamlStringifyOptions, YamlVisitor, YamlVisitorEvent };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/yaml",
-	"version": "0.5.1",
+	"version": "0.6.0",
 	"private": false,
 	"description": "Zero-dependency YAML parsing, editing and formatting as Effect schemas.",
 	"keywords": [