@gol/sdk 0.1.0-next.0

package/README.md

@@ -0,0 +1,70 @@
+# GOL SDK
+
+Public TypeScript interfaces for GOL Network.
+
+This first package covers developer onboarding and API credential verification through the public GOL Platform API. Mandates, payment actions, receipts, and webhooks are intentionally not exposed until their contract and platform interfaces exist.
+
+## Install
+
+The package is not published yet. After a release is available:
+
+```sh
+pnpm add @gol/sdk
+```
+
+Use Node.js 22 or later. The root entry point exports browser-safe types and errors. API clients that accept session tokens or API keys are available only from `@gol/sdk/server`.
+
+## API key authentication
+
+Send a project API key in the bearer authorization header. Keep the value in a server-side environment variable and never commit it or place it in browser code.
+
+```sh
+curl "https://api.gol.network/v1/whoami" \
+  --header "Accept: application/json" \
+  --header "Authorization: Bearer $GOL_API_KEY"
+```
+
+The server client applies the same header:
+
+```ts
+import { GolApiClient } from "@gol/sdk/server";
+
+const gol = new GolApiClient({
+  baseUrl: "https://api.gol.network",
+  apiKey: process.env.GOL_API_KEY!,
+});
+
+const identity = await gol.whoami();
+```
+
+Console management operations use a developer session token instead:
+
+```ts
+import { GolManagementClient } from "@gol/sdk/server";
+
+const gol = new GolManagementClient({
+  baseUrl: "https://api.gol.network",
+  sessionToken: "replace-with-a-server-side-session-token",
+});
+
+const projects = await gol.listProjects();
+```
+
+## Development
+
+```sh
+pnpm install --frozen-lockfile
+pnpm sync:openapi
+pnpm generate:check
+pnpm upstream:check
+pnpm typecheck
+pnpm lint
+pnpm test
+pnpm build
+pnpm verify:pack
+pnpm format:check
+```
+
+`openapi/platform.json` is a versioned snapshot of the platform contract. `pnpm sync:openapi` refreshes the snapshot from `../platform/openapi/openapi.json` by default and regenerates TypeScript declarations. Set `GOL_PLATFORM_OPENAPI_PATH` when the platform repository is elsewhere.
+
+`pnpm verify:pack` builds and packs the SDK, installs the archive into a temporary clean consumer, checks both package entry points, runs the compiled consumer, and deletes the temporary files. It does not publish the package.

package/dist/errors.d.ts

@@ -0,0 +1,10 @@
+export declare class GolApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly correlationId: string | null;
+    constructor(status: number, code: string, message: string, correlationId: string | null);
+}
+export declare class GolTransportError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAY,SAAQ,KAAK;IAElC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;gBAH5B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACN,aAAa,EAAE,MAAM,GAAG,IAAI;CAKxC;AAED,qBAAa,iBAAkB,SAAQ,KAAK;gBAC9B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIpD"}

package/dist/errors.js

@@ -0,0 +1,19 @@
+export class GolApiError extends Error {
+    status;
+    code;
+    correlationId;
+    constructor(status, code, message, correlationId) {
+        super(message);
+        this.status = status;
+        this.code = code;
+        this.correlationId = correlationId;
+        this.name = "GolApiError";
+    }
+}
+export class GolTransportError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = "GolTransportError";
+    }
+}
+//# 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,MAAM,OAAO,WAAY,SAAQ,KAAK;IAEzB;IACA;IAEA;IAJX,YACW,MAAc,EACd,IAAY,EACrB,OAAe,EACN,aAA4B;QAErC,KAAK,CAAC,OAAO,CAAC,CAAC;QALN,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAQ;QAEZ,kBAAa,GAAb,aAAa,CAAe;QAGrC,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,YAAY,OAAe,EAAE,OAAsB;QACjD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF"}