npm - naystack - Versions diffs - 1.5.9 → 1.5.10 - Mend

naystack 1.5.9 → 1.5.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (114) hide show

package/README.md +646 -91
package/dist/auth/constants.d.mts +4 -0
package/dist/auth/constants.d.ts +4 -0
package/dist/auth/email/client.d.mts +149 -0
package/dist/auth/email/client.d.ts +149 -0
package/dist/auth/email/index.cjs.js +2 -20
package/dist/auth/email/index.d.mts +41 -1
package/dist/auth/email/index.d.ts +41 -1
package/dist/auth/email/index.esm.js +1 -17
package/dist/auth/email/routes/delete.cjs.js +0 -1
package/dist/auth/email/routes/delete.d.mts +5 -0
package/dist/auth/email/routes/delete.d.ts +5 -0
package/dist/auth/email/routes/delete.esm.js +0 -1
package/dist/auth/email/routes/get.d.mts +5 -0
package/dist/auth/email/routes/get.d.ts +5 -0
package/dist/auth/email/routes/post.cjs.js +0 -1
package/dist/auth/email/routes/post.d.mts +5 -0
package/dist/auth/email/routes/post.d.ts +5 -0
package/dist/auth/email/routes/post.esm.js +0 -1
package/dist/auth/email/routes/put.cjs.js +0 -1
package/dist/auth/email/routes/put.d.mts +5 -0
package/dist/auth/email/routes/put.d.ts +5 -0
package/dist/auth/email/routes/put.esm.js +0 -1
package/dist/auth/email/token.d.mts +62 -0
package/dist/auth/email/token.d.ts +62 -0
package/dist/auth/email/types.d.mts +22 -0
package/dist/auth/email/types.d.ts +22 -0
package/dist/auth/email/utils.cjs.js +0 -18
package/dist/auth/email/utils.d.mts +41 -3
package/dist/auth/email/utils.d.ts +41 -3
package/dist/auth/email/utils.esm.js +0 -16
package/dist/auth/google/get.d.mts +5 -0
package/dist/auth/google/get.d.ts +5 -0
package/dist/auth/google/index.d.mts +39 -0
package/dist/auth/google/index.d.ts +39 -0
package/dist/auth/index.cjs.js +4 -22
package/dist/auth/index.d.mts +1 -1
package/dist/auth/index.d.ts +1 -1
package/dist/auth/index.esm.js +3 -19
package/dist/auth/instagram/client.d.mts +19 -0
package/dist/auth/instagram/client.d.ts +19 -0
package/dist/auth/instagram/index.d.mts +37 -0
package/dist/auth/instagram/index.d.ts +37 -0
package/dist/auth/instagram/route.d.mts +5 -0
package/dist/auth/instagram/route.d.ts +5 -0
package/dist/auth/instagram/utils.d.mts +13 -0
package/dist/auth/instagram/utils.d.ts +13 -0
package/dist/auth/types.d.mts +24 -0
package/dist/auth/types.d.ts +24 -0
package/dist/auth/utils/errors.d.mts +10 -0
package/dist/auth/utils/errors.d.ts +10 -0
package/dist/auth/utils/token.d.mts +20 -0
package/dist/auth/utils/token.d.ts +20 -0
package/dist/client/hooks.d.mts +59 -0
package/dist/client/hooks.d.ts +59 -0
package/dist/client/seo.d.mts +46 -0
package/dist/client/seo.d.ts +46 -0
package/dist/env.d.mts +61 -0
package/dist/env.d.ts +61 -0
package/dist/file/client.d.mts +53 -1
package/dist/file/client.d.ts +53 -1
package/dist/file/index.cjs.js +0 -1
package/dist/file/index.esm.js +0 -1
package/dist/file/put.cjs.js +0 -1
package/dist/file/put.d.mts +11 -0
package/dist/file/put.d.ts +11 -0
package/dist/file/put.esm.js +0 -1
package/dist/file/setup.cjs.js +0 -1
package/dist/file/setup.d.mts +48 -0
package/dist/file/setup.d.ts +48 -0
package/dist/file/setup.esm.js +0 -1
package/dist/file/utils.d.mts +41 -0
package/dist/file/utils.d.ts +41 -0
package/dist/graphql/client.d.mts +113 -0
package/dist/graphql/client.d.ts +113 -0
package/dist/graphql/errors.d.mts +26 -0
package/dist/graphql/errors.d.ts +26 -0
package/dist/graphql/index.cjs.js +2 -3
package/dist/graphql/index.esm.js +2 -3
package/dist/graphql/init.cjs.js +0 -1
package/dist/graphql/init.d.mts +33 -0
package/dist/graphql/init.d.ts +33 -0
package/dist/graphql/init.esm.js +0 -1
package/dist/graphql/server.d.mts +88 -0
package/dist/graphql/server.d.ts +88 -0
package/dist/graphql/types.d.mts +21 -0
package/dist/graphql/types.d.ts +21 -0
package/dist/graphql/utils.d.mts +217 -0
package/dist/graphql/utils.d.ts +217 -0
package/dist/index.d.mts +16 -0
package/dist/index.d.ts +16 -0
package/dist/socials/instagram/getters.d.mts +115 -0
package/dist/socials/instagram/getters.d.ts +115 -0
package/dist/socials/instagram/setters.d.mts +18 -0
package/dist/socials/instagram/setters.d.ts +18 -0
package/dist/socials/instagram/types.d.mts +46 -0
package/dist/socials/instagram/types.d.ts +46 -0
package/dist/socials/instagram/utils.d.mts +19 -0
package/dist/socials/instagram/utils.d.ts +19 -0
package/dist/socials/instagram/webhook.d.mts +31 -0
package/dist/socials/instagram/webhook.d.ts +31 -0
package/dist/socials/meta-webhook.d.mts +11 -0
package/dist/socials/meta-webhook.d.ts +11 -0
package/dist/socials/threads/getters.d.mts +57 -0
package/dist/socials/threads/getters.d.ts +57 -0
package/dist/socials/threads/setters.d.mts +59 -0
package/dist/socials/threads/setters.d.ts +59 -0
package/dist/socials/threads/types.d.mts +9 -0
package/dist/socials/threads/types.d.ts +9 -0
package/dist/socials/threads/utils.d.mts +19 -0
package/dist/socials/threads/utils.d.ts +19 -0
package/dist/socials/threads/webhook.d.mts +30 -0
package/dist/socials/threads/webhook.d.ts +30 -0
package/package.json +4 -2

