npm - @devwithbobby/loops - Versions diffs - 0.1.0 → 0.1.2 - Mend

@devwithbobby/loops 0.1.0 → 0.1.2

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 (72) hide show

package/README.md +343 -375
package/dist/client/index.d.ts +186 -0
package/dist/client/index.d.ts.map +1 -0
package/dist/client/index.js +396 -0
package/dist/client/types.d.ts +24 -0
package/dist/client/types.d.ts.map +1 -0
package/dist/client/types.js +0 -0
package/dist/component/convex.config.d.ts +3 -0
package/dist/component/convex.config.d.ts.map +1 -0
package/dist/component/convex.config.js +25 -0
package/dist/component/lib.d.ts +103 -0
package/dist/component/lib.d.ts.map +1 -0
package/dist/component/lib.js +1000 -0
package/dist/component/schema.d.ts +3 -0
package/dist/component/schema.d.ts.map +1 -0
package/dist/component/schema.js +16 -0
package/dist/component/tables/contacts.d.ts +2 -0
package/dist/component/tables/contacts.d.ts.map +1 -0
package/dist/component/tables/contacts.js +14 -0
package/dist/component/tables/emailOperations.d.ts +2 -0
package/dist/component/tables/emailOperations.d.ts.map +1 -0
package/dist/component/tables/emailOperations.js +20 -0
package/dist/component/validators.d.ts +18 -0
package/dist/component/validators.d.ts.map +1 -0
package/dist/component/validators.js +34 -0
package/dist/utils.d.ts +4 -0
package/dist/utils.d.ts.map +1 -0
package/dist/utils.js +5 -0
package/package.json +11 -5
package/.changeset/README.md +0 -8
package/.changeset/config.json +0 -14
package/.config/commitlint.config.ts +0 -11
package/.config/lefthook.yml +0 -11
package/.github/workflows/release.yml +0 -52
package/.github/workflows/test-and-lint.yml +0 -39
package/biome.json +0 -45
package/bun.lock +0 -1166
package/bunfig.toml +0 -7
package/convex.json +0 -3
package/example/CLAUDE.md +0 -106
package/example/README.md +0 -21
package/example/bun-env.d.ts +0 -17
package/example/convex/_generated/api.d.ts +0 -53
package/example/convex/_generated/api.js +0 -23
package/example/convex/_generated/dataModel.d.ts +0 -60
package/example/convex/_generated/server.d.ts +0 -149
package/example/convex/_generated/server.js +0 -90
package/example/convex/convex.config.ts +0 -7
package/example/convex/example.ts +0 -76
package/example/convex/schema.ts +0 -3
package/example/convex/tsconfig.json +0 -34
package/example/src/App.tsx +0 -185
package/example/src/frontend.tsx +0 -39
package/example/src/index.css +0 -15
package/example/src/index.html +0 -12
package/example/src/index.tsx +0 -19
package/example/tsconfig.json +0 -28
package/prds/CHANGELOG.md +0 -38
package/prds/CLAUDE.md +0 -408
package/prds/CONTRIBUTING.md +0 -274
package/prds/ENV_SETUP.md +0 -222
package/prds/MONITORING.md +0 -301
package/prds/RATE_LIMITING.md +0 -412
package/prds/SECURITY.md +0 -246
package/renovate.json +0 -32
package/test/client/_generated/_ignore.ts +0 -1
package/test/client/index.test.ts +0 -65
package/test/client/setup.test.ts +0 -54
package/test/component/lib.test.ts +0 -225
package/test/component/setup.test.ts +0 -21
package/tsconfig.build.json +0 -20
package/tsconfig.json +0 -22

package/bunfig.toml DELETED Viewed

@@ -1,7 +0,0 @@
-[test]
-preload = ["./test/component/setup.test.ts"]
-coveragePathIgnorePatterns = "**/*.js"
-[serve.static]
-plugins = ["bun-plugin-tailwind"]
-env = "CONVEX_*"

package/convex.json DELETED Viewed

@@ -1,3 +0,0 @@
-{
-	"functions": "example/convex"
-}

package/example/CLAUDE.md DELETED Viewed

