npm - @dbos-inc/create - Versions diffs - 1.31.23-preview → 1.31.25-preview - Mend

@dbos-inc/create 1.31.23-preview → 1.31.25-preview

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

package/templates/hello-nextjs/src/app/layout.tsx DELETED Viewed

@@ -1,34 +0,0 @@
-import type { Metadata } from "next";
-import { Geist, Geist_Mono } from "next/font/google";
-import "./globals.css";
-const geistSans = Geist({
-  variable: "--font-geist-sans",
-  subsets: ["latin"],
-});
-const geistMono = Geist_Mono({
-  variable: "--font-geist-mono",
-  subsets: ["latin"],
-});
-export const metadata: Metadata = {
-  title: "Create Next App with DBOS",
-  description: "Generated by DBOS",
-};
-export default function RootLayout({
-  children,
-}: Readonly<{
-  children: React.ReactNode;
-}>) {
-  return (
-    <html lang="en">
-      <body
-        className={`${geistSans.variable} ${geistMono.variable} antialiased`}
-      >
-        {children}
-      </body>
-    </html>
-  );
-}

package/templates/hello-nextjs/src/app/page.tsx DELETED Viewed

@@ -1,73 +0,0 @@
-import Image from "next/image";
-import BackGroundTask from "@/components/client/BackGroundTask";
-import CallDBOSWorkflow from "@/components/client/callDBOSWorkflow";
-export default function Home() {
-  return (
-    <div className="grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20 font-[family-name:var(--font-geist-sans)]">
-      <main className="flex flex-col gap-8 row-start-2 items-center sm:items-start">
-          <h1 className="text-xl font-semibold mb-4">Welcome to DBOS!</h1>
-          <p className="mb-4">
-             DBOS helps you build applications that are <strong>resilient to any failure</strong>&mdash;no matter how many times you crash this app, your background task will always recover from its last completed step in about ten seconds.
-         </p>
-         <div>
-            <CallDBOSWorkflow wfResult="" />
-          </div>
-          <div>
-            <BackGroundTask />
-          </div>
-        </main>
-      <footer className="row-start-3 flex gap-6 flex-wrap items-center justify-center">
-        <a
-          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
-          href="https://docs.dbos.dev/"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <Image
-            aria-hidden
-            src="/file.svg"
-            alt="File icon"
-            width={16}
-            height={16}
-          />
-          Learn
-        </a>
-        <a
-          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
-          href="https://docs.dbos.dev/#example-applications"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <Image
-            aria-hidden
-            src="/window.svg"
-            alt="Window icon"
-            width={16}
-            height={16}
-          />
-          Examples
-        </a>
-        <a
-          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
-          href="https://www.dbos.dev/"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <Image
-            aria-hidden
-            src="/globe.svg"
-            alt="Globe icon"
-            width={16}
-            height={16}
-          />
-          Go to dbos.dev →
-        </a>
-      </footer>
-    </div>
-  );
-}

package/templates/hello-nextjs/src/app/step/[slug]/route.ts DELETED Viewed

@@ -1,15 +0,0 @@
-import { NextResponse } from "next/server";
-import { DBOS } from "@dbos-inc/dbos-sdk";
-export async function GET(request: Request, { params }: { params: Promise<{ slug: string }> }) {
-    const taskId = (await params).slug;
-    DBOS.logger.info(`Received request to check on taskId: ${taskId}`);
-    let step = await DBOS.getEvent(taskId, "steps_event");
-    DBOS.logger.info(`For taskId: ${taskId} we are done with ${step} steps`);
-    return NextResponse.json({ "stepsCompleted": step});
-}

package/templates/hello-nextjs/src/app/tasks/[slug]/route.ts DELETED Viewed

@@ -1,18 +0,0 @@
-import { NextResponse } from "next/server";
-import { DBOS } from "@dbos-inc/dbos-sdk";
-import { dbosBackgroundTask } from "@/actions/dbosWorkflow";
-export async function GET(request: Request, { params }: { params: Promise<{ slug: string }> }) {
-    const taskId = (await params).slug;
-    DBOS.logger.info(`Received request to start background task taskId: ${taskId}`);
-    DBOS.logger.info(`Started background task taskId: ${taskId}`);
-    await dbosBackgroundTask(taskId)
-    return NextResponse.json({ message: "Background task started" });
-}