package/dist/graphql/client.d.mts CHANGED Viewed

@@ -3,16 +3,129 @@ import { InMemoryCacheConfig, OperationVariables, MutationHookOptions } from '@a
 import { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import React__default, { PropsWithChildren } from 'react';
+/**
+ * Apollo Client provider for Next.js. Wrap your app (or a subtree) so client components can run GraphQL queries and mutations.
+ * The GraphQL endpoint is read from `NEXT_PUBLIC_GRAPHQL_ENDPOINT` env var.
+ *
+ * Must be placed **inside** `AuthWrapper` (since `useAuthQuery` / `useAuthMutation` depend on the auth token).
+ *
+ * @param props - Component props.
+ * @param props.children - React children (your app or page content).
+ * @param props.cacheConfig - Optional `InMemoryCache` config (e.g. `typePolicies`, `addTypename`). Passed to Apollo's `InMemoryCache`.
+ * @returns Provider component that supplies Apollo Client to the tree.
+ *
+ * @example
+ * ```tsx
+ * // app/layout.tsx
+ * import { AuthWrapper } from "naystack/auth/email/client";
+ * import { ApolloWrapper } from "naystack/graphql/client";
+ *
+ * export default function RootLayout({ children }: { children: React.ReactNode }) {
+ *   return (
+ *     <html lang="en">
+ *       <body>
+ *         <AuthWrapper>
+ *           <ApolloWrapper>{children}</ApolloWrapper>
+ *         </AuthWrapper>
+ *       </body>
+ *     </html>
+ *   );
+ * }
+ * ```
+ *
+ * @category GraphQL
+ */
 declare const ApolloWrapper: ({ children, cacheConfig, }: PropsWithChildren<{
     cacheConfig?: InMemoryCacheConfig;
 }>) => React__default.JSX.Element;
+/**
+ * Builds the Apollo link context so requests include the user's Bearer token.
+ * Used internally by `useAuthQuery` / `useAuthMutation`; you typically don't call this directly.
+ *
+ * @param token - The JWT access token. If `null`/`undefined`, returns `undefined` (no auth header).
+ * @returns Context object with `headers.authorization` and `credentials: 'omit'`, or `undefined` if no token.
+ *
+ * @category GraphQL
+ */
 declare const tokenContext: (token?: string | null) => {
     headers: {
         authorization: string;
     };
     credentials: string;
 } | undefined;
+/**
+ * Hook to run a GraphQL query with the current user's token. The query auto-fires when both the token
+ * and variables are available. Returns a refetch function and the Apollo query result.
+ *
+ * Uses `fetchPolicy: "no-cache"` by default to always get fresh data.
+ *
+ * @param query - A `TypedDocumentNode` for the query (e.g. from codegen or a `gql` template).
+ * @param variables - Optional initial variables. Query fires automatically when this and token are set; change to refetch.
+ * @returns Tuple: `[refetch, result]`.
+ *   - `refetch(input)` — runs the query again with the given input (passed as `variables.input`).
+ *   - `result` — `{ data, loading, error }` from Apollo.
+ *
+ * @example Lazy query (no initial variables, manually triggered):
+ * ```tsx
+ * import { useAuthQuery } from "naystack/graphql/client";
+ * import { GET_SUMMARY } from "@/constants/graphql/queries";
+ *
+ * function SummaryCard({ type }: { type: string }) {
+ *   const [getSummary, { loading, data }] = useAuthQuery(GET_SUMMARY);
+ *
+ *   const handleFetch = async () => {
+ *     const result = await getSummary({ type });
+ *     if (result.data?.getSummary) setSummary(result.data.getSummary);
+ *   };
+ *
+ *   return <button onClick={handleFetch} disabled={loading}>Get Summary</button>;
+ * }
+ * ```
+ *
+ * @example Auto-firing query with variables:
+ * ```tsx
+ * const [refetch, { data, loading }] = useAuthQuery(GET_ORGANIZATION_DETAILS, { id: orgId });
+ * // Query fires automatically when orgId and token are available
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function useAuthQuery<T, V extends OperationVariables>(query: TypedDocumentNode<T, V>, variables?: V): readonly [(input: V["input"]) => Promise<_apollo_client.QueryResult<T, V>>, _apollo_client.QueryResult<T, V>];
+/**
+ * Hook to run a GraphQL mutation with the current user's token. Returns a function you call with the mutation input.
+ *
+ * The input is sent as `variables.input` to the GraphQL endpoint.
+ *
+ * @param mutation - A `TypedDocumentNode` for the mutation (e.g. from codegen or a `gql` template).
+ * @param options - Optional Apollo `MutationHookOptions` (e.g. `onCompleted`, `onError`, `refetchQueries`).
+ * @returns Tuple: `[mutate, result]`.
+ *   - `mutate(input)` — runs the mutation with the given input. Returns a Promise with `{ data }`.
+ *   - `result` — `{ data, loading, error }` from Apollo.
+ *
+ * @example
+ * ```tsx
+ * import { useAuthMutation } from "naystack/graphql/client";
+ * import { CREATE_DEAL } from "@/lib/gql/mutations";
+ *
+ * function CreateDealModal({ propertyId }: { propertyId: number }) {
+ *   const [createDeal, { loading }] = useAuthMutation(CREATE_DEAL);
+ *
+ *   const onSubmit = async (values: FormFields) => {
+ *     const response = await createDeal({
+ *       propertyId,
+ *       share: Number(values.share),
+ *       targetProfit: Number(values.targetProfit),
+ *     });
+ *     const dealId = response.data?.createDeal;
+ *     if (dealId) router.push(`/deals/${dealId}`);
+ *   };
+ *
+ *   return <form onSubmit={handleSubmit(onSubmit)}>...</form>;
+ * }
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function useAuthMutation<T, V extends OperationVariables>(mutation: TypedDocumentNode<T, V>, options?: MutationHookOptions<T, V>): readonly [(input: V["input"]) => Promise<_apollo_client.FetchResult<T>>, _apollo_client.MutationResult<T>];
 export { ApolloWrapper, tokenContext, useAuthMutation, useAuthQuery };

package/dist/graphql/client.d.ts CHANGED Viewed

@@ -3,16 +3,129 @@ import { InMemoryCacheConfig, OperationVariables, MutationHookOptions } from '@a
 import { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import React__default, { PropsWithChildren } from 'react';
+/**
+ * Apollo Client provider for Next.js. Wrap your app (or a subtree) so client components can run GraphQL queries and mutations.
+ * The GraphQL endpoint is read from `NEXT_PUBLIC_GRAPHQL_ENDPOINT` env var.
+ *
+ * Must be placed **inside** `AuthWrapper` (since `useAuthQuery` / `useAuthMutation` depend on the auth token).
+ *
+ * @param props - Component props.
+ * @param props.children - React children (your app or page content).
+ * @param props.cacheConfig - Optional `InMemoryCache` config (e.g. `typePolicies`, `addTypename`). Passed to Apollo's `InMemoryCache`.
+ * @returns Provider component that supplies Apollo Client to the tree.
+ *
+ * @example
+ * ```tsx
+ * // app/layout.tsx
+ * import { AuthWrapper } from "naystack/auth/email/client";
+ * import { ApolloWrapper } from "naystack/graphql/client";
+ *
+ * export default function RootLayout({ children }: { children: React.ReactNode }) {
+ *   return (
+ *     <html lang="en">
+ *       <body>
+ *         <AuthWrapper>
+ *           <ApolloWrapper>{children}</ApolloWrapper>
+ *         </AuthWrapper>
+ *       </body>
+ *     </html>
+ *   );
+ * }
+ * ```
+ *
+ * @category GraphQL
+ */
 declare const ApolloWrapper: ({ children, cacheConfig, }: PropsWithChildren<{
     cacheConfig?: InMemoryCacheConfig;
 }>) => React__default.JSX.Element;
+/**
+ * Builds the Apollo link context so requests include the user's Bearer token.
+ * Used internally by `useAuthQuery` / `useAuthMutation`; you typically don't call this directly.
+ *
+ * @param token - The JWT access token. If `null`/`undefined`, returns `undefined` (no auth header).
+ * @returns Context object with `headers.authorization` and `credentials: 'omit'`, or `undefined` if no token.
+ *
+ * @category GraphQL
+ */
 declare const tokenContext: (token?: string | null) => {
     headers: {
         authorization: string;
     };
     credentials: string;
 } | undefined;
+/**
+ * Hook to run a GraphQL query with the current user's token. The query auto-fires when both the token
+ * and variables are available. Returns a refetch function and the Apollo query result.
+ *
+ * Uses `fetchPolicy: "no-cache"` by default to always get fresh data.
+ *
+ * @param query - A `TypedDocumentNode` for the query (e.g. from codegen or a `gql` template).
+ * @param variables - Optional initial variables. Query fires automatically when this and token are set; change to refetch.
+ * @returns Tuple: `[refetch, result]`.
+ *   - `refetch(input)` — runs the query again with the given input (passed as `variables.input`).
+ *   - `result` — `{ data, loading, error }` from Apollo.
+ *
+ * @example Lazy query (no initial variables, manually triggered):
+ * ```tsx
+ * import { useAuthQuery } from "naystack/graphql/client";
+ * import { GET_SUMMARY } from "@/constants/graphql/queries";
+ *
+ * function SummaryCard({ type }: { type: string }) {
+ *   const [getSummary, { loading, data }] = useAuthQuery(GET_SUMMARY);
+ *
+ *   const handleFetch = async () => {
+ *     const result = await getSummary({ type });
+ *     if (result.data?.getSummary) setSummary(result.data.getSummary);
+ *   };
+ *
+ *   return <button onClick={handleFetch} disabled={loading}>Get Summary</button>;
+ * }
+ * ```
+ *
+ * @example Auto-firing query with variables:
+ * ```tsx
+ * const [refetch, { data, loading }] = useAuthQuery(GET_ORGANIZATION_DETAILS, { id: orgId });
+ * // Query fires automatically when orgId and token are available
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function useAuthQuery<T, V extends OperationVariables>(query: TypedDocumentNode<T, V>, variables?: V): readonly [(input: V["input"]) => Promise<_apollo_client.QueryResult<T, V>>, _apollo_client.QueryResult<T, V>];
+/**
+ * Hook to run a GraphQL mutation with the current user's token. Returns a function you call with the mutation input.
+ *
+ * The input is sent as `variables.input` to the GraphQL endpoint.
+ *
+ * @param mutation - A `TypedDocumentNode` for the mutation (e.g. from codegen or a `gql` template).
+ * @param options - Optional Apollo `MutationHookOptions` (e.g. `onCompleted`, `onError`, `refetchQueries`).
+ * @returns Tuple: `[mutate, result]`.
+ *   - `mutate(input)` — runs the mutation with the given input. Returns a Promise with `{ data }`.
+ *   - `result` — `{ data, loading, error }` from Apollo.
+ *
+ * @example
+ * ```tsx
+ * import { useAuthMutation } from "naystack/graphql/client";
+ * import { CREATE_DEAL } from "@/lib/gql/mutations";
+ *
+ * function CreateDealModal({ propertyId }: { propertyId: number }) {
+ *   const [createDeal, { loading }] = useAuthMutation(CREATE_DEAL);
+ *
+ *   const onSubmit = async (values: FormFields) => {
+ *     const response = await createDeal({
+ *       propertyId,
+ *       share: Number(values.share),
+ *       targetProfit: Number(values.targetProfit),
+ *     });
+ *     const dealId = response.data?.createDeal;
+ *     if (dealId) router.push(`/deals/${dealId}`);
+ *   };
+ *
+ *   return <form onSubmit={handleSubmit(onSubmit)}>...</form>;
+ * }
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function useAuthMutation<T, V extends OperationVariables>(mutation: TypedDocumentNode<T, V>, options?: MutationHookOptions<T, V>): readonly [(input: V["input"]) => Promise<_apollo_client.FetchResult<T>>, _apollo_client.MutationResult<T>];
 export { ApolloWrapper, tokenContext, useAuthMutation, useAuthQuery };

package/dist/graphql/errors.d.mts CHANGED Viewed

@@ -1,5 +1,31 @@
 import { GraphQLError } from 'graphql/error';
+/**
+ * Creates a GraphQL error with an HTTP status code in `extensions.statusCode`.
+ * Use in resolvers when validation, authorization, or lookup fails.
+ *
+ * Default messages by status:
+ * - **400** → "Please provide all required inputs"
+ * - **403** → "You are not allowed to perform this action"
+ * - **404** → "Entity not found"
+ * - **other** → "Server Error"
+ *
+ * @param status - HTTP-like status code (e.g. 400, 403, 404). Defaults to 500.
+ * @param message - Override the default message for the status. If omitted, the default above is used.
+ * @returns GraphQLError with `extensions.statusCode` set.
+ *
+ * @example
+ * ```ts
+ * import { GQLError } from "naystack/graphql";
+ *
+ * // In a resolver:
+ * if (!input.email) throw GQLError(400);
+ * if (!ctx.userId)  throw GQLError(403);
+ * if (!deal)        throw GQLError(404, "Deal not found");
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function GQLError(status?: number, message?: string): GraphQLError;
 export { GQLError };

package/dist/graphql/errors.d.ts CHANGED Viewed

@@ -1,5 +1,31 @@
 import { GraphQLError } from 'graphql/error';
+/**
+ * Creates a GraphQL error with an HTTP status code in `extensions.statusCode`.
+ * Use in resolvers when validation, authorization, or lookup fails.
+ *
+ * Default messages by status:
+ * - **400** → "Please provide all required inputs"
+ * - **403** → "You are not allowed to perform this action"
+ * - **404** → "Entity not found"
+ * - **other** → "Server Error"
+ *
+ * @param status - HTTP-like status code (e.g. 400, 403, 404). Defaults to 500.
+ * @param message - Override the default message for the status. If omitted, the default above is used.
+ * @returns GraphQLError with `extensions.statusCode` set.
+ *
+ * @example
+ * ```ts
+ * import { GQLError } from "naystack/graphql";
+ *
+ * // In a resolver:
+ * if (!input.email) throw GQLError(400);
+ * if (!ctx.userId)  throw GQLError(403);
+ * if (!deal)        throw GQLError(404, "Deal not found");
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function GQLError(status?: number, message?: string): GraphQLError;
 export { GQLError };

package/dist/graphql/index.cjs.js CHANGED Viewed

@@ -627,7 +627,6 @@ function getEnv(key, skipCheck) {
 // src/auth/email/utils.ts
 var import_jsonwebtoken2 = require("jsonwebtoken");
-var import_headers2 = require("next/headers");
 // src/auth/email/token.ts
 var import_bcryptjs = require("bcryptjs");
@@ -717,7 +716,7 @@ async function initGraphQLServer({
 }
 // src/graphql/utils.ts
-var import_headers3 = require("next/headers");
+var import_headers2 = require("next/headers");
 var import_react = require("react");
 var import_type_graphql2 = require("type-graphql");
 function query(fn, options) {
@@ -729,7 +728,7 @@ function query(fn, options) {
   };
 }
 var getUserId = async () => {
-  const Cookie = await (0, import_headers3.cookies)();
+  const Cookie = await (0, import_headers2.cookies)();
   const refresh = Cookie.get(REFRESH_COOKIE_NAME)?.value;
   return refresh ? getUserIdFromRefreshToken(refresh) : null;
 };

package/dist/graphql/index.esm.js CHANGED Viewed

@@ -614,7 +614,6 @@ function getEnv(key, skipCheck) {
 // src/auth/email/utils.ts
 import { verify as verify2 } from "jsonwebtoken";
-import { cookies as cookies2 } from "next/headers";
 // src/auth/email/token.ts
 import { compare } from "bcryptjs";
@@ -704,7 +703,7 @@ async function initGraphQLServer({
 }
 // src/graphql/utils.ts
-import { cookies as cookies3 } from "next/headers";
+import { cookies as cookies2 } from "next/headers";
 import { cache } from "react";
 import {
   Arg,
@@ -725,7 +724,7 @@ function query(fn, options) {
   };
 }
 var getUserId = async () => {
-  const Cookie = await cookies3();
+  const Cookie = await cookies2();
   const refresh = Cookie.get(REFRESH_COOKIE_NAME)?.value;
   return refresh ? getUserIdFromRefreshToken(refresh) : null;
 };

package/dist/graphql/init.cjs.js CHANGED Viewed

@@ -80,7 +80,6 @@ function getEnv(key, skipCheck) {
 // src/auth/email/utils.ts
 var import_jsonwebtoken2 = require("jsonwebtoken");
-var import_headers2 = require("next/headers");
 // src/auth/email/token.ts
 var import_bcryptjs = require("bcryptjs");

package/dist/graphql/init.d.mts CHANGED Viewed

@@ -2,6 +2,39 @@ import { ApolloServerPlugin } from '@apollo/server';
 import { NextRequest } from 'next/server';
 import { AuthChecker, NonEmptyArray } from 'type-graphql';
+/**
+ * Builds the Apollo GraphQL server and Next.js GET/POST route handlers.
+ * Call this at the top level of your GraphQL route file (e.g. `app/api/(graphql)/route.ts`) and export the returned `GET` and `POST`.
+ *
+ * Uses `type-graphql` to build the schema from the resolver classes you provide (created with `QueryLibrary` and `FieldLibrary`).
+ * The default `authChecker` authorizes requests where `context.userId` is truthy.
+ * The default `getContext` reads the `Authorization: Bearer` header or the refresh cookie — pass a custom one to override.
+ *
+ * In production (`NODE_ENV=production`), introspection is disabled and the Apollo production landing page is shown.
+ * In development, the Apollo Sandbox is available.
+ *
+ * @param options - Configuration object.
+ * @param options.authChecker - Optional custom type-graphql `AuthChecker`. Default: authorized if `context.userId` is truthy.
+ * @param options.resolvers - Array of type-graphql resolver classes (from `QueryLibrary` / `FieldLibrary`). **Required.**
+ * @param options.plugins - Optional Apollo Server plugins (e.g. logging, tracing, caching).
+ * @param options.getContext - Optional function to build context from the request. Default: reads Bearer token or refresh cookie.
+ *   Signature: `(req: NextRequest) => Promise<Context> | Context`. Must return at least `{ userId: number | null }`.
+ * @returns Promise of `{ GET, POST }` — export these as your route's handlers.
+ *
+ * @example
+ * ```ts
+ * // app/api/(graphql)/route.ts
+ * import { initGraphQLServer } from "naystack/graphql";
+ * import { UserResolvers, UserFieldResolvers } from "./User/graphql";
+ * import { ChatResolvers } from "./Chat/graphql";
+ *
+ * export const { GET, POST } = await initGraphQLServer({
+ *   resolvers: [UserResolvers, UserFieldResolvers, ChatResolvers],
+ * });
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function initGraphQLServer({ authChecker, resolvers, plugins, getContext: overrideGetContext, }: {
     authChecker?: AuthChecker<any>;
     resolvers: NonEmptyArray<Function>;

package/dist/graphql/init.d.ts CHANGED Viewed

@@ -2,6 +2,39 @@ import { ApolloServerPlugin } from '@apollo/server';
 import { NextRequest } from 'next/server';
 import { AuthChecker, NonEmptyArray } from 'type-graphql';
+/**
+ * Builds the Apollo GraphQL server and Next.js GET/POST route handlers.
+ * Call this at the top level of your GraphQL route file (e.g. `app/api/(graphql)/route.ts`) and export the returned `GET` and `POST`.
+ *
+ * Uses `type-graphql` to build the schema from the resolver classes you provide (created with `QueryLibrary` and `FieldLibrary`).
+ * The default `authChecker` authorizes requests where `context.userId` is truthy.
+ * The default `getContext` reads the `Authorization: Bearer` header or the refresh cookie — pass a custom one to override.
+ *
+ * In production (`NODE_ENV=production`), introspection is disabled and the Apollo production landing page is shown.
+ * In development, the Apollo Sandbox is available.
+ *
+ * @param options - Configuration object.
+ * @param options.authChecker - Optional custom type-graphql `AuthChecker`. Default: authorized if `context.userId` is truthy.
+ * @param options.resolvers - Array of type-graphql resolver classes (from `QueryLibrary` / `FieldLibrary`). **Required.**
+ * @param options.plugins - Optional Apollo Server plugins (e.g. logging, tracing, caching).
+ * @param options.getContext - Optional function to build context from the request. Default: reads Bearer token or refresh cookie.
+ *   Signature: `(req: NextRequest) => Promise<Context> | Context`. Must return at least `{ userId: number | null }`.
+ * @returns Promise of `{ GET, POST }` — export these as your route's handlers.
+ *
+ * @example
+ * ```ts
+ * // app/api/(graphql)/route.ts
+ * import { initGraphQLServer } from "naystack/graphql";
+ * import { UserResolvers, UserFieldResolvers } from "./User/graphql";
+ * import { ChatResolvers } from "./Chat/graphql";
+ *
+ * export const { GET, POST } = await initGraphQLServer({
+ *   resolvers: [UserResolvers, UserFieldResolvers, ChatResolvers],
+ * });
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function initGraphQLServer({ authChecker, resolvers, plugins, getContext: overrideGetContext, }: {
     authChecker?: AuthChecker<any>;
     resolvers: NonEmptyArray<Function>;

package/dist/graphql/init.esm.js CHANGED Viewed

@@ -61,7 +61,6 @@ function getEnv(key, skipCheck) {
 // src/auth/email/utils.ts
 import { verify as verify2 } from "jsonwebtoken";
-import { cookies as cookies2 } from "next/headers";
 // src/auth/email/token.ts
 import { compare } from "bcryptjs";

package/dist/graphql/server.d.mts CHANGED Viewed

@@ -2,12 +2,67 @@ import { OperationVariables } from '@apollo/client';
 import { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import React__default, { FC } from 'react';
+/** Component props type minus loading and data (inferred from Injector Component). */
 type OmittedProps<Y> = Omit<Omit<Y, "loading">, "data">;
+/** Props for Injector: either optional or required based on remaining Component props. */
 type ComponentProps<Y> = OmittedProps<Y> extends Record<string, never> ? {
     props?: object;
 } : {
     props: OmittedProps<Y>;
 };
+/**
+ * Server component that wraps a client component with server-fetched data using Suspense.
+ *
+ * While the `fetch` function is resolving, the `Component` is rendered with `loading={true}` (and no `data`).
+ * Once the fetch resolves, the `Component` re-renders with `loading={false}` and `data` set to the result.
+ *
+ * This is the primary way to inject server-side data into client components in naystack.
+ * Use `.authCall()` or `.call()` from your query definitions inside the `fetch` function.
+ *
+ * @param injectorProps - Configuration object.
+ * @param injectorProps.fetch - Async function that returns the data to pass to the component. Runs on the server.
+ * @param injectorProps.Component - React component that receives `{ data?: T; loading: boolean }` plus any extra props.
+ * @param injectorProps.props - Optional. Any additional props to pass to `Component`. Required if the Component has props other than `data` and `loading`.
+ * @returns A React element that suspends until `fetch()` completes, then renders `Component` with the data.
+ *
+ * @example Simple usage:
+ * ```tsx
+ * import { Injector } from "naystack/graphql/server";
+ * import getCurrentUser from "@/app/api/(graphql)/User/resolvers/get-current-user";
+ * import AuthChecker from "./components/auth-checker";
+ *
+ * export default async function Layout({ children }: { children: React.ReactNode }) {
+ *   return (
+ *     <div>
+ *       {children}
+ *       <Injector fetch={getCurrentUser.authCall} Component={AuthChecker} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example Fetching multiple queries:
+ * ```tsx
+ * import { Injector } from "naystack/graphql/server";
+ * import getCurrentUser from "@/app/api/(graphql)/User/resolvers/get-current-user";
+ * import getChats from "@/app/api/(graphql)/Chat/resolvers/get-chats";
+ * import { ChatWindow } from "./components/chat-window";
+ *
+ * export default async function ChatPage() {
+ *   return (
+ *     <Injector
+ *       fetch={async () => ({
+ *         user: await getCurrentUser.authCall(),
+ *         chats: await getChats.authCall(),
+ *       })}
+ *       Component={ChatWindow}
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * @category GraphQL
+ */
 declare function Injector<T, Y>({ fetch, Component, props, }: {
     fetch: () => Promise<T>;
     Component: FC<{
@@ -15,6 +70,39 @@ declare function Injector<T, Y>({ fetch, Component, props, }: {
         loading: boolean;
     } & Y>;
 } & ComponentProps<Y>): React__default.JSX.Element;
+/**
+ * Runs a raw GraphQL query on the server using the registered Apollo client.
+ * Cookies are forwarded automatically so the backend can identify the user.
+ *
+ * Use this in Server Components, Server Actions, or route handlers when you need to
+ * run a query against the GraphQL endpoint (rather than calling a resolver directly with `.call()`/`.authCall()`).
+ *
+ * Supports Next.js ISR via `revalidate` and on-demand revalidation via `tags`.
+ *
+ * @param _query - A `TypedDocumentNode` (e.g. from codegen) defining the query and its result type.
+ * @param options - Optional query options.
+ * @param options.variables - Variables object for the query (must match the document's variable types).
+ * @param options.revalidate - Next.js revalidate in seconds; when set, enables caching with this TTL.
+ * @param options.tags - Next.js cache tags for on-demand revalidation.
+ * @param options.noCookie - If `true`, the request is sent without cookies (unauthenticated).
+ * @returns Promise resolving to the query result data (typed by the document).
+ *
+ * @example
+ * ```ts
+ * import { query } from "naystack/graphql/server";
+ * import { GetUserDocument } from "@/generated/graphql";
+ *
+ * // In a Server Component:
+ * const data = await query(GetUserDocument, {
+ *   variables: { id: userId },
+ *   revalidate: 60,       // Cache for 60s (Next.js ISR)
+ *   tags: ["user"],        // For on-demand revalidation
+ * });
+ * return <Profile user={data.user} />;
+ * ```
+ *
+ * @category GraphQL
+ */
 declare const query: <T, V extends OperationVariables>(_query: TypedDocumentNode<T, V>, options?: {
     variables?: V;
     revalidate?: number;