WIP Draft that attempts to use new endpoints to post fields

Author: bickelj

src/charityNavigator.ts

@@ -7,9 +7,12 @@ import { HttpLink } from '@apollo/client/link/http';
 import { isValidEin } from './ein';
 import { logger } from './logger';
 import { AccessTokenSet, getToken, oidcOptions } from './oidc';
-import { getChangemakers, getSources, postSource } from './pdc-api';
+import {
+  getChangemakers, getSources, postChangemakerFieldValue, postChangemakerFieldValueBatch,
+  postSource,
+} from './pdc-api';
 import type { CommandModule } from 'yargs';
-import type { Source } from '@pdc/sdk';
+import type { Changemaker, ChangemakerBundle, Source } from '@pdc/sdk';
 
 const CN_SHORT_CODE = 'charitynav';
 
@@ -24,8 +27,18 @@ interface NonprofitPublic {
   encompassScore?: number,
   encompassStarRating?: number
   encompassPublicationDate?: string,
+  size?: string,
+  cause?: string,
 }
 
+/** Map from Charity Navigator NonprofitPublic attribute name to PDC base field name */
+const baseFieldMap = {
+  name: 'organization_name',
+  website: 'organization_website',
+  phone: 'organization_phone',
+  mission: 'organization_mission_statement',
+};
+
 interface PageInfo {
   totalPages: number;
   totalItems: number;
@@ -72,6 +85,8 @@ NonprofitsPublicVariables
           encompassScore
           encompassStarRating
           encompassPublicationDate
+          size
+          cause
         }
         pageInfo {
           totalPages
@@ -205,6 +220,22 @@ const lookupCommand: CommandModule<unknown, LookupCommandArgs> = {
   },
 };
 
+const getChangemakerByEin = (ein: string, changemakers: ChangemakerBundle): Changemaker | null => {
+  const matches = changemakers.entries.filter((c) => c.taxId === ein);
+  if (matches.length > 1) {
+    logger.warn(`Found multiple changemakers with EIN ${ein}, not returning any.`);
+    return null;
+  }
+  if (matches.length < 1) {
+    logger.info(`Found no changemaker with EIN ${ein}`);
+    return null;
+  }
+  if (matches.length === 1 && matches[0] !== undefined) {
+    return matches[0];
+  }
+  throw new Error('How could this have happened?');
+};
+
 const getOrCreateSource = async (baseUrl: string, token: AccessTokenSet): Promise<Source> => {
   const sources = await getSources(baseUrl, token);
   const filteredSources = sources.entries.filter((s) => s.dataProviderShortCode === CN_SHORT_CODE);
@@ -262,15 +293,38 @@ const updateAllCommand: CommandModule<unknown, UpdateAllCommandArgs> = {
       args.oidcClientId,
       args.oidcClientSecret,
     );
+    if (!charityNavResponse.data) {
+      logger.warn('No data found');
+      return;
+    }
     // First, find the existing source. As of this writing, it cannot be created by non-admins.
     const source = await getOrCreateSource(args.pdcApiBaseUrl, token);
     logger.info(source, 'The PDC Source for Charity Navigator was found');
     // Second, post the fields to PDC
-    if (charityNavResponse.data) {
-      const { edges } = charityNavResponse.data.nonprofitsPublic;
-      const nonprofits = edges.filter((e): e is NonprofitPublic => isNonprofitPublic(e));
-      logger.info(nonprofits, 'Found these nonprofits');
-    }
+    const { edges } = charityNavResponse.data.nonprofitsPublic;
+    const nonprofits = edges.filter((e): e is NonprofitPublic => isNonprofitPublic(e));
+    logger.info(nonprofits, 'Found these nonprofits');
+    // Third, register a batch of changemaker fields to be posted
+    const fieldBatch = await postChangemakerFieldValueBatch(args.pdcApiBaseUrl, token, { sourceId: source.id, notes: `data-scripts charityNavigator.ts execution ${Date.now()}` });
+    // Last, for each nonprofit, for each field, post the field
+    edges.map(async (e) => {
+      const changemaker = getChangemakerByEin(e.ein, changemakers);
+      if (changemaker !== null) {
+        Object.entries(baseFieldMap).map(async ([cnAttributeName, baseFieldShortCode]) => {
+          const cnAttribute = e[cnAttributeName as keyof NonprofitPublic];
+          if (cnAttribute !== undefined) {
+            const fieldValue = await postChangemakerFieldValue(args.pdcApiBaseUrl, token, {
+              changemakerId: changemaker.id,
+              batchId: fieldBatch.id,
+              baseFieldShortCode,
+              value: cnAttribute.toString(),
+              goodAsOf: e.updatedAt,
+            });
+            logger.info(`Added changemaker field value: ${JSON.stringify(fieldValue)}`);
+          }
+        });
+      }
+    });
   },
 };
 

src/pdc-api.ts

@@ -98,6 +98,70 @@ const postSource = (baseUrl: string, token: AccessTokenSet, data: WritableSource
   )
 );
 
+// TODO: use the SDK, delete these temp types copied from the service repo
+interface ChangemakerFieldValueBatch {
+  readonly id: number;
+  sourceId: number;
+  notes: string | null;
+  readonly createdAt: string;
+  readonly source: Source;
+}
+interface ChangemakerFieldValue {
+  readonly id: number;
+  changemakerId: number;
+  baseFieldShortCode: string;
+  batchId: number;
+  value: string;
+  readonly file: File | null;
+  goodAsOf: string | null;
+  readonly createdAt: string;
+  readonly baseField: BaseField;
+  readonly batch: ChangemakerFieldValueBatch;
+  readonly isValid: boolean;
+}
+
+interface WritableChangemakerFieldValueBatch {
+  sourceId: number;
+  notes: string | null;
+}
+interface WritableChangemakerFieldValue {
+  changemakerId: number;
+  baseFieldShortCode: string;
+  batchId: number;
+  value: string;
+  goodAsOf: string | null;
+}
+
+const postChangemakerFieldValueBatch = (
+  baseUrl: string,
+  token: AccessTokenSet,
+  data: WritableChangemakerFieldValueBatch,
+) => (
+  callPdcApi<ChangemakerFieldValueBatch>(
+    baseUrl,
+    '/changemakerFieldValueBatches',
+    {},
+    'post',
+    token,
+    data,
+  )
+);
+
+const postChangemakerFieldValue = (
+  baseUrl: string,
+  token: AccessTokenSet,
+  data: WritableChangemakerFieldValue,
+) => (
+  callPdcApi<ChangemakerFieldValue>(
+    baseUrl,
+    '/changemakerFieldValues',
+    {},
+    'post',
+    token,
+    data,
+  )
+);
+
 const postPlatformProviderData = (
   baseUrl: string,
   token: AccessTokenSet,
@@ -120,10 +184,14 @@ const postPlatformProviderData = (
 );
 
 export {
+  ChangemakerFieldValue,
+  ChangemakerFieldValueBatch,
   getBaseFields,
   getChangemakers,
   getProposals,
   getSources,
+  postChangemakerFieldValueBatch,
+  postChangemakerFieldValue,
   postPlatformProviderData,
   postSource,
 };