@codedrifters/utils 0.0.1 → 0.0.2

package/README.md

@@ -209,42 +209,49 @@ function configureDeployment(stage: AwsStageType) {
 - `AWS_STAGE_TYPE.STAGE` - Staging environment
 - `AWS_STAGE_TYPE.PROD` - Production environment
 
-#### `AWS_ENVIRONMENT_TYPE` and `AwsEnvironmentType`
+#### `DEPLOYMENT_TARGET_ROLE` and `DeploymentTargetRoleType`
 
-Constants and types for environment classification (primary, secondary).
+Constants and types for deployment target role (primary vs secondary region).
 
 ```typescript
-import { AWS_ENVIRONMENT_TYPE, AwsEnvironmentType } from '@codedrifters/utils/lib/aws/aws-types';
+import { DEPLOYMENT_TARGET_ROLE, DeploymentTargetRoleType } from '@codedrifters/utils/lib/aws/aws-types';
 
 // Use the constant
-const env = AWS_ENVIRONMENT_TYPE.PRIMARY; // "primary"
-const replicaEnv = AWS_ENVIRONMENT_TYPE.SECONDARY; // "secondary"
+const role = DEPLOYMENT_TARGET_ROLE.PRIMARY; // "primary"
+const replicaRole = DEPLOYMENT_TARGET_ROLE.SECONDARY; // "secondary"
 
 // Use the type
-function configureRegion(env: AwsEnvironmentType) {
-  // env can be "primary" or "secondary"
+function configureRegion(role: DeploymentTargetRoleType) {
+  // role can be "primary" or "secondary"
 }
 ```
 
 **Available Values:**
-- `AWS_ENVIRONMENT_TYPE.PRIMARY` - Primary region/environment
-- `AWS_ENVIRONMENT_TYPE.SECONDARY` - Secondary/replica region/environment
+- `DEPLOYMENT_TARGET_ROLE.PRIMARY` - Primary deployment target (account/region)
+- `DEPLOYMENT_TARGET_ROLE.SECONDARY` - Secondary/replica deployment target
 
 **Example Usage:**
 
 ```typescript
-import { AWS_STAGE_TYPE, AWS_ENVIRONMENT_TYPE } from '@codedrifters/utils/lib/aws/aws-types';
+import { AWS_STAGE_TYPE, DEPLOYMENT_TARGET_ROLE } from '@codedrifters/utils/lib/aws/aws-types';
 import { AwsDeploymentTarget } from '@codedrifters/configulator';
 
-// Configure a deployment target
+// Configure a deployment target (preferred: deploymentTargetRole)
 new AwsDeploymentTarget(project, {
   account: '123456789012',
   region: 'us-east-1',
   awsStageType: AWS_STAGE_TYPE.PROD,
-  awsEnvironmentType: AWS_ENVIRONMENT_TYPE.PRIMARY,
+  deploymentTargetRole: DEPLOYMENT_TARGET_ROLE.PRIMARY,
 });
 ```
 
+#### `AWS_ENVIRONMENT_TYPE` and `AwsEnvironmentType` (deprecated)
+
+**Deprecated.** Use `DEPLOYMENT_TARGET_ROLE` and `DeploymentTargetRoleType` instead. These names are maintained for backward compatibility.
+
+- `AWS_ENVIRONMENT_TYPE` - Same as `DEPLOYMENT_TARGET_ROLE` (PRIMARY, SECONDARY)
+- `AwsEnvironmentType` - Same as `DeploymentTargetRoleType`
+
 ## API Reference
 
 ### Exports
@@ -262,8 +269,10 @@ The package exports the following utility functions:
 **AWS Types:**
 - `AWS_STAGE_TYPE` - Constants for deployment stages (DEV, STAGE, PROD)
 - `AwsStageType` - Type for deployment stage values
-- `AWS_ENVIRONMENT_TYPE` - Constants for environment types (PRIMARY, SECONDARY)
-- `AwsEnvironmentType` - Type for environment type values
+- `DEPLOYMENT_TARGET_ROLE` - Constants for deployment target role (PRIMARY, SECONDARY)
+- `DeploymentTargetRoleType` - Type for deployment target role values
+- `AWS_ENVIRONMENT_TYPE` - (Deprecated) Use `DEPLOYMENT_TARGET_ROLE` instead
+- `AwsEnvironmentType` - (Deprecated) Use `DeploymentTargetRoleType` instead
 
 ### Import Paths
 

package/lib/aws/aws-types.d.ts

@@ -22,9 +22,29 @@ export declare const AWS_STAGE_TYPE: {
  */
 export type AwsStageType = (typeof AWS_STAGE_TYPE)[keyof typeof AWS_STAGE_TYPE];
 /**
- * Environment Types
+ * Deployment target role: whether an (account, region) is the primary or
+ * secondary deployment target (e.g. primary vs replica region).
+ */
+export declare const DEPLOYMENT_TARGET_ROLE: {
+    /**
+     * Account and region that represents the primary region for this service.
+     * For example, the base DynamoDB Region for global tables.
+     */
+    readonly PRIMARY: "primary";
+    /**
+     * Account and region that represents a secondary region for this service.
+     * For example, a replica region for a global DynamoDB table.
+     */
+    readonly SECONDARY: "secondary";
+};
+/**
+ * Type for deployment target role values.
+ */
+export type DeploymentTargetRoleType = (typeof DEPLOYMENT_TARGET_ROLE)[keyof typeof DEPLOYMENT_TARGET_ROLE];
+/**
+ * Environment types (primary/secondary).
  *
- * Is this a primary of secondary region / environment?
+ * @deprecated Use {@link DEPLOYMENT_TARGET_ROLE} instead. This constant is maintained for backward compatibility.
  */
 export declare const AWS_ENVIRONMENT_TYPE: {
     /**
@@ -39,6 +59,8 @@ export declare const AWS_ENVIRONMENT_TYPE: {
     readonly SECONDARY: "secondary";
 };
 /**
- * Above const as a type.
+ * Type for environment type values.
+ *
+ * @deprecated Use {@link DeploymentTargetRoleType} instead. This type is maintained for backward compatibility.
  */
-export type AwsEnvironmentType = (typeof AWS_ENVIRONMENT_TYPE)[keyof typeof AWS_ENVIRONMENT_TYPE];
+export type AwsEnvironmentType = DeploymentTargetRoleType;

package/lib/aws/aws-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AWS_ENVIRONMENT_TYPE = exports.AWS_STAGE_TYPE = void 0;
+exports.AWS_ENVIRONMENT_TYPE = exports.DEPLOYMENT_TARGET_ROLE = exports.AWS_STAGE_TYPE = void 0;
 /**
  * Stage Types
  *
@@ -21,11 +21,10 @@ exports.AWS_STAGE_TYPE = {
     PROD: "prod",
 };
 /**
- * Environment Types
- *
- * Is this a primary of secondary region / environment?
+ * Deployment target role: whether an (account, region) is the primary or
+ * secondary deployment target (e.g. primary vs replica region).
  */
-exports.AWS_ENVIRONMENT_TYPE = {
+exports.DEPLOYMENT_TARGET_ROLE = {
     /**
      * Account and region that represents the primary region for this service.
      * For example, the base DynamoDB Region for global tables.
@@ -37,4 +36,10 @@ exports.AWS_ENVIRONMENT_TYPE = {
      */
     SECONDARY: "secondary",
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXdzLXR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2F3cy9hd3MtdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7R0FJRztBQUNVLFFBQUEsY0FBYyxHQUFHO0lBQzVCOztPQUVHO0lBQ0gsR0FBRyxFQUFFLEtBQUs7SUFFVjs7T0FFRztJQUNILEtBQUssRUFBRSxPQUFPO0lBRWQ7O09BRUc7SUFDSCxJQUFJLEVBQUUsTUFBTTtDQUNKLENBQUM7QUFPWDs7OztHQUlHO0FBQ1UsUUFBQSxvQkFBb0IsR0FBRztJQUNsQzs7O09BR0c7SUFDSCxPQUFPLEVBQUUsU0FBUztJQUNsQjs7O09BR0c7SUFDSCxTQUFTLEVBQUUsV0FBVztDQUNkLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIFN0YWdlIFR5cGVzXG4gKlxuICogV2hhdCBzdGFnZSBvZiBkZXBsb3ltZW50IGlzIHRoaXM/IERldiwgc3RhZ2luZywgb3IgcHJvZD9cbiAqL1xuZXhwb3J0IGNvbnN0IEFXU19TVEFHRV9UWVBFID0ge1xuICAvKipcbiAgICogRGV2ZWxvcG1lbnQgZW52aXJvbm1lbnQsIHR5cGljYWxseSB1c2VkIGZvciB0ZXN0aW5nIGFuZCBkZXZlbG9wbWVudC5cbiAgICovXG4gIERFVjogXCJkZXZcIixcblxuICAvKipcbiAgICogU3RhZ2luZyBlbnZpcm9ubWVudCwgdXNlZCBmb3IgcHJlLXByb2R1Y3Rpb24gdGVzdGluZy5cbiAgICovXG4gIFNUQUdFOiBcInN0YWdlXCIsXG5cbiAgLyoqXG4gICAqIFByb2R1Y3Rpb24gZW52aXJvbm1lbnQsIHVzZWQgZm9yIGxpdmUgZGVwbG95bWVudHMuXG4gICAqL1xuICBQUk9EOiBcInByb2RcIixcbn0gYXMgY29uc3Q7XG5cbi8qKlxuICogQWJvdmUgY29uc3QgYXMgYSB0eXBlLlxuICovXG5leHBvcnQgdHlwZSBBd3NTdGFnZVR5cGUgPSAodHlwZW9mIEFXU19TVEFHRV9UWVBFKVtrZXlvZiB0eXBlb2YgQVdTX1NUQUdFX1RZUEVdO1xuXG4vKipcbiAqIEVudmlyb25tZW50IFR5cGVzXG4gKlxuICogSXMgdGhpcyBhIHByaW1hcnkgb2Ygc2Vjb25kYXJ5IHJlZ2lvbiAvIGVudmlyb25tZW50P1xuICovXG5leHBvcnQgY29uc3QgQVdTX0VOVklST05NRU5UX1RZUEUgPSB7XG4gIC8qKlxuICAgKiBBY2NvdW50IGFuZCByZWdpb24gdGhhdCByZXByZXNlbnRzIHRoZSBwcmltYXJ5IHJlZ2lvbiBmb3IgdGhpcyBzZXJ2aWNlLlxuICAgKiBGb3IgZXhhbXBsZSwgdGhlIGJhc2UgRHluYW1vREIgUmVnaW9uIGZvciBnbG9iYWwgdGFibGVzLlxuICAgKi9cbiAgUFJJTUFSWTogXCJwcmltYXJ5XCIsXG4gIC8qKlxuICAgKiBBY2NvdW50IGFuZCByZWdpb24gdGhhdCByZXByZXNlbnRzIGEgc2Vjb25kYXJ5IHJlZ2lvbiBmb3IgdGhpcyBzZXJ2aWNlLlxuICAgKiBGb3IgZXhhbXBsZSwgYSByZXBsaWNhIHJlZ2lvbiBmb3IgYSBnbG9iYWwgRHluYW1vREIgdGFibGUuXG4gICAqL1xuICBTRUNPTkRBUlk6IFwic2Vjb25kYXJ5XCIsXG59IGFzIGNvbnN0O1xuXG4vKipcbiAqIEFib3ZlIGNvbnN0IGFzIGEgdHlwZS5cbiAqL1xuZXhwb3J0IHR5cGUgQXdzRW52aXJvbm1lbnRUeXBlID1cbiAgKHR5cGVvZiBBV1NfRU5WSVJPTk1FTlRfVFlQRSlba2V5b2YgdHlwZW9mIEFXU19FTlZJUk9OTUVOVF9UWVBFXTtcbiJdfQ==
+/**
+ * Environment types (primary/secondary).
+ *
+ * @deprecated Use {@link DEPLOYMENT_TARGET_ROLE} instead. This constant is maintained for backward compatibility.
+ */
+exports.AWS_ENVIRONMENT_TYPE = exports.DEPLOYMENT_TARGET_ROLE;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXdzLXR5cGVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2F3cy9hd3MtdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7R0FJRztBQUNVLFFBQUEsY0FBYyxHQUFHO0lBQzVCOztPQUVHO0lBQ0gsR0FBRyxFQUFFLEtBQUs7SUFFVjs7T0FFRztJQUNILEtBQUssRUFBRSxPQUFPO0lBRWQ7O09BRUc7SUFDSCxJQUFJLEVBQUUsTUFBTTtDQUNKLENBQUM7QUFPWDs7O0dBR0c7QUFDVSxRQUFBLHNCQUFzQixHQUFHO0lBQ3BDOzs7T0FHRztJQUNILE9BQU8sRUFBRSxTQUFTO0lBQ2xCOzs7T0FHRztJQUNILFNBQVMsRUFBRSxXQUFXO0NBQ2QsQ0FBQztBQVFYOzs7O0dBSUc7QUFDVSxRQUFBLG9CQUFvQixHQUFHLDhCQUFzQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBTdGFnZSBUeXBlc1xuICpcbiAqIFdoYXQgc3RhZ2Ugb2YgZGVwbG95bWVudCBpcyB0aGlzPyBEZXYsIHN0YWdpbmcsIG9yIHByb2Q/XG4gKi9cbmV4cG9ydCBjb25zdCBBV1NfU1RBR0VfVFlQRSA9IHtcbiAgLyoqXG4gICAqIERldmVsb3BtZW50IGVudmlyb25tZW50LCB0eXBpY2FsbHkgdXNlZCBmb3IgdGVzdGluZyBhbmQgZGV2ZWxvcG1lbnQuXG4gICAqL1xuICBERVY6IFwiZGV2XCIsXG5cbiAgLyoqXG4gICAqIFN0YWdpbmcgZW52aXJvbm1lbnQsIHVzZWQgZm9yIHByZS1wcm9kdWN0aW9uIHRlc3RpbmcuXG4gICAqL1xuICBTVEFHRTogXCJzdGFnZVwiLFxuXG4gIC8qKlxuICAgKiBQcm9kdWN0aW9uIGVudmlyb25tZW50LCB1c2VkIGZvciBsaXZlIGRlcGxveW1lbnRzLlxuICAgKi9cbiAgUFJPRDogXCJwcm9kXCIsXG59IGFzIGNvbnN0O1xuXG4vKipcbiAqIEFib3ZlIGNvbnN0IGFzIGEgdHlwZS5cbiAqL1xuZXhwb3J0IHR5cGUgQXdzU3RhZ2VUeXBlID0gKHR5cGVvZiBBV1NfU1RBR0VfVFlQRSlba2V5b2YgdHlwZW9mIEFXU19TVEFHRV9UWVBFXTtcblxuLyoqXG4gKiBEZXBsb3ltZW50IHRhcmdldCByb2xlOiB3aGV0aGVyIGFuIChhY2NvdW50LCByZWdpb24pIGlzIHRoZSBwcmltYXJ5IG9yXG4gKiBzZWNvbmRhcnkgZGVwbG95bWVudCB0YXJnZXQgKGUuZy4gcHJpbWFyeSB2cyByZXBsaWNhIHJlZ2lvbikuXG4gKi9cbmV4cG9ydCBjb25zdCBERVBMT1lNRU5UX1RBUkdFVF9ST0xFID0ge1xuICAvKipcbiAgICogQWNjb3VudCBhbmQgcmVnaW9uIHRoYXQgcmVwcmVzZW50cyB0aGUgcHJpbWFyeSByZWdpb24gZm9yIHRoaXMgc2VydmljZS5cbiAgICogRm9yIGV4YW1wbGUsIHRoZSBiYXNlIER5bmFtb0RCIFJlZ2lvbiBmb3IgZ2xvYmFsIHRhYmxlcy5cbiAgICovXG4gIFBSSU1BUlk6IFwicHJpbWFyeVwiLFxuICAvKipcbiAgICogQWNjb3VudCBhbmQgcmVnaW9uIHRoYXQgcmVwcmVzZW50cyBhIHNlY29uZGFyeSByZWdpb24gZm9yIHRoaXMgc2VydmljZS5cbiAgICogRm9yIGV4YW1wbGUsIGEgcmVwbGljYSByZWdpb24gZm9yIGEgZ2xvYmFsIER5bmFtb0RCIHRhYmxlLlxuICAgKi9cbiAgU0VDT05EQVJZOiBcInNlY29uZGFyeVwiLFxufSBhcyBjb25zdDtcblxuLyoqXG4gKiBUeXBlIGZvciBkZXBsb3ltZW50IHRhcmdldCByb2xlIHZhbHVlcy5cbiAqL1xuZXhwb3J0IHR5cGUgRGVwbG95bWVudFRhcmdldFJvbGVUeXBlID1cbiAgKHR5cGVvZiBERVBMT1lNRU5UX1RBUkdFVF9ST0xFKVtrZXlvZiB0eXBlb2YgREVQTE9ZTUVOVF9UQVJHRVRfUk9MRV07XG5cbi8qKlxuICogRW52aXJvbm1lbnQgdHlwZXMgKHByaW1hcnkvc2Vjb25kYXJ5KS5cbiAqXG4gKiBAZGVwcmVjYXRlZCBVc2Uge0BsaW5rIERFUExPWU1FTlRfVEFSR0VUX1JPTEV9IGluc3RlYWQuIFRoaXMgY29uc3RhbnQgaXMgbWFpbnRhaW5lZCBmb3IgYmFja3dhcmQgY29tcGF0aWJpbGl0eS5cbiAqL1xuZXhwb3J0IGNvbnN0IEFXU19FTlZJUk9OTUVOVF9UWVBFID0gREVQTE9ZTUVOVF9UQVJHRVRfUk9MRTtcblxuLyoqXG4gKiBUeXBlIGZvciBlbnZpcm9ubWVudCB0eXBlIHZhbHVlcy5cbiAqXG4gKiBAZGVwcmVjYXRlZCBVc2Uge0BsaW5rIERlcGxveW1lbnRUYXJnZXRSb2xlVHlwZX0gaW5zdGVhZC4gVGhpcyB0eXBlIGlzIG1haW50YWluZWQgZm9yIGJhY2t3YXJkIGNvbXBhdGliaWxpdHkuXG4gKi9cbmV4cG9ydCB0eXBlIEF3c0Vudmlyb25tZW50VHlwZSA9IERlcGxveW1lbnRUYXJnZXRSb2xlVHlwZTtcbiJdfQ==

package/package.json

@@ -29,7 +29,7 @@
   },
   "main": "lib/index.js",
   "license": "MIT",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "types": "lib/index.d.ts",
   "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\".",
   "scripts": {
@@ -40,14 +40,12 @@
     "eslint": "npx projen eslint",
     "package": "npx projen package",
     "post-compile": "npx projen post-compile",
-    "post-upgrade": "npx projen post-upgrade",
     "pre-compile": "npx projen pre-compile",
     "release": "npx projen release",
     "reset": "npx projen reset",
     "test": "npx projen test",
     "test:watch": "npx projen test:watch",
     "unbump": "npx projen unbump",
-    "upgrade": "npx projen upgrade",
     "watch": "npx projen watch",
     "projen": "npx projen"
   }