open-index/open-npm huggingface dataset:
npm package: @microfox/twitter
Description: Twitter/X V2 SDK for Microfox
Latest version: 1.4.0

# Microfox X SDK

A lightweight, type-safe SDK for interacting with the X (Twitter) API v2

## Installation

```bash
npm install @microfox/twitter
```

## Environment Variables

The following environment variables are used by this SDK:

- `X_API_KEY`: Your X API key. (Required)
- `X_API_SECRET`: Your X API secret key. (Required)
- `X_ACCESS_TOKEN`: Your X access token. (Required)
- `X_ACCESS_SECRET`: Your X access token secret. (Required)

## Additional Information

Use the `createXSDK` constructor to create a new X client.

The SDK supports both v2 API endpoints for tweets and users.

Media uploads are supported through the v1.1 API endpoint.

## API Reference

For detailed documentation on the constructor and all available functions, see:

- [createXSDK](./docs/createXSDK.md)
- [create](./docs/create.md)
- [get](./docs/get.md)
- [getMultiple](./docs/getMultiple.md)
- [delete](./docs/delete.md)
- [getByUsername](./docs/getByUsername.md)
- [getByUsernames](./docs/getByUsernames.md)
- [getById](./docs/getById.md)
- [getByIds](./docs/getByIds.md)
- [getMe](./docs/getMe.md)
- [upload](./docs/upload.md)
- [generateOAuthHeader](./docs/generateOAuthHeader.md)
npm package: @microfox/types
Description: General Required Types for Agents
Latest version: 1.2.0

# Types

<!-- Add your project description here -->

A TypeScript SDK for Types.

## Installation

\`\`\`bash
npm install @microfox/types
\`\`\`

## Quick Start

\`\`\`typescript
import { TypesSdk } from '@microfox/types';

// Initialize the SDK
const sdk = new TypesSdk({
apiKey: 'your-api-key',
// Add other config options
});

// Example usage
const result = await sdk.hello('World');
console.log(result.data);
\`\`\`

## Configuration

\`\`\`typescript
interface TypesSdkConfig {
apiKey: string; // Required: Your API key
baseUrl?: string; // Optional: Custom base URL
name?: string; // Optional: SDK instance name
version?: string; // Optional: API version
}
\`\`\`

## Methods

### hello(name: string)

Example method - replace with your own API methods.

\`\`\`typescript
const result = await sdk.hello('World');
// Returns: { data: "Hello, World!", success: true, status: 200, message: "Success" }
\`\`\`

<!--
## TODO: Add your API documentation here

### getData(id: string)
\`\`\`typescript
const data = await sdk.getData('123');
\`\`\`

### createItem(item: object)
\`\`\`typescript
const result = await sdk.createItem({ name: 'Example' });
\`\`\`
-->

## Development

\`\`\`bash

# Install dependencies

npm install

# Build the project

npm run build

# Run tests

npm test

# Lint code

npm run lint
\`\`\`

## License

MIT
npm package: @microfox/usage-tracker
Description: A TypeScript SDK for Tracking Usage of any LLM and TypeScript AI SDK internally.
Latest version: 0.3.0

# Microfox Usage Tracker

A powerful usage tracking system for Microfox AI that enables tracking of LLM and API usage across your applications.

## Features

- Track LLM usage (tokens, models)
- Track API usage (request counts, data)
- Daily, monthly, and yearly usage reports
- Redis-based storage with Upstash
- TypeScript support with full type safety
- Environment variable configuration

## Installation

```bash
npm install @microfox/usage-tracker
```

## Configuration

The usage tracker requires Redis configuration. You can provide this either through environment variables or constructor options:

### Environment Variables

```env
MICROFOX_REDIS_URL_TRACKER=your_redis_url
MICROFOX_REDIS_TOKEN_TRACKER=your_redis_token
MICROFOX_CLIENT_REQUEST_ID=your_client_id
```

### Constructor Options

```typescript
interface UsageTrackerConstructorOptions {
  redisOptions?: {
    url: string;
    token: string;
  };
  prefix?: string;
}
```

## Supported Usage Types

### 1. LLM Usage

Track language model usage including:

- Model identifier
- Prompt tokens
- Completion tokens
- Optional markup percentage

```typescript
interface LLMUsage {
  type: 'llm';
  model?: string;
  promptTokens: number;
  completionTokens: number;
}
```

### 2. API Usage

Track API usage including:

- Request key
- Request count
- Optional request data size
- Optional markup percentage

```typescript
interface API1Usage {
  type: 'api_1';
  requestKey?: string;
  requestCount: number;
  requestData?: number;
}
```

## Usage Examples

### Basic Setup

```typescript
import { createMicrofoxUsageTracker } from '@microfox/usage-tracker';

const tracker = createMicrofoxUsageTracker({
  redisOptions: {
    url: 'your_redis_url',
    token: 'your_redis_token',
  },
});
```

### Tracking LLM Usage

```typescript
await tracker.trackLLMUsage('my-package', 'gpt-4', {
  promptTokens: 100,
  completionTokens: 50,
});
```

### Tracking API Usage

```typescript
await tracker.trackApi1Usage('my-package', 'api-key', {
  requestCount: 1,
  requestData: 1024,
});
```

### Retrieving Usage Data

```typescript
// Get today's usage
const dailyUsage = await tracker.getDailyUsage();

// Get monthly usage
const monthlyUsage = await tracker.getMonthlyUsage();

// Get yearly usage
const yearlyUsage = await tracker.getYearlyUsage();

// Get usage for specific package
const packageUsage = await tracker.getDailyUsage('my-package');
```

## Environment Variables for Package-Specific Tracking

For each package you want to track, you can set these environment variables:

```env
PACKAGE_NAME_SECRET_TRACKING=markup
PACKAGE_NAME_SECRET_MARKUP_PERCENT=10
```

Replace `PACKAGE_NAME` with your actual package name (converted to uppercase with hyphens/spaces replaced by underscores).

## License

MIT

**See the [github repo](https://github.com/microfox-ai/microfox) or [docs](https://microfox.so) for more info.**
npm package: @microfox/veo-on-vertex-ai
Description: A TypeScript SDK for interacting with the Veo API on Google Cloud's Vertex AI platform.
Latest version: 1.2.0

# Veo on Vertex AI SDK

A TypeScript SDK for interacting with the Veo API on Google Cloud's Vertex AI platform.

## Installation

```bash
npm install @microfox/veo-on-vertex-ai
```

## Environment Variables

To use this package, you need to set the following environment variables:

- `GOOGLE_CLOUD_PROJECT`: Your Google Cloud project ID. This is required to identify the project to use for Vertex AI services. ** (Required)**
- `GOOGLE_CLOUD_LOCATION`: The Google Cloud location for your Vertex AI resources (e.g., 'us-central1'). This is required to specify the regional endpoint for the API. ** (Required)**

## API Reference

For detailed documentation on the constructor and all available functions, please refer to the following files:

- [**VeoonVertexAIAPISdk** (Constructor)](./docs/VeoonVertexAIAPISdk.md): Initializes the client.
- [createVeoonVertexAIAPISDK](./docs/createVeoonVertexAIAPISDK.md)
- [fetchOperationStatus](./docs/fetchOperationStatus.md)
- [generateVideo](./docs/generateVideo.md)
- [pollOperation](./docs/pollOperation.md)