@oapiex/sdk-kit 0.1.1 → 0.1.2

package/README.md

@@ -1 +1,132 @@
-# SDK Core
+# @oapiex/sdk-kit
+
+[![NPM Downloads](https://img.shields.io/npm/dt/@oapiex/sdk-kit.svg)](https://www.npmjs.com/package/@oapiex/sdk-kit)
+[![npm version](https://img.shields.io/npm/v/@oapiex/sdk-kit.svg)](https://www.npmjs.com/package/@oapiex/sdk-kit)
+[![License](https://img.shields.io/npm/l/@oapiex/sdk-kit.svg)](https://github.com/toneflix/oapiex/blob/main/LICENSE)
+[![codecov](https://img.shields.io/codecov/c/github/toneflix/oapiex.svg?token=9C8arbqlX2)](https://codecov.io/gh/toneflix/oapiex)
+[![Publish Package](https://github.com/toneflix/oapiex/actions/workflows/publish.yml/badge.svg)](https://github.com/toneflix/oapiex/actions/workflows/publish.yml)
+[![Deploy Docs](https://github.com/toneflix/oapiex/actions/workflows/docs.yml/badge.svg)](https://github.com/toneflix/oapiex/actions/workflows/docs.yml)
+[![Run Tests](https://github.com/toneflix/oapiex/actions/workflows/test.yml/badge.svg)](https://github.com/toneflix/oapiex/actions/workflows/test.yml)
+
+Core runtime primitives for SDKs generated by oapiex.
+
+This package provides the shared building blocks used by generated SDK packages:
+
+- `Core` for authenticated SDK instances
+- `BaseApi` for SDK-specific API binders and API classes
+- `createSdk()` for manifest-driven runtime SDKs
+- shared HTTP utilities, exceptions, contracts, and helper types
+
+Most consumers will install a generated SDK package instead of using this package directly. Use `@oapiex/sdk-kit` when you want to build or customize an SDK on top of the generated OpenAPI manifest output.
+
+## Install
+
+```bash
+pnpm add @oapiex/sdk-kit
+```
+
+## Quick Start
+
+### Class-based SDK
+
+```ts
+import { BaseApi, Core, Http } from '@oapiex/sdk-kit';
+
+class ExampleApi extends BaseApi {
+  async list() {
+    await this.core.validateAccess();
+
+    const { data } = await Http.send(
+      this.core.builder.buildTargetUrl('/v1/examples', {}, {}),
+      'GET',
+      {},
+      {},
+    );
+
+    return data;
+  }
+}
+
+class ApiBinder extends BaseApi {
+  examples!: ExampleApi;
+
+  protected override boot() {
+    this.examples = new ExampleApi(this.core);
+  }
+}
+
+class ExampleCore extends Core {
+  static override apiClass = ApiBinder;
+
+  declare api: ApiBinder;
+}
+
+const sdk = new ExampleCore({
+  clientId: process.env.CLIENT_ID!,
+  clientSecret: process.env.CLIENT_SECRET!,
+  environment: 'sandbox',
+});
+
+await sdk.api.examples.list();
+```
+
+### Runtime manifest SDK
+
+```ts
+import { createSdk, type RuntimeSdkBundle } from '@oapiex/sdk-kit';
+
+const bundle = {
+  document: {},
+  manifest: {
+    groups: [
+      {
+        className: 'Example',
+        propertyName: 'examples',
+        operations: [
+          {
+            path: '/v1/examples',
+            method: 'GET',
+            methodName: 'list',
+            responseType: 'Example[]',
+            inputType: 'Record<string, never>',
+            queryType: 'Record<string, never>',
+            headerType: 'Record<string, never>',
+            paramsType: 'Record<string, never>',
+            hasBody: false,
+            bodyRequired: false,
+            pathParams: [],
+            queryParams: [],
+            headerParams: [],
+          },
+        ],
+      },
+    ],
+  },
+} satisfies RuntimeSdkBundle;
+
+const sdk = createSdk(bundle, {
+  clientId: process.env.CLIENT_ID!,
+  clientSecret: process.env.CLIENT_SECRET!,
+  environment: 'sandbox',
+});
+
+await sdk.api.examples.list();
+```
+
+## Main Exports
+
+- `Core`: base SDK client with environment setup, access validation, and runtime bundle support
+- `BaseApi`: base class for SDK-specific API binders and API classes
+- `createSdk()`: helper for creating a runtime SDK from a manifest bundle
+- `Http`, `Builder`, and exceptions: lower-level request and error primitives
+- `InitOptions`, `UnifiedResponse`, and runtime manifest types: shared contracts for generated SDKs
+
+## Commands
+
+Run these inside `packages/sdk-kit`:
+
+```bash
+pnpm test
+pnpm build
+pnpm coverage
+```

package/dist/index.d.cts

@@ -262,7 +262,7 @@ declare class HttpException extends Error {
    * @param code
    * @param data
    */
-  static fromCode(code: number, data: Required<UnifiedResponse>, parent?: Error): BadRequestException | UnauthorizedRequestException | HttpException | ForbiddenRequestException;
+  static fromCode(code: number, data: Required<UnifiedResponse>, parent?: Error): BadRequestException | ForbiddenRequestException | UnauthorizedRequestException | HttpException;
 }
 //#endregion
 //#region src/Apis/BaseApi.d.ts

package/dist/index.d.ts

@@ -263,7 +263,7 @@ declare class HttpException extends Error {
    * @param code
    * @param data
    */
-  static fromCode(code: number, data: Required<UnifiedResponse>, parent?: Error): BadRequestException | UnauthorizedRequestException | HttpException | ForbiddenRequestException;
+  static fromCode(code: number, data: Required<UnifiedResponse>, parent?: Error): BadRequestException | ForbiddenRequestException | UnauthorizedRequestException | HttpException;
 }
 //#endregion
 //#region src/Apis/BaseApi.d.ts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oapiex/sdk-kit",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A TypeScript Base for building SDKs using OpenAPI specifications extracted by OAPIEX.",
   "main": "./dist/index.cjs",
   "private": false,