refactor: migrate interfaces to dedicated directory

Reorganizes TypeScript interfaces into a modular structure:
- Create dedicated interfaces directory with specialized files
- Split interfaces by domain (claims, common, limits, records, user)
- Update imports in endorserServer.ts to use new interface locations
- Replace 'any' types with 'unknown' for better type safety
- Add proper type imports and exports

This improves code organization and maintainability by:
- Centralizing interface definitions
- Reducing file size of endorserServer.ts
- Making interface relationships more explicit
- Improving type safety with stricter types

src/interfaces/claims-result.ts

@@ -0,0 +1,47 @@
+import { AxiosResponse } from "axios";
+import { GiverReceiverInputInfo } from "../libs/util";
+import { ErrorResult, ResultWithType } from "./common";
+
+export interface GiverOutputInfo {
+  action: string;
+  giver?: GiverReceiverInputInfo;
+  description?: string;
+  amount?: number;
+  unitCode?: string;
+}
+
+export interface ClaimResult {
+  success: { claimId: string; handleId: string };
+  error: { code: string; message: string };
+}
+
+export interface VerifiableCredential {
+  exp?: number;
+  iat: number;
+  iss: string;
+  vc: {
+    "@context": string[];
+    type: string[];
+    credentialSubject: VerifiableCredentialSubject;
+  };
+}
+
+export interface VerifiableCredentialSubject {
+  "@context": string;
+  "@type": string;
+  [key: string]: unknown;
+}
+
+export interface WorldProperties {
+  startTime?: string;
+  endTime?: string;
+}
+
+// Type for createAndSubmitClaim result
+export type CreateAndSubmitClaimResult = SuccessResult | ErrorResult;
+
+// Update SuccessResult to use ClaimResult
+export interface SuccessResult extends ResultWithType {
+  type: "success";
+  response: AxiosResponse<ClaimResult>;
+}

src/interfaces/claims.ts

@@ -0,0 +1,63 @@
+import { GenericVerifiableCredential } from "./common";
+
+export interface AgreeVerifiableCredential {
+  "@context": string;
+  "@type": string;
+  object: Record<string, unknown>;
+}
+
+// Note that previous VCs may have additional fields.
+// https://endorser.ch/doc/html/transactions.html#id4
+export interface GiveVerifiableCredential extends GenericVerifiableCredential {
+  "@context"?: string;
+  "@type": "GiveAction";
+  agent?: { identifier: string };
+  description?: string;
+  fulfills?: { "@type": string; identifier?: string; lastClaimId?: string }[];
+  identifier?: string;
+  image?: string;
+  object?: { amountOfThisGood: number; unitCode: string };
+  provider?: GenericVerifiableCredential;
+  recipient?: { identifier: string };
+}
+
+// Note that previous VCs may have additional fields.
+// https://endorser.ch/doc/html/transactions.html#id8
+export interface OfferVerifiableCredential extends GenericVerifiableCredential {
+  "@context"?: string;
+  "@type": "Offer";
+  description?: string;
+  includesObject?: { amountOfThisGood: number; unitCode: string };
+  itemOffered?: {
+    description?: string;
+    isPartOf?: { identifier?: string; lastClaimId?: string; "@type"?: string };
+  };
+  offeredBy?: { identifier: string };
+  recipient?: { identifier: string };
+  validThrough?: string;
+}
+
+// Note that previous VCs may have additional fields.
+// https://endorser.ch/doc/html/transactions.html#id7
+export interface PlanVerifiableCredential extends GenericVerifiableCredential {
+  "@context": "https://schema.org";
+  "@type": "PlanAction";
+  name: string;
+  agent?: { identifier: string };
+  description?: string;
+  identifier?: string;
+  lastClaimId?: string;
+  location?: {
+    geo: { "@type": "GeoCoordinates"; latitude: number; longitude: number };
+  };
+}
+
+// AKA Registration & RegisterAction
+export interface RegisterVerifiableCredential {
+  "@context": string;
+  "@type": "RegisterAction";
+  agent: { identifier: string };
+  identifier?: string;
+  object: string;
+  participant?: { identifier: string };
+}

src/interfaces/common.ts

@@ -0,0 +1,41 @@
+// similar to VerifiableCredentialSubject... maybe rename this
+export interface GenericVerifiableCredential {
+  "@context"?: string;
+  "@type": string;
+  [key: string]: unknown;
+}
+
+export interface GenericCredWrapper<T extends GenericVerifiableCredential> {
+  claim: T;
+  claimType?: string;
+  handleId: string;
+  id: string;
+  issuedAt: string;
+  issuer: string;
+  publicUrls?: Record<string, string>;
+}
+
+export interface ResultWithType {
+  type: string;
+}
+
+export interface SuccessResult extends ResultWithType {
+  type: "success";
+  response: unknown;
+}
+
+export interface ErrorResponse {
+  error?: {
+    message?: string;
+  };
+}
+
+export interface InternalError {
+  error: string;
+  userMessage?: string;
+}
+
+export interface ErrorResult extends ResultWithType {
+  type: "error";
+  error: InternalError;
+}

src/interfaces/index.ts

@@ -0,0 +1,6 @@
+export * from "./claims";
+export * from "./claims-result";
+export * from "./common";
+export * from "./limits";
+export * from "./records";
+export * from "./user";

src/interfaces/limits.ts

@@ -0,0 +1,14 @@
+export interface EndorserRateLimits {
+  doneClaimsThisWeek: string;
+  doneRegistrationsThisMonth: string;
+  maxClaimsPerWeek: string;
+  maxRegistrationsPerMonth: string;
+  nextMonthBeginDateTime: string;
+  nextWeekBeginDateTime: string;
+}
+
+export interface ImageRateLimits {
+  doneImagesThisWeek: string;
+  maxImagesPerWeek: string;
+  nextWeekBeginDateTime: string;
+}

src/interfaces/records.ts

@@ -0,0 +1,90 @@
+import { GiveVerifiableCredential, OfferVerifiableCredential } from "./claims";
+
+// a summary record; the VC is found the fullClaim field
+export interface GiveSummaryRecord {
+  agentDid: string;
+  amount: number;
+  amountConfirmed: number;
+  description: string;
+  fullClaim: GiveVerifiableCredential;
+  fulfillsHandleId: string;
+  fulfillsPlanHandleId?: string;
+  fulfillsType?: string;
+  handleId: string;
+  issuedAt: string;
+  issuerDid: string;
+  jwtId: string;
+  providerPlanHandleId?: string;
+  recipientDid: string;
+  unit: string;
+}
+
+// a summary record; the VC is found the fullClaim field
+export interface OfferSummaryRecord {
+  amount: number;
+  amountGiven: number;
+  amountGivenConfirmed: number;
+  fullClaim: OfferVerifiableCredential;
+  fulfillsPlanHandleId: string;
+  handleId: string;
+  issuerDid: string;
+  jwtId: string;
+  nonAmountGivenConfirmed: number;
+  objectDescription: string;
+  offeredByDid: string;
+  recipientDid: string;
+  requirementsMet: boolean;
+  unit: string;
+  validThrough: string;
+}
+
+export interface OfferToPlanSummaryRecord extends OfferSummaryRecord {
+  planName: string;
+}
+
+// a summary record; the VC is not currently part of this record
+export interface PlanSummaryRecord {
+  agentDid?: string;
+  description: string;
+  endTime?: string;
+  fulfillsPlanHandleId: string;
+  handleId: string;
+  image?: string;
+  issuerDid: string;
+  locLat?: number;
+  locLon?: number;
+  name?: string;
+  startTime?: string;
+  url?: string;
+}
+
+/**
+ * Represents data about a project
+ *
+ * @deprecated
+ * (Maybe we should use PlanSummaryRecord instead, either by adding rowId or by iterating with jwtId.)
+ **/
+export interface PlanData {
+  /**
+   * Description of the project
+   **/
+  description: string;
+  /**
+   * URL referencing information about the project
+   **/
+  handleId: string;
+  image?: string;
+  /**
+   * The DID of the issuer
+   */
+  issuerDid: string;
+  /**
+   * Name of the project
+   **/
+  name: string;
+  /**
+   * The identifier of the project record -- different from jwtId
+   * (Maybe we should use the jwtId to iterate through the records instead.)
+   **/
+  rowId?: string;
+}

src/interfaces/user.ts

@@ -0,0 +1,8 @@
+export interface UserInfo {
+  did: string;
+  name: string;
+  publicEncKey: string;
+  registered: boolean;
+  profileImageUrl?: string;
+  nextPublicEncKeyHash?: string;
+}