@asteroidcms/core-utils 0.1.1 → 0.1.3

package/dist/index.d.cts

@@ -1,9 +1,4 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
-import { PropsWithChildren } from 'react';
-import * as _apollo_client from '@apollo/client';
-import { InMemoryCacheConfig, ApolloClientOptions, ApolloClient } from '@apollo/client';
-import { useMutation } from '@apollo/client/react';
+import { InMemoryCacheConfig, ApolloClientOptions, ApolloClient, DocumentNode } from '@apollo/client';
 
 type AsteroidCMSConfig = {
     /** Base URL of the Asteroid CMS API (e.g. https://cms-api.example.com). */
@@ -30,25 +25,6 @@ type ResolvedAsteroidCMSConfig = Required<Pick<AsteroidCMSConfig, "cmsUrl" | "ap
     onError?: AsteroidCMSConfig["onError"];
 };
 
-type AsteroidCMSProviderProps = PropsWithChildren<AsteroidCMSConfig>;
-/**
- * Root provider for `@asteroidcms/core-utils`.
- *
- * Wrap your app once at the top level:
- *
- * ```tsx
- * <AsteroidCMSProvider cmsUrl="https://cms.example.com" apiKey="...">
- *   <App />
- * </AsteroidCMSProvider>
- * ```
- *
- * Everything below — `useCmsContent`, `useCmsMutate`, `useCmsImage`,
- * `<RichTextContent>` — picks up `cmsUrl` and `apiKey` from this provider.
- */
-declare function AsteroidCMSProvider({ children, ...config }: AsteroidCMSProviderProps): react_jsx_runtime.JSX.Element;
-
-declare function useAsteroidCMSConfig(): ResolvedAsteroidCMSConfig;
-
 declare module "@apollo/client" {
     namespace ApolloClient.DeclareDefaultOptions {
         interface WatchQuery {
@@ -65,15 +41,15 @@ declare module "@apollo/client" {
 }
 declare function createApolloClient(config: AsteroidCMSConfig): ApolloClient;
 
-type FieldSelector$1 = string | {
+type FieldSelector = string | {
     field: string;
     as?: string;
 };
-type ReferenceExpansion$1 = {
+type ReferenceExpansion = {
     field: string;
     as?: string;
     single?: boolean;
-    select?: readonly (FieldSelector$1 | ReferenceExpansion$1)[];
+    select?: readonly (FieldSelector | ReferenceExpansion)[];
 };
 type ContentStatus = "DRAFT" | "PUBLISHED" | "ARCHIVED";
 type CmsSearchCondition = {
@@ -84,126 +60,22 @@ type CmsSearchCondition = {
 type UseCmsContentOptions = {
     schema_slug: string;
     entrySlug?: string;
-    select?: readonly (FieldSelector$1 | ReferenceExpansion$1)[];
+    select?: readonly (FieldSelector | ReferenceExpansion)[];
     fullData?: boolean;
     limit?: number;
     offset?: number;
     status?: ContentStatus;
     filter?: Record<string, string | number | boolean | null>;
     search?: CmsSearchCondition[];
-    variables?: Record<string, any>;
+    variables?: Record<string, unknown>;
 };
-/**
- * React hook for querying content from Asteroid CMS via a flexible GraphQL API.
- *
- * Supports single-entry fetches (`entrySlug`) and paginated/filtered lists,
- * with arbitrarily nested reference expansion and field aliasing.
- */
-declare function useCmsContent<T = unknown>({ schema_slug, entrySlug, select, fullData, limit, offset, status, filter, search, variables, }: UseCmsContentOptions): {
-    client: _apollo_client.ApolloClient;
-    observable: _apollo_client.ObservableQuery<unknown, _apollo_client.OperationVariables>;
-    previousData?: unknown;
-    networkStatus: _apollo_client.NetworkStatus;
-    startPolling: (pollInterval: number) => void;
-    stopPolling: () => void;
-    subscribeToMore: _apollo_client.SubscribeToMoreFunction<unknown, _apollo_client.OperationVariables>;
-    updateQuery: (mapFn: _apollo_client.UpdateQueryMapFn<unknown, _apollo_client.OperationVariables>) => void;
-    refetch: (variables?: Partial<_apollo_client.OperationVariables> | undefined) => Promise<{
-        data: unknown;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    variables: _apollo_client.OperationVariables;
-    fetchMore: <TFetchData = unknown, TFetchVars extends _apollo_client.OperationVariables = _apollo_client.OperationVariables>(fetchMoreOptions: _apollo_client.ObservableQuery.FetchMoreOptions<unknown, _apollo_client.OperationVariables, TFetchData, TFetchVars>) => Promise<{
-        data: TFetchData | undefined;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    dataState: "empty";
-    loading: boolean;
-    error: _apollo_client.ErrorLike | undefined;
-    data: T | undefined;
-} | {
-    client: _apollo_client.ApolloClient;
-    observable: _apollo_client.ObservableQuery<unknown, _apollo_client.OperationVariables>;
-    previousData?: unknown;
-    networkStatus: _apollo_client.NetworkStatus;
-    startPolling: (pollInterval: number) => void;
-    stopPolling: () => void;
-    subscribeToMore: _apollo_client.SubscribeToMoreFunction<unknown, _apollo_client.OperationVariables>;
-    updateQuery: (mapFn: _apollo_client.UpdateQueryMapFn<unknown, _apollo_client.OperationVariables>) => void;
-    refetch: (variables?: Partial<_apollo_client.OperationVariables> | undefined) => Promise<{
-        data: unknown;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    variables: _apollo_client.OperationVariables;
-    fetchMore: <TFetchData = unknown, TFetchVars extends _apollo_client.OperationVariables = _apollo_client.OperationVariables>(fetchMoreOptions: _apollo_client.ObservableQuery.FetchMoreOptions<unknown, _apollo_client.OperationVariables, TFetchData, TFetchVars>) => Promise<{
-        data: TFetchData | undefined;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    dataState: "complete";
-    loading: boolean;
-    error: _apollo_client.ErrorLike | undefined;
-    data: T | undefined;
-} | {
-    client: _apollo_client.ApolloClient;
-    observable: _apollo_client.ObservableQuery<unknown, _apollo_client.OperationVariables>;
-    previousData?: unknown;
-    networkStatus: _apollo_client.NetworkStatus;
-    startPolling: (pollInterval: number) => void;
-    stopPolling: () => void;
-    subscribeToMore: _apollo_client.SubscribeToMoreFunction<unknown, _apollo_client.OperationVariables>;
-    updateQuery: (mapFn: _apollo_client.UpdateQueryMapFn<unknown, _apollo_client.OperationVariables>) => void;
-    refetch: (variables?: Partial<_apollo_client.OperationVariables> | undefined) => Promise<{
-        data: unknown;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    variables: _apollo_client.OperationVariables;
-    fetchMore: <TFetchData = unknown, TFetchVars extends _apollo_client.OperationVariables = _apollo_client.OperationVariables>(fetchMoreOptions: _apollo_client.ObservableQuery.FetchMoreOptions<unknown, _apollo_client.OperationVariables, TFetchData, TFetchVars>) => Promise<{
-        data: TFetchData | undefined;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    dataState: "streaming";
-    loading: boolean;
-    error: _apollo_client.ErrorLike | undefined;
-    data: T | undefined;
+declare function buildCmsQuery({ schema_slug, entrySlug, select, fullData, limit, offset, status, filter, search, variables, }: UseCmsContentOptions): {
+    query: DocumentNode;
+    variables: Record<string, unknown>;
+    isSingle: boolean;
 };
 
-type FieldSelector = string | {
-    field: string;
-    as?: string;
-    single?: boolean;
-    select?: readonly (FieldSelector | ReferenceExpansion)[];
-};
-type ReferenceExpansion = {
-    field: string;
-    as?: string;
-    single?: boolean;
-    select?: readonly (FieldSelector | ReferenceExpansion)[];
-};
-type MutationType = "create" | "update" | "delete";
-type UseCmsMutateOptions = {
-    schema_slug: string;
-    entrySlug?: string;
-    select?: readonly (FieldSelector | ReferenceExpansion)[];
-    fullData?: boolean;
-    mutationType?: MutationType;
-    entryId?: string;
-    variables?: Record<string, any>;
-};
-/**
- * React hook for mutating content in Asteroid CMS (`create` / `update` / `delete`).
- * Uses the same selection syntax as `useCmsContent`.
- */
-declare function useCmsMutate<TData = unknown>({ schema_slug, select, fullData, mutationType, entryId, variables: inputVariables, }: UseCmsMutateOptions): {
-    readonly data: TData | undefined;
-    readonly loading: boolean;
-    readonly called: boolean;
-    readonly client: _apollo_client.ApolloClient;
-    readonly reset: () => void;
-    readonly error: _apollo_client.ErrorLike | undefined;
-    readonly mutate: useMutation.MutationFunction<unknown, {
-        [x: string]: any;
-    }, _apollo_client.ApolloCache, "none">;
-};
+declare function fetchCmsContent<T>(getClient: () => ApolloClient, opts: UseCmsContentOptions): Promise<T>;
 
 /**
  * Build a canonical media URL from an asset id. Pass `cmsUrl` explicitly when
@@ -214,8 +86,6 @@ declare function cmsImage(id: string | undefined, options: {
     cmsUrl: string;
     mediaPath?: string;
 }): string;
-/** Hook variant that pulls `cmsUrl`/`mediaPath` from the provider. */
-declare function useCmsImage(): (id?: string) => string;
 
 type ReadTimeUnit = "short" | "long";
 interface GetContentReadTimeOptions {
@@ -280,19 +150,4 @@ declare function parseRichText(html: string, options?: ParseRichTextOptions): st
  */
 declare function removeEmptyParagraphs(html: string): string;
 
-interface RichTextContentProps {
-    html: string;
-    classMap?: RichTextClassMap;
-    /** Wrapper element. Defaults to `div`. Use `article` for blog content. */
-    as?: keyof React.JSX.IntrinsicElements;
-    className?: string;
-}
-declare function RichTextContent({ html, classMap, as, className, }: RichTextContentProps): react.DOMElement<{
-    ref: react.MutableRefObject<HTMLElement | null>;
-    className: string | undefined;
-    dangerouslySetInnerHTML: {
-        __html: string;
-    };
-}, HTMLElement>;
-
-export { type AsteroidCMSConfig, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ParseRichTextOptions, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, cmsImage, createApolloClient, getContentReadTime, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+export { type AsteroidCMSConfig, type CmsSearchCondition, type ContentStatus, type FieldSelector, type ParseRichTextOptions, type ReferenceExpansion, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, type UseCmsContentOptions, buildCmsQuery, cmsImage, createApolloClient, fetchCmsContent, getContentReadTime, parseRichText, removeEmptyParagraphs };

package/dist/index.d.ts

@@ -1,9 +1,4 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
-import { PropsWithChildren } from 'react';
-import * as _apollo_client from '@apollo/client';
-import { InMemoryCacheConfig, ApolloClientOptions, ApolloClient } from '@apollo/client';
-import { useMutation } from '@apollo/client/react';
+import { InMemoryCacheConfig, ApolloClientOptions, ApolloClient, DocumentNode } from '@apollo/client';
 
 type AsteroidCMSConfig = {
     /** Base URL of the Asteroid CMS API (e.g. https://cms-api.example.com). */
@@ -30,25 +25,6 @@ type ResolvedAsteroidCMSConfig = Required<Pick<AsteroidCMSConfig, "cmsUrl" | "ap
     onError?: AsteroidCMSConfig["onError"];
 };
 
-type AsteroidCMSProviderProps = PropsWithChildren<AsteroidCMSConfig>;
-/**
- * Root provider for `@asteroidcms/core-utils`.
- *
- * Wrap your app once at the top level:
- *
- * ```tsx
- * <AsteroidCMSProvider cmsUrl="https://cms.example.com" apiKey="...">
- *   <App />
- * </AsteroidCMSProvider>
- * ```
- *
- * Everything below — `useCmsContent`, `useCmsMutate`, `useCmsImage`,
- * `<RichTextContent>` — picks up `cmsUrl` and `apiKey` from this provider.
- */
-declare function AsteroidCMSProvider({ children, ...config }: AsteroidCMSProviderProps): react_jsx_runtime.JSX.Element;
-
-declare function useAsteroidCMSConfig(): ResolvedAsteroidCMSConfig;
-
 declare module "@apollo/client" {
     namespace ApolloClient.DeclareDefaultOptions {
         interface WatchQuery {
@@ -65,15 +41,15 @@ declare module "@apollo/client" {
 }
 declare function createApolloClient(config: AsteroidCMSConfig): ApolloClient;
 
-type FieldSelector$1 = string | {
+type FieldSelector = string | {
     field: string;
     as?: string;
 };
-type ReferenceExpansion$1 = {
+type ReferenceExpansion = {
     field: string;
     as?: string;
     single?: boolean;
-    select?: readonly (FieldSelector$1 | ReferenceExpansion$1)[];
+    select?: readonly (FieldSelector | ReferenceExpansion)[];
 };
 type ContentStatus = "DRAFT" | "PUBLISHED" | "ARCHIVED";
 type CmsSearchCondition = {
@@ -84,126 +60,22 @@ type CmsSearchCondition = {
 type UseCmsContentOptions = {
     schema_slug: string;
     entrySlug?: string;
-    select?: readonly (FieldSelector$1 | ReferenceExpansion$1)[];
+    select?: readonly (FieldSelector | ReferenceExpansion)[];
     fullData?: boolean;
     limit?: number;
     offset?: number;
     status?: ContentStatus;
     filter?: Record<string, string | number | boolean | null>;
     search?: CmsSearchCondition[];
-    variables?: Record<string, any>;
+    variables?: Record<string, unknown>;
 };
-/**
- * React hook for querying content from Asteroid CMS via a flexible GraphQL API.
- *
- * Supports single-entry fetches (`entrySlug`) and paginated/filtered lists,
- * with arbitrarily nested reference expansion and field aliasing.
- */
-declare function useCmsContent<T = unknown>({ schema_slug, entrySlug, select, fullData, limit, offset, status, filter, search, variables, }: UseCmsContentOptions): {
-    client: _apollo_client.ApolloClient;
-    observable: _apollo_client.ObservableQuery<unknown, _apollo_client.OperationVariables>;
-    previousData?: unknown;
-    networkStatus: _apollo_client.NetworkStatus;
-    startPolling: (pollInterval: number) => void;
-    stopPolling: () => void;
-    subscribeToMore: _apollo_client.SubscribeToMoreFunction<unknown, _apollo_client.OperationVariables>;
-    updateQuery: (mapFn: _apollo_client.UpdateQueryMapFn<unknown, _apollo_client.OperationVariables>) => void;
-    refetch: (variables?: Partial<_apollo_client.OperationVariables> | undefined) => Promise<{
-        data: unknown;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    variables: _apollo_client.OperationVariables;
-    fetchMore: <TFetchData = unknown, TFetchVars extends _apollo_client.OperationVariables = _apollo_client.OperationVariables>(fetchMoreOptions: _apollo_client.ObservableQuery.FetchMoreOptions<unknown, _apollo_client.OperationVariables, TFetchData, TFetchVars>) => Promise<{
-        data: TFetchData | undefined;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    dataState: "empty";
-    loading: boolean;
-    error: _apollo_client.ErrorLike | undefined;
-    data: T | undefined;
-} | {
-    client: _apollo_client.ApolloClient;
-    observable: _apollo_client.ObservableQuery<unknown, _apollo_client.OperationVariables>;
-    previousData?: unknown;
-    networkStatus: _apollo_client.NetworkStatus;
-    startPolling: (pollInterval: number) => void;
-    stopPolling: () => void;
-    subscribeToMore: _apollo_client.SubscribeToMoreFunction<unknown, _apollo_client.OperationVariables>;
-    updateQuery: (mapFn: _apollo_client.UpdateQueryMapFn<unknown, _apollo_client.OperationVariables>) => void;
-    refetch: (variables?: Partial<_apollo_client.OperationVariables> | undefined) => Promise<{
-        data: unknown;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    variables: _apollo_client.OperationVariables;
-    fetchMore: <TFetchData = unknown, TFetchVars extends _apollo_client.OperationVariables = _apollo_client.OperationVariables>(fetchMoreOptions: _apollo_client.ObservableQuery.FetchMoreOptions<unknown, _apollo_client.OperationVariables, TFetchData, TFetchVars>) => Promise<{
-        data: TFetchData | undefined;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    dataState: "complete";
-    loading: boolean;
-    error: _apollo_client.ErrorLike | undefined;
-    data: T | undefined;
-} | {
-    client: _apollo_client.ApolloClient;
-    observable: _apollo_client.ObservableQuery<unknown, _apollo_client.OperationVariables>;
-    previousData?: unknown;
-    networkStatus: _apollo_client.NetworkStatus;
-    startPolling: (pollInterval: number) => void;
-    stopPolling: () => void;
-    subscribeToMore: _apollo_client.SubscribeToMoreFunction<unknown, _apollo_client.OperationVariables>;
-    updateQuery: (mapFn: _apollo_client.UpdateQueryMapFn<unknown, _apollo_client.OperationVariables>) => void;
-    refetch: (variables?: Partial<_apollo_client.OperationVariables> | undefined) => Promise<{
-        data: unknown;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    variables: _apollo_client.OperationVariables;
-    fetchMore: <TFetchData = unknown, TFetchVars extends _apollo_client.OperationVariables = _apollo_client.OperationVariables>(fetchMoreOptions: _apollo_client.ObservableQuery.FetchMoreOptions<unknown, _apollo_client.OperationVariables, TFetchData, TFetchVars>) => Promise<{
-        data: TFetchData | undefined;
-        error?: _apollo_client.ErrorLike;
-    }>;
-    dataState: "streaming";
-    loading: boolean;
-    error: _apollo_client.ErrorLike | undefined;
-    data: T | undefined;
+declare function buildCmsQuery({ schema_slug, entrySlug, select, fullData, limit, offset, status, filter, search, variables, }: UseCmsContentOptions): {
+    query: DocumentNode;
+    variables: Record<string, unknown>;
+    isSingle: boolean;
 };
 
-type FieldSelector = string | {
-    field: string;
-    as?: string;
-    single?: boolean;
-    select?: readonly (FieldSelector | ReferenceExpansion)[];
-};
-type ReferenceExpansion = {
-    field: string;
-    as?: string;
-    single?: boolean;
-    select?: readonly (FieldSelector | ReferenceExpansion)[];
-};
-type MutationType = "create" | "update" | "delete";
-type UseCmsMutateOptions = {
-    schema_slug: string;
-    entrySlug?: string;
-    select?: readonly (FieldSelector | ReferenceExpansion)[];
-    fullData?: boolean;
-    mutationType?: MutationType;
-    entryId?: string;
-    variables?: Record<string, any>;
-};
-/**
- * React hook for mutating content in Asteroid CMS (`create` / `update` / `delete`).
- * Uses the same selection syntax as `useCmsContent`.
- */
-declare function useCmsMutate<TData = unknown>({ schema_slug, select, fullData, mutationType, entryId, variables: inputVariables, }: UseCmsMutateOptions): {
-    readonly data: TData | undefined;
-    readonly loading: boolean;
-    readonly called: boolean;
-    readonly client: _apollo_client.ApolloClient;
-    readonly reset: () => void;
-    readonly error: _apollo_client.ErrorLike | undefined;
-    readonly mutate: useMutation.MutationFunction<unknown, {
-        [x: string]: any;
-    }, _apollo_client.ApolloCache, "none">;
-};
+declare function fetchCmsContent<T>(getClient: () => ApolloClient, opts: UseCmsContentOptions): Promise<T>;
 
 /**
  * Build a canonical media URL from an asset id. Pass `cmsUrl` explicitly when
@@ -214,8 +86,6 @@ declare function cmsImage(id: string | undefined, options: {
     cmsUrl: string;
     mediaPath?: string;
 }): string;
-/** Hook variant that pulls `cmsUrl`/`mediaPath` from the provider. */
-declare function useCmsImage(): (id?: string) => string;
 
 type ReadTimeUnit = "short" | "long";
 interface GetContentReadTimeOptions {
@@ -280,19 +150,4 @@ declare function parseRichText(html: string, options?: ParseRichTextOptions): st
  */
 declare function removeEmptyParagraphs(html: string): string;
 
-interface RichTextContentProps {
-    html: string;
-    classMap?: RichTextClassMap;
-    /** Wrapper element. Defaults to `div`. Use `article` for blog content. */
-    as?: keyof React.JSX.IntrinsicElements;
-    className?: string;
-}
-declare function RichTextContent({ html, classMap, as, className, }: RichTextContentProps): react.DOMElement<{
-    ref: react.MutableRefObject<HTMLElement | null>;
-    className: string | undefined;
-    dangerouslySetInnerHTML: {
-        __html: string;
-    };
-}, HTMLElement>;
-
-export { type AsteroidCMSConfig, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ParseRichTextOptions, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, cmsImage, createApolloClient, getContentReadTime, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+export { type AsteroidCMSConfig, type CmsSearchCondition, type ContentStatus, type FieldSelector, type ParseRichTextOptions, type ReferenceExpansion, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, type UseCmsContentOptions, buildCmsQuery, cmsImage, createApolloClient, fetchCmsContent, getContentReadTime, parseRichText, removeEmptyParagraphs };