@wxn0brp/db-core 0.12.13 → 0.12.14

package/dist/types/arg.d.ts

@@ -5,7 +5,15 @@ import { UpdaterArg } from "./updater.js";
 export type Arg<T = any> = {
     [K in keyof T]?: any;
 } & Record<string, any>;
+/**
+ * Function-based search.
+ * @deprecated Use operator objects or a plugin instead.
+ */
 export type SearchFunc<T = any> = (data: T, context: VContext) => boolean;
+/**
+ * Function-based updater.
+ * @deprecated Use operator objects instead.
+ */
 export type UpdaterFunc<T = any> = (data: T, context: VContext) => Data | void;
 export type Search<T = any, AllowFn extends boolean = true> = AllowFn extends true ? SearchOptions<T> | SearchFunc<T> : SearchOptions<T>;
 export type Updater<T = any, AllowFn extends boolean = true> = AllowFn extends true ? UpdaterArg<T> | UpdaterFunc<T> : UpdaterArg<T>;

package/dist/types/collection.d.ts

@@ -3,5 +3,6 @@ import { VContext } from "./types.js";
 export interface UpdateOneOrAdd<T> {
     add_arg?: Arg<T>;
     id_gen?: boolean;
+    /** @deprecated */
     context?: VContext;
 }

package/dist/types/export.d.ts

@@ -10,6 +10,8 @@ export declare namespace ValtheraTypes {
     type Data = import("./data.js").Data;
     type SearchOptions = import("./searchOpts.js").SearchOptions;
     type Id = import("./Id.js").Id;
+    /** @deprecated */
     type Context = import("./types.js").VContext;
+    /** @deprecated */
     type VContext = import("./types.js").VContext;
 }

package/dist/types/query.d.ts

@@ -19,6 +19,7 @@ export interface VQuery<T = Data, AllowFn extends boolean = true> {
     /** logic path, dir or file, depends on context */
     collection?: string;
     search?: Search<T, AllowFn>;
+    /** @deprecated */
     context?: VContext;
     dbFindOpts?: DbFindOpts<T>;
     findOpts?: FindOpts<T>;
@@ -49,20 +50,24 @@ export declare namespace VQueryT {
         search?: Search<T, AllowFn>;
         findOpts?: FindOpts<T>;
         dbFindOpts?: DbFindOpts<T>;
+        /** @deprecated */
         context?: VContext;
     };
     type FindOne<T = Data, AllowFn extends boolean = true> = QueryBase<T> & {
         search: Search<T, AllowFn>;
         findOpts?: FindOpts<T>;
+        /** @deprecated */
         context?: VContext;
     };
     type Update<T = Data, AllowFn extends boolean = true> = QueryBase<T> & {
         search: Search<T, AllowFn>;
         updater: Updater<T, AllowFn>;
+        /** @deprecated */
         context?: VContext;
     };
     type Remove<T = Data, AllowFn extends boolean = true> = QueryBase<T> & {
         search: Search<T, AllowFn>;
+        /** @deprecated */
         context?: VContext;
     };
     type UpdateOneOrAdd<T = Data, AllowFn extends boolean = true> = QueryBase<T> & {
@@ -70,11 +75,13 @@ export declare namespace VQueryT {
         updater: Updater<T, AllowFn>;
         add_arg?: Arg<T>;
         id_gen?: boolean;
+        /** @deprecated */
         context?: VContext;
     };
     type ToggleOne<T = Data, AllowFn extends boolean = true> = QueryBase<T> & {
         search: Search<T, AllowFn>;
         data: Arg<T>;
+        /** @deprecated */
         context?: VContext;
     };
     interface UpdateOneOrAddResult<T> {

package/dist/types/searchOpts.d.ts

@@ -72,10 +72,20 @@ export type ArrayOperators<T = any> = {
     /** [1, 2, 3] has size 3 */
     $size?: NestedValue<T, number>;
 };
+/**
+ * Raw regex pattern string.
+ * @deprecated Pass a `RegExp` instance instead.
+ */
+export interface RawRegexPattern extends String {
+}
 /** String Operators with nested support */
 export type StringOperators<T = any> = {
-    /** "John" matches /oh/ */
-    $regex?: NestedValue<T, RegExp | string, string>;
+    /**
+     * "John" matches /oh/
+     *
+     * Prefer a `RegExp` instance; raw strings ({@link RawRegexPattern}) are deprecated.
+     */
+    $regex?: NestedValue<T, RegExp | RawRegexPattern, string>;
     /** "John" starts with "Jo" */
     $startsWith?: NestedValue<T, string, string>;
     /** "John" ends with "hn" */

package/dist/types/types.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @deprecated Function-based queries are deprecated, so this type will be removed together with them.
+ */
 export interface VContext {
     [key: string]: any;
 }

package/dist/utils/deprecation.d.ts

@@ -0,0 +1 @@
+export declare function warnDeprecated(code: string, message: string): void;

package/dist/utils/deprecation.js

@@ -0,0 +1,15 @@
+const warned = new Set();
+export function warnDeprecated(code, message) {
+    if (warned.has(code))
+        return;
+    warned.add(code);
+    const proc = globalThis.process;
+    if (typeof proc?.emitWarning === "function") {
+        proc.emitWarning(message, {
+            type: "DeprecationWarning",
+            code,
+        });
+        return;
+    }
+    console.warn(message);
+}

package/dist/utils/hasFieldsAdvanced.js

@@ -1,4 +1,5 @@
 import { QueryValidationError } from "../errors.js";
+import { warnDeprecated } from "./deprecation.js";
 import { hasFields } from "./hasFields.js";
 import { compareIds } from "./id.js";
 import { isUnsafeKey } from "./security.js";
@@ -69,6 +70,8 @@ function mainCheck(obj, fields) {
         regex: (data, regexData) => {
             if (typeof data !== "string")
                 return false;
+            if (typeof regexData === "string")
+                warnDeprecated("VALTHERA_REGEX_STRING_PATTERN", "$regex with a string pattern is deprecated; pass a RegExp instance instead.");
             const regex = typeof regexData === "string" ? new RegExp(regexData) : regexData;
             return regex.test(data);
         },

package/dist/utils/process.js

@@ -1,3 +1,4 @@
+import { warnDeprecated } from "./deprecation.js";
 import { hasFieldsAdvanced } from "./hasFieldsAdvanced.js";
 import { updateFindObject } from "./updateFindObject.js";
 import { updateObjectAdvanced } from "./updateObject.js";
@@ -10,8 +11,11 @@ export function matchObj(config, obj) {
     const { search, context } = config;
     if (search === undefined || search === null)
         return true;
-    if (typeof search === "function" && search(obj, context))
-        return true;
+    if (typeof search === "function") {
+        warnDeprecated("VALTHERA_FUNCTION_SEARCH", "Function-based search is deprecated; use operator objects or a plugin.");
+        if (search(obj, context))
+            return true;
+    }
     if (typeof search === "object" &&
         !Array.isArray(search) &&
         hasFieldsAdvanced(obj, search))
@@ -28,6 +32,7 @@ export function updateObj(config, obj) {
         return obj;
     }
     if (typeof updater === "function") {
+        warnDeprecated("VALTHERA_FUNCTION_UPDATER", "Function-based updater is deprecated; use operator objects.");
         const updateObjValue = updater(obj, context);
         if (updateObjValue)
             return updateObjValue;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.12.13";
+export declare const version = "0.12.14";

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.12.13";
+export const version = "0.12.14";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db-core",
-  "version": "0.12.13",
+  "version": "0.12.14",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "author": "wxn0brP",