upload-post 1.0.1 → 2.0.3

package/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: 'Dry run (no publish)'
+        required: true
+        default: true
+        type: boolean
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write  # Required for OIDC trusted publishing
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Update npm to latest
+        run: npm install -g npm@latest && npm --version
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build (if needed)
+        run: npm run build --if-present
+
+      - name: Publish to npm (dry-run)
+        if: ${{ inputs.dry_run == true }}
+        run: npm publish --access public --dry-run
+
+      - name: Publish to npm
+        if: ${{ inputs.dry_run != true }}
+        run: npm publish --access public --provenance

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Upload-Post
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,13 +1,8 @@
-# Upload-Post Node.js Client
+# Upload-Post SDK for Node.js
 
-Official client library for [Upload-Post](https://www.upload-post.com) API - cross-platform social media video upload.
+Official Node.js client for the [Upload-Post API](https://www.upload-post.com) - Cross-platform social media upload.
 
-## Features
-
-- 🚀 Simple video upload to multiple platforms
-- 🔒 Secure API key authentication
-- 📁 Supports all major video formats
-- 📝 Automatic form data handling
+Upload videos, photos, text posts, and documents to **TikTok, Instagram, YouTube, LinkedIn, Facebook, Pinterest, Threads, Reddit, Bluesky, and X (Twitter)** with a single API.
 
 ## Installation
 
@@ -15,43 +10,317 @@ Official client library for [Upload-Post](https://www.upload-post.com) API - cro
 npm install upload-post
 ```
 
-## Usage
+## Quick Start
 
 ```javascript
 import { UploadPost } from 'upload-post';
 
-const uploader = new UploadPost('your-api-key-here');
+const client = new UploadPost('YOUR_API_KEY');
+
+// Upload a video to multiple platforms
+const response = await client.upload('./video.mp4', {
+  title: 'Check out this awesome video! 🎬',
+  user: 'my-profile',
+  platforms: ['tiktok', 'instagram', 'youtube']
+});
+
+console.log(response);
+```
+
+## Features
+
+- ✅ **Video Upload** - TikTok, Instagram, YouTube, LinkedIn, Facebook, Pinterest, Threads, Bluesky, X
+- ✅ **Photo Upload** - TikTok, Instagram, LinkedIn, Facebook, Pinterest, Threads, Reddit, Bluesky, X
+- ✅ **Text Posts** - X, LinkedIn, Facebook, Threads, Reddit, Bluesky
+- ✅ **Document Upload** - LinkedIn (PDF, PPT, PPTX, DOC, DOCX)
+- ✅ **Scheduling** - Schedule posts for later
+- ✅ **Posting Queue** - Add posts to your configured queue
+- ✅ **First Comments** - Auto-post first comment after publishing
+- ✅ **Analytics** - Get engagement metrics
+- ✅ **Full TypeScript Support**
+
+## API Reference
+
+### Upload Video
+
+```javascript
+const response = await client.upload('./video.mp4', {
+  title: 'My awesome video',
+  user: 'my-profile',
+  platforms: ['tiktok', 'instagram', 'youtube'],
+  
+  // Optional: Schedule for later
+  scheduledDate: '2024-12-25T10:00:00Z',
+  timezone: 'Europe/Madrid',
+  
+  // Optional: Add first comment
+  firstComment: 'Thanks for watching! 🙏',
+  
+  // Optional: Platform-specific settings
+  tiktokPrivacyLevel: 'PUBLIC_TO_EVERYONE',
+  instagramMediaType: 'REELS',
+  youtubePrivacyStatus: 'public',
+  youtubeTags: ['tutorial', 'coding'],
+});
+```
+
+### Upload Photos
+
+```javascript
+// Upload single or multiple photos
+const response = await client.uploadPhotos(
+  ['./photo1.jpg', './photo2.jpg', 'https://example.com/photo3.jpg'],
+  {
+    title: 'Check out these photos! 📸',
+    user: 'my-profile',
+    platforms: ['instagram', 'facebook', 'x'],
+    
+    // Optional: Add to queue instead of posting immediately
+    addToQueue: true,
+    
+    // Platform-specific
+    instagramMediaType: 'IMAGE', // or 'STORIES'
+    facebookPageId: 'your-page-id',
+  }
+);
+```
+
+### Upload Text Posts
+
+```javascript
+const response = await client.uploadText({
+  title: 'Just shipped a new feature! 🚀 Check it out at example.com',
+  user: 'my-profile',
+  platforms: ['x', 'linkedin', 'threads'],
+  
+  // Optional: Create a poll on X
+  xPollOptions: ['Option A', 'Option B', 'Option C'],
+  xPollDuration: 1440, // 24 hours in minutes
+  
+  // Optional: Post to a LinkedIn company page
+  targetLinkedinPageId: 'company-page-id',
+});
+```
 
-// Upload video with options
-const result = await uploader.upload('/path/to/video.mp4', {
-  title: 'My Awesome Video',
-  user: 'test-user',
-  platforms: ['tiktok'] // Currently supported platforms
+### Upload Documents (LinkedIn)
+
+```javascript
+const response = await client.uploadDocument('./presentation.pdf', {
+  title: 'Q4 2024 Report',
+  user: 'my-profile',
+  description: 'Check out our latest quarterly results!',
+  linkedinVisibility: 'PUBLIC',
+  targetLinkedinPageId: 'company-page-id', // Optional: post to company page
 });
+```
 
-console.log('Upload successful:', result);
+### Check Upload Status
+
+For async uploads, check the status using the request_id:
+
+```javascript
+const status = await client.getStatus('request_id_from_upload');
+console.log(status);
 ```
 
-## API Documentation
+### Get Upload History
 
-### Constructor
-`new UploadPost(apiKey: string)`
+```javascript
+const history = await client.getHistory({ page: 1, limit: 20 });
+console.log(history.uploads);
+```
+
+### Scheduled Posts
+
+```javascript
+// List all scheduled posts
+const scheduled = await client.listScheduled();
+
+// Edit a scheduled post
+await client.editScheduled('job-id', {
+  scheduledDate: '2024-12-26T15:00:00Z',
+  timezone: 'America/New_York',
+});
+
+// Cancel a scheduled post
+await client.cancelScheduled('job-id');
+```
+
+### User Management
+
+```javascript
+// List all profiles
+const users = await client.listUsers();
 
-### upload()
-`upload(videoPath: string, options: UploadOptions): Promise<object>`
+// Create a new profile
+await client.createUser('new-profile');
 
-#### Options
-- `videoPath`: Path to video file (MP4, MOV, AVI, etc.)
-- `options.title`: Video title
-- `options.user`: User identifier
-- `options.platforms`: Array of target platforms (currently supports 'tiktok')
+// Delete a profile
+await client.deleteUser('old-profile');
+
+// Generate JWT for platform integration (white-label)
+const jwt = await client.generateJwt('my-profile', {
+  redirectUrl: 'https://yourapp.com/callback',
+  platforms: ['tiktok', 'instagram'],
+});
+```
+
+### Get Analytics
+
+```javascript
+const analytics = await client.getAnalytics('my-profile', {
+  platforms: ['instagram', 'tiktok'],
+});
+console.log(analytics);
+```
+
+### Helper Methods
+
+```javascript
+// Get Facebook pages for a profile
+const fbPages = await client.getFacebookPages('my-profile');
+
+// Get LinkedIn pages for a profile
+const liPages = await client.getLinkedinPages('my-profile');
+
+// Get Pinterest boards for a profile
+const boards = await client.getPinterestBoards('my-profile');
+```
+
+## Platform-Specific Options
+
+### TikTok (Video)
+- `tiktokPrivacyLevel` - PUBLIC_TO_EVERYONE, MUTUAL_FOLLOW_FRIENDS, FOLLOWER_OF_CREATOR, SELF_ONLY
+- `tiktokDisableDuet` - Disable duet
+- `tiktokDisableComment` - Disable comments
+- `tiktokDisableStitch` - Disable stitch
+- `tiktokCoverTimestamp` - Timestamp in ms for cover
+- `tiktokIsAigc` - AI-generated content flag
+- `tiktokPostMode` - DIRECT_POST or MEDIA_UPLOAD
+- `brandContentToggle` - Branded content toggle
+- `brandOrganicToggle` - Brand organic toggle
+
+### TikTok (Photos)
+- `tiktokAutoAddMusic` - Auto add music
+- `tiktokPhotoCoverIndex` - Index of photo for cover (0-based)
+- `tiktokDisableComment` - Disable comments
+
+### Instagram
+- `instagramMediaType` - REELS, STORIES, IMAGE
+- `instagramShareToFeed` - Share to feed (for Reels/Stories)
+- `instagramCollaborators` - Comma-separated collaborator usernames
+- `instagramCoverUrl` - Custom cover URL
+- `instagramAudioName` - Audio track name
+- `instagramUserTags` - Comma-separated user tags
+- `instagramLocationId` - Location ID
+- `instagramThumbOffset` - Thumbnail offset
+
+### YouTube
+- `youtubeTags` - Array or comma-separated tags
+- `youtubeCategoryId` - Category ID (default: "22" People & Blogs)
+- `youtubePrivacyStatus` - public, unlisted, private
+- `youtubeEmbeddable` - Allow embedding
+- `youtubeLicense` - youtube, creativeCommon
+- `youtubePublicStatsViewable` - Show public stats
+- `youtubeThumbnailUrl` - Custom thumbnail URL
+- `youtubeSelfDeclaredMadeForKids` - Made for kids (COPPA)
+- `youtubeContainsSyntheticMedia` - AI/synthetic content flag
+- `youtubeDefaultLanguage` - Title/description language (BCP-47)
+- `youtubeDefaultAudioLanguage` - Audio language (BCP-47)
+- `youtubeAllowedCountries` / `youtubeBlockedCountries` - Country restrictions
+- `youtubeHasPaidProductPlacement` - Paid placement flag
+- `youtubeRecordingDate` - Recording date (ISO 8601)
+
+### LinkedIn
+- `linkedinVisibility` - PUBLIC, CONNECTIONS, LOGGED_IN, CONTAINER
+- `targetLinkedinPageId` - Page ID for organization posts
+
+### Facebook
+- `facebookPageId` - Facebook Page ID (required)
+- `facebookVideoState` - PUBLISHED, DRAFT
+- `facebookMediaType` - REELS, STORIES
+- `facebookLinkUrl` - URL for text posts
+
+### Pinterest
+- `pinterestBoardId` - Board ID
+- `pinterestLink` - Destination link
+- `pinterestAltText` - Alt text for photos
+- `pinterestCoverImageUrl` - Cover image URL (video)
+- `pinterestCoverImageKeyFrameTime` - Key frame time in ms
+
+### X (Twitter)
+- `xReplySettings` - everyone, following, mentionedUsers, subscribers, verified
+- `xNullcast` - Promoted-only post
+- `xTaggedUserIds` - User IDs to tag
+- `xPlaceId` / `xGeoPlaceId` - Location place ID
+- `xQuoteTweetId` - Tweet ID to quote
+- `xPollOptions` - Poll options (2-4)
+- `xPollDuration` - Poll duration in minutes (5-10080)
+- `xForSuperFollowersOnly` - Exclusive for super followers
+- `xCommunityId` - Community ID
+- `xShareWithFollowers` - Share community post with followers
+- `xCardUri` - Card URI for Twitter Cards
+- `xLongTextAsPost` - Post long text as single post
+
+### Threads
+- `threadsLongTextAsPost` - Post long text as single post (vs thread)
+
+### Reddit
+- `redditSubreddit` - Subreddit name (without r/)
+- `redditFlairId` - Flair template ID
+
+## Common Options
+
+These options work across all upload methods:
+
+| Option | Description |
+|--------|-------------|
+| `title` | Post title/caption (required) |
+| `user` | Profile name (required) |
+| `platforms` | Target platforms array (required) |
+| `firstComment` | First comment to post |
+| `altText` | Alt text for accessibility |
+| `scheduledDate` | ISO date for scheduling |
+| `timezone` | Timezone for scheduled date |
+| `addToQueue` | Add to posting queue |
+| `asyncUpload` | Process asynchronously (default: true) |
+
+## TypeScript Support
+
+Full TypeScript support with comprehensive type definitions:
+
+```typescript
+import { UploadPost, UploadVideoOptions, UploadResponse } from 'upload-post';
+
+const client = new UploadPost('YOUR_API_KEY');
+
+const options: UploadVideoOptions = {
+  title: 'My video',
+  user: 'my-profile',
+  platforms: ['tiktok', 'instagram'],
+  tiktokPrivacyLevel: 'PUBLIC_TO_EVERYONE',
+};
+
+const response: UploadResponse = await client.upload('./video.mp4', options);
+```
 
 ## Error Handling
-The library throws errors for:
-- Missing required parameters
-- File not found
-- API request failures
-- Invalid platform specifications
+
+```javascript
+try {
+  const response = await client.upload('./video.mp4', options);
+  console.log('Upload successful:', response);
+} catch (error) {
+  console.error('Upload failed:', error.message);
+}
+```
+
+## Links
+
+- [Upload-Post Website](https://www.upload-post.com)
+- [API Documentation](https://docs.upload-post.com)
+- [Dashboard](https://app.upload-post.com)
 
 ## License
+
 MIT