@jin-qu/jinqu 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Umut Özel
+
+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,212 @@
+# Jinqu - LINQ for Javascript
+
+[![Build and Test](https://github.com/jin-qu/jinqu/actions/workflows/build.yml/badge.svg)](https://github.com/jin-qu/jinqu/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/jin-qu/jinqu/graph/badge.svg?token=KkhZnOc44l)](https://codecov.io/gh/jin-qu/jinqu)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5cc1af8cf2304b4aa5362c33225b380f)](https://www.codacy.com/gh/jin-qu/jinqu/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jin-qu/jinqu&utm_campaign=Badge_Grade)
+<a href="https://snyk.io/test/npm/jinqu"><img src="https://snyk.io/test/npm/jinqu/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/npm/jinqu" style="max-width:100%;"></a>
+
+[![npm version](https://img.shields.io/npm/v/jinqu)](https://www.npmjs.com/package/jinqu)
+[![npm downloads](https://img.shields.io/npm/dm/jinqu.svg)](https://www.npmjs.com/package/jinqu)
+
+[![GitHub issues](https://img.shields.io/github/issues/jin-qu/jinqu.svg)](https://github.com/jin-qu/jinqu/issues)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/jin-qu/jinqu/main/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/jin-qu/jinqu.svg?style=social&label=Star)](https://github.com/jin-qu/jinqu)
+[![GitHub forks](https://img.shields.io/github/forks/jin-qu/jinqu.svg?style=social&label=Fork)](https://github.com/jin-qu/jinqu)
+
+Jinqu, based on the LINQ design, is the ultimate querying API for Javscript & Typescript. It provides:
+
+* LINQ syntax
+* Lazy (i.e. deferred) Evaluation
+* Local and Remote Evaluation w/ provider model for libraries implementing remote evaluation (e.g. `jinqu-odata`)
+* Static Typing (in Typescript)
+* Dynamic queries (in strings)
+* Even works on IE 11 (with transpilation)
+
+Jinqu works perfectly in both Javascript and Typescript, but is optimized for Typescript. Jinqu is itself written in Typescript.
+
+## Installation
+
+> npm install jinqu
+
+## Code Examples
+
+First, make sure you've imported jinqu. This will add **asQueryable** method to Array Prototype.
+
+```typescript
+import 'jinqu'
+```
+
+We need to call **asQueryable** to create a query for an Array.
+
+```typescript
+const array = [1,2,3,4,5]
+const query = array.asQueryable().where(c => n % 2 == 0).toArray()
+for (var n of query)
+    console.log (n) // outputs 2,4
+```
+
+If you want to use query methods directly, you need to install and import **jinqu-array-extensions** package.
+
+> npm i jinqu-array-extensions
+
+```typescript
+import 'jinqu-array-extensions'
+```
+
+You actually only need to do this once, such as in the entry point for your application, to ensure the Array prototype extensions are set up.
+
+Now let's filter an array:
+
+```typescript
+const array = [1,2,3,4,5]
+const query = array.where(c => n % 2 == 0).toArray()
+for (var n of query)
+    console.log (n) // outputs 2,4
+```
+
+We can *chain* query operators:
+
+```typescript
+const array = [1,2,3,4,5]
+const query = array
+    .where(c => n % 2 == 0)
+    .orderByDescending (n => n)
+    .toArray()
+for (var n of query)
+  console.log (n) // outputs 4,2
+```
+
+Importantly, results aren't evaluated until `toArray` is called.
+
+## Dynamic Expressions
+
+```JavaScript
+const filtered = orders.where('c => c.id > value', { value: 3 })
+```
+
+The additional argument is a *variable scope* that lets you pass in variables dynamically.
+
+## Supported Query Operators
+
+The full range of LINQ operators are supported:
+
+```typescript
+where  
+ofType  
+cast  
+select  
+selectMany  
+join  
+groupJoin  
+orderBy  
+orderByDescending  
+thenBy  
+thenByDescending  
+take  
+takeWhile  
+skip  
+skipWhile  
+groupBy  
+distinct  
+concat  
+zip  
+union  
+intersect  
+except  
+defaultIfEmpty  
+reverse  
+first  
+firstOrDefault  
+last  
+lastOrDefault  
+single  
+singleOrDefault  
+elementAt  
+elementAtOrDefault  
+contains  
+sequenceEqual  
+any  
+all  
+count  
+min  
+max  
+sum  
+average  
+aggregate  
+toArray
+```
+
+As well as:
+
+```typescript
+ofGuardedType
+```
+
+And also:
+
+```typescript
+range  
+repeat
+```
+
+## Remote Query Providers
+
+Jinqu has the following remote providers:
+
+* [Jinqu-OData](https://github.com/jin-qu/jinqu-odata) - Query OData endpoints
+* [Linquest](https://github.com/jin-qu/linquest) - Query Remote LINQ endpoints
+
+Remote queries always return promises so are awaited. So rather than `toArray` to obtain the results of the query, you'll call `toArrayAsync`:
+
+```typescript
+const result = await remoteQuery.toArrayAsync()
+for (var item of result) {
+    // do stuff
+}
+```
+
+## Array Prototype Extensions
+
+Jinqu query operators build queries with a simple model: they take a query type as an input, transform it, and output another query type. However, the very first operator in a query needs to take an array type as the original source for the query. To make this work, jinqu extends the Array prototype.
+
+Extending the array prototype is very convenient, but occasionally has conflict issues with Array's built-in prototype or other 3rd party prototype extensions.
+
+To overcome this, you can call `asQueryable` or the convenience `q` for short, to ensure you're working with an `IQuery<T>` type:
+
+```typescript
+[1,2,3].asQueryable().reverse()
+[1,2,3].q().reverse() // same as above
+```
+
+In addition, the `concat`, `join`, and `reverse` methdos (which are built into the Array prototype), have special support: call `concatWith`, `joinWith`, and `reverseTo`, to start a query with these operators on the array type.
+
+## ofType and ofGuardedType
+
+`ofType` and `ofGuardedType` filter elements of a specified type. The type arguments you must supply are a little different to what you might expect if you come from a C# background, but will make sense to you when you get a feel for the Typescript type system.
+
+* `ofType` takes either a:
+  * constructor to filter class instances
+  * default value to filter primitive types
+* `ofGuardedType` takes a:
+  * Typescript type guard (See [Typescript Advanced Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html)) to filter values by a condition indicative of type
+
+Their usage is as follows:
+
+```typescript
+class Panda {
+    constructor (public id: number) {}
+}
+
+function isNumber(x: any): x is number {
+    return typeof x === "number"
+}
+
+const array = ["1", 2, new Panda(3), "4", 5, new Panda(6)]
+const justPandas = array.ofType(Panda) // panda 3, panda 6 - using constructor type filter
+const justStrings = array.ofType("") // "1", "4" - using default value type filter
+const justNumbers = array.ofGuardedType(isNumber) // 2, 5 - using type guard filter
+```
+
+## License
+
+jinqu is licensed with the [MIT License](LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { Ctor, IQuery } from "./lib/shared";
+declare global {
+    interface Array<T> {
+        asQueryable(ctor?: Ctor<T>): IQuery<T>;
+    }
+}
+export * from "./lib/ajax";
+export * from "./lib/array-query-provider";
+export * from "./lib/query-part";
+export * from "./lib/query";
+export * from "./lib/shared";

package/dist/index.js

@@ -0,0 +1,27 @@
+"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 });
+var array_query_provider_1 = require("./lib/array-query-provider");
+Array.prototype.asQueryable = function (ctor) {
+    var query = new array_query_provider_1.ArrayQueryProvider(this).createQuery();
+    return ctor ? query.cast(ctor) : query;
+};
+__exportStar(require("./lib/ajax"), exports);
+__exportStar(require("./lib/array-query-provider"), exports);
+__exportStar(require("./lib/query-part"), exports);
+__exportStar(require("./lib/query"), exports);
+__exportStar(require("./lib/shared"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mEAAgE;AAShE,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,UAAS,IAAmB;IACtD,IAAM,KAAK,GAAG,IAAI,yCAAkB,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IACzD,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC3C,CAAC,CAAC;AAEF,6CAA2B;AAC3B,6DAA2C;AAC3C,mDAAiC;AACjC,8CAA4B;AAC5B,+CAA6B"}

package/dist/lib/ajax.d.ts

@@ -0,0 +1,26 @@
+import { Value } from "./shared";
+export interface QueryParameter {
+    key: string;
+    value: string;
+}
+export declare const AjaxFuncs: {
+    includeResponse: string;
+    options: string;
+};
+export interface AjaxOptions {
+    $url?: string;
+    $method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    $params?: QueryParameter[];
+    $data?: unknown;
+    $timeout?: number;
+    $headers?: {
+        [key: string]: string;
+    };
+}
+export interface AjaxResponse<TResponse> {
+    response: TResponse;
+}
+export interface IAjaxProvider<TResponse, TOptions extends AjaxOptions = AjaxOptions> {
+    ajax<T>(options: TOptions): PromiseLike<Value<T> & AjaxResponse<TResponse>>;
+}
+export declare function mergeAjaxOptions(o1?: AjaxOptions | null, o2?: AjaxOptions | null): AjaxOptions;

package/dist/lib/ajax.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AjaxFuncs = void 0;
+exports.mergeAjaxOptions = mergeAjaxOptions;
+exports.AjaxFuncs = {
+    includeResponse: "includeResponse",
+    options: "options",
+};
+function mergeAjaxOptions(o1, o2) {
+    if (o1 == null)
+        return o2;
+    if (o2 == null)
+        return o1;
+    return {
+        $data: Object.assign({}, o1.$data, o2.$data),
+        $headers: Object.assign({}, o1.$headers, o2.$headers),
+        $method: o2.$method || o1.$method,
+        $params: (o1.$params || []).concat(o2.$params || []),
+        $timeout: o2.$timeout || o1.$timeout,
+        $url: o2.$url != null ? o2.$url : o1.$url,
+    };
+}
+//# sourceMappingURL=ajax.js.map

package/dist/lib/ajax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ajax.js","sourceRoot":"","sources":["../../lib/ajax.ts"],"names":[],"mappings":";;;AA4BA,4CAYC;AAlCY,QAAA,SAAS,GAAG;IACrB,eAAe,EAAE,iBAAiB;IAClC,OAAO,EAAE,SAAS;CACrB,CAAC;AAmBF,SAAgB,gBAAgB,CAAC,EAAuB,EAAE,EAAuB;IAC7E,IAAI,EAAE,IAAI,IAAI;QAAE,OAAO,EAAE,CAAC;IAC1B,IAAI,EAAE,IAAI,IAAI;QAAE,OAAO,EAAE,CAAC;IAE1B,OAAO;QACH,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC;QAC5C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC;QACrD,OAAO,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,OAAO;QACjC,OAAO,EAAE,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC;QACpD,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,EAAE,CAAC,QAAQ;QACpC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI;KAC5C,CAAC;AACN,CAAC"}

package/dist/lib/array-query-provider.d.ts

@@ -0,0 +1,11 @@
+import { Query } from "./query";
+import { Ctor, IQueryPart, IQueryProvider } from "./shared";
+export declare class ArrayQueryProvider implements IQueryProvider {
+    private readonly items?;
+    constructor(items?: unknown[] | IterableIterator<unknown> | null);
+    createQuery<T>(parts?: IQueryPart[], ctor?: Ctor<T>): Query<T>;
+    execute<TResult = unknown>(parts?: IQueryPart[] | null): TResult;
+    executeAsync<TResult = unknown>(parts: IQueryPart[]): PromiseLike<TResult>;
+    handlePart(items: IterableIterator<unknown>, part: IQueryPart): any;
+    multiOrderBy(items: IterableIterator<unknown>, keySelectors: IQueryPart[]): ArrayIterator<unknown>;
+}