@keystrokehq/shopify 0.0.1

package/dist/triggers.mjs

@@ -0,0 +1,138 @@
+import { a as shopifyAppCredentialSet, t as shopify } from "./integration-BN3pjCz4.mjs";
+import { shopifyOrderCancelledEventSchema, shopifyOrderCreatedEventSchema, shopifyOrderFulfilledEventSchema, shopifyOrderUpdatedEventSchema, shopifyOrderWebhookPayloadSchema, shopifyProductCreatedEventSchema, shopifyProductDeletedEventSchema, shopifyProductUpdatedEventSchema, shopifyProductWebhookPayloadSchema } from "./events.mjs";
+import { t as SHOPIFY_WEBHOOK_RUNTIME_DEFINITIONS } from "./webhook-management-BmIxO0vr.mjs";
+import { createHmac, timingSafeEqual } from "node:crypto";
+import { createWebhookTriggerBindingFactory } from "@keystrokehq/integration-authoring";
+
+//#region src/verification.ts
+function getHeader(headers, name) {
+	const normalizedName = name.toLowerCase();
+	for (const [key, value] of Object.entries(headers)) if (key.toLowerCase() === normalizedName) return value;
+}
+function verifyShopifyWebhook(request, webhookSecret) {
+	const signature = getHeader(request.headers, "x-shopify-hmac-sha256");
+	if (!signature) return false;
+	const expectedDigest = createHmac("sha256", webhookSecret).update(request.rawBody, "utf8").digest("base64");
+	const signatureBuffer = Buffer.from(signature, "utf8");
+	const expectedBuffer = Buffer.from(expectedDigest, "utf8");
+	if (signatureBuffer.length !== expectedBuffer.length) return false;
+	return timingSafeEqual(signatureBuffer, expectedBuffer);
+}
+
+//#endregion
+//#region src/triggers.ts
+function getWebhookPath(topic) {
+	const definition = SHOPIFY_WEBHOOK_RUNTIME_DEFINITIONS.find((candidate) => candidate.eventTopic === topic);
+	if (!definition) throw new Error(`Unsupported Shopify webhook topic: ${topic}`);
+	return definition.path;
+}
+function extractStringField(payload, fieldNames) {
+	for (const fieldName of fieldNames) {
+		const value = payload[fieldName];
+		if (typeof value === "string" && value.length > 0) return value;
+	}
+}
+function extractNumberField(payload, fieldNames) {
+	for (const fieldName of fieldNames) {
+		const value = payload[fieldName];
+		if (typeof value === "number" && Number.isFinite(value)) return String(value);
+	}
+}
+function buildShopifyWebhookEventId(topic, payload) {
+	return `${topic}:${extractStringField(payload, ["admin_graphql_api_id"]) ?? extractNumberField(payload, ["id"]) ?? "unknown-resource"}:${extractStringField(payload, [
+		"updated_at",
+		"created_at",
+		"cancelled_at",
+		"processed_at",
+		"published_at"
+	]) ?? "unknown-time"}`;
+}
+function createShopifyWebhookBindingFactory(config) {
+	return createWebhookTriggerBindingFactory({
+		defaultName: config.defaultName,
+		defaultDescription: config.defaultDescription,
+		path: getWebhookPath(config.topic),
+		method: "POST",
+		payload: config.payloadSchema,
+		credentialSets: [shopify, shopifyAppCredentialSet],
+		verify: (request, ctx) => {
+			const appCredentials = ctx.credentials["shopify-app"];
+			if (!verifyShopifyWebhook(request, appCredentials.webhookSecret)) throw new Error("Invalid Shopify webhook signature.");
+		},
+		mapPayload: (payload) => config.eventSchema.parse({
+			eventId: buildShopifyWebhookEventId(config.topic, payload),
+			topic: config.topic,
+			resourceId: extractStringField(payload, ["admin_graphql_api_id"]) ?? extractNumberField(payload, ["id"]),
+			occurredAt: extractStringField(payload, [
+				"updated_at",
+				"created_at",
+				"cancelled_at",
+				"processed_at",
+				"published_at"
+			]),
+			payload
+		}),
+		response: { successStatus: 200 }
+	});
+}
+const productCreatedBinding = createShopifyWebhookBindingFactory({
+	topic: "products/create",
+	defaultName: "Shopify Product Created",
+	defaultDescription: "Trigger when a Shopify product is created.",
+	payloadSchema: shopifyProductWebhookPayloadSchema,
+	eventSchema: shopifyProductCreatedEventSchema
+});
+const productUpdatedBinding = createShopifyWebhookBindingFactory({
+	topic: "products/update",
+	defaultName: "Shopify Product Updated",
+	defaultDescription: "Trigger when a Shopify product is updated.",
+	payloadSchema: shopifyProductWebhookPayloadSchema,
+	eventSchema: shopifyProductUpdatedEventSchema
+});
+const productDeletedBinding = createShopifyWebhookBindingFactory({
+	topic: "products/delete",
+	defaultName: "Shopify Product Deleted",
+	defaultDescription: "Trigger when a Shopify product is deleted.",
+	payloadSchema: shopifyProductWebhookPayloadSchema,
+	eventSchema: shopifyProductDeletedEventSchema
+});
+const orderCreatedBinding = createShopifyWebhookBindingFactory({
+	topic: "orders/create",
+	defaultName: "Shopify Order Created",
+	defaultDescription: "Trigger when a Shopify order is created.",
+	payloadSchema: shopifyOrderWebhookPayloadSchema,
+	eventSchema: shopifyOrderCreatedEventSchema
+});
+const orderUpdatedBinding = createShopifyWebhookBindingFactory({
+	topic: "orders/updated",
+	defaultName: "Shopify Order Updated",
+	defaultDescription: "Trigger when a Shopify order is updated.",
+	payloadSchema: shopifyOrderWebhookPayloadSchema,
+	eventSchema: shopifyOrderUpdatedEventSchema
+});
+const orderCancelledBinding = createShopifyWebhookBindingFactory({
+	topic: "orders/cancelled",
+	defaultName: "Shopify Order Cancelled",
+	defaultDescription: "Trigger when a Shopify order is cancelled.",
+	payloadSchema: shopifyOrderWebhookPayloadSchema,
+	eventSchema: shopifyOrderCancelledEventSchema
+});
+const orderFulfilledBinding = createShopifyWebhookBindingFactory({
+	topic: "orders/fulfilled",
+	defaultName: "Shopify Order Fulfilled",
+	defaultDescription: "Trigger when a Shopify order is fulfilled.",
+	payloadSchema: shopifyOrderWebhookPayloadSchema,
+	eventSchema: shopifyOrderFulfilledEventSchema
+});
+const webhooks = Object.freeze({
+	productCreated: (options) => productCreatedBinding(options),
+	productUpdated: (options) => productUpdatedBinding(options),
+	productDeleted: (options) => productDeletedBinding(options),
+	orderCreated: (options) => orderCreatedBinding(options),
+	orderUpdated: (options) => orderUpdatedBinding(options),
+	orderCancelled: (options) => orderCancelledBinding(options),
+	orderFulfilled: (options) => orderFulfilledBinding(options)
+});
+
+//#endregion
+export { webhooks };

