@web-ts-toolkit/moo 0.43.0 → 0.48.0

package/schema.d.ts

@@ -1,10 +1,17 @@
+/**
+ * Arbitrary Mongoose schema-type options merged over the helper defaults.
+ * Provided keys win over the defaults at runtime via object spread; the
+ * helpers type this with `Omit<Base, keyof TOverrides> & TOverrides` so an
+ * override of `default`, `trim`, or `index` is reflected in the inferred
+ * return type instead of keeping the fixed default type.
+ */
 type SchemaOptionOverrides = Record<string, unknown>;
-declare const uniqueNullableString: (field: string, options?: SchemaOptionOverrides) => {
+type UniqueNullableBase = {
     type: StringConstructor;
     index: {
         unique: boolean;
         partialFilterExpression: {
-            [x: string]: {
+            [field: string]: {
                 $type: string;
             };
         };
@@ -12,12 +19,12 @@ declare const uniqueNullableString: (field: string, options?: SchemaOptionOverri
     trim: boolean;
     default: null;
 };
-declare const uniqueEmptiableString: (field: string, options?: SchemaOptionOverrides) => {
+type UniqueEmptiableBase = {
     type: StringConstructor;
     index: {
         unique: boolean;
         partialFilterExpression: {
-            [x: string]: {
+            [field: string]: {
                 $type: string;
                 $gt: string;
             };
@@ -26,5 +33,27 @@ declare const uniqueEmptiableString: (field: string, options?: SchemaOptionOverr
     trim: boolean;
     default: null;
 };
+/**
+ * Partial-unique string field that allows any number of `null` values while
+ * still rejecting duplicate non-null strings (including `''`). The partial
+ * index only covers string-typed values (`{ [field]: { $type: 'string' } }`),
+ * so `null`/missing entries never conflict. Extra `options` are spread over
+ * the defaults and reflected in the return type.
+ *
+ * @example
+ * const userSchema = new Schema({ email: uniqueNullableString('email') });
+ */
+declare const uniqueNullableString: <TOverrides extends SchemaOptionOverrides = Record<string, never>>(field: string, options?: TOverrides) => Omit<UniqueNullableBase, keyof TOverrides> & TOverrides;
+/**
+ * Partial-unique string field that additionally ignores empty strings:
+ * both `null` and `''` can repeat, while duplicate non-empty strings are
+ * rejected. The partial index only covers strings longer than `''`
+ * (`{ [field]: { $type: 'string', $gt: '' } }`). Extra `options` are spread
+ * over the defaults and reflected in the return type.
+ *
+ * @example
+ * const userSchema = new Schema({ username: uniqueEmptiableString('username') });
+ */
+declare const uniqueEmptiableString: <TOverrides extends SchemaOptionOverrides = Record<string, never>>(field: string, options?: TOverrides) => Omit<UniqueEmptiableBase, keyof TOverrides> & TOverrides;
 
-export { uniqueEmptiableString, uniqueNullableString };
+export { type SchemaOptionOverrides, uniqueEmptiableString, uniqueNullableString };

package/schema.js

@@ -24,23 +24,30 @@ __export(schema_exports, {
   uniqueNullableString: () => uniqueNullableString
 });
 module.exports = __toCommonJS(schema_exports);
-var uniqueNullableString = (field, options = {}) => ({
-  type: String,
-  index: { unique: true, partialFilterExpression: { [field]: { $type: "string" } } },
-  trim: true,
-  default: null,
-  ...options
-});
-var uniqueEmptiableString = (field, options = {}) => ({
-  type: String,
-  index: {
-    unique: true,
-    partialFilterExpression: { [field]: { $type: "string", $gt: "" } }
-  },
-  trim: true,
-  default: null,
-  ...options
-});
+var uniqueNullableString = (field, options) => (
+  // The runtime spread applies overrides over the defaults; the cast expresses
+  // that override-wins merge because TypeScript cannot narrow a generic spread.
+  {
+    type: String,
+    index: { unique: true, partialFilterExpression: { [field]: { $type: "string" } } },
+    trim: true,
+    default: null,
+    ...options
+  }
+);
+var uniqueEmptiableString = (field, options) => (
+  // Same override-wins spread contract as uniqueNullableString above.
+  {
+    type: String,
+    index: {
+      unique: true,
+      partialFilterExpression: { [field]: { $type: "string", $gt: "" } }
+    },
+    trim: true,
+    default: null,
+    ...options
+  }
+);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   uniqueEmptiableString,

package/schema.mjs

@@ -1,21 +1,28 @@
 // src/schema.ts
-var uniqueNullableString = (field, options = {}) => ({
-  type: String,
-  index: { unique: true, partialFilterExpression: { [field]: { $type: "string" } } },
-  trim: true,
-  default: null,
-  ...options
-});
-var uniqueEmptiableString = (field, options = {}) => ({
-  type: String,
-  index: {
-    unique: true,
-    partialFilterExpression: { [field]: { $type: "string", $gt: "" } }
-  },
-  trim: true,
-  default: null,
-  ...options
-});
+var uniqueNullableString = (field, options) => (
+  // The runtime spread applies overrides over the defaults; the cast expresses
+  // that override-wins merge because TypeScript cannot narrow a generic spread.
+  {
+    type: String,
+    index: { unique: true, partialFilterExpression: { [field]: { $type: "string" } } },
+    trim: true,
+    default: null,
+    ...options
+  }
+);
+var uniqueEmptiableString = (field, options) => (
+  // Same override-wins spread contract as uniqueNullableString above.
+  {
+    type: String,
+    index: {
+      unique: true,
+      partialFilterExpression: { [field]: { $type: "string", $gt: "" } }
+    },
+    trim: true,
+    default: null,
+    ...options
+  }
+);
 export {
   uniqueEmptiableString,
   uniqueNullableString