actionsflow-interface - npm Package Compare versions

Comparing version 0.1.12 to 0.1.13

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+## [0.1.13](https://github.com/actionsflow/actionsflow/compare/actionsflow-interface@0.1.12...actionsflow-interface@0.1.13) (2020-09-15)
+
+### Features
+
+- change anyobject ([98b82c9](https://github.com/actionsflow/actionsflow/commit/98b82c94ea17cafb285898f2441ba343f6bda562))
+- no \_ ([21f913d](https://github.com/actionsflow/actionsflow/commit/21f913ddc3fb95aec299b5d60e5bdcd6d0299a2d))
+- support config option ([ab75cfb](https://github.com/actionsflow/actionsflow/commit/ab75cfbcb59fffb6f007d96cc2f6665015632109))
+- support email trigger ([7f3ae2d](https://github.com/actionsflow/actionsflow/commit/7f3ae2d35e839eb5e87d35c4d57beb6e9cf03a0e))
+- support items ([dfb6ea0](https://github.com/actionsflow/actionsflow/commit/dfb6ea0f570be4497c23ab0c0058714fbc71df5e))
+- triggerResult can be array ([9ca58ad](https://github.com/actionsflow/actionsflow/commit/9ca58ad2f452826867fa15e74adde3a37994bfbd))
+
 ## [0.1.12](https://github.com/actionsflow/actionsflow/compare/actionsflow-interface@0.1.11...actionsflow-interface@0.1.12) (2020-09-09)
@@ -8,0 +19,0 @@

dist/src/index.d.ts

@@ -7,9 +7,17 @@ /// <reference types="node" />
 export declare type HTTP_METHODS_LOWERCASE = "head" | "get" | "post" | "put" | "patch" | "delete" | "options";
-export declare type AnyObject = Record<string, unknown>;
-export interface IGithub {
+export declare type GenericValue = string | number | boolean | undefined | null;
+export declare type AnyObject = Record<string, GenericValue | GenericValue[] | unknown>;
+export interface IBinaryData {
+    [key: string]: string | undefined;
+    data: string;
+    mimeType: string;
+    fileName?: string;
+    fileExtension?: string;
+}
+export interface IGithub extends AnyObject {
     event: AnyObject;
-    [key: string]: unknown;
 }
 export interface IHelpers {
     createContentDigest: (input: unknown) => string;
+    formatBinary: (content: Buffer, filePath?: string, mimeType?: string) => Promise<IBinaryData>;
     cache: {
@@ -24,15 +32,19 @@ get: (key: string) => Promise<unknown>;
 }
-export interface ITriggerContext extends AnyObject {
+export interface ITriggerContext {
     secrets: Record<string, string>;
     github: IGithub;
 }
-export interface ITriggerOptions extends AnyObject {
+export interface ITriggerGeneralConfigOptions {
     every?: number;
-    should_deduplicate?: boolean;
-    skip_first?: boolean;
-    max_items_count?: number;
+    shouldDeduplicate?: boolean;
+    skipFirst?: boolean;
+    maxItemsCount?: number;
     force?: boolean;
-    log_level?: LogLevelDesc;
+    logLevel?: LogLevelDesc;
     active?: boolean;
+    continueOnError?: boolean;
 }
+export interface ITriggerOptions extends AnyObject {
+    config?: ITriggerGeneralConfigOptions;
+}
 export interface ITriggerContructorParams {
@@ -43,5 +55,6 @@ options: ITriggerOptions;
 }
-export interface ITriggerResult {
+export interface ITriggerResultObject {
     items: AnyObject[];
 }
+export declare type ITriggerResult = AnyObject[] | ITriggerResultObject;
 export interface IWebhookRequestRawPayload {
@@ -76,3 +89,3 @@ method?: HTTP_METHODS_LOWERCASE;
 export interface ITriggerClassType {
-    shouldDeduplicate?: boolean;
+    config?: ITriggerGeneralConfigOptions;
     getItemKey?: (item: AnyObject) => string;
@@ -79,0 +92,0 @@ run?(): Promise<ITriggerResult> | ITriggerResult;

package.json

 {
-  "version": "0.1.12",
+  "version": "0.1.13",
   "license": "MIT",
@@ -26,3 +26,3 @@ "main": "dist/src/index.js",
   },
-  "gitHead": "e49d450f06d81a78fbb4a157771601a10bcbd85c",
+  "gitHead": "3e73be834dda58051f3a55c44bf06787cb4cd396",
   "dependencies": {
@@ -29,0 +29,0 @@ "axios": "^0.20.0",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13004

increased by12.57%

Lines of code

146

increased by9.77%

No dependency changes