@shopify/ui-extensions-server-kit 0.0.0-nightly-20250605112924

package/src/utilities/assetToString.test.ts

@@ -0,0 +1,16 @@
+import {assetToString} from './assetToString'
+import type {Asset} from '../types'
+
+describe('assetToString tests', () => {
+  test('creates a URL string from an asset', () => {
+    const asset: Asset = {
+      name: 'main',
+      url: 'http://localhost:8000/extensions/00000000/assets/handle.js',
+      lastUpdated: 1637004124,
+    }
+
+    const url = assetToString(asset)
+
+    expect(url).toBe(`${asset.url}?lastUpdated=${asset.lastUpdated}`)
+  })
+})

package/src/utilities/assetToString.ts

@@ -0,0 +1,8 @@
+import type {Asset} from '../types'
+
+export function assetToString(asset: Asset) {
+  // eslint-disable-next-line node/no-unsupported-features/node-builtins
+  const url = new URL(asset.url)
+  url.searchParams.set('lastUpdated', String(asset.lastUpdated))
+  return url.toString()
+}

package/src/utilities/groupByKey.ts

@@ -0,0 +1,3 @@
+export function groupByKey<T extends {[key: string]: unknown}>(key: keyof T, items: T[]): Map<T[keyof T], T> {
+  return new Map(items.map((item) => [item[key], item]))
+}

package/src/utilities/index.ts

@@ -0,0 +1,7 @@
+export * from './groupByKey'
+export * from './noop'
+export * from './replaceUpdated'
+export * from './set'
+export * from './assetToString'
+export * from './isValidSurface'
+export * from './isUIExtension'

package/src/utilities/isUIExtension.ts

@@ -0,0 +1,7 @@
+export function isUIExtension(extension: any): extension is ExtensionServer.UIExtension {
+  return (
+    extension.type === 'ui_extension' &&
+    Array.isArray(extension.extensionPoints) &&
+    extension.extensionPoints.every((extensionPoint: any) => typeof extensionPoint === 'object')
+  )
+}

package/src/utilities/isValidSurface.ts

@@ -0,0 +1,7 @@
+/* eslint-disable @shopify/strict-component-boundaries */
+import {AVAILABLE_SURFACES} from '../ExtensionServerClient/types'
+import type {Surface} from '../ExtensionServerClient/types'
+
+export function isValidSurface(surface: any): surface is Surface {
+  return surface && AVAILABLE_SURFACES.includes(surface)
+}

package/src/utilities/noop.ts

@@ -0,0 +1 @@
+export const noop = () => {}

package/src/utilities/replaceUpdated.test.ts

@@ -0,0 +1,26 @@
+/* eslint-disable id-length */
+import {replaceUpdated} from './replaceUpdated'
+
+describe('replaceUpdated', () => {
+  test('replaces updated items in place, and appends new items', () => {
+    const arr = [
+      {id: 1, a: 'a'},
+      {id: 2, a: 'b'},
+      {id: 3, a: 'c'},
+      {id: 4, a: 'd'},
+    ]
+
+    const updates = [
+      {id: 2, a: 'updated'},
+      {id: 5, a: 'e'},
+    ]
+
+    expect(replaceUpdated(arr, updates, ({id}) => id)).toStrictEqual([
+      {id: 1, a: 'a'},
+      {id: 2, a: 'updated'},
+      {id: 3, a: 'c'},
+      {id: 4, a: 'd'},
+      {id: 5, a: 'e'},
+    ])
+  })
+})

package/src/utilities/replaceUpdated.ts

@@ -0,0 +1,17 @@
+export function replaceUpdated<T>(arr: T[], updates: T[], cb: (v: T) => unknown): T[] {
+  const updatesMap = new Map(updates.map((updated) => [cb(updated), updated]))
+  const updated = arr.map((item) => {
+    // eslint-disable-next-line node/callback-return
+    const key = cb(item)
+    if (updatesMap.has(key)) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const updated = updatesMap.get(key)!
+      updatesMap.delete(key)
+      return updated
+    } else {
+      return item
+    }
+  })
+
+  return [...updated, ...updatesMap.values()]
+}

package/src/utilities/set.test.ts

@@ -0,0 +1,19 @@
+/* eslint-disable id-length */
+import {set} from './set'
+
+describe('set()', () => {
+  test('deep sets object without mutation', () => {
+    const obj = {
+      a: {b: {c: {d: '123'}}},
+    }
+
+    const newObj = set(obj, (o) => o.a.b.c.d, 'abc')
+    expect(newObj).toStrictEqual({
+      a: {b: {c: {d: 'abc'}}},
+    })
+
+    // verify no mutation occurred
+    expect(obj.a.b.c.d).not.toBe('abc')
+    expect(obj.a).not.toBe(newObj.a)
+  })
+})

package/src/utilities/set.ts

@@ -0,0 +1,30 @@
+/**
+ * Deep sets an object in a type-safe way
+ */
+export function set<TObject, TValue>(obj: TObject, pathFn: (o: TObject) => TValue, value: TValue) {
+  const path: string[] = []
+  const proxy: any = new Proxy(
+    {},
+    {
+      get: (_, prop: string) => {
+        path.push(prop)
+        return proxy
+      },
+    },
+  )
+  pathFn(proxy)
+
+  const newObj: TObject = {...obj}
+  let current: any = newObj
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  const lastKey = path.pop()!
+
+  for (const key of path) {
+    current[key] = {...current[key]}
+    current = current[key]
+  }
+
+  current[lastKey] = value
+
+  return newObj
+}

package/testing.d.ts

@@ -0,0 +1 @@
+export * from './dist/testing';

package/testing.js

@@ -0,0 +1 @@
+module.exports = require('./dist/testing/index.cjs');

package/testing.mjs

@@ -0,0 +1 @@
+export * from './dist/testing/index.es.js';

package/tests/setup.ts

@@ -0,0 +1,6 @@
+import 'vi-fetch/setup'
+import {mockFetch} from 'vi-fetch'
+
+beforeEach(() => {
+  mockFetch.clearAll()
+})