@xylabs/object 4.13.4 → 4.13.6

package/dist/neutral/index.d.ts

@@ -1,187 +1,158 @@
-import { AnyNonPromise } from '@xylabs/promise';
-import type { AnyObject } from '@xylabs/object-model';
-import { AsTypeFunction } from '@xylabs/object-model';
-import type { FieldType } from '@xylabs/typeof';
-import { ObjectTypeShape } from '@xylabs/typeof';
-import type { Promisable } from '@xylabs/promise';
-import type { TypeCheck } from '@xylabs/object-model';
-import type { TypeCheckConfig } from '@xylabs/object-model';
-import { TypedObject } from '@xylabs/typeof';
-
-export declare const asAnyObject: AsTypeFunction<AnyObject>;
-
-export declare const AsObjectFactory: {
-    create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
-    createOptional: <T extends TypedObject>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;
-};
-
-export declare const AsTypeFactory: {
-    create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
-    createOptional: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;
-};
-
-/**
- * Creates a deep merge function with the specified options.
- * @param options Options for merging.
- * @returns A deep merge function configured for the specified options.
- */
-export declare function createDeepMerge(options: MergeOptions): <T extends AnyObject[]>(...objects: T) => MergeAll<T>;
-
-/**
- * Deeply merges two types into a new type.
- */
-declare type DeepMerge<A, B> = {
-    [K in keyof A | keyof B]: K extends keyof B ? K extends keyof A ? A[K] extends object ? B[K] extends object ? DeepMerge<A[K], B[K]> : B[K] : B[K] : B[K] : K extends keyof A ? A[K] : never;
-};
-
-/**
- * Deeply merges multiple objects into a new object.
- * @param objects Multiple objects to merge deeply.
- * The function merges properties from all objects into a new object.
- * If a property exists in multiple objects, the last object's value will be used.
- * If a property is an object, it will be merged recursively.
- * If a property is an array, it will be overwritten by the last object's value.
- * If a property is a primitive value, it will be overwritten by the last object's value.
- * If a property is undefined in the source, it will be skipped.
- * If a property is a symbol, it will be merged as well.
- * @returns A new object with the merged properties.
- */
-export declare const deepMerge: <T extends AnyObject[]>(...objects: T) => MergeAll<T>;
-
-export declare type DeepOmitStartsWith<T, Prefix extends string> = T extends (infer U)[] ? DeepOmitStartsWith<U, Prefix>[] : T extends object ? {
-    [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? never : K : K]: DeepOmitStartsWith<T[K], Prefix>;
-} : T;
-
-export declare type DeepPickStartsWith<T, Prefix extends string> = T extends (infer U)[] ? DeepPickStartsWith<U, Prefix>[] : T extends object ? {
-    [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? K : never : K]: DeepPickStartsWith<T[K], Prefix>;
-} : T;
-
-export declare type DeepRestrictToStringKeys<T> = {
-    [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToStringKeys<U>[] : T[K] extends object ? DeepRestrictToStringKeys<T[K]> : T[K];
-};
-
-/**
- * An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
- * extended from, which then adds only those additional fields
- */
-export declare type EmptyObject<T extends object = object> = {
-    [K in keyof T]?: never;
-};
-
-export declare type EmptyObjectOf<T extends object> = EmptyObject<T> extends T ? EmptyObject<T> : never;
-
-export declare const isJsonArray: (value: unknown) => value is JsonArray;
-
-export declare const isJsonObject: (value: unknown) => value is JsonObject;
-
-export declare const isJsonValue: (value: unknown) => value is JsonValue;
-
-export declare const isObject: <T>(value: T) => value is T & object;
-
-export declare class IsObjectFactory<T extends TypedObject> {
-    create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject>[]): TypeCheck<T>;
-}
-
-export declare const isType: (value: unknown, expectedType: FieldType) => boolean;
-
-export declare const isValidJsonFieldPair: ([key, value]: [key: unknown, value: unknown]) => boolean;
-
-export declare type JsonArray = JsonValue[];
-
-export declare type JsonObject = {
-    [key: string]: JsonValue;
-};
-
-export declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
-
-/**
- * Merges multiple types into a new type.
- */
-declare type MergeAll<T extends object[], R = {}> = T extends [infer First extends object, ...infer Rest extends object[]] ? MergeAll<Rest, DeepMerge<R, First>> : R;
-
-/**
- * Options for merging objects in the deep merge function.
- */
-declare type MergeOptions = {
-    /**
-     * Strategy for merging arrays.
-     * - 'overwrite': Overwrites the array with the last object's value.
-     * - 'concat': Concatenates arrays from all objects.
-     * @default 'overwrite'
-     */
-    arrayStrategy?: 'overwrite' | 'concat';
-    /**
-     * Mutate the first object in the list instead of creating a new one.
-     * @default false
-     */
-    mutate?: boolean;
-};
-
-export declare interface ObjectTypeConfig extends TypeCheckConfig {
-}
-
-export declare abstract class ObjectWrapper<T extends EmptyObject = EmptyObject> {
-    readonly obj: T;
-    constructor(obj: T);
-    protected get stringKeyObj(): StringKeyObject;
-}
-
-export declare const omitBy: <T extends EmptyObject>(obj: T, predicate: OmitByPredicate, maxDepth?: number) => Partial<T>;
-
-export declare type OmitByPredicate<T extends EmptyObject = Record<string, unknown>> = (value: T[keyof T], key: keyof T) => boolean;
-
-export declare const omitByPrefix: <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth?: number) => DeepOmitStartsWith<T, P>;
-
-export declare type OmitStartsWith<T, Prefix extends string> = {
-    [K in keyof T as K extends `${Prefix}${string}` ? never : K]: T[K];
-};
-
-export declare type Optional<T extends object, F extends keyof T> = Omit<T, F> & Partial<Pick<T, F>>;
-
-export declare type Override<T1, T2> = Omit<T1, keyof T2> & T2;
-
-/** @deprecated use Partial<Record<>> instead */
-export declare type PartialRecord<K extends keyof any, T> = {
-    [P in K]?: T;
-};
-
-export declare const pickBy: <T extends EmptyObject>(obj: T, predicate: PickByPredicate, maxDepth?: number) => Partial<T>;
-
-export declare type PickByPredicate<T extends EmptyObject = Record<string, unknown>> = (value: T[keyof T], key: keyof T) => boolean;
-
-export declare const pickByPrefix: <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth?: number) => DeepPickStartsWith<T, P>;
-
-export declare type PickStartsWith<T, Prefix extends string> = {
-    [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K];
-};
-
-export declare const removeFields: <T extends EmptyObject, K extends keyof T>(obj: T, fields: K[]) => Omit<T, K>;
-
-export declare type StringKeyObject<T = unknown> = {
-    [key: string]: T;
-};
-
-export declare const toJson: (value: unknown, maxDepth?: number) => JsonValue;
-
-export declare const toJsonArray: (value: unknown[], cycleList?: unknown[], maxDepth?: number) => JsonArray;
-
-export declare const toJsonObject: (value: object, cycleList?: unknown[], maxDepth?: number) => JsonObject;
-
-export declare const toJsonString: (value: unknown, maxDepth?: number) => string;
-
-export declare const toJsonValue: (value: unknown, cycleList?: unknown[], maxDepth?: number) => JsonValue;
-
-export declare interface Validator<T extends EmptyObject = AnyObject> {
-    validate(payload: T): Promisable<Error[]>;
-}
-
-export declare abstract class ValidatorBase<T extends EmptyObject = AnyObject> extends ObjectWrapper<Partial<T>> implements Validator<T> {
-    abstract validate(payload: T): Promisable<Error[]>;
-}
-
-export declare type WithAdditional<T extends EmptyObject | void, TAdditional extends EmptyObject | void = void> = TAdditional extends EmptyObject ? T & TAdditional : T;
-
-
-export * from "@xylabs/object-model";
-
-export { }
+import * as _xylabs_object_model from '@xylabs/object-model';
+import { AnyObject, TypeCheck, AsTypeFunction, TypeCheckConfig } from '@xylabs/object-model';
+export * from '@xylabs/object-model';
+import * as _xylabs_promise from '@xylabs/promise';
+import { AnyNonPromise, Promisable } from '@xylabs/promise';
+import { TypedObject, ObjectTypeShape, FieldType } from '@xylabs/typeof';
+
+declare const asAnyObject: _xylabs_object_model.AsTypeFunction<AnyObject>;
+
+declare const AsObjectFactory: {
+    create: <T extends TypedObject>(typeCheck: TypeCheck<T>) => _xylabs_object_model.AsTypeFunction<T>;
+    createOptional: <T extends TypedObject>(typeCheck: TypeCheck<T>) => (value: _xylabs_promise.AnyNonPromise) => T | undefined;
+};
+
+declare const AsTypeFactory: {
+    create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => AsTypeFunction<T>;
+    createOptional: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => (value: AnyNonPromise) => T | undefined;
+};
+
+/**
+ * Deeply merges two types into a new type.
+ */
+type DeepMerge<A, B> = {
+    [K in keyof A | keyof B]: K extends keyof B ? K extends keyof A ? A[K] extends object ? B[K] extends object ? DeepMerge<A[K], B[K]> : B[K] : B[K] : B[K] : K extends keyof A ? A[K] : never;
+};
+/**
+ * Merges multiple types into a new type.
+ */
+type MergeAll<T extends object[], R = {}> = T extends [infer First extends object, ...infer Rest extends object[]] ? MergeAll<Rest, DeepMerge<R, First>> : R;
+/**
+ * Options for merging objects in the deep merge function.
+ */
+type MergeOptions = {
+    /**
+     * Strategy for merging arrays.
+     * - 'overwrite': Overwrites the array with the last object's value.
+     * - 'concat': Concatenates arrays from all objects.
+     * @default 'overwrite'
+     */
+    arrayStrategy?: 'overwrite' | 'concat';
+    /**
+     * Mutate the first object in the list instead of creating a new one.
+     * @default false
+     */
+    mutate?: boolean;
+};
+/**
+ * Creates a deep merge function with the specified options.
+ * @param options Options for merging.
+ * @returns A deep merge function configured for the specified options.
+ */
+declare function createDeepMerge(options: MergeOptions): <T extends AnyObject[]>(...objects: T) => MergeAll<T>;
+/**
+ * Deeply merges multiple objects into a new object.
+ * @param objects Multiple objects to merge deeply.
+ * The function merges properties from all objects into a new object.
+ * If a property exists in multiple objects, the last object's value will be used.
+ * If a property is an object, it will be merged recursively.
+ * If a property is an array, it will be overwritten by the last object's value.
+ * If a property is a primitive value, it will be overwritten by the last object's value.
+ * If a property is undefined in the source, it will be skipped.
+ * If a property is a symbol, it will be merged as well.
+ * @returns A new object with the merged properties.
+ */
+declare const deepMerge: <T extends AnyObject[]>(...objects: T) => MergeAll<T>;
+
+/**
+ * An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
+ * extended from, which then adds only those additional fields
+ */
+type EmptyObject<T extends object = object> = {
+    [K in keyof T]?: never;
+};
+type EmptyObjectOf<T extends object> = EmptyObject<T> extends T ? EmptyObject<T> : never;
+
+declare const isObject: <T>(value: T) => value is T & object;
+
+interface ObjectTypeConfig extends TypeCheckConfig {
+}
+declare class IsObjectFactory<T extends TypedObject> {
+    create(shape?: ObjectTypeShape, additionalChecks?: TypeCheck<TypedObject>[]): TypeCheck<T>;
+}
+
+declare const isType: (value: unknown, expectedType: FieldType) => boolean;
+
+type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
+type JsonObject = {
+    [key: string]: JsonValue;
+};
+type JsonArray = JsonValue[];
+declare const isJsonValue: (value: unknown) => value is JsonValue;
+declare const isJsonArray: (value: unknown) => value is JsonArray;
+declare const isValidJsonFieldPair: ([key, value]: [key: unknown, value: unknown]) => boolean;
+declare const isJsonObject: (value: unknown) => value is JsonObject;
+
+type StringKeyObject<T = unknown> = {
+    [key: string]: T;
+};
+
+declare abstract class ObjectWrapper<T extends EmptyObject = EmptyObject> {
+    readonly obj: T;
+    constructor(obj: T);
+    protected get stringKeyObj(): StringKeyObject;
+}
+
+type OmitStartsWith<T, Prefix extends string> = {
+    [K in keyof T as K extends `${Prefix}${string}` ? never : K]: T[K];
+};
+type DeepOmitStartsWith<T, Prefix extends string> = T extends (infer U)[] ? DeepOmitStartsWith<U, Prefix>[] : T extends object ? {
+    [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? never : K : K]: DeepOmitStartsWith<T[K], Prefix>;
+} : T;
+type DeepRestrictToStringKeys<T> = {
+    [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToStringKeys<U>[] : T[K] extends object ? DeepRestrictToStringKeys<T[K]> : T[K];
+};
+
+type OmitByPredicate<T extends EmptyObject = Record<string, unknown>> = (value: T[keyof T], key: keyof T) => boolean;
+declare const omitBy: <T extends EmptyObject>(obj: T, predicate: OmitByPredicate, maxDepth?: number) => Partial<T>;
+declare const omitByPrefix: <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth?: number) => DeepOmitStartsWith<T, P>;
+
+type Optional<T extends object, F extends keyof T> = Omit<T, F> & Partial<Pick<T, F>>;
+
+type Override<T1, T2> = Omit<T1, keyof T2> & T2;
+
+/** @deprecated use Partial<Record<>> instead */
+type PartialRecord<K extends keyof any, T> = {
+    [P in K]?: T;
+};
+
+type PickStartsWith<T, Prefix extends string> = {
+    [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K];
+};
+type DeepPickStartsWith<T, Prefix extends string> = T extends (infer U)[] ? DeepPickStartsWith<U, Prefix>[] : T extends object ? {
+    [K in keyof T as K extends string ? K extends `${Prefix}${string}` ? K : never : K]: DeepPickStartsWith<T[K], Prefix>;
+} : T;
+
+type PickByPredicate<T extends EmptyObject = Record<string, unknown>> = (value: T[keyof T], key: keyof T) => boolean;
+declare const pickBy: <T extends EmptyObject>(obj: T, predicate: PickByPredicate, maxDepth?: number) => Partial<T>;
+declare const pickByPrefix: <T extends EmptyObject, P extends string>(payload: T, prefix: P, maxDepth?: number) => DeepPickStartsWith<T, P>;
+
+declare const removeFields: <T extends EmptyObject, K extends keyof T>(obj: T, fields: K[]) => Omit<T, K>;
+
+declare const toJsonArray: (value: unknown[], cycleList?: unknown[], maxDepth?: number) => JsonArray;
+declare const toJsonObject: (value: object, cycleList?: unknown[], maxDepth?: number) => JsonObject;
+declare const toJsonValue: (value: unknown, cycleList?: unknown[], maxDepth?: number) => JsonValue;
+declare const toJsonString: (value: unknown, maxDepth?: number) => string;
+declare const toJson: (value: unknown, maxDepth?: number) => JsonValue;
+
+interface Validator<T extends EmptyObject = AnyObject> {
+    validate(payload: T): Promisable<Error[]>;
+}
+declare abstract class ValidatorBase<T extends EmptyObject = AnyObject> extends ObjectWrapper<Partial<T>> implements Validator<T> {
+    abstract validate(payload: T): Promisable<Error[]>;
+}
+
+type WithAdditional<T extends EmptyObject | void, TAdditional extends EmptyObject | void = void> = TAdditional extends EmptyObject ? T & TAdditional : T;
+
+export { AsObjectFactory, AsTypeFactory, IsObjectFactory, ObjectWrapper, ValidatorBase, asAnyObject, createDeepMerge, deepMerge, isJsonArray, isJsonObject, isJsonValue, isObject, isType, isValidJsonFieldPair, omitBy, omitByPrefix, pickBy, pickByPrefix, removeFields, toJson, toJsonArray, toJsonObject, toJsonString, toJsonValue };
+export type { DeepOmitStartsWith, DeepPickStartsWith, DeepRestrictToStringKeys, EmptyObject, EmptyObjectOf, JsonArray, JsonObject, JsonValue, ObjectTypeConfig, OmitByPredicate, OmitStartsWith, Optional, Override, PartialRecord, PickByPredicate, PickStartsWith, StringKeyObject, Validator, WithAdditional };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/object",
-  "version": "4.13.4",
+  "version": "4.13.6",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,14 +29,14 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.4",
-    "@xylabs/object-model": "^4.13.4",
-    "@xylabs/promise": "^4.13.4",
-    "@xylabs/typeof": "^4.13.4"
+    "@xylabs/assert": "^4.13.6",
+    "@xylabs/object-model": "^4.13.6",
+    "@xylabs/promise": "^4.13.6",
+    "@xylabs/typeof": "^4.13.6"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.7",
-    "@xylabs/tsconfig": "^7.0.0-rc.7",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.8",
+    "@xylabs/tsconfig": "^7.0.0-rc.8",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },