@panter/cloud-tasks 0.0.0-main-bd6f546b → 0.0.0

package/README.md

@@ -1,176 +1,4 @@
-# 🚀 Google Cloud Tasks, Simplified
+# Make Google Cloud Tasks Great Again
 
-A lightweight library that streamlines the use of **Google Cloud Tasks**.
-
-## 🔹 Why Use This Library?
-
-Using Google Cloud Tasks typically requires:
-
-1. Implementing a worker service.
-2. Defining and managing the API between the worker and client.
-3. Handling task queue management and scheduling.
-4. Setting up a local development environment.
-5. Configuring Google Cloud Tasks to send HTTP requests to the worker.
-
-This library eliminates much of this complexity by leveraging **tRPC** to define the API between the worker and the client.
-
-### ✅ Key Features
-
-- **Seamless API communication** between workers and clients.
-- **Simple task scheduling** with an intuitive API.
-- **Type safety and jump-to-definition** support via tRPC.
-- **Built-in support for local development** with a Cloud Tasks emulator.
-
----
-
-## 📂 Example Usage
-
-Suppose we have two task workers (`when-multiple` and `this-is-nice-convention`) and a backend API (`some-backend-api`) that schedules tasks.
-
-### Project Structure
-
-```plaintext
-.
-└── apps/
-    ├── tasks-worker-when-multiple/
-    │   ├── api.ts
-    │   └── index.ts
-    ├── tasks-worker-this-is-nice-convention/
-    │   ├── api.ts
-    │   └── index.ts
-    └── some-backend-api/
-        └── src/
-            └── someEndpoint.ts
-```
-
----
-
-### 🛠 Step 1: Create the Task Worker (`api.ts`)
-
-Define a **tRPC-powered task server**:
-
-```ts
-import { logger } from "@repo/logger";
-import { createTasksServer } from "@panter/cloud-tasks/server";
-import { z } from "zod";
-
-logger.info("Starting tasks server...");
-
-export const { runServer, router } = createTasksServer((t) =>
-  t.router({
-    getUser: t.procedure.input(z.string()).query((opts) => {
-      return { id: opts.input, name: "Bilbo" };
-    }),
-    createUser: t.procedure
-      .input(z.object({ name: z.string().min(5) }))
-      .mutation(async (opts) => {
-        await new Promise((resolve) => setTimeout(resolve, 1000));
-        return { id: "1", name: opts.input.name };
-      }),
-    doNothing: t.procedure.mutation(() => {
-      logger.info("Executing a no-op task");
-    }),
-    sendEmail: t.procedure.mutation(() => {}),
-  }),
-);
-
-// Export the router type for use in the client
-export type Router = typeof router;
-```
-
----
-
-### 🚀 Step 2: Start the Task Worker (`index.ts`)
-
-Initialize the worker server:
-
-```ts
-import { logger } from "@repo/logger";
-import { runServer } from "./api";
-
-const port = parseInt(process.env.PORT);
-runServer(port);
-logger.info(`🚀 Task worker tRPC server running at http://localhost:${port}/`);
-```
-
----
-
-### 🏗 Step 3: Create the Task Client (`some-backend-api`)
-
-Now, in the backend API (`some-backend-api`), define a **task client** to send tasks:
-
-```ts
-import { builder } from "../builder";
-import { logger } from "@repo/logger";
-
-// Import the router type from the worker
-import type { Router } from "@repo/tasks-worker-when-multiple/api";
-import { createTasksClient } from "@panter/cloud-tasks/client";
-
-const tasks = createTasksClient<Router>({
-  tasksWorkerUrl: new URL(process.env.TASKS_WORKER_URL),
-  queueName: "reasonable-queue-name",
-  useEmulator: process.env.ENV_SHORT === "local", // Enable emulator in local development
-  logger,
-});
-
-builder.mutationField("runJob", (t) =>
-  t.field({
-    type: "String",
-    resolve: async () => {
-      // Schedule a task with a payload
-      await tasks.createUser.schedule({ name: "Bilbo Baggins" });
-      //          ^^^^^^^^^^ Try jumping to definition here!
-      return "ok";
-    },
-  }),
-);
-```
-
-#### 📌 Important: Avoid Circular Dependencies
-
-Notice that `Router` is **imported as a type** from `api.ts`. This prevents circular dependencies since `@repo/tasks-worker-when-multiple` is only included as a `devDependency`:
-
-```json
-{
-  "dependencies": {
-    "@panter/cloud-tasks": "^0.0.1"
-  },
-  "devDependencies": {
-    "@repo/tasks-worker-when-multiple": "workspace:*"
-  }
-}
-```
-
----
-
-## 🛠 Local Development: Using Cloud Tasks Emulator
-
-For local testing, use the **Cloud Tasks Emulator** with Docker:
-
-```yml
-version: "3.1"
-
-services:
-  gcloud-tasks-emulator:
-    image: ghcr.io/aertje/cloud-tasks-emulator:latest
-    command: -host 0.0.0.0 -port 8123
-    ports:
-      - "6020:8123"
-    # NOTE: Comment out `extra_hosts` if using Podman (see: https://github.com/containers/podman/issues/21681)
-    extra_hosts:
-      - "host.containers.internal:host-gateway"
-```
-
----
-
-## 🎯 Summary
-
-This library makes **Google Cloud Tasks** easy to use by:
-
-- Removing the need for manual HTTP request handling.
-- Providing a **type-safe, tRPC-powered API**.
-- Enabling seamless communication between workers and clients.
-- Offering **built-in support for local development**.
-
-💡 **With this library, scheduling background tasks is as simple as calling a function!** 🚀
+This allows you create quickly type safe API between your tasks
+worker and a client that sends tasks to it.

package/package.json

@@ -2,9 +2,9 @@
   "name": "@panter/cloud-tasks",
   "repository": {
     "type": "git",
-    "url": "https://git.panter.ch/open-source/cloud-tasks.git"
+    "url": "git+https://git.panter.ch/open-source/cloud-tasks.git"
   },
-  "version": "0.0.0-main-bd6f546b",
+  "version": "0.0.0",
   "sideEffects": false,
   "exports": {
     ".": {
@@ -48,18 +48,17 @@
   },
   "dependencies": {
     "@google-cloud/tasks": "^5.5.2",
-    "@trpc/client": "^10.45.2",
     "@trpc/server": "^10.45.2",
     "express": "^4.21.2",
     "ts-results-es": "^4.2.0"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
+    "@trpc/client": "^10.45.2",
     "@types/express": "^4.17.21",
     "esbuild": "^0.24.2",
     "prettier": "^3.4.2",
     "typescript": "5.7.3"
   },
-  "packageManager": "yarn@4.6.0",
-  "stableVersion": "0.0.0"
+  "packageManager": "yarn@4.6.0"
 }