feat: refactoring to allow N alias to replace core impl

Author: farfromrefug

package.json

@@ -3,7 +3,7 @@
     "version": "1.0.0",
     "description": "Nativescript plugin for gestures",
     "scripts": {
-        "tsc": "cp src/https.d.ts plugin && tsc -skipLibCheck -d",
+        "tsc": "cp src/index.d.ts src/request.d.ts plugin && tsc -skipLibCheck -d",
         "clean": "rimraf ./plugin/**/*.d.ts ./plugin/**/*.js ./plugin/**/*.js.map plugin/node_modules plugin/package-lock.json",
         "build.plugin": " cp README.md plugin/ && rm -f .tsbuildinfo && npm run tsc",
         "build.android": "bash src-native/android/build.sh",

plugin/package.json

@@ -2,9 +2,9 @@
     "name": "@nativescript-community/https",
     "version": "3.3.13",
     "description": "Nativescript plugin for gestures",
-    "main": "https",
+    "main": "index",
     "sideEffects": false,
-    "typings": "https.d.ts",
+    "typings": "index.d.ts",
     "nativescript": {
         "platforms": {
             "android": "6.2.1",

src/https.d.ts

@@ -0,0 +1,68 @@
+/* eslint-disable @typescript-eslint/unified-signatures */
+/* eslint-disable no-redeclare */
+import { ImageSource } from '@nativescript/core';
+import { HttpsRequestOptions } from './request';
+
+export * from './request';
+
+/**
+ * Downloads the content from the specified URL as a string.
+ * @param url The URL to request from.
+ */
+export function getString(url: string): Promise<string>;
+
+/**
+ * Downloads the content from the specified URL as a string.
+ * @param options An object that specifies various request options.
+ */
+export function getString(options: HttpsRequestOptions): Promise<string>;
+
+/**
+ * Downloads the content from the specified URL as a string and returns its JSON.parse representation.
+ * @param url The URL to request from.
+ */
+export function getJSON<T>(url: string): Promise<T>;
+
+/**
+ * Downloads the content from the specified URL as a string and returns its JSON.parse representation.
+ * @param options An object that specifies various request options.
+ */
+export function getJSON<T>(options: HttpsRequestOptions): Promise<T>;
+
+/**
+ * Downloads the content from the specified URL and attempts to decode it as an image.
+ * @param url The URL to request from.
+ */
+export function getImage(url: string): Promise<ImageSource>;
+
+/**
+ * Downloads the content from the specified URL and attempts to decode it as an image.
+ * @param options An object that specifies various request options.
+ */
+export function getImage(options: HttpsRequestOptions): Promise<ImageSource>;
+
+/**
+ * Downloads the content from the specified URL and attempts to save it as file.
+ * @param url The URL to request from.
+ * @param destinationFilePath Optional. The downloaded file path.
+ */
+export function getFile(url: string, destinationFilePath?: string): Promise<File>;
+
+/**
+ * Downloads the content from the specified URL and attempts to save it as file.
+ * @param options An object that specifies various request options.
+ * @param destinationFilePath Optional. The downloaded file path.
+ */
+export function getFile(options: HttpsRequestOptions, destinationFilePath?: string): Promise<File>;
+
+/**
+ * Downloads the content from the specified URL as binary and returns an ArrayBuffer.
+ * @param url The URL to request from.
+ */
+export function getBinary(url: string): Promise<ArrayBuffer>;
+
+/**
+ * Downloads the content from the specified URL as binary and returns an ArrayBuffer.
+ * @param options An object that specifies various request options.
+ */
+export function getBinary(options: HttpsRequestOptions): Promise<ArrayBuffer>;

src/index.d.ts

@@ -0,0 +1,28 @@
+import { ImageSource } from '@nativescript/core';
+import { request } from './request';
+export * from './request';
+
+export async function getString(arg: any): Promise<string> {
+    const r = await request(typeof arg === 'string' ? { url: arg, method: 'GET' } : arg);
+    return r.content.toString();
+}
+
+export async function getJSON<T>(arg: any): Promise<T> {
+    const r = await request(typeof arg === 'string' ? { url: arg, method: 'GET' } : arg);
+    return r.content.toJSON();
+}
+
+export async function getImage(arg: any): Promise<ImageSource> {
+    const r = await request(typeof arg === 'string' ? { url: arg, method: 'GET' } : arg);
+    return r.content.toImage();
+}
+
+export async function getFile(arg: any, destinationFilePath?: string): Promise<any> {
+    const r = await request(typeof arg === 'string' ? { url: arg, method: 'GET' } : arg);
+    return r.content.toFile(destinationFilePath);
+}
+
+export async function getBinary(arg: any): Promise<ArrayBuffer> {
+    const r = await request(typeof arg === 'string' ? { url: arg, method: 'GET' } : arg);
+    return r.content.toArrayBuffer();
+}

src/index.ts

@@ -1,7 +1,7 @@
 import { File, HttpResponseEncoding, ImageSource, Utils } from '@nativescript/core';
-import * as Https from './https.common';
+import { CacheOptions, getFilenameFromUrl, HttpsFormDataParam, HttpsRequest, HttpsRequestOptions, HttpsResponseLegacy, HttpsSSLPinningOptions, interceptors, networkInterceptors, parseJSON } from '.';
 
-export { addNetworkInterceptor, addInterceptor } from './https.common';
+export { addNetworkInterceptor, addInterceptor } from './request.common';
 
 interface Ipeer {
     enabled: boolean;
@@ -21,7 +21,7 @@ const peer: Ipeer = {
 
 let cache: okhttp3.Cache;
 let forceCache = false;
-export function setCache(options?: Https.CacheOptions) {
+export function setCache(options?: CacheOptions) {
     if (options) {
         forceCache = options.forceCache === true;
         cache = new okhttp3.Cache(new java.io.File(options.diskLocation), options.diskSize);
@@ -40,7 +40,7 @@ export function clearCache() {
 
 let _timeout = 10;
 
-class HttpsResponse implements Https.HttpsResponseLegacy {
+class HttpsResponseLegacyIOS implements HttpsResponseLegacy {
     private callback?: com.nativescript.https.OkHttpResponse.OkHttpResponseAsyncCallback;
     constructor(private response: com.nativescript.https.OkHttpResponse, private tag: string, private url: string) {}
 
@@ -130,7 +130,7 @@ class HttpsResponse implements Https.HttpsResponseLegacy {
             }
             // TODO: handle arraybuffer already stored
             this.stringResponse = this.stringResponse || this.response.asString();
-            this.jsonResponse = this.stringResponse ? Https.parseJSON(this.stringResponse) : null;
+            this.jsonResponse = this.stringResponse ? parseJSON(this.stringResponse) : null;
             return this.jsonResponse;
         } catch (err) {
             console.error('HttpsResponse.toJSON', err);
@@ -143,12 +143,12 @@ class HttpsResponse implements Https.HttpsResponseLegacy {
             return this.jsonResponse;
         }
         if (this.stringResponse !== undefined) {
-            this.jsonResponse = this.stringResponse ? Https.parseJSON(this.stringResponse) : null;
+            this.jsonResponse = this.stringResponse ? parseJSON(this.stringResponse) : null;
             return this.jsonResponse;
         }
         // TODO: handle arraybuffer already stored
         const r = await this.toStringAsync();
-        this.jsonResponse = r ? Https.parseJSON(r) : null;
+        this.jsonResponse = r ? parseJSON(r) : null;
         return this.jsonResponse;
     }
 
@@ -168,7 +168,7 @@ class HttpsResponse implements Https.HttpsResponseLegacy {
     }
     // toFile(destinationFilePath: string): File {
     //     if (!destinationFilePath) {
-    //         destinationFilePath = Https.getFilenameFromUrl(this.url);
+    //         destinationFilePath = getFilenameFromUrl(this.url);
     //     }
     //     const file = this.response.toFile(destinationFilePath);
     //     return File.fromPath(destinationFilePath);
@@ -180,7 +180,7 @@ class HttpsResponse implements Https.HttpsResponseLegacy {
             return Promise.resolve(this.file);
         }
         if (!destinationFilePath) {
-            destinationFilePath = Https.getFilenameFromUrl(this.url);
+            destinationFilePath = getFilenameFromUrl(this.url);
         }
         return new Promise((resolve, reject) => {
             this.getOrCreateCloseCallback();
@@ -192,7 +192,7 @@ class HttpsResponse implements Https.HttpsResponseLegacy {
     }
 }
 
-export function enableSSLPinning(options: Https.HttpsSSLPinningOptions) {
+export function enableSSLPinning(options: HttpsSSLPinningOptions) {
     if (!peer.host && !peer.certificate) {
         let certificate: string;
         let inputStream: java.io.FileInputStream;
@@ -268,8 +268,8 @@ function getClient(reload: boolean = false, timeout: number = 10): okhttp3.OkHtt
     }
 
     const builder = new okhttp3.OkHttpClient.Builder();
-    Https.interceptors.forEach((interceptor) => builder.addInterceptor(interceptor));
-    Https.networkInterceptors.forEach((interceptor) => builder.addNetworkInterceptor(interceptor));
+    interceptors.forEach((interceptor) => builder.addInterceptor(interceptor));
+    networkInterceptors.forEach((interceptor) => builder.addNetworkInterceptor(interceptor));
     if (peer.enabled === true) {
         if (peer.host || peer.certificate) {
             const spec = okhttp3.ConnectionSpec.MODERN_TLS;
@@ -389,7 +389,7 @@ const notClosedResponses: {
 const runningClients: { [k: string]: okhttp3.OkHttpClient } = {};
 
 let OkHttpResponse: typeof com.nativescript.https.OkHttpResponse;
-export function createRequest(opts: Https.HttpsRequestOptions, useLegacy: boolean = true): Https.HttpsRequest {
+export function createRequest(opts: HttpsRequestOptions, useLegacy: boolean = true): HttpsRequest {
     const client = getClient(false, opts.timeout);
 
     const request = new okhttp3.Request.Builder();
@@ -434,7 +434,7 @@ export function createRequest(opts: Https.HttpsRequestOptions, useLegacy: boolea
             const builder = new okhttp3.MultipartBody.Builder();
             builder.setType(MEDIA_TYPE);
 
-            (opts.body as Https.HttpsFormDataParam[]).forEach((param) => {
+            (opts.body as HttpsFormDataParam[]).forEach((param) => {
                 if (param.fileName && param.contentType) {
                     const MEDIA_TYPE = okhttp3.MediaType.parse(param.contentType);
                     builder.addFormDataPart(param.parameterName, param.fileName, okhttp3.RequestBody.create(MEDIA_TYPE, param.data));
@@ -519,7 +519,7 @@ export function createRequest(opts: Https.HttpsRequestOptions, useLegacy: boolea
 
                             resolve({
                                 response,
-                                content: new HttpsResponse(nResponse, tag, opts.url),
+                                content: new HttpsResponseLegacyIOS(nResponse, tag, opts.url),
                                 statusCode,
                                 reason: message,
                                 get headers() {
@@ -548,7 +548,7 @@ export function createRequest(opts: Https.HttpsRequestOptions, useLegacy: boolea
     };
 }
 
-export function request(opts: Https.HttpsRequestOptions, useLegacy: boolean = true) {
+export function request(opts: HttpsRequestOptions, useLegacy: boolean = true) {
     return new Promise((resolve, reject) => {
         try {
             createRequest(opts, useLegacy).run(resolve, reject);

src/https.android.ts renamed to src/request.android.ts

@@ -0,0 +1,34 @@
+import { knownFolders, path } from '@nativescript/core';
+
+export function getFilenameFromUrl(url: string) {
+    const slashPos = url.lastIndexOf('/') + 1;
+    const questionMarkPos = url.lastIndexOf('?');
+
+    let actualFileName: string;
+    if (questionMarkPos !== -1) {
+        actualFileName = url.substring(slashPos, questionMarkPos);
+    } else {
+        actualFileName = url.substring(slashPos);
+    }
+
+    const result = path.join(knownFolders.documents().path, actualFileName);
+
+    return result;
+}
+export function parseJSON(source: string): any {
+    const src = source.trim();
+    if (src.lastIndexOf(')') === src.length - 1) {
+        return JSON.parse(src.substring(src.indexOf('(') + 1, src.lastIndexOf(')')));
+    }
+
+    return JSON.parse(src);
+}
+
+export const interceptors = [];
+export function addInterceptor(interceptor) {
+    interceptors.push(interceptor);
+}
+export const networkInterceptors = [];
+export function addNetworkInterceptor(interceptor) {
+    networkInterceptors.push(interceptor);
+}

src/request.common.ts

@@ -1,4 +1,5 @@
-import { File, Headers, HttpRequestOptions, ImageSource, knownFolders, path } from '@nativescript/core';
+import { File, HttpRequestOptions, ImageSource } from '@nativescript/core';
+import * as Https from './request.common';
 
 export interface HttpsSSLPinningOptions {
     host: string;
@@ -84,35 +85,18 @@ export interface HttpsResponseLegacy<T = any> {
     // toFileAsync(destinationFilePath: string): Promise<File>;
 }
 
-export function getFilenameFromUrl(url: string) {
-    const slashPos = url.lastIndexOf('/') + 1;
-    const questionMarkPos = url.lastIndexOf('?');
-
-    let actualFileName: string;
-    if (questionMarkPos !== -1) {
-        actualFileName = url.substring(slashPos, questionMarkPos);
-    } else {
-        actualFileName = url.substring(slashPos);
-    }
-
-    const result = path.join(knownFolders.documents().path, actualFileName);
-
-    return result;
-}
-export function parseJSON(source: string): any {
-    const src = source.trim();
-    if (src.lastIndexOf(')') === src.length - 1) {
-        return JSON.parse(src.substring(src.indexOf('(') + 1, src.lastIndexOf(')')));
-    }
-
-    return JSON.parse(src);
-}
-
-export const interceptors = [];
-export function addInterceptor(interceptor) {
-    interceptors.push(interceptor);
-}
-export const networkInterceptors = [];
-export function addNetworkInterceptor(interceptor) {
-    networkInterceptors.push(interceptor);
-}
+export function enableSSLPinning(options: HttpsSSLPinningOptions);
+
+export function disableSSLPinning();
+
+// export declare function request<T = any>(options: HttpsRequestOptions): Promise<HttpsResponse<HttpsResponseLegacy<T>>>;
+export declare function request<T = any, U extends boolean = true>(
+    options: HttpsRequestOptions,
+    useLegacy?: U
+): U extends true ? Promise<HttpsResponse<HttpsResponseLegacy<T>>> : Promise<HttpsResponse<T>>;
+export function setCache(options?: CacheOptions);
+export function clearCache();
+export function createRequest(opts: HttpsRequestOptions): HttpsRequest;
+export function cancelRequest(tag: string);
+export function addNetworkInterceptor(interceptor);
+export * from './request.common';