feat(void): add Void schema

jacob-alford · Sep 20, 2023 · f28cbe7 · f28cbe7
1 parent 1163da7
commit f28cbe7
Show file tree

Hide file tree

Showing 87 changed files with 228 additions and 356 deletions.
diff --git a/docs/Arbitrary.md b/docs/Arbitrary.md
@@ -37,7 +37,7 @@ Derive a fast-check arbitrary from a schemata-ts schema
 **Signature**
 
 ```ts
-export declare const deriveArbitrary: Interpreter<SchemableLambda>
+export declare const deriveArbitrary: any
 ```
 
 Added in v2.0.0

diff --git a/docs/Eq.md b/docs/Eq.md
@@ -149,7 +149,7 @@ Interprets a schema as an `Eq` instance.
 **Signature**
 
 ```ts
-export declare const deriveEq: Interpreter<I.SchemableLambda>
+export declare const deriveEq: any
 ```
 
 Added in v2.0.0

diff --git a/docs/Guard.md b/docs/Guard.md
@@ -50,7 +50,7 @@ Interprets a schema as a decoder
 **Signature**
 
 ```ts
-export declare const deriveGuard: Interpreter<I.SchemableLambda>
+export declare const deriveGuard: any
 ```
 
 Added in v2.0.0

diff --git a/docs/JsonSchema.md b/docs/JsonSchema.md
@@ -56,7 +56,7 @@ export declare const annotate: (
     | {
         readonly title?: string | undefined
         readonly description?: string | undefined
-        readonly references?: Readonly<Record<string, JsonSchema>> | undefined
+        readonly references?: Readonly<Record<string, any>> | undefined
         readonly deprecated?: boolean | undefined
         readonly readOnly?: boolean | undefined
       }
@@ -73,10 +73,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const array: (params?: {
-  minItems?: number
-  maxItems?: number
-}) => <A>(items: Const<JsonSchema, A>) => Const<JsonSchema, A[]>
+export declare const array: (params?: { minItems?: number; maxItems?: number }) => <A>(items: any) => any
 ```
 
 Added in v1.2.0
@@ -86,7 +83,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const booleanSchema: Const<JsonSchema, boolean>
+export declare const booleanSchema: any
 ```
 
 Added in v1.2.0
@@ -96,7 +93,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const emptySchema: Const<I.JsonEmpty, never>
+export declare const emptySchema: any
 ```
 
 Added in v1.2.0
@@ -112,13 +109,7 @@ export declare const integer: <
 >(params?: {
   minimum?: Min | undefined
   maximum?: Max | undefined
-}) => Const<
-  JsonSchema,
-  Opaque<
-    number,
-    IntBrand<Min extends undefined ? -9007199254740991 : Min, Max extends undefined ? 9007199254740991 : Max>
-  >
->
+}) => any
 ```
 
 Added in v1.2.0
@@ -128,9 +119,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const intersection: <B>(
-  right: Const<JsonSchema, B>
-) => <A>(left: Const<JsonSchema, A>) => Const<JsonSchema, A & B>
+export declare const intersection: <B>(right: any) => <A>(left: any) => any
 ```
 
 Added in v1.2.0
@@ -140,7 +129,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const literal: <A extends string | number | boolean | null>(value: A) => Const<JsonSchema, A>
+export declare const literal: <A extends string | number | boolean | null>(value: A) => any
 ```
 
 Added in v1.2.0
@@ -150,7 +139,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const nullSchema: Const<I.JsonNull, never>
+export declare const nullSchema: any
 ```
 
 Added in v1.2.0
@@ -166,16 +155,7 @@ export declare const number: <
 >(params?: {
   minimum?: Min | undefined
   maximum?: Max | undefined
-}) => Const<
-  JsonSchema,
-  Opaque<
-    number,
-    FloatBrand<
-      Min extends undefined ? -1.7976931348623157e308 : Min,
-      Max extends undefined ? 1.7976931348623157e308 : Max
-    >
-  >
->
+}) => any
 ```
 
 Added in v1.2.0
@@ -185,27 +165,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const record: <A>(
-  additionalProperties: Const<JsonSchema, A>,
-  propertyNames?:
-    | (I.JsonEmpty & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonString & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonNumber & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonBoolean & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonNull & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonInteger & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonConst & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonString & I.JsonConst & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonNumber & I.JsonConst & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonBoolean & I.JsonConst & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonNull & I.JsonConst & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonStruct & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonArray & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonUnion & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonIntersection & I.Description & I.References & I.Default & { readonly _A: string })
-    | (I.JsonRef & I.Description & I.References & I.Default & { readonly _A: string })
-    | undefined
-) => Const<JsonSchema, Record<string, A>>
+export declare const record: <A>(additionalProperties: any, propertyNames?: Const<JsonSchema, string>) => any
 ```
 
 Added in v1.2.0
@@ -217,7 +177,7 @@ A reference to a schema definition
 **Signature**
 
 ```ts
-export declare const ref: <A>(ref: string) => Const<JsonSchema, A>
+export declare const ref: <A>(ref: string) => any
 ```
 
 Added in v2.0.0
@@ -246,28 +206,10 @@ Added in v1.2.0
 
 ```ts
 export declare const struct: <A>(
-  properties: { [K in keyof A]: Const<JsonSchema, A[K]> },
+  properties: { [K in keyof A]: any },
   required?: ReadonlyArray<string>,
-  additionalProperties?:
-    | false
-    | (I.JsonEmpty & I.Description & I.References & I.Default)
-    | (I.JsonString & I.Description & I.References & I.Default)
-    | (I.JsonNumber & I.Description & I.References & I.Default)
-    | (I.JsonBoolean & I.Description & I.References & I.Default)
-    | (I.JsonNull & I.Description & I.References & I.Default)
-    | (I.JsonInteger & I.Description & I.References & I.Default)
-    | (I.JsonConst & I.Description & I.References & I.Default)
-    | (I.JsonString & I.JsonConst & I.Description & I.References & I.Default)
-    | (I.JsonNumber & I.JsonConst & I.Description & I.References & I.Default)
-    | (I.JsonBoolean & I.JsonConst & I.Description & I.References & I.Default)
-    | (I.JsonNull & I.JsonConst & I.Description & I.References & I.Default)
-    | (I.JsonStruct & I.Description & I.References & I.Default)
-    | (I.JsonArray & I.Description & I.References & I.Default)
-    | (I.JsonUnion & I.Description & I.References & I.Default)
-    | (I.JsonIntersection & I.Description & I.References & I.Default)
-    | (I.JsonRef & I.Description & I.References & I.Default)
-    | undefined
-) => Const<JsonSchema, A>
+  additionalProperties?: JsonSchema | false
+) => any
 ```
 
 Added in v1.2.0
@@ -277,9 +219,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const tuple: <A extends readonly unknown[]>(
-  ...items: { [K in keyof A]: Const<JsonSchema, A[K]> }
-) => Const<JsonSchema, A>
+export declare const tuple: <A extends readonly unknown[]>(...items: { [K in keyof A]: any }) => any
 ```
 
 Added in v1.2.0
