@zeroin.earth/appwrite-graphql 0.13.0

package/dist/index.d.ts

@@ -0,0 +1,349 @@
+import * as _graphql_typed_document_node_core from '@graphql-typed-document-node/core';
+import { TypedDocumentNode, DocumentTypeDecoration } from '@graphql-typed-document-node/core';
+import { Account, Client, Models, AppwriteException } from 'appwrite';
+import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
+import { DefaultError, UseMutationOptions, QueryKey, UndefinedInitialDataOptions, DefinedInitialDataOptions, UseQueryOptions } from '@tanstack/react-query';
+import * as _tanstack_query_core_build_legacy_queryClient_bm_z2rsD from '@tanstack/query-core/build/legacy/queryClient-bm-z2rsD';
+
+type Maybe<T> = T | null;
+/** All built-in and custom scalars, mapped to their actual values */
+type Scalars = {
+    ID: {
+        input: string;
+        output: string;
+    };
+    String: {
+        input: string;
+        output: string;
+    };
+    Boolean: {
+        input: boolean;
+        output: boolean;
+    };
+    Int: {
+        input: number;
+        output: number;
+    };
+    Float: {
+        input: number;
+        output: number;
+    };
+    Date: {
+        input: any;
+        output: any;
+    };
+    JSON: {
+        input: any;
+        output: any;
+    };
+};
+type Preferences = {
+    __typename?: 'Preferences';
+    data?: Maybe<Scalars['JSON']['output']>;
+};
+type Session = {
+    __typename?: 'Session';
+    current?: Maybe<Scalars['Boolean']['output']>;
+    expire?: Maybe<Scalars['String']['output']>;
+    userId?: Maybe<Scalars['String']['output']>;
+};
+type Token = {
+    __typename?: 'Token';
+    _createdAt?: Maybe<Scalars['String']['output']>;
+    _id?: Maybe<Scalars['String']['output']>;
+    expire?: Maybe<Scalars['String']['output']>;
+    userId?: Maybe<Scalars['String']['output']>;
+};
+type User = {
+    __typename?: 'User';
+    _createdAt?: Maybe<Scalars['Date']['output']>;
+    _id?: Maybe<Scalars['String']['output']>;
+    _updatedAt?: Maybe<Scalars['Date']['output']>;
+    accessedAt?: Maybe<Scalars['String']['output']>;
+    email?: Maybe<Scalars['String']['output']>;
+    emailVerification?: Maybe<Scalars['Boolean']['output']>;
+    labels?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
+    name?: Maybe<Scalars['String']['output']>;
+    phone?: Maybe<Scalars['String']['output']>;
+    phoneVerification?: Maybe<Scalars['Boolean']['output']>;
+    prefs?: Maybe<Preferences>;
+    registration?: Maybe<Scalars['String']['output']>;
+    status?: Maybe<Scalars['String']['output']>;
+};
+type Account_UserFragmentFragment = {
+    __typename?: 'User';
+    name?: string | null;
+    email?: string | null;
+    prefs?: {
+        __typename?: 'Preferences';
+        data?: any | null;
+    } | null;
+} & {
+    ' $fragmentName'?: 'Account_UserFragmentFragment';
+};
+type AccountGetQuery = {
+    __typename?: 'Query';
+    accountGet?: ({
+        __typename?: 'User';
+    } & {
+        ' $fragmentRefs'?: {
+            'Account_UserFragmentFragment': Account_UserFragmentFragment;
+        };
+    }) | null;
+};
+type DeleteSessionMutation = {
+    __typename?: 'Mutation';
+    accountDeleteSession?: {
+        __typename?: 'Status';
+        status?: boolean | null;
+    } | null;
+};
+
+type Variables = Record<string, unknown>;
+declare function useAppwrite(): {
+    account: Account;
+    graphql: {
+        client: Client;
+        query: <T, V extends Variables = Variables>({ query, variables, }: {
+            query: TypedDocumentNode<T, V>;
+            variables?: V;
+        }) => Promise<{
+            data: T;
+            errors: unknown[];
+        }>;
+        mutation: <T_1, V_1 extends Variables = Variables>({ query, variables, }: {
+            query: TypedDocumentNode<T_1, V_1>;
+            variables?: V_1;
+        }) => Promise<{
+            data: T_1;
+            errors: unknown[];
+        }>;
+    };
+};
+
+declare function useMutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>): _tanstack_react_query_build_legacy_types.UseMutationResult<TData, TError, TVariables, TContext>;
+
+declare function useQuery<TQueryFnData, TError, TData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> | DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> | UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): _tanstack_react_query_build_legacy_types.UseQueryResult<TData, TError>;
+
+declare function useQueryClient(): _tanstack_query_core_build_legacy_queryClient_bm_z2rsD.b;
+
+declare function useAccount<Preferences extends Models.Preferences>({ options, }: {
+    options?: UseQueryOptions<AccountGetQuery['accountGet'], AppwriteException, AccountGetQuery['accountGet'], string[]>;
+}): _tanstack_react_query_build_legacy_types.UseQueryResult<{
+    __typename?: "User";
+} & {
+    ' $fragmentRefs'?: {
+        Account_UserFragmentFragment: Account_UserFragmentFragment;
+    };
+}, AppwriteException>;
+
+type LoginProps = {
+    email: string;
+    password: string;
+};
+type OAuthLoginProps = {
+    provider: string;
+    success: string;
+    failure: string;
+};
+declare function useLogin(): {
+    login: _tanstack_react_query_build_legacy_types.UseMutationResult<Session, AppwriteException, LoginProps, unknown>;
+    oAuthLogin: _tanstack_react_query_build_legacy_types.UseMutationResult<void | URL, AppwriteException, OAuthLoginProps, unknown>;
+};
+
+declare function useLogout(): _tanstack_react_query_build_legacy_types.UseMutationResult<{
+    data: DeleteSessionMutation;
+    errors: unknown[];
+}, Error, void, unknown>;
+
+type Props$3 = {
+    email: string;
+    resetUrl: string;
+};
+/**
+ * Send the recovery email to the address supplied
+ */
+declare function usePasswordRecovery(): _tanstack_react_query_build_legacy_types.UseMutationResult<Token, AppwriteException, Props$3, unknown>;
+
+type Props$2 = {
+    userId: string;
+    secret: string;
+    password: string;
+    confirmPassword: string;
+};
+declare function useResetPassword(): _tanstack_react_query_build_legacy_types.UseMutationResult<Token, AppwriteException, Props$2, unknown>;
+
+type SignUpProps = {
+    userId?: string;
+    name?: string;
+    email: string;
+    password: string;
+};
+type VerifyProps = {
+    verifyUrl: string;
+};
+declare function useSignUp(): {
+    signUp: _tanstack_react_query_build_legacy_types.UseMutationResult<User, Error, SignUpProps, unknown>;
+    verifyEmail: _tanstack_react_query_build_legacy_types.UseMutationResult<Token, Error, VerifyProps, unknown>;
+};
+
+type Props$1 = {
+    userId: string | null;
+    secret: string | null;
+};
+declare function useVerification(): _tanstack_react_query_build_legacy_types.UseMutationResult<Token, AppwriteException, Props$1, unknown>;
+
+type Document<T> = T & Models.Document;
+type Collection<T> = Models.DocumentList<Document<T>>;
+
+declare function useCollection<TDocument>({ databaseId, collectionId, queries, options, }: {
+    databaseId: string;
+    collectionId: string;
+    queries: string[];
+    options?: UseQueryOptions<Collection<TDocument>, AppwriteException, Collection<TDocument>, (string | {
+        queries: string[];
+    })[]>;
+}): {
+    documents: Document<TDocument>[];
+    total: number;
+    data: Collection<TDocument>;
+    error: AppwriteException;
+    isError: true;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: AppwriteException;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD._) => Promise<_tanstack_query_core_build_legacy_queryClient_bm_z2rsD.ad<Collection<TDocument>, AppwriteException>>;
+    fetchStatus: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD.a6;
+} | {
+    documents: Document<TDocument>[];
+    total: number;
+    data: Collection<TDocument>;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: AppwriteException;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD._) => Promise<_tanstack_query_core_build_legacy_queryClient_bm_z2rsD.ad<Collection<TDocument>, AppwriteException>>;
+    fetchStatus: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD.a6;
+} | {
+    documents: Document<TDocument>[];
+    total: number;
+    data: undefined;
+    error: AppwriteException;
+    isError: true;
+    isPending: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: AppwriteException;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD._) => Promise<_tanstack_query_core_build_legacy_queryClient_bm_z2rsD.ad<Collection<TDocument>, AppwriteException>>;
+    fetchStatus: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD.a6;
+} | {
+    documents: Document<TDocument>[];
+    total: number;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: AppwriteException;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD._) => Promise<_tanstack_query_core_build_legacy_queryClient_bm_z2rsD.ad<Collection<TDocument>, AppwriteException>>;
+    fetchStatus: _tanstack_query_core_build_legacy_queryClient_bm_z2rsD.a6;
+};
+
+declare function useCreateDocument<TDocument>(databaseId: string, collectionId: string, documentId: string, data: TDocument, permissions?: string[], options?: UseMutationOptions<string | undefined | null, AppwriteException, Document<TDocument>, string[]>): _tanstack_react_query_build_legacy_types.UseMutationResult<string, AppwriteException, Document<TDocument>, string[]>;
+
+declare function useDocument<TDocument>(databaseId: string, collectionId: string, documentId: string, options?: UseQueryOptions<Document<TDocument>, AppwriteException, Document<TDocument>, string[]>): _tanstack_react_query_build_legacy_types.UseQueryResult<Document<TDocument>, AppwriteException>;
+
+type Props = {
+    functionId: string;
+    body?: Record<string, unknown> | undefined;
+    async?: boolean | undefined;
+    path?: string | undefined;
+    method?: string | undefined;
+    headers?: object | undefined;
+};
+declare function useFunction(): {
+    executeFunction: _tanstack_react_query_build_legacy_types.UseMutationResult<Record<string, unknown>, Error, Props, unknown>;
+    currentExecution: _tanstack_react_query_build_legacy_types.UseQueryResult<unknown, unknown>;
+};
+
+type FragmentType<TDocumentType extends DocumentTypeDecoration<any, any>> = TDocumentType extends DocumentTypeDecoration<infer TType, any> ? [TType] extends [{
+    ' $fragmentName'?: infer TKey;
+}] ? TKey extends string ? {
+    ' $fragmentRefs'?: {
+        [key in TKey]: TType;
+    };
+} : never : never : never;
+declare function getFragmentData<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>): TType;
+declare function getFragmentData<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null | undefined): TType | null | undefined;
+declare function getFragmentData<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>): ReadonlyArray<TType>;
+declare function getFragmentData<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined): ReadonlyArray<TType> | null | undefined;
+
+declare const fragments: {
+    Account_UserFragment: _graphql_typed_document_node_core.TypedDocumentNode<Account_UserFragmentFragment, unknown>;
+};
+
+export { fragments, getFragmentData, useAccount, useAppwrite, useCollection, useCreateDocument, useDocument, useFunction, useLogin, useLogout, useMutation, usePasswordRecovery, useQuery, useQueryClient, useResetPassword, useSignUp, useVerification };