Skip to content

Adding 'annotations' to component typing for actions #18511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 7, 2025
Merged

Adding 'annotations' to component typing for actions #18511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8e11849
Adding 'annotations' to component typing for actions
GTFalcao Sep 30, 2025
6707441
Package bump
GTFalcao Sep 30, 2025
d6f2059
Adding idempotentHint
GTFalcao Sep 30, 2025
cb79318
Merge branch 'master' into component-types-update-annotations
GTFalcao Oct 4, 2025
4b100b9
adding skiplibcheck
GTFalcao Oct 4, 2025
8dbcb81
Removing unused ban-types rule
GTFalcao Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion types/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@pipedream/types",
"version": "0.3.2",
"version": "0.3.3",
"description": "Pipedream TypeScript types",
"keywords": [
"pipedream",
Expand Down
15 changes: 10 additions & 5 deletions types/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/ban-types */
/* eslint-disable @typescript-eslint/no-explicit-any */
export type JSONValue =
| string
Expand Down Expand Up @@ -70,7 +69,7 @@ export interface HTTPResponse {
/**
* Http Body
*/
body: string | Buffer | NodeJS.ReadableStream;
body: string | Buffer | ReadableStream;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-Non-blocking-

I'm not sure if it matters, but I think the instances of ReadableStream in this file could instead be Readable. And WritableStream could be Writeable. For example:

import {
  Readable, Writable,
} from "stream";
// ...
body: string | Buffer | Readable;
// ...
export interface IFile {
  delete(): Promise<void>;
  createReadStream(): Promise<Readable>;
  createWriteStream(contentType?: string, contentLength?: number): Promise<Writable>;
  toEncodedString(encoding?: string, start?: number, end?: number): Promise<string>;
  toUrl(): Promise<string>;
  toFile(localFilePath: string): Promise<void>;
  toBuffer(): Promise<Buffer>;
  fromReadableStream(readableStream: Readable, contentType?: string, contentSize?: number): Promise<IFile>;

If you call File.fromReadableStream(readStream) with a stream derived from fs.createReadStream(), for example, then the readStream would have the type fs.ReadStream, which extends stream.Readable.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - I'll follow up on this. Shipping the current change for now to unblock building components

/**
* If true, issue the response when the promise returned is resolved, otherwise issue
* the response at the end of the workflow execution
Expand Down Expand Up @@ -115,13 +114,13 @@ export interface IApi {

export interface IFile {
delete(): Promise<void>;
createReadStream(): Promise<NodeJS.ReadableStream>;
createWriteStream(contentType?: string, contentLength?: number): Promise<NodeJS.WritableStream>;
createReadStream(): Promise<ReadableStream>;
createWriteStream(contentType?: string, contentLength?: number): Promise<WritableStream>;
toEncodedString(encoding?: string, start?: number, end?: number): Promise<string>;
toUrl(): Promise<string>;
toFile(localFilePath: string): Promise<void>;
toBuffer(): Promise<Buffer>;
fromReadableStream(readableStream: NodeJS.ReadableStream, contentType?: string, contentSize?: number): Promise<IFile>;
fromReadableStream(readableStream: ReadableStream, contentType?: string, contentSize?: number): Promise<IFile>;
fromFile(localFilePath: string, contentType?: string): Promise<IFile>;
fromUrl(url: string, options?: any): Promise<IFile>;
toJSON(): any;
Expand Down Expand Up @@ -384,6 +383,12 @@ export interface Action<
type: "action";
methods?: Methods & ThisType<PropThis<ActionPropDefinitions> & Methods>;
props?: ActionPropDefinitions;
annotations?: {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should add idempotentHint? while you're at it, even though we aren't backfilling that value for any components right now

destructiveHint?: boolean;
idempotentHint?: boolean;
openWorldHint?: boolean;
readOnlyHint?: boolean;
}
additionalProps?: (
previousPropDefs: ActionPropDefinitions
) => Promise<ActionPropDefinitions>;
Expand Down
1 change: 1 addition & 0 deletions types/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"lib": ["es6"],
"strictFunctionTypes": true,
"strictNullChecks": true,
"skipLibCheck": true, /* Skip type checking of declaration files in node_modules. */
"baseUrl": ".",
"paths": { "@pipedream/types": ["."] }
},
Expand Down
Loading