@norahe/remotion-workflow 0.1.0 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norahe/remotion-workflow",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
   "description": "Workflow CLI for using Nora Remotion process in existing or new projects.",
   "bin": {

package/src/cli.mjs

@@ -2,7 +2,7 @@
 /**
  * [INPUT]: process args, filesystem state, and optional create-video scaffolding.
  * [OUTPUT]: initialized workflow guide files in an existing or newly created project.
- * [POS]: CLI entrypoint for @nora/remotion-workflow package.
+ * [POS]: CLI entrypoint for @norahe/remotion-workflow package.
  * [PROTOCOL]: update this header when code changes, then check AGENTS.md
  */
 
@@ -41,6 +41,183 @@ const writeIfMissing = (filePath, content) => {
   return true;
 };
 
+const upsertPackageJsonDependency = (projectDir, depName, version) => {
+  const packagePath = path.join(projectDir, 'package.json');
+  if (!fs.existsSync(packagePath)) return false;
+  const raw = fs.readFileSync(packagePath, 'utf8');
+  const pkg = JSON.parse(raw);
+  const inDeps = Boolean(pkg.dependencies?.[depName]);
+  const inDevDeps = Boolean(pkg.devDependencies?.[depName]);
+  if (inDeps || inDevDeps) return false;
+  pkg.dependencies = pkg.dependencies || {};
+  pkg.dependencies[depName] = version;
+  const sortedDeps = Object.keys(pkg.dependencies)
+    .sort((a, b) => a.localeCompare(b))
+    .reduce((acc, key) => {
+      acc[key] = pkg.dependencies[key];
+      return acc;
+    }, {});
+  pkg.dependencies = sortedDeps;
+  fs.writeFileSync(packagePath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8');
+  return true;
+};
+
+const buildStarterSchemaTs = () => {
+  return [
+    '/**',
+    ' * [INPUT]: zod runtime and Remotion props panel validation.',
+    ' * [OUTPUT]: starter schema for visual/audio/timing controls.',
+    ' * [POS]: Nora workflow starter schema for quick project bootstrapping.',
+    ' * [PROTOCOL]: update this header when code changes, then check AGENTS.md',
+    ' */',
+    '',
+    "import {z} from 'zod';",
+    '',
+    'export const starterSchema = z.object({',
+    '  visual: z.object({',
+    '    headingScalePct: z.number().int().min(80).max(130),',
+    '    bodyScalePct: z.number().int().min(80).max(130),',
+    '  }),',
+    '  audio: z.object({',
+    '    enableVoiceover: z.boolean(),',
+    '    enableMusic: z.boolean(),',
+    '    musicVolumePct: z.number().int().min(0).max(100),',
+    '    voiceVolumePct: z.number().int().min(0).max(200),',
+    '  }),',
+    '  timing: z.object({',
+    '    totalFrames: z.number().int().min(300).max(3600),',
+    '    scene1Frames: z.number().int().min(60).max(1800),',
+    '  }),',
+    '});',
+    '',
+    'export type StarterProps = z.infer<typeof starterSchema>;',
+  ].join('\n');
+};
+
+const buildStarterDefaultPropsTs = () => {
+  return [
+    '/**',
+    ' * [INPUT]: StarterProps type from starter schema.',
+    ' * [OUTPUT]: default props values for the starter composition.',
+    ' * [POS]: single source of truth for initial right-panel values.',
+    ' * [PROTOCOL]: update this header when code changes, then check AGENTS.md',
+    ' */',
+    '',
+    "import type {StarterProps} from './schema';",
+    '',
+    'export const starterDefaultProps: StarterProps = {',
+    '  visual: {',
+    '    headingScalePct: 100,',
+    '    bodyScalePct: 100,',
+    '  },',
+    '  audio: {',
+    '    enableVoiceover: true,',
+    '    enableMusic: true,',
+    '    musicVolumePct: 20,',
+    '    voiceVolumePct: 100,',
+    '  },',
+    '  timing: {',
+    '    totalFrames: 1800,',
+    '    scene1Frames: 360,',
+    '  },',
+    '};',
+  ].join('\n');
+};
+
+const buildStarterCompositionTsx = () => {
+  return [
+    '/**',
+    ' * [INPUT]: starter props from schema/defaultProps.',
+    ' * [OUTPUT]: minimal, editable scene proving controls are wired.',
+    ' * [POS]: first-touch composition for non-technical users in Studio.',
+    ' * [PROTOCOL]: update this header when code changes, then check AGENTS.md',
+    ' */',
+    '',
+    "import React from 'react';",
+    "import {AbsoluteFill, useCurrentFrame, interpolate} from 'remotion';",
+    "import type {StarterProps} from './schema';",
+    '',
+    'export const NoraWorkflowStarter: React.FC<StarterProps> = (props) => {',
+    '  const frame = useCurrentFrame();',
+    '  const fade = interpolate(frame, [0, 20], [0, 1], {extrapolateRight: "clamp"});',
+    '  const headingSize = 78 * (props.visual.headingScalePct / 100);',
+    '  const bodySize = 34 * (props.visual.bodyScalePct / 100);',
+    '',
+    '  return (',
+    '    <AbsoluteFill',
+    '      style={{',
+    "        background: 'radial-gradient(circle at 25% 20%, rgba(32,114,255,0.20), transparent 35%), #040c1d',",
+    "        color: '#f4f7ff',",
+    "        fontFamily: 'Inter, system-ui, sans-serif',",
+    "        opacity: fade,",
+    "        justifyContent: 'center',",
+    "        alignItems: 'center',",
+    "        textAlign: 'center',",
+    '      }}',
+    '    >',
+    '      <div style={{padding: "0 120px"}}>',
+    '        <h1 style={{fontSize: headingSize, margin: 0, lineHeight: 1.1}}>Nora Workflow Starter</h1>',
+    '        <p style={{fontSize: bodySize, marginTop: 24, opacity: 0.88}}>',
+    '          Edit props on the right panel: visual / audio / timing. This is your default schema.',
+    '        </p>',
+    '      </div>',
+    '    </AbsoluteFill>',
+    '  );',
+    '};',
+  ].join('\n');
+};
+
+const ensureStarterFiles = (projectDir) => {
+  const srcDir = path.join(projectDir, 'src');
+  const starterDir = path.join(srcDir, 'NoraWorkflow');
+  ensureDir(starterDir);
+  writeIfMissing(path.join(starterDir, 'schema.ts'), `${buildStarterSchemaTs()}\n`);
+  writeIfMissing(path.join(starterDir, 'defaultProps.ts'), `${buildStarterDefaultPropsTs()}\n`);
+  writeIfMissing(path.join(starterDir, 'StarterComposition.tsx'), `${buildStarterCompositionTsx()}\n`);
+};
+
+const ensureStarterInRoot = (projectDir) => {
+  const rootTsxPath = path.join(projectDir, 'src', 'Root.tsx');
+  if (!fs.existsSync(rootTsxPath)) return false;
+  const raw = fs.readFileSync(rootTsxPath, 'utf8');
+  if (raw.includes('NoraWorkflowStarter')) return false;
+
+  const importLines = [
+    "import {NoraWorkflowStarter} from './NoraWorkflow/StarterComposition';",
+    "import {starterSchema} from './NoraWorkflow/schema';",
+    "import {starterDefaultProps} from './NoraWorkflow/defaultProps';",
+  ];
+  let next = raw;
+
+  for (const line of importLines) {
+    if (!next.includes(line)) {
+      next = `${line}\n${next}`;
+    }
+  }
+
+  const compositionBlock = [
+    '      <Composition',
+    '        id="NoraWorkflow-Starter"',
+    '        component={NoraWorkflowStarter}',
+    '        durationInFrames={starterDefaultProps.timing.totalFrames}',
+    '        fps={30}',
+    '        width={1920}',
+    '        height={1080}',
+    '        schema={starterSchema}',
+    '        defaultProps={starterDefaultProps}',
+    '      />',
+  ].join('\n');
+
+  if (next.includes('</>')) {
+    next = next.replace('</>', `${compositionBlock}\n    </>`);
+  } else {
+    return false;
+  }
+
+  fs.writeFileSync(rootTsxPath, next, 'utf8');
+  return true;
+};
+
 const isRemotionProject = (cwd) => {
   const packagePath = path.join(cwd, 'package.json');
   const remotionConfigPathTs = path.join(cwd, 'remotion.config.ts');
@@ -80,7 +257,7 @@ const buildGuide = (projectName) => {
     `Project: ${projectName}`,
     '',
     '1) Prompt selection',
-    '- Open prompt browser: https://github.com/norahe0304-art/remotion-platform (see prompts app docs)',
+    '- Open prompt browser: https://prompts-mauve.vercel.app/app/',
     '- Copy either `Copy AI Template` (prompt-based) or `Copy Input Guide` (blank from scratch).',
     '',
     '2) Input location',
@@ -134,5 +311,14 @@ if (command !== 'init') {
 const projectName = getArgValue('--project-name');
 const cwd = process.cwd();
 const projectDir = createProjectIfNeeded(cwd, projectName);
+ensureStarterFiles(projectDir);
+const rootUpdated = ensureStarterInRoot(projectDir);
+const zodAdded = upsertPackageJsonDependency(projectDir, 'zod', '^3.25.76');
 ensureWorkflowFiles(projectDir);
+if (rootUpdated) {
+  console.log('[workflow] Added NoraWorkflow starter composition to src/Root.tsx');
+}
+if (zodAdded) {
+  console.log('[workflow] Added dependency: zod');
+}
 console.log(`[workflow] Done. Use project: ${projectDir}`);