{"_id":"@aemforms/aem-site-theme-builder","_rev":"3-0b885fb3f0cf41e810e555ba2fa648d4","name":"@aemforms/aem-site-theme-builder","dist-tags":{"latest":"5.3.0"},"versions":{"5.3.0":{"name":"@aemforms/aem-site-theme-builder","version":"5.3.0","author":"","license":"MIT License, Copyright 2020 Adobe Systems Incorporated","_id":"@aemforms/aem-site-theme-builder@5.3.0","maintainers":[{"name":"cqguides","email":"arnjain@adobe.com"},{"name":"nitigupt","email":"niting.iitr@gmail.com"},{"name":"rismehta","email":"rismehta@adobe.com"},{"name":"salilt","email":"salilt@adobe.com"},{"name":"vdua","email":"vdua@adobe.com"}],"bin":{"aem-site-theme-builder":"bin/index.js"},"dist":{"shasum":"6aea617ca3a8d4a2ebf1f9e0647dddbe02a9b293","tarball":"https://registry.npmjs.org/@aemforms/aem-site-theme-builder/-/aem-site-theme-builder-5.3.0.tgz","fileCount":15,"integrity":"sha512-DDJb74eBP2yNorpigz+9wpKFqA5wGlmuy8wSG7/1BHF3sXt+O+I8awS19yXy3qsJ1a0wXOJPHGAFr8JYWycHoA==","signatures":[{"sig":"MEUCIQCRSZnrwyRvvE5GLl3Anh2ceRY/4YmCOXwvTIzKiNL/fgIgA46I4nTHWQkA/kujjbH6XDoN5Vyk5ilwIuwbSUZUGfk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":19038,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAKAJACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqY5Q/9FoAIk1nQQkQVqTtrMcE7PDz1raw+43g4bwwdvabbpe+NYGgW\r\n6CQKIft1krBCzRpl7DjzEeo4aieOp1KXo11Y5cYeCaoWXi0iE5BWj1AJtJ+5\r\n/JQc3EwHHURdmTCrgsUHeuchidKpoZdPujt+qa2pEnHWyPXR08A8QuUq3+vP\r\ncEw245XhX2FzYRKLHnHKZnhHJwOpJoseuZ3i1ypgcnkocdieOc/R7kcWgAtD\r\n58ZMFY+wqU332gkhAh8vr10Kr0VxtmLZvdV3/+oeLYAlnpNgiiJIHg48u7VC\r\nVSyAHYNTmqVeKtpueMK4Q3fS3CdsnG3QbEmz0ig8HrALzJ6ZmJOeTsb9axFx\r\njI3eac4WVyI0I9Xh6d833Gjk4raXrbeqaLip476B4lAuDMlVz17tx1/vIkia\r\nTC8RASrnDcYUkJqtfSF8i9x6aGfL5hz3nB8EHLUCDA48hGufSaHgXP9+MUGG\r\n7/0om3Tfr/cEjIRGf9D2su7+t9b0VJFC4MhexoRFXcxYtwitXFHqYMEe848+\r\nyNERdFgqeGo6lub7pl40n9byXOASK2rx8fPcctAAIQ51UlterPqUivvTvk2L\r\n6ijbVa2qnJKE6ul+Gc0Bt+cfaQDQrO6eP54x/7y1VkgVOXORaTs/wdOIaeWu\r\nN3HezdPtoNA6TWex5wMT7RLw0pZpKaL1d0Y=\r\n=KzW7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"bin/index.js","gitHead":"f4239173f4ec23e7673047b803f265252f0a673f","scripts":{},"_npmUser":{"name":"rismehta","email":"rismehta@adobe.com"},"_npmVersion":"9.5.0","description":"This repository contains scripts for building a Site Theme, ensuring compatibility with the requirements of AEM Site Templates. The recommended way of integrating the Theme Builder is to install it as an npm dependency of the Site Template Theme. This way","directories":{},"_nodeVersion":"19.7.0","dependencies":{"zlib":"^1.0.5","yargs":"16.1.0","dotenv":"8.2.0","connect":"3.7.0","shelljs":"0.8.4","http-proxy":"1.18.1","browser-sync":"^2.28.1","tcp-port-used":"1.0.2","browser-sync-client":"2.27.9"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.0.0","eslint-plugin-node":"^11.1.0","eslint-plugin-import":"^2.25.1","eslint-plugin-promise":"^5.1.0","eslint-config-standard":"^16.0.3"},"_npmOperationalInternal":{"tmp":"tmp/aem-site-theme-builder_5.3.0_1677762568884_0.6327908164958294","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-03-02T13:09:28.762Z","modified":"2026-05-29T13:54:45.784Z","5.3.0":"2023-03-02T13:09:29.117Z"},"license":"MIT License, Copyright 2020 Adobe Systems Incorporated","description":"This repository contains scripts for building a Site Theme, ensuring compatibility with the requirements of AEM Site Templates. The recommended way of integrating the Theme Builder is to install it as an npm dependency of the Site Template Theme. This way","maintainers":[{"email":"vdua@adobe.com","name":"vdua"},{"email":"salilt@adobe.com","name":"salilt"},{"email":"rismehta@adobe.com","name":"rismehta"},{"email":"niting.iitr@gmail.com","name":"nitigupt"},{"email":"arnjain@adobe.com","name":"cqguides"},{"email":"vijju311985@gmail.com","name":"jalagari"},{"email":"syr@adobe.com","name":"syamavarma"}],"readme":"# AEM Site Theme Builder\n\nThis repository contains scripts for building a Site Theme, ensuring compatibility with the requirements of AEM Site Templates. The recommended way of integrating the Theme Builder is to install it as an npm dependency of the Site Template Theme. This way `aem-site-theme-builder` commands can be used in NPM scripts. Example of such integration can be found in [Standard Site Template](https://github.com/adobe/aem-site-template-standard/blob/main/theme/package.json).\n\n## Installation\n\n```\ncd <your-site-theme>\nnpm install @aemforms/aem-site-theme-builder --save-dev\n```\n\n## Usage\n\n### Proxy\n\nProxy your site running on AEM as a Cloud Service to localhost and replace requests made to the Site Theme with your locally compiled version of the Site Theme.\n\n```\nnpx aem-site-theme-builder proxy\n```\n\nThe URLs to a Site Theme can be provided via `.env` described in [environment variables](#environment-variables). In order to inject your locally compiled theme, the [location of compiled site theme](#expected-location-of-compiled-site-theme) must match.\n\n### Live Preview\n\nThe live preview will run proxy server (desribed above) as well browser sync functionality. Browser sync will point to the proxied page and will be looking for changes in the `dist` folder and will refresh the page each time you got a change.\n\n```\nnpx aem-site-theme-builder live\n```\n\n### Theme Deployment\n\n1. Compile your theme and make the artifact available on GitHub. AEM as a Cloud Service will try to access `https://api.github.com/repos/%GIT_ORG%/%GIT_REPO%/actions/artifacts/%GIT_ARTIFACT_ID%/zip` in order to download the theme.\n1. Execute `npx aem-site-theme-builder deploy` in order to update the reference on AEM as a Cloud Service.\n\n## Complete development workflow\n\nIn order to make best use of theme-builder you have to run the live preview which provides proxy and browser sync functionalities. On top of that you need to make sure that you have additional watcher for your source files that triggers your theme build process which produces changes in the `dist` folder of your theme. This way after making change in your source file you will get your proxy page refreshed via browser sync.\n\n## API\n\n### Environment Variables\n\nTheme Builder scripts are based on the environment variables you provide. These variables are used to properly provide live preview and deploy functionality of the AEM Site Theme Builder. \n\nHere is the list of required variables:\n\n```\nAEM_URL=<URL of the AEM as a Cloud Service instance>\nAEM_SITE=<name of the AEM site>\nAEM_PROXY_PORT=<localhost proxy server port>\n```\nHere is the list of optional variables:\n\n```\nAEM_ADAPTIVE_FORM=<name of the AEM Form>\n```\n\nRecommended way to define site variables is to use / create `.env` file within your theme project repository.\n\n### Expected Output of Compiled Site Theme\n\nYou're free to use any build tools of your choice. The only contract with the Site Theme Builder is that the compiled artifact shall be provided as follows:\n\n```\ndist/\n    css/\n        theme.css\n    js/\n        theme.js\n    resources/\n        a-font.font\n        an-image.png\n```\n\n## Release and publish\n\nRun the \"Release and publish\" GitHub workflow and provide the semantic version you're about to release.\n\n## Contributing\n\nContributions are welcomed! Read the [Contributing Guide](.github/CONTRIBUTING.md) for more information.\n\n## Licensing\n\nThis project is licensed under the MIT License. See [LICENSE](LICENSE.md) for more information.\n","readmeFilename":"README.md"}