Adding helpers to generate cluster specific object files (#1603)

Author: dhchandw

docs/api.md

@@ -8915,6 +8915,7 @@ This module contains the API for templating. For more detailed instructions, rea
     * [~access_aggregate(options)](#module_Templating API_ Access helpers..access_aggregate)
     * [~access(options)](#module_Templating API_ Access helpers..access)
     * [~default_access(options)](#module_Templating API_ Access helpers..default_access) ⇒
+    * [~chip_get_access_role(options)](#module_Templating API_ Access helpers..chip_get_access_role) ⇒ <code>string</code>
 
 <a name="module_Templating API_ Access helpers..collectDefaultAccessList"></a>
 
@@ -8979,6 +8980,18 @@ Get the access list information.
 | --- | --- |
 | options | <code>\*</code> | 
 
+<a name="module_Templating API_ Access helpers..chip_get_access_role"></a>
+
+### Templating API: Access helpers~chip\_get\_access\_role(options) ⇒ <code>string</code>
+Determines the access role for a given entity and operation.
+
+**Kind**: inner method of [<code>Templating API: Access helpers</code>](#module_Templating API_ Access helpers)  
+**Returns**: <code>string</code> - The access role.  
+
+| Param | Type |
+| --- | --- |
+| options | <code>\*</code> | 
+
 <a name="module_Templating API_ Attribute helpers"></a>
 
 ## Templating API: Attribute helpers

docs/helpers.md

@@ -54,6 +54,7 @@ This module contains the API for templating. For more detailed instructions, rea
     * [~access_aggregate(options)](#module_Templating API_ Access helpers..access_aggregate)
     * [~access(options)](#module_Templating API_ Access helpers..access)
     * [~default_access(options)](#module_Templating API_ Access helpers..default_access) ⇒
+    * [~chip_get_access_role(options)](#module_Templating API_ Access helpers..chip_get_access_role) ⇒ <code>string</code>
 
 <a name="module_Templating API_ Access helpers..collectDefaultAccessList"></a>
 
@@ -118,6 +119,18 @@ Get the access list information.
 | --- | --- |
 | options | <code>\*</code> | 
 
+<a name="module_Templating API_ Access helpers..chip_get_access_role"></a>
+
+### Templating API: Access helpers~chip\_get\_access\_role(options) ⇒ <code>string</code>
+Determines the access role for a given entity and operation.
+
+**Kind**: inner method of [<code>Templating API: Access helpers</code>](#module_Templating API_ Access helpers)  
+**Returns**: <code>string</code> - The access role.  
+
+| Param | Type |
+| --- | --- |
+| options | <code>\*</code> | 
+
 <a name="module_Templating API_ Attribute helpers"></a>
 
 ## Templating API: Attribute helpers

src-electron/generator/helper-access.js

@@ -237,6 +237,33 @@ async function default_access(options) {
   return templateUtil.templatePromise(this.global, p)
 }
 
+/**
+ * Determines the access role for a given entity and operation.
+ *
+ * @param {*} options
+ * @returns {string} The access role.
+ */
+async function chip_get_access_role(options) {
+  if (!('op' in options.hash)) {
+    throw new Error('Access helper requires op from the op="<op>" option.')
+  }
+
+  const op = options.hash.op
+  const accessList = await collectAccesslist(this, options)
+  const accessForOp = accessList.find((a) => a.operation === op)
+
+  if (accessForOp?.role) {
+    return accessForOp.role
+  }
+
+  if ('default' in options.hash) {
+    return options.hash.default
+  }
+
+  return ''
+}
+
 exports.access = access
 exports.access_aggregate = access_aggregate
 exports.default_access = default_access
+exports.chip_get_access_role = chip_get_access_role

src-electron/generator/matter/app/zap-templates/templates/app/helper.js

@@ -594,6 +594,20 @@ function asUpperCamelCase(label, options) {
   const preserveAcronyms = options && options.hash.preserveAcronyms;
   return asCamelCase(label, false, preserveAcronyms);
 }
+/**
+ * Same as asUpperCamelCase, but with a special case for "RFID".
+ * Special case for cluster specific object files for Matter.
+ *
+ * @param {*} label
+ * @param {*} options
+ * @returns {string}
+ */
+function chip_name_for_id_usage(label, options) {
+  if (label == 'RFID') {
+    return 'Rfid';
+  }
+  return asUpperCamelCase(label, options);
+}
 
 function chip_friendly_endpoint_type_name(options) {
   let name = this.endpointTypeName;
@@ -1272,6 +1286,7 @@ exports.zcl_commands_that_need_timed_invoke =
   zcl_commands_that_need_timed_invoke;
 exports.if_is_fabric_scoped_struct = if_is_fabric_scoped_struct;
 exports.if_is_non_zero_default = if_is_non_zero_default;
+exports.chip_name_for_id_usage = chip_name_for_id_usage;
 
 exports.meta = {
   category: dbEnum.helperCategory.matter,

test/gen-matter-3-1.test.js

@@ -570,6 +570,14 @@ test(
       zclPackageId
     )
     expect(globalBitmap.id).not.toEqual(clusterBitmap.id)
+
+    // Testing chip_get_access_role for attributes
+    expect(ept).toContain(
+      'Name - Acl, Read Privilege - Administer, Write Privilege - Administer'
+    )
+
+    // Testing chip_get_access_role for commands
+    expect(ept).toContain('Name - KeySetWrite, Invoke Privilege - Administer')
   },
   testUtil.timeout.long()
 )

test/gen-template/matter3/miscellaneous_helper_tests.zapt

@@ -46,3 +46,15 @@ SemanticTagStruct item {{index}} from Identify cluster: {{name}}
   {{#if struct_contains_array}} Struct with array: {{name}}
   {{/if}}
 {{/zcl_structs}}
+
+// Test chip_get_access_role for attributes
+{{#zcl_attributes_server}}
+{{#if clusterRef}}
+Name - {{asUpperCamelCase label}}, Read Privilege - {{asUpperCamelCase (chip_get_access_role entity="attribute" op="read" default="view")}}, {{#if isWritableAttribute}}Write Privilege - {{asUpperCamelCase (chip_get_access_role entity="attribute" op="write" default="operate")}}{{/if}}
+{{/if}}
+{{/zcl_attributes_server}}
+
+// Test chip_get_access_role for commands
+{{#zcl_commands_source_client}}
+Name - {{asUpperCamelCase name}}, Invoke Privilege - {{asUpperCamelCase (chip_get_access_role entity="command" op="invoke" default="operate")}}
+{{/zcl_commands_source_client}}