create-ollie-shop 0.2.2 → 1.0.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> create-ollie-shop@0.2.2 build /home/runner/work/ollie-shop/ollie-shop/packages/create-ollie-shop
+> create-ollie-shop@1.0.0 build /home/runner/work/ollie-shop/ollie-shop/packages/create-ollie-shop
 > tsup
 
 CLI Building entry: src/index.ts
@@ -9,5 +9,5 @@
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
-ESM dist/index.js 6.28 KB
-ESM ⚡️ Build success in 146ms
+ESM dist/index.js 5.83 KB
+ESM ⚡️ Build success in 426ms

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # create-ollie-shop
 
+## 1.0.0
+
+### Major Changes
+
+- 3b0ed1c: Create studio experience refactoring the previous flow. Remove the previewjs dependency
+
+## 0.2.3
+
+### Patch Changes
+
+- af65e8f: fix(security): update Next.js to 15.5.9 for RSC security vulnerabilities
+
+  Addresses critical security vulnerabilities in Next.js App Router (React Server Components):
+
+  - **CVE-2025-55184** (High): DoS via infinite loop in Server Functions deserialization
+  - **CVE-2025-67779** (High): DoS via malicious HTTP requests (complete fix)
+  - **CVE-2025-55183** (Medium): Source code exposure of Server Functions
+
+  Updated Next.js from 15.5.7 to 15.5.9 across all 14 affected packages.
+
+  Reference: https://nextjs.org/blog/security-update-2025-12-11
+
 ## 0.2.2
 
 ### Patch Changes

package/README.md

@@ -1,129 +1,102 @@
 # create-ollie-shop
 
-A CLI tool to create a new Ollie Shop e-commerce project with a modern tech stack and pre-built components.
+A CLI tool to scaffold a new Ollie Shop checkout customization project.
 
-## Overview
-
-`create-ollie-shop` is a scaffolding tool that helps you quickly set up a new e-commerce project using the Ollie Shop framework. It provides a selection of templates, components, and configurations to kickstart your online store development.
-
-## Requirements
-
-- Node.js 20.x or higher
-- pnpm 7.x or higher (recommended package manager)
-
-## Installation
-
-### Using pnpm create
-
-```bash
-pnpm create ollie-shop [project-name]
-```
-
-### Or use directly with npx
+## Quick Start
 
 ```bash
-npx create-ollie-shop [project-name]
+npx create-ollie-shop
 ```
 
-### Options
+You'll be prompted for:
+1. **Project directory** (default: `my-checkout`)
+2. **Store ID** (your Ollie Shop store UUID)
+3. **Version ID** (optional, press Enter to skip)
 
-- `--store-id <id>` - Specify an Ollie store ID
-- `--version-id <id>` - Specify an Ollie store version ID
-- `--help` - Display help information
-- `--version` - Display version information
+## Usage
 
-### Examples
+### Interactive mode
 
 ```bash
-# Start interactive project bootstrapping
 npx create-ollie-shop
-
-# Create a new project with a custom name
-npx create-ollie-shop my-awesome-store
-
-# Create a new project with store configuration
-npx create-ollie-shop my-store --store-id 7217542a-d7c6-40d3-a20e-db13b310a781 --version-id 882c8c18-550c-4ac5-9d3b-015d7dd25741
 ```
 
