create-pdf-forge 1.0.0-canary.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# create-pdf-forge
+
+## 1.0.0-canary.0
+
+### Major Changes
+
+- 5900266: first push

package/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2024 Plus Five Five, Inc
+Copyright 2025 ahmedrowaihi (fork modifications)
+
+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/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "create-pdf-forge",
+  "version": "1.0.0-canary.0",
+  "description": "The easiest way to get started with React PDF",
+  "main": "src/index.js",
+  "type": "module",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^13.0.0",
+    "fs-extra": "^11.1.1",
+    "log-symbols": "^7.0.0",
+    "ora": "^8.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ahmedrowaihi/react-pdf-forge.git",
+    "directory": "packages/create-pdf"
+  },
+  "keywords": [
+    "react",
+    "pdf"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "bin": {
+    "create-pdf-forge": "src/index.js"
+  },
+  "devDependencies": {
+    "nypm": "0.6.0",
+    "react": "^19",
+    "typescript": "5.8.3",
+    "@ahmedrowaihi/pdf-forge-components": "1.0.0-canary.0",
+    "tsconfig": "1.0.0-canary.0"
+  },
+  "scripts": {
+    "test": "vitest run"
+  }
+}

package/src/index.js

@@ -0,0 +1,104 @@
+#!/usr/bin/env node
+
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Command } from 'commander';
+import fse from 'fs-extra';
+import logSymbols from 'log-symbols';
+import ora from 'ora';
+import { tree } from './tree.js';
+
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+
+const packageJson = JSON.parse(
+  fse.readFileSync(path.resolve(dirname, '../package.json'), 'utf8'),
+);
+
+const getLatestVersionOfTag = async (packageName, tag) => {
+  const response = await fetch(
+    `https://registry.npmjs.org/${packageName}/${tag}`,
+  );
+  const data = await response.json();
+
+  if (typeof data === 'string' && data.startsWith('version not found')) {
+    console.error(`Tag ${tag} does not exist for ${packageName}.`);
+    process.exit(1);
+  }
+
+  const { version } = data;
+
+  if (!/^\d+\.\d+\.\d+.*$/.test(version)) {
+    console.error('Invalid version received, something has gone very wrong.');
+  }
+
+  return version;
+};
+
+const init = async (name, { tag }) => {
+  let projectPath = name;
+
+  if (!projectPath) {
+    projectPath = path.join(process.cwd(), 'react-pdf-starter');
+  }
+
+  if (typeof projectPath === 'string') {
+    projectPath = projectPath.trim();
+  }
+
+  const templatePath = path.resolve(dirname, '../template');
+  const resolvedProjectPath = path.resolve(projectPath);
+
+  if (fse.existsSync(resolvedProjectPath)) {
+    console.error(`Project called ${projectPath} already exists!`);
+    process.exit(1);
+  }
+
+  const spinner = ora({
+    text: 'Preparing files...\n',
+  }).start();
+
+  fse.copySync(templatePath, resolvedProjectPath, {
+    recursive: true,
+  });
+  const templatePackageJsonPath = path.resolve(
+    resolvedProjectPath,
+    './package.json',
+  );
+  const templatePackageJson = fse.readFileSync(templatePackageJsonPath, 'utf8');
+  fse.writeFileSync(
+    templatePackageJsonPath,
+    templatePackageJson
+      .replace(
+        'INSERT_COMPONENTS_VERSION',
+        await getLatestVersionOfTag('@ahmedrowaihi/pdf-forge-components', tag),
+      )
+      .replaceAll(
+        'INSERT_REACT_PDF_VERSION',
+        await getLatestVersionOfTag('@ahmedrowaihi/pdf-forge-cli', tag),
+      ),
+    'utf8',
+  );
+
+  spinner.stopAndPersist({
+    symbol: logSymbols.success,
+    text: 'React PDF Starter files ready',
+  });
+
+  console.info(
+    await tree(resolvedProjectPath, 4, (dirent) => {
+      return !path
+        .join(dirent.parentPath, dirent.name)
+        .includes('node_modules');
+    }),
+  );
+};
+
+new Command()
+  .name(packageJson.name)
+  .version(packageJson.version)
+  .description('The easiest way to get started with React PDF')
+  .arguments('[dir]', 'Path to initialize the project')
+  .option('-t, --tag <tag>', 'Tag of React PDF versions to use', 'latest')
+  .action(init)
+  .parse(process.argv);

package/template/README.md

