@activeboxes/pieces-framework 0.7.4-2.0

package/README.md

@@ -0,0 +1,11 @@
+# pieces-framework
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build pieces-framework` to build the library.
+
+## Running unit tests
+
+Run `nx test pieces-framework` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@activeboxes/pieces-framework",
+  "version": "0.7.42.0",
+  "type": "commonjs",
+  "dependencies": {
+    "@sinclair/typebox": "0.34.11",
+    "deepmerge-ts": "7.1.0",
+    "nanoid": "3.3.8",
+    "semver": "7.6.0",
+    "@activeboxes/shared": "0.10.146",
+    "tslib": "1.14.1"
+  },
+  "overrides": {
+    "cross-spawn": "7.0.6",
+    "@tryfabric/martian": {
+      "@notionhq/client": "$@notionhq/client"
+    },
+    "vite": {
+      "rollup": "npm:@rollup/wasm-node"
+    }
+  },
+  "resolutions": {
+    "rollup": "npm:@rollup/wasm-node"
+  },
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/pieces/community/framework/src/index.ts"],"names":[],"mappings":";;;AAAA,gDAAsB"}

package/src/lib/action/action.d.ts

@@ -0,0 +1,45 @@
+import { Static } from '@sinclair/typebox';
+import { ActionContext } from '../context';
+import { ActionBase } from '../piece-metadata';
+import { InputPropertyMap } from '../property';
+import { PieceAuthProperty } from '../property/authentication';
+export type ActionRunner<PieceAuth extends PieceAuthProperty, ActionProps extends InputPropertyMap> = (ctx: ActionContext<PieceAuth, ActionProps>) => Promise<unknown | void>;
+export declare const ErrorHandlingOptionsParam: import("@sinclair/typebox").TObject<{
+    retryOnFailure: import("@sinclair/typebox").TObject<{
+        defaultValue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+        hide: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    }>;
+    continueOnFailure: import("@sinclair/typebox").TObject<{
+        defaultValue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+        hide: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    }>;
+}>;
+export type ErrorHandlingOptionsParam = Static<typeof ErrorHandlingOptionsParam>;
+type CreateActionParams<PieceAuth extends PieceAuthProperty, ActionProps extends InputPropertyMap> = {
+    /**
+     * A dummy parameter used to infer {@code PieceAuth} type
+     */
+    name: string;
+    auth?: PieceAuth;
+    displayName: string;
+    description: string;
+    props: ActionProps;
+    run: ActionRunner<PieceAuth, ActionProps>;
+    test?: ActionRunner<PieceAuth, ActionProps>;
+    requireAuth?: boolean;
+    errorHandlingOptions?: ErrorHandlingOptionsParam;
+};
+export declare class IAction<PieceAuth extends PieceAuthProperty, ActionProps extends InputPropertyMap> implements ActionBase {
+    readonly name: string;
+    readonly displayName: string;
+    readonly description: string;
+    readonly props: ActionProps;
+    readonly run: ActionRunner<PieceAuth, ActionProps>;
+    readonly test: ActionRunner<PieceAuth, ActionProps>;
+    readonly requireAuth: boolean;
+    readonly errorHandlingOptions: ErrorHandlingOptionsParam;
+    constructor(name: string, displayName: string, description: string, props: ActionProps, run: ActionRunner<PieceAuth, ActionProps>, test: ActionRunner<PieceAuth, ActionProps>, requireAuth: boolean, errorHandlingOptions: ErrorHandlingOptionsParam);
+}
+export type Action<PieceAuth extends PieceAuthProperty = any, ActionProps extends InputPropertyMap = any> = IAction<PieceAuth, ActionProps>;
+export declare const createAction: <PieceAuth extends PieceAuthProperty = PieceAuthProperty, ActionProps extends InputPropertyMap = any>(params: CreateActionParams<PieceAuth, ActionProps>) => IAction<PieceAuth, ActionProps>;
+export {};

package/src/lib/action/action.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAction = exports.IAction = exports.ErrorHandlingOptionsParam = void 0;
+const typebox_1 = require("@sinclair/typebox");
+exports.ErrorHandlingOptionsParam = typebox_1.Type.Object({
+    retryOnFailure: typebox_1.Type.Object({
+        defaultValue: typebox_1.Type.Optional(typebox_1.Type.Boolean()),
+        hide: typebox_1.Type.Optional(typebox_1.Type.Boolean()),
+    }),
+    continueOnFailure: typebox_1.Type.Object({
+        defaultValue: typebox_1.Type.Optional(typebox_1.Type.Boolean()),
+        hide: typebox_1.Type.Optional(typebox_1.Type.Boolean()),
+    }),
+});
+class IAction {
+    constructor(name, displayName, description, props, run, test, requireAuth, errorHandlingOptions) {
+        this.name = name;
+        this.displayName = displayName;
+        this.description = description;
+        this.props = props;
+        this.run = run;
+        this.test = test;
+        this.requireAuth = requireAuth;
+        this.errorHandlingOptions = errorHandlingOptions;
+    }
+}
+exports.IAction = IAction;
+const createAction = (params) => {
+    var _a, _b, _c;
+    return new IAction(params.name, params.displayName, params.description, params.props, params.run, (_a = params.test) !== null && _a !== void 0 ? _a : params.run, (_b = params.requireAuth) !== null && _b !== void 0 ? _b : true, (_c = params.errorHandlingOptions) !== null && _c !== void 0 ? _c : {
+        continueOnFailure: {
+            defaultValue: false,
+        },
+        retryOnFailure: {
+            defaultValue: false,
+        }
+    });
+};
+exports.createAction = createAction;
+//# sourceMappingURL=action.js.map

package/src/lib/action/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../../../../../../../../packages/pieces/community/framework/src/lib/action/action.ts"],"names":[],"mappings":";;;AAAA,+CAAiD;AASpC,QAAA,yBAAyB,GAAG,cAAI,CAAC,MAAM,CAAC;IACnD,cAAc,EAAE,cAAI,CAAC,MAAM,CAAC;QAC1B,YAAY,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,EAAE,CAAC;KACpC,CAAC;IACF,iBAAiB,EAAE,cAAI,CAAC,MAAM,CAAC;QAC7B,YAAY,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,EAAE,CAAC;KACpC,CAAC;CACH,CAAC,CAAA;AAkBF,MAAa,OAAO;IAClB,YACkB,IAAY,EACZ,WAAmB,EACnB,WAAmB,EACnB,KAAkB,EAClB,GAAyC,EACzC,IAA0C,EAC1C,WAAoB,EACpB,oBAA+C;QAP/C,SAAI,GAAJ,IAAI,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAAQ;QACnB,UAAK,GAAL,KAAK,CAAa;QAClB,QAAG,GAAH,GAAG,CAAsC;QACzC,SAAI,GAAJ,IAAI,CAAsC;QAC1C,gBAAW,GAAX,WAAW,CAAS;QACpB,yBAAoB,GAApB,oBAAoB,CAA2B;IAC7D,CAAC;CACN;AAXD,0BAWC;AAOM,MAAM,YAAY,GAAG,CAI1B,MAAkD,EAClD,EAAE;;IACF,OAAO,IAAI,OAAO,CAChB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,GAAG,EACV,MAAA,MAAM,CAAC,IAAI,mCAAI,MAAM,CAAC,GAAG,EACzB,MAAA,MAAM,CAAC,WAAW,mCAAI,IAAI,EAC1B,MAAA,MAAM,CAAC,oBAAoB,mCAAI;QAC7B,iBAAiB,EAAE;YACjB,YAAY,EAAE,KAAK;SACpB;QACD,cAAc,EAAE;YACd,YAAY,EAAE,KAAK;SACpB;KACF,CACF,CAAA;AACH,CAAC,CAAA;AAvBY,QAAA,YAAY,gBAuBxB"}

package/src/lib/context.d.ts

@@ -0,0 +1,122 @@
+import { AppConnectionValue, ExecutionType, FlowRunId, PopulatedFlow, ProjectId, ResumePayload, SeekPage, TriggerPayload } from '@activeboxes/shared';
+import { TriggerStrategy } from './trigger/trigger';
+import { InputPropertyMap, PiecePropValueSchema, StaticPropsValue } from './property';
+import { PieceAuthProperty } from './property/authentication';
+import { StopResponse, DelayPauseMetadata, PauseMetadata, WebhookPauseMetadata } from '@activeboxes/shared';
+type BaseContext<PieceAuth extends PieceAuthProperty, Props extends InputPropertyMap> = {
+    flows: FlowsContext;
+    auth: PiecePropValueSchema<PieceAuth>;
+    propsValue: StaticPropsValue<Props>;
+    store: Store;
+    project: {
+        id: ProjectId;
+        externalId: () => Promise<string | undefined>;
+    };
+};
+type AppWebhookTriggerHookContext<PieceAuth extends PieceAuthProperty, TriggerProps extends InputPropertyMap> = BaseContext<PieceAuth, TriggerProps> & {
+    webhookUrl: string;
+    payload: TriggerPayload;
+    app: {
+        createListeners({ events, identifierValue, }: {
+            events: string[];
+            identifierValue: string;
+        }): void;
+    };
+};
+type PollingTriggerHookContext<PieceAuth extends PieceAuthProperty, TriggerProps extends InputPropertyMap> = BaseContext<PieceAuth, TriggerProps> & {
+    setSchedule(schedule: {
+        cronExpression: string;
+        timezone?: string;
+    }): void;
+};
+type WebhookTriggerHookContext<PieceAuth extends PieceAuthProperty, TriggerProps extends InputPropertyMap> = BaseContext<PieceAuth, TriggerProps> & {
+    webhookUrl: string;
+    payload: TriggerPayload;
+};
+export type TriggerHookContext<PieceAuth extends PieceAuthProperty, TriggerProps extends InputPropertyMap, S extends TriggerStrategy> = S extends TriggerStrategy.APP_WEBHOOK ? AppWebhookTriggerHookContext<PieceAuth, TriggerProps> : S extends TriggerStrategy.POLLING ? PollingTriggerHookContext<PieceAuth, TriggerProps> : S extends TriggerStrategy.WEBHOOK ? WebhookTriggerHookContext<PieceAuth, TriggerProps> : never;
+export type TestOrRunHookContext<PieceAuth extends PieceAuthProperty, TriggerProps extends InputPropertyMap, S extends TriggerStrategy> = TriggerHookContext<PieceAuth, TriggerProps, S> & {
+    files: FilesService;
+};
+export type StopHookParams = {
+    response: StopResponse;
+};
+export type StopHook = (params?: StopHookParams) => void;
+export type PauseHookParams = {
+    pauseMetadata: PauseMetadata;
+};
+export type PauseHook = (params: {
+    pauseMetadata: DelayPauseMetadata | Omit<WebhookPauseMetadata, 'requestId'>;
+}) => void;
+export type FlowsContext = {
+    list(): Promise<SeekPage<PopulatedFlow>>;
+    current: {
+        id: string;
+        version: {
+            id: string;
+        };
+    };
+};
+export type PropertyContext = {
+    server: ServerContext;
+    project: {
+        id: ProjectId;
+        externalId: () => Promise<string | undefined>;
+    };
+    searchValue?: string;
+    flows: FlowsContext;
+};
+export type ServerContext = {
+    apiUrl: string;
+    publicUrl: string;
+    token: string;
+};
+export type RunContext = {
+    id: FlowRunId;
+    stop: StopHook;
+    pause: PauseHook;
+};
+export type OnStartContext<PieceAuth extends PieceAuthProperty, TriggerProps extends InputPropertyMap> = Omit<BaseContext<PieceAuth, TriggerProps>, 'flows'> & {
+    run: Pick<RunContext, 'id'>;
+    payload: unknown;
+};
+export type BaseActionContext<ET extends ExecutionType, PieceAuth extends PieceAuthProperty, ActionProps extends InputPropertyMap> = BaseContext<PieceAuth, ActionProps> & {
+    executionType: ET;
+    connections: ConnectionsManager;
+    tags: TagsManager;
+    server: ServerContext;
+    files: FilesService;
+    serverUrl: string;
+    run: RunContext;
+    generateResumeUrl: (params: {
+        queryParams: Record<string, string>;
+    }) => string;
+};
+type BeginExecutionActionContext<PieceAuth extends PieceAuthProperty = PieceAuthProperty, ActionProps extends InputPropertyMap = InputPropertyMap> = BaseActionContext<ExecutionType.BEGIN, PieceAuth, ActionProps>;
+type ResumeExecutionActionContext<PieceAuth extends PieceAuthProperty = PieceAuthProperty, ActionProps extends InputPropertyMap = InputPropertyMap> = BaseActionContext<ExecutionType.RESUME, PieceAuth, ActionProps> & {
+    resumePayload: ResumePayload;
+};
+export type ActionContext<PieceAuth extends PieceAuthProperty = PieceAuthProperty, ActionProps extends InputPropertyMap = InputPropertyMap> = BeginExecutionActionContext<PieceAuth, ActionProps> | ResumeExecutionActionContext<PieceAuth, ActionProps>;
+export interface FilesService {
+    write({ fileName, data, }: {
+        fileName: string;
+        data: Buffer;
+    }): Promise<string>;
+}
+export interface ConnectionsManager {
+    get(key: string): Promise<AppConnectionValue | Record<string, unknown> | string | null>;
+}
+export interface TagsManager {
+    add(params: {
+        name: string;
+    }): Promise<void>;
+}
+export interface Store {
+    put<T>(key: string, value: T, scope?: StoreScope): Promise<T>;
+    get<T>(key: string, scope?: StoreScope): Promise<T | null>;
+    delete(key: string, scope?: StoreScope): Promise<void>;
+}
+export declare enum StoreScope {
+    PROJECT = "COLLECTION",
+    FLOW = "FLOW"
+}
+export {};

package/src/lib/context.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StoreScope = void 0;
+var StoreScope;
+(function (StoreScope) {
+    // Collection were deprecated in favor of project
+    StoreScope["PROJECT"] = "COLLECTION";
+    StoreScope["FLOW"] = "FLOW";
+})(StoreScope || (exports.StoreScope = StoreScope = {}));
+//# sourceMappingURL=context.js.map

package/src/lib/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../../packages/pieces/community/framework/src/lib/context.ts"],"names":[],"mappings":";;;AA2MA,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,iDAAiD;IACjD,oCAAsB,CAAA;IACtB,2BAAa,CAAA;AACf,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB"}

package/src/lib/index.d.ts

@@ -0,0 +1,7 @@
+export * from './action/action';
+export * from './property';
+export * from './trigger/trigger';
+export * from './context';
+export * from './piece';
+export * from './piece-metadata';
+export * from './validators/index';

package/src/lib/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./action/action"), exports);
+tslib_1.__exportStar(require("./property"), exports);
+tslib_1.__exportStar(require("./trigger/trigger"), exports);
+tslib_1.__exportStar(require("./context"), exports);
+tslib_1.__exportStar(require("./piece"), exports);
+tslib_1.__exportStar(require("./piece-metadata"), exports);
+tslib_1.__exportStar(require("./validators/index"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/pieces/community/framework/src/lib/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,qDAA2B;AAC3B,4DAAkC;AAClC,oDAA0B;AAC1B,kDAAwB;AACxB,2DAAiC;AACjC,6DAAkC"}