UNPKG

convex

Version:

Client for the Convex Cloud

236 lines 8.85 kB
{ "name": "convex", "description": "Client for the Convex Cloud", "version": "0.6.0", "author": "Convex, Inc. <team@convex.dev>", "homepage": "https://convex.dev", "main": "./dist/cjs/index.js", "module": "./dist/esm/index.js", "types": "./dist/types/index.d.ts", "sideEffects": false, "exports": { ".": { "types": "./dist/types/index.d.ts", "import": "./dist/esm/index.js", "require": "./dist/cjs/index.js" }, "./schema": { "types": "./dist/types/schema/schema.d.ts", "import": "./dist/esm/schema/index.js", "require": "./dist/cjs/schema/index.js" }, "./server": { "types": "./dist/types/server/server.d.ts", "import": "./dist/esm/server/index.js", "require": "./dist/cjs/server/index.js" }, "./server-internal": { "types": "./dist/types/server/server-internal.d.ts", "import": "./dist/esm/server/index.js", "require": "./dist/cjs/server/index.js" }, "./react": { "types": "./dist/types/react/react.d.ts", "import": "./dist/esm/react/index.js", "require": "./dist/cjs/react/index.js" }, "./react-internal": { "types": "./dist/types/server/react-internal.d.ts", "import": "./dist/esm/react/index.js", "require": "./dist/cjs/react/index.js" }, "./react-auth0": { "types": "./dist/types/react-auth0/react-auth0.d.ts", "import": "./dist/esm/react-auth0/index.js", "require": "./dist/cjs/react-auth0/index.js" }, "./browser": { "types": "./dist/types/browser/browser.d.ts", "import": "./dist/esm/browser/index.js", "require": "./dist/cjs/browser/index.js" }, "./browser-internal": { "types": "./dist/types/browser/browser-internal.d.ts", "import": "./dist/esm/browser/index.js", "require": "./dist/cjs/browser/index.js" }, "./values": { "types": "./dist/types/values/values.d.ts", "import": "./dist/esm/values/index.js", "require": "./dist/cjs/values/index.js" }, "./common": { "types": "./dist/types/common/index.d.ts", "import": "./dist/esm/common/index.js", "require": "./dist/cjs/common/index.js" }, "./environment": { "types": "./dist/types/environment/index.d.ts" }, "./api": { "types": "./dist/types/api/index.d.ts" }, "./package.json": "./package.json" }, "@comment typesVersions": [ "This type field in exports was not supported until 4.7" ], "typesVersions": { "<=4.6": { "*": [ "./dist/types/index.d.ts" ], "schema": [ "./dist/types/schema/schema.d.ts" ], "server": [ "./dist/types/server/server.d.ts" ], "server-internal": [ "./dist/types/server/server-internal.d.ts" ], "react": [ "./dist/types/react/react.d.ts" ], "react-internal": [ "./dist/types/react/react-internal.d.ts" ], "react-auth0": [ "./dist/types/react-auth0/react-auth0.d.ts" ], "browser": [ "./dist/types/browser/browser.d.ts" ], "browser-internal": [ "./dist/types/browser/browser-internal.d.ts" ], "values": [ "./dist/types/values/values.d.ts" ], "common": [ "./dist/esm/common/index.d.ts" ], "environment": [ "./dist/types/environment/index.d.ts" ] } }, "bin": { "convex": "bin/main.js" }, "keywords": [ "convex", "database", "react", "state", "serverless" ], "license": "MIT", "@comment dependencies": [ "CLI tool dependencies are listed in devDependencies instead." ], "dependencies": { "base64-js": "^1.5.1", "encoding": "^0.1.13", "esbuild": "^0.15.16", "node-fetch": "^2.6.1", "uuid": "^9.0.0" }, "peerDependencies": { "react": "^17.0.2 || ^18.0.0", "react-dom": "^17.0.2 || ^18.0.0", "@auth0/auth0-react": "^1.9.0" }, "peerDependenciesMeta": { "react": { "optional": true }, "react-dom": { "optional": true }, "@auth0/auth0-react": { "optional": true } }, "@comment devDependencies": [ "The dependencies of the CLI are also in devDependencies, built into", "a bundle." ], "devDependencies": { "@auth0/auth0-react": "^1.12.0", "@jest/globals": "^28.1.0", "@microsoft/api-extractor": "^7.33.6", "@sentry/node": "^7.23.0", "@sentry/tracing": "^7.23.0", "@testing-library/react-hooks": "~8.0.1", "@types/base64-js": "^1.3.0", "@types/deep-equal": "1.0.1", "@types/http-proxy": "~1.17.9", "@types/inquirer": "^8.2.0", "@types/jest": "^28.1.0", "@types/node": "^16.11.12", "@types/node-fetch": "^2.6.1", "@types/prettier": "^2.7.1", "@types/react": "^17.0.47", "@types/react-dom": "^17.0.17", "@types/semver": "^7.3.13", "@types/uuid": "^8.3.4", "@types/ws": "^8.5.3", "@typescript-eslint/eslint-plugin": "^5.45.0", "@typescript-eslint/parser": "^5.45.0", "axios": "^0.27.2", "axios-retry": "^3.2.4", "boxen": "~7.0.0", "bufferutil": "^4.0.7", "chalk": "4", "chokidar": "3.5.3", "commander": "^9.4.1", "deep-equal": "2.1.0", "depcheck": "~1.4.3", "envfile": "6.18.0", "esbuild": "^0.15.16", "esbuild-plugin-external-global": "~1.0.1", "eslint": "^8.29.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-react": "^7.31.11", "eslint-plugin-react-hooks": "^4.6.0", "http-proxy": "~1.18.1", "inquirer": "^9.1.4", "jest": "^27.1.0", "jest-environment-jsdom": "^27.1.0", "open": "^8.3.0", "openid-client": "^5.3.1", "ora": "^6.1.0", "prettier": "^2.8.0", "semver": "^7.3.8", "shx": "~0.3.4", "strip-ansi": "^7.0.1", "ts-jest": "^27.1.3", "typedoc": "^0.23.21", "typescript": "~4.8.4", "utf-8-validate": "^5.0.10", "ws": "^8.11.0", "zod": "^3.19.1" }, "engines": { "npm": ">=7.0.0", "node": ">=14.17.0" }, "scripts": { "build": "npm run clean && shx mkdir -p dist/ && python3 build.py 2>&1", "build-types": "tsc && tsc -p src/cli/tsconfig.json", "build-esm": "shx mkdir -p dist/esm && echo '{\"type\": \"module\"}' > dist/esm/package.json && node build.cjs esm && npm run build-environment", "build-cjs": "shx mkdir -p dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json && node build.cjs cjs", "build-environment": "shx mkdir -p dist/types/environment dist/types/esm && shx cp src/environment/index.d.ts dist/types/environment && shx cp src/environment/index.d.ts dist/esm/environment", "build-api": "api-extractor run -c", "build-browser-script-tag": "node build.cjs browser-script-tag", "build-react-script-tag": "node build.cjs react-script-tag", "build-standalone-cli": "node build.cjs standalone-cli", "bundle-server": "node bundle-server.mjs", "clean": "shx rm -rf dist", "lint": "eslint . --ext .js,.jsx,.ts,.tsx", "test": "NODE_OPTIONS=--experimental-vm-modules jest && ./checkdeps.mjs", "test-esm": "node ./test-esm.mjs" }, "readme": "# Convex\n\n**Convex is the reactive backend-as-a-service for web developers.**\n\nConvex makes it dead simple to store your app's shared state and sync it\neverywhere. As a developer, you interact with your shared state using JavaScript\nor TypeScript functions and bind that state to your reactive app.\n\nRealtime updates are automatic. Every user everywhere sees the current version\nof your state.\n\nConvex is fully serverless and automatically handles caching and scaling.\n\n**Get started at [docs.convex.dev](https://docs.convex.dev)!**\n\nThis package includes several separate entry points for building apps on Convex:\n\n- [`convex/server`](https://docs.convex.dev/api/modules/server): Helpers for\n implementing Convex functions.\n- [`convex/react`](https://docs.convex.dev/api/modules/react): Hooks and a\n `ConvexReactClient` for integrating Convex into React applications.\n- [`convex/browser`](https://docs.convex.dev/api/modules/browser): A\n `ConvexHttpClient` for using Convex in other browser environments.\n- [`convex/values`](https://docs.convex.dev/api/modules/values): Utilities for\n working with values stored in Convex.\n- [`convex/schema`](https://docs.convex.dev/api/modules/schema): Utilities for\n defining the schema of your Convex project.\n- [`convex/react-auth0`](https://docs.convex.dev/api/modules/values): A React\n component for authenticating users with Auth0.\n\nThis package also includes [`convex`](https://docs.convex.dev/using/cli), a\ncommand-line interface for managing Convex projects.\n\n---\n\n_Looking for the Angular ORM named Convex? See\n[github.com/bendrucker/convex](https://github.com/bendrucker/convex)_\n\n---\n" }