sharetribe-flex-sdk/playground.js

Sharetribe SDK for JavaScript

/* eslint-env node */
/* eslint-disable no-console */

// Don't show an error when devDependencies (i.e. colors) is imported
/* eslint import/no-extraneous-dependencies: ["error", {"devDependencies": true}] */

const colors = require('colors');
const repl = require('repl');
const commandLineArgs = require('command-line-args');
const commandLineUsage = require('command-line-usage');
const fs = require('fs');
const open = require('open');
const util = require('util');
const sharetribeSdk = require('./src/index');
const {LatLng, LatLgnBounds, UUID, Money, BigDecimal} = require('./src/types');

// Welcome message when Playground starts
const printWelcomeMessage = raw => {
  colors.setTheme({
    h1: 'yellow',
    h2: 'yellow',
    inline: 'gray',
    block: 'gray',
  });

  if (raw) {
    console.log('');
    console.log('  # Playground (raw mode)'.h1);
    console.log('  ');
    console.log('  With the Marketplace API Playground you can test and try out the SDK with real results from the API.');
    console.log('  ');
    console.log('  ## Globals'.h2);
    console.log('  ');
    console.log('  The following globals are available:');
    console.log('  ');
    console.log(`  - ${'`sharetribeSdk`'.inline}: The SDK module`);
    console.log(`  - ${'`printResponse`'.inline}: Helper function for pretty printing the API response.`);
    console.log(`  - ${'`pr`'.inline}: Helper function for pretty printing the API response from the last command that ran (presumably an API call).`);
    console.log(`  - ${'`apiDocs`'.inline}: Open the Marketplace API documentation in your browser.`);
    console.log('  ');
    console.log('  ## Example usage'.h2);
    console.log('  ');
    console.log('  Create new SDK instance:');
    console.log('  ');
    console.log('  ```'.block);
    console.log('  const clientId = "<your clientId here>";'.block);
    console.log('  const sdk = sharetribeSdk.createInstance({'.block);
    console.log('    clientId,'.block);
    console.log('    tokenStore: sharetribeSdk.tokenStore.memoryStore()'.block);
    console.log('  });'.block);
    console.log('  ```'.block);
    console.log('  ');
    console.log('  Print marketplace information:');
    console.log('  ');
    console.log('  sdk.marketplace.show().then(printResponse);'.block);
    console.log('  ');
    console.log('  Alternative version using pr():');
    console.log('  ');
    console.log('  sdk.marketplace.show();'.block);
    console.log('  pr();'.block);
    console.log('  ');
    console.log('  Fetch 10 listings:');
    console.log('  ');
    console.log('  sdk.listings.query({per_page: 10}).then(response => {'.block);
    console.log('    console.log("Fetched " + response.data.data.length + " listings.");'.block);
    console.log('    response.data.data.forEach(listing => {'.block);
    console.log('      console.log(listing.attributes.title);'.block);
    console.log('    });'.block);
    console.log('  });'.block);
    console.log('  ');
    console.log(`  Type ${'`.exit`'.inline} when you want to exit the Playground`);
  } else {
    console.log('');
    console.log('  # Playground'.h1);
    console.log('  ');
    console.log('  With the Marketplace API Playground you can test and try out the SDK with real results from the API.');
    console.log('  ');
    console.log('  ## Globals'.h2);
    console.log('  ');
    console.log('  The following globals are available:');
    console.log('  ');
    console.log(`  - ${'`sharetribeSdk`'.inline}: The SDK module`);
    console.log(`  - ${'`sdk`'.inline}: An SDK instance initialized with your client ID`);
    console.log(`  - ${'`printResponse`'.inline}: Helper function for pretty printing the API response.`);
    console.log(`  - ${'`apiDocs`'.inline}: Open the Marketplace API documentation in your browser.`);
    console.log('  ');
    console.log('  ## Example usage'.h2);
    console.log('  ');
    console.log('  Print marketplace information:');
    console.log('  ');
    console.log('  sdk.marketplace.show().then(printResponse);'.block);
    console.log('  ');
    console.log('  Alternative version using pr():');
    console.log('  ');
    console.log('  sdk.marketplace.show();'.block);
    console.log('  pr();'.block);
    console.log('  ');
    console.log('  Fetch 10 listings:');
    console.log('  ');
    console.log('  ```'.block);
    console.log('  sdk.listings.query({per_page: 10}).then(response => {'.block);
    console.log('    console.log("Fetched " + response.data.data.length + " listings.");'.block);
    console.log('    response.data.data.forEach(listing => {'.block);
    console.log('      console.log(listing.attributes.title);'.block);
    console.log('    });'.block);
    console.log('  });'.block);
    console.log('  ```'.block);
    console.log('  ');
    console.log(`  Type ${'`.exit`'.inline} when you want to exit the Playground`);
  }
};

