@layer-drone/protocol 2.3.0 → 2.4.0

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.0",
+  "version": "2.4.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/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;

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" }
+>;