repair export of custom AxiosRequestConfig + add raw example + remove examples from builded + rename build to lib

Author: thib3113

.gitignore

@@ -154,6 +154,7 @@ config.json
 !.gitkeep
 /package-lock.json
 
+lib
 build
 last-check.json
 yarn.lock

.npmignore

@@ -169,4 +169,5 @@ _config.yml
 jest.config.js
 tsconfig.json
 renovate.json
-unifi-storage
+unifi-storage
+examples/

examples/raw/RawRequests.ts

@@ -0,0 +1,33 @@
+import { Controller } from '../../src';
+
+// create main function to deal with async/await
+const main = async () => {
+    const controller = new Controller({
+        username: process.env.TEST_UNIFIOS_USERNAME,
+        password: process.env.TEST_UNIFIOS_PASSWORD,
+        url: process.env.TEST_UNIFIOS_URL || 'https://unifi',
+        strictSSL: false
+    });
+
+    await controller.login();
+
+    //exemple of a raw request to the controller
+    // I want to call : https://unifi/api/users/self to get informations about mySelf
+    const mySelf = await controller.getInstance().get('/api/users/self');
+
+    // exemple of a raw request to a site
+    // I want to get sysinfo for the default site, so the request on my UDM pro is : https://unifi/proxy/network/api/s/default/stat/sysinfo
+    // I get the "default" site
+    const defaultSite = (await controller.getSites()).find((s) => s.name === 'default');
+    // I call /stat/sysinfo ... The instance will automaticaly transform for the correct url, and set the params .
+    const sysInfo = await defaultSite.getInstance().get('/stat/sysinfo');
+
+    // if I wan't to use a new V2 endpoint, like : https://unifi/proxy/network/v2/api/site/default/notifications
+    // I just need to reuse my site, call /notifications, and specify that I wan't to use apiVersion 2
+    const notifications = await defaultSite.getInstance().get('/notifications', {
+        apiVersion: 2
+    });
+};
+
+//just run the async main, and log error if needed
+main().catch((e) => console.error(e));

package.json

@@ -1,11 +1,11 @@
 {
   "name": "unifi-client",
   "version": "0.5.0",
-  "main": "build/index.js",
+  "main": "lib/index.js",
   "description": "NodeJs client for Unifi products (https://www.ui.com/)",
   "scripts": {
-    "debug": "tsc && node -r source-map-support/register ./build/test.js",
-    "start": "node -r source-map-support/register ./build/index.js",
+    "debug": "tsc && node -r source-map-support/register ./lib/test.js",
+    "start": "node -r source-map-support/register ./lib/index.js",
     "build": "tsc",
     "test": "jest",
     "test:CI": "jest --ci",
@@ -49,7 +49,7 @@
     "set-cookie-parser": "2.4.8",
     "source-map-support": "0.5.19",
     "typescript": "4.3.5",
-    "ws": "^8.0.0"
+    "ws": "8.0.0"
   },
   "devDependencies": {
     "@types/cookie": "0.4.1",

renovate.json

@@ -1,5 +1,16 @@
 {
   "extends": [
-    "config:base"
+    "config:base",
+    ":separateMajorReleases",
+    ":combinePatchMinorReleases",
+    ":prImmediately",
+    ":updateNotScheduled",
+    ":automergeDisabled",
+    ":ignoreModulesAndTests",
+    ":pinDependencies",
+    ":pinDevDependencies",
+    "group:monorepos",
+    "group:recommended",
+    "workarounds:all"
   ]
 }

sonar-project.properties

@@ -7,7 +7,7 @@ sonar.sources=src
 
 sonar.sourceEncoding=UTF-8
 
-sonar.exclusions=**/*.test.*,node_modules/**,coverage/**, logs/**, build/**, buildTests/**, front/**, cache/**, tests/**, src/test.ts
+sonar.exclusions=**/*.test.*,node_modules/**,coverage/**, logs/**, build/**, lib/**, buildTests/**, front/**, cache/**, tests/**, src/test.ts
 
 sonar.tests=tests
 ; sonar.testExecutionReportPaths=coverage/test-report.xml

src/custom.d.ts

@@ -11,3 +11,20 @@ export * from './WebSockets';
 
 export { Controller };
 export default Controller;
+
+declare module 'axios' {
+    export interface AxiosRequestConfig {
+        urlParams?: Record<string, string>;
+        site?: string;
+        apiVersion?: number;
+        /**
+         * default /proxy/network
+         */
+        unifiUrl?: string;
+        /**
+         * default false
+         */
+        authenticationRequest?: boolean;
+        retryAuth?: boolean;
+    }
+}

src/index.ts

@@ -7,16 +7,13 @@
     "allowJs": true,
     "esModuleInterop": true,
     "declaration": true,
-    "outDir": "build"
+    "outDir": "lib"
   },
   "exclude": [
     "node_modules",
     "tests"
   ],
   "include": [
     "src/**/*.ts"
-  ],
-  "files": [
-    "./src/custom.d.ts"
   ]
 }