twitter-developer-api 2.5.3 → 2.7.0

package/scripts/release-guard/policy.mjs

@@ -1,223 +0,0 @@
-/** Each entry: path (relative to root) + extractor returning the version string. */
-function parseJsonVersion(raw) {
-  return JSON.parse(raw).version;
-}
-
-export const versionSurfaces = [
-  { path: "server.json", get: parseJsonVersion },
-  { path: "openclaw.plugin.json", get: parseJsonVersion },
-  { path: ".codex-plugin/plugin.json", get: parseJsonVersion },
-  { path: ".claude-plugin/plugin.json", get: parseJsonVersion },
-  {
-    path: ".claude-plugin/marketplace.json",
-    get: (j) => {
-      const m = JSON.parse(j);
-      return [m.metadata?.version, ...(m.plugins ?? []).map((p) => p.version)];
-    },
-  },
-  {
-    path: "skills/x-twitter-scraper/metadata.json",
-    get: parseJsonVersion,
-  },
-  {
-    path: "skills/x-twitter-scraper/SKILL.md",
-    get: (t) => {
-      const match = /^\s*version:\s*"([^"]+)"/m.exec(t);
-      return match?.[1];
-    },
-  },
-  {
-    path: "stub-server.mjs",
-    get: (t) => /version:\s*"([^"]+)"/.exec(t)?.[1],
-  },
-];
-
-export const skillFrontmatterExpectations = {
-  scalars: {
-    author: "Xquik <support@xquik.com>",
-    compatibility:
-      "Requires internet access to call the first-party Xquik REST API.",
-    "metadata.author": "Xquik",
-    "metadata.capabilities.network.allowed": true,
-    "metadata.capabilities.shell.allowed": false,
-    "metadata.capabilities.filesystem.read": false,
-    "metadata.capabilities.filesystem.write": false,
-    "metadata.capabilities.mcp.allowed": true,
-    "metadata.capabilities.mcp.transport": "native-http-or-oauth-only",
-    "metadata.capabilities.codeExecution.allowed": false,
-    "metadata.capabilities.localNetwork.allowed": false,
-    "metadata.openclaw.primaryEnv": "XQUIK_API_KEY",
-    "metadata.openclaw.homepage": "https://docs.xquik.com",
-    "metadata.security.credentialsHandledByAgent": "api-key-only",
-    "metadata.security.credentialsTransmitted": "xquik-api-key-only",
-    "metadata.security.xLoginSecretsHandled": false,
-    "metadata.security.passwordsCollected": false,
-    "metadata.security.totpCollected": false,
-    "metadata.security.sessionCookiesCollected": false,
-    "metadata.security.contentIsolation": "enforced",
-    "metadata.security.inputValidation": "enforced",
-    "metadata.security.outputSanitization": "enforced",
-    "metadata.security.writeConfirmation": "required",
-    "metadata.security.persistentResourceConfirmation": "required",
-    "metadata.security.accountChangeExecution": false,
-    "metadata.security.autonomousPlanChanges": false,
-    "metadata.security.planChanges": "dashboard-only",
-    "metadata.security.creditChanges": "dashboard-only",
-    "metadata.security.mcpTransport": "native-http-or-oauth-only",
-    "metadata.security.thirdPartyContentIsolation": "explicit-boundary-markers",
-    "metadata.security.executionModel": "api-only",
-    "metadata.security.codeExecution": "none",
-    "metadata.security.localFileAccess": "none",
-    "metadata.security.localNetworkAccess": "none",
-    "metadata.security.auditLogging": "enabled",
-    "metadata.security.rateLimiting": "per-method-tier",
-    "metadata.security.usageConfirmation": "required",
-    "metadata.security.securityReference": "references/security.md",
-  },
-  arrays: {
-    tags: ["twitter", "x", "social-media", "api-development", "scraping"],
-    "metadata.capabilities.network.hosts": ["xquik.com", "docs.xquik.com"],
-    "metadata.capabilities.environment.required": ["XQUIK_API_KEY"],
-    "metadata.capabilities.environment.optional": ["XQUIK_WEBHOOK_SECRET"],
-    "metadata.openclaw.requires.env": ["XQUIK_API_KEY"],
-    "metadata.security.allowedHosts": ["xquik.com", "docs.xquik.com"],
-  },
-  enums: {
-    "metadata.security.contentTrust": ["mixed"],
-  },
-};
-
-export const taskGuideFrontmatterExpectations = {
-  scalars: {
-    "metadata.internal": true,
-    "metadata.author": "Xquik",
-    "metadata.openclaw.primaryEnv": "XQUIK_API_KEY",
-    "metadata.openclaw.homepage": "https://docs.xquik.com",
-    "metadata.security.contentIsolation": "enforced",
-    "metadata.security.promptInjectionDefense": true,
-    "metadata.security.writeConfirmation": "required",
-    "metadata.security.usageConfirmation": "required",
-    "metadata.security.planChanges": "dashboard-only",
-    "metadata.security.creditChanges": "dashboard-only",
-    "metadata.security.executionModel": "api-only",
-    "metadata.security.codeExecution": "none",
-    "metadata.security.credentialProxy": false,
-  },
-  arrays: {
-    "metadata.openclaw.requires.env": ["XQUIK_API_KEY"],
-  },
-  enums: {
-    "metadata.security.contentTrust": ["trusted", "mixed", "untrusted"],
-  },
-};
-
-export const manifestReferences = [
-  [".codex-plugin/plugin.json", "skills"],
-  [".codex-plugin/plugin.json", "mcpServers"],
-  [".codex-plugin/plugin.json", "interface.composerIcon"],
-  [".claude-plugin/plugin.json", "skills"],
-  [".claude-plugin/plugin.json", "mcpServers"],
-  ["openclaw.plugin.json", "skills"],
-];
-
-export const jsonFieldExpectations = [
-  {
-    path: "package.json",
-    fields: {
-      name: "x-developer",
-      "author.name": "Xquik",
-      "author.url": "https://docs.xquik.com",
-      homepage: "https://docs.xquik.com",
-      license: "MIT",
-      "repository.url": "git+https://github.com/Xquik-dev/x-twitter-scraper.git",
-      "bugs.url": "https://github.com/Xquik-dev/x-twitter-scraper/issues",
-    },
-  },
-  {
-    path: "openclaw.plugin.json",
-    fields: {
-      id: "x-developer",
-      name: "X Developer API",
-      "skills.0": "./skills",
-      "providerAuthEnvVars.xquik.0": "XQUIK_API_KEY",
-      "uiHints.apiKey.sensitive": true,
-      "configSchema.additionalProperties": false,
-    },
-  },
-  {
-    path: ".codex-plugin/plugin.json",
-    fields: {
-      name: "x-twitter-scraper",
-      "author.name": "Xquik",
-      homepage: "https://docs.xquik.com",
-      repository: "https://github.com/Xquik-dev/x-twitter-scraper",
-      license: "MIT",
-      skills: "./skills/",
-      mcpServers: "./.mcp.json",
-      "interface.developerName": "Xquik",
-      "interface.websiteURL": "https://docs.xquik.com",
-      "interface.privacyPolicyURL": "https://xquik.com/privacy",
-      "interface.termsOfServiceURL": "https://xquik.com/terms",
-    },
-  },
-  {
-    path: ".claude-plugin/plugin.json",
-    fields: {
-      name: "x-twitter-scraper",
-      "author.name": "Xquik",
-      homepage: "https://docs.xquik.com",
-      repository: "https://github.com/Xquik-dev/x-twitter-scraper",
-      license: "MIT",
-      skills: "./skills/",
-      mcpServers: "./.mcp.json",
-      "userConfig.api_key.sensitive": true,
-    },
-  },
-  {
-    path: ".claude-plugin/marketplace.json",
-    fields: {
-      name: "x-twitter-scraper",
-      "owner.name": "Xquik",
-      "owner.email": "support@xquik.com",
-      "plugins.0.name": "x-twitter-scraper",
-      "plugins.0.homepage": "https://docs.xquik.com",
-      "plugins.0.repository": "https://github.com/Xquik-dev/x-twitter-scraper",
-      "plugins.0.license": "MIT",
-    },
-  },
-  {
-    path: "server.json",
-    fields: {
-      name: "com.xquik/mcp",
-      title: "Xquik MCP Server",
-      "repository.url": "https://github.com/Xquik-dev/x-twitter-scraper",
-      "repository.source": "github",
-      websiteUrl: "https://docs.xquik.com/mcp/overview",
-      "remotes.0.type": "streamable-http",
-      "remotes.0.url": "https://xquik.com/mcp",
-    },
-  },
-  {
-    path: "skills/x-twitter-scraper/metadata.json",
-    fields: {
-      organization: "Xquik",
-      homepage: "https://docs.xquik.com",
-      repository: "https://github.com/Xquik-dev/x-twitter-scraper",
-      license: "MIT",
-      "security.defaultMode": "read-only-public-data",
-      "security.localExecution": false,
-      "security.localFileAccess": false,
-      "security.localNetworkAccess": false,
-      "security.untrustedContentBoundaries": true,
-    },
-  },
-];
-
-export const markdownRoots = [
-  ".github",
-  "commands",
-  "docker-mcp-registry",
-  "mcpize",
-  "skills",
-  "task-guides",
-];

