@shopify/shopify-api/lib/utils/types.ts

Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks

import {AdapterArgs} from '../../runtime/types';

export enum HmacValidationType {
  Flow = 'flow',
  Webhook = 'webhook',
  FulfillmentService = 'fulfillment_service',
}

export interface ValidateParams extends AdapterArgs {
  /**
   * The raw body of the request.
   */
  rawBody: string;
}

export const ValidationErrorReason = {
  MissingBody: 'missing_body',
  InvalidHmac: 'invalid_hmac',
  MissingHmac: 'missing_hmac',
} as const;

export type ValidationErrorReasonType =
  (typeof ValidationErrorReason)[keyof typeof ValidationErrorReason];

export interface ValidationInvalid {
  /**
   * Whether the request is a valid Flow request from Shopify.
   */
  valid: false;
  /**
   * The reason why the request is not valid.
   */
  reason: ValidationErrorReasonType;
}

export interface ValidationValid {
  /**
   * Whether the request is a valid request from Shopify.
   */
  valid: true;
}