@activepieces/pieces-framework 0.6.0 → 0.6.1

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@activepieces/pieces-framework",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "type": "commonjs",
   "dependencies": {
     "@sinclair/typebox": "^0.26.3",
     "nanoid": "^3.3.4",
     "semver": "7.5.3",
-    "@activepieces/shared": "0.5.5",
+    "@activepieces/shared": "0.5.6",
     "tslib": "1.14.1"
   },
   "main": "./src/index.js",

package/src/lib/piece.d.ts

@@ -3,6 +3,25 @@ import { Action } from './action/action';
 import { EventPayload, ParseEventResponse } from '@activepieces/shared';
 import { PieceBase, PieceMetadata } from './piece-metadata';
 import { PieceAuthProperty } from './property';
+export declare class Piece<PieceAuth extends PieceAuthProperty = PieceAuthProperty> implements Omit<PieceBase, "version" | "name"> {
+    readonly displayName: string;
+    readonly logoUrl: string;
+    readonly authors: string[];
+    readonly events: PieceEventProcessors | undefined;
+    readonly auth?: PieceAuth | undefined;
+    readonly minimumSupportedRelease?: string | undefined;
+    readonly maximumSupportedRelease?: string | undefined;
+    readonly description: string;
+    private readonly _actions;
+    private readonly _triggers;
+    constructor(displayName: string, logoUrl: string, authors: string[], events: PieceEventProcessors | undefined, actions: Action<PieceAuth>[], triggers: Trigger<PieceAuth>[], auth?: PieceAuth | undefined, minimumSupportedRelease?: string | undefined, maximumSupportedRelease?: string | undefined, description?: string);
+    metadata(): Omit<PieceMetadata, "name" | "version">;
+    getAction(actionName: string): Action | undefined;
+    getTrigger(triggerName: string): Trigger | undefined;
+    actions(): Record<string, Action>;
+    triggers(): Record<string, Trigger>;
+}
+export declare const createPiece: <PieceAuth extends PieceAuthProperty>(params: CreatePieceParams<PieceAuth>) => Piece<PieceAuth>;
 type CreatePieceParams<PieceAuth extends PieceAuthProperty = PieceAuthProperty> = {
     displayName: string;
     logoUrl: string;
@@ -25,23 +44,4 @@ type PieceEventProcessors = {
         appWebhookUrl: string;
     }) => boolean;
 };
-export declare class Piece<PieceAuth extends PieceAuthProperty = PieceAuthProperty> implements Omit<PieceBase, "version" | "name"> {
-    readonly displayName: string;
-    readonly logoUrl: string;
-    readonly authors: string[];
-    readonly events: PieceEventProcessors | undefined;
-    readonly auth?: PieceAuth | undefined;
-    readonly minimumSupportedRelease?: string | undefined;
-    readonly maximumSupportedRelease?: string | undefined;
-    readonly description: string;
-    private readonly _actions;
-    private readonly _triggers;
-    constructor(displayName: string, logoUrl: string, authors: string[], events: PieceEventProcessors | undefined, actions: Action<PieceAuth>[], triggers: Trigger<PieceAuth>[], auth?: PieceAuth | undefined, minimumSupportedRelease?: string | undefined, maximumSupportedRelease?: string | undefined, description?: string);
-    metadata(): Omit<PieceMetadata, "name" | "version">;
-    getAction(actionName: string): Action | undefined;
-    getTrigger(triggerName: string): Trigger | undefined;
-    actions(): Record<string, Action>;
-    triggers(): Record<string, Trigger>;
-}
-export declare const createPiece: <PieceAuth extends PieceAuthProperty>(params: CreatePieceParams<PieceAuth>) => Piece<PieceAuth>;
 export {};

package/src/lib/piece.js.map

