@hypequery/react 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are advised to review the applicable
+      documentation for the specific language governing permissions and
+      limitations under each license.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 hypequery
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License. 

package/README.md

@@ -0,0 +1,365 @@
+# @hypequery/react
+
+Type-safe React hooks for hypequery APIs. Wraps your generated API definition in thin TanStack Query shims so you can call `useQuery('weeklyRevenue')` with end-to-end type safety.
+
+## Installation
+
+```bash
+npm install @hypequery/react @tanstack/react-query
+```
+
+Peer dependencies: `react@^18`, `@tanstack/react-query@^5`.
+
+## Quick Start
+
+```ts
+// lib/analytics.ts
+import { createHooks } from '@hypequery/react';
+import type { Api } from '@/analytics/queries';
+
+export const { useQuery, useMutation } = createHooks<Api>({
+  baseUrl: '/api',
+});
+```
+
+Wrap your app with TanStack Query's provider:
+
+```tsx
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+
+const queryClient = new QueryClient();
+
+export function App({ children }: { children: React.ReactNode }) {
+  return (
+    <QueryClientProvider client={queryClient}>
+      {children}
+    </QueryClientProvider>
+  );
+}
+```
+
+Use the hooks in your components:
+
+```tsx
+// Query
+const { data, error, isLoading } = useQuery('weeklyRevenue', { startDate: '2025-01-01' });
+
+// Mutation
+const rebuild = useMutation('rebuildMetrics');
+rebuild.mutate({ force: true });
+```
+
+---
+
+## API Reference
+
+### `createHooks<Api>(config)`
+
+Factory function that creates type-safe `useQuery` and `useMutation` hooks for your API.
+
+**Parameters:**
+
+```ts
+interface CreateHooksConfig<TApi> {
+  baseUrl: string;                          // Required: API base URL (e.g., '/api' or 'https://api.example.com')
+  fetchFn?: typeof fetch;                   // Optional: Custom fetch implementation (defaults to global fetch)
+  headers?: Record<string, string>;         // Optional: Default headers for all requests
+  config?: Record<string, QueryMethodConfig>; // Optional: Per-route HTTP method overrides
+  api?: TApi;                               // Optional: API object to auto-extract HTTP methods
+}
+
+interface QueryMethodConfig {
+  method?: string; // HTTP method: 'GET', 'POST', 'PUT', 'DELETE', etc.
+}
+```
+
+**Returns:**
+
+```ts
+{
+  useQuery: <Name>(name, input?, options?) => UseQueryResult<Output, HttpError>,
+  useMutation: <Name>(name, options?) => UseMutationResult<Output, HttpError, Input>
+}
+```
+
+**Example:**
+
+```ts
+const { useQuery, useMutation } = createHooks<Api>({
+  baseUrl: 'https://api.example.com',
+  headers: {
+    'X-API-Key': process.env.API_KEY,
+  },
+  config: {
+    // Override HTTP method for specific routes
+    uploadFile: { method: 'POST' },
+  },
+});
+```
+
+---
+
+### `useQuery(name, input?, options?)`
+
+Type-safe wrapper around TanStack Query's `useQuery`. Automatically infers input and output types from your API definition.
+
+**Signatures:**
+
+```ts
+// No input required
+useQuery(name: Name)
+useQuery(name: Name, options: QueryOptions)
+
+// Input required
+useQuery(name: Name, input: Input)
+useQuery(name: Name, input: Input, options: QueryOptions)
+```
+
+**Parameters:**
+
+- `name` - Query name from your API definition
+- `input` - Query input (typed from your API). Optional if query has no input schema
+- `options` - TanStack Query options (`enabled`, `staleTime`, `refetchInterval`, etc.)
+
+**Returns:** TanStack Query's `UseQueryResult<Output, HttpError>`
+
+**Examples:**
+
+```tsx
+// Simple query with no input
+const { data } = useQuery('healthCheck');
+
+// Query with input
+const { data, error, isLoading } = useQuery('getUser', { id: '123' });
+
+// Query with options
+const { data } = useQuery('getUser', { id: '123' }, {
+  enabled: isLoggedIn,
+  staleTime: 60000,
+  refetchOnWindowFocus: false,
+});
+
+// Query without input but with options
+const { data } = useQuery('healthCheck', { refetchInterval: 5000 });
+```
+
+---
+
+### `useMutation(name, options?)`
+
+Type-safe wrapper around TanStack Query's `useMutation`.
+
+**Parameters:**
+
+- `name` - Mutation name from your API definition
+- `options` - TanStack Query mutation options (`onSuccess`, `onError`, `retry`, etc.)
+
+**Returns:** TanStack Query's `UseMutationResult<Output, HttpError, Input>`
+
+**Examples:**
+
+```tsx
+// Basic mutation
+const createUser = useMutation('createUser');
+createUser.mutate({ name: 'Alice', email: 'alice@example.com' });
+
+// Mutation with callbacks
+const updateProfile = useMutation('updateProfile', {
+  onSuccess: (data) => {
+    console.log('Profile updated:', data);
+    queryClient.invalidateQueries(['hypequery', 'getProfile']);
+  },
+  onError: (error) => {
+    console.error('Failed to update profile:', error.message);
+  },
+});
+
+updateProfile.mutate({ bio: 'New bio' });
+```
+
+---
+
+### `queryOptions(options)`
+
+Helper function to explicitly mark an object as query options (not input). Useful when your query input and TanStack Query options have overlapping property names.
+
+**Parameters:**
+
+- `options` - TanStack Query options object
+
+**Returns:** The same object with an internal symbol marker
+
+**When to use:**
+
+If your API input has properties like `enabled`, `staleTime`, etc., the library might misclassify input as options. Use `queryOptions()` to disambiguate:
+
+```tsx
+// ❌ Ambiguous - could be input or options?
+useQuery('getConfig', { enabled: true, staleTime: 5000 });
+
+// ✅ Explicit - this is input
+useQuery('getConfig', { enabled: true, staleTime: 5000 });
+
+// ✅ Explicit - these are options
+import { queryOptions } from '@hypequery/react';
+useQuery('getConfig', queryOptions({ enabled: true, staleTime: 5000 }));
+```
+
+---
+
+### `HttpError`
+
+Custom error class thrown by failed HTTP requests. Extends the standard `Error` class with additional properties.
+
+**Properties:**
+
+```ts
+class HttpError extends Error {
+  readonly status: number;  // HTTP status code (404, 500, etc.)
+  readonly body: unknown;   // Parsed response body (JSON or text)
+}
+```
+
+**Usage:**
+
+```tsx
+const { error } = useQuery('getUser', { id: '123' });
+
+if (error) {
+  console.log(error.message);  // "GET request to /api/getUser failed with status 404"
+  console.log(error.status);   // 404
+  console.log(error.body);     // { message: "User not found" }
+
+  // Type-safe instanceof check
+  if (error instanceof HttpError) {
+    if (error.status === 404) {
+      return <NotFound />;
+    }
+  }
+}
+```
+
+**Error handling example:**
+
+```tsx
+import { HttpError } from '@hypequery/react';
+
+function UserProfile({ userId }: { userId: string }) {
+  const { data, error, isLoading } = useQuery('getUser', { id: userId });
+
+  if (isLoading) return <Spinner />;
+
+  if (error instanceof HttpError) {
+    switch (error.status) {
+      case 404:
+        return <NotFound message="User not found" />;
+      case 403:
+        return <Unauthorized />;
+      case 500:
+        return <ServerError details={error.body} />;
+      default:
+        return <Error message={error.message} />;
+    }
+  }
+
+  return <div>{data.name}</div>;
+}
+```
+
+---
+
+## Advanced Usage
+
+### Custom fetch implementation
+
+```ts
+const { useQuery } = createHooks<Api>({
+  baseUrl: '/api',
+  fetchFn: async (url, init) => {
+    // Add authentication token
+    const token = await getAuthToken();
+    return fetch(url, {
+      ...init,
+      headers: {
+        ...init?.headers,
+        Authorization: `Bearer ${token}`,
+      },
+    });
+  },
+});
+```
+
+### Default headers
+
+```ts
+const { useQuery } = createHooks<Api>({
+  baseUrl: '/api',
+  headers: {
+    'X-API-Key': process.env.API_KEY,
+    'X-Client-Version': '1.0.0',
+  },
+});
+```
+
+### HTTP method configuration
+
+```ts
+const { useQuery } = createHooks<Api>({
+  baseUrl: '/api',
+  config: {
+    // Override default GET for specific queries
+    refreshCache: { method: 'POST' },
+    deleteUser: { method: 'DELETE' },
+  },
+});
+```
+
+### Auto-extract methods from API object
+
+If your API definition includes HTTP method information, pass it to auto-configure:
+
+```ts
+import { api } from '@/analytics/queries';
+
+const { useQuery } = createHooks({
+  baseUrl: '/api',
+  api, // Automatically extracts method config from api object
+});
+```
+
+---
+
+## TypeScript
+
+All hooks are fully typed based on your API definition:
+
+```ts
+interface Api {
+  getUser: {
+    input: { id: string };
+    output: { name: string; email: string };
+  };
+  weeklyRevenue: {
+    input: { startDate: string };
+    output: { total: number };
+  };
+}
+
+const { useQuery } = createHooks<Api>({ baseUrl: '/api' });
+
+// ✅ TypeScript infers input and output types
+const { data } = useQuery('getUser', { id: '123' });
+//    ^? { name: string; email: string } | undefined
+
+// ❌ TypeScript error: missing required input
+const { data } = useQuery('getUser');
+
+// ❌ TypeScript error: invalid property
+const { data } = useQuery('getUser', { userId: '123' });
+```
+
+---
+
+## License
+
+MIT