package/templates/hello-nextjs/src/components/client/BackGroundTask.tsx DELETED Viewed

@@ -1,179 +0,0 @@
-"use client";
-import { useState, useEffect } from "react";
-import { useRouter, useSearchParams } from "next/navigation";
-import { Suspense } from 'react'
-let intervalInitialized = false;
-function generateRandomString(): string {
-    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-    const array = new Uint8Array(6);
-    crypto.getRandomValues(array); // Fills the array with cryptographically random values
-    return Array.from(array)
-        .map(x => chars[x % chars.length])
-        .join('');
-}
-function BackGroundTask() {
-    const [isRunning, setIsRunning] = useState(false);
-    const [currentStep, setCurrentStep] = useState(0);
-    const [taskId, setTaskid] = useState("");
-    const [isReconnecting, setIsReconnecting] = useState(false);
-    const router = useRouter();
-    const searchParams = useSearchParams();
-    const startBackgroundJob = async () => {
-      setIsRunning(true);
-      setCurrentStep(0);
-      let task = taskId
-      if (taskId === "") {
-        task = generateRandomString();
-        setTaskid(task);
-        updateQueryParam("id", task);
-      }
-      //  start the background job
-      try {
-        await fetch(`/tasks/${task}`, { method: "GET" });
-      } catch (error) {
-        console.error("Failed to start job", error);
-        setIsRunning(false);
-      }
-  };
-  const crashApp = async () => {
-    if(!isRunning) {
-        console.log("Not running, nothing to crash");
-        return;
-    }
-    setIsRunning(false);
-    console.log("Crashing the application");
-    // stop the background job
-    try {
-      await fetch("/crash", { method: "GET" });
-    } catch (error) {
-      console.error("Failed to start job", error);
-    }
-  };
-  // Update the URL query parameter
-  const updateQueryParam = (key: string, value: string) => {
-    const params = new URLSearchParams(searchParams.toString());
-    params.set(key, value);
-    const newUrl = `${window.location.pathname}?${params.toString()}`;
-    router.replace(newUrl);
-  };
-  // Remove the `id` query parameter from the URL
-  const clearQueryParam = (key: string) => {
-    const params = new URLSearchParams(searchParams.toString());
-    params.delete(key);
-    const newUrl = `${window.location.pathname}?${params.toString()}`;
-    router.replace(newUrl);
-  };
-  // fetch the current progress
-  const fetchProgress = async () => {
-    try {
-      if (taskId === "") {
-        console.log("No task to monitor");
-        return;
-      }
-      const response = await fetch(`/step/${taskId}`, { method: "GET" });
-      if (!response.ok) {
-        console.error("Failed to fetch job progress", response.statusText);
-        setIsReconnecting(true);
-        return;
-      }
-      setIsReconnecting(false);
-      const data = await response.json();
-      console.log("Step completed", data.stepsCompleted);
-      if (data.stepsCompleted) {
-        setIsRunning(true);
-        setCurrentStep(data.stepsCompleted);
-        if (data.stepsCompleted === 10) {
-          clearQueryParam("id");
-          setIsRunning(false);
-          setTaskid("");
-          setCurrentStep(0);
-        }
-      }
-    } catch (error) {
-      console.error("Failed to fetch job progress", error);
-      setIsRunning(false);
-      setTaskid("");
-      setIsReconnecting(true);
-    }
-  };
-   // Polling the progress every 2 seconds while the job is running
-  useEffect(() => {
-    const idFromUrl = searchParams.get("id");
-    if (idFromUrl) {
-      setTaskid(idFromUrl);
-      setIsRunning(true); // Assume the job is already running if there's an ID
-    }
-    if (!intervalInitialized) {
-      const interval = setInterval(fetchProgress, 2000);
-      intervalInitialized = true;
-      return () => {
-        clearInterval(interval);
-        intervalInitialized = false;
-      };
-    }
-  }, [searchParams]);
-  return (
-    <div>
-      <div className="flex flex-row gap-2">
-        <button onClick={startBackgroundJob} disabled={isRunning} className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600">
-          {isRunning ? "Job in Progress..." : "Start Background Job"}
-        </button>
-        <button onClick={crashApp} disabled={!isRunning} className="px-4 py-2 bg-red-500 text-white rounded hover:bg-red-600">
-           { isRunning ? "Crash the application" : "Not Running"}
-        </button>
-      </div>
-      <p>
-        {currentStep < 10
-          ? `Your background task has completed step ${currentStep} of 10.`
-          : "Background task completed successfully!"}
-      </p>
-      <p>
-        {isReconnecting ? "Reconnecting..." : ""}
-      </p>
-    </div>
-  );
-}
-const WrappedBackgroundJobComponent = () => (
-    <Suspense fallback={<p>Loading...</p>}>
-      <BackGroundTask />
-    </Suspense>
-  );
-export default WrappedBackgroundJobComponent;

