@jsonapi-serde/server 1.0.0 → 1.0.1

package/dist/request/query.d.ts

@@ -7,15 +7,15 @@ import { type SearchParamsInput } from "../http/index.js";
  *
  * Defines which related resources are allowed in an `include` request.
  */
-export type ParseQueryIncludeOptions<TInclude extends string> = {
+export type ParseQueryIncludeOptions<TInclude extends readonly string[] | undefined> = {
     /**
      * Allowed include-paths (e.g., "author", "comments.author")
      *
      * Allowing "comments" automatically allows "comments.author".
      */
-    allowed: TInclude[];
+    allowed: TInclude;
     /** Default include-paths if none are provided in the query */
-    default?: string[];
+    default?: TInclude extends readonly string[] ? ParentPaths<TInclude[number]>[] : undefined;
 };
 /**
  * Represents a sortable field and its sort direction
@@ -38,41 +38,41 @@ export type Sort<TSort extends string> = SortField<TSort>[];
 /**
  * Options for the `sort` query parameter
  */
-export type ParseQuerySortOptions<TFields extends string> = {
+export type ParseQuerySortOptions<TFields extends readonly string[] | undefined> = {
     /** List of field names that are allowed to be sorted */
-    allowed: TFields[];
+    allowed: TFields;
     /** Default sorting order, if none is provided in the query */
-    default?: SortField<TFields>[];
+    default?: TFields extends readonly string[] ? Sort<TFields[number]> : undefined;
     /** Whether multiple sort fields are allowed (comma-separated) */
     multiple?: boolean;
 };
-export type SparseFieldSets = Record<string, string[]>;
+export type SparseFieldSets = Record<string, readonly string[]>;
 export type PartialSparseFieldSets<TFieldSets extends SparseFieldSets> = {
-    [K in keyof TFieldSets]?: Partial<TFieldSets[K]>;
+    [K in keyof TFieldSets]?: TFieldSets[K][number][];
 };
 /**
  * Options for the `fields` (sparse fieldsets) query parameter
  *
  * Allows specifying which fields are allowed per resource type.
  */
-export type ParseQuerySparseFieldsetOptions<TAllowed extends Record<string, string[]>> = {
+export type ParseQuerySparseFieldsetOptions<TAllowed extends SparseFieldSets | undefined> = {
     /** Allowed field names per resource type (e.g., { articles: ["title", "body"] }) */
     allowed: TAllowed;
     /** Default fieldsets to apply when the query omits some or all `fields` */
-    default?: PartialSparseFieldSets<TAllowed>;
+    default?: TAllowed extends SparseFieldSets ? PartialSparseFieldSets<TAllowed> : undefined;
 };
 /**
  * Configuration object for creating a JSON:API query parser
  *
  * Omitting a property will disallow it in the query parameters.
  */
-export type ParseQueryOptions<TInclude extends string | undefined, TSortFields extends string | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined> = {
+export type ParseQueryOptions<TInclude extends readonly string[] | undefined, TSortFields extends readonly string[] | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined> = {
     /** Configuration for `include` query param */
-    include?: TInclude extends string ? ParseQueryIncludeOptions<TInclude> : undefined;
+    include?: ParseQueryIncludeOptions<TInclude>;
     /** Configuration for `sort` query param */
-    sort?: TSortFields extends string ? ParseQuerySortOptions<TSortFields> : undefined;
+    sort?: ParseQuerySortOptions<TSortFields>;
     /** Configuration for `fields` query param */
-    fields?: TSparseFieldSets extends SparseFieldSets ? ParseQuerySparseFieldsetOptions<TSparseFieldSets> : undefined;
+    fields?: ParseQuerySparseFieldsetOptions<TSparseFieldSets>;
     /** Zod schema for validating and parsing the `filter` query param */
     filter?: TFilterSchema;
     /** Zod schema for validating and parsing the `page` query param */
@@ -81,17 +81,17 @@ export type ParseQueryOptions<TInclude extends string | undefined, TSortFields e
 /**
  * Structured result returned by the query parser
  */
-export type ParseQueryResult<TInclude extends string | undefined, TSortFields extends string | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined> = {
-    include: TInclude extends string ? ParentPaths<TInclude>[] : undefined;
-    sort: TSortFields extends string ? Sort<TSortFields> : undefined;
-    fields: TSparseFieldSets extends SparseFieldSets ? PartialSparseFieldSets<TSparseFieldSets> : undefined;
+export type ParseQueryResult<TInclude extends readonly string[] | undefined, TSortFields extends readonly string[] | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined> = {
+    include: undefined extends TInclude ? undefined : TInclude extends readonly string[] ? ParentPaths<TInclude[number]>[] : undefined;
+    sort: undefined extends TSortFields ? undefined : TSortFields extends readonly string[] ? Sort<TSortFields[number]> : undefined;
+    fields: undefined extends TSparseFieldSets ? undefined : TSparseFieldSets extends SparseFieldSets ? PartialSparseFieldSets<TSparseFieldSets> : undefined;
     filter: TFilterSchema extends $ZodType ? z.output<TFilterSchema> : undefined;
     page: TPageSchema extends $ZodType ? z.output<TPageSchema> : undefined;
 };
 /**
  * A query parser that parses a JSON:API-style query string into a strongly typed object.
  */
-export type QueryParser<TInclude extends string | undefined, TSortFields extends string | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined> = (searchParams: SearchParamsInput) => ParseQueryResult<TInclude, TSortFields, TSparseFieldSets, TFilterSchema, TPageSchema>;
+export type QueryParser<TInclude extends readonly string[] | undefined, TSortFields extends readonly string[] | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined> = (searchParams: SearchParamsInput) => ParseQueryResult<TInclude, TSortFields, TSparseFieldSets, TFilterSchema, TPageSchema>;
 /**
  * Creates a query parser for JSON:API-compliant query strings.
  *
@@ -113,4 +113,4 @@ export type QueryParser<TInclude extends string | undefined, TSortFields extends
  * const query = parsePostQuery("include=author&sort=-createdAt&fields[articles]=title,body");
  * ```
  */
-export declare const createQueryParser: <TInclude extends string | undefined, TSortFields extends string | undefined, TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined>(options: ParseQueryOptions<TInclude, TSortFields, TSparseFieldSets, TFilterSchema, TPageSchema>) => QueryParser<NoInfer<TInclude>, NoInfer<TSortFields>, NoInfer<TSparseFieldSets>, NoInfer<TFilterSchema>, NoInfer<TPageSchema>>;
+export declare const createQueryParser: <const TInclude extends readonly string[] | undefined, const TSortFields extends readonly string[] | undefined, const TSparseFieldSets extends SparseFieldSets | undefined, TFilterSchema extends $ZodType | undefined, TPageSchema extends $ZodType | undefined>(options: ParseQueryOptions<TInclude, TSortFields, TSparseFieldSets, TFilterSchema, TPageSchema>) => QueryParser<NoInfer<TInclude>, NoInfer<TSortFields>, NoInfer<TSparseFieldSets>, NoInfer<TFilterSchema>, NoInfer<TPageSchema>>;

package/dist/request/query.js

@@ -116,13 +116,13 @@ const buildSparseFieldsetSchema = (options) => z.strictObject(Object.fromEntries
  */
 export const createQueryParser = (options) => {
     const schema = z.strictObject({
-        include: options.include
+        include: options.include?.allowed
             ? buildIncludeSchema(options.include)
             : z.undefined({ error: "'include' parameter is not supported" }),
-        sort: options.sort
+        sort: options.sort?.allowed
             ? buildSortSchema(options.sort)
             : z.undefined({ error: "'sort' parameter is not supported" }),
-        fields: options.fields
+        fields: options.fields?.allowed
             ? buildSparseFieldsetSchema(options.fields)
             : z.undefined({ error: "'fields' parameter is not supported" }),
         filter: options.filter

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonapi-serde/server",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Framework agnostic JSON:API serialization and deserialization",
   "type": "module",
   "author": "Ben Scholzen 'DASPRiD'",
@@ -55,6 +55,7 @@
     }
   },
   "devDependencies": {
+    "expect-type": "^1.2.1",
     "zod": "^3.25.42"
   },
   "peerDependencies": {