@fabriciogferreira/schema-to-query-string 0.1.0 → 0.1.2

package/package.json

@@ -1,14 +1,22 @@
 {
 	"name": "@fabriciogferreira/schema-to-query-string",
-	"description": "function for convert schema to Spatie Laravel Query Builder",
-	"version": "0.1.0",
-	"private": false,
-	"main": "dist/index.cjs",
-	"module": "dist/index.js",
-	"types": "dist/index.d.ts",
+	"version": "0.1.2",
+	"type": "module",
+	"license": "MIT",
+	"author": "Fabrício G. Ferreira <fabriciof481@gmail.com>",
+	"description": "Function for convert schema to Spatie Laravel Query Builder",
 	"files": [
-		"dist"
+		"src"
 	],
+	"keywords": [
+		"conversion",
+		"schema",
+		"query string"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/fabriciogferreira/schema-to-query-string"
+	},
 	"scripts": {
 		"build": "tsc",
 		"test": "bun test",

package/src/index.js

@@ -0,0 +1 @@
+export { schemaToQueryString } from './schema-to-query-string';

package/src/index.ts

@@ -0,0 +1 @@
+export { schemaToQueryString } from './schema-to-query-string';

package/src/schema-to-query-string.js

@@ -0,0 +1,47 @@
+//* Libraries imports
+import { ZodArray, ZodNullable, ZodObject } from "zod/v4";
+export const schemaToQueryString = (schema, rootResource, includeKey = "include", fieldsKey = "fields") => {
+    const fields = {};
+    const includes = new Set();
+    fields[rootResource] = [];
+    const walk = (currentSchema, resourcePath) => {
+        const currentFieldsKey = resourcePath ?? rootResource;
+        if (!fields[currentFieldsKey]) {
+            fields[currentFieldsKey] = [];
+        }
+        for (const key in currentSchema.shape) {
+            let rawField = currentSchema.shape[key];
+            if (rawField instanceof ZodNullable) {
+                rawField = rawField.unwrap();
+            }
+            if (rawField instanceof ZodObject || rawField instanceof ZodArray) {
+                let nextPath = resourcePath
+                    ? `${resourcePath}.${key}`
+                    : key;
+                includes.add(nextPath);
+                // ARRAY
+                if (rawField instanceof ZodArray) {
+                    rawField = rawField.unwrap();
+                }
+                // OBJETO
+                if (rawField instanceof ZodObject) {
+                    walk(rawField, nextPath);
+                }
+                continue;
+            }
+            // CAMPO SIMPLES
+            fields[currentFieldsKey].push(key);
+        }
+    };
+    walk(schema, null);
+    const queryParts = [];
+    for (const resource in fields) {
+        if (fields[resource].length > 0) {
+            queryParts.push(`${fieldsKey}[${resource}]=${fields[resource].join(",")}`);
+        }
+    }
+    if (includes.size) {
+        queryParts.push(`${includeKey}=${Array.from(includes).join(",")}`);
+    }
+    return "?" + queryParts.join("&");
+};

package/src/schema-to-query-string.ts

@@ -0,0 +1,76 @@
+//* Libraries imports
+import { ZodArray, ZodNullable, ZodObject } from "zod/v4";
+
+export const schemaToQueryString = (
+  schema: ZodObject,
+  rootResource: string,
+	includeKey: string = "include",
+	fieldsKey: string = "fields"
+) => {
+  const fields: Record<string, string[]> = {};
+  const includes = new Set<string>();
+
+  fields[rootResource] = [];
+
+  const walk = (
+    currentSchema: ZodObject,
+    resourcePath: string | null
+  ) => {
+    const currentFieldsKey = resourcePath ?? rootResource;
+
+    if (!fields[currentFieldsKey]) {
+      fields[currentFieldsKey] = [];
+    }
+
+    for (const key in currentSchema.shape) {
+      let rawField = currentSchema.shape[key];
+      
+			if (rawField instanceof ZodNullable) {
+				rawField = rawField.unwrap()
+			}
+      
+			if (rawField instanceof ZodObject || rawField instanceof ZodArray) {
+				let nextPath = resourcePath
+					? `${resourcePath}.${key}`
+					: key;
+
+        includes.add(nextPath);
+				
+				// ARRAY
+				if (rawField instanceof ZodArray) {
+					rawField = rawField.unwrap()
+				}
+				
+				// OBJETO
+				if (rawField instanceof ZodObject) {
+					walk(rawField, nextPath);
+				}
+
+				continue;
+			}
+
+      // CAMPO SIMPLES
+      fields[currentFieldsKey].push(key);
+    }
+  };
+
+  walk(schema, null);
+
+  const queryParts: string[] = [];
+
+	for (const resource in fields) {
+    if (fields[resource].length > 0) {
+      queryParts.push(
+        `${fieldsKey}[${resource}]=${fields[resource].join(",")}`
+      );
+    }
+  }
+
+  if (includes.size) {
+    queryParts.push(
+      `${includeKey}=${Array.from(includes).join(",")}`
+    );
+  }
+
+  return "?" + queryParts.join("&");
+};