@orpc/solid-query 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 oRPC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/solid-query">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fsolid-query?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+
+---
+
+## Highlights
+
+- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
+- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
+- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
+- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
+- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid), Pinia Colada, and more.
+- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
+- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
+- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
+- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
+- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
+- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
+- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
+- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
+- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
+- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/solid-query`
+
+Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview). Read the [documentation](https://orpc.unnoq.com/docs/tanstack-query/solid) for more information.
+
+```ts
+export function Example() {
+  const query = createQuery(() => orpc.planet.find.queryOptions({
+    input: { id: 123 }, // Specify input if needed
+    context: { cache: true }, // Provide client context if needed
+  // additional options...
+  }))
+
+  const query = createInfiniteQuery(() => orpc.planet.list.infiniteOptions({
+    input: (pageParam: number | undefined) => ({ limit: 10, offset: pageParam }),
+    context: { cache: true }, // Provide client context if needed
+    initialPageParam: undefined,
+    getNextPageParam: lastPage => lastPage.nextPageParam,
+  // additional options...
+  }))
+
+  const mutation = createMutation(() => orpc.planet.create.mutationOptions({
+    context: { cache: true }, // Provide client context if needed
+  // additional options...
+  }))
+
+  mutation.mutate({ name: 'Earth' })
+
+  const queryClient = useQueryClient()
+
+  // Invalidate all planet queries
+  queryClient.invalidateQueries({
+    queryKey: orpc.planet.key(),
+  })
+
+  // Invalidate only regular (non-infinite) planet queries
+  queryClient.invalidateQueries({
+    queryKey: orpc.planet.key({ type: 'query' })
+  })
+
+  // Invalidate the planet find query with id 123
+  queryClient.invalidateQueries({
+    queryKey: orpc.planet.find.key({ input: { id: 123 } })
+  })
+}
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.d.mts

