⬆️ Update dependency @effect/schema to v0.75.5 #56

renovate · 2024-02-05T22:16:02Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@effect/schema (source)	`0.60.4` -> `0.75.5`

Release Notes

Effect-TS/effect (@effect/schema)

`v0.75.5`

Compare Source

Patch Changes

#3792 382556f Thanks @gcanti! - resolve parse error when using pick with union of class schemas, closes #3751

#3790 97cb014 Thanks @gcanti! - Equivalence: Fixed a bug related to discriminated tuples.

Example:

The following equivalence check was incorrectly returning false:

import * as E from "@&#8203;effect/schema/Equivalence"
import * as S from "@&#8203;effect/schema/Schema"

// Union of discriminated tuples
const schema = S.Union(
  S.Tuple(S.Literal("a"), S.String),
  S.Tuple(S.Literal("b"), S.Number)
)

const equivalence = E.make(schema)

console.log(equivalence(["a", "x"], ["a", "x"]))
// false

Patch Changes

#3761 360ec14 Thanks @gcanti! - Allow Schema.Either to support Schema.Never without type errors, closes #3755.
- Updated the type parameters of format to extend Schema.All instead of Schema<A, I, R>.
- Updated the type parameters of Schema.EitherFromSelf to extend Schema.All instead of Schema.Any.
- Updated the type parameters of Schema.Either to extend Schema.All instead of Schema.Any.
- Updated the type parameters of Schema.EitherFromUnion to extend Schema.All instead of Schema.Any.

`v0.75.2`

Compare Source

Patch Changes

#3753 f02b354 Thanks @gcanti! - Enhanced Error Reporting for Discriminated Union Tuple Schemas, closes #3752

Previously, irrelevant error messages were generated for each member of the union. Now, when a discriminator is present in the input, only the relevant member will trigger an error.

Before

import * as Schema from "@&#8203;effect/schema/Schema"

const schema = Schema.Union(
  Schema.Tuple(Schema.Literal("a"), Schema.String),
  Schema.Tuple(Schema.Literal("b"), Schema.Number)
).annotations({ identifier: "MyUnion" })

console.log(Schema.decodeUnknownSync(schema)(["a", 0]))
/*
throws:
ParseError: MyUnion
├─ readonly ["a", string]
│  └─ [1]
│     └─ Expected string, actual 0
└─ readonly ["b", number]
   └─ [0]
      └─ Expected "b", actual "a"
*/

After

import * as Schema from "@&#8203;effect/schema/Schema"

const schema = Schema.Union(
  Schema.Tuple(Schema.Literal("a"), Schema.String),
  Schema.Tuple(Schema.Literal("b"), Schema.Number)
).annotations({ identifier: "MyUnion" })

console.log(Schema.decodeUnknownSync(schema)(["a", 0]))
/*
throws:
ParseError: MyUnion
└─ readonly ["a", string]
   └─ [1]
      └─ Expected string, actual 0
*/

`v0.75.1`

Compare Source

Patch Changes

#3740 3b2ad1d Thanks @tim-smart! - revert deno Inspectable changes
Updated dependencies [3b2ad1d]:
- [email protected]

`v0.75.0`

Compare Source

Minor Changes

#3620 0ba66f2 Thanks @tim-smart! - add deno support to Inspectable

Patch Changes

Updated dependencies [ff3d1aa, 0ba66f2, bf77f51, 016f9ad, 0779681, 534129f, d75140c, be0451c, 9237ac6, be0451c, 5b36494, c716adb, 4986391, d75140c, d1387ae]:
- [email protected]

`v0.74.2`

Compare Source

Patch Changes

Updated dependencies [88e85db, 83887ca, 5266b6c, cdead5c, 766a8af]:
- [email protected]

`v0.74.1`

Compare Source

Patch Changes

#3669 734eae6 Thanks @gcanti! - Add description annotation to the encoded part of NumberFromString.

Before

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.NumberFromString

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string"
}
*/

