@metarisc/metarisc-js 0.0.1-alpha.1

package/.eslintrc

@@ -0,0 +1,12 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+    ]
+}

package/README.md

@@ -0,0 +1,3 @@
+# Metarisc JS
+
+La librairie Metarisc JS offre un accès simple et pratique à l'API Metarisc à partir d'applications écrites en langage JS. Elle comprend un ensemble de classes et de fonctions pour l'ensemble des ressources de l'API.

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { Metarisc } from './metarisc';

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metarisc = void 0;
+var metarisc_1 = require("./metarisc");
+Object.defineProperty(exports, "Metarisc", { enumerable: true, get: function () { return metarisc_1.Metarisc; } });

package/lib/metarisc.d.ts

@@ -0,0 +1,19 @@
+import { AxiosResponse } from "axios";
+interface RequestConfig {
+    body?: any;
+    headers?: string | {
+        [name: string]: string | string[];
+    };
+    params?: {
+        [param: string]: string | string[];
+    };
+    endpoint?: string;
+    method?: string;
+}
+export declare class Metarisc {
+    private axios;
+    constructor();
+    request<T>(config: RequestConfig): Promise<AxiosResponse<T>>;
+    autoPagingIterator<T>(config: RequestConfig): AsyncGenerator<T, void, unknown>;
+}
+export {};

package/lib/metarisc.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metarisc = void 0;
+const axios_1 = require("axios");
+class Metarisc {
+    constructor() {
+        this.axios = axios_1.default.create({
+            baseURL: 'https://api.metarisc.fr/'
+        });
+    }
+    async request(config) {
+        return this.axios.request({
+            method: config.method || 'GET',
+            url: config.endpoint || '/',
+            params: config.params,
+            data: config.body
+        });
+    }
+    async *autoPagingIterator(config) {
+        let current_page = config.params && 'page' in config.params ? parseInt(config.params['page'].toString()) : 1;
+        const per_page = config.params && 'per_page' in config.params ? parseInt(config.params['per_page'].toString()) : 25;
+        while (true) {
+            const response = await this.request({ ...config, ...{ params: { page: current_page.toString(), per_page: per_page.toString() } } });
+            for (const element of response.data.data) {
+                yield element;
+            }
+            if (response.data.meta.pagination.current_page === response.data.meta.pagination.total_pages) {
+                break;
+            }
+            current_page++;
+        }
+    }
+}
+exports.Metarisc = Metarisc;

package/package.json

@@ -0,0 +1,20 @@
+{
+    "name": "@metarisc/metarisc-js",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "version": "0.0.1-alpha.1",
+    "scripts": {
+        "lint": "eslint . --ext .ts",
+        "compile": "tsc"
+    },
+    "devDependencies": {
+        "@types/node": "^18.14.4",
+        "@typescript-eslint/eslint-plugin": "^5.54.0",
+        "@typescript-eslint/parser": "^5.54.0",
+        "eslint": "^8.35.0",
+        "typescript": "^4.9.5"
+    },
+    "dependencies": {
+        "axios": "^1.4.0"
+    }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { Metarisc } from './metarisc';

package/src/metarisc.ts

@@ -0,0 +1,62 @@
+import axios, { AxiosInstance, AxiosResponse } from "axios";
+
+interface RequestConfig {
+    body ?: any,
+    headers ?: string | {[name: string]: string | string[]},
+    params ?: {[param: string]: string | string[]},
+    endpoint ?: string,
+    method ?: string
+}
+
+export class Metarisc
+{
+    private axios : AxiosInstance;
+
+    constructor()
+    {
+        this.axios = axios.create({
+            baseURL: 'https://api.metarisc.fr/'
+        });
+    }
+
+    async request<T>(config : RequestConfig) : Promise<AxiosResponse<T>>
+    {
+        return this.axios.request<T>({
+            method: config.method || 'GET',
+            url: config.endpoint || '/',
+            params: config.params,
+            data: config.body
+        });
+    }
+
+    async * autoPagingIterator<T>(config : RequestConfig) : AsyncGenerator<T, void, unknown>
+    {
+        let current_page : number = config.params && 'page' in config.params ? parseInt(config.params['page'].toString()) : 1;
+        const per_page : number = config.params && 'per_page' in  config.params ? parseInt(config.params['per_page'].toString()) : 25;
+
+        while (true) {
+            const response = <AxiosResponse<{
+                data?: Array<T>;
+                meta?: {
+                    pagination?: {
+                        total?: number;
+                        count?: number;
+                        per_page?: number;
+                        current_page?: number;
+                        total_pages?: number;
+                      };
+                };
+                }>> await this.request({...config, ...{params: {page: current_page.toString(), per_page: per_page.toString()}}});
+
+            for (const element of response.data.data) {
+                yield element;
+            }
+
+            if (response.data.meta.pagination.current_page === response.data.meta.pagination.total_pages) {
+                break;
+            }
+
+            current_page++;
+        }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "outDir": "./lib",
+        "module": "commonjs",
+        "target": "es2020",
+        "declaration": true
+    },
+    "include": [
+        "src/**/*"
+    ]
+}