@statelyai/agent 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @statelyai/agent
 
+## 0.0.7
+
+### Patch Changes
+
+- [#18](https://github.com/statelyai/agent/pull/18) [`dcaabab`](https://github.com/statelyai/agent/commit/dcaababe69255b7eaff3347d0cf09469d3e6cc78) Thanks [@davidkpiano](https://github.com/davidkpiano)! - `context` is now optional for `createSchemas(…)`
+
 ## 0.0.6
 
 ### Patch Changes

package/dist/index.d.ts

@@ -36,13 +36,13 @@ declare function createSchemas<const TContextSchema extends ContextSchema, const
      *
      * Must be of `{ type: 'object' }`.
      */
-    context: TContextSchema;
+    context?: TContextSchema;
     /**
      * An object mapping event types to each event object's JSON Schema.
      */
     events: TEventSchemas;
 }): {
-    context: TContextSchema;
+    context: TContextSchema | undefined;
     events: ConvertToJSONSchemas<TEventSchemas>;
     types: {
         context: FromSchema<TContextSchema>;

package/examples/wordGuesser.ts

@@ -0,0 +1,156 @@
+import { assign, log, setup } from 'xstate';
+import { getFromTerminal } from './helpers/helpers';
+import { createAgent, createOpenAIAdapter, createSchemas } from '../src';
+import OpenAI from 'openai';
+
+const openAI = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+const adapter = createOpenAIAdapter(openAI, {
+  model: 'gpt-4-1106-preview',
+});
+
+const schemas = createSchemas({
+  events: {
+    guessLetter: {
+      description: 'Player guesses a letter',
+      properties: {
+        letter: {
+          type: 'string',
+          description: 'The letter guessed',
+          maxLength: 1,
+          minLength: 1,
+        },
+      },
+    },
+    guessWord: {
+      description: 'Player guesses the full word',
+      properties: {
+        word: {
+          type: 'string',
+          description: 'The word guessed',
+        },
+      },
+    },
+  },
+});
+
+const context = {
+  word: null as string | null,
+  guessedWord: null as string | null,
+  letters: [] as string[],
+};
+
+const wordGuesserMachine = setup({
+  types: {
+    context: {} as typeof context,
+    events: schemas.types.events,
+  },
+  actors: {
+    getFromTerminal,
+    guesser: adapter.fromEvent(
+      (input: typeof context) => `
+You are trying to guess the word. The word has ${
+        input.word!.length
+      } letters. You have guessed the following letters so far: ${input.letters.join(
+        ', '
+      )}. These letters matched: ${input
+        .word!.split('')
+        .map((letter) =>
+          input.letters.includes(letter.toUpperCase())
+            ? letter.toUpperCase()
+            : '_'
+        )
+        .join('')}
+Please make your next guess - type a letter or the full word. You can only make 10 total guesses.
+    `
+    ),
+  },
+  schemas,
+}).createMachine({
+  initial: 'providingWord',
+  context,
+  states: {
+    providingWord: {
+      invoke: {
+        src: 'getFromTerminal',
+        input: 'Enter a word',
+        onDone: {
+          actions: assign({
+            word: ({ event }) => event.output,
+          }),
+          target: 'guessing',
+        },
+      },
+    },
+    guessing: {
+      always: {
+        guard: ({ context }) => context.letters.length > 10,
+        target: 'finalGuess',
+      },
+      invoke: {
+        src: 'guesser',
+        input: ({ context }) => context,
+      },
+      on: {
+        guessLetter: {
+          actions: assign({
+            letters: ({ context, event }) => {
+              return [...context.letters, event.letter.toUpperCase()];
+            },
+          }),
+          target: 'guessing',
+          reenter: true,
+        },
+        guessWord: {
+          actions: assign({
+            guessedWord: ({ event }) => event.word,
+          }),
+          target: 'gameOver',
+        },
+      },
+    },
+    finalGuess: {
+      invoke: {
+        src: 'guesser',
+        input: ({ context }) => context,
+      },
+      on: {
+        guessWord: {
+          actions: assign({
+            guessedWord: ({ event }) => event.word,
+          }),
+          target: 'gameOver',
+        },
+      },
+    },
+    gameOver: {
+      entry: log(({ context }) => {
+        if (
+          context.guessedWord?.toUpperCase() === context.word?.toUpperCase()
+        ) {
+          return 'You won!';
+        } else {
+          return 'You lost! The word was ' + context.word;
+        }
+      }),
+    },
+  },
+  exit: () => process.exit(),
+});
+
+const actor = createAgent(wordGuesserMachine, {
+  inspect: (ev) => {
+    if (ev.type === '@xstate.event') {
+      console.log(ev.event);
+    }
+  },
+});
+
+actor.subscribe((s) => {
+  console.log(s.value);
+  console.log(s.context);
+});
+
+actor.start();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statelyai/agent",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/schemas.ts

@@ -19,13 +19,13 @@ export function createSchemas<
    *
    * Must be of `{ type: 'object' }`.
    */
-  context: TContextSchema;
+  context?: TContextSchema;
   /**
    * An object mapping event types to each event object's JSON Schema.
    */
   events: TEventSchemas;
 }): {
-  context: TContextSchema;
+  context: TContextSchema | undefined;
   events: ConvertToJSONSchemas<TEventSchemas>;
   types: {
     context: FromSchema<TContextSchema>;