@nest-boot/graphql-connection 7.6.0 → 7.6.2

package/dist/types/connection-class.type.d.ts

@@ -1,3 +1,21 @@
 import { Type } from "@nestjs/common";
 import { ConnectionInterface } from "../interfaces";
+/**
+ * Type alias for a Connection class type.
+ *
+ * This is used to reference Connection classes generated by ConnectionBuilder.build()
+ * in type annotations for ConnectionManager.find() and similar methods.
+ *
+ * @typeParam T - The entity type for the connection
+ *
+ * @example
+ * ```typescript
+ * const UserConnection: ConnectionClass<User> = new ConnectionBuilder(User)
+ *   .addField({ field: "name", type: "string" })
+ *   .build().Connection;
+ *
+ * // Use in ConnectionManager
+ * const result = await connectionManager.find(UserConnection, args);
+ * ```
+ */
 export type ConnectionClass<T> = Type<ConnectionInterface<T>>;

package/dist/types/field-options.type.d.ts

@@ -1,12 +1,82 @@
 import type { FieldType, ReplacementCallbackFieldOptions as FilterReplacementCallbackFieldOptions, ReplacementFieldOptions as FilterReplacementFieldOptions, SimpleFieldOptions as FilterSimpleFieldOptions } from "mikro-orm-filter-query-schema";
+/**
+ * Base options shared by all field types.
+ */
 export interface BaseFieldOptions {
+    /**
+     * Whether this field can be used in filter queries.
+     * @default true
+     */
     filterable?: boolean;
+    /**
+     * Whether this field is included in text search queries.
+     * Only applicable to string fields.
+     */
     searchable?: boolean;
 }
+/**
+ * Options for fields that can be sorted.
+ */
 export interface SortableFieldOptions {
+    /**
+     * Whether this field can be used for ordering results.
+     * When true, the field will be included in the OrderField enum.
+     */
     sortable?: boolean;
 }
+/**
+ * Options for a simple field with direct entity property mapping.
+ *
+ * @typeParam Entity - The entity type
+ * @typeParam Type - The field type ("string", "number", "boolean", or "date")
+ */
 export type SimpleFieldOptions<Entity extends object, Type extends FieldType = never> = FilterSimpleFieldOptions<Entity, Type> & BaseFieldOptions & SortableFieldOptions;
+/**
+ * Options for a field with a replacement property path.
+ *
+ * Use this when the GraphQL field name differs from the entity property path.
+ *
+ * @typeParam Entity - The entity type
+ * @typeParam Type - The field type
+ * @typeParam Field - The GraphQL field name
+ */
 export type ReplacementFieldOptions<Entity extends object, Type extends FieldType = never, Field extends string = never> = FilterReplacementFieldOptions<Entity, Type, Field> & BaseFieldOptions & SortableFieldOptions;
+/**
+ * Options for a field with a replacement callback function.
+ *
+ * Use this for complex field mappings that require runtime logic.
+ *
+ * @typeParam Entity - The entity type
+ * @typeParam Type - The field type
+ */
 export type ReplacementFunctionFieldOptions<Entity extends object, Type extends FieldType = never> = FilterReplacementCallbackFieldOptions<Entity, Type> & BaseFieldOptions & SortableFieldOptions;
+/**
+ * Union type of all field option types.
+ *
+ * This is the type used when adding fields to a ConnectionBuilder.
+ *
+ * @typeParam Entity - The entity type
+ * @typeParam Type - The field type
+ * @typeParam Field - The GraphQL field name (for replacement options)
+ *
+ * @example Simple field
+ * ```typescript
+ * const options: FieldOptions<User, "string"> = {
+ *   field: "name",
+ *   type: "string",
+ *   filterable: true,
+ *   sortable: true,
+ * };
+ * ```
+ *
+ * @example Replacement field
+ * ```typescript
+ * const options: FieldOptions<User, "string", "authorName"> = {
+ *   field: "authorName",
+ *   type: "string",
+ *   replacement: "author.name",
+ *   filterable: true,
+ * };
+ * ```
+ */
 export type FieldOptions<Entity extends object, Type extends FieldType = never, Field extends string = never> = SimpleFieldOptions<Entity, Type> | ReplacementFieldOptions<Entity, Type, Field> | ReplacementFunctionFieldOptions<Entity, Type>;

package/dist/utils/create-connection-args.d.ts

