import type { GadgetRecord, RecordShape } from "./GadgetRecord.js"; import type { GadgetRecordList } from "./GadgetRecordList.js"; import type { LimitToKnownKeys, VariablesOptions } from "./types.js"; export type PromiseOrLiveIterator = Promise | AsyncIterable; export type AsyncRecord = PromiseOrLiveIterator>; export type AsyncNullableRecord = PromiseOrLiveIterator | null>; export type AsyncRecordList = PromiseOrLiveIterator>; export interface GQLBuilderResult { query: string; variables: Record; } export interface FindOneFunction { (fieldValue: string, options?: LimitToKnownKeys): AsyncRecord; type: "findOne"; findByVariableName: string; operationName: string; modelApiIdentifier: string; defaultSelection: DefaultsT; namespace?: string | string[] | null; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; plan?: (fieldValue: string, options?: LimitToKnownKeys) => GQLBuilderResult; } export interface MaybeFindOneFunction { (fieldValue: string, options?: LimitToKnownKeys): AsyncNullableRecord; type: "maybeFindOne"; findByVariableName: string; operationName: string; modelApiIdentifier: string; defaultSelection: DefaultsT; namespace?: string | string[] | null; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; plan?: (fieldValue: string, options?: LimitToKnownKeys) => GQLBuilderResult; } export interface FindManyFunction { (options?: LimitToKnownKeys): AsyncRecordList; type: "findMany"; operationName: string; modelApiIdentifier: string; defaultSelection: DefaultsT; namespace?: string | string[] | null; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; plan?: (options?: LimitToKnownKeys) => GQLBuilderResult; } export interface FindFirstFunction { (options?: LimitToKnownKeys): AsyncRecord; type: "findFirst"; operationName: string; modelApiIdentifier: string; defaultSelection: DefaultsT; namespace?: string | string[] | null; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; plan?: (options?: LimitToKnownKeys) => GQLBuilderResult; } export interface MaybeFindFirstFunction { (options?: LimitToKnownKeys): AsyncNullableRecord; type: "maybeFindFirst"; operationName: string; modelApiIdentifier: string; defaultSelection: DefaultsT; namespace?: string | string[] | null; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; plan?: (options?: LimitToKnownKeys) => GQLBuilderResult; } export interface ViewFunctionWithoutVariables { (): Promise; type: "computedView"; operationName: string; gqlFieldName: string; namespace?: string | string[] | null; referencedTypenames?: string[]; resultType: ResultT; plan(): GQLBuilderResult; } export interface ViewFunctionWithVariables { (variables: VariablesT): Promise; type: "computedView"; operationName: string; gqlFieldName: string; namespace?: string | string[] | null; referencedTypenames?: string[]; variables: VariablesOptions; variablesType: VariablesT; resultType: ResultT; plan(variables: VariablesOptions): GQLBuilderResult; } export type ViewFunction = ViewFunctionWithoutVariables | ViewFunctionWithVariables; export interface ActionWithIdAndVariables { (id: string, variables: VariablesT, options?: LimitToKnownKeys): AsyncRecord | Promise; } export interface ActionWithNoIdAndVariables { (variables: VariablesT, options?: LimitToKnownKeys): AsyncRecord; } export interface ActionWithIdAndNoVariables { (id: string, options?: LimitToKnownKeys): AsyncRecord | Promise; } export interface ActionWithNoIdAndNoVariables { (options?: LimitToKnownKeys): AsyncRecord; } export interface BulkActionWithIdsAndNoVariables { (ids: string[], options?: LimitToKnownKeys): AsyncRecord; } export interface BulkActionWithInputs { (inputs: VariablesT, options?: LimitToKnownKeys): AsyncRecord; } export type HasReturnType = boolean | Record; export interface ActionFunctionMetadata { type: "action"; operationName: string; operationReturnType?: string; namespace: string | string[] | null; modelApiIdentifier: string; operatesWithRecordIdentity?: boolean; modelSelectionField: string; defaultSelection: DefaultsT; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; variables: VariablesOptions; variablesType: VariablesT; isBulk: IsBulk; hasAmbiguousIdentifier?: boolean; acceptsModelInput?: boolean; paramOnlyVariables?: readonly string[]; hasReturnType?: HasReturnType; singleActionFunctionName?: string; singleAction?: IsBulk extends true ? ActionFunctionMetadata : never; plan?: (options?: LimitToKnownKeys) => GQLBuilderResult; /** @deprecated */ hasCreateOrUpdateEffect?: boolean; } export type StubbedActionReason = "MissingApiTrigger"; export interface StubbedActionFunctionMetadata { type: "stubbedAction"; functionName: string; operationName?: string; errorMessage: string; actionApiIdentifier: string; modelApiIdentifier?: string; variables: VariablesOptions; reason: StubbedActionReason; dataPath: string; } export type StubbedActionFunction = StubbedActionFunctionMetadata & ActionWithNoIdAndNoVariables; export type ActionFunction = ActionFunctionMetadata & (ActionWithIdAndVariables | ActionWithIdAndNoVariables | ActionWithNoIdAndVariables | ActionWithNoIdAndNoVariables); export type BulkActionFunction = ActionFunctionMetadata & (BulkActionWithIdsAndNoVariables | BulkActionWithInputs); export interface GetFunction { (options?: LimitToKnownKeys): AsyncRecord>; type: "get"; operationName: string; modelApiIdentifier: string; defaultSelection: DefaultsT; namespace?: string | string[] | null; selectionType: SelectionT; optionsType: OptionsT; schemaType: SchemaT | null; plan?: (options?: LimitToKnownKeys) => GQLBuilderResult; } export interface GlobalActionFunction { (variables: VariablesT): Promise; type: "globalAction"; operationName: string; operationReturnType?: string; namespace: string | string[] | null; variables: VariablesOptions; variablesType: VariablesT; isBulk?: undefined; plan?: (variables?: VariablesOptions) => GQLBuilderResult; } export type AnyActionFunction = ActionFunctionMetadata | ActionFunctionMetadata | GlobalActionFunction; export type AnyBulkActionFunction = ActionFunctionMetadata;