@izumisy-tailor/tailor-data-viewer 0.2.11 → 0.2.13

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@izumisy-tailor/tailor-data-viewer",
   "private": false,
-  "version": "0.2.11",
+  "version": "0.2.13",
   "type": "module",
   "description": "Flexible data viewer component for Tailor Platform",
   "files": [

package/src/component/collection/collection-provider.tsx

@@ -3,7 +3,6 @@ import type { UseCollectionReturn } from "../types";
 
 const CollectionContext = createContext<UseCollectionReturn<
   string,
-  unknown,
   unknown
 > | null>(null);
 
@@ -25,7 +24,7 @@ export function CollectionProvider({
   value,
   children,
 }: {
-  value: UseCollectionReturn<string, unknown, unknown>;
+  value: UseCollectionReturn<string, unknown>;
   children: ReactNode;
 }) {
   return (
@@ -35,8 +34,6 @@ export function CollectionProvider({
   );
 }
 
-
-
 /**
  * Hook to access collection state from the nearest `Collection.Provider`.
  *
@@ -71,8 +68,6 @@ export function useCollectionContext<
   return ctx as UseCollectionReturn<TFieldName>;
 }
 
-
-
 /**
  * `Collection` namespace object providing the Provider component.
  *
@@ -86,5 +81,3 @@ export function useCollectionContext<
 export const Collection = {
   Provider: CollectionProvider,
 } as const;
-
-

package/src/component/collection/use-collection.ts

@@ -8,20 +8,9 @@ import type {
   SortState,
   UseCollectionOptions,
   UseCollectionReturn,
-  ExtractQueryVariables,
   ValidateCollectionQuery,
 } from "../types";
-import type { FieldName } from "../types";
-
-/**
- * Resolves query variables type: uses `ExtractQueryVariables<TQuery>` when
- * the query document carries a `__variablesType` brand (e.g. gql-tada),
- * otherwise falls back to `QueryVariables<TFieldName>`.
- */
-type ResolveVariables<TQuery, TFieldName extends string = string> =
-  ExtractQueryVariables<TQuery> extends never
-    ? QueryVariables<TFieldName>
-    : ExtractQueryVariables<TQuery>;
+import type { FieldName, OrderableFieldName } from "../types";
 
 // -----------------------------------------------------------------------------
 // Overload signatures
@@ -58,14 +47,17 @@ export function useCollection<
   > & {
     metadata: TMetadata;
     tableName: TTableName;
-    query: ValidateCollectionQuery<TQuery, FieldName<TMetadata, TTableName>>;
+    query: ValidateCollectionQuery<
+      TQuery,
+      FieldName<TMetadata, TTableName>,
+      OrderableFieldName<TMetadata, TTableName>
+    >;
   },
 ): UseCollectionReturn<
   FieldName<TMetadata, TTableName>,
-  ResolveVariables<TQuery, FieldName<TMetadata, TTableName>>,
   {
     query: TQuery;
-    variables: ResolveVariables<TQuery, FieldName<TMetadata, TTableName>>;
+    variables: QueryVariables;
   },
   MetadataFilter<TMetadata, TTableName>
 >;
@@ -91,11 +83,7 @@ export function useCollection<TQuery>(
     metadata?: never;
     tableName?: never;
   },
-): UseCollectionReturn<
-  string,
-  ResolveVariables<TQuery>,
-  { query: TQuery; variables: ResolveVariables<TQuery> }
->;
+): UseCollectionReturn<string, { query: TQuery; variables: QueryVariables }>;
 
 // -----------------------------------------------------------------------------
 // Implementation
@@ -106,11 +94,7 @@ export function useCollection(
     tableName?: string;
     query: unknown;
   },
