@generazioneai/genquery 0.1.0

package/dist/schema.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Schema describes what fields and relations exist on each entity, so the
+ * parser can validate queries and the adapter can produce correct joins and
+ * conditions. The schema is intentionally ORM-agnostic.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaError = void 0;
+exports.getEntity = getEntity;
+exports.getField = getField;
+exports.getRelation = getRelation;
+exports.primaryKeyOf = primaryKeyOf;
+class SchemaError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "SchemaError";
+    }
+}
+exports.SchemaError = SchemaError;
+function getEntity(schema, name) {
+    const entity = schema.entities[name];
+    if (!entity) {
+        throw new SchemaError(`Unknown entity '${name}' in schema`);
+    }
+    return entity;
+}
+function getField(schema, entityName, field) {
+    return getEntity(schema, entityName).fields[field];
+}
+function getRelation(schema, entityName, field) {
+    return getEntity(schema, entityName).relations?.[field];
+}
+function primaryKeyOf(entity) {
+    return entity.primaryKey ?? "id";
+}
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AA2DH,8BAMC;AAED,4BAMC;AAED,kCAMC;AAED,oCAEC;AAjCD,MAAa,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AALD,kCAKC;AAED,SAAgB,SAAS,CAAC,MAAc,EAAE,IAAY;IACpD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,WAAW,CAAC,mBAAmB,IAAI,aAAa,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,QAAQ,CACtB,MAAc,EACd,UAAkB,EAClB,KAAa;IAEb,OAAO,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,SAAgB,WAAW,CACzB,MAAc,EACd,UAAkB,EAClB,KAAa;IAEb,OAAO,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,SAAgB,YAAY,CAAC,MAAwB;IACnD,OAAO,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC;AACnC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Raw input types as accepted from the wire.
+ *
+ * These mirror the spec literally. Anything received from the frontend should
+ * conform to `GenQueryInput`. Use the parser to validate + normalize into the
+ * `Parsed*` types defined in `./parsed.ts`.
+ *
+ * The input types are generic on an entity type `T`. With `T = unknown`
+ * (default) you get the loose, untyped form. Pass a concrete entity class
+ * (`GenQueryInput<User>`) to get autocomplete and value-shape checking for
+ * fields and relations.
+ */
+export type SortOrder = "asc" | "desc";
+export type StringSearchMode = "splitword" | "exact" | "nativeregex";
+export type NumericOp = ">" | "<" | ">=" | "<=" | "==";
+/** Timezone offset. "Z" (UTC) or "+HH:MM" / "-HH:MM" (also "+HHMM" / "+HH"). */
+export type OffsetInput = string;
+export interface DateTimeObjectInput {
+    year?: number;
+    month?: number;
+    day?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+    offset?: OffsetInput;
+}
+export type DateTimeInput = string | DateTimeObjectInput;
+export interface NumericComparisonInput {
+    operation?: NumericOp;
+    value: number;
+}
+/**
+ * Null-presence check, valid on any primitive field type (string, number,
+ * boolean, date, enum).
+ *
+ *   { isNull: true }  → IS NULL
+ *   { isNull: false } → IS NOT NULL
+ */
+export interface NullCheckInput {
+    isNull: boolean;
+}
+/**
+ * Empty-presence check, valid only on string fields. "Empty" means NULL or
+ * the empty string `''`.
+ *
+ *   { isEmpty: true }  → (col IS NULL OR col = '')
+ *   { isEmpty: false } → (col IS NOT NULL AND col <> '')
+ */
+export interface EmptyCheckInput {
+    isEmpty: boolean;
+}
+export interface StringSearchObjectInput {
+    mode?: StringSearchMode;
+    contained?: boolean;
+    /** Case-sensitive comparison. Defaults to `false` (case-insensitive). */
+    caseSensitive?: boolean;
+    value: string;
+}
+export type StringSearchInput = string | StringSearchObjectInput | NullCheckInput | EmptyCheckInput;
+export interface DateRangeInput {
+    before?: DateTimeInput;
+    after?: DateTimeInput;
+}
+export type DateSearchInput = DateTimeInput | DateRangeInput | NullCheckInput;
+export type NumberSearchInput = number | NumericComparisonInput | NullCheckInput;
+export type BoolSearchInput = boolean | NullCheckInput;
+/** Detects the `any` type, which otherwise satisfies every conditional. */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+/** True iff T is `unknown` or `any` — i.e. caller didn't constrain. */
+type IsLoose<T> = IsAny<T> extends true ? true : unknown extends T ? true : false;
+type Prim = string | number | boolean | Date;
+/**
+ * Picks the right search value shape for a single property's TS type.
+ *
+ * For string literal unions (enum-style), the value is strictly constrained
+ * to the union members — both the enum member form (`UserRoles.admin`) and the
+ * matching string literal (`"admin"`) compile. Arbitrary `string` variables
+ * are rejected at compile time; cast them if you really need to pass them.
+ */
+type SearchValueFor<V> = [
+    NonNullable<V>
+] extends [Date] ? DateSearchInput : [
+    NonNullable<V>
+] extends [string] ? [string] extends [NonNullable<V>] ? StringSearchInput : NonNullable<V> | `${NonNullable<V> & string}` | NullCheckInput : [
+    NonNullable<V>
+] extends [number] ? NumberSearchInput : [
+    NonNullable<V>
+] extends [boolean] ? BoolSearchInput : [
+    NonNullable<V>
+] extends [(infer U)[]] ? RelationFilterInput<NonNullable<U>> : [
+    NonNullable<V>
+] extends [object] ? RelationFilterInput<NonNullable<V>> : unknown;
+/**
+ * Wrapper for relation filters with explicit cardinality operators. The short
+ * form (a plain `SearchByInput`) is treated as implicit `some`.
+ *
+ *   posts: { title: "x" }                           // implicit some
+ *   posts: { some:  { title: "x" } }                // explicit some
+ *   posts: { every: { published: true } }
+ *   posts: { none:  { draft: true } }
+ *   posts: { some: { ... }, none: { ... } }         // multiple ops, AND-ed
+ */
+export type RelationFilterInput<T = unknown> = SearchByInput<T> | {
+    some?: SearchByInput<T>;
+    every?: SearchByInput<T>;
+    none?: SearchByInput<T>;
+};
+/** Keys of T whose value is a primitive (string/number/boolean/Date). */
+type FieldKeysOf<T> = {
+    [K in keyof T]-?: [NonNullable<T[K]>] extends [Prim] ? K : never;
+}[keyof T];
+/** Keys of T whose value is a relation (array of object, or object). */
+type RelationKeysOf<T> = {
+    [K in keyof T]-?: [NonNullable<T[K]>] extends [Prim] ? never : [NonNullable<T[K]>] extends [object] ? K : never;
+}[keyof T];
+/** Strips relation arrays down to their element type. */
+type RelationTargetOf<T, K extends keyof T> = [
+    NonNullable<T[K]>
+] extends [(infer U)[]] ? NonNullable<U> : [
+    NonNullable<T[K]>
+] extends [object] ? NonNullable<T[K]> : never;
+/**
+ * `searchBy` is a recursive object whose keys are field names of the current
+ * entity, relation names of the current entity, or the literal `OR`.
+ *
+ * Values depend on the kind of field:
+ *  - string field: `StringSearchInput`
+ *  - number field: `NumberSearchInput`
+ *  - boolean field: `BoolSearchInput`
+ *  - date field:   `DateSearchInput`
+ *  - relation:     a nested `SearchByInput` against the related entity
+ *
+ * The `OR` key is special: it takes an array of full `SearchByInput`s; matches
+ * if any of them matches. All non-`OR` entries combine with AND.
+ */
+export type SearchByInput<T = unknown> = IsLoose<T> extends true ? LooseSearchByInput : TypedSearchByInput<T>;
+export type LooseSearchByInput = {
+    OR?: LooseSearchByInput[];
+    [field: string]: unknown;
+};
+export type TypedSearchByInput<T> = {
+    OR?: TypedSearchByInput<T>[];
+} & {
+    [K in Exclude<keyof T, "OR"> as [NonNullable<T[K]>] extends [Prim | object] ? K : never]?: SearchValueFor<T[K]>;
+};
+export interface OrderByObjectInput<TField extends string = string> {
+    field: TField;
+    order?: SortOrder;
+}
+export type OrderByInput<T = unknown> = IsLoose<T> extends true ? string | OrderByObjectInput<string> : FieldKeysOf<T> & string extends infer F extends string ? F | OrderByObjectInput<F> : never;
+export type IncludeFieldSpec = boolean;
+export type IncludeRelationSpec<U = unknown> = IsLoose<U> extends true ? "all" | {
+    [field: string]: IncludeFieldSpec;
+} : "all" | {
+    [K in FieldKeysOf<U>]?: IncludeFieldSpec;
+};
+export type IncludeInput<T = unknown> = IsLoose<T> extends true ? "none" | "all" | {
+    [relation: string]: IncludeRelationSpec;
+} : "none" | "all" | {
+    [K in RelationKeysOf<T>]?: IncludeRelationSpec<RelationTargetOf<T, K>>;
+};
+export type SelectInput<T = unknown> = IsLoose<T> extends true ? "none" | "all" | {
+    [field: string]: boolean;
+} : "none" | "all" | {
+    [K in FieldKeysOf<T>]?: boolean;
+};
+export interface PaginationObjectInput {
+    page?: number;
+    perPage?: number;
+}
+export type PaginationInput = "all" | "first" | PaginationObjectInput;
+export interface GenQueryInput<T = unknown> {
+    orderBy?: OrderByInput<T>;
+    searchBy?: SearchByInput<T>;
+    include?: IncludeInput<T>;
+    select?: SelectInput<T>;
+    pagination?: PaginationInput;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;AACrE,MAAM,MAAM,SAAS,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEvD,gFAAgF;AAChF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,mBAAmB,CAAC;AAEzD,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yEAAyE;IACzE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,uBAAuB,GACvB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;AAE9E,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,sBAAsB,GAAG,cAAc,CAAC;AAEjF,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,cAAc,CAAC;AAOvD,2EAA2E;AAC3E,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAE/C,uEAAuE;AACvE,KAAK,OAAO,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,IAAI,GACnC,IAAI,GACJ,OAAO,SAAS,CAAC,GACf,IAAI,GACJ,KAAK,CAAC;AAEZ,KAAK,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7C;;;;;;;GAOG;AACH,KAAK,cAAc,CAAC,CAAC,IACnB;IAAC,WAAW,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,eAAe,GACjD;IAAC,WAAW,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,MAAM,CAAC,GAC7B,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC/B,iBAAiB,GACjB,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,cAAc,GAEpE;IAAC,WAAW,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,iBAAiB,GACrD;IAAC,WAAW,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,eAAe,GACpD;IAAC,WAAW,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC5E;IAAC,WAAW,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GACvE,OAAO,CAAC;AAEV;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IACvC,aAAa,CAAC,CAAC,CAAC,GAChB;IACE,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACxB,KAAK,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CACzB,CAAC;AAEN,yEAAyE;AACzE,KAAK,WAAW,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK;CACjE,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,wEAAwE;AACxE,KAAK,cAAc,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAChD,KAAK,GACL,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,GAClC,CAAC,GACD,KAAK;CACZ,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,yDAAyD;AACzD,KAAK,gBAAgB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IACxC;IAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAC1D;IAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACxD,KAAK,CAAC;AAMR;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAC5D,kBAAkB,GAClB,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE1B,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC1B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;CAC9B,GAAG;KACD,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,GAAG,MAAM,CAAC,GACvE,CAAC,GACD,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,CAAC;AAMF,MAAM,WAAW,kBAAkB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3D,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,GACnC,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,SAAS,MAAM,CAAC,SAAS,MAAM,GACpD,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC;AAMZ,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC;AAEvC,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAClE,KAAK,GAAG;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,GAEzC,KAAK,GACL;KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,gBAAgB;CAAE,CAAC;AAErD,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3D,MAAM,GAAG,KAAK,GAAG;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAA;CAAE,GAExD,MAAM,GACN,KAAK,GACL;KAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAAE,CAAC;AAMnF,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAC1D,MAAM,GAAG,KAAK,GAAG;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAEzC,MAAM,GACN,KAAK,GACL;KAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO;CAAE,CAAC;AAM5C,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,OAAO,GAAG,qBAAqB,CAAC;AAMtE,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,QAAQ,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC5B,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACxB,UAAU,CAAC,EAAE,eAAe,CAAC;CAC9B"}

package/dist/types.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * Raw input types as accepted from the wire.
+ *
+ * These mirror the spec literally. Anything received from the frontend should
+ * conform to `GenQueryInput`. Use the parser to validate + normalize into the
+ * `Parsed*` types defined in `./parsed.ts`.
+ *
+ * The input types are generic on an entity type `T`. With `T = unknown`
+ * (default) you get the loose, untyped form. Pass a concrete entity class
+ * (`GenQueryInput<User>`) to get autocomplete and value-shape checking for
+ * fields and relations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@generazioneai/genquery",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.0",
+  "description": "ORM-agnostic JSON query language with pluggable adapters (TypeORM, ...)",
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GenerazioneAI-SRL/genquery.git"
+  },
+  "homepage": "https://github.com/GenerazioneAI-SRL/genquery#readme",
+  "bugs": {
+    "url": "https://github.com/GenerazioneAI-SRL/genquery/issues"
+  },
+  "keywords": [
+    "query",
+    "query-builder",
+    "orm",
+    "typeorm",
+    "json-query",
+    "dsl",
+    "search",
+    "filter",
+    "pagination"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./typeorm": {
+      "types": "./dist/adapters/typeorm/index.d.ts",
+      "import": "./dist/adapters/typeorm/index.js",
+      "require": "./dist/adapters/typeorm/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "spec.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:dev": "tsc && rm -rf node_modules/typeorm",
+    "typecheck": "tsc --noEmit",
+    "test": "node --test dist/tests",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "typeorm": ">=0.3.0"
+  },
+  "peerDependenciesMeta": {
+    "typeorm": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "reflect-metadata": "^0.2.2",
+    "sqlite3": "^5.1.7",
+    "typeorm": "^0.3.20",
+    "typescript": "^5.4.0"
+  }
+}