After

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.NumberFromString

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "description": "a string that will be parsed into a number"
}
*/

#3667 fd83d0e Thanks @gcanti! - Remove default json schema annotations from string, number and boolean.

Before

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.String.annotations({ examples: ["a", "b"] })

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "description": "a string",
  "title": "string",
  "examples": [
    "a",
    "b"
  ]
}
*/

After

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.String.annotations({ examples: ["a", "b"] })

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "examples": [
    "a",
    "b"
  ]
}
*/

#3673 ad7e1de Thanks @gcanti! - Add more description annotations.

#3672 090e41c Thanks @gcanti! - JSON Schema: handle refinements where the 'from' part includes a transformation, closes #3662

Before

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.Date

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
throws
Error: Missing annotation
details: Generating a JSON Schema for this schema requires a "jsonSchema" annotation
schema (Refinement): Date
*/

After

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.Date

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "description": "a string that will be parsed into a Date"
}
*/

#3672 090e41c Thanks @gcanti! - Add description annotation to the encoded part of DateFromString.

Before

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.DateFromString

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string"
}
*/

After

import { JSONSchema, Schema } from "@&#8203;effect/schema"

const schema = Schema.DateFromString

console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string",
  "description": "a string that will be parsed into a Date"
}
*/

Updated dependencies [4509656]:
- [email protected]

`v0.74.0`

Compare Source

Minor Changes

#3654 de48aa5 Thanks @gcanti! - Remove internal sorting of property signatures, closes #3652

`v0.73.4`

Compare Source

Patch Changes

Updated dependencies [bb5ec6b]:
- [email protected]

`v0.73.3`

Compare Source

Patch Changes

#3635 e6440a7 Thanks @gcanti! - Stable filters such as minItems, maxItems, and itemsCount now generate multiple errors when the 'errors' option is set to 'all', closes #3633

Example:

import { ArrayFormatter, Schema } from "@&#8203;effect/schema"

const schema = Schema.Struct({
  tags: Schema.Array(Schema.String.pipe(Schema.minLength(2))).pipe(
    Schema.minItems(3)
  )
})

const invalidData = { tags: ["AB", "B"] }

const either = Schema.decodeUnknownEither(schema, { errors: "all" })(
  invalidData
)
if (either._tag === "Left") {
  console.log(ArrayFormatter.formatErrorSync(either.left))
  /*
  Output:
  [
    {
      _tag: 'Type',
      path: [ 'tags', 1 ],
      message: 'Expected a string at least 2 character(s) long, actual "B"'
    },
    {
      _tag: 'Type',
      path: [ 'tags' ],
      message: 'Expected an array of at least 3 items, actual ["AB","B"]'
    }
  ]
  */
}

Previously, only the issue related to the [ 'tags', 1 ] path was reported.

`v0.73.2`

Compare Source

Patch Changes

Updated dependencies [f0d8ef1]:
- [email protected]

`v0.73.1`

Compare Source

Patch Changes

#3619 f56ab78 Thanks @gcanti! - add Date filters (less than, greater than, between), closes #3606
Updated dependencies [10bf621, ae36fa6]:
- [email protected]

`v0.73.0`

Compare Source

Minor Changes

#3589 7fdf9d9 Thanks @gcanti! - Updates the constraints for members within a union from the more restrictive Schema.Any to the more inclusive Schema.All, closes #3587.

Affected APIs include:
- Schema.Union
- Schema.UndefinedOr
- Schema.NullOr
- Schema.NullishOr
- Schema.optional
- AST.Union.make now retains duplicate members and no longer eliminates the neverKeyword.

Patch Changes

Updated dependencies [fcfa6ee, bb9931b, 5798f76, 5f0bfa1, 812a4e8, 273565e, 569a801, aa1fa53, 02f6b06, 12b893e, bbad27e, adf7d7a, 007289a, 42a8f99, eebfd29, 040703d]:
- [email protected]

`v0.72.4`

Compare Source

Patch Changes

Updated dependencies [35a0f81]:
- [email protected]