@@ -1,106 +0,0 @@
-Default to using Bun instead of Node.js.
-- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
-- Use `bun test` instead of `jest` or `vitest`
-- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
-- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
-- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
-- Bun automatically loads .env, so don't use dotenv.
-## APIs
-- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
-- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
-- `Bun.redis` for Redis. Don't use `ioredis`.
-- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
-- `WebSocket` is built-in. Don't use `ws`.
-- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
-- Bun.$`ls` instead of execa.
-## Testing
-Use `bun test` to run tests.
-```ts#index.test.ts
-import { test, expect } from "bun:test";
-test("hello world", () => {
-  expect(1).toBe(1);
-});
-```
-## Frontend
-Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
-Server:
-```ts#index.ts
-import index from "./index.html"
-Bun.serve({
-  routes: {
-    "/": index,
-    "/api/users/:id": {
-      GET: (req) => {
-        return new Response(JSON.stringify({ id: req.params.id }));
-      },
-    },
-  },
-  // optional websocket support
-  websocket: {
-    open: (ws) => {
-      ws.send("Hello, world!");
-    },
-    message: (ws, message) => {
-      ws.send(message);
-    },
-    close: (ws) => {
-      // handle close
-    }
-  },
-  development: {
-    hmr: true,
-    console: true,
-  }
-})
-```
-HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
-```html#index.html
-<html>
-  <body>
-    <h1>Hello, world!</h1>
-    <script type="module" src="./frontend.tsx"></script>
-  </body>
-</html>
-```
-With the following `frontend.tsx`:
-```tsx#frontend.tsx
-import React from "react";
-// import .css files directly and it works
-import './index.css';
-import { createRoot } from "react-dom/client";
-const root = createRoot(document.body);
-export default function Frontend() {
-  return <h1>Hello, world!</h1>;
-}
-root.render(<Frontend />);
-```
-Then, run index.ts
-```sh
-bun --hot ./index.ts
-```
-For more information, read the Bun API docs in `node_modules/bun-types/docs/**.md`.

package/example/README.md DELETED Viewed

@@ -1,21 +0,0 @@
-# bun-react-tailwind-template
-To install dependencies:
-```bash
-bun install
-```
-To start a development server:
-```bash
-bun dev
-```
-To run for production:
-```bash
-bun start
-```
-This project was created using `bun init` in bun v1.3.0. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.

package/example/bun-env.d.ts DELETED Viewed

@@ -1,17 +0,0 @@
-// Generated by `bun init`
-declare module "*.svg" {
-	/**
-	 * A path to the SVG file
-	 */
-	const path: `${string}.svg`;
-	export = path;
-}
-declare module "*.module.css" {
-	/**
-	 * A record of class names to their corresponding CSS module classes
-	 */
-	const classes: { readonly [key: string]: string };
-	export = classes;
-}

package/example/convex/_generated/api.d.ts DELETED Viewed

@@ -1,53 +0,0 @@
-/* eslint-disable */
-/**
- * Generated `api` utility.
- *
- * THIS CODE IS AUTOMATICALLY GENERATED.
- *
- * To regenerate, run `npx convex dev`.
- * @module
- */
-import type * as example from "../example.js";
-import type {
-  ApiFromModules,
-  FilterApi,
-  FunctionReference,
-} from "convex/server";
-/**
- * A utility for referencing Convex functions in your app's API.
- *
- * Usage:
- * ```js
- * const myFunctionReference = api.myModule.myFunction;
- * ```
- */
-declare const fullApi: ApiFromModules<{
-  example: typeof example;
-}>;
-declare const fullApiWithMounts: typeof fullApi;
-export declare const api: FilterApi<
-  typeof fullApiWithMounts,
-  FunctionReference<any, "public">
->;
-export declare const internal: FilterApi<
-  typeof fullApiWithMounts,
-  FunctionReference<any, "internal">
->;
-export declare const components: {
-  shardedCounter: {
-    lib: {
-      add: FunctionReference<
-        "mutation",
-        "internal",
-        { count: number; name: string; shards?: number },
-        null
-      >;
-      count: FunctionReference<"query", "internal", { name: string }, number>;
-    };
-  };
-};

package/example/convex/_generated/api.js DELETED Viewed

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

package/example/convex/_generated/dataModel.d.ts DELETED Viewed