package/templates/hello-nextjs/src/components/client/callDBOSWorkflow.tsx DELETED Viewed

@@ -1,31 +0,0 @@
-"use client";
-import { useState } from "react";
-export default function CallDBOSWorkflow( { wfResult }: { wfResult: string }) {
-    const [greetingsWfResult, setGreetingsWfResult] = useState<string>(wfResult);
-    const [loading, setLoading] = useState<boolean>(false);
-    const greetUser = async () => {
-        setLoading(true);
-        try {
-            const response = await fetch("/greetings", { method: "POST", body: JSON.stringify({ userName: "dbosuser" }) });
-            const data = await response.json();
-            setGreetingsWfResult(data);
-        } catch (error) {
-            console.error("Error calling greetings workflow", error);
-            setGreetingsWfResult("Error calling greetings workflow: " + error);
-        } finally {
-            setLoading(false);
-        }
-    }
-    return(
-        <div>
-            <button onClick={greetUser} disabled={loading} className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600">
-                {loading ? "" : "Run DBOS Workflow"}
-            </button>
-            <p>{greetingsWfResult}</p>
-        </div>
-  );
-}

package/templates/hello-nextjs/src/dbos/background.ts DELETED Viewed

@@ -1,23 +0,0 @@
-import { DBOS } from "@dbos-inc/dbos-sdk";
-export class dbosWorkflowClass {
-    @DBOS.transaction()
-    static async backgroundTaskStep(i : number) {
-        DBOS.logger.info(`Completed step ${i}`);
-    }
-    @DBOS.workflow()
-    static async backgroundTask(i: number) {
-        DBOS.logger.info("Hello from background task!");
-        for (let j = 1; j <= i; j++) {
-            await dbosWorkflowClass.backgroundTaskStep(j);
-            DBOS.logger.info("Sleeping for 2 seconds");
-            await DBOS.sleepSeconds(2);
-            await DBOS.setEvent("steps_event", j)
-        }
-        DBOS.logger.info("Background task complete!");
-    }
-}

package/templates/hello-nextjs/src/dbos/hello.ts DELETED Viewed

@@ -1,24 +0,0 @@
-import { DBOS } from "@dbos-inc/dbos-sdk";
-import { Knex } from "knex";
-export interface dbos_hello {
-    name: string;
-    greet_count: number;
-  }
-function getClient() {return DBOS.knexClient as Knex;}
-export class helloWorkflowClass {
-    @DBOS.transaction()
-    static async helloDBOS(userName: string) {
-        DBOS.logger.info("Hello from DBOS Transaction!");
-        // Retrieve and increment the number of times this user has been greeted.
-        const query = "INSERT INTO dbos_hello (name, greet_count) VALUES (?, 1) ON CONFLICT (name) DO UPDATE SET greet_count = dbos_hello.greet_count + 1 RETURNING greet_count;";
-        const { rows } = await getClient().raw(query, [userName]) as { rows: dbos_hello[] };
-        const greet_count = rows[0].greet_count;
-        const greeting = `Hello! You have been greeted ${greet_count} times.`;
-        return greeting;
-    }
-}