@@ -1 +1 @@
-{"version":3,"file":"piece.js","sourceRoot":"","sources":["../../../../../../packages/pieces/framework/src/lib/piece.ts"],"names":[],"mappings":";;;AAwBA,MAAa,KAAK;IAIhB,YACkB,WAAmB,EACnB,OAAe,EACf,OAAiB,EACjB,MAAwC,EACxD,OAA4B,EAC5B,QAA8B,EACd,IAAgB,EAChB,uBAAgC,EAChC,uBAAgC,EAChC,cAAsB,EAAE;QATxB,gBAAW,GAAX,WAAW,CAAQ;QACnB,YAAO,GAAP,OAAO,CAAQ;QACf,YAAO,GAAP,OAAO,CAAU;QACjB,WAAM,GAAN,MAAM,CAAkC;QAGxC,SAAI,GAAJ,IAAI,CAAY;QAChB,4BAAuB,GAAvB,uBAAuB,CAAS;QAChC,4BAAuB,GAAvB,uBAAuB,CAAS;QAChC,gBAAW,GAAX,WAAW,CAAa;QAbzB,aAAQ,GAA2B,EAAE,CAAA;QACrC,cAAS,GAA4B,EAAE,CAAA;QActD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;QAC9D,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;IACrE,CAAC;IAED,QAAQ;QACN,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACtD,CAAA;IACH,CAAC;IAED,SAAS,CAAC,UAAkB;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAClC,CAAC;IAED,UAAU,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;IACpC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;CACF;AAhDD,sBAgDC;AAEM,MAAM,WAAW,GAAG,CAAsC,MAAoC,EAAE,EAAE;;IACvG,OAAO,IAAI,KAAK,CACd,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,OAAO,EACd,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,EACpB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAA,MAAM,CAAC,IAAI,mCAAI,SAAS,EACxB,MAAM,CAAC,uBAAuB,EAC9B,MAAM,CAAC,uBAAuB,EAC9B,MAAM,CAAC,WAAW,CACnB,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,WAAW,eAavB"}
+{"version":3,"file":"piece.js","sourceRoot":"","sources":["../../../../../../packages/pieces/framework/src/lib/piece.ts"],"names":[],"mappings":";;;AAMA,MAAa,KAAK;IAIhB,YACkB,WAAmB,EACnB,OAAe,EACf,OAAiB,EACjB,MAAwC,EACxD,OAA4B,EAC5B,QAA8B,EACd,IAAgB,EAChB,uBAAgC,EAChC,uBAAgC,EAChC,cAAsB,EAAE;QATxB,gBAAW,GAAX,WAAW,CAAQ;QACnB,YAAO,GAAP,OAAO,CAAQ;QACf,YAAO,GAAP,OAAO,CAAU;QACjB,WAAM,GAAN,MAAM,CAAkC;QAGxC,SAAI,GAAJ,IAAI,CAAY;QAChB,4BAAuB,GAAvB,uBAAuB,CAAS;QAChC,4BAAuB,GAAvB,uBAAuB,CAAS;QAChC,gBAAW,GAAX,WAAW,CAAa;QAbzB,aAAQ,GAA2B,EAAE,CAAA;QACrC,cAAS,GAA4B,EAAE,CAAA;QActD,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;QAC9D,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;IACrE,CAAC;IAED,QAAQ;QACN,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACtD,CAAA;IACH,CAAC;IAED,SAAS,CAAC,UAAkB;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAClC,CAAC;IAED,UAAU,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;IACpC,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;CACF;AAhDD,sBAgDC;AAEM,MAAM,WAAW,GAAG,CAAsC,MAAoC,EAAE,EAAE;;IACvG,OAAO,IAAI,KAAK,CACd,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,OAAO,EACd,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE,EACpB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAA,MAAM,CAAC,IAAI,mCAAI,SAAS,EACxB,MAAM,CAAC,uBAAuB,EAC9B,MAAM,CAAC,uBAAuB,EAC9B,MAAM,CAAC,WAAW,CACnB,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,WAAW,eAavB"}

package/src/lib/property/base-prop.d.ts

@@ -3,6 +3,18 @@ export type BasePropertySchema = {
     displayName: string;
     description?: string;
 };
+type PieceAuthValidatorParams<AuthValueSchema> = {
+    auth: AuthValueSchema;
+};
+export type PieceAuthValidatorResponse = {
+    valid: true;
+} | {
+    valid: false;
+    error: string;
+};
+export type BasePieceAuthSchema<AuthValueSchema> = BasePropertySchema & {
+    validate?: (params: PieceAuthValidatorParams<AuthValueSchema>) => Promise<PieceAuthValidatorResponse>;
+};
 export type TPropertyValue<T, U extends PropertyType, REQUIRED extends boolean> = {
     valueSchema: T;
     type: U;
@@ -11,7 +23,7 @@ export type TPropertyValue<T, U extends PropertyType, REQUIRED extends boolean>
 };
 export type ShortTextProperty<R extends boolean> = BasePropertySchema & TPropertyValue<string, PropertyType.SHORT_TEXT, R>;
 export type LongTextProperty<R extends boolean> = BasePropertySchema & TPropertyValue<string, PropertyType.LONG_TEXT, R>;
-export type SecretTextProperty<R extends boolean> = BasePropertySchema & TPropertyValue<string, PropertyType.SECRET_TEXT, R>;
+export type SecretTextProperty<R extends boolean> = BasePieceAuthSchema<string> & TPropertyValue<string, PropertyType.SECRET_TEXT, R>;
 export type CheckboxProperty<R extends boolean> = BasePropertySchema & TPropertyValue<boolean, PropertyType.CHECKBOX, R>;
 export type NumberProperty<R extends boolean> = BasePropertySchema & TPropertyValue<number, PropertyType.NUMBER, R>;
 export type ArrayProperty<R extends boolean> = BasePropertySchema & TPropertyValue<unknown[], PropertyType.ARRAY, R>;
@@ -24,3 +36,4 @@ export type ApFile = {
     base64: string;
 };
 export type FileProperty<R extends boolean> = BasePropertySchema & TPropertyValue<ApFile, PropertyType.FILE, R>;
+export {};

