@layer-drone/protocol 0.0.11 → 0.0.13

package/src/client/sdk.gen.ts

@@ -40,6 +40,14 @@ import type {
   FlightsControllerValidateFlightResponses,
   KeysControllerGetProvenanceCryptoKeyData,
   KeysControllerGetProvenanceCryptoKeyResponses,
+  MissionsControllerClaimRewardsData,
+  MissionsControllerClaimRewardsErrors,
+  MissionsControllerClaimRewardsResponses,
+  MissionsControllerCreateMissionsData,
+  MissionsControllerCreateMissionsErrors,
+  MissionsControllerCreateMissionsResponses,
+  MissionsControllerUpdateMissionsData,
+  MissionsControllerUpdateMissionsResponses,
   QuotesControllerCreateQuoteData,
   QuotesControllerCreateQuoteErrors,
   QuotesControllerCreateQuoteResponses,
@@ -312,6 +320,75 @@ export const quotesControllerGetQuote = <ThrowOnError extends boolean = false>(
   });
 };
 
+/**
+ * Create new missions
+ * Create missions for specified zones and mission types.
+ */
+export const missionsControllerCreateMissions = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<MissionsControllerCreateMissionsData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).post<
+    MissionsControllerCreateMissionsResponses,
+    MissionsControllerCreateMissionsErrors,
+    ThrowOnError
+  >({
+    url: "/missions",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options.headers,
+    },
+  });
+};
+
+/**
+ * Update missions
+ * Update missions' rewards or cancel them altogether
+ */
+export const missionsControllerUpdateMissions = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<MissionsControllerUpdateMissionsData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).put<
+    MissionsControllerUpdateMissionsResponses,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/missions",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options.headers,
+    },
+  });
+};
+
+/**
+ * Claim rewards for a mission
+ * Claim rewards for a completed flight within a mission
+ */
+export const missionsControllerClaimRewards = <
+  ThrowOnError extends boolean = false,
+>(
+  options: Options<MissionsControllerClaimRewardsData, ThrowOnError>,
+) => {
+  return (options.client ?? _heyApiClient).post<
+    MissionsControllerClaimRewardsResponses,
+    MissionsControllerClaimRewardsErrors,
+    ThrowOnError
+  >({
+    url: "/missions/{id}/rewards",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options.headers,
+    },
+  });
+};
+
 export const flightsControllerGenerateFlightId = <
   ThrowOnError extends boolean = false,
 >(

package/src/client/types.gen.ts

@@ -87,6 +87,72 @@ export type CreateQuoteRequestDto = {
   mintOnChain: boolean;
 };
 
+export type CreateMissionRequestDto = {
+  missions: Array<{
+    zoneId: string;
+    flightPlanId: number;
+    amount: number;
+    startTime: Date;
+    endTime: Date;
+  }>;
+  campaignId: number;
+  requestor: string;
+  mintOnChain?: boolean;
+};
+
+export type CreateMissionResponseDto = {
+  success: boolean;
+  data:
+    | {
+        missions: Array<{
+          missionId: string;
+          vaultId: string;
+          amount: number;
+          zoneId: string;
+          flightPlanId: number;
+          captureStartTime: Date;
+          captureEndTime: Date;
+          requestor: string;
+        }>;
+        totalAmount: number;
+      }
+    | string;
+};
+
+export type UpdateMissionsRequestDto = {
+  missions: Array<
+    | {
+        id: string;
+        amount: number;
+      }
+    | {
+        id: string;
+        isOpen: false;
+      }
+  >;
+};
+
+export type UpdateMissionsResponseDto = {
+  success: boolean;
+  data: {
+    rewardUpdatesQueued: Array<string>;
+    cancelUpdatesQueued: Array<string>;
+  };
+};
+
+export type ClaimRewardsRequestDto = {
+  flightIds: Array<number>;
+};
+
+export type ClaimRewardsResponseDto = {
+  success: boolean;
+  data:
+    | {
+        cancelUpdatesQueued: Array<string>;
+      }
+    | string;
+};
+
 export type FlightDto = {
   token_id: number;
   owner: string;
@@ -114,11 +180,6 @@ export type ValidateFlightDto = {
   pilotAddress: string;
   missionId: number;
   flightTimestamp: string;
-  externalBucketInfo?: {
-    prefix: string;
-    bucketName: string;
-    region: string;
-  };
   flightRequestInfo: {
     filePaths: Array<string>;
     flightPlanId: number;
@@ -149,7 +210,14 @@ export type GetTimeLimitsForSunAltitudeResponse = {
 export type CreateWebhookBody = {
   name: string;
   url: string;
-  event_types: Array<"test" | "protocol.flight.submitted" | "*">;
+  event_types: Array<
+    | "test"
+    | "protocol.flight.submitted"
+    | "protocol.mission.created"
+    | "protocol.mission.updated"
+    | "protocol.flight.reviewed"
+    | "*"
+  >;
   active: boolean;
 };
 
@@ -162,7 +230,14 @@ export type GetWebhooksResponse = Array<{
   id: number;
   name: string;
   url: string;
-  event_types: Array<"test" | "protocol.flight.submitted" | "*">;
+  event_types: Array<
+    | "test"
+    | "protocol.flight.submitted"
+    | "protocol.mission.created"
+    | "protocol.mission.updated"
+    | "protocol.flight.reviewed"
+    | "*"
+  >;
   active: boolean;
   failure_count: number;
   last_failure_reason: string;
@@ -174,7 +249,14 @@ export type GetWebhookResponse = {
   id: number;
   name: string;
   url: string;
-  event_types: Array<"test" | "protocol.flight.submitted" | "*">;
+  event_types: Array<
+    | "test"
+    | "protocol.flight.submitted"
+    | "protocol.mission.created"
+    | "protocol.mission.updated"
+    | "protocol.flight.reviewed"
+    | "*"
+  >;
   active: boolean;
   failure_count: number;
   last_failure_reason: string;
@@ -185,7 +267,14 @@ export type GetWebhookResponse = {
 export type UpdateWebhookBody = {
   name?: string;
   url?: string;
-  event_types?: Array<"test" | "protocol.flight.submitted" | "*">;
+  event_types?: Array<
+    | "test"
+    | "protocol.flight.submitted"
+    | "protocol.mission.created"
+    | "protocol.mission.updated"
+    | "protocol.flight.reviewed"
+    | "*"
+  >;
   active?: boolean;
 };
 
@@ -193,7 +282,14 @@ export type UpdateWebhookResponse = {
   id: number;
   name: string;
   url: string;
-  event_types: Array<"test" | "protocol.flight.submitted" | "*">;
+  event_types: Array<
+    | "test"
+    | "protocol.flight.submitted"
+    | "protocol.mission.created"
+    | "protocol.mission.updated"
+    | "protocol.flight.reviewed"
+    | "*"
+  >;
   active: boolean;
   failure_count: number;
   last_failure_reason: string;
@@ -392,6 +488,89 @@ export type QuotesControllerGetQuoteResponses = {
   200: unknown;
 };
 
+export type MissionsControllerCreateMissionsData = {
+  body: CreateMissionRequestDto;
+  path?: never;
+  query?: never;
+  url: "/missions";
+};
+
+export type MissionsControllerCreateMissionsErrors = {
+  /**
+   * Validation failed - invalid Zones, mission types, or times
+   */
+  400: unknown;
+  /**
+   * Insufficient treasury spending limit
+   */
+  403: unknown;
+  /**
+   * Internal server error during mission creation
+   */
+  500: unknown;
+};
+
+export type MissionsControllerCreateMissionsResponses = {
+  /**
+   * Mission creation transaction queued successfully
+   */
+  201: CreateMissionResponseDto;
+};
+
+export type MissionsControllerCreateMissionsResponse =
+  MissionsControllerCreateMissionsResponses[keyof MissionsControllerCreateMissionsResponses];
+
+export type MissionsControllerUpdateMissionsData = {
+  body: UpdateMissionsRequestDto;
+  path?: never;
+  query?: never;
+  url: "/missions";
+};
+
+export type MissionsControllerUpdateMissionsResponses = {
+  /**
+   * Missions update transaction queued successfully
+   */
+  200: UpdateMissionsResponseDto;
+};
+
+export type MissionsControllerUpdateMissionsResponse =
+  MissionsControllerUpdateMissionsResponses[keyof MissionsControllerUpdateMissionsResponses];
+
+export type MissionsControllerClaimRewardsData = {
+  body: ClaimRewardsRequestDto;
+  path: {
+    id: bigint;
+  };
+  query?: never;
+  url: "/missions/{id}/rewards";
+};
+
+export type MissionsControllerClaimRewardsErrors = {
+  /**
+   * Flight not approved or validation failed
+   */
+  400: unknown;
+  /**
+   * Mission or Flight not found
+   */
+  404: unknown;
+  /**
+   * Internal server error during reward claiming
+   */
+  500: unknown;
+};
+
+export type MissionsControllerClaimRewardsResponses = {
+  /**
+   * Rewards claimed successfully
+   */
+  200: ClaimRewardsResponseDto;
+};
+
+export type MissionsControllerClaimRewardsResponse =
+  MissionsControllerClaimRewardsResponses[keyof MissionsControllerClaimRewardsResponses];
+
 export type FlightsControllerGenerateFlightIdData = {
   body?: never;
   path?: never;

package/src/event/types.gen.ts

@@ -24,5 +24,72 @@ export const Event = z.union([
         .strict(),
     })
     .strict(),
+  z
+    .object({
+      id: z.any(),
+      event_type: z.literal("protocol.mission.created"),
+      timestamp: z.any(),
+      data: z
+        .object({
+          missionId: z.string(),
+          vaultId: z.string(),
+          amount: z.string(),
+          zoneId: z.string(),
+          flightPlanId: z.number(),
+          captureStartTime: z.string(),
+          captureEndTime: z.string(),
+          detailsHash: z.string(),
+        })
+        .strict(),
+    })
+    .strict(),
+  z
+    .object({
+      id: z.any(),
+      event_type: z.literal("protocol.mission.updated"),
+      timestamp: z.any(),
+      data: z
+        .object({
+          id: z.string(),
+          amount: z.number().optional(),
+          isOpen: z.boolean().optional(),
+        })
+        .strict(),
+    })
+    .strict(),
+  z
+    .object({
+      id: z.any(),
+      event_type: z.literal("protocol.flight.reviewed"),
+      timestamp: z.any(),
+      data: z
+        .object({
+          flightId: z.number(),
+          isApproved: z.boolean(),
+          validationLogUri: z.string(),
+          validator: z.string(),
+          filesHash: z.string(),
+        })
+        .strict(),
+    })
+    .strict(),
 ]);
 export type Event = z.infer<typeof Event>;
+
+export type TestEvent = Extract<Event, { event_type: "test" }>;
+export type FlightSubmittedEvent = Extract<
+  Event,
+  { event_type: "protocol.flight.submitted" }
+>;
+export type MissionCreatedEvent = Extract<
+  Event,
+  { event_type: "protocol.mission.created" }
+>;
+export type MissionUpdatedEvent = Extract<
+  Event,
+  { event_type: "protocol.mission.updated" }
+>;
+export type FlightReviewedEvent = Extract<
+  Event,
+  { event_type: "protocol.flight.reviewed" }
+>;