`v0.72.3`

Compare Source

Patch Changes

#3560 f6acb71 Thanks @gcanti! - Enhanced the generation of recursive Arbitraries to prevent infinite nesting, closes #3512

`v0.72.2`

Compare Source

Patch Changes

Updated dependencies [8a601d7, 353ba19]:
- [email protected]

`v0.72.1`

Compare Source

Patch Changes

Updated dependencies [79859e7, f6a469c, dcb9ec0, 79aa6b1]:
- [email protected]

`v0.72.0`

Compare Source

Patch Changes

Updated dependencies [db89601, 2f456cc, 8745e41, e557838, d6e7e40, 8356321, 192f2eb, 718cb70, e9d0310, 6bf28f7]:
- [email protected]

`v0.71.4`

Compare Source

Patch Changes

Updated dependencies [e809286]:
- [email protected]

`v0.71.3`

Compare Source

Patch Changes

Updated dependencies [50ec889]:
- [email protected]

`v0.71.2`

Compare Source

Patch Changes

Updated dependencies [f960bf4, 46a575f]:
- [email protected]

`v0.71.1`

Compare Source

Patch Changes

Updated dependencies [14a47a8, 0c09841]:
- [email protected]

`v0.71.0`

Compare Source

Minor Changes

#3433 c1987e2 Thanks @gcanti! - Make json schema output more compatible with Open AI structured output, closes #3432.

JSONSchema
- remove oneOf in favour of anyOf (e.g. in JsonSchema7object, JsonSchema7empty, JsonSchema7Enums)
- remove const in favour of enum (e.g. in JsonSchema7Enums)
- remove JsonSchema7Const type
- remove JsonSchema7OneOf type
AST
- remove identifier annotation from Schema.Null
- remove identifier annotation from Schema.Object

Patch Changes

#3448 1ceed14 Thanks @tim-smart! - add Schema.ArrayEnsure & Schema.NonEmptyArrayEnsure

These schemas can be used to ensure that a value is an array, from a value that may be an array or a single value.

import { Schema } from "@&#8203;effect/schema";

const schema = Schema.ArrayEnsure(Schema.String);

Schema.decodeUnknownSync(schema)("hello");
// => ["hello"]

Schema.decodeUnknownSync(schema)(["a", "b", "c"]);
// => ["a", "b", "c"]

#3450 0e42a8f Thanks @tim-smart! - update dependencies
Updated dependencies [8295281, c940df6, 00b6c6d, f8d95a6]:
- [email protected]

`v0.70.4`

Compare Source

Patch Changes

Updated dependencies [04adcac]:
- [email protected]

`v0.70.3`

Compare Source

Patch Changes

#3430 99ad841 Thanks @gcanti! - Fix return types for attachPropertySignature function.

This commit addresses an inconsistency in the return types between the curried and non-curried versions of the attachPropertySignature function. Previously, the curried version returned a Schema, while the non-curried version returned a SchemaClass.
Updated dependencies [fd4b2f6]:
- [email protected]

`v0.70.2`

Compare Source

Patch Changes

Updated dependencies [510a34d, 45dbb9f]:
- [email protected]

`v0.70.1`

Compare Source

Patch Changes

#3347 3dce357 Thanks @gcanti! - Enhanced Parsing with TemplateLiteralParser, closes #3307

In this update we've introduced a sophisticated API for more refined string parsing: TemplateLiteralParser. This enhancement stems from recognizing limitations in the Schema.TemplateLiteral and Schema.pattern functionalities, which effectively validate string formats without extracting structured data.

Overview of Existing Limitations

The Schema.TemplateLiteral function, while useful as a simple validator, only verifies that an input conforms to a specific string pattern by converting template literal definitions into regular expressions. Similarly, Schema.pattern employs regular expressions directly for the same purpose. Post-validation, both methods require additional manual parsing to convert the validated string into a usable data format.

Introducing TemplateLiteralParser

