CHANGELOG.md

@atproto/lex-schema

0.2.5

Patch Changes

• #5318 8b55a4a Thanks @matthieusieben! - Allow isX string format checkers to be called with any (unknown) value instead of just strings

• Updated dependencies [8b55a4a]:

  • @atproto/syntax@0.7.4

0.2.4

Patch Changes

• #5295 6a3d607 Thanks @matthieusieben! - Update vitest dependencies

• Updated dependencies [6a3d607]:

  • @atproto/lex-data@0.1.7
  • @atproto/syntax@0.7.3

0.2.3

Patch Changes

• #5287 95aa1d6 Thanks @matthieusieben! - Add README.md file

• Updated dependencies [95aa1d6]:

  • @atproto/lex-data@0.1.6

0.2.2

Patch Changes

• #5192 1570e44 Thanks @arjxnt! - Add description to permission-set options for developer-facing documentation.

• Updated dependencies [9e1da84]:

  • @atproto/syntax@0.7.2

0.2.1

Patch Changes

• #5197 a0c49d9 Thanks @matthieusieben! - Rewrite import statements to be compatible with TypeScript's verbatimModuleSyntax config.

• Updated dependencies [a0c49d9, cc6b901, cc6b901, cc6b901]:

  • @atproto/lex-data@0.1.5
  • @atproto/syntax@0.7.1

0.2.0

Minor Changes

• #5162 d1be0ce Thanks @nnabeyang! - Language-tag string-format validation now has strict and lenient variants, matching the pattern already used for at-uri and datetime. isLanguageString (and the default language string-format verifier) is now strict and rejects BCP 47 tags that violate RFC 5646 §4.1 (e.g. duplicate variant subtags or duplicate extension singletons). Pass { strict: false } to fall back to the lenient (syntax-only) verifier, isLanguageStringLenient.

Patch Changes

• Updated dependencies [d1be0ce, d79f6d5]:
  • @atproto/syntax@0.7.0

0.1.6

Patch Changes

• #5099 b43ec31 Thanks @matthieusieben! - Update TypeScript build to rely on references to composite internal projects

• #5099 b43ec31 Thanks @matthieusieben! - Build using verbatimModuleSyntax, reducing runtime import graph

• #5099 b43ec31 Thanks @matthieusieben! - Bundle only necessary files in the NPM tarball, including the CHANGELOG.md and README.md files (if present).

• Updated dependencies [28a0b58, b43ec31, b43ec31, b43ec31]:

  • @atproto/syntax@0.6.4
  • @atproto/lex-data@0.1.4

0.1.5

Patch Changes

• #5151 a51c45d Thanks @matthieusieben! - Update dependencies

• Updated dependencies [a51c45d]:

  • @atproto/lex-data@0.1.3
  • @atproto/syntax@0.6.3

0.1.4

Patch Changes

• #4967 9fc720c Thanks @matthieusieben! - Use TypeScript 7 to build package

• Updated dependencies [9fc720c]:

  • @atproto/lex-data@0.1.2
  • @atproto/syntax@0.6.2

0.1.3

Patch Changes

• #5037 7b8ca6e Thanks @matthieusieben! - Add atUri() helper for safely building AtUriString values from raw components or record schemas. Also fixes validation of 'any' record-key strings.

0.1.2

Patch Changes

• #5006 60721e6 Thanks @matthieusieben! - Add $token accessor for token lexicon values schemas

0.1.1

Patch Changes

• #4955 20c5cc1 Thanks @matthieusieben! - Fixes a bug that would reject valid datetime atproto strings in non-strict validation

• #4955 20c5cc1 Thanks @matthieusieben! - Use datetime validation utility from @atproto/syntax

• Updated dependencies [20c5cc1]:

  • @atproto/syntax@0.6.1

0.1.0

Minor Changes

• #4929 f01c59f Thanks @devinivy! - BREAKING: Drop support for Node.js 18 and 20. Node.js 22 is now the minimum supported version. Docker images now use Node.js 24.

