@adisuper94/nih-reporter 0.0.1

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 120,
+  "singleQuote": false,
+  "semi": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+}

package/README.md

@@ -0,0 +1,4 @@
+# WIP: nih-reporter
+
+A TypeScript/JavaScript wrapper to call NIH reporter API
+

package/dist/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { NIHProjectQuery } from "./project.js";
+import { NIHProject } from "./types.js";
+export { NIHProjectQuery, NIHProject };

package/dist/lib/index.js

@@ -0,0 +1,2 @@
+import { NIHProjectQuery } from "./project.js";
+export { NIHProjectQuery };

package/dist/lib/project.d.ts

@@ -0,0 +1,23 @@
+import { NIHProject, NIHProjectFields } from "./types.js";
+declare class NIHProjectQuery {
+    private useRelavance;
+    private fiscalYears;
+    private includeActiveProjects;
+    private piProfileIds;
+    private excludeFields;
+    private offset;
+    private limit;
+    constructor();
+    setPIProfileIds(piProfileIds: number[]): NIHProjectQuery;
+    setFiscalYears(fiscalYears: number[]): NIHProjectQuery;
+    setUseRelevance(useRelevance: boolean): NIHProjectQuery;
+    setIncludeActiveProjects(includeActiveProjects: boolean): NIHProjectQuery;
+    setExcludeFields(excludeFields: NIHProjectFields[]): NIHProjectQuery;
+    addExcludeField(excludeField: NIHProjectFields): NIHProjectQuery;
+    removeExcludeField(excludeField: string): NIHProjectQuery;
+    setLimit(limit: number): NIHProjectQuery;
+    setOffset(offset: number): NIHProjectQuery;
+    execute(): Promise<NIHProject[]>;
+    iterator(): AsyncGenerator<NIHProject, void, unknown>;
+}
+export { NIHProjectQuery, NIHProject };

package/dist/lib/project.js

@@ -0,0 +1,108 @@
+import { parseNIHProject } from "./types.js";
+class NIHProjectQuery {
+    constructor() {
+        this.useRelavance = false;
+        this.fiscalYears = [];
+        this.includeActiveProjects = true;
+        this.piProfileIds = [];
+        this.excludeFields = [];
+        this.offset = 0;
+        this.limit = 50;
+    }
+    setPIProfileIds(piProfileIds) {
+        this.piProfileIds = piProfileIds;
+        return this;
+    }
+    setFiscalYears(fiscalYears) {
+        this.fiscalYears = fiscalYears;
+        return this;
+    }
+    setUseRelevance(useRelevance) {
+        this.useRelavance = useRelevance;
+        return this;
+    }
+    setIncludeActiveProjects(includeActiveProjects) {
+        this.includeActiveProjects = includeActiveProjects;
+        return this;
+    }
+    setExcludeFields(excludeFields) {
+        this.excludeFields = excludeFields;
+        return this;
+    }
+    addExcludeField(excludeField) {
+        if (!this.excludeFields.includes(excludeField)) {
+            this.excludeFields.push(excludeField);
+        }
+        return this;
+    }
+    removeExcludeField(excludeField) {
+        this.excludeFields = this.excludeFields.filter((field) => field !== excludeField);
+        return this;
+    }
+    setLimit(limit) {
+        if (limit <= 0) {
+            this.limit = 50;
+        }
+        else if (limit > 14999) {
+            this.limit = 14999;
+        }
+        else {
+            this.limit = limit;
+        }
+        return this;
+    }
+    setOffset(offset) {
+        if (offset < 0) {
+            this.offset = 0;
+        }
+        else {
+            this.offset = offset;
+        }
+        return this;
+    }
+    async execute() {
+        const resp = await fetch("https://api.reporter.nih.gov/v2/projects/search", {
+            method: "POST",
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify({
+                criteria: {
+                    use_relevance: this.useRelavance,
+                    fiscal_years: this.fiscalYears,
+                    include_active_projects: this.includeActiveProjects,
+                    pi_profile_ids: this.piProfileIds,
+                },
+                exclude_fields: this.excludeFields,
+                offset: this.offset,
+                limit: this.limit,
+            }),
+        });
+        const data = await resp.json();
+        const results = data.results;
+        if (typeof results != "object") {
+            const errMsg = data[0];
+            throw new Error(`NIH API err_msg: ${errMsg}`);
+        }
+        const projects = results.map((raw) => parseNIHProject(raw));
+        return projects;
+    }
+    async *iterator() {
+        let buffer = [];
+        let idx = 0;
+        while (true) {
+            if (idx >= buffer.length) {
+                const projects = await this.execute();
+                this.setOffset(this.offset + this.limit);
+                buffer = projects;
+                idx = 0;
+            }
+            if (idx >= buffer.length) {
+                return;
+            }
+            yield buffer[idx++];
+        }
+    }
+}
+export { NIHProjectQuery };

package/dist/lib/types.d.ts

@@ -0,0 +1,65 @@
+type NIHProject = {
+    applId: number;
+    subProjectId?: string;
+    fiscalYear: number;
+    projectNum: string;
+    projectSerialNum: string;
+    awardType: string;
+    activityCode: string;
+    awardAmount: number;
+    directCost: number;
+    indirectCost: number;
+    isActive: boolean;
+    congDistrict: string;
+    projectStartDate: Date;
+    projectEndDate: Date;
+    budgetStartDate: Date;
+    budgetEndDate: Date;
+    principalInvestigators: NIHPerson[];
+    dateAdded: Date;
+    agencyCode: string;
+    arraFunded: string;
+    oppurtunityNumber: string;
+    isNew: boolean;
+    coreProjectNum: string;
+    mechanismCodeDc: string;
+    projectTitle: string;
+    covidResponse?: string;
+    cfdaCode: string;
+    org: NIHOrg;
+    spendingCategories?: number[];
+    terms?: string[];
+    prefTerms?: string[];
+    abstractText?: string;
+};
+type NIHPerson = {
+    eraId: number;
+    firstName: string;
+    lastName: string;
+    middleName: string;
+    fullName: string;
+    isContactPI: boolean;
+    title?: string;
+};
+type NIHOrg = {
+    orgName: string;
+    city?: string;
+    country?: string;
+    orgCity: string;
+    orgState: string;
+    orgCountry?: string;
+    orgStateName?: string;
+    orgZipCode: string;
+    orgFips: string;
+    orgIPFCode: string;
+    externalOrgId: string;
+    deptType: string;
+    fipsCountyCode?: string;
+    orgDuns: string[];
+    orgUeis: string[];
+    primaryDuns: string;
+    primaryUei: string;
+};
+declare function parseNIHProject(raw: any): NIHProject;
+type NIHProjectFields = "SpendingCategories" | "SpendingCategoriesDesc" | "ProgramOfficers" | "AbstractText" | "Terms" | "PrefTerms" | "CovidResponse" | "SubprojectId";
+export { parseNIHProject, NIHProjectFields, NIHProject };

package/dist/lib/types.js

@@ -0,0 +1,73 @@
+function parseNIHPerson(raw) {
+    return {
+        eraId: raw.profile_id,
+        firstName: raw.first_name,
+        lastName: raw.last_name,
+        middleName: raw.middle_name,
+        fullName: raw.full_name,
+        isContactPI: raw.is_contact_pi,
+        title: raw.title || undefined,
+    };
+}
+function parseNIHOrg(raw) {
+    return {
+        orgName: raw.org_name,
+        city: raw.city ?? undefined,
+        country: raw.country ?? undefined,
+        orgCity: raw.org_city,
+        orgState: raw.org_state,
+        orgCountry: raw.org_country ?? undefined,
+        orgStateName: raw.org_state_name ?? undefined,
+        deptType: raw.dept_type,
+        orgDuns: raw.org_duns,
+        orgUeis: raw.org_ueis,
+        primaryDuns: raw.primary_duns,
+        primaryUei: raw.primary_uei,
+        orgFips: raw.org_fips,
+        orgIPFCode: raw.org_ipf_code,
+        orgZipCode: raw.org_zipcode,
+        externalOrgId: raw.external_org_id,
+        fipsCountyCode: raw.fips_county_code ?? undefined,
+    };
+}
+function parseNIHProject(raw) {
+    let pis = [];
+    if (raw.principal_investigators) {
+        pis = raw.principal_investigators.map((pi) => parseNIHPerson(pi));
+    }
+    const org = parseNIHOrg(raw.organization);
+    return {
+        applId: Number(raw.appl_id),
+        subProjectId: raw.subproject_id ?? undefined,
+        fiscalYear: Number(raw.fiscal_year),
+        projectNum: raw.project_num,
+        projectSerialNum: raw.project_serial_num,
+        awardType: raw.award_type,
+        activityCode: raw.activity_code,
+        awardAmount: Number(raw.award_amount),
+        isActive: Boolean(raw.is_active),
+        congDistrict: raw.cong_district,
+        projectStartDate: new Date(raw.project_start_date),
+        projectEndDate: new Date(raw.project_end_date),
+        principalInvestigators: pis,
+        budgetStartDate: new Date(raw.budget_start),
+        budgetEndDate: new Date(raw.budget_end),
+        directCost: Number(raw.direct_cost_amt),
+        indirectCost: Number(raw.indirect_cost_amt),
+        agencyCode: raw.agency_code,
+        arraFunded: raw.arra_funded,
+        dateAdded: new Date(raw.date_added),
+        coreProjectNum: raw.core_project_num,
+        oppurtunityNumber: raw.opportunity_number,
+        isNew: Boolean(raw.is_new),
+        mechanismCodeDc: raw.mechanism_code_dc,
+        projectTitle: raw.project_title,
+        covidResponse: raw.covid_response ?? undefined,
+        org: org,
+        cfdaCode: raw.cfda_code,
+        prefTerms: raw.pref_terms ? raw.pref_terms.split(";") : undefined,
+        terms: raw.terms ? raw.terms.match(/<([^>]+)>/g)?.map((tag) => tag.slice(1, -1)) || [] : undefined,
+        spendingCategories: raw.spending_categories ? raw.spending_categories.map((cat) => Number(cat)) : undefined,
+    };
+}
+export { parseNIHProject };

package/dist/test/projects.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/projects.test.js

@@ -0,0 +1,29 @@
+import { describe, it, before } from "node:test";
+import assert from "node:assert";
+import { NIHProjectQuery } from "../lib/index.js";
+describe("Project: Pinaki 2020", async () => {
+    let projects = [];
+    let iter;
+    before(async () => {
+        const nihProjectQuery = new NIHProjectQuery();
+        const data = await nihProjectQuery
+            .setPIProfileIds([10936793])
+            .setFiscalYears([2020, 2021])
+            .setUseRelevance(true)
+            .setExcludeFields(["PrefTerms", "Terms", "AbstractText"])
+            .execute();
+        projects = data;
+        iter = nihProjectQuery.iterator();
+    });
+    it("Award count", () => {
+        assert.equal(projects.length, 9);
+    });
+    it("Iterator test", async () => {
+        let result = await iter.next();
+        assert.equal(result.done, false);
+        assert.equal(result.value?.applId, 11049028);
+        result = await iter.next();
+        assert.equal(result.done, false);
+        assert.equal(result.value?.applId, 10228110);
+    });
+});

package/lib/index.ts

@@ -0,0 +1,3 @@
+import { NIHProjectQuery } from "./project.js";
+import { NIHProject } from "./types.js";
+export { NIHProjectQuery, NIHProject };

package/lib/project.ts

