shopify-token/types/index.d.ts

Get an OAuth 2.0 access token for the Shopify API with ease

/// <reference types="node" />
import { Agent } from 'https';

declare namespace ShopifyToken {
  export interface ShopifyTokenOptions {
    // The redirect URL for the Oauth2 flow
    redirectUri: string;
    // The Shared Secret for the app
    sharedSecret: string;
    // The API Key for the app
    apiKey: string;
    // The list of scopes
    scopes?: string | string[];
    // The request timeout
    timeout?: number;
    // API access mode
    accessMode?: string;
    // The agent used for all HTTP requests
    agent?: Agent;
  }

  export interface OfflineAccessTokenData {
    access_token: string;
    scope: string;
  }

  export interface AccessTokenAssociatedUser {
    id: number;
    first_name: string;
    last_name: string;
    email: string;
    email_verified: boolean;
    account_owner: boolean;
    locale: string;
    collaborator: boolean;
  }

  export interface OnlineAccessTokenData {
    access_token: string;
    scope: string;
    expires_in: number;
    associated_user_scope: string;
    associated_user: AccessTokenAssociatedUser;
  }
}

declare class ShopifyToken {
  /**
   * Create a ShopifyToken instance.
   *
   * @param {Object} options Configuration options
   * @param {String} options.redirectUri The redirect URL for the Oauth2 flow
   * @param {String} options.sharedSecret The Shared Secret for the app
   * @param {Array|String} [options.scopes] The list of scopes
   * @param {String} options.apiKey The API Key for the app
   * @param {String} [options.accessMode] The API access mode
   * @param {Number} [options.timeout] The request timeout
   * @param {Agent} [options.agent] The agent used for all HTTP requests
   */
  constructor(options: ShopifyToken.ShopifyTokenOptions);
  /**
   * Generate a random nonce.
   *
   * @return {String} The random nonce
   * @public
   */
  generateNonce(): string;
  /**
   * Build the authorization URL.
   *
   * @param {String} shop The shop name
   * @param {Array|String} [scopes] The list of scopes
   * @param {String} [nonce] The nonce
   * @param {String} [accessMode] The API access mode
   * @return {String} The authorization URL
   * @public
   */
  generateAuthUrl(
    shop: string,
    scopes?: string | string[],
    nonce?: string,
    accessMode?: string
  ): string;
  /**
   * Verify the hmac returned by Shopify.
   *
   * @param {Object} query The parsed query string
   * @return {Boolean} `true` if the hmac is valid, else `false`
   * @public
   */
  verifyHmac(query: any): boolean;
  /**
   * Request an access token.
   *
   * @param {String} shop The hostname of the shop, e.g. foo.myshopify.com
   * @param {String} code The authorization code
   * @return {Promise} Promise which is fulfilled with an access token and
   *     additional data
   * @public
   */
  getAccessToken(
    shop: string,
    code: string
  ): Promise<
    ShopifyToken.OfflineAccessTokenData | ShopifyToken.OnlineAccessTokenData
  >;
}

export = ShopifyToken;