@midsummer-ai/sdk 0.0.0-stage → 0.1.0-next.1723

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @midsummer-ai/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The handles a Midsummer app's code uses for its Database, Storage, Queues, Vector DB, AI, Email and Agents, each with a stand-in for tests.
+
+Docs: https://docs.midsummer.new

package/agents/contract.d.mts

@@ -0,0 +1,9 @@
+import { RunWire } from "./index.mjs";
+//#region src/agents/contract.d.ts
+interface AgentContractCase {
+  readonly name: string;
+  run(start: (input?: unknown) => Promise<RunWire>): Promise<void>;
+}
+declare const agentContract: ReadonlyArray<AgentContractCase>;
+//#endregion
+export { AgentContractCase, agentContract };

package/agents/contract.mjs

@@ -0,0 +1,221 @@
+import { AgentError, execute } from "./index.mjs";
+//#region src/agents/contract.ts
+/**
+* Agents' contract: what every place that keeps Agent runs promises, as cases any test runner can
+* run. The Stand-in runs them in this package; the platform runs the same cases through its wire.
+*
+*   for (const c of agentContract) test(c.name, () => c.run(makeRuns()))
+*
+* Each case gets `start`, which begins a new run of a fresh Agent whose version allows the tool
+* `greet` and no other, in one Environment, and returns the run's wire. Expected values are written
+* out, never computed with the SDK's own code.
+*/
+const greeter = {
+	tools: { greet: (input) => `Hello, ${input.name}!` },
+	async run(input, agent) {
+		await agent.log("starting");
+		return { greeting: await agent.tool("greet", { name: input.name }) };
+	}
+};
+const agentContract = [
+	{
+		name: "a run completes with what its code returns, and a run that ended is not run again",
+		async run(start) {
+			const wire = await start({ name: "Ada" });
+			equal(await execute(greeter, wire), {
+				status: "completed",
+				output: { greeting: "Hello, Ada!" }
+			}, "the run's end");
+			let ran = false;
+			equal(await execute({ run: () => {
+				ran = true;
+			} }, wire), {
+				status: "completed",
+				output: { greeting: "Hello, Ada!" }
+			}, "the end, asked again");
+			equal(ran, false, "whether the code ran again");
+		}
+	},
+	{
+		name: "a run whose code throws fails with its message",
+		async run(start) {
+			equal(await execute({ run: () => {
+				throw new Error("no input");
+			} }, await start()), {
+				status: "failed",
+				error: "no input"
+			}, "the run's end");
+		}
+	},
+	{
+		name: "a run cut off part way resumes when run again: a step's work is done once",
+		async run(start) {
+			const wire = await start({ name: "Ada" });
+			let charged = 0;
+			const agent = { async run(_input, context) {
+				await context.step("charge", () => {
+					charged += 1;
+					return "charged";
+				});
+				await context.memory.set("charged", true);
+				return { done: await context.step("send", () => "sent") };
+			} };
+			let calls = 0;
+			const cut = {
+				...wire,
+				call: (number, call) => ++calls > 3 ? Promise.reject(new AgentError("unavailable", "lost")) : wire.call(number, call),
+				finish: () => Promise.reject(new AgentError("unavailable", "lost"))
+			};
+			await execute(agent, cut).then(() => {
+				throw new Error("the cut-off run ended");
+			}, (error) => equal(error.code, "unavailable", "why it stopped"));
+			equal(await execute(agent, wire), {
+				status: "completed",
+				output: { done: "sent" }
+			}, "the resumed run's end");
+			equal(charged, 1, "how many times the step's work ran");
+		}
+	},
+	{
+		name: "a tool whose own work made calls is answered from what was kept, and the run goes on after them",
+		async run(start) {
+			const wire = await start({ name: "Ada" });
+			let greeted = 0;
+			const agent = {
+				tools: { greet: async (input, context) => {
+					greeted += 1;
+					await context.log(`greeting ${input.name}`);
+					return `Hello, ${input.name}!`;
+				} },
+				async run(input, context) {
+					const greeting = await context.tool("greet", { name: input.name });
+					await context.memory.set("greeted", greeting);
+					return {
+						greeting,
+						kept: await context.memory.get("greeted")
+					};
+				}
+			};
+			let calls = 0;
+			const cut = {
+				...wire,
+				call: (number, call) => ++calls > 3 ? Promise.reject(new AgentError("unavailable", "lost")) : wire.call(number, call),
+				finish: () => Promise.reject(new AgentError("unavailable", "lost"))
+			};
+			await execute(agent, cut).then(() => {
+				throw new Error("the cut-off run ended");
+			}, (error) => equal(error.code, "unavailable", "why it stopped"));
+			equal(await execute(agent, wire), {
+				status: "completed",
+				output: {
+					greeting: "Hello, Ada!",
+					kept: "Hello, Ada!"
+				}
+			}, "the resumed run's end");
+			equal(greeted, 1, "how many times the tool ran");
+		}
+	},
+	{
+		name: "steps run side by side, one kept and one not when the run was cut off, each resume where they were",
+		async run(start) {
+			const wire = await start();
+			let ran = 0;
+			let read = () => {}, release = () => {};
+			const slowRead = new Promise((resolve) => {
+				read = resolve;
+			});
+			const slowGoesOn = new Promise((resolve) => {
+				release = resolve;
+			});
+			let cutting = true;
+			const agent = { async run(_input, context) {
+				const [fast, slow] = await Promise.all([context.step("fast", async () => {
+					ran += 1;
+					await slowRead;
+					await context.memory.set("counter", 1);
+					return "fast done";
+				}), context.step("slow", async () => {
+					const seen = await context.memory.get("counter");
+					read();
+					if (cutting) await slowGoesOn;
+					return seen;
+				})]);
+				return {
+					fast,
+					slow
+				};
+			} };
+			const cut = {
+				...wire,
+				call: async (id, call) => {
+					if (!cutting) throw new AgentError("unavailable", "lost");
+					const answer = await wire.call(id, call);
+					if (call.kind === "step" && call.name === "fast" && call.done) {
+						cutting = false;
+						release();
+					}
+					return answer;
+				},
+				finish: () => Promise.reject(new AgentError("unavailable", "lost"))
+			};
+			await execute(agent, cut).then(() => {
+				throw new Error("the cut-off run ended");
+			}, (error) => equal(error.code, "unavailable", "why it stopped"));
+			equal(await execute(agent, wire), {
+				status: "completed",
+				output: {
+					fast: "fast done",
+					slow: null
+				}
+			}, "the resumed run's end");
+			equal(ran, 1, "how many times the kept step's work ran");
+		}
+	},
+	{
+		name: "a tool the version does not allow is refused, and the run can go on",
+		async run(start) {
+			equal(await execute({
+				tools: {
+					greet: () => "hi",
+					wipe: () => "wiped"
+				},
+				async run(_input, context) {
+					return {
+						refused: await context.tool("wipe").then(() => "ran", (error) => error.code),
+						greet: await context.tool("greet")
+					};
+				}
+			}, await start()), {
+				status: "completed",
+				output: {
+					refused: "refused",
+					greet: "hi"
+				}
+			}, "the run's end");
+		}
+	},
+	{
+		name: "memory one run writes, the next run in the Environment reads",
+		async run(start) {
+			await execute({ async run(_input, context) {
+				await context.memory.set("seen", ["Ada"]);
+			} }, await start());
+			equal(await execute({ run: async (_input, context) => ({
+				seen: await context.memory.get("seen"),
+				none: await context.memory.get("nothing")
+			}) }, await start()), {
+				status: "completed",
+				output: {
+					seen: ["Ada"],
+					none: null
+				}
+			}, "the second run's end");
+		}
+	}
+];
+function equal(actual, expected, what) {
+	const a = JSON.stringify(actual), b = JSON.stringify(expected);
+	if (a !== b) throw new Error(`${what}: expected ${b}, got ${a}`);
+}
+//#endregion
+export { agentContract };

