Merge pull request #16 from owenr88/release/1.2.0

v1.2.0

Author: owenr88

.github/workflows/on-close-pr.yml

@@ -49,6 +49,7 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           custom_tag: ${{ steps.split.outputs.VERSION }}
+          tag_prefix: ""
       - name: Create a GitHub release
         uses: ncipollo/release-action@v1
         with:

README.md

@@ -20,6 +20,8 @@ Run `npm run start` to watch all packages for local development.
 
 Please open an issue and create a pull request with any contributions.
 
+We generate the changelog using [Angular's git message conventions](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
 ## Release
 
-Create a new release in Github to automatically bump the package.json version and release to NPM. Too easy!
+Close a new release/x.x.x PR to release to NPM. Too easy!

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "cognito-export",
   "description": "A simple CLI tool and JavaScript package for exporting users from an AWS Cognito user pool.",
-  "version": "1.1.10",
+  "version": "1.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": "dist/cli.js",
@@ -27,6 +27,7 @@
     "chalk": "^4.1.2",
     "commander": "^12.0.0",
     "papaparse": "^5.4.1",
+    "zod": "^3.23.8",
     "zod-cognito": "^1.0.13"
   },
   "devDependencies": {

packages/cognito-export/package.json

@@ -1,9 +1,11 @@
 import { ListUsersRequest } from "@aws-sdk/client-cognito-identity-provider";
 import * as fs from "fs";
 import Papa from "papaparse";
+import { z } from "zod";
 import {
   ImportRecordSchema,
   ImportRecordSchemaType,
+  extractCustomAttributeKeys,
   parseUserAttributes,
 } from "zod-cognito";
 import CognitoBase from "./CognitoBase";
@@ -30,8 +32,22 @@ export class CognitoExport extends CognitoBase {
         res?.Users?.forEach((user) => {
           if (users.length >= limit) return false;
 
+          // Convert the customAttributeKeys to an object
+          const customAttributeKeys = extractCustomAttributeKeys(
+            user.Attributes ?? []
+          );
+          const customAttr: Record<string, z.ZodType<string | number>> = {};
+          customAttributeKeys?.forEach((key) => {
+            customAttr[key] = z.union([z.string(), z.number()]);
+          });
+          customAttr.sub = z.string(); // Add this to exported data
+          const customAttributes = z.object(customAttr);
+
           // Map the attributes to a key-value object
-          const attrbs = parseUserAttributes(user.Attributes);
+          const attrbs = parseUserAttributes<typeof customAttr>(
+            user.Attributes,
+            customAttributes
+          );
 
           // Return if some core data isn't there
           if (!user.Username) {
@@ -54,12 +70,15 @@ export class CognitoExport extends CognitoBase {
             return false;
           }
 
+          // Delete the sub field from the export list
+          const { sub, ...attributesToExport } = attrbs;
+
           // Add the user to the list
           const newUser = ImportRecordSchema.safeParse({
             "cognito:username": user.Username,
             "cognito:mfa_enabled": false,
             updated_at: (user.UserLastModifiedDate ?? new Date()).toISOString(),
-            ...attrbs,
+            ...attributesToExport,
           });
           if (!newUser.success) {
             this.log(

packages/cognito-export/src/exporter.ts

@@ -1,7 +1,7 @@
 {
   "name": "cognito-import",
   "description": "A simple CLI tool and JavaScript package for importing users into an AWS Cognito user pool.",
-  "version": "1.1.10",
+  "version": "1.2.0",
   "main": "dist/index.js",
   "bin": "dist/cli.js",
   "repository": {

packages/cognito-import/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zod-cognito",
   "description": "Zod schemas for AWS Cognito User Pools",
-  "version": "1.1.10",
+  "version": "1.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {

packages/zod-cognito/package.json

@@ -4,15 +4,20 @@ import {
   ImportRecordSchema,
   ImportRecordSchemaType,
   RawImportRecordSchema,
-  UserAttributesSchema,
-  UserAttributesSchemaType,
+  RawUserAttributesSchema,
+  RawUserAttributesSchemaType,
+  extractCustomAttributeKeys,
   parseUserAttributes,
+  refineExtendedUserAttributesSchema,
 } from ".";
 
 describe("UserAttributesSchema", () => {
+  const RefinedUserAttributesSchema = refineExtendedUserAttributesSchema(
+    RawUserAttributesSchema
+  );
   it("should parse with email fields", () => {
     expect(
-      UserAttributesSchema.safeParse({
+      RefinedUserAttributesSchema.safeParse({
         sub: "test",
         email: "hello@test.com",
         email_verified: "true",
@@ -21,7 +26,7 @@ describe("UserAttributesSchema", () => {
   });
   it("should not parse email_verified without email", () => {
     expect(
-      UserAttributesSchema.safeParse({
+      RefinedUserAttributesSchema.safeParse({
         sub: "test",
         email: "",
         email_verified: "true",
@@ -30,7 +35,7 @@ describe("UserAttributesSchema", () => {
   });
   it("should not parse phone_number_verified without phone_number", () => {
     expect(
-      UserAttributesSchema.safeParse({
+      RefinedUserAttributesSchema.safeParse({
         sub: "test",
         phone_number: "",
         phone_number_verified: "true",
@@ -39,22 +44,13 @@ describe("UserAttributesSchema", () => {
   });
   it("should parse with phone_number fields", () => {
     expect(
-      UserAttributesSchema.safeParse({
+      RefinedUserAttributesSchema.safeParse({
         sub: "test",
         phone_number: "+1234567890",
         phone_number_verified: "true",
       }).success
     ).toBe(true);
   });
-  it("should not parse without email or phone_number fields", () => {
-    expect(
-      UserAttributesSchema.safeParse({
-        sub: "test",
-        email_verified: "false",
-        phone_number_verified: "false",
-      }).success
-    ).toBe(false);
-  });
 });
 
 describe("parseUserAttributes", () => {
@@ -84,18 +80,39 @@ describe("parseUserAttributes", () => {
     expect(result.sub).toBe("test");
     expect(result.email).toBe("test@test.com");
     expect(result.email_verified).toBe(true);
-    // expect(result["custom:thing"]).toBe("test2");
+    // @ts-expect-error need to fix this
+    expect(result["custom:thing"]).toBe("test2");
+  });
+});
+
+describe("extractCustomAttributeKeys", () => {
+  it("should extract custom attributes", () => {
+    const keys = extractCustomAttributeKeys([
+      { Name: "sub", Value: "test" },
+      { Name: "email", Value: "test@test.com" },
+      { Name: "email_verified", Value: "true" },
+      { Name: "custom:thing_one", Value: "exampl" },
+    ]);
+    expect(keys).toHaveLength(1);
+    expect(keys[0]).toBe("custom:thing_one");
+  });
+  it("should not extract when there are no custom attributes", () => {
+    const keys = extractCustomAttributeKeys([
+      { Name: "sub", Value: "test" },
+      { Name: "email", Value: "test@test.com" },
+      { Name: "email_verified", Value: "true" },
+    ]);
+    expect(keys).toHaveLength(0);
   });
 });
 
 describe("ImportRecordSchema", () => {
   const birthdate = new Date(2024, 2, 20);
-  const baseUser: UserAttributesSchemaType &
+  const baseUser: Omit<RawUserAttributesSchemaType, "sub"> &
     Pick<
       ImportRecordSchemaType,
       "cognito:username" | "cognito:mfa_enabled" | "updated_at"
     > = {
-    sub: "test",
     "cognito:username": "test",
     name: "test",
     given_name: "test",
@@ -155,13 +172,6 @@ describe("ImportRecordSchema", () => {
     ).toBe(false);
   });
   it("should parse with email fields", () => {
-    console.log(
-      ImportRecordSchema.parse({
-        ...baseUser,
-        email: "hello@test.com",
-        email_verified: true,
-      })
-    );
     expect(
       ImportRecordSchema.safeParse({
         ...baseUser,
@@ -192,23 +202,14 @@ describe("ImportRecordSchema", () => {
     expect(
       ImportRecordSchema.safeParse({
         ...baseUser,
-        sub: "test",
         phone_number: "+1234567890",
         phone_number_verified: true,
       }).success
     ).toBe(true);
   });
-  it("should not parse without email or phone_number fields", () => {
-    expect(
-      ImportRecordSchema.safeParse({
-        ...baseUser,
-        email_verified: false,
-        phone_number_verified: false,
-      }).success
-    ).toBe(false);
-  });
   it("should have a valid birth date", () => {
     const result = ImportRecordSchema.parse(baseUser);
+    console.log("result", result);
     expect(result.birthdate).toBe("03/20/2024");
   });
 });