@web-ts-toolkit/moo 0.4.0 → 0.6.0

package/README.md

@@ -1,25 +1,25 @@
-# moo
+# `@web-ts-toolkit/moo`
 
-Helpers for common Mongoose patterns.
-
-This package includes:
-
-- partial-index helpers for nullable or empty string fields
-- an `isObjectId(...)` guard for strict ObjectId checks
-- document plugins for model-bound helper functions and cascade deletes
+Mongoose helpers for schema fields, ObjectId checks, and document plugins.
 
 ## Installation
 
 ```sh
-npm install mongoose @web-ts-toolkit/moo
+pnpm add mongoose @web-ts-toolkit/moo
 ```
 
-## Documentation
+Peer dependencies:
 
-- Full package documentation lives in `website/docs/packages/moo.md`.
-- Use the Docusaurus site in `website` for the full examples.
+- `mongoose >= 8`
 
-## Minimal Example
+## Highlights
+
+- partial-index helpers for nullable or empty-string fields
+- strict `isObjectId(...)` guard
+- model-function plugin
+- cascade-delete plugin
+
+## Quick Start
 
 ```ts
 import { Schema } from 'mongoose';
@@ -30,3 +30,39 @@ const userSchema = new Schema({
   username: uniqueEmptiableString('username'),
 });
 ```
+
+## Main Exports
+
+Root entrypoint (`@web-ts-toolkit/moo`):
+
+- schema helpers such as `uniqueNullableString(...)`
+- `isObjectId(...)`
+
+Subpath entrypoints:
+
+- `@web-ts-toolkit/moo/schema` — schema field helpers
+- `@web-ts-toolkit/moo/is` — type guards such as `isObjectId(...)`
+- `@web-ts-toolkit/moo/utils` — mongoose utilities
+- `@web-ts-toolkit/moo/plugins` — plugin entrypoint
+- `@web-ts-toolkit/moo/plugins/cascade-delete` — cascade-delete plugin
+- `@web-ts-toolkit/moo/plugins/model-function` — model-function plugin
+
+### Subpath import example
+
+```ts
+import { Schema } from 'mongoose';
+import { uniqueEmptiableString } from '@web-ts-toolkit/moo';
+import { cascadeDeletePlugin } from '@web-ts-toolkit/moo/plugins/cascade-delete';
+
+const userSchema = new Schema({
+  email: uniqueEmptiableString('email'),
+});
+
+userSchema.plugin(cascadeDeletePlugin, { foreignKey: 'parentRef' });
+```
+
+## Documentation
+
+Full package documentation lives in `website/docs/packages/moo.md`.
+
+- live docs: https://web-ts-toolkit.pages.dev/docs/packages/moo

package/is.d.mts

@@ -1,6 +1,13 @@
 import { Types } from 'mongoose';
 
 declare const ObjectId: typeof Types.ObjectId;
+/**
+ * Type guard that returns `true` when `value` is a valid MongoDB ObjectId
+ * string or ObjectId instance.
+ *
+ * @example
+ * if (isObjectId(req.params.id)) { doSomething(); }
+ */
 declare function isObjectId(value: unknown): value is InstanceType<typeof ObjectId> | string;
 
 export { isObjectId };

package/is.d.ts

@@ -1,6 +1,13 @@
 import { Types } from 'mongoose';
 
 declare const ObjectId: typeof Types.ObjectId;
+/**
+ * Type guard that returns `true` when `value` is a valid MongoDB ObjectId
+ * string or ObjectId instance.
+ *
+ * @example
+ * if (isObjectId(req.params.id)) { doSomething(); }
+ */
 declare function isObjectId(value: unknown): value is InstanceType<typeof ObjectId> | string;
 
 export { isObjectId };

package/llms.txt

@@ -0,0 +1,67 @@
+# @web-ts-toolkit/moo
+
+Mongoose helpers for schema fields, ObjectId checks, and document plugins.
+
+## Main Patterns
+
+Partial-index schema fields:
+
+```ts
+import { Schema } from 'mongoose';
+import { uniqueEmptiableString, uniqueNullableString } from '@web-ts-toolkit/moo';
+
+const userSchema = new Schema({
+  email: uniqueNullableString('email'),
+  username: uniqueEmptiableString('username'),
+});
+```
+
+Strict ObjectId guard:
+
+```ts
+import { isObjectId } from '@web-ts-toolkit/moo';
+
+if (isObjectId(req.params.id)) { doSomething(); }
+```
+
+Cascade-delete plugin:
+
+```ts
+import { cascadeDeletePlugin } from '@web-ts-toolkit/moo/plugins/cascade-delete';
+
+userSchema.plugin(cascadeDeletePlugin, { foreignKey: 'parentRef' });
+```
+
+Model-function plugin:
+
+```ts
+import { modelFunctionPlugin } from '@web-ts-toolkit/moo/plugins/model-function';
+
+userSchema.plugin(modelFunctionPlugin, {
+  fnName: 'fullName',
+  fn: (doc) => `${doc.name}`,
+});
+
+// static + instance methods `fullName` and `fullNameById` are now available on the model
+```
+
+## Gotchas
+
+- peer dependency: `mongoose >= 8`
+- root entrypoint exports schema helpers and `isObjectId`; plugins and utils live under subpaths
+- `isObjectId(...)` is a strict guard: it rejects strings that `ObjectId.isValid` accepts but that don't round-trip back to the same string
+- `uniqueNullableString`/`uniqueEmptiableString` return partial-index field definitions, not full schemas
+
+## Subpaths
+
+- `@web-ts-toolkit/moo/is` — `isObjectId`
+- `@web-ts-toolkit/moo/schema` — `uniqueNullableString`, `uniqueEmptiableString`
+- `@web-ts-toolkit/moo/utils` — `isSchema`, `isObjectIdType`, `isReference`
+- `@web-ts-toolkit/moo/plugins` — re-exports all plugins
+- `@web-ts-toolkit/moo/plugins/cascade-delete` — `cascadeDeletePlugin`
+- `@web-ts-toolkit/moo/plugins/model-function` — `modelFunctionPlugin`
+
+## Pointers
+
+- README: installation, quickstart, main exports, subpath list
+- website/docs/packages/moo.md: full documentation

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@web-ts-toolkit/moo",
   "description": "Mongoose helpers for schema fields, ObjectId checks, and document plugins",
-  "version": "0.4.0",
+  "homepage": "https://web-ts-toolkit.pages.dev/docs/packages/moo",
+  "version": "0.6.0",
+  "sideEffects": false,
   "keywords": [
     "mongoose",
     "mongodb",
     "schema",
-    "plugin"
+    "plugins",
+    "objectid"
   ],
   "main": "./index.js",
   "module": "./index.mjs",
@@ -55,19 +58,19 @@
       "default": "./plugins/model-function.js"
     }
   },
+  "engines": {
+    "node": ">=20"
+  },
   "peerDependencies": {
     "mongoose": ">=8.0.0"
   },
   "dependencies": {
-    "@web-ts-toolkit/utils": "0.4.0"
+    "@web-ts-toolkit/utils": "0.6.0"
   },
   "author": "Junmin Ahn",
   "bugs": {
     "url": "https://github.com/egose/web-ts-toolkit/issues"
   },
-  "engines": {
-    "node": ">=20"
-  },
   "license": "Apache-2.0",
   "repository": {
     "type": "git",