@@ -289,9 +229,7 @@ Added in v1.2.0
 **Signature**
 
 ```ts
-export declare const union: <U extends readonly Const<JsonSchema, unknown>[]>(
-  ...members: U
-) => Const<JsonSchema, U[number] extends Const<JsonSchema, infer A> ? A : never>
+export declare const union: <U extends readonly any[]>(...members: U) => any
 ```
 
 Added in v1.2.0
@@ -320,7 +258,7 @@ Interprets a schema as a JsonSchema projecting into either Draft-07 or 2020-12
 
 ```ts
 export declare const deriveJsonSchema: <I, O>(
-  schema: Schema<I, O>,
+  schema: any,
   version?: 'Draft-07' | '2019-09' | '2020-12',
   maintainIdentity?: boolean
 ) => JsonSchema

diff --git a/docs/MergeSemigroup.md b/docs/MergeSemigroup.md
@@ -36,7 +36,7 @@ Interprets a schema as a MergeSemigroup
 **Signature**
 
 ```ts
-export declare const deriveMergeSemigroup: Interpreter<SchemableLambda>
+export declare const deriveMergeSemigroup: any
 ```
 
 Added in v2.0.0

diff --git a/docs/TranscodeError.md b/docs/TranscodeError.md
@@ -1,6 +1,6 @@
 ---
 title: TranscodeError.ts
-nav_order: 85
+nav_order: 86
 permalink: /transcode-error/
 ---
 

diff --git a/docs/Transcoder.md b/docs/Transcoder.md
@@ -1,6 +1,6 @@
 ---
 title: Transcoder.ts
-nav_order: 86
+nav_order: 87
 permalink: /transcoder/
 ---
 
@@ -54,10 +54,7 @@ A failure case at a specific index
 **Signature**
 
 ```ts
