querier-ts 0.0.0

package/lib/utils/functions/generic/compare-arrays.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compares two arrays.
+ *
+ * @param {any[]} a First array to compare.
+ * @param {any[]} b Second array to compare.
+ *
+ * @returns {boolean} Validation result.
+ */
+export declare const compareArrays: (a: any[], b: any[]) => boolean;

package/lib/utils/functions/generic/compare-arrays.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareArrays = void 0;
+/**
+ * Compares two arrays.
+ *
+ * @param {any[]} a First array to compare.
+ * @param {any[]} b Second array to compare.
+ *
+ * @returns {boolean} Validation result.
+ */
+const compareArrays = (a, b) => a.length === b.length && a.every((v, i) => v === b[i]);
+exports.compareArrays = compareArrays;

package/lib/utils/functions/generic/get-entries.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the entries of an object.
+ *
+ * @param {object} obj The object to retrieve entries.
+ *
+ * @returns {[string, any]} The entries of the object.
+ */
+export declare const getEntries: <T extends object>(obj: T) => [[keyof T, T[keyof T]]];

package/lib/utils/functions/generic/get-entries.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntries = void 0;
+/**
+ * Returns the entries of an object.
+ *
+ * @param {object} obj The object to retrieve entries.
+ *
+ * @returns {[string, any]} The entries of the object.
+ */
+const getEntries = (obj) => Object.entries(obj);
+exports.getEntries = getEntries;

package/lib/utils/functions/generic/index.d.ts

@@ -0,0 +1,3 @@
+import { compareArrays } from './compare-arrays';
+import { getEntries } from './get-entries';
+export { compareArrays, getEntries, };

package/lib/utils/functions/generic/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntries = exports.compareArrays = void 0;
+const compare_arrays_1 = require("./compare-arrays");
+Object.defineProperty(exports, "compareArrays", { enumerable: true, get: function () { return compare_arrays_1.compareArrays; } });
+const get_entries_1 = require("./get-entries");
+Object.defineProperty(exports, "getEntries", { enumerable: true, get: function () { return get_entries_1.getEntries; } });

package/lib/utils/functions/sort/index.d.ts

@@ -0,0 +1,3 @@
+import { sortByProperties } from './sort-by-properties';
+import { sortByProperty } from './sort-by-property';
+export { sortByProperties, sortByProperty, };

package/lib/utils/functions/sort/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortByProperty = exports.sortByProperties = void 0;
+const sort_by_properties_1 = require("./sort-by-properties");
+Object.defineProperty(exports, "sortByProperties", { enumerable: true, get: function () { return sort_by_properties_1.sortByProperties; } });
+const sort_by_property_1 = require("./sort-by-property");
+Object.defineProperty(exports, "sortByProperty", { enumerable: true, get: function () { return sort_by_property_1.sortByProperty; } });

package/lib/utils/functions/sort/sort-by-properties.d.ts

@@ -0,0 +1,2 @@
+import { GenericObject } from '../../types';
+export declare function sortByProperties(...props: string[]): (obj1: GenericObject, obj2: GenericObject) => number;

package/lib/utils/functions/sort/sort-by-properties.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortByProperties = void 0;
+const _1 = require(".");
+function sortByProperties(...props) {
+    return (obj1, obj2) => {
+        const numberOfProperties = props.length;
+        let result = 0;
+        let i = 0;
+        while (result === 0 && i < numberOfProperties) {
+            result = (0, _1.sortByProperty)(props[i])(obj1, obj2);
+            i++;
+        }
+        return result;
+    };
+}
+exports.sortByProperties = sortByProperties;

package/lib/utils/functions/sort/sort-by-property.d.ts

@@ -0,0 +1,2 @@
+import { GenericObject } from '../../types';
+export declare function sortByProperty(property: string): (a: GenericObject, b: GenericObject) => number;

package/lib/utils/functions/sort/sort-by-property.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortByProperty = void 0;
+function sortByProperty(property) {
+    let sortOrder = 1;
+    if (property.startsWith('-')) {
+        sortOrder = -1;
+        property = property.substring(1);
+    }
+    return (a, b) => {
+        const result = (a[property] < b[property]) ? -1 : (a[property] > b[property]) ? 1 : 0;
+        return result * sortOrder;
+    };
+}
+exports.sortByProperty = sortByProperty;

package/lib/utils/functions/type-guards/index.d.ts

@@ -0,0 +1,4 @@
+import { isFunction } from './is-function';
+import { isNumber } from './is-number';
+import { isObject } from './is-object';
+export { isFunction, isNumber, isObject, };

package/lib/utils/functions/type-guards/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = exports.isNumber = exports.isFunction = void 0;
+const is_function_1 = require("./is-function");
+Object.defineProperty(exports, "isFunction", { enumerable: true, get: function () { return is_function_1.isFunction; } });
+const is_number_1 = require("./is-number");
+Object.defineProperty(exports, "isNumber", { enumerable: true, get: function () { return is_number_1.isNumber; } });
+const is_object_1 = require("./is-object");
+Object.defineProperty(exports, "isObject", { enumerable: true, get: function () { return is_object_1.isObject; } });

package/lib/utils/functions/type-guards/is-function.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Determines if the given value is a function.
+ *
+ * @param {any} value The value to check.
+ *
+ * @returns {boolean} Validation result.
+ */
+export declare const isFunction: (value: any) => value is (...args: any[]) => any;

package/lib/utils/functions/type-guards/is-function.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFunction = void 0;
+/**
+ * Determines if the given value is a function.
+ *
+ * @param {any} value The value to check.
+ *
+ * @returns {boolean} Validation result.
+ */
+const isFunction = (value) => typeof value === 'function';
+exports.isFunction = isFunction;

package/lib/utils/functions/type-guards/is-number.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Determines if the given value is a number.
+ *
+ * @param {any} value The value to check.
+ *
+ * @returns {boolean} Validation result.
+ */
+export declare const isNumber: (value: any) => value is number;

package/lib/utils/functions/type-guards/is-number.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNumber = void 0;
+/**
+ * Determines if the given value is a number.
+ *
+ * @param {any} value The value to check.
+ *
+ * @returns {boolean} Validation result.
+ */
+const isNumber = (value) => typeof value === 'number';
+exports.isNumber = isNumber;

package/lib/utils/functions/type-guards/is-object.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Determines if the given value is an object.
+ *
+ * @param {any} value The value to check.
+ *
+ * @returns {boolean} Validation result.
+ */
+export declare const isObject: (value: any) => value is object;

package/lib/utils/functions/type-guards/is-object.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = void 0;
+/**
+ * Determines if the given value is an object.
+ *
+ * @param {any} value The value to check.
+ *
+ * @returns {boolean} Validation result.
+ */
+const isObject = (value) => typeof value === 'object' && value !== null;
+exports.isObject = isObject;

package/lib/utils/types/add-prefix-to-object.d.ts

@@ -0,0 +1,3 @@
+export declare type addPrefixToObject<T, P extends string> = {
+    [K in keyof T as K extends string ? `${P}${K}` : never]: T[K];
+};

package/lib/utils/types/add-prefix-to-object.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/allowed-names.d.ts

@@ -0,0 +1,5 @@
+import { FlagExcludedType } from '.';
+/**
+ * Gets the keys that are not flagged as 'never'.
+ */
+export declare type AllowedNames<Base, Type> = FlagExcludedType<Base, Type>[keyof Base];

package/lib/utils/types/allowed-names.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/flag-excluded-type.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Transforms the type to flag all the undesired keys as 'never'.
+ */
+export declare type FlagExcludedType<Base, Type> = {
+    [Key in keyof Base]: Base[Key] extends Type ? never : Key;
+};

package/lib/utils/types/flag-excluded-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/generic-object.d.ts

@@ -0,0 +1,3 @@
+export interface GenericObject {
+    [key: string]: any;
+}

package/lib/utils/types/generic-object.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;

package/lib/utils/types/index.d.ts

@@ -0,0 +1,10 @@
+import { addPrefixToObject } from './add-prefix-to-object';
+import { AllowedNames } from './allowed-names';
+import { FlagExcludedType } from './flag-excluded-type';
+import { GenericObject } from './generic-object';
+import { OmitType } from './omit-type';
+import { PartialOfProperties } from './partial-of-properties';
+import { PropertyOnly } from './property-only';
+import { PropOf } from './prop-of';
+import { RecursivePartial } from './recursive-partial';
+export { addPrefixToObject, AllowedNames, FlagExcludedType, GenericObject, OmitType, PartialOfProperties, PropertyOnly, PropOf, RecursivePartial, };

package/lib/utils/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/omit-type.d.ts

@@ -0,0 +1,5 @@
+import { AllowedNames } from '.';
+/**
+ * Use this with a simple Pick to get the right interface, excluding the undesired type.
+ */
+export declare type OmitType<Base, Type> = Pick<Base, AllowedNames<Base, Type>>;

package/lib/utils/types/omit-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/partial-of-properties.d.ts

@@ -0,0 +1,2 @@
+import { PropertyOnly } from '.';
+export declare type PartialOfProperties<T extends object> = Partial<PropertyOnly<T>>;

package/lib/utils/types/partial-of-properties.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/prop-of.d.ts

@@ -0,0 +1,5 @@
+import { PropertyOnly } from '.';
+/**
+ * Represents a property of a class or interface.
+ */
+export declare type PropOf<T extends object> = keyof PropertyOnly<T>;

package/lib/utils/types/prop-of.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/property-only.d.ts

@@ -0,0 +1,4 @@
+import { NonFunctionKeys } from 'utility-types';
+export declare type PropertyOnly<T extends object> = {
+    [P in NonFunctionKeys<T>]: T[P];
+};

package/lib/utils/types/property-only.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/recursive-partial.d.ts

@@ -0,0 +1,3 @@
+export declare type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};

package/lib/utils/types/recursive-partial.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/types/type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Represents a class.
+ */
+export declare type Type<T = any> = new (...args: any[]) => T;

package/lib/utils/types/type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "querier-ts",
+  "version": "0.0.0",
+  "description": "Query tool for analysing arrays of objects",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "test": "jest --config jestconfig.json",
+    "build": "tsc",
+    "format": "prettier --write \"src/*.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm test && npm run lint",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/luizfilipezs/query-ts.git"
+  },
+  "keywords": [
+    "query",
+    "data filtering"
+  ],
+  "author": {
+    "name": "Luiz Filipe da Silva",
+    "email": "filipeluiz.bs@gmail.com",
+    "url": "https://blogdolipe.com.br"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/luizfilipezs/query-ts/issues"
+  },
+  "homepage": "https://github.com/luizfilipezs/query-ts#readme",
+  "devDependencies": {
+    "@types/jest": "^27.4.0",
+    "jest": "^27.5.0",
+    "prettier": "^2.5.1",
+    "ts-jest": "^27.1.3",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "~4.5.2"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "dependencies": {
+    "reflect-metadata": "^0.1.13",
+    "utility-types": "^3.10.0"
+  }
+}