refactor: declare BreezeRuntime by global augmentation (#13)

Author: vanppo

.github/workflows/publish.yml

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@byzanteam/breeze-js",
-  "version": "0.4.0",
+  "version": "0.5.0",
+  "license": "MIT",
   "compilerOptions": {
     "strict": true,
     "useUnknownInCatchVariables": true,
@@ -11,19 +11,25 @@
     ]
   },
   "exclude": [
-    ".git"
+    ".git",
+    ".github"
   ],
   "exports": {
     ".": "./lib/runtime.ts",
     "./runtime": "./lib/runtime.ts",
     "./url": "./lib/url.ts",
     "./types": "./types/global.d.ts"
   },
-  "license": "MIT",
-  "publish": {
-    "exclude": [
-      ".github"
-    ]
+  "imports": {
+    "@std/assert": "jsr:@std/assert@^1.0.13",
+    "@std/testing": "jsr:@std/testing@^1.0.13"
+  },
+  "lint": {
+    "rules": {
+      "exclude": [
+        "no-slow-types"
+      ]
+    }
   },
   "tasks": {
     "check": "deno fmt && deno lint && deno task check:types && deno task test",

deno.jsonc

@@ -1,5 +1,6 @@
-import { getEnv, getEnvOrThrow } from "../lib/runtime.ts";
-import { assertEquals, assertThrows, describe, it } from "../dev_deps.ts";
+import { assertEquals, assertThrows } from "@std/assert";
+import { describe, it } from "@std/testing/bdd";
+import { getEnv, getEnvOrThrow } from "./runtime.ts";
 
 describe("Runtime Module", () => {
   it("getEnv should return the value of an environment variable", () => {

dev_deps.ts

@@ -1,6 +1,7 @@
-import { buildUrl, getBaseUrl, joinPath } from "../lib/url.ts";
-import { assertEquals, describe, it } from "../dev_deps.ts";
-import { setupEnv } from "./testing_util.ts";
+import { assertEquals } from "@std/assert";
+import { describe, it } from "@std/testing/bdd";
+import { buildUrl, getBaseUrl, joinPath } from "./url.ts";
+import { setupEnv } from "../tests/env.ts";
 
 describe("buildUrl function", () => {
   const { setEnv } = setupEnv();

tests/runtime_test.ts lib/runtime.test.tstests/runtime_test.ts renamed to lib/runtime.test.ts

@@ -1,4 +1,5 @@
-import { afterEach, beforeEach, type Stub, stub } from "../dev_deps.ts";
+import { afterEach, beforeEach } from "@std/testing/bdd";
+import { type Stub, stub } from "@std/testing/mock";
 import { _internals } from "../lib/runtime.ts";
 
 let envs: {

tests/url_test.ts lib/url.test.tstests/url_test.ts renamed to lib/url.test.ts

@@ -1,86 +1,88 @@
-declare namespace BreezeRuntime {
-  export interface DeploymentInfo {
-    projectId: string;
-    environmentId: string;
-    functionId: string;
-  }
-
-  export interface Plugin {
-    id: string;
-    endpoint: string;
-  }
+declare global {
+  namespace BreezeRuntime {
+    export interface DeploymentInfo {
+      projectId: string;
+      environmentId: string;
+      functionId: string;
+    }
 
-  /**
-   * A JWT token generated by Breeze to authorize plugin  or workflow requests.
-   */
-  export type Token = string;
+    export interface Plugin {
+      id: string;
+      endpoint: string;
+    }
 
-  export interface TokenOptions {
     /**
-     * The instance name of plugin.
+     * A JWT token generated by Breeze to authorize plugin  or workflow requests.
      */
-    plugin?: string;
+    export type Token = string;
+
+    export interface TokenOptions {
+      /**
+       * The instance name of plugin.
+       */
+      plugin?: string;
+    }
   }
 
-  /**
-   * Retrieves the current deployment information.
-   * @returns The deployment information of the current function.
-   */
-  export function getDeploymentInfo(): DeploymentInfo;
+  interface BreezeRuntime {
+    /**
+     * Generates an authentication token for a plugin or workflow request.
+     * @param opts - Optional settings for the token generation.
+     * @returns A JWT token.
+     */
+    generateToken(opts?: BreezeRuntime.TokenOptions): BreezeRuntime.Token;
 
-  /**
-   * Retrieves a registered plugin by its name.
-   * @param plugin - The name of the plugin.
-   * @returns The plugin instance if found, otherwise `null`.
-   */
-  export function getPlugin(plugin: string): Plugin | null;
+    /**
+     * Retrieves the current deployment information.
+     * @returns The deployment information of the current function.
+     */
+    getDeploymentInfo(): BreezeRuntime.DeploymentInfo;
 
-  /**
-   * Generates an authentication token for a plugin or workflow request.
-   * @param opts - Optional settings for the token generation.
-   * @returns A JWT token.
-   */
-  export function generateToken(opts?: TokenOptions): Token;
+    /**
+     * Retrieves a registered plugin by its name.
+     * @param plugin - The name of the plugin.
+     * @returns The plugin instance if found, otherwise `null`.
+     */
+    getPlugin(plugin: string): BreezeRuntime.Plugin | null;
 
-  /**
-   * Performs a fetch request to the specified plugin.
-   * @param plugin - The name of the plugin.
-   * @returns A `Promise` resolving to the response.
-   */
-  export function pluginFetch(plugin: string): Promise<Response>;
+    /**
+     * Performs a fetch request to the specified plugin.
+     * @param plugin - The name of the plugin.
+     * @returns A `Promise` resolving to the response.
+     */
+    pluginFetch(plugin: string): Promise<Response>;
 
-  /**
-   * Performs a fetch request to a specific path on the specified plugin.
-   * @param plugin - The name of the plugin.
-   * @param path - The request path.
-   * @returns A `Promise` resolving to the response.
-   */
-  export function pluginFetch(
-    plugin: string,
-    path: string,
-  ): Promise<Response>;
+    /**
+     * Performs a fetch request to a specific path on the specified plugin.
+     * @param plugin - The name of the plugin.
+     * @param path - The request path.
+     * @returns A `Promise` resolving to the response.
+     */
+    pluginFetch(plugin: string, path: string): Promise<Response>;
+
+    /**
+     * Performs a fetch request to a plugin with custom request options.
+     * @param plugin - The name of the plugin.
+     * @param opts - The fetch request options.
+     * @returns A `Promise` resolving to the response.
+     */
+    pluginFetch(plugin: string, opts: RequestInit): Promise<Response>;
 
-  /**
-   * Performs a fetch request to a plugin with custom request options.
-   * @param plugin - The name of the plugin.
-   * @param opts - The fetch request options.
-   * @returns A `Promise` resolving to the response.
-   */
-  export function pluginFetch(
-    plugin: string,
-    opts: RequestInit,
-  ): Promise<Response>;
+    /**
+     * Performs a fetch request to a specific path on a plugin with custom request options.
+     * @param plugin - The name of the plugin.
+     * @param path - The request path.
+     * @param opts - The fetch request options.
+     * @returns A `Promise` resolving to the response.
+     */
+    pluginFetch(
+      plugin: string,
+      path: string,
+      opts: RequestInit,
+    ): Promise<Response>;
+  }
 
-  /**
-   * Performs a fetch request to a specific path on a plugin with custom request options.
-   * @param plugin - The name of the plugin.
-   * @param path - The request path.
-   * @param opts - The fetch request options.
-   * @returns A `Promise` resolving to the response.
-   */
-  export function pluginFetch(
-    plugin: string,
-    path: string,
-    opts: RequestInit,
-  ): Promise<Response>;
+  const BreezeRuntime: BreezeRuntime;
 }
+
+export {};

tests/testing_util.ts tests/env.tstests/testing_util.ts renamed to tests/env.ts

@@ -3,7 +3,7 @@ import {
   type Has,
   type IsExact,
   type IsNullable,
-} from "../dev_deps.ts";
+} from "@std/testing/types";
 
 {
   type Result = ReturnType<typeof BreezeRuntime.getDeploymentInfo>;