TypeBox Codegen
+ +Code Generation Tools for TypeBox
+ +
+
++ +
Code Generation Tools for TypeBox
+ +
+
+
+const Code = `
+export type T = {
+ x: number,
+ y: number,
+ z: number
+}
+`
+// ----------------------------------------------------------------------------
+//
+// TypeScriptToTypeBox
+//
+// Generates an immediate TypeScript to TypeBox type code transformation
+//
+// ----------------------------------------------------------------------------
+
+console.log('TypeScript To TypeBox', Codegen.TypeScriptToTypeBox.Generate(Code))
+
+// ----------------------------------------------------------------------------
+//
+// TypeScriptToModel
+//
+// Generates an in-memory TypeBox Type Model
+//
+// ----------------------------------------------------------------------------
+
+const model = Codegen.TypeScriptToModel.Generate(Code)
+
+// ----------------------------------------------------------------------------
+//
+// ModelToX
+//
+// The TypeBox Type Model can be passed to several generators which map the
+// Model into varying type representations.
+//
+// ----------------------------------------------------------------------------
+
+console.log('TypeBoxModel', model)
+console.log('Model To JsonSchema', Codegen.ModelToJsonSchema.Generate(model))
+console.log('Model To JavaScript', Codegen.ModelToJavaScript.Generate(model))
+console.log('Model To TypeScript', Codegen.ModelToTypeScript.Generate(model))
+console.log('Model To Valibot', Codegen.ModelToValibot.Generate(model))
+console.log('Model To Value', Codegen.ModelToValue.Generate(model))
+console.log('Model To Yup', Codegen.ModelToYup.Generate(model))
+console.log('Model To Zod', Codegen.ModelToZod.Generate(model))
+console.log('Model To ArkType', Codegen.ModelToArkType.Generate(model))
+```
## Running Local
@@ -22,8 +84,6 @@ $ npm format # prettier pass for `src` and `example`
$ npm clean # remove the `target` directory.
$ npm start # run the `example` script in node
-
-$ npm serve # run the `example` script in browser
```
## Formatting hook
diff --git a/src/common/encoder.ts b/src/common/encoder.ts
index a549e3c..55000c9 100644
--- a/src/common/encoder.ts
+++ b/src/common/encoder.ts
@@ -1,6 +1,6 @@
/*--------------------------------------------------------------------------
-@typebox/codegen
+@sinclair/typebox-codegen
The MIT License (MIT)
diff --git a/src/common/formatter.ts b/src/common/formatter.ts
index e52007a..daad6f6 100644
--- a/src/common/formatter.ts
+++ b/src/common/formatter.ts
@@ -1,6 +1,6 @@
/*--------------------------------------------------------------------------
-@typebox/codegen
+@sinclair/typebox-codegen
The MIT License (MIT)
diff --git a/src/common/index.ts b/src/common/index.ts
index 1e9d171..48da298 100644
--- a/src/common/index.ts
+++ b/src/common/index.ts
@@ -1,6 +1,6 @@
/*--------------------------------------------------------------------------
-@typebox/codegen
+@sinclair/typebox-codegen
The MIT License (MIT)
diff --git a/src/common/jsdoc.ts b/src/common/jsdoc.ts
index 68611ce..19e983f 100644
--- a/src/common/jsdoc.ts
+++ b/src/common/jsdoc.ts
@@ -1,6 +1,6 @@
/*--------------------------------------------------------------------------
-@typebox/codegen
+@sinclair/typebox-codegen
The MIT License (MIT)
diff --git a/src/index.ts b/src/index.ts
index 97885d4..fbd0418 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,6 +1,6 @@
/*--------------------------------------------------------------------------
-@typebox/codegen
+@sinclair/typebox-codegen
The MIT License (MIT)
diff --git a/src/model/index.ts b/src/model/index.ts
index d2302d0..89682ed 100644
--- a/src/model/index.ts
+++ b/src/model/index.ts
@@ -1,6 +1,6 @@
/*--------------------------------------------------------------------------
-@typebox/codegen
+@sinclair/typebox-codegen
The MIT License (MIT)
@@ -24,10 +24,14 @@ THE SOFTWARE.
---------------------------------------------------------------------------*/
+export * from './model-to-arktype'
+export * from './model-to-io-ts'
export * from './model-to-javascript'
export * from './model-to-json-schema'
export * from './model-to-typebox'
export * from './model-to-typescript'
+export * from './model-to-valibot'
export * from './model-to-value'
+export * from './model-to-yup'
export * from './model-to-zod'
export * from './model'
diff --git a/src/model/model-to-arktype.ts b/src/model/model-to-arktype.ts
new file mode 100644
index 0000000..3220d13
--- /dev/null
+++ b/src/model/model-to-arktype.ts
@@ -0,0 +1,266 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox-codegen
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+
+import { Formatter, PropertyEncoder } from '../common/index'
+import { TypeBoxModel } from './model'
+import * as Types from '@sinclair/typebox'
+
+// --------------------------------------------------------------------------
+// ModelToArkType
+// --------------------------------------------------------------------------
+export namespace ModelToArkType {
+ // ------------------------------------------------------------------------
+ // Constraints
+ // ------------------------------------------------------------------------
+ function Wrap(value: string) {
+ return `'${value}'`
+ }
+ function Unwrap(value: string) {
+ if (value.indexOf("'") !== 0) return value
+ return value.slice(1, value.length - 1)
+ }
+ // ------------------------------------------------------------------------
+ // Composite
+ // ------------------------------------------------------------------------
+ function RequiresType(types: string[]) {
+ return types.some((type) => type.indexOf("'") !== 0)
+ }
+ function Composite(types: string[], operator: string) {
+ if (RequiresType(types)) {
+ const mapped = types.join(`, '${operator}', `)
+ return `[${mapped}]`
+ } else {
+ const mapped = types.map((type) => Unwrap(type)).join(` ${operator} `)
+ return Wrap(mapped)
+ }
+ }
+ // ------------------------------------------------------------------------
+ // Constraints
+ // ------------------------------------------------------------------------
+ function ConstrainedSequenceType(type: string, options: { minimum?: number; maximum?: number }) {
+ if (IsDefined