@naturalcycles/js-lib 15.68.0 → 15.70.0

package/dist/promise/pProps.js

@@ -14,7 +14,5 @@
  */
 export async function pProps(input) {
     const keys = Object.keys(input);
-    // `as any` here is added to make it compile when `noUncheckedIndexedAccess` is false
-    // oxlint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
     return Object.fromEntries((await Promise.all(Object.values(input))).map((v, i) => [keys[i], v]));
 }

package/dist/string/regex.js

@@ -3,4 +3,4 @@
  *
  * Source: https://regexr.com/3e48o
  */
-export const SIMPLE_EMAIL_REGEX = /^[\w-.]+@([\w-]+\.)+[\w-]{2,4}$/;
+export const SIMPLE_EMAIL_REGEX = /^[\w\-.]+@([\w-]+\.)+[\w-]{2,4}$/;

package/dist/types.d.ts

@@ -84,6 +84,14 @@ export type AnyAsyncFunction<T = any> = (...args: any[]) => Promise<T>;
 export type AsyncFunction<T = any> = () => Promise<T>;
 export type AnyPromisableFunction<T = any> = (...args: any[]) => Promisable<T>;
 export type PromisableFunction<T = any> = () => Promisable<T>;
+export type AnySyncFunction<T = any> = (...args: any[]) => NotPromise<T>;
+export type SyncFunction<T = any> = () => NotPromise<T>;
+/**
+ * Compile-time guard against accidentally returning a Promise from a sync context.
+ * Example usage: `fn: () => NotPromise<T>`
+ * This would fail if fn returns a Promise (e.g an async function).
+ */
+export type NotPromise<T> = [T] extends [PromiseLike<any>] ? never : T;
 /**
  * A function that lazily calculates something.
  */

package/package.json

@@ -1,20 +1,16 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.68.0",
+  "version": "15.70.0",
   "dependencies": {
     "tslib": "^2"
   },
   "peerDependencies": {
-    "undici": "^7",
-    "zod": "^4"
+    "undici": "^7"
   },
   "peerDependenciesMeta": {
     "undici": {
       "optional": true
-    },
-    "zod": {
-      "optional": true
     }
   },
   "devDependencies": {
@@ -52,8 +48,7 @@
     "./semver": "./dist/semver.js",
     "./string": "./dist/string/index.js",
     "./string/*.js": "./dist/string/*.js",
-    "./types": "./dist/types.js",
-    "./zod": "./dist/zod/index.js"
+    "./types": "./dist/types.js"
   },
   "files": [
     "dist",

package/src/promise/pProps.ts

@@ -16,9 +16,5 @@ export async function pProps<T>(input: { [K in keyof T]: T[K] | Promise<T[K]> })
   [K in keyof T]: Awaited<T[K]>
 }> {
   const keys = Object.keys(input)
-  // `as any` here is added to make it compile when `noUncheckedIndexedAccess` is false
-  // oxlint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-  return Object.fromEntries(
-    (await Promise.all(Object.values(input))).map((v, i) => [keys[i], v]),
-  ) as any
+  return Object.fromEntries((await Promise.all(Object.values(input))).map((v, i) => [keys[i], v]))
 }

package/src/string/regex.ts

@@ -3,4 +3,4 @@
  *
  * Source: https://regexr.com/3e48o
  */
-export const SIMPLE_EMAIL_REGEX = /^[\w-.]+@([\w-]+\.)+[\w-]{2,4}$/
+export const SIMPLE_EMAIL_REGEX = /^[\w\-.]+@([\w-]+\.)+[\w-]{2,4}$/

package/src/types.ts

@@ -105,6 +105,16 @@ export type AnyAsyncFunction<T = any> = (...args: any[]) => Promise<T>
 export type AsyncFunction<T = any> = () => Promise<T>
 export type AnyPromisableFunction<T = any> = (...args: any[]) => Promisable<T>
 export type PromisableFunction<T = any> = () => Promisable<T>