package/skills/x-twitter-scraper/references/api-endpoints-api-keys.md

@@ -1,31 +0,0 @@
-# Xquik REST API Endpoints: API Keys
-
-Session auth only. These endpoints do not accept API key auth.
-
-### Create API Key
-
-```
-POST /api-keys
-```
-
-**Body:** `{ "name": "My Key" }` (optional)
-
-**Response:** Returns `fullKey` (shown only once), `prefix`, `name`, `id`, `createdAt`.
-
-### List API Keys
-
-```
-GET /api-keys
-```
-
-Returns all keys with `id`, `name`, `prefix`, `isActive`, `createdAt`, `lastUsedAt`. Full key is never exposed.
-
-### Revoke API Key
-
-```
-delete request to `/api-keys/{id}`
-```
-
-Permanent and irreversible. The key stops working immediately.
-
----

package/skills/x-twitter-scraper/references/api-endpoints-compose.md

@@ -1,33 +0,0 @@
-# Xquik REST API Endpoints: Compose
-
-### Compose Tweet
-
-```
-POST /compose
-```
-
-Compose, refine, and score tweets with Xquik style signals. Three-step workflow.
-
-**Body:**
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `step` | string | Yes | `compose`, `refine`, or `score` |
-| `topic` | string | No | Tweet topic (compose, refine) |
-| `goal` | string | No | `engagement`, `followers`, `authority`, `conversation` |
-| `styleUsername` | string | No | Cached style username for voice matching (compose) |
-| `tone` | string | No | Desired tone (refine) |
-| `additionalContext` | string | No | Extra context or URLs (refine) |
-| `callToAction` | string | No | Desired CTA (refine) |
-| `mediaType` | string | No | `photo`, `video`, `none` (refine) |
-| `draft` | string | No | Tweet text to evaluate (score) |
-| `hasLink` | boolean | No | Link attached (score) |
-| `hasMedia` | boolean | No | Media attached (score) |
-
-**Response (step=compose):** Returns `contentRules`, `scorerWeights`, `followUpQuestions`, `algorithmInsights`, `engagementMultipliers`, `topPenalties`.
-
-**Response (step=refine):** Returns `compositionGuidance`, `examplePatterns`.
-
-**Response (step=score):** Returns `totalChecks`, `passedCount`, `topSuggestion`, `checklist[]` with `factor`, `passed`, `suggestion`.
-
----