package/dist/createHooks.d.ts

@@ -0,0 +1,45 @@
+import { type UseQueryOptions as TanstackUseQueryOptions, type UseMutationOptions as TanstackUseMutationOptions, type UseMutationResult, type UseQueryResult } from '@tanstack/react-query';
+import type { ExtractNames, QueryInput, QueryOutput } from './types.js';
+import { HttpError } from './errors.js';
+export interface QueryMethodConfig {
+    method?: string;
+}
+export interface CreateHooksConfig<TApi = any> {
+    baseUrl: string;
+    fetchFn?: typeof fetch;
+    headers?: Record<string, string>;
+    config?: Record<string, QueryMethodConfig>;
+    api?: TApi;
+}
+/**
+ * Symbol used to mark objects as query options (not input)
+ * @internal
+ */
+declare const OPTIONS_SYMBOL: unique symbol;
+/**
+ * Helper to explicitly mark an object as query options
+ * Prevents ambiguity when query input and options have overlapping properties
+ *
+ * @example
+ * ```ts
+ * // Without helper - ambiguous (could be input or options)
+ * useQuery('getData', { enabled: true, staleTime: 5000 })
+ *
+ * // With helper - explicit
+ * useQuery('getData', queryOptions({ enabled: true, staleTime: 5000 }))
+ * ```
+ */
+export declare function queryOptions<T extends object>(opts: T): T & {
+    [OPTIONS_SYMBOL]: true;
+};
+export declare function createHooks<Api extends {
+    [K in keyof Api]: {
+        input: unknown;
+        output: unknown;
+    };
+}>(config: CreateHooksConfig): {
+    readonly useQuery: <Name extends ExtractNames<Api>>(...args: QueryInput<Api, Name> extends unknown ? unknown extends QueryInput<Api, Name> ? [name: Name, options?: Omit<TanstackUseQueryOptions<QueryOutput<Api, Name>, HttpError, QueryOutput<Api, Name>, ["hypequery", Name, QueryInput<Api, Name>]>, "queryKey" | "queryFn"> | undefined] : [name: Name, input: QueryInput<Api, Name>, options?: Omit<TanstackUseQueryOptions<QueryOutput<Api, Name>, HttpError, QueryOutput<Api, Name>, ["hypequery", Name, QueryInput<Api, Name>]>, "queryKey" | "queryFn"> | undefined] : [name: Name, input: QueryInput<Api, Name>, options?: Omit<TanstackUseQueryOptions<QueryOutput<Api, Name>, HttpError, QueryOutput<Api, Name>, ["hypequery", Name, QueryInput<Api, Name>]>, "queryKey" | "queryFn"> | undefined]) => UseQueryResult<QueryOutput<Api, Name>, HttpError>;
+    readonly useMutation: <Name extends ExtractNames<Api>>(name: Name, options?: Omit<TanstackUseMutationOptions<QueryOutput<Api, Name>, HttpError, QueryInput<Api, Name>, unknown>, "mutationFn">) => UseMutationResult<QueryOutput<Api, Name>, HttpError, QueryInput<Api, Name>>;
+};
+export {};
+//# sourceMappingURL=createHooks.d.ts.map

package/dist/createHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHooks.d.ts","sourceRoot":"","sources":["../src/createHooks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,eAAe,IAAI,uBAAuB,EAC/C,KAAK,kBAAkB,IAAI,0BAA0B,EACrD,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAEV,YAAY,EACZ,UAAU,EACV,WAAW,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAQD,MAAM,WAAW,iBAAiB,CAAC,IAAI,GAAG,GAAG;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC3C,GAAG,CAAC,EAAE,IAAI,CAAC;CACZ;AAED;;;GAGG;AACH,QAAA,MAAM,cAAc,eAAkC,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG;IAAE,CAAC,cAAc,CAAC,EAAE,IAAI,CAAA;CAAE,CAEtF;AA4DD,wBAAgB,WAAW,CAAC,GAAG,SAAS;KACrC,CAAC,IAAI,MAAM,GAAG,GAAG;QAChB,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KACjB;CACF,EAAE,MAAM,EAAE,iBAAiB;wBAiFR,IAAI,SAAS,YAAY,CAAC,GAAG,CAAC,kuBAE7C,cAAc,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC;2BAoD/B,IAAI,SAAS,YAAY,CAAC,GAAG,CAAC,QAC3C,IAAI,kIAET,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;EAW/E"}