+export type AnySyncFunction<T = any> = (...args: any[]) => NotPromise<T>
+export type SyncFunction<T = any> = () => NotPromise<T>
+
+/**
+ * Compile-time guard against accidentally returning a Promise from a sync context.
+ * Example usage: `fn: () => NotPromise<T>`
+ * This would fail if fn returns a Promise (e.g an async function).
+ */
+export type NotPromise<T> = [T] extends [PromiseLike<any>] ? never : T
+
 /**
  * A function that lazily calculates something.
  */

package/dist/zod/customZod.d.ts

@@ -1,6 +0,0 @@
-import { z as z4, ZodType } from 'zod';
-import { customZodSchemas } from './zod.shared.schemas.js';
-type ExtendedZod = Omit<typeof z4, keyof typeof customZodSchemas | 'iso'> & typeof customZodSchemas;
-declare const z: ExtendedZod;
-type zInfer<T> = z4.infer<T>;
-export { z, type zInfer, ZodType };

package/dist/zod/customZod.js

@@ -1,4 +0,0 @@
-import { z as z4, ZodType } from 'zod';
-import { customZodSchemas } from './zod.shared.schemas.js';
-const z = { ...z4, ...customZodSchemas };
-export { z, ZodType };

package/dist/zod/index.d.ts

@@ -1,3 +0,0 @@
-export * from './customZod.js';
-export * from './zod.shared.schemas.js';
-export * from './zod.util.js';

package/dist/zod/index.js

@@ -1,3 +0,0 @@
-export * from './customZod.js';
-export * from './zod.shared.schemas.js';
-export * from './zod.util.js';

package/dist/zod/zod.shared.schemas.d.ts

@@ -1,46 +0,0 @@
-import type { ZodString } from 'zod';
-import { z } from 'zod';
-import type { IANATimezone, IsoDate, UnixTimestamp, UnixTimestampMillis } from '../types.js';
-type ZodBranded<T, B> = T & Record<'_zod', Record<'output', B>>;
-export type ZodBrandedString<B> = ZodBranded<z.ZodString, B>;
-export type ZodBrandedInt<B> = ZodBranded<z.ZodInt, B>;
-export type ZodBrandedNumber<B> = ZodBranded<z.ZodNumber, B>;
-export type ZodBrandedIsoDate = ZodBranded<z.ZodISODate, IsoDate>;
-declare function unixTimestamp(): ZodBrandedInt<UnixTimestamp>;
-declare function unixTimestamp2000(): ZodBrandedInt<UnixTimestamp>;
-declare function unixTimestampMillis(): ZodBranded<z.ZodNumber, UnixTimestampMillis>;
-declare function unixTimestampMillis2000(): ZodBrandedInt<UnixTimestampMillis>;
-declare function semVer(): z.ZodString;
-declare function isoDate(): ZodBrandedString<IsoDate>;
-declare function base62(): z.ZodString;
-declare function base64(): z.ZodString;
-declare function base64Url(): z.ZodString;
-declare function jwt(): z.ZodString;
-/**
- * "Slug" - a valid URL, filename, etc.
- */
-declare function slug(): z.ZodString;
-declare function ianaTimezone(): ZodBrandedString<IANATimezone>;
-type BaseDBEntityZodShape = {
-    id: ZodString;
-    created: ZodBrandedInt<UnixTimestamp>;
-    updated: ZodBrandedInt<UnixTimestamp>;
-};
-declare function dbEntity(): z.ZodObject<BaseDBEntityZodShape>;
-declare function dbEntity<T extends z.ZodRawShape>(shape: T): z.ZodObject<BaseDBEntityZodShape & T>;
-export declare const customZodSchemas: {
-    base62: typeof base62;
-    base64: typeof base64;
-    base64Url: typeof base64Url;
-    dbEntity: typeof dbEntity;
-    ianaTimezone: typeof ianaTimezone;
-    isoDate: typeof isoDate;
-    jwt: typeof jwt;
-    slug: typeof slug;
-    semver: typeof semVer;
-    unixTimestamp: typeof unixTimestamp;
-    unixTimestamp2000: typeof unixTimestamp2000;
-    unixTimestampMillis: typeof unixTimestampMillis;
-    unixTimestampMillis2000: typeof unixTimestampMillis2000;
-};
-export {};