To address these limitations and eliminate the need for manual post-validation parsing, the new TemplateLiteralParser API has been developed. It not only validates the input format but also automatically parses it into a more structured and type-safe output, specifically into a tuple format.

This new approach enhances developer productivity by reducing boilerplate code and simplifying the process of working with complex string inputs.

Example (string based schemas)
```
import { Schema } from "@&#8203;effect/schema";

// const schema: Schema.Schema<readonly [number, "a", string], `${string}a${string}`, never>
const schema = Schema.TemplateLiteralParser(
  Schema.NumberFromString,
  "a",
  Schema.NonEmptyString,
);

console.log(Schema.decodeEither(schema)("100ab"));
// { _id: 'Either', _tag: 'Right', right: [ 100, 'a', 'b' ] }

console.log(Schema.encode(schema)([100, "a", "b"]));
// { _id: 'Either', _tag: 'Right', right: '100ab' }
```
Example (number based schemas)
```
import { Schema } from "@&#8203;effect/schema";

// const schema: Schema.Schema<readonly [number, "a"], `${number}a`, never>
const schema = Schema.TemplateLiteralParser(Schema.Int, "a");

console.log(Schema.decodeEither(schema)("1a"));
// { _id: 'Either', _tag: 'Right', right: [ 1, 'a' ] }

console.log(Schema.encode(schema)([1, "a"]));
// { _id: 'Either', _tag: 'Right', right: '1a' }
```

#3346 657fc48 Thanks @gcanti! - Implement DecodingFallbackAnnotation to manage decoding errors.

export type DecodingFallbackAnnotation<A> = (
  issue: ParseIssue,
) => Effect<A, ParseIssue>;

This update introduces a decodingFallback annotation, enabling custom handling of decoding failures in schemas. This feature allows developers to specify fallback behaviors when decoding operations encounter issues.

Example

import { Schema } from "@&#8203;effect/schema";
import { Effect, Either } from "effect";

// Basic Fallback

const schema = Schema.String.annotations({
  decodingFallback: () => Either.right("<fallback>"),
});

console.log(Schema.decodeUnknownSync(schema)("valid input")); // Output: valid input
console.log(Schema.decodeUnknownSync(schema)(null)); // Output: <fallback value>

// Advanced Fallback with Logging

const schemaWithLog = Schema.String.annotations({
  decodingFallback: (issue) =>
    Effect.gen(function* () {
      yield* Effect.log(issue._tag);
      yield* Effect.sleep(10);
      return yield* Effect.succeed("<fallback2>");
    }),
});

Effect.runPromise(Schema.decodeUnknown(schemaWithLog)(null)).then(
  console.log,
);
/*
Output:
timestamp=2024-07-25T13:22:37.706Z level=INFO fiber=#&#8203;0 message=Type
<fallback2>
*/

`v0.70.0`

Compare Source

Patch Changes

#3380 8135294 Thanks @tim-smart! - add schemas for working with the DateTime module
Updated dependencies [1e0fe80, 8135294, cd255a4, 3845646, 2d09078, 4bce5a0, 4ddbff0, e74cc38, bb069b4, cd255a4, 7d02174]:
- [email protected]

`v0.69.3`

Compare Source

Patch Changes

#3359 7c0da50 Thanks @gcanti! - Add Context field to Schema interface, closes #3356
#3363 2fc0ff4 Thanks @gcanti! - export isPropertySignature guard
#3357 f262665 Thanks @gcanti! - Improve annotation retrieval from Class APIs, closes #3348.

Previously, accessing annotations such as identifier and title required explicit casting of the ast field to AST.Transformation.
This update refines the type definitions to reflect that ast is always an AST.Transformation, eliminating the need for casting and simplifying client code.
```
import { AST, Schema } from "@&#8203;effect/schema";

class Person extends Schema.Class<Person>("Person")(
  {
    name: Schema.String,
    age: Schema.Number,
  },
  { description: "my description" },
) {}

console.log(AST.getDescriptionAnnotation(Person.ast.to));
// { _id: 'Option', _tag: 'Some', value: 'my description' }
```