@@ -0,0 +1,125 @@
+import { NIHProject, NIHProjectFields, parseNIHProject } from "./types.js";
+
+class NIHProjectQuery {
+  private useRelavance: boolean;
+  private fiscalYears: number[];
+  private includeActiveProjects: boolean;
+  private piProfileIds: number[];
+  private excludeFields: NIHProjectFields[];
+  private offset: number;
+  private limit: number;
+
+  constructor() {
+    this.useRelavance = false;
+    this.fiscalYears = [];
+    this.includeActiveProjects = true;
+    this.piProfileIds = [];
+    this.excludeFields = [];
+    this.offset = 0;
+    this.limit = 50;
+  }
+
+  setPIProfileIds(piProfileIds: number[]): NIHProjectQuery {
+    this.piProfileIds = piProfileIds;
+    return this;
+  }
+
+  setFiscalYears(fiscalYears: number[]): NIHProjectQuery {
+    this.fiscalYears = fiscalYears;
+    return this;
+  }
+
+  setUseRelevance(useRelevance: boolean): NIHProjectQuery {
+    this.useRelavance = useRelevance;
+    return this;
+  }
+
+  setIncludeActiveProjects(includeActiveProjects: boolean): NIHProjectQuery {
+    this.includeActiveProjects = includeActiveProjects;
+    return this;
+  }
+
+  setExcludeFields(excludeFields: NIHProjectFields[]): NIHProjectQuery {
+    this.excludeFields = excludeFields;
+    return this;
+  }
+
+  addExcludeField(excludeField: NIHProjectFields): NIHProjectQuery {
+    if (!this.excludeFields.includes(excludeField)) {
+      this.excludeFields.push(excludeField);
+    }
+    return this;
+  }
+
+  removeExcludeField(excludeField: string): NIHProjectQuery {
+    this.excludeFields = this.excludeFields.filter((field) => field !== excludeField);
+    return this;
+  }
+
+  setLimit(limit: number): NIHProjectQuery {
+    if (limit <= 0) {
+      this.limit = 50;
+    } else if (limit > 14999) {
+      this.limit = 14999;
+    } else {
+      this.limit = limit;
+    }
+    return this;
+  }
+
+  setOffset(offset: number): NIHProjectQuery {
+    if (offset < 0) {
+      this.offset = 0;
+    } else {
+      this.offset = offset;
+    }
+    return this;
+  }
+
+  async execute(): Promise<NIHProject[]> {
+    const resp = await fetch("https://api.reporter.nih.gov/v2/projects/search", {
+      method: "POST",
+      headers: {
+        Accept: "application/json",
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify({
+        criteria: {
+          use_relevance: this.useRelavance,
+          fiscal_years: this.fiscalYears,
+          include_active_projects: this.includeActiveProjects,
+          pi_profile_ids: this.piProfileIds,
+        },
+        exclude_fields: this.excludeFields,
+        offset: this.offset,
+        limit: this.limit,
+      }),
+    });
+    const data = await resp.json();
+    const results = data.results;
+    if (typeof results != "object") {
+      const errMsg = data[0];
+      throw new Error(`NIH API err_msg: ${errMsg}`);
+    }
+    const projects: NIHProject[] = results.map((raw: any) => parseNIHProject(raw));
+    return projects;
+  }
+
+  async *iterator() {
+    let buffer: NIHProject[] = [];
+    let idx = 0;
+    while (true) {
+      if (idx >= buffer.length) {
+        const projects = await this.execute();
+        this.setOffset(this.offset + this.limit);
+        buffer = projects;
+        idx = 0;
+      }
+      if (idx >= buffer.length) {
+        return;
+      }
+      yield buffer[idx++];
+    }
+  }
+}
+export { NIHProjectQuery, NIHProject };

package/lib/types.ts

@@ -0,0 +1,150 @@
+type NIHProject = {
+  applId: number;
+  subProjectId?: string;
+  fiscalYear: number;
+  projectNum: string;
+  projectSerialNum: string;
+  awardType: string;
+  activityCode: string;
+  awardAmount: number;
+  directCost: number;
+  indirectCost: number;
+  isActive: boolean;
+  congDistrict: string;
+  projectStartDate: Date;
+  projectEndDate: Date;
+  budgetStartDate: Date;
+  budgetEndDate: Date;
+  principalInvestigators: NIHPerson[];
+  dateAdded: Date;
+  agencyCode: string;
+  arraFunded: string;
+  oppurtunityNumber: string;
+  isNew: boolean;
+  coreProjectNum: string;
+  mechanismCodeDc: string;
+  projectTitle: string;
+  covidResponse?: string;
+  cfdaCode: string;
+  org: NIHOrg;
+  spendingCategories?: number[];
+  terms?: string[];
+  prefTerms?: string[];
+  abstractText?: string;
+};
+
+type NIHPerson = {
+  eraId: number;
+  firstName: string;
+  lastName: string;
+  middleName: string;
+  fullName: string;
+  isContactPI: boolean;
+  title?: string;
+};
+
+type NIHOrg = {
+  orgName: string;
+  city?: string;
+  country?: string;
+  orgCity: string;
+  orgState: string;
+  orgCountry?: string;
+  orgStateName?: string;
+  orgZipCode: string;
+  orgFips: string;
+  orgIPFCode: string;
+  externalOrgId: string;
+  deptType: string;
+  fipsCountyCode?: string;
+  orgDuns: string[];
+  orgUeis: string[];
+  primaryDuns: string;
+  primaryUei: string;
+};
+
+function parseNIHPerson(raw: any): NIHPerson {
+  return {
+    eraId: raw.profile_id,
+    firstName: raw.first_name,
+    lastName: raw.last_name,
+    middleName: raw.middle_name,
+    fullName: raw.full_name,
+    isContactPI: raw.is_contact_pi,
+    title: raw.title || undefined,
+  };
+}
+function parseNIHOrg(raw: any): NIHOrg {
+  return {
+    orgName: raw.org_name,
+    city: raw.city ?? undefined,
+    country: raw.country ?? undefined,
+    orgCity: raw.org_city,
+    orgState: raw.org_state,
+    orgCountry: raw.org_country ?? undefined,
+    orgStateName: raw.org_state_name ?? undefined,
+    deptType: raw.dept_type,
+    orgDuns: raw.org_duns,
+    orgUeis: raw.org_ueis,
+    primaryDuns: raw.primary_duns,
+    primaryUei: raw.primary_uei,
+    orgFips: raw.org_fips,
+    orgIPFCode: raw.org_ipf_code,
+    orgZipCode: raw.org_zipcode,
+    externalOrgId: raw.external_org_id,
+    fipsCountyCode: raw.fips_county_code ?? undefined,
+  };
+}
+
+function parseNIHProject(raw: any): NIHProject {
+  let pis: NIHPerson[] = [];
+  if (raw.principal_investigators) {
+    pis = raw.principal_investigators.map((pi: any) => parseNIHPerson(pi));
+  }
+  const org = parseNIHOrg(raw.organization);
+  return {
+    applId: Number(raw.appl_id),
+    subProjectId: raw.subproject_id ?? undefined,
+    fiscalYear: Number(raw.fiscal_year),
+    projectNum: raw.project_num,
+    projectSerialNum: raw.project_serial_num,
+    awardType: raw.award_type,
+    activityCode: raw.activity_code,
+    awardAmount: Number(raw.award_amount),
+    isActive: Boolean(raw.is_active),
+    congDistrict: raw.cong_district,
+    projectStartDate: new Date(raw.project_start_date),
+    projectEndDate: new Date(raw.project_end_date),
+    principalInvestigators: pis,
+    budgetStartDate: new Date(raw.budget_start),
+    budgetEndDate: new Date(raw.budget_end),
+    directCost: Number(raw.direct_cost_amt),
+    indirectCost: Number(raw.indirect_cost_amt),
+    agencyCode: raw.agency_code,
+    arraFunded: raw.arra_funded,
+    dateAdded: new Date(raw.date_added),
+    coreProjectNum: raw.core_project_num,
+    oppurtunityNumber: raw.opportunity_number,
+    isNew: Boolean(raw.is_new),
+    mechanismCodeDc: raw.mechanism_code_dc,
+    projectTitle: raw.project_title,
+    covidResponse: raw.covid_response ?? undefined,
+    org: org,
+    cfdaCode: raw.cfda_code,
+    prefTerms: raw.pref_terms ? raw.pref_terms.split(";") : undefined,
+    terms: raw.terms ? raw.terms.match(/<([^>]+)>/g)?.map((tag: string) => tag.slice(1, -1)) || [] : undefined,
+    spendingCategories: raw.spending_categories ? raw.spending_categories.map((cat: any) => Number(cat)) : undefined,
+  };
+}
+
+type NIHProjectFields =
+  | "SpendingCategories"
+  | "SpendingCategoriesDesc"
+  | "ProgramOfficers"
+  | "AbstractText"
+  | "Terms"
+  | "PrefTerms"
+  | "CovidResponse"
+  | "SubprojectId";
+
+  export { parseNIHProject, NIHProjectFields, NIHProject };

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@adisuper94/nih-reporter",
+  "version": "0.0.1",
+  "description": "",
+  "type": "module",
+  "main": "dist/lib/index.js",
+  "types": "dist/lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --loader ts-node/esm --no-warnings=ExperimentalWarning test/*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adiSuper94/nih-reporter.git"
+  },
+  "keywords": [],
+  "author": "Aditya Subramanian",
+  "bugs": {
+    "url": "https://github.com/adiSuper94/nih-reporter/issues"
+  },
+  "homepage": "https://github.com/adiSuper94/nih-reporter#readme",
+  "devDependencies": {
+    "@types/node": "^22.14.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  }
+}