package/templates/hello-nextjs/src/dbos/operations.ts DELETED Viewed

@@ -1,9 +0,0 @@
-import { DBOS } from "@dbos-inc/dbos-sdk";
-export  { dbosWorkflowClass } from "./background";
-export  { helloWorkflowClass } from "./hello";
-console.log("Hello from operations.ts");
-if (process.env.NEXT_PHASE !== "phase-production-build") {
-   await DBOS.launch()
-}

package/templates/hello-nextjs/tailwind.config.ts DELETED Viewed

@@ -1,18 +0,0 @@
-import type { Config } from "tailwindcss";
-export default {
-  content: [
-    "./src/pages/**/*.{js,ts,jsx,tsx,mdx}",
-    "./src/components/**/*.{js,ts,jsx,tsx,mdx}",
-    "./src/app/**/*.{js,ts,jsx,tsx,mdx}",
-  ],
-  theme: {
-    extend: {
-      colors: {
-        background: "var(--background)",
-        foreground: "var(--foreground)",
-      },
-    },
-  },
-  plugins: [],
-} satisfies Config;

package/templates/hello-nextjs/tsconfig.json DELETED Viewed

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "target": "ES2017",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "preserve",
-    "incremental": true,
-    "plugins": [
-      {
-        "name": "next"
-      }
-    ],
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
-}

package/templates/hello-prisma/.vscode/extensions.json DELETED Viewed

@@ -1,7 +0,0 @@
-{
-	// Automatically recommend the DBOS extension to VSCode users.
-	// Documentation on extensions.json: http://go.microsoft.com/fwlink/?LinkId=827846
-	"recommendations": [
-		"dbos-inc.dbos-ttdbg"
-	]
-}

package/templates/hello-prisma/.vscode/launch.json DELETED Viewed

@@ -1,21 +0,0 @@
-{
-    // Automatically configure the VSCode debugger for DBOS projects.
-    // Documentation on launch.json: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-      {
-        "type": "node-terminal",
-        "request": "launch",
-        "name": "Local Debug",
-        "command": "npx dbos start",
-        "preLaunchTask": "npm: build",
-      },
-      {
-        "type": "node-terminal",
-        "request": "launch",
-        "name": "Time Travel Debug",
-        "command": "npx dbos debug -x ${command:dbos-ttdbg.get-proxy-url} -u ${command:dbos-ttdbg.pick-workflow-id}",
-        "preLaunchTask": "npm: build"
-      }
-    ]
-  }

package/templates/hello-prisma/.vscode/tasks.json DELETED Viewed

@@ -1,19 +0,0 @@
-{
-    // Configure the build command for DBOS projects using VSCode.
-    // Documentation on tasks.json: https://code.visualstudio.com/docs/editor/tasks
-    "version": "2.0.0",
-    "tasks": [
-      {
-        "label": "npm: build",
-        "type": "npm",
-        "script": "build",
-        "group": {
-          "kind": "build",
-          "isDefault": true
-        },
-        "problemMatcher": [
-          "$tsc"
-        ]
-      }
-    ]
-  }

package/templates/hello-prisma/README.md DELETED Viewed

