packagefox: Process 'Create SDK for Riverside API' [Issue #187]

[microfox-git]

Automated PR created from issue #187.

Request Type: pkg-create
Query: Create SDK for Riverside API
URL: https://docs.riverside.fm/

Notes:
Create an SDK for the Riverside.fm API.

Closes #187

[microfox-git]

Packagefox: Research Report

Step	Status	Details	Token Usage	Total Tokens
📝 generateMetadata	✅	API Name: Riverside Package: @microfox/riverside Auth Type: apikey Auth SDK: N/A	351 + 66 = 417	417
🔗 extractLinks	✅	Total Links: 20 Base URL: https://docs.riverside.fm/	-	-
🔍 analyzeLinks	✅	Useful Links: 14 Total Links: 20 Filtered Links: 14 Setup Instructions: Found	526 + 318 = 844	844
📄 extractContentFromUrls	✅	Successfully Extracted: 14 Failed URLs: 0 Total Content Length: 16.17 KB Average Content Length: 1.15 KB	-	-
📊 summarizeContent	✅	Summary Length: 4.44 KB Input Length: 17.24 KB Compression Ratio: 387.98% Saved at: /home/runner/work/microfox/microfox/packages/riverside/docSummary.md	5012 + 1202 = 6214	6214

---

Total Usage: Tokens: 392016 | Cost: $1.5600

[microfox-git]

Packagefox: Code Generation Report

Generated Files

File	Size (bytes)
src/RiversideSdk.ts	3207
src/types/index.ts	1350
src/schemas/index.ts	3571
src/index.ts	77

Setup Information

• Auth Type: apikey

• Setup Info: To use the Riverside SDK, you need to obtain an API key by contacting your Riverside customer success member. Once you have the API key, you can initialize the SDK like this:

import { createRiversideSDK } from '@microfox/riverside';

const riversideSDK = createRiversideSDK({
  apiKey: 'YOUR_API_KEY_HERE'
});

Make sure to keep your API key secure and never expose it in client-side code.

The SDK uses the native fetch API available in Node.js 20+. Ensure you're using a compatible Node.js version.

Rate Limiting:

• The SDK respects rate limits for each endpoint.
• Implement retry mechanisms with exponential backoff in your application logic if needed.

Error Handling:

• The SDK throws custom errors for various scenarios (network issues, API errors, etc.).
• Always wrap SDK calls in try-catch blocks to handle potential errors.

Pagination:

• For endpoints that support pagination, the SDK provides helper methods to iterate through pages.

File Downloads:

• The SDK provides methods to download media files and transcriptions.
• Handle the returned streams appropriately in your application.

API Versioning:

• The SDK uses different API versions (v1 and v2) for different endpoints as per the Riverside API.
• This is handled internally by the SDK, but be aware of potential differences in response structures.

---

Total Usage: Total Bytes: 8205 | Tokens: 419693 | Cost: $1.6824

[microfox-git]

Packagefox: Documentation Report

Step	Status	Details	Error
📝 generate	✅	Generated Docs: 5
✅ validate	✅	Total Tokens: 7608 Constructor Docs: 579 Functions Docs: 2 Env Keys: 0
💾 save	✅	constructor: createRiversideSDK functions: 2 envKeys: 0

---

Total Usage: Tokens: 427301 | Cost: $1.7117

[github-actions]

❌ Package Info Validation Failed

File: /home/runner/work/microfox/microfox/packages/riverside/package-info.json

The following issues were found:

• keyInstructions.link: Invalid url
• icon: The icon must be either a valid HTTPS URL or a valid path to an existing file in the repository

File: /home/runner/work/microfox/microfox/packages/coingecko-sdk/package-info.json

The following issues were found:

• keyInstructions.link: Invalid url

File: /home/runner/work/microfox/microfox/packages/amazon-rekognition-face-detection/package-info.json

The following issues were found:

• keyInstructions.link: Invalid url

Please fix these issues and update your PR.