@prismatic-io/components-customer-io 0.0.0-stage → 0.0.1

package/npm-dist/index.cjs

@@ -0,0 +1,265 @@
+let _prismatic_io_spectral = require("@prismatic-io/spectral");
+let _prismatic_io_spectral_http = require("@prismatic-io/spectral/http");
+let customerio_node = require("customerio-node");
+//#region src/inputs/common.ts
+const id = (0, _prismatic_io_spectral.input)({
+	label: "ID",
+	type: "string",
+	required: true,
+	example: "exampleCustomerId",
+	placeholder: "Enter customer ID",
+	comments: "The unique identifier that targets a specific customer record.",
+	clean: _prismatic_io_spectral.util.types.toString
+});
+const region = (0, _prismatic_io_spectral.input)({
+	label: "Region",
+	placeholder: "Enter region",
+	type: "string",
+	model: [{
+		label: "US",
+		value: "US"
+	}, {
+		label: "EU",
+		value: "EU"
+	}],
+	required: true,
+	example: "US",
+	comments: "The region in which the account is configured.",
+	clean: _prismatic_io_spectral.util.types.toString
+});
+const connectionInput = (0, _prismatic_io_spectral.input)({
+	label: "Connection",
+	type: "connection",
+	required: true,
+	comments: "The Customer.io connection to use."
+});
+//#endregion
+//#region src/utils/clean.ts
+const cleanKeyValueList = (value) => _prismatic_io_spectral.util.types.keyValPairListToObject(value);
+const cleanOptionalKeyValueList = (value) => {
+	if (!value || Array.isArray(value) && value.length === 0) return;
+	const result = cleanKeyValueList(value);
+	return Object.keys(result).length > 0 ? result : void 0;
+};
+//#endregion
+//#region src/inputs/customers.ts
+const customerData = (0, _prismatic_io_spectral.input)({
+	label: "Customer Data",
+	type: "string",
+	collection: "keyvaluelist",
+	required: true,
+	comments: "The key and value pairs that make up a customer record. The key must be a string, and the value can be a string, number, array, or object.",
+	clean: cleanKeyValueList
+});
+const eventData = (0, _prismatic_io_spectral.input)({
+	label: "Event Data",
+	type: "string",
+	collection: "keyvaluelist",
+	required: false,
+	comments: "The key and value pairs that describe the event the customer performed.",
+	clean: cleanOptionalKeyValueList
+});
+const eventName = (0, _prismatic_io_spectral.input)({
+	label: "Event Name",
+	example: "myCustomerEvent",
+	placeholder: "Enter event name",
+	type: "string",
+	required: true,
+	comments: "The identifier recorded for the tracked event.",
+	clean: _prismatic_io_spectral.util.types.toString
+});
+const url = (0, _prismatic_io_spectral.input)({
+	label: "URL",
+	type: "string",
+	required: true,
+	example: "www.example.com",
+	placeholder: "Enter page path",
+	comments: "The page path to track. Enter the full path to track a specific page, or use the asterisk '*' to track any page.",
+	clean: _prismatic_io_spectral.util.types.toString
+});
+const destroyInputs = {
+	id,
+	region,
+	cioConnection: connectionInput
+};
+const identifyInputs = {
+	id,
+	region,
+	customerData,
+	cioConnection: connectionInput
+};
+const trackInputs = {
+	id,
+	region,
+	eventData,
+	eventName,
+	cioConnection: connectionInput
+};
+const trackPageViewInputs = {
+	id,
+	region,
+	url,
+	cioConnection: connectionInput
+};
+//#endregion
+//#region src/inputs/misc.ts
+const rawRequestInputs = {
+	connection: connectionInput,
+	region,
+	..._prismatic_io_spectral_http.inputs,
+	url: {
+		..._prismatic_io_spectral_http.inputs.url,
+		comments: "The path to append to the base URL. Enter the path only (for example, /v1/accounts/region); the base URL (https://track.customer.io/api) is already included.",
+		example: "/v1/accounts/region"
+	}
+};
+//#endregion
+//#region src/client.ts
+const getRegion = (region) => {
+	if (region === "US") return customerio_node.RegionUS;
+	if (region === "EU") return customerio_node.RegionEU;
+	throw new Error(`Unsupported region: ${region}`);
+};
+const createCustomerClient = (cioConnection, region) => {
+	if (cioConnection.key !== "apiKey") throw new _prismatic_io_spectral.ConnectionError(cioConnection, `Unsupported authorization method: ${cioConnection.key}`);
+	return new customerio_node.TrackClient(_prismatic_io_spectral.util.types.toString(cioConnection.fields.siteId), _prismatic_io_spectral.util.types.toString(cioConnection.fields.apiKey), { region: getRegion(region) });
+};
+//#endregion
+//#region src/examplePayloads.ts
+const destroyExamplePayload = { data: null };
+const identifyExamplePayload = { data: null };
+const trackExamplePayload = { data: null };
+const trackPageViewExamplePayload = { data: null };
+//#endregion
+//#region src/actions/customers/destroy.ts
+const destroy = (0, _prismatic_io_spectral.action)({
+	display: {
+		label: "Destroy",
+		description: "Delete a customer by unique ID."
+	},
+	perform: async (context, { id, region, cioConnection }) => {
+		return { data: await createCustomerClient(cioConnection, region).destroy(id) };
+	},
+	inputs: destroyInputs,
+	examplePayload: destroyExamplePayload
+});
+//#endregion
+//#region src/actions/customers/identify.ts
+const identify = (0, _prismatic_io_spectral.action)({
+	display: {
+		label: "Identify",
+		description: "Create or update a customer."
+	},
+	perform: async (context, { id, region, customerData, cioConnection }) => {
+		return { data: await createCustomerClient(cioConnection, region).identify(id, customerData) };
+	},
+	inputs: identifyInputs,
+	examplePayload: identifyExamplePayload
+});
+//#endregion
+//#region src/actions/customers/track.ts
+const track = (0, _prismatic_io_spectral.action)({
+	display: {
+		label: "Track",
+		description: "Track customer events."
+	},
+	perform: async (context, { id, region, eventData, eventName, cioConnection }) => {
+		const client = createCustomerClient(cioConnection, region);
+		const payload = eventData ? {
+			name: eventName,
+			data: eventData
+		} : { name: eventName };
+		return { data: await client.track(id, payload) };
+	},
+	inputs: trackInputs,
+	examplePayload: trackExamplePayload
+});
+//#endregion
+//#region src/actions/customers/trackPageView.ts
+const trackPageView = (0, _prismatic_io_spectral.action)({
+	display: {
+		label: "Track Page View",
+		description: "Track a customer page view."
+	},
+	perform: async (context, { id, region, url, cioConnection }) => {
+		return { data: await createCustomerClient(cioConnection, region).trackPageView(id, url) };
+	},
+	inputs: trackPageViewInputs,
+	examplePayload: trackPageViewExamplePayload
+});
+//#endregion
+//#region src/actions/misc/rawRequest.ts
+const rawRequest = (0, _prismatic_io_spectral.action)({
+	display: {
+		label: "Raw Request",
+		description: "Send raw HTTP request to Customer.io."
+	},
+	inputs: rawRequestInputs,
+	perform: async (context, { connection, region, ...httpClientInputs }) => {
+		const client = createCustomerClient(connection, region);
+		const siteid = client.siteid;
+		const apikey = client.apikey;
+		try {
+			const { data } = await (0, _prismatic_io_spectral_http.sendRawRequest)("https://track.customer.io/api", httpClientInputs, { Authorization: `Basic ${Buffer.from(`${siteid}:${apikey}`).toString("base64")}` });
+			return { data };
+		} catch (error) {
+			const handled = (0, _prismatic_io_spectral_http.handleErrors)(error);
+			const serialized = _prismatic_io_spectral.util.types?.toJSON(handled);
+			throw new Error(serialized);
+		}
+	}
+});
+var connections_default = [(0, _prismatic_io_spectral.connection)({
+	key: "apiKey",
+	display: {
+		label: "API Key",
+		description: "Authenticate requests to Customer.io using an API key and secret."
+	},
+	inputs: {
+		apiKey: {
+			label: "API Key",
+			placeholder: "API Key",
+			type: "password",
+			required: true,
+			shown: true,
+			comments: "Provide the API key from the developer console.",
+			example: "example-a131bf1767a7"
+		},
+		siteId: {
+			label: "Site Id",
+			placeholder: "Site Id",
+			type: "string",
+			required: true,
+			shown: true,
+			comments: "Provide the Site Id obtained from the developer console.",
+			example: "example-a131bf1767a7"
+		}
+	}
+})];
+//#endregion
+//#region src/index.ts
+var src_default = (0, _prismatic_io_spectral.component)({
+	key: "customer-io",
+	documentationUrl: "https://prismatic.io/docs/components/customer-io/",
+	public: true,
+	display: {
+		label: "Customer.io",
+		category: "Application Connectors",
+		description: "Manage customers on the Customer.io platform.",
+		iconPath: "icon.png"
+	},
+	actions: {
+		destroy,
+		identify,
+		track,
+		trackPageView,
+		rawRequest
+	},
+	connections: connections_default,
+	hooks: { error: _prismatic_io_spectral_http.handleErrors }
+});
+//#endregion
+//#region npm-dist/.entry.ts
+var _entry_default = (0, _prismatic_io_spectral.callableComponent)(src_default);
+//#endregion
+module.exports = _entry_default;

