leeqj / better-onetab-sync-server

This is the sync server for better-onetab. Please don't submit PR to master directly.

Better Onetab Sync Server

It will provide more features like sharing or management in the future.

Development notes

Todo

• complete API paramater validation
• restrict socket connect from application
• remove useless API
• refactor structure
• front page

Authorization

Visiting /auth/:type will go to OAuth page and the final page will take the jwt token in header.

available type list: github google (case-sensitive)

Every time you send a request to API with token will get a new token.

Tricks for using it in a web extension:

1st way If query string has a paramater named ext it will redirect to ${ext}/#${jwt token}# at the final.

e.g.

Visiting

/auth/github?ext=https%3A%2F%2Fgeghaancpajoplmhcocjboinmihhmpjf.chromiumapp.org%2F%22

will redirect to

https://geghaancpajoplmhcocjboinmihhmpjf.chromiumapp.org/#{JWT_TOKEN}#

at the final.

So it is possible to use chrome.identity.launchWebAuthFlow to get token. But it has some incompatibility problem and maybe do not work on Firefox or occur some error in Chrome. So in the new version it will take the next way.

2nd way Use content script to send token to background page.

So in the new version of sync server will provide a or more user friendly login page.

API

v1

all of following API require authorization

GET /api/info Get the infos of user and sync.

GET /api/lists Get all lists.

GET /api/opts Get all options.

PUT /api/opts Modify all options.

PUT /api/lists Modify all lists.

v2 (planning)

POST /api/v2/list Create a new list.

PUT /api/v2/list/:id Change a list.

DELETE /api/v2/list/:id Remove a list.

PUT /api/v2/lists/order Change the order of lists.

PUT /api/v2/opt Change an option.

GET /api/v2/lists Get all lists with pagination.

PUT /api/v2/list/:id/public Make a list public.