-): UseCollectionReturn<
-  string,
-  QueryVariables,
-  { query: unknown; variables: QueryVariables }
-> {
+): UseCollectionReturn<string, { query: unknown; variables: QueryVariables }> {
   const { params = {}, query: queryDocument } = options;
   const {
     initialFilters = [],

package/src/component/index.ts

@@ -28,6 +28,7 @@ export type {
   DataTableRowProps,
   DataTableCellProps,
   FieldName,
+  OrderableFieldName,
   ExtractOrderField,
   ExtractQueryVariables,
   ExtractQueryInputKeys,

package/src/component/types.ts

@@ -186,15 +186,31 @@ export interface PageInfo {
 /**
  * GraphQL query variables in Tailor Platform format.
  *
- * @typeParam TFieldName - Union of allowed field name strings (default: `string`).
- *                         When metadata is provided to `useCollection`, this
- *                         narrows `order[].field` to match the table's field names,
- *                         making the output directly compatible with gql-tada's
- *                         `VariablesOf<>` types.
+ * Field-level type safety for `query` and `order` is not enforced here.
+ * Instead, `ValidateCollectionQuery` performs compile-time checks
+ * (e.g. `CheckQueryInput` for filter field names, `CheckOrderField`
+ * for orderable fields) when `useCollection` is called with metadata.
  */
-export interface QueryVariables<TFieldName extends string = string> {
+export interface QueryVariables {
+  /**
+   * Filter object built at runtime by `useCollection`.
+   *
+   * Typed as `Record<string, unknown>` because the concrete shape depends on
+   * which filters the user applies at runtime (e.g. `{ name: { eq: "foo" } }`).
+   *
+   * Compile-time safety for field names is enforced separately by
+   * `ValidateCollectionQuery` (specifically `CheckQueryInput`), which verifies
+   * that metadata field names are a subset of the GraphQL `QueryInput` type's keys.
+   */
   query?: Record<string, unknown>;
-  order?: { field: TFieldName; direction: "Asc" | "Desc" }[];
+  /**
+   * Sort order built at runtime by `useCollection`.
+   *
+   * `field` is typed as `string` here. Compile-time validation that
+   * field names are assignable to the GraphQL `OrderInput` enum is
+   * performed by `ValidateCollectionQuery` (specifically `CheckOrderField`).
+   */
+  order?: { field: string; direction: "Asc" | "Desc" }[];
   first: number;
   after?: string | null;
 }
@@ -369,16 +385,12 @@ export interface UseCollectionOptions<
  * `UseCollectionReturn<string>` (bivariant method check).
  *
  * @typeParam TFieldName - Union of allowed field name strings (default: `string`).
- * @typeParam TVariables - Type of the `variables` output (default: `QueryVariables<TFieldName>`).
- *                         Pass `VariablesOf<typeof YOUR_QUERY>` (gql-tada) to get
- *                         exact type compatibility with your GraphQL client.
  * @typeParam TQueryArgs - Type returned by `toQueryArgs()`. Contains both
  *                         `query` and `variables`.
  */
 export interface UseCollectionReturn<
   TFieldName extends string = string,
-  TVariables = QueryVariables<TFieldName>,
-  TQueryArgs = { query: unknown; variables: TVariables },
+  TQueryArgs = { query: unknown; variables: QueryVariables },
   TFilter = Filter<TFieldName>,
 > {
   /**
@@ -453,7 +465,7 @@ export interface UseDataTableOptions<TRow extends Record<string, unknown>> {
   /** Error */
   error?: Error | null;
   /** Collection state for sort/pagination integration */
-  collection?: UseCollectionReturn<string, unknown, unknown>;
+  collection?: UseCollectionReturn<string, unknown>;
 }
 
 /**
@@ -582,6 +594,41 @@ export type FieldName<
     : never
   : never;
 
+/**
+ * Field types that support ordering.
+ * Mirrors the runtime `fieldTypeToSortConfig` logic — types that return
+ * a `SortConfig` (not `undefined`) are considered orderable.
+ */
+type OrderableFieldType =
+  | "string"
+  | "number"
+  | "boolean"
+  | "datetime"
+  | "date"
+  | "time"
+  | "enum";
+
+/**
+ * Extract only orderable field names from table metadata.
+ *
+ * Fields whose `type` is not in `OrderableFieldType` (e.g. `uuid`, `array`,
+ * `nested`, `file`) are excluded.  This allows `CheckOrderField` to compare
+ * only the fields that Tailor Platform actually exposes in the
+ * `OrderFieldEnum`, avoiding false positives for fields like `id`.
+ */
+export type OrderableFieldName<
+  TMetadata extends TableMetadataMap,
+  TTableName extends keyof TMetadata,
+> =
+  Extract<
+    TMetadata[TTableName]["fields"][number],
+    { readonly type: OrderableFieldType }
+  > extends { readonly name: infer N }
+    ? N extends string
+      ? N
+      : never
+    : never;
+
 /**
  * Extract the `order[].field` union type from a GraphQL variables type.
  *
@@ -726,6 +773,7 @@ type CheckQueryInput<
 export type ValidateCollectionQuery<
   TQuery,
   TFieldName extends string = string,
+  TOrderableFieldName extends string = TFieldName,
 > =
   ExtractQueryVariables<TQuery> extends never
     ? TQuery // No gql-tada type info → skip validation
@@ -733,7 +781,7 @@ export type ValidateCollectionQuery<
       ? TQuery & CheckFirstVariable<TQuery> // No metadata → only check $first
       : TQuery &
           CheckFirstVariable<TQuery> &
-          CheckOrderField<TQuery, TFieldName> &
+          CheckOrderField<TQuery, TOrderableFieldName> &
           CheckQueryInput<TQuery, TFieldName>;
 
 /**