@layer-drone/protocol 2.3.1 → 2.5.0

package/dist/index.js

@@ -146,6 +146,7 @@ __export(index_exports, {
   missionsControllerUpdateMissions1: () => missionsControllerUpdateMissions1,
   parseWebhookEvent: () => parseWebhookEvent,
   pilotsControllerGetPilotReputationV2V2: () => pilotsControllerGetPilotReputationV2V2,
+  pilotsControllerGetPilotReservationSlotsV2V2: () => pilotsControllerGetPilotReservationSlotsV2V2,
   protocolTriggersApiControllerTriggerMissionClose0V1: () => protocolTriggersApiControllerTriggerMissionClose0V1,
   protocolTriggersApiControllerTriggerMissionClose1: () => protocolTriggersApiControllerTriggerMissionClose1,
   protocolTriggersApiControllerTriggerPayout0V1: () => protocolTriggersApiControllerTriggerPayout0V1,
@@ -3730,6 +3731,18 @@ var pilotsControllerGetPilotReputationV2V2 = /* @__PURE__ */ __name((options) =>
     ...options
   });
 }, "pilotsControllerGetPilotReputationV2V2");
+var pilotsControllerGetPilotReservationSlotsV2V2 = /* @__PURE__ */ __name((options) => {
+  return (options.client ?? client).get({
+    security: [
+      {
+        name: "x-api-token",
+        type: "apiKey"
+      }
+    ],
+    url: "/v2/pilots/{address}/reservation-slots",
+    ...options
+  });
+}, "pilotsControllerGetPilotReservationSlotsV2V2");
 var reservationsControllerGetReservationsV2V2 = /* @__PURE__ */ __name((options) => {
   return (options?.client ?? client).get({
     security: [
@@ -4031,6 +4044,94 @@ var Event = import_zod.z.union([
         }).optional()
       }).catchall(import_zod.z.any()).optional()
     }).catchall(import_zod.z.any())
+  }).catchall(import_zod.z.any()),
+  import_zod.z.object({
+    id: import_zod.z.string(),
+    event_type: import_zod.z.literal("fulfillment.reservation"),
+    timestamp: import_zod.z.string(),
+    data: import_zod.z.object({
+      version: import_zod.z.literal(1),
+      data: import_zod.z.object({
+        id: import_zod.z.string().uuid(),
+        missionId: import_zod.z.string().uuid(),
+        missionHoldId: import_zod.z.string().uuid(),
+        pilotAddress: import_zod.z.string().regex(new RegExp("^0x[a-fA-F0-9]{40}$")),
+        status: import_zod.z.enum([
+          "active",
+          "completed",
+          "cancelled",
+          "expired"
+        ]),
+        endedAt: import_zod.z.union([
+          import_zod.z.string().datetime({
+            offset: true
+          }),
+          import_zod.z.null()
+        ]),
+        createdAt: import_zod.z.string().datetime({
+          offset: true
+        }),
+        updatedAt: import_zod.z.string().datetime({
+          offset: true
+        })
+      }).catchall(import_zod.z.any()),
+      changes: import_zod.z.array(import_zod.z.enum([
+        "id",
+        "missionId",
+        "missionHoldId",
+        "pilotAddress",
+        "status",
+        "endedAt",
+        "createdAt",
+        "updatedAt"
+      ])).optional()
+    }).catchall(import_zod.z.any())
+  }).catchall(import_zod.z.any()),
+  import_zod.z.object({
+    id: import_zod.z.string(),
+    event_type: import_zod.z.literal("fulfillment.mission-hold"),
+    timestamp: import_zod.z.string(),
+    data: import_zod.z.object({
+      version: import_zod.z.literal(1),
+      data: import_zod.z.object({
+        id: import_zod.z.string().uuid(),
+        missionId: import_zod.z.string().uuid(),
+        pilotAddress: import_zod.z.string().regex(new RegExp("^0x[a-fA-F0-9]{40}$")),
+        expiresAt: import_zod.z.string().datetime({
+          offset: true
+        }),
+        releasedAt: import_zod.z.union([
+          import_zod.z.string().datetime({
+            offset: true
+          }),
+          import_zod.z.null()
+        ]),
+        releasedReason: import_zod.z.union([
+          import_zod.z.enum([
+            "expired",
+            "completed",
+            "cancelled"
+          ]),
+          import_zod.z.null()
+        ]),
+        createdAt: import_zod.z.string().datetime({
+          offset: true
+        }),
+        updatedAt: import_zod.z.string().datetime({
+          offset: true
+        })
+      }).catchall(import_zod.z.any()),
+      changes: import_zod.z.array(import_zod.z.enum([
+        "id",
+        "missionId",
+        "pilotAddress",
+        "expiresAt",
+        "releasedAt",
+        "releasedReason",
+        "createdAt",
+        "updatedAt"
+      ])).optional()
+    }).catchall(import_zod.z.any())
   }).catchall(import_zod.z.any())
 ]);
 
