@useparagon/ocs-contracts 0.2.8

package/dist/globals.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Sandbox globals injected by the OCS isolated-vm runtime into connector hook
+ * code (pipelines, triggers, actions). These are ambient declarations only —
+ * not npm dependencies; they are available globally inside your hook files.
+ *
+ * Wire them into your connector's `tsconfig.json` via:
+ *
+ *   { "compilerOptions": { "types": ["@useparagon-internal/ocs-contracts/globals"] } }
+ */
+
+interface IntegrationRequestInput {
+  method?: string;
+  /** Path appended to `url` or the configured proxy base URL. */
+  path?: string;
+  /** Absolute URL used for direct HTTP requests. */
+  url?: string;
+  headers?: Record<string, string>;
+  params?: Record<string, string | number | boolean>;
+  body?: unknown;
+}
+
+interface IntegrationRequestProxyEnvelope<TOutput = unknown> {
+  status: number;
+  headers: Record<string, unknown>;
+  output: TOutput;
+}
+
+interface IntegrationRequestResponse<TOutput = unknown> {
+  status: number;
+  statusText: string;
+  ok: boolean;
+  headers: Record<string, string>;
+  json(): Promise<TOutput>;
+  text(): Promise<string>;
+}
+
+/**
+ * Perform an authenticated request against the connector's integration proxy
+ * (or an absolute URL). Injected globally inside connector hook code when the
+ * host has configured an integration/proxy handler; `undefined` when it is not
+ * available (e.g. local runs without proxy settings).
+ */
+declare const integrationRequest:
+  | (<TOutput = unknown>(
+      input: IntegrationRequestInput,
+    ) => Promise<IntegrationRequestResponse<IntegrationRequestProxyEnvelope<TOutput>>>)
+  | undefined;