@gitterm/sdk 0.6.0 → 0.6.1

package/README.md

@@ -118,12 +118,14 @@ without a GitTerm server, is described at the [end](#direct-provider-mode).
 `createGittermClient()` resolves its server and token in this order: constructor options →
 `GITTERM_SERVER_URL` / `GITTERM_API_TOKEN` → the CLI config at `~/.config/gitterm/cli.json`
 written by `gitterm login`. The default server is the hosted API at `https://api.gitterm.dev`;
-self-hosted instances use the same SDK with their own `serverUrl`:
+self-hosted instances use the same SDK with their own `serverUrl`. Behind the bundled
+path-routing proxy, point it at the `/api` path (for example
+`GITTERM_SERVER_URL=https://<host>/api`); a server reached directly uses its origin:
 
 ```ts
 const hosted = createGittermClient({ token: process.env.GITTERM_API_TOKEN });
 const selfHosted = createGittermClient({
-  serverUrl: "https://gitterm.example.com", // or http://localhost:3000
+  serverUrl: "https://gitterm.example.com/api", // or http://localhost:3000
   token: process.env.GITTERM_API_TOKEN,
 });
 const fromCli = createGittermClient(); // env vars, then the CLI's saved login

package/dist/index.js

@@ -112,6 +112,23 @@ function normalizeServerUrl(value) {
   url.search = "";
   return url.toString().replace(/\/$/, "");
 }
+function withPath(serverUrl, pathname) {
+  const url = new URL(serverUrl);
+  url.pathname = pathname;
+  return url.toString();
+}
+function basePath(serverUrl) {
+  return new URL(serverUrl).pathname.replace(/\/+$/, "");
+}
+function trpcEndpoint(serverUrl) {
+  const base = basePath(serverUrl);
+  return withPath(serverUrl, base.endsWith("/trpc") ? base : `${base}/trpc`);
+}
+function apiEndpoint(serverUrl, route) {
+  const base = basePath(serverUrl);
+  const apiBase = base.endsWith("/api") ? base : `${base}/api`;
+  return withPath(serverUrl, `${apiBase}/${route.replace(/^\/+/, "")}`);
+}
 function createNoRedirectFetch(fetchImpl = fetch) {
   return async (input, init) => {
     const response = await fetchImpl(input, { ...init, redirect: "manual" });
@@ -286,9 +303,6 @@ function resolveCredentials(options) {
   }
   return { serverUrl: normalizeServerUrl(serverUrl), token };
 }
-function toTrpcUrl(serverUrl) {
-  return new URL("/trpc", serverUrl).toString();
-}
 function toIso(value) {
   if (!value)
     return null;
@@ -492,14 +506,14 @@ function createGittermClient(options = {}) {
       splitLink({
         condition: (operation) => operation.type === "subscription",
         true: httpSubscriptionLink({
-          url: toTrpcUrl(credentials.serverUrl),
+          url: trpcEndpoint(credentials.serverUrl),
           EventSource,
           eventSourceOptions: {
             fetch: (url, init) => fetchImpl(url, { ...init, headers: { ...init.headers, authorization } })
           }
         }),
         false: httpBatchLink({
-          url: toTrpcUrl(credentials.serverUrl),
+          url: trpcEndpoint(credentials.serverUrl),
           fetch: fetchImpl,
           headers: () => ({ authorization })
         })
@@ -747,7 +761,7 @@ function sleep2(ms) {
 async function loginWithDeviceCode(serverUrl, options = {}) {
   const normalizedServerUrl = normalizeServerUrl(serverUrl);
   const fetchImpl = createNoRedirectFetch(options.fetch);
-  const codeRes = await fetchImpl(new URL("/api/device/code", normalizedServerUrl), {
+  const codeRes = await fetchImpl(apiEndpoint(normalizedServerUrl, "device/code"), {
     method: "POST",
     headers: { "content-type": "application/json" },
     body: JSON.stringify({ clientName: options.clientName ?? "gitterm" })
@@ -763,7 +777,7 @@ async function loginWithDeviceCode(serverUrl, options = {}) {
   });
   const deadline = Date.now() + codeJson.expiresInSeconds * 1000;
   while (Date.now() < deadline) {
-    const tokenRes = await fetchImpl(new URL("/api/device/token", normalizedServerUrl), {
+    const tokenRes = await fetchImpl(apiEndpoint(normalizedServerUrl, "device/token"), {
       method: "POST",
       headers: { "content-type": "application/json" },
       body: JSON.stringify({ deviceCode: codeJson.deviceCode })
@@ -802,10 +816,6 @@ function errorCode(code) {
     return code;
   return "SERVER_ERROR";
 }
-function toWorkspaceTrpcUrl(serverUrl) {
-  const url = new URL(serverUrl);
-  return url.pathname.endsWith("/trpc") ? serverUrl : new URL("/trpc", url).toString();
-}
 function createGittermWorkspaceClient(options = {}) {
   const detected = options.serverUrl && options.token && options.workspaceId ? null : getWorkspaceEnvironment();
   const rawServerUrl = options.serverUrl ?? detected?.serverUrl;
@@ -818,7 +828,7 @@ function createGittermWorkspaceClient(options = {}) {
   const trpc = createTRPCClient2({
     links: [
       httpBatchLink2({
-        url: toWorkspaceTrpcUrl(serverUrl),
+        url: trpcEndpoint(serverUrl),
         fetch: createNoRedirectFetch(options.fetch),
         headers: () => ({ authorization: `Bearer ${token}` })
       })

package/dist/transport.d.ts

@@ -1,2 +1,9 @@
 export declare function normalizeServerUrl(value: string): string;
+/**
+ * Resolve the tRPC endpoint relative to the server URL's path, so a base like
+ * `https://host/api` (path-routing proxy) maps to `https://host/api/trpc`.
+ */
+export declare function trpcEndpoint(serverUrl: string): string;
+/** Resolve a server `/api/*` route, adding `/api` only when the base doesn't already end in it. */
+export declare function apiEndpoint(serverUrl: string, route: string): string;
 export declare function createNoRedirectFetch(fetchImpl?: typeof fetch): typeof fetch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitterm/sdk",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "files": [
     "dist"
   ],