@atproto/lex-schema 0.0.5 → 0.0.7

package/src/helpers.test.ts

@@ -1,3 +1,4 @@
+import { describe, test } from 'vitest'
 import * as l from './external.js'
 
 class BinaryValue {

package/src/helpers.ts

@@ -1,14 +1,23 @@
-import { Restricted } from './core.js'
+import { LexErrorData } from '@atproto/lex-data'
+import { Infer, Restricted, Schema } from './core.js'
 import {
   InferPayload,
   InferPayloadBody,
   InferPayloadEncoding,
+  ObjectSchema,
+  OptionalSchema,
   Payload,
   Procedure,
   Query,
+  StringSchema,
   Subscription,
 } from './schema.js'
-import { Infer, Schema } from './validation.js'
+
+export type Main<T> = T | { main: T }
+
+export function getMain<T extends object>(ns: Main<T>): T {
+  return 'main' in ns ? ns.main : ns
+}
 
 /**
  * Every XRPC implementation should translate `application/json` and `text/*`
@@ -59,3 +68,8 @@ export type InferMethodMessage<
   //
   M extends Procedure | Query | Subscription,
 > = M extends { message: Schema } ? Infer<M['message']> : undefined
+
+export const lexErrorData: Schema<LexErrorData> = new ObjectSchema({
+  error: new StringSchema({ minLength: 1 }),
+  message: new OptionalSchema(new StringSchema({})),
+})

package/src/schema/_parameters.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { paramSchema, paramsSchema } from './_parameters.js'
 
 describe('paramSchema', () => {

package/src/schema/_parameters.ts

@@ -1,4 +1,4 @@
-import { Infer, Validator } from '../validation.js'
+import { Infer, Validator } from '../core.js'
 import { ArraySchema } from './array.js'
 import { BooleanSchema } from './boolean.js'
 import { DictSchema } from './dict.js'

package/src/schema/array.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { ArraySchema } from './array.js'
 import { IntegerSchema } from './integer.js'
 import { ObjectSchema } from './object.js'

package/src/schema/array.ts

@@ -4,7 +4,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 
 export type ArraySchemaOptions = {
   minLength?: number

package/src/schema/blob.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { parseCid } from '@atproto/lex-data'
 import { BlobSchema } from './blob.js'
 

package/src/schema/blob.ts

@@ -1,21 +1,18 @@
 import {
   BlobRef,
+  BlobRefValidationOptions,
   LegacyBlobRef,
   isBlobRef,
   isLegacyBlobRef,
 } from '@atproto/lex-data'
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
-export type BlobSchemaOptions = {
+export type BlobSchemaOptions = BlobRefValidationOptions & {
   /**
    * Whether to allow legacy blob references format
    * @see {@link LegacyBlobRef}
    */
   allowLegacy?: boolean
-  /**
-   * Whether to enforce strict validation on the blob reference (CID version, codec, hash function)
-   */
-  strict?: boolean
   /**
    * List of accepted mime types
    */

package/src/schema/boolean.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { BooleanSchema } from './boolean.js'
 
 describe('BooleanSchema', () => {

package/src/schema/boolean.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export type BooleanSchemaOptions = {
   default?: boolean

package/src/schema/bytes.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { BytesSchema } from './bytes.js'
 
 describe('BytesSchema', () => {

package/src/schema/bytes.ts

@@ -1,5 +1,5 @@
 import { asUint8Array } from '@atproto/lex-data'
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export type BytesSchemaOptions = {
   minLength?: number

package/src/schema/cid.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { parseCid } from '@atproto/lex-data'
 import { CidSchema } from './cid.js'
 

package/src/schema/cid.ts

@@ -1,5 +1,5 @@
 import { Cid, isCid } from '@atproto/lex-data'
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export type { Cid }
 

package/src/schema/custom.test.ts

@@ -1,4 +1,5 @@
-import { IssueCustom } from '../validation.js'
+import { describe, expect, it, vi } from 'vitest'
+import { IssueCustom } from '../core.js'
 import { CustomSchema } from './custom.js'
 
 describe('CustomSchema', () => {
@@ -371,7 +372,7 @@ describe('CustomSchema', () => {
 
   describe('assertion context behavior', () => {
     it('calls assertion with null as this', () => {
-      const assertion = jest.fn(function (
+      const assertion = vi.fn(function (
         this: unknown,
         input: unknown,
       ): input is string {

package/src/schema/custom.ts

@@ -5,7 +5,7 @@ import {
   Schema,
   ValidationResult,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 
 export type CustomAssertionContext = {
   path: PropertyKey[]

package/src/schema/dict.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { BooleanSchema } from './boolean.js'
 import { DictSchema } from './dict.js'
 import { EnumSchema } from './enum.js'

package/src/schema/dict.ts

@@ -5,7 +5,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 
 export type DictSchemaOutput<
   KeySchema extends Validator<string>,

package/src/schema/discriminated-union.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { DiscriminatedUnionSchema } from './discriminated-union.js'
 import { EnumSchema } from './enum.js'
 import { IntegerSchema } from './integer.js'

package/src/schema/discriminated-union.ts

@@ -5,7 +5,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 import { EnumSchema } from './enum.js'
 import { LiteralSchema } from './literal.js'
 import { ObjectSchema } from './object.js'

package/src/schema/enum.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { EnumSchema } from './enum.js'
 
 describe('EnumSchema', () => {

package/src/schema/enum.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export type EnumSchemaOptions<T extends null | string | number | boolean> = {
   default?: T

package/src/schema/integer.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { IntegerSchema } from './integer.js'
 
 describe('IntegerSchema', () => {

package/src/schema/integer.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export type IntegerSchemaOptions = {
   default?: number
@@ -32,8 +32,8 @@ export class IntegerSchema extends Schema<number> {
 }
 
 /**
- * Simple wrapper around {@link Number.isInteger} that acts as a type guard.
+ * Simple wrapper around {@link Number.isSafeInteger} that acts as a type guard.
  */
 function isInteger(input: unknown): input is number {
-  return Number.isInteger(input) && Number.isSafeInteger(input)
+  return Number.isSafeInteger(input)
 }

package/src/schema/intersection.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { BooleanSchema } from './boolean.js'
 import { DictSchema } from './dict.js'
 import { EnumSchema } from './enum.js'

package/src/schema/intersection.ts

@@ -1,10 +1,10 @@
-import { Simplify } from '../core.js'
 import {
   Infer,
   Schema,
+  Simplify,
   ValidationResult,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 import { DictSchema } from './dict.js'
 import { ObjectSchema } from './object.js'
 

package/src/schema/literal.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { LiteralSchema } from './literal.js'
 
 describe('LiteralSchema', () => {

package/src/schema/literal.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export type LiteralSchemaOptions<T extends null | string | number | boolean> = {
   default?: T

package/src/schema/never.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { NeverSchema } from './never.js'
 
 describe('NeverSchema', () => {

package/src/schema/never.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationFailure, ValidatorContext } from '../validation.js'
+import { Schema, ValidationFailure, ValidatorContext } from '../core.js'
 
 export class NeverSchema extends Schema<never> {
   validateInContext(input: unknown, ctx: ValidatorContext): ValidationFailure {

package/src/schema/null.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { NullSchema } from './null.js'
 
 describe('NullSchema', () => {

package/src/schema/null.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export class NullSchema extends Schema<null> {
   constructor() {

package/src/schema/nullable.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { EnumSchema } from './enum.js'
 import { IntegerSchema } from './integer.js'
 import { NullableSchema } from './nullable.js'

package/src/schema/nullable.ts

@@ -3,7 +3,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 
 export class NullableSchema<V> extends Schema<V | null> {
   constructor(readonly schema: Validator<V>) {

package/src/schema/object.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { EnumSchema } from './enum.js'
 import { IntegerSchema } from './integer.js'
 import { NullableSchema } from './nullable.js'

package/src/schema/object.ts

@@ -1,13 +1,13 @@
 import { isPlainObject } from '@atproto/lex-data'
-import { WithOptionalProperties } from '../core.js'
-import { lazyProperty } from '../util/lazy-property.js'
 import {
   Infer,
   Schema,
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+  WithOptionalProperties,
+} from '../core.js'
+import { lazyProperty } from '../util/lazy-property.js'
 
 export type ObjectSchemaShape = Record<string, Validator>
 

package/src/schema/optional.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { BooleanSchema } from './boolean.js'
 import { IntegerSchema } from './integer.js'
 import { OptionalSchema } from './optional.js'

package/src/schema/optional.ts

@@ -3,7 +3,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 
 export class OptionalSchema<V> extends Schema<V | undefined> {
   constructor(readonly schema: Validator<V>) {

package/src/schema/params.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { ArraySchema } from './array.js'
 import { BooleanSchema } from './boolean.js'
 import { IntegerSchema } from './integer.js'

package/src/schema/params.ts

@@ -1,13 +1,13 @@
 import { isPlainObject } from '@atproto/lex-data'
-import { WithOptionalProperties } from '../core.js'
-import { lazyProperty } from '../util/lazy-property.js'
 import {
   Infer,
   Schema,
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+  WithOptionalProperties,
+} from '../core.js'
+import { lazyProperty } from '../util/lazy-property.js'
 import { Param, ParamScalar, paramSchema } from './_parameters.js'
 import { StringSchema } from './string.js'
 

package/src/schema/payload.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { IntegerSchema } from './integer.js'
 import { ObjectSchema } from './object.js'
 import { Payload } from './payload.js'

package/src/schema/payload.ts

@@ -1,5 +1,5 @@
 import { LexValue } from '@atproto/lex-data'
-import { Infer, Schema } from '../validation.js'
+import { Infer, Schema } from '../core.js'
 
 export type InferPayload<
   P extends Payload,

package/src/schema/permission-set.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { asNsidString } from '../core.js'
 import { PermissionSet } from './permission-set.js'
 import { Permission } from './permission.js'

package/src/schema/permission.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { Permission } from './permission.js'
 
 describe('Permission', () => {

package/src/schema/procedure.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { ObjectSchema } from './object.js'
 import { ParamsSchema } from './params.js'
 import { Payload } from './payload.js'

package/src/schema/query.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { asNsidString } from '../core.js'
 import { IntegerSchema } from './integer.js'
 import { ObjectSchema } from './object.js'

package/src/schema/record.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { ObjectSchema } from './object.js'
 import { RecordSchema } from './record.js'
 import { StringSchema } from './string.js'

package/src/schema/record.ts

@@ -1,11 +1,14 @@
-import { LexiconRecordKey, NsidString, Simplify, TidString } from '../core.js'
 import {
+  $Typed,
   Infer,
+  LexiconRecordKey,
+  NsidString,
   Schema,
+  TidString,
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 import { LiteralSchema } from './literal.js'
 import { StringSchema } from './string.js'
 import { TypedObject } from './typed-union.js'
@@ -16,7 +19,7 @@ export type InferRecordKey<R extends RecordSchema> =
 export type RecordSchemaOutput<
   T extends NsidString,
   S extends Validator<{ [k: string]: unknown }>,
-> = Simplify<{ $type: T } & Omit<Infer<S>, '$type'>>
+> = $Typed<Infer<S>, T>
 
 export class RecordSchema<
   K extends LexiconRecordKey = any,
@@ -36,17 +39,16 @@ export class RecordSchema<
 
   isTypeOf<X extends { $type?: unknown }>(
     value: X,
-  ): value is Exclude<
-    X extends { $type?: T } ? X : X & { $type?: T },
-    TypedObject
-  > {
+  ): value is Exclude<X extends { $type: T } ? X : $Typed<X, T>, TypedObject> {
     return value.$type === this.$type
   }
 
   build<X extends Omit<Infer<S>, '$type'>>(
     input: X,
-  ): Simplify<Omit<X, '$type'> & { $type: T }> {
-    return { ...input, $type: this.$type }
+  ): $Typed<Omit<X, '$type'>, T> {
+    return input.$type === this.$type
+      ? (input as $Typed<X, T>)
+      : { ...input, $type: this.$type }
   }
 
   $isTypeOf<X extends { $type?: unknown }>(value: X) {

package/src/schema/ref.test.ts

@@ -1,4 +1,5 @@
-import { Schema } from '../validation.js'
+import { describe, expect, it } from 'vitest'
+import { Schema } from '../core.js'
 import { IntegerSchema } from './integer.js'
 import { ObjectSchema } from './object.js'
 import { OptionalSchema } from './optional.js'

package/src/schema/ref.ts

@@ -3,7 +3,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 
 export type RefSchemaGetter<V> = () => Validator<V>
 

package/src/schema/refine.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { IntegerSchema } from './integer.js'
 import { ObjectSchema } from './object.js'
 import { refine } from './refine.js'

package/src/schema/refine.ts

@@ -5,7 +5,7 @@ import {
   ValidationResult,
   Validator,
   ValidatorContext,
-} from '../validation.js'
+} from '../core.js'
 import { CustomAssertionContext } from './custom.js'
 
 export type RefinementCheck<T> = {
@@ -31,6 +31,23 @@ export type Refinement<T = any, Out extends T = T> =
   | RefinementCheck<T>
   | RefinementAssertion<T, Out>
 
+/**
+ * Create a refined schema based on an existing schema and a refinement check.
+ *
+ * @param schema - The base schema to refine.
+ * @param refinement - The refinement check to apply.
+ * @returns A new schema that includes the refinement.
+ * @example
+ *
+ * ```ts
+ * const PositiveInt = refine(l.integer(), {
+ *   check: (value) => value > 0,
+ *   message: 'Value must be a positive integer',
+ * })
+ * const result = PositiveInt.validate(-5)
+ * // result.success === false
+ * ```
+ */
 export function refine<S extends Validator, Out extends Infer<S>>(
   schema: S,
   refinement: RefinementAssertion<Infer<S>, Out>,

package/src/schema/regexp.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { RegexpSchema } from './regexp.js'
 
 describe('RegexpSchema', () => {

package/src/schema/regexp.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export class RegexpSchema<T extends string> extends Schema<T> {
   constructor(public readonly pattern: RegExp) {

package/src/schema/string.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { StringSchema } from './string.js'
 import { TokenSchema } from './token.js'
 

package/src/schema/string.ts

@@ -1,6 +1,12 @@
 import { asCid, graphemeLen, utf8Len } from '@atproto/lex-data'
-import { InferStringFormat, StringFormat, assertStringFormat } from '../core.js'
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import {
+  InferStringFormat,
+  Schema,
+  StringFormat,
+  ValidationResult,
+  ValidatorContext,
+  assertStringFormat,
+} from '../core.js'
 import { TokenSchema } from './token.js'
 
 export type StringSchemaOptions = {

package/src/schema/subscription.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { asNsidString } from '../core.js'
 import { IntegerSchema } from './integer.js'
 import { ObjectSchema } from './object.js'

package/src/schema/subscription.ts

@@ -1,5 +1,4 @@
-import { NsidString } from '../core.js'
-import { Infer, Schema } from '../validation.js'
+import { Infer, NsidString, Schema } from '../core.js'
 import { ParamsSchema } from './params.js'
 
 export type InferSubscriptionParameters<S extends Subscription> = Infer<

package/src/schema/token.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { TokenSchema } from './token.js'
 
 describe('TokenSchema', () => {

package/src/schema/token.ts

@@ -1,4 +1,4 @@
-import { Schema, ValidationResult, ValidatorContext } from '../validation.js'
+import { Schema, ValidationResult, ValidatorContext } from '../core.js'
 
 export class TokenSchema<V extends string = any> extends Schema<V> {
   constructor(protected readonly value: V) {

package/src/schema/typed-object.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from 'vitest'
 import { EnumSchema } from './enum.js'
 import { IntegerSchema } from './integer.js'
 import { NullableSchema } from './nullable.js'