@@ -1,51 +0,0 @@
-# DBOS Hello with Prisma
-This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Prisma](https://docs.dbos.dev/typescript/tutorials/orms/using-prisma).
-## Getting Started
-Before you can launch your app, you need a database.
-DBOS works with any Postgres database, but to make things easier, we've provided a script that starts a Docker Postgres container and creates a database.
-Run:
-```bash
-node start_postgres_docker.js
-```
-If successful, the script should print `Database started successfully!`.
-Next, build the app:
-```bash
-npm run build
-```
-Then, run a schema migration to create some tables.
-Prisma provides rich support for [schema migrations](https://www.prisma.io/docs/orm/prisma-migrate), including automatic generation of migration files from Prisma schema.
-Fore more information, see [our docs](https://docs.dbos.dev/typescript/tutorials/orms/using-prisma).
-```bash
-npx dbos migrate
-```
-If successful, the migration should print `Migration successful!`.
-Finally, run the app:
-```bash
-npx dbos start
-```
-To see that it's working, visit this URL in your browser: [`http://localhost:3000/greeting/dbos`](http://localhost:3000/greeting/dbos).
-You should get this message: `Hello, dbos! You have been greeted 1 times.`
-Each time you refresh the page, the counter should go up by one!
-Congratulations! You just launched a DBOS application.
-## Next Steps
-- For more information on using Prisma with DBOS, check out [our docs](https://docs.dbos.dev/typescript/tutorials/orms/using-prisma).
-- To add more functionality to this application, modify `src/operations.ts`, then rebuild and restart it.  Alternatively, `npm run dev` uses `nodemon` to automatically rebuild and restart the app when source files change, using instructions specified in `nodemon.json`.
-- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
-- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/quickstart/)
-- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

package/templates/hello-prisma/start_postgres_docker.js DELETED Viewed

@@ -1,40 +0,0 @@
-const { execSync } = require('child_process');
-// Default PostgreSQL port
-let port = '5432';
-// Set the host PostgreSQL port with the -p/--port flag.
-process.argv.forEach((val, index) => {
-  if (val === '-p' || val === '--port') {
-    if (process.argv[index + 1]) {
-      port = process.argv[index + 1];
-    }
-  }
-});
-if (!process.env.PGPASSWORD) {
-  console.error("Error: PGPASSWORD is not set.");
-  process.exit(1);
-}
-try {
-  execSync(`docker run --rm --name=dbos-db --env=POSTGRES_PASSWORD="${process.env.PGPASSWORD}" --env=PGDATA=/var/lib/postgresql/data --volume=/var/lib/postgresql/data -p ${port}:5432 -d sibedge/postgres-plv8`);
-  console.log("Waiting for PostgreSQL to start...");
-  let attempts = 30;
-  const checkDatabase = setInterval(() => {
-    try {
-      execSync('docker exec dbos-db psql -U postgres -c "SELECT 1;"', { stdio: 'ignore' });
-      console.log("PostgreSQL started!");
-      clearInterval(checkDatabase);
-      console.log("Database started successfully!");
-    } catch (error) {
-      if (--attempts === 0) {
-        clearInterval(checkDatabase);
-        console.error("Failed to start PostgreSQL.");
-      }
-    }
-  }, 1000);
-} catch (error) {
-  console.error("Error starting PostgreSQL in Docker:", error.message);
-}

package/templates/hello-typeorm/.vscode/extensions.json DELETED Viewed

@@ -1,7 +0,0 @@
-{
-	// Automatically recommend the DBOS extension to VSCode users.
-	// Documentation on extensions.json: http://go.microsoft.com/fwlink/?LinkId=827846
-	"recommendations": [
-		"dbos-inc.dbos-ttdbg"
-	]
-}

package/templates/hello-typeorm/.vscode/launch.json DELETED Viewed

@@ -1,21 +0,0 @@
-{
-    // Automatically configure the VSCode debugger for DBOS projects.
-    // Documentation on launch.json: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-      {
-        "type": "node-terminal",
-        "request": "launch",
-        "name": "Local Debug",
-        "command": "npx dbos start",
-        "preLaunchTask": "npm: build",
-      },
-      {
-        "type": "node-terminal",
-        "request": "launch",
-        "name": "Time Travel Debug",
-        "command": "npx dbos debug -x ${command:dbos-ttdbg.get-proxy-url} -u ${command:dbos-ttdbg.pick-workflow-id}",
-        "preLaunchTask": "npm: build"
-      }
-    ]
-  }

package/templates/hello-typeorm/.vscode/tasks.json DELETED Viewed

@@ -1,19 +0,0 @@
-{
-    // Configure the build command for DBOS projects using VSCode.
-    // Documentation on tasks.json: https://code.visualstudio.com/docs/editor/tasks
-    "version": "2.0.0",
-    "tasks": [
-      {
-        "label": "npm: build",
-        "type": "npm",
-        "script": "build",
-        "group": {
-          "kind": "build",
-          "isDefault": true
-        },
-        "problemMatcher": [
-          "$tsc"
-        ]
-      }
-    ]
-  }