@@ -0,0 +1,63 @@
+# React PDF Starter
+
+This is a starter template for React PDF Render.
+
+## Getting Started
+
+1. Install dependencies:
+
+   ```sh
+   pnpm install
+   # or
+   npm install
+   # or
+   yarn install
+   ```
+
+2. Start the development server:
+
+   ```sh
+   pnpm dev
+   # or
+   npm run dev
+   # or
+   yarn dev
+   ```
+
+3. Open http://localhost:3000 in your browser
+
+## Creating Templates
+
+Add your PDF templates in the `templates/` directory. Each template should be a React component that exports a default function.
+
+Example:
+
+```tsx
+import { Document, Body } from '@ahmedrowaihi/pdf-forge-components';
+
+export default function MyTemplate() {
+  return (
+    <Document>
+      <Body>
+        <h1>Hello World</h1>
+      </Body>
+    </Document>
+  );
+}
+```
+
+## Building Templates
+
+To export all templates as HTML:
+
+```sh
+pnpm export
+# or
+npm run export
+# or
+yarn export
+```
+
+## Learn More
+
+Visit [react-pdf-forge.com](https://react-pdf-forge.com) for documentation.

package/template/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "react-pdf-forge-starter",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "build": "pdf-dev build",
+    "dev": "pdf-dev dev",
+    "export": "pdf-dev export"
+  },
+  "dependencies": {
+    "@ahmedrowaihi/pdf-forge-components": "INSERT_COMPONENTS_VERSION",
+    "react-dom": "^19",
+    "react": "^19"
+  },
+  "devDependencies": {
+    "@ahmedrowaihi/pdf-forge-preview": "INSERT_REACT_PDF_VERSION",
+    "@ahmedrowaihi/pdf-forge-cli": "INSERT_REACT_PDF_VERSION",
+    "@types/react": "^19",
+    "@types/react-dom": "^19"
+  }
+}

package/template/templates/welcome.tsx

@@ -0,0 +1,107 @@
+import { Body, Document } from '@ahmedrowaihi/pdf-forge-components';
+
+export interface WelcomeProps {
+  name?: string;
+}
+
+function Welcome({ name = 'World' }: WelcomeProps) {
+  const cssStyles = `
+    :root {
+      --color-bg: #ffffff;
+      --color-text: #000000;
+      --color-text-muted: #666666;
+      --color-border: #e0e0e0;
+      --color-accent: #007141;
+      --color-accent-light: rgba(0, 188, 109, 0.1);
+    }
+
+    /* Dark mode variable overrides */
+    :root.dark-mode,
+    .dark-mode {
+      --color-bg: #1a1a1a;
+      --color-text: #ffffff;
+      --color-text-muted: #b0b0b0;
+      --color-border: #404040;
+      --color-accent: #00c76d;
+      --color-accent-light: rgba(0, 199, 109, 0.2);
+    }
+
+    * {
+      box-sizing: border-box;
+      margin: 0;
+      padding: 0;
+      -webkit-print-color-adjust: exact;
+      print-color-adjust: exact;
+    }
+
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+      background-color: var(--color-bg);
+      color: var(--color-text);
+      padding: 20mm;
+      line-height: 1.6;
+      transition: background-color 0.3s ease, color 0.3s ease;
+    }
+
+    h1 {
+      font-size: 32px;
+      font-weight: 700;
+      color: var(--color-text);
+      margin-bottom: 10mm;
+      border-bottom: 2px solid var(--color-accent);
+      padding-bottom: 5mm;
+    }
+
+    .content {
+      font-size: 14px;
+      color: var(--color-text);
+      margin-bottom: 8mm;
+    }
+
+    .content p {
+      margin-bottom: 5mm;
+    }
+
+    .footer {
+      margin-top: 15mm;
+      padding-top: 8mm;
+      border-top: 1px solid var(--color-border);
+      text-align: center;
+      font-size: 12px;
+      color: var(--color-text-muted);
+    }
+  `;
+
+  return (
+    <Document lang="en" dir="ltr">
+      <style dangerouslySetInnerHTML={{ __html: cssStyles }} />
+      <Body>
+        <div className="container">
+          <h1>Welcome, {name}!</h1>
+
+          <div className="content">
+            <p>
+              This is your first PDF template created with React PDF Render.
+            </p>
+            <p>
+              You can start editing this template in{' '}
+              <code>templates/welcome.tsx</code> to create your own PDF
+              documents.
+            </p>
+          </div>
+
+          <div className="footer">
+            React PDF Render • Get started at{' '}
+            <a href="https://react-pdf-forge.com">react-pdf-forge.com</a>
+          </div>
+        </div>
+      </Body>
+    </Document>
+  );
+}
+
+Welcome.PreviewProps = {
+  name: 'World',
+} as WelcomeProps;
+
+export default Welcome;

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "tsconfig/base.json",
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["dist", "build", "node_modules", ".test"],
+  "compilerOptions": {
+    "moduleResolution": "nodenext",
+    "module": "nodenext",
+    "jsx": "react-jsx",
+    "noEmit": true,
+    "types": ["vitest/globals"]
+  }
+}