package/skills/x-twitter-scraper/references/api-endpoints-credits.md

@@ -1,11 +0,0 @@
-# Xquik REST API Endpoints: Credits
-
-### Get Credit Balance
-
-```
-GET /credits
-```
-
-Get credit balance and lifetime usage fields. Plan and credit changes are dashboard-only and intentionally omitted from this installable skill.
-
----

package/skills/x-twitter-scraper/references/api-endpoints-drafts.md

@@ -1,86 +0,0 @@
-# Xquik REST API Endpoints: Drafts
-
-### Create Draft
-
-`POST /drafts`
-
-Save a tweet draft for later.
-
-**Request body:**
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `text` | string | Yes | The draft tweet text |
-| `topic` | string | No | Topic the tweet is about |
-| `goal` | string | No | Optimization goal: `engagement`, `followers`, `authority`, `conversation` |
-
-**Response (201):**
-
-```json
-{
-  "id": "123",
-  "text": "draft text",
-  "topic": "product launch",
-  "goal": "engagement",
-  "createdAt": "2026-02-24T10:30:00.000Z",
-  "updatedAt": "2026-02-24T10:30:00.000Z"
-}
-```
-
----
-
-### List Drafts
-
-`GET /drafts`
-
-List saved tweet drafts with cursor pagination.
-
-**Query parameters:**
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| `limit` | number | No | 50 | Results per page (max 50) |
-| `afterCursor` | string | No | - | Pagination cursor from previous response |
-
-**Response (200):**
-
-```json
-{
-  "drafts": [
-    {
-      "id": "123",
-      "text": "draft text",
-      "topic": "product launch",
-      "goal": "engagement",
-      "createdAt": "2026-02-24T10:30:00.000Z",
-      "updatedAt": "2026-02-24T10:30:00.000Z"
-    }
-  ],
-  "afterCursor": "cursor_string",
-  "hasMore": true
-}
-```
-
----
-
-### Get Draft
-
-`GET /drafts/{id}`
-
-Get a specific draft by ID.
-
-**Response (200):** Single draft object.
-
-**Errors:** `400 invalid_id`, `404 draft_not_found`
-
----
-
-### Delete Draft
-
-delete request to `/drafts/{id}`
-
-Delete a draft. Returns `204 No Content`.
-
-**Errors:** `400 invalid_id`, `404 draft_not_found`
-
----

