chore: publish to jsr (#12)

Author: fahchen

.github/workflows/ci.yml

@@ -14,29 +14,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        deno: ["canary", "v1.x"]
+        deno: ["canary", "v2.x"]
 
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - name: Setup Deno
-        uses: denoland/setup-deno@v1
+        uses: denoland/setup-deno@v2
         with:
           deno-version: ${{ matrix.deno }}
 
-      - name: Verify formatting
-        run: deno fmt --check
-
-      - name: Run linter
-        run: deno lint
-
       - name: Spell-check
-        if: matrix.deno == 'v1.x'
+        if: matrix.deno == 'v2.x'
         uses: crate-ci/typos@master
 
-      - name: Type check project
-        run: deno task check:types
-
-      - name: Run tests
-        run: deno task test
+      - run: deno fmt
+      - run: deno lint
+      - run: deno task check:types
+      - run: deno task test

.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - run: npx jsr publish

README.md

@@ -1,17 +1,3 @@
 # TypeScript type definitions for BreezeRuntime
 
-## Usage
-
-Add types into your deno config file(eg: `deno.jsonc`):
-
-```jsonc
-{
-  "$schema": "https://deno.land/x/deno/cli/schemas/config-file.v1.json",
-  "compilerOptions": {
-    "types": [
-      // add types of BreezeRuntime
-      "https://cdn.jsdelivr.net/gh/Byzanteam/breeze-js@latest/mod.d.ts"
-    ]
-  }
-}
-```
+[![JSR](https://jsr.io/badges/@byzanteam/breeze-js)](https://jsr.io/@byzanteam/breeze-js)

deno.jsonc

@@ -1,19 +1,33 @@
 {
-  "$schema": "https://deno.land/x/deno/cli/schemas/config-file.v1.json",
+  "$schema": "https://jsr.io/schema/config-file.v1.json",
+  "name": "@byzanteam/breeze-js",
+  "version": "0.1.0",
   "compilerOptions": {
     "strict": true,
     "useUnknownInCatchVariables": true,
     "noImplicitOverride": true,
     "types": [
-      "./mod.d.ts"
+      "./types/global.d.ts"
     ]
   },
   "exclude": [
     ".git"
   ],
+  "exports": {
+    ".": "./lib/runtime.ts",
+    "./runtime": "./lib/runtime.ts",
+    "./url": "./lib/url.ts",
+    "./types": "./types/global.d.ts"
+  },
+  "license": "MIT",
+  "publish": {
+    "exclude": [
+      ".github"
+    ]
+  },
   "tasks": {
-    "test": "deno check types_test.ts",
-    "check:types": "deno check **/*.ts",
-    "check": "deno fmt --check && deno lint && deno task check:types && deno task test"
+    "check": "deno fmt && deno lint && deno task check:types && deno task test",
+    "check:types": "deno check lib/**/*.ts && deno check types/global_test.ts",
+    "test": "deno test -A"
   }
 }

dev_deps.ts

@@ -1,3 +1,4 @@
-export * from "https://deno.land/std@0.218.0/testing/bdd.ts";
-export * from "https://deno.land/std@0.218.0/assert/mod.ts";
-export * from "https://deno.land/std@0.208.0/testing/mock.ts";
+export * from "jsr:@std/assert";
+export * from "jsr:@std/testing/bdd";
+export * from "jsr:@std/testing/mock";
+export * from "jsr:@std/testing/types";

lib/runtime.ts

@@ -1,8 +1,5 @@
-export const isDeno = typeof Deno !== "undefined";
-export const isBreezeRuntime = typeof BreezeRuntime !== "undefined";
-
 export function getEnv(key: string): string | undefined {
-  return Deno.env.get(key);
+  return _internals.doGetEnv(key);
 }
 
 export function getEnvOrThrow(key: string): string {

mod.d.ts

@@ -1,5 +1,5 @@
 import { getEnv, getEnvOrThrow } from "../lib/runtime.ts";
-import { assertEquals, assertRejects, describe, it } from "../dev_deps.ts";
+import { assertEquals, assertThrows, describe, it } from "../dev_deps.ts";
 
 describe("Runtime Module", () => {
   it("getEnv should return the value of an environment variable", () => {
@@ -10,10 +10,8 @@ describe("Runtime Module", () => {
   it("getEnvOrThrow should throw if the environment variable is not set", () => {
     const key = "NON_EXISTENT_VAR";
 
-    assertRejects(
-      async () => {
-        await getEnvOrThrow(key);
-      },
+    assertThrows(
+      () => getEnvOrThrow(key),
       Error,
       `Missing environment variable: ${key}`,
     );

tests/runtime_test.ts

@@ -1,4 +1,4 @@
-import { afterEach, beforeEach, Stub, stub } from "../dev_deps.ts";
+import { afterEach, beforeEach, type Stub, stub } from "../dev_deps.ts";
 import { _internals } from "../lib/runtime.ts";
 
 let envs: {
@@ -26,5 +26,6 @@ export function setupEnv() {
   function setEnv(key: string, value: string) {
     envs.push({ key, value });
   }
+
   return { setEnv };
 }

tests/testing_util.ts

@@ -0,0 +1,86 @@
+declare namespace BreezeRuntime {
+  export interface DeploymentInfo {
+    projectId: string;
+    environmentId: string;
+    functionId: string;
+  }
+
+  export interface Plugin {
+    id: string;
+    endpoint: string;
+  }
+
+  /**
+   * A JWT token generated by Breeze to authorize plugin  or workflow requests.
+   */
+  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;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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 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 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.
+   */
+  export function pluginFetch(
+    plugin: string,
+    path: string,
+    opts: RequestInit,
+  ): Promise<Response>;
+}