package/test/projects.test.ts

@@ -0,0 +1,32 @@
+import { describe, it, before } from "node:test";
+import assert from "node:assert";
+import { NIHProject, NIHProjectQuery } from "../lib/index.js";
+
+describe("Project: Pinaki 2020", async () => {
+  let projects: NIHProject[] = [];
+  let iter: AsyncGenerator<NIHProject>;
+  before(async () => {
+    const nihProjectQuery = new NIHProjectQuery();
+    const data = await nihProjectQuery
+      .setPIProfileIds([10936793])
+      .setFiscalYears([2020, 2021])
+      .setUseRelevance(true)
+      .setExcludeFields(["PrefTerms", "Terms", "AbstractText"])
+      .execute();
+    projects = data;
+    iter = nihProjectQuery.iterator();
+  });
+
+  it("Award count", () => {
+    assert.equal(projects.length, 9);
+  });
+
+  it("Iterator test", async () => {
+    let result = await iter.next();
+    assert.equal(result.done, false);
+    assert.equal(result.value?.applId, 11049028);
+    result = await iter.next();
+    assert.equal(result.done, false);
+    assert.equal(result.value?.applId, 10228110);
+  });
+});

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    "target": "es2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+     "declaration": true,
+    "module": "NodeNext",                                /* Specify what module code is generated. */
+    "moduleResolution": "NodeNext",                      /* Specify how TypeScript looks up a file from a given module specifier. */
+    "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["lib", "test"]
+}