Skip to content

Update Payment Customization function templates #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: update-function-templates-2025-07
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
839 changes: 625 additions & 214 deletions checkout/javascript/payment-customization/default/schema.graphql

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
api_version = "2025-01"
api_version = "2025-07"

[[extensions]]
name = "t:name"
Expand All @@ -8,9 +8,9 @@ type = "function"
description = "t:description"

[[extensions.targeting]]
target = "purchase.payment-customization.run"
input_query = "src/run.graphql"
export = "run"
target = "cart.payment-methods.transform.run"
input_query = "src/cart_payment_methods_transform_run.graphql"
export = "cart-payment-methods-transform-run"

[extensions.build]
command = ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
query RunInput {
query CartPaymentMethodsTransformRunInput {
paymentCustomization {
metafield(namespace: "$app:{{handle | replace: " ", "-" | downcase}}", key: "function-configuration") {
value
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{%- if flavor contains "vanilla-js" -%}
// @ts-check

/**
* @typedef {import("../generated/api").CartPaymentMethodsTransformRunInput} CartPaymentMethodsTransformRunInput
* @typedef {import("../generated/api").CartPaymentMethodsTransformRunResult} CartPaymentMethodsTransformRunResult
*/

/**
* @type {CartPaymentMethodsTransformRunResult}
*/
const NO_CHANGES = {
operations: [],
};

/**
* @param {CartPaymentMethodsTransformRunInput} input
* @returns {CartPaymentMethodsTransformRunResult}
*/
export function cartPaymentMethodsTransformRun(input) {
const configuration = JSON.parse(
input?.paymentCustomization?.metafield?.value ?? "{}"
);

return NO_CHANGES;
};
{%- elsif flavor contains "typescript" -%}
import type {
CartPaymentMethodsTransformRunInput,
CartPaymentMethodsTransformRunResult,
} from "../generated/api";

const NO_CHANGES: CartPaymentMethodsTransformRunResult = {
operations: [],
};

type Configuration = {};

export function cartPaymentMethodsTransformRun(input: CartPaymentMethodsTransformRunInput): CartPaymentMethodsTransformRunResult {
const configuration: Configuration = JSON.parse(
input?.paymentCustomization?.metafield?.value ?? "{}"
);
return NO_CHANGES;
};
{%- endif -%}
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
{%- if flavor contains "vanilla-js" -%}
import { describe, it, expect } from 'vitest';
import { run } from './run';
import { cartPaymentMethodsTransformRun } from './cart_payment_methods_transform_run';

/**
* @typedef {import("../generated/api").FunctionRunResult} FunctionRunResult
* @typedef {import("../generated/api").CartPaymentMethodsTransformRunResult} CartPaymentMethodsTransformRunResult
*/

describe('payment customization function', () => {
it('returns no operations without configuration', () => {
const result = run({
const result = cartPaymentMethodsTransformRun({
paymentCustomization: {
metafield: null
}
});
const expected = /** @type {FunctionRunResult} */ ({ operations: [] });
const expected = /** @type {CartPaymentMethodsTransformRunResult} */ ({ operations: [] });

expect(result).toEqual(expected);
});
});
{%- elsif flavor contains "typescript" -%}
import { describe, it, expect } from 'vitest';
import { run } from './run';
import { FunctionRunResult } from '../generated/api';
import { cartPaymentMethodsTransformRun } from './cart_payment_methods_transform_run';
import { CartPaymentMethodsTransformRunResult } from '../generated/api';

describe('payment customization function', () => {
it('returns no operations without configuration', () => {
const result = run({
const result = cartPaymentMethodsTransformRun({
paymentCustomization: {
metafield: null
}
});
const expected: FunctionRunResult = { operations: [] };
const expected: CartPaymentMethodsTransformRunResult = { operations: [] };

expect(result).toEqual(expected);
});
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export * from './run';
export * from './cart_payment_methods_transform_run';
45 changes: 0 additions & 45 deletions checkout/javascript/payment-customization/default/src/run.liquid

This file was deleted.

Loading