@jobrouter/api 2022.1.1-stable → 2022.1.2-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/api.d.ts +73 -45
  2. package/package.json +1 -1
package/api.d.ts CHANGED
@@ -1,61 +1,89 @@
1
1
  /********************************************************
2
- JobRouter JavaScript-API Stubs v5.1
2
+ JobRouter JavaScript-API Stubs v2022.1
3
3
  ********************************************************/
4
4
  type CustomErrorHandler = (errorMessage: string) => void;
5
- type ElementId = string;
5
+ type DecimalSeparator = "" | "," | ".";
6
+ type DialogFunctionUserParameters = {
7
+ [key: string]: unknown;
8
+ };
9
+ type DialogSuccessReturnObject = {
10
+ status: string;
11
+ result?: {
12
+ [key: string]: unknown;
13
+ };
14
+ };
15
+ type DialogErrorReturnObject = {
16
+ status: string;
17
+ message?: string;
18
+ result?: {
19
+ [key: string]: unknown;
20
+ };
21
+ };
22
+ type ElementValue = string | number | Date | boolean;
23
+ type MessageReplacements = {
24
+ [key: string]: string;
25
+ };
6
26
  type StepAction = "abort" | "answer" | "assign" | "back" | "finish" | "jumpTo" | "request" | "resubmission" | "save" | "send";