• #4943 c459153 Thanks @devinivy! - BREAKING: Convert to pure ESM. All packages now ship "type": "module" with ES module output and Node16 module resolution.

  Node.js 22's require() compatibility layer can still load these packages in CommonJS code.

• #4930 908bece Thanks @devinivy! - Build with TypeScript 6.0.

Patch Changes

• Updated dependencies [f01c59f, c459153, 908bece]:
  • @atproto/lex-data@0.1.0
  • @atproto/syntax@0.6.0

0.0.20

Patch Changes

• #4925 2fd8d62 Thanks @rafaeleyng! - Increase string preview validation error

0.0.19

Patch Changes

• #4806 26d793a Thanks @matthieusieben! - Export AtUriString utilities from @atproto/syntax

• Updated dependencies [26d793a, 26d793a, 26d793a, 55d06de, 26d793a]:

  • @atproto/syntax@0.5.4

0.0.18

Patch Changes

• #4828 c62651d Thanks @matthieusieben! - Accept legacy blob references in non-strict mode. Legacy blob references (objects with cid and mimeType properties) are now accepted when strict: false, which is the default behavior when strictResponseProcessing is disabled on the Client.

  BREAKING: The allowLegacy option has been removed from the blob schema builder, and legacy blobs are now handled automatically based on the strictness mode: in strict mode they are rejected, and in non-strict mode they are accepted. Consumers should stop passing allowLegacy and rely on strictness configuration instead. Likewise, CLI consumers should stop using the removed --allowLegacyBlobs flag and use the default strict/non-strict behavior.

• Updated dependencies [c62651d, f6f100c, c62651d, c62651d]:

  • @atproto/lex-data@0.0.15

0.0.17

Patch Changes

• #4779 527f5d4 Thanks @matthieusieben! - Update lexErrorDataSchema to match spec (rejecting error constants with whitespace)

• #4787 c4df84c Thanks @matthieusieben! - Optimize counting of graphemes when validating strings

• #4779 527f5d4 Thanks @matthieusieben! - Fix build() method of record and typed object to not perform validation.

• #4784 e5e5bcf Thanks @matthieusieben! - Show invalid values in issue description (when stringifiable in reasonably small string)

• #4796 ac6bd18 Thanks @matthieusieben! - Allow specifying ValidateOptions to matches() and ifMathces() method, allowing disabling "strict" mode

• #4799 c5c6c7d Thanks @matthieusieben! - Allow any encoding to match payload that don't expect any particular encoding

• Updated dependencies [0dbea15, d0c136c, 527f5d4]:

  • @atproto/syntax@0.5.2

0.0.16

Patch Changes

• #4761 6a88461 Thanks @matthieusieben! - Allow using a dynamic non-strict validation mode

• Updated dependencies [6a88461]:

  • @atproto/lex-data@0.0.14

0.0.15

Patch Changes

• #4734 3dc3791 Thanks @matthieusieben! - Rename IssueInvalidFormat's message property to detail

• #4734 3dc3791 Thanks @matthieusieben! - Add a read-only message property to the Issue class

• #4734 3dc3791 Thanks @matthieusieben! - LexValidationError class now implements ResultFailure allowing it to be used as validation return value directly (without the need to be wrapped)

• #4734 3dc3791 Thanks @matthieusieben! - Update stringification of issues (toString()) to consistently display the error path at the end.

• 112b159 Thanks @matthieusieben! - Export more string format type assertion utilities

• #4734 3dc3791 Thanks @matthieusieben! - PropertyKey is no longer exported. Use the global value instead.

• #4734 3dc3791 Thanks @matthieusieben! - Add Standard Schema compatibility

• Updated dependencies [67eb0c1]:

  • @atproto/syntax@0.5.1

0.0.14

Patch Changes

• #4688 52834ab Thanks @matthieusieben! - Allow WWWAuthenticate to have multiple challenges for the same scheme

• #4689 f7c2610 Thanks @matthieusieben! - Export more DatetimeString utilities from @atproto/syntax

