\n\n# Built for PS Generator\n\nThis CLI allow you to generate a Built For PS with different parameters: PrestaShop version, Billing i sandbox or not, Billing environment, Product ID (which allow to use different pricing model)\n\n### Requirements\n\nFirst of all you need to install composer, please refer to the [Linux / Unix / MacOS instruction](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) or [Windows instructions](https://getcomposer.org/doc/00-intro.md#installation-windows).\n\n## Installation\n\n```bash\nnpm i -g @prestashopcorp/builtfor-generator-vanilla\n```\n\nor\n\n```bash\nyarn global add @prestashopcorp/builtfor-generator-vanilla\n```\n\n## Usage\n\n### Classic\n\nLaunch in a terminal this command\n\n```bash\nbuiltforGen -id [...other options]\n```\n\n#### Options for classic usage\n\n```man\nGenerate Built for PS for PrestaShop\n\nOptions:\n -id, --productId Technical id of the Built for PS. This id will be used to generate the Built for PS with the proper value. Ths value should match the product family item configured\n in Chargebee, otherwise you must create it.\n --psVersion Description of the Built for PS (choices: \"1.7\", \"8\", \"9\", default: \"9\")\n -s --sandbox Use this flag to generate a Built for PS in sandbox mode\n -e, --environment Specify an environment when you don't want to use the production (choices: \"prestabulle1\", \"prestabulle2\", \"prestabulle3\", \"prestabulle4\", \"prestabulle5\",\n \"prestabulle6\", \"preprod\")\n -t, --template Specify a template when you want to handling display of yours plans (choices: \"standard\", \"handle\",\n default: \"standard\")\n -wd, --workingDir Directory where the Built for PS will be created. You can specify a relative or an absolute path. (default: \"tmp\")\n -d, --description Description of the Built for PS (default: \"Built for PS in Vanilla JS for PrestaShop\")\n -name, --displayName Display name of the Built for PS\n -c, --context This option allow you to inject some information within the context. Please give a stringified json: '{\"foo\": \"bar\"}' (default: {})\n --customCancellation Use this flag to activate custom cancellation modal\n -l, --module-lib-billing-version This option allow you set the version of module-lib-billing. If you want to set it to a branch, you should add `dev` in front of it\n (i.g. `dev-feat/my-feature` (default: \"^4.0.0\")\n -h, --help display help for command\n```\n\n#### Focus on --context\n\nYou need to use this when the [Built For PS documentation about billing](https://docs.cloud.prestashop.com/5-prestashop-billing/), mention to add info within the context from your Javascript (in configure.tpl).\n\nIn this case please refer to the documentation to known which JSON structure should be used.\n\nExample:\n\n```json\n// JSON which allow you to specify the unit when using a stairstep pricing model, in order to display\n// the proper information in the plan page into the funnel\n{\n \"product\": {\n \"components\": [\n {\n \"id\": \"builtfor_example_stairstep\", // this is the pricing id in chargebee\n \"unitDescription\": \"Users\"\n }\n ]\n }\n}\n```\n\n### Registered configuration\n\nThis script provide some registered configuration to save time. In this case the module generated is compatible with PS version 1.7, and all config are in sandbox.\n\n```bash\nbuiltforRegistered -c \n```\n\n#### Options for registered configuration\n\n```man\nGenerate Built for PS for PrestaShop with registered whole configuration\n\nOptions:\n -c, --config Select your registered configuration (choices: \"flat_bulle1\", \"flat_bulle2\", \"flat_bulle3\", \"flat_bulle4\", \"flat_bulle5\", \"flat_bulle6\", \"flat_preprod\", \"flat\", \"flat_handle_bulle1\",\n \"flat_handle_bulle2\", \"flat_handle_bulle3\", \"flat_handle_bulle4\", \"flat_handle_bulle5\", \"flat_handle_bulle6\", \"flat_handle_preprod\", \"flat_handle\", \"stairstep_bulle1\", \"stairstep_bulle2\",\n \"stairstep_bulle3\", \"stairstep_bulle4\", \"stairstep_bulle5\", \"stairstep_bulle6\", \"stairstep_preprod\", \"stairstep\")\n -h, --help display help for command\n```\n\n### Examples\n\nThe product id is the key that makes this module either flat fee or stairstep\n\n#### PS 9, Live, Production\n\n##### Generate a flat fee module\n\n```bash\nbuiltforGen -id builtfor_example -d \"PS 9 | Built for PS with a flat fee pricing\"\n```\n\n##### Generate a flat fee module with the offer already selected\n\n```bash\nbuiltforGen \\\n -id builtfor_example \\\n -s \\\n -e prestabulle2 \\\n -d \"PS 9 | Built for PS with a flat fee pricing in sandbox for prestabulle2. Selection automatic of the plan.\" \\\n -c '{\"offerSelection\": {\"offerPricingId\": \"builtfor_example-ultimate-EUR-Monthly\"}}'\n```\n\n##### Generate a stairstep module\n\n```bash\nbuiltforGen \\\n -id builtfor_example_stairstep \\\n -d \"PS 9 | Built for PS with a stairstep pricing\" \\\n -c '{\"product\": {\"components\": [{\"id\": \"builtfor_example_stairstep\", \"unitDescription\": \"Users\" }]}}'\n```\n\n##### Generate a stairstep module with preselected step\n\n```bash\nbuiltforGen \\\n -id builtfor_example_stairstep \\\n -s \\\n -e prestabulle2 \\\n -d \"PS 9 | Built for PS with a stairstep pricing in sandbox for prestabulle2\" \\\n -c '{\"product\": {\"components\": [{\"id\": \"builtfor_example_stairstep\", \"unitDescription\": \"Users\" }]}, \"offerSelection\": {\"offerPricingId\": \"builtfor_example_stairstep\", \"offerQuantity\": 255}}'\n```\n\n##### Generate a stairstep module with a frequency switcher\n\n```bash\nbuiltforGen \\\n -id builtfor_example_stairstep \\\n -name 'Builtfor Stairstep Example' \\\n -e prestabulle2 \\\n --template frequency \\\n -c '{\"offerSelection\": {\"offerPricingId\": \"builtfor_stairstep-EUR-Monthly\",\"offerQuantity\": 1 }}'\n```\n\n#### PS 1.7, Sandbox, Prestabulle 2\n\n##### Generate a flat fee module for PS 1.7\n\n```bash\n# With builtforGen\n$ builtforGen -id builtfor_example -s -e prestabulle2 -d \"PS 1.7 | Built for PS with a flat fee pricing in sandbox for prestabulle2\" --psVersion \"1.7\" -l 3.3.0\n# Or with builtforRegistered\n$ builtforRegistered -c flat_bulle2\n```\n\n##### Generate a flat fee with handle plan module for PS1.7\n\n```bash\n# With builtforGen\nbuiltforGen -id builtfor_example -s -e prestabulle2 -d \"PS 1.7 | Built for PS with a flat fee pricing in sandbox for prestabulle2\" --psVersion \"1.7\" -t \"handle\" -l 3.3.0\n# Or with builtforRegistered\nbuiltforRegistered -c flat_handle_bulle2\n```\n\n##### Generate a stairstep module for PS1.7\n\n```bash\nbuiltforGen \\\n -id builtfor_example_stairstep \\\n -s \\\n -e prestabulle2 \\\n -d \"PS 1.7 | Built for PS with a stairstep pricing in sandbox for prestabulle2\" \\\n --psVersion \"1.7\" \\\n -c '{\"product\": {\"components\": [{\"id\": \"builtfor_example_stairstep\", \"unitDescription\": \"Users\" }]}}' \\\n -l 3.3.0\n```\n\n### Change PHP version\n\n#### With Homebrew\n\n```bash\n$ brew install php@{version}\n$ brew link --force --overwrite php@{version}\n# You should install shivammathur before https://github.com/shivammathur/homebrew-php\n$ brew services start shivammathur/php/php@{version}\n```\n\n## Contribute\n\n### Installation\n\n```bash\nyarn install\n```\n\n### Launch\n\n```bash\n# Built for classic generator\nyarn start\n\n# Built for classic generator in watch mode\nyarn start:dev\n\n# Built for registered configuration\nyarn start_reg\n\n# Built for registered configuration in watch mode\nyarn start_reg:dev\n```\n\n### Build\n\n```bash\nyarn build\n```\n","readmeFilename":"README.md"}
![\"Logo\"](\"https://prestashop.com/sites/default/files/email/logo_x2_rebrand.png\"){kind=logo}
\n \n