package/dist/webhook-management-BmIxO0vr.mjs

@@ -0,0 +1,150 @@
+import { shopifyGlobalIdSchema, shopifyUserErrorSchema } from "./schemas.mjs";
+import { createShopifyClient } from "./client.mjs";
+import { shopifyWebhookSubscriptionTopicSchema, shopifyWebhookTopicSchema } from "./events.mjs";
+import { z } from "zod";
+
+//#region src/webhook-management.ts
+const shopifyWebhookRuntimeDefinitionSchema = z.object({
+	eventTopic: shopifyWebhookTopicSchema,
+	subscriptionTopic: shopifyWebhookSubscriptionTopicSchema,
+	path: z.string().min(1)
+});
+const SHOPIFY_WEBHOOK_RUNTIME_DEFINITIONS = [
+	{
+		eventTopic: "products/create",
+		subscriptionTopic: "PRODUCTS_CREATE",
+		path: "/shopify/products/create"
+	},
+	{
+		eventTopic: "products/update",
+		subscriptionTopic: "PRODUCTS_UPDATE",
+		path: "/shopify/products/update"
+	},
+	{
+		eventTopic: "products/delete",
+		subscriptionTopic: "PRODUCTS_DELETE",
+		path: "/shopify/products/delete"
+	},
+	{
+		eventTopic: "orders/create",
+		subscriptionTopic: "ORDERS_CREATE",
+		path: "/shopify/orders/create"
+	},
+	{
+		eventTopic: "orders/updated",
+		subscriptionTopic: "ORDERS_UPDATED",
+		path: "/shopify/orders/updated"
+	},
+	{
+		eventTopic: "orders/cancelled",
+		subscriptionTopic: "ORDERS_CANCELLED",
+		path: "/shopify/orders/cancelled"
+	},
+	{
+		eventTopic: "orders/fulfilled",
+		subscriptionTopic: "ORDERS_FULFILLED",
+		path: "/shopify/orders/fulfilled"
+	}
+];
+const webhookSubscriptionSchema = z.object({
+	id: shopifyGlobalIdSchema,
+	topic: shopifyWebhookSubscriptionTopicSchema,
+	uri: z.string().url()
+});
+const listWebhookSubscriptionsResponseSchema = z.object({ webhookSubscriptions: z.object({ nodes: z.array(webhookSubscriptionSchema) }) });
+const createWebhookSubscriptionResponseSchema = z.object({ webhookSubscriptionCreate: z.object({
+	webhookSubscription: webhookSubscriptionSchema.nullable(),
+	userErrors: z.array(shopifyUserErrorSchema)
+}) });
+const deleteWebhookSubscriptionResponseSchema = z.object({ webhookSubscriptionDelete: z.object({
+	deletedWebhookSubscriptionId: shopifyGlobalIdSchema.nullable(),
+	userErrors: z.array(shopifyUserErrorSchema)
+}) });
+function assertNoUserErrors(userErrors) {
+	if (userErrors.length === 0) return;
+	const message = userErrors.map((error) => error.field && error.field.length > 0 ? `${error.field.join(".")}: ${error.message}` : error.message).join("; ");
+	throw new Error(`Shopify webhook subscription error: ${message}`);
+}
+function buildShopifyWebhookCallbackUri(baseUrl, path) {
+	return new URL(path, baseUrl.endsWith("/") ? baseUrl : `${baseUrl}/`).toString();
+}
+async function listShopifyWebhookSubscriptions(credentials) {
+	return (await createShopifyClient(credentials).graphql(`
+      query ListWebhookSubscriptions($topics: [WebhookSubscriptionTopic!]) {
+        webhookSubscriptions(first: 50, topics: $topics) {
+          nodes {
+            id
+            topic
+            uri
+          }
+        }
+      }
+    `, listWebhookSubscriptionsResponseSchema, { variables: { topics: SHOPIFY_WEBHOOK_RUNTIME_DEFINITIONS.map((definition) => definition.subscriptionTopic) } })).webhookSubscriptions.nodes;
+}
+async function createShopifyWebhookSubscription(credentials, topic, uri) {
+	const response = await createShopifyClient(credentials).graphql(`
+      mutation CreateWebhookSubscription(
+        $topic: WebhookSubscriptionTopic!
+        $webhookSubscription: WebhookSubscriptionInput!
+      ) {
+        webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {
+          webhookSubscription {
+            id
+            topic
+            uri
+          }
+          userErrors {
+            field
+            message
+          }
+        }
+      }
+    `, createWebhookSubscriptionResponseSchema, { variables: {
+		topic,
+		webhookSubscription: { uri }
+	} });
+	assertNoUserErrors(response.webhookSubscriptionCreate.userErrors);
+	if (!response.webhookSubscriptionCreate.webhookSubscription) throw new Error(`Shopify did not return the created webhook subscription for ${topic}.`);
+	return response.webhookSubscriptionCreate.webhookSubscription;
+}
+async function deleteShopifyWebhookSubscription(credentials, id) {
+	const response = await createShopifyClient(credentials).graphql(`
+      mutation DeleteWebhookSubscription($id: ID!) {
+        webhookSubscriptionDelete(id: $id) {
+          deletedWebhookSubscriptionId
+          userErrors {
+            field
+            message
+          }
+        }
+      }
+    `, deleteWebhookSubscriptionResponseSchema, { variables: { id } });
+	assertNoUserErrors(response.webhookSubscriptionDelete.userErrors);
+	if (!response.webhookSubscriptionDelete.deletedWebhookSubscriptionId) throw new Error(`Shopify did not confirm deletion for webhook subscription ${id}.`);
+	return response.webhookSubscriptionDelete.deletedWebhookSubscriptionId;
+}
+async function ensureShopifyWebhookSubscriptions(credentials, callbackBaseUrl) {
+	const existing = await listShopifyWebhookSubscriptions(credentials);
+	const kept = [];
+	const created = [];
+	const deleted = [];
+	for (const definition of SHOPIFY_WEBHOOK_RUNTIME_DEFINITIONS) {
+		const expectedUri = buildShopifyWebhookCallbackUri(callbackBaseUrl, definition.path);
+		const matches = existing.filter((subscription) => subscription.topic === definition.subscriptionTopic);
+		const canonical = matches.find((subscription) => subscription.uri === expectedUri);
+		if (canonical) kept.push(canonical.id);
+		for (const subscription of matches) if (!canonical || subscription.id !== canonical.id) deleted.push(await deleteShopifyWebhookSubscription(credentials, subscription.id));
+		if (!canonical) {
+			const createdSubscription = await createShopifyWebhookSubscription(credentials, definition.subscriptionTopic, expectedUri);
+			created.push(createdSubscription.id);
+		}
+	}
+	return {
+		kept,
+		created,
+		deleted
+	};
+}
+
+//#endregion
+export { listShopifyWebhookSubscriptions as i, buildShopifyWebhookCallbackUri as n, ensureShopifyWebhookSubscriptions as r, SHOPIFY_WEBHOOK_RUNTIME_DEFINITIONS as t };