• #4688 52834ab Thanks @matthieusieben! - Make $ utility function bound to the instance, allowing to use them without the schema as this context

• #4688 52834ab Thanks @matthieusieben! - Ignore empty strings from params parsing

• #4688 52834ab Thanks @matthieusieben! - Renaming ValidationError to LexValidationError for consistency with LexError & sub-classes

• Updated dependencies [f7c2610, f7c2610, f7c2610, f7c2610, 52834ab, f7c2610, 52834ab, f7c2610, 52834ab]:

  • @atproto/syntax@0.5.0
  • @atproto/lex-data@0.0.13

0.0.13

Patch Changes

• #4654 39dea03 Thanks @matthieusieben! - Params cannot be arrays of mixed string, number and booleans (items can only be of one type)

• #4660 ea5df64 Thanks @matthieusieben! - Improve typeing of string() schemas

• #4660 ea5df64 Thanks @matthieusieben! - Fix import statement

• #4654 39dea03 Thanks @matthieusieben! - Schemas now define a type property that allows to better discriminate them

• #4654 39dea03 Thanks @matthieusieben! - Add support for knownValues in string schemas

• #4660 ea5df64 Thanks @matthieusieben! - Expose MaybeTypedObject type utility (retrun type of TypedObjectSchema.isTypeOf method)

• #4654 39dea03 Thanks @matthieusieben! - Properly support "enum" and "const" schemas in params

• #4660 ea5df64 Thanks @matthieusieben! - Allow using InferMethod* type helpers without any argument

• #4660 ea5df64 Thanks @matthieusieben! - Minor optimization when checking payload encoding

• #4660 ea5df64 Thanks @matthieusieben! - Improve error messages when encountering an unexpected legacy blob

• #4660 ea5df64 Thanks @matthieusieben! - Add new issueUnexpectedType method on ValidationContext to better allow creation issues with multiple allowed types

• #4660 ea5df64 Thanks @matthieusieben! - Update validation message for $typed object to match working of @atproto/lexicon

• #4660 ea5df64 Thanks @matthieusieben! - Replace UnknownObject with LexMap to improve consistency with underlying data structure being validated

• #4660 ea5df64 Thanks @matthieusieben! - Expose TypedRecord type utility (result of RecordSchema.isTypeOf methid

• Updated dependencies [ea5df64]:

  • @atproto/lex-data@0.0.12

0.0.12

Patch Changes

• #4603 7b9a98a Thanks @matthieusieben! - Constrain XRPC Payload to be LexValue instead of unknown (better reflecting reality)

• #4603 7b9a98a Thanks @matthieusieben! - Properly infer type of generic Payload body

• #4601 ed61c62 Thanks @matthieusieben! - Fix exports field in package.json

• #4603 7b9a98a Thanks @matthieusieben! - Properly coerce params into arrays when defined as such

• #4603 7b9a98a Thanks @matthieusieben! - Constrain subscription message schema to validate LexValue only

• #4601 ed61c62 Thanks @matthieusieben! - Add JSDoc

• Updated dependencies [ed61c62, ed61c62]:

  • @atproto/lex-data@0.0.11

0.0.11

Patch Changes

• Updated dependencies [369bb02]:
  • @atproto/lex-data@0.0.10

0.0.10

Patch Changes

• #4571 99963d0 Thanks @matthieusieben! - Remove asX and assertX string format assertion utilities

• #4562 7310b97 Thanks @matthieusieben! - Memoize array schemas (without options)

• #4562 7310b97 Thanks @matthieusieben! - Remove default option from string, integer, boolean, enum and literal types. These are replace with a new withDefault() type wrapper.

• #4562 7310b97 Thanks @matthieusieben! - TypedObject and Record's build() method now performs parsing of the input data (ensuring that defaults are applied).

• #4562 7310b97 Thanks @matthieusieben! - Rename TypedObject to Unknown$TypedObject

