73 lines
No EOL
2.8 KiB
JavaScript
73 lines
No EOL
2.8 KiB
JavaScript
/**
|
|
* @fileoverview User API, as defined by httpapi.js
|
|
* @author <a href="mailto:Jeff@pcjs.org">Jeff Parsons</a>
|
|
* @version 1.0
|
|
* Created 2014-May-13
|
|
*
|
|
* Copyright © 2012-2015 Jeff Parsons <Jeff@pcjs.org>
|
|
*
|
|
* This file is part of the JavaScript Machines Project (aka JSMachines) at <http://jsmachines.net/>
|
|
* and <http://pcjs.org/>.
|
|
*
|
|
* JSMachines is free software: you can redistribute it and/or modify it under the terms of the
|
|
* GNU General Public License as published by the Free Software Foundation, either version 3
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* JSMachines is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
|
|
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along with JSMachines.
|
|
* If not, see <http://www.gnu.org/licenses/gpl.html>.
|
|
*
|
|
* You are required to include the above copyright notice in every source code file of every
|
|
* copy or modified version of this work, and to display that copyright notice on every screen
|
|
* that loads or runs any version of this software (see Computer.sCopyright).
|
|
*
|
|
* Some JSMachines files also attempt to load external resource files, such as character-image files,
|
|
* ROM files, and disk image files. Those external resource files are not considered part of the
|
|
* JSMachines Project for purposes of the GNU General Public License, and the author does not claim
|
|
* any copyright as to their contents.
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
/*
|
|
* Examples of User API requests:
|
|
*
|
|
* web.getHost() + UserAPI.ENDPOINT + '?' + UserAPI.QUERY.REQ + '=' + UserAPI.REQ.VERIFY + '&' + UserAPI.QUERY.USER + '=' + sUser;
|
|
*/
|
|
|
|
var UserAPI = {
|
|
ENDPOINT: "/api/v1/user",
|
|
QUERY: {
|
|
REQ: "req", // specifies a request
|
|
USER: "user", // specifies a user ID
|
|
STATE: "state", // specifies a state ID
|
|
DATA: "data" // specifies state data
|
|
},
|
|
REQ: {
|
|
CREATE: "create", // creates a user ID
|
|
VERIFY: "verify", // requests verification of a user ID
|
|
STORE: "store", // stores a machine state on the server
|
|
LOAD: "load" // loads a machine state from the server
|
|
},
|
|
RES: {
|
|
CODE: "code",
|
|
DATA: "data"
|
|
},
|
|
CODE: {
|
|
OK: "ok",
|
|
FAIL: "error"
|
|
},
|
|
FAIL: {
|
|
DUPLICATE: "user already exists",
|
|
VERIFY: "unable to verify user",
|
|
BADSTATE: "invalid state parameter",
|
|
NOSTATE: "no machine state",
|
|
BADLOAD: "unable to load machine state",
|
|
BADSTORE: "unable to save machine state"
|
|
}
|
|
};
|
|
|
|
if (typeof module !== 'undefined') module.exports = UserAPI; |