@atproto/lex-schema 0.0.4 → 0.0.6

package/src/core.ts

@@ -1,5 +1,10 @@
 export * from './core/$type.js'
+export * from './core/property-key.js'
 export * from './core/record-key.js'
 export * from './core/result.js'
+export * from './core/schema.js'
 export * from './core/string-format.js'
 export * from './core/types.js'
+export * from './core/validation-error.js'
+export * from './core/validation-issue.js'
+export * from './core/validator.js'

package/src/external.ts

@@ -1,4 +1,14 @@
-import { $Type, $TypeOf, $type, LexiconRecordKey, NsidString } from './core.js'
+import {
+  $Type,
+  $TypeOf,
+  $type,
+  Infer,
+  LexiconRecordKey,
+  NsidString,
+  PropertyKey,
+  Schema,
+  Validator,
+} from './core.js'
 import {
   ArraySchema,
   ArraySchemaOptions,
@@ -31,7 +41,7 @@ import {
   ParamsSchema,
   ParamsSchemaShape,
   Payload,
-  PayloadBody,
+  PayloadSchema,
   Permission,
   PermissionOptions,
   PermissionSet,
@@ -57,28 +67,25 @@ import {
   UnknownSchema,
   refine,
 } from './schema.js'
-import { Infer, PropertyKey, Validator } from './validation.js'
+import { memoizedOptions, memoizedTransformer } from './util/memoize.js'
 
 export * from './core.js'
+export * from './helpers.js'
 export * from './schema.js'
-export * from './validation.js'
 
-/*@__NO_SIDE_EFFECTS__*/
-export function never() {
+export { _null as null }
+
+export const never = /*#__PURE__*/ memoizedOptions(function () {
   return new NeverSchema()
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function unknown() {
+export const unknown = /*#__PURE__*/ memoizedOptions(function () {
   return new UnknownSchema()
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function _null() {
+const _null = /*#__PURE__*/ memoizedOptions(function () {
   return new NullSchema()
-}
-
-export { _null as null }
+})
 
 /*@__NO_SIDE_EFFECTS__*/
 export function literal<const V extends null | string | number | boolean>(
@@ -99,39 +106,45 @@ export function _enum<const V extends null | string | number | boolean>(
 // @NOTE "enum" is a reserved keyword in JS/TS
 export { _enum as enum }
 
-/*@__NO_SIDE_EFFECTS__*/
-export function boolean(options?: BooleanSchemaOptions) {
-  return new BooleanSchema(options)
-}
-
-/*@__NO_SIDE_EFFECTS__*/
-export function integer(options?: IntegerSchemaOptions) {
+export const boolean = /*#__PURE__*/ memoizedOptions(
+  function (options?: BooleanSchemaOptions) {
+    return new BooleanSchema(options)
+  },
+  (options) => {
+    const keys = Object.keys(options)
+    if (keys.length === 1 && keys[0] === 'default') return options.default!
+  },
+)
+
+export const integer = /*#__PURE__*/ memoizedOptions(function (
+  options?: IntegerSchemaOptions,
+) {
   return new IntegerSchema(options)
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function cidLink(options?: CidSchemaOptions) {
+export const cidLink = /*#__PURE__*/ memoizedOptions(function (
+  options?: CidSchemaOptions,
+) {
   return new CidSchema(options)
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function bytes(options?: BytesSchemaOptions) {
+export const bytes = /*#__PURE__*/ memoizedOptions(function (
+  options?: BytesSchemaOptions,
+) {
   return new BytesSchema(options)
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function blob<O extends BlobSchemaOptions = NonNullable<unknown>>(
-  options: O = {} as O,
-) {
+export const blob = /*#__PURE__*/ memoizedOptions(function <
+  O extends BlobSchemaOptions = NonNullable<unknown>,
+>(options: O = {} as O) {
   return new BlobSchema(options)
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function string<
+export const string = /*#__PURE__*/ memoizedOptions(function <
   const O extends StringSchemaOptions = NonNullable<unknown>,
 >(options: StringSchemaOptions & O = {} as O) {
   return new StringSchema<O>(options)
-}
+})
 
 /*@__NO_SIDE_EFFECTS__*/
 export function regexp<T extends string = string>(pattern: RegExp) {
@@ -170,10 +183,9 @@ export function dict<
 // Utility
 export type { UnknownObjectOutput as UnknownObject }
 
-/*@__NO_SIDE_EFFECTS__*/
-export function unknownObject() {
+export const unknownObject = /*#__PURE__*/ memoizedOptions(function () {
   return new UnknownObjectSchema()
-}
+})
 
 /*@__NO_SIDE_EFFECTS__*/
 export function ref<T>(get: RefSchemaGetter<T>) {
@@ -189,15 +201,17 @@ export function custom<T>(
   return new CustomSchema<T>(assertion, message, path)
 }
 
-/*@__NO_SIDE_EFFECTS__*/
-export function nullable<const S extends Validator>(schema: S) {
+export const nullable = /*#__PURE__*/ memoizedTransformer(function <
+  const S extends Validator,
+>(schema: S) {
   return new NullableSchema<Infer<S>>(schema)
-}
+})
 
-/*@__NO_SIDE_EFFECTS__*/
-export function optional<const S extends Validator>(schema: S) {
+export const optional = /*#__PURE__*/ memoizedTransformer(function <
+  const S extends Validator,
+>(schema: S) {
   return new OptionalSchema<Infer<S>>(schema)
-}
+})
 
 /*@__NO_SIDE_EFFECTS__*/
 export function union<const V extends UnionSchemaValidators>(validators: V) {
@@ -262,7 +276,7 @@ export function typedUnion<
 export function typedObject<
   const N extends NsidString,
   const H extends string,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(nsid: N, hash: H, schema: S): TypedObjectSchema<$Type<N, H>, S>
 export function typedObject<V extends { $type?: $Type }>(
   nsid: V extends { $type?: infer T extends string }
@@ -281,7 +295,7 @@ export function typedObject<V extends { $type?: $Type }>(
 export function typedObject<
   const N extends NsidString,
   const H extends string,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(nsid: N, hash: H, schema: S) {
   return new TypedObjectSchema<$Type<N, H>, S>($type(nsid, hash), schema)
 }
@@ -305,7 +319,7 @@ type AsNsid<T> = T extends `${string}#${string}` ? never : T
 export function record<
   const K extends LexiconRecordKey,
   const T extends NsidString,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(key: K, type: AsNsid<T>, schema: S): RecordSchema<K, T, S>
 export function record<
   const K extends LexiconRecordKey,
@@ -319,26 +333,32 @@ export function record<
 export function record<
   const K extends LexiconRecordKey,
   const T extends NsidString,
-  const S extends Validator<{ [_ in string]?: unknown }>,
+  const S extends Validator<{ [k: string]: unknown }>,
 >(key: K, type: T, schema: S) {
   return new RecordSchema<K, T, S>(key, type, schema)
 }
 
-/*@__NO_SIDE_EFFECTS__*/
-export function params<
+export const params = /*#__PURE__*/ memoizedOptions(function <
   const P extends ParamsSchemaShape = NonNullable<unknown>,
 >(properties: P = {} as P) {
   return new ParamsSchema<P>(properties)
-}
+})
 
 /*@__NO_SIDE_EFFECTS__*/
 export function payload<
   const E extends string | undefined = undefined,
-  const S extends PayloadBody<E> = undefined,
+  const S extends PayloadSchema<E> = undefined,
 >(encoding: E = undefined as E, schema: S = undefined as S) {
   return new Payload<E, S>(encoding, schema)
 }
 
+/*@__NO_SIDE_EFFECTS__*/
+export function jsonPayload<const P extends ObjectSchemaShape>(
+  properties: P,
+): Payload<'application/json', ObjectSchema<P>> {
+  return payload('application/json', object(properties))
+}
+
 /*@__NO_SIDE_EFFECTS__*/
 export function query<
   const N extends NsidString,
@@ -364,7 +384,7 @@ export function procedure<
 export function subscription<
   const N extends NsidString,
   const P extends ParamsSchema,
-  const M extends undefined | RefSchema | TypedUnionSchema | ObjectSchema,
+  const M extends Schema,
   const E extends undefined | readonly string[] = undefined,
 >(nsid: N, parameters: P, message: M, errors: E = undefined as E) {
   return new Subscription<N, P, M, E>(nsid, parameters, message, errors)