• #4562 7310b97 Thanks @matthieusieben! - Distinguish "parse" and "validation" modes when checking against a schema. Validation (validate() and safeValidate()) only ensures that a value matches the input schema, while parsing (parse() and safeParse()) will also apply defaults and coerce input values into the expected output type.

• #4562 7310b97 Thanks @matthieusieben! - Rename cidLink() to cid()

• #4562 7310b97 Thanks @matthieusieben! - Memoize empty params schemas

• #4571 99963d0 Thanks @matthieusieben! - Improve performance of string format checking

• #4562 7310b97 Thanks @matthieusieben! - Fix inability to assign (object containing) open union results to LexMap type

• #4562 7310b97 Thanks @matthieusieben! - Add new Unknown$Type type to represent records an object's unknown $type property (typically from open unions).

• #4562 7310b97 Thanks @matthieusieben! - Rename UnknownObjectOutput to UnknownObject

• #4562 7310b97 Thanks @matthieusieben! - Fail early when validating nested structures

• Updated dependencies [99963d0, 99963d0, 99963d0, 7310b97, 99963d0, 99963d0, 99963d0]:

  • @atproto/syntax@0.4.3
  • @atproto/lex-data@0.0.9

0.0.9

Patch Changes

• Updated dependencies [dfd4bee, dfd4bee, dfd4bee, dfd4bee]:
  • @atproto/lex-data@0.0.8

0.0.8

Patch Changes

• #4512 d78484f Thanks @matthieusieben! - Add stricter validation rules for CidSchema

• #4512 d78484f Thanks @matthieusieben! - Expose tokenSchema value as public property

• Updated dependencies [d78484f, d78484f, d78484f]:

  • @atproto/lex-data@0.0.7

0.0.7

Patch Changes

• #4501 2f78893 Thanks @matthieusieben! - Export new $TypedMaybe type util

• Updated dependencies [2f78893, 2f78893, 2f78893]:

  • @atproto/lex-data@0.0.6

0.0.6

Patch Changes

• #4443 9af7a2d Thanks @matthieusieben! - Remove LexMap exported type

• #4443 9af7a2d Thanks @matthieusieben! - Add jsonPayload schema builder utilities

• #4443 9af7a2d Thanks @matthieusieben! - Expose lexErrorData validation schema

• #4443 9af7a2d Thanks @matthieusieben! - Expose Main<T> and getMain() helpers to work with namespaced schemas

• #4443 9af7a2d Thanks @matthieusieben! - Simplify definition of TypedObject

• #4443 9af7a2d Thanks @matthieusieben! - ValidationError now extend LexError (from @atproto/data)

• #4443 9af7a2d Thanks @matthieusieben! - Memoize most popular schemas

• Updated dependencies [9af7a2d, 9af7a2d]:

  • @atproto/lex-data@0.0.5

0.0.5

Patch Changes

• #4457 e6b6107 Thanks @matthieusieben! - Add cast() method to Schema classes. This acts as a type cast that does not alter the value or throws if the value does not match the schema.

• #4457 e6b6107 Thanks @matthieusieben! - Forbid use of unsafe integers

• #4457 e6b6107 Thanks @matthieusieben! - Replace InferParamsSchema with InferMethodParams

• #4457 e6b6107 Thanks @matthieusieben! - Add matchesEncoding method on the PayloadSchema class.

• #4457 e6b6107 Thanks @matthieusieben! - Replace InferProcedureParameters with InferMethodParams

• #4457 e6b6107 Thanks @matthieusieben! - Export format checking utilities for string (isDidString, isCidString, etc.)

• #4457 e6b6107 Thanks @matthieusieben! - Expose $Typed and Un$Typed utilities

• #4457 e6b6107 Thanks @matthieusieben! - Rename ResultFailure's error field to reason

• #4457 e6b6107 Thanks @matthieusieben! - Type the encoding field of Payload more accurately. Methods with an encoding of */* are now correctly represented as ${string}/${string} instead of the */* literal type.

• #4457 e6b6107 Thanks @matthieusieben! - Add matchesMime utility method on BlobSchema class

