Fold functions-pickup-point-delivery-option-generators js and ts impl

Author: tjoyal

functions-pickup-point-delivery-option-generators-js/src/fetch.liquid

@@ -1,3 +1,4 @@
+{%- if flavor contains "vanilla-js" -%}
 export function fetch(input) {
     let { countryCode, longitude, latitude } = input.deliveryAddress;
     if (longitude && latitude && countryCode === 'CA') {
@@ -25,3 +26,43 @@ function buildExternalApiRequest(latitude, longitude) {
         },
     };
 }
+{%- elsif flavor contains "typescript" -%}
+import {
+    Maybe,
+    Allocation,
+    MailingAddress,
+    CountryCode,
+    HttpRequest,
+    HttpRequestMethod,
+    FunctionFetchResult,
+    FetchInput
+} from '../generated/api';
+
+export function fetch(input: FetchInput): FunctionFetchResult {
+    let { countryCode, longitude, latitude } = input.deliveryAddress;
+    if (longitude && latitude && countryCode === CountryCode.Ca) {
+        return {
+            request: buildExternalApiRequest(latitude, longitude),
+        };
+    }
+    return { request: null };
+}
+
+function buildExternalApiRequest(latitude: number, longitude: number): HttpRequest {
+    // The latitude and longitude parameters are included in the URL for demonstration purposes only. They do not influence the result.
+    let url = `https://cdn.shopify.com/s/files/1/0628/3830/9033/files/pickup-points-external-api-v2.json?v=1714588690&lat=${latitude}&lon=${longitude}`;
+
+    return {
+        method: HttpRequestMethod.Get,
+        url,
+        headers: [{
+            name: "Accept",
+            value: "application/json; charset=utf-8"
+        }],
+        body: null,
+        policy: {
+            readTimeoutMs: 500,
+        },
+    };
+}
+{%- endif -%}

functions-pickup-point-delivery-option-generators-js/src/fetch.test.liquid

@@ -1,3 +1,4 @@
+{%- if flavor contains "vanilla-js" -%}
 import { describe, it, expect } from 'vitest';
 import { fetch } from './fetch';
 
@@ -44,3 +45,49 @@ describe('fetch function', () => {
     expect(result).toEqual(expected);
   });
 });
+{%- elsif flavor contains "typescript" -%}
+import { describe, it, expect } from 'vitest';
+import { fetch } from './fetch';
+
+import { CountryCode, FunctionFetchResult, HttpRequestMethod } from '../generated/api';
+
+describe('fetch function', () => {
+  it('returns a request when country is Canada', () => {
+    const result = fetch({
+      deliveryAddress: {
+        countryCode: CountryCode.Ca,
+        longitude: 12.3,
+        latitude: 45.6,
+      }
+    });
+    const expected: FunctionFetchResult = ({
+      request: {
+        body: null,
+        headers: [
+          { name: "Accept", value: "application/json; charset=utf-8" },
+        ],
+        method: HttpRequestMethod.Get,
+        policy: {
+          readTimeoutMs: 500,
+        },
+        url: 'https://cdn.shopify.com/s/files/1/0628/3830/9033/files/pickup-points-external-api-v2.json?v=1714588690&lat=45.6&lon=12.3',
+      }
+    });
+
+    expect(result).toEqual(expected);
+  });
+
+  it('returns no request when country is not Canada', () => {
+    const result = fetch({
+      deliveryAddress: {
+        countryCode: CountryCode.Us,
+        longitude: 12.3,
+        latitude: 45.6,
+      }
+    });
+    const expected: FunctionFetchResult = ({ request: null });
+
+    expect(result).toEqual(expected);
+  });
+});
+{%- endif -%}

functions-pickup-point-delivery-option-generators-js/src/run.liquid