@@ -1,60 +0,0 @@
-/* eslint-disable */
-/**
- * Generated data model types.
- *
- * THIS CODE IS AUTOMATICALLY GENERATED.
- *
- * To regenerate, run `npx convex dev`.
- * @module
- */
-import type {
-  DataModelFromSchemaDefinition,
-  DocumentByName,
-  TableNamesInDataModel,
-  SystemTableNames,
-} from "convex/server";
-import type { GenericId } from "convex/values";
-import schema from "../schema.js";
-/**
- * The names of all of your Convex tables.
- */
-export type TableNames = TableNamesInDataModel<DataModel>;
-/**
- * The type of a document stored in Convex.
- *
- * @typeParam TableName - A string literal type of the table name (like "users").
- */
-export type Doc<TableName extends TableNames> = DocumentByName<
-  DataModel,
-  TableName
->;
-/**
- * An identifier for a document in Convex.
- *
- * Convex documents are uniquely identified by their `Id`, which is accessible
- * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
- *
- * Documents can be loaded using `db.get(id)` in query and mutation functions.
- *
- * IDs are just strings at runtime, but this type can be used to distinguish them from other
- * strings when type checking.
- *
- * @typeParam TableName - A string literal type of the table name (like "users").
- */
-export type Id<TableName extends TableNames | SystemTableNames> =
-  GenericId<TableName>;
-/**
- * A type describing your Convex data model.
- *
- * This type includes information about what tables you have, the type of
- * documents stored in those tables, and the indexes defined on them.
- *
- * This type is used to parameterize methods like `queryGeneric` and
- * `mutationGeneric` to make them type-safe.
- */
-export type DataModel = DataModelFromSchemaDefinition<typeof schema>;

package/example/convex/_generated/server.d.ts DELETED Viewed

@@ -1,149 +0,0 @@
-/* eslint-disable */
-/**
- * Generated utilities for implementing server-side Convex query and mutation functions.
- *
- * THIS CODE IS AUTOMATICALLY GENERATED.
- *
- * To regenerate, run `npx convex dev`.
- * @module
- */
-import {
-  ActionBuilder,
-  AnyComponents,
-  HttpActionBuilder,
-  MutationBuilder,
-  QueryBuilder,
-  GenericActionCtx,
-  GenericMutationCtx,
-  GenericQueryCtx,
-  GenericDatabaseReader,
-  GenericDatabaseWriter,
-  FunctionReference,
-} from "convex/server";
-import type { DataModel } from "./dataModel.js";
-type GenericCtx =
-  | GenericActionCtx<DataModel>
-  | GenericMutationCtx<DataModel>
-  | GenericQueryCtx<DataModel>;
-/**
- * Define a query in this Convex app's public API.
- *
- * This function will be allowed to read your Convex database and will be accessible from the client.
- *
- * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
- * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
- */
-export declare const query: QueryBuilder<DataModel, "public">;
-/**
- * Define a query that is only accessible from other Convex functions (but not from the client).
- *
- * This function will be allowed to read from your Convex database. It will not be accessible from the client.
- *
- * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
- * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
- */
-export declare const internalQuery: QueryBuilder<DataModel, "internal">;
-/**
- * Define a mutation in this Convex app's public API.
- *
- * This function will be allowed to modify your Convex database and will be accessible from the client.
- *
- * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
- * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
- */
-export declare const mutation: MutationBuilder<DataModel, "public">;
-/**
- * Define a mutation that is only accessible from other Convex functions (but not from the client).
- *
- * This function will be allowed to modify your Convex database. It will not be accessible from the client.
- *
- * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
- * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
- */
-export declare const internalMutation: MutationBuilder<DataModel, "internal">;
-/**
- * Define an action in this Convex app's public API.
- *
- * An action is a function which can execute any JavaScript code, including non-deterministic
- * code and code with side-effects, like calling third-party services.
- * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
- * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
- *
- * @param func - The action. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
- */
-export declare const action: ActionBuilder<DataModel, "public">;
-/**
- * Define an action that is only accessible from other Convex functions (but not from the client).
- *
- * @param func - The function. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
- */
-export declare const internalAction: ActionBuilder<DataModel, "internal">;
-/**
- * Define an HTTP action.
- *
- * This function will be used to respond to HTTP requests received by a Convex
- * deployment if the requests matches the path and method where this action
- * is routed. Be sure to route your action in `convex/http.js`.
- *
- * @param func - The function. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped function. Import this function from `convex/http.js` and route it to hook it up.
- */
-export declare const httpAction: HttpActionBuilder;
-/**
- * A set of services for use within Convex query functions.
- *
- * The query context is passed as the first argument to any Convex query
- * function run on the server.
- *
- * This differs from the {@link MutationCtx} because all of the services are
- * read-only.
- */
-export type QueryCtx = GenericQueryCtx<DataModel>;
-/**
- * A set of services for use within Convex mutation functions.
- *
- * The mutation context is passed as the first argument to any Convex mutation
- * function run on the server.
- */
-export type MutationCtx = GenericMutationCtx<DataModel>;
-/**
- * A set of services for use within Convex action functions.
- *
- * The action context is passed as the first argument to any Convex action
- * function run on the server.
- */
-export type ActionCtx = GenericActionCtx<DataModel>;
-/**
- * An interface to read from the database within Convex query functions.
- *
- * The two entry points are {@link DatabaseReader.get}, which fetches a single
- * document by its {@link Id}, or {@link DatabaseReader.query}, which starts
- * building a query.
- */
-export type DatabaseReader = GenericDatabaseReader<DataModel>;
-/**
- * An interface to read from and write to the database within Convex mutation
- * functions.
- *
- * Convex guarantees that all writes within a single mutation are
- * executed atomically, so you never have to worry about partial writes leaving
- * your data in an inconsistent state. See [the Convex Guide](https://docs.convex.dev/understanding/convex-fundamentals/functions#atomicity-and-optimistic-concurrency-control)
- * for the guarantees Convex provides your functions.
- */
-export type DatabaseWriter = GenericDatabaseWriter<DataModel>;

