Merge pull request #596 from Shopify/dc-local-pickup

Update local pickup examples
Shopify · Feb 24, 2025 · 7fbd371 · 7fbd371
2 parents 7afda8a + 3fa4bdb
commit 7fbd371
Show file tree

Hide file tree

Showing 9 changed files with 120 additions and 93 deletions.
diff --git a/...javascript/local-pickup-delivery-option-generators/default/locales/en.default.json.liquid b/...javascript/local-pickup-delivery-option-generators/default/locales/en.default.json.liquid
@@ -0,0 +1,4 @@
+{
+  "name": "{{name}}",
+  "description": "{{name}}"
+}
diff --git a/order-routing/javascript/local-pickup-delivery-option-generators/default/package.json.liquid b/order-routing/javascript/local-pickup-delivery-option-generators/default/package.json.liquid
@@ -11,14 +11,17 @@
   },
   "codegen": {
     "schema": "schema.graphql",
-    "documents": "input.graphql",
+    "documents": "src/*.graphql",
     "generates": {
       "./generated/api.ts": {
         "plugins": [
           "typescript",
           "typescript-operations"
         ]
       }
+    },
+    "config": {
+      "omitOperationSuffix": true
     }
   },
   "devDependencies": {

diff --git a/.../javascript/local-pickup-delivery-option-generators/default/shopify.extension.toml.liquid b/.../javascript/local-pickup-delivery-option-generators/default/shopify.extension.toml.liquid
@@ -1,8 +1,20 @@
-name = "{{name}}"
-type = "local_pickup_delivery_option_generator"
-{% if uid %}uid = "{{ uid }}"{% endif %}
 api_version = "unstable"
 
-[build]
-command = ""
-path = "dist/function.wasm"
+[[extensions]]
+name = "t:name"
+handle = "{{handle}}"
+type = "function"
+{% if uid %}uid = "{{ uid }}"{% endif %}
+
+  [[extensions.targeting]]
+  target = "purchase.local-pickup-delivery-option-generator.run"
+  input_query = "src/run.graphql"
+  export = "run"
+
+  [extensions.build]
+  command = ""
+  path = "dist/function.wasm"
+
+  [extensions.ui.paths]
+  create = "/"
+  details = "/"
diff --git a/order-routing/javascript/local-pickup-delivery-option-generators/default/src/index.liquid b/order-routing/javascript/local-pickup-delivery-option-generators/default/src/index.liquid
@@ -1,67 +1 @@
-{%- if flavor contains "vanilla-js" -%}
-// @ts-check
-
-/**
- * @typedef {import("../generated/api").InputQuery} InputQuery
- * @typedef {import("../generated/api").FunctionResult} FunctionResult
- */
-
-/**
- * @type {FunctionResult}
- */
-const DELIVERY_OPTION = {
-  operations: [
-    {
-      add: {
-        title: "Main St.",
-        cost: 1.99,
-        pickupLocation: {
-          locationHandle: "2578303",
-          pickupInstruction: "Usually ready in 24 hours."
-        }
-      }
-    }
-  ],
-};
-
-export default /**
- * @param {InputQuery} input
- * @returns {FunctionResult}
- */
-(input) => {
-  const configuration = JSON.parse(
-    input?.deliveryOptionGenerator?.metafield?.value ?? "{}"
-  );
-
-  return DELIVERY_OPTION;
-};
-{%- elsif flavor contains "typescript" -%}
-import {
-  InputQuery,
-  FunctionResult,
-} from "../generated/api";
-
-const DELIVERY_OPTION: FunctionResult = {
-  operations: [
-    {
-      add: {
-        title: "Main St.",
-        cost: 1.99,
-        pickupLocation: {
-          locationHandle: "2578303",
-          pickupInstruction: "Usually ready in 24 hours."
-        }
-      }
-    }
-  ],
-};
-
-type Configuration = {};
-
-export default (input: InputQuery): FunctionResult => {
-  const configuration: Configuration = JSON.parse(
-    input?.deliveryOptionGenerator?.metafield?.value ?? "{}"
-  );
-  return DELIVERY_OPTION;
-};
-{%- endif -%}
+export * from './run';
diff --git a/...n-generators/default/input.graphql.liquid → ...generators/default/src/run.graphql.liquid b/...n-generators/default/input.graphql.liquid → ...generators/default/src/run.graphql.liquid
@@ -1,4 +1,4 @@
-query Input {
+query RunInput {
   cart {
     lines {
       id

diff --git a/order-routing/javascript/local-pickup-delivery-option-generators/default/src/run.liquid b/order-routing/javascript/local-pickup-delivery-option-generators/default/src/run.liquid
@@ -0,0 +1,61 @@
+{%- if flavor contains "vanilla-js" -%}
+// @ts-check
+
+/**
+ * @typedef {import("../generated/api").RunInput} RunInput
+ * @typedef {import("../generated/api").FunctionRunResult} FunctionRunResult
+ */
+
+/**
+ * @param {RunInput} input
+ * @returns {FunctionRunResult}
+ */
+export function run(input) {
+  const configuration = JSON.parse(
+    input?.deliveryOptionGenerator?.metafield?.value ?? "{}"
+  );
+
+  return {
+    operations: [
+      {
+        add: {
+          title: "Main St.",
+          cost: 1.99,
+          pickupLocation: {
+            locationHandle: "2578303",
+            pickupInstruction: "Usually ready in 24 hours."
+          }
+        }
+      }
+    ],
+  };
+}
+{%- elsif flavor contains "typescript" -%}
+import {
+  RunInput,
+  FunctionRunResult,
+} from "../generated/api";
+
+type Configuration = {};
+
+export function run(input: RunInput): FunctionRunResult {
+  const configuration: Configuration = JSON.parse(
+    input?.deliveryOptionGenerator?.metafield?.value ?? "{}"
+  );
+
+  return {
+    operations: [
+      {
+        add: {
+          title: "Main St.",
+          cost: 1.99,
+          pickupLocation: {
+            locationHandle: "2578303",
+            pickupInstruction: "Usually ready in 24 hours."
+          }
+        }
+      }
+    ],
+  };
+}
+{%- endif -%}
diff --git a/...-generators/default/src/index.test.liquid → ...on-generators/default/src/run.test.liquid b/...-generators/default/src/index.test.liquid → ...on-generators/default/src/run.test.liquid
@@ -1,14 +1,15 @@
 {%- if flavor contains "vanilla-js" -%}
 import { describe, it, expect } from 'vitest';
-import deliveryOptionGenerator from './index';
+import { run } from './run';
 
 /**
- * @typedef {import("../generated/api").FunctionResult} FunctionResult
+ * @typedef {import("../generated/api").RunInput} RunInput
+ * @typedef {import("../generated/api").FunctionRunResult} FunctionRunResult
  */
 
 describe('local pickup delivery option generator function', () => {
   it('returns a delivery option', () => {
-    const result = deliveryOptionGenerator({
+    const result = run({
       cart: {
         lines: [
           {
@@ -43,7 +44,7 @@ describe('local pickup delivery option generator function', () => {
         metafield: null
       }
     });
-    const expected = /** @type {FunctionResult} */ ({
+    const expected = /** @type {FunctionRunResult} */ ({
       operations: [
         {
           add: {
@@ -63,12 +64,12 @@ describe('local pickup delivery option generator function', () => {
 });
 {%- elsif flavor contains "typescript" -%}
 import { describe, it, expect } from 'vitest';
-import deliveryOptionGenerator from './index';
-import { FunctionResult } from '../generated/api';
+import { run } from './run';
+import { RunInput, FunctionRunResult } from '../generated/api';
 
 describe('local pickup delivery option generator function', () => {
   it('returns a delivery option', () => {
-    const result = deliveryOptionGenerator({
+    const result = run({
       cart: {
         lines: [
           {
@@ -103,7 +104,7 @@ describe('local pickup delivery option generator function', () => {
         metafield: null
       }
     });
-    const expected: FunctionResult = {
+    const expected: FunctionRunResult = {
       operations: [
         {
           add: {

diff --git a/...uting/rust/local-pickup-delivery-option-generators/default/locales/en.default.json.liquid b/...uting/rust/local-pickup-delivery-option-generators/default/locales/en.default.json.liquid
@@ -0,0 +1,4 @@
+{
+  "name": "{{name}}",
+  "description": "{{name}}"
+}
diff --git a/...outing/rust/local-pickup-delivery-option-generators/default/shopify.extension.toml.liquid b/...outing/rust/local-pickup-delivery-option-generators/default/shopify.extension.toml.liquid
@@ -1,13 +1,21 @@
-name = "{{name}}"
-type = "local_pickup_delivery_option_generator"
-{% if uid %}uid = "{{ uid }}"{% endif %}
 api_version = "unstable"
 
-[build]
-command = "cargo build --target=wasm32-wasip1 --release"
-path = "target/wasm32-wasip1/release/{{name | replace: " ", "-" | downcase}}.wasm"
-watch = [ "src/**/*.rs" ]
+[[extensions]]
+name = "t:name"
+handle = "{{handle}}"
+type = "function"
+{% if uid %}uid = "{{ uid }}"{% endif %}
+
+  [[extensions.targeting]]
+  target = "purchase.local-pickup-delivery-option-generator.run"
+  input_query = "src/run.graphql"
+  export = "run"
+
+  [extensions.build]
+  command = "cargo build --target=wasm32-wasip1 --release"
+  path = "target/wasm32-wasip1/release/{{handle | replace: " ", "-" | downcase}}.wasm"
+  watch = [ "src/**/*.rs" ]
 
-[ui.paths]
-create = "/"
-details = "/"
+  [extensions.ui.paths]
+  create = "/"
+  details = "/"