@carlonicora/nextjs-jsonapi 6.2.0 → 6.3.0

package/src/features/company/data/company.interface.ts

@@ -1,6 +1,7 @@
 import { ApiDataInterface } from "../../../core";
 import { FeatureInterface } from "../../feature/data/feature.interface";
 import { ModuleInterface } from "../../module/data/module.interface";
+import type { CreditWarningOffer } from "../../billing/data/credit-warning";
 
 export type CompanyInput = {
   id: string;
@@ -45,6 +46,16 @@ export interface CompanyInterface extends ApiDataInterface {
    */
   get aiEnabled(): boolean;
 
+  /**
+   * Credit-warning state, written by the server only (never sent by
+   * `createJsonApi()`). All four are absent until the feature is on and the
+   * company has received a monthly grant.
+   */
+  get creditsGrantedThisPeriod(): number | undefined;
+  get creditWarningSentAt(): Date | undefined;
+  get creditWarningDismissedAt(): Date | undefined;
+  get creditWarningOffer(): CreditWarningOffer | undefined;
+
   get features(): FeatureInterface[];
   get modules(): ModuleInterface[];
   get legal_address(): string | undefined;

package/src/features/company/data/company.service.ts

@@ -1,4 +1,5 @@
 import { AbstractService, EndpointCreator, HttpMethod, Modules, NextRef } from "../../../core";
+import { CREDIT_WARNING_DISMISS_SEGMENT } from "../../billing/data/credit-warning";
 import { CompanyInput, CompanyInterface } from "./company.interface";
 
 export class CompanyService extends AbstractService {
@@ -82,4 +83,20 @@ export class CompanyService extends AbstractService {
       input: params,
     });
   }
+
+  /**
+   * Dismisses this period's credit warning for the company. The request has no
+   * body: the server stamps the dismissal itself and answers 204.
+   */
+  static async dismissCreditWarning(params: { companyId: string }): Promise<void> {
+    await this.callApi({
+      type: Modules.Company,
+      method: HttpMethod.POST,
+      endpoint: new EndpointCreator({
+        endpoint: Modules.Company,
+        id: params.companyId,
+        childEndpoint: CREDIT_WARNING_DISMISS_SEGMENT,
+      }).generate(),
+    });
+  }
 }

package/src/features/company/data/company.spec.ts

@@ -38,3 +38,32 @@ describe("Company.aiEnabled", () => {
     expect(company.aiEnabled).toBe(true);
   });
 });
+
+describe("Company credit-warning fields", () => {
+  it("rehydrates credit-warning fields", () => {
+    const company = new Company().rehydrate({
+      jsonApi: {
+        attributes: {
+          creditsGrantedThisPeriod: 200,
+          creditWarningSentAt: "2026-10-25T10:00:00.000Z",
+          creditWarningOffer: "pack",
+        },
+      },
+    } as any);
+
+    expect(company.creditsGrantedThisPeriod).toBe(200);
+    expect(company.creditWarningSentAt).toBeInstanceOf(Date);
+    expect(company.creditWarningSentAt?.toISOString()).toBe("2026-10-25T10:00:00.000Z");
+    expect(company.creditWarningDismissedAt).toBeUndefined();
+    expect(company.creditWarningOffer).toBe("pack");
+  });
+
+  it("leaves every credit-warning getter undefined when the attributes are absent", () => {
+    const company = new Company().rehydrate({ jsonApi: { attributes: {} } } as any);
+
+    expect(company.creditsGrantedThisPeriod).toBeUndefined();
+    expect(company.creditWarningSentAt).toBeUndefined();
+    expect(company.creditWarningDismissedAt).toBeUndefined();
+    expect(company.creditWarningOffer).toBeUndefined();
+  });
+});

package/src/features/company/data/company.ts

@@ -1,6 +1,7 @@
 import { AbstractApiData, JsonApiHydratedDataInterface, Modules } from "../../../core";
 import { FeatureInterface } from "../../feature";
 import { ModuleInterface } from "../../module";
+import type { CreditWarningOffer } from "../../billing/data/credit-warning";
 import { CompanyInput, CompanyInterface } from "./company.interface";
 
 export class Company extends AbstractApiData implements CompanyInterface {
@@ -16,6 +17,11 @@ export class Company extends AbstractApiData implements CompanyInterface {
   private _availableExtraCredits: number = 0;
   private _aiEnabled?: boolean;
 
+  private _creditsGrantedThisPeriod?: number;
+  private _creditWarningSentAt?: Date;
+  private _creditWarningDismissedAt?: Date;
+  private _creditWarningOffer?: CreditWarningOffer;
+
   private _features?: FeatureInterface[];
   private _modules?: ModuleInterface[];
 
@@ -63,6 +69,22 @@ export class Company extends AbstractApiData implements CompanyInterface {
     return this._aiEnabled ?? true;
   }
 
+  get creditsGrantedThisPeriod(): number | undefined {
+    return this._creditsGrantedThisPeriod;
+  }
+
+  get creditWarningSentAt(): Date | undefined {
+    return this._creditWarningSentAt;
+  }
+
+  get creditWarningDismissedAt(): Date | undefined {
+    return this._creditWarningDismissedAt;
+  }
+
+  get creditWarningOffer(): CreditWarningOffer | undefined {
+    return this._creditWarningOffer;
+  }
+
   get features(): FeatureInterface[] {
     return this._features ?? [];
   }
@@ -130,6 +152,15 @@ export class Company extends AbstractApiData implements CompanyInterface {
     this._availableExtraCredits = data.jsonApi.attributes.availableExtraCredits ?? 0;
     this._aiEnabled = data.jsonApi.attributes.aiEnabled ?? true;
 
+    this._creditsGrantedThisPeriod = data.jsonApi.attributes.creditsGrantedThisPeriod ?? undefined;
+    this._creditWarningSentAt = data.jsonApi.attributes.creditWarningSentAt
+      ? new Date(data.jsonApi.attributes.creditWarningSentAt)
+      : undefined;
+    this._creditWarningDismissedAt = data.jsonApi.attributes.creditWarningDismissedAt
+      ? new Date(data.jsonApi.attributes.creditWarningDismissedAt)
+      : undefined;
+    this._creditWarningOffer = data.jsonApi.attributes.creditWarningOffer ?? undefined;
+
     this._legal_address = data.jsonApi.attributes.legal_address;
     this._street_number = data.jsonApi.attributes.street_number;
     this._street = data.jsonApi.attributes.street;