Version 1.0.48 (#1435)

* Parser: Prevent Socket.Dev Warning

* ChangeLog

* Version

* Documentation

Author: sinclairzx81

changelog/1.0.0.md

@@ -3,6 +3,8 @@
 ---
 
 ### Version Updates
+- [Revision 1.0.48](https://github.com/sinclairzx81/typebox/pull/1435)
+  - Resolve Socket.Dev False Positive | Function Signature Parser
 - [Revision 1.0.47](https://github.com/sinclairzx81/typebox/pull/1434)
   - Fix ReadonlyType Fallthrough Case for Non-Mappable types.
 - [Revision 1.0.46](https://github.com/sinclairzx81/typebox/pull/1432)

design/syntax/syntax.ts

@@ -281,7 +281,7 @@ const Base = Runtime.Union([
   Runtime.Ref('TemplateLiteral'),
   Runtime.Ref('Literal'),
   Runtime.Ref('Constructor'),
-  Runtime.Ref('Function'),
+  Runtime.Ref('_Function_'),
   Runtime.Ref('Mapped'),
   Runtime.Ref('Options'),
   Runtime.Ref('GenericCall'),
@@ -577,9 +577,9 @@ const Constructor = Runtime.Tuple([
   Runtime.Ref('Type')
 ])
 // ------------------------------------------------------------------
-// Function
+// _Function_
 // ------------------------------------------------------------------
-const Function = Runtime.Tuple([
+const _Function_ = Runtime.Tuple([
   Runtime.Const(LParen),
   Runtime.Ref('ParameterList'),
   Runtime.Const(RParen),
@@ -993,7 +993,7 @@ export const SyntaxModule = new Runtime.Module({
   ParameterBase,
   Parameter,
   ParameterList,
-  Function,
+  _Function_,
   Constructor,
 
   MappedReadonly,

design/website/docs/script/overview.md

@@ -1,10 +1,10 @@
 # Script
 
-TypeScript Runtime Scripting Engine
+Parse TypeScript into Json Schema
 
 ## Overview
 
-TypeBox can translate TypeScript syntax into Json Schema. The Script function is a fully type-safe, syntactic frontend to the TypeBox type builder API, allowing Json Schema to be constructed and mapped using TypeScript type expressions encoded as strings.
+TypeBox can parse TypeScript syntax into Json Schema. The Script function is designed to be syntactic frontend to the TypeBox type builder API, enabling Json Schema to be both constructed and mapped using TypeScript type expressions encoded in template literal strings.
 
 ### Example
 

docs/docs/script/overview.html

@@ -1,7 +1,7 @@
 <h1>Script</h1>
-<p>TypeScript Runtime Scripting Engine</p>
+<p>Parse TypeScript into Json Schema</p>
 <h2>Overview</h2>
-<p>TypeBox can translate TypeScript syntax into Json Schema. The Script function is a fully type-safe, syntactic frontend to the TypeBox type builder API, allowing Json Schema to be constructed and mapped using TypeScript type expressions encoded as strings.</p>
+<p>TypeBox can parse TypeScript syntax into Json Schema. The Script function is designed to be syntactic frontend to the TypeBox type builder API, enabling Json Schema to be both constructed and mapped using TypeScript type expressions encoded in template literal strings.</p>
 <h3>Example</h3>
 <p>The following uses Script to construct and map Json Schema.</p>
 <pre><code class="language-typescript">import Type from &#39;typebox&#39;

src/type/script/mapping.ts

@@ -528,7 +528,7 @@ export function ExtendsMapping(input: [unknown, unknown, unknown, unknown, unkno
     : []
 }
 // -------------------------------------------------------------------
-// Base: ['(', Type, ')'] | Keyword | _Object_ | Tuple | TemplateLiteral | Literal | Constructor | Function | Mapped | Options | GenericCall | Reference
+// Base: ['(', Type, ')'] | Keyword | _Object_ | Tuple | TemplateLiteral | Literal | Constructor | _Function_ | Mapped | Options | GenericCall | Reference
 // -------------------------------------------------------------------
 export type TBaseMapping<Input extends [unknown, unknown, unknown] | unknown> = (
   Input extends ['(', infer Type extends T.TSchema, ')'] ? Type :
@@ -1076,14 +1076,14 @@ export function ParameterListMapping(input: [unknown, unknown]): unknown {
   return Delimited(input)
 }
 // -------------------------------------------------------------------
-// Function: ['(', ParameterList, ')', '=>', Type]
+// _Function_: ['(', ParameterList, ')', '=>', Type]
 // -------------------------------------------------------------------
-export type TFunctionMapping<Input extends [unknown, unknown, unknown, unknown, unknown]> = (
+export type T_Function_Mapping<Input extends [unknown, unknown, unknown, unknown, unknown]> = (
   Input extends ['(', infer ParameterList extends T.TSchema[], ')', '=>', infer ReturnType extends T.TSchema]
     ? T.TFunction<ParameterList, ReturnType>
     : never
 )
-export function FunctionMapping(input: [unknown, unknown, unknown, unknown, unknown]): unknown {
+export function _Function_Mapping(input: [unknown, unknown, unknown, unknown, unknown]): unknown {
   return T.Function(input[1] as T.TSchema[], input[4] as T.TSchema)
 }
 // -------------------------------------------------------------------

src/type/script/parser.ts

@@ -8,7 +8,7 @@ import { Range } from './task/range/index.ts'
 import { Metrics } from './task/metrics/index.ts'
 import { Task } from 'tasksmith'
 
-const Version = '1.0.47'
+const Version = '1.0.48'
 
 // ------------------------------------------------------------------
 // Build

tasks.ts

@@ -22,6 +22,7 @@ Test('Should KeyOf 2', () => {
     y: Type.Number(),
     z: Type.Number()
   })
+  // DENO_CACHE_ERROR
   const T: Type.TUnion<[
     Type.TLiteral<'x'>,
     Type.TLiteral<'y'>,
@@ -59,6 +60,7 @@ Test('Should KeyOf 5', () => {
     Type.Object({ y: Type.Number() }),
     Type.Object({ z: Type.Number() })
   ])
+  // DENO_CACHE_ERROR
   const T: Type.TUnion<[
     Type.TLiteral<'x'>,
     Type.TLiteral<'y'>,
@@ -100,6 +102,7 @@ Test('Should KeyOf 8', () => {
       Type.Object({ z: Type.Number() })
     ])
   ])
+  // DENO_CACHE_ERROR
   const T: Type.TUnion<[Type.TLiteral<'x'>, Type.TLiteral<'b'>]> = Type.KeyOf(A)
   Assert.IsTrue(Type.IsUnion(T))
   Assert.IsEqual(T.anyOf[0].const, 'x')
@@ -114,6 +117,7 @@ Test('Should KeyOf 9', () => {
       Type.Object({ z: Type.Number() })
     ])
   ]))
+  // DENO_CACHE_ERROR
   const T: Type.TUnion<[Type.TLiteral<'x'>, Type.TLiteral<'b'>]> = Type.KeyOf(A)
   Assert.IsTrue(Type.IsUnion(T))
   Assert.IsEqual(T.anyOf[0].const, 'x')
@@ -173,6 +177,7 @@ Test('Should KeyOf 12', () => {
     Type.Object({ x: Type.Number(), y: Type.String() }),
     Type.Object({ x: Type.Number(), y: Type.String() })
   ]))
+  // DENO_CACHE_ERROR
   const T: Type.TUnion<[Type.TLiteral<'x'>, Type.TLiteral<'y'>]> = Type.KeyOf(A)
   Assert.IsTrue(Type.IsUnion(T))
   Assert.IsEqual(T.anyOf[0].const, 'x')