package/dist/zod/zod.shared.schemas.js

@@ -1,101 +0,0 @@
-import { z } from 'zod';
-const TS_2500 = 16725225600; // 2500-01-01
-const TS_2000 = 946684800; // 2000-01-01
-function unixTimestamp() {
-    return z
-        .number()
-        .int()
-        .min(0)
-        .max(TS_2500, 'Must be a UnixTimestamp number')
-        .describe('UnixTimestamp');
-}
-function unixTimestamp2000() {
-    return z
-        .number()
-        .int()
-        .min(TS_2000)
-        .max(TS_2500, 'Must be a UnixTimestamp number after 2000-01-01')
-        .describe('UnixTimestamp2000');
-}
-function unixTimestampMillis() {
-    return z
-        .number()
-        .int()
-        .min(0)
-        .max(TS_2500 * 1000, 'Must be a UnixTimestampMillis number')
-        .describe('UnixTimestampMillis');
-}
-function unixTimestampMillis2000() {
-    return z
-        .number()
-        .int()
-        .min(TS_2000 * 1000)
-        .max(TS_2500 * 1000, 'Must be a UnixTimestampMillis number after 2000-01-01')
-        .describe('UnixTimestampMillis2000');
-}
-function semVer() {
-    return z
-        .string()
-        .regex(/^[0-9]+\.[0-9]+\.[0-9]+$/, 'Must be a SemVer string')
-        .describe('SemVer');
-}
-function isoDate() {
-    return z
-        .string()
-        .regex(/^\d{4}-\d{2}-\d{2}$/, { error: 'Must be a YYYY-MM-DD string' })
-        .describe('IsoDate');
-}
-const BASE62_REGEX = /^[a-zA-Z0-9]+$/;
-const BASE64_REGEX = /^[A-Za-z0-9+/]+={0,2}$/;
-const BASE64URL_REGEX = /^[\w\-/]+$/;
-function base62() {
-    return z.string().regex(BASE62_REGEX, 'Must be a base62 string').describe('Base62String');
-}
-function base64() {
-    return z.string().regex(BASE64_REGEX, 'Must be a base64 string').describe('Base64String');
-}
-function base64Url() {
-    return z.string().regex(BASE64URL_REGEX, 'Must be a base64url string').describe('Base64UrlString');
-}
-const JWT_REGEX = /^[\w-]+\.[\w-]+\.[\w-]+$/;
-function jwt() {
-    return z.string().regex(JWT_REGEX, 'Must be a JWT string').describe('JWTString');
-}
-/**
- * "Slug" - a valid URL, filename, etc.
- */
-function slug() {
-    return z
-        .string()
-        .regex(/^[a-z0-9-]{1,255}$/, 'Must be a slug string')
-        .describe('Slug');
-}
-function ianaTimezone() {
-    return z
-        // UTC is added to assist unit-testing, which uses UTC by default (not technically a valid Iana timezone identifier)
-        .enum([...Intl.supportedValuesOf('timeZone'), 'UTC'])
-        .describe('IANATimezone');
-}
-const baseDBEntitySchema = z.object({
-    id: z.string(),
-    created: unixTimestamp2000(),
-    updated: unixTimestamp2000(),
-});
-function dbEntity(shape) {
-    return baseDBEntitySchema.extend(shape ?? {});
-}
-export const customZodSchemas = {
-    base62,
-    base64,
-    base64Url,
-    dbEntity,
-    ianaTimezone,
-    isoDate,
-    jwt,
-    slug,
-    semver: semVer,
-    unixTimestamp,
-    unixTimestamp2000,
-    unixTimestampMillis,
-    unixTimestampMillis2000,
-};

package/dist/zod/zod.util.d.ts