#3343 9bbe7a6 Thanks @gcanti! - - add NonEmptyTrimmedString

Example

import { Schema } from "@&#8203;effect/schema";

console.log(Schema.decodeOption(Schema.NonEmptyTrimmedString)("")); // Option.none()
console.log(Schema.decodeOption(Schema.NonEmptyTrimmedString)(" a ")); // Option.none()
console.log(Schema.decodeOption(Schema.NonEmptyTrimmedString)("a")); // Option.some("a")

add OptionFromNonEmptyTrimmedString, closes #3335

Example

import { Schema } from "@&#8203;effect/schema";

console.log(Schema.decodeSync(Schema.OptionFromNonEmptyTrimmedString)("")); // Option.none()
console.log(
  Schema.decodeSync(Schema.OptionFromNonEmptyTrimmedString)(" a "),
); // Option.some("a")
console.log(Schema.decodeSync(Schema.OptionFromNonEmptyTrimmedString)("a")); // Option.some("a")

Updated dependencies [6359644, 7f41e42, f566fd1]:
- [email protected]

`v0.69.2`

Compare Source

Patch Changes

Updated dependencies [1ba640c, c8c71bd, a26ce58]:
- [email protected]

`v0.69.1`

Compare Source

Patch Changes

#3333 f241154 Thanks @gcanti! - Expose success and failure schemas on TaggedRequestClass interface, closes #3331

`v0.69.0`

Compare Source

Minor Changes

#3227 20807a4 Thanks @gcanti! - ## Codemod

For some of the breking changes, a code-mod has been released to make migration as easy as possible.

You can run it by executing:
```
npx @&#8203;effect/codemod schema-0.69 src/**/*
```
It might not be perfect - if you encounter issues, let us know! Also make sure you commit any changes before running it, in case you need to revert anything.

Breaking Changes

Schema

-   We've improved the `TaggedRequest` API to make it more intuitive by grouping parameters into a single object (**codmod**), closes #&#8203;3144

    Before Update

    ```ts
    class Sample extends Schema.TaggedRequest<Sample>()(
      "Sample",
      Schema.String, // Failure Schema
      Schema.Number, // Success Schema
      { id: Schema.String, foo: Schema.Number }, // Payload Schema
    ) {}
    ```

    After Update

    ```ts
    class Sample extends Schema.TaggedRequest<Sample>()("Sample", {
      payload: {
        id: Schema.String,
        foo: Schema.Number,
      },
      success: Schema.Number,
      failure: Schema.String,
    }) {}
    ```

-   change `TaggedRequestClass` type parameters order (swap `Success` with `Failure`)

-   simplify `TaggedRequest.Any`, use `TaggedRequest.All` instead

-   To improve clarity, we have renamed `nonEmpty` filter to `nonEmptyString` and `NonEmpty` schema to `NonEmptyString` (**codmod**), closes #&#8203;3115

-   The `Record` constructor now consistently accepts an object argument, aligning it with similar constructors such as `Map` and `HashMap` (**codmod**), closes #&#8203;2793

    Before Update

    ```ts
    import { Schema } from "@&#8203;effect/schema";

    const schema = Schema.Record(Schema.String, Schema.Number);
    ```

    After Update

    ```ts
    import { Schema } from "@&#8203;effect/schema";

    const schema = Schema.Record({ key: Schema.String, value: Schema.Number });
    ```

-   rename `Base64` to `Uint8ArrayFromBase64` (**codmod**)

-   rename `Base64Url` to `Uint8ArrayFromBase64Url` (**codmod**)

-   rename `Hex` to `Uint8ArrayFromHex` (**codmod**)

-   make `defect` schema required in `ExitFromSelf`, `Exit`, `CauseFromSelf`, `CauseFromSelf` (**codmod**)
    This is for two reasons:

    1.  The optionality of `defect` caused inference issues when the schema was declared within a Struct. In such cases, the `R` type of the schema was erroneously inferred as `unknown` instead of `never`.
    2.  In general, schema definitions such as `Schema.ExitFromSelf` or `Schema.Exit` shouldn't have a default. The user should actively choose them to avoid hidden behaviors.

