Skip to content

Improve the interface of the Actions class #98

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

Open
mateuscardosodeveloper wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve the interface of the Actions class #98

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bde181e
Improvere the interface of the Actions class
mateuscardosodeveloper Jul 12, 2023
96323cc
Merge branch 'master' into improvement/interface-actions/SDKJS-37
felipefdl Aug 18, 2023
34faa02
Merge branch 'master' into improvement/interface-actions/SDKJS-37
felipefdl Aug 18, 2023
f795950
Code review fixes
mateuscardosodeveloper Aug 18, 2023
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
53 changes: 48 additions & 5 deletions src/modules/Resources/actions.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { GenericID, Conditionals, TagsObj, Query, ExpireTimeOption } from "../../common/common.types";
import { Conditionals, ExpireTimeOption, GenericID, Query, TagsObj } from "../../common/common.types";

type ActionType = "condition" | "resource" | "interval" | "schedule" | "mqtt_topic";

type ActionTypeParams =
| {
script: GenericID[];
script: GenericID | GenericID[];
type: "script";
}
| {
Expand Down Expand Up @@ -34,17 +34,41 @@ type ActionTypeParams =
payload: string;
topic: string;
type: "mqtt";
qos?: 1 | 2 | 3;
Copy link
Member

@RicardoStoklosa RicardoStoklosa Sep 18, 2023

Choose a reason for hiding this comment

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

Suggested change
qos?: 1 | 2 | 3;
qos?: 0 | 1 | 2;

retain?: boolean;
}
| {
headers: {};
headers: Record<string, string>;
Copy link
Member

@RicardoStoklosa RicardoStoklosa Sep 18, 2023

Choose a reason for hiding this comment

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

Suggested change
headers: Record<string, string>;
headers?: Record<string, string>;

fallback_token?: string;
type: "post";
url: string;
}
| {
type: "insert_bucket";
}
| {
type: "tcore";
tcore_id: GenericID;
device_token: string;
}
| {
type: "tcore";
device_token: string;
tcore_cluster_id: string;
};

type ActionTriggerType =
| {
resource: "device" | "bucket" | "file" | "analysis" | "action" | "am" | "user" | "financial" | "profile";
when: "create" | "update" | "delete";
when:
| "create"
| "update"
| "delete"
| "mqtt_connect"
| "mqtt_disconnect"
| "login_success"
| "login_fail"
| "chunk_copied";
tag_key: string;
tag_value: string;
}
Expand All @@ -63,6 +87,25 @@ type ActionTriggerType =
second_value?: string;
value_type: "string" | "number" | "boolean" | "*";
unlock?: boolean;
}
| {
variable: string;
is: Conditionals;
value: string;
second_value?: string;
value_type: "string" | "number" | "boolean" | "*";
unlock?: boolean;
tag_key: string;
tag_value: string;
}
| {
device: string;
topic: string;
}
| {
tag_key: string;
tag_value: string;
topic: string;
};

interface ActionCreateInfo {
Expand All @@ -85,7 +128,7 @@ interface ActionCreateInfo {
/**
* Description of the action.
*/
description?: string | null;
description?: string;
lock?: boolean;
/**
* Type of action
Expand Down