@@ -1,13 +0,0 @@
-import type { ZodError, ZodType } from 'zod';
-import type { ErrorData } from '../error/error.model.js';
-import { AppError } from '../error/error.util.js';
-import type { ValidationFunction, ValidationFunctionResult } from '../validation/validation.js';
-export declare function getZodValidationFunction<T>(schema: ZodType<T>): ValidationFunction<T, ZodValidationError>;
-export declare function zIsValid<T>(value: unknown, schema: ZodType<T>): boolean;
-export declare function zValidate<T>(value: unknown, schema: ZodType<T>): T;
-export declare function zSafeValidate<T>(input: unknown, schema: ZodType<T>): ValidationFunctionResult<T, ZodValidationError>;
-export interface ZodValidationErrorData extends ErrorData {
-}
-export declare class ZodValidationError extends AppError<ZodValidationErrorData> {
-    constructor(zodError: ZodError, value: any, schema: ZodType);
-}

package/dist/zod/zod.util.js

@@ -1,54 +0,0 @@
-import { _assert } from '../error/assert.js';
-import { AppError } from '../error/error.util.js';
-import { _stringify } from '../string/stringify.js';
-export function getZodValidationFunction(schema) {
-    return (input, opt) => {
-        _assert(!opt?.mutateInput, 'mutateInput=true is not yet supported with Zod');
-        return zSafeValidate(input, schema);
-    };
-}
-export function zIsValid(value, schema) {
-    const { success } = schema.safeParse(value);
-    return success;
-}
-export function zValidate(value, schema) {
-    const [err, data] = zSafeValidate(value, schema);
-    if (err)
-        throw err;
-    return data;
-}
-export function zSafeValidate(input, schema
-// inputName?: string,
-) {
-    const r = schema.safeParse(input);
-    if (r.success) {
-        return [null, r.data];
-    }
-    return [new ZodValidationError(r.error, input, schema), r.data ?? input];
-}
-export class ZodValidationError extends AppError {
-    constructor(zodError, value, schema) {
-        const message = createZodErrorMessage(zodError, schema, value);
-        // const message = z.prettifyError(zodError) // todo: consider adopting it instead
-        super(message, {}, { name: 'ZodValidationError' });
-    }
-}
-function createZodErrorMessage(err, schema, value) {
-    let objectTitle = schema.description;
-    if (typeof value === 'object' && value) {
-        const inputName = schema.description || value.constructor?.name;
-        const inputId = value['id'];
-        objectTitle = [inputName, inputId].filter(Boolean).join('.');
-    }
-    objectTitle ||= 'data';
-    return [
-        `Invalid ${objectTitle}`,
-        '',
-        'Input:',
-        _stringify(value),
-        err.issues.length > 1 ? `\n${err.issues.length} issues:` : '',
-        ...err.issues.slice(0, 100).map(i => {
-            return [i.path.join('.'), i.message].filter(Boolean).join(': ');
-        }),
-    ].join('\n');
-}

package/src/zod/customZod.ts

@@ -1,11 +0,0 @@
-import { z as z4, ZodType } from 'zod'
-import { customZodSchemas } from './zod.shared.schemas.js'
-
-type ExtendedZod = Omit<typeof z4, keyof typeof customZodSchemas | 'iso'> & typeof customZodSchemas
-
-const z: ExtendedZod = { ...z4, ...customZodSchemas }
-
-// eslint-disable-next-line @typescript-eslint/naming-convention
-type zInfer<T> = z4.infer<T>
-
-export { z, type zInfer, ZodType }

package/src/zod/index.ts

@@ -1,3 +0,0 @@
-export * from './customZod.js'
-export * from './zod.shared.schemas.js'
-export * from './zod.util.js'

package/src/zod/zod.shared.schemas.ts

