@fabriciogferreira/schema-to-query-string 0.1.4 → 0.1.8

package/dist/for-tests.d.ts

@@ -0,0 +1,19 @@
+import z4 from "zod/v4";
+export declare const schemaForTest: z4.ZodObject<{
+    rootOne: z4.ZodString;
+    rootTwo: z4.ZodString;
+    rootObject: z4.ZodObject<{
+        subOne: z4.ZodNumber;
+        subTwo: z4.ZodNumber;
+    }, z4.core.$strip>;
+    rootNullableObject: z4.ZodNullable<z4.ZodObject<{
+        subOne: z4.ZodNumber;
+        subTwo: z4.ZodNumber;
+    }, z4.core.$strip>>;
+    rootArrayObject: z4.ZodArray<z4.ZodObject<{
+        subOne: z4.ZodNumber;
+        subTwo: z4.ZodNumber;
+    }, z4.core.$strip>>;
+}, z4.core.$strip>;
+export declare const expectedStringForTest = "fields[root]=rootOne,rootTwo&fields[rootObject]=subOne,subTwo&fields[rootNullableObject]=subOne,subTwo&fields[rootArrayObject]=subOne,subTwo&include=rootObject,rootNullableObject,rootArrayObject";
+export declare const expectedQueryStringForTest: string;

package/dist/for-tests.js

@@ -0,0 +1,19 @@
+import z4 from "zod/v4";
+export const schemaForTest = z4.object({
+    rootOne: z4.string(),
+    rootTwo: z4.string(),
+    rootObject: z4.object({
+        subOne: z4.number(),
+        subTwo: z4.number(),
+    }),
+    rootNullableObject: z4.object({
+        subOne: z4.number(),
+        subTwo: z4.number(),
+    }).nullable(),
+    rootArrayObject: z4.object({
+        subOne: z4.number(),
+        subTwo: z4.number(),
+    }).array(),
+});
+export const expectedStringForTest = "fields[root]=rootOne,rootTwo&fields[rootObject]=subOne,subTwo&fields[rootNullableObject]=subOne,subTwo&fields[rootArrayObject]=subOne,subTwo&include=rootObject,rootNullableObject,rootArrayObject";
+export const expectedQueryStringForTest = "?" + expectedStringForTest;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { schemaToQueryString } from './schema-to-query-string';
+export { schemaForTest, expectedStringForTest, expectedQueryStringForTest } from './for-tests';
+export type { schemaParam, rootResourceParam, includeParam, fieldsParam, SchemaToQueryStringConfig } from './types';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { schemaToQueryString } from './schema-to-query-string';
+export { schemaForTest, expectedStringForTest, expectedQueryStringForTest } from './for-tests';

package/dist/schema-to-query-string.d.ts

@@ -0,0 +1,5 @@
+import { fieldsParam, includeParam, rootResourceParam, schemaParam } from "./types";
+export declare const schemaToQueryString: (schema: schemaParam, rootResource: rootResourceParam, includeKey?: includeParam, fieldsKey?: fieldsParam) => {
+    string: string;
+    queryString: string;
+};

package/{src → dist}/schema-to-query-string.js

@@ -43,5 +43,10 @@ export const schemaToQueryString = (schema, rootResource, includeKey = "include"
     if (includes.size) {
         queryParts.push(`${includeKey}=${Array.from(includes).join(",")}`);
     }
-    return "?" + queryParts.join("&");
+    const string = queryParts.length ? queryParts.join("&") : "";
+    const queryString = string ? "?" + string : "";
+    return {
+        string,
+        queryString
+    };
 };

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+import { ZodObject } from "zod/v4";
+export type schemaParam = ZodObject;
+export type rootResourceParam = string;
+export type includeParam = string;
+export type fieldsParam = string;
+export type SchemaToQueryStringConfig = {
+    schema: schemaParam;
+    rootResource: rootResourceParam;
+    includeKey?: includeParam;
+    fieldsKey?: fieldsParam;
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,13 +1,19 @@
 {
 	"name": "@fabriciogferreira/schema-to-query-string",
-	"version": "0.1.4",
+	"version": "0.1.8",
+	"description": "Function for convert schema to Spatie Laravel Query Builder",
 	"type": "module",
 	"license": "MIT",
-	"author": "Fabrício G. Ferreira <fabriciof481@gmail.com>",
-	"description": "Function for convert schema to Spatie Laravel Query Builder",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
 	"files": [
-		"src",
-		"./index.ts"
+		"dist"
 	],
 	"keywords": [
 		"conversion",
@@ -23,13 +29,13 @@
 		"test": "bun test",
 		"prepublishOnly": "bun run build"
 	},
+	"peerDependencies": {
+		"zod": "^4.3.5"
+	},
 	"devDependencies": {
-		"bun-types": "^1.3.5",
 		"typescript": "^5.9.3",
+		"bun-types": "^1.3.5",
 		"fast-cartesian": "^9.0.1",
 		"js-combinatorics": "^2.1.2"
-	},
-	"dependencies": {
-		"zod": "^4.3.5"
 	}
 }

package/index.ts

@@ -1 +0,0 @@
-export { schemaToQueryString } from './src';

package/src/index.js

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

package/src/index.ts

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

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

@@ -1,76 +0,0 @@
-//* 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("&");
-};