@8ms/helpers 1.1.103 → 1.1.105

package/aws/s3/writeFile.d.ts

@@ -2,6 +2,7 @@ declare type WriteFile = {
     bucket: string;
     data: any;
     key: string;
+    [options: string]: any;
 };
 /**
  * Write a file to S3.

package/aws/s3/writeUrlContents.d.ts

@@ -0,0 +1,10 @@
+declare type WriteUrlContents = {
+    bucket: string;
+    key: string;
+    url: string;
+};
+/**
+ * Download a file and write to S3.
+ */
+declare const writeUrlContents: ({ bucket, key, url }: WriteUrlContents) => Promise<void>;
+export default writeUrlContents;

package/aws/s3/writeUrlContents.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const get_1 = __importDefault(require("../../axios/get"));
+const writeFile_1 = __importDefault(require("./writeFile"));
+/**
+ * Download a file and write to S3.
+ */
+const writeUrlContents = async ({ bucket, key, url }) => {
+    return (0, get_1.default)({
+        config: {
+            responseType: "arraybuffer",
+            responseEncoding: "binary",
+        },
+        url,
+    })
+        .then(async (response) => {
+        await (0, writeFile_1.default)({
+            bucket,
+            data: response.data,
+            key,
+            ContentType: response.headers["content-type"],
+            ContentLength: response.headers["content-length"],
+        });
+    });
+};
+exports.default = writeUrlContents;

package/axios/get.d.ts

@@ -1,8 +1,10 @@
+import ApiResponse from '../api/ApiResponse';
 export declare type Get = {
     config?: object;
     onError?: Function;
     onSuccess?: Function;
+    returnApiResponse?: boolean;
     url: string;
 };
-declare const get: ({ config, onError, onSuccess, url }: Get) => Promise<any>;
+declare const get: ({ config, onError, onSuccess, returnApiResponse, url }: Get) => Promise<any | ApiResponse>;
 export default get;

package/axios/get.js

@@ -4,9 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
+const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
 const states_1 = __importDefault(require("../api/states"));
-const get = async ({ config = {}, onError, onSuccess, url }) => {
-    const response = await axios_1.default.get(url, config)
+const get = async ({ config = {}, onError, onSuccess, returnApiResponse, url }) => {
+    let response = await axios_1.default.get(url, config)
         .then(async (response) => {
         if (200 === response.status) {
             // Is an API request
@@ -39,6 +40,10 @@ const get = async ({ config = {}, onError, onSuccess, url }) => {
             throw Error;
         }
     });
+    // Convert the response into an ApiResponse instance
+    if (returnApiResponse) {
+        response = new ApiResponse_1.default(response);
+    }
     return response;
 };
 exports.default = get;

package/axios/post.d.ts

@@ -1,12 +1,14 @@
+import ApiResponse from '../api/ApiResponse';
 export declare type Post = {
     config?: object;
     data?: object;
     onError?: Function;
     onSuccess?: Function;
+    returnApiResponse?: boolean;
     url: string;
 };
 /**
  * Make a POST request.
  */
-declare const post: ({ config, data, onError, onSuccess, url }: Post) => Promise<any>;
+declare const post: ({ config, data, onError, onSuccess, returnApiResponse, url }: Post) => Promise<any | ApiResponse>;
 export default post;

package/axios/post.js

@@ -4,12 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
+const ApiResponse_1 = __importDefault(require("../api/ApiResponse"));
 const states_1 = __importDefault(require("../api/states"));
 /**
  * Make a POST request.
  */
-const post = async ({ config = {}, data = {}, onError, onSuccess, url }) => {
-    const response = await axios_1.default.post(url, data, config)
+const post = async ({ config = {}, data = {}, onError, onSuccess, returnApiResponse, url }) => {
+    let response = await axios_1.default.post(url, data, config)
         .then(async (response) => {
         if (200 === response.status) {
             // Is an API request
@@ -42,6 +43,10 @@ const post = async ({ config = {}, data = {}, onError, onSuccess, url }) => {
             throw Error;
         }
     });
+    // Convert the response into an ApiResponse instance
+    if (returnApiResponse) {
+        response = new ApiResponse_1.default(response);
+    }
     return response;
 };
 exports.default = post;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "1.1.103",
+	"version": "1.1.105",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"