@nadohq/mobile-client 0.27.0

package/src/types/serverQueryTypes.ts

@@ -0,0 +1,74 @@
+import {
+  MobileServerPublicQueryParamsByType,
+  MobileServerPublicQueryType,
+  MobileServerSuccessResponse,
+} from './serverBaseTypes';
+import {
+  MobileServerIdentity,
+  MobileServerNotificationPreferences,
+  MobileServerProfile,
+  MobileServerRegisteredDevice,
+} from './serverModelTypes';
+
+/**
+ * Unsigned `public_query` request body: a `type` discriminant flattened with its params.
+ */
+export type MobileServerPublicQueryRequest<
+  T extends MobileServerPublicQueryType = MobileServerPublicQueryType,
+> = {
+  [K in MobileServerPublicQueryType]: {
+    type: K;
+  } & MobileServerPublicQueryParamsByType[K];
+}[T];
+
+/**
+ * Request body for the `username_availability` public query.
+ */
+export type MobileServerUsernameAvailabilityRequest =
+  MobileServerPublicQueryRequest<'username_availability'>;
+
+/**
+ * Request body for the `profile` public query.
+ */
+export type MobileServerProfileRequest =
+  MobileServerPublicQueryRequest<'profile'>;
+
+/**
+ * Successful response for the `username_availability` public query.
+ */
+export type MobileServerUsernameAvailabilityResponse =
+  MobileServerSuccessResponse<{
+    username: string;
+    available: boolean;
+  }>;
+
+/**
+ * Successful response for the `profile` public query.
+ */
+export type MobileServerProfileResponse = MobileServerSuccessResponse<{
+  profile: MobileServerProfile;
+}>;
+
+/**
+ * Successful response for the signed `self_identity` query. A `null` identity means the subaccount has not
+ * claimed a username yet — this is normal data, not an error.
+ */
+export type MobileServerSelfIdentityResponse = MobileServerSuccessResponse<{
+  identity: MobileServerIdentity | null;
+}>;
+
+/**
+ * Successful response for the signed `notification_preferences` query.
+ */
+export type MobileServerNotificationPreferencesResponse =
+  MobileServerSuccessResponse<{
+    preferences: MobileServerNotificationPreferences;
+  }>;
+
+/**
+ * Successful response for the signed `registered_devices` query.
+ */
+export type MobileServerRegisteredDevicesResponse =
+  MobileServerSuccessResponse<{
+    devices: MobileServerRegisteredDevice[];
+  }>;

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './patterns';
+export * from './serverResponseGuards';

package/src/utils/patterns.ts

@@ -0,0 +1,4 @@
+/**
+ * Validates a display name: 3-20 ASCII characters from `[A-Za-z0-9_.]`, allowed in any position.
+ */
+export const MOBILE_DISPLAY_NAME_PATTERN = /^[A-Za-z0-9_.]{3,20}$/;

package/src/utils/serverResponseGuards.ts

@@ -0,0 +1,27 @@
+import { MobileServerFailureResponse } from '../types/serverBaseTypes';
+
+/**
+ * Narrows an unknown response body to the mobile service API failure envelope.
+ */
+export function isMobileServerFailureResponse(
+  data: unknown,
+): data is MobileServerFailureResponse {
+  return (
+    typeof data === 'object' &&
+    data !== null &&
+    (data as Record<string, unknown>).status === 'failure'
+  );
+}
+
+/**
+ * Narrows an unknown response body to a successful mobile service API envelope.
+ */
+export function isMobileServerSuccessResponse<T extends { status: 'success' }>(
+  data: unknown,
+): data is T {
+  return (
+    typeof data === 'object' &&
+    data !== null &&
+    (data as Record<string, unknown>).status === 'success'
+  );
+}