Incorrect documentation

[ericwooley]

Expected Behavior

https://github.com/openworkflowdev/openworkflow/blob/d828d640c7538abc01381932f3a431064e7f29bc/packages/docs/docs/workflows.mdx#running-a-workflow

Specifies you can define a workflow like this:

import { defineWorkflow } from "openworkflow";

export const sendWelcomeEmail = defineWorkflow(
  { name: "send-welcome-email" },
  async ({ input, step }) => {
    const user = await step.run({ name: "fetch-user" }, async () => {
      return await db.users.findOne({ id: input.userId });
    });

    await step.run({ name: "send-email" }, async () => {
      await emailService.send({
        to: user.email,
        subject: "Welcome!",
        body: "Thanks for signing up.",
      });
    });

    return { sent: true };
  },
);

and run it like this:

import { sendWelcomeEmail } from "./workflows/send-welcome-email";

const handle = await sendWelcomeEmail.run({ userId: "user_123" });

Actual Behavior

however, when I do that, i get an error that run is not defined. I looked at the code, and that appears to be correct:

openworkflow/packages/openworkflow/workflow.ts

Line 46 in d828d64

export interface Workflow<Input, Output, RawInput> {

I don't see a run function anywhere. I suspect this might be documentation for an old version?

Steps to Reproduce

1. Install openworkflow with these versions

pnpm ls | grep openworkflow
@openworkflow/backend-postgres 0.6.0
openworkflow 0.6.7
@openworkflow/cli 0.4.0

2. Write out the example.
3. See the error: Property 'run' does not exist on type 'Workflow<...>'.ts(2339)

[ericwooley]

I discovered https://github.com/openworkflowdev/openworkflow/blob/main/examples/basic/index.ts

I think, the documentation is sort of mixing how this should work? If I define it using the OpenWorkflow class, then I can run it with something like:

import { OpenWorkflow } from 'openworkflow';
import { BackendPostgres } from '@openworkflow/backend-postgres';
// eslint-disable-next-line no-undef
const postgresUrl = process.env.OPENWORKFLOW_POSTGRES_URL;
if (!postgresUrl) throw new Error('No postgres url');
export default new OpenWorkflow({
  backend: await BackendPostgres.connect(postgresUrl, {
    namespaceId: 'default',
    runMigrations: true,
  }),
});

import ow from './openworkflow.client.ts'
import {sendWelcomeEmail}  from './workflows/sendWelcomeEmail.ts'
const wf = await openWorkFlow.runWorkflow(sendWelcomeEmail.spec, workflowInput);
const result = await wf.result(); 

[jamescmartinez]

Thanks for flagging this - the docs are indeed wrong here

defineWorkflow is a newer API that returns a pure definition object (spec + implementation). It has no connection to the backend, so it doesn't have the .run() method like our older client.defineWorkflow does

I'll push a fix to the docs shortly