@convex-dev/platform 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +7 -0
  2. package/dist/client.cjs +47 -0
  3. package/dist/client.cjs.map +1 -0
  4. package/dist/client.d.cts +14 -0
  5. package/dist/client.d.cts.map +1 -0
  6. package/dist/client.d.ts +14 -0
  7. package/dist/client.d.ts.map +1 -0
  8. package/dist/client.js +39 -0
  9. package/dist/client.js.map +1 -0
  10. package/dist/generatedDeploymentApi.cjs +7 -0
  11. package/dist/generatedDeploymentApi.cjs.map +1 -0
  12. package/dist/generatedDeploymentApi.d.cts +787 -0
  13. package/dist/generatedDeploymentApi.d.cts.map +1 -0
  14. package/dist/generatedDeploymentApi.d.ts +787 -0
  15. package/dist/generatedDeploymentApi.d.ts.map +1 -0
  16. package/dist/generatedDeploymentApi.js +6 -0
  17. package/dist/generatedDeploymentApi.js.map +1 -0
  18. package/dist/generatedLogStreamApi.cjs +7 -0
  19. package/dist/generatedLogStreamApi.cjs.map +1 -0
  20. package/dist/generatedLogStreamApi.d.cts +149 -0
  21. package/dist/generatedLogStreamApi.d.cts.map +1 -0
  22. package/dist/generatedLogStreamApi.d.ts +149 -0
  23. package/dist/generatedLogStreamApi.d.ts.map +1 -0
  24. package/dist/generatedLogStreamApi.js +6 -0
  25. package/dist/generatedLogStreamApi.js.map +1 -0
  26. package/dist/generatedManagementApi.cjs +7 -0
  27. package/dist/generatedManagementApi.cjs.map +1 -0
  28. package/dist/generatedManagementApi.d.cts +924 -0
  29. package/dist/generatedManagementApi.d.cts.map +1 -0
  30. package/dist/generatedManagementApi.d.ts +924 -0
  31. package/dist/generatedManagementApi.d.ts.map +1 -0
  32. package/dist/generatedManagementApi.js +6 -0
  33. package/dist/generatedManagementApi.js.map +1 -0
  34. package/dist/index.cjs +18 -0
  35. package/dist/index.cjs.map +1 -0
  36. package/dist/index.d.cts +2 -0
  37. package/dist/index.d.cts.map +1 -0
  38. package/dist/index.d.ts +2 -0
  39. package/dist/index.d.ts.map +1 -0
  40. package/dist/index.js +2 -0
  41. package/dist/index.js.map +1 -0
  42. package/dist/version.cjs +5 -0
  43. package/dist/version.cjs.map +1 -0
  44. package/dist/version.d.cts +2 -0
  45. package/dist/version.d.cts.map +1 -0
  46. package/dist/version.d.ts +2 -0
  47. package/dist/version.d.ts.map +1 -0
  48. package/dist/version.js +2 -0
  49. package/dist/version.js.map +1 -0
  50. package/package.json +69 -0