package/package.json

@@ -0,0 +1,130 @@
+{
+  "name": "@keystrokehq/shopify",
+  "version": "0.0.1",
+  "private": false,
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./messaging": {
+      "types": "./dist/messaging.d.mts",
+      "default": "./dist/messaging.mjs"
+    },
+    "./connection": {
+      "types": "./dist/connection.d.mts",
+      "default": "./dist/connection.mjs"
+    },
+    "./client": {
+      "types": "./dist/client.d.mts",
+      "default": "./dist/client.mjs"
+    },
+    "./schemas": {
+      "types": "./dist/schemas.d.mts",
+      "default": "./dist/schemas.mjs"
+    },
+    "./events": {
+      "types": "./dist/events.d.mts",
+      "default": "./dist/events.mjs"
+    },
+    "./shop": {
+      "types": "./dist/shop.d.mts",
+      "default": "./dist/shop.mjs"
+    },
+    "./products": {
+      "types": "./dist/products.d.mts",
+      "default": "./dist/products.mjs"
+    },
+    "./collections": {
+      "types": "./dist/collections.d.mts",
+      "default": "./dist/collections.mjs"
+    },
+    "./orders": {
+      "types": "./dist/orders.d.mts",
+      "default": "./dist/orders.mjs"
+    },
+    "./customers": {
+      "types": "./dist/customers.d.mts",
+      "default": "./dist/customers.mjs"
+    },
+    "./blogs": {
+      "types": "./dist/blogs.d.mts",
+      "default": "./dist/blogs.mjs"
+    },
+    "./articles": {
+      "types": "./dist/articles.d.mts",
+      "default": "./dist/articles.mjs"
+    },
+    "./inventory": {
+      "types": "./dist/inventory.d.mts",
+      "default": "./dist/inventory.mjs"
+    },
+    "./locations": {
+      "types": "./dist/locations.d.mts",
+      "default": "./dist/locations.mjs"
+    },
+    "./fulfillments": {
+      "types": "./dist/fulfillments.d.mts",
+      "default": "./dist/fulfillments.mjs"
+    },
+    "./triggers": {
+      "types": "./dist/triggers.d.mts",
+      "default": "./dist/triggers.mjs"
+    },
+    "./_official": {
+      "types": "./dist/_official/index.d.mts",
+      "default": "./dist/_official/index.mjs"
+    },
+    "./_runtime": {
+      "types": "./dist/_runtime/index.d.mts",
+      "default": "./dist/_runtime/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "typecheck": "tsgo --build",
+    "build": "tsdown",
+    "lint": "biome check .",
+    "test:unit": "vitest run --passWithNoTests --project unit",
+    "test:int": "vitest run --passWithNoTests --project int",
+    "prepublishOnly": "pnpm build && pnpm test:unit",
+    "lint:fix": "biome check --write ."
+  },
+  "dependencies": {
+    "@shopify/admin-api-client": "^1.1.2",
+    "@keystrokehq/credential-connection": "^0.0.1",
+    "@keystrokehq/integration-authoring": "^0.0.1",
+    "@keystrokehq/core": "^0.0.5",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "catalog:",
+    "@keystrokehq/test-utils": "workspace:*",
+    "@keystrokehq/typescript-config": "workspace:*",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "keywords": [
+    "shopify",
+    "keystroke",
+    "integration",
+    "commerce"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/keystrokehq/integrations",
+    "directory": "integrations/shopify"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}