@editframe/cli 0.7.0-beta.8 → 0.8.0-beta.1

package/dist/VERSION.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "0.8.0-beta.1";

package/dist/VERSION.js

@@ -1,4 +1,4 @@
-const VERSION = "0.7.0-beta.8";
+const VERSION = "0.8.0-beta.1";
 export {
   VERSION
 };

package/dist/commands/auth.d.ts

@@ -0,0 +1,9 @@
+export interface APIOrgResult {
+    name: string;
+    id: string;
+    org_id: string;
+    created_at: unknown;
+    updated_at: unknown;
+    org_display_name: string;
+}
+export declare const getApiData: () => Promise<APIOrgResult>;

package/dist/commands/check.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/preview.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/process-file.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/process-file.js

@@ -0,0 +1,32 @@
+import { basename } from "node:path";
+import { program } from "commander";
+import { withSpinner } from "../utils/withSpinner.js";
+import { getClient } from "../utils/index.js";
+import { createReadStream } from "node:fs";
+import { createUnprocessedFile, uploadUnprocessedFile, updateUnprocessedFile } from "@editframe/api";
+import { md5FilePath } from "@editframe/assets";
+program.command("process-file <file>").description("Upload a audio/video to Editframe for processing.").action(async (path) => {
+  const client = getClient();
+  const fileId = await md5FilePath(path);
+  await withSpinner("Creating unprocessed file record", async () => {
+    await createUnprocessedFile(client, {
+      id: fileId,
+      processes: [],
+      filename: basename(path)
+    });
+  });
+  const readStream = createReadStream(path);
+  await withSpinner("Uploading file", async () => {
+    await uploadUnprocessedFile(client, fileId, readStream);
+  });
+  const unprocessedFile = await withSpinner(
+    "Marking for processing",
+    async () => {
+      return await updateUnprocessedFile(client, fileId, {
+        processes: ["isobmff"]
+      });
+    }
+  );
+  process.stderr.write("File uploaded and marked for processing.\n");
+  console.log(JSON.stringify(unprocessedFile, null, 2));
+});

package/dist/commands/process.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/render.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/render.js

@@ -1,20 +1,21 @@
 import path from "node:path";
 import { readFile, writeFile } from "node:fs/promises";
+import { inspect } from "node:util";
+import { PassThrough } from "node:stream";
 import * as tar from "tar";
 import { program, Option } from "commander";
 import { parse } from "node-html-parser";
 import { build } from "vite";
 import { md5Directory, md5FilePath } from "@editframe/assets";
 import { withSpinner } from "../utils/withSpinner.js";
+import { syncAssetDirectory } from "../operations/syncAssetsDirectory.js";
 import { createRender, uploadRender } from "@editframe/api";
 import { launchBrowserAndWaitForSDK } from "../utils/launchBrowserAndWaitForSDK.js";
 import { PreviewServer } from "../utils/startPreviewServer.js";
-import { PassThrough } from "node:stream";
-import { syncAssetDirectory } from "../operations/syncAssetsDirectory.js";
 import { getClient } from "../utils/index.js";
 import { getRenderInfo } from "../operations/getRenderInfo.js";
 import { processRenderInfo } from "../operations/processRenderInfo.js";
