@steerprotocol/sdk 0.1.4 → 1.0.0

package/dist/types/index.d.ts

@@ -1,4 +1,63 @@
+export * from './base/SmartRewards';
 export * from './client';
 export * from './types';
 export * from './const';
+export * from './const/subgraph';
+/**
+ * @packageDocumentation
+ *
+ * The Steer Protocol SDK provides a comprehensive interface for interacting with Steer Protocol's smart contracts and services.
+ *
+ * ## Key Features
+ *
+ * - Smart Rewards Management
+ * - Campaign Interactions
+ * - Claim Management
+ * - Multi-chain Support
+ *
+ * ## Quick Start
+ *
+ * ```typescript
+ * import { createClient, SmartRewards } from '@steerprotocol/sdk';
+ * import { createPublicClient, createWalletClient, http } from 'viem';
+ *
+ * // Initialize the clients
+ * const client = createClient();
+ * const publicClient = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ * const walletClient = createWalletClient({
+ *   chain: mainnet,
+ *   transport: http()
+ * });
+ *
+ * // Create SmartRewards instance
+ * class MySmartRewards extends SmartRewards {
+ *   constructor() {
+ *     super(client, publicClient, walletClient);
+ *   }
+ * }
+ *
+ * // Use SmartRewards functionality
+ * const rewards = new MySmartRewards();
+ *
+ * // Get user's reward summary
+ * const summary = await rewards.getRewardSummary(userAddress, chainId);
+ *
+ * // Claim rewards
+ * const tx = await rewards.claimCampaignRewards(userAddress, chainId);
+ * ```
+ *
+ * ## Smart Rewards
+ *
+ * The {@link SmartRewards} class provides comprehensive functionality for managing rewards:
+ *
+ * - View reward balances and claim history
+ * - Claim rewards across multiple campaigns
+ * - Track historical claims
+ * - Get comprehensive reward summaries
+ *
+ * See {@link SmartRewards} for detailed API documentation.
+ */
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steerprotocol/sdk",
-  "version": "0.1.4",
+  "version": "1.0.0",
   "description": "Steer Protocol SDK",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -25,7 +25,13 @@
     "lint": "eslint . --ext .ts",
     "format": "prettier --write \"src/**/*.ts\"",
     "prepare": "npm run build",
-    "prepack": "tsx src/scripts/processDeployments.ts"
+    "prepack": "tsx src/scripts/processDeployments.ts",
+    "docs": "typedoc --out docs --entryPoints src/index.ts src/client.ts src/base/SmartRewards.ts src/base/SubgraphClient.ts src/base/VaultClient.ts --name \"Steer Protocol SDK\" --readme README.md --excludePrivate --excludeProtected",
+    "docs:watch": "typedoc --out docs --entryPoints src/index.ts src/base/SmartRewards.ts src/generated/sdk.ts --name \"Steer Protocol SDK\" --readme README.md --excludePrivate --excludeProtected --plugin none --watch",
+    "docs:serve": "npx serve docs",
+    "commit": "git-cz",
+    "typecheck": "tsc --noEmit",
+    "check-all": "yarn typecheck && yarn lint"
   },
   "keywords": [
     "steer",
@@ -50,13 +56,27 @@
     "rimraf": "^5.0.5",
     "ts-jest": "^29.2.5",
     "tsx": "^4.19.2",
+    "typedoc": "^0.27.6",
     "typescript": "^5.3.3",
-    "viem": "^2.22.0"
+    "viem": "^2.22.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.3",
+    "@semantic-release/npm": "^11.0.1",
+    "semantic-release": "^22.0.8",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "commitizen": "^4.3.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "husky": "^8.0.3"
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@steerprotocol/api-sdk": "^1.0.2"
   }
 }