transaction-serde 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Andrew Bridge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# transaction-serde
+
+Transaction serialisation and deserialisation library

package/build/main/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/build/main/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./lib"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHdDQUFzQiJ9

package/build/main/lib/deserialisers/csv.d.ts

@@ -0,0 +1,28 @@
+import { Deserialiser, TransactionLike } from 'transaction-serde';
+type DeserialiserOptions = {
+    headers: boolean;
+    map: (object: Record<string, unknown>) => TransactionLike;
+};
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+declare const handler: Deserialiser<DeserialiserOptions>;
+export default handler;

package/build/main/lib/deserialisers/csv.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const parse_1 = require("@fast-csv/parse");
+const common_1 = require("../../types/common");
+const dates_1 = require("../../utilities/dates");
+const options_1 = require("../../utilities/options");
+const defaultOptions = {
+    headers: true,
+    map: (object) => {
+        const transaction = {};
+        if (typeof object !== 'object' || object === null)
+            return transaction;
+        common_1.transactionKeys.forEach((key) => {
+            const value = object[key];
+            if (typeof value === 'string') {
+                transaction[key] = value;
+            }
+        });
+        return transaction;
+    },
+};
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+const handler = async (input, options) => {
+    const { headers, map } = (0, options_1.mergeOptions)(defaultOptions, options);
+    const objects = await new Promise((resolve, reject) => {
+        const rows = [];
+        (0, parse_1.parseString)(input, { headers })
+            .transform(map)
+            .on('data', (row) => rows.push(row))
+            .on('error', (error) => reject(error))
+            .on('end', () => resolve(rows));
+    });
+    const transactions = [];
+    const dates = [];
+    while (objects.length > 0) {
+        const object = objects.shift();
+        if (!object)
+            continue;
+        if (typeof object.date !== 'string' ||
+            !['number', 'string'].includes(typeof object.amount))
+            continue;
+        const transaction = {};
+        const dateString = object.date;
+        Object.keys(object).forEach((key) => {
+            switch (key) {
+                case 'date':
+                    dates.push({ date: dateString, transaction });
+                    break;
+                case 'amount':
+                    if (typeof object.amount === 'number') {
+                        transaction.amount = object.amount;
+                    }
+                    else if (typeof object.amount === 'string') {
+                        transaction.amount = parseFloat(object.amount);
+                    }
+                    break;
+                case 'payee':
+                case 'description':
+                case 'category':
+                    if (typeof object[key] === 'string') {
+                        transaction[key] = object[key];
+                    }
+                    break;
+            }
+        });
+        transactions.push(transaction);
+    }
+    const parsedDates = (0, dates_1.parseDateStrings)(dates.map((d) => d.date));
+    parsedDates.forEach((date, i) => (dates[i].transaction.date = date));
+    return transactions;
+};
+exports.default = handler;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3N2LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9kZXNlcmlhbGlzZXJzL2Nzdi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJDQUE4QztBQUc5QywrQ0FBcUQ7QUFDckQsaURBQXlEO0FBQ3pELHFEQUF1RDtBQU92RCxNQUFNLGNBQWMsR0FBd0I7SUFDMUMsT0FBTyxFQUFFLElBQUk7SUFDYixHQUFHLEVBQUUsQ0FBQyxNQUFNLEVBQUUsRUFBRTtRQUNkLE1BQU0sV0FBVyxHQUFvQixFQUFFLENBQUM7UUFDeEMsSUFBSSxPQUFPLE1BQU0sS0FBSyxRQUFRLElBQUksTUFBTSxLQUFLLElBQUk7WUFBRSxPQUFPLFdBQVcsQ0FBQztRQUN0RSx3QkFBZSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUFFO1lBQzlCLE1BQU0sS0FBSyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUMxQixJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsRUFBRSxDQUFDO2dCQUM5QixXQUFXLENBQUMsR0FBRyxDQUFDLEdBQUcsS0FBSyxDQUFDO1lBQzNCLENBQUM7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUNILE9BQU8sV0FBVyxDQUFDO0lBQ3JCLENBQUM7Q0FDRixDQUFDO0FBRUY7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHO0FBQ0gsTUFBTSxPQUFPLEdBQXNDLEtBQUssRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFLEVBQUU7SUFDMUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxHQUFHLEVBQUUsR0FBRyxJQUFBLHNCQUFZLEVBQUMsY0FBYyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQy9ELE1BQU0sT0FBTyxHQUFzQixNQUFNLElBQUksT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxFQUFFO1FBQ3ZFLE1BQU0sSUFBSSxHQUFzQixFQUFFLENBQUM7UUFDbkMsSUFBQSxtQkFBVyxFQUF1QyxLQUFLLEVBQUUsRUFBRSxPQUFPLEVBQUUsQ0FBQzthQUNsRSxTQUFTLENBQUMsR0FBRyxDQUFDO2FBQ2QsRUFBRSxDQUFDLE1BQU0sRUFBRSxDQUFDLEdBQW9CLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7YUFDcEQsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO2FBQ3JDLEVBQUUsQ0FBQyxLQUFLLEVBQUUsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7SUFDcEMsQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLFlBQVksR0FBa0IsRUFBRSxDQUFDO0lBQ3ZDLE1BQU0sS0FBSyxHQUFpRCxFQUFFLENBQUM7SUFDL0QsT0FBTyxPQUFPLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO1FBQzFCLE1BQU0sTUFBTSxHQUFHLE9BQU8sQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUMvQixJQUFJLENBQUMsTUFBTTtZQUFFLFNBQVM7UUFDdEIsSUFDRSxPQUFPLE1BQU0sQ0FBQyxJQUFJLEtBQUssUUFBUTtZQUMvQixDQUFDLENBQUMsUUFBUSxFQUFFLFFBQVEsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxPQUFPLE1BQU0sQ0FBQyxNQUFNLENBQUM7WUFFcEQsU0FBUztRQUNYLE1BQU0sV0FBVyxHQUFnQixFQUFFLENBQUM7UUFDcEMsTUFBTSxVQUFVLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQztRQUMvQixNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUFFO1lBQ2xDLFFBQVEsR0FBRyxFQUFFLENBQUM7Z0JBQ1osS0FBSyxNQUFNO29CQUNULEtBQUssQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLFdBQVcsRUFBRSxDQUFDLENBQUM7b0JBQzlDLE1BQU07Z0JBQ1IsS0FBSyxRQUFRO29CQUNYLElBQUksT0FBTyxNQUFNLENBQUMsTUFBTSxLQUFLLFFBQVEsRUFBRSxDQUFDO3dCQUN0QyxXQUFXLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQyxNQUFNLENBQUM7b0JBQ3JDLENBQUM7eUJBQU0sSUFBSSxPQUFPLE1BQU0sQ0FBQyxNQUFNLEtBQUssUUFBUSxFQUFFLENBQUM7d0JBQzdDLFdBQVcsQ0FBQyxNQUFNLEdBQUcsVUFBVSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQztvQkFDakQsQ0FBQztvQkFDRCxNQUFNO2dCQUNSLEtBQUssT0FBTyxDQUFDO2dCQUNiLEtBQUssYUFBYSxDQUFDO2dCQUNuQixLQUFLLFVBQVU7b0JBQ2IsSUFBSSxPQUFPLE1BQU0sQ0FBQyxHQUFHLENBQUMsS0FBSyxRQUFRLEVBQUUsQ0FBQzt3QkFDcEMsV0FBVyxDQUFDLEdBQUcsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQVcsQ0FBQztvQkFDM0MsQ0FBQztvQkFDRCxNQUFNO1lBQ1YsQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBQ0gsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNqQyxDQUFDO0lBQ0QsTUFBTSxXQUFXLEdBQUcsSUFBQSx3QkFBZ0IsRUFBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUMvRCxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLE9BQU8sWUFBWSxDQUFDO0FBQ3RCLENBQUMsQ0FBQztBQUNGLGtCQUFlLE9BQU8sQ0FBQyJ9

