xquik-convex 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      Copyright 2026 Xquik
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          https://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.

package/README.md

@@ -1,3 +1,183 @@
-# Temporary Holding Version
+# Twitter API & X data in Convex with Xquik
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![Convex Component](https://www.convex.dev/components/badge/xquik-convex)](https://www.convex.dev/components/xquik-convex)
+
+A Convex component for every public Xquik X API operation, signed webhooks & live event queries.
+
+Xquik is the world's fastest and cheapest X Twitter scraper service with the most complete X data.
+Xquik charges only for delivered, unique, filter-matching results and never pads rows.
+
+<!-- trust:start -->
+
+## Trust & usage
+
+[![Twitter API package downloads](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fdownloads.json)](https://xquik.com/trust#downloads)
+[![Twitter scraper users on Apify](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fapify-users.json)](https://apify.com/xquik)
+[![Twitter scraper runs on Apify](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fapify-runs.json)](https://apify.com/xquik)
+[![Tweet scraper rating on Apify](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fapify-rating.json)](https://apify.com/xquik/x-tweet-scraper/reviews)
+[![Xquik Twitter API accounts](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Faccounts.json)](https://xquik.com/trust#accounts)
+[![Twitter Skill installs](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fskill-installs.json)](https://xquik.com/trust#skill-installs)
+[![Xquik verified revenue on TrustMRR](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Frevenue.json)](https://trustmrr.com/startup/xquik)
+[![Twitter API p99 server read time](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Frest-p99.json)](https://xquik.com/trust#speed)
+[![Xquik GitHub stars](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fgithub-stars.json)](https://github.com/Xquik-dev)
+
+- 54,000+ downloads of Xquik's Twitter API packages on npm, PyPI, RubyGems, NuGet, Packagist & Terraform ([source](https://xquik.com/trust#downloads)) <!-- trust:downloads 54576 -->
+- 10,000+ users of Xquik's Twitter scraper Actors on Apify ([source](https://apify.com/xquik)) <!-- trust:apify-users 10119 -->
+- 7,000,000+ runs of Xquik's Twitter scraper Actors on Apify ([source](https://apify.com/xquik)) <!-- trust:apify-runs 7076266 -->
+- 4.66 of 5 for the X Tweet Scraper from 16 Apify reviews ([source](https://apify.com/xquik/x-tweet-scraper/reviews)) <!-- trust:apify-rating 4.66 16 -->
+- 4,100+ accounts on xquik.com ([source](https://xquik.com/trust#accounts)) <!-- trust:accounts 4126 -->
+- 1,600+ installs of Xquik's Twitter Skills on skills.sh ([source](https://xquik.com/trust#skill-installs)) <!-- trust:skill-installs 1619 -->
+- $40,000+ in revenue verified by TrustMRR ([source](https://trustmrr.com/startup/xquik)) <!-- trust:revenue 40329 -->
+- 13.8 s p99 REST API server read time over 7 days, failed reads included ([source](https://xquik.com/trust#speed)) <!-- trust:rest-p99 13778 -->
+- 380+ GitHub stars across Xquik's repos ([source](https://github.com/Xquik-dev)) <!-- trust:github-stars 386 -->
+
+Checked on 2026-10-28. See each number with its date & source on [xquik.com/trust](https://xquik.com/trust) or as [JSON](https://xquik.com/trust.json).
+
+<!-- trust:end -->
+
+<!-- START: Include on https://convex.dev/components -->
+
+Read the full guide at [docs.xquik.com/guides/convex](https://docs.xquik.com/guides/convex).
+
+## What you get
+
+- 190 typed Convex actions, 1 for each public operation in the [Xquik API reference](https://docs.xquik.com/api-reference/overview). Convex checks the arguments & the result of each call.
+- A webhook receiver that checks each delivery's signature & stores each event once.
+- Live queries over stored events, so your UI updates as events arrive.
+- Durable jobs that retry safe calls & repeat on a schedule.
+- No X developer account & no X bearer token.
+
+## Install
+
+```bash
+npm install xquik-convex
+```
+
+Add the component in `convex/convex.config.ts`.
+
+```ts
+import { defineApp } from "convex/server";
+import { v } from "convex/values";
+import xquik from "xquik-convex/convex.config.js";
+
+const app = defineApp({ env: { XQUIK_API_KEY: v.optional(v.string()) } });
+app.use(xquik, { httpPrefix: "/xquik/", env: { XQUIK_API_KEY: app.env.XQUIK_API_KEY } });
+export default app;
+```
+
+Set your key from the [Xquik dashboard](https://xquik.com/dashboard). Every component function answers `missing_api_key` until you set it.
+
+```bash
+npx convex env set XQUIK_API_KEY xq_your_key
+```
+
+## Call any operation
+
+Each action takes the operation's path, query, header & body fields side by side. Convex checks them before the call.
+
+```ts
+import { v } from "convex/values";
+import { components } from "./_generated/api";
+import { internalAction } from "./_generated/server";
+
+export const latest = internalAction({
+  args: { username: v.string() },
+  handler: async (ctx, { username }) =>
+    await ctx.runAction(components.xquik.operations.searchTweets, { q: `from:${username}`, limit: 20 }),
+});
+```
+
+Call `components.xquik.operations.getUser` with `{ id: "elonmusk" }` for a profile. A failed call throws a `ConvexError`. Its data has `status`, `error`, `message` & `retryAfter` in seconds for a 429.
+
+Each result has the type & the validator of its schema in the API reference, so the `name` of a `getUser` result is a `string`. The result holds only the fields that schema lists. A JSON-LD key such as `@id` arrives as `id`. Import `OperationResult<"getUser">` from `xquik-convex` to name a result type.
+
+## Receive webhook events
+
+```ts
+import { Xquik, eventFields } from "xquik-convex";
+import { v } from "convex/values";
+import { components, internal } from "./_generated/api";
+import { internalAction, internalMutation } from "./_generated/server";
+
+const xquik = new Xquik(components.xquik);
+
+export const watch = internalAction({
+  args: {},
+  handler: async (ctx) =>
+    await xquik.createWebhook(ctx, { eventTypes: ["tweet.new", "tweet.reply"], onEvent: internal.x.onEvent }),
+});
+
+export const onEvent = internalMutation({
+  args: { event: eventFields },
+  handler: async (ctx, { event }) => {
+    console.info(event.eventType, event.streamEventId);
+  },
+});
+```
+
+The component creates the Xquik webhook at `https://<deployment>.convex.site/xquik/webhooks/<token>`. It keeps the signing secret in its own table. Each delivery must carry a valid `X-Xquik-Signature` & a timestamp within 5 minutes. A replayed nonce gets a 401. A retry with the same `streamEventId` is stored once, and your handler runs once per endpoint. The `webhook.test` alert gets a 200 & sets `testedAt` on the endpoint.
+
+For a webhook made elsewhere, call `xquik.addWebhook(ctx, { secret })` from a mutation & paste the URL it returns.
+
+## Show events live
+
+```ts
+import { paginationOptsValidator } from "convex/server";
+import { components } from "./_generated/api";
+import { query } from "./_generated/server";
+
+export const events = query({
+  args: { paginationOpts: paginationOptsValidator },
+  handler: async (ctx, { paginationOpts }) => {
+    if ((await ctx.auth.getUserIdentity()) === null) throw new Error("Sign in first.");
+    return await ctx.runQuery(components.xquik.events.list, { paginationOpts });
+  },
+});
+```
+
+Use it with `usePaginatedQuery(api.x.events, {}, { initialNumItems: 20 })`. Pass `filter: { eventType }` or `filter: { monitorId }` to narrow the list.
+
+## Schedule calls
+
+```ts
+await xquik.schedule(ctx, "listEvents", { limit: 100 }, { key: "events", everyMs: 5 * 60 * 1000 });
+```
+
+While a job with the same `key` is scheduled or running, the call returns that job's ID. A read, or a write that takes an `Idempotency-Key`, makes up to 5 attempts on a 429, a 5xx or a network error. The component fills the key for you. A result that breaks its schema fails the job without a retry. Scheduled `listEvents` jobs store their events with the webhook events. Read a job with `components.xquik.jobs.get` & stop it with `components.xquik.jobs.cancel`.
+
+## Keep credits safe
+
+Component functions run only from your backend. Wrap them in internal functions, or check the caller's identity & rate limit in each public function that spends credits. The [example app](https://github.com/Xquik-dev/xquik-convex/tree/main/example) keeps every credit-spending function internal.
+
+## Test your app
+
+```ts
+import { convexTest } from "convex-test";
+import xquikTest from "xquik-convex/test";
+
+const t = convexTest(schema, modules);
+xquikTest.register(t);
+```
+
+<!-- END: Include on https://convex.dev/components -->
+
+## Develop
+
+```bash
+npm ci
+npm run generate
+bin/check-local
+```
+
+`example/` holds a runnable Convex app that uses the component. `npm run generate` rebuilds the operation registry from `openapi.json`. The tests prove that every public operation in `openapi.json` is an action, & that every event type gets a receiver test. See [CONTRIBUTING.md](CONTRIBUTING.md) for each check.
+
+## Documentation
+
+- [Xquik Convex guide](https://docs.xquik.com/guides/convex)
+- [Xquik API reference](https://docs.xquik.com/api-reference/overview)
+- [Webhook signature verification](https://docs.xquik.com/webhooks/verification)
+- [Organization support policy](https://github.com/Xquik-dev/.github/blob/main/SUPPORT.md)
+- [Security policy](SECURITY.md)
+- [Contributing](CONTRIBUTING.md)
+
+Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.

package/dist/client/index.d.ts

@@ -0,0 +1,85 @@
+import { type FunctionArgs, type FunctionReference, type FunctionReturnType, type GenericActionCtx, type GenericDataModel, type GenericMutationCtx } from "convex/server";
+import { type Infer } from "convex/values";
+import type { ComponentApi } from "../component/_generated/component.js";
+import { eventFields, type EventFields } from "../component/values.js";
+export { eventFields, type EventFields };
+export declare const eventDoc: import("convex/values").VObject<{
+    monitorId?: string;
+    data: import("convex/values").Value;
+    streamEventId: string;
+    eventType: string;
+    occurredAt: number;
+    _creationTime: number;
+    _id: string;
+}, {
+    streamEventId: import("convex/values").VString<string, "required">;
+    eventType: import("convex/values").VString<string, "required">;
+    occurredAt: import("convex/values").VFloat64<number, "required">;
+    monitorId: import("convex/values").VString<string | undefined, "optional">;
+    data: import("convex/values").VAny<import("convex/values").Value, "required", string>;
+    _id: import("convex/values").VString<string, "required">;
+    _creationTime: import("convex/values").VFloat64<number, "required">;
+}, "required", "data" | "_creationTime" | "_id" | "streamEventId" | "eventType" | "monitorId" | "occurredAt" | `data.${string}`>;
+export type EventDoc = Infer<typeof eventDoc>;
+export type OperationName = keyof ComponentApi["operations"];
+export type OperationArgs<Name extends OperationName> = FunctionArgs<ComponentApi["operations"][Name]>;
+export type OperationResult<Name extends OperationName> = FunctionReturnType<ComponentApi["operations"][Name]>;
+type ActionCtx = Pick<GenericActionCtx<GenericDataModel>, "runAction">;
+type MutationCtx = Pick<GenericMutationCtx<GenericDataModel>, "runMutation">;
+export type EventHandler = FunctionReference<"mutation", "internal" | "public", {
+    event: EventFields;
+}>;
+export type EventTypes = FunctionArgs<ComponentApi["webhooks"]["create"]>["eventTypes"];
+export interface Schedule {
+    readonly key?: string;
+    readonly everyMs?: number;
+    readonly delayMs?: number;
+}
+/** Calls the Xquik component from your app's mutations and actions. */
+export declare class Xquik {
+    readonly component: ComponentApi;
+    /**
+     * @param component The mounted component, `components.xquik` from `./_generated/api`.
+     */
+    constructor(component: ComponentApi);
+    /**
+     * Schedules an operation as a durable job and returns its job ID.
+     *
+     * While a job with the same `key` is scheduled or running, the call returns that job's ID.
+     * Reads and writes that take an `Idempotency-Key` retry on a 429, a 5xx or a network error.
+     *
+     * @param operation The operation name, such as `"getUser"`.
+     * @param args The operation's arguments, typed from its schema.
+     * @param options `key` keeps 1 scheduled job per key. `everyMs` repeats the job, at 60,000 ms or more.
+     * `delayMs` starts it later.
+     */
+    schedule<Name extends OperationName>(ctx: MutationCtx, operation: Name, args: OperationArgs<Name>, options?: Schedule): Promise<string>;
+    /**
+     * Creates an Xquik webhook for the event types and an endpoint in the component that receives it.
+     *
+     * @param args `eventTypes` to deliver, and `onEvent`, a mutation that runs once for each `streamEventId` this endpoint receives. A retry or the `webhook.test` alert does not run it.
+     * @returns The endpoint ID, its URL and the Xquik webhook ID.
+     */
+    createWebhook(ctx: ActionCtx, args: {
+        readonly eventTypes: EventTypes;
+        readonly onEvent?: EventHandler;
+    }): Promise<{
+        endpointId: string;
+        url: string;
+        webhookId: string;
+    }>;
+    /**
+     * Adds an endpoint for a webhook you created elsewhere, with its signing secret.
+     *
+     * @param args The webhook's `secret`, and `onEvent`, a mutation that runs once for each `streamEventId` this endpoint receives. A retry or the `webhook.test` alert does not run it.
+     * @returns The endpoint ID and the URL to give Xquik.
+     */
+    addWebhook(ctx: MutationCtx, args: {
+        readonly secret: string;
+        readonly onEvent?: EventHandler;
+    }): Promise<{
+        endpointId: string;
+        url: string;
+    }>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACxB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAK,KAAK,KAAK,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAE,KAAK,WAAW,EAAE,CAAC;AAEzC,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;gIAAqE,CAAC;AAE3F,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAE9C,MAAM,MAAM,aAAa,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,CAAC;AAE7D,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,aAAa,IAAI,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAEvG,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,aAAa,IAAI,kBAAkB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/G,KAAK,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,CAAC;AACvE,KAAK,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,aAAa,CAAC,CAAC;AAE7E,MAAM,MAAM,YAAY,GAAG,iBAAiB,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ,EAAE;IAAE,KAAK,EAAE,WAAW,CAAA;CAAE,CAAC,CAAC;AAExG,MAAM,MAAM,UAAU,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AAExF,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,uEAAuE;AACvE,qBAAa,KAAK;IAChB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IAEjC;;OAEG;gBACS,SAAS,EAAE,YAAY;IAInC;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,IAAI,SAAS,aAAa,EACvC,GAAG,EAAE,WAAW,EAChB,SAAS,EAAE,IAAI,EACf,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,EACzB,OAAO,GAAE,QAAa,GACrB,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;OAKG;IACG,aAAa,CACjB,GAAG,EAAE,SAAS,EACd,IAAI,EAAE;QAAE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;QAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAA;KAAE,GACzE,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAKlE;;;;;OAKG;IACG,UAAU,CACd,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAA;KAAE,GACjE,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAIhD"}

package/dist/client/index.js

@@ -0,0 +1,50 @@
+import { createFunctionHandle, } from "convex/server";
+import { v } from "convex/values";
+import { eventFields } from "../component/values.js";
+export { eventFields };
+export const eventDoc = eventFields.extend({ _id: v.string(), _creationTime: v.number() });
+/** Calls the Xquik component from your app's mutations and actions. */
+export class Xquik {
+    component;
+    /**
+     * @param component The mounted component, `components.xquik` from `./_generated/api`.
+     */
+    constructor(component) {
+        this.component = component;
+    }
+    /**
+     * Schedules an operation as a durable job and returns its job ID.
+     *
+     * While a job with the same `key` is scheduled or running, the call returns that job's ID.
+     * Reads and writes that take an `Idempotency-Key` retry on a 429, a 5xx or a network error.
+     *
+     * @param operation The operation name, such as `"getUser"`.
+     * @param args The operation's arguments, typed from its schema.
+     * @param options `key` keeps 1 scheduled job per key. `everyMs` repeats the job, at 60,000 ms or more.
+     * `delayMs` starts it later.
+     */
+    async schedule(ctx, operation, args, options = {}) {
+        return await ctx.runMutation(this.component.jobs.enqueue, { operation, args, ...options });
+    }
+    /**
+     * Creates an Xquik webhook for the event types and an endpoint in the component that receives it.
+     *
+     * @param args `eventTypes` to deliver, and `onEvent`, a mutation that runs once for each `streamEventId` this endpoint receives. A retry or the `webhook.test` alert does not run it.
+     * @returns The endpoint ID, its URL and the Xquik webhook ID.
+     */
+    async createWebhook(ctx, args) {
+        const onEvent = args.onEvent === undefined ? {} : { onEvent: await createFunctionHandle(args.onEvent) };
+        return await ctx.runAction(this.component.webhooks.create, { eventTypes: args.eventTypes, ...onEvent });
+    }
+    /**
+     * Adds an endpoint for a webhook you created elsewhere, with its signing secret.
+     *
+     * @param args The webhook's `secret`, and `onEvent`, a mutation that runs once for each `streamEventId` this endpoint receives. A retry or the `webhook.test` alert does not run it.
+     * @returns The endpoint ID and the URL to give Xquik.
+     */
+    async addWebhook(ctx, args) {
+        const onEvent = args.onEvent === undefined ? {} : { onEvent: await createFunctionHandle(args.onEvent) };
+        return await ctx.runMutation(this.component.webhooks.add, { secret: args.secret, ...onEvent });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAOrB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAc,MAAM,eAAe,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAoB,MAAM,wBAAwB,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAoB,CAAC;AAEzC,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAuB3F,uEAAuE;AACvE,MAAM,OAAO,KAAK;IACP,SAAS,CAAe;IAEjC;;OAEG;IACH,YAAY,SAAuB;QACjC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAgB,EAChB,SAAe,EACf,IAAyB,EACzB,UAAoB,EAAE;QAEtB,OAAO,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,GAAc,EACd,IAA0E;QAE1E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACxG,OAAO,MAAM,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,GAAgB,EAChB,IAAkE;QAElE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACxG,OAAO,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;CACF"}

package/dist/component/_generated/api.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import type * as access from "../access.js";
+import type * as crons from "../crons.js";
+import type * as delivery from "../delivery.js";
+import type * as events from "../events.js";
+import type * as http from "../http.js";
+import type * as jobs from "../jobs.js";
+import type * as operation from "../operation.js";
+import type * as operations from "../operations.js";
+import type * as request from "../request.js";
+import type * as shape from "../shape.js";
+import type * as values from "../values.js";
+import type * as webhooks from "../webhooks.js";
+import type { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
+declare const fullApi: ApiFromModules<{
+    access: typeof access;
+    crons: typeof crons;
+    delivery: typeof delivery;
+    events: typeof events;
+    http: typeof http;
+    jobs: typeof jobs;
+    operation: typeof operation;
+    operations: typeof operations;
+    request: typeof request;
+    shape: typeof shape;
+    values: typeof values;
+    webhooks: typeof webhooks;
+}>;
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export declare const api: FilterApi<typeof fullApi, FunctionReference<any, "public">>;
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export declare const internal: FilterApi<typeof fullApi, FunctionReference<any, "internal">>;
+export declare const components: {};
+export {};
+//# sourceMappingURL=api.d.ts.map

package/dist/component/_generated/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,KAAK,MAAM,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,KAAK,KAAK,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,KAAK,MAAM,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,KAAK,UAAU,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,KAAK,OAAO,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,KAAK,KAAK,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,KAAK,MAAM,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAEhD,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,iBAAiB,EAClB,MAAM,eAAe,CAAC;AAGvB,QAAA,MAAM,OAAO,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,OAAO,MAAM,CAAC;IACtB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1B,MAAM,EAAE,OAAO,MAAM,CAAC;IACtB,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,SAAS,EAAE,OAAO,SAAS,CAAC;IAC5B,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,OAAO,EAAE,OAAO,OAAO,CAAC;IACxB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,MAAM,EAAE,OAAO,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,QAAQ,CAAC;CAC3B,CAAiB,CAAC;AAEnB;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,EAAE,SAAS,CACzB,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,CACjB,CAAC;AAElB;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,SAAS,CAC9B,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,UAAU,CAAC,CACnB,CAAC;AAElB,eAAO,MAAM,UAAU,EAAqC,EAAE,CAAC"}

package/dist/component/_generated/api.js

@@ -0,0 +1,31 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import { anyApi, componentsGeneric } from "convex/server";
+const fullApi = anyApi;
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api = anyApi;
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export const internal = anyApi;
+export const components = componentsGeneric();
+//# sourceMappingURL=api.js.map

package/dist/component/_generated/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AAoBH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE1D,MAAM,OAAO,GAaR,MAAa,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,GAAG,GAGZ,MAAa,CAAC;AAElB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAGjB,MAAa,CAAC;AAElB,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,EAAmB,CAAC"}