• #4457 e6b6107 Thanks @matthieusieben! - Enforce size and accept options when validating blobs

• #4457 e6b6107 Thanks @matthieusieben! - Replace InferProcedureInputBody with InferMethodInputBody

• #4457 e6b6107 Thanks @matthieusieben! - Add check() method to all Schema classes. That method is an alias for the assert() method that allows to avoid ts(2775) errors.

• #4457 e6b6107 Thanks @matthieusieben! - Rename format assertion and checking utilities to all contain the String prefix (like in asAtUriString, assertAtUriString, etc.)

• #4457 e6b6107 Thanks @matthieusieben! - Replace InferProcedureOutputBody with InferMethodOutputBody

• Updated dependencies [e6b6107, e6b6107, e6b6107, e6b6107, e6b6107]:

  • @atproto/lex-data@0.0.4

0.0.4

Patch Changes

• Updated dependencies [693784c]:
  • @atproto/lex-data@0.0.3

0.0.3

Patch Changes

• #4390 1d445af Thanks @matthieusieben! - Add default option to literal and enum schemas

• #4390 1d445af Thanks @matthieusieben! - Rework object validation logic to work without options argument

• #4390 1d445af Thanks @matthieusieben! - literal schemas no longer use the value as "default". The "default" must now be explicitly provided.

• #4390 1d445af Thanks @matthieusieben! - Use l.nullable for nullable object properties and l.optional for optional object properties in lex schemas.

• #4390 1d445af Thanks @matthieusieben! - Add l.refine utility to add custom refinements to existing schemas.

• #4401 a487ab8 Thanks @matthieusieben! - Add test suite for all schema types

• #4401 a487ab8 Thanks @matthieusieben! - Allow array schema's generic to be both a Validator type or an item value type

• #4390 1d445af Thanks @matthieusieben! - Validation issues are now child classed to the Issue abstract class instead of simple objects with interfaces. This allows for better extensibility and custom behavior on issues (such as custom error messages).

• #4390 1d445af Thanks @matthieusieben! - Replace use of CID with Cid

• #4401 a487ab8 Thanks @matthieusieben! - Drop lexiconType property

• #4401 a487ab8 Thanks @matthieusieben! - Fix type of typedObject and record schemas

• #4390 1d445af Thanks @matthieusieben! - Remove options (required, nullable) from object schemas. Those are replaced by l.optional and l.nullable wrappers.

• #4390 1d445af Thanks @matthieusieben! - Discriminated unions now only accept discriminators to be declared a literal or enum schemas and will throw at initialization if discriminators values aren't strictly disjoined.

• #4389 bcae2b7 Thanks @matthieusieben! - Use string formats from @atproto/syntax

• #4389 bcae2b7 Thanks @matthieusieben! - Add l.regexp schema builder

• #4390 1d445af Thanks @matthieusieben! - Require l.discriminatedUnion discriminator field to be a literal or enum schema

• #4401 a487ab8 Thanks @matthieusieben! - Simplify ParamsSchema interface

• #4390 1d445af Thanks @matthieusieben! - Remove options (required) from params schemas. Those are replaced by l.optional wrappers.

• #4387 9f87ff3 Thanks @matthieusieben! - Simplify dict type definition

• #4390 1d445af Thanks @matthieusieben! - Rename schema methods validate, check and maybe to safeParse, matches and ifMatches respectively.

• #4397 688f9d6 Thanks @matthieusieben! - Add CHANGELOG.md to npm package

• #4390 1d445af Thanks @matthieusieben! - Add default option to const and enum schemas

• Updated dependencies [1d445af, 1d445af, bcae2b7, 688f9d6]:

  • @atproto/lex-data@0.0.2
  • @atproto/syntax@0.4.2

0.0.2

Patch Changes

• #4380 23c271f Thanks @matthieusieben! - Use literal value as default

0.0.1

Patch Changes

• #4371 46550d6 Thanks @matthieusieben! - Release

• Updated dependencies [46550d6]:

  • @atproto/lex-data@0.0.1