feat: return raw phone number when requested via context (#15)

* feat: return raw phone number when requested via context

Author: andershermansen

README.md

@@ -190,6 +190,32 @@ Example response:
 }
 ```
 
+## Get the raw phone number value
+
+If you need to access the raw phone number value you can use context when you query:
+
+```ts
+const employees = await payload.find({
+  collection: 'employees',
+  where: {
+    phoneNumber: {
+      equals: '+4712345678'
+    }
+  },
+  context: {
+    phoneNumberPluginReturnRawValue: true,
+  },
+})
+```
+
+Example response:
+
+```json
+{
+  "phoneNumber": "+4712345678"
+}
+```
+
 ## Additional Information
 
 A region code is an ISO 3166-1 alpha-2 code.

dev/int.spec.ts

@@ -133,4 +133,30 @@ describe('Phone Number Plugin integration tests', () => {
             regionCode: 'US',
         });
     });
+
+    test('returns raw phone number string when requested via context', async () => {
+        const phoneNumber = '+4745360001';
+
+        const employee = await payload.create({
+            collection: 'employees',
+            data: {
+                name: 'Test',
+                phoneNumber,
+            },
+        });
+
+        expect(employee.phoneNumber).toMatchObject({
+            e164: phoneNumber,
+        });
+
+        const employeeWithRawPhone = await payload.findByID({
+            collection: 'employees',
+            id: employee.id,
+            context: {
+                phoneNumberPluginReturnRawValue: true,
+            },
+        });
+
+        expect(employeeWithRawPhone.phoneNumber).toBe(phoneNumber);
+    });
 });

src/fields/phoneNumber.ts

@@ -100,8 +100,8 @@ const phoneNumberField = <T extends RegionCode[] | undefined = undefined>({ requ
                 },
             ],
             afterRead: [
-                ({ value }) => {
-                    if (value && typeof value === 'string') {
+                ({ value, context }) => {
+                    if (value && typeof value === 'string' && context['phoneNumberPluginReturnRawValue'] !== true) {
                         return getPhoneNumberDetails(value);
                     }
                     return value;