convex 1.13.0-alpha.1 → 1.13.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## 1.13.0-alpha.1
+
+- Convex queries, mutations, and actions now accept `returns:` property to
+  specify a return value validator.
+
+  Return value validators throw a runtime error (so will roll back the
+  transaction in a mutation) when the value returned from a query or mutation
+  does not match this validator. This is _stricter than TypeScript_ in that
+  extra properties will not be allowed.
+
+- Validator fields are now exposed: the return value of `v.object({ ... })` now
+  has a `.fields` property with the validators for each property on it.
+
+  ```
+  const message = v.object({ user: v.string(), body: v.string() });
+  const imageMessage = v.object({ ...message.fields, })
+  ```
+
+  These validators are also exposed on the schema at
+  `schema.tables.messages.validator`
+
+  The `Validator` export is no longer a class. It is now a discriminated union
+  type of all validators where the `.kind` as the discriminator. The `Validator`
+  type still has three type parameters with only the first (the TypeScript type
+  enforced by the validator) required.
+
+  These are breaking changes if you're using the two optional type parameters of
+  `Validator` or doing `instanceof` checks with `Validator`! We apologize for
+  the inconvenience. The same users this affects should be the ones that most
+  benefit from the ability to work with validator types more directly.
+
+- Argument validators now accept validators (object validators and union
+  validators) in addition to objects with validators as properties. Return value
+  validators similarly accept either validators or objects with validators as
+  properties, but unlike `args:` any validator is allowed.
+
+  Custom function wrappers (AKA middleware) should continue to work, but to
+  present the same API has the builtin Convex function wrappers `query`,
+  `internalQuery`, `mutation` etc. you'll need to update such code to accept
+  either a validator or an object of validators. You'll likely want to update
+  these anyway to support return value validators. The new `asValidator` helper
+  maybe useful here.
+
+- The default tsconfig.json created in projects when first creating the
+  `convex/` directory now uses `"moduleResolution": "Bundler"`. This is just a
+  better default, you
+  [probably never want the previous default `"node"`/`"node10"`](https://www.typescriptlang.org/tsconfig/#moduleResolution).
+
 ## 1.12.1
 
 - Fix bug where `npx convex deploy` and `npx convex dev` would incorrectly skip

package/bin/main-dev

@@ -3,9 +3,9 @@
 
 if [ "$(uname)" == "Darwin" ] || [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
   SCRIPTDIR="$(echo "$0" | python3 -c 'import os; print(os.path.dirname(os.path.realpath(input())))')"
-  "exec" "$SCRIPTDIR/../node_modules/.bin/ts-node-esm" "--swc" "$SCRIPTDIR/../src/cli/index.ts" "$@"
+  CONVEX_RUNNING_LIVE_IN_MONOREPO=1 "exec" "$SCRIPTDIR/../node_modules/.bin/tsx" "$SCRIPTDIR/../src/cli/index.ts" "$@"
 else # it's probably Windows
   # This doesn't follow symlinks quite as correctly as the Mac/Linux solution above
   CONVEXDIR="$(dirname "$(dirname "$0")")"
-  "exec" "$CONVEXDIR/node_modules/.bin/ts-node-esm" "--swc" "$CONVEXDIR/src/cli/index.ts" "$@"
+  CONVEX_RUNNING_LIVE_IN_MONOREPO=1 "exec" "$CONVEXDIR/node_modules/.bin/tsx" "$CONVEXDIR/src/cli/index.ts" "$@"
 fi

package/dist/browser.bundle.js

@@ -28,7 +28,7 @@ var convex = (() => {
   });
 
   // src/index.ts
-  var version = "1.13.0-alpha.1";
+  var version = "1.13.0";
 
   // src/values/base64.ts
   var base64_exports = {};