// CLI Usage information
const optionDefinitions = [
  {
    name: 'help',
    description: 'Display this usage guide.',
    alias: 'h',
    type: Boolean
  },
  {
    name: 'clientid',
    description: 'Your Marketplace API Client ID to initialize the SDK with. You create your Client ID in Console: {underline https://console.sharetribe.com/advanced/applications}.',
    alias: 'c',
    typeLabel: '{underline ID}',
    type: String
  },
  {
    name: 'user',
    description: 'The email of the user to log in with. The SDK is initialized in an authenticated state.',
    alias: 'u',
    typeLabel: '{underline email}',
    type: String
  },
  {
    name: 'password',
    description: 'The password of the user to log in with. The SDK is initialized in an authenticated state.',
    alias: 's',
    typeLabel: '{underline password}',
    type: String
  },
  {
    name: 'raw',
    description: 'Start the playground without initializing the SDK.',
    type: Boolean
  },
  {
    name: 'script',
    description: 'Execute a playground script, i.e. a file that contains one or more playground commands.',
    typeLabel: '{underline script_file.js}',
    type: String
  },
  {
    name: 'apidocs',
    description: 'Open the Marketplace API reference using default browser.',
    type: Boolean
  }
];

const printUsage = () => {
  console.log(commandLineUsage([
    {
      header: 'Marketplace API Playground',
      content: 'The easiest way to call the Sharetribe Marketplace API using the JS SDK to try things out, to learn the APIs and to test your ideas.'
    },
    {
      header: 'Options',
      optionList: optionDefinitions
    }
  ]));
};

const printResponse = response => {
  console.log(JSON.stringify(response.data, null, 4));
  return response;
}

const printLastResponse = (ctx) =>
      () => ctx._.then(printResponse);

const apiDocs = () =>
      open('https://www.sharetribe.com/api-reference/marketplace.html?javascript#marketplace-api')
      .then(() => '');

const setupContext = (ctx, sdk) => {
  ctx.sharetribeSdk = sharetribeSdk;
  if (sdk) {
    ctx.sdk = sdk;
  }
  ctx.printResponse = printResponse;
  ctx.pr = printLastResponse(ctx);
  ctx.apiDocs = apiDocs;
  ctx.LatLng = LatLng;
  ctx.LatLngBounds = LatLgnBounds;
  ctx.UUID = UUID;
  ctx.Money = Money;
  ctx.BigDecimal = BigDecimal;
}

const startRepl = (sdk, rawMode, src) =>
      () => {
        if (src) {
          // Setup context
          setupContext(global, sdk);

          // Start REPL
          console.log('Executing script...');
          console.log();
          repl.start({
            prompt: '> ',
            input: src,
            output: process.stdout,
            useGlobal: true,
            writer: result => result instanceof Promise ? '' : util.inspect(result)
          });
        } else {
          printWelcomeMessage(rawMode);
          // Start REPL
          const replInstance = repl.start('> ');

          // Attach history
          // Node versions prior to 10.11 don't support setupHistory
          if (replInstance.setupHistory) {
            replInstance.setupHistory('./.repl_history', () => null);
          }

          // Setup context
          const ctx = replInstance.context;
          setupContext(ctx, sdk);
        }
      }

const exitOnFailure = msg =>
      () => {
        console.error(msg)
        process.exit(1);
      };

// Parse command line args
//
const options = commandLineArgs(optionDefinitions);

if (options.apidocs) {
  apiDocs();
  process.exit();
}

if (options.help || (!options.raw && options.clientid == null)) {
  printUsage();
  process.exit();
};

let scriptSrc;
if (options.script) {
  scriptSrc = fs.createReadStream(options.script);
} else {
  scriptSrc = null;
}

// If client ID is provided on start, instantiate and expose sdk
if (options.clientid) {
  const sdk = sharetribeSdk.createInstance({
    clientId: options.clientid,
    tokenStore: sharetribeSdk.tokenStore.memoryStore()
  });

  // If user auth info is given too, log in with the user.
  if (options.user && options.password) {
    console.log(`Initializing SDK instance with Client ID: ${options.clientid}...`)
    sdk.marketplace.show()
      .then(result => console.log(`Successfully connected to ${result.data.data.attributes.name} marketplace.`))
      .catch(exitOnFailure(`Unable to access the Marketplace API with the given Client ID: ${options.clientid}.`))
      .then(() => {
        console.log(`Logging in user ${options.user}...`);
        return sdk.login({
          username: options.user,
          password: options.password
        });
      })
      .catch(exitOnFailure(`Unable to log in with the email: ${options.user} and password you gave.`))
      .then(startRepl(sdk, false, scriptSrc));

  // No user auth, just Client ID
  } else {
    console.log(`Initializing SDK instance with Client ID: ${options.clientid}...`)
    sdk.marketplace.show()
      .then(result => console.log(`Successfully connected to ${result.data.data.attributes.name} marketplace.`))
      .catch(exitOnFailure(`Unable to access the Marketplace API with the given Client ID: ${options.clientid}.`))
      .then(startRepl(sdk, false, scriptSrc));

  }
// Raw mode
} else {
  startRepl(null, true, scriptSrc)();
}