-   rename `CauseDefectUnknown` to `Defect` (**codmod**)

-   fix `Schema.Void` behavior: now accepts any value instead of only validating `undefined`, closes #&#8203;3297

-   rename `optionalWithOptions` interface to `optionalWith`

-   We've refined the `optional` and `partial` APIs by splitting them into two distinct methods: one without options (`optional` and `partial`) and another with options (`optionalWith` and `partialWith`). This change resolves issues with previous implementations when used with the `pipe` method:

    ```ts
    Schema.String.pipe(Schema.optional);
    ```

ParseResult

-   `Missing`: change `ast` field from `AST.Annotated` to `AST.Type`
-   `Composite`: change `ast` field from `AST.Annotated` to `AST.AST`
-   `Type`: change `ast` field from `AST.Annotated` to `AST.AST`
-   `Forbidden`: change `ast` field from `AST.Annotated` to `AST.AST`

AST

-   pass the input of the transformation to `transform` and `transformOrFail` APIs
-   fix `TemplateLiteralSpan.toString` implementation by returning both its type and its literal

    Before

    ```ts
    import { AST } from "@&#8203;effect/schema";

    console.log(String(new AST.TemplateLiteralSpan(AST.stringKeyword, "a"))); // ${string}
    ```

    Now

    ```ts
    import { AST } from "@&#8203;effect/schema";

    console.log(String(new AST.TemplateLiteralSpan(AST.stringKeyword, "a"))); // ${string}a
    ```

Serializable

-   change `WithResult` fields to standard lowercase (`Success` -> `success`, `Failure` -> `failure`)
-   rename `WithResult.Error` to `WithResult.Failure`

New Features

Schema

-   add `StringFromBase64` transformation
-   add `StringFromBase64Url` transformation
-   add `StringFromHex` transformation
-   add `TaggedRequest.All`
-   Support for extending `Schema.String`, `Schema.Number`, and `Schema.Boolean` with refinements has been added:

    ```ts
    import { Schema } from "@&#8203;effect/schema";

    const Integer = Schema.Int.pipe(Schema.brand("Int"));
    const Positive = Schema.Positive.pipe(Schema.brand("Positive"));

    // Schema.Schema<number & Brand<"Positive"> & Brand<"Int">, number, never>
    const PositiveInteger = Schema.asSchema(Schema.extend(Positive, Integer));

    Schema.decodeUnknownSync(PositiveInteger)(-1);
    /*
    throws
    ParseError: Int & Brand<"Int">
    └─ From side refinement failure
      └─ Positive & Brand<"Positive">
          └─ Predicate refinement failure
            └─ Expected Positive & Brand<"Positive">, actual -1
    */

    Schema.decodeUnknownSync(PositiveInteger)(1.1);
    /*
    throws
    ParseError: Int & Brand<"Int">
    └─ Predicate refinement failure
      └─ Expected Int & Brand<"Int">, actual 1.1
    */
    ```

Serializable

-   add `WithResult.SuccessEncoded`
-   add `WithResult.FailureEncoded`
-   add `WithResult.Any`
-   add `WithResult.All`
-   add `asWithResult`
-   add `Serializable.Any`
-   add `Serializable.All`
-   add `asSerializable`
-   add `SerializableWithResult.Any`
-   add `SerializableWithResult.All`
-   add `asSerializableWithResult`

`v0.68.27`

Compare Source

Patch Changes

#3310 99bddcf Thanks @fubhy! - Added additional pure annotations to improve tree-shakeability
#3311 6921c4f Thanks @gcanti! - Remove incorrect static override type annotations in class definitions.

This will also improve tree-shakeability.
Updated dependencies [3afcc93, 99bddcf]:
- [email protected]

`v0.68.26`

Compare Source

Patch Changes