-## Preview.js Plugin
-
-Ollie Shop projects were designed to be previewed using the Preview.js plugin for VS Code. This tool allows developers to visualize and interact with components in isolation during development.
-
-### Installation
-
-Simply install the Preview.js extension from the VS Code marketplace:
-[VS Code Extension](https://marketplace.visualstudio.com/items?itemName=zenclabs.previewjs)
+```
+🛍️  Create Ollie Shop
 
-### Usage
+Project directory (my-checkout): my-store
+Store ID: 7217542a-d7c6-40d3-a20e-db13b310a781
+Version ID (optional, press Enter to skip):
 
-Preview.js works seamlessly with properly bootstrapped Ollie Shop projects. After creating your project with `create-ollie-shop`, the Preview.js server will automatically read the Ollie configurations and set up accordingly.
+🚀 Creating Ollie Shop project "my-store"...
+📁 Copying template files...
+🔧 Initializing git repository...
 
-To use Preview.js:
-1. Open any component file in your Ollie Shop project
-2. Click the Preview.js icon in the editor or press the keyboard shortcut
-3. A live preview of your component will appear, reflecting any changes you make in real-time
+✅ Ollie Shop project created in my-store:
+  $ cd my-store
 
-This integration allows you to develop and test components without needing to set up a separate development environment or manually configure Preview.js.
+Install dependencies:
+  $ npm install
 
-## Development
+Start development:
+  $ npm start
 
-To work on `create-ollie-shop` locally:
+🛍️  Happy building with Ollie Shop!
+```
 
-1. Clone the repository
+### With store ID flag
 
 ```bash
-git clone git@github.com:ollie-shop/ollie-shop.git
-cd ollie-shop
+npx create-ollie-shop --store-id 7217542a-d7c6-40d3-a20e-db13b310a781
 ```
 
-2. Install dependencies
+### With version ID (optional)
 
 ```bash
-pnpm install
+npx create-ollie-shop --store-id 7217542a-d7c6-40d3-a20e-db13b310a781 --version-id abc12345-d7c6-40d3-a20e-db13b310a781
 ```
 
-3. Link local packages
+### Options
 
-```bash
-# Navigate to the create-ollie-shop package directory
-cd packages/create-ollie-shop
+| Option | Description |
+|--------|-------------|
+| `--store-id <uuid>` | Store ID (skips prompt if provided) |
+| `--version-id <uuid>` | Version ID (optional, for version-specific development) |
+| `--help` | Display help |
+| `--version` | Display version |
 
-# Create a global link
-pnpm link --global
+## Project Structure
 
-# For working with other local packages, use pnpm link inside each package directory
-# For example, to link the ollie-shop library:
-cd ../ollie-shop
-pnpm link --global
+After scaffolding, your project will have:
 
-# Then, in the create-ollie-shop directory:
-pnpm link --global ollie-shop
 ```
-
-> **Note**: When using `pnpm link`, make sure all linked packages have their dependencies installed. The link creates a symlink to your local package, allowing you to make changes and immediately see them reflected in projects that use the linked package.
-
-4. Build the package
-
-```bash
-pnpm build
+my-checkout/
+├── .vscode/           # VS Code settings (Biome formatter)
+├── components/        # Your checkout components
+│   └── HelloWorld/    # Example component
+├── types/             # TypeScript type definitions
+├── .gitignore
+├── ollie.json         # Ollie Shop configuration
+├── package.json
+└── tsconfig.json
 ```
 
-5. Test your changes
+## Development
+
+After creating your project:
 
 ```bash
-pnpm test
+cd my-checkout
+npm install
+npm start
 ```
 
-## Contributing
+This starts the Ollie Studio development server and opens it in your browser.
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+## Requirements
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
+- Node.js 20.x or higher
 
 ## License
 
-MIT
+MIT

package/dist/index.js

@@ -2,210 +2,189 @@
 
 // src/index.ts
 import path2 from "path";
-import chalk3 from "chalk";
-import { Command } from "commander";
-import fs2 from "fs-extra";
+import process from "process";
+import readline from "readline/promises";
+import meow from "meow";
+import { z } from "zod";
 
-// src/commands/create-project.ts
-import child_process from "child_process";
+// src/create-project.ts
+import { exec } from "child_process";
+import fs from "fs/promises";
 import path from "path";
 import { fileURLToPath } from "url";
 import { promisify } from "util";
-import chalk from "chalk";
-import fs from "fs-extra";
-var exec = promisify(child_process.exec);
-var BASE_DIR = path.dirname(fileURLToPath(import.meta.url));
-async function createProject(config) {
-  const {
-    projectName,
-    storeId,
-    versionId,
-    platform,
-    platformStoreId,
-    targetDir
-  } = config;
-  console.log(
-    `
-\u{1F680} Creating a new Ollie Shop project in ${chalk.green(`./${projectName}`)}...`
-  );
-  fs.ensureDirSync(targetDir);
-  const templateDir = path.join(BASE_DIR, "template");
-  await fs.copy(templateDir, targetDir, {
-    overwrite: true
-  });
-  const pkgPath = path.join(targetDir, "package.json");
-  const pkg = await fs.readJSON(path.join(targetDir, "package.json"));
-  pkg.name = projectName;
-  await fs.writeJSON(pkgPath, pkg, { spaces: 2 });
-  const ollieConfigPath = path.join(targetDir, "ollie.json");
-  await fs.writeJSON(
-    ollieConfigPath,
-    {
-      storeId: storeId || null,
-      versionId: versionId || null,
-      platform,
-      platformStoreId: platformStoreId || null
-    },
-    { spaces: 2 }
-  );
-  try {
-    await exec("git init", { cwd: targetDir });
-  } catch (e) {
-    console.log("\n\u274C Error initializing git:", e);
+import fsExtra from "fs-extra";
+import slugify from "slugify";
+var execAsync = promisify(exec);
+var __dirname = path.dirname(fileURLToPath(import.meta.url));
+async function copyWithTemplate(from, to, variables) {
+  const dirname = path.dirname(to);
+  await fsExtra.ensureDir(dirname);
+  const source = await fs.readFile(from, "utf8");
+  let content = source;
+  content = content.replace(/%NAME%/g, variables.name);
+  content = content.replace(/%STORE_ID%/g, variables.storeId);
+  await fs.writeFile(to, content);
+}
+function getDestinationFilename(filename) {
+  if (filename.startsWith("_")) {
+    const rest = filename.slice(1);
+    if (!rest.includes(".")) {
+      return `.${rest}`;
+    }
+    return rest;
   }
-  printSuccessMessage(
-    projectName,
-    storeId,
-    versionId,
-    platform,
-    platformStoreId
-  );
+  return filename;
 }
-function printSuccessMessage(projectName, storeId, versionId, platform, platformStoreId) {
-  console.log("\n\u2705 Project created successfully!");
-  console.log("\nNext steps:");
-  console.log(`  cd ${chalk.cyan(projectName)}`);
-  console.log(
-    `  npm install (or ${chalk.cyan("pnpm install")} or ${chalk.cyan("yarn")})`
-  );
-  console.log(
-    "\n  The development environment leverages the Preview.js extension for VS Code:"
-  );
-  console.log(
-    `  ${chalk.cyan("https://marketplace.visualstudio.com/items?itemName=zenclabs.previewjs")}
-`
-  );
-  if (storeId) {
-    console.log(`Store ID: ${chalk.green(storeId)}`);
-  } else if (platform && platformStoreId) {
-    console.log(`Platform: ${chalk.green(platform)}`);
-    console.log(`Platform Store ID: ${chalk.green(platformStoreId)}`);
+async function copyTemplateDir(templateDir, targetDir, variables) {
+  const entries = await fs.readdir(templateDir, { withFileTypes: true });
+  for (const entry of entries) {
+    const srcPath = path.join(templateDir, entry.name);
+    const destName = getDestinationFilename(entry.name);
+    const destPath = path.join(targetDir, destName);
+    if (entry.isDirectory()) {
+      await fsExtra.ensureDir(destPath);
+      await copyTemplateDir(srcPath, destPath, variables);
+    } else {
+      const ext = path.extname(entry.name).toLowerCase();
+      const textExtensions = [
+        ".json",
+        ".ts",
+        ".tsx",
+        ".js",
+        ".jsx",
+        ".md",
+        ".css",
+        ".html",
+        ""
+      ];
+      if (textExtensions.includes(ext) || entry.name.startsWith("_")) {
+        await copyWithTemplate(srcPath, destPath, variables);
+      } else {
+        await fs.copyFile(srcPath, destPath);
+      }
+    }
+  }
+}
+async function createProject(projectPath, options) {
+  const { storeId, versionId } = options;
+  const projectName = slugify(path.basename(projectPath), { lower: true });
+  const exists = await fsExtra.pathExists(projectPath);
+  if (exists) {
+    throw new Error(`Directory "${projectPath}" already exists.`);
   }
+  console.log(`\u{1F680} Creating Ollie Shop project "${projectName}"...`);
+  await fsExtra.ensureDir(projectPath);
+  const templateDir = path.join(__dirname, "..", "template");
+  const variables = {
+    name: projectName,
+    storeId,
+    versionId
+  };
+  console.log("\u{1F4C1} Copying template files...");
+  await copyTemplateDir(templateDir, projectPath, variables);
   if (versionId) {
-    console.log(`Version ID: ${chalk.green(versionId)}`);
+    const ollieConfigPath = path.join(projectPath, "ollie.json");
+    const ollieConfig = JSON.parse(await fs.readFile(ollieConfigPath, "utf8"));
+    ollieConfig.versionId = versionId;
+    await fs.writeFile(ollieConfigPath, JSON.stringify(ollieConfig, null, 2));
+  }
+  console.log("\u{1F527} Initializing git repository...");
+  try {
+    await execAsync("git init", { cwd: projectPath });
+  } catch {
+    console.log("   \u26A0\uFE0F  Could not initialize git repository");
   }
-  console.log("\n\u{1F6CD}\uFE0F  Happy development with Ollie Shop! \u{1F6CD}\uFE0F\n");
-}
-
-// src/utils/prompts.ts
-import chalk2 from "chalk";
-import prompts from "prompts";
-import { z } from "zod";
-async function promptForProjectName(defaultValue = "my-ollie-shop") {
-  const { value } = await prompts({
-    type: "text",
-    name: "value",
-    message: "Project name:",
-    initial: defaultValue,
-    validate: (value2) => z.string().nonempty().safeParse(value2).success
-  });
-  return value || defaultValue;
-}
-async function promptForOverwrite(dirName) {
-  const { overwrite } = await prompts({
-    type: "confirm",
-    name: "overwrite",
-    message: `Directory ${chalk2.cyan(dirName)} already exists. Overwrite?`,
-    initial: false
-  });
-  return overwrite;
-}
-async function promptForStoreId() {
-  const { value } = await prompts({
-    type: "text",
-    name: "value",
-    message: "Store ID (optional):",
-    hint: "Leave empty if you want to set up the workspace manually",
-    validate: (value2) => z.string().uuid().or(z.literal("")).safeParse(value2).success || "Please enter a valid UUID or leave empty"
-  });
-  return value && value.trim() !== "" ? value : void 0;
-}
-async function promptForPlatformStoreId(platform) {
-  const { platformStoreId } = await prompts({
-    type: "text",
-    name: "platformStoreId",
-    message: `Enter your ${platform.toUpperCase()} account name:`,
-    validate: (value) => z.string().min(1).safeParse(value).success || "Account name cannot be empty"
-  });
-  return platformStoreId;
-}
-async function promptForVersionId() {
-  const { value } = await prompts({
-    type: "text",
-    name: "value",
-    message: "Version ID (optional):",
-    validate: (value2) => z.string().uuid().or(z.literal("")).safeParse(value2).success
-  });
-  return value && value.trim() !== "" ? value : void 0;
 }
 
 // src/index.ts
-async function main() {
-  console.log(
-    chalk3.bold.blue(
-      "\u{1F6CD}\uFE0F  Create Ollie Shop - Bootstrap a new Ollie Shop project"
-    )
-  );
-  const program = new Command().name("create-ollie-shop").description(
-    "Bootstrap a new Ollie Shop project with optional store configuration"
-  ).version("0.1.0").argument("[project-name]", "Project folder name", "my-ollie-shop").option("--store-id <id>", "Specify an Ollie store ID").option("--version-id <id>", "Specify an Ollie store version ID").addHelpText(
-    "after",
-    `
-  Examples:
-    $ create-ollie-shop
-    $ create-ollie-shop my-awesome-store
-    $ create-ollie-shop my-store --store-id 7217542a-d7c6-40d3-a20e-db13b310a781 --version-id 882c8c18-550c-4ac5-9d3b-015d7dd25741
+var uuidSchema = z.string().uuid("Invalid store ID format. Must be a valid UUID.");
+var cli = meow(
   `
-  ).parse(process.argv);
-  try {
-    await initializeProject(program);
-  } catch (error) {
-    console.error(chalk3.red("\n\u274C Error:"), error);
-    process.exit(1);
+  Usage
+    $ create-ollie-shop [--store-id <uuid>] [--version-id <uuid>]
+
+  Options
+    --store-id     Store ID (must be a valid UUID)
+    --version-id   Version ID (optional, must be a valid UUID)
+
+  Examples
+    $ create-ollie-shop
+    $ create-ollie-shop --store-id 7217542a-d7c6-40d3-a20e-db13b310a781
+    $ create-ollie-shop --store-id 7217542a-d7c6-40d3-a20e-db13b310a781 --version-id abc12345-d7c6-40d3-a20e-db13b310a781
+`,
+  {
+    importMeta: import.meta,
+    flags: {
+      storeId: {
+        type: "string"
+      },
+      versionId: {
+        type: "string"
+      }
+    }
   }
+);
+async function prompt(question, defaultValue) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  const suffix = defaultValue ? ` (${defaultValue})` : "";
+  const answer = await rl.question(`${question}${suffix}: `);
+  rl.close();
+  return answer.trim() || defaultValue || "";
 }
-async function initializeProject(program) {
-  const options = program.opts();
-  let storeId = options.storeId;
-  let versionId = options.versionId;
-  const platform = "vtex";
-  let platformStoreId;
-  let projectName = program.args[0];
-  if (!projectName) {
-    projectName = await promptForProjectName();
+async function main() {
+  console.log("\n\u{1F6CD}\uFE0F  Create Ollie Shop\n");
+  const projectDirectory = await prompt("Project directory", "my-checkout");
+  const projectPath = path2.resolve(process.cwd(), projectDirectory);
+  let storeId = cli.flags.storeId;
+  if (!storeId) {
+    storeId = await prompt("Store ID");
   }
-  const cwd = process.cwd();
-  const targetDir = path2.join(cwd, projectName);
-  if (fs2.existsSync(targetDir)) {
-    const shouldOverwrite = await promptForOverwrite(projectName);
-    if (!shouldOverwrite) {
-      console.log(chalk3.red("\u274C Operation cancelled"));
-      return;
-    }
-    await fs2.emptyDir(targetDir);
+  const storeIdResult = uuidSchema.safeParse(storeId);
+  if (!storeIdResult.success) {
+    console.error(`
+\u274C ${storeIdResult.error.errors[0]?.message}`);
+    process.exit(1);
   }
-  if (!storeId) {
-    storeId = await promptForStoreId();
-    if (!storeId) {
-      console.log(
-        chalk3.blue(
-          `Using ${chalk3.bold(platform.toUpperCase())} as the platform`
-        )
-      );
-      platformStoreId = await promptForPlatformStoreId(platform);
+  let versionId = cli.flags.versionId;
+  if (!versionId) {
+    versionId = await prompt("Version ID (optional, press Enter to skip)");
+  }
+  if (versionId) {
+    const versionIdResult = uuidSchema.safeParse(versionId);
+    if (!versionIdResult.success) {
+      console.error("\n\u274C Invalid version ID format. Must be a valid UUID.");
+      process.exit(1);
     }
   }
-  if (!versionId) {
-    versionId = await promptForVersionId();
+  const finalVersionId = versionId || void 0;
+  try {
+    console.log();
+    await createProject(projectPath, { storeId, versionId: finalVersionId });
+    const relativePath = path2.relative(process.cwd(), projectPath);
+    console.log(
+      [
+        "",
+        `\u2705 Ollie Shop project created in ${relativePath || "the current directory"}:`,
+        relativePath ? `  $ cd ${relativePath}` : void 0,
+        "",
+        "Install dependencies:",
+        "  $ npm install",
+        "",
+        "Start development:",
+        "  $ npm start",
+        "",
+        "\u{1F6CD}\uFE0F  Happy building with Ollie Shop!",
+        ""
+      ].filter((line) => line !== void 0).join("\n")
+    );
+  } catch (error) {
+    console.error(`
+\u274C ${error instanceof Error ? error.message : error}`);
+    process.exit(1);
   }
-  const config = {
-    projectName,
-    storeId,
-    versionId,
-    platform,
-    platformStoreId,
-    targetDir
-  };
-  await createProject(config);
 }
 main();

package/dist/template/.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["biomejs.biome", "zenclabs.previewjs"]
+  "recommendations": ["biomejs.biome"]
 }

package/dist/template/.vscode/settings.json

@@ -5,22 +5,7 @@
     "source.fixAll.biome": "explicit",
     "source.organizeImports.biome": "explicit"
   },
-  "[typescript]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[typescriptreact]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[javascript]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[javascriptreact]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[json]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[jsonc]": {
+  "[typescript][typescriptreact][javascript][javascriptreact][json][jsonc]": {
     "editor.defaultFormatter": "biomejs.biome"
   }
 }

package/dist/template/_gitignore

@@ -0,0 +1,42 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+coverage
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
+dist
+
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Misc
+.DS_Store
+*.pem
+
+*storybook.log
+
+storybook-static/