@@ -3,4 +3,23 @@ import { type Type } from "@nestjs/common";
 import { GraphQLScalarType } from "graphql";
 import type { FieldType } from "mikro-orm-filter-query-schema";
 import { ConnectionArgsInterface, FieldOptions, OrderInterface } from "../interfaces";
+/**
+ * Creates a GraphQL Args type for connection queries.
+ *
+ * The generated Args type includes:
+ * - `first`/`last`: Number of items to return (for forward/backward pagination)
+ * - `after`/`before`: Cursor for pagination position
+ * - `query`: Search query string
+ * - `filter`: MongoDB-style filter query
+ * - `orderBy`: Sorting options
+ *
+ * @typeParam Entity - The entity type being queried
+ * @param entityName - The name to use for the GraphQL type
+ * @param fieldOptionsMap - Map of field configurations
+ * @param OrderClass - The Order input type class
+ * @param FilterScalar - The Filter scalar type
+ * @returns A class implementing ConnectionArgsInterface
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 export declare function createConnectionArgs<Entity extends object>(entityName: string, fieldOptionsMap: Map<string, FieldOptions<Entity, FieldType, string>>, OrderClass: Type<OrderInterface<Entity>>, FilterScalar: GraphQLScalarType<FilterQuery<Entity>>): Type<ConnectionArgsInterface<Entity>>;

package/dist/utils/create-connection-args.js

@@ -12,6 +12,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createConnectionArgs = createConnectionArgs;
 const graphql_1 = require("@nest-boot/graphql");
 const inflection_1 = require("inflection");
+/**
+ * Creates a GraphQL Args type for connection queries.
+ *
+ * The generated Args type includes:
+ * - `first`/`last`: Number of items to return (for forward/backward pagination)
+ * - `after`/`before`: Cursor for pagination position
+ * - `query`: Search query string
+ * - `filter`: MongoDB-style filter query
+ * - `orderBy`: Sorting options
+ *
+ * @typeParam Entity - The entity type being queried
+ * @param entityName - The name to use for the GraphQL type
+ * @param fieldOptionsMap - Map of field configurations
+ * @param OrderClass - The Order input type class
+ * @param FilterScalar - The Filter scalar type
+ * @returns A class implementing ConnectionArgsInterface
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 function createConnectionArgs(entityName, fieldOptionsMap, OrderClass, FilterScalar) {
     const humanizeAndPluralizeEntityName = (0, inflection_1.pluralize)((0, inflection_1.humanize)(entityName, true));
     const filterableFields = [...fieldOptionsMap.values()].filter((field) => field.filterable);

package/dist/utils/create-connection-args.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-connection-args.js","sourceRoot":"","sources":["../../src/utils/create-connection-args.ts"],"names":[],"mappings":";;;;;;;;;;;AAaA,oDAkEC;AA9ED,gDAA0D;AAG1D,2CAAiD;AASjD,SAAgB,oBAAoB,CAClC,UAAkB,EAClB,eAAqE,EACrE,UAAwC,EACxC,YAAoD;IAEpD,MAAM,8BAA8B,GAAG,IAAA,sBAAS,EAAC,IAAA,qBAAQ,EAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7E,MAAM,gBAAgB,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC3D,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAC5B,CAAC;IAGF,IAAM,cAAc,GAApB,MAAM,cAAc;KAkDnB,CAAA;IAvCC;QAVC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,QAAQ,EAAE,IAAI;YACd,GAAG,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;gBAC7B,CAAC,CAAC;oBACE,WAAW,EAAE,8EAA8E,gBAAgB;yBACxG,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;yBAClC,IAAI,CAAC,IAAI,CAAC,EAAE;iBAChB;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;;iDACa;IAOf;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,YAAY,EAAE;YACzB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,UAAU,8BAA8B,8BAA8B;SACpF,CAAC;;kDAC2B;IAM7B;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,EAAE;YAChB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qDAAqD;SACnE,CAAC;;iDACa;IAMf;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,EAAE;YAChB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,oDAAoD;SAClE,CAAC;;gDACY;IAMd;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,WAAW,EAAE,4DAA4D;YACzE,QAAQ,EAAE,IAAI;SACf,CAAC;;iDACa;IAMf;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,WAAW,EAAE,6DAA6D;YAC1E,QAAQ,EAAE,IAAI;SACf,CAAC;;kDACc;IAOhB;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,UAAU,EAAE;YACvB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qCAAqC,8BAA8B,GAAG;SACpF,CAAC;;mDAC+B;IAjD7B,cAAc;QADnB,IAAA,kBAAQ,EAAC,GAAG,UAAU,gBAAgB,CAAC;OAClC,cAAc,CAkDnB;IAED,OAAO,cAAc,CAAC;AACxB,CAAC"}
+{"version":3,"file":"create-connection-args.js","sourceRoot":"","sources":["../../src/utils/create-connection-args.ts"],"names":[],"mappings":";;;;;;;;;;;AAgCA,oDAkEC;AAjGD,gDAA0D;AAG1D,2CAAiD;AASjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,oBAAoB,CAClC,UAAkB,EAClB,eAAqE,EACrE,UAAwC,EACxC,YAAoD;IAEpD,MAAM,8BAA8B,GAAG,IAAA,sBAAS,EAAC,IAAA,qBAAQ,EAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7E,MAAM,gBAAgB,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC3D,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAC5B,CAAC;IAGF,IAAM,cAAc,GAApB,MAAM,cAAc;KAkDnB,CAAA;IAvCC;QAVC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,QAAQ,EAAE,IAAI;YACd,GAAG,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC;gBAC7B,CAAC,CAAC;oBACE,WAAW,EAAE,8EAA8E,gBAAgB;yBACxG,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;yBAClC,IAAI,CAAC,IAAI,CAAC,EAAE;iBAChB;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;;iDACa;IAOf;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,YAAY,EAAE;YACzB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,UAAU,8BAA8B,8BAA8B;SACpF,CAAC;;kDAC2B;IAM7B;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,EAAE;YAChB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qDAAqD;SACnE,CAAC;;iDACa;IAMf;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,EAAE;YAChB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,oDAAoD;SAClE,CAAC;;gDACY;IAMd;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,WAAW,EAAE,4DAA4D;YACzE,QAAQ,EAAE,IAAI;SACf,CAAC;;iDACa;IAMf;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,WAAW,EAAE,6DAA6D;YAC1E,QAAQ,EAAE,IAAI;SACf,CAAC;;kDACc;IAOhB;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,UAAU,EAAE;YACvB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qCAAqC,8BAA8B,GAAG;SACpF,CAAC;;mDAC+B;IAjD7B,cAAc;QADnB,IAAA,kBAAQ,EAAC,GAAG,UAAU,gBAAgB,CAAC;OAClC,cAAc,CAkDnB;IAED,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/dist/utils/create-connection.d.ts

@@ -3,4 +3,22 @@ import { type Type } from "@nestjs/common";
 import type { FieldType } from "mikro-orm-filter-query-schema";
 import type { ZodType } from "zod";
 import { ConnectionInterface, EdgeInterface, FieldOptions } from "../interfaces";
+/**
+ * Creates a GraphQL Connection type for cursor-based pagination.
+ *
+ * The generated Connection type includes:
+ * - `edges`: List of edges containing nodes and cursors
+ * - `pageInfo`: Pagination information (hasNextPage, hasPreviousPage, cursors)
+ * - `totalCount`: Total number of items matching the query
+ *
+ * @typeParam Entity - The entity type for the connection
+ * @param entityClass - The MikroORM entity class
+ * @param entityName - The name to use for the GraphQL type
+ * @param EdgeClass - The Edge type class to use for edges
+ * @param fieldOptionsMap - Map of field configurations
+ * @param filterQuerySchema - Zod schema for validating filter queries
+ * @returns A class implementing ConnectionInterface
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 export declare function createConnection<Entity extends object>(entityClass: EntityClass<Entity>, entityName: string, EdgeClass: Type<EdgeInterface<Entity>>, fieldOptionsMap: Map<string, FieldOptions<Entity, FieldType, string>>, filterQuerySchema: ZodType<FilterQuery<Entity>>): Type<ConnectionInterface<Entity>>;

package/dist/utils/create-connection.js

@@ -14,6 +14,24 @@ const graphql_1 = require("@nest-boot/graphql");
 const inflection_1 = require("inflection");
 const graphql_connection_constants_1 = require("../graphql-connection.constants");
 const objects_1 = require("../objects");
+/**
+ * Creates a GraphQL Connection type for cursor-based pagination.
+ *
+ * The generated Connection type includes:
+ * - `edges`: List of edges containing nodes and cursors
+ * - `pageInfo`: Pagination information (hasNextPage, hasPreviousPage, cursors)
+ * - `totalCount`: Total number of items matching the query
+ *
+ * @typeParam Entity - The entity type for the connection
+ * @param entityClass - The MikroORM entity class
+ * @param entityName - The name to use for the GraphQL type
+ * @param EdgeClass - The Edge type class to use for edges
+ * @param fieldOptionsMap - Map of field configurations
+ * @param filterQuerySchema - Zod schema for validating filter queries
+ * @returns A class implementing ConnectionInterface
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 function createConnection(entityClass, entityName, EdgeClass, fieldOptionsMap, filterQuerySchema) {
     const pluralizeEntityName = (0, inflection_1.pluralize)(entityName);
     let Connection = class Connection {

package/dist/utils/create-connection.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-connection.js","sourceRoot":"","sources":["../../src/utils/create-connection.ts"],"names":[],"mappings":";;;;;;;;;;;AAgBA,4CAwCC;AAvDD,gDAA4D;AAE5D,2CAAuC;AAIvC,kFAA8E;AAO9E,wCAAsC;AAEtC,SAAgB,gBAAgB,CAC9B,WAAgC,EAChC,UAAkB,EAClB,SAAsC,EACtC,eAAqE,EACrE,iBAA+C;IAE/C,MAAM,mBAAmB,GAAG,IAAA,sBAAS,EAAC,UAAU,CAAC,CAAC;IAWlD,IAAM,UAAU,GAAhB,MAAM,UAAU;KAmBf,CAAA;IAbC;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE;YACxB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,kBAAkB;SAChC,CAAC;;6CAC8B;IAMhC;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,kBAAQ,EAAE;YACrB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,mCAAmC;SACjD,CAAC;kCACS,kBAAQ;gDAAC;IAMpB;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,EAAE;YAChB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,wDAAwD;SACtE,CAAC;;kDACkB;IAlBhB,UAAU;QATf,OAAO,CAAC,QAAQ,CAAC,0DAA2B,EAAE;YAC7C,WAAW;YACX,eAAe;YACf,iBAAiB;SACmB,CAAC;QACtC,IAAA,oBAAU,EAAC,GAAG,UAAU,YAAY,EAAE;YACrC,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,0DAA0D,mBAAmB,GAAG;SAC9F,CAAC;OACI,UAAU,CAmBf;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}
+{"version":3,"file":"create-connection.js","sourceRoot":"","sources":["../../src/utils/create-connection.ts"],"names":[],"mappings":";;;;;;;;;;;AAkCA,4CAwCC;AAzED,gDAA4D;AAE5D,2CAAuC;AAIvC,kFAA8E;AAO9E,wCAAsC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,gBAAgB,CAC9B,WAAgC,EAChC,UAAkB,EAClB,SAAsC,EACtC,eAAqE,EACrE,iBAA+C;IAE/C,MAAM,mBAAmB,GAAG,IAAA,sBAAS,EAAC,UAAU,CAAC,CAAC;IAWlD,IAAM,UAAU,GAAhB,MAAM,UAAU;KAmBf,CAAA;IAbC;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE;YACxB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,kBAAkB;SAChC,CAAC;;6CAC8B;IAMhC;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,kBAAQ,EAAE;YACrB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,mCAAmC;SACjD,CAAC;kCACS,kBAAQ;gDAAC;IAMpB;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,EAAE;YAChB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,wDAAwD;SACtE,CAAC;;kDACkB;IAlBhB,UAAU;QATf,OAAO,CAAC,QAAQ,CAAC,0DAA2B,EAAE;YAC7C,WAAW;YACX,eAAe;YACf,iBAAiB;SACmB,CAAC;QACtC,IAAA,oBAAU,EAAC,GAAG,UAAU,YAAY,EAAE;YACrC,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,0DAA0D,mBAAmB,GAAG;SAC9F,CAAC;OACI,UAAU,CAmBf;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/utils/create-edge.d.ts

@@ -1,4 +1,18 @@
 import type { EntityClass } from "@mikro-orm/core";
 import { type Type } from "@nestjs/common";
 import { EdgeInterface } from "../interfaces";
+/**
+ * Creates a GraphQL Edge type for a connection.
+ *
+ * An Edge type contains:
+ * - `node`: The actual entity item
+ * - `cursor`: A string cursor for pagination
+ *
+ * @typeParam Entity - The entity type for the edge
+ * @param entityClass - The MikroORM entity class (used as the node type)
+ * @param entityName - The name to use for the GraphQL type
+ * @returns A class implementing EdgeInterface
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 export declare function createEdge<Entity extends object>(entityClass: EntityClass<Entity>, entityName: string): Type<EdgeInterface<Entity>>;

package/dist/utils/create-edge.js

@@ -11,6 +11,20 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createEdge = createEdge;
 const graphql_1 = require("@nest-boot/graphql");
+/**
+ * Creates a GraphQL Edge type for a connection.
+ *
+ * An Edge type contains:
+ * - `node`: The actual entity item
+ * - `cursor`: A string cursor for pagination
+ *
+ * @typeParam Entity - The entity type for the edge
+ * @param entityClass - The MikroORM entity class (used as the node type)
+ * @param entityName - The name to use for the GraphQL type
+ * @returns A class implementing EdgeInterface
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 function createEdge(entityClass, entityName) {
     let Edge = class Edge {
     };

package/dist/utils/create-edge.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-edge.js","sourceRoot":"","sources":["../../src/utils/create-edge.ts"],"names":[],"mappings":";;;;;;;;;;;AAMA,gCAsBC;AA3BD,gDAAuD;AAKvD,SAAgB,UAAU,CACxB,WAAgC,EAChC,UAAkB;IAKlB,IAAM,IAAI,GAAV,MAAM,IAAI;KAYT,CAAA;IAPC;QAHC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,WAAW,EAAE;YACxB,WAAW,EAAE,0BAA0B,UAAU,OAAO;SACzD,CAAC;;sCACY;IAMd;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,iCAAiC;SAC/C,CAAC;;wCACc;IAXZ,IAAI;QAHT,IAAA,oBAAU,EAAC,GAAG,UAAU,MAAM,EAAE;YAC/B,WAAW,EAAE,0CAA0C,UAAU,kCAAkC;SACpG,CAAC;OACI,IAAI,CAYT;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"create-edge.js","sourceRoot":"","sources":["../../src/utils/create-edge.ts"],"names":[],"mappings":";;;;;;;;;;;AAoBA,gCAsBC;AAzCD,gDAAuD;AAKvD;;;;;;;;;;;;;GAaG;AACH,SAAgB,UAAU,CACxB,WAAgC,EAChC,UAAkB;IAKlB,IAAM,IAAI,GAAV,MAAM,IAAI;KAYT,CAAA;IAPC;QAHC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,WAAW,EAAE;YACxB,WAAW,EAAE,0BAA0B,UAAU,OAAO;SACzD,CAAC;;sCACY;IAMd;QAJC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,EAAE;YACnB,UAAU,EAAE,CAAC;YACb,WAAW,EAAE,iCAAiC;SAC/C,CAAC;;wCACc;IAXZ,IAAI;QAHT,IAAA,oBAAU,EAAC,GAAG,UAAU,MAAM,EAAE;YAC/B,WAAW,EAAE,0CAA0C,UAAU,kCAAkC;SACpG,CAAC;OACI,IAAI,CAYT;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/utils/create-filter.d.ts

@@ -2,9 +2,39 @@ import { FilterQuery } from "@mikro-orm/core";
 import { GraphQLScalarType } from "graphql";
 import { FieldType, FilterOptions, FilterQuerySchemaBuilder } from "mikro-orm-filter-query-schema";
 import { FieldOptions } from "../interfaces";
+/**
+ * The Zod schema type returned by FilterQuerySchemaBuilder.
+ *
+ * @typeParam Entity - The entity type for the filter
+ */
 export type FilterQuerySchema<Entity extends object> = ReturnType<FilterQuerySchemaBuilder<Entity>["build"]>;