-export declare const errorAtIndex: (
-  index: number,
-  ...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>
-) => TE.TranscodeError
+export declare const errorAtIndex: (index: number, ...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>) => any
 ```
 
 Added in v2.0.0
@@ -69,10 +66,7 @@ A failure case at a specific key
 **Signature**
 
 ```ts
-export declare const errorAtKey: (
-  key: string,
-  ...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>
-) => TE.TranscodeError
+export declare const errorAtKey: (key: string, ...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>) => any
 ```
 
 Added in v2.0.0
@@ -87,7 +81,7 @@ A failure case for a union member
 export declare const errorAtUnionMember: (
   member: string | number,
   ...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>
-) => TE.TranscodeError
+) => any
 ```
 
 Added in v2.0.0
@@ -97,7 +91,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const failure: <A>(e: TE.TranscodeErrors) => Either<TE.TranscodeErrors, A>
+export declare const failure: <A>(e: any) => any
 ```
 
 Added in v2.0.0
@@ -109,7 +103,7 @@ A failure case for a serialization or deserialization error
 **Signature**
 
 ```ts
-export declare const serializationError: (expected: string, error: unknown, actual: unknown) => TE.TranscodeError
+export declare const serializationError: (...args: ConstructorParameters<typeof TE.SerializationError>) => any
 ```
 
 Added in v2.0.0
@@ -119,7 +113,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const success: <A>(a: A) => Either<TE.TranscodeErrors, A>
+export declare const success: <A>(a: A) => any
 ```
 
 Added in v2.0.0
@@ -131,7 +125,7 @@ A collection of failure cases
 **Signature**
 
 ```ts
-export declare const transcodeErrors: (...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>) => TE.TranscodeErrors
+export declare const transcodeErrors: (...errors: RNEA.ReadonlyNonEmptyArray<TE.TranscodeError>) => any
 ```
 
 Added in v2.0.0
@@ -143,7 +137,7 @@ A failure case for a value that does not match the expected type
 **Signature**
 
 ```ts
-export declare const typeMismatch: (expected: string, actual: unknown) => TE.TranscodeError
+export declare const typeMismatch: (...args: ConstructorParameters<typeof TE.TypeMismatch>) => any
 ```
 
 Added in v2.0.0
@@ -155,7 +149,7 @@ A failure case for an unexpected value
 **Signature**
 
 ```ts
-export declare const unexpectedValue: (actual: unknown) => TE.TranscodeError
+export declare const unexpectedValue: (...errors: ConstructorParameters<typeof TE.UnexpectedValue>) => any
 ```
 
 Added in v2.0.0
@@ -167,10 +161,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const drawErrorTree: (
-  errors: TE.TranscodeErrors,
-  configuration?: { readonly showHeading?: boolean | undefined } | undefined
-) => string
+export declare const drawErrorTree: (...params: Parameters<typeof TE.drawTree>) => string
 ```
 
 Added in v2.0.0
@@ -208,7 +199,7 @@ Interprets a schema as a decoder
 **Signature**
 
 ```ts
-export declare const deriveTranscoder: <I, O>(schema: Schema<I, O>) => Transcoder<I, O>
+export declare const deriveTranscoder: <I, O>(schema: any) => Transcoder<I, O>
 ```
 
 Added in v2.0.0

diff --git a/docs/TranscoderPar.md b/docs/TranscoderPar.md
@@ -1,6 +1,6 @@
 ---
 title: TranscoderPar.ts
-nav_order: 87
+nav_order: 88
 permalink: /transcoder-par/
 ---
 
@@ -42,7 +42,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const failure: <A>(e: TCE.TranscodeErrors) => TaskEither<TCE.TranscodeErrors, A>
+export declare const failure: <A>(e: any) => any
 ```
 
 Added in v2.0.0
@@ -52,7 +52,7 @@ Added in v2.0.0
 **Signature**
 
 ```ts
-export declare const success: <A>(a: A) => TaskEither<TCE.TranscodeErrors, A>
+export declare const success: <A>(a: A) => any
 ```
 
 Added in v2.0.0
@@ -90,7 +90,7 @@ Interprets a schema as a decoder
 **Signature**
 
 ```ts
-export declare const deriveTranscoderPar: <I, O>(schema: Schema<I, O>) => TranscoderPar<I, O>
+export declare const deriveTranscoderPar: <I, O>(schema: any) => TranscoderPar<I, O>
 ```
 
 Added in v2.0.0