@doflo/flow-interfaces - npm Package Compare versions

Comparing version 1.16.1 to 1.16.2

dist/types/executionWrapper.d.ts

@@ -0,1 +1,3 @@
+export interface AppExecutionContext<InputData = any> extends Readonly<Required<ExecutionWrapper<InputData>>> {
+}
 /**
@@ -2,0 +4,0 @@ * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=ExecutionWrapper&v=1.0.0)

dist/types/index.d.ts

@@ -6,2 +6,3 @@ /// <reference types="node" />
 import type { Logger } from './logger';
+import { RequestInfo, RequestInit, Response } from 'node-fetch';
 export * as api from './api';
@@ -15,3 +16,3 @@ export * as validation from './validation';
 }
-export { ExecutionWrapper } from './executionWrapper';
+export { ExecutionWrapper, AppExecutionContext } from './executionWrapper';
 export interface IPropertyOptionsLoadFunctions extends IRPCContext {
@@ -47,3 +48,43 @@ getElement(): IElement;
 export interface IRPCContext {
+    /**
+     * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=IRPCContext;env&v=1.0.0)
+     *
+     * **env** holds environmental data as well as the secrets specified for the name space
+     */
     env: EnvironmentData;
+    /**
+     * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=IRPCContext;fetch&v=1.0.0)
+     *
+     * **node-fetch** http client for making requests use it if you need it
+     */
+    fetch: (url: RequestInfo, init?: RequestInit) => Promise<Response>;
+    /**
+     * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=IRPCContext;stash&v=1.0.0)
+     *
+     * **stash** short term storage of data, (up to 2 days) this is commonly used to securely stash
+     * sensitive information that can later be picked up with the ticket number
+     */
+    stash: (data: any) => string;
+    /**
+     * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=IRPCContext;pickup&v=1.0.0)
+     *
+     * **pickup** short term storage of data, (up to 2 days) this is commonly used to securely stash
+     * sensitive information that can later be picked up with the ticket number
+     */
+    pickup: <T>(ticket: string, preserve: boolean) => T;
+    /**
+     * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=IRPCContext;expire&v=1.0.0)
+     *
+     * **expire** short term storage of data, (up to 2 days) this is commonly used to securely stash
+     * sensitive information that can later be picked up with the ticket number
+     */
+    expire: (ticket: string) => void;
+    /**
+     * ![doFlo Logo](https://schemas.doflo.com/docslogo.png?topic=IRPCContext;log&v=1.0.0)
+     *
+     * **data** refers to the data that utilized in the workflow
+     * this data object is almost immediately striped from the
+     * response and wrapped into a new object that is passed
+     * into the workflow
+     */
     log: Logger;
@@ -50,0 +91,0 @@ }

package.json

 {
   "name": "@doflo/flow-interfaces",
-  "version": "1.16.1",
+  "version": "1.16.2",
   "description": "Public Interfaces, Schemas, & GRPC Signatures for doFlo developers",
@@ -71,4 +71,5 @@ "main": "dist/index.js",
     "@types/google-protobuf": "^3.7.4",
+    "@types/node-fetch": "^2.5.10",
     "reflect-metadata": "^0.1.13"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

288876

increased by2.04%

Lines of code

4629

increased by0.94%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Added@types/node-fetch@^2.5.10

• + Added@types/node@22.13.5(transitive)

• + Added@types/node-fetch@2.6.12(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedcall-bind-apply-helpers@1.0.2(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addeddunder-proto@1.0.1(transitive)

• + Addedes-define-property@1.0.1(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes-object-atoms@1.1.1(transitive)

• + Addedes-set-tostringtag@2.1.0(transitive)

• + Addedform-data@4.0.2(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-intrinsic@1.3.0(transitive)

• + Addedget-proto@1.0.1(transitive)

• + Addedgopd@1.2.0(transitive)

• + Addedhas-symbols@1.1.0(transitive)

• + Addedhas-tostringtag@1.0.2(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedmath-intrinsics@1.1.0(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedundici-types@6.20.0(transitive)