package/README.md ADDED
@@ -0,0 +1,7 @@
1
+ # Convex management APIs
2
+
3
+ A client wrapping the management APIs available at
4
+
5
+ https://provision.convex.dev/v1/openapi.json
6
+
7
+ as well as the deployment APIs available on every Convex backend.
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.provisionHost = exports.productionProvisionHost = void 0;
7
+ exports.createManagementClient = createManagementClient;
8
+ exports.createDeploymentClient = createDeploymentClient;
9
+ const openapi_fetch_1 = __importDefault(require("openapi-fetch"));
10
+ const version_js_1 = require("./version.cjs");
11
+ exports.productionProvisionHost = "https://api.convex.dev";
12
+ exports.provisionHost = globalThis?.process?.env?.CONVEX_PROVISION_HOST ||
13
+ exports.productionProvisionHost;
14
+ function createManagementClient(accessToken) {
15
+ const baseUrl = `${exports.provisionHost}/v1`;
16
+ const auth = {
17
+ kind: "accessToken",
18
+ accessToken,
19
+ };
20
+ const headers = {
21
+ // Yep, even API keys go use Bearer. Everyone else does it.
22
+ Authorization: `Bearer ${auth.accessToken}`,
23
+ "Convex-Client": `convex-platform-${version_js_1.version}`,
24
+ };
25
+ const client = (0, openapi_fetch_1.default)({
26
+ baseUrl,
27
+ headers,
28
+ });
29
+ return client;
30
+ }
31
+ function createDeploymentClient(nameOrUrl, token) {
32
+ const deploymentUrl = nameOrUrl.startsWith("http")
33
+ ? nameOrUrl
34
+ : `https://${nameOrUrl}.convex.cloud`;
35
+ const baseUrl = `${deploymentUrl}/api/v1`;
36
+ const headers = {
37
+ // Yep, even API keys go use Bearer. Everyone else does it.
38
+ Authorization: `Convex ${token}`,
39
+ "Convex-Client": `convex-platform-${version_js_1.version}`,
40
+ };
41
+ const client = (0, openapi_fetch_1.default)({
42
+ baseUrl,
43
+ headers,
44
+ });
45
+ return client;
46
+ }
47
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAoBA,wDAmBC;AAED,wDAiBC;AA1DD,kEAAyC;AAKzC,8CAAuC;AAK1B,QAAA,uBAAuB,GAAG,wBAAwB,CAAC;AACnD,QAAA,aAAa,GACvB,UAAkB,EAAE,OAAO,EAAE,GAAG,EAAE,qBAAqB;IACxD,+BAAuB,CAAC;AAO1B,SAAgB,sBAAsB,CAAC,WAAmB;IACxD,MAAM,OAAO,GAAG,GAAG,qBAAa,KAAK,CAAC;IAEtC,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,aAAa;QACnB,WAAW;KACZ,CAAC;IAEF,MAAM,OAAO,GAA2B;QACtC,2DAA2D;QAC3D,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;QAC3C,eAAe,EAAE,mBAAmB,oBAAO,EAAE;KAC9C,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,uBAAY,EAAwB;QACjD,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,sBAAsB,CAAC,SAAiB,EAAE,KAAa;IACrE,MAAM,aAAa,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;QAChD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,WAAW,SAAS,eAAe,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,aAAa,SAAS,CAAC;IAE1C,MAAM,OAAO,GAA2B;QACtC,2DAA2D;QAC3D,aAAa,EAAE,UAAU,KAAK,EAAE;QAChC,eAAe,EAAE,mBAAmB,oBAAO,EAAE;KAC9C,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,uBAAY,EAAwB;QACjD,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -0,0 +1,14 @@
1
+ import type { paths as ConvexManagementPaths } from "./generatedManagementApi.cjs";
2
+ import type { paths as ConvexDeploymentPaths } from "./generatedDeploymentApi.cjs";
3
+ import type { paths as ConvexEventLogPaths } from "./generatedLogStreamApi.cjs";
4
+ type ConvexEventLog = ConvexEventLogPaths["schemas"];
5
+ export type { ConvexEventLog };
6
+ export declare const productionProvisionHost = "https://api.convex.dev";
7
+ export declare const provisionHost: any;
8
+ export type ConvexAuth = {
9
+ kind: "accessToken";
10
+ accessToken: string;
11
+ };
12
+ export declare function createManagementClient(accessToken: string): import("openapi-fetch").Client<ConvexManagementPaths, `${string}/${string}`>;
13
+ export declare function createDeploymentClient(nameOrUrl: string, token: string): import("openapi-fetch").Client<ConvexDeploymentPaths, `${string}/${string}`>;
14
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,IAAI,qBAAqB,EAAE,qCAAoC;AAClF,OAAO,KAAK,EAAE,KAAK,IAAI,qBAAqB,EAAE,qCAAoC;AAClF,OAAO,KAAK,EAAE,KAAK,IAAI,mBAAmB,EAAE,oCAAmC;AAG/E,KAAK,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;AACrD,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,eAAO,MAAM,uBAAuB,2BAA2B,CAAC;AAChE,eAAO,MAAM,aAAa,KAED,CAAC;AAE1B,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,gFAmBzD;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,gFAiBtE"}
@@ -0,0 +1,14 @@
1
+ import type { paths as ConvexManagementPaths } from "./generatedManagementApi.js";
2
+ import type { paths as ConvexDeploymentPaths } from "./generatedDeploymentApi.js";
3
+ import type { paths as ConvexEventLogPaths } from "./generatedLogStreamApi.js";
4
+ type ConvexEventLog = ConvexEventLogPaths["schemas"];
5
+ export type { ConvexEventLog };
6
+ export declare const productionProvisionHost = "https://api.convex.dev";
7
+ export declare const provisionHost: any;
8
+ export type ConvexAuth = {
9
+ kind: "accessToken";
10
+ accessToken: string;
11
+ };
12
+ export declare function createManagementClient(accessToken: string): import("openapi-fetch").Client<ConvexManagementPaths, `${string}/${string}`>;
13
+ export declare function createDeploymentClient(nameOrUrl: string, token: string): import("openapi-fetch").Client<ConvexDeploymentPaths, `${string}/${string}`>;
14
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,IAAI,qBAAqB,EAAE,oCAAoC;AAClF,OAAO,KAAK,EAAE,KAAK,IAAI,qBAAqB,EAAE,oCAAoC;AAClF,OAAO,KAAK,EAAE,KAAK,IAAI,mBAAmB,EAAE,mCAAmC;AAG/E,KAAK,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;AACrD,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,eAAO,MAAM,uBAAuB,2BAA2B,CAAC;AAChE,eAAO,MAAM,aAAa,KAED,CAAC;AAE1B,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,gFAmBzD;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,gFAiBtE"}
package/dist/client.js ADDED
@@ -0,0 +1,39 @@
1
+ import createClient from "openapi-fetch";
2
+ import { version } from "./version.js";
3
+ export const productionProvisionHost = "https://api.convex.dev";
4
+ export const provisionHost = globalThis?.process?.env?.CONVEX_PROVISION_HOST ||
5
+ productionProvisionHost;
6
+ export function createManagementClient(accessToken) {
7
+ const baseUrl = `${provisionHost}/v1`;
8
+ const auth = {
9
+ kind: "accessToken",
10
+ accessToken,
11
+ };
12
+ const headers = {
13
+ // Yep, even API keys go use Bearer. Everyone else does it.
14
+ Authorization: `Bearer ${auth.accessToken}`,
15
+ "Convex-Client": `convex-platform-${version}`,
16
+ };
17
+ const client = createClient({
18
+ baseUrl,
19
+ headers,
20
+ });
21
+ return client;
22
+ }
23
+ export function createDeploymentClient(nameOrUrl, token) {
24
+ const deploymentUrl = nameOrUrl.startsWith("http")
25
+ ? nameOrUrl
26
+ : `https://${nameOrUrl}.convex.cloud`;
27
+ const baseUrl = `${deploymentUrl}/api/v1`;
28
+ const headers = {
29
+ // Yep, even API keys go use Bearer. Everyone else does it.
30
+ Authorization: `Convex ${token}`,
31
+ "Convex-Client": `convex-platform-${version}`,
32
+ };
33
+ const client = createClient({
34
+ baseUrl,
35
+ headers,
36
+ });
37
+ return client;
38
+ }
39
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAKzC,OAAO,EAAE,OAAO,EAAE,qBAAqB;AAKvC,MAAM,CAAC,MAAM,uBAAuB,GAAG,wBAAwB,CAAC;AAChE,MAAM,CAAC,MAAM,aAAa,GACvB,UAAkB,EAAE,OAAO,EAAE,GAAG,EAAE,qBAAqB;IACxD,uBAAuB,CAAC;AAO1B,MAAM,UAAU,sBAAsB,CAAC,WAAmB;IACxD,MAAM,OAAO,GAAG,GAAG,aAAa,KAAK,CAAC;IAEtC,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,aAAa;QACnB,WAAW;KACZ,CAAC;IAEF,MAAM,OAAO,GAA2B;QACtC,2DAA2D;QAC3D,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;QAC3C,eAAe,EAAE,mBAAmB,OAAO,EAAE;KAC9C,CAAC;IAEF,MAAM,MAAM,GAAG,YAAY,CAAwB;QACjD,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,SAAiB,EAAE,KAAa;IACrE,MAAM,aAAa,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC;QAChD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,WAAW,SAAS,eAAe,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,aAAa,SAAS,CAAC;IAE1C,MAAM,OAAO,GAA2B;QACtC,2DAA2D;QAC3D,aAAa,EAAE,UAAU,KAAK,EAAE;QAChC,eAAe,EAAE,mBAAmB,OAAO,EAAE;KAC9C,CAAC;IAEF,MAAM,MAAM,GAAG,YAAY,CAAwB;QACjD,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by openapi-typescript.
4
+ * Do not make direct changes to the file.
5
+ */
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ //# sourceMappingURL=generatedDeploymentApi.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generatedDeploymentApi.js","sourceRoot":"","sources":["../src/generatedDeploymentApi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}