#3287 f0285d3 Thanks @gcanti! - JSON Schema: change default behavior for property signatures containing undefined

Changed the default behavior when encountering a required property signature whose type contains undefined. Instead of raising an exception, undefined is now pruned and the field is set as optional.

Before

import { JSONSchema, Schema } from "@&#8203;effect/schema";

const schema = Schema.Struct({
  a: Schema.NullishOr(Schema.Number),
});

const jsonSchema = JSONSchema.make(schema);
console.log(JSON.stringify(jsonSchema, null, 2));
/*
throws
Error: Missing annotation
at path: ["a"]
details: Generating a JSON Schema for this schema requires a "jsonSchema" annotation
schema (UndefinedKeyword): undefined
*/

Now

import { JSONSchema, Schema } from "@&#8203;effect/schema";

const schema = Schema.Struct({
  a: Schema.NullishOr(Schema.Number),
});

const jsonSchema = JSONSchema.make(schema);
console.log(JSON.stringify(jsonSchema, null, 2));
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "required": [], // <=== empty
  "properties": {
    "a": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "$ref": "#/$defs/null"
        }
      ]
    }
  },
  "additionalProperties": false,
  "$defs": {
    "null": {
      "const": null
    }
  }
}
*/

#3291 8ec4955 Thanks @gcanti! - remove type-level error message from optional signature, closes #3290

This fix eliminates the type-level error message from the optional function signature, which was causing issues in generic contexts.

#3284 3ac2d76 Thanks @gcanti! - Fix: Correct Handling of JSON Schema Annotations in Refinements

Fixes an issue where the JSON schema annotation set by a refinement after a transformation was mistakenly interpreted as an override annotation. This caused the output to be incorrect, as the annotations were not applied as intended.

Before

import { JSONSchema, Schema } from "@&#8203;effect/schema";

const schema = Schema.Trim.pipe(Schema.nonEmpty());

const jsonSchema = JSONSchema.make(schema);
console.log(JSON.stringify(jsonSchema, null, 2));
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "minLength": 1
}
*/

Now

import { JSONSchema, Schema } from "@&#8203;effect/schema";

const schema = Schema.Trim.pipe(Schema.nonEmpty());

const jsonSchema = JSONSchema.make(schema);
console.log(JSON.stringify(jsonSchema, null, 2));
/*
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "string"
}
*/

Updated dependencies [cc327a1, 4bfe4fb, 2b14d18]:
- [email protected]

`v0.68.25`

Compare Source

Patch Changes

Updated dependencies [a9d7800]:
- [email protected]

`v0.68.24`

Compare Source

Patch Changes

#3253 ed0dde4 Thanks @tim-smart! - update dependencies
Updated dependencies [ed0dde4, ca775ce, 5be9cc0, 203658f, eb1c4d4]:
- [email protected]

`v0.68.23`

Compare Source

Patch Changes

#3234 edb0da3 Thanks @tim-smart! - ensure Schema.TaggedError renders a .cause correctly
Updated dependencies [edb0da3, c8d3fb0, dabd028, 786b2ab, fc57354]:
- [email protected]

`v0.68.22`

Compare Source

Patch Changes

Updated dependencies [639208e, 6684b4c, 6684b4c, 6684b4c]:
- [email protected]

`v0.68.21`

Compare Source

Patch Changes

Updated dependencies [55fdd76]:
- [email protected]

`v0.68.20`

Compare Source

Patch Changes