package/src/lib/property/basic-auth-prop.d.ts

@@ -1,6 +1,10 @@
 import { PropertyType } from "./property";
-import { BasePropertySchema, TPropertyValue } from "./base-prop";
-export type BasicAuthPropertySchema = BasePropertySchema & {
+import { BasePieceAuthSchema, TPropertyValue } from "./base-prop";
+export type BasicAuthPropertyValue = {
+    username: string;
+    password: string;
+};
+export type BasicAuthPropertySchema = BasePieceAuthSchema<BasicAuthPropertyValue> & {
     username: {
         displayName: string;
         description?: string;
@@ -10,8 +14,4 @@ export type BasicAuthPropertySchema = BasePropertySchema & {
         description?: string;
     };
 };
-export type BasicAuthPropertyValue = {
-    username: string;
-    password: string;
-};
 export type BasicAuthProperty<R extends boolean> = BasicAuthPropertySchema & TPropertyValue<BasicAuthPropertyValue, PropertyType.BASIC_AUTH, R>;

package/src/lib/property/custom-auth-prop.d.ts

@@ -1,12 +1,12 @@
 import { PropertyType } from "./property";
-import { BasePropertySchema, CheckboxProperty, LongTextProperty, NumberProperty, SecretTextProperty, ShortTextProperty, TPropertyValue } from "./base-prop";
+import { BasePieceAuthSchema, CheckboxProperty, LongTextProperty, NumberProperty, SecretTextProperty, ShortTextProperty, TPropertyValue } from "./base-prop";
 import { StaticDropdownProperty } from "./dropdown-prop";
 import { StaticPropsValue } from "./property";
 export interface CustomAuthProps {
     [name: string]: ShortTextProperty<boolean> | LongTextProperty<boolean> | SecretTextProperty<boolean> | NumberProperty<boolean> | StaticDropdownProperty<unknown, boolean> | CheckboxProperty<boolean>;
 }
 export type CustomAuthPropertyValue<T extends CustomAuthProps> = StaticPropsValue<T>;
-export type CustomAuthPropertySchema<T> = BasePropertySchema & {
+export type CustomAuthPropertySchema<T extends CustomAuthProps> = BasePieceAuthSchema<CustomAuthPropertyValue<T>> & {
     props: T;
 };
 export type CustomAuthProperty<R extends boolean, T extends CustomAuthProps> = CustomAuthPropertySchema<T> & TPropertyValue<CustomAuthPropertyValue<T>, PropertyType.CUSTOM_AUTH, R>;

package/src/lib/property/oauth2-prop.d.ts

@@ -1,5 +1,5 @@
 import { PropertyType } from "./property";
-import { BasePropertySchema, SecretTextProperty, ShortTextProperty, TPropertyValue } from "./base-prop";
+import { BasePieceAuthSchema, SecretTextProperty, ShortTextProperty, TPropertyValue } from "./base-prop";
 import { StaticDropdownProperty } from "./dropdown-prop";
 import { StaticPropsValue } from "./property";
 type OAuthProp = ShortTextProperty<true> | SecretTextProperty<true> | StaticDropdownProperty<any, true>;
@@ -7,7 +7,7 @@ export interface OAuth2Props {
     [name: string]: ShortTextProperty<boolean> | SecretTextProperty<boolean> | StaticDropdownProperty<unknown, boolean>;
 }
 export type OAuthPropsValue<T extends OAuth2Props> = StaticPropsValue<T>;
-export type OAuth2PropertySchema = BasePropertySchema & {
+export type OAuth2PropertySchema = BasePieceAuthSchema<OAuth2PropertyValue> & {
     props?: Record<string, OAuthProp>;
     authUrl: string;
     tokenUrl: string;

package/src/lib/property/property.d.ts

@@ -24,7 +24,7 @@ export declare enum PropertyType {
     DATE_TIME = "DATE_TIME",
     FILE = "FILE"
 }
-export type PieceAuthProperty = BasicAuthProperty<boolean> | CustomAuthProperty<boolean, CustomAuthProps> | OAuth2Property<boolean, OAuth2Props> | SecretTextProperty<boolean>;
+export type PieceAuthProperty = BasicAuthProperty<boolean> | CustomAuthProperty<boolean, any> | OAuth2Property<boolean, OAuth2Props> | SecretTextProperty<boolean>;
 export type NonAuthPieceProperty = ShortTextProperty<boolean> | LongTextProperty<boolean> | CheckboxProperty<boolean> | DropdownProperty<any, boolean> | StaticDropdownProperty<any, boolean> | NumberProperty<boolean> | ArrayProperty<boolean> | ObjectProperty<boolean> | JsonProperty<boolean> | MultiSelectDropdownProperty<unknown, boolean> | StaticMultiSelectDropdownProperty<unknown, boolean> | DynamicProperties<boolean> | DateTimeProperty<boolean> | FileProperty<boolean>;
 export type PieceProperty = NonAuthPieceProperty | PieceAuthProperty;
 export interface PiecePropertyMap {