package/skills/x-twitter-scraper/references/api-endpoints-draws.md

@@ -1,75 +0,0 @@
-# Xquik REST API Endpoints: Draws
-
-### Create Draw
-
-```
-POST /draws
-```
-
-Run a giveaway draw from a tweet. Picks random winners from replies.
-
-**Body:**
-```json
-{
-  "tweetUrl": "https://x.com/user/status/1893456789012345678",
-  "winnerCount": 3,
-  "backupCount": 2,
-  "uniqueAuthorsOnly": true,
-  "mustRetweet": true,
-  "mustFollowUsername": "burakbayir",
-  "filterMinFollowers": 100,
-  "filterAccountAgeDays": 30,
-  "filterLanguage": "en",
-  "requiredKeywords": ["giveaway"],
-  "requiredHashtags": ["#contest"],
-  "requiredMentions": ["@xquik"]
-}
-```
-
-All filter fields are optional. Only `tweetUrl` is required.
-
-**Response:**
-```json
-{
-  "id": "42",
-  "tweetId": "1893456789012345678",
-  "tweetUrl": "https://x.com/user/status/1893456789012345678",
-  "tweetText": "Like & RT to enter! Picking 3 winners tomorrow.",
-  "tweetAuthorUsername": "xquik",
-  "tweetLikeCount": 4200,
-  "tweetRetweetCount": 1800,
-  "tweetReplyCount": 1500,
-  "tweetQuoteCount": 120,
-  "status": "completed",
-  "totalEntries": 1500,
-  "validEntries": 890,
-  "createdAt": "2026-02-24T10:00:00.000Z",
-  "drawnAt": "2026-02-24T10:01:00.000Z"
-}
-```
-
-### List Draws
-
-```
-GET /draws
-```
-
-Cursor-paginated. Returns compact draw objects.
-
-### Get Draw
-
-```
-GET /draws/{id}
-```
-
-Returns full draw details including winners.
-
-### Export Draw
-
-```
-GET /draws/{id}/export?format=csv&type=winners
-```
-
-Formats: `csv`, `json`, `md`, `md-document`, `pdf`, `txt`, `xlsx`. Types: `winners` (default), `entries`. Entry exports capped at 100,000 rows (PDF capped at 10,000).
-
----

package/skills/x-twitter-scraper/references/api-endpoints-error-codes.md

@@ -1,37 +0,0 @@
-# Xquik REST API Endpoints: Error Codes
-
-| Status | Code | Meaning |
-|--------|------|---------|
-| 400 | `invalid_input` | Request body failed validation |
-| 400 | `invalid_id` | Path parameter is not a valid ID |
-| 400 | `invalid_json` | Invalid JSON in request body |
-| 400 | `invalid_tweet_url` | Tweet URL format is invalid |
-| 400 | `invalid_tweet_id` | Tweet ID is empty or invalid |
-| 400 | `invalid_username` | X username is empty or invalid |
-| 400 | `invalid_tool_type` | Extraction tool type not recognized |
-| 400 | `invalid_format` | Export format not `csv`, `json`, `md`, `md-document`, `pdf`, `txt`, or `xlsx` |
-| 400 | `invalid_params` | Export query parameters are missing or invalid |
-| 400 | `missing_query` | Required query parameter is missing |
-| 400 | `missing_params` | Required query parameters are missing |
-| 400 | `no_media` | Tweet has no downloadable media |
-| 400 | `webhook_inactive` | Webhook is disabled (test-webhook only) |
-| 401 | `unauthenticated` | Missing or invalid API key |
-| 403 | `account_needs_reauth` | X account session expired; use dashboard re-auth flow |
-| 402 | `no_subscription` | No active plan |
-| 402 | `subscription_inactive` | Plan is not active |
-| 402 | `no_credits` | No credit balance record exists |
-| 402 | `insufficient_credits` | Credit balance is too low |
-| 403 | `api_key_limit_reached` | API key limit reached (100 max) |
-| 404 | `not_found` | Resource does not exist |
-| 404 | `user_not_found` | X user not found |
-| 404 | `tweet_not_found` | Tweet not found |
-| 404 | `style_not_found` | No cached style found |
-| 404 | `draft_not_found` | Draft not found |
-| 409 | `monitor_already_exists` | Duplicate monitor for same username |
-| 422 | `login_failed` | Account connection failed; use dashboard re-auth flow |
-| 429 | - | Rate limited. Retry with backoff |
-| 429 | `x_api_rate_limited` | X data source rate limited. Retry |
-| 500 | `internal_error` | Server error |
-| 502 | `stream_registration_failed` | Stream registration failed. Retry |
-| 502 | `x_api_unavailable` | X data source temporarily unavailable |
-| 502 | `x_api_unauthorized` | X data source authentication failed. Retry |

