@nizza/devkit 0.1.3-beta.3 → 0.2.0-beta.5

package/dist/cjs/executors/deploy/helpers.cjs

@@ -13,6 +13,12 @@ async function copyAssetsToS3(s3BucketPath, projectRoot) {
     await utils.runCommand(`aws s3 cp ${projectRoot}/dist ${s3BucketPath} --recursive`);
     devkit.logger.info('🚚 Assets files copied.');
 }
+async function copyTypingsToS3(s3BucketPath, projectRoot) {
+    const typingsPath = `${projectRoot}/dist`;
+    devkit.logger.info(`📦 Copying typings to S3 bucket at ${s3BucketPath}...`);
+    await utils.runCommand(`aws s3 cp ${typingsPath} ${s3BucketPath} --recursive --exclude "*" --include "*.d.ts"`);
+    devkit.logger.info('🚚 Typings files copied.');
+}
 async function createCloudFrontInvalidation(distributionId, invalidationPaths) {
     const pathsString = invalidationPaths.map((path)=>`"${path}"`).join(' ');
     const command = `aws cloudfront create-invalidation --distribution-id ${distributionId} --paths ${pathsString}`;
@@ -20,21 +26,28 @@ async function createCloudFrontInvalidation(distributionId, invalidationPaths) {
     await utils.runCommand(command);
     devkit.logger.info('🔄 CloudFront invalidation created.');
 }
-function validateCustomPath(args) {
-    let s3BucketPath = args.s3BucketPath;
-    let cloudFrontInvalidationPaths = args.cloudFrontInvalidationPaths;
-    if (args.customPath) {
-        devkit.logger.info(`🔃 Using S3 custom path: "${args.customPath}"`);
-        s3BucketPath = args.s3BucketPath.replace('{customPath}', args.customPath);
-        cloudFrontInvalidationPaths = args.cloudFrontInvalidationPaths.map((x)=>x.replace('{customPath}', args.customPath));
-    }
+function buildS3Path(args) {
+    const slash = (s)=>s ? `/${s}` : '';
+    const rootDir = args.rootDir !== undefined ? args.rootDir : args.name;
+    const assetsDir = args.assetsDir !== undefined ? args.assetsDir : args.name;
+    const s3Bucket = `s3://${args.s3Bucket}`;
+    const s3Path = `${rootDir}${slash(assetsDir)}`;
+    const s3FullPath = `${s3Bucket}${slash(s3Path)}`;
+    const cloudFrontInvalidationPaths = [
+        `${slash(s3Path)}/*`
+    ];
     return {
-        s3BucketPath,
+        rootDir,
+        assetsDir,
+        s3Bucket,
+        s3Path,
+        s3FullPath,
         cloudFrontInvalidationPaths
     };
 }
 
+exports.buildS3Path = buildS3Path;
 exports.cleanS3Bucket = cleanS3Bucket;
 exports.copyAssetsToS3 = copyAssetsToS3;
+exports.copyTypingsToS3 = copyTypingsToS3;
 exports.createCloudFrontInvalidation = createCloudFrontInvalidation;
-exports.validateCustomPath = validateCustomPath;

package/dist/cjs/executors/deploy/index.cjs

@@ -1,20 +1,42 @@
 'use strict';
 
+var devkit = require('@nx/devkit');
 var utils = require('../shared/utils.cjs');
 var helpers = require('./helpers.cjs');
 
 async function deployExecutor(opts, ctx) {
     try {
+        const { cloudFrontId, skipBuild = false, typings = false, ignoreConfigs = [], dryRun = false } = opts;
+        const success = ()=>{
+            const now = new Date().toLocaleString();
+            return utils.ok(`✨ Build completed successfully on ${now}`);
+        };
+        if (ctx.configurationName && ignoreConfigs.includes(ctx.configurationName)) {
+            devkit.logger.info(`❗ Configuration ignored: ${ctx.configurationName}`);
+            return success();
+        }
         const { root, name } = utils.getProjectConfig(ctx);
-        const { cloudFrontDistributionId, skipBuild = false } = opts;
         const buildTarget = `${name}:${opts.buildTarget}`;
-        const { s3BucketPath, cloudFrontInvalidationPaths } = helpers.validateCustomPath(opts);
+        const { s3FullPath, cloudFrontInvalidationPaths } = helpers.buildS3Path({
+            ...opts,
+            name
+        });
+        if (dryRun) {
+            devkit.logger.info('😉 Dry run mode enabled');
+            devkit.logger.info(`   - s3Path: ${s3FullPath}`);
+            devkit.logger.info(`   - cloudFrontInvalidationPaths: ${cloudFrontInvalidationPaths.join(', ')}`);
+            devkit.logger.info(`   - buildTarget: ${buildTarget}`);
+            return success();
+        }
         if (!skipBuild) await utils.runCommand(`nx run ${buildTarget}`);
-        await helpers.cleanS3Bucket(s3BucketPath);
-        await helpers.copyAssetsToS3(s3BucketPath, root);
-        await helpers.createCloudFrontInvalidation(cloudFrontDistributionId, cloudFrontInvalidationPaths);
-        const now = new Date().toLocaleString();
-        return utils.ok(`✨ Build completed successfully on ${now}`);
+        await helpers.cleanS3Bucket(s3FullPath);
+        if (typings) {
+            await helpers.copyTypingsToS3(s3FullPath, root);
+        } else {
+            await helpers.copyAssetsToS3(s3FullPath, root);
+        }
+        await helpers.createCloudFrontInvalidation(cloudFrontId, cloudFrontInvalidationPaths);
+        return success();
     } catch (error) {
         return utils.err(error, '❌ Error when executing deploy command');
     }

package/dist/cjs/executors/deploy/schema.json

@@ -5,26 +5,21 @@
   "description": "Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache",
   "type": "object",
   "properties": {
-    "s3BucketPath": {
+    "s3Bucket": {
       "type": "string",
-      "description": "The AWS S3 bucket path where the project assets will be deployed. Format: 's3://bucket-name/path'"
+      "description": "The AWS S3 bucket path where the project assets will be deployed. Ie: 'bucket-name'"
     },
-    "customPath": {
+    "rootDir": {
       "type": "string",
-      "description": "Optional path to deploy to a custom s3BucketPath folder: Ie: pmx run ssv-script:deploy:custom --buildTarget build:prod --customPath jose"
+      "description": "root directory in s3Bucket, by default it's the name of the project: Ie: pmx run ssv-script:deploy:custom --buildTarget build:prod --rootDir your-root-dir"
     },
-    "cloudFrontDistributionId": {
+    "assetsDir": {
       "type": "string",
-      "description": "The ID of the AWS CloudFront distribution for cache invalidation, ensuring updated assets are served."
+      "description": "assets directory for store dist files, by default it's the name of the project: Ie: pmx run ssv-script:deploy:custom --buildTarget build:prod --rootDir your-root-dir"
     },
-    "cloudFrontInvalidationPaths": {
-      "type": "array",
-      "description": "List of paths to invalidate in the CloudFront cache. Specify at least one path. Example: ['/index.html']",
-      "items": {
-        "type": "string"
-      },
-      "uniqueItems": true,
-      "minItems": 1
+    "cloudFrontId": {
+      "type": "string",
+      "description": "The ID of the AWS CloudFront distribution for cache invalidation, ensuring updated assets are served."
     },
     "buildTarget": {
       "type": "string",
@@ -34,12 +29,19 @@
       "type": "boolean",
       "description": "It allows to omit the Build process and assumes that it was already done",
       "default": false
+    },
+    "typings": {
+      "type": "boolean",
+      "description": "Flag to indicate whether to upload .d.ts files for specific libraries",
+      "default": false
+    },
+    "ignoreConfigs": {
+      "type": "array",
+      "description": "List of configs to ignore",
+      "items": {
+        "type": "string"
+      }
     }
   },
-  "required": [
-    "s3BucketPath",
-    "cloudFrontDistributionId",
-    "cloudFrontInvalidationPaths",
-    "buildTarget"
-  ]
+  "required": ["s3Bucket", "cloudFrontId", "buildTarget"]
 }

package/dist/cjs/executors/environments/index.cjs

@@ -10,12 +10,10 @@ const ENV_DIR = 'src/environments';
 const ENV_DEV_FILE = 'environment.ts';
 const ENV_LOCAL_FILE = 'environment.local.ts';
 const ENV_PROD_FILE = 'environment.prod.ts';
-const ENV_STAGING_FILE = 'environment.staging.ts';
 const environmentFiles = [
     ENV_DEV_FILE,
     ENV_LOCAL_FILE,
-    ENV_PROD_FILE,
-    ENV_STAGING_FILE
+    ENV_PROD_FILE
 ];
 /**
  * The executor function to create environment files.

package/dist/cjs/executors/shared/utils.cjs

@@ -37,12 +37,13 @@ const execAsync = util.promisify(child_process.exec);
  * Retrieves the project configuration for the current execution context.
  *
  * @param {ExecutorContext} ctx - The execution context containing project information.
- * @returns {ProjectConfiguration} - The configuration object for the current project.
+ * @returns {MyProjectConfiguration} - The configuration object for the current project.
  * @throws {Error} If the project configuration is invalid or not found.
  */ function getProjectConfig(ctx) {
     const projectName = ctx.projectName || '';
     const projectConfig = ctx.projectsConfigurations?.projects?.[projectName];
     if (!projectConfig) throw new Error('Invalid project configuration.');
+    if (!projectConfig.name) throw new Error('Invalid project name.');
     return projectConfig;
 }
 async function runCommand(command, cwd) {

package/dist/esm/executors/deploy/helpers.mjs

@@ -11,6 +11,12 @@ async function copyAssetsToS3(s3BucketPath, projectRoot) {
     await runCommand(`aws s3 cp ${projectRoot}/dist ${s3BucketPath} --recursive`);
     logger.info('🚚 Assets files copied.');
 }
+async function copyTypingsToS3(s3BucketPath, projectRoot) {
+    const typingsPath = `${projectRoot}/dist`;
+    logger.info(`📦 Copying typings to S3 bucket at ${s3BucketPath}...`);
+    await runCommand(`aws s3 cp ${typingsPath} ${s3BucketPath} --recursive --exclude "*" --include "*.d.ts"`);
+    logger.info('🚚 Typings files copied.');
+}
 async function createCloudFrontInvalidation(distributionId, invalidationPaths) {
     const pathsString = invalidationPaths.map((path)=>`"${path}"`).join(' ');
     const command = `aws cloudfront create-invalidation --distribution-id ${distributionId} --paths ${pathsString}`;
@@ -18,18 +24,24 @@ async function createCloudFrontInvalidation(distributionId, invalidationPaths) {
     await runCommand(command);
     logger.info('🔄 CloudFront invalidation created.');
 }
-function validateCustomPath(args) {
-    let s3BucketPath = args.s3BucketPath;
-    let cloudFrontInvalidationPaths = args.cloudFrontInvalidationPaths;
-    if (args.customPath) {
-        logger.info(`🔃 Using S3 custom path: "${args.customPath}"`);
-        s3BucketPath = args.s3BucketPath.replace('{customPath}', args.customPath);
-        cloudFrontInvalidationPaths = args.cloudFrontInvalidationPaths.map((x)=>x.replace('{customPath}', args.customPath));
-    }
+function buildS3Path(args) {
+    const slash = (s)=>s ? `/${s}` : '';
+    const rootDir = args.rootDir !== undefined ? args.rootDir : args.name;
+    const assetsDir = args.assetsDir !== undefined ? args.assetsDir : args.name;
+    const s3Bucket = `s3://${args.s3Bucket}`;
+    const s3Path = `${rootDir}${slash(assetsDir)}`;
+    const s3FullPath = `${s3Bucket}${slash(s3Path)}`;
+    const cloudFrontInvalidationPaths = [
+        `${slash(s3Path)}/*`
+    ];
     return {
-        s3BucketPath,
+        rootDir,
+        assetsDir,
+        s3Bucket,
+        s3Path,
+        s3FullPath,
         cloudFrontInvalidationPaths
     };
 }
 
-export { cleanS3Bucket, copyAssetsToS3, createCloudFrontInvalidation, validateCustomPath };
+export { buildS3Path, cleanS3Bucket, copyAssetsToS3, copyTypingsToS3, createCloudFrontInvalidation };

package/dist/esm/executors/deploy/index.mjs

@@ -1,18 +1,40 @@
-import { getProjectConfig, runCommand, ok, err } from '../shared/utils.mjs';
-import { validateCustomPath, cleanS3Bucket, copyAssetsToS3, createCloudFrontInvalidation } from './helpers.mjs';
+import { logger } from '@nx/devkit';
+import { ok, getProjectConfig, runCommand, err } from '../shared/utils.mjs';
+import { buildS3Path, cleanS3Bucket, copyTypingsToS3, copyAssetsToS3, createCloudFrontInvalidation } from './helpers.mjs';
 
 async function deployExecutor(opts, ctx) {
     try {
+        const { cloudFrontId, skipBuild = false, typings = false, ignoreConfigs = [], dryRun = false } = opts;
+        const success = ()=>{
+            const now = new Date().toLocaleString();
+            return ok(`✨ Build completed successfully on ${now}`);
+        };
+        if (ctx.configurationName && ignoreConfigs.includes(ctx.configurationName)) {
+            logger.info(`❗ Configuration ignored: ${ctx.configurationName}`);
+            return success();
+        }
         const { root, name } = getProjectConfig(ctx);
-        const { cloudFrontDistributionId, skipBuild = false } = opts;
         const buildTarget = `${name}:${opts.buildTarget}`;
-        const { s3BucketPath, cloudFrontInvalidationPaths } = validateCustomPath(opts);
+        const { s3FullPath, cloudFrontInvalidationPaths } = buildS3Path({
+            ...opts,
+            name
+        });
+        if (dryRun) {
+            logger.info('😉 Dry run mode enabled');
+            logger.info(`   - s3Path: ${s3FullPath}`);
+            logger.info(`   - cloudFrontInvalidationPaths: ${cloudFrontInvalidationPaths.join(', ')}`);
+            logger.info(`   - buildTarget: ${buildTarget}`);
+            return success();
+        }
         if (!skipBuild) await runCommand(`nx run ${buildTarget}`);
-        await cleanS3Bucket(s3BucketPath);
-        await copyAssetsToS3(s3BucketPath, root);
-        await createCloudFrontInvalidation(cloudFrontDistributionId, cloudFrontInvalidationPaths);
-        const now = new Date().toLocaleString();
-        return ok(`✨ Build completed successfully on ${now}`);
+        await cleanS3Bucket(s3FullPath);
+        if (typings) {
+            await copyTypingsToS3(s3FullPath, root);
+        } else {
+            await copyAssetsToS3(s3FullPath, root);
+        }
+        await createCloudFrontInvalidation(cloudFrontId, cloudFrontInvalidationPaths);
+        return success();
     } catch (error) {
         return err(error, '❌ Error when executing deploy command');
     }

package/dist/esm/executors/deploy/schema.json

@@ -5,26 +5,21 @@
   "description": "Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache",
   "type": "object",
   "properties": {
-    "s3BucketPath": {
+    "s3Bucket": {
       "type": "string",
-      "description": "The AWS S3 bucket path where the project assets will be deployed. Format: 's3://bucket-name/path'"
+      "description": "The AWS S3 bucket path where the project assets will be deployed. Ie: 'bucket-name'"
     },
-    "customPath": {
+    "rootDir": {
       "type": "string",
-      "description": "Optional path to deploy to a custom s3BucketPath folder: Ie: pmx run ssv-script:deploy:custom --buildTarget build:prod --customPath jose"
+      "description": "root directory in s3Bucket, by default it's the name of the project: Ie: pmx run ssv-script:deploy:custom --buildTarget build:prod --rootDir your-root-dir"
     },
-    "cloudFrontDistributionId": {
+    "assetsDir": {
       "type": "string",
-      "description": "The ID of the AWS CloudFront distribution for cache invalidation, ensuring updated assets are served."
+      "description": "assets directory for store dist files, by default it's the name of the project: Ie: pmx run ssv-script:deploy:custom --buildTarget build:prod --rootDir your-root-dir"
     },
-    "cloudFrontInvalidationPaths": {
-      "type": "array",
-      "description": "List of paths to invalidate in the CloudFront cache. Specify at least one path. Example: ['/index.html']",
-      "items": {
-        "type": "string"
-      },
-      "uniqueItems": true,
-      "minItems": 1
+    "cloudFrontId": {
+      "type": "string",
+      "description": "The ID of the AWS CloudFront distribution for cache invalidation, ensuring updated assets are served."
     },
     "buildTarget": {
       "type": "string",
@@ -34,12 +29,19 @@
       "type": "boolean",
       "description": "It allows to omit the Build process and assumes that it was already done",
       "default": false
+    },
+    "typings": {
+      "type": "boolean",
+      "description": "Flag to indicate whether to upload .d.ts files for specific libraries",
+      "default": false
+    },
+    "ignoreConfigs": {
+      "type": "array",
+      "description": "List of configs to ignore",
+      "items": {
+        "type": "string"
+      }
     }
   },
-  "required": [
-    "s3BucketPath",
-    "cloudFrontDistributionId",
-    "cloudFrontInvalidationPaths",
-    "buildTarget"
-  ]
+  "required": ["s3Bucket", "cloudFrontId", "buildTarget"]
 }

package/dist/esm/executors/environments/index.mjs

@@ -8,12 +8,10 @@ const ENV_DIR = 'src/environments';
 const ENV_DEV_FILE = 'environment.ts';
 const ENV_LOCAL_FILE = 'environment.local.ts';
 const ENV_PROD_FILE = 'environment.prod.ts';
-const ENV_STAGING_FILE = 'environment.staging.ts';
 const environmentFiles = [
     ENV_DEV_FILE,
     ENV_LOCAL_FILE,
-    ENV_PROD_FILE,
-    ENV_STAGING_FILE
+    ENV_PROD_FILE
 ];
 /**
  * The executor function to create environment files.

package/dist/esm/executors/shared/utils.mjs

@@ -35,12 +35,13 @@ const execAsync = promisify(exec);
  * Retrieves the project configuration for the current execution context.
  *
  * @param {ExecutorContext} ctx - The execution context containing project information.
- * @returns {ProjectConfiguration} - The configuration object for the current project.
+ * @returns {MyProjectConfiguration} - The configuration object for the current project.
  * @throws {Error} If the project configuration is invalid or not found.
  */ function getProjectConfig(ctx) {
     const projectName = ctx.projectName || '';
     const projectConfig = ctx.projectsConfigurations?.projects?.[projectName];
     if (!projectConfig) throw new Error('Invalid project configuration.');
+    if (!projectConfig.name) throw new Error('Invalid project name.');
     return projectConfig;
 }
 async function runCommand(command, cwd) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizza/devkit",
-  "version": "0.1.3-beta.3",
+  "version": "0.2.0-beta.5",
   "type": "module",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",