NCS: extract some API communication schemas

.changeset/quiet-fishes-lie.md

@@ -0,0 +1,5 @@
+---
+"@crossmint/client-signers": patch
+---
+
+Adding API DTOs

packages/client/signers/src/api/index.ts

@@ -0,0 +1 @@
+export * from "./schemas";

packages/client/signers/src/api/schemas/completeOnboarding.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+
+export const completeOnboardingRequestSchema = z.object({
+    publicKey: z.string(),
+    onboardingAuthentication: z.object({
+        otp: z.string(),
+    }),
+    deviceId: z.string(),
+});
+export type CompleteOnboardingRequest = z.infer<typeof completeOnboardingRequestSchema>;
+
+export const completeOnboardingResponseSchema = z.object({
+    deviceKeyShare: z.string(),
+    signerId: z.string(),
+});
+export type CompleteOnboardingResponse = z.infer<typeof completeOnboardingResponseSchema>;

packages/client/signers/src/api/schemas/getAttestation.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+
+export const getAttestationRequestSchema = z.undefined();
+export type GetAttestationRequest = z.infer<typeof getAttestationRequestSchema>;
+
+export const getAttestationResponseSchema = z.object({
+    publicKey: z.string(),
+    quote: z.string(),
+    event_log: z.string(),
+    hash_algorithm: z.literal("sha512"),
+    prefix: z.literal("app-data"),
+});
+export type GetAttestationResponse = z.infer<typeof getAttestationResponseSchema>;

packages/client/signers/src/api/schemas/getAuthShard.ts

@@ -0,0 +1,11 @@
+import { z } from "zod";
+
+export const getAuthShardRequestSchema = z.undefined();
+export type GetAuthShardRequest = z.infer<typeof getAuthShardRequestSchema>;
+
+export const getAuthShardResponseSchema = z.object({
+    signerId: z.string(),
+    authKeyShare: z.string(),
+    deviceKeyShareHash: z.string(),
+});
+export type GetAuthShardResponse = z.infer<typeof getAuthShardResponseSchema>;

packages/client/signers/src/api/schemas/getPublicKey.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+export const getPublicKeyRequestSchema = z.undefined();
+export type GetPublicKeyRequest = z.infer<typeof getPublicKeyRequestSchema>;
+
+export const getPublicKeyResponseSchema = z.object({
+    publicKey: z.string(),
+});
+export type GetPublicKeyResponse = z.infer<typeof getPublicKeyResponseSchema>;

packages/client/signers/src/api/schemas/index.ts

@@ -0,0 +1,5 @@
+export * from "./completeOnboarding";
+export * from "./getAttestation";
+export * from "./getAuthShard";
+export * from "./getPublicKey";
+export * from "./startOnboarding";

packages/client/signers/src/api/schemas/startOnboarding.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+
+export const startOnboardingRequestSchema = z.object({
+    authId: z.string(),
+    deviceId: z.string(),
+    encryptionContext: z.object({
+        publicKey: z.string(),
+    }),
+});
+export type StartOnboardingRequest = z.infer<typeof startOnboardingRequestSchema>;
+
+export const startOnboardingResponseSchema = z.object({});
+export type StartOnboardingResponse = z.infer<typeof startOnboardingResponseSchema>;

packages/client/signers/src/index.ts

@@ -1 +1,2 @@
 export * from "./communications";
+export * from "./api";