Updated dependencies [a1f5b83, a1f5b83, a1f5b83, 60bc3d0, 5ab348f, 60bc3d0, 3e04bf8, e7fc45f, a1f5b83, 4626de5, [f01e7db](https://redirect.github.com/Effect-TS/effect/commit/f01e7db317827255d

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

renovate bot added renovate upgrade Any kind of dependency updates labels Feb 5, 2024

renovate-approve bot previously approved these changes Feb 5, 2024

View reviewed changes

renovate bot force-pushed the renovate/effect-schema-0.x branch 2 times, most recently from 7f3e2a6 to fcafb0a Compare February 6, 2024 03:04

renovate bot dismissed renovate-approve[bot]’s stale review via 63daa91 February 6, 2024 07:25

renovate bot force-pushed the renovate/effect-schema-0.x branch from fcafb0a to 63daa91 Compare February 6, 2024 07:25

renovate-approve bot previously approved these changes Feb 6, 2024

View reviewed changes

renovate bot force-pushed the renovate/effect-schema-0.x branch 9 times, most recently from 00e63db to 177abaa Compare February 6, 2024 19:16

renovate bot dismissed renovate-approve[bot]’s stale review via 8e805c3 February 7, 2024 22:43

renovate bot force-pushed the renovate/effect-schema-0.x branch from 177abaa to 8e805c3 Compare February 7, 2024 22:43

renovate bot changed the title ~~⬆️ Update dependency @effect/schema to v0.61.5~~ ⬆️ Update dependency @effect/schema to v0.61.6 Feb 7, 2024

renovate-approve bot previously approved these changes Feb 7, 2024

View reviewed changes

renovate bot dismissed renovate-approve[bot]’s stale review via 888ee5f February 8, 2024 00:05

renovate bot force-pushed the renovate/effect-schema-0.x branch from 8e805c3 to 888ee5f Compare February 8, 2024 00:05

renovate bot changed the title ~~⬆️ Update dependency @effect/schema to v0.61.6~~ ⬆️ Update dependency @effect/schema to v0.61.7 Feb 8, 2024

renovate-approve bot previously approved these changes Feb 8, 2024

View reviewed changes

renovate bot dismissed renovate-approve[bot]’s stale review via 65b948f February 8, 2024 04:27

renovate bot force-pushed the renovate/effect-schema-0.x branch from 888ee5f to 65b948f Compare February 8, 2024 04:27

renovate-approve bot previously approved these changes Feb 8, 2024

View reviewed changes

renovate bot force-pushed the renovate/effect-schema-0.x branch from 65b948f to 26d04a9 Compare February 9, 2024 01:06

renovate bot dismissed renovate-approve[bot]’s stale review via b0202e0 February 9, 2024 10:46

renovate bot force-pushed the renovate/effect-schema-0.x branch 2 times, most recently from 47a2cdb to 8a5a579 Compare November 11, 2024 03:09

renovate bot force-pushed the renovate/effect-schema-0.x branch 5 times, most recently from 36fc011 to 06bbe1c Compare November 22, 2024 03:04

renovate bot force-pushed the renovate/effect-schema-0.x branch 11 times, most recently from 61637b8 to 8aecee7 Compare November 28, 2024 09:48

renovate bot force-pushed the renovate/effect-schema-0.x branch 4 times, most recently from 77de2fa to bdd0aeb Compare December 4, 2024 04:49

renovate bot force-pushed the renovate/effect-schema-0.x branch 5 times, most recently from 2e570c0 to 2605659 Compare December 16, 2024 03:54

renovate bot force-pushed the renovate/effect-schema-0.x branch from 2605659 to 04e735c Compare December 16, 2024 06:26

⬆️ Update dependency @effect/schema to v0.75.5

2d36289

renovate bot force-pushed the renovate/effect-schema-0.x branch from 04e735c to 2d36289 Compare December 17, 2024 20:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⬆️ Update dependency @effect/schema to v0.75.5 #56

⬆️ Update dependency @effect/schema to v0.75.5 #56

renovate bot commented Feb 5, 2024 •

edited

Loading

⬆️ Update dependency @effect/schema to v0.75.5 #56

Are you sure you want to change the base?

⬆️ Update dependency @effect/schema to v0.75.5 #56

Conversation

renovate bot commented Feb 5, 2024 • edited Loading

Release Notes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Breaking Changes

Schema

ParseResult

AST

Serializable

New Features

Schema

Serializable

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Configuration

renovate bot commented Feb 5, 2024 •

edited

Loading