@arrirpc/schema 0.75.2 → 0.76.0

package/README.md

@@ -1010,9 +1010,12 @@ $$User.serializeUnsafe({ id: '1', email: null, created: new Date() });
 
 In most cases, the compiled validators will be much faster than the standard utilities. However there is some overhead with compiling the schemas so ideally each validator would be compiled once. Additionally the resulting methods are created using [`new Function()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) so they can only be used in an environment that you control such as a backend server. They WILL NOT work in a browser environment.
 
-You can also use `a.compile` for code generation. The compiler result gives you access to the generated function bodies.
+You can also use `a.compile` for code generation. Passing `true` as the second parameter will ensure that the compile result gives you access to the generated function bodies. This is disabled by default as of `v0.76.0` in order to reduce unwanted memory usage. (No need to carry around these large strings if they aren't going to be used.)
 
 ```ts
+// pass true to the second parameter to get access to the generated function bodies
+const $$User = a.compile(User, true);
+
 $$User.compiledCode.validate; // the generated validation code
 $$User.compiledCode.parse; // the generated parsing code
 $$User.compiledCode.coerce; // the generated coercion code

package/dist/index.cjs

@@ -1460,7 +1460,7 @@ function isValidationException(input) {
   return input instanceof ValidationException;
 }
 
-function compile(schema) {
+function compile(schema, includeCompiledCode) {
   const validateCode = createValidationTemplate("input", schema);
   const parser = getCompiledParser("input", schema, false);
   const parserFn = parser.fn;
@@ -1577,12 +1577,12 @@ function compile(schema) {
     serializeUnsafe(input) {
       return serializeFn(input);
     },
-    compiledCode: {
+    compiledCode: includeCompiledCode === true ? {
       validate: validateCode,
       parse: parser.code,
       coerce: coercer.code,
       serialize: serializer.code
-    },
+    } : void 0,
     "~standard": adapters.createStandardSchemaProperty(validate, (input, ctx) => {
       const result2 = parse(input);
       if (!result2.success) {

package/dist/index.d.cts

@@ -9,7 +9,13 @@ declare function createSerializationV2Template(inputName: string, schema: Schema
 
 declare function createValidationTemplate(inputName: string, schema: ASchema<any>): string;
 
-interface CompiledValidator<TSchema extends ASchema<any>> {
+interface CompiledValidatorCompiledCode {
+    parse: string;
+    coerce: string;
+    serialize: string;
+    validate: string;
+}
+interface CompiledValidator<TSchema extends ASchema<any>, TIncludeCode extends boolean = false> {
     schema: ASchemaStrict<TSchema>;
     /**
      * Determine if a type matches a schema. This is a type guard.
@@ -42,18 +48,13 @@ interface CompiledValidator<TSchema extends ASchema<any>> {
     /**
      * The ATD Schema
      */
-    compiledCode: {
-        parse: string;
-        coerce: string;
-        serialize: string;
-        validate: string;
-    };
+    compiledCode: TIncludeCode extends true ? CompiledValidatorCompiledCode : undefined;
 }
-type CompiledValidatorWithAdapters<TSchema extends ASchema> = CompiledValidator<TSchema> & StandardSchemaV1<InferType<TSchema>>;
+type CompiledValidatorWithAdapters<TSchema extends ASchema, TIncludeCode extends boolean = false> = CompiledValidator<TSchema, TIncludeCode> & StandardSchemaV1<InferType<TSchema>>;
 /**
  * Create compiled versions of the `decode()`, `validate()`, and `serialize()` functions
  */
-declare function compile<TSchema extends ASchema<any>>(schema: TSchema): CompiledValidatorWithAdapters<TSchema>;
+declare function compile<TSchema extends ASchema<any>, TIncludeCompiled extends boolean = false>(schema: TSchema, includeCompiledCode?: TIncludeCompiled): CompiledValidatorWithAdapters<TSchema, TIncludeCompiled>;
 type CompiledParser<TSchema extends ASchema<any>> = SchemaValidator<InferType<TSchema>>['parse'];
 declare function getCompiledParser<TSchema extends ASchema<any>>(input: string, schema: Schema, shouldCoerce: boolean): {
     fn: CompiledParser<TSchema>;
@@ -405,4 +406,4 @@ declare const int64Max: bigint;
 declare const uint64Min: bigint;
 declare const uint64Max: bigint;
 
-export { AArraySchema, ADiscriminatorSchemaWithAdapters, AObjectSchema, AObjectSchemaOptions, AObjectSchemaWithAdapters, ARecordSchemaWithAdapters, ARefSchema, AScalarSchemaWithAdapters, ASchema, ASchemaOptions, ASchemaStrict, ASchemaWithAdapters, AStringEnumSchemaWithAdapters, type CompiledValidator, InferObjectOutput, InferSubType, InferType, ResolveObject, Result, STR_ESCAPE, SchemaValidator, ValidationContext, ValueError, WithAdapters, _namespace as a, any, array, boolean, clone, coerce, coerceUnsafe, compile, decodeObjectSchema, discriminator, enumerator, errors, extend, float32, float64, getCompiledParser, getCompiledSerializer, createParsingTemplate as getSchemaDecodingCode, createSerializationV2Template as getSchemaSerializationCode, createValidationTemplate as getSchemaValidationCode, int16, int16Max, int16Min, int32, int32Max, int32Min, int64, int64Max, int64Min, int8, int8Max, int8Min, nullable, number, object, omit, optional, parse, parseUnsafe, partial, pick, record, recursive, sanitizeJson, serialize, serializeObject, serializeSmallString, serializeString, serializeUnsafe, string, stringEnum, timestamp, uint16, uint16Max, uint16Min, uint32, uint32Max, uint32Min, uint64, uint64Max, uint64Min, uint8, uint8Max, uint8Min, validate, validateObjectSchema };
+export { AArraySchema, ADiscriminatorSchemaWithAdapters, AObjectSchema, AObjectSchemaOptions, AObjectSchemaWithAdapters, ARecordSchemaWithAdapters, ARefSchema, AScalarSchemaWithAdapters, ASchema, ASchemaOptions, ASchemaStrict, ASchemaWithAdapters, AStringEnumSchemaWithAdapters, type CompiledValidator, type CompiledValidatorCompiledCode, InferObjectOutput, InferSubType, InferType, ResolveObject, Result, STR_ESCAPE, SchemaValidator, ValidationContext, ValueError, WithAdapters, _namespace as a, any, array, boolean, clone, coerce, coerceUnsafe, compile, decodeObjectSchema, discriminator, enumerator, errors, extend, float32, float64, getCompiledParser, getCompiledSerializer, createParsingTemplate as getSchemaDecodingCode, createSerializationV2Template as getSchemaSerializationCode, createValidationTemplate as getSchemaValidationCode, int16, int16Max, int16Min, int32, int32Max, int32Min, int64, int64Max, int64Min, int8, int8Max, int8Min, nullable, number, object, omit, optional, parse, parseUnsafe, partial, pick, record, recursive, sanitizeJson, serialize, serializeObject, serializeSmallString, serializeString, serializeUnsafe, string, stringEnum, timestamp, uint16, uint16Max, uint16Min, uint32, uint32Max, uint32Min, uint64, uint64Max, uint64Min, uint8, uint8Max, uint8Min, validate, validateObjectSchema };

package/dist/index.d.mts

@@ -9,7 +9,13 @@ declare function createSerializationV2Template(inputName: string, schema: Schema
 
 declare function createValidationTemplate(inputName: string, schema: ASchema<any>): string;
 
-interface CompiledValidator<TSchema extends ASchema<any>> {
+interface CompiledValidatorCompiledCode {
+    parse: string;
+    coerce: string;
+    serialize: string;
+    validate: string;
+}
+interface CompiledValidator<TSchema extends ASchema<any>, TIncludeCode extends boolean = false> {
     schema: ASchemaStrict<TSchema>;
     /**
      * Determine if a type matches a schema. This is a type guard.
@@ -42,18 +48,13 @@ interface CompiledValidator<TSchema extends ASchema<any>> {
     /**
      * The ATD Schema
      */
-    compiledCode: {
-        parse: string;
-        coerce: string;
-        serialize: string;
-        validate: string;
-    };
+    compiledCode: TIncludeCode extends true ? CompiledValidatorCompiledCode : undefined;
 }
-type CompiledValidatorWithAdapters<TSchema extends ASchema> = CompiledValidator<TSchema> & StandardSchemaV1<InferType<TSchema>>;
+type CompiledValidatorWithAdapters<TSchema extends ASchema, TIncludeCode extends boolean = false> = CompiledValidator<TSchema, TIncludeCode> & StandardSchemaV1<InferType<TSchema>>;
 /**
  * Create compiled versions of the `decode()`, `validate()`, and `serialize()` functions
  */
-declare function compile<TSchema extends ASchema<any>>(schema: TSchema): CompiledValidatorWithAdapters<TSchema>;
+declare function compile<TSchema extends ASchema<any>, TIncludeCompiled extends boolean = false>(schema: TSchema, includeCompiledCode?: TIncludeCompiled): CompiledValidatorWithAdapters<TSchema, TIncludeCompiled>;
 type CompiledParser<TSchema extends ASchema<any>> = SchemaValidator<InferType<TSchema>>['parse'];
 declare function getCompiledParser<TSchema extends ASchema<any>>(input: string, schema: Schema, shouldCoerce: boolean): {
     fn: CompiledParser<TSchema>;
@@ -405,4 +406,4 @@ declare const int64Max: bigint;
 declare const uint64Min: bigint;
 declare const uint64Max: bigint;
 
-export { AArraySchema, ADiscriminatorSchemaWithAdapters, AObjectSchema, AObjectSchemaOptions, AObjectSchemaWithAdapters, ARecordSchemaWithAdapters, ARefSchema, AScalarSchemaWithAdapters, ASchema, ASchemaOptions, ASchemaStrict, ASchemaWithAdapters, AStringEnumSchemaWithAdapters, type CompiledValidator, InferObjectOutput, InferSubType, InferType, ResolveObject, Result, STR_ESCAPE, SchemaValidator, ValidationContext, ValueError, WithAdapters, _namespace as a, any, array, boolean, clone, coerce, coerceUnsafe, compile, decodeObjectSchema, discriminator, enumerator, errors, extend, float32, float64, getCompiledParser, getCompiledSerializer, createParsingTemplate as getSchemaDecodingCode, createSerializationV2Template as getSchemaSerializationCode, createValidationTemplate as getSchemaValidationCode, int16, int16Max, int16Min, int32, int32Max, int32Min, int64, int64Max, int64Min, int8, int8Max, int8Min, nullable, number, object, omit, optional, parse, parseUnsafe, partial, pick, record, recursive, sanitizeJson, serialize, serializeObject, serializeSmallString, serializeString, serializeUnsafe, string, stringEnum, timestamp, uint16, uint16Max, uint16Min, uint32, uint32Max, uint32Min, uint64, uint64Max, uint64Min, uint8, uint8Max, uint8Min, validate, validateObjectSchema };
+export { AArraySchema, ADiscriminatorSchemaWithAdapters, AObjectSchema, AObjectSchemaOptions, AObjectSchemaWithAdapters, ARecordSchemaWithAdapters, ARefSchema, AScalarSchemaWithAdapters, ASchema, ASchemaOptions, ASchemaStrict, ASchemaWithAdapters, AStringEnumSchemaWithAdapters, type CompiledValidator, type CompiledValidatorCompiledCode, InferObjectOutput, InferSubType, InferType, ResolveObject, Result, STR_ESCAPE, SchemaValidator, ValidationContext, ValueError, WithAdapters, _namespace as a, any, array, boolean, clone, coerce, coerceUnsafe, compile, decodeObjectSchema, discriminator, enumerator, errors, extend, float32, float64, getCompiledParser, getCompiledSerializer, createParsingTemplate as getSchemaDecodingCode, createSerializationV2Template as getSchemaSerializationCode, createValidationTemplate as getSchemaValidationCode, int16, int16Max, int16Min, int32, int32Max, int32Min, int64, int64Max, int64Min, int8, int8Max, int8Min, nullable, number, object, omit, optional, parse, parseUnsafe, partial, pick, record, recursive, sanitizeJson, serialize, serializeObject, serializeSmallString, serializeString, serializeUnsafe, string, stringEnum, timestamp, uint16, uint16Max, uint16Min, uint32, uint32Max, uint32Min, uint64, uint64Max, uint64Min, uint8, uint8Max, uint8Min, validate, validateObjectSchema };

package/dist/index.d.ts

@@ -9,7 +9,13 @@ declare function createSerializationV2Template(inputName: string, schema: Schema
 
 declare function createValidationTemplate(inputName: string, schema: ASchema<any>): string;
 
-interface CompiledValidator<TSchema extends ASchema<any>> {
+interface CompiledValidatorCompiledCode {
+    parse: string;
+    coerce: string;
+    serialize: string;
+    validate: string;
+}
+interface CompiledValidator<TSchema extends ASchema<any>, TIncludeCode extends boolean = false> {
     schema: ASchemaStrict<TSchema>;
     /**
      * Determine if a type matches a schema. This is a type guard.
@@ -42,18 +48,13 @@ interface CompiledValidator<TSchema extends ASchema<any>> {
     /**
      * The ATD Schema
      */
-    compiledCode: {
-        parse: string;
-        coerce: string;
-        serialize: string;
-        validate: string;
-    };
+    compiledCode: TIncludeCode extends true ? CompiledValidatorCompiledCode : undefined;
 }
-type CompiledValidatorWithAdapters<TSchema extends ASchema> = CompiledValidator<TSchema> & StandardSchemaV1<InferType<TSchema>>;
+type CompiledValidatorWithAdapters<TSchema extends ASchema, TIncludeCode extends boolean = false> = CompiledValidator<TSchema, TIncludeCode> & StandardSchemaV1<InferType<TSchema>>;
 /**
  * Create compiled versions of the `decode()`, `validate()`, and `serialize()` functions
  */
-declare function compile<TSchema extends ASchema<any>>(schema: TSchema): CompiledValidatorWithAdapters<TSchema>;
+declare function compile<TSchema extends ASchema<any>, TIncludeCompiled extends boolean = false>(schema: TSchema, includeCompiledCode?: TIncludeCompiled): CompiledValidatorWithAdapters<TSchema, TIncludeCompiled>;
 type CompiledParser<TSchema extends ASchema<any>> = SchemaValidator<InferType<TSchema>>['parse'];
 declare function getCompiledParser<TSchema extends ASchema<any>>(input: string, schema: Schema, shouldCoerce: boolean): {
     fn: CompiledParser<TSchema>;
@@ -405,4 +406,4 @@ declare const int64Max: bigint;
 declare const uint64Min: bigint;
 declare const uint64Max: bigint;
 
-export { AArraySchema, ADiscriminatorSchemaWithAdapters, AObjectSchema, AObjectSchemaOptions, AObjectSchemaWithAdapters, ARecordSchemaWithAdapters, ARefSchema, AScalarSchemaWithAdapters, ASchema, ASchemaOptions, ASchemaStrict, ASchemaWithAdapters, AStringEnumSchemaWithAdapters, type CompiledValidator, InferObjectOutput, InferSubType, InferType, ResolveObject, Result, STR_ESCAPE, SchemaValidator, ValidationContext, ValueError, WithAdapters, _namespace as a, any, array, boolean, clone, coerce, coerceUnsafe, compile, decodeObjectSchema, discriminator, enumerator, errors, extend, float32, float64, getCompiledParser, getCompiledSerializer, createParsingTemplate as getSchemaDecodingCode, createSerializationV2Template as getSchemaSerializationCode, createValidationTemplate as getSchemaValidationCode, int16, int16Max, int16Min, int32, int32Max, int32Min, int64, int64Max, int64Min, int8, int8Max, int8Min, nullable, number, object, omit, optional, parse, parseUnsafe, partial, pick, record, recursive, sanitizeJson, serialize, serializeObject, serializeSmallString, serializeString, serializeUnsafe, string, stringEnum, timestamp, uint16, uint16Max, uint16Min, uint32, uint32Max, uint32Min, uint64, uint64Max, uint64Min, uint8, uint8Max, uint8Min, validate, validateObjectSchema };
+export { AArraySchema, ADiscriminatorSchemaWithAdapters, AObjectSchema, AObjectSchemaOptions, AObjectSchemaWithAdapters, ARecordSchemaWithAdapters, ARefSchema, AScalarSchemaWithAdapters, ASchema, ASchemaOptions, ASchemaStrict, ASchemaWithAdapters, AStringEnumSchemaWithAdapters, type CompiledValidator, type CompiledValidatorCompiledCode, InferObjectOutput, InferSubType, InferType, ResolveObject, Result, STR_ESCAPE, SchemaValidator, ValidationContext, ValueError, WithAdapters, _namespace as a, any, array, boolean, clone, coerce, coerceUnsafe, compile, decodeObjectSchema, discriminator, enumerator, errors, extend, float32, float64, getCompiledParser, getCompiledSerializer, createParsingTemplate as getSchemaDecodingCode, createSerializationV2Template as getSchemaSerializationCode, createValidationTemplate as getSchemaValidationCode, int16, int16Max, int16Min, int32, int32Max, int32Min, int64, int64Max, int64Min, int8, int8Max, int8Min, nullable, number, object, omit, optional, parse, parseUnsafe, partial, pick, record, recursive, sanitizeJson, serialize, serializeObject, serializeSmallString, serializeString, serializeUnsafe, string, stringEnum, timestamp, uint16, uint16Max, uint16Min, uint32, uint32Max, uint32Min, uint64, uint64Max, uint64Min, uint8, uint8Max, uint8Min, validate, validateObjectSchema };

package/dist/index.mjs

@@ -1459,7 +1459,7 @@ function isValidationException(input) {
   return input instanceof ValidationException;
 }
 
-function compile(schema) {
+function compile(schema, includeCompiledCode) {
   const validateCode = createValidationTemplate("input", schema);
   const parser = getCompiledParser("input", schema, false);
   const parserFn = parser.fn;
@@ -1576,12 +1576,12 @@ function compile(schema) {
     serializeUnsafe(input) {
       return serializeFn(input);
     },
-    compiledCode: {
+    compiledCode: includeCompiledCode === true ? {
       validate: validateCode,
       parse: parser.code,
       coerce: coercer.code,
       serialize: serializer.code
-    },
+    } : void 0,
     "~standard": createStandardSchemaProperty(validate, (input, ctx) => {
       const result2 = parse(input);
       if (!result2.success) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/schema",
-  "version": "0.75.2",
+  "version": "0.76.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -25,7 +25,7 @@
     "@standard-schema/spec": "1.0.0",
     "scule": "^1.3.0",
     "uncrypto": "^0.1.3",
-    "@arrirpc/type-defs": "0.75.2"
+    "@arrirpc/type-defs": "0.76.0"
   },
   "devDependencies": {
     "ajv": "^8.17.1",