Comparing version 0.0.2 to 0.0.3
@@ -58,4 +58,4 @@ 'use strict'; | ||
*/ | ||
/*:: export type GromitBodyData = string | Object | ArrayBuffer | $ArrayBufferView | URLSearchParams | FormData | File | Blob | stream$Readable | Buffer;*/ // @flow | ||
/** | ||
@@ -66,2 +66,3 @@ * HTTP method for a request | ||
*/ | ||
/*:: export type GromitParamData = Object | URLSearchParams;*/ | ||
@@ -74,2 +75,3 @@ | ||
*/ | ||
/*:: export type GromitMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';*/ | ||
@@ -99,2 +101,25 @@ | ||
/*:: export type GromitResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream';*/ | ||
/*:: export type GromitConfiguration = { | ||
method?: GromitMethod, | ||
path?: string, | ||
data?: GromitBodyData, | ||
params?: GromitParamData, | ||
headers?: Object, | ||
baseUrl?: string, | ||
timeout?: number, | ||
withCredentials?: bool, | ||
auth?: { | ||
username: string, | ||
password: string | ||
}, | ||
responseType?: GromitResponseType, | ||
maxContentLength?: number, | ||
maxRedirects?: number, | ||
onUploadProgress?: (progressEvent: ProgressEvent) => void, | ||
onDownloadProgress?: (progressEvent: ProgressEvent) => void, | ||
beforeResponse?: (response: GromitResponse) => any | ||
};*/ | ||
var defaultConfig = { | ||
@@ -139,3 +164,3 @@ method: 'get' | ||
var Gromit = exports.Gromit = function () { | ||
function Gromit(configuration) { | ||
function Gromit(configuration /*: GromitConfiguration*/) { | ||
(0, _classCallCheck3.default)(this, Gromit); | ||
@@ -153,3 +178,3 @@ | ||
key: 'unit', | ||
value: function unit(configuration) { | ||
value: function unit(configuration /*: GromitConfiguration*/) /*: Gromit*/ { | ||
return new Gromit((0, _extends3.default)({}, this.configuration, { | ||
@@ -170,3 +195,3 @@ configuration: configuration | ||
key: 'configure', | ||
value: function configure(configurator) { | ||
value: function configure(configurator /*: (GromitConfiguration) => GromitConfiguration*/) /*: Gromit*/ { | ||
return new Gromit(configurator(this.configuration)); | ||
@@ -183,3 +208,3 @@ } | ||
key: 'uploadProgress', | ||
value: function uploadProgress(cb) { | ||
value: function uploadProgress(cb /*: (progressEvent: ProgressEvent) => void*/) /*: Gromit*/ { | ||
return this.unit({ | ||
@@ -198,3 +223,3 @@ onUploadProgress: cb | ||
key: 'downloadProgress', | ||
value: function downloadProgress(cb) { | ||
value: function downloadProgress(cb /*: (progressEvent: ProgressEvent) => void*/) /*: Gromit*/ { | ||
return this.unit({ | ||
@@ -216,3 +241,3 @@ onDownloadProgress: cb | ||
key: 'request', | ||
value: function request(method, path, data, params) { | ||
value: function request(method /*: ?GromitMethod*/, path /*: ?string*/, data /*: ?GromitBodyData*/, params /*: ?GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.unit({ | ||
@@ -235,3 +260,3 @@ method: method || this.configuration.method, | ||
key: 'get', | ||
value: function get(path, params) { | ||
value: function get(path /*:: ?: string*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('get', path, null, params); | ||
@@ -250,3 +275,3 @@ } | ||
key: 'post', | ||
value: function post(path, data, params) { | ||
value: function post(path /*:: ?: string*/, data /*:: ?: GromitBodyData*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('post', path, data, params); | ||
@@ -265,3 +290,3 @@ } | ||
key: 'put', | ||
value: function put(path, data, params) { | ||
value: function put(path /*:: ?: string*/, data /*:: ?: GromitBodyData*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('put', path, data, params); | ||
@@ -280,3 +305,3 @@ } | ||
key: 'patch', | ||
value: function patch(path, data, params) { | ||
value: function patch(path /*:: ?: string*/, data /*:: ?: GromitBodyData*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('patch', path, data, params); | ||
@@ -294,3 +319,3 @@ } | ||
key: 'delete', | ||
value: function _delete(path, params) { | ||
value: function _delete(path /*:: ?: string*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('delete', path, null, params); | ||
@@ -308,3 +333,3 @@ } | ||
key: 'head', | ||
value: function head(path, params) { | ||
value: function head(path /*:: ?: string*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('head', path, null, params); | ||
@@ -322,3 +347,3 @@ } | ||
key: 'options', | ||
value: function options(path, params) { | ||
value: function options(path /*:: ?: string*/, params /*:: ?: GromitParamData*/) /*: Promise<GromitResponse>*/ { | ||
return this.request('options', path, null, params); | ||
@@ -334,3 +359,3 @@ } | ||
key: 'fetch', | ||
value: function fetch() { | ||
value: function fetch() /*: Promise<GromitResponse>*/ { | ||
var _this = this; | ||
@@ -381,4 +406,4 @@ | ||
function GromitFactory(configuration) { | ||
function GromitFactory(configuration /*: GromitConfiguration*/) /*: Gromit*/ { | ||
return new Gromit(configuration); | ||
} |
@@ -89,4 +89,5 @@ 'use strict'; | ||
'511': { message: 'Network Authentication Required', name: 'NETWORK_AUTHENTICATION_REQUIRED' } | ||
}; | ||
}; //@flow | ||
/** | ||
@@ -106,2 +107,9 @@ * | ||
*/ | ||
/*:: export type GromitErrorResponseData = { | ||
statusCode: number, | ||
name: string, | ||
message: string, | ||
data: ?Object | ||
};*/ | ||
var GromitError = function (_Error) { | ||
@@ -121,3 +129,3 @@ (0, _inherits3.default)(GromitError, _Error); | ||
*/ | ||
function GromitError(error, errorData) { | ||
function GromitError(error /*: Object*/, errorData /*: GromitErrorResponseData*/) { | ||
(0, _classCallCheck3.default)(this, GromitError); | ||
@@ -166,3 +174,3 @@ | ||
key: 'serialize', | ||
value: function serialize() { | ||
value: function serialize() /*: GromitError*/ { | ||
var message = '[' + this.statusCode + '][' + this.name + '] ' + this.message; | ||
@@ -179,3 +187,3 @@ | ||
key: 'toJSON', | ||
value: function toJSON() { | ||
value: function toJSON() /*: Object*/ { | ||
return { | ||
@@ -200,3 +208,3 @@ stack: this.stack, | ||
key: 'deserialize', | ||
value: function deserialize(error) { | ||
value: function deserialize(error /*: Object*/) /*: GromitError*/ { | ||
var errData = error.message.match(/^\[(.+?)\]\[(.+?)\](.+$)/); | ||
@@ -225,3 +233,3 @@ if (!errData) return GromitError.wrap(error); | ||
key: 'wrap', | ||
value: function wrap(error, statusCode, message, name, data) { | ||
value: function wrap(error /*: Object*/, statusCode /*: ?number*/, message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
var errorStatusCode = statusCode || parseInt(error.statusCode, 10) || 500; | ||
@@ -252,3 +260,3 @@ var defaultErrorData = STATUS_CODE_MAP[errorStatusCode]; | ||
key: 'create', | ||
value: function create(statusCode, message, name, data) { | ||
value: function create(statusCode /*: ?number*/, message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
var errorStatusCode = statusCode || 500; | ||
@@ -283,3 +291,3 @@ var defaultErrorData = STATUS_CODE_MAP[errorStatusCode]; | ||
key: 'badRequest', | ||
value: function badRequest(message, name, data) { | ||
value: function badRequest(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(400, message, name, data); | ||
@@ -298,3 +306,3 @@ } | ||
key: 'unauthorized', | ||
value: function unauthorized(message, name, data) { | ||
value: function unauthorized(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(401, message, name, data); | ||
@@ -313,3 +321,3 @@ } | ||
key: 'paymentRequired', | ||
value: function paymentRequired(message, name, data) { | ||
value: function paymentRequired(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(402, message, name, data); | ||
@@ -328,3 +336,3 @@ } | ||
key: 'forbidden', | ||
value: function forbidden(message, name, data) { | ||
value: function forbidden(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(403, message, name, data); | ||
@@ -343,3 +351,3 @@ } | ||
key: 'notFound', | ||
value: function notFound(message, name, data) { | ||
value: function notFound(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(404, message, name, data); | ||
@@ -358,3 +366,3 @@ } | ||
key: 'methodNotAllowed', | ||
value: function methodNotAllowed(message, name, data) { | ||
value: function methodNotAllowed(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(405, message, name, data); | ||
@@ -373,3 +381,3 @@ } | ||
key: 'notAcceptable', | ||
value: function notAcceptable(message, name, data) { | ||
value: function notAcceptable(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(406, message, name, data); | ||
@@ -388,3 +396,3 @@ } | ||
key: 'proxyAuthRequired', | ||
value: function proxyAuthRequired(message, name, data) { | ||
value: function proxyAuthRequired(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(407, message, name, data); | ||
@@ -403,3 +411,3 @@ } | ||
key: 'clientTimeout', | ||
value: function clientTimeout(message, name, data) { | ||
value: function clientTimeout(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(408, message, name, data); | ||
@@ -418,3 +426,3 @@ } | ||
key: 'conflict', | ||
value: function conflict(message, name, data) { | ||
value: function conflict(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(409, message, name, data); | ||
@@ -433,3 +441,3 @@ } | ||
key: 'resourceGone', | ||
value: function resourceGone(message, name, data) { | ||
value: function resourceGone(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(410, message, name, data); | ||
@@ -448,3 +456,3 @@ } | ||
key: 'lengthRequired', | ||
value: function lengthRequired(message, name, data) { | ||
value: function lengthRequired(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(411, message, name, data); | ||
@@ -463,3 +471,3 @@ } | ||
key: 'preconditionFailed', | ||
value: function preconditionFailed(message, name, data) { | ||
value: function preconditionFailed(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(412, message, name, data); | ||
@@ -478,3 +486,3 @@ } | ||
key: 'entityTooLarge', | ||
value: function entityTooLarge(message, name, data) { | ||
value: function entityTooLarge(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(413, message, name, data); | ||
@@ -493,3 +501,3 @@ } | ||
key: 'uriTooLong', | ||
value: function uriTooLong(message, name, data) { | ||
value: function uriTooLong(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(414, message, name, data); | ||
@@ -508,3 +516,3 @@ } | ||
key: 'unsupportedMediaType', | ||
value: function unsupportedMediaType(message, name, data) { | ||
value: function unsupportedMediaType(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(415, message, name, data); | ||
@@ -523,3 +531,3 @@ } | ||
key: 'rangeNotSatisfiable', | ||
value: function rangeNotSatisfiable(message, name, data) { | ||
value: function rangeNotSatisfiable(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(416, message, name, data); | ||
@@ -538,3 +546,3 @@ } | ||
key: 'expectationFailed', | ||
value: function expectationFailed(message, name, data) { | ||
value: function expectationFailed(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(417, message, name, data); | ||
@@ -553,3 +561,3 @@ } | ||
key: 'teapot', | ||
value: function teapot(message, name, data) { | ||
value: function teapot(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(418, message, name, data); | ||
@@ -568,3 +576,3 @@ } | ||
key: 'badData', | ||
value: function badData(message, name, data) { | ||
value: function badData(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(422, message, name, data); | ||
@@ -583,3 +591,3 @@ } | ||
key: 'locked', | ||
value: function locked(message, name, data) { | ||
value: function locked(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(423, message, name, data); | ||
@@ -598,3 +606,3 @@ } | ||
key: 'preconditionRequired', | ||
value: function preconditionRequired(message, name, data) { | ||
value: function preconditionRequired(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(428, message, name, data); | ||
@@ -613,3 +621,3 @@ } | ||
key: 'tooManyRequests', | ||
value: function tooManyRequests(message, name, data) { | ||
value: function tooManyRequests(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(429, message, name, data); | ||
@@ -628,3 +636,3 @@ } | ||
key: 'illegal', | ||
value: function illegal(message, name, data) { | ||
value: function illegal(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(451, message, name, data); | ||
@@ -643,3 +651,3 @@ } | ||
key: 'notImplemented', | ||
value: function notImplemented(message, name, data) { | ||
value: function notImplemented(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(501, message, name, data); | ||
@@ -658,3 +666,3 @@ } | ||
key: 'badGateway', | ||
value: function badGateway(message, name, data) { | ||
value: function badGateway(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(502, message, name, data); | ||
@@ -673,3 +681,3 @@ } | ||
key: 'serverUnavailable', | ||
value: function serverUnavailable(message, name, data) { | ||
value: function serverUnavailable(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(503, message, name, data); | ||
@@ -688,3 +696,3 @@ } | ||
key: 'gatewayTimeout', | ||
value: function gatewayTimeout(message, name, data) { | ||
value: function gatewayTimeout(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(504, message, name, data); | ||
@@ -703,3 +711,3 @@ } | ||
key: 'httpVersionNotSupported', | ||
value: function httpVersionNotSupported(message, name, data) { | ||
value: function httpVersionNotSupported(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(505, message, name, data); | ||
@@ -718,3 +726,3 @@ } | ||
key: 'variantAlsoNegotiates', | ||
value: function variantAlsoNegotiates(message, name, data) { | ||
value: function variantAlsoNegotiates(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(506, message, name, data); | ||
@@ -733,3 +741,3 @@ } | ||
key: 'insufficientStorage', | ||
value: function insufficientStorage(message, name, data) { | ||
value: function insufficientStorage(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(507, message, name, data); | ||
@@ -748,3 +756,3 @@ } | ||
key: 'bandwidthLimitExceeded', | ||
value: function bandwidthLimitExceeded(message, name, data) { | ||
value: function bandwidthLimitExceeded(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(509, message, name, data); | ||
@@ -763,3 +771,3 @@ } | ||
key: 'notExtended', | ||
value: function notExtended(message, name, data) { | ||
value: function notExtended(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(510, message, name, data); | ||
@@ -778,3 +786,3 @@ } | ||
key: 'networkAuthenticationRequired', | ||
value: function networkAuthenticationRequired(message, name, data) { | ||
value: function networkAuthenticationRequired(message /*: ?string*/, name /*: ?string*/, data /*: ?Object*/) /*: GromitError*/ { | ||
return GromitError.create(511, message, name, data); | ||
@@ -784,3 +792,3 @@ } | ||
key: 'fromAxiosError', | ||
value: function fromAxiosError(error, requester) { | ||
value: function fromAxiosError(error /*: Object*/, requester /*: Gromit*/) /*: GromitError*/ { | ||
var statusCode = error.response ? error.response.status : 500; | ||
@@ -787,0 +795,0 @@ return GromitError.wrap(error, statusCode, error.message, null, { |
@@ -24,2 +24,17 @@ 'use strict'; | ||
*/ | ||
/*:: export type GromitResponseResponseData = { | ||
statusCode: number, | ||
statusText: string, | ||
data: any, | ||
headers: Object, | ||
request: XMLHttpRequest | http$ClientRequest | ||
};*/ //@flow | ||
/** | ||
* | ||
* @module GromitResponse | ||
* | ||
*/ | ||
var GromitResponse = function () { | ||
@@ -38,3 +53,3 @@ | ||
*/ | ||
function GromitResponse(responseData, requester) { | ||
function GromitResponse(responseData /*: GromitResponseResponseData*/, requester /*: ?Gromit*/) { | ||
(0, _classCallCheck3.default)(this, GromitResponse); | ||
@@ -76,3 +91,3 @@ | ||
key: 'fromAxiosResponse', | ||
value: function fromAxiosResponse(response, requester) { | ||
value: function fromAxiosResponse(response /*: Object*/, requester /*: Gromit*/) /*: GromitResponse*/ { | ||
return new GromitResponse({ | ||
@@ -90,8 +105,2 @@ request: response.request, | ||
/** | ||
* | ||
* @module GromitResponse | ||
* | ||
*/ | ||
exports.default = GromitResponse; |
@@ -26,2 +26,4 @@ 'use strict'; | ||
//@flow | ||
exports.default = _Gromit2.default; | ||
@@ -28,0 +30,0 @@ exports.GromitError = _GromitError2.default; |
@@ -45,5 +45,5 @@ 'use strict'; | ||
*/ | ||
exports.default = function (url, getToken) { | ||
exports.default = function (url /*: string*/, getToken /*: () => Promise<string>*/) { | ||
return function () { | ||
var _ref = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee(query, variables) { | ||
var _ref = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee(query /*: string*/, variables /*: Object*/) /*: Promise<Object>*/ { | ||
var token; | ||
@@ -77,2 +77,2 @@ return _regenerator2.default.wrap(function _callee$(_context) { | ||
}(); | ||
}; | ||
}; //@flow |
@@ -7,3 +7,3 @@ { | ||
"name": "gromit", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"description": "", | ||
@@ -22,3 +22,3 @@ "license": "UNLICENSED", | ||
"watch": "rm -rf lib && babel src --out-dir lib -w", | ||
"build": "rm -rf lib && babel src --out-dir lib && node ./scripts/flow", | ||
"build": "rm -rf lib && babel src --out-dir lib", | ||
"build-examples": "cd example && yarn install && yarn run build && cd -", | ||
@@ -41,2 +41,3 @@ "deploy-to-gh-pages": "yarn run build && yarn run build-examples && yarn run docs && node scripts/publish.js", | ||
"babel-plugin-istanbul": "^4.1.4", | ||
"babel-plugin-transform-flow-comments": "^6.22.0", | ||
"babel-preset-blueflag": "^0.6.0", | ||
@@ -43,0 +44,0 @@ "babel-register": "^6.23.0", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1140
57165
21
7