package/skills/x-twitter-scraper/references/api-endpoints-events.md

@@ -1,48 +0,0 @@
-# Xquik REST API Endpoints: Events
-
-### List Events
-
-```
-GET /events
-```
-
-**Query parameters:**
-
-| Param | Type | Description |
-|-------|------|-------------|
-| `monitorId` | string | Filter by monitor ID |
-| `eventType` | string | Filter by event type |
-| `limit` | number | Results per page (1-100, default 50) |
-| `after` | string | Cursor for next page |
-
-**Response:**
-```json
-{
-  "events": [
-    {
-      "id": "9010",
-      "type": "tweet.new",
-      "monitorId": "7",
-      "username": "elonmusk",
-      "occurredAt": "2026-02-24T16:45:00.000Z",
-      "data": {
-        "tweetId": "1893556789012345678",
-        "text": "Hello world",
-        "metrics": { "likes": 3200, "retweets": 890, "replies": 245 }
-      }
-    }
-  ],
-  "hasMore": true,
-  "nextCursor": "MjAyNi0wMi0yNFQxNjozMDowMC4wMDBa..."
-}
-```
-
-### Get Event
-
-```
-GET /events/{id}
-```
-
-Returns a single event with full details.
-
----

package/skills/x-twitter-scraper/references/api-endpoints-extractions.md

@@ -1,97 +0,0 @@
-# Xquik REST API Endpoints: Extractions
-
-### Create Extraction
-
-```
-POST /extractions
-```
-
-Run a bulk data extraction job. See `references/extractions.md` for all 23 tool types.
-
-**Body:**
-```json
-{
-  "toolType": "reply_extractor",
-  "targetTweetId": "1893704267862470862",
-  "resultsLimit": 500
-}
-```
-
-`resultsLimit` (optional): Maximum results to extract. Stops early instead of fetching all data. Useful for controlling usage.
-
-**Tweet Search Filters** (`tweet_search_extractor` only):
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `fromUser` | string | Author username |
-| `toUser` | string | Directed to user |
-| `mentioning` | string | Mentions user |
-| `language` | string | Language code (e.g., `en`) |
-| `sinceDate` | string | Start date (YYYY-MM-DD) |
-| `untilDate` | string | End date (YYYY-MM-DD) |
-| `mediaType` | string | `images`, `videos`, `gifs`, or `media` |
-| `minFaves` | number | Minimum likes |
-| `minRetweets` | number | Minimum retweets |
-| `minReplies` | number | Minimum replies |
-| `verifiedOnly` | boolean | Verified authors only |
-| `replies` | string | `include`, `exclude`, or `only` |
-| `retweets` | string | `include`, `exclude`, or `only` |
-| `exactPhrase` | string | Exact match text |
-| `excludeWords` | string | Comma-separated words to exclude |
-| `advancedQuery` | string | Raw X search operators appended to query |
-
-These filters are converted to X search operators and combined with `searchQuery`.
-
-**Response:**
-```json
-{
-  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
-  "toolType": "reply_extractor",
-  "status": "running"
-}
-```
-
-### Estimate Extraction
-
-```
-POST /extractions/estimate
-```
-
-Preview usage before running. Same body as create.
-
-**Response:**
-```json
-{
-  "allowed": true,
-  "creditsAvailable": "50000",
-  "creditsRequired": "150",
-  "source": "replyCount",
-  "estimatedResults": 150
-}
-```
-
-### List Extractions
-
-```
-GET /extractions
-```
-
-Cursor-paginated. Filter by `status` and `toolType`.
-
-### Get Extraction
-
-```
-GET /extractions/{id}
-```
-
-Returns job details with paginated results (up to 1,000 per page).
-
-### Export Extraction
-
-```
-GET /extractions/{id}/export?format=csv
-```
-
-Formats: `csv`, `json`, `md`, `md-document`, `pdf`, `txt`, `xlsx`. 100,000 row limit (PDF 10,000). Exports include enrichment columns not in the API response.
-
----