+/**
+ * The result of creating a filter scalar and schema.
+ *
+ * @typeParam Entity - The entity type for the filter
+ */
 export interface CreateFilterResult<Entity extends object> {
+    /**
+     * The GraphQL scalar type for the filter.
+     */
     Filter: GraphQLScalarType<FilterQuery<Entity>>;
+    /**
+     * The Zod schema for validating filter queries.
+     */
     filterQuerySchema: FilterQuerySchema<Entity>;
 }
+/**
+ * Creates a GraphQL Filter scalar type and validation schema.
+ *
+ * The Filter scalar accepts MongoDB-style query syntax and validates
+ * it against the configured field options.
+ *
+ * @typeParam Entity - The entity type being filtered
+ * @param entityName - The name to use for the GraphQL scalar
+ * @param fieldOptionsMap - Map of field configurations
+ * @param filterOptions - Options for filter complexity limits
+ * @returns An object containing the Filter scalar and filterQuerySchema
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 export declare function createFilter<Entity extends object>(entityName: string, fieldOptionsMap: Map<string, FieldOptions<Entity, FieldType, string>>, filterOptions?: FilterOptions): CreateFilterResult<Entity>;

package/dist/utils/create-filter.js

@@ -40,6 +40,20 @@ function parseLiteralValue(ast) {
             throw new Error(`Unexpected AST kind: ${ast.kind}`);
     }
 }
+/**
+ * Creates a GraphQL Filter scalar type and validation schema.
+ *
+ * The Filter scalar accepts MongoDB-style query syntax and validates
+ * it against the configured field options.
+ *
+ * @typeParam Entity - The entity type being filtered
+ * @param entityName - The name to use for the GraphQL scalar
+ * @param fieldOptionsMap - Map of field configurations
+ * @param filterOptions - Options for filter complexity limits
+ * @returns An object containing the Filter scalar and filterQuerySchema
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 function createFilter(entityName, fieldOptionsMap, filterOptions) {
     const filterableFields = [...fieldOptionsMap.values()]
         .filter((field) => field.filterable !== false)

package/dist/utils/create-filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-filter.js","sourceRoot":"","sources":["../../src/utils/create-filter.ts"],"names":[],"mappings":";;AA0DA,oCAoCC;AA7FD,qCAA6D;AAC7D,iFAKuC;AAQvC,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAc;IACvC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,cAAI,CAAC,MAAM,CAAC;QACjB,KAAK,cAAI,CAAC,IAAI;YACZ,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,KAAK,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACjB,MAAM,GAAG,GAA4B,EAAE,CAAC;YACxC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC/B,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,KAAK,cAAI,CAAC,IAAI;YACZ,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC3C,KAAK,cAAI,CAAC,GAAG;YACX,OAAO,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjC,KAAK,cAAI,CAAC,KAAK;YACb,OAAO,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,cAAI,CAAC,OAAO;YACf,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,KAAK,cAAI,CAAC,IAAI;YACZ,OAAO,IAAI,CAAC;QACd;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;AACH,CAAC;AAOD,SAAgB,YAAY,CAC1B,UAAkB,EAClB,eAAqE,EACrE,aAA6B;IAE7B,MAAM,gBAAgB,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;SACnD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC;SAC7C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE/B,MAAM,OAAO,GAAG,IAAI,wDAAwB,CAAS,aAAa,CAAC,CAAC;IAEpE,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,eAAe,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YACjC,OAAO,CAAC,QAAQ,CACd,OAAwD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAE1C,MAAM,MAAM,GAAG,IAAI,2BAAiB,CAAsB;QACxD,IAAI,EAAE,GAAG,UAAU,QAAQ;QAC3B,WAAW,EAAE,gBAAgB,UAAU,0DAA0D,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAC9H,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAA4B;QAClD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAChC,OAAO,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AACvC,CAAC"}
+{"version":3,"file":"create-filter.js","sourceRoot":"","sources":["../../src/utils/create-filter.ts"],"names":[],"mappings":";;AAyFA,oCAoCC;AA5HD,qCAA6D;AAC7D,iFAKuC;AAavC,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAc;IACvC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,cAAI,CAAC,MAAM,CAAC;QACjB,KAAK,cAAI,CAAC,IAAI;YACZ,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,KAAK,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACjB,MAAM,GAAG,GAA4B,EAAE,CAAC;YACxC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC/B,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,KAAK,cAAI,CAAC,IAAI;YACZ,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC3C,KAAK,cAAI,CAAC,GAAG;YACX,OAAO,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjC,KAAK,cAAI,CAAC,KAAK;YACb,OAAO,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,cAAI,CAAC,OAAO;YACf,OAAO,GAAG,CAAC,KAAK,CAAC;QACnB,KAAK,cAAI,CAAC,IAAI;YACZ,OAAO,IAAI,CAAC;QACd;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;AACH,CAAC;AAmBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,YAAY,CAC1B,UAAkB,EAClB,eAAqE,EACrE,aAA6B;IAE7B,MAAM,gBAAgB,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;SACnD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC;SAC7C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE/B,MAAM,OAAO,GAAG,IAAI,wDAAwB,CAAS,aAAa,CAAC,CAAC;IAEpE,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,eAAe,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YACjC,OAAO,CAAC,QAAQ,CACd,OAAwD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAE1C,MAAM,MAAM,GAAG,IAAI,2BAAiB,CAAsB;QACxD,IAAI,EAAE,GAAG,UAAU,QAAQ;QAC3B,WAAW,EAAE,gBAAgB,UAAU,0DAA0D,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAC9H,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAA4B;QAClD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAChC,OAAO,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AACvC,CAAC"}

package/dist/utils/create-order.d.ts

@@ -1,8 +1,35 @@
 import { type Type } from "@nestjs/common";
 import type { FieldType } from "mikro-orm-filter-query-schema";
 import { FieldOptions, OrderFieldType, OrderInterface } from "../interfaces";
+/**
+ * The result of creating order types.
+ *
+ * @typeParam Entity - The entity type for ordering
+ */
 export interface CreateOrderResult<Entity extends object> {
+    /**
+     * The Order input type class.
+     */
     Order: Type<OrderInterface<Entity>>;
+    /**
+     * The OrderField enum object mapping field keys to paths.
+     */
     OrderField: OrderFieldType<Entity>;
 }
