workflow: stub workflow/api package so it can be referenced in a workflow context (#290)

* workflow: stub workflow/api package so it can be referenced in a workflow context

what's not allowed is to call these functions, so let's stub them and make them fail in runtime.
i guess that eventually we will actually implement some of them (start or resumeHook or whatever) in a durable way.

Signed-off-by: Gal Schlezinger <gal@spitfire.co.il>

* changeset

Signed-off-by: Gal Schlezinger <gal@spitfire.co.il>

* Update packages/workflow/src/api-workflow.ts

Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Signed-off-by: Gal Schlezinger <gal@spitfire.co.il>

---------

Signed-off-by: Gal Schlezinger <gal@spitfire.co.il>
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>

Author: Schniz

.changeset/silver-boats-fold.md

@@ -0,0 +1,5 @@
+---
+"workflow": patch
+---
+
+stub `workflow/api` in a workflow context with functions that fail immediately, so they can be referenced in workflow-related code but not invoked

packages/workflow/package.json

@@ -28,7 +28,11 @@
       "require": "./dist/typescript-plugin.cjs",
       "default": "./dist/index.js"
     },
-    "./api": "./dist/api.js",
+    "./api": {
+      "types": "./dist/api.d.ts",
+      "workflow": "./dist/api-workflow.js",
+      "default": "./dist/api.js"
+    },
     "./internal/errors": "./dist/internal/errors.js",
     "./internal/serialization": "./dist/internal/serialization.js",
     "./internal/builtins": "./dist/internal/builtins.js",

packages/workflow/src/api-workflow.ts

@@ -0,0 +1,24 @@
+export type {
+  Event,
+  StartOptions,
+  WorkflowReadableStreamOptions,
+  WorkflowRun,
+} from '@workflow/core/runtime';
+
+const workflowStub = (item: string) => {
+  throw new Error(
+    `The workflow environment doesn't allow this runtime usage of ${item}.`
+  );
+};
+
+export class Run {
+  constructor() {
+    workflowStub('Run');
+  }
+}
+export const getRun = () => workflowStub('getRun');
+export const getHookByToken = () => workflowStub('getHookByToken');
+export const resumeHook = () => workflowStub('resumeHook');
+export const resumeWebhook = () => workflowStub('resumeWebhook');
+export const runStep = () => workflowStub('runStep');
+export const start = () => workflowStub('start');