package/example/convex/_generated/server.js DELETED Viewed

@@ -1,90 +0,0 @@
-/* eslint-disable */
-/**
- * Generated utilities for implementing server-side Convex query and mutation functions.
- *
- * THIS CODE IS AUTOMATICALLY GENERATED.
- *
- * To regenerate, run `npx convex dev`.
- * @module
- */
-import {
-  actionGeneric,
-  httpActionGeneric,
-  queryGeneric,
-  mutationGeneric,
-  internalActionGeneric,
-  internalMutationGeneric,
-  internalQueryGeneric,
-  componentsGeneric,
-} from "convex/server";
-/**
- * Define a query in this Convex app's public API.
- *
- * This function will be allowed to read your Convex database and will be accessible from the client.
- *
- * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
- * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
- */
-export const query = queryGeneric;
-/**
- * Define a query that is only accessible from other Convex functions (but not from the client).
- *
- * This function will be allowed to read from your Convex database. It will not be accessible from the client.
- *
- * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
- * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
- */
-export const internalQuery = internalQueryGeneric;
-/**
- * Define a mutation in this Convex app's public API.
- *
- * This function will be allowed to modify your Convex database and will be accessible from the client.
- *
- * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
- * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
- */
-export const mutation = mutationGeneric;
-/**
- * Define a mutation that is only accessible from other Convex functions (but not from the client).
- *
- * This function will be allowed to modify your Convex database. It will not be accessible from the client.
- *
- * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
- * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
- */
-export const internalMutation = internalMutationGeneric;
-/**
- * Define an action in this Convex app's public API.
- *
- * An action is a function which can execute any JavaScript code, including non-deterministic
- * code and code with side-effects, like calling third-party services.
- * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
- * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
- *
- * @param func - The action. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
- */
-export const action = actionGeneric;
-/**
- * Define an action that is only accessible from other Convex functions (but not from the client).
- *
- * @param func - The function. It receives an {@link ActionCtx} as its first argument.
- * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
- */
-export const internalAction = internalActionGeneric;
-/**
- * Define a Convex HTTP action.
- *
- * @param func - The function. It receives an {@link ActionCtx} as its first argument, and a `Request` object
- * as its second.
- * @returns The wrapped endpoint function. Route a URL path to this function in `convex/http.js`.
- */
-export const httpAction = httpActionGeneric;

