@smarthost/feathers-unsplash

@smarthost/feathers-unsplash

FeathersJS service adapter for querying the Unsplash API

About

This project uses Feathers. An open source web framework for building modern real-time applications.

It is built on top of the official unsplash-js package.

This is a fork and update of marshallswain/feathers-unsplash

Supported Services

Below is a list of all exposed services and their implemented methods. All can be used like the UnsplashPhotos example given below

• UnsplashPhotos (find, get)
• UnsplashPhotoStatistics (get)
• UnsplashTrackPhotos (create)
• UnsplashCollections (find, get)
• UnsplashCollectionPhotos (find)
• UnsplashRelatedCollections (get)
• UnsplashTopics (find, get)
• UnsplashTopicPhotos (find)
• UnsplashUsers (find, get)
• UnsplashUserPhotos (find)
• UnsplashUserCollections (find)
• UnsplashUserLikes (find)

More documentation coming soon

Install

npm install @smarthost/feathers-unsplash node-fetch unsplash-js

yarn add @smarthost/feathers-unsplash node-fetch unsplash-js

Other packages needed may be: tslib, @feathersjs/errors

This adapter requires fetch support, which means you'll need to provide it on the global scope. This means that somewhere in your app you need to use this code:

// preferably in the the index file
const fetch = require("node-fetch");
global.fetch = fetch;

// typescript
import fetch from "node-fetch";
global.fetch = fetch as any; // trick for type imcompatibility for now

Setup API Access

First you'll need to setup Unsplash API access.

• Create an app on the Unsplash API
• Copy the accessKey into an environment variable.
• Setup the FeathersJS config

// default.json

"unsplash": {
    "accessKey": "MYAPPNAME_UNSPLASH_ACCESS_KEY"
}

Setup a Service

The easiest way to setup a service is to use the FeathersJS Cli to generate a "Custom Service". You can then delete the service-name.class.js file that the generator makes and use code like in this example:

// Initializes the `unsplash-photos` service on path `/unsplash-photos`
const { UnsplashPhotos } = require("@smarthost/feathers-unsplash");
const hooks = require("./unsplash-photos.hooks");

module.exports = function (app) {
  const options = {
    accessKey: app.get("unsplash").accessKey,
  };

  // Initialize the service with any options it requires
  app.use("/unsplash-photos", new UnsplashPhotos(options, app));

  // Get the initialized service so that we can register hooks
  const service = app.service("unsplash-photos");

  service.hooks(hooks);
};

API

find

The find method supports searching photos by the following query params:

• keyword: the search text
• orientation: can be either portrait or landscape. Any other values return an empty list.
• collectionIds: an array of collection ids.
• also other parameters supported by the unsplash wrapper. search.getPhotos

It also supports familiar pagination attributes: $limit and $skip. Note that since the Unsplash API only supports page-level pagination (not record-level skipping like most FeathersJS adapters), you must provide $skip as a multiple of the $limit. Here is an example query:

const response = await app.service('unsplash-photos').find({
  query: {
    $limit: 10, // this is the default limit
    $skip: 10 // Skipping 10 returns the second page of data.
    keyword: 'food',
    orientation: 'portrait',
  }
})

get

The get method can be used in two ways:

• Pass an image id to retrieve data about the image.
• Pass 'random' to retrieve a random image. See possible params for photos.getRandom

const imageData = await app.service("unsplash-photos").get(id);
const randomImageData = await app.service("unsplash-photos").get("random");

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.