Merge pull request #60 from ferflores507/dev

Dev

Author: ferflores507

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ferflores507/object-builder",
-  "version": "9.8.1",
+  "version": "9.9.0",
   "main": "index.js",
   "scripts": {
     "test": "vitest"

src/builders/Operators.ts

@@ -1,4 +1,4 @@
-import { Builder, ChildrenSchema, OperatorTask, Propiedades, Schema, SchemaDefinition, WithTaskOptions } from "../models"
+import { Builder, ChildrenSchema, DebounceOptions, DebounceSchema, OperatorTask, Propiedades, RequestInitWithUrl, RequestPlainOptions, Schema, SchemaDefinition, WithTaskOptions } from "../models"
 import { reduceRequest, type RequestInfo } from "../helpers/requestHelper"
 
 import {
@@ -10,8 +10,6 @@ import {
     formatSortOptions,
     Path,
     removeAccents,
-    RequestInitWithUrl,
-    type RequestPlainOptions,
     sortCompare,
     type SortOptions,
     spread,
@@ -56,8 +54,26 @@ export class Operators implements WithTaskOptions<Operators> {
     date = (value: any, options: Intl.DateTimeFormatOptions & { locale: string }) => {
         return new Date(value).toLocaleString(options.locale, options)
     }
-    debounce = (fn: (...args: []) => any, ms: number | true) => {
-        return createDebounce(fn, ms === true ? 500 : ms)
+    debounce = (fn: Function, ms: number | true | Function) => {
+        if(typeof ms == "function") {
+            fn = ms
+            ms = true
+        }
+
+        return createDebounce(fn, typeof ms == "number" ? ms : 500)
+    }
+    debounceWith = {
+        transform: ({ function: fn, ms, target }: DebounceSchema) => {
+            return {
+                propiedades: {
+                    function: target ? target : { function: fn },
+                    ms
+                }
+            }
+        },
+        task: (initial: any, { function: fn, ms }: DebounceOptions) => {
+            return this.debounce(fn, ms)
+        }
     }
     entries = entries
     spreadStart = (target: any[], value: any) => {
@@ -131,8 +147,9 @@ export class Operators implements WithTaskOptions<Operators> {
         },
         task: (initial: Record<string, any>, current: Record<string, any>) => current
     }
-    request = (initial: any, options: RequestPlainOptions) => {
-        return buildRequest(options)
+    request = {
+        transform: (propiedades: Propiedades) => ({ propiedades }),
+        task: (initial: any, options: RequestPlainOptions) => buildRequest(options)
     }
     reduceFetch = (requestInit: RequestInitWithUrl, id: any, builder: Builder) => {
         const requestInfo: RequestInfo = {

src/helpers/varios.ts

@@ -1,4 +1,4 @@
-type Modify<T, R> = Omit<T, keyof R> & R;
+import { RequestInitWithUrl, RequestPlainOptions } from "../models"
 
 export const fetchHelper = async (request: RequestInitWithUrl, init?: RequestInit) => {
     // Verify if its ok to add signal in 2nd param object or spread to request
@@ -14,22 +14,12 @@ export const fetchHelper = async (request: RequestInitWithUrl, init?: RequestIni
     return response.json()
 }
 
-export type RequestPlainOptions = Modify<Partial<Request>, {
-    url: string
-    contentType?: typeof applicationJson
-    query?: Record<string, any>
-    body?: Record<string, any>
-    formData?: Record<string, any>
-}>
-
 export const urlWithCleanQueryString = (url: string, query: Record<string, any>) => {
     const queryString = new URLSearchParams(removeNullOrUndefined(query)).toString()
 
     return url + (queryString && "?") + queryString
 }
 
-export type RequestInitWithUrl = Modify<RequestInit, { url: string }>
-
 export class RequestWithUrl extends Request {
     constructor(input: RequestInitWithUrl) {
         super(input.url, input)
@@ -99,7 +89,7 @@ const argsPairFn = () => {
 
 export const argsPair = argsPairFn()
 
-export const createDebounce = (callback: (...args: any[]) => any, ms: number) => {
+export const createDebounce = (callback: Function, ms: number) => {
     let timeoutId: NodeJS.Timeout
 
     return (...args: any[]) => {

src/models.ts

@@ -1,5 +1,31 @@
 import { Path } from "./helpers/varios"
 
+type Modify<T, R> = Omit<T, keyof R> & R;
+
+export type RequestInitWithUrl = Modify<RequestInit, { url: string }>
+
+export type RequestPlainOptions = { url: string } & Partial<Modify<Request, {
+    contentType: string
+    query: Record<string, unknown>
+    body: Record<string, any>
+    formData: Record<string, any>
+}>>
+
+export type RequestPlainOptionsSchema = { url: Schema }
+    & {
+        [P in keyof RequestPlainOptions]: Schema
+    }
+    & Partial<{
+        body: SchemaDefinition
+        formData: SchemaDefinition
+    }>
+
+export type RequestSchema = {
+    [P in keyof RequestPlainOptionsSchema]: RequestPlainOptions[P] | RequestPlainOptionsSchema[P]
+} & { 
+    $bind?: Schema 
+}
+
 export type ChildrenSchema = Partial<{
     setup: SchemaDefinition
     schema: SchemaDefinition
@@ -85,6 +111,20 @@ export type SchemaDefinition = Schema | { [n: number]: Schema | SchemaPrimitive
 
 export type SchemaPrimitive = string | number | bigint | boolean | null
 export type Propiedades = Record<string, SchemaDefinition | SchemaPrimitive>
+export type DebounceOptions = {
+    function: Function
+    ms: number
+}
+
+export type DebounceSchema = {
+    ms: SchemaDefinition | number
+} & ({
+    function: SchemaDefinition
+    target?: undefined
+} | {
+    function?: undefined
+    target: SchemaDefinition
+})
 
 export type Schema = Partial<{
     allEqual: boolean
@@ -104,6 +144,7 @@ export type Schema = Partial<{
     const: any
     date: Schema | SchemaPrimitive
     debounce: Schema | SchemaPrimitive
+    debounceWith: DebounceSchema
     decrement: string
     default: SchemaDefinition | SchemaPrimitive
     definitions: (Schema | SchemaPrimitive)[]
@@ -150,7 +191,7 @@ export type Schema = Partial<{
     reduce: SchemaDefinition
     reduceOrDefault: SchemaDefinition
     removeAccents: true
-    request: Schema
+    request: RequestSchema
     reduceFetch: Schema | SchemaPrimitive
     required: string[]
     schemaFrom: SchemaDefinition

tests/schema/mixed.test.ts

@@ -585,12 +585,10 @@ test.skip("expect api response", async () => {
       reduce: [
         {
           request: {
-            propiedades: {
-              url: "https://api.the-odds-api.com/v4/sports",
-              query: {
-                propiedades: {
-                  apiKey: process.env.ODDS_API_KEY!
-                }
+            url: "https://api.the-odds-api.com/v4/sports",
+            query: {
+              propiedades: {
+                apiKey: process.env.ODDS_API_KEY!
               }
             }
           },
@@ -1704,24 +1702,63 @@ describe("debounce", function () {
   beforeEach(() => vi.useFakeTimers());
   afterEach(() => vi.useRealTimers());
 
-  it("expects function call to set arg as 'store.nombre' value", () => {
-    const builder = new ObjectBuilder()
-      .with({
-        schema: {
+  describe("function call", () => {
+    const schemas: Schema[] = [
+      {
+        debounce: {
           function: {
             set: "nombre"
-          },
-          debounce: true
+          }
         }
-      })
-
-    const debounceSet = builder.build()
-
-    debounceSet("Melany")
-    
-    vi.runAllTimers()
+      },
+      {
+        function: {
+          set: "nombre"
+        },
+        debounce: true
+      },
+      {
+        debounceWith: {
+          ms: 1000,
+          function: {
+            set: "nombre"
+          }
+        }
+      },
+      {
+        reduce: [
+          {
+            set: [
+              "setNombre",
+              {
+                function: {
+                  set: "nombre"
+                }
+              }
+            ]
+          },
+          {
+            debounceWith: {
+              ms: 1000,
+              target: {
+                path: "setNombre"
+              }
+            }
+          }
+        ]
+      }
+    ]
 
-    expect(builder.options.store.nombre).toBe("Melany")
+    it.each(schemas)("expects function call to set arg as 'store.nombre' value", schema => {
+      const builder = new ObjectBuilder().with({ schema })
+      const debounceSet = builder.build()
+  
+      debounceSet("Melany")
+      
+      vi.runAllTimers()
+  
+      expect(builder.options.store.nombre).toBe("Melany")
+    })
   })
 
   const cases = [true, 300, 1000] as const

tests/schemaServer.test.ts

@@ -69,7 +69,7 @@ describe("reduce fetch check requests length after each request", async () => {
         store,
         schema: {
           request: {
-            propiedades: { url }
+            url
           },
           reduceFetch: id
         }
@@ -90,9 +90,7 @@ test("reduce fetch", async () => {
   const result = await new ObjectBuilder()
     .withSchema({
       request: {
-        propiedades: {
-          url: "http://localhost:8000/numeros"
-        }
+        url: "http://localhost:8000/numeros"
       },
       reduceFetch: 1
     })
@@ -107,9 +105,7 @@ test("schema request", async () => {
   const request = new ObjectBuilder()
     .withSchema({
       request: {
-        propiedades: {
-          url: "http://localhost:8000/numeros"
-        }
+        url: "http://localhost:8000/numeros"
       }
     })
     .build()

tsconfig.json

@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
         "strict": true,
-        "target": "ES2024"
+        "target": "ES2024",
+        "moduleResolution": "node"
     }
 }