package/example/convex/convex.config.ts DELETED Viewed

@@ -1,7 +0,0 @@
-import component from "devwithbobby/loops/convex.config";
-import { defineApp } from "convex/server";
-const app = defineApp();
-app.use(component);
-export default app;

package/example/convex/example.ts DELETED Viewed

@@ -1,76 +0,0 @@
-import { Loops } from "devwithbobby/loops";
-import { components } from "./_generated/api";
-/**
- * Initialize the Loops client with the mounted component.
- * This provides a type-safe interface to the Loops component.
- *
- * ⚠️ SECURITY: The API key MUST be set in your Convex environment variables.
- *
- * Set it via:
- * - Convex Dashboard: Settings → Environment Variables → Add LOOPS_API_KEY
- * - CLI: npx convex env set LOOPS_API_KEY "your-api-key"
- *
- * See ENV_SETUP.md for detailed setup instructions.
- *
- * ⚠️ NEVER pass the API key directly via options in production code.
- * Only use options.apiKey for local testing.
- */
-const loops = new Loops(components.loops);
-/**
- * ⚠️ SECURITY WARNING ⚠️
- *
- * This example exports functions directly for demonstration purposes.
- * In production, you MUST:
- *
- * 1. Add authentication checks:
- *    ```ts
- *    const identity = await ctx.auth.getUserIdentity();
- *    if (!identity) throw new Error("Unauthorized");
- *    ```
- *
- * 2. Add authorization/permission checks based on user roles
- *
- * 3. Add rate limiting to prevent abuse
- *
- * 4. Sanitize error messages before returning to clients
- *
- * 5. Audit sensitive operations (delete, unsubscribe, send emails)
- *
- * See SECURITY.md for detailed security guidelines.
- */
-/**
- * Export the API functions for use in the React app.
- * ⚠️ These are exported without auth checks for example purposes only.
- *
- * In production, wrap each function with authentication and authorization:
- *
- * ```ts
- * export const addContact = action({
- *   args: { email: v.string(), ... },
- *   handler: async (ctx, args) => {
- *     const identity = await ctx.auth.getUserIdentity();
- *     if (!identity) throw new Error("Unauthorized");
- *
- *     // Add permission checks here
- *     return await loops.addContact(ctx, args);
- *   },
- * });
- * ```
- */
-export const {
-	addContact,
-	updateContact,
-	findContact,
-	batchCreateContacts,
-	unsubscribeContact,
-	resubscribeContact,
-	countContacts,
-	sendTransactional,
-	sendEvent,
-	sendCampaign,
-	triggerLoop,
-	deleteContact,
-} = loops.api();

package/example/convex/schema.ts DELETED Viewed

@@ -1,3 +0,0 @@
-import { defineSchema } from "convex/server";
-export default defineSchema({});

package/example/convex/tsconfig.json DELETED Viewed

@@ -1,34 +0,0 @@
-{
-	/* This TypeScript project config describes the environment that
-	 * Convex functions run in and is used to typecheck them.
-	 * You can modify it, but some settings required to use Convex.
-	 */
-	"compilerOptions": {
-		/* These settings are not required by Convex and can be modified. */
-		"allowJs": true,
-		"strict": true,
-		"skipLibCheck": true,
-		"verbatimModuleSyntax": true,
-		/* These compiler options are required by Convex */
-		"target": "ESNext",
-		"lib": ["ES2021", "dom", "ESNext.Array"],
-		"forceConsistentCasingInFileNames": true,
-		"allowSyntheticDefaultImports": true,
-		"module": "ESNext",
-		"moduleResolution": "Bundler",
-		"isolatedModules": true,
-		"noEmit": true,
-		/* This should only be used in this example. Real apps should not attempt
-		 * to compile TypeScript because differences between tsconfig.json files can
-		 * cause the code to be compiled differently.
-		 */
-		// Un-comment this to get instant types between your component and example.
-		// However, if you're willing to wait for a build before the types update,
-		// it's better to leave this commented out to catch build errors faster.
-		"customConditions": ["@convex-dev/component-source"]
-	},
-	"include": ["./**/*"],
-	"exclude": ["./_generated"]
-}