+/**
+ * Creates GraphQL Order input type and OrderField enum.
+ *
+ * The Order type allows specifying:
+ * - `field`: Which field to order by (from the OrderField enum)
+ * - `direction`: ASC or DESC
+ *
+ * Only fields marked as `sortable: true` in field options are included.
+ *
+ * @typeParam Entity - The entity type being ordered
+ * @param entityName - The name to use for the GraphQL types
+ * @param fieldOptionsMap - Map of field configurations
+ * @returns An object containing the Order class and OrderField enum
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 export declare function createOrder<Entity extends object>(entityName: string, fieldOptionsMap: Map<string, FieldOptions<Entity, FieldType, string>>): CreateOrderResult<Entity>;

package/dist/utils/create-order.js

@@ -13,6 +13,22 @@ exports.createOrder = createOrder;
 const graphql_1 = require("@nest-boot/graphql");
 const inflection_1 = require("inflection");
 const enums_1 = require("../enums");
+/**
+ * Creates GraphQL Order input type and OrderField enum.
+ *
+ * The Order type allows specifying:
+ * - `field`: Which field to order by (from the OrderField enum)
+ * - `direction`: ASC or DESC
+ *
+ * Only fields marked as `sortable: true` in field options are included.
+ *
+ * @typeParam Entity - The entity type being ordered
+ * @param entityName - The name to use for the GraphQL types
+ * @param fieldOptionsMap - Map of field configurations
+ * @returns An object containing the Order class and OrderField enum
+ *
+ * @internal Used by ConnectionBuilder.build()
+ */
 function createOrder(entityName, fieldOptionsMap) {
     const humanizeEntityName = (0, inflection_1.humanize)(entityName, true);
     const humanizeAndPluralizeEntityName = (0, inflection_1.pluralize)((0, inflection_1.humanize)(entityName, true));

package/dist/utils/create-order.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-order.js","sourceRoot":"","sources":["../../src/utils/create-order.ts"],"names":[],"mappings":";;;;;;;;;;;AAmBA,kCA2CC;AA9DD,gDAAwE;AAExE,2CAA6D;AAG7D,oCAA0C;AAc1C,SAAgB,WAAW,CACzB,UAAkB,EAClB,eAAqE;IAErE,MAAM,kBAAkB,GAAG,IAAA,qBAAQ,EAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACtD,MAAM,8BAA8B,GAAG,IAAA,sBAAS,EAAC,IAAA,qBAAQ,EAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7E,MAAM,cAAc,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CACzD,CAAC,KAAK,EAAE,EAAE,CAAE,KAA8B,EAAE,QAAQ,CACrD,CAAC;IAEF,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CACtC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;QACvB,OAAO;YACL,GAAG,MAAM;YACT,CAAC,IAAA,uBAAU,EAAC,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,EAC3C,YAAyC,CAAC,WAAW;gBACtD,YAAY,CAAC,KAAK;SACrB,CAAC;IACJ,CAAC,EACD,EAAE,EAAE,EAAE,IAAI,EAAuC,CAClD,CAAC;IAEF,IAAA,0BAAgB,EAAC,UAAU,EAAE;QAC3B,IAAI,EAAE,GAAG,UAAU,YAAY;QAC/B,WAAW,EAAE,uBAAuB,kBAAkB,8BAA8B;KACrF,CAAC,CAAC;IAKH,IAAM,KAAK,GAAX,MAAM,KAAK;KASV,CAAA;IAJC;QAHC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,UAAoB,EAAE;YACjC,WAAW,EAAE,sBAAsB,8BAA8B,MAAM;SACxE,CAAC;;wCAC4B;IAG9B;QADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,sBAAc,EAAE,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;;4CAC7C;IARvB,KAAK;QAHV,IAAA,mBAAS,EAAC,GAAG,UAAU,OAAO,EAAE;YAC/B,WAAW,EAAE,wBAAwB,kBAAkB,cAAc;SACtE,CAAC;OACI,KAAK,CASV;IAED,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAC/B,CAAC"}
+{"version":3,"file":"create-order.js","sourceRoot":"","sources":["../../src/utils/create-order.ts"],"names":[],"mappings":";;;;;;;;;;;AA+CA,kCA2CC;AA1FD,gDAAwE;AAExE,2CAA6D;AAG7D,oCAA0C;AA0B1C;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,WAAW,CACzB,UAAkB,EAClB,eAAqE;IAErE,MAAM,kBAAkB,GAAG,IAAA,qBAAQ,EAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACtD,MAAM,8BAA8B,GAAG,IAAA,sBAAS,EAAC,IAAA,qBAAQ,EAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7E,MAAM,cAAc,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CACzD,CAAC,KAAK,EAAE,EAAE,CAAE,KAA8B,EAAE,QAAQ,CACrD,CAAC;IAEF,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CACtC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;QACvB,OAAO;YACL,GAAG,MAAM;YACT,CAAC,IAAA,uBAAU,EAAC,YAAY,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,EAC3C,YAAyC,CAAC,WAAW;gBACtD,YAAY,CAAC,KAAK;SACrB,CAAC;IACJ,CAAC,EACD,EAAE,EAAE,EAAE,IAAI,EAAuC,CAClD,CAAC;IAEF,IAAA,0BAAgB,EAAC,UAAU,EAAE;QAC3B,IAAI,EAAE,GAAG,UAAU,YAAY;QAC/B,WAAW,EAAE,uBAAuB,kBAAkB,8BAA8B;KACrF,CAAC,CAAC;IAKH,IAAM,KAAK,GAAX,MAAM,KAAK;KASV,CAAA;IAJC;QAHC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,UAAoB,EAAE;YACjC,WAAW,EAAE,sBAAsB,8BAA8B,MAAM;SACxE,CAAC;;wCAC4B;IAG9B;QADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,sBAAc,EAAE,EAAE,WAAW,EAAE,yBAAyB,EAAE,CAAC;;4CAC7C;IARvB,KAAK;QAHV,IAAA,mBAAS,EAAC,GAAG,UAAU,OAAO,EAAE;YAC/B,WAAW,EAAE,wBAAwB,kBAAkB,cAAc;SACtE,CAAC;OACI,KAAK,CASV;IAED,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAC/B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nest-boot/graphql-connection",
-  "version": "7.6.0",
+  "version": "7.6.2",
   "description": "",
   "author": "d4rkcr0w <me@d4rkcr0w.com>",
   "homepage": "",
@@ -17,7 +17,7 @@
     "inflection": "^3.0.2",
     "lodash": "^4.17.21",
     "mikro-orm-filter-query-schema": "^1.1.0",
-    "search-syntax": "^3.5.0",
+    "search-syntax": "^3.6.0",
     "zod": "^4.1.13"
   },
   "devDependencies": {
@@ -41,9 +41,9 @@
     "ts-jest": "^29.4.4",
     "typescript": "^5.9.3",
     "@nest-boot/eslint-config": "^7.0.2",
-    "@nest-boot/eslint-plugin": "^7.0.2",
-    "@nest-boot/graphql": "^7.1.1",
-    "@nest-boot/tsconfig": "^7.0.0"
+    "@nest-boot/eslint-plugin": "^7.0.3",
+    "@nest-boot/graphql": "^7.1.2",
+    "@nest-boot/tsconfig": "^7.0.1"
   },
   "peerDependencies": {
     "@mikro-orm/core": "^6.0.0",