ENG-999 - add more project fields and credit issuances for projects to API (#566)

Author: dkokotov

src/api-client.ts

@@ -13,7 +13,7 @@ import type {
     Subaccount,
     ImpactData,
     ImpactHostedPageConfig,
-    Project,
+    ProjectWithCreditIssuances,
     ProjectCategoryWithProjects,
     Portfolio,
     PortfolioWithCategoryAllocations,
@@ -519,13 +519,13 @@ export class CNaughtApiClient {
      * Get details for a project
      * @param id Id of the project whose details are to be retrieved
      * @param requestOptions Optional additional request options, e.g. for transforming the Request before sending
-     * @returns Project details
+     * @returns Project details with credit issuances
      */
     getProjectDetails = (
         id: string,
         requestOptions?: ApiRequestOptions
-    ): Promise<Project> =>
-        this.apiHandler.makeApiGetRequest<Project>(
+    ): Promise<ProjectWithCreditIssuances> =>
+        this.apiHandler.makeApiGetRequest<ProjectWithCreditIssuances>(
             `/projects/${id}`,
             requestOptions
         );

src/models/CreditIssuance.ts

@@ -0,0 +1,4 @@
+export interface CreditIssuance {
+    vintage_year: number;
+    total_amount: number;
+}

src/models/Project.ts

@@ -1,7 +1,13 @@
+import type { ProjectDueDiligenceFigure } from './ProjectDueDiligenceFigure.js';
+import type { ProjectLifetime } from './ProjectLifetime.js';
+import type { ProjectNewsArticle } from './ProjectNewsArticle.js';
+import type { ProjectNotableBuyer } from './ProjectNotableBuyer.js';
+
 export interface Project {
     id: string;
     name: string;
     type: string;
+    activity_types?: string[];
     developer?: string;
     registry_name?: string;
     registry_id?: string;
@@ -13,4 +19,16 @@ export interface Project {
     location_longitude?: number;
     primary_image_url?: string;
     un_sdg_goals: number[];
+    methodology?: string;
+    verifier?: string;
+    permanence?: string;
+    lifetime?: ProjectLifetime;
+    impact_type?: string;
+    due_diligence?: string;
+    beyond_carbon?: string;
+    risk_of_reversal?: string;
+    third_party_labels?: string[];
+    notable_buyers?: ProjectNotableBuyer[];
+    due_diligence_figure?: ProjectDueDiligenceFigure;
+    news_articles?: ProjectNewsArticle[];
 }

src/models/ProjectDueDiligenceFigure.ts

@@ -0,0 +1,5 @@
+export interface ProjectDueDiligenceFigure {
+    description: string;
+    image_url: string;
+    image_alt_text?: string;
+}

src/models/ProjectLifetime.ts

@@ -0,0 +1,4 @@
+export interface ProjectLifetime {
+    start_year?: number;
+    end_year?: number;
+}

src/models/ProjectNewsArticle.ts

@@ -0,0 +1,7 @@
+export interface ProjectNewsArticle {
+    title: string;
+    url: string;
+    author: string;
+    published_on: string;
+    cnaught_take?: string;
+}

src/models/ProjectNotableBuyer.ts

@@ -0,0 +1,5 @@
+export interface ProjectNotableBuyer {
+    name: string;
+    logo_url: string;
+    logo_alt_text?: string;
+}

src/models/ProjectWithCreditIssuances.ts

@@ -0,0 +1,6 @@
+import type { CreditIssuance } from './CreditIssuance.js';
+import type { Project } from './Project.js';
+
+export interface ProjectWithCreditIssuances extends Project {
+    credit_issuances: CreditIssuance[];
+}

src/models/index.ts

@@ -18,6 +18,10 @@ export * from './ImpactHostedPageConfig.js';
 export * from './CNaughtProblemDetails.js';
 export * from './quotes/index.js';
 export * from './Project.js';
+export * from './ProjectLifetime.js';
+export * from './ProjectNewsArticle.js';
+export * from './ProjectNotableBuyer.js';
+export * from './ProjectDueDiligenceFigure.js';
 export * from './ProjectAllocation.js';
 export * from './ProjectCategory.js';
 export * from './ProjectCategoryWithProjects.js';
@@ -30,3 +34,9 @@ export * from './SubaccountLogoFileOptions.js';
 export * from './ImpactDateFilterOptions.js';
 export * from './CheckoutSession.js';
 export * from './CheckoutSessionOptions.js';
+export * from './CreditIssuance.js';
+export * from './ProjectLifetime.js';
+export * from './ProjectNewsArticle.js';
+export * from './ProjectNotableBuyer.js';
+export * from './ProjectDueDiligenceFigure.js';
+export * from './ProjectWithCreditIssuances.js';

test/integration/test/projects.test.ts

@@ -5,6 +5,7 @@ test('get project by id', async () => {
 
     const project = await client.getProjectDetails('I0UbDH'); // well-known project
 
+    // Test basic fields
     expect(project.name).toBe('Sandbox Project A');
     expect(project.type).toBe('Reforestation');
     expect(project.developer).toBe('Sandbox Project Developer');
@@ -22,4 +23,31 @@ test('get project by id', async () => {
         'https://assets.cnaught.com/64fd900fcf6f93409fc7ff21/67466d4c5dac34242677eb4b_64cabf485b8978f04658185f_pexels-symeon-ekizoglou-2880801.webp'
     );
     expect(project.un_sdg_goals).toStrictEqual([1, 4, 6]);
-}, 30000);
+
+    // Test new fields
+    expect(project.activity_types).toEqual(['Reforestation', 'Improved Forest Management']);
+    expect(project.impact_type).toBe('Removal');
+    expect(project.methodology).toBe('Verified Carbon Standard (VCS)');
+    expect(project.verifier).toBe('Sandbox Verification Services');
+    expect(project.permanence).toBe('100+ years');
+    expect(project.lifetime).toEqual({
+        start_year: 2022,
+        end_year: 2052
+    });
+
+    // Test credit issuances
+    expect(project.credit_issuances).toBeDefined();
+    expect(project.credit_issuances.length).toBe(3);
+
+    // Check specific issuances
+    const issuances = project.credit_issuances.sort((a, b) => a.vintage_year - b.vintage_year);
+
+    expect(issuances[0].vintage_year).toBe(2022);
+    expect(issuances[0].total_amount).toBe(5000);
+
+    expect(issuances[1].vintage_year).toBe(2023);
+    expect(issuances[1].total_amount).toBe(7500);
+
+    expect(issuances[2].vintage_year).toBe(2024);
+    expect(issuances[2].total_amount).toBe(10000);
+}, 30000);

test/unit/api-client.spec.ts

@@ -148,7 +148,30 @@ describe('api-client', () => {
         name: 'Some project',
         type: 'ARR',
         un_sdg_goals: [],
-        developer: 'Test Developer'
+        developer: 'Test Developer',
+        activity_types: ['Test Activity'],
+        summary: 'Test Summary',
+        description: 'Test Description',
+        verifier: 'Test Verifier',
+        lifetime: {
+            start_year: 2021,
+            end_year: 2024
+        },
+        impact_type: 'Avoided Emissions',
+        beyond_carbon: 'Test Beyond Carbon',
+        due_diligence: 'Test Due Diligence',
+        location_name: 'Test Location',
+        methodology: 'Test Methodology',
+        permanence: 'Test Permanence',
+        news_articles: [
+            {
+                title: 'Test title',
+                url: 'https://example.com',
+                author: 'Test Author',
+                published_on: '2022-08-05T24:00:00.29Z',
+                cnaught_take: 'Our take'
+            }
+        ]
     };
 
     const projectCategoryId = 'project-category-id';