@epilot/metering-client 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.1.1](https://github.com/epilot-dev/sdk-js/compare/v1.0.0...v0.1.1) (2022-03-09)

package/README.md

@@ -0,0 +1,43 @@
+# `@epilot/ts-sam-client`
+
+API Client for epilot ts-sam API.
+
+Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+
+## Getting Started
+
+Install the package:
+
+```bash
+npm install --save-dev @epilot/ts-sam-client
+```
+
+Import the package:
+
+```typescript
+import { getClient } from '@epilot/ts-sam-client';
+```
+
+Use the client:
+```typescript
+// get typed client
+const client = await getClient();
+
+// call an operation
+const res = await client.testS3();
+```
+
+## BaseURL & Authorization
+
+To pass an authorization header and set up the API url, you can use axios
+defaults:
+
+```typescript
+const client = getClient();
+client.defaults.baseURL = config.API_URL;
+client.defaults.headers['authorization'] = `Bearer ${token}`;
+```
+
+## API Docs:
+
+https://docs.api.epilot.io/

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+import { Client } from './openapi';
+export declare const getClient: () => Client;

package/dist/client.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.getClient = void 0;
+var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
+var definition_1 = __importDefault(require("./definition"));
+var getClient = function () {
+    var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
+    return api.initSync();
+};
+exports.getClient = getClient;
+//# sourceMappingURL=client.js.map

package/dist/definition.d.ts

@@ -0,0 +1,3 @@
+import type { Document } from 'openapi-client-axios';
+declare const _default: Document;
+export default _default;

package/dist/definition.js

@@ -0,0 +1 @@
+!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=n(r(279));t.default=a.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Metering API","version":"1.0.0"},"tags":[{"name":"Epilot_360","description":"Epilot_360"},{"name":"ECP","description":"End customer portal"}],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"paths":{"/v1/metering/reading":{"post":{"operationId":"saveMeterReading","summary":"saveMeterReading","description":"This operation inserts a new meter reading","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"requestBody":{"description":"Meter reading payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeterReading"}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}},"/v1/metering/reading/{meter_id}/{counter_id}":{"get":{"operationId":"fetchReadingsByInterval","summary":"fetchReadingsByInterval","description":"- Get all readings specified in an interval\\n- If the start_date & end_date are equal, then returns the readings of the specified date\\n- start_date should <= end_date\\n","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"meter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter"},{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of counter"},{"in":"query","name":"start_date","required":true,"schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":true,"schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}},"total_count":{"type":"number","example":120}}}}}}}}},"/v1/metering/down-sample/readings/{meter_id}/{counter_id}":{"get":{"operationId":"fetchDownSampleReadingsByInterval","summary":"fetchDownSampleReadingsByInterval","description":"- Get the down sampled data of the entire readings specified in an interval\\n- If the start_date & end_date are equal, then returns the readings of the specified date\\n- start_date should <= end_date\\n","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"meter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter"},{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of counter"},{"in":"query","name":"start_date","required":true,"schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":true,"schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}},{"in":"query","name":"unit","schema":{"type":"string","default":"day","enum":["day","week","month","year"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"},"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Authorization header with customer pilot OAuth2 bearer token","bearerFormat":"JWT"}},"schemas":{"Id":{"type":"string"},"MeterReading":{"type":"object","properties":{"value":{"type":"number","example":240},"unit":{"type":"string","enum":["W","WH","KW","KWH","KVARH","MW","MWH","unit","cubic meter","hour","day","month","year","percentage"]},"read_by":{"type":"string","example":"John Doe"},"reason":{"type":"string","example":"Storing the feed-in record"},"meter_id":{"type":"string","example":"1446829f-4b6f-474e-b978-3997d89a7928"},"counter_id":{"type":"string","example":"2A-3"}}}}}}')}},t={};return function r(n){if(t[n])return t[n].exports;var a=t[n]={exports:{}};return e[n].call(a.exports,a,a.exports,r),a.exports}(914)})());

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export type { Client, Components, Paths, PathsDictionary, OperationMethods } from './openapi';
+export type { OpenAPIClient, OpenAPIClientAxios, Document } from 'openapi-client-axios';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+//# sourceMappingURL=index.js.map

package/dist/openapi.d.ts

@@ -0,0 +1,219 @@
+/* eslint-disable */
+import type {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+    namespace Schemas {
+        export type Id = string;
+        export interface MeterReading {
+            /**
+             * example:
+             * 240
+             */
+            value?: number;
+            unit?: "W" | "WH" | "KW" | "KWH" | "KVARH" | "MW" | "MWH" | "unit" | "cubic meter" | "hour" | "day" | "month" | "year" | "percentage";
+            /**
+             * example:
+             * John Doe
+             */
+            read_by?: string;
+            /**
+             * example:
+             * Storing the feed-in record
+             */
+            reason?: string;
+            /**
+             * example:
+             * 1446829f-4b6f-474e-b978-3997d89a7928
+             */
+            meter_id?: string;
+            /**
+             * example:
+             * 2A-3
+             */
+            counter_id?: string;
+        }
+    }
+}
+declare namespace Paths {
+    namespace FetchDownSampleReadingsByInterval {
+        namespace Parameters {
+            export type CounterId = Components.Schemas.Id;
+            /**
+             * example:
+             * "2022-10-10T00:00:00.000Z"
+             */
+            export type EndDate = string;
+            export type MeterId = Components.Schemas.Id;
+            /**
+             * example:
+             * "2022-10-01T00:00:00.000Z"
+             */
+            export type StartDate = string;
+            export type Unit = "day" | "week" | "month" | "year";
+        }
+        export interface PathParameters {
+            meter_id: Parameters.MeterId;
+            counter_id: Parameters.CounterId;
+        }
+        export interface QueryParameters {
+            start_date: /**
+             * example:
+             * "2022-10-01T00:00:00.000Z"
+             */
+            Parameters.StartDate;
+            end_date: /**
+             * example:
+             * "2022-10-10T00:00:00.000Z"
+             */
+            Parameters.EndDate;
+            unit?: Parameters.Unit;
+        }
+        namespace Responses {
+            export interface $200 {
+                results?: Components.Schemas.MeterReading[];
+            }
+        }
+    }
+    namespace FetchReadingsByInterval {
+        namespace Parameters {
+            export type CounterId = Components.Schemas.Id;
+            /**
+             * example:
+             * "2022-10-10T00:00:00.000Z"
+             */
+            export type EndDate = string;
+            export type MeterId = Components.Schemas.Id;
+            /**
+             * example:
+             * "2022-10-01T00:00:00.000Z"
+             */
+            export type StartDate = string;
+        }
+        export interface PathParameters {
+            meter_id: Parameters.MeterId;
+            counter_id: Parameters.CounterId;
+        }
+        export interface QueryParameters {
+            start_date: /**
+             * example:
+             * "2022-10-01T00:00:00.000Z"
+             */
+            Parameters.StartDate;
+            end_date: /**
+             * example:
+             * "2022-10-10T00:00:00.000Z"
+             */
+            Parameters.EndDate;
+        }
+        namespace Responses {
+            export interface $200 {
+                results?: Components.Schemas.MeterReading[];
+                /**
+                 * example:
+                 * 120
+                 */
+                total_count?: number;
+            }
+        }
+    }
+    namespace SaveMeterReading {
+        export type RequestBody = Components.Schemas.MeterReading;
+        namespace Responses {
+            export interface $200 {
+                data?: Components.Schemas.MeterReading;
+            }
+        }
+    }
+}
+
+export interface OperationMethods {
+  /**
+   * saveMeterReading - saveMeterReading
+   * 
+   * This operation inserts a new meter reading
+   */
+  'saveMeterReading'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.SaveMeterReading.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SaveMeterReading.Responses.$200>
+  /**
+   * fetchReadingsByInterval - fetchReadingsByInterval
+   * 
+   * - Get all readings specified in an interval
+   * - If the start_date & end_date are equal, then returns the readings of the specified date
+   * - start_date should <= end_date
+   * 
+   */
+  'fetchReadingsByInterval'(
+    parameters?: Parameters<Paths.FetchReadingsByInterval.PathParameters & Paths.FetchReadingsByInterval.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.FetchReadingsByInterval.Responses.$200>
+  /**
+   * fetchDownSampleReadingsByInterval - fetchDownSampleReadingsByInterval
+   * 
+   * - Get the down sampled data of the entire readings specified in an interval
+   * - If the start_date & end_date are equal, then returns the readings of the specified date
+   * - start_date should <= end_date
+   * 
+   */
+  'fetchDownSampleReadingsByInterval'(
+    parameters?: Parameters<Paths.FetchDownSampleReadingsByInterval.PathParameters & Paths.FetchDownSampleReadingsByInterval.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.FetchDownSampleReadingsByInterval.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/v1/metering/reading']: {
+    /**
+     * saveMeterReading - saveMeterReading
+     * 
+     * This operation inserts a new meter reading
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.SaveMeterReading.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SaveMeterReading.Responses.$200>
+  }
+  ['/v1/metering/reading/{meter_id}/{counter_id}']: {
+    /**
+     * fetchReadingsByInterval - fetchReadingsByInterval
+     * 
+     * - Get all readings specified in an interval
+     * - If the start_date & end_date are equal, then returns the readings of the specified date
+     * - start_date should <= end_date
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.FetchReadingsByInterval.PathParameters & Paths.FetchReadingsByInterval.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.FetchReadingsByInterval.Responses.$200>
+  }
+  ['/v1/metering/down-sample/readings/{meter_id}/{counter_id}']: {
+    /**
+     * fetchDownSampleReadingsByInterval - fetchDownSampleReadingsByInterval
+     * 
+     * - Get the down sampled data of the entire readings specified in an interval
+     * - If the start_date & end_date are equal, then returns the readings of the specified date
+     * - start_date should <= end_date
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.FetchDownSampleReadingsByInterval.PathParameters & Paths.FetchDownSampleReadingsByInterval.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.FetchDownSampleReadingsByInterval.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@epilot/metering-client",
+  "version": "0.1.1",
+  "description": "API Client for epilot Metering API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "openapi read --json ../lambda/ApiHandlerFunction/openapi.yml > src/openapi.json",
+    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ../lambda/ApiHandlerFunction/openapi.yml >> src/openapi.d.ts",
+    "build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
+    "eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "**/*.js",
+    "**/*.d.ts",
+    "!*.test.*",
+    "!**/*.test.*",
+    "!node_modules",
+    "!src",
+    "!*.config.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/epilot-dev/sdk-js",
+    "directory": "clients/ts-sam-client"
+  },
+  "keywords": [],
+  "author": "epilot GmbH",
+  "license": "UNLICENSED",
+  "peerDependencies": {
+    "axios": "^0.21.4"
+  },
+  "dependencies": {
+    "buffer": "^6.0.3",
+    "https-browserify": "^1.0.0",
+    "openapi-client-axios": "^4.4.9",
+    "stream-http": "^3.1.1",
+    "url": "^0.11.0",
+    "util": "^0.12.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^26.0.20",
+    "axios": "^0.21.1",
+    "copy-webpack-plugin": "^7.0.0",
+    "jest": "^26.6.3",
+    "json-loader": "^0.5.7",
+    "openapi-client-axios-typegen": "^4.4.9",
+    "openapicmd": "^1.8.2",
+    "ts-jest": "^26.5.6",
+    "ts-loader": "^8.3.0",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.5.4",
+    "webpack": "^5.18.0",
+    "webpack-cli": "^4.4.0"
+  }
+}