modelence 0.12.3 → 0.12.5-dev.1

package/dist/{types-BOFsm7A2.d.ts → types-Dr14pZxy.d.ts}

@@ -21,10 +21,15 @@ type ValueType<T> = T extends 'number' ? number : T extends 'string' ? string :
 
 type User = Document;
 type UserInfo = {
+    /** The user's unique identifier. */
     id: string;
+    /** The user's display handle. */
     handle: string;
+    /** The role strings assigned to this user in the database. */
     roles: string[];
+    /** Returns `true` if the user has the given role. */
     hasRole: (role: string) => boolean;
+    /** Throws an error if the user does not have the given role. */
     requireRole: (role: string) => void;
 };
 type Role = string;
@@ -35,9 +40,30 @@ type Session = {
     userId: ObjectId | null;
 };
 type Permission = string;
+/**
+ * Defines a role that can be assigned to users.
+ *
+ * Roles are registered via the `roles` option in {@link AppOptions} and
+ * are synced to the Modelence Cloud dashboard for user management.
+ *
+ * @example
+ * ```typescript
+ * import { startApp } from 'modelence/server';
+ *
+ * startApp({
+ *   roles: {
+ *     admin: { description: 'Full access to all features' },
+ *     editor: { description: 'Can edit content' },
+ *     viewer: {},
+ *   },
+ * });
+ * ```
+ */
 type RoleDefinition = {
+    /** Human-readable description of the role, shown in the Modelence Cloud dashboard. */
     description?: string;
-    permissions: Permission[];
+    /** @internal */
+    permissions?: Permission[];
 };
 type AuthProvider = 'google' | 'github' | 'email';
 type AuthSuccessProps = {
@@ -79,6 +105,7 @@ type Args = Record<string, unknown>;
 type Handler<T = unknown> = (args: Args, context: Context) => Promise<T> | T;
 type MethodType = 'query' | 'mutation';
 type MethodDefinition<T = unknown> = {
+    /** @internal */
     permissions?: Permission[];
     handler: Handler<T>;
 } | Handler<T>;

package/dist/{types-BBQnIN4-.d.ts → types-l1amQvLa.d.ts}

@@ -1,5 +1,5 @@
 import './index-CwdohC5n.js';
-import { i as Context } from './types-BOFsm7A2.js';
+import { i as Context } from './types-Dr14pZxy.js';
 import * as mongodb from 'mongodb';
 import { WithId, IndexDescription, SearchIndexDescription, MongoClient, Collection, FilterOperators, Document, FindOptions, ObjectId, OptionalUnlessRequiredId, InsertOneResult, InsertManyResult, UpdateFilter, UpdateResult, ClientSession, DeleteResult, AggregateOptions, AggregationCursor, AnyBulkWriteOperation, BulkWriteResult } from 'mongodb';
 import { z, ZodNumber, ZodArray } from 'zod';
@@ -30,7 +30,7 @@ interface EmailProvider {
     sendEmail(data: EmailPayload): Promise<void>;
 }
 
-type RateLimitType = 'ip' | 'user';
+type RateLimitType = 'ip' | 'user' | 'email';
 type RateLimitRule = {
     /** Logical action being limited, e.g. "signup" */
     bucket: string;

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 export { A as AppServer, E as ExpressMiddleware, M as ModelenceConfig } from './index-CwdohC5n.js';
-export { e as AppConfig, l as Args, d as AuthErrorProps, q as AuthProvider, A as AuthSuccessProps, j as ClientInfo, b as ConfigKey, C as ConfigSchema, o as ConfigType, p as Configs, k as ConnectionInfo, i as Context, D as DefaultRoles, H as Handler, n as Method, M as MethodDefinition, m as MethodType, P as Permission, h as Role, R as RoleDefinition, f as Session, U as User, g as UserInfo, a as WebsocketClientProvider, W as WebsocketServerProvider } from './types-BOFsm7A2.js';
-export { B as BodyConfig, h as CronJob, C as CronJobInputParams, i as CronJobMetadata, g as EmailAttachment, c as EmailPayload, E as EmailProvider, k as ExpressHandler, H as HttpMethod, I as InferDocumentType, M as ModelSchema, a as RateLimitRule, b as RateLimitType, R as RouteDefinition, d as RouteHandler, j as RouteHandlers, e as RouteParams, f as RouteResponse, s as schema } from './types-BBQnIN4-.js';
+export { e as AppConfig, l as Args, d as AuthErrorProps, q as AuthProvider, A as AuthSuccessProps, j as ClientInfo, b as ConfigKey, C as ConfigSchema, o as ConfigType, p as Configs, k as ConnectionInfo, i as Context, D as DefaultRoles, H as Handler, n as Method, M as MethodDefinition, m as MethodType, P as Permission, h as Role, R as RoleDefinition, f as Session, U as User, g as UserInfo, a as WebsocketClientProvider, W as WebsocketServerProvider } from './types-Dr14pZxy.js';
+export { B as BodyConfig, h as CronJob, C as CronJobInputParams, i as CronJobMetadata, g as EmailAttachment, c as EmailPayload, E as EmailProvider, k as ExpressHandler, H as HttpMethod, I as InferDocumentType, M as ModelSchema, a as RateLimitRule, b as RateLimitType, R as RouteDefinition, d as RouteHandler, j as RouteHandlers, e as RouteParams, f as RouteResponse, s as schema } from './types-l1amQvLa.js';
 import 'express';
 import 'http';
 import 'mongodb';

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "modelence",
-  "version": "0.12.3",
+  "version": "0.12.5-dev.1",
   "description": "The Node.js Framework for Real-Time MongoDB Apps",
   "main": "dist/index.js",
   "types": "dist/global.d.ts",

package/dist/chunk-Y7YZSGJG.js

@@ -1,3 +0,0 @@
-var s="module",i="modelence",r="0.12.3",o="The Node.js Framework for Real-Time MongoDB Apps",n="dist/index.js",p="dist/global.d.ts",c={".":"./dist/index.js","./client":"./dist/client.js","./server":"./dist/server.js","./telemetry":"./dist/telemetry.js","./mongodb":"./dist/mongo.js","./types":{types:"./dist/types.d.ts",default:"./dist/types.js"}},d=["dist","dist/bin"],l={modelence:"./dist/bin/modelence.js"},a={build:"tsup",dev:"tsup --watch",format:'prettier --write "src/**/*.{ts,tsx,js,jsx,json,css,md}"',"format:check":'prettier --check "src/**/*.{ts,tsx,js,jsx,json,css,md}"',lint:"eslint src --ext .ts,.tsx --fix","lint:check":"eslint src --ext .ts,.tsx",prepublishOnly:"npm run build",test:"NODE_OPTIONS=--experimental-vm-modules jest","test:watch":"NODE_OPTIONS=--experimental-vm-modules jest --watch","test:coverage":"NODE_OPTIONS=--experimental-vm-modules jest --coverage",postversion:"git push && git push --tags",prepare:"cd ../.. && git config core.hooksPath .husky"},m={type:"git",url:"git+https://github.com/modelence/modelence.git"},y="Modelence",u="SEE LICENSE IN LICENSE",j={url:"https://github.com/modelence/modelence/issues"},g="https://modelence.com",h={"@types/archiver":"^6.0.3","@types/bcrypt":"^6.0.0","@types/cookie-parser":"^1.4.9","@types/express":"^5.0.0","@types/fs-extra":"^11.0.4","@types/jest":"^30.0.0","@types/node":"^22.5.1","@types/react":"^19.0.0","@types/react-dom":"^19.0.1","@types/socket.io":"^3.0.1","@typescript-eslint/eslint-plugin":"^8.17.0","@typescript-eslint/parser":"^8.17.0",eslint:"^9.37.0",husky:"^9.1.7",jest:"^30.2.0","lint-staged":"^16.2.7",prettier:"^3.6.2",react:"^19.0.0","react-dom":"^19.0.0","ts-jest":"^29.4.5","ts-node":"^10.9.2"},x={"@socket.io/mongo-adapter":"^0.4.0","@vitejs/plugin-react":"^4.3.4",archiver:"^7.0.1",bcrypt:"^6.0.0",commander:"^12.0.0","cookie-parser":"^1.4.7",dotenv:"^16.4.5","elastic-apm-node":"^4.15.0",express:"^4.21.0","fs-extra":"^11.2.0",jiti:"^2.4.2",mongodb:"^6.8.1",open:"^10.1.0","socket.io":"^4.8.1","socket.io-client":"^4.8.1",tsup:"^8.3.6",tsx:"^4.19.3",typescript:"^5.7.2",vite:"^6.0.3","vite-plugin-eslint":"^1.8.1",winston:"^3.15.0","winston-elasticsearch":"^0.19.0",zod:"^3.23.8",zustand:"^5.0.2"},v={react:">=18.0.0","react-dom":">=18.0.0"},b={type:s,name:i,version:r,description:o,main:n,types:p,exports:c,files:d,bin:l,scripts:a,"lint-staged":{"src/**/*.{ts,tsx,js,jsx,json,css,md}":"prettier --write"},repository:m,author:y,license:u,bugs:j,homepage:g,devDependencies:h,dependencies:x,peerDependencies:v};
-export{s as a,i as b,r as c,o as d,n as e,p as f,c as g,d as h,l as i,a as j,m as k,y as l,u as m,j as n,g as o,h as p,x as q,v as r,b as s};//# sourceMappingURL=chunk-Y7YZSGJG.js.map
-//# sourceMappingURL=chunk-Y7YZSGJG.js.map

package/dist/chunk-Y7YZSGJG.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../package.json"],"names":["type","name","version","description","main","types","exports","files","bin","scripts","repository","author","license","bugs","homepage","devDependencies","dependencies","peerDependencies","package_default"],"mappings":"AACE,IAAAA,CAAAA,CAAQ,QAAA,CACRC,CAAAA,CAAQ,WAAA,CACRC,CAAAA,CAAW,SACXC,CAAAA,CAAe,kDAAA,CACfC,CAAAA,CAAQ,eAAA,CACRC,CAAAA,CAAS,kBAAA,CACTC,EAAW,CACT,GAAA,CAAK,iBAAA,CACL,UAAA,CAAY,kBAAA,CACZ,UAAA,CAAY,kBAAA,CACZ,aAAA,CAAe,qBAAA,CACf,WAAA,CAAa,iBAAA,CACb,SAAA,CAAW,CACT,KAAA,CAAS,oBACT,OAAA,CAAW,iBACb,CACF,CAAA,CACAC,CAAAA,CAAS,CACP,MAAA,CACA,UACF,CAAA,CACAC,CAAAA,CAAO,CACL,SAAA,CAAa,yBACf,CAAA,CACAC,EAAW,CACT,KAAA,CAAS,MAAA,CACT,GAAA,CAAO,cAAA,CACP,MAAA,CAAU,yDAAA,CACV,cAAA,CAAgB,yDAAA,CAChB,IAAA,CAAQ,iCAAA,CACR,YAAA,CAAc,2BAAA,CACd,cAAA,CAAkB,gBAClB,IAAA,CAAQ,6CAAA,CACR,YAAA,CAAc,qDAAA,CACd,eAAA,CAAiB,wDAAA,CACjB,YAAe,6BAAA,CACf,OAAA,CAAW,8CACb,CAAA,CAIAC,CAAAA,CAAc,CACZ,KAAQ,KAAA,CACR,GAAA,CAAO,gDACT,CAAA,CACAC,CAAAA,CAAU,WAAA,CACVC,CAAAA,CAAW,wBAAA,CACXC,CAAAA,CAAQ,CACN,GAAA,CAAO,+CACT,CAAA,CACAC,CAAAA,CAAY,wBACZC,CAAAA,CAAmB,CACjB,iBAAA,CAAmB,QAAA,CACnB,eAAA,CAAiB,QAAA,CACjB,sBAAA,CAAwB,QAAA,CACxB,gBAAA,CAAkB,QAAA,CAClB,iBAAA,CAAmB,SAAA,CACnB,aAAA,CAAe,SAAA,CACf,cAAe,SAAA,CACf,cAAA,CAAgB,SAAA,CAChB,kBAAA,CAAoB,SAAA,CACpB,kBAAA,CAAoB,QAAA,CACpB,kCAAA,CAAoC,SAAA,CACpC,2BAAA,CAA6B,SAAA,CAC7B,MAAA,CAAU,SAAA,CACV,KAAA,CAAS,SACT,IAAA,CAAQ,SAAA,CACR,aAAA,CAAe,SAAA,CACf,QAAA,CAAY,QAAA,CACZ,MAAS,SAAA,CACT,WAAA,CAAa,SAAA,CACb,SAAA,CAAW,SAAA,CACX,SAAA,CAAW,SACb,CAAA,CACAC,CAAAA,CAAgB,CACd,0BAAA,CAA4B,QAAA,CAC5B,sBAAA,CAAwB,QAAA,CACxB,QAAA,CAAY,QAAA,CACZ,MAAA,CAAU,QAAA,CACV,SAAA,CAAa,SAAA,CACb,eAAA,CAAiB,SACjB,MAAA,CAAU,SAAA,CACV,kBAAA,CAAoB,SAAA,CACpB,OAAA,CAAW,SAAA,CACX,UAAA,CAAY,SAAA,CACZ,IAAA,CAAQ,QAAA,CACR,OAAA,CAAW,QAAA,CACX,IAAA,CAAQ,SAAA,CACR,YAAa,QAAA,CACb,kBAAA,CAAoB,QAAA,CACpB,IAAA,CAAQ,QAAA,CACR,GAAA,CAAO,SAAA,CACP,UAAA,CAAc,QAAA,CACd,IAAA,CAAQ,QAAA,CACR,oBAAA,CAAsB,QAAA,CACtB,OAAA,CAAW,UACX,uBAAA,CAAyB,SAAA,CACzB,GAAA,CAAO,SAAA,CACP,OAAA,CAAW,QACb,EACAC,CAAAA,CAAoB,CAClB,KAAA,CAAS,UAAA,CACT,WAAA,CAAa,UACf,EAxGFC,CAAAA,CAAA,CACE,IAAA,CAAAlB,CAAAA,CACA,IAAA,CAAAC,CAAAA,CACA,OAAA,CAAAC,CAAAA,CACA,WAAA,CAAAC,CAAAA,CACA,IAAA,CAAAC,CAAAA,CACA,KAAA,CAAAC,CAAAA,CACA,QAAAC,CAAAA,CAWA,KAAA,CAAAC,CAAAA,CAIA,GAAA,CAAAC,CAAAA,CAGA,OAAA,CAAAC,CAAAA,CAcA,aAAA,CAAe,CACb,sCAAA,CAAwC,kBAC1C,CAAA,CACA,UAAA,CAAAC,CAAAA,CAIA,OAAAC,CAAAA,CACA,OAAA,CAAAC,CAAAA,CACA,IAAA,CAAAC,CAAAA,CAGA,QAAA,CAAAC,CAAAA,CACA,eAAA,CAAAC,CAAAA,CAuBA,YAAA,CAAAC,CAAAA,CA0BA,gBAAA,CAAAC,CAIF","file":"chunk-Y7YZSGJG.js","sourcesContent":["{\n  \"type\": \"module\",\n  \"name\": \"modelence\",\n  \"version\": \"0.12.3\",\n  \"description\": \"The Node.js Framework for Real-Time MongoDB Apps\",\n  \"main\": \"dist/index.js\",\n  \"types\": \"dist/global.d.ts\",\n  \"exports\": {\n    \".\": \"./dist/index.js\",\n    \"./client\": \"./dist/client.js\",\n    \"./server\": \"./dist/server.js\",\n    \"./telemetry\": \"./dist/telemetry.js\",\n    \"./mongodb\": \"./dist/mongo.js\",\n    \"./types\": {\n      \"types\": \"./dist/types.d.ts\",\n      \"default\": \"./dist/types.js\"\n    }\n  },\n  \"files\": [\n    \"dist\",\n    \"dist/bin\"\n  ],\n  \"bin\": {\n    \"modelence\": \"./dist/bin/modelence.js\"\n  },\n  \"scripts\": {\n    \"build\": \"tsup\",\n    \"dev\": \"tsup --watch\",\n    \"format\": \"prettier --write \\\"src/**/*.{ts,tsx,js,jsx,json,css,md}\\\"\",\n    \"format:check\": \"prettier --check \\\"src/**/*.{ts,tsx,js,jsx,json,css,md}\\\"\",\n    \"lint\": \"eslint src --ext .ts,.tsx --fix\",\n    \"lint:check\": \"eslint src --ext .ts,.tsx\",\n    \"prepublishOnly\": \"npm run build\",\n    \"test\": \"NODE_OPTIONS=--experimental-vm-modules jest\",\n    \"test:watch\": \"NODE_OPTIONS=--experimental-vm-modules jest --watch\",\n    \"test:coverage\": \"NODE_OPTIONS=--experimental-vm-modules jest --coverage\",\n    \"postversion\": \"git push && git push --tags\",\n    \"prepare\": \"cd ../.. && git config core.hooksPath .husky\"\n  },\n  \"lint-staged\": {\n    \"src/**/*.{ts,tsx,js,jsx,json,css,md}\": \"prettier --write\"\n  },\n  \"repository\": {\n    \"type\": \"git\",\n    \"url\": \"git+https://github.com/modelence/modelence.git\"\n  },\n  \"author\": \"Modelence\",\n  \"license\": \"SEE LICENSE IN LICENSE\",\n  \"bugs\": {\n    \"url\": \"https://github.com/modelence/modelence/issues\"\n  },\n  \"homepage\": \"https://modelence.com\",\n  \"devDependencies\": {\n    \"@types/archiver\": \"^6.0.3\",\n    \"@types/bcrypt\": \"^6.0.0\",\n    \"@types/cookie-parser\": \"^1.4.9\",\n    \"@types/express\": \"^5.0.0\",\n    \"@types/fs-extra\": \"^11.0.4\",\n    \"@types/jest\": \"^30.0.0\",\n    \"@types/node\": \"^22.5.1\",\n    \"@types/react\": \"^19.0.0\",\n    \"@types/react-dom\": \"^19.0.1\",\n    \"@types/socket.io\": \"^3.0.1\",\n    \"@typescript-eslint/eslint-plugin\": \"^8.17.0\",\n    \"@typescript-eslint/parser\": \"^8.17.0\",\n    \"eslint\": \"^9.37.0\",\n    \"husky\": \"^9.1.7\",\n    \"jest\": \"^30.2.0\",\n    \"lint-staged\": \"^16.2.7\",\n    \"prettier\": \"^3.6.2\",\n    \"react\": \"^19.0.0\",\n    \"react-dom\": \"^19.0.0\",\n    \"ts-jest\": \"^29.4.5\",\n    \"ts-node\": \"^10.9.2\"\n  },\n  \"dependencies\": {\n    \"@socket.io/mongo-adapter\": \"^0.4.0\",\n    \"@vitejs/plugin-react\": \"^4.3.4\",\n    \"archiver\": \"^7.0.1\",\n    \"bcrypt\": \"^6.0.0\",\n    \"commander\": \"^12.0.0\",\n    \"cookie-parser\": \"^1.4.7\",\n    \"dotenv\": \"^16.4.5\",\n    \"elastic-apm-node\": \"^4.15.0\",\n    \"express\": \"^4.21.0\",\n    \"fs-extra\": \"^11.2.0\",\n    \"jiti\": \"^2.4.2\",\n    \"mongodb\": \"^6.8.1\",\n    \"open\": \"^10.1.0\",\n    \"socket.io\": \"^4.8.1\",\n    \"socket.io-client\": \"^4.8.1\",\n    \"tsup\": \"^8.3.6\",\n    \"tsx\": \"^4.19.3\",\n    \"typescript\": \"^5.7.2\",\n    \"vite\": \"^6.0.3\",\n    \"vite-plugin-eslint\": \"^1.8.1\",\n    \"winston\": \"^3.15.0\",\n    \"winston-elasticsearch\": \"^0.19.0\",\n    \"zod\": \"^3.23.8\",\n    \"zustand\": \"^5.0.2\"\n  },\n  \"peerDependencies\": {\n    \"react\": \">=18.0.0\",\n    \"react-dom\": \">=18.0.0\"\n  }\n}\n"]}