Swaps hello and goodbye

Author: omaiboroda

.github/workflows/npm-publish.yml

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "description": "Restack get started example",
   "scripts": {
-    "dev": "tsx --watch src/services.ts",
+    "dev": "tsx watch --include src src/services.ts",
     "build": "tsc --build",
     "schedule-workflow": "tsx scheduleWorkflow.ts",
     "restack-up": "tsx restackUp.ts",

examples/get-started/package.json

@@ -1,56 +1,43 @@
-# Requirements
+# Restack Get Started
 
-- Node 20 or higher
-- pnpm or other package manager
+A sample repository, which demonstrates working with Restack Framework and optional Restack OpenAI integration.
 
-## Install Restack Studio
+For a full Typescript documentation refer to <https://docs.restack.io/libraries/typescript/reference>
 
-To install the Restack Studio, you can use Docker.
+## Requirements
 
-```bash
-docker run -d --pull always --name studio -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
-```
-
-## Start services
+- **Node 20+**, **pnpm** (or other package manager)
 
-Where all your code is defined, including workflow steps.
-
-add OPENAI_API_KEY in .env
+## Install dependencies and start services
 
 ```bash
 pnpm i
-
 pnpm dev
 ```
 
-Your code will be running and syncing with Restack engine to execute workflows or functions.
-
-## Schedule a workflow
+This will start Node.js app with two Restack Services. Your code will be running and syncing with Restack engine to execute workflows or functions.
 
-In another shell:
+## Start Restack Studio
 
-pnpm schedule
+To start the Restack Studio, you can use Docker.
 
-Will schedule to start example workflow immediately.
+```bash
+docker run -d --pull always --name studio -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/restack:main
+```
 
-## Architecture
+## Schedule a demo workflow
 
-```mermaid
-flowchart TD
-    C[fa:fa-bolt scheduleWorkflow client] -->|registers workflow with schedule| E{Restack Engine}
-    E --> |queries results| C
-    E -->|pulls queue with input| P1[fa:fa-ship restack pod]
-    E -->|orchestrates with rate limit| P2[fa:fa-ship openai pod]
-    P1 -->|runs| W[fa:fa-th-list example workflow]
-    P1 -->|runs| Go[fa:fa-code goodbye function]
-    P2 -->|runs| Gr[fa:fa-code greet function]
-    P1 -->|sends status + output | E
-    P2 -->|sends status output | E
+```bash
+pnpm schedule-workflow
 ```
 
-## Deploy on Restack
+This will trigger a demo Workflow - a greeting, which is a simple function and goodbye, which uses [@restackio/integration-openai](https://www.npmjs.com/package/@restackio/integrations-openai).
+
+## Deploy on Restack Cloud
 
+``` bash
 pnpm restack-up
+```
 
 To deploy the application on Restack, you can use the provided `restackUp.ts` script. This script utilizes the Restack Cloud SDK to define and deploy your application stack. It sets up the necessary environment variables and configures the application for deployment.
 

examples/get-started/readme.md

@@ -0,0 +1,11 @@
+interface Input {
+  name: string;
+}
+
+interface Output {
+  message: string;
+}
+
+export async function hello(input: Input): Promise<Output> {
+  return { message: `Hello, ${input.name}!` };
+}

examples/get-started/src/functions/goodbye.ts

@@ -1 +1 @@
-export * from "./goodbye";
+export * from "./hello";

examples/get-started/src/functions/hello.ts

@@ -1,4 +1,4 @@
-import { goodbye } from "./functions";
+import { hello } from "./functions";
 import { openaiService } from "@restackio/integrations-openai";
 import { client } from "./client";
 
@@ -9,7 +9,7 @@ async function services() {
       // Start service with current workflows and functions
       client.startService({
         workflowsPath,
-        functions: { goodbye },
+        functions: { hello },
       }),
       // Start the openai service
       openaiService({ client }),

examples/get-started/src/functions/index.ts

@@ -8,41 +8,47 @@ import * as functions from "../functions";
 interface Input {
   name: string;
 }
+const GoodbyeMessageSchema = z.object({
+  message: z.string().describe("The goodbye message."),
+});
 
-export async function helloWorkflow({ name }: Input) {
-  const userContent = `Greet this person: ${name}. In 4 words or less.`;
+const goodbyeJsonSchema = {
+  name: "goodbye",
+  schema: zodToJsonSchema(GoodbyeMessageSchema),
+};
 
-  const MessageSchema = z.object({
-    message: z.string().describe("The greeting message."),
+export async function helloWorkflow({ name }: Input) {
+  // Step 1: Create hello message with simple function
+  const { message: greetMessage } = await step<typeof functions>({}).hello({
+    name,
   });
 
-  const jsonSchema = {
-    name: "greet",
-    schema: zodToJsonSchema(MessageSchema),
-  };
-
-  // Step 1 create greeting message with openai
-  const openaiOutput = await step<typeof openaiFunctions>({
-    taskQueue: openaiTaskQueue,
-  }).openaiChatCompletionsBase({
-    userContent,
-    jsonSchema,
-  });
+  log.info("Hello", { greetMessage });
 
-  const greetMessage = openaiOutput.result.choices[0].message.content ?? "";
-  const greetCost = openaiOutput.cost;
+  // Step 2: Create goodbye message with our OpenAI integration (requires OPENAI_API_KEY in .env)
+  let goodbyeMessage;
+  try {
+    const userContent = `Say goodbye to this person: ${name}. In 4 words or less.`;
 
-  log.info("greeted", { greetMessage });
+    const openaiOutput = await step<typeof openaiFunctions>({
+      taskQueue: openaiTaskQueue,
+    }).openaiChatCompletionsBase({
+      userContent,
+      jsonSchema: goodbyeJsonSchema,
+    });
 
-  // Step 2 create goodbye message with simple function
-  const { message: goodbyeMessage } = await step<typeof functions>({}).goodbye({
-    name,
-  });
+    goodbyeMessage = openaiOutput.result.choices[0].message.content ?? "";
 
-  log.info("goodbye", { goodbyeMessage });
+    log.info("Goodbye", { goodbyeMessage });
+  } catch (error: any) {
+    if (error.failure.cause.message.includes("API key is required")) {
+      log.warn("Provide an OpenAI API key to use the OpenAI integration", {
+        error,
+      });
+    }
+  }
 
   return {
-    messages: [greetMessage, goodbyeMessage],
-    cost: greetCost,
+    messages: { greetMessage, goodbyeMessage },
   };
 }