package/npm-dist/index.d.cts

@@ -0,0 +1,369 @@
+//#region node_modules/axios/index.d.ts
+type UppercaseMethod = 'GET' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH' | 'PURGE' | 'LINK' | 'UNLINK' | 'QUERY';
+type Method = (UppercaseMethod | Lowercase<UppercaseMethod>) & {};
+type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream' | 'formdata';
+//#endregion
+//#region npm-dist/.entry.d.ts
+declare const _default: import("@prismatic-io/spectral").CallableComponent<{
+  key: "customer-io";
+  documentationUrl: "https://prismatic.io/docs/components/customer-io/";
+  public: true;
+  display: {
+    label: string;
+    category: "Application Connectors";
+    description: string;
+    iconPath: string;
+  };
+  actions: {
+    destroy: import("@prismatic-io/spectral").ActionDefinition<{
+      id: {
+        label: string;
+        type: "string";
+        required: true;
+        example: string;
+        placeholder: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      region: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        model: {
+          label: string;
+          value: string;
+        }[];
+        required: true;
+        example: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      cioConnection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+    identify: import("@prismatic-io/spectral").ActionDefinition<{
+      id: {
+        label: string;
+        type: "string";
+        required: true;
+        example: string;
+        placeholder: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      region: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        model: {
+          label: string;
+          value: string;
+        }[];
+        required: true;
+        example: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      customerData: {
+        label: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: true;
+        comments: string;
+        clean: (value: unknown) => Record<string, unknown>;
+      };
+      cioConnection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+    track: import("@prismatic-io/spectral").ActionDefinition<{
+      id: {
+        label: string;
+        type: "string";
+        required: true;
+        example: string;
+        placeholder: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      region: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        model: {
+          label: string;
+          value: string;
+        }[];
+        required: true;
+        example: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      eventData: {
+        label: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: false;
+        comments: string;
+        clean: (value: unknown) => Record<string, unknown> | undefined;
+      };
+      eventName: {
+        label: string;
+        example: string;
+        placeholder: string;
+        type: "string";
+        required: true;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      cioConnection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+    trackPageView: import("@prismatic-io/spectral").ActionDefinition<{
+      id: {
+        label: string;
+        type: "string";
+        required: true;
+        example: string;
+        placeholder: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      region: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        model: {
+          label: string;
+          value: string;
+        }[];
+        required: true;
+        example: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      url: {
+        label: string;
+        type: "string";
+        required: true;
+        example: string;
+        placeholder: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+      cioConnection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+    rawRequest: import("@prismatic-io/spectral").ActionDefinition<{
+      url: {
+        comments: string;
+        example: string;
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: true;
+        clean: (value: unknown) => string;
+      };
+      method: {
+        label: string;
+        type: "string";
+        required: true;
+        model: {
+          label: Method;
+          value: Method;
+        }[];
+        comments: string;
+        clean: (value: unknown) => string;
+      };
+      data: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: false;
+        comments: string;
+        example: string;
+      };
+      formData: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: false;
+        comments: string;
+        example: string;
+      };
+      fileData: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: false;
+        comments: string;
+        example: string;
+      };
+      fileDataFileNames: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: false;
+        comments: string;
+        clean: (values: any) => Record<string, string> | undefined;
+      };
+      queryParams: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: false;
+        comments: string;
+      };
+      headers: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        collection: "keyvaluelist";
+        required: false;
+        comments: string;
+        example: string;
+      };
+      responseType: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        default: string;
+        required: true;
+        comments: string;
+        model: {
+          label: ResponseType;
+          value: ResponseType;
+        }[];
+        clean: (value: unknown) => ResponseType;
+      };
+      timeout: {
+        label: string;
+        type: "string";
+        required: false;
+        comments: string;
+        example: string;
+        clean: (value: unknown) => number;
+      };
+      debugRequest: {
+        label: string;
+        type: "boolean";
+        required: false;
+        comments: string;
+        clean: (value: unknown) => boolean;
+      };
+      retryDelayMS: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: false;
+        comments: string;
+        default: string;
+        clean: (value: unknown) => number;
+      };
+      retryAllErrors: {
+        label: string;
+        type: "boolean";
+        default: string;
+        required: false;
+        comments: string;
+        clean: (value: unknown) => boolean;
+      };
+      maxRetries: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: false;
+        comments: string;
+        default: string;
+        clean: (value: unknown) => number;
+      };
+      useExponentialBackoff: {
+        label: string;
+        type: "boolean";
+        default: string;
+        required: false;
+        comments: string;
+        clean: (value: unknown) => boolean;
+      };
+      connection: {
+        label: string;
+        type: "connection";
+        required: true;
+        comments: string;
+      };
+      region: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        model: {
+          label: string;
+          value: string;
+        }[];
+        required: true;
+        example: string;
+        comments: string;
+        clean: (value: unknown, defaultValue?: string) => string;
+      };
+    }, import("@prismatic-io/spectral").ConfigVarResultCollection, boolean, {
+      data: any;
+    }>;
+  };
+  connections: import("@prismatic-io/spectral").KeyedConnection<{
+    key: "apiKey";
+    display: {
+      label: string;
+      description: string;
+    };
+    inputs: {
+      apiKey: {
+        label: string;
+        placeholder: string;
+        type: "password";
+        required: true;
+        shown: true;
+        comments: string;
+        example: string;
+      };
+      siteId: {
+        label: string;
+        placeholder: string;
+        type: "string";
+        required: true;
+        shown: true;
+        comments: string;
+        example: string;
+      };
+    };
+  }, "apiKey">[];
+  hooks: {
+    error: (error: unknown) => unknown;
+  };
+}>;
+export = _default;

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "@prismatic-io/components-customer-io",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "main": "./npm-dist/index.cjs",
+  "types": "./npm-dist/index.d.cts",
+  "exports": {
+    ".": {
+      "types": "./npm-dist/index.d.cts",
+      "default": "./npm-dist/index.cjs"
+    }
+  },
+  "description": "Manage customers on the Customer.io platform.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prismatic-io/components.git",
+    "directory": "components/customer-io"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "npm-dist",
+    "dist"
+  ],
+  "prismatic": {
+    "component": "./dist/index.js"
+  },
+  "scripts": {
+    "lint": "biome lint --write .",
+    "format": "biome format --write .",
+    "build": "npm run format && npm run lint && tsdown",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "prepare": "npm run build",
+    "publish:platform": "npm run build && prism components:publish"
+  },
+  "peerDependencies": {
+    "@prismatic-io/spectral": "^10.38.5"
+  },
+  "dependencies": {
+    "customerio-node": "5.0.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.5.1",
+    "@types/node": "^26.6.4",
+    "tsdown": "0.22.3",
+    "typescript": "6.0.3",
+    "vitest": "4.1.9",
+    "@prismatic-io/spectral": "^10.38.5"
+  }
+}