@@ -1,3 +1,4 @@
+{%- if flavor contains "vanilla-js" -%}
 export function run(input) {
     const { fetchResult } = input;
     const status = fetchResult?.status;
@@ -101,3 +102,118 @@ function formatTime(time) {
 
     return `${hourIn24Format.toString().padStart(2, '0')}:${min}:00`;
 }
+{%- elsif flavor contains "typescript" -%}
+import {
+    BusinessHours,
+    FunctionRunResult,
+    Operation,
+    PickupAddress,
+    PickupPointDeliveryOption,
+    Provider,
+    RunInput
+} from "../generated/api";
+
+export function run(input: RunInput): FunctionRunResult {
+    const { fetchResult } = input;
+    const status = fetchResult?.status;
+    const body = fetchResult?.body;
+
+    let operations: Operation[] = [];
+
+    if (status === 200 && body) {
+        const { deliveryPoints: externalApiDeliveryPoints } = JSON.parse(body);
+        operations = buildPickupPointDeliveryOptionOperations(externalApiDeliveryPoints);
+    }
+
+    return { operations };
+
+}
+
+function buildPickupPointDeliveryOptionOperations(externalApiDeliveryPoints: any[]): Operation[] {
+    return externalApiDeliveryPoints
+        .map(externalApiDeliveryPoint => ({ add: buildPickupPointDeliveryOption(externalApiDeliveryPoint) }));
+}
+
+function buildPickupPointDeliveryOption(externalApiDeliveryPoint: any): PickupPointDeliveryOption {
+    return {
+        cost: null,
+        pickupPoint: {
+            externalId: externalApiDeliveryPoint.pointId,
+            name: externalApiDeliveryPoint.pointName,
+            provider: buildProvider(),
+            address: buildAddress(externalApiDeliveryPoint),
+            businessHours: buildBusinessHours(externalApiDeliveryPoint),
+        },
+    };
+}
+
+function buildProvider(): Provider {
+    return {
+        name: "Shopify TypeScript Demo",
+        logoUrl: "https://cdn.shopify.com/s/files/1/0628/3830/9033/files/shopify_icon_146101.png?v=1706120545",
+    };
+}
+
+function buildAddress(externalApiDeliveryPoint: any): PickupAddress {
+    let location = externalApiDeliveryPoint.location;
+    let addressComponents = location.addressComponents;
+    let geometry = location.geometry.location;
+    let administrativeArea = addressComponents.administrativeArea;
+
+    return {
+        address1: `${addressComponents.streetNumber} ${addressComponents.route}`,
+        address2: null,
+        city: addressComponents.locality,
+        country: addressComponents.country,
+        countryCode: addressComponents.countryCode,
+        latitude: geometry.lat,
+        longitude: geometry.lng,
+        phone: null,
+        province: administrativeArea.name,
+        provinceCode: administrativeArea.code,
+        zip: addressComponents.postalCode,
+    };
+}
+
+// Transforms the opening hours of a delivery point into a vector of `BusinessHours` objects.
+// Each day's opening hours are represented using a `BusinessHours` object as follows:
+// "Monday: 9:00 AM – 5:00 PM" is transformed to {day: "MONDAY", periods: [{opening_time: "09:00:00", closing_time: "17:00:00"}]}
+// "Tuesday: Closed" is transformed to {day: "TUESDAY", periods: []}
+function buildBusinessHours(externalApiDeliveryPoint: any): BusinessHours[] | null {
+    if(!externalApiDeliveryPoint.openingHours){
+        return null;
+    }
+
+    return externalApiDeliveryPoint.openingHours.weekdayText
+        .map((dayOpeningHours: string) => {
+            let dayOpeningHoursParts = dayOpeningHours.split(": ");
+            let dayName = dayOpeningHoursParts[0].toUpperCase();
+            if (dayOpeningHoursParts[1] === "Closed") {
+                return { day: dayName, periods: [] };
+            } else {
+                let openingClosingTimes = dayOpeningHoursParts[1].split(" – ");
+                return {
+                    day: dayName,
+                    periods: [{
+                        openingTime: formatTime(openingClosingTimes[0]),
+                        closingTime: formatTime(openingClosingTimes[1]),
+                    }],
+                };
+            }
+        });
+}
+
+// Converts a time string from 12-hour to 24-hour format.
+// Example: "9:00 AM" => "09:00:00", "5:00 PM" => "17:00:00"
+function formatTime(time: string): string {
+    let timeParts = time.split(' ');
+    let hourMin = timeParts[0].split(':');
+    let hour = parseInt(hourMin[0]);
+    let min = hourMin[1];
+    let period = timeParts[1];
+
+    let hourIn24Format = period === 'AM' ? (hour === 12 ? 0 : hour) : (hour === 12 ? hour : hour + 12);
+
+    return `${hourIn24Format.toString().padStart(2, '0')}:${min}:00`;
+}
+{%- endif -%}