@scalepad/sdk-lm 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,90 @@
+# @scalepad/sdk-lm
+
+Typed client for the ScalePad Lifecycle Manager API routes used by the ScalePad CLI.
+
+## Install
+
+```bash
+npm install @scalepad/sdk-lm
+```
+
+## Usage
+
+```ts
+import { createLifecycleManagerClient } from "@scalepad/sdk-lm";
+
+const client = createLifecycleManagerClient({
+  apiKey: process.env.SCALEPAD_API_KEY!
+});
+
+const actionItems = await client.listActionItems({ pageSize: 10 });
+console.log(actionItems.data);
+```
+
+## API
+
+The package exports a generated client plus a small convenience wrapper.
+
+Wrapper helpers:
+
+- `createLifecycleManagerClient(config)`
+- `ScalepadLifecycleManagerClient`
+- `listActionItems(query)`
+- `getActionItem(id)`
+
+Generated and schema exports:
+
+- `GeneratedLifecycleManagerClient`
+- `lifecycleManagerOperations`
+- `ScalepadLmApiError`
+- `paths`
+
+## Client configuration
+
+```ts
+type LifecycleManagerClientConfig = {
+  apiKey: string;
+  baseUrl?: string;
+  fetchImpl?: typeof fetch;
+  userAgent?: string;
+  maxRetries?: number;
+};
+```
+
+- `apiKey` is required and is sent as `x-api-key`
+- `baseUrl` defaults to `https://api.scalepad.com`
+- `fetchImpl` lets you inject a custom fetch implementation
+- `userAgent` defaults to `@scalepad/cli`
+- `maxRetries` controls retry attempts for `429` responses and defaults to `3`
+
+## List queries
+
+List endpoints accept this shared shape:
+
+```ts
+type ListQuery = {
+  cursor?: string;
+  pageSize?: number;
+  filters?: Record<string, string>;
+  sort?: string;
+};
+```
+
+Filters are translated to `filter[field]=expression` query parameters, and `pageSize` is translated to `page_size`.
+
+## Error handling
+
+Failed responses throw `ScalepadLmApiError`, which includes:
+
+- `status`: the HTTP status code
+- `payload`: the parsed response body when one is available
+
+## Development
+
+This package is generated from the checked-in OpenAPI spec in the monorepo root. To refresh or rebuild it:
+
+```bash
+pnpm fetch:specs
+pnpm generate:sdk
+pnpm --filter @scalepad/sdk-lm build
+```

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@scalepad/sdk-lm",
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "description": "Typed ScalePad Lifecycle Manager API client used by the ScalePad CLI.",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",