vidjutsu 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,139 @@
+# vidjutsu
+
+TypeScript SDK for the [VidJutsu](https://vidjutsu.ai) video intelligence API.
+
+Watch, extract, transcribe, and overlay — fully typed, auto-generated from the [OpenAPI spec](https://raw.githubusercontent.com/tfcbot/vidjutsu-openapi/main/openapi/spec.json).
+
+## Install
+
+```bash
+npm install vidjutsu
+```
+
+## Get your API key
+
+```bash
+curl -fsSL https://vidjutsu.ai/install.sh | bash
+vidjutsu subscribe --email you@example.com
+```
+
+Your key saves to `~/.vidjutsu/config.json` automatically. The SDK reads it from there — no extra setup needed.
+
+## Quick start
+
+```ts
+import { createClient } from "vidjutsu";
+
+const vj = createClient();
+
+// Watch — AI analyzes a video and answers your prompt (10 credits)
+const { data: watch } = await vj.watchMedia({
+  mediaUrl: "https://cdn.example.com/video.mp4",
+  prompt: "Is the hook strong enough for fitness TikTok?",
+});
+console.log(watch.response);
+
+// Extract — pull frames, audio, and metadata (5 credits)
+const { data: extract } = await vj.extractMedia({
+  mediaUrl: "https://cdn.example.com/video.mp4",
+  frames: "auto",
+  audio: true,
+});
+console.log(extract.frames, extract.metadata);
+
+// Transcribe — speech-to-text with word-level timing (10 credits)
+const { data: transcript } = await vj.transcribeMedia({
+  mediaUrl: "https://cdn.example.com/video.mp4",
+});
+console.log(transcript.transcript, transcript.words);
+
+// Overlay — burn text onto video (5 credits)
+const { data: overlay } = await vj.createOverlay({
+  videoUrl: "https://cdn.example.com/video.mp4",
+  text: "Follow for more tips",
+  position: "bottom",
+});
+console.log(overlay.resultUrl);
+```
+
+## Authentication
+
+The client resolves your API key in this order:
+
+1. **Explicit** — `createClient({ apiKey: "vj_live_..." })`
+2. **Environment variable** — `VIDJUTSU_API_KEY`
+3. **Config file** — `~/.vidjutsu/config.json` (written by `vidjutsu auth`)
+
+```ts
+// Reads from env or config file
+const vj = createClient();
+
+// Or pass explicitly
+const vj = createClient({ apiKey: "vj_live_..." });
+
+// Custom base URL
+const vj = createClient({ baseUrl: "https://staging.api.vidjutsu.ai" });
+```
+
+## All methods
+
+### Video intelligence (paid)
+
+| Method | Credits | Description |
+|--------|---------|-------------|
+| `watchMedia(body)` | 10 | AI watches a video/image and answers your prompt |
+| `extractMedia(body)` | 5 | Extract frames, audio, and metadata from video |
+| `transcribeMedia(body)` | 10 | Speech-to-text with word-level timing |
+| `checkSpec(body)` | 5 | Validate a VidLang spec against rules |
+| `createOverlay(body)` | 5 | Burn text overlay onto video |
+
+### Resources (free)
+
+| Method | Description |
+|--------|-------------|
+| `createAccount(body)` / `updateAccount(body, query)` / `listOrGetAccounts(query)` / `deleteAccount(query)` | Manage accounts |
+| `createPost(body)` / `updatePost(body, query)` / `listOrGetPosts(query)` / `deletePost(query)` | Manage posts |
+| `createAsset(body)` / `updateAsset(body, query)` / `listOrGetAssets(query)` / `deleteAsset(query)` | Manage assets |
+| `createReference(body)` / `updateReference(body, query)` / `listOrGetReferences(query)` / `deleteReference(query)` | Manage references |
+| `uploadFile(body)` / `uploadFromUrl(body)` | Upload media to CDN |
+| `getBalance()` | Check credit balance |
+
+### Utilities (free)
+
+| Method | Description |
+|--------|-------------|
+| `getInfo()` | API info and endpoint discovery |
+| `getPricing()` | Current pricing |
+| `createCheckout(body)` | Create Stripe checkout session |
+| `getCheckoutStatus(query)` | Check checkout status |
+| `createSubscription(body)` | Subscribe ($99/mo) |
+| `rotateApiKey()` | Rotate API key (invalidates current key) |
+| `recoverApiKey(body)` | Recover key via email |
+
+## Raw client
+
+Every method returns the `openapi-fetch` response shape: `{ data, error, response }`. For endpoints not covered by convenience methods, use the raw client:
+
+```ts
+const { data, error } = await vj.api.GET("/v1/balance");
+const { data, error } = await vj.api.POST("/v1/watch", {
+  body: { mediaUrl: "...", prompt: "..." },
+});
+```
+
+## Credits & billing
+
+- **$99/month** — 1,000 credits included
+- **Extra credits** — $0.10 each
+- No overage charges — API returns 402 when credits run out
+
+## Links
+
+- [Documentation](https://docs.vidjutsu.ai)
+- [API Reference](https://docs.vidjutsu.ai/api-reference/introduction)
+- [CLI](https://github.com/tfcbot/vidjutsu-cli)
+- [OpenAPI Spec](https://raw.githubusercontent.com/tfcbot/vidjutsu-openapi/main/openapi/spec.json)
+
+## License
+
+MIT

package/dist/client.d.ts

@@ -28,7 +28,7 @@ export type VidJutsuClient = VidJutsuMethods & {
  * const { data } = await vj.transcribeMedia({ mediaUrl: 'https://...' });
  *
  * // Raw openapi-fetch (escape hatch):
- * const { data } = await vj.api.GET('/v1/balance');
+ * const { data } = await vj.api.GET('/v1/usage');
  * ```
  */
 export declare function createClient(config?: VidJutsuConfig): VidJutsuClient;

package/dist/client.js

@@ -30,7 +30,7 @@ function readConfigFile() {
  * const { data } = await vj.transcribeMedia({ mediaUrl: 'https://...' });
  *
  * // Raw openapi-fetch (escape hatch):
- * const { data } = await vj.api.GET('/v1/balance');
+ * const { data } = await vj.api.GET('/v1/usage');
  * ```
  */
 export function createClient(config = {}) {

package/dist/methods.d.ts

@@ -38,16 +38,14 @@ export interface VidJutsuMethods {
     confirmVerification(body: ReqBody<"/v1/auth/verify/confirm", "post">): ReturnType<Client["POST"]>;
     /** Request email verification code Public endpoint. */
     requestVerification(body: ReqBody<"/v1/auth/verify/request", "post">): ReturnType<Client["POST"]>;
-    /** Get credit balance Auth required. */
-    getBalance(): ReturnType<Client["GET"]>;
+    /** Get daily usage and rate limits */
+    getUsage(): ReturnType<Client["GET"]>;
     /** Check spec Auth required. 5 credits. */
     checkSpec(body: ReqBody<"/v1/check", "post">): ReturnType<Client["POST"]>;
     /** Get check rules Auth required. */
     getCheckRules(): ReturnType<Client["GET"]>;
     /** Update check rules Auth required. */
     updateCheckRules(body: ReqBody<"/v1/check/rules", "put">): ReturnType<Client["PUT"]>;
-    /** Create checkout session Public endpoint. */
-    createCheckout(body: ReqBody<"/v1/credits", "post">): ReturnType<Client["POST"]>;
     /** Check checkout status Public endpoint. */
     getCheckoutStatus(query?: QueryParams<"/v1/credits/status", "get">): ReturnType<Client["GET"]>;
     /** Extract from media Auth required. 5 credits. */

package/dist/methods.js

@@ -36,8 +36,8 @@ export function bindMethods(client) {
         requestVerification(body) {
             return client.POST("/v1/auth/verify/request", { body });
         },
-        getBalance() {
-            return client.GET("/v1/balance", {});
+        getUsage() {
+            return client.GET("/v1/usage", {});
         },
         checkSpec(body) {
             return client.POST("/v1/check", { body });
@@ -48,9 +48,6 @@ export function bindMethods(client) {
         updateCheckRules(body) {
             return client.PUT("/v1/check/rules", { body });
         },
-        createCheckout(body) {
-            return client.POST("/v1/credits", { body });
-        },
         getCheckoutStatus(query) {
             return client.GET("/v1/credits/status", { params: { query } });
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vidjutsu",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK for the VidJutsu video intelligence API",
   "type": "module",
   "main": "./dist/index.js",