@yuneta/gobj-js 7.16.6 → 7.21.0

package/dist/gobj-js.es.js

@@ -4020,10 +4020,18 @@ Being `kw` a:
 - list of strings [s,...]
 - list of dicts [{},...]
 - dict of dicts {id:{},...}
-return a **NEW** list of incref (clone) kw filtering the rows by `jn_filter` (where),
-and matching the ids.
-If match_fn is 0 then kw_match_simple is used.
-NOTE Using JSON_INCREF/JSON_DECREF HACK
+return a NEW list holding the rows that match `ids` and the
+`jn_filter` (where). If match_fn is 0 then kw_match_simple is used.
+
+WARNING the LIST is new; its elements are THE SAME objects, not
+copies. The C twin increfs each one and says "clone", which this
+comment repeated for years: javascript has no refcount, so a write
+through a collected row writes into `kw`. Copy what you mean to
+modify.
+
+Returns null -- not an empty list -- for a `kw` that is neither a
+list nor a dict, so a caller that reads `.length` off the answer
+must check it first (kwid_find_one_record does).
 *************************************************************/
 function kwid_collect(gobj, kw, ids, jn_filter, match_fn) {
 	if (gobj && !is_gobj(gobj)) log_error(`GObj bad instanceof`);
@@ -4052,12 +4060,17 @@ function kwid_collect(gobj, kw, ids, jn_filter, match_fn) {
 }
 /*************************************************************
 Utility for databases.
-Return a new dict from a "dict of records" or "list of records"
-WARNING the "id" of a dict's record is hardcorded to their key.
+Return a dict from a "dict of records" or "list of records".
+WARNING the "id" of a dict's record is hardcoded to its key.
 Convention:
-- all arrays are list of records (dicts) with "id" field as primary key
+- all arrays are lists of records (dicts) with "id" as primary key
 - delimiter is '`' and '.'
 If path is empty then use kw
+
+WARNING "new" is the C twin's word, where it means a new REFERENCE:
+handed a dict, both return THAT dict and not a copy of it. Only the
+list case builds something new, and even then the records inside it
+are the same objects.
 *************************************************************/
 function kwid_new_dict(gobj, kw, path) {
 	if (gobj && !is_gobj(gobj)) log_error(`GObj bad instanceof`);
@@ -4066,20 +4079,59 @@ function kwid_new_dict(gobj, kw, path) {
 	if (is_object(kw)) new_dict = kw;
 	else if (is_array(kw)) for (let i = 0; i < kw.length; i++) {
 		let kv = kw[i];
-		let id = kw_get_str(gobj, kv, "id", "", 0);
+		let id = kw_get_str(gobj, kv, "id", "", kw_flag_t.KW_REQUIRED);
 		if (!empty_string(id)) new_dict[id] = kv;
 	}
 	else log_error(`${gobj_short_name(gobj)} kwid_new_dict: data type unknown`);
 	return new_dict;
 }
 /*************************************************************
+Utility for databases.
+Return a list from a "dict of records" or "list of records".
+The NORMALIZING function of this family: whatever shape the data
+arrives in, what comes back is the shape a table indexed and
+sorted by `id` wants.
+Convention:
+- all arrays are lists of records (dicts) with "id" as primary key
+- delimiter is '`' and '.'
+If path is empty then use kw
+
+WARNING handed a DICT it writes each record's key into the record
+as its `id`, OVERWRITING one that differs -- in the source records,
+which it does not copy. That is the C twin's behaviour
+(`json_object_set_new(v, "id", ...)` in kwid.c) and it is the point:
+a dict keyed by id whose records disagree with their own key is
+exactly what this is for. Handed a LIST it returns that same list,
+untouched, as C returns a new reference to it.
+*************************************************************/
+function kwid_new_list(gobj, kw, path) {
+	if (gobj && !is_gobj(gobj)) log_error(`GObj bad instanceof`);
+	if (!empty_string(path)) kw = kw_find_path(gobj, kw, path);
+	if (is_array(kw)) return kw;
+	if (is_object(kw)) {
+		let new_list = [];
+		for (let id of Object.keys(kw)) {
+			let record = kw[id];
+			if (!is_object(record)) {
+				log_error(`${gobj_short_name(gobj)} kwid_new_list: not a record: '${id}'`);
+				continue;
+			}
+			record["id"] = id;
+			new_list.push(record);
+		}
+		return new_list;
+	}
+	log_error(`${gobj_short_name(gobj)} kwid_new_list: wrong type for list`);
+	return [];
+}
+/*************************************************************
 *  Utility for databases. See kwid_collect parameters
 *************************************************************/
 function kwid_find_one_record(gobj, kw, ids, jn_filter, match_fn) {
 	if (gobj && !is_gobj(gobj)) log_error(`GObj bad instanceof`);
 	let list = kwid_collect(gobj, kw, ids, jn_filter, match_fn);
-	if (list.length > 0) return list[0];
-	else return null;
+	if (!list || list.length === 0) return null;
+	return list[0];
 }
 /*************************************************************
 Utility for databases.
@@ -6906,6 +6958,6 @@ function register_c_ievent_cli() {
 	return create_gclass(GCLASS_NAME);
 }
 //#endregion
-export { GObj, SDATA, SDATAAUTHZ, SDATACM, SDATACM2, SDATADF, SDATAPM, SDATAPM0, SDATA_END, SDataDesc, YUNETA_VERSION, __yuno__, build_command_response, build_path, build_stats_response, clean_name, clear_timeout, cmp_two_simple_json, command_parser, createElement2, createOneHtml, create_json_record, create_template_record, current_timestamp, data_type_t, db_list_persistent_attrs, db_load_persistent_attrs, db_remove_persistent_attrs, db_save_persistent_attrs, debounce, delete_from_list, duplicate_objects, empty_json, empty_string, escapeHtml, event_flag_t, flat2json, flat_apply, flat_diff, flat_key_join, flat_key_split, gclass_add_ev_action, gclass_add_event_type, gclass_add_state, gclass_check_fsm, gclass_create, gclass_event_type, gclass_find_by_name, gclass_flag_t, gclass_unregister, getPositionRelativeToBody, get_function_name, get_now, gobj_bottom_gobj, gobj_change_parent, gobj_change_state, gobj_command, gobj_create, gobj_create2, gobj_create_default_service, gobj_create_pure_child, gobj_create_service, gobj_create_volatil, gobj_create_yuno, gobj_current_state, gobj_default_service, gobj_deliver_posted_events, gobj_destroy, gobj_find_child, gobj_find_gobj, gobj_find_service, gobj_find_subscribings, gobj_find_subscriptions, gobj_flag_t, gobj_full_name, gobj_gclass_name, gobj_global_trace_level, gobj_has_attr, gobj_has_event, gobj_has_output_event, gobj_hsdata, gobj_is_destroying, gobj_is_playing, gobj_is_pure_child, gobj_is_running, gobj_is_service, gobj_is_volatil, gobj_list_persistent_attrs, gobj_list_subscriptions, gobj_load_persistent_attrs, gobj_match_children, gobj_match_children_tree, gobj_match_gobj, gobj_name, gobj_parent, gobj_pause, gobj_play, gobj_post_event, gobj_posted_events_size, gobj_publish_event, gobj_read_attr, gobj_read_attrs, gobj_read_bool_attr, gobj_read_integer_attr, gobj_read_pointer_attr, gobj_read_str_attr, gobj_remove_persistent_attrs, gobj_repr_global_trace_levels, gobj_reset_volatil_attrs, gobj_save_persistent_attrs, gobj_search_path, gobj_send_event, gobj_services, gobj_set_bottom_gobj, gobj_set_deep_trace, gobj_set_gclass_no_trace, gobj_set_gclass_trace, gobj_set_global_no_trace, gobj_set_global_trace, gobj_set_gobj_no_trace, gobj_set_gobj_trace, gobj_set_trace_machine_format, gobj_short_name, gobj_start, gobj_start_children, gobj_start_tree, gobj_start_up, gobj_stats, gobj_stop, gobj_stop_children, gobj_stop_tree, gobj_subscribe_event, gobj_trace_level, gobj_trace_machine_format, gobj_trace_no_level, gobj_unsubscribe_event, gobj_unsubscribe_list, gobj_walk_gobj_children, gobj_walk_gobj_children_tree, gobj_write_attr, gobj_write_attrs, gobj_write_bool_attr, gobj_write_integer_attr, gobj_write_str_attr, gobj_yuno, gobj_yuno_id, gobj_yuno_name, gobj_yuno_role, id_index_in_obj_list, index_in_list, is_array, is_boolean, is_date, is_function, is_gobj, is_metadata_key, is_null, is_number, is_object, is_private_key, is_pure_number, is_string, jdb_delete, jdb_get, jdb_get_by_idx, jdb_get_topic, jdb_init, jdb_update, json2flat, json_array_append, json_array_append_new, json_array_extend, json_array_remove, json_array_size, json_deep_copy, json_is_identical, json_object_del, json_object_get, json_object_set, json_object_set_new, json_object_size, json_object_update, json_object_update_existing, json_object_update_missing, json_size, jwt2json, jwtDecode, kw_clone_by_keys, kw_clone_by_not_keys, kw_collect, kw_delete, kw_find_json_in_list, kw_find_path, kw_flag_t, kw_get_bool, kw_get_dict, kw_get_dict_value, kw_get_int, kw_get_list, kw_get_local_storage_value, kw_get_pointer, kw_get_real, kw_get_str, kw_has_key, kw_match_simple, kw_pop, kw_remove_local_storage_value, kw_select, kw_set_dict_value, kw_set_local_storage_value, kw_set_subdict_value, kwid_collect, kwid_find_one_record, kwid_get_ids, kwid_match_id, kwid_new_dict, list2options, load_json_file, log_debug, log_error, log_info, log_warning, msg_iev_get_msg_type, msg_iev_get_stack, msg_iev_push_stack, msg_iev_read_key, msg_iev_set_msg_type, msg_iev_write_key, node_uuid, parseBoolean, parseSVG, refresh_language, register_c_ievent_cli, register_c_timer, register_c_yuno, safeSrc, sdata_flag_t, send_http_json_post, set_console_log_enabled, set_console_log_filter, set_log_callback, set_remote_log_functions, set_timeout, set_timeout_periodic, sprintf, stats_parser, str_in_list, strcasecmp, strcmp, strncmp, strs_in_list, strstr, template_get_field_desc, timeTracker, trace_json, trace_level_t, trace_msg, treedb_decoder_fkey, treedb_decoder_hook, treedb_encoder_fkey, treedb_get_field_desc, treedb_hook_data_size, vsprintf, walk_type_t };
+export { GObj, SDATA, SDATAAUTHZ, SDATACM, SDATACM2, SDATADF, SDATAPM, SDATAPM0, SDATA_END, SDataDesc, YUNETA_VERSION, __yuno__, build_command_response, build_path, build_stats_response, clean_name, clear_timeout, cmp_two_simple_json, command_parser, createElement2, createOneHtml, create_json_record, create_template_record, current_timestamp, data_type_t, db_list_persistent_attrs, db_load_persistent_attrs, db_remove_persistent_attrs, db_save_persistent_attrs, debounce, delete_from_list, duplicate_objects, empty_json, empty_string, escapeHtml, event_flag_t, flat2json, flat_apply, flat_diff, flat_key_join, flat_key_split, gclass_add_ev_action, gclass_add_event_type, gclass_add_state, gclass_check_fsm, gclass_create, gclass_event_type, gclass_find_by_name, gclass_flag_t, gclass_unregister, getPositionRelativeToBody, get_function_name, get_now, gobj_bottom_gobj, gobj_change_parent, gobj_change_state, gobj_command, gobj_create, gobj_create2, gobj_create_default_service, gobj_create_pure_child, gobj_create_service, gobj_create_volatil, gobj_create_yuno, gobj_current_state, gobj_default_service, gobj_deliver_posted_events, gobj_destroy, gobj_find_child, gobj_find_gobj, gobj_find_service, gobj_find_subscribings, gobj_find_subscriptions, gobj_flag_t, gobj_full_name, gobj_gclass_name, gobj_global_trace_level, gobj_has_attr, gobj_has_event, gobj_has_output_event, gobj_hsdata, gobj_is_destroying, gobj_is_playing, gobj_is_pure_child, gobj_is_running, gobj_is_service, gobj_is_volatil, gobj_list_persistent_attrs, gobj_list_subscriptions, gobj_load_persistent_attrs, gobj_match_children, gobj_match_children_tree, gobj_match_gobj, gobj_name, gobj_parent, gobj_pause, gobj_play, gobj_post_event, gobj_posted_events_size, gobj_publish_event, gobj_read_attr, gobj_read_attrs, gobj_read_bool_attr, gobj_read_integer_attr, gobj_read_pointer_attr, gobj_read_str_attr, gobj_remove_persistent_attrs, gobj_repr_global_trace_levels, gobj_reset_volatil_attrs, gobj_save_persistent_attrs, gobj_search_path, gobj_send_event, gobj_services, gobj_set_bottom_gobj, gobj_set_deep_trace, gobj_set_gclass_no_trace, gobj_set_gclass_trace, gobj_set_global_no_trace, gobj_set_global_trace, gobj_set_gobj_no_trace, gobj_set_gobj_trace, gobj_set_trace_machine_format, gobj_short_name, gobj_start, gobj_start_children, gobj_start_tree, gobj_start_up, gobj_stats, gobj_stop, gobj_stop_children, gobj_stop_tree, gobj_subscribe_event, gobj_trace_level, gobj_trace_machine_format, gobj_trace_no_level, gobj_unsubscribe_event, gobj_unsubscribe_list, gobj_walk_gobj_children, gobj_walk_gobj_children_tree, gobj_write_attr, gobj_write_attrs, gobj_write_bool_attr, gobj_write_integer_attr, gobj_write_str_attr, gobj_yuno, gobj_yuno_id, gobj_yuno_name, gobj_yuno_role, id_index_in_obj_list, index_in_list, is_array, is_boolean, is_date, is_function, is_gobj, is_metadata_key, is_null, is_number, is_object, is_private_key, is_pure_number, is_string, jdb_delete, jdb_get, jdb_get_by_idx, jdb_get_topic, jdb_init, jdb_update, json2flat, json_array_append, json_array_append_new, json_array_extend, json_array_remove, json_array_size, json_deep_copy, json_is_identical, json_object_del, json_object_get, json_object_set, json_object_set_new, json_object_size, json_object_update, json_object_update_existing, json_object_update_missing, json_size, jwt2json, jwtDecode, kw_clone_by_keys, kw_clone_by_not_keys, kw_collect, kw_delete, kw_find_json_in_list, kw_find_path, kw_flag_t, kw_get_bool, kw_get_dict, kw_get_dict_value, kw_get_int, kw_get_list, kw_get_local_storage_value, kw_get_pointer, kw_get_real, kw_get_str, kw_has_key, kw_match_simple, kw_pop, kw_remove_local_storage_value, kw_select, kw_set_dict_value, kw_set_local_storage_value, kw_set_subdict_value, kwid_collect, kwid_find_one_record, kwid_get_ids, kwid_match_id, kwid_new_dict, kwid_new_list, list2options, load_json_file, log_debug, log_error, log_info, log_warning, msg_iev_get_msg_type, msg_iev_get_stack, msg_iev_push_stack, msg_iev_read_key, msg_iev_set_msg_type, msg_iev_write_key, node_uuid, parseBoolean, parseSVG, refresh_language, register_c_ievent_cli, register_c_timer, register_c_yuno, safeSrc, sdata_flag_t, send_http_json_post, set_console_log_enabled, set_console_log_filter, set_log_callback, set_remote_log_functions, set_timeout, set_timeout_periodic, sprintf, stats_parser, str_in_list, strcasecmp, strcmp, strncmp, strs_in_list, strstr, template_get_field_desc, timeTracker, trace_json, trace_level_t, trace_msg, treedb_decoder_fkey, treedb_decoder_hook, treedb_encoder_fkey, treedb_get_field_desc, treedb_hook_data_size, vsprintf, walk_type_t };
 
 //# sourceMappingURL=gobj-js.es.js.map