Rename runParameters to args; rename runParameters schema to params

core/actions/_lib/runActionInstance.ts

@@ -27,30 +27,7 @@ type ActionInstanceRunResult = ClientException | ClientExceptionOptions | Action
 type ActionInstanceArgs = {
 	pubId: PubsId;
 	actionInstanceId: ActionInstancesId;
-	runParameters?: Record<string, unknown>;
-};
-
-const recordActionRun = async (
-	actionInstanceId: ActionInstancesId,
-	pubId: PubsId,
-	result: ActionInstanceRunResult,
-	config?: unknown,
-	params?: unknown,
-	event?: Event
-) => {
-	const actionRun = await db
-		.insertInto("action_runs")
-		.values({
-			action_instance_id: actionInstanceId,
-			pub_id: pubId,
-			status: "error" in result ? ActionRunStatus.failure : ActionRunStatus.success,
-			config,
-			params,
-			event,
-		})
-		.execute();
-
-	return actionRun;
+	args?: Record<string, unknown>;
 };
 
 const _runActionInstance = async (
@@ -63,7 +40,7 @@ const _runActionInstance = async (
 		stageId: StagesId;
 	},
 	pub: GetPubResponseBody,
-	runParameters = {}
+	args = {}
 ): Promise<ActionInstanceRunResult> => {
 	if (!actionInstance.action) {
 		return {
@@ -89,11 +66,11 @@ const _runActionInstance = async (
 		};
 	}
 
-	const parsedrunParameters = action.runParameters.safeParse(runParameters ?? {});
-	if (!parsedrunParameters.success) {
+	const parsedArgs = action.params.safeParse(args ?? {});
+	if (!parsedArgs.success) {
 		return {
 			title: "Invalid pub config",
-			cause: parsedrunParameters.error,
+			cause: parsedArgs.error,
 			error: "The action was run with invalid parameters",
 		};
 	}
@@ -116,7 +93,7 @@ const _runActionInstance = async (
 				id: pub.id,
 				values: pub.values as any,
 			},
-			runParameters: runParameters,
+			args: args,
 			stageId: actionInstance.stageId,
 		});
 
@@ -134,7 +111,7 @@ const _runActionInstance = async (
 };
 
 const runAndRecordActionInstance = async (
-	{ pubId, actionInstanceId, runParameters = {} }: ActionInstanceArgs,
+	{ pubId, actionInstanceId, args = {} }: ActionInstanceArgs,
 	event?: Event
 ) => {
 	let result: ActionInstanceRunResult;
@@ -171,31 +148,33 @@ const runAndRecordActionInstance = async (
 			cause: actionInstanceResult.reason,
 		};
 	} else {
-		result = await _runActionInstance(
-			actionInstanceResult.value,
-			pubResult.value,
-			runParameters
-		);
+		result = await _runActionInstance(actionInstanceResult.value, pubResult.value, args);
 	}
 
-	await recordActionRun(
-		actionInstanceId,
-		pubId,
-		result,
-		actionInstanceResult.status === "fulfilled" ? actionInstanceResult.value.config : undefined,
-		runParameters,
-		event
-	);
+	await db
+		.insertInto("action_runs")
+		.values({
+			action_instance_id: actionInstanceId,
+			pub_id: pubId,
+			status: "error" in result ? ActionRunStatus.failure : ActionRunStatus.success,
+			config:
+				actionInstanceResult.status === "fulfilled"
+					? actionInstanceResult.value.config
+					: undefined,
+			params: args,
+			event,
+		})
+		.execute();
 
 	return result;
 };
 
 export const runActionInstance = defineServerAction(async function runActionInstance({
 	pubId,
 	actionInstanceId,
-	runParameters = {},
+	args = {},
 }: ActionInstanceArgs) {
-	return runAndRecordActionInstance({ pubId, actionInstanceId, runParameters });
+	return runAndRecordActionInstance({ pubId, actionInstanceId, args });
 });
 
 export const runInstancesForEvent = async (pubId: PubsId, stageId: StagesId, event: Event) => {

core/actions/email/action.ts

@@ -13,7 +13,7 @@ export const action = defineAction({
 		body: z.string().min(0).max(1_000).describe("Email body||textarea"),
 	}),
 	description: "Send an email to one or more users",
-	runParameters: z
+	params: z
 		.object({
 			email: z
 				.string()

core/actions/email/run.ts

@@ -6,7 +6,7 @@ import type { action } from "./action";
 import { smtpclient } from "~/lib/server/mailgun";
 import { defineRun } from "../types";
 
-export const run = defineRun<typeof action>(async ({ pub, config, runParameters }) => {
+export const run = defineRun<typeof action>(async ({ pub, config, args }) => {
 	try {
 		await smtpclient.sendMail({
 			from: "[email protected]",
@@ -24,7 +24,7 @@ export const run = defineRun<typeof action>(async ({ pub, config, runParameters
 		};
 	}
 
-	logger.info({ msg: "email", pub, config, runParameters });
+	logger.info({ msg: "email", pub, config, args });
 
 	return {
 		success: true,

core/actions/log/action.ts

@@ -11,7 +11,7 @@ export const action = defineAction({
 		debounce: z.number().optional().describe("Debounce time in milliseconds."),
 	}),
 	description: "Log a pub to the console",
-	runParameters: z
+	params: z
 		.object({
 			debounce: z.number().optional().describe("Debounce time in milliseconds."),
 			text: z

core/actions/log/run.ts

@@ -5,17 +5,17 @@ import { logger } from "logger";
 import type { action } from "./action";
 import { defineRun } from "../types";
 
-export const run = defineRun<typeof action>(async ({ pub, config, runParameters }) => {
+export const run = defineRun<typeof action>(async ({ pub, config, args }) => {
 	logger.info({
-		msg: `Logging${runParameters?.text ? ` ${runParameters.text}` : ""}`,
+		msg: `Logging${args?.text ? ` ${args.text}` : ""}`,
 		pub,
 		config,
-		runParameters,
+		args,
 	});
 
 	return {
 		success: true,
-		report: `Logged out ${runParameters?.text || "some data"}, check your console.`,
+		report: `Logged out ${args?.text || "some data"}, check your console.`,
 		data: {},
 	};
 });

core/actions/move/action.ts

@@ -10,7 +10,7 @@ export const action = defineAction({
 		stage: z.string().describe("Destination stage"),
 	}),
 	description: "Move a pub to a different stage",
-	runParameters: z.object({}).optional(),
+	params: z.object({}).optional(),
 	pubFields: [],
 	icon: MoveHorizontal,
 });

core/actions/pdf/action.ts

@@ -11,7 +11,7 @@ export const action = defineAction({
 		margin: z.number().optional().describe("Page margin in pixels"),
 	}),
 	description: "Generate a PDF from a pub",
-	runParameters: z
+	params: z
 		.object({
 			margin: z.number().optional().describe("Page margin in pixels"),
 		})

core/actions/pdf/run.ts

@@ -5,9 +5,9 @@ import { logger } from "logger";
 import type { action } from "./action";
 import { defineRun } from "../types";
 
-export const run = defineRun<typeof action>(async ({ pub, config, runParameters }) => {
+export const run = defineRun<typeof action>(async ({ pub, config, args }) => {
 	await new Promise((resolve) => setTimeout(resolve, 1000));
-	logger.info({ msg: "pdf generated", pub, config, runParameters });
+	logger.info({ msg: "pdf generated", pub, config, args });
 	return {
 		error: "Wow, an error",
 	};

core/actions/pushToV6/action.ts

@@ -12,7 +12,7 @@ export const action = defineAction({
 		authToken: z.string().describe("PubPub v6 API auth token"),
 	}),
 	description: "Sync a PubPub v7 pub to v6",
-	runParameters: z.object({}).optional(),
+	params: z.object({}).optional(),
 	pubFields: [corePubFields.title, corePubFields.content],
 	icon: FileText,
 });

core/actions/pushToV6/run.ts

@@ -172,7 +172,7 @@ const updateV6PubId = async (pubId: string, v6PubId: string) => {
 		.execute();
 };
 
-export const run = defineRun<typeof action>(async ({ pub, config, runParameters }) => {
+export const run = defineRun<typeof action>(async ({ pub, config, args }) => {
 	try {
 		const v6Community = await getV6Community(config.communitySlug, config.authToken);
 
@@ -235,7 +235,7 @@ export const run = defineRun<typeof action>(async ({ pub, config, runParameters
 		};
 	}
 
-	logger.info({ msg: "pub pushed to v6", pub, config, runParameters });
+	logger.info({ msg: "pub pushed to v6", pub, config, args });
 
 	return {
 		success: true,

core/actions/types.ts

@@ -17,18 +17,18 @@ export type ActionPub<T extends ActionPubType> = {
 };
 
 export type RunProps<T extends Action> =
-	T extends Action<infer PT, infer AC, infer RP>
-		? { config: AC; pub: ActionPub<PT>; runParameters: RP; stageId: StagesId }
+	T extends Action<infer P, infer C, infer A>
+		? { config: C; pub: ActionPub<P>; args: A; stageId: StagesId }
 		: never;
 
 export type ConfigProps<C> = {
 	config: C;
 };
 
 export type Action<
-	PT extends ActionPubType = ActionPubType,
-	AC extends object = {},
-	RP extends object | undefined = {} | undefined,
+	P extends ActionPubType = ActionPubType,
+	C extends object = {},
+	A extends object | undefined = {} | undefined,
 	N extends string = string,
 > = {
 	id?: string;
@@ -39,7 +39,7 @@ export type Action<
 	 *
 	 * These are the "statically known" parameters for this action.
 	 */
-	config: z.ZodType<AC>;
+	config: z.ZodType<C>;
 	/**
 	 * The run parameters for this action
 	 *
@@ -48,11 +48,11 @@ export type Action<
 	 * Defining this as an optional Zod schema (e.g. `z.object({/*...*\/}).optional()`) means that the action can be automatically run
 	 * through a rule.
 	 */
-	runParameters: z.ZodType<RP>;
+	params: z.ZodType<A>;
 	/**
 	 * The core pub fields that this action requires in order to run.
 	 */
-	pubFields: PT;
+	pubFields: P;
 	/**
 	 * The icon to display for this action. Used in the UI.
 	 */
@@ -61,11 +61,11 @@ export type Action<
 
 export const defineAction = <
 	T extends ActionPubType,
-	AC extends object,
-	RP extends object | undefined,
+	C extends object,
+	A extends object | undefined,
 	N extends string,
 >(
-	action: Action<T, AC, RP, N>
+	action: Action<T, C, A, N>
 ) => action;
 
 export type ActionSuccess = {

core/app/c/[communitySlug]/stages/manage/components/panel/StagePanelPubsRunActionButton.tsx

@@ -41,7 +41,7 @@ export const StagePanelPubsRunActionButton = ({
 				const result = await runAction({
 					actionInstanceId: actionInstance.id as ActionInstancesId,
 					pubId: pub.id as PubsId,
-					runParameters: values,
+					args: values,
 				});
 
 				if ("success" in result) {
@@ -73,7 +73,7 @@ export const StagePanelPubsRunActionButton = ({
 				<DialogHeader>
 					<DialogTitle>{actionInstance.name || action.name}</DialogTitle>
 				</DialogHeader>
-				<AutoForm formSchema={action.runParameters as ZodObject<{}>} onSubmit={onSubmit}>
+				<AutoForm formSchema={action.params as ZodObject<{}>} onSubmit={onSubmit}>
 					<AutoFormSubmit disabled={isPending}>Run</AutoFormSubmit>
 				</AutoForm>
 			</DialogContent>