bigjpg 1.0.0

package/README.md

@@ -0,0 +1,29 @@
+# Install
+
+Npm
+```
+npm i bigjpg
+```
+
+GitHub
+```
+npm i git+https://github.com/1Marcuth/bigjpg-js.git
+```
+
+# Simple use example
+```js
+const enlarger = new Bigjpg("YOUR API TOKEN HERE")
+
+
+const imageInfo = await enlarger.enlarge(
+    Styles.Art,
+    Noices.None,
+    EnlargeValues._4x,
+    "https://avatars.githubusercontent.com/u/91915075?v=4"
+)
+
+const imageUrl = imageInfo.getUrl()
+await imageInfo.download("enlarged-image.png")
+
+console.log(imageUrl)
+```

package/dist/example.js

@@ -0,0 +1,19 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./src/index");
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    const enlarger = new index_1.Bigjpg("634153909e7b46f68d8d1e0faa03bb37");
+    const imageInfo = yield enlarger.enlarge(index_1.Styles.Art, index_1.Noices.None, index_1.EnlargeValues._4x, "https://avatars.githubusercontent.com/u/91915075?v=4");
+    const imageUrl = imageInfo.getUrl();
+    yield imageInfo.download("enlarged-image.png");
+    console.log(imageUrl);
+}))();

package/dist/src/enlarger.js

@@ -0,0 +1,103 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const image_downloader_1 = __importDefault(require("image-downloader"));
+const axios_1 = __importDefault(require("axios"));
+const utils_1 = require("./utils");
+const baseUrl = "https://bigjpg.com/api";
+class BigjpgError extends Error {
+}
+class BigjpgImage {
+    constructor(imageUrl) {
+        this.imageUrl = imageUrl;
+    }
+    getUrl() {
+        return this.imageUrl;
+    }
+    download(dest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield image_downloader_1.default.image({
+                url: this.imageUrl,
+                dest: dest,
+                agent: true,
+                auth: null,
+                headers: undefined,
+                maxHeaderSize: undefined,
+                timeout: 0
+            });
+        });
+    }
+}
+class BigjpgTask {
+    constructor(url, taskId) {
+        this.url = url;
+        this.taskId = taskId;
+    }
+    fetchUntilAchieveTheResult() {
+        return __awaiter(this, void 0, void 0, function* () {
+            while (true) {
+                const response = yield axios_1.default.get(this.url);
+                const dataResponse = response.data;
+                const data = dataResponse[this.taskId];
+                const status = data.status;
+                if (status === "success") {
+                    return data;
+                }
+                else if (status === "error") {
+                    throw new BigjpgError("Error processing the image!");
+                }
+                yield (0, utils_1.sleep)(.5);
+            }
+        });
+    }
+}
+class Bigjpg {
+    constructor(apiToken) {
+        this.apiToken = apiToken;
+    }
+    enlarge(style, noise, enlargeValue, imageUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `${baseUrl}/task/`;
+            const config = {
+                style: style,
+                noise: noise,
+                x2: enlargeValue,
+                input: imageUrl
+            };
+            const headers = { "X-API-KEY": this.apiToken };
+            const data = { "conf": JSON.stringify(config) };
+            const response = yield axios_1.default.post(url, data, { headers });
+            const dataResponse = response.data;
+            if (Object.keys(dataResponse).includes("status")) {
+                const status = dataResponse.status;
+                if (status === "valid_api_key_required") {
+                    throw new BigjpgError("Invalid API token, get your API token on the website by registering 'https://bigjpg.com/' and going to the 'API' section and copying your token that is present in the example code");
+                }
+                else if (status === "param_error") {
+                    throw new BigjpgError("Some invalid parameter, check parameters and features available in your account and try again");
+                }
+            }
+            const remainingApiCalls = dataResponse.remaining_api_calls;
+            console.log(`> [Bigjpg-info] Remaining API calls: ${remainingApiCalls}`);
+            const taskId = dataResponse.tid;
+            const taskUrl = `${baseUrl}/task/${taskId}`;
+            const task = new BigjpgTask(taskUrl, taskId);
+            const taskResult = yield task.fetchUntilAchieveTheResult();
+            const enlargedImageUrl = taskResult.url;
+            const enlargedImage = new BigjpgImage(enlargedImageUrl);
+            return enlargedImage;
+        });
+    }
+}
+exports.default = Bigjpg;

package/dist/src/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnlargeValues = exports.Noices = exports.Styles = exports.Bigjpg = void 0;
+const enlarger_1 = __importDefault(require("./enlarger"));
+exports.Bigjpg = enlarger_1.default;
+const styles_1 = __importDefault(require("./types/styles"));
+exports.Styles = styles_1.default;
+const noices_1 = __importDefault(require("./types/noices"));
+exports.Noices = noices_1.default;
+const enlarge_values_1 = __importDefault(require("./types/enlarge-values"));
+exports.EnlargeValues = enlarge_values_1.default;

package/dist/src/interfaces/enlarge-config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/enlarge-values.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const EnlargeValues = {
+    _2x: "1",
+    _4x: "2",
+    _8x: "3",
+    _16x: "4"
+};
+exports.default = EnlargeValues;

package/dist/src/types/noices.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Noices = {
+    None: "-1",
+    Low: "0",
+    Medium: "1",
+    High: "2",
+    Highest: "3"
+};
+exports.default = Noices;

package/dist/src/types/styles.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Styles = {
+    Art: "art",
+    Photo: "photo"
+};
+exports.default = Styles;

