components/apple/test

Variables

default

default: object;

Type Declaration

modules

modules: Record<string, () => Promise<unknown>>;

registerAppleOauth

registerAppleOauth: (t, name) => void;

Register the Apple OAuth component with a convex-test instance.

Parameters

Parameter	Type	Default value	Description
t	TestConvex<SchemaDefinition<GenericSchema, boolean>>	undefined	The test convex instance, e.g. from calling convexTest.
name	string	"authApple"	The mount name of this component instance, as registered in convex.config.ts. Defaults to "authApple".

Returns

void

schema

schema: SchemaDefinition<{
  authorizationRequests: TableDefinition<VObject<{
     callbackUrl: string;
     codeVerifier: string;
     expiresAt: number;
     redirectTo: string;
     stateHash: string;
   }, {
     callbackUrl: VString<string, "required">;
     codeVerifier: VString<string, "required">;
     expiresAt: VFloat64<number, "required">;
     redirectTo: VString<string, "required">;
     stateHash: VString<string, "required">;
   }, "required", 
     | "redirectTo"
     | "stateHash"
     | "expiresAt"
     | "callbackUrl"
     | "codeVerifier">, {
     stateHash: ["stateHash", "_creationTime"];
   }, {
   }, {
  }>;
  tickets: TableDefinition<VObject<{
     encryptedPayload: string;
     expiresAt: number;
     stateHash: string;
     ticketCodeHash: string;
   }, {
     encryptedPayload: VString<string, "required">;
     expiresAt: VFloat64<number, "required">;
     stateHash: VString<string, "required">;
     ticketCodeHash: VString<string, "required">;
   }, "required", "stateHash" | "expiresAt" | "ticketCodeHash" | "encryptedPayload">, {
     ticketCodeHash: ["ticketCodeHash", "_creationTime"];
   }, {
   }, {
  }>;
}, true>;

Functions

registerAppleOauth()

function registerAppleOauth(t, name?): void;

Register the Apple OAuth component with a convex-test instance.

Parameters

Parameter	Type	Default value	Description
t	TestConvex<SchemaDefinition<GenericSchema, boolean>>	undefined	The test convex instance, e.g. from calling convexTest.
name	string	"authApple"	The mount name of this component instance, as registered in convex.config.ts. Defaults to "authApple".

Returns

void