package/spec.md

@@ -0,0 +1,221 @@
+# Spec
+
+This is somewhat of a "spec" that defines the query language.
+
+It's not a proper spec, more like an example than a spec, but it's fairly comprehensive.
+
+## OR
+	`|` means or in the definition, `"asc" | "desc"` means either "asc" or "desc".
+	So `string | {}` means either a string or an empty object.
+
+## Default
+	`@` means that that is a default value.
+	This means that in `"asc" | @"desc"`, `"desc"` is default if the option is not specified.
+
+## Non optional
+	`*` means that that is not an optional value, it's mandatory inside of the object it is defined into.
+
+## Array types
+	When a type is specified like this: `[type]` it means that it's an array composed of many `type`.
+
+## type definitions:
+	```json
+		offsetType: string | @"Z",
+
+		dateTimeType: string (ISO 8601) | {
+			year: int,
+			month: int,
+			day: int,
+			hours: int,
+			minutes: int,
+			seconds: int,
+			offset: offsetType
+		},
+
+		numericComparisonType: {
+			operation: ">" | "<" | ">=" | "<=" | @"=="
+			*value: number
+		},
+
+		// Presence check. Usable as the value of any primitive field
+		// (string, number, boolean, date, enum) in `searchBy`.
+		//
+		//   { isNull: true }   → IS NULL                  (NULLABLE fields only)
+		//   { isNull: false }  → IS NOT NULL              (NULLABLE fields only)
+		//   { isEmpty: true }  → IS NULL OR = ''          (STRING fields only)
+		//   { isEmpty: false } → IS NOT NULL AND <> ''    (STRING fields only)
+		//
+		// Both keys may appear in the same object; they are AND-ed. The useful
+		// combination is `{ isNull: false, isEmpty: true }` which matches rows
+		// that are not NULL but are the empty string. At least one of the two
+		// keys must be present.
+		//
+		// Constraints (rejected at parse time):
+		//  - `isNull` on a field whose schema entry has `nullable: false`
+		//    (the default) — non-nullable fields can never be NULL, so the
+		//    check is always degenerate.
+		//  - `isEmpty` on a non-string field.
+		presenceCheckType: {
+			isNull:  bool,
+			isEmpty: bool,
+		},
+	```
+
+	In the dateTimeType object when it's not an iso string all fields are optional. If not specified offset will have "Z" as default
+
+## String search modes
+
+Strings may be searched using different search modes.
+
+### Splitword (current default)
+
+Any search string will be split by whitespace and searched against every piece of the now split query.
+
+For example given this query to find a user in our table:
+
+```json
+{
+	searchBy: {
+		firstname: "mario rossi",
+		lastname: "mario rossi",
+	}
+}
+```
+
+with splitword the result of the query would include anything that respect ALL the following conditions:
+
+- firstname: is either "mario" or "rossi"
+- lastname is either "mario" or "rossi"
+
+so the following user would all be found by the query:
+```json
+[
+	{
+		firstname: "mario",
+		lastname: "mario"
+	},
+	{
+		firstname: "mario",
+		lastname: "rossi"
+	},
+	{
+		firstname: "rossi",
+		lastname: "rossi"
+	},
+	{
+		firstname: "rossi",
+		lastname: "mario"
+	}
+]
+```
+
+Of course here `firstname` and `lastname` are the same but this might not always be the case.
+
+### exact
+
+Just as it sounds, the string that is specified is the string that gets found, nothing more, nothing less.
+
+### nativeregex
+
+A string is searched against a specified regex. The regex is in the language natively supported by the ORM or the database, so no kind of processing is done on it.
+
+# example:
+```json
+{
+	orderBy: string | { // if orderBy is a string then default order is "desc" just as described below
+
+		*field: string, // field: nameOfTheFieldToPerformSortingOperationsOn
+		order: "asc" | @"desc",
+
+	},
+
+	searchBy: {
+
+		// Any primitive field (string, number, boolean, date, enum) accepts
+		// `presenceCheckType` as an alternative value. `isEmpty` inside it is
+		// string-only — passing it on a non-string field is rejected.
+
+		// string
+
+
+		exampleStringField: string | presenceCheckType | { // when only a string is specified, default values apply here
+			mode: @"splitword" | "exact" | "nativeregex"
+
+			contained: true | @false, // This means that the query should match as part of a string, so "something" would also match "somethingelse"
+
+			caseSensitive: true | @false, // When false (default), comparison is case-insensitive. Applies to all modes including nativeregex.
+
+			*value: "something", // a value
+		},
+
+		firstname: "mario rossi",
+		lastname: "mario rossi", // remember splitword
+
+		fiscalCode: {
+			type: "exact"
+			value: "AFISCALCODE123"
+		},
+
+		// date
+
+		date: dateTimeType | presenceCheckType | { before: dateTimeType, after: dateTimeType }, // either before or after can be omitted from the object
+
+		// relations
+
+		// Implicit `some` — matches if at least one related row satisfies the filter.
+		relationName: {
+			otherField: "lorem ipsum"
+		},
+
+		// Explicit cardinality operators. `some` / `every` / `none` can appear
+		// alone or combined (multiple ops are AND-ed). Equivalent to Prisma's
+		// relation filters.
+		relationName: {
+			some:  { otherField: "x" },
+			every: { published: true },
+			none:  { draft: true }
+		},
+
+		// bool
+
+		exampleBoolField: true | presenceCheckType,
+
+		// number
+
+		exampleNumberField: number | presenceCheckType | {
+			operation: ">" | "<" | ">=" | "<=" | @"==",
+			*value: number
+		},
+
+		// enum
+
+		// An enum field must be a string value that matches one of the allowed
+		// values declared in the schema. The parser rejects anything else.
+		exampleEnumField: "allowedValue1" | "allowedValue2" | ... | presenceCheckType,
+
+		// OR
+
+		OR: [
+			searchBy, // recursive
+			searchBy, // here all the searchBy(s) are evaluated similar to prisma's OR
+			searchBy,
+		]
+	},
+
+	include: @"none" | "all" | { // which relations to include in the query result
+		relationField: {
+			firstname: true // only firstname will be included from relationField
+		},
+		otherRelation: "all", // all fields will be included from otherRelation
+	},
+
+	select: "none" | @"all" |  { // which fields to include in the query result
+		someField: true, // only field 'someField' will be included in the query this way
+	},
+
+	pagination: @"all" | "first" | { // using first makes this a "findFirst" type query, equivalent to page: 0 and perPage: 1.
+		page: int | @0,
+		perPage: int | @20,
+	}
+}
+```