@@ -1,139 +0,0 @@
-import type { ZodString } from 'zod'
-import { z } from 'zod'
-import type { IANATimezone, IsoDate, UnixTimestamp, UnixTimestampMillis } from '../types.js'
-
-type ZodBranded<T, B> = T & Record<'_zod', Record<'output', B>>
-export type ZodBrandedString<B> = ZodBranded<z.ZodString, B>
-export type ZodBrandedInt<B> = ZodBranded<z.ZodInt, B>
-export type ZodBrandedNumber<B> = ZodBranded<z.ZodNumber, B>
-export type ZodBrandedIsoDate = ZodBranded<z.ZodISODate, IsoDate>
-
-const TS_2500 = 16725225600 // 2500-01-01
-const TS_2000 = 946684800 // 2000-01-01
-
-function unixTimestamp(): ZodBrandedInt<UnixTimestamp> {
-  return z
-    .number()
-    .int()
-    .min(0)
-    .max(TS_2500, 'Must be a UnixTimestamp number')
-    .describe('UnixTimestamp') as ZodBrandedInt<UnixTimestamp>
-}
-
-function unixTimestamp2000(): ZodBrandedInt<UnixTimestamp> {
-  return z
-    .number()
-    .int()
-    .min(TS_2000)
-    .max(TS_2500, 'Must be a UnixTimestamp number after 2000-01-01')
-    .describe('UnixTimestamp2000') as ZodBrandedInt<UnixTimestamp>
-}
-
-function unixTimestampMillis(): ZodBranded<z.ZodNumber, UnixTimestampMillis> {
-  return z
-    .number()
-    .int()
-    .min(0)
-    .max(TS_2500 * 1000, 'Must be a UnixTimestampMillis number')
-    .describe('UnixTimestampMillis') as ZodBrandedInt<UnixTimestampMillis>
-}
-
-function unixTimestampMillis2000(): ZodBrandedInt<UnixTimestampMillis> {
-  return z
-    .number()
-    .int()
-    .min(TS_2000 * 1000)
-    .max(TS_2500 * 1000, 'Must be a UnixTimestampMillis number after 2000-01-01')
-    .describe('UnixTimestampMillis2000') as ZodBrandedInt<UnixTimestampMillis>
-}
-
-function semVer(): z.ZodString {
-  return z
-    .string()
-    .regex(/^[0-9]+\.[0-9]+\.[0-9]+$/, 'Must be a SemVer string')
-    .describe('SemVer')
-}
-
-function isoDate(): ZodBrandedString<IsoDate> {
-  return z
-    .string()
-    .regex(/^\d{4}-\d{2}-\d{2}$/, { error: 'Must be a YYYY-MM-DD string' })
-    .describe('IsoDate') as ZodBrandedString<IsoDate>
-}
-
-const BASE62_REGEX = /^[a-zA-Z0-9]+$/
-const BASE64_REGEX = /^[A-Za-z0-9+/]+={0,2}$/
-const BASE64URL_REGEX = /^[\w\-/]+$/
-
-function base62(): z.ZodString {
-  return z.string().regex(BASE62_REGEX, 'Must be a base62 string').describe('Base62String')
-}
-
-function base64(): z.ZodString {
-  return z.string().regex(BASE64_REGEX, 'Must be a base64 string').describe('Base64String')
-}
-
-function base64Url(): z.ZodString {
-  return z.string().regex(BASE64URL_REGEX, 'Must be a base64url string').describe('Base64UrlString')
-}
-
-const JWT_REGEX = /^[\w-]+\.[\w-]+\.[\w-]+$/
-
-function jwt(): z.ZodString {
-  return z.string().regex(JWT_REGEX, 'Must be a JWT string').describe('JWTString')
-}
-
-/**
- * "Slug" - a valid URL, filename, etc.
- */
-function slug(): z.ZodString {
-  return z
-    .string()
-    .regex(/^[a-z0-9-]{1,255}$/, 'Must be a slug string')
-    .describe('Slug')
-}
-
-function ianaTimezone(): ZodBrandedString<IANATimezone> {
-  return (
-    z
-      // UTC is added to assist unit-testing, which uses UTC by default (not technically a valid Iana timezone identifier)
-      .enum([...Intl.supportedValuesOf('timeZone'), 'UTC'])
-      .describe('IANATimezone') as unknown as ZodBrandedString<IANATimezone>
-  )
-}
-
-const baseDBEntitySchema = z.object({
-  id: z.string(),
-  created: unixTimestamp2000(),
-  updated: unixTimestamp2000(),
-})
-
-// oxlint-disable-next-line @typescript-eslint/consistent-type-definitions
-type BaseDBEntityZodShape = {
-  id: ZodString
-  created: ZodBrandedInt<UnixTimestamp>
-  updated: ZodBrandedInt<UnixTimestamp>
-}
-
-function dbEntity(): z.ZodObject<BaseDBEntityZodShape>
-function dbEntity<T extends z.ZodRawShape>(shape: T): z.ZodObject<BaseDBEntityZodShape & T>
-
-function dbEntity<T extends z.ZodRawShape>(shape?: T): z.ZodObject<BaseDBEntityZodShape & T> {
-  return baseDBEntitySchema.extend(shape ?? {}) as z.ZodObject<BaseDBEntityZodShape & T>
-}
-
-export const customZodSchemas = {
-  base62,
-  base64,
-  base64Url,
-  dbEntity,
-  ianaTimezone,
-  isoDate,
-  jwt,
-  slug,
-  semver: semVer,
-  unixTimestamp,
-  unixTimestamp2000,
-  unixTimestampMillis,
-  unixTimestampMillis2000,
-}