@@ -0,0 +1,72 @@
+import { ClientContext, Client, NestedClient } from '@orpc/client';
+import { QueryKey, SolidQueryOptions, QueryFunctionContext, SolidInfiniteQueryOptions, SolidMutationOptions, InfiniteData } from '@tanstack/solid-query';
+import { PartialDeep, SetOptional, MaybeOptionalOptions } from '@orpc/shared';
+
+type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
+interface BuildKeyOptions<TType extends KeyType, TInput> {
+    type?: TType;
+    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
+}
+declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
+
+/**
+ * Utils at any level (procedure or router)
+ */
+interface GeneralUtils<TInput> {
+    key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
+}
+declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
+
+type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData> = (undefined extends TInput ? {
+    input?: TInput;
+} : {
+    input: TInput;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & SetOptional<SolidQueryOptions<TOutput, TError, TSelectData>, 'queryKey'>;
+interface QueryOptionsBase<TOutput, TError extends Error> {
+    queryKey: QueryKey;
+    queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData, TPageParam> = {
+    input: (pageParam: TPageParam) => TInput;
+} & (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & SetOptional<SolidInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey'>;
+interface InfiniteOptionsBase<TOutput, TError extends Error, TPageParam> {
+    queryKey: QueryKey;
+    queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext> = (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & MutationOptions<TInput, TOutput, TError, TMutationContext>;
+type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext> = SolidMutationOptions<TOutput, TError, TInput, TMutationContext>;
+
+interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
+    call: Client<TClientContext, TInput, TOutput, TError>;
+    queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
+    infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
+    mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
+}
+interface CreateProcedureUtilsOptions {
+    path: string[];
+}
+declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+
+type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
+} & GeneralUtils<unknown>;
+interface CreateRouterUtilsOptions {
+    path?: string[];
+}
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
+
+export { type BuildKeyOptions, type CreateProcedureUtilsOptions, type CreateRouterUtilsOptions, type GeneralUtils, type InfiniteOptionsBase, type InfiniteOptionsIn, type KeyType, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptionsBase, type QueryOptionsIn, type RouterUtils, buildKey, createGeneralUtils, createRouterUtils as createORPCSolidQueryUtils, createProcedureUtils, createRouterUtils };

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+import { ClientContext, Client, NestedClient } from '@orpc/client';
+import { QueryKey, SolidQueryOptions, QueryFunctionContext, SolidInfiniteQueryOptions, SolidMutationOptions, InfiniteData } from '@tanstack/solid-query';
+import { PartialDeep, SetOptional, MaybeOptionalOptions } from '@orpc/shared';
+
+type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
+interface BuildKeyOptions<TType extends KeyType, TInput> {
+    type?: TType;
+    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
+}
+declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
+
+/**
+ * Utils at any level (procedure or router)
+ */
+interface GeneralUtils<TInput> {
+    key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
+}
+declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
+
+type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData> = (undefined extends TInput ? {
+    input?: TInput;
+} : {
+    input: TInput;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & SetOptional<SolidQueryOptions<TOutput, TError, TSelectData>, 'queryKey'>;
+interface QueryOptionsBase<TOutput, TError extends Error> {
+    queryKey: QueryKey;
+    queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData, TPageParam> = {
+    input: (pageParam: TPageParam) => TInput;
+} & (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & SetOptional<SolidInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey'>;
+interface InfiniteOptionsBase<TOutput, TError extends Error, TPageParam> {
+    queryKey: QueryKey;
+    queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext> = (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & MutationOptions<TInput, TOutput, TError, TMutationContext>;
+type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext> = SolidMutationOptions<TOutput, TError, TInput, TMutationContext>;
+
+interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
+    call: Client<TClientContext, TInput, TOutput, TError>;
+    queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
+    infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
+    mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
+}
+interface CreateProcedureUtilsOptions {
+    path: string[];
+}
+declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+
+type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
+} & GeneralUtils<unknown>;
+interface CreateRouterUtilsOptions {
+    path?: string[];
+}
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
+
+export { type BuildKeyOptions, type CreateProcedureUtilsOptions, type CreateRouterUtilsOptions, type GeneralUtils, type InfiniteOptionsBase, type InfiniteOptionsIn, type KeyType, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptionsBase, type QueryOptionsIn, type RouterUtils, buildKey, createGeneralUtils, createRouterUtils as createORPCSolidQueryUtils, createProcedureUtils, createRouterUtils };

package/dist/index.mjs

@@ -0,0 +1,74 @@
+function buildKey(path, options) {
+  const withInput = options?.input !== void 0 ? { input: options?.input } : {};
+  const withType = options?.type !== void 0 ? { type: options?.type } : {};
+  return [path, {
+    ...withInput,
+    ...withType
+  }];
+}
+
+function createGeneralUtils(path) {
+  return {
+    key(options) {
+      return buildKey(path, options);
+    }
+  };
+}
+
+function createProcedureUtils(client, options) {
+  return {
+    call: client,
+    queryOptions(...[optionsIn = {}]) {
+      return {
+        queryKey: buildKey(options.path, { type: "query", input: optionsIn.input }),
+        queryFn: ({ signal }) => client(optionsIn.input, { signal, context: optionsIn.context }),
+        ...optionsIn
+      };
+    },
+    infiniteOptions(optionsIn) {
+      return {
+        queryKey: buildKey(options.path, { type: "infinite", input: optionsIn.input(optionsIn.initialPageParam) }),
+        queryFn: ({ pageParam, signal }) => {
+          return client(optionsIn.input(pageParam), { signal, context: optionsIn.context });
+        },
+        ...optionsIn
+      };
+    },
+    mutationOptions(...[optionsIn = {}]) {
+      return {
+        mutationKey: buildKey(options.path, { type: "mutation" }),
+        mutationFn: (input) => client(input, { context: optionsIn.context }),
+        ...optionsIn
+      };
+    }
+  };
+}
+
+function createRouterUtils(client, options = {}) {
+  const path = options.path ?? [];
+  const generalUtils = createGeneralUtils(path);
+  const procedureUtils = createProcedureUtils(client, { path });
+  const recursive = new Proxy({
+    ...generalUtils,
+    ...procedureUtils
+  }, {
+    get(target, prop) {
+      const value = Reflect.get(target, prop);
+      if (typeof prop !== "string") {
+        return value;
+      }
+      const nextUtils = createRouterUtils(client[prop], { ...options, path: [...path, prop] });
+      if (typeof value !== "function") {
+        return nextUtils;
+      }
+      return new Proxy(value, {
+        get(_, prop2) {
+          return Reflect.get(nextUtils, prop2);
+        }
+      });
+    }
+  });
+  return recursive;
+}
+
+export { buildKey, createGeneralUtils, createRouterUtils as createORPCSolidQueryUtils, createProcedureUtils, createRouterUtils };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@orpc/solid-query",
+  "type": "module",
+  "version": "0.0.0",
+  "license": "MIT",
+  "homepage": "https://orpc.unnoq.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unnoq/orpc.git",
+    "directory": "packages/solid-query"
+  },
+  "keywords": [
+    "unnoq",
+    "orpc",
+    "solid-query",
+    "tanstack query",
+    "solid"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@tanstack/solid-query": ">=5.59.0",
+    "solid-js": ">=1.9.0",
+    "@orpc/client": "0.47.0"
+  },
+  "dependencies": {
+    "@orpc/shared": "0.47.0"
+  },
+  "devDependencies": {
+    "zod": "^3.24.2"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "build:watch": "pnpm run build --watch",
+    "type:check": "tsc -b"
+  }
+}