package/agents/index.d.mts

@@ -0,0 +1,128 @@
+//#region src/agents/index.d.ts
+/** What a run's code reaches through its `agent`. */
+interface AgentContext {
+  readonly runId: string;
+  /** The Agent's name. */
+  readonly agent: string;
+  readonly environment: string;
+  readonly version: number;
+  /** The version's instructions, for model questions. */
+  readonly instructions: string;
+  /** The run's Environment values, and a placeholder for each secret bound to hosts. */
+  readonly env: Readonly<Record<string, string>>;
+  /** The tools the version allows. */
+  readonly tools: ReadonlyArray<string>;
+  /** A line in the run's events. */
+  log(message: string, data?: unknown): Promise<void>;
+  /**
+   * Runs `work` and records its result; when the run resumes, a completed step returns its recorded
+   * result without running again. A step interrupted before its result is recorded can run again,
+   * so make outside writes idempotent with an identifier that stays the same across attempts.
+   */
+  step<T>(name: string, work: () => T | Promise<T>): Promise<T>;
+  /** Calls one of the Agent's tools, when the version allows it; refused otherwise. Recorded as a step is, so the same rule holds: an interrupted call can run again. */
+  tool(name: string, input?: unknown): Promise<unknown>;
+  /** The Environment's memory: kept between runs. */
+  readonly memory: {
+    get(key: string): Promise<unknown>;
+    set(key: string, value: unknown): Promise<void>;
+    delete(key: string): Promise<void>;
+  };
+  /** Keeps a file with the run, `text/plain` unless typed. */
+  artifact(name: string, content: string | Uint8Array, type?: string): Promise<void>;
+  /** Asks the model, with the version's instructions; what it costs counts toward the version's spend ceiling. */
+  ask(prompt: string): Promise<string>;
+}
+/** An Agent: its `run`, and the tools it may be allowed. */
+interface Agent<Input = any, Output = unknown> {
+  readonly tools?: Readonly<Record<string, (input: any, agent: AgentContext) => unknown>>;
+  run(input: Input, agent: AgentContext): Output | Promise<Output>;
+}
+/** One call a run's code makes, as its wire keeps it. */
+type AgentCall = {
+  readonly kind: "log";
+  readonly message: string;
+  readonly data?: unknown;
+} | {
+  readonly kind: "step";
+  readonly name: string;
+  readonly done?: boolean;
+  readonly value?: unknown;
+} | {
+  readonly kind: "tool";
+  readonly name: string;
+  readonly input?: unknown;
+  readonly done?: boolean;
+  readonly value?: unknown;
+} | {
+  readonly kind: "memory.get";
+  readonly key: string;
+} | {
+  readonly kind: "memory.set";
+  readonly key: string;
+  readonly value: unknown;
+} | {
+  readonly kind: "memory.delete";
+  readonly key: string;
+} | {
+  readonly kind: "artifact";
+  readonly name: string;
+  readonly type: string;
+  readonly data: string;
+} | {
+  readonly kind: "ask";
+  readonly prompt: string;
+};
+type RunStatus = "queued" | "running" | "completed" | "failed" | "cancelled";
+/** What a run is when it begins. */
+interface RunStart {
+  readonly runId: string;
+  readonly agent: string;
+  readonly environment: string;
+  readonly version: number;
+  readonly input: unknown;
+  readonly instructions: string;
+  readonly tools: ReadonlyArray<string>;
+  readonly status: RunStatus;
+  readonly output?: unknown;
+  readonly error?: string;
+}
+/**
+ * Where a run is kept. `call` keeps the call with id `id` and replies to it, or returns what it kept
+ * before; a step or tool asked without `done` returns `{ done: false }` until its value is kept,
+ * then `{ done: true, value }`. A call's id is its place among its scope's calls, from 0, after the
+ * ids of the steps it is in: the run's own calls are `0`, `1`, …, and step 3's work makes `3.0`,
+ * `3.1`, …, whatever runs beside it. It throws `AgentError`; `unavailable` means ask again later.
+ */
+interface RunWire {
+  begin(): Promise<RunStart>;
+  call(id: string, call: AgentCall): Promise<unknown>;
+  finish(end: {
+    readonly output: unknown;
+  } | {
+    readonly error: string;
+  }): Promise<unknown>;
+}
+type AgentErrorCode = "refused" | "ended" | "invalid" | "not-found" | "unavailable";
+declare class AgentError extends Error {
+  readonly code: AgentErrorCode;
+  constructor(code: AgentErrorCode, message: string);
+}
+/** How a run ended. */
+interface RunEnd {
+  readonly status: RunStatus;
+  readonly output?: unknown;
+  readonly error?: string;
+}
+/**
+ * Runs one Agent run to its end and returns how it ended. A run that already ended is not run
+ * again. When the wire itself fails, so the run can't be kept, it throws, and the run waits to be
+ * executed again.
+ */
+declare function execute(agent: Agent, wire: RunWire, env?: Readonly<Record<string, string>>): Promise<RunEnd>;
+/** The wire of a run on the platform, at `url` with the run's token. */
+declare function httpWire(url: string, token: string, fetcher?: typeof fetch): RunWire;
+/** Runs the run the environment names, as the platform's host does: `MIDSUMMER_AGENT_WIRE` and `MIDSUMMER_AGENT_TOKEN`; the rest is the run's `env`. */
+declare function executeFromEnvironment(agent: Agent, env: Readonly<Record<string, string | undefined>>): Promise<RunEnd>;
+//#endregion
+export { Agent, AgentCall, AgentContext, AgentError, AgentErrorCode, RunEnd, RunStart, RunStatus, RunWire, execute, executeFromEnvironment, httpWire };