[JET-2527] feature: Adapt breeze.js to zephyr (#9)

Author: vanppo

lib/runtime.ts

@@ -2,7 +2,7 @@ export const isDeno = typeof Deno !== "undefined";
 export const isBreezeRuntime = typeof BreezeRuntime !== "undefined";
 
 export function getEnv(key: string): string | undefined {
-  return _internals.doGetEnv(key);
+  return Deno.env.get(key);
 }
 
 export function getEnvOrThrow(key: string): string {
@@ -13,18 +13,14 @@ export function getEnvOrThrow(key: string): string {
   return value;
 }
 
-export function serveHttp(
+export function serve(
   handler: (req: Request) => Response | Promise<Response>,
 ) {
-  if (isBreezeRuntime) return BreezeRuntime.serveHttp(handler);
-  if (isDeno) return Deno.serve(handler);
-  throw new Error("Unknown runtime for serveHttp");
+  Deno.serve({ port: 0 }, handler);
 }
 
 function doGetEnv(key: string): string | undefined {
-  if (isBreezeRuntime) return BreezeRuntime.env.get(key);
-  if (isDeno) return Deno.env.get(key);
-  throw new Error("Unknown runtime for getEnv");
+  return Deno.env.get(key);
 }
 
 export const _internals = { doGetEnv };

mod.d.ts

@@ -1,96 +1,35 @@
 declare namespace BreezeRuntime {
-  export interface Env {
-    /**
-     * Retrieves the value of an environment variable.
-     * @param key The name of the environment variable.
-     * @returns The value of the environment variable, or undefined if it is not set.
-     *
-     * @example
-     * ```ts
-     * BreezeRuntime.env.get("foo");
-     * // Returns "bar" if the environment variable "foo" is set to "bar".
-     * ```
-     */
-    get(key: string): string | undefined;
-
-    /**
-     * Retrieves all environment variables.
-     * @returns A map of all environment variables.
-     *
-     * @example
-     * ```ts
-     * BreezeRuntime.env.toObject();
-     * // Returns { foo: "bar" } if the environment variable "foo" is set to "bar".
-     * ```
-     */
-    toObject(): Record<string, string | undefined>;
-
-    /**
-     * Checks whether an environment variable is set.
-     * @param key The name of the environment variable.
-     * @returns Whether the environment variable is set.
-     *
-     * @example
-     * ```ts
-     * BreezeRuntime.env.has("foo");
-     * // Returns true if the environment variable "foo" is set.
-     * ```
-     */
-    has(key: string): boolean;
+  export interface DeploymentInfo {
+    projectId: string;
+    environmentId: string;
+    functionId: string;
   }
 
   export interface Plugin {
-    /**
-     * Retrieves the plugin's endpoint.
-     *
-     * @example
-     *
-     * To retrieve the endpoint of the kv plugin:
-     * ```ts
-     * BreezeRuntime.plugins.kv.getEndpoint();
-     * // Returns new URL("breeze://kv.plugins")
-     * ```
-     *
-     * To retrieve the endpoint of the kv plugin under a subpath:
-     * ```ts
-     * BreezeRuntime.plugins.kv.getEndpoint("/put");
-     * // Returns new URL("breeze://kv.plugins/put")
-     * ```
-     */
-    getEndpoint(subpath?: string): Promise<URL>;
+    id: string;
+    endpoint: string;
   }
 
   /**
-   * The environment variables.
+   * An JWT token generated by Breeze to authorize plugin  or workflow requests.
    */
-  export const env: Env;
+  export type Token = string;
 
-  /**
-   * A map of all plugins.
-   */
-  export const plugins: Record<string, Plugin>;
+  export interface TokenOptions {
+    /**
+     * The instance name of plugin.
+     */
+    plugin?: string;
+  }
 
-  /**
-   * Provides an interface to handle HTTP request and responses over TCP connections.
-   * See detail at https://deno.land/api?s=Deno.serveHttp
-   * @example
-   * ```ts
-   * import { Hono } from "https://deno.land/x/hono@v3.4.1/mod.ts";
-   * const app = new Hono();
-   *
-   * app.get("/", (c) => c.text("Hello world!"));
-   * app.get("/greet/:name", (c) => {
-   *   const name = c.req.param("name");
-   *   return c.text(`Hi, ${name}`);
-   * });
-   * app.notFound((c) => {
-   *   return c.text("Not found", 404);
-   * });
-   *
-   * BreezeRuntime.serveHttp(app.fetch);
-   * ```
-   */
-  export function serveHttp(
-    handler: (req: Request) => Response | Promise<Response>,
-  ): void;
+  export function getDeploymentInfo(): DeploymentInfo;
+
+  export function getPlugin(plugin: string): Plugin | null;
+
+  export function generateToken(opts?: TokenOptions): Token;
+
+  export function pluginFetch(
+    plugin: string,
+    opts: RequestInit,
+  ): Promise<Response>;
 }

types_test.ts

@@ -5,55 +5,36 @@ import {
   IsNullable,
 } from "https://deno.land/std@0.212.0/testing/types.ts";
 
-// env
 {
-  // get
-  {
-    const value = BreezeRuntime.env.get("foo");
+  type Result = ReturnType<typeof BreezeRuntime.getDeploymentInfo>;
 
-    assertType<IsNullable<typeof value>>(true);
-    assertType<Has<typeof value, string>>(true);
-  }
-
-  // toObject
-  {
-    const values = BreezeRuntime.env.toObject();
-
-    assertType<IsExact<typeof values, Record<string, string | undefined>>>(
-      true,
-    );
-  }
-
-  // has
-  {
-    const value = BreezeRuntime.env.has("foo");
-
-    assertType<IsExact<typeof value, boolean>>(true);
-  }
+  assertType<IsExact<Result, BreezeRuntime.DeploymentInfo>>(true);
 }
 
-// plugins
 {
-  // get a plugin
-  {
-    const plugin = BreezeRuntime.plugins.kv;
+  type Name = Parameters<typeof BreezeRuntime.getPlugin>[0];
+  type Result = ReturnType<typeof BreezeRuntime.getPlugin>;
 
-    assertType<IsExact<typeof plugin, BreezeRuntime.Plugin>>(true);
-  }
+  assertType<IsExact<Name, string>>(true);
+  assertType<Has<Result, BreezeRuntime.Plugin>>(true);
+  assertType<IsNullable<Result>>(true);
+}
 
-  // getEndpoint
-  {
-    const result = BreezeRuntime.plugins.kv.getEndpoint();
+{
+  type Options = Parameters<typeof BreezeRuntime.generateToken>[0];
+  type Result = ReturnType<typeof BreezeRuntime.generateToken>;
 
-    assertType<IsExact<typeof result, Promise<URL>>>(true);
-  }
+  assertType<Has<Options, BreezeRuntime.TokenOptions>>(true);
+  assertType<IsNullable<Options>>(true);
+  assertType<IsExact<Result, string>>(true);
 }
 
-// serveHttp
 {
-  type Params = Parameters<typeof BreezeRuntime.serveHttp>[0];
+  type Name = Parameters<typeof BreezeRuntime.pluginFetch>[0];
+  type Options = Parameters<typeof BreezeRuntime.pluginFetch>[1];
+  type Result = ReturnType<typeof BreezeRuntime.pluginFetch>;
 
-  assertType<
-    IsExact<Params, (req: Request) => Response | Promise<Response>>
-  >(true);
+  assertType<IsExact<Name, string>>(true);
+  assertType<Has<Options, RequestInit>>(true);
+  assertType<IsExact<Result, Promise<Response>>>(true);
 }