@atproto/lex-schema 0.0.12 → 0.0.13

package/src/schema/typed-object.ts

@@ -15,6 +15,13 @@ import {
   Validator,
 } from '../core.js'
 
+export type MaybeTypedObject<
+  TType extends $Type,
+  TValue extends { $type?: unknown } = { $type?: unknown },
+> = TValue extends { $type?: TType }
+  ? TValue
+  : $TypedMaybe<Exclude<TValue, Unknown$TypedObject>, TType>
+
 /**
  * Schema for typed objects in Lexicon unions.
  *
@@ -40,6 +47,8 @@ export class TypedObjectSchema<
   $TypedMaybe<InferInput<TShape>, TType>,
   $TypedMaybe<InferOutput<TShape>, TType>
 > {
+  readonly type = 'typedObject' as const
+
   constructor(
     readonly $type: TType,
     readonly schema: TShape,
@@ -47,11 +56,9 @@ export class TypedObjectSchema<
     super()
   }
 
-  isTypeOf<X extends Record<string, unknown>>(
-    value: X,
-  ): value is X extends { $type?: TType }
-    ? X
-    : $TypedMaybe<Exclude<X, Unknown$TypedObject>, TType> {
+  isTypeOf<TValue extends Record<string, unknown>>(
+    value: TValue,
+  ): value is MaybeTypedObject<TType, TValue> {
     return value.$type === undefined || value.$type === this.$type
   }
 
@@ -64,17 +71,21 @@ export class TypedObjectSchema<
     >
   }
 
-  $isTypeOf<X extends Record<string, unknown>>(value: X) {
+  $isTypeOf<TValue extends Record<string, unknown>>(
+    value: TValue,
+  ): value is MaybeTypedObject<TType, TValue> {
     return this.isTypeOf(value)
   }
 
-  $build(input: Omit<InferInput<this>, '$type'>) {
+  $build(
+    input: Omit<InferInput<this>, '$type'>,
+  ): $Typed<InferOutput<this>, TType> {
     return this.build(input)
   }
 
   validateInContext(input: unknown, ctx: ValidationContext) {
     if (!isPlainObject(input)) {
-      return ctx.issueInvalidType(input, 'object')
+      return ctx.issueUnexpectedType(input, 'object')
     }
 
     if (

package/src/schema/typed-ref.ts

@@ -51,6 +51,8 @@ export class TypedRefSchema<
   $Typed<InferInput<TValidator>>,
   $Typed<InferOutput<TValidator>>
 > {
+  readonly type = 'typedRef' as const
+
   #getter: TypedRefGetter<TValidator>
 
   constructor(getter: TypedRefGetter<TValidator>) {

package/src/schema/typed-union.ts

@@ -42,6 +42,8 @@ export class TypedUnionSchema<
     ? InferOutput<TValidators[number]>
     : InferOutput<TValidators[number]> | Unknown$TypedObject
 > {
+  readonly type = 'typedUnion' as const
+
   constructor(
     protected readonly validators: TValidators,
     public readonly closed: TClosed,
@@ -67,7 +69,7 @@ export class TypedUnionSchema<
 
   validateInContext(input: unknown, ctx: ValidationContext) {
     if (!isPlainObject(input) || !('$type' in input)) {
-      return ctx.issueInvalidType(input, '$typed')
+      return ctx.issueUnexpectedType(input, '$typed')
     }
 
     const { $type } = input

package/src/schema/union.ts

@@ -37,6 +37,8 @@ export class UnionSchema<
   InferInput<TValidators[number]>,
   InferOutput<TValidators[number]>
 > {
+  readonly type = 'union' as const
+
   constructor(protected readonly validators: TValidators) {
     super()
   }

package/src/schema/unknown.ts

@@ -15,6 +15,8 @@ import { memoizedOptions } from '../util/memoize.js'
  * ```
  */
 export class UnknownSchema extends Schema<unknown> {
+  readonly type = 'unknown' as const
+
   validateInContext(input: unknown, ctx: ValidationContext) {
     return ctx.success(input)
   }

package/src/schema/with-default.ts

@@ -25,6 +25,8 @@ import {
 export class WithDefaultSchema<
   const TValidator extends Validator,
 > extends Schema<InferInput<TValidator>, InferOutput<TValidator>> {
+  readonly type = 'withDefault' as const
+
   constructor(
     readonly validator: TValidator,
     readonly defaultValue: InferInput<TValidator>,

package/src/schema.ts

@@ -7,13 +7,14 @@ export * from './schema/cid.js'
 export * from './schema/dict.js'
 export * from './schema/enum.js'
 export * from './schema/integer.js'
+export * from './schema/lex-map.js'
+export * from './schema/lex-value.js'
 export * from './schema/literal.js'
 export * from './schema/never.js'
 export * from './schema/null.js'
 export * from './schema/object.js'
 export * from './schema/regexp.js'
 export * from './schema/string.js'
-export * from './schema/unknown-object.js'
 export * from './schema/unknown.js'
 
 // Composite Types

package/src/util/if-any.ts

@@ -0,0 +1,3 @@
+export type IfAny<T, TrueValue, FalseValue> = 0 extends 1 & T
+  ? TrueValue
+  : FalseValue

package/dist/schema/unknown-object.d.ts

@@ -1,42 +0,0 @@
-import { LexMap } from '@atproto/lex-data';
-import { Schema, ValidationContext } from '../core.js';
-/**
- * Type alias for a plain object with unknown values.
- */
-export type UnknownObject = LexMap;
-/**
- * Schema that accepts any plain object without validating its properties.
- *
- * Validates that the input is a plain object (not an array, Date, or other
- * special object type), but does not validate the object's properties.
- *
- * @example
- * ```ts
- * const schema = new UnknownObjectSchema()
- * schema.validate({ any: 'props' }) // success
- * schema.validate([1, 2, 3])        // fails - arrays not accepted
- * ```
- */
-export declare class UnknownObjectSchema extends Schema<UnknownObject> {
-    validateInContext(input: unknown, ctx: ValidationContext): import("../core.js").ValidationResult<LexMap>;
-}
-/**
- * Creates a schema that accepts any plain object.
- *
- * Unlike `l.unknown()` which accepts any value, this validates that the input
- * is specifically a plain object (not an array, null, or primitive).
- *
- * @returns A new {@link UnknownObjectSchema} instance
- *
- * @example
- * ```ts
- * // Accept any object shape
- * const metadataSchema = l.unknownObject()
- *
- * metadataSchema.parse({ foo: 1, bar: 'baz' }) // success
- * metadataSchema.parse([1, 2, 3])              // throws - not a plain object
- * metadataSchema.parse(null)                   // throws
- * ```
- */
-export declare const unknownObject: () => UnknownObjectSchema;
-//# sourceMappingURL=unknown-object.d.ts.map

package/dist/schema/unknown-object.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"unknown-object.d.ts","sourceRoot":"","sources":["../../src/schema/unknown-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAY,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAGtD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC;;;;;;;;;;;;GAYG;AACH,qBAAa,mBAAoB,SAAQ,MAAM,CAAC,aAAa,CAAC;IAC5D,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,iBAAiB;CAOzD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,2BAExB,CAAA"}

package/dist/schema/unknown-object.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unknownObject = exports.UnknownObjectSchema = void 0;
-const lex_data_1 = require("@atproto/lex-data");
-const core_js_1 = require("../core.js");
-const memoize_js_1 = require("../util/memoize.js");
-/**
- * Schema that accepts any plain object without validating its properties.
- *
- * Validates that the input is a plain object (not an array, Date, or other
- * special object type), but does not validate the object's properties.
- *
- * @example
- * ```ts
- * const schema = new UnknownObjectSchema()
- * schema.validate({ any: 'props' }) // success
- * schema.validate([1, 2, 3])        // fails - arrays not accepted
- * ```
- */
-class UnknownObjectSchema extends core_js_1.Schema {
-    validateInContext(input, ctx) {
-        if ((0, lex_data_1.isLexMap)(input)) {
-            return ctx.success(input);
-        }
-        return ctx.issueInvalidType(input, 'unknown');
-    }
-}
-exports.UnknownObjectSchema = UnknownObjectSchema;
-/**
- * Creates a schema that accepts any plain object.
- *
- * Unlike `l.unknown()` which accepts any value, this validates that the input
- * is specifically a plain object (not an array, null, or primitive).
- *
- * @returns A new {@link UnknownObjectSchema} instance
- *
- * @example
- * ```ts
- * // Accept any object shape
- * const metadataSchema = l.unknownObject()
- *
- * metadataSchema.parse({ foo: 1, bar: 'baz' }) // success
- * metadataSchema.parse([1, 2, 3])              // throws - not a plain object
- * metadataSchema.parse(null)                   // throws
- * ```
- */
-exports.unknownObject = (0, memoize_js_1.memoizedOptions)(function () {
-    return new UnknownObjectSchema();
-});
-//# sourceMappingURL=unknown-object.js.map

package/dist/schema/unknown-object.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"unknown-object.js","sourceRoot":"","sources":["../../src/schema/unknown-object.ts"],"names":[],"mappings":";;;AAAA,gDAAoD;AACpD,wCAAsD;AACtD,mDAAoD;AAOpD;;;;;;;;;;;;GAYG;AACH,MAAa,mBAAoB,SAAQ,gBAAqB;IAC5D,iBAAiB,CAAC,KAAc,EAAE,GAAsB;QACtD,IAAI,IAAA,mBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;QAED,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC/C,CAAC;CACF;AARD,kDAQC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACU,QAAA,aAAa,GAAiB,IAAA,4BAAe,EAAC;IACzD,OAAO,IAAI,mBAAmB,EAAE,CAAA;AAClC,CAAC,CAAC,CAAA","sourcesContent":["import { LexMap, isLexMap } from '@atproto/lex-data'\nimport { Schema, ValidationContext } from '../core.js'\nimport { memoizedOptions } from '../util/memoize.js'\n\n/**\n * Type alias for a plain object with unknown values.\n */\nexport type UnknownObject = LexMap\n\n/**\n * Schema that accepts any plain object without validating its properties.\n *\n * Validates that the input is a plain object (not an array, Date, or other\n * special object type), but does not validate the object's properties.\n *\n * @example\n * ```ts\n * const schema = new UnknownObjectSchema()\n * schema.validate({ any: 'props' }) // success\n * schema.validate([1, 2, 3])        // fails - arrays not accepted\n * ```\n */\nexport class UnknownObjectSchema extends Schema<UnknownObject> {\n  validateInContext(input: unknown, ctx: ValidationContext) {\n    if (isLexMap(input)) {\n      return ctx.success(input)\n    }\n\n    return ctx.issueInvalidType(input, 'unknown')\n  }\n}\n\n/**\n * Creates a schema that accepts any plain object.\n *\n * Unlike `l.unknown()` which accepts any value, this validates that the input\n * is specifically a plain object (not an array, null, or primitive).\n *\n * @returns A new {@link UnknownObjectSchema} instance\n *\n * @example\n * ```ts\n * // Accept any object shape\n * const metadataSchema = l.unknownObject()\n *\n * metadataSchema.parse({ foo: 1, bar: 'baz' }) // success\n * metadataSchema.parse([1, 2, 3])              // throws - not a plain object\n * metadataSchema.parse(null)                   // throws\n * ```\n */\nexport const unknownObject = /*#__PURE__*/ memoizedOptions(function () {\n  return new UnknownObjectSchema()\n})\n"]}

package/src/schema/unknown-object.ts

@@ -1,53 +0,0 @@
-import { LexMap, isLexMap } from '@atproto/lex-data'
-import { Schema, ValidationContext } from '../core.js'
-import { memoizedOptions } from '../util/memoize.js'
-
-/**
- * Type alias for a plain object with unknown values.
- */
-export type UnknownObject = LexMap
-
-/**
- * Schema that accepts any plain object without validating its properties.
- *
- * Validates that the input is a plain object (not an array, Date, or other
- * special object type), but does not validate the object's properties.
- *
- * @example
- * ```ts
- * const schema = new UnknownObjectSchema()
- * schema.validate({ any: 'props' }) // success
- * schema.validate([1, 2, 3])        // fails - arrays not accepted
- * ```
- */
-export class UnknownObjectSchema extends Schema<UnknownObject> {
-  validateInContext(input: unknown, ctx: ValidationContext) {
-    if (isLexMap(input)) {
-      return ctx.success(input)
-    }
-
-    return ctx.issueInvalidType(input, 'unknown')
-  }
-}
-
-/**
- * Creates a schema that accepts any plain object.
- *
- * Unlike `l.unknown()` which accepts any value, this validates that the input
- * is specifically a plain object (not an array, null, or primitive).
- *
- * @returns A new {@link UnknownObjectSchema} instance
- *
- * @example
- * ```ts
- * // Accept any object shape
- * const metadataSchema = l.unknownObject()
- *
- * metadataSchema.parse({ foo: 1, bar: 'baz' }) // success
- * metadataSchema.parse([1, 2, 3])              // throws - not a plain object
- * metadataSchema.parse(null)                   // throws
- * ```
- */
-export const unknownObject = /*#__PURE__*/ memoizedOptions(function () {
-  return new UnknownObjectSchema()
-})