convex-helpers 0.1.86 → 0.1.87
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.
- package/browser.d.ts +2 -2
- package/browser.d.ts.map +1 -1
- package/browser.ts +2 -2
- package/package.json +2 -2
- package/server/rateLimit.d.ts +2 -3
- package/server/rateLimit.d.ts.map +1 -1
- package/server/rateLimit.ts +2 -2
package/browser.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { BetterOmit, EmptyObject } from "./index.js";
|
|
2
|
-
import type { ConvexClient } from "convex/browser";
|
|
2
|
+
import type { ConvexClient, ConvexHttpClient } from "convex/browser";
|
|
3
3
|
import type { FunctionArgs, FunctionReturnType } from "convex/server";
|
|
4
4
|
import type { FunctionReference } from "convex/server";
|
|
5
5
|
import type { Value } from "convex/values";
|
|
@@ -22,7 +22,7 @@ export type ArgsArray<Injected extends Record<string, Value>, FullArgs extends I
|
|
|
22
22
|
* @param injectedArgs Arguments to inject into each query/mutation/action call.
|
|
23
23
|
* @returns { query, mutation, action } functions with the injected arguments
|
|
24
24
|
*/
|
|
25
|
-
export declare function withArgs<A extends Record<string, Value>>(client: ConvexClient, injectedArgs: A): {
|
|
25
|
+
export declare function withArgs<A extends Record<string, Value>>(client: ConvexClient | ConvexHttpClient, injectedArgs: A): {
|
|
26
26
|
query<Query extends FunctionReference<"query">>(query: Query, ...args: ArgsArray<A, FunctionArgs<Query>>): Promise<Awaited<FunctionReturnType<Query>>>;
|
|
27
27
|
mutation<Mutation extends FunctionReference<"mutation">>(mutation: Mutation, ...args: ArgsArray<A, FunctionArgs<Mutation>>): Promise<Awaited<FunctionReturnType<Mutation>>>;
|
|
28
28
|
action<Action extends FunctionReference<"action">>(action: Action, ...args: ArgsArray<A, FunctionArgs<Action>>): Promise<Awaited<FunctionReturnType<Action>>>;
|
package/browser.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["browser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["browser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C,MAAM,MAAM,SAAS,CACnB,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACtC,QAAQ,SAAS,QAAQ,IACvB,MAAM,QAAQ,SAAS,MAAM,QAAQ,GACrC,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,GACpB,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EACtD,MAAM,EAAE,YAAY,GAAG,gBAAgB,EACvC,YAAY,EAAE,CAAC;UAGP,KAAK,SAAS,iBAAiB,CAAC,OAAO,CAAC,SACrC,KAAK,WACH,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,GACzC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;aAMrC,QAAQ,SAAS,iBAAiB,CAAC,UAAU,CAAC,YAC3C,QAAQ,WACT,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,GAC5C,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;WAM1C,MAAM,SAAS,iBAAiB,CAAC,QAAQ,CAAC,UACvC,MAAM,WACL,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,GAC1C,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;EAOlD"}
|
package/browser.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { BetterOmit, EmptyObject } from "./index.js";
|
|
2
|
-
import type { ConvexClient } from "convex/browser";
|
|
2
|
+
import type { ConvexClient, ConvexHttpClient } from "convex/browser";
|
|
3
3
|
import type { FunctionArgs, FunctionReturnType } from "convex/server";
|
|
4
4
|
import type { FunctionReference } from "convex/server";
|
|
5
5
|
import type { Value } from "convex/values";
|
|
@@ -30,7 +30,7 @@ export type ArgsArray<
|
|
|
30
30
|
* @returns { query, mutation, action } functions with the injected arguments
|
|
31
31
|
*/
|
|
32
32
|
export function withArgs<A extends Record<string, Value>>(
|
|
33
|
-
client: ConvexClient,
|
|
33
|
+
client: ConvexClient | ConvexHttpClient,
|
|
34
34
|
injectedArgs: A,
|
|
35
35
|
) {
|
|
36
36
|
return {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "convex-helpers",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.87",
|
|
4
4
|
"description": "A collection of useful code to complement the official convex package.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
"homepage": "https://github.com/get-convex/convex-helpers/tree/main/packages/convex-helpers/README.md",
|
|
151
151
|
"devDependencies": {
|
|
152
152
|
"chalk": "5.4.1",
|
|
153
|
-
"commander": "
|
|
153
|
+
"commander": "14.0.0"
|
|
154
154
|
},
|
|
155
155
|
"peerDependencies": {
|
|
156
156
|
"convex": "^1.13.0",
|
package/server/rateLimit.d.ts
CHANGED
|
@@ -46,7 +46,7 @@ export type RateLimitConfig = TokenBucketRateLimit | FixedWindowRateLimit;
|
|
|
46
46
|
* @param throws Whether to throw an error if the rate limit is exceeded.
|
|
47
47
|
* By default, {@link rateLimit} will just return { ok: false, retryAt: number }.
|
|
48
48
|
*/
|
|
49
|
-
interface RateLimitArgsWithoutConfig<Name extends string = string> {
|
|
49
|
+
export interface RateLimitArgsWithoutConfig<Name extends string = string> {
|
|
50
50
|
name: Name;
|
|
51
51
|
key?: string;
|
|
52
52
|
count?: number;
|
|
@@ -74,7 +74,7 @@ export declare function isRateLimitError(error: unknown): error is {
|
|
|
74
74
|
* If you use {@link defineRateLimits} to define the named rate limit, you don't
|
|
75
75
|
* specify the config inline.
|
|
76
76
|
*/
|
|
77
|
-
interface RateLimitArgs extends RateLimitArgsWithoutConfig {
|
|
77
|
+
export interface RateLimitArgs extends RateLimitArgsWithoutConfig {
|
|
78
78
|
config: RateLimitConfig;
|
|
79
79
|
}
|
|
80
80
|
export declare const RateLimitTable = "rateLimits";
|
|
@@ -247,5 +247,4 @@ export declare function resetRateLimit(ctx: {
|
|
|
247
247
|
name: string;
|
|
248
248
|
key?: string;
|
|
249
249
|
}): Promise<void>;
|
|
250
|
-
export {};
|
|
251
250
|
//# sourceMappingURL=rateLimit.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rateLimit.d.ts","sourceRoot":"","sources":["rateLimit.ts"],"names":[],"mappings":"AA2GA,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,6BAA6B,EAC7B,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAGvB;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAE1E;;;;;;;;;GASG;AACH,
|
|
1
|
+
{"version":3,"file":"rateLimit.d.ts","sourceRoot":"","sources":["rateLimit.ts"],"names":[],"mappings":"AA2GA,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,6BAA6B,EAC7B,gBAAgB,EACjB,MAAM,eAAe,CAAC;AAGvB;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAE1E;;;;;;;;;GASG;AACH,MAAM,WAAW,0BAA0B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM;IACtE,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,CAEnC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAc,SAAQ,0BAA0B;IAC/D,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,eAAO,MAAM,cAAc,eAAe,CAAC;AAE3C;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;CAO3B,CAAC;AAGF,MAAM,WAAW,kBACf,SAAQ,6BAA6B,CACnC,gBAAgB,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAC/C;CAAG;AAEN;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,EAC9C,MAAM,EAAE,MAAM;IAIZ;;;;OAIG;qBAED,SAAS,SAAS,kBAAkB,EACpC,IAAI,SAAS,MAAM,kCAEX;QAAE,EAAE,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAA;KAAE,QAC1C,0BAA0B,CAAC,IAAI,CAAC,GACpC,CAAC,IAAI,iCAA0B,EAAE,GAAG;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAAC;;;;;;;;;;;IASpE;;;;;;;;;;;;OAYG;gBACe,IAAI,SAAS,MAAM,+BAC9B;QAAE,EAAE,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAA;KAAE,QAChD,0BAA0B,CAAC,IAAI,CAAC,GACpC,CAAC,IAAI,iCAA0B,EAAE,GAAG;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAAC;;;;IASpE;;;;;;;;OAQG;qBACoB,IAAI,SAAS,MAAM,+BACnC;QAAE,EAAE,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAA;KAAE,QAChD;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE;EAKvC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,SAAS,CAC7B,GAAG,EAAE;IAAE,EAAE,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAA;CAAE,EACtD,IAAI,EAAE,aAAa;;;GAepB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,cAAc,CAAC,SAAS,SAAS,kBAAkB,EACvE,GAAG,EAAE;IAAE,EAAE,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAA;CAAE,EAC7C,IAAI,EAAE,aAAa;;;;;;;;;;GA2DpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAClC,GAAG,EAAE;IAAE,EAAE,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAA;CAAE,EACtD,IAAI,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,iBAMrC"}
|
package/server/rateLimit.ts
CHANGED
|
@@ -163,7 +163,7 @@ export type RateLimitConfig = TokenBucketRateLimit | FixedWindowRateLimit;
|
|
|
163
163
|
* @param throws Whether to throw an error if the rate limit is exceeded.
|
|
164
164
|
* By default, {@link rateLimit} will just return { ok: false, retryAt: number }.
|
|
165
165
|
*/
|
|
166
|
-
interface RateLimitArgsWithoutConfig<Name extends string = string> {
|
|
166
|
+
export interface RateLimitArgsWithoutConfig<Name extends string = string> {
|
|
167
167
|
name: Name;
|
|
168
168
|
key?: string;
|
|
169
169
|
count?: number;
|
|
@@ -196,7 +196,7 @@ export function isRateLimitError(
|
|
|
196
196
|
* If you use {@link defineRateLimits} to define the named rate limit, you don't
|
|
197
197
|
* specify the config inline.
|
|
198
198
|
*/
|
|
199
|
-
interface RateLimitArgs extends RateLimitArgsWithoutConfig {
|
|
199
|
+
export interface RateLimitArgs extends RateLimitArgsWithoutConfig {
|
|
200
200
|
config: RateLimitConfig;
|
|
201
201
|
}
|
|
202
202
|
|