package/dist/src/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = void 0;
+function sleep(time) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            setTimeout(() => {
+                resolve(null);
+            }, time);
+        });
+    });
+}
+exports.sleep = sleep;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "bigjpg",
+  "version": "1.0.0",
+  "types": "index.d.ts",
+  "description": "Simple wrapper for https://bigjpg.com/",
+  "main": "dist/index.js",
+  "scripts": {
+    "dev": "ts-node example.ts",
+    "build": "tsc"
+  },
+  "keywords": [
+    "bigjpg",
+    "api",
+    "wrapper"
+  ],
+  "author": "Marcuth",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.2.2",
+    "image-downloader": "^4.3.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1Marcuth/bigjpg-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/1Marcuth/bigjpg-js/issues"
+  },
+  "homepage": "https://github.com/1Marcuth/bigjpg-js#readme",
+  "devDependencies": {
+    "@types/node": "^18.11.18"
+  }
+}

package/src/enlarger.ts

@@ -0,0 +1,117 @@
+import imageDownloader from "image-downloader"
+import axios from "axios"
+
+import IEnlargeConfig from "./interfaces/enlarge-config"
+import { sleep } from "./utils"
+
+const baseUrl = "https://bigjpg.com/api"
+
+class BigjpgError extends Error {}
+
+class BigjpgImage {
+    private imageUrl: string
+
+    constructor(imageUrl: string) {
+        this.imageUrl = imageUrl
+    }
+
+    getUrl(): string {
+        return this.imageUrl
+    }
+
+    async download(dest: string) {
+        await imageDownloader.image({
+            url: this.imageUrl,
+            dest: dest,
+            agent: true,
+            auth: null,
+            headers: undefined,
+            maxHeaderSize: undefined,
+            timeout: 0
+        })
+    }
+}
+
+class BigjpgTask {
+    private url: string
+    private taskId: string
+
+    constructor(url: string, taskId: string) {
+        this.url = url
+        this.taskId = taskId
+    }
+
+    async fetchUntilAchieveTheResult() {
+        while (true) {
+            const response = await axios.get(this.url)
+            const dataResponse = response.data
+
+            const data = dataResponse[this.taskId]
+
+            const status = data.status
+
+            if (status === "success") {
+                return data 
+            } else if (status === "error") {
+                throw new BigjpgError("Error processing the image!")
+            }
+
+            await sleep(.5)
+        }
+    }
+}
+
+class Bigjpg {
+    private apiToken: string
+
+    constructor(apiToken: string) {
+        this.apiToken = apiToken
+    }
+
+    async enlarge(
+        style: string,
+        noise: string,
+        enlargeValue: string,
+        imageUrl: string
+    ): Promise<BigjpgImage> {
+        const url = `${baseUrl}/task/`
+        const config: IEnlargeConfig = {
+            style: style,
+            noise: noise,
+            x2: enlargeValue,
+            input: imageUrl
+        }
+
+        const headers = { "X-API-KEY": this.apiToken }
+        const data = { "conf": JSON.stringify(config) }
+
+        const response = await axios.post(url, data, { headers })
+        const dataResponse = response.data
+
+        if (Object.keys(dataResponse).includes("status")) {
+            const status = dataResponse.status
+
+            if (status === "valid_api_key_required") {
+                throw new BigjpgError("Invalid API token, get your API token on the website by registering 'https://bigjpg.com/' and going to the 'API' section and copying your token that is present in the example code")
+            } else if (status === "param_error") {
+                throw new BigjpgError("Some invalid parameter, check parameters and features available in your account and try again")
+            }
+        }
+
+        const remainingApiCalls = dataResponse.remaining_api_calls
+
+        console.log(`> [Bigjpg-info] Remaining API calls: ${remainingApiCalls}`)
+
+        const taskId = dataResponse.tid
+        const taskUrl = `${baseUrl}/task/${taskId}`
+        const task = new BigjpgTask(taskUrl, taskId)
+        const taskResult = await task.fetchUntilAchieveTheResult()
+
+        const enlargedImageUrl = taskResult.url
+        const enlargedImage = new BigjpgImage(enlargedImageUrl)
+        
+        return enlargedImage
+    }
+}
+
+export default Bigjpg

package/src/index.ts

@@ -0,0 +1,6 @@
+import Bigjpg from "./enlarger"
+import Styles from "./types/styles"
+import Noices from "./types/noices"
+import EnlargeValues from "./types/enlarge-values"
+
+export { Bigjpg, Styles, Noices, EnlargeValues }

package/src/interfaces/enlarge-config.ts

@@ -0,0 +1,8 @@
+interface IEnlargeConfig {
+    style: string
+    noise: string
+    x2: string
+    input: string
+}
+
+export default IEnlargeConfig

package/src/types/enlarge-values.ts

@@ -0,0 +1,8 @@
+const EnlargeValues = {
+    _2x: "1",
+    _4x: "2",
+    _8x: "3",
+    _16x: "4"
+}
+
+export default EnlargeValues

package/src/types/noices.ts

@@ -0,0 +1,9 @@
+const Noices = {
+    None: "-1",
+    Low: "0",
+    Medium: "1",
+    High: "2",
+    Highest: "3"
+}
+
+export default Noices

package/src/types/styles.ts

@@ -0,0 +1,6 @@
+const Styles = {
+    Art: "art",
+    Photo: "photo"
+}
+
+export default Styles

package/src/utils.ts

@@ -0,0 +1,9 @@
+async function sleep(time: number) {
+    return new Promise((resolve, reject) => {
+        setTimeout(() => {
+            resolve(null)
+        }, time)
+    })
+}
+
+export { sleep }

package/tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist/",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}