package/src/zod/zod.util.ts

@@ -1,72 +0,0 @@
-import type { ZodError, ZodType } from 'zod'
-import { _assert } from '../error/assert.js'
-import type { ErrorData } from '../error/error.model.js'
-import { AppError } from '../error/error.util.js'
-import { _stringify } from '../string/stringify.js'
-import type { ValidationFunction, ValidationFunctionResult } from '../validation/validation.js'
-
-export function getZodValidationFunction<T>(
-  schema: ZodType<T>,
-): ValidationFunction<T, ZodValidationError> {
-  return (input, opt) => {
-    _assert(!opt?.mutateInput, 'mutateInput=true is not yet supported with Zod')
-    return zSafeValidate(input, schema)
-  }
-}
-
-export function zIsValid<T>(value: unknown, schema: ZodType<T>): boolean {
-  const { success } = schema.safeParse(value)
-  return success
-}
-
-export function zValidate<T>(value: unknown, schema: ZodType<T>): T {
-  const [err, data] = zSafeValidate(value, schema)
-  if (err) throw err
-  return data
-}
-
-export function zSafeValidate<T>(
-  input: unknown,
-  schema: ZodType<T>,
-  // inputName?: string,
-): ValidationFunctionResult<T, ZodValidationError> {
-  const r = schema.safeParse(input)
-  if (r.success) {
-    return [null, r.data]
-  }
-
-  return [new ZodValidationError(r.error, input, schema), r.data ?? (input as T)]
-}
-
-export interface ZodValidationErrorData extends ErrorData {}
-
-export class ZodValidationError extends AppError<ZodValidationErrorData> {
-  constructor(zodError: ZodError, value: any, schema: ZodType) {
-    const message = createZodErrorMessage(zodError, schema, value)
-    // const message = z.prettifyError(zodError) // todo: consider adopting it instead
-    super(message, {}, { name: 'ZodValidationError' })
-  }
-}
-
-function createZodErrorMessage<T>(err: ZodError<T>, schema: ZodType<T>, value: T): string {
-  let objectTitle = schema.description
-
-  if (typeof value === 'object' && value) {
-    const inputName = schema.description || value.constructor?.name
-    const inputId = (value as any)['id'] as string
-    objectTitle = [inputName, inputId].filter(Boolean).join('.')
-  }
-
-  objectTitle ||= 'data'
-
-  return [
-    `Invalid ${objectTitle}`,
-    '',
-    'Input:',
-    _stringify(value),
-    err.issues.length > 1 ? `\n${err.issues.length} issues:` : '',
-    ...err.issues.slice(0, 100).map(i => {
-      return [i.path.join('.'), i.message].filter(Boolean).join(': ')
-    }),
-  ].join('\n')
-}