-import { inspect } from "node:util";
+import { validateVideoResolution } from "../utils/validateVideoResolution.js";
 const buildProductionUrl = async (origin, tagName, assetPath) => {
   const md5Sum = await md5FilePath(assetPath);
   const basename = path.basename(assetPath);
@@ -89,6 +90,10 @@ program.command("render [directory]").description(
     },
     async (page) => {
       const renderInfo = await page.evaluate(getRenderInfo);
+      validateVideoResolution({
+        width: renderInfo.width,
+        height: renderInfo.height
+      });
       await processRenderInfo(renderInfo);
       const doc = parse(
         await readFile(path.join(distDir, "index.html"), "utf-8")

package/dist/commands/sync.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1 @@
+

package/dist/index.js

@@ -7,6 +7,7 @@ import "./commands/sync.js";
 import "./commands/render.js";
 import "./commands/preview.js";
 import "./commands/process.js";
+import "./commands/process-file.js";
 import "./commands/check.js";
 program.name("editframe").addOption(new Option("-t, --token <token>", "API Token").env("EF_TOKEN")).addOption(
   new Option("--ef-host <host>", "Editframe Host").env("EF_HOST").default("https://editframe.dev")

package/dist/operations/getRenderInfo.d.ts

@@ -0,0 +1,15 @@
+/**
+ * THIS MODULE DOESNT USE THE DEBUG LOGGER BECAUSE IT IS
+ * RUN IN A WEB BROWSER. LOGS ARE CAPTURED AND RE-LOGGED.
+ */
+export declare const getRenderInfo: () => Promise<{
+    width: number;
+    height: number;
+    fps: number;
+    durationMs: number;
+    assets: {
+        efMedia: Record<string, any>;
+        efCaptions: string[];
+        efImage: string[];
+    };
+}>;

package/dist/operations/processRenderInfo.d.ts

@@ -0,0 +1,3 @@
+import { getRenderInfo } from './getRenderInfo.ts';
+
+export declare const processRenderInfo: (renderInfo: Awaited<ReturnType<typeof getRenderInfo>>) => Promise<void>;

package/dist/operations/syncAssetsDirectory.d.ts

@@ -0,0 +1 @@
+export declare const syncAssetDirectory: (projectDirectory: string) => Promise<void>;

package/dist/utils/attachWorkbench.d.ts

@@ -0,0 +1,3 @@
+import { Page } from 'playwright';
+
+export declare const attachWorkbench: (page: Page) => void;

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+import { Client } from '../../../api/src';
+
+export declare const getClient: () => Client;

package/dist/utils/launchBrowserAndWaitForSDK.d.ts

@@ -0,0 +1,10 @@
+import { Page } from 'playwright';
+
+interface LaunchOptions {
+    url: string;
+    headless?: boolean;
+    interactive?: boolean;
+    efInteractive?: boolean;
+}
+export declare function launchBrowserAndWaitForSDK(options: LaunchOptions, fn: (page: Page) => Promise<void>): Promise<void>;
+export {};

package/dist/utils/startDevServer.d.ts

@@ -0,0 +1,8 @@
+import { ViteDevServer } from 'vite';
+
+export declare class DevServer {
+    private devServer;
+    static start(directory: string): Promise<DevServer>;
+    constructor(devServer: ViteDevServer);
+    get url(): string;
+}

package/dist/utils/startPreviewServer.d.ts

@@ -0,0 +1,8 @@
+import { ViteDevServer } from 'vite';
+
+export declare class PreviewServer {
+    private previewServer;
+    static start(directory: string): Promise<PreviewServer>;
+    constructor(previewServer: ViteDevServer);
+    get url(): string;
+}

package/dist/utils/validateVideoResolution.d.ts

@@ -0,0 +1,9 @@
+type VideoPayload = {
+    width: number;
+    height: number;
+};
+export declare const validateVideoResolution: (rawPayload: VideoPayload) => Promise<{
+    width: number;
+    height: number;
+}>;
+export {};

package/dist/utils/validateVideoResolution.js

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import ora from "ora";
+import debug from "debug";
+const log = debug("ef:cli:validateVideoResolution");
+const schema = z.object({
+  width: z.number().int(),
+  height: z.number().int()
+}).refine((data) => data.width % 2 === 0, {
+  message: "Width must be divisible by 2",
+  path: ["width"]
+}).refine((data) => data.height % 2 === 0, {
+  message: "Height must be divisible by 2"
+});
+const validateVideoResolution = async (rawPayload) => {
+  const spinner = ora("Validating video resolution").start();
+  const result = schema.safeParse(rawPayload);
+  if (result.success) {
+    spinner.succeed("Video resolution is valid");
+    return result.data;
+  }
+  spinner.fail("Invalid video resolution");
+  process.stderr.write(result.error?.errors.map((e) => e.message).join("\n"));
+  process.stderr.write("\n");
+  log("Error:", result.error?.errors.map((e) => e.message).join("\n"));
+  process.exit(1);
+};
+export {
+  validateVideoResolution
+};

package/dist/utils/withSpinner.d.ts

@@ -0,0 +1 @@
+export declare const withSpinner: <T extends unknown>(label: string, fn: () => Promise<T>) => Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/cli",
-  "version": "0.7.0-beta.8",
+  "version": "0.8.0-beta.1",
   "description": "Command line interface for EditFrame",
   "bin": {
     "editframe": "./dist/index.js"
@@ -15,17 +15,18 @@
   "license": "UNLICENSED",
   "devDependencies": {
     "@types/dom-webcodecs": "^0.1.11",
-    "@types/node": "^20.14.9",
+    "@types/node": "^20.14.13",
     "@types/promptly": "^3.0.5",
     "@types/tar": "^6.1.13",
+    "typescript": "^5.5.4",
     "vite-plugin-dts": "^3.9.1",
     "vite-tsconfig-paths": "^4.3.2"
   },
   "dependencies": {
-    "@editframe/api": "0.7.0-beta.8",
-    "@editframe/assets": "0.7.0-beta.8",
-    "@editframe/elements": "0.7.0-beta.8",
-    "@editframe/vite-plugin": "0.7.0-beta.8",
+    "@editframe/api": "0.8.0-beta.1",
+    "@editframe/assets": "0.8.0-beta.1",
+    "@editframe/elements": "0.8.0-beta.1",
+    "@editframe/vite-plugin": "0.8.0-beta.1",
     "axios": "^1.6.8",
     "chalk": "^5.3.0",
     "commander": "^12.0.0",
@@ -41,7 +42,6 @@
     "promptly": "^3.2.0",
     "tailwindcss": "^3.4.3",
     "tar": "^7.1.0",
-    "typescript": "^5.2.2",
     "vite": "^5.2.11",
     "zod": "^3.23.8"
   }

package/src/commands/auth.ts

@@ -3,7 +3,7 @@ import ora from "ora";
 import chalk from "chalk";
 import debug from "debug";
 
-import { getClient } from "../utils";
+import { getClient } from "../utils/index.ts";
 
 const log = debug("ef:cli:auth");
 

package/src/commands/process-file.ts

@@ -0,0 +1,50 @@
+import { basename } from "node:path";
+
+import { program } from "commander";
+
+import { withSpinner } from "../utils/withSpinner.ts";
+
+import { getClient } from "../utils/index.ts";
+import { createReadStream } from "node:fs";
+import {
+  createUnprocessedFile,
+  updateUnprocessedFile,
+  uploadUnprocessedFile,
+} from "@editframe/api";
+import { md5FilePath } from "@editframe/assets";
+
+program
+  .command("process-file <file>")
+  .description("Upload a audio/video to Editframe for processing.")
+  .action(async (path: string) => {
+    const client = getClient();
+
+    const fileId = await md5FilePath(path);
+
+    await withSpinner("Creating unprocessed file record", async () => {
+      await createUnprocessedFile(client, {
+        id: fileId,
+        processes: [],
+        filename: basename(path),
+      });
+    });
+
+    const readStream = createReadStream(path);
+
+    await withSpinner("Uploading file", async () => {
+      await uploadUnprocessedFile(client, fileId, readStream);
+    });
+
+    const unprocessedFile = await withSpinner(
+      "Marking for processing",
+      async () => {
+        return await updateUnprocessedFile(client, fileId, {
+          processes: ["isobmff"],
+        });
+      },
+    );
+
+    process.stderr.write("File uploaded and marked for processing.\n");
+
+    console.log(JSON.stringify(unprocessedFile, null, 2));
+  });

package/src/commands/process.ts

@@ -3,11 +3,11 @@ import path from "node:path";
 
 import { program } from "commander";
 
-import { withSpinner } from "../utils/withSpinner";
-import { launchBrowserAndWaitForSDK } from "../utils/launchBrowserAndWaitForSDK";
-import { PreviewServer } from "../utils/startPreviewServer";
-import { getRenderInfo } from "../operations/getRenderInfo";
-import { processRenderInfo } from "../operations/processRenderInfo";
+import { withSpinner } from "../utils/withSpinner.ts";
+import { launchBrowserAndWaitForSDK } from "../utils/launchBrowserAndWaitForSDK.ts";
+import { PreviewServer } from "../utils/startPreviewServer.ts";
+import { getRenderInfo } from "../operations/getRenderInfo.ts";
+import { processRenderInfo } from "../operations/processRenderInfo.ts";
 
 program
   .command("process [directory]")

package/src/commands/render.ts

@@ -1,5 +1,7 @@
 import path from "node:path";
 import { readFile, writeFile } from "node:fs/promises";
+import { inspect } from "node:util";
+import { PassThrough } from "node:stream";
 
 import * as tar from "tar";
 import { program, Option } from "commander";
@@ -8,16 +10,15 @@ import { build } from "vite";
 
 import { md5Directory, md5FilePath } from "@editframe/assets";
 
-import { withSpinner } from "../utils/withSpinner";
+import { withSpinner } from "../utils/withSpinner.ts";
+import { syncAssetDirectory } from "../operations/syncAssetsDirectory.ts";
 import { createRender, uploadRender } from "@editframe/api";
-import { launchBrowserAndWaitForSDK } from "../utils/launchBrowserAndWaitForSDK";
-import { PreviewServer } from "../utils/startPreviewServer";
-import { PassThrough } from "node:stream";
-import { syncAssetDirectory } from "../operations/syncAssetsDirectory";
-import { getClient } from "../utils";
-import { getRenderInfo } from "../operations/getRenderInfo";
-import { processRenderInfo } from "../operations/processRenderInfo";
-import { inspect } from "node:util";
+import { launchBrowserAndWaitForSDK } from "../utils/launchBrowserAndWaitForSDK.ts";
+import { PreviewServer } from "../utils/startPreviewServer.ts";
+import { getClient } from "../utils/index.ts";
+import { getRenderInfo } from "../operations/getRenderInfo.ts";
+import { processRenderInfo } from "../operations/processRenderInfo.ts";
+import { validateVideoResolution } from "../utils/validateVideoResolution.ts";
 
 interface StrategyBuilder {
   buildProductionUrl: (tagName: string, assetPath: string) => Promise<string>;
@@ -114,6 +115,12 @@ program
       },
       async (page) => {
         const renderInfo = await page.evaluate(getRenderInfo);
+
+        validateVideoResolution({
+          width: renderInfo.width,
+          height: renderInfo.height,
+        });
+
         await processRenderInfo(renderInfo);
 
         const doc = parseHTML(

package/src/commands/sync.ts

@@ -1,5 +1,5 @@
 import { program } from "commander";
-import { syncAssetDirectory } from "../operations/syncAssetsDirectory";
+import { syncAssetDirectory } from "../operations/syncAssetsDirectory.ts";
 
 program
   .command("sync")

package/src/operations/processRenderInfo.ts

@@ -3,7 +3,7 @@ import {
   cacheImage,
   findOrCreateCaptions,
 } from "@editframe/assets";
-import type { getRenderInfo } from "./getRenderInfo";
+import type { getRenderInfo } from "./getRenderInfo.ts";
 
 export const processRenderInfo = async (
   renderInfo: Awaited<ReturnType<typeof getRenderInfo>>,

package/src/operations/syncAssetsDirectory.ts

@@ -15,7 +15,7 @@ import {
 
 import { createReadStream } from "node:fs";
 import type { z } from "zod";
-import { getClient } from "../utils";
+import { getClient } from "../utils/index.ts";
 
 const imageMatch = /\.(png|jpe?g|gif|webp)$/i;
 const trackMatch = /\.track-[\d]+.mp4$/i;

package/src/utils/launchBrowserAndWaitForSDK.ts

@@ -2,7 +2,7 @@ import chalk from "chalk";
 import { type Browser, type Page, chromium } from "playwright";
 import debug from "debug";
 
-import { withSpinner } from "./withSpinner";
+import { withSpinner } from "./withSpinner.ts";
 
 const browserLog = debug("ef:cli::browser");
 

package/src/utils/startDevServer.ts

@@ -5,7 +5,7 @@ import tailwindcss from "tailwindcss";
 
 import { vitePluginEditframe as editframe } from "@editframe/vite-plugin";
 
-import { withSpinner } from "./withSpinner";
+import { withSpinner } from "./withSpinner.ts";
 
 export class DevServer {
   static async start(directory: string) {

package/src/utils/startPreviewServer.ts

@@ -3,7 +3,7 @@ import path from "node:path";
 
 import { vitePluginEditframe as editframe } from "@editframe/vite-plugin";
 
-import { withSpinner } from "./withSpinner";
+import { withSpinner } from "./withSpinner.ts";
 
 export class PreviewServer {
   static async start(directory: string) {

package/src/utils/validateVideoResolution.ts

@@ -0,0 +1,36 @@
+import { z } from "zod";
+import ora from "ora";
+import debug from "debug";
+
+const log = debug("ef:cli:validateVideoResolution");
+
+type VideoPayload = {
+  width: number;
+  height: number;
+};
+
+const schema = z
+  .object({
+    width: z.number().int(),
+    height: z.number().int(),
+  })
+  .refine((data) => data.width % 2 === 0, {
+    message: "Width must be divisible by 2",
+    path: ["width"],
+  })
+  .refine((data) => data.height % 2 === 0, {
+    message: "Height must be divisible by 2",
+  });
+export const validateVideoResolution = async (rawPayload: VideoPayload) => {
+  const spinner = ora("Validating video resolution").start();
+  const result = schema.safeParse(rawPayload);
+  if (result.success) {
+    spinner.succeed("Video resolution is valid");
+    return result.data;
+  }
+  spinner.fail("Invalid video resolution");
+  process.stderr.write(result.error?.errors.map((e) => e.message).join("\n"));
+  process.stderr.write("\n");
+  log("Error:", result.error?.errors.map((e) => e.message).join("\n"));
+  process.exit(1);
+};

package/dist/VERSION.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const VERSION = "0.7.0-beta.8";
-exports.VERSION = VERSION;

package/dist/commands/auth.cjs

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const commander = require("commander");
-const ora = require("ora");
-const chalk = require("chalk");
-const debug = require("debug");
-const index = require("../utils/index.cjs");
-const log = debug("ef:cli:auth");
-const getApiData = async () => {
-  const response = await index.getClient().authenticatedFetch("/api/org");
-  return response.json();
-};
-const authCommand = commander.program.command("auth").description("Fetch organization data using API token").action(async () => {
-  const options = authCommand.opts();
-  log("Options:", options);
-  const spinner = ora("Loading...").start();
-  try {
-    const apiData = await getApiData();
-    spinner.succeed("You are authenticated! 🎉");
-    process.stderr.write(chalk.green(`Name: ${apiData.name}
-`));
-    process.stderr.write(
-      chalk.green(`Welcome to ${apiData.org_display_name}!
-`)
-    );
-  } catch (error) {
-    spinner.fail("Authentication failed!");
-    process.stderr.write(error?.message);
-    process.stderr.write("\n");
-    log("Error:", error);
-  }
-});
-exports.getApiData = getApiData;

package/dist/commands/check.cjs

@@ -1,115 +0,0 @@
-"use strict";
-const node_child_process = require("node:child_process");
-const os = require("node:os");
-const commander = require("commander");
-const ora = require("ora");
-const chalk = require("chalk");
-const checks = {
-  ffmpeg: {
-    message: () => {
-      const platform = os.platform();
-      const message = [
-        "Processing assets for <ef-video>, <ef-audio>, <ef-captions>, and <ef-waveform>\n elements requires ffmpeg to be installed."
-      ];
-      switch (platform) {
-        case "darwin": {
-          message.push(
-            "On platform=darwin you can install ffmpeg using Homebrew:"
-          );
-          message.push(" - brew install ffmpeg");
-          message.push(
-            "Or you can download ffmpeg from https://ffmpeg.org/download.html"
-          );
-          break;
-        }
-        case "linux": {
-          message.push(
-            "You can install ffmpeg using your distribution's package manager."
-          );
-          break;
-        }
-        case "win32": {
-          message.push(
-            "You can download ffmpeg from https://ffmpeg.org/download.html"
-          );
-          message.push(
-            "You can use package managers like Chocolatey or Scoop to install ffmpeg."
-          );
-          message.push(" - choco install ffmpeg-full");
-          message.push(" - scoop install ffmpeg");
-          message.push(" - winget install ffmpeg");
-          break;
-        }
-        default: {
-          message.push(`Unrecognized platform ${platform}`);
-          message.push(
-            "You can download ffmpeg from https://ffmpeg.org/download.html"
-          );
-          message.push(
-            "Or try installing it from your operating system's package manager"
-          );
-          break;
-        }
-      }
-      return message;
-    },
-    check: async () => {
-      return new Promise((resolve, reject) => {
-        node_child_process.exec("ffmpeg -version", (error, stdout, _stderr) => {
-          if (error) {
-            reject(error);
-            return;
-          }
-          resolve(stdout);
-        });
-      });
-    }
-  },
-  whisper_timestamped: {
-    message: () => {
-      const message = [
-        "<ef-captions> Requires whisper_timestamped to be installed."
-      ];
-      message.push("whisper_timestamped depends on python3");
-      message.push(" - pip3 install whisper_timestamped");
-      message.push("Alternate installation instructions are availble at:");
-      message.push(
-        "https://github.com/linto-ai/whisper-timestamped#installation"
-      );
-      return message;
-    },
-    check: async () => {
-      return new Promise((resolve, reject) => {
-        node_child_process.exec(
-          "whisper_timestamped --version",
-          (error, stdout, _stderr) => {
-            if (error) {
-              reject(error);
-              return;
-            }
-            resolve(stdout);
-          }
-        );
-      });
-    }
-  }
-};
-commander.program.command("check").description("Check on dependencies and other requirements").action(async () => {
-  for (const checkName in checks) {
-    const check = checks[checkName];
-    if (!check) {
-      continue;
-    }
-    const spinner = ora(`Checking ${checkName}`).start();
-    try {
-      await check.check();
-      spinner.succeed(
-        chalk.white.bgGreen(` Check for ${checkName} passed  `)
-      );
-    } catch (error) {
-      spinner.fail(chalk.white.bgRed(`  Check for ${checkName} failed  `));
-      process.stderr.write(chalk.red(check.message().join("\n\n")));
-      process.stderr.write("\n");
-    }
-  }
-});