get-bookmark.js

/**
 *
 * @todo support setting ref and token in more way, via cookie, params, etc.
 *
 */
module.exports = {

  friendlyName: 'Get document by bookmark',
  description: 'Get a prismic document by bookmark.',

  inputs: {
    apiEndpoint: {
      example: 'https://mycompany.prismic.io/api',
      description: 'Api endpoint for your prismic instance',
      required: true,
    },
    accessToken: {
      example: 'MC5WUWg4VFOHFh.77-9777-9Me-_73vv73vv70rUO-_vWPvv71O77-9ZUPvv73vv71pX--_vQdaNe-_vQ',
      description: 'Token provided via settings/apps/.',
      required: true
    },
    bookmark: {
      example: 'my-great-bookmark',
      description: 'Bookmark of document.',
      required: true
    },
    ref: {
      example: 'VUYf7y0AAJkBHcVj',
      description: 'Control which versions of documents we can access. Defaults to master which is all live documents.',
      required: false
    }
  },

  defaultExit: 'success',

  exits: {
    error: {
      description: 'An unexpected error occurred.'
    },
    notFound: {
      description: 'Document not found',
    },
    notAuthorized: {
      description: 'Not authorized'
    },
    success: {
      description: 'Document found via slug',
      example: {}
    }
  },

  fn: function(inputs, exits) {

    var Prismic = require('prismic.io').Prismic;

    function linkResolver(doc) {
      if (doc.isBroken) return false;
      return '/documents/' + doc.id + '/' + doc.slug;
    }

    Prismic.Api(inputs.apiEndpoint, function(err, Api) {
      if (err && err.toString().indexOf('401') !== -1) {
        return exits.notAuthorized(err);
      } else if (err) {
        return exits.error(err);
      }
      var ctx = {
        api: Api,
        ref: inputs.ref || Api.master(),
        linkResolver: function(doc) {
          return linkResolver(doc);
        }
      };

      var id = ctx.api.bookmarks[inputs.bookmark];
      var getDocument = require('machine').build(require('./get-document'));

      getDocument({
        apiEndpoint: inputs.apiEndpoint,
        accessToken: inputs.accessToken,
        ref: inputs.ref,
        id: id
      }).exec({
        error: exits.error,
        notFound: exits.notFound,
        notAuthorized: exits.notAuthorized,
        success: exits.success
      });

    }, inputs.accessToken);

  }

};







// fin