add ./convex.config.js entrypoint

Author: ianmacartney

README.md

@@ -6,25 +6,31 @@
 
 <!-- START: Include on https://convex.dev/components -->
 
-This component adds a geospatial index to Convex, allowing you to efficiently store and query points on the Earth's surface.
+This component adds a geospatial index to Convex, allowing you to efficiently
+store and query points on the Earth's surface.
 
-- Insert points into the geospatial key value store along with their geographic coordinates.
+- Insert points into the geospatial key value store along with their geographic
+  coordinates.
 - Efficiently query for all points within a given rectangle on the sphere.
 - Control the sort order for the results with a custom sorting key.
 - Filter query results with equality and `IN` clauses.
-- And since it's built on Convex, everything is automatically consistent, reactive, and cached!
+- And since it's built on Convex, everything is automatically consistent,
+  reactive, and cached!
 
-This component is currently in beta. It's missing some functionality, but what's there should work. We've tested the example
-app up to about 1,000,000 points, so reach out if you're using a much larger dataset.
-If you find a bug or have a feature request, you can [file it here](https://github.com/get-convex/geospatial/issues).
+This component is currently in beta. It's missing some functionality, but what's
+there should work. We've tested the example app up to about 1,000,000 points, so
+reach out if you're using a much larger dataset. If you find a bug or have a
+feature request, you can
+[file it here](https://github.com/get-convex/geospatial/issues).
 
 ## Pre-requisite: Convex
 
-You'll need an existing Convex project to use the component.
-Convex is a hosted backend platform, including a database, serverless functions,
-and a ton more you can learn about [here](https://docs.convex.dev/get-started).
+You'll need an existing Convex project to use the component. Convex is a hosted
+backend platform, including a database, serverless functions, and a ton more you
+can learn about [here](https://docs.convex.dev/get-started).
 
-Run `npm create convex` or follow any of the [quickstarts](https://docs.convex.dev/home) to set one up.
+Run `npm create convex` or follow any of the
+[quickstarts](https://docs.convex.dev/home) to set one up.
 
 ## Installation
 
@@ -34,11 +40,12 @@ First, add `@convex-dev/geospatial` to your Convex project:
 npm install @convex-dev/geospatial
 ```
 
-Then, install the component into your Convex project within the `convex/convex.config.ts` file:
+Then, install the component into your Convex project within the
+`convex/convex.config.ts` file:
 
 ```ts
 // convex/convex.config.ts
-import geospatial from "@convex-dev/geospatial/convex.config";
+import geospatial from "@convex-dev/geospatial/convex.config.js";
 import { defineApp } from "convex/server";
 
 const app = defineApp();
@@ -47,7 +54,8 @@ app.use(geospatial);
 export default app;
 ```
 
-Finally, create a new `GeospatialIndex` within your `convex/` folder, and point it to the installed component:
+Finally, create a new `GeospatialIndex` within your `convex/` folder, and point
+it to the installed component:
 
 ```ts
 // convex/index.ts
@@ -59,9 +67,10 @@ const geospatial = new GeospatialIndex(components.geospatial);
 
 ## Inserting points
 
-After installing the component, you can `insert`, `get`, and `remove` points from the index. You can specify
-a `filterKeys` record for filtering at query time and optionally a `sortKey` for the query result order. We
-currently only support ascending order on the `sortKey`.
+After installing the component, you can `insert`, `get`, and `remove` points
+from the index. You can specify a `filterKeys` record for filtering at query
+time and optionally a `sortKey` for the query result order. We currently only
+support ascending order on the `sortKey`.
 
 ```ts
 // convex/index.ts
@@ -85,9 +94,11 @@ const example = mutation({
 });
 ```
 
-If you would like some more typesafety, you can specify a type argument for the `GeospatialIndex` class. This
-will also provide you with auto-complete for the `filterKeys` and `sortKey` parameters.
-Above the key was "American Museum of Natural History" but most commonly the `key` will be an ID in another table of yours.
+If you would like some more typesafety, you can specify a type argument for the
+`GeospatialIndex` class. This will also provide you with auto-complete for the
+`filterKeys` and `sortKey` parameters. Above the key was "American Museum of
+Natural History" but most commonly the `key` will be an ID in another table of
+yours.
 
 ```ts
 // convex/index.ts
@@ -125,13 +136,13 @@ const example = query({
 });
 ```
 
-This query will find all points that lie within the query rectangle, sort them in ascending
-`sortKey` order, and return at most 16 results.
+This query will find all points that lie within the query rectangle, sort them
+in ascending `sortKey` order, and return at most 16 results.
 
 You can optionally add filter conditions to queries.
 
-The first type of filter condition is an `in()` filter, which requires that a matching
-document have a filter field with a value in a specified set.
+The first type of filter condition is an `in()` filter, which requires that a
+matching document have a filter field with a value in a specified set.
 
 ```ts
 // convex/index.ts
@@ -153,8 +164,8 @@ const example = query({
 });
 ```
 
-The second type of filter condition is an `eq()` filter, which requires that a matching
-document have a filter field with a value equal to a specified value.
+The second type of filter condition is an `eq()` filter, which requires that a
+matching document have a filter field with a value equal to a specified value.
 
 ```ts
 // convex/index.ts
@@ -170,7 +181,9 @@ const example = query({
 });
 ```
 
-The final type of filter condition allows you to specify ranges over the `sortKey`. We currently only support (optional) inclusive lower bounds and exclusive upper bounds.
+The final type of filter condition allows you to specify ranges over the
+`sortKey`. We currently only support (optional) inclusive lower bounds and
+exclusive upper bounds.
 
 ```ts
 // convex/index.ts
@@ -192,10 +205,13 @@ const example = query({
 });
 ```
 
-Queries take in a `limit`, which bounds the maximum number of rows returned. If this limit is hit,
-the query will return a `nextCursor` for continuation. The query may also return a `nextCursor` with fewer than `limit` results if it runs out of its IO budget while executing.
+Queries take in a `limit`, which bounds the maximum number of rows returned. If
+this limit is hit, the query will return a `nextCursor` for continuation. The
+query may also return a `nextCursor` with fewer than `limit` results if it runs
+out of its IO budget while executing.
 
-In either case, you can continue the stream by passing `nextCursor` to the next call's `cursor` parameter.
+In either case, you can continue the stream by passing `nextCursor` to the next
+call's `cursor` parameter.
 
 ```ts
 // convex/index.ts
@@ -234,11 +250,13 @@ const example = query({
 });
 ```
 
-**Note: you typically pass the `nextCursor` in from a client that is paginating through results, to avoid loading too much data in a single query.**
+**Note: you typically pass the `nextCursor` in from a client that is paginating
+through results, to avoid loading too much data in a single query.**
 
 ## Querying the points nearest a query point
 
-You can also query for the points closest to a given point, optionally limiting to a maximum distance (in meters).
+You can also query for the points closest to a given point, optionally limiting
+to a maximum distance (in meters).
 
 ```ts
 // convex/index.ts
@@ -258,11 +276,13 @@ const example = query({
 });
 ```
 
-The `maxDistance` parameter is optional, but providing it can greatly speed up searching the index.
+The `maxDistance` parameter is optional, but providing it can greatly speed up
+searching the index.
 
 ## Example
 
-See [`example/`](./example/) for a full example with a [Leaflet](https://leafletjs.com/)-based frontend.
+See [`example/`](./example/) for a full example with a
+[Leaflet](https://leafletjs.com/)-based frontend.
 
 ## Development
 
@@ -275,7 +295,8 @@ npm install
 npm run dev
 ```
 
-The component definition is in `src/` and reflects what users of the component will install. The example app,
-which is entirely independent, lives in `example/`.
+The component definition is in `src/` and reflects what users of the component
+will install. The example app, which is entirely independent, lives in
+`example/`.
 
 <!-- END: Include on https://convex.dev/components -->

package.json

@@ -58,6 +58,10 @@
     "./convex.config": {
       "types": "./dist/component/convex.config.d.ts",
       "default": "./dist/component/convex.config.js"
+    },
+    "./convex.config.js": {
+      "types": "./dist/component/convex.config.d.ts",
+      "default": "./dist/component/convex.config.js"
     }
   },
   "dependencies": {