@polardbx/pxbaas-client 0.0.0-stage → 0.1.0-beta.10

package/dist/errors.js

@@ -0,0 +1,64 @@
+/**
+ * Shared API error formatting for all drivers.
+ *
+ * WHY: Storage/Meta error bodies are `{ statusCode, error, message }` where
+ * `error` is a coarse category (literally "Error" for Storage 400s) and
+ * `message` carries the actionable detail. Each driver used to prefer `error`
+ * and hard-coded 401/403/404 texts that swallowed the server `message`
+ * entirely, so users saw e.g. `Storage API error (400): Error` instead of
+ * `body must have required property 'prefix'`.
+ *
+ * Contract: always throws a plain `Error` whose message starts with
+ * `<source> API error (<status>): ` — upper layers match on that text, so do
+ * not introduce custom error classes or codes here.
+ */
+function asRecord(value) {
+    return typeof value === 'object' && value !== null ? value : undefined;
+}
+function firstString(...candidates) {
+    for (const candidate of candidates) {
+        if (typeof candidate === 'string' && candidate.trim() !== '')
+            return candidate;
+    }
+    return undefined;
+}
+/**
+ * Build the error for a failed API call and throw it as a plain `Error`.
+ */
+export function formatApiError(source, info, options = {}) {
+    const { status, data } = info;
+    const body = asRecord(data);
+    // Share-Links nests details as `{ error: { message } }`; Meta/Storage use flat
+    // `{ error, message }`. `message` always wins over the coarse `error` category.
+    const nested = asRecord(body?.error);
+    const detail = firstString(body?.message, nested?.message, body?.error);
+    const friendly = status !== undefined
+        ? options.statusTexts?.[status]
+        : undefined;
+    let message;
+    if (friendly) {
+        message = detail ? `${friendly} Server said: ${detail}` : friendly;
+    }
+    else if (detail) {
+        // Keep the category as a prefix only when it adds information beyond the detail.
+        const category = typeof body?.error === 'string' && body.error !== detail ? `${body.error}: ` : '';
+        message = `${category}${detail}`;
+    }
+    else if (body === undefined && info.fallbackMessage) {
+        // No JSON body at all (network failure / gateway HTML): keep the transport message.
+        message = info.fallbackMessage;
+    }
+    else {
+        message = 'no error body';
+    }
+    if (info.debug) {
+        const method = info.debug.method ?? 'unknown';
+        const url = info.debug.url ?? 'unknown';
+        message += `\n[debug] ${method.toUpperCase()} ${url} -> ${status ?? 'unknown'}`;
+        if (info.debug.responseBody !== undefined) {
+            message += `\n[debug] response body: ${info.debug.responseBody}`;
+        }
+    }
+    throw new Error(`${source} API error (${status ?? 'unknown'}): ${message}`);
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAsBH,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAE,KAAiC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtG,CAAC;AAED,SAAS,WAAW,CAAC,GAAG,UAAqB;IAC3C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,OAAO,SAAS,CAAC;IACjF,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,IAAkB,EAClB,UAAiC,EAAE;IAEnC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,+EAA+E;IAC/E,gFAAgF;IAChF,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACxE,MAAM,QAAQ,GACZ,MAAM,KAAK,SAAS;QAClB,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,MAAyB,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEhB,IAAI,OAAe,CAAC;IACpB,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,iBAAiB,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrE,CAAC;SAAM,IAAI,MAAM,EAAE,CAAC;QAClB,iFAAiF;QACjF,MAAM,QAAQ,GAAG,OAAO,IAAI,EAAE,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACnG,OAAO,GAAG,GAAG,QAAQ,GAAG,MAAM,EAAE,CAAC;IACnC,CAAC;SAAM,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACtD,oFAAoF;QACpF,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC;IACjC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,eAAe,CAAC;IAC5B,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,SAAS,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,SAAS,CAAC;QACxC,OAAO,IAAI,aAAa,MAAM,CAAC,WAAW,EAAE,IAAI,GAAG,OAAO,MAAM,IAAI,SAAS,EAAE,CAAC;QAChF,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,IAAI,4BAA4B,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACnE,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,eAAe,MAAM,IAAI,SAAS,MAAM,OAAO,EAAE,CAAC,CAAC;AAC9E,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @polardbx/pxbaas-client
+ *
+ * Shared HTTP client SDK for PolarDB-X BaaS data plane APIs.
+ *
+ * This package provides typed clients for:
+ * - Kong gateway routing
+ * - Meta API (/pg/*)
+ * - Functions Management API (/v1/projects/*)
+ * - Storage API (/storage/v1/*)
+ * - Auth Admin API (/auth/v1/admin/*)
+ * - REST API (/rest/v1/*)
+ *
+ * @packageDocumentation
+ */
+export * from "./types.js";
+export * from "./errors.js";
+export * from "./drivers/meta.driver.js";
+export * from "./drivers/functions.driver.js";
+export * from "./drivers/apps.driver.js";
+export * from "./drivers/share-links.driver.js";
+export * from "./drivers/storage.driver.js";
+export * from "./drivers/auth-admin.driver.js";
+export * from "./drivers/tenant-ddl.driver.js";
+export * from "./drivers/tenant-admin.driver.js";
+export * from "./drivers/zero.driver.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAM5B,cAAc,0BAA0B,CAAC;AAGzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAG5C,cAAc,gCAAgC,CAAC;AAG/C,cAAc,gCAAgC,CAAC;AAG/C,cAAc,kCAAkC,CAAC;AAGjD,cAAc,0BAA0B,CAAC"}

package/dist/index.js

@@ -0,0 +1,37 @@
+/**
+ * @polardbx/pxbaas-client
+ *
+ * Shared HTTP client SDK for PolarDB-X BaaS data plane APIs.
+ *
+ * This package provides typed clients for:
+ * - Kong gateway routing
+ * - Meta API (/pg/*)
+ * - Functions Management API (/v1/projects/*)
+ * - Storage API (/storage/v1/*)
+ * - Auth Admin API (/auth/v1/admin/*)
+ * - REST API (/rest/v1/*)
+ *
+ * @packageDocumentation
+ */
+export * from "./types.js";
+export * from "./errors.js";
+// TODO: M1 - Add Kong client
+// export * from './kong.js';
+// M3 - Meta API driver
+export * from "./drivers/meta.driver.js";
+// M4 - Functions, Apps, and Storage drivers
+export * from "./drivers/functions.driver.js";
+export * from "./drivers/apps.driver.js";
+export * from "./drivers/share-links.driver.js";
+export * from "./drivers/storage.driver.js";
+// M5 - Auth Admin driver
+export * from "./drivers/auth-admin.driver.js";
+// Tenant self-service DDL / RLS driver (multi-tenant, per-tenant service_role)
+export * from "./drivers/tenant-ddl.driver.js";
+// Tenant admin driver (platform-operator surface; dashboard Basic Auth)
+export * from "./drivers/tenant-admin.driver.js";
+// Zero provisioning driver (PolarDB-X Zero PXBaas)
+export * from "./drivers/zero.driver.js";
+// TODO: M5 - Add REST driver
+// export * from './drivers/rest.driver.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAE5B,6BAA6B;AAC7B,6BAA6B;AAE7B,uBAAuB;AACvB,cAAc,0BAA0B,CAAC;AAEzC,4CAA4C;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAE5C,yBAAyB;AACzB,cAAc,gCAAgC,CAAC;AAE/C,+EAA+E;AAC/E,cAAc,gCAAgC,CAAC;AAE/C,wEAAwE;AACxE,cAAc,kCAAkC,CAAC;AAEjD,mDAAmD;AACnD,cAAc,0BAA0B,CAAC;AAEzC,6BAA6B;AAC7B,4CAA4C"}

package/dist/types.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Core types for @polardbx/pxbaas-client
+ */
+export interface TenantProfile {
+    endpoint: string;
+    tenantId?: string;
+    anonKey: string;
+    serviceRoleKey: string;
+}
+export interface JwtPayload {
+    role: 'anon' | 'service_role';
+    tenant_id?: string;
+    iss: string;
+    iat: number;
+    exp: number;
+}
+export interface ApiResponse<T = unknown> {
+    data: T;
+    error?: string;
+}
+export interface PaginatedResponse<T> extends ApiResponse<T[]> {
+    count: number;
+    offset: number;
+    limit: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO;IACtC,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,EAAE,CAAC;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Core types for @polardbx/pxbaas-client
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@polardbx/pxbaas-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0-beta.10",
+  "description": "Shared HTTP client SDK for PolarDB-X BaaS data plane APIs",
+  "keywords": [
+    "polardbx",
+    "baas",
+    "client",
+    "sdk",
+    "http"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/polardbx/mysql-supabase.git",
+    "directory": "cli/packages/baas-client"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "axios": "^1.6.0",
+    "form-data": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "eslint": "^8.56.0",
+    "msw": "^2.2.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.2.0"
+  },
+  "engines": {
+    "node": "^22.23.4 || ^24.22.1 || >=26.12.1"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:unit": "vitest run",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist *.tsbuildinfo"
+  }
 }