@squadbase/vite-server 0.1.12-dev.a9ac647 → 0.1.17-dev.3b633bb

package/dist/connectors/zendesk-oauth.js

@@ -65,6 +65,28 @@ var ConnectorPlugin = class _ConnectorPlugin {
   tools;
   query;
   checkConnection;
+  /**
+   * SQPD-1212: Logic-based, rule-driven connection setup. Connectors that
+   * implement this expose a step-by-step exploration flow (database/schema/
+   * table/etc. discovery) that the dashboard backend drives via the
+   * `/connections/:connectionId/setup` endpoint. Implement by delegating to
+   * `runSetupFlow` from `setup-flow.ts`.
+   */
+  setup;
+  /**
+   * Opt-out of the default "verify before save" behavior on connection
+   * creation. The backend invokes `checkConnection` synchronously while
+   * creating the connection and aborts (no row inserted) if it fails — this
+   * flag disables that for connectors where the check cannot succeed pre-save:
+   *
+   *   - `squadbase-db` populates `connection-url` only after Neon provisioning
+   *   - OAuth connectors require an OAuth-aware proxyFetch keyed by the
+   *     connectionId, which doesn't exist until the row is saved
+   *
+   * Exceptions are the explicit position; new credential-input connectors get
+   * the default verify-on-create behavior without opt-in.
+   */
+  skipConnectionCheckOnCreate;
   constructor(config) {
     this.slug = config.slug;
     this.authType = config.authType;
@@ -81,6 +103,8 @@ var ConnectorPlugin = class _ConnectorPlugin {
     this.tools = config.tools;
     this.query = config.query;
     this.checkConnection = config.checkConnection;
+    this.setup = config.setup;
+    this.skipConnectionCheckOnCreate = config.skipConnectionCheckOnCreate;
   }
   get connectorKey() {
     return _ConnectorPlugin.deriveKey(this.slug, this.authType);
@@ -145,6 +169,76 @@ var ConnectorPlugin = class _ConnectorPlugin {
   }
 };
 
+// ../connectors/src/setup-flow.ts
+async function runSetupFlow(flow, params, ctx, config) {
+  const runtime = {
+    params,
+    language: ctx.language,
+    config
+  };
+  let state = flow.initialState();
+  let answerIdx = 0;
+  const pendingParameterUpdates = [];
+  for (const step of flow.steps) {
+    const ans = ctx.answers[answerIdx];
+    if (ans && ans.questionSlug === step.slug) {
+      state = step.applyAnswer(state, ans.answer);
+      if (step.toParameterUpdates) {
+        pendingParameterUpdates.push(...step.toParameterUpdates(state));
+      }
+      answerIdx += 1;
+      continue;
+    }
+    const resolvedAllowFreeText = step.allowFreeText !== void 0 ? step.allowFreeText : true;
+    if (step.type === "text") {
+      if (step.fetchOptions) {
+        const options2 = await step.fetchOptions(state, runtime);
+        if (options2.length === 0) {
+          continue;
+        }
+      }
+      return {
+        type: "nextQuestion",
+        questionSlug: step.slug,
+        question: step.question[ctx.language],
+        questionType: "text",
+        allowFreeText: resolvedAllowFreeText,
+        ...pendingParameterUpdates.length > 0 && {
+          parameterUpdates: pendingParameterUpdates
+        }
+      };
+    }
+    const options = step.fetchOptions ? await step.fetchOptions(state, runtime) : [];
+    if (options.length === 0) {
+      continue;
+    }
+    return {
+      type: "nextQuestion",
+      questionSlug: step.slug,
+      question: step.question[ctx.language],
+      questionType: step.type,
+      options,
+      allowFreeText: resolvedAllowFreeText,
+      ...pendingParameterUpdates.length > 0 && {
+        parameterUpdates: pendingParameterUpdates
+      }
+    };
+  }
+  const dataInvestigationResult = await flow.finalize(state, runtime);
+  return {
+    type: "fulfilled",
+    dataInvestigationResult,
+    ...pendingParameterUpdates.length > 0 && {
+      parameterUpdates: pendingParameterUpdates
+    }
+  };
+}
+async function resolveSetupSelection(params) {
+  const { selected, allSentinel, fetchAll, limit } = params;
+  const resolved = selected.includes(allSentinel) ? await fetchAll() : selected.filter((v) => v !== allSentinel);
+  return resolved.slice(0, limit);
+}
+
 // ../connectors/src/auth-types.ts
 var AUTH_TYPES = {
   OAUTH: "oauth",
@@ -309,6 +403,124 @@ var zendeskOauthOnboarding = new ConnectorOnboarding({
   }
 });
 
+// ../connectors/src/connectors/zendesk-oauth/utils.ts
+function apiFetch(proxyFetch, path2, init) {
+  const url = path2.startsWith("/") ? path2 : `/${path2}`;
+  const headers = new Headers(init?.headers);
+  headers.set("Accept", "application/json");
+  return proxyFetch(url, { ...init, headers });
+}
+
+// ../connectors/src/connectors/zendesk-oauth/setup-flow.ts
+var ZENDESK_SETUP_MAX_ENTITIES = 5;
+var ZENDESK_ENTITIES = [
+  {
+    value: "tickets",
+    label: "Tickets",
+    countPath: "/api/v2/tickets.json?page[size]=1"
+  },
+  {
+    value: "users",
+    label: "Users",
+    countPath: "/api/v2/users.json?page[size]=1"
+  },
+  {
+    value: "organizations",
+    label: "Organizations",
+    countPath: "/api/v2/organizations.json?page[size]=1"
+  },
+  {
+    value: "groups",
+    label: "Groups",
+    countPath: "/api/v2/groups.json?page[size]=1"
+  },
+  {
+    value: "articles",
+    label: "Help Center articles",
+    countPath: "/api/v2/help_center/articles.json?page[size]=1"
+  }
+];
+async function listBrands(proxyFetch) {
+  const res = await apiFetch(proxyFetch, "/api/v2/brands.json");
+  if (!res.ok) return [];
+  const data = await res.json();
+  return data.brands ?? [];
+}
+async function fetchCount(proxyFetch, path2) {
+  const res = await apiFetch(proxyFetch, path2);
+  if (!res.ok) return null;
+  const data = await res.json();
+  if (typeof data["count"] === "number") return data["count"];
+  return null;
+}
+var zendeskOauthSetupFlow = {
+  initialState: () => ({}),
+  steps: [
+    {
+      slug: "brand",
+      type: "select",
+      question: {
+        ja: "\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u3067\u5BFE\u8C61\u3068\u3059\u308BZendesk\u30D6\u30E9\u30F3\u30C9\u3092\u9078\u3093\u3067\u304F\u3060\u3055\u3044",
+        en: "Select the Zendesk brand to use for setup"
+      },
+      async fetchOptions(_state, rt) {
+        const brands = await listBrands(rt.config.proxyFetch);
+        const active = brands.filter((b) => b.active !== false && b.name);
+        if (active.length < 2) return [];
+        return active.map((b) => ({
+          value: String(b.subdomain ?? b.id ?? b.name),
+          label: String(b.name)
+        }));
+      },
+      applyAnswer: (state, answer) => ({ ...state, brand: answer[0] })
+    },
+    {
+      slug: "entities",
+      type: "multiSelect",
+      question: {
+        ja: "\u30BB\u30C3\u30C8\u30A2\u30C3\u30D7\u3067\u6982\u89B3\u3057\u305F\u3044\u30A8\u30F3\u30C6\u30A3\u30C6\u30A3\u3092\u9078\u3093\u3067\u304F\u3060\u3055\u3044\uFF08\u8907\u6570\u9078\u629E\u53EF\uFF09",
+        en: "Select the entities to include in setup (multi-select allowed)"
+      },
+      async fetchOptions(_state, _rt) {
+        return ZENDESK_ENTITIES.map((e) => ({ value: e.value, label: e.label }));
+      },
+      applyAnswer: (state, answer) => ({ ...state, entities: answer })
+    }
+  ],
+  async finalize(state, rt) {
+    if (!state.entities) {
+      throw new Error("Zendesk setup: incomplete state on finalize");
+    }
+    const targetEntities = await resolveSetupSelection({
+      selected: state.entities,
+      allSentinel: "__ALL__",
+      fetchAll: async () => ZENDESK_ENTITIES.map((e) => e.value),
+      limit: ZENDESK_SETUP_MAX_ENTITIES
+    });
+    const entityByValue = new Map(ZENDESK_ENTITIES.map((e) => [e.value, e]));
+    const sections = ["## Zendesk", ""];
+    if (state.brand) {
+      sections.push(`### Brand: ${state.brand}`, "");
+    }
+    sections.push("### Selected entities", "");
+    sections.push("| Entity | Count |");
+    sections.push("|--------|-------|");
+    for (const value of targetEntities) {
+      const entity = entityByValue.get(value);
+      if (!entity) {
+        sections.push(`| ${value} | _unknown_ |`);
+        continue;
+      }
+      const count = await fetchCount(rt.config.proxyFetch, entity.countPath);
+      sections.push(
+        `| ${entity.label} (${entity.value}) | ${count == null ? "-" : count} |`
+      );
+    }
+    sections.push("");
+    return sections.join("\n");
+  }
+};
+
 // ../connectors/src/connectors/zendesk-oauth/parameters.ts
 var parameters = {};
 
@@ -317,6 +529,7 @@ var tools = { request: requestTool };
 var zendeskOauthConnector = new ConnectorPlugin({
   slug: "zendesk",
   authType: AUTH_TYPES.OAUTH,
+  skipConnectionCheckOnCreate: true,
   name: "Zendesk",
   description: "Connect to Zendesk Support for tickets, users, organizations, and customer service data using OAuth.",
   iconUrl: "https://images.ctfassets.net/9ncizv60xc5y/7e9Q7PwV6MJRJMj543m2gl/55385fae903ccfa1599e35be9d3516aa/zendesk-icon.svg",
@@ -451,6 +664,7 @@ const data = await res.json();
 \`\`\``
   },
   tools,
+  setup: (params, ctx, config) => runSetupFlow(zendeskOauthSetupFlow, params, ctx, config),
   async checkConnection(_params, config) {
     const { proxyFetch } = config;
     try {
@@ -500,6 +714,7 @@ function resolveEnvVarOptional(entry, key) {
 import { getContext } from "hono/context-storage";
 import { getCookie } from "hono/cookie";
 var APP_SESSION_COOKIE_NAME = "__Host-squadbase-session";
+var TABLEAU_SESSION_SENTINEL_URL = "squadbase://tableau-session/";
 function normalizeHeaders(input) {
   const out = {};
   if (!input) return out;
@@ -508,6 +723,11 @@ function normalizeHeaders(input) {
   });
   return out;
 }
+function extractInputUrl(input) {
+  if (typeof input === "string") return input;
+  if (input instanceof URL) return input.href;
+  return input.url;
+}
 function createSandboxProxyFetch(connectionId) {
   return async (input, init) => {
     const token = process.env.INTERNAL_SQUADBASE_OAUTH_MACHINE_CREDENTIAL;
@@ -517,10 +737,17 @@ function createSandboxProxyFetch(connectionId) {
         "Connection proxy is not configured. Please check your deployment settings."
       );
     }
-    const originalUrl = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
+    const originalUrl = extractInputUrl(input);
+    const baseDomain = process.env["SQUADBASE_PREVIEW_BASE_DOMAIN"] ?? "preview.app.squadbase.dev";
+    if (originalUrl === TABLEAU_SESSION_SENTINEL_URL) {
+      const sessionUrl = `https://${sandboxId}.${baseDomain}/_sqcore/connections/${connectionId}/tableau-session`;
+      return fetch(sessionUrl, {
+        method: "POST",
+        headers: { Authorization: `Bearer ${token}` }
+      });
+    }
     const originalMethod = init?.method ?? "GET";
     const originalBody = init?.body ? JSON.parse(init.body) : void 0;
-    const baseDomain = process.env["SQUADBASE_PREVIEW_BASE_DOMAIN"] ?? "preview.app.squadbase.dev";
     const proxyUrl = `https://${sandboxId}.${baseDomain}/_sqcore/connections/${connectionId}/request`;
     return fetch(proxyUrl, {
       method: "POST",
@@ -546,10 +773,9 @@ function createDeployedAppProxyFetch(connectionId) {
   }
   const baseDomain = process.env["SQUADBASE_APP_BASE_DOMAIN"] ?? "squadbase.app";
   const proxyUrl = `https://${projectId}.${baseDomain}/_sqcore/connections/${connectionId}/request`;
+  const sessionUrl = `https://${projectId}.${baseDomain}/_sqcore/connections/${connectionId}/tableau-session`;
   return async (input, init) => {
-    const originalUrl = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
-    const originalMethod = init?.method ?? "GET";
-    const originalBody = init?.body ? JSON.parse(init.body) : void 0;
+    const originalUrl = extractInputUrl(input);
     const c = getContext();
     const appSession = getCookie(c, APP_SESSION_COOKIE_NAME);
     if (!appSession) {
@@ -557,6 +783,14 @@ function createDeployedAppProxyFetch(connectionId) {
         "No authentication method available for connection proxy."
       );
     }
+    if (originalUrl === TABLEAU_SESSION_SENTINEL_URL) {
+      return fetch(sessionUrl, {
+        method: "POST",
+        headers: { Authorization: `Bearer ${appSession}` }
+      });
+    }
+    const originalMethod = init?.method ?? "GET";
+    const originalBody = init?.body ? JSON.parse(init.body) : void 0;
     return fetch(proxyUrl, {
       method: "POST",
       headers: {