Extra TS checks

Author: ernest-nowacki

bun.lock

@@ -12,7 +12,7 @@
     },
     "packages/cre-sdk": {
       "name": "@chainlink/cre-sdk",
-      "version": "0.0.4-alpha",
+      "version": "0.0.5-alpha",
       "bin": {
         "cre-compile": "bin/cre-compile.ts",
       },
@@ -37,13 +37,16 @@
     },
     "packages/cre-sdk-examples": {
       "name": "@chainlink/cre-sdk-examples",
-      "version": "0.0.4-alpha",
+      "version": "0.0.5-alpha",
       "dependencies": {
         "@bufbuild/protobuf": "2.6.3",
         "@chainlink/cre-sdk": "workspace:*",
         "viem": "2.34.0",
         "zod": "3.25.76",
       },
+      "devDependencies": {
+        "@types/bun": "1.2.21",
+      },
     },
     "packages/cre-sdk-javy-plugin": {
       "name": "@chainlink/cre-sdk-javy-plugin",

packages/cre-sdk-examples/README.md

@@ -31,31 +31,37 @@ The setup is done in a way that treats `cre-sdk-examples` root directory as a CR
 [Hello World workflow](https://github.com/smartcontractkit/cre-sdk-typescript/blob/main/packages/cre-sdk-examples/src/workflows/hello-world/index.ts):
 
 ```zsh
-cre workflow simulate ./src/workflows/hello-world --target local-simulation
+cre workflow simulate ./src/workflows/hello-world
 ```
 
 [Http Fetch workflow](https://github.com/smartcontractkit/cre-sdk-typescript/blob/main/packages/cre-sdk-examples/src/workflows/http-fetch/index.ts):
 
 ```zsh
-cre workflow simulate ./src/workflows/http-fetch --target local-simulation
+cre workflow simulate ./src/workflows/http-fetch
 ```
 
 [On Chain Read workflow](https://github.com/smartcontractkit/cre-sdk-typescript/blob/main/packages/cre-sdk-examples/src/workflows/on-chain/index.ts):
 
 ```zsh
-cre workflow simulate ./src/workflows/on-chain --target local-simulation
+cre workflow simulate ./src/workflows/on-chain
 ```
 
 [On Chain Write workflow](https://github.com/smartcontractkit/cre-sdk-typescript/blob/main/packages/cre-sdk-examples/src/workflows/on-chain-write/index.ts):
 
 ```zsh
-cre workflow simulate ./src/workflows/on-chain-write --target local-simulation --broadcast
+cre workflow simulate ./src/workflows/on-chain-write
 ```
 
 [Proof of Reserve workflow](https://github.com/smartcontractkit/cre-sdk-typescript/blob/main/packages/cre-sdk-examples/src/workflows/proof-of-reserve/index.ts):
 
 ```zsh
-cre workflow simulate ./src/workflows/proof-of-reserve --target local-simulation --broadcast --secrets ../../../secrets.yaml
+cre workflow simulate ./src/workflows/proof-of-reserve
+```
+
+[Star Wars character example](https://github.com/smartcontractkit/cre-sdk-typescript/blob/main/packages/cre-sdk-examples/src/workflows/star-wars/index.ts):
+
+```zsh
+cre workflow simulate ./src/workflows/star-wars
 ```
 
 ## Testing workflow compilation only

packages/cre-sdk-examples/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@chainlink/cre-sdk-examples",
 	"private": true,
-	"version": "0.0.5-alpha",
+	"version": "0.0.6-alpha",
 	"type": "module",
 	"author": "Ernest Nowacki",
 	"license": "BUSL-1.1",
@@ -19,6 +19,9 @@
 		"viem": "2.34.0",
 		"zod": "3.25.76"
 	},
+	"devDependencies": {
+		"@types/bun": "1.2.21"
+	},
 	"engines": {
 		"bun": ">=1.2.21"
 	}

packages/cre-sdk-examples/src/workflows/proof-of-reserve/workflow.yaml

@@ -30,6 +30,7 @@ local-simulation:
   workflow-artifacts:
     workflow-path: "./index.ts"
     config-path: "./config.json"
+    secrets-path: "../../../secrets.yaml"
 
 # ==========================================================================
 production-testnet:

packages/cre-sdk-examples/src/workflows/star-wars/config.json

@@ -0,0 +1,3 @@
+{
+	"url": "https://swapi.info/api/people/{characterId}/"
+}

packages/cre-sdk-examples/src/workflows/star-wars/http_trigger_payload.json

@@ -0,0 +1,3 @@
+{
+	"characterId": 1
+}

packages/cre-sdk-examples/src/workflows/star-wars/index.ts

@@ -0,0 +1,88 @@
+import {
+	consensusIdenticalAggregation,
+	cre,
+	decodeJson,
+	type HTTPPayload,
+	type HTTPSendRequester,
+	json,
+	ok,
+	Runner,
+	type Runtime,
+} from '@chainlink/cre-sdk'
+import { z } from 'zod'
+
+const configSchema = z.object({
+	url: z.string(),
+})
+
+type Config = z.infer<typeof configSchema>
+
+const responseSchema = z.object({
+	name: z.string(),
+	height: z.string(),
+	mass: z.string(),
+	hair_color: z.string(),
+	skin_color: z.string(),
+	eye_color: z.string(),
+	birth_year: z.string(),
+	gender: z.string(),
+	homeworld: z.string(),
+	films: z.array(z.string()),
+	species: z.array(z.string()),
+	vehicles: z.array(z.string()),
+	starships: z.array(z.string()),
+	created: z.string().datetime(),
+	edited: z.string().datetime(),
+	url: z.string(),
+})
+
+type StarWarsCharacter = z.infer<typeof responseSchema>
+
+const fetchStarWarsCharacter = (
+	sendRequester: HTTPSendRequester,
+	config: Config,
+	payload: HTTPPayload,
+): StarWarsCharacter => {
+	const input = decodeJson(payload.input)
+	const url = config.url.replace('{characterId}', input.characterId)
+
+	const response = sendRequester.sendRequest({ url }).result()
+
+	// Check if the response is successful using the helper function
+	if (!ok(response)) {
+		throw new Error(`HTTP request failed with status: ${response.statusCode}`)
+	}
+
+	const character = responseSchema.parse(json(response))
+
+	return character
+}
+
+const onHTTPTrigger = async (runtime: Runtime<Config>, payload: HTTPPayload) => {
+	const httpCapability = new cre.capabilities.HTTPClient()
+
+	const result: StarWarsCharacter = httpCapability
+		.sendRequest(
+			runtime,
+			fetchStarWarsCharacter,
+			consensusIdenticalAggregation(),
+		)(runtime.config, payload)
+		.result()
+
+	return result
+}
+
+const initWorkflow = () => {
+	const httpTrigger = new cre.capabilities.HTTPCapability()
+
+	return [cre.handler(httpTrigger.trigger({}), onHTTPTrigger)]
+}
+
+export async function main() {
+	const runner = await Runner.newRunner<Config>({
+		configSchema,
+	})
+	await runner.run(initWorkflow)
+}
+
+main()

packages/cre-sdk-examples/src/workflows/star-wars/workflow.yaml

@@ -0,0 +1,38 @@
+# ==========================================================================
+# CRE WORKFLOW SETTINGS FILE
+# ==========================================================================
+# This file defines environment-specific workflow settings used by the CRE CLI.
+#
+# Each top-level key is a target (e.g., `production`, `production-testnet`, etc.).
+# You can also define your own custom targets, such as `my-target`, and
+# point the CLI to it via an environment variable.
+#
+# Note: If any setting in this file conflicts with a setting in the CRE Project Settings File,
+# the value defined here in the workflow settings file will take precedence.
+#
+# Below is an example `my-target`:
+#
+# my-target:
+#   user-workflow:
+#     # Optional: The address of the workflow owner (wallet or MSIG contract).
+#     # Used to establish ownership for encrypting the workflow's secrets.
+#     # If omitted, defaults to an empty string.
+#     workflow-owner-address: "0x1234567890abcdef1234567890abcdef12345678"
+#
+#     # Required: The name of the workflow to register with the Workflow Registry contract.
+#     workflow-name: "MyExampleWorkflow"
+
+# ==========================================================================
+local-simulation:
+  user-workflow:
+    workflow-owner-address: "(optional) Multi-signature contract address"
+    workflow-name: "star-wars"
+  workflow-artifacts:
+    workflow-path: "./index.ts"
+    config-path: "./config.json"
+
+# ==========================================================================
+production-testnet:
+  user-workflow:
+    workflow-owner-address: "(optional) Multi-signature contract address"
+    workflow-name: "star-wars"

packages/cre-sdk-examples/tsconfig.json

@@ -1,11 +1,10 @@
 {
 	"compilerOptions": {
 		// Enable latest features
-		"lib": ["ESNext", "DOM", "DOM.Iterable"],
+		"lib": ["ESNext"],
 		"target": "ESNext",
 		"module": "ESNext",
 		"moduleDetection": "force",
-		"jsx": "react-jsx",
 		"allowJs": true,
 
 		// Bundler mode