@izumisy-tailor/tailor-data-viewer 0.2.12 → 0.2.14

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@izumisy-tailor/tailor-data-viewer",
   "private": false,
-  "version": "0.2.12",
+  "version": "0.2.14",
   "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

@@ -14,13 +14,20 @@ import type {
 import type { FieldName, OrderableFieldName } 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>`.
+ * Resolves the variables type for `toQueryArgs()` return value.
+ *
+ * When the query document carries gql-tada type information
+ * (`ExtractQueryVariables` resolves to a concrete type), uses that type
+ * so the result is directly compatible with `useQuery()` from urql.
+ * Otherwise falls back to `QueryVariables`.
+ *
+ * Note: The runtime value is always `QueryVariables`, but the gql-tada
+ * variables type is structurally compatible (a supertype), so the cast
+ * is safe.
  */
-type ResolveVariables<TQuery, TFieldName extends string = string> =
+type ResolveVariables<TQuery> =
   ExtractQueryVariables<TQuery> extends never
-    ? QueryVariables<TFieldName>
+    ? QueryVariables
     : ExtractQueryVariables<TQuery>;
 
 // -----------------------------------------------------------------------------
@@ -66,10 +73,9 @@ export function useCollection<
   },
 ): UseCollectionReturn<
   FieldName<TMetadata, TTableName>,
-  ResolveVariables<TQuery, FieldName<TMetadata, TTableName>>,
   {
     query: TQuery;
-    variables: ResolveVariables<TQuery, FieldName<TMetadata, TTableName>>;
+    variables: ResolveVariables<TQuery>;
   },
   MetadataFilter<TMetadata, TTableName>
 >;
@@ -97,7 +103,6 @@ export function useCollection<TQuery>(
   },
 ): UseCollectionReturn<
   string,
-  ResolveVariables<TQuery>,
   { query: TQuery; variables: ResolveVariables<TQuery> }
 >;
 
@@ -110,11 +115,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/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>;
 }
 
 /**