Class Shopify

integrations/shopify/src/index.ts:52–225

  TEventCatalog extends WebhookEventCatalog<infer U, any> ? keyof U : never;

export class Shopify implements TriggerIntegration {
  private _options: ShopifyIntegrationOptions;

  private _client?: ReturnType<(typeof this)["createClient"]>;
  private _io?: IO;
  private _connectionKey?: string;
  private _session?: Session;
  private _shopDomain: string;

  constructor(private options: ShopifyIntegrationOptions) {
    if (Object.keys(options).includes("apiKey") && !options.apiKey) {
      throw `Can't create Shopify integration (${options.id}) as apiKey was undefined`;
    }

    if (Object.keys(options).includes("apiSecretKey") && !options.apiSecretKey) {
      throw `Can't create Shopify integration (${options.id}) as apiSecretKey was undefined`;
    }

    if (Object.keys(options).includes("adminAccessToken") && !options.adminAccessToken) {
      throw `Can't create Shopify integration (${options.id}) as adminAccessToken was undefined`;
    }

    if (Object.keys(options).includes("hostName") && !options.hostName) {
      throw `Can't create Shopify integration (${options.id}) as hostName was undefined`;
    }

    this._options = options;
    // Extract the shop domain if user has entered the full URL
    this._shopDomain = this._options.hostName
      .replace(/^https?:\/\//, "") // Remove http:// or https://
      .replace(/\/$/, ""); // Remove trailing slash if it exists (e.g. `example.myshopify.com/`)

    // Regular expression to ensure the shopDomain is a valid `.myshopify.com` domain
    const shopifyDomainPattern = /^[a-zA-Z0-9-]+\.myshopify\.com$/;

    if (!shopifyDomainPattern.test(this._shopDomain)) {
      throw `Can't create Shopify integration (${options.id}) because hostName should be a valid ".myshopify.com" domain, not a custom primary domain. For example: my-domain.myshopify.com`;
    }
  }

  get authSource() {
    return this._options.apiKey ? "LOCAL" : "HOSTED";
  }

  get id() {
    return this.options.id;
  }

  get metadata() {
    return { id: "shopify", name: "Shopify" };
  }

  get #source() {
    return createWebhookEventSource(this);
  }

  get #eventCatalog() {
    return createWebhookEventCatalog(this.#source);