7
- type TimeUnit = "s" | "m" | "h" | "d";
8
- type Stamp = {
9
- text: string
10
- includeTime: boolean
11
- includeDate: boolean
12
- color: string
13
- onStamp?: ((stamp: Stamp, x: number, y: number) => void)
27
+ type Stamp = { text: string } & StampOptions;
28
+ type StampOptionOnStampFunction = (stamp: Stamp, x: number, y: number) => void;
29
+ type StampOptions = {
30
+ includeTime: boolean;
31
+ includeDate: boolean;
32
+ color: string;
33
+ onStamp?: StampOptionOnStampFunction;
34
+ };
35
+ type SubtableData = {
36
+ [key: number]: SubtableRowObject;
14
37
  };
38
+ type SubtableRowObject = {
39
+ [key: string]: ElementValue;
40
+ };
41
+ type ThousandsSeparator = "" | "," | "." | "'";
42
+ type TimeUnit = "s" | "m" | "h" | "d";
15
43
 
16
44
  declare const jr_execute: (action: StepAction | "reserve") => void;
17
- declare const jr_get_value: (id: ElementId, customErrorHandler?: CustomErrorHandler) => any;
18
- declare const jr_set_value: (id: ElementId, value: any, customHandler?: CustomErrorHandler) => void;
19
- declare const jr_get_display_value: (id: ElementId, customHandler?: CustomErrorHandler) => any;
20
- declare const jr_reset_value: (id: ElementId, customHandler?: CustomErrorHandler) => void;
21
- declare const jr_set_required: (id: ElementId, value?: boolean, customHandler?: CustomErrorHandler) => void;
22
- declare const jr_is_required: (id: ElementId, customHandler?: CustomErrorHandler) => boolean;
23
- declare const jr_set_label: (id: ElementId, label: string, radioValue?: string, customHandler?: CustomErrorHandler) => void;
24
- declare const jr_get_label: (id: ElementId, radioValue?: string, customHandler?: CustomErrorHandler) => string;
25
- declare const jr_set_label2: (id: ElementId, label: string, radioValue?: string, customHandler?: CustomErrorHandler) => void;
26
- declare const jr_get_label2: (id: ElementId, radioValue?: string, customHandler?: CustomErrorHandler) => string;
27
- declare const jr_show: (obj: string | string[]) => void;
28
- declare const jr_hide: (obj: string | string[]) => void;
29
- declare const jr_is_visible: (id: ElementId, customHandler?: CustomErrorHandler) => boolean;
45
+ declare const jr_get_value: (id: string, customErrorHandler?: CustomErrorHandler) => ElementValue;
46
+ declare const jr_set_value: (id: string, value: ElementValue, customHandler?: CustomErrorHandler) => void;
47
+ declare const jr_get_display_value: (id: string, customHandler?: CustomErrorHandler) => ElementValue;
48
+ declare const jr_reset_value: (id: string, customHandler?: CustomErrorHandler) => void;
49
+ declare const jr_set_required: (id: string, value?: boolean, customHandler?: CustomErrorHandler) => void;
50
+ declare const jr_is_required: (id: string, customHandler?: CustomErrorHandler) => boolean;
51
+ declare const jr_set_label: (id: string, label: string, radioValue?: string, customHandler?: CustomErrorHandler) => void;
52
+ declare const jr_get_label: (id: string, radioValue?: string, customHandler?: CustomErrorHandler) => string;
53
+ declare const jr_set_label2: (id: string, label: string, radioValue?: string, customHandler?: CustomErrorHandler) => void;
54
+ declare const jr_get_label2: (id: string, radioValue?: string, customHandler?: CustomErrorHandler) => string;
55
+ declare const jr_show: (id: string | string[]) => void;
56
+ declare const jr_hide: (id: string | string[]) => void;
57
+ declare const jr_is_visible: (id: string, customHandler?: CustomErrorHandler) => boolean;
30
58
  declare const jr_show_page: (pageName: string | string[]) => void;
31
59
  declare const jr_hide_page: (pageName: string | string[]) => void;
32
60
  declare const jr_show_step_action: (action: StepAction | StepAction[]) => void;
33
61
  declare const jr_hide_step_action: (action: StepAction | StepAction[]) => void;
34
62
  declare const jr_set_step_action_label: (action: StepAction, label: string) => void;
35
63
  declare const jr_select_page: (pageName: string) => void;
36
- declare const jr_set_readonly: (id: ElementId, value?: boolean, customHandler?: CustomErrorHandler) => void;
37
- declare const jr_is_readonly: (id: ElementId, customHandler?: CustomErrorHandler) => boolean;
38
- declare const jr_set_disabled: (id: ElementId, value?: boolean, customHandler?: CustomErrorHandler) => void;
39
- declare const jr_is_disabled: (id: ElementId, customHandler?: CustomErrorHandler) => boolean;
40
- declare const jr_set_background_color: (id: ElementId, color: string, customHandler?: CustomErrorHandler) => void;
41
- declare const jr_set_subtable_value: (subtableViewName: string, rowId: number, columnName: string, value: any, customHandler?: CustomErrorHandler) => void;
42
- declare const jr_set_subtable_display_value: (subtableViewName: string, rowId: number, columnName: string, value: any, customHandler?: CustomErrorHandler) => void;
43
- declare const jr_get_subtable_value: (subtableViewName: string, rowId: number | "sum", columnName: string, customHandler?: CustomErrorHandler) => any;
44
- declare const jr_get_subtable_display_value: (subtableViewName: string, rowId: number, columnName: string, customHandler?: CustomErrorHandler) => any;
45
- declare const jr_add_subtable_row: (subtableViewName: string, numberOfRows: number | Object | Object[], ignoreMaxRows?: boolean, finishCallback?: (addedRows: number) => void, customHandler?: CustomErrorHandler) => void;
64
+ declare const jr_set_readonly: (id: string, value?: boolean, customHandler?: CustomErrorHandler) => void;
65
+ declare const jr_is_readonly: (id: string, customHandler?: CustomErrorHandler) => boolean;
66
+ declare const jr_set_disabled: (id: string, value?: boolean, customHandler?: CustomErrorHandler) => void;
67
+ declare const jr_is_disabled: (id: string, customHandler?: CustomErrorHandler) => boolean;
68
+ declare const jr_set_background_color: (id: string, color: string, customHandler?: CustomErrorHandler) => void;
69
+ declare const jr_set_subtable_value: (subtableViewName: string, rowId: number, columnName: string, value: ElementValue, customHandler?: CustomErrorHandler) => void;
70
+ declare const jr_set_subtable_display_value: (subtableViewName: string, rowId: number, columnName: string, value: ElementValue, customHandler?: CustomErrorHandler) => void;
71
+ declare const jr_get_subtable_value: (subtableViewName: string, rowId: number | "sum", columnName: string, customHandler?: CustomErrorHandler) => ElementValue;
72
+ declare const jr_get_subtable_display_value: (subtableViewName: string, rowId: number, columnName: string, customHandler?: CustomErrorHandler) => ElementValue;
73
+ declare const jr_add_subtable_row: (subtableViewName: string, rows: number | SubtableRowObject | SubtableRowObject[], ignoreMaxRows?: boolean, finishCallback?: (addedRows: number) => void, customHandler?: CustomErrorHandler) => void;
46
74
  declare const jr_remove_subtable_row: (subtableViewName: string, rowId: number | number[], ignoreMinRows?: boolean) => void;
47
75
  declare const jr_copy_subtable_row: (subtableViewName: string, rowId: number | number[]) => void;
48
- declare const jr_hide_subtable_column: (subtableViewName: string, columnId: string | string[], radioValue?: string) => void;
49
- declare const jr_show_subtable_column: (subtableViewName: string, columnId: string | string[], radioValue?: string) => void;
76
+ declare const jr_hide_subtable_column: (subtableViewName: string, columnName: string | string[], radioValue?: string) => void;
77
+ declare const jr_show_subtable_column: (subtableViewName: string, columnName: string | string[], radioValue?: string) => void;
50
78
  declare const jr_hide_subtable_row: (subtableViewName: string, rowId: number) => void;
51
79
  declare const jr_show_subtable_row: (subtableViewName: string, rowId: number) => void;
52
80
  declare const jr_get_subtable_count: (subtableViewName: string, customHandler?: CustomErrorHandler) => number;
53
81
  declare const jr_get_subtable_max_id: (subtableViewName: string, customHandler?: CustomErrorHandler) => number;
54
82
  declare const jr_get_subtable_row_ids: (subtableViewName: string, customHandler?: CustomErrorHandler) => number[];
55
- declare const jr_sum_subtable_column: (subtableViewName: string, columnName: string, thousandsSeparator?: string, decimalSeparator?: string, decimalPlace?: number) => number;
56
- declare const jr_loop_table: (subtableViewName: string, callback: (subtableView: string, currentRow: number) => void, customHandler?: CustomErrorHandler) => void;
57
- declare const jr_set_column_label: (elementName: string, columnName: string, label: string, customHandler?: CustomErrorHandler) => void;
58
- declare const jr_get_column_label: (elementName: string, columnName: string, customHandler?: CustomErrorHandler) => string;
83
+ declare const jr_sum_subtable_column: (subtableViewName: string, columnName: string, thousandsSeparator?: ThousandsSeparator, decimalSeparator?: DecimalSeparator, decimalPlace?: number) => number;
84
+ declare const jr_loop_table: (subtableViewName: string, callback: (subtableViewName: string, currentRow: number) => void, customHandler?: CustomErrorHandler) => void;
85
+ declare const jr_set_column_label: (id: string, columnName: string, label: string, customHandler?: CustomErrorHandler) => void;
86
+ declare const jr_get_column_label: (id: string, columnName: string, customHandler?: CustomErrorHandler) => string;
59
87
  declare const jr_set_cell_label2: (subtableViewName: string, rowId: number, columnName: string, label: string, radioValue?: string, customHandler?: CustomErrorHandler) => void;
60
88
  declare const jr_get_cell_label2: (subtableViewName: string, rowId: number, columnName: string, radioValue?: string, customHandler?: CustomErrorHandler) => string;
61
89
  declare const jr_get_table_count: (tableName: string, customHandler?: CustomErrorHandler) => number;
@@ -63,18 +91,18 @@ declare const jr_get_table_max_id: (tableName: string, customHandler?: CustomErr
63
91
  declare const jr_set_table_background_color: (tableName: string, rowId: number | "*", columnName: string, color: string, customHandler?: CustomErrorHandler) => void;
64
92
  declare const jr_date_add: (date: Date, value: string, timeUnit: TimeUnit, customHandler?: CustomErrorHandler) => Date;
65
93
  declare const jr_date_diff: (date1: Date, date2: Date, timeUnit: TimeUnit, customHandler?: CustomErrorHandler) => number;
66
- declare const jr_sql_refresh: (id: ElementId | ElementId[], successCallback?: (id: ElementId, oldValue: any) => void, errorCallback?: (id: ElementId, error: string) => void, sequential?: boolean) => void;
94
+ declare const jr_sql_refresh: (id: string | string[], successCallback?: (id: string, oldValue: ElementValue) => void, errorCallback?: (id: string, error: string) => void, sequential?: boolean) => void;
67
95
  declare const jr_subtable_refresh: (subtableViewName: string, columnName?: string, rowId?: number | "*", successCallback?: (subtableViewName: string, columnName: string, rowId: number | "*") => void, errorCallback?: (subtableViewName: string, columnName: string, rowId: number | "*", error: string) => void, customHandler?: CustomErrorHandler) => void;
68
- declare const jr_message: (message: string, data?: Object, customHandler?: CustomErrorHandler) => void;
69
- declare const jr_get_message: (message: string, data?: Object, customHandler?: CustomErrorHandler) => string;
96
+ declare const jr_message: (message: string, replacements?: MessageReplacements, customHandler?: CustomErrorHandler) => void;
97
+ declare const jr_get_message: (message: string, replacements?: MessageReplacements, customHandler?: CustomErrorHandler) => string;
70
98
  declare const jr_allow_send: (value: boolean) => void;
71
99
  declare const jr_enable_send: () => void;
72
100
  declare const jr_disable_send: () => void;
73
101
  declare const jr_set_steplabel: (label: string) => void;
74
102
  declare const jr_get_steplabel: () => string;
75
103
  declare const jr_print: (callback?: () => void) => void;
76
- declare const jr_get_table_value: (tableName: string, rowId: number, columnName: string, customHandler?: CustomErrorHandler) => any;
77
- declare const jr_execute_dialog_function: (functionName: string, userParameters?: Object, onSuccessCallback?: (returnObject: { status: string, result?: Object }) => void, onErrorCallback?: (returnObject: { status: string, message?: string, result?: Object }) => void) => void;
104
+ declare const jr_get_table_value: (tableName: string, rowId: number, columnName: string, customHandler?: CustomErrorHandler) => ElementValue;
105
+ declare const jr_execute_dialog_function: (functionName: string, userParameters?: DialogFunctionUserParameters, onSuccessCallback?: (returnObject: DialogSuccessReturnObject) => void, onErrorCallback?: (returnObject: DialogErrorReturnObject) => void) => void;
78
106
  declare const jr_set_dialog_unchanged: () => void;
79
107
  declare const jr_has_dialog_changed: () => boolean;
80
108
  declare const jr_enable_dialog_changecheck: () => void;
@@ -86,10 +114,10 @@ declare const jr_notify_info: (message: string, timeoutInSeconds?: number) => vo
86
114
  declare const jr_notify_warn: (message: string, timeoutInSeconds?: number) => void;
87
115
  declare const jr_notify_error: (message: string, timeoutInSeconds?: number) => void;
88
116
  declare const jr_set_window_title: (title: string) => void;
89
- declare const jr_viewer_stamp_create: (stampText: string, options: Object) => Stamp;
117
+ declare const jr_viewer_stamp_create: (stampText: string, options: StampOptions) => Stamp;
90
118
  declare const jr_viewer_stamp_activate: (stamp: Stamp) => void;
91
119
  declare const jr_viewer_stamp_remove: (stamp: Stamp) => void;
92
- declare const jr_subtable_init: (subtableViewName: string, subtableData: Object, successCallback?: (subtableViewName: string) => void, errorCallback?: (subtableViewName: string, error: string) => void) => void;
120
+ declare const jr_subtable_init: (subtableViewName: string, subtableData: SubtableData, successCallback?: (subtableViewName: string) => void, errorCallback?: (subtableViewName: string, error: string) => void) => void;
93
121
  declare const jr_get_instance_id: () => number;
94
122
  declare const jr_close_section: (sectionName: string) => void;
95
123
  declare const jr_open_section: (sectionName: string) => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jobrouter/api",
3
- "version": "2022.1.1-stable",
3
+ "version": "2022.1.2-beta.1",
4
4
  "description": "JobRouter® JavaScript API",
5
5
  "main": "",
6
6
  "author": "JobRouter AG",