package/build/main/lib/deserialisers/index.d.ts

@@ -0,0 +1,2 @@
+import qif from './qif';
+export { qif };

package/build/main/lib/deserialisers/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qif = void 0;
+const qif_1 = __importDefault(require("./qif"));
+exports.qif = qif_1.default;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2Rlc2VyaWFsaXNlcnMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsZ0RBQXdCO0FBRWYsY0FGRixhQUFHLENBRUUifQ==

package/build/main/lib/deserialisers/json.d.ts

@@ -0,0 +1,24 @@
+import { Deserialiser } from 'transaction-serde';
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+declare const handler: Deserialiser;
+export default handler;

package/build/main/lib/deserialisers/json.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dates_1 = require("../../utilities/dates");
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+const handler = (input) => {
+    let objects = [];
+    try {
+        objects = JSON.parse(input);
+    }
+    catch {
+        throw Error('Input is not valid JSON');
+    }
+    if (!Array.isArray(objects)) {
+        throw Error('Input is not an array');
+    }
+    const transactions = [];
+    const dates = [];
+    while (objects.length > 0) {
+        const object = objects.shift();
+        if (!object)
+            continue;
+        if (typeof object.date !== 'string' || typeof object.amount !== 'number')
+            continue;
+        const transaction = {};
+        const dateString = object.date;
+        Object.keys(object).forEach((key) => {
+            switch (key) {
+                case 'date':
+                    dates.push({ date: dateString, transaction });
+                    break;
+                case 'amount':
+                    if (typeof object.amount === 'number') {
+                        transaction.amount = object.amount;
+                    }
+                    break;
+                case 'payee':
+                case 'description':
+                case 'category':
+                    if (typeof object[key] === 'string') {
+                        transaction[key] = object[key];
+                    }
+                    break;
+            }
+        });
+        transactions.push(transaction);
+    }
+    const parsedDates = (0, dates_1.parseDateStrings)(dates.map((d) => d.date));
+    parsedDates.forEach((date, i) => (dates[i].transaction.date = date));
+    return transactions;
+};
+exports.default = handler;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoianNvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvZGVzZXJpYWxpc2Vycy9qc29uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBRUEsaURBQXlEO0FBRXpEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRztBQUNILE1BQU0sT0FBTyxHQUFpQixDQUFDLEtBQWEsRUFBRSxFQUFFO0lBQzlDLElBQUksT0FBTyxHQUFpQyxFQUFFLENBQUM7SUFDL0MsSUFBSSxDQUFDO1FBQ0gsT0FBTyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDOUIsQ0FBQztJQUFDLE1BQU0sQ0FBQztRQUNQLE1BQU0sS0FBSyxDQUFDLHlCQUF5QixDQUFDLENBQUM7SUFDekMsQ0FBQztJQUNELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7UUFDNUIsTUFBTSxLQUFLLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUN2QyxDQUFDO0lBQ0QsTUFBTSxZQUFZLEdBQWtCLEVBQUUsQ0FBQztJQUN2QyxNQUFNLEtBQUssR0FBaUQsRUFBRSxDQUFDO0lBQy9ELE9BQU8sT0FBTyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUMxQixNQUFNLE1BQU0sR0FBRyxPQUFPLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDL0IsSUFBSSxDQUFDLE1BQU07WUFBRSxTQUFTO1FBQ3RCLElBQUksT0FBTyxNQUFNLENBQUMsSUFBSSxLQUFLLFFBQVEsSUFBSSxPQUFPLE1BQU0sQ0FBQyxNQUFNLEtBQUssUUFBUTtZQUN0RSxTQUFTO1FBQ1gsTUFBTSxXQUFXLEdBQWdCLEVBQUUsQ0FBQztRQUNwQyxNQUFNLFVBQVUsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDO1FBQy9CLE1BQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxFQUFFLEVBQUU7WUFDbEMsUUFBUSxHQUFHLEVBQUUsQ0FBQztnQkFDWixLQUFLLE1BQU07b0JBQ1QsS0FBSyxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksRUFBRSxVQUFVLEVBQUUsV0FBVyxFQUFFLENBQUMsQ0FBQztvQkFDOUMsTUFBTTtnQkFDUixLQUFLLFFBQVE7b0JBQ1gsSUFBSSxPQUFPLE1BQU0sQ0FBQyxNQUFNLEtBQUssUUFBUSxFQUFFLENBQUM7d0JBQ3RDLFdBQVcsQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztvQkFDckMsQ0FBQztvQkFDRCxNQUFNO2dCQUNSLEtBQUssT0FBTyxDQUFDO2dCQUNiLEtBQUssYUFBYSxDQUFDO2dCQUNuQixLQUFLLFVBQVU7b0JBQ2IsSUFBSSxPQUFPLE1BQU0sQ0FBQyxHQUFHLENBQUMsS0FBSyxRQUFRLEVBQUUsQ0FBQzt3QkFDcEMsV0FBVyxDQUFDLEdBQUcsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQVcsQ0FBQztvQkFDM0MsQ0FBQztvQkFDRCxNQUFNO1lBQ1YsQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBQ0gsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNqQyxDQUFDO0lBQ0QsTUFBTSxXQUFXLEdBQUcsSUFBQSx3QkFBZ0IsRUFBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUMvRCxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLE9BQU8sWUFBWSxDQUFDO0FBQ3RCLENBQUMsQ0FBQztBQUNGLGtCQUFlLE9BQU8sQ0FBQyJ9

package/build/main/lib/deserialisers/qif copy.d.ts

@@ -0,0 +1,25 @@
+/// <reference path="../../../../src/types/lib.d.ts" />
+import { Deserialiser } from "transaction-serde";
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+declare const handler: Deserialiser;
+export default handler;

package/build/main/lib/deserialisers/qif copy.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const qif_1 = require("../../types/qif");
+const dates_1 = require("../../utilities/dates");
+function isValidHeader(header) {
+    return qif_1.HEADER_VALUES.includes(header);
+}
+const fieldMap = {
+    D: 'date',
+    T: 'amount',
+    P: 'payee',
+    M: 'description',
+    L: 'category'
+};
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+const handler = (input) => {
+    const lines = input.trim().split('\n');
+    const header = lines.shift();
+    if (!isValidHeader(header))
+        throw Error('Unknown header: ' + header);
+    const transactions = [{}];
+    const dates = [];
+    while (lines.length > 0) {
+        const line = lines.shift();
+        if (!line)
+            continue;
+        const indicator = line.charAt(0);
+        if (indicator === qif_1.ENTRY_END && lines.length > 0) {
+            transactions.push({});
+            continue;
+        }
+        else if (indicator === qif_1.ENTRY_END)
+            break;
+        const transaction = transactions.at(-1);
+        if (!(indicator in fieldMap))
+            continue;
+        const fieldName = fieldMap[indicator];
+        const fieldValue = line.substring(1);
+        switch (fieldName) {
+            case 'date':
+                dates.push({ date: fieldValue, transaction });
+                break;
+            case 'amount':
+                transaction.amount = parseFloat(fieldValue);
+                break;
+            default:
+                transaction[fieldName] = fieldValue;
+        }
+    }
+    const parsedDates = (0, dates_1.parseDateStrings)(dates.map(d => d.date));
+    parsedDates.forEach((date, i) => dates[i].transaction.date = date);
+    return transactions;
+};
+exports.default = handler;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWlmIGNvcHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2Rlc2VyaWFsaXNlcnMvcWlmIGNvcHkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSx5Q0FBMkQ7QUFFM0QsaURBQXlEO0FBRXpELFNBQVMsYUFBYSxDQUFDLE1BQWU7SUFDbEMsT0FBTyxtQkFBYSxDQUFDLFFBQVEsQ0FBQyxNQUFnQixDQUFDLENBQUM7QUFDcEQsQ0FBQztBQUVELE1BQU0sUUFBUSxHQUF5QztJQUNuRCxDQUFDLEVBQUUsTUFBTTtJQUNULENBQUMsRUFBRSxRQUFRO0lBQ1gsQ0FBQyxFQUFFLE9BQU87SUFDVixDQUFDLEVBQUUsYUFBYTtJQUNoQixDQUFDLEVBQUUsVUFBVTtDQUNoQixDQUFDO0FBRUY7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBb0JHO0FBQ0gsTUFBTSxPQUFPLEdBQWlCLENBQUMsS0FBYSxFQUFFLEVBQUU7SUFDNUMsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN2QyxNQUFNLE1BQU0sR0FBRyxLQUFLLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsSUFBSSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUM7UUFBRSxNQUFNLEtBQUssQ0FBQyxrQkFBa0IsR0FBRyxNQUFNLENBQUMsQ0FBQztJQUNyRSxNQUFNLFlBQVksR0FBa0IsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUN6QyxNQUFNLEtBQUssR0FBaUQsRUFBRSxDQUFDO0lBQy9ELE9BQU8sS0FBSyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUN0QixNQUFNLElBQUksR0FBRyxLQUFLLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDM0IsSUFBSSxDQUFDLElBQUk7WUFBRSxTQUFTO1FBQ3BCLE1BQU0sU0FBUyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDakMsSUFBSSxTQUFTLEtBQUssZUFBUyxJQUFJLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDOUMsWUFBWSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztZQUN0QixTQUFTO1FBQ2IsQ0FBQzthQUFNLElBQUksU0FBUyxLQUFLLGVBQVM7WUFBRSxNQUFNO1FBQzFDLE1BQU0sV0FBVyxHQUFHLFlBQVksQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQWdCLENBQUM7UUFDdkQsSUFBSSxDQUFDLENBQUMsU0FBUyxJQUFJLFFBQVEsQ0FBQztZQUFFLFNBQVM7UUFDdkMsTUFBTSxTQUFTLEdBQUcsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ3RDLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDckMsUUFBTyxTQUFTLEVBQUUsQ0FBQztZQUNmLEtBQUssTUFBTTtnQkFDUCxLQUFLLENBQUMsSUFBSSxDQUFDLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxXQUFXLEVBQUUsQ0FBQyxDQUFDO2dCQUM5QyxNQUFNO1lBQ1YsS0FBSyxRQUFRO2dCQUNULFdBQVcsQ0FBQyxNQUFNLEdBQUcsVUFBVSxDQUFDLFVBQVUsQ0FBQyxDQUFDO2dCQUM1QyxNQUFNO1lBQ1Y7Z0JBQ0ksV0FBVyxDQUFDLFNBQVMsQ0FBQyxHQUFHLFVBQVUsQ0FBQztRQUM1QyxDQUFDO0lBQ0wsQ0FBQztJQUNELE1BQU0sV0FBVyxHQUFHLElBQUEsd0JBQWdCLEVBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQzdELFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQztJQUNuRSxPQUFPLFlBQVksQ0FBQztBQUN4QixDQUFDLENBQUM7QUFDRixrQkFBZSxPQUFPLENBQUMifQ==

package/build/main/lib/deserialisers/qif.d.ts

@@ -0,0 +1,24 @@
+import { Deserialiser } from 'transaction-serde';
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+declare const handler: Deserialiser;
+export default handler;

package/build/main/lib/deserialisers/qif.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const qif_1 = require("../../types/qif");
+const dates_1 = require("../../utilities/dates");
+function isValidHeader(header) {
+    return qif_1.HEADER_VALUES.includes(header);
+}
+const fieldMap = {
+    D: 'date',
+    T: 'amount',
+    P: 'payee',
+    M: 'description',
+    L: 'category',
+};
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+const handler = (input) => {
+    const lines = input.trim().split('\n');
+    const header = lines.shift();
+    if (!isValidHeader(header))
+        throw Error('Unknown header: ' + header);
+    const transactions = [{}];
+    const dates = [];
+    while (lines.length > 0) {
+        const line = lines.shift();
+        if (!line)
+            continue;
+        const indicator = line.charAt(0);
+        if (indicator === qif_1.ENTRY_END && lines.length > 0) {
+            transactions.push({});
+            continue;
+        }
+        else if (indicator === qif_1.ENTRY_END)
+            break;
+        const transaction = transactions.at(-1);
+        if (!(indicator in fieldMap))
+            continue;
+        const fieldName = fieldMap[indicator];
+        const fieldValue = line.substring(1);
+        switch (fieldName) {
+            case 'date':
+                dates.push({ date: fieldValue, transaction });
+                break;
+            case 'amount':
+                transaction.amount = parseFloat(fieldValue);
+                break;
+            default:
+                transaction[fieldName] = fieldValue;
+        }
+    }
+    const parsedDates = (0, dates_1.parseDateStrings)(dates.map((d) => d.date));
+    parsedDates.forEach((date, i) => (dates[i].transaction.date = date));
+    return transactions;
+};
+exports.default = handler;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWlmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9kZXNlcmlhbGlzZXJzL3FpZi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUVBLHlDQUEyRDtBQUUzRCxpREFBeUQ7QUFFekQsU0FBUyxhQUFhLENBQUMsTUFBZTtJQUNwQyxPQUFPLG1CQUFhLENBQUMsUUFBUSxDQUFDLE1BQWdCLENBQUMsQ0FBQztBQUNsRCxDQUFDO0FBRUQsTUFBTSxRQUFRLEdBQXlDO0lBQ3JELENBQUMsRUFBRSxNQUFNO0lBQ1QsQ0FBQyxFQUFFLFFBQVE7SUFDWCxDQUFDLEVBQUUsT0FBTztJQUNWLENBQUMsRUFBRSxhQUFhO0lBQ2hCLENBQUMsRUFBRSxVQUFVO0NBQ2QsQ0FBQztBQUVGOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRztBQUNILE1BQU0sT0FBTyxHQUFpQixDQUFDLEtBQWEsRUFBRSxFQUFFO0lBQzlDLE1BQU0sS0FBSyxHQUFHLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDdkMsTUFBTSxNQUFNLEdBQUcsS0FBSyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLElBQUksQ0FBQyxhQUFhLENBQUMsTUFBTSxDQUFDO1FBQUUsTUFBTSxLQUFLLENBQUMsa0JBQWtCLEdBQUcsTUFBTSxDQUFDLENBQUM7SUFDckUsTUFBTSxZQUFZLEdBQWtCLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDekMsTUFBTSxLQUFLLEdBQWlELEVBQUUsQ0FBQztJQUMvRCxPQUFPLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDeEIsTUFBTSxJQUFJLEdBQUcsS0FBSyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzNCLElBQUksQ0FBQyxJQUFJO1lBQUUsU0FBUztRQUNwQixNQUFNLFNBQVMsR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ2pDLElBQUksU0FBUyxLQUFLLGVBQVMsSUFBSSxLQUFLLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ2hELFlBQVksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDdEIsU0FBUztRQUNYLENBQUM7YUFBTSxJQUFJLFNBQVMsS0FBSyxlQUFTO1lBQUUsTUFBTTtRQUMxQyxNQUFNLFdBQVcsR0FBRyxZQUFZLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFnQixDQUFDO1FBQ3ZELElBQUksQ0FBQyxDQUFDLFNBQVMsSUFBSSxRQUFRLENBQUM7WUFBRSxTQUFTO1FBQ3ZDLE1BQU0sU0FBUyxHQUFHLFFBQVEsQ0FBQyxTQUFTLENBQUMsQ0FBQztRQUN0QyxNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3JDLFFBQVEsU0FBUyxFQUFFLENBQUM7WUFDbEIsS0FBSyxNQUFNO2dCQUNULEtBQUssQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLFdBQVcsRUFBRSxDQUFDLENBQUM7Z0JBQzlDLE1BQU07WUFDUixLQUFLLFFBQVE7Z0JBQ1gsV0FBVyxDQUFDLE1BQU0sR0FBRyxVQUFVLENBQUMsVUFBVSxDQUFDLENBQUM7Z0JBQzVDLE1BQU07WUFDUjtnQkFDRSxXQUFXLENBQUMsU0FBUyxDQUFDLEdBQUcsVUFBVSxDQUFDO1FBQ3hDLENBQUM7SUFDSCxDQUFDO0lBQ0QsTUFBTSxXQUFXLEdBQUcsSUFBQSx3QkFBZ0IsRUFBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUMvRCxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLE9BQU8sWUFBWSxDQUFDO0FBQ3RCLENBQUMsQ0FBQztBQUNGLGtCQUFlLE9BQU8sQ0FBQyJ9

package/build/main/lib/deserialisers/qif.spec copy.d.ts

@@ -0,0 +1 @@
+export {};

package/build/main/lib/deserialisers/qif.spec copy.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const qif_1 = __importDefault(require("./qif"));
+const utc_1 = require("@date-fns/utc");
+const DATA = `
+!Type:Bank
+D01/04/2024
+T134.99
+PAcme
+LIncome
+MAcme Salary April
+^
+D02/04/2024
+T-34.99
+PInternet
+LBills
+MINET12345678-0
+^
+D02/04/2024
+T-100
+PEnergy
+LBills
+MA-0A00AA00-001
+^`;
+(0, ava_1.default)('deserialising qif', (t) => {
+    t.deepEqual((0, qif_1.default)(DATA), [
+        {
+            date: new utc_1.UTCDateMini(2024, 3, 1),
+            amount: 134.99,
+            payee: 'Acme',
+            description: 'Acme Salary April',
+            category: 'Income'
+        },
+        {
+            date: new utc_1.UTCDateMini(2024, 3, 2),
+            amount: -34.99,
+            payee: 'Internet',
+            description: 'INET12345678-0',
+            category: 'Bills'
+        },
+        {
+            date: new utc_1.UTCDateMini(2024, 3, 2),
+            amount: -100,
+            payee: 'Energy',
+            description: 'A-0A00AA00-001',
+            category: 'Bills'
+        }
+    ]);
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWlmLnNwZWMgY29weS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvZGVzZXJpYWxpc2Vycy9xaWYuc3BlYyBjb3B5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsOENBQXVCO0FBRXZCLGdEQUF3QjtBQUN4Qix1Q0FBNEM7QUFFNUMsTUFBTSxJQUFJLEdBQUc7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7RUFtQlgsQ0FBQztBQUVILElBQUEsYUFBSSxFQUFDLG1CQUFtQixFQUFFLENBQUMsQ0FBQyxFQUFFLEVBQUU7SUFDNUIsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxJQUFBLGFBQUcsRUFBQyxJQUFJLENBQUMsRUFBRTtRQUNuQjtZQUNJLElBQUksRUFBRSxJQUFJLGlCQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDakMsTUFBTSxFQUFFLE1BQU07WUFDZCxLQUFLLEVBQUUsTUFBTTtZQUNiLFdBQVcsRUFBRSxtQkFBbUI7WUFDaEMsUUFBUSxFQUFFLFFBQVE7U0FDckI7UUFDRDtZQUNJLElBQUksRUFBRSxJQUFJLGlCQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDakMsTUFBTSxFQUFFLENBQUMsS0FBSztZQUNkLEtBQUssRUFBRSxVQUFVO1lBQ2pCLFdBQVcsRUFBRSxnQkFBZ0I7WUFDN0IsUUFBUSxFQUFFLE9BQU87U0FDcEI7UUFDRDtZQUNJLElBQUksRUFBRSxJQUFJLGlCQUFXLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDakMsTUFBTSxFQUFFLENBQUMsR0FBRztZQUNaLEtBQUssRUFBRSxRQUFRO1lBQ2YsV0FBVyxFQUFFLGdCQUFnQjtZQUM3QixRQUFRLEVBQUUsT0FBTztTQUNwQjtLQUNKLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFDIn0=

package/build/main/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './deserialisers';

package/build/main/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./deserialisers"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxrREFBZ0MifQ==

package/build/main/lib/number.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Multiplies a value by 2. (Also a full example of TypeDoc's functionality.)
+ *
+ * ### Example (es module)
+ * ```js
+ * import { double } from 'typescript-starter'
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var double = require('typescript-starter').double;
+ * console.log(double(4))
+ * // => 8
+ * ```
+ *
+ * @param value - Comment describing the `value` parameter.
+ * @returns Comment describing the return type.
+ * @anotherNote Some other value.
+ */
+export declare const double: (value: number) => number;
+/**
+ * Raise the value of the first parameter to the power of the second using the
+ * es7 exponentiation operator (`**`).
+ *
+ * ### Example (es module)
+ * ```js
+ * import { power } from 'typescript-starter'
+ * console.log(power(2,3))
+ * // => 8
+ * ```
+ *
+ * ### Example (commonjs)
+ * ```js
+ * var power = require('typescript-starter').power;
+ * console.log(power(2,3))
+ * // => 8
+ * ```
+ * @param base - the base to exponentiate
+ * @param exponent - the power to which to raise the base
+ */
+export declare const power: (base: number, exponent: number) => number;