@@ -4203,6 +4304,7 @@ __name(getFirstHeader, "getFirstHeader");
   missionsControllerUpdateMissions1,
   parseWebhookEvent,
   pilotsControllerGetPilotReputationV2V2,
+  pilotsControllerGetPilotReservationSlotsV2V2,
   protocolTriggersApiControllerTriggerMissionClose0V1,
   protocolTriggersApiControllerTriggerMissionClose1,
   protocolTriggersApiControllerTriggerPayout0V1,

package/dist/index.mjs

@@ -3537,6 +3537,18 @@ var pilotsControllerGetPilotReputationV2V2 = /* @__PURE__ */ __name((options) =>
     ...options
   });
 }, "pilotsControllerGetPilotReputationV2V2");
+var pilotsControllerGetPilotReservationSlotsV2V2 = /* @__PURE__ */ __name((options) => {
+  return (options.client ?? client).get({
+    security: [
+      {
+        name: "x-api-token",
+        type: "apiKey"
+      }
+    ],
+    url: "/v2/pilots/{address}/reservation-slots",
+    ...options
+  });
+}, "pilotsControllerGetPilotReservationSlotsV2V2");
 var reservationsControllerGetReservationsV2V2 = /* @__PURE__ */ __name((options) => {
   return (options?.client ?? client).get({
     security: [
@@ -3838,6 +3850,94 @@ var Event = z.union([
         }).optional()
       }).catchall(z.any()).optional()
     }).catchall(z.any())
+  }).catchall(z.any()),
+  z.object({
+    id: z.string(),
+    event_type: z.literal("fulfillment.reservation"),
+    timestamp: z.string(),
+    data: z.object({
+      version: z.literal(1),
+      data: z.object({
+        id: z.string().uuid(),
+        missionId: z.string().uuid(),
+        missionHoldId: z.string().uuid(),
+        pilotAddress: z.string().regex(new RegExp("^0x[a-fA-F0-9]{40}$")),
+        status: z.enum([
+          "active",
+          "completed",
+          "cancelled",
+          "expired"
+        ]),
+        endedAt: z.union([
+          z.string().datetime({
+            offset: true
+          }),
+          z.null()
+        ]),
+        createdAt: z.string().datetime({
+          offset: true
+        }),
+        updatedAt: z.string().datetime({
+          offset: true
+        })
+      }).catchall(z.any()),
+      changes: z.array(z.enum([
+        "id",
+        "missionId",
+        "missionHoldId",
+        "pilotAddress",
+        "status",
+        "endedAt",
+        "createdAt",
+        "updatedAt"
+      ])).optional()
+    }).catchall(z.any())
+  }).catchall(z.any()),
+  z.object({
+    id: z.string(),
+    event_type: z.literal("fulfillment.mission-hold"),
+    timestamp: z.string(),
+    data: z.object({
+      version: z.literal(1),
+      data: z.object({
+        id: z.string().uuid(),
+        missionId: z.string().uuid(),
+        pilotAddress: z.string().regex(new RegExp("^0x[a-fA-F0-9]{40}$")),
+        expiresAt: z.string().datetime({
+          offset: true
+        }),
+        releasedAt: z.union([
+          z.string().datetime({
+            offset: true
+          }),
+          z.null()
+        ]),
+        releasedReason: z.union([
+          z.enum([
+            "expired",
+            "completed",
+            "cancelled"
+          ]),
+          z.null()
+        ]),
+        createdAt: z.string().datetime({
+          offset: true
+        }),
+        updatedAt: z.string().datetime({
+          offset: true
+        })
+      }).catchall(z.any()),
+      changes: z.array(z.enum([
+        "id",
+        "missionId",
+        "pilotAddress",
+        "expiresAt",
+        "releasedAt",
+        "releasedReason",
+        "createdAt",
+        "updatedAt"
+      ])).optional()
+    }).catchall(z.any())
   }).catchall(z.any())
 ]);
 
@@ -4009,6 +4109,7 @@ export {
   missionsControllerUpdateMissions1,
   parseWebhookEvent,
   pilotsControllerGetPilotReputationV2V2,
+  pilotsControllerGetPilotReservationSlotsV2V2,
   protocolTriggersApiControllerTriggerMissionClose0V1,
   protocolTriggersApiControllerTriggerMissionClose1,
   protocolTriggersApiControllerTriggerPayout0V1,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@layer-drone/protocol",
   "description": "Layer Drone protocol SDK with typed API client and event parsing",
-  "version": "2.3.1",
+  "version": "2.5.0",
   "license": "MIT",
   "files": [
     "dist",
@@ -35,8 +35,8 @@
     "zod": "^3.24.2",
     "zod-to-json-schema": "^3.24.5",
     "@layer-drone/eslint-config": "0.0.0",
-    "@layer-drone/typescript-config": "0.0.0",
-    "@layer-drone/event-schema": "0.0.0"
+    "@layer-drone/event-schema": "0.0.0",
+    "@layer-drone/typescript-config": "0.0.0"
   },
   "peerDependencies": {
     "zod": "^3.x.x"

package/src/client/sdk.gen.ts

@@ -417,6 +417,9 @@ import type {
   PilotsControllerGetPilotReputationV2V2Data,
   PilotsControllerGetPilotReputationV2V2Errors,
   PilotsControllerGetPilotReputationV2V2Responses,
+  PilotsControllerGetPilotReservationSlotsV2V2Data,
+  PilotsControllerGetPilotReservationSlotsV2V2Errors,
+  PilotsControllerGetPilotReservationSlotsV2V2Responses,
   ProtocolTriggersApiControllerTriggerMissionClose0V1Data,
   ProtocolTriggersApiControllerTriggerMissionClose0V1Errors,
   ProtocolTriggersApiControllerTriggerMissionClose0V1Responses,
@@ -4543,6 +4546,34 @@ export const pilotsControllerGetPilotReputationV2V2 = <
   });
 };
 
+/**
+ * Get a pilot's reservation slots (mission-fulfillment)
+ * Returns how many reservation slots the pilot's reputation points unlock, how many their active reservations use, and how many are free, from mission-fulfillment.
+ */
+export const pilotsControllerGetPilotReservationSlotsV2V2 = <
+  ThrowOnError extends boolean = true,
+>(
+  options: Options<
+    PilotsControllerGetPilotReservationSlotsV2V2Data,
+    ThrowOnError
+  >,
+) => {
+  return (options.client ?? _heyApiClient).get<
+    PilotsControllerGetPilotReservationSlotsV2V2Responses,
+    PilotsControllerGetPilotReservationSlotsV2V2Errors,
+    ThrowOnError
+  >({
+    security: [
+      {
+        name: "x-api-token",
+        type: "apiKey",
+      },
+    ],
+    url: "/v2/pilots/{address}/reservation-slots",
+    ...options,
+  });
+};
+
 /**
  * List reservations (mission-fulfillment)
  * Returns reservations from mission-fulfillment.

package/src/client/types.gen.ts

@@ -1005,6 +1005,9 @@ export type CreateVaultsResponseDto = {
 export type CreateWebhookBody = {
   name: string;
   url: string;
+  /**
+   * "*" subscribes to every event type except the transitional fulfillment.reservation and fulfillment.mission-hold, which are delivered only when named and will be removed once Pilot API MVT indexing moves to LayerDrone.
+   */
   event_types: Array<
     | "test"
     | "protocol.mission.created"
@@ -1013,6 +1016,8 @@ export type CreateWebhookBody = {
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
     | "protocol.zone"
+    | "fulfillment.reservation"
+    | "fulfillment.mission-hold"
     | "*"
   >;
   active: boolean;
@@ -1027,6 +1032,9 @@ export type GetWebhooksResponse = Array<{
   id: number;
   name: string;
   url: string;
+  /**
+   * "*" subscribes to every event type except the transitional fulfillment.reservation and fulfillment.mission-hold, which are delivered only when named and will be removed once Pilot API MVT indexing moves to LayerDrone.
+   */
   event_types: Array<
     | "test"
     | "protocol.mission.created"
@@ -1035,6 +1043,8 @@ export type GetWebhooksResponse = Array<{
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
     | "protocol.zone"
+    | "fulfillment.reservation"
+    | "fulfillment.mission-hold"
     | "*"
   >;
   active: boolean;
@@ -1049,6 +1059,9 @@ export type GetWebhookResponse = {
   id: number;
   name: string;
   url: string;
+  /**
+   * "*" subscribes to every event type except the transitional fulfillment.reservation and fulfillment.mission-hold, which are delivered only when named and will be removed once Pilot API MVT indexing moves to LayerDrone.
+   */
   event_types: Array<
     | "test"
     | "protocol.mission.created"
@@ -1057,6 +1070,8 @@ export type GetWebhookResponse = {
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
     | "protocol.zone"
+    | "fulfillment.reservation"
+    | "fulfillment.mission-hold"
     | "*"
   >;
   active: boolean;
@@ -1070,6 +1085,9 @@ export type GetWebhookResponse = {
 export type UpdateWebhookBody = {
   name?: string;
   url?: string;
+  /**
+   * "*" subscribes to every event type except the transitional fulfillment.reservation and fulfillment.mission-hold, which are delivered only when named and will be removed once Pilot API MVT indexing moves to LayerDrone.
+   */
   event_types?: Array<
     | "test"
     | "protocol.mission.created"
@@ -1078,6 +1096,8 @@ export type UpdateWebhookBody = {
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
     | "protocol.zone"
+    | "fulfillment.reservation"
+    | "fulfillment.mission-hold"
     | "*"
   >;
   active?: boolean;
@@ -1087,6 +1107,9 @@ export type UpdateWebhookResponse = {
   id: number;
   name: string;
   url: string;
+  /**
+   * "*" subscribes to every event type except the transitional fulfillment.reservation and fulfillment.mission-hold, which are delivered only when named and will be removed once Pilot API MVT indexing moves to LayerDrone.
+   */
   event_types: Array<
     | "test"
     | "protocol.mission.created"
@@ -1095,6 +1118,8 @@ export type UpdateWebhookResponse = {
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
     | "protocol.zone"
+    | "fulfillment.reservation"
+    | "fulfillment.mission-hold"
     | "*"
   >;
   active: boolean;
@@ -1450,6 +1475,7 @@ export type FlightPathIntendedResponse = {
       id: string;
       slug?: string | null;
       name?: string;
+      family?: "Map" | "Multi Panorama" | "Panorama" | "Grid Map" | "Hybrid";
     };
     zoneHash: string;
     imageCount: number;
@@ -1848,6 +1874,13 @@ export type CancelReservationBody = {
   pilot_address: string;
 };
 
+export type PilotReservationSlotsResponse = {
+  pilot_address: string;
+  total: number;
+  used: number;
+  free: number;
+};
+
 export type PilotReputationResponse = {
   pilot_address: string;
   points: number;
@@ -5551,6 +5584,27 @@ export type PilotsControllerGetPilotReputationV2V2Responses = {
 export type PilotsControllerGetPilotReputationV2V2Response =
   PilotsControllerGetPilotReputationV2V2Responses[keyof PilotsControllerGetPilotReputationV2V2Responses];
 
+export type PilotsControllerGetPilotReservationSlotsV2V2Data = {
+  body?: never;
+  path: {
+    address: string;
+  };
+  query?: never;
+  url: "/v2/pilots/{address}/reservation-slots";
+};
+
+export type PilotsControllerGetPilotReservationSlotsV2V2Errors = {
+  401: unknown;
+  403: unknown;
+};
+
+export type PilotsControllerGetPilotReservationSlotsV2V2Responses = {
+  200: PilotReservationSlotsResponse;
+};
+
+export type PilotsControllerGetPilotReservationSlotsV2V2Response =
+  PilotsControllerGetPilotReservationSlotsV2V2Responses[keyof PilotsControllerGetPilotReservationSlotsV2V2Responses];
+
 export type ReservationsControllerGetReservationsV2V2Data = {
   body?: never;
   path?: never;

package/src/event/types.gen.ts

@@ -169,6 +169,91 @@ export const Event = z.union([
         .catchall(z.any()),
     })
     .catchall(z.any()),
+  z
+    .object({
+      id: z.string(),
+      event_type: z.literal("fulfillment.reservation"),
+      timestamp: z.string(),
+      data: z
+        .object({
+          version: z.literal(1),
+          data: z
+            .object({
+              id: z.string().uuid(),
+              missionId: z.string().uuid(),
+              missionHoldId: z.string().uuid(),
+              pilotAddress: z.string().regex(new RegExp("^0x[a-fA-F0-9]{40}$")),
+              status: z.enum(["active", "completed", "cancelled", "expired"]),
+              endedAt: z.union([
+                z.string().datetime({ offset: true }),
+                z.null(),
+              ]),
+              createdAt: z.string().datetime({ offset: true }),
+              updatedAt: z.string().datetime({ offset: true }),
+            })
+            .catchall(z.any()),
+          changes: z
+            .array(
+              z.enum([
+                "id",
+                "missionId",
+                "missionHoldId",
+                "pilotAddress",
+                "status",
+                "endedAt",
+                "createdAt",
+                "updatedAt",
+              ]),
+            )
+            .optional(),
+        })
+        .catchall(z.any()),
+    })
+    .catchall(z.any()),
+  z
+    .object({
+      id: z.string(),
+      event_type: z.literal("fulfillment.mission-hold"),
+      timestamp: z.string(),
+      data: z
+        .object({
+          version: z.literal(1),
+          data: z
+            .object({
+              id: z.string().uuid(),
+              missionId: z.string().uuid(),
+              pilotAddress: z.string().regex(new RegExp("^0x[a-fA-F0-9]{40}$")),
+              expiresAt: z.string().datetime({ offset: true }),
+              releasedAt: z.union([
+                z.string().datetime({ offset: true }),
+                z.null(),
+              ]),
+              releasedReason: z.union([
+                z.enum(["expired", "completed", "cancelled"]),
+                z.null(),
+              ]),
+              createdAt: z.string().datetime({ offset: true }),
+              updatedAt: z.string().datetime({ offset: true }),
+            })
+            .catchall(z.any()),
+          changes: z
+            .array(
+              z.enum([
+                "id",
+                "missionId",
+                "pilotAddress",
+                "expiresAt",
+                "releasedAt",
+                "releasedReason",
+                "createdAt",
+                "updatedAt",
+              ]),
+            )
+            .optional(),
+        })
+        .catchall(z.any()),
+    })
+    .catchall(z.any()),
 ]);
 export type Event = z.infer<typeof Event>;
 
@@ -194,3 +279,23 @@ export type FlightReviewedEvent = Extract<
   { event_type: "protocol.flight.reviewed" }
 >;
 export type ZoneEvent = Extract<Event, { event_type: "protocol.zone" }>;
+/**
+ * @deprecated Transitional - for Pilot API MVT indexing only, and removed once
+ * MVT generation moves to LayerDrone. Not delivered through "*": a webhook
+ * must subscribe to it by name. Delivery is at most once, so do not treat it
+ * as a source of truth.
+ */
+export type FulfillmentReservationEvent = Extract<
+  Event,
+  { event_type: "fulfillment.reservation" }
+>;
+/**
+ * @deprecated Transitional - for Pilot API MVT indexing only, and removed once
+ * MVT generation moves to LayerDrone. Not delivered through "*": a webhook
+ * must subscribe to it by name. Delivery is at most once, so do not treat it
+ * as a source of truth.
+ */
+export type FulfillmentMissionHoldEvent = Extract<
+  Event,
+  { event_type: "fulfillment.mission-hold" }
+>;