crelte 0.5.0 → 0.5.1

package/dist/queries/vars.d.ts

@@ -3,19 +3,6 @@ export declare const vars: {
     any: () => QueryVar<any>;
     number: () => QueryVar<number>;
     string: () => QueryVar<string>;
-    id: () => QueryVar<number>;
-    ids: () => QueryVar<number[]>;
-    siteId: () => QueryVar<number>;
-};
-export type ValidIf<T> = (v: T, cs: ServerRouter) => boolean;
-export declare class QueryVar<T = any> {
-    private name;
-    private type;
-    private flagNullable;
-    private validIfFn;
-    constructor();
-    string(): QueryVar<string>;
-    number(): QueryVar<number>;
     /**
      * Id is almost the same as number but will also parse
      * strings, but only allow non negative integers
@@ -25,7 +12,7 @@ export declare class QueryVar<T = any> {
      * you need to validate the response to make sure filters
      * with this id returned something
      */
-    id(): QueryVar<number>;
+    id: () => QueryVar<number>;
     /**
      * Ids is an array of ids
      * it will also convert a single id to an array with one element
@@ -43,6 +30,19 @@ export declare class QueryVar<T = any> {
      * To mitigate this you could do a second query with the filtered
      * ids in the field, and check if the return matches the length.
      */
+    ids: () => QueryVar<number[]>;
+    siteId: () => QueryVar<number>;
+};
+export type ValidIf<T> = (v: T, cs: ServerRouter) => boolean;
+export declare class QueryVar<T = any> {
+    private name;
+    private type;
+    private flagNullable;
+    private validIfFn;
+    constructor();
+    string(): QueryVar<string>;
+    number(): QueryVar<number>;
+    id(): QueryVar<number>;
     ids(): QueryVar<number[]>;
     nullable(): QueryVar<T | null>;
     /**

package/dist/queries/vars.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vars.d.ts","sourceRoot":"","sources":["../../src/queries/vars.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAErD,eAAO,MAAM,IAAI;eACP,QAAQ,CAAC,GAAG,CAAC;kBACV,QAAQ,CAAC,MAAM,CAAC;kBAChB,QAAQ,CAAC,MAAM,CAAC;cACpB,QAAQ,CAAC,MAAM,CAAC;eACf,QAAQ,CAAC,MAAM,EAAE,CAAC;kBACf,QAAQ,CAAC,MAAM,CAAC;CAM5B,CAAC;AAIF,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,YAAY,KAAK,OAAO,CAAC;AAE7D,qBAAa,QAAQ,CAAC,CAAC,GAAG,GAAG;IAC5B,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,IAAI,CAA6C;IACzD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,SAAS,CAAa;;IAS9B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B;;;;;;;;OAQG;IACH,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC;IAKtB;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;IAKzB,QAAQ,IAAI,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC;IAK9B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,GAAG,CAAC,GAAG,IAAI;IAkE9C;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,YAAY;CACZ;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,QAAQ,CAEhD"}
+{"version":3,"file":"vars.d.ts","sourceRoot":"","sources":["../../src/queries/vars.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAErD,eAAO,MAAM,IAAI;eACP,QAAQ,CAAC,GAAG,CAAC;kBACV,QAAQ,CAAC,MAAM,CAAC;kBAChB,QAAQ,CAAC,MAAM,CAAC;IAE5B;;;;;;;;OAQG;cACK,QAAQ,CAAC,MAAM,CAAC;IAExB;;;;;;;;;;;;;;;;OAgBG;eACM,QAAQ,CAAC,MAAM,EAAE,CAAC;kBAEf,QAAQ,CAAC,MAAM,CAAC;CAM5B,CAAC;AAIF,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,YAAY,KAAK,OAAO,CAAC;AAE7D,qBAAa,QAAQ,CAAC,CAAC,GAAG,GAAG;IAC5B,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,IAAI,CAA6C;IACzD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,SAAS,CAAa;;IAS9B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK1B,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC;IAKtB,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;IAKzB,QAAQ,IAAI,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC;IAK9B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,GAAG,CAAC,GAAG,IAAI;IAqE9C;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAKpC,YAAY;CACZ;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,QAAQ,CAEhD"}

package/dist/queries/vars.js

@@ -2,7 +2,33 @@ export const vars = {
     any: () => new QueryVar(),
     number: () => new QueryVar().number(),
     string: () => new QueryVar().string(),
+    /**
+     * Id is almost the same as number but will also parse
+     * strings, but only allow non negative integers
+     *
+     * ## Warning
+     * Ids are not automatically safe to be cached
+     * you need to validate the response to make sure filters
+     * with this id returned something
+     */
     id: () => new QueryVar().id(),
+    /**
+     * Ids is an array of ids
+     * it will also convert a single id to an array with one element
+     * the returned array will **never be empty**, but might be null if
+     * allowed. Id's are always non negative integers
+     *
+     * ## Warning
+     * Ids are not automatically safe to be cached, it is also not
+     * enough to just check if the filter returned some results.
+     * Since for example a `relatedTo` filter works like an `or` and
+     * not an `and` meaning if you request ids `[1,2,3]` and
+     * only 1 and 3 have related entries you will get results
+     * even though id 2 did not return anything.
+     *
+     * To mitigate this you could do a second query with the filtered
+     * ids in the field, and check if the return matches the length.
+     */
     ids: () => new QueryVar().ids(),
     siteId: () => new QueryVar()
         .number()
@@ -27,36 +53,10 @@ export class QueryVar {
         this.type = 'number';
         return this;
     }
-    /**
-     * Id is almost the same as number but will also parse
-     * strings, but only allow non negative integers
-     *
-     * ## Warning
-     * Ids are not automatically safe to be cached
-     * you need to validate the response to make sure filters
-     * with this id returned something
-     */
     id() {
         this.type = 'id';
         return this;
     }
-    /**
-     * Ids is an array of ids
-     * it will also convert a single id to an array with one element
-     * the returned array will **never be empty**, but might be null if
-     * allowed. Id's are always non negative integers
-     *
-     * ## Warning
-     * Ids are not automatically safe to be cached, it is also not
-     * enough to just check if the filter returned some results.
-     * Since for example a `relatedTo` filter works like an `or` and
-     * not an `and` meaning if you request ids `[1,2,3]` and
-     * only 1 and 3 have related entries you will get results
-     * even though id 2 did not return anything.
-     *
-     * To mitigate this you could do a second query with the filtered
-     * ids in the field, and check if the return matches the length.
-     */
     ids() {
         this.type = 'ids';
         return this;
@@ -115,6 +115,8 @@ export class QueryVar {
                 v = v.map(v => (typeof v === 'string' ? parseInt(v) : v));
                 if (!v.every(isValidId))
                     throw new Error(`variable ${this.name} is not a list of valid ids`);
+                // make unique and sort by number
+                v = Array.from(new Set(v)).sort((a, b) => a - b);
                 break;
             default:
                 throw new Error('uknown type ' + this.type);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "crelte",
-	"version": "0.5.0",
+	"version": "0.5.1",
 	"author": "Crelte <support@crelte.com>",
 	"type": "module",
 	"scripts": {

package/src/queries/vars.ts

@@ -4,8 +4,37 @@ export const vars = {
 	any: (): QueryVar<any> => new QueryVar(),
 	number: (): QueryVar<number> => new QueryVar().number(),
 	string: (): QueryVar<string> => new QueryVar().string(),
+
+	/**
+	 * Id is almost the same as number but will also parse
+	 * strings, but only allow non negative integers
+	 *
+	 * ## Warning
+	 * Ids are not automatically safe to be cached
+	 * you need to validate the response to make sure filters
+	 * with this id returned something
+	 */
 	id: (): QueryVar<number> => new QueryVar().id(),
+
+	/**
+	 * Ids is an array of ids
+	 * it will also convert a single id to an array with one element
+	 * the returned array will **never be empty**, but might be null if
+	 * allowed. Id's are always non negative integers
+	 *
+	 * ## Warning
+	 * Ids are not automatically safe to be cached, it is also not
+	 * enough to just check if the filter returned some results.
+	 * Since for example a `relatedTo` filter works like an `or` and
+	 * not an `and` meaning if you request ids `[1,2,3]` and
+	 * only 1 and 3 have related entries you will get results
+	 * even though id 2 did not return anything.
+	 *
+	 * To mitigate this you could do a second query with the filtered
+	 * ids in the field, and check if the return matches the length.
+	 */
 	ids: (): QueryVar<number[]> => new QueryVar().ids(),
+
 	siteId: (): QueryVar<number> =>
 		new QueryVar()
 			.number()
@@ -41,37 +70,11 @@ export class QueryVar<T = any> {
 		return this as unknown as QueryVar<number>;
 	}
 
-	/**
-	 * Id is almost the same as number but will also parse
-	 * strings, but only allow non negative integers
-	 *
-	 * ## Warning
-	 * Ids are not automatically safe to be cached
-	 * you need to validate the response to make sure filters
-	 * with this id returned something
-	 */
 	id(): QueryVar<number> {
 		this.type = 'id';
 		return this as unknown as QueryVar<number>;
 	}
 
-	/**
-	 * Ids is an array of ids
-	 * it will also convert a single id to an array with one element
-	 * the returned array will **never be empty**, but might be null if
-	 * allowed. Id's are always non negative integers
-	 *
-	 * ## Warning
-	 * Ids are not automatically safe to be cached, it is also not
-	 * enough to just check if the filter returned some results.
-	 * Since for example a `relatedTo` filter works like an `or` and
-	 * not an `and` meaning if you request ids `[1,2,3]` and
-	 * only 1 and 3 have related entries you will get results
-	 * even though id 2 did not return anything.
-	 *
-	 * To mitigate this you could do a second query with the filtered
-	 * ids in the field, and check if the return matches the length.
-	 */
 	ids(): QueryVar<number[]> {
 		this.type = 'ids';
 		return this as unknown as QueryVar<number[]>;
@@ -147,6 +150,9 @@ export class QueryVar<T = any> {
 					throw new Error(
 						`variable ${this.name} is not a list of valid ids`,
 					);
+
+				// make unique and sort by number
+				v = Array.from(new Set(v as number[])).sort((a, b) => a - b);
 				break;
 
 			default:
@@ -176,6 +182,6 @@ export function isQueryVar(v: any): v is QueryVar {
 }
 
 // does not do string to number conversion
-function isValidId(id: any): boolean {
+function isValidId(id: any): id is number {
 	return typeof id === 'number' && Number.isInteger(id) && id >= 0;
 }