@kalutskii/foundation 0.5.2 → 0.6.2

package/dist/index.d.ts

@@ -42,15 +42,15 @@ type FetchResult<T> = {
     data: null;
 };
 
+type QueryPrimitive = string | number | boolean | bigint | Date | null | undefined;
 /**
- * Type utility that recursively transforms all Date fields to string, as well as handling arrays and objects.
- * This is necessary for proper typing when working with RPC, as JSON does not support the Date type directly.
- * Example usage: `SerializeDates<{ createdAt: Date; nested: { updatedAt: Date }; tags: Date[] }>` \
- * = `{ createdAt: string; nested: { updatedAt: string }; tags: string[] }`
+ * Type utility that recursively transforms all fields to string, as well as handling arrays and objects.
+ * This is useful for serializing complex data structures into query parameters, which must be strings.
+ * Example usage: `AsQuery<{ id: number; name: string; tags: string[] }>` = `{ id: string; name: string; tags: string[] }`
  */
-type SerializeDates<T> = T extends Date ? string : T extends (infer U)[] ? SerializeDates<U>[] : T extends readonly (infer U)[] ? readonly SerializeDates<U>[] : T extends object ? {
-    [K in keyof T]: SerializeDates<T[K]>;
-} : T;
+type AsQuery<T> = T extends QueryPrimitive ? string : T extends readonly (infer Item)[] ? AsQuery<Item>[] : T extends object ? {
+    [Key in keyof T]: AsQuery<T[Key]>;
+} : string;
 
 /**
  * Wraps c.json with a typed success payload / (or void data) & possible APIError response.
@@ -59,7 +59,7 @@ type SerializeDates<T> = T extends Date ? string : T extends (infer U)[] ? Seria
 declare function respond<T extends object = Record<string, never>, S extends SuccessStatusCode = SuccessStatusCode>(c: Context, options: {
     status: S;
     data?: T;
-}): Response & TypedResponse<APISuccess<SerializeDates<T>> | APIError, S, 'json'>;
+}): Response & TypedResponse<APISuccess<AsQuery<T>> | APIError, S, 'json'>;
 
 /**
  * Factory for creating successful API responses with serializable data.
@@ -120,11 +120,11 @@ type PaginationOptions = z.infer<typeof paginationSchema>;
  *
  * ```ts
  * await db.query.someTable.findMany({
- *   ...getPagination(options),
+ *   ...refinePagination(options),
  * });
  * ```
  */
-declare const getPagination: (options?: PaginationOptions) => {
+declare const refinePagination: (options?: PaginationOptions) => {
     offset?: number | undefined;
     limit?: number | undefined;
 };
@@ -218,6 +218,7 @@ declare const log: {
 type Simplify<T> = {
     [K in keyof T]: T[K];
 } & {};
+
 /**
  * A utility type that represents a value that can be of type T or null.
  * Commonly used for optional fields in data models or function return types.
@@ -249,23 +250,17 @@ type XOR<T, U> = Simplify<T & {
 type AtLeastOne<T, Keys extends keyof T = keyof T> = Keys extends keyof T ? Simplify<Required<Pick<T, Keys>> & Partial<Omit<T, Keys>>> : never;
 
 /**
- * A Zod refinement function that ensures at least one of the specified keys in a Zod object schema is defined.
- * This is useful for validating input where at least one of several optional fields must be provided.
+ * Refines a Zod object schema to ensure that at least one of its keys is defined.
+ * This is useful for validating objects where at least one property must be present.
  *
  * ```ts
- * const mySchema = atLeastOneDefined(
- *   z.object({
- *     name: z.string().optional(),
- *     email: z.string().email().optional(),
- *     phone: z.string().optional(),
- *   })
- * );
- *
- * // Valid: { name: "Alice" }, { email: "alice@example.com" }, { phone: "123-456-7890" }
- * // Invalid: {}, { name: undefined, email: undefined, phone: undefined }
+ * const mySchema = z.object({
+ *   a: z.string()
+ *   b: z.number()
+ * }).refine(atLeastOneDefined);
  * ```
  */
-declare const atLeastOneDefined: <T extends z.ZodRawShape>(schema: z.ZodObject<T>) => z.ZodObject<T, z.core.$strip>;
+declare const atLeastOneDefined: <T extends z.ZodRawShape>(schema: z.ZodObject<T>) => z.ZodType<AtLeastOne<z.infer<z.ZodObject<T>>>>;
 /**
  * Transforms a string to a number (when passing query parameters).
  * Example usage: `asQueryNumber(z.number())('123') = 123`
@@ -277,16 +272,6 @@ declare const asQueryNumber: <T extends z.ZodNumber>(schema: T) => z.ZodPreproce
  */
 declare const asQueryBoolean: <T extends z.ZodTypeAny>(schema: T) => z.ZodPreprocess<T>;
 
-type QueryPrimitive = string | number | boolean | bigint | Date | null | undefined;
-/**
- * Type utility that recursively transforms all fields to string, as well as handling arrays and objects.
- * This is useful for serializing complex data structures into query parameters, which must be strings.
- * Example usage: `AsQuery<{ id: number; name: string; tags: string[] }>` = `{ id: string; name: string; tags: string[] }`
- */
-type AsQuery<T> = T extends QueryPrimitive ? string : T extends readonly (infer Item)[] ? AsQuery<Item>[] : T extends object ? {
-    [Key in keyof T]: AsQuery<T[Key]>;
-} : string;
-
 /** Options for configuring the JWT service. */
 type JWTServiceOptions = {
     /** The algorithm to use for signing and verifying JWTs. Defaults to 'HS256'. */
@@ -335,4 +320,4 @@ declare class ZodJWTService<TPayloadOrSchema> {
     verifyOrThrow(token: string, secret: string): Promise<Payload<TPayloadOrSchema>>;
 }
 
-export { type APIContractData, type APIContractError, type APIContractResult, type APIError, type APISuccess, type AsQuery, type AtLeastOne, EXCEPTION_STATUS_CODES, type ExceptionStatusCode, type FetchResult, type JWTServiceOptions, type JWTSignOptions, type MeasuredExecution, type PaginationOptions, type Payload, type PayloadSchema, SUCCESS_STATUS_CODES, type SerializeDates, type Simplify, type SuccessStatusCode, type XOR, ZodJWTService, asQueryBoolean, asQueryNumber, atLeastOneDefined, failure, fetchAndThrow, fetchSafely, formatTime, generateRandomString, getColoredHTTPStatus, getFormattedDate, getFormattedTime, getPagination, getUTCOffset, getZonedTime, honoLoggingHandler, log, measureExecutionTime, onHandlerError, paginationSchema, respond, safeExecute, success };
+export { type APIContractData, type APIContractError, type APIContractResult, type APIError, type APISuccess, type AsQuery, type AtLeastOne, EXCEPTION_STATUS_CODES, type ExceptionStatusCode, type FetchResult, type JWTServiceOptions, type JWTSignOptions, type MeasuredExecution, type PaginationOptions, type Payload, type PayloadSchema, SUCCESS_STATUS_CODES, type Simplify, type SuccessStatusCode, type XOR, ZodJWTService, asQueryBoolean, asQueryNumber, atLeastOneDefined, failure, fetchAndThrow, fetchSafely, formatTime, generateRandomString, getColoredHTTPStatus, getFormattedDate, getFormattedTime, getUTCOffset, getZonedTime, honoLoggingHandler, log, measureExecutionTime, onHandlerError, paginationSchema, refinePagination, respond, safeExecute, success };

package/dist/index.js

@@ -137,8 +137,8 @@ var paginationSchema = z.object({
   limit: z.number().int().positive().optional()
 });
 
-// src/pagination/pagination.utilities.ts
-var getPagination = (options) => {
+// src/pagination/pagination.refiners.ts
+var refinePagination = (options) => {
   const pagination = {};
   if (options?.offset !== void 0) {
     pagination.offset = options.offset;
@@ -168,10 +168,16 @@ async function measureExecutionTime(execution) {
 
 // src/validation/validation.refiners.ts
 import z2 from "zod";
+
+// src/validation/validation.messages.ts
 var AT_LEAST_ONE_DEFINED_ERROR = (keys) => `At least one of the specified keys must be defined: ${keys.join(", ")}`;
+
+// src/validation/validation.refiners.ts
 var atLeastOneDefined = (schema) => {
   const keys = Object.keys(schema.shape);
-  return schema.refine((value) => keys.some((key) => value[key] !== void 0 && value[key] !== null), { message: AT_LEAST_ONE_DEFINED_ERROR(keys) });
+  return schema.partial().refine((value) => keys.some((key) => value[key] != null), {
+    message: AT_LEAST_ONE_DEFINED_ERROR(keys)
+  });
 };
 var asQueryNumber = (schema) => z2.preprocess((v) => typeof v === "string" ? Number(v) : v, schema);
 var asQueryBoolean = (schema) => {
@@ -254,7 +260,6 @@ export {
   getColoredHTTPStatus,
   getFormattedDate,
   getFormattedTime,
-  getPagination,
   getUTCOffset,
   getZonedTime,
   honoLoggingHandler,
@@ -262,6 +267,7 @@ export {
   measureExecutionTime,
   onHandlerError,
   paginationSchema,
+  refinePagination,
   respond,
   safeExecute,
   success

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kalutskii/foundation",
-  "version": "0.5.2",
+  "version": "0.6.2",
   "description": "Typescript collection of most common utilities, schemas and functions among private projects.",
   "type": "module",
   "repository": {