@friggframework/api-module-hubspot 2.0.0-next.2 → 2.0.0-next.3

package/definition.js

@@ -18,7 +18,7 @@ const Definition = {
         getEntityDetails: async function (api, callbackParams, tokenResponse, userId) {
             const userDetails = await api.getUserDetails();
             return {
-                identifiers: {externalId: userDetails.portalId, userId},
+                identifiers: {externalId: String(userDetails.portalId), userId},
                 details: {name: userDetails.hub_domain},
             }
         },
@@ -31,7 +31,7 @@ const Definition = {
         getCredentialDetails: async function (api, userId) {
             const userDetails = await api.getUserDetails();
             return {
-                identifiers: {externalId: userDetails.portalId, userId},
+                identifiers: {externalId: String(userDetails.portalId), userId},
                 details: {}
             };
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/api-module-hubspot",
-  "version": "2.0.0-next.2",
+  "version": "2.0.0-next.3",
   "prettier": "@friggframework/prettier-config",
   "description": "HubSpot API module that lets the Frigg Framework interact with HubSpot",
   "main": "index.js",
@@ -22,5 +22,5 @@
   "dependencies": {
     "@friggframework/core": "^2.0.0-next.16"
   },
-  "gitHead": "6976db7ea821bb6e15e171d51c3e1938b6c566f9"
+  "gitHead": "13f08e689a67d6b3cbaf5774056557d25ce6e5f2"
 }

package/tests/definition.test.js

@@ -0,0 +1,67 @@
+/**
+ * Definition unit tests — assert the shape of identifiers handed to
+ * Frigg core during the auth handshake. The Postgres schema in
+ * @friggframework/core ≥ 2.0.0-next types Credential.externalId as
+ * String?, so portalId (Int from HubSpot's /access-tokens response)
+ * must be stringified at the api-module boundary.
+ */
+
+const { Definition } = require('../definition');
+
+const baseUserDetails = {
+    portalId: 111111111, // HubSpot returns this as an integer
+    hub_domain: 'Testing Object Things-dev-44613847.com',
+    hub_id: 111111111,
+};
+
+function makeStubApi(userDetailsOverride = {}) {
+    return {
+        getUserDetails: async () =>
+            Object.assign({}, baseUserDetails, userDetailsOverride),
+    };
+}
+
+describe('HubSpot Definition externalId coercion', () => {
+    describe('getEntityDetails()', () => {
+        it('returns externalId as a string, not an integer', async () => {
+            const api = makeStubApi();
+            const result =
+                await Definition.requiredAuthMethods.getEntityDetails(
+                    api,
+                    null,
+                    null,
+                    42
+                );
+
+            expect(typeof result.identifiers.externalId).toBe('string');
+            expect(result.identifiers.externalId).toBe('111111111');
+        });
+
+        it('stringifies a very large portalId without losing precision', async () => {
+            const api = makeStubApi({ portalId: 9999999999 });
+            const result =
+                await Definition.requiredAuthMethods.getEntityDetails(
+                    api,
+                    null,
+                    null,
+                    42
+                );
+
+            expect(result.identifiers.externalId).toBe('9999999999');
+        });
+    });
+
+    describe('getCredentialDetails()', () => {
+        it('returns externalId as a string, not an integer', async () => {
+            const api = makeStubApi();
+            const result =
+                await Definition.requiredAuthMethods.getCredentialDetails(
+                    api,
+                    42
+                );
+
+            expect(typeof result.identifiers.externalId).toBe('string');
+            expect(result.identifiers.externalId).toBe('111111111');
+        });
+    });
+});