openship 0.1.0 → 0.1.1

package/apps/dashboard/src/lib/api/client.ts

@@ -0,0 +1,199 @@
+/**
+ * Standard API client for the Openship dashboard.
+ *
+ * Use this for all non-auth API calls (projects, deployments, domains, etc.).
+ * Auth calls should go through `auth-client.ts` (Better Auth SDK).
+ *
+ * Features:
+ *   - Automatic base URL resolution (`NEXT_PUBLIC_API_URL`)
+ *   - 15s request timeout (configurable per-call)
+ *   - Credentials included by default (cookies forwarded cross-origin)
+ *   - Typed JSON responses via generics
+ *   - Consistent error shape (`ApiError`)
+ */
+
+const BASE_URL = process.env.NEXT_PUBLIC_API_URL ?? "http://localhost:4000/api";
+const DEFAULT_TIMEOUT = 15_000;
+
+/* Ensure the base always ends with a slash for correct URL resolution */
+const RESOLVED_BASE = BASE_URL.endsWith("/") ? BASE_URL : BASE_URL + "/";
+
+/** Public accessor for building full URLs (e.g. SSE endpoints). */
+export function getApiBaseUrl(): string {
+  return RESOLVED_BASE;
+}
+
+/* ------------------------------------------------------------------ */
+/*  Global network-error hook                                         */
+/* ------------------------------------------------------------------ */
+
+/**
+ * Optional callback invoked whenever a request fails at the network level
+ * (server unreachable, connection refused, or request timeout).
+ * Wire this up once from a React component that has access to the toast context.
+ *
+ * Example:
+ *   setNetworkErrorHandler((msg) => showToast(msg, "error", "Connection Error"));
+ */
+let _networkErrorHandler: ((message: string) => void) | null = null;
+
+export function setNetworkErrorHandler(fn: ((message: string) => void) | null) {
+  _networkErrorHandler = fn;
+}
+
+/* ------------------------------------------------------------------ */
+/*  Error                                                             */
+/* ------------------------------------------------------------------ */
+
+export class ApiError extends Error {
+  constructor(
+    public status: number,
+    public statusText: string,
+    public body: unknown,
+  ) {
+    super(`API ${status}: ${statusText}`);
+    this.name = "ApiError";
+  }
+}
+
+/**
+ * Returns `true` when the error was caused by a request abort / timeout.
+ */
+export function isAbortError(err: unknown): boolean {
+  return err instanceof DOMException && err.name === "AbortError";
+}
+
+/**
+ * Returns `true` when the error was caused by a network-level failure
+ * (server unreachable, ECONNREFUSED, etc.).
+ */
+export function isNetworkError(err: unknown): boolean {
+  return err instanceof TypeError;
+}
+
+/**
+ * Extract the most useful server-side message from an API error.
+ */
+export function getApiErrorMessage(
+  err: unknown,
+  fallback = "Request failed",
+): string {
+  if (err instanceof ApiError) {
+    const body = err.body as Record<string, unknown> | undefined;
+    if (body && typeof body.message === "string") return body.message;
+    if (body && typeof body.error === "string") return body.error;
+    return err.message || fallback;
+  }
+  if (err instanceof Error) return err.message;
+  return fallback;
+}
+
+/* ------------------------------------------------------------------ */
+/*  Request helper                                                    */
+/* ------------------------------------------------------------------ */
+
+export type RequestOptions = Omit<RequestInit, "body"> & {
+  /** Request body — objects are JSON-serialised automatically. */
+  body?: unknown;
+  /** Per-request timeout in ms (default 15 000). */
+  timeout?: number;
+  /** URL search params appended to the path. */
+  params?: Record<string, string | number | boolean | undefined>;
+};
+
+/**
+ * Low-level fetch wrapper — prefer the convenience methods below.
+ */
+async function request<T = unknown>(
+  path: string,
+  { body, timeout = DEFAULT_TIMEOUT, params, ...init }: RequestOptions = {},
+): Promise<T> {
+  /* --- Build URL -------------------------------------------------- */
+  const cleanPath = path.startsWith("/") ? path.slice(1) : path;
+  const url = new URL(cleanPath, RESOLVED_BASE);
+
+  if (params) {
+    for (const [k, v] of Object.entries(params)) {
+      if (v !== undefined) url.searchParams.set(k, String(v));
+    }
+  }
+
+  /* --- Timeout ---------------------------------------------------- */
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), timeout);
+
+  /* --- Headers ---------------------------------------------------- */
+  const headers = new Headers(init.headers);
+
+  if (body && typeof body === "object" && !(body instanceof FormData)) {
+    headers.set("Content-Type", "application/json");
+  }
+
+  /* --- Fetch ------------------------------------------------------ */
+  try {
+    const res = await fetch(url, {
+      ...init,
+      headers,
+      credentials: "include",
+      signal: controller.signal,
+      body:
+        body instanceof FormData
+          ? body
+          : body !== undefined
+            ? JSON.stringify(body)
+            : undefined,
+    });
+
+    if (!res.ok) {
+      const text = await res.text().catch(() => "");
+      let parsed: unknown = text;
+      try {
+        parsed = JSON.parse(text);
+      } catch {
+        /* keep as string */
+      }
+      throw new ApiError(res.status, res.statusText, parsed);
+    }
+
+    /* 204 No Content */
+    if (res.status === 204) return undefined as T;
+
+    const contentType = res.headers.get("content-type") ?? "";
+    if (contentType.includes("application/json")) {
+      return (await res.json()) as T;
+    }
+
+    return (await res.text()) as T;
+  } catch (err) {
+    // Network-level failures: server unreachable (TypeError) or request timeout (AbortError)
+    if (err instanceof TypeError) {
+      _networkErrorHandler?.("Cannot reach the server. Make sure the API is running.");
+    } else if (err instanceof DOMException && err.name === "AbortError") {
+      _networkErrorHandler?.("Request timed out. The server took too long to respond.");
+    }
+    throw err;
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+/* ------------------------------------------------------------------ */
+/*  Convenience methods                                               */
+/* ------------------------------------------------------------------ */
+
+export const api = {
+  get: <T = unknown>(path: string, opts?: RequestOptions) =>
+    request<T>(path, { ...opts, method: "GET" }),
+
+  post: <T = unknown>(path: string, body?: unknown, opts?: RequestOptions) =>
+    request<T>(path, { ...opts, method: "POST", body }),
+
+  put: <T = unknown>(path: string, body?: unknown, opts?: RequestOptions) =>
+    request<T>(path, { ...opts, method: "PUT", body }),
+
+  patch: <T = unknown>(path: string, body?: unknown, opts?: RequestOptions) =>
+    request<T>(path, { ...opts, method: "PATCH", body }),
+
+  delete: <T = unknown>(path: string, opts?: RequestOptions) =>
+    request<T>(path, { ...opts, method: "DELETE" }),
+} as const;

package/apps/dashboard/src/lib/api/cloud.ts

@@ -0,0 +1,15 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+export interface CloudStatus {
+  connected: boolean;
+  user?: { name: string; email: string; image?: string | null };
+}
+
+export const cloudApi = {
+  /** Disconnect from Openship Cloud */
+  disconnect: () => api.post<CloudStatus>(endpoints.cloud.disconnect),
+
+  /** Check current cloud connection status */
+  status: () => api.get<CloudStatus>(endpoints.cloud.status),
+};

package/apps/dashboard/src/lib/api/deploy.ts

@@ -0,0 +1,58 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+/* ------------------------------------------------------------------ */
+/*  Deploy / Build API                                                */
+/* ------------------------------------------------------------------ */
+
+export const deployApi = {
+  /** List all deployments for the authenticated user */
+  getAll: (opts?: { page?: number; perPage?: number }) =>
+    api.get<any>(endpoints.deploy.list, { params: opts }),
+
+  /** Cancel a deployment */
+  cancel: (id: string) =>
+    api.post<any>(endpoints.deploy.cancel(id)),
+
+  /** Delete a deployment */
+  deleteDeployment: (id: string) =>
+    api.delete<any>(endpoints.deploy.delete(id)),
+
+  /** Resolve project info from GitHub repo or local path — detects stack */
+  prepare: (body:
+    | { source?: "github"; owner: string; repo: string; force?: string | boolean }
+    | { source: "local"; path: string }
+  ) =>
+    api.post<any>(endpoints.deploy.prepare, body),
+
+  /** Create deployment + build session for an existing project */
+  buildAccess: (payload: {
+    projectId: string;
+    branch?: string;
+    environment?: string;
+    envVars?: Record<string, string>;
+    customDomain?: string;
+    buildStrategy?: "server" | "local";
+  }) =>
+    api.post<any>(endpoints.deploy.buildAccess, payload),
+
+  /** Poll build status */
+  getBuildStatus: (deploymentId: string) =>
+    api.get<any>(endpoints.deploy.buildStatus(deploymentId)),
+
+  /** Start a build by deployment ID */
+  buildStart: (deployment_id: string) =>
+    api.post<any>(endpoints.deploy.buildStart(deployment_id)),
+
+  /** Re-deploy an existing deployment */
+  buildRedeploy: (deployment_id: string) =>
+    api.post<any>(endpoints.deploy.buildRedeploy(deployment_id)),
+
+  /** Check SSL certificate status for a domain */
+  sslStatus: (domain: string) =>
+    api.post<any>(endpoints.deploy.sslStatus, { domain }),
+
+  /** Renew SSL certificate */
+  sslRenew: (domain: string, includeWww = false) =>
+    api.post<any>(endpoints.deploy.sslRenew, { domain, includeWww }),
+};

package/apps/dashboard/src/lib/api/domains.ts

@@ -0,0 +1,13 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+export const domainsApi = {
+  /** Get DNS records preview for a hostname (no domain creation needed). */
+  previewRecords: (hostname: string) =>
+    api.post<{
+      data: {
+        mode: "cloud" | "selfhosted";
+        records: Array<{ type: "CNAME" | "A" | "TXT"; host: string; value: string }>;
+      };
+    }>(endpoints.domains.preview, { hostname }),
+};

package/apps/dashboard/src/lib/api/endpoints.ts

@@ -0,0 +1,129 @@
+/**
+ * Single source of truth for every API endpoint path.
+ *
+ * All route strings live here — never hardcode paths in components,
+ * hooks, or context files. Import from `@/lib/api` instead.
+ */
+
+export const endpoints = {
+  /* ---------------------------------------------------------------- */
+  /*  Projects                                                        */
+  /* ---------------------------------------------------------------- */
+  projects: {
+    home: "projects/home",
+    local: "projects/local",
+    scan: "projects/scan",
+    import: "projects/import",
+    info: (id: string | number) => `projects/${id}/info`,
+    delete: (id: string | number) => `projects/${id}/delete`,
+    update: (id: string | number) => `projects/${id}/update`,
+    options: (id: string | number) => `projects/${id}/options`,
+    toggle: (id: string | number, action: "enable" | "disable") =>
+      `projects/${id}/${action}`,
+    clearCache: (id: string | number) => `projects/${id}/clear-cache`,
+    clearBuild: (id: string | number) => `projects/${id}/clear-build`,
+    deploymentSession: (id: string | number) =>
+      `projects/${id}/deployment-session`,
+    connect: (id: string | number) => `projects/${id}/connect`,
+    envSet: (id: string | number) => `projects/${id}/env/set`,
+    envGet: (id: string | number) => `projects/${id}/env/get`,
+    git: (id: string | number) => `projects/${id}/git`,
+    branches: (id: string | number) => `projects/${id}/branches`,
+    branch: (id: string | number) => `projects/${id}/branch`,
+    gitSwitch: (id: string | number) => `projects/${id}/git/switch`,
+    autoDeploy: (id: string | number) => `projects/${id}/auto-deploy`,
+    resources: (id: string | number) => `projects/${id}/resources`,
+    sleepMode: (id: string | number) => `projects/${id}/sleep-mode`,
+    deployments: (id: string | number) => `projects/${id}/deployments`,
+    logs: (id: string | number) => `projects/${id}/logs`,
+    logsStream: (id: string | number) => `projects/${id}/logs/stream`,
+    ensure: "projects/ensure",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  Deploy / Build                                                  */
+  /* ---------------------------------------------------------------- */
+  deploy: {
+    list: "deployments",
+    delete: (id: string) => `deployments/${id}`,
+    cancel: (id: string) => `deployments/${id}/cancel`,
+    prepare: "deployments/prepare",
+    buildAccess: "deployments/build/access",
+    buildStart: (id: string) => `deployments/${id}/build`,
+    buildStatus: (id: string) => `deployments/${id}/build`,
+    buildRedeploy: (id: string) => `deployments/${id}/redeploy`,
+    sslStatus: "deployments/ssl/status",
+    sslRenew: "deployments/ssl/renew",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  Domains                                                          */
+  /* ---------------------------------------------------------------- */
+  domains: {
+    preview: "domains/preview",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  GitHub                                                          */
+  /* ---------------------------------------------------------------- */
+  github: {
+    userHome: "github/home",
+    orgRepos: (owner: string) => `github/orgs/${owner}/repos`,
+    userRepos: "github/repos",
+    status: "github/status",
+    connect: "github/connect",
+    connectPoll: "github/connect/poll",
+    disconnect: "github/disconnect",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  Icons                                                           */
+  /* ---------------------------------------------------------------- */
+  icons: {
+    search: "icons/search-icons",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  AI                                                              */
+  /* ---------------------------------------------------------------- */
+  ai: {
+    sessionList: "/ai/session/list",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  System (self-hosted only)                                       */
+  /* ---------------------------------------------------------------- */
+  system: {
+    browse: "system/browse",
+    settings: "system/settings",
+    check: "system/check",
+    install: "system/install",
+    installStream: "system/install/stream",
+    installSession: "system/install/session",
+    monitorStream: "system/monitor/stream",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  Sandbox                                                         */
+  /* ---------------------------------------------------------------- */
+  sandbox: {
+    resources: (id: string | number) => `sandbox/${id}/resources`,
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  Settings (user platform preferences)                            */
+  /* ---------------------------------------------------------------- */
+  settings: {
+    get: "settings",
+    upsert: "settings",
+    buildMode: "settings/build-mode",
+  },
+
+  /* ---------------------------------------------------------------- */
+  /*  Cloud (Openship Cloud connection — local/self-hosted only)      */
+  /* ---------------------------------------------------------------- */
+  cloud: {
+    disconnect: "cloud/disconnect",
+    status: "cloud/status",
+  },
+} as const;

package/apps/dashboard/src/lib/api/github.ts

@@ -0,0 +1,31 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+/* ------------------------------------------------------------------ */
+/*  GitHub Integration API                                            */
+/* ------------------------------------------------------------------ */
+
+export const githubApi = {
+  /** Dashboard home — user info, orgs, recent repos */
+  getUserHome: () => api.get<any>(endpoints.github.userHome),
+
+  /** Repos for a specific GitHub org */
+  getOrgRepos: (owner: string) =>
+    api.get<any>(endpoints.github.orgRepos(owner)),
+
+  /** Repos for a specific GitHub user */
+  getUserRepos: (owner: string) =>
+    api.get<any>(endpoints.github.userRepos, { params: { owner } }),
+
+  /** Check GitHub connection status */
+  getStatus: () => api.get<any>(endpoints.github.status),
+
+  /** Start GitHub OAuth connection */
+  connect: () => api.post<any>(endpoints.github.connect),
+
+  /** Poll device flow status */
+  pollConnect: () => api.get<any>(endpoints.github.connectPoll),
+
+  /** Disconnect GitHub integration */
+  disconnect: () => api.post<any>(endpoints.github.disconnect),
+};

package/apps/dashboard/src/lib/api/icons.ts

@@ -0,0 +1,12 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+/* ------------------------------------------------------------------ */
+/*  Icons API                                                         */
+/* ------------------------------------------------------------------ */
+
+export const iconsApi = {
+  /** Search icons by query string with pagination */
+  search: (query: string, offset = 0, limit = 100) =>
+    api.post<any>(endpoints.icons.search, { query, offset, limit }),
+};

package/apps/dashboard/src/lib/api/index.ts

@@ -0,0 +1,41 @@
+/**
+ * @module @/lib/api
+ *
+ * Centralised API layer for the Openship dashboard.
+ *
+ * Usage:
+ *   import { projectsApi, deployApi, githubApi } from "@/lib/api";
+ *   const { projects, numbers } = await projectsApi.getHome();
+ */
+
+/* --- Low-level client (rarely needed directly) -------------------- */
+export {
+	api,
+	ApiError,
+	getApiErrorMessage,
+	isAbortError,
+	isNetworkError,
+	setNetworkErrorHandler,
+	getApiBaseUrl,
+} from "./client";
+export type { RequestOptions } from "./client";
+
+/* --- Endpoint registry (single source of truth for paths) --------- */
+export { endpoints } from "./endpoints";
+
+/* --- Domain services ---------------------------------------------- */
+export { projectsApi } from "./projects";
+export { deployApi } from "./deploy";
+export { domainsApi } from "./domains";
+export { githubApi } from "./github";
+export { iconsApi } from "./icons";
+export { aiApi } from "./ai";
+export { sandboxApi } from "./sandbox";
+export { systemApi } from "./system";
+export { settingsApi } from "./settings";
+export type { BuildMode, UserSettingsResponse } from "./settings";
+export { cloudApi } from "./cloud";
+export type { CloudStatus } from "./cloud";
+
+/* --- Auth helpers -------------------------------------------------- */
+export { getAuthToken } from "./auth";

package/apps/dashboard/src/lib/api/projects.ts

@@ -0,0 +1,153 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+/* ------------------------------------------------------------------ */
+/*  Projects API                                                      */
+/* ------------------------------------------------------------------ */
+
+export const projectsApi = {
+  /** Dashboard overview — projects list + stats numbers */
+  getHome: () =>
+    api.get<{ success: boolean; projects: any[]; numbers: Record<string, number> }>(
+      endpoints.projects.home,
+    ),
+
+  /** Create or update a project (mandatory before build access) */
+  ensure: (body: {
+    name: string;
+    slug?: string;
+    gitOwner?: string;
+    gitRepo?: string;
+    gitBranch?: string;
+    framework?: string;
+    localPath?: string;
+    packageManager?: string;
+    installCommand?: string;
+    buildCommand?: string;
+    outputDirectory?: string;
+    productionPaths?: string;
+    rootDirectory?: string;
+    startCommand?: string;
+    buildImage?: string;
+    port?: number;
+    hasServer?: boolean;
+    hasBuild?: boolean;
+  }) =>
+    api.post<any>(endpoints.projects.ensure, body),
+
+  /** List local projects only */
+  getLocal: () =>
+    api.get<{ success: boolean; projects: any[] }>(endpoints.projects.local),
+
+  /** Scan a local directory for framework detection */
+  scan: (path: string) =>
+    api.post<{
+      success: boolean;
+      name: string;
+      path: string;
+      stack: string;
+      category: string;
+      packageManager: string;
+      installCommand: string;
+      buildCommand: string;
+      startCommand: string;
+      outputDirectory: string;
+    }>(endpoints.projects.scan, { path }),
+
+  /** Import a local folder as a project */
+  importLocal: (data: {
+    name: string;
+    localPath: string;
+    framework?: string;
+    packageManager?: string;
+    buildCommand?: string;
+    installCommand?: string;
+    outputDirectory?: string;
+    port?: number;
+  }) =>
+    api.post<{ data: any }>(endpoints.projects.import, data),
+
+  /** Delete a local project */
+  deleteLocal: (id: string) =>
+    api.delete<{ message: string }>(`projects/${id}`),
+
+  /** Single project info */
+  getInfo: (id: string | number) => api.get<any>(endpoints.projects.info(id)),
+
+  /** Delete a project */
+  delete: (id: string | number) => api.post<any>(endpoints.projects.delete(id)),
+
+  /** Update name or description */
+  update: (id: string | number, action: string, value: string) =>
+    api.post<any>(endpoints.projects.update(id), { action, value }),
+
+  /** Update build options (single field) */
+  setOptions: (id: string | number, options: Record<string, any>) =>
+    api.post<any>(endpoints.projects.options(id), options),
+
+  /** Enable or disable a project */
+  toggle: (id: string | number, enable: boolean) =>
+    api.post<any>(
+      endpoints.projects.toggle(id, enable ? "enable" : "disable"),
+    ),
+
+  /** Clear CDN / proxy cache */
+  clearCache: (id: string | number) =>
+    api.post<any>(endpoints.projects.clearCache(id)),
+
+  /** Clear build artifacts */
+  clearBuild: (id: string | number) =>
+    api.post<any>(endpoints.projects.clearBuild(id)),
+
+  /** Create a new deployment session */
+  createDeploymentSession: (id: string | number) =>
+    api.post<any>(endpoints.projects.deploymentSession(id)),
+
+  /** Connect a custom domain */
+  connectDomain: (
+    id: string | number,
+    body: { domain: string; includeWww: boolean },
+  ) => api.post<any>(endpoints.projects.connect(id), body),
+
+  /** Set environment variables */
+  setEnv: (id: string | number, envVars: any) =>
+    api.post<any>(endpoints.projects.envSet(id), { envVars }),
+
+  /** Get environment variables */
+  getEnv: (id: string | number) => api.get<any>(endpoints.projects.envGet(id)),
+
+  /** Get git settings */
+  getGit: (id: string | number) => api.get<any>(endpoints.projects.git(id)),
+
+  /** List branches */
+  getBranches: (id: string | number) =>
+    api.get<any>(endpoints.projects.branches(id)),
+
+  /** Set active branch */
+  setBranch: (id: string | number, branch: string) =>
+    api.post<any>(endpoints.projects.branch(id), { branch }),
+
+  /** Toggle git auto-deploy via git/switch */
+  gitSwitch: (id: string | number, auto_deploy: boolean) =>
+    api.post<any>(endpoints.projects.gitSwitch(id), { auto_deploy }),
+
+  /** Toggle auto-deploy setting */
+  setAutoDeploy: (id: string | number, enabled: boolean) =>
+    api.post<any>(endpoints.projects.autoDeploy(id), { enabled }),
+
+  /** Set resources (POST — tier-based) */
+  setResources: (id: string | number, resources: Record<string, any>) =>
+    api.post<any>(endpoints.projects.resources(id), resources),
+
+  /** Update resources (PUT — raw values) */
+  updateResources: (id: string | number, resources: Record<string, any>) =>
+    api.put<any>(endpoints.projects.resources(id), resources),
+
+  /** Set sleep-mode */
+  setSleepMode: (id: string | number, sleep_mode: string) =>
+    api.post<any>(endpoints.projects.sleepMode(id), { sleep_mode }),
+
+  /** List deployments for a project */
+  getDeployments: (id: string | number) =>
+    api.get<any>(endpoints.projects.deployments(id)),
+};

package/apps/dashboard/src/lib/api/sandbox.ts

@@ -0,0 +1,14 @@
+import { api } from "./client";
+import { endpoints } from "./endpoints";
+
+/* ------------------------------------------------------------------ */
+/*  Sandbox API                                                       */
+/* ------------------------------------------------------------------ */
+
+export const sandboxApi = {
+  /** Update sandbox resources (CPU, RAM, storage) */
+  updateResources: (
+    id: string | number,
+    resources: { cpu: number; ram: number; storage: number },
+  ) => api.put<any>(endpoints.sandbox.resources(id), resources),
+};