@genesislcap/foundation-entity-management 14.205.0 → 14.206.0

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.
@@ -1819,442 +1819,243 @@
1819
1819
  },
1820
1820
  {
1821
1821
  "kind": "javascript-module",
1822
- "path": "src/routes/config.ts",
1823
- "declarations": [],
1824
- "exports": []
1825
- },
1826
- {
1827
- "kind": "javascript-module",
1828
- "path": "src/routes/index.ts",
1829
- "declarations": [],
1830
- "exports": [
1831
- {
1832
- "kind": "js",
1833
- "name": "*",
1834
- "declaration": {
1835
- "name": "*",
1836
- "package": "./config"
1837
- }
1838
- }
1839
- ]
1840
- },
1841
- {
1842
- "kind": "javascript-module",
1843
- "path": "src/users/users.template.ts",
1822
+ "path": "src/profiles/editProfileSchema.ts",
1844
1823
  "declarations": [
1845
1824
  {
1846
- "kind": "function",
1847
- "name": "getPrefixedUsers",
1848
- "parameters": [
1849
- {
1850
- "name": "prefix"
1851
- }
1852
- ]
1825
+ "kind": "variable",
1826
+ "name": "editProfileFormSchema",
1827
+ "type": {
1828
+ "text": "UiSchema"
1829
+ },
1830
+ "default": "{\n type: 'VerticalLayout',\n elements: [\n {\n type: 'Control',\n label: 'Name',\n scope: '#/properties/NAME',\n },\n {\n type: 'Control',\n label: 'Description',\n scope: '#/properties/DESCRIPTION',\n },\n {\n type: 'Control',\n label: 'Status',\n scope: '#/properties/STATUS',\n },\n {\n type: 'Control',\n label: 'Rights',\n scope: '#/properties/RIGHT_CODES',\n options: {\n allOptionsResourceName: 'RIGHT',\n valueField: 'CODE',\n labelField: 'CODE',\n },\n },\n {\n type: 'Control',\n label: 'Users',\n scope: '#/properties/USER_NAMES',\n options: {\n allOptionsResourceName: 'USER',\n valueField: 'USER_NAME',\n labelField: 'USER_NAME',\n },\n },\n ],\n}"
1853
1831
  }
1854
1832
  ],
1855
1833
  "exports": [
1856
1834
  {
1857
1835
  "kind": "js",
1858
- "name": "getPrefixedUsers",
1836
+ "name": "editProfileFormSchema",
1859
1837
  "declaration": {
1860
- "name": "getPrefixedUsers",
1861
- "module": "src/users/users.template.ts"
1838
+ "name": "editProfileFormSchema",
1839
+ "module": "src/profiles/editProfileSchema.ts"
1862
1840
  }
1863
1841
  }
1864
1842
  ]
1865
1843
  },
1866
1844
  {
1867
1845
  "kind": "javascript-module",
1868
- "path": "src/users/users.ts",
1846
+ "path": "src/profiles/profiles.ts",
1869
1847
  "declarations": [
1870
- {
1871
- "kind": "variable",
1872
- "name": "UsersColumnConfig",
1873
- "type": {
1874
- "text": "array"
1875
- },
1876
- "default": "[\n {\n ...defaultColumnConfig,\n field: 'USER_NAME',\n headerName: 'Username',\n },\n {\n ...defaultColumnConfig,\n field: 'FIRST_NAME',\n headerName: 'First Name',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_NAME',\n headerName: 'Last Name',\n },\n {\n ...defaultColumnConfig,\n field: 'EMAIL_ADDRESS',\n headerName: 'Email',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_LOGIN',\n headerName: 'Last Login',\n valueFormatter: ({ value }) =>\n value\n ? new Intl.DateTimeFormat('default', {\n year: 'numeric',\n month: 'numeric',\n day: 'numeric',\n hour: 'numeric',\n minute: 'numeric',\n }).format(value)\n : '',\n },\n]",
1877
- "description": "Defines the default columns which are present on the user management component",
1878
- "privacy": "public"
1879
- },
1880
1848
  {
1881
1849
  "kind": "class",
1882
- "description": "Main class which defines the user management functionality",
1883
- "name": "Users",
1850
+ "description": "Main class which defined the profile management functionality",
1851
+ "name": "Profiles",
1884
1852
  "members": [
1885
1853
  {
1886
- "kind": "field",
1887
- "name": "prefix",
1888
- "type": {
1889
- "text": "string"
1890
- },
1891
- "default": "'zero'",
1892
- "description": "Name of the design system prefix that will be used for components.",
1893
- "privacy": "public"
1854
+ "kind": "method",
1855
+ "name": "readProfileData",
1856
+ "privacy": "public",
1857
+ "parameters": [
1858
+ {
1859
+ "name": "profile"
1860
+ }
1861
+ ]
1894
1862
  },
1895
1863
  {
1896
- "kind": "field",
1897
- "name": "persistColumnStateKey",
1898
- "type": {
1899
- "text": "string"
1900
- },
1901
- "default": "'entity_users_management'",
1902
- "description": "This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.",
1903
- "privacy": "public"
1864
+ "kind": "method",
1865
+ "name": "confirmDelete",
1866
+ "inheritedFrom": {
1867
+ "name": "EntityManagement",
1868
+ "module": "src/entities/entities.ts"
1869
+ }
1904
1870
  },
1905
1871
  {
1906
1872
  "kind": "field",
1907
- "name": "enableSearchBar",
1873
+ "name": "createEvent",
1908
1874
  "type": {
1909
- "text": "boolean"
1875
+ "text": "string"
1910
1876
  },
1911
- "default": "false",
1912
- "description": "This attribute controls whether to enable the search-bar.",
1913
- "privacy": "public"
1877
+ "description": "Name of the event handler on the Genesis server which handles creating an entity",
1878
+ "privacy": "public",
1879
+ "inheritedFrom": {
1880
+ "name": "EntityManagement",
1881
+ "module": "src/entities/entities.ts"
1882
+ }
1914
1883
  },
1915
1884
  {
1916
1885
  "kind": "field",
1917
- "name": "datasourceType",
1886
+ "name": "deleteEvent",
1918
1887
  "type": {
1919
- "text": "DatasourceType"
1888
+ "text": "string"
1920
1889
  },
1921
- "default": "'client'",
1922
- "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
1923
- "privacy": "public"
1890
+ "description": "Name of the event handler on the Genesis server which handles deleting the entity",
1891
+ "privacy": "public",
1892
+ "inheritedFrom": {
1893
+ "name": "EntityManagement",
1894
+ "module": "src/entities/entities.ts"
1895
+ }
1924
1896
  },
1925
1897
  {
1926
1898
  "kind": "field",
1927
- "name": "isServerSideDatasource",
1899
+ "name": "updateEvent",
1928
1900
  "type": {
1929
- "text": "boolean"
1901
+ "text": "string"
1930
1902
  },
1931
- "readonly": true
1903
+ "description": "Name of the event handler on the Genesis server which handles updating the entity",
1904
+ "privacy": "public",
1905
+ "inheritedFrom": {
1906
+ "name": "EntityManagement",
1907
+ "module": "src/entities/entities.ts"
1908
+ }
1932
1909
  },
1933
1910
  {
1934
1911
  "kind": "field",
1935
- "name": "gridOptions",
1912
+ "name": "persistColumnStateKey",
1936
1913
  "type": {
1937
- "text": "GridOptions"
1914
+ "text": "string"
1938
1915
  },
1939
- "description": "GridOptions to be passed down from application",
1940
- "privacy": "public"
1916
+ "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.",
1917
+ "privacy": "public",
1918
+ "default": "'entity_profiles_management'",
1919
+ "inheritedFrom": {
1920
+ "name": "EntityManagement",
1921
+ "module": "src/entities/entities.ts"
1922
+ }
1941
1923
  },
1942
1924
  {
1943
1925
  "kind": "field",
1944
- "name": "columns",
1926
+ "name": "updateFormUiSchema",
1945
1927
  "type": {
1946
- "text": "(ColDef<any> | ColGroupDef<any>)[]"
1928
+ "text": "UiSchema"
1947
1929
  },
1948
- "default": "[\n {\n ...defaultColumnConfig,\n field: 'USER_NAME',\n headerName: 'Username',\n },\n {\n ...defaultColumnConfig,\n field: 'FIRST_NAME',\n headerName: 'First Name',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_NAME',\n headerName: 'Last Name',\n },\n {\n ...defaultColumnConfig,\n field: 'EMAIL_ADDRESS',\n headerName: 'Email',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_LOGIN',\n headerName: 'Last Login',\n valueFormatter: ({ value }) =>\n value\n ? new Intl.DateTimeFormat('default', {\n year: 'numeric',\n month: 'numeric',\n day: 'numeric',\n hour: 'numeric',\n minute: 'numeric',\n }).format(value)\n : '',\n },\n]",
1949
- "description": "Column definition, default to the UsersColumnConfig"
1930
+ "default": "editProfileFormSchema",
1931
+ "inheritedFrom": {
1932
+ "name": "EntityManagement",
1933
+ "module": "src/entities/entities.ts"
1934
+ }
1950
1935
  },
1951
1936
  {
1952
1937
  "kind": "field",
1953
- "name": "additionalCreateFields",
1938
+ "name": "createFormUiSchema",
1954
1939
  "type": {
1955
- "text": "AdditionalEntry[]"
1940
+ "text": "UiSchema"
1956
1941
  },
1957
- "default": "[]"
1942
+ "default": "editProfileFormSchema",
1943
+ "inheritedFrom": {
1944
+ "name": "EntityManagement",
1945
+ "module": "src/entities/entities.ts"
1946
+ }
1958
1947
  },
1959
1948
  {
1960
1949
  "kind": "field",
1961
- "name": "additionalUpdateFields",
1950
+ "name": "readEventFn",
1962
1951
  "type": {
1963
- "text": "AdditionalEntry[]"
1952
+ "text": "(...args) => {}"
1964
1953
  },
1965
- "default": "[]"
1954
+ "inheritedFrom": {
1955
+ "name": "EntityManagement",
1956
+ "module": "src/entities/entities.ts"
1957
+ }
1966
1958
  },
1967
1959
  {
1968
1960
  "kind": "field",
1969
- "name": "allAccessType",
1961
+ "name": "resourceName",
1970
1962
  "type": {
1971
- "text": "boolean"
1963
+ "text": "string"
1964
+ },
1965
+ "description": "Name of the backend resource which contain the entities to manage",
1966
+ "privacy": "public",
1967
+ "default": "'ALL_PROFILES'",
1968
+ "inheritedFrom": {
1969
+ "name": "EntityManagement",
1970
+ "module": "src/entities/entities.ts"
1972
1971
  }
1973
1972
  },
1974
1973
  {
1975
1974
  "kind": "field",
1976
- "name": "entityIdValue",
1975
+ "name": "title",
1977
1976
  "type": {
1978
1977
  "text": "string"
1979
1978
  },
1980
- "privacy": "private"
1979
+ "description": "Title of the grid",
1980
+ "privacy": "public",
1981
+ "default": "'Profile Management'",
1982
+ "inheritedFrom": {
1983
+ "name": "EntityManagement",
1984
+ "module": "src/entities/entities.ts"
1985
+ }
1981
1986
  },
1982
1987
  {
1983
1988
  "kind": "field",
1984
- "name": "createEvent",
1989
+ "name": "entityLabel",
1985
1990
  "type": {
1986
1991
  "text": "string"
1987
1992
  },
1988
- "description": "String which contains event if we have permission to insert user of empty string if not"
1993
+ "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
1994
+ "privacy": "public",
1995
+ "default": "'Profile'",
1996
+ "inheritedFrom": {
1997
+ "name": "EntityManagement",
1998
+ "module": "src/entities/entities.ts"
1999
+ }
1989
2000
  },
1990
2001
  {
1991
2002
  "kind": "field",
1992
- "name": "deleteEvent",
2003
+ "name": "connect",
1993
2004
  "type": {
1994
- "text": "string"
2005
+ "text": "Connect"
1995
2006
  },
1996
- "description": "String which contains event if we have permission to delete user of empty string if not"
2007
+ "privacy": "protected",
2008
+ "description": "DI connect object which is used to interact with the backend.",
2009
+ "inheritedFrom": {
2010
+ "name": "EntityManagement",
2011
+ "module": "src/entities/entities.ts"
2012
+ }
1997
2013
  },
1998
2014
  {
1999
2015
  "kind": "field",
2000
- "name": "updateEvent",
2016
+ "name": "prefix",
2001
2017
  "type": {
2002
2018
  "text": "string"
2003
2019
  },
2004
- "description": "String which contains event if we have permission to update user of empty string if not"
2005
- },
2006
- {
2007
- "kind": "method",
2008
- "name": "deepClone",
2009
- "return": {
2010
- "type": {
2011
- "text": "Node"
2012
- }
2020
+ "default": "'zero'",
2021
+ "description": "Name of the design system prefix that will be used in renderers.",
2022
+ "privacy": "public",
2023
+ "inheritedFrom": {
2024
+ "name": "EntityManagement",
2025
+ "module": "src/entities/entities.ts"
2013
2026
  }
2014
- }
2015
- ],
2016
- "attributes": [
2027
+ },
2017
2028
  {
2018
- "name": "design-system-prefix",
2029
+ "kind": "field",
2030
+ "name": "readEvent",
2019
2031
  "type": {
2020
2032
  "text": "string"
2021
2033
  },
2022
- "default": "'zero'",
2023
- "description": "Name of the design system prefix that will be used for components.",
2024
- "fieldName": "prefix"
2034
+ "inheritedFrom": {
2035
+ "name": "EntityManagement",
2036
+ "module": "src/entities/entities.ts"
2037
+ }
2025
2038
  },
2026
2039
  {
2027
- "name": "persist-column-state-key",
2040
+ "kind": "field",
2041
+ "name": "readonly",
2028
2042
  "type": {
2029
- "text": "string"
2043
+ "text": "boolean"
2030
2044
  },
2031
- "default": "'entity_users_management'",
2032
- "description": "This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.",
2033
- "fieldName": "persistColumnStateKey"
2045
+ "inheritedFrom": {
2046
+ "name": "EntityManagement",
2047
+ "module": "src/entities/entities.ts"
2048
+ }
2034
2049
  },
2035
2050
  {
2036
- "name": "enable-search-bar",
2051
+ "kind": "field",
2052
+ "name": "asyncAdd",
2037
2053
  "type": {
2038
2054
  "text": "boolean"
2039
2055
  },
2040
2056
  "default": "false",
2041
- "description": "This attribute controls whether to enable the search-bar.",
2042
- "fieldName": "enableSearchBar"
2043
- },
2044
- {
2045
- "name": "datasource-type",
2046
- "type": {
2047
- "text": "DatasourceType"
2048
- },
2049
- "default": "'client'",
2050
- "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
2051
- "fieldName": "datasourceType"
2052
- }
2053
- ],
2054
- "mixins": [
2055
- {
2056
- "name": "LifecycleMixin",
2057
- "package": "@genesislcap/foundation-utils"
2058
- }
2059
- ],
2060
- "superclass": {
2061
- "name": "FASTElement",
2062
- "package": "@microsoft/fast-element"
2063
- },
2064
- "deprecated": "- Use '\\@genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/\\@genesislcap/pbc-auth'",
2065
- "tagName": "user-management",
2066
- "customElement": true
2067
- }
2068
- ],
2069
- "exports": [
2070
- {
2071
- "kind": "js",
2072
- "name": "UsersColumnConfig",
2073
- "declaration": {
2074
- "name": "UsersColumnConfig",
2075
- "module": "src/users/users.ts"
2076
- }
2077
- },
2078
- {
2079
- "kind": "js",
2080
- "name": "Users",
2081
- "declaration": {
2082
- "name": "Users",
2083
- "module": "src/users/users.ts"
2084
- }
2085
- },
2086
- {
2087
- "kind": "custom-element-definition",
2088
- "name": "user-management",
2089
- "declaration": {
2090
- "name": "Users",
2091
- "module": "src/users/users.ts"
2092
- }
2093
- }
2094
- ]
2095
- },
2096
- {
2097
- "kind": "javascript-module",
2098
- "path": "src/utils/formatting.ts",
2099
- "declarations": [
2100
- {
2101
- "kind": "function",
2102
- "name": "getErrorFormat",
2103
- "parameters": [
2104
- {
2105
- "name": "err"
2106
- }
2107
- ],
2108
- "description": "Format the error as a string with a different format depending on whether\n`err` has a `FIELD` property or not",
2109
- "privacy": "public"
2110
- }
2111
- ],
2112
- "exports": [
2113
- {
2114
- "kind": "js",
2115
- "name": "getErrorFormat",
2116
- "declaration": {
2117
- "name": "getErrorFormat",
2118
- "module": "src/utils/formatting.ts"
2119
- }
2120
- }
2121
- ]
2122
- },
2123
- {
2124
- "kind": "javascript-module",
2125
- "path": "src/utils/index.ts",
2126
- "declarations": [],
2127
- "exports": [
2128
- {
2129
- "kind": "js",
2130
- "name": "*",
2131
- "declaration": {
2132
- "name": "*",
2133
- "package": "./formatting"
2134
- }
2135
- },
2136
- {
2137
- "kind": "js",
2138
- "name": "*",
2139
- "declaration": {
2140
- "name": "*",
2141
- "package": "./logger"
2142
- }
2143
- },
2144
- {
2145
- "kind": "js",
2146
- "name": "*",
2147
- "declaration": {
2148
- "name": "*",
2149
- "package": "./renderer"
2150
- }
2151
- }
2152
- ]
2153
- },
2154
- {
2155
- "kind": "javascript-module",
2156
- "path": "src/utils/logger.ts",
2157
- "declarations": [
2158
- {
2159
- "kind": "variable",
2160
- "name": "logger",
2161
- "privacy": "public"
2162
- }
2163
- ],
2164
- "exports": [
2165
- {
2166
- "kind": "js",
2167
- "name": "logger",
2168
- "declaration": {
2169
- "name": "logger",
2170
- "module": "src/utils/logger.ts"
2171
- }
2172
- }
2173
- ]
2174
- },
2175
- {
2176
- "kind": "javascript-module",
2177
- "path": "src/utils/renderer.ts",
2178
- "declarations": [
2179
- {
2180
- "kind": "function",
2181
- "name": "buttonCellRenderer",
2182
- "return": {
2183
- "type": {
2184
- "text": "ColDef"
2185
- }
2186
- },
2187
- "parameters": [
2188
- {
2189
- "name": "title"
2190
- },
2191
- {
2192
- "name": "clickHandler"
2193
- },
2194
- {
2195
- "name": "contentTemplate"
2196
- }
2197
- ],
2198
- "privacy": "public"
2199
- }
2200
- ],
2201
- "exports": [
2202
- {
2203
- "kind": "js",
2204
- "name": "buttonCellRenderer",
2205
- "declaration": {
2206
- "name": "buttonCellRenderer",
2207
- "module": "src/utils/renderer.ts"
2208
- }
2209
- }
2210
- ]
2211
- },
2212
- {
2213
- "kind": "javascript-module",
2214
- "path": "src/profiles/editProfileSchema.ts",
2215
- "declarations": [
2216
- {
2217
- "kind": "variable",
2218
- "name": "editProfileFormSchema",
2219
- "type": {
2220
- "text": "UiSchema"
2221
- },
2222
- "default": "{\n type: 'VerticalLayout',\n elements: [\n {\n type: 'Control',\n label: 'Name',\n scope: '#/properties/NAME',\n },\n {\n type: 'Control',\n label: 'Description',\n scope: '#/properties/DESCRIPTION',\n },\n {\n type: 'Control',\n label: 'Status',\n scope: '#/properties/STATUS',\n },\n {\n type: 'Control',\n label: 'Rights',\n scope: '#/properties/RIGHT_CODES',\n options: {\n allOptionsResourceName: 'RIGHT',\n valueField: 'CODE',\n labelField: 'CODE',\n },\n },\n {\n type: 'Control',\n label: 'Users',\n scope: '#/properties/USER_NAMES',\n options: {\n allOptionsResourceName: 'USER',\n valueField: 'USER_NAME',\n labelField: 'USER_NAME',\n },\n },\n ],\n}"
2223
- }
2224
- ],
2225
- "exports": [
2226
- {
2227
- "kind": "js",
2228
- "name": "editProfileFormSchema",
2229
- "declaration": {
2230
- "name": "editProfileFormSchema",
2231
- "module": "src/profiles/editProfileSchema.ts"
2232
- }
2233
- }
2234
- ]
2235
- },
2236
- {
2237
- "kind": "javascript-module",
2238
- "path": "src/profiles/profiles.ts",
2239
- "declarations": [
2240
- {
2241
- "kind": "class",
2242
- "description": "Main class which defined the profile management functionality",
2243
- "name": "Profiles",
2244
- "members": [
2245
- {
2246
- "kind": "method",
2247
- "name": "readProfileData",
2057
+ "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
2248
2058
  "privacy": "public",
2249
- "parameters": [
2250
- {
2251
- "name": "profile"
2252
- }
2253
- ]
2254
- },
2255
- {
2256
- "kind": "method",
2257
- "name": "confirmDelete",
2258
2059
  "inheritedFrom": {
2259
2060
  "name": "EntityManagement",
2260
2061
  "module": "src/entities/entities.ts"
@@ -2262,11 +2063,12 @@
2262
2063
  },
2263
2064
  {
2264
2065
  "kind": "field",
2265
- "name": "createEvent",
2066
+ "name": "asyncRemove",
2266
2067
  "type": {
2267
- "text": "string"
2068
+ "text": "boolean"
2268
2069
  },
2269
- "description": "Name of the event handler on the Genesis server which handles creating an entity",
2070
+ "default": "false",
2071
+ "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
2270
2072
  "privacy": "public",
2271
2073
  "inheritedFrom": {
2272
2074
  "name": "EntityManagement",
@@ -2275,11 +2077,12 @@
2275
2077
  },
2276
2078
  {
2277
2079
  "kind": "field",
2278
- "name": "deleteEvent",
2080
+ "name": "asyncUpdate",
2279
2081
  "type": {
2280
- "text": "string"
2082
+ "text": "boolean"
2281
2083
  },
2282
- "description": "Name of the event handler on the Genesis server which handles deleting the entity",
2084
+ "default": "true",
2085
+ "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
2283
2086
  "privacy": "public",
2284
2087
  "inheritedFrom": {
2285
2088
  "name": "EntityManagement",
@@ -2288,11 +2091,12 @@
2288
2091
  },
2289
2092
  {
2290
2093
  "kind": "field",
2291
- "name": "updateEvent",
2094
+ "name": "rowSelection",
2292
2095
  "type": {
2293
2096
  "text": "string"
2294
2097
  },
2295
- "description": "Name of the event handler on the Genesis server which handles updating the entity",
2098
+ "default": "'single'",
2099
+ "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.",
2296
2100
  "privacy": "public",
2297
2101
  "inheritedFrom": {
2298
2102
  "name": "EntityManagement",
@@ -2301,13 +2105,13 @@
2301
2105
  },
2302
2106
  {
2303
2107
  "kind": "field",
2304
- "name": "persistColumnStateKey",
2108
+ "name": "enableCellFlashing",
2305
2109
  "type": {
2306
- "text": "string"
2110
+ "text": "boolean"
2307
2111
  },
2308
- "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.",
2112
+ "default": "false",
2113
+ "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
2309
2114
  "privacy": "public",
2310
- "default": "'entity_profiles_management'",
2311
2115
  "inheritedFrom": {
2312
2116
  "name": "EntityManagement",
2313
2117
  "module": "src/entities/entities.ts"
@@ -2315,11 +2119,13 @@
2315
2119
  },
2316
2120
  {
2317
2121
  "kind": "field",
2318
- "name": "updateFormUiSchema",
2122
+ "name": "enableRowFlashing",
2319
2123
  "type": {
2320
- "text": "UiSchema"
2124
+ "text": "boolean"
2321
2125
  },
2322
- "default": "editProfileFormSchema",
2126
+ "default": "false",
2127
+ "description": "If true, will enable row flashing for all rows for `add` transactions",
2128
+ "privacy": "public",
2323
2129
  "inheritedFrom": {
2324
2130
  "name": "EntityManagement",
2325
2131
  "module": "src/entities/entities.ts"
@@ -2327,207 +2133,9 @@
2327
2133
  },
2328
2134
  {
2329
2135
  "kind": "field",
2330
- "name": "createFormUiSchema",
2136
+ "name": "datasourceType",
2331
2137
  "type": {
2332
- "text": "UiSchema"
2333
- },
2334
- "default": "editProfileFormSchema",
2335
- "inheritedFrom": {
2336
- "name": "EntityManagement",
2337
- "module": "src/entities/entities.ts"
2338
- }
2339
- },
2340
- {
2341
- "kind": "field",
2342
- "name": "readEventFn",
2343
- "type": {
2344
- "text": "(...args) => {}"
2345
- },
2346
- "inheritedFrom": {
2347
- "name": "EntityManagement",
2348
- "module": "src/entities/entities.ts"
2349
- }
2350
- },
2351
- {
2352
- "kind": "field",
2353
- "name": "resourceName",
2354
- "type": {
2355
- "text": "string"
2356
- },
2357
- "description": "Name of the backend resource which contain the entities to manage",
2358
- "privacy": "public",
2359
- "default": "'ALL_PROFILES'",
2360
- "inheritedFrom": {
2361
- "name": "EntityManagement",
2362
- "module": "src/entities/entities.ts"
2363
- }
2364
- },
2365
- {
2366
- "kind": "field",
2367
- "name": "title",
2368
- "type": {
2369
- "text": "string"
2370
- },
2371
- "description": "Title of the grid",
2372
- "privacy": "public",
2373
- "default": "'Profile Management'",
2374
- "inheritedFrom": {
2375
- "name": "EntityManagement",
2376
- "module": "src/entities/entities.ts"
2377
- }
2378
- },
2379
- {
2380
- "kind": "field",
2381
- "name": "entityLabel",
2382
- "type": {
2383
- "text": "string"
2384
- },
2385
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
2386
- "privacy": "public",
2387
- "default": "'Profile'",
2388
- "inheritedFrom": {
2389
- "name": "EntityManagement",
2390
- "module": "src/entities/entities.ts"
2391
- }
2392
- },
2393
- {
2394
- "kind": "field",
2395
- "name": "connect",
2396
- "type": {
2397
- "text": "Connect"
2398
- },
2399
- "privacy": "protected",
2400
- "description": "DI connect object which is used to interact with the backend.",
2401
- "inheritedFrom": {
2402
- "name": "EntityManagement",
2403
- "module": "src/entities/entities.ts"
2404
- }
2405
- },
2406
- {
2407
- "kind": "field",
2408
- "name": "prefix",
2409
- "type": {
2410
- "text": "string"
2411
- },
2412
- "default": "'zero'",
2413
- "description": "Name of the design system prefix that will be used in renderers.",
2414
- "privacy": "public",
2415
- "inheritedFrom": {
2416
- "name": "EntityManagement",
2417
- "module": "src/entities/entities.ts"
2418
- }
2419
- },
2420
- {
2421
- "kind": "field",
2422
- "name": "readEvent",
2423
- "type": {
2424
- "text": "string"
2425
- },
2426
- "inheritedFrom": {
2427
- "name": "EntityManagement",
2428
- "module": "src/entities/entities.ts"
2429
- }
2430
- },
2431
- {
2432
- "kind": "field",
2433
- "name": "readonly",
2434
- "type": {
2435
- "text": "boolean"
2436
- },
2437
- "inheritedFrom": {
2438
- "name": "EntityManagement",
2439
- "module": "src/entities/entities.ts"
2440
- }
2441
- },
2442
- {
2443
- "kind": "field",
2444
- "name": "asyncAdd",
2445
- "type": {
2446
- "text": "boolean"
2447
- },
2448
- "default": "false",
2449
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
2450
- "privacy": "public",
2451
- "inheritedFrom": {
2452
- "name": "EntityManagement",
2453
- "module": "src/entities/entities.ts"
2454
- }
2455
- },
2456
- {
2457
- "kind": "field",
2458
- "name": "asyncRemove",
2459
- "type": {
2460
- "text": "boolean"
2461
- },
2462
- "default": "false",
2463
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
2464
- "privacy": "public",
2465
- "inheritedFrom": {
2466
- "name": "EntityManagement",
2467
- "module": "src/entities/entities.ts"
2468
- }
2469
- },
2470
- {
2471
- "kind": "field",
2472
- "name": "asyncUpdate",
2473
- "type": {
2474
- "text": "boolean"
2475
- },
2476
- "default": "true",
2477
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
2478
- "privacy": "public",
2479
- "inheritedFrom": {
2480
- "name": "EntityManagement",
2481
- "module": "src/entities/entities.ts"
2482
- }
2483
- },
2484
- {
2485
- "kind": "field",
2486
- "name": "rowSelection",
2487
- "type": {
2488
- "text": "string"
2489
- },
2490
- "default": "'single'",
2491
- "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.",
2492
- "privacy": "public",
2493
- "inheritedFrom": {
2494
- "name": "EntityManagement",
2495
- "module": "src/entities/entities.ts"
2496
- }
2497
- },
2498
- {
2499
- "kind": "field",
2500
- "name": "enableCellFlashing",
2501
- "type": {
2502
- "text": "boolean"
2503
- },
2504
- "default": "false",
2505
- "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
2506
- "privacy": "public",
2507
- "inheritedFrom": {
2508
- "name": "EntityManagement",
2509
- "module": "src/entities/entities.ts"
2510
- }
2511
- },
2512
- {
2513
- "kind": "field",
2514
- "name": "enableRowFlashing",
2515
- "type": {
2516
- "text": "boolean"
2517
- },
2518
- "default": "false",
2519
- "description": "If true, will enable row flashing for all rows for `add` transactions",
2520
- "privacy": "public",
2521
- "inheritedFrom": {
2522
- "name": "EntityManagement",
2523
- "module": "src/entities/entities.ts"
2524
- }
2525
- },
2526
- {
2527
- "kind": "field",
2528
- "name": "datasourceType",
2529
- "type": {
2530
- "text": "DatasourceType"
2138
+ "text": "DatasourceType"
2531
2139
  },
2532
2140
  "default": "'client'",
2533
2141
  "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
@@ -3522,6 +3130,452 @@
3522
3130
  }
3523
3131
  ]
3524
3132
  },
3133
+ {
3134
+ "kind": "javascript-module",
3135
+ "path": "src/routes/config.ts",
3136
+ "declarations": [],
3137
+ "exports": []
3138
+ },
3139
+ {
3140
+ "kind": "javascript-module",
3141
+ "path": "src/routes/index.ts",
3142
+ "declarations": [],
3143
+ "exports": [
3144
+ {
3145
+ "kind": "js",
3146
+ "name": "*",
3147
+ "declaration": {
3148
+ "name": "*",
3149
+ "package": "./config"
3150
+ }
3151
+ }
3152
+ ]
3153
+ },
3154
+ {
3155
+ "kind": "javascript-module",
3156
+ "path": "src/users/users.template.ts",
3157
+ "declarations": [
3158
+ {
3159
+ "kind": "function",
3160
+ "name": "getPrefixedUsers",
3161
+ "parameters": [
3162
+ {
3163
+ "name": "prefix"
3164
+ }
3165
+ ]
3166
+ }
3167
+ ],
3168
+ "exports": [
3169
+ {
3170
+ "kind": "js",
3171
+ "name": "getPrefixedUsers",
3172
+ "declaration": {
3173
+ "name": "getPrefixedUsers",
3174
+ "module": "src/users/users.template.ts"
3175
+ }
3176
+ }
3177
+ ]
3178
+ },
3179
+ {
3180
+ "kind": "javascript-module",
3181
+ "path": "src/users/users.ts",
3182
+ "declarations": [
3183
+ {
3184
+ "kind": "variable",
3185
+ "name": "UsersColumnConfig",
3186
+ "type": {
3187
+ "text": "array"
3188
+ },
3189
+ "default": "[\n {\n ...defaultColumnConfig,\n field: 'USER_NAME',\n headerName: 'Username',\n },\n {\n ...defaultColumnConfig,\n field: 'FIRST_NAME',\n headerName: 'First Name',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_NAME',\n headerName: 'Last Name',\n },\n {\n ...defaultColumnConfig,\n field: 'EMAIL_ADDRESS',\n headerName: 'Email',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_LOGIN',\n headerName: 'Last Login',\n valueFormatter: ({ value }) =>\n value\n ? new Intl.DateTimeFormat('default', {\n year: 'numeric',\n month: 'numeric',\n day: 'numeric',\n hour: 'numeric',\n minute: 'numeric',\n }).format(value)\n : '',\n },\n]",
3190
+ "description": "Defines the default columns which are present on the user management component",
3191
+ "privacy": "public"
3192
+ },
3193
+ {
3194
+ "kind": "class",
3195
+ "description": "Main class which defines the user management functionality",
3196
+ "name": "Users",
3197
+ "members": [
3198
+ {
3199
+ "kind": "field",
3200
+ "name": "prefix",
3201
+ "type": {
3202
+ "text": "string"
3203
+ },
3204
+ "default": "'zero'",
3205
+ "description": "Name of the design system prefix that will be used for components.",
3206
+ "privacy": "public"
3207
+ },
3208
+ {
3209
+ "kind": "field",
3210
+ "name": "persistColumnStateKey",
3211
+ "type": {
3212
+ "text": "string"
3213
+ },
3214
+ "default": "'entity_users_management'",
3215
+ "description": "This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.",
3216
+ "privacy": "public"
3217
+ },
3218
+ {
3219
+ "kind": "field",
3220
+ "name": "enableSearchBar",
3221
+ "type": {
3222
+ "text": "boolean"
3223
+ },
3224
+ "default": "false",
3225
+ "description": "This attribute controls whether to enable the search-bar.",
3226
+ "privacy": "public"
3227
+ },
3228
+ {
3229
+ "kind": "field",
3230
+ "name": "datasourceType",
3231
+ "type": {
3232
+ "text": "DatasourceType"
3233
+ },
3234
+ "default": "'client'",
3235
+ "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
3236
+ "privacy": "public"
3237
+ },
3238
+ {
3239
+ "kind": "field",
3240
+ "name": "isServerSideDatasource",
3241
+ "type": {
3242
+ "text": "boolean"
3243
+ },
3244
+ "readonly": true
3245
+ },
3246
+ {
3247
+ "kind": "field",
3248
+ "name": "gridOptions",
3249
+ "type": {
3250
+ "text": "GridOptions"
3251
+ },
3252
+ "description": "GridOptions to be passed down from application",
3253
+ "privacy": "public"
3254
+ },
3255
+ {
3256
+ "kind": "field",
3257
+ "name": "columns",
3258
+ "type": {
3259
+ "text": "(ColDef<any> | ColGroupDef<any>)[]"
3260
+ },
3261
+ "default": "[\n {\n ...defaultColumnConfig,\n field: 'USER_NAME',\n headerName: 'Username',\n },\n {\n ...defaultColumnConfig,\n field: 'FIRST_NAME',\n headerName: 'First Name',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_NAME',\n headerName: 'Last Name',\n },\n {\n ...defaultColumnConfig,\n field: 'EMAIL_ADDRESS',\n headerName: 'Email',\n },\n {\n ...defaultColumnConfig,\n field: 'LAST_LOGIN',\n headerName: 'Last Login',\n valueFormatter: ({ value }) =>\n value\n ? new Intl.DateTimeFormat('default', {\n year: 'numeric',\n month: 'numeric',\n day: 'numeric',\n hour: 'numeric',\n minute: 'numeric',\n }).format(value)\n : '',\n },\n]",
3262
+ "description": "Column definition, default to the UsersColumnConfig"
3263
+ },
3264
+ {
3265
+ "kind": "field",
3266
+ "name": "additionalCreateFields",
3267
+ "type": {
3268
+ "text": "AdditionalEntry[]"
3269
+ },
3270
+ "default": "[]"
3271
+ },
3272
+ {
3273
+ "kind": "field",
3274
+ "name": "additionalUpdateFields",
3275
+ "type": {
3276
+ "text": "AdditionalEntry[]"
3277
+ },
3278
+ "default": "[]"
3279
+ },
3280
+ {
3281
+ "kind": "field",
3282
+ "name": "allAccessType",
3283
+ "type": {
3284
+ "text": "boolean"
3285
+ }
3286
+ },
3287
+ {
3288
+ "kind": "field",
3289
+ "name": "entityIdValue",
3290
+ "type": {
3291
+ "text": "string"
3292
+ },
3293
+ "privacy": "private"
3294
+ },
3295
+ {
3296
+ "kind": "field",
3297
+ "name": "createEvent",
3298
+ "type": {
3299
+ "text": "string"
3300
+ },
3301
+ "description": "String which contains event if we have permission to insert user of empty string if not"
3302
+ },
3303
+ {
3304
+ "kind": "field",
3305
+ "name": "deleteEvent",
3306
+ "type": {
3307
+ "text": "string"
3308
+ },
3309
+ "description": "String which contains event if we have permission to delete user of empty string if not"
3310
+ },
3311
+ {
3312
+ "kind": "field",
3313
+ "name": "updateEvent",
3314
+ "type": {
3315
+ "text": "string"
3316
+ },
3317
+ "description": "String which contains event if we have permission to update user of empty string if not"
3318
+ },
3319
+ {
3320
+ "kind": "method",
3321
+ "name": "deepClone",
3322
+ "return": {
3323
+ "type": {
3324
+ "text": "Node"
3325
+ }
3326
+ }
3327
+ }
3328
+ ],
3329
+ "attributes": [
3330
+ {
3331
+ "name": "design-system-prefix",
3332
+ "type": {
3333
+ "text": "string"
3334
+ },
3335
+ "default": "'zero'",
3336
+ "description": "Name of the design system prefix that will be used for components.",
3337
+ "fieldName": "prefix"
3338
+ },
3339
+ {
3340
+ "name": "persist-column-state-key",
3341
+ "type": {
3342
+ "text": "string"
3343
+ },
3344
+ "default": "'entity_users_management'",
3345
+ "description": "This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.",
3346
+ "fieldName": "persistColumnStateKey"
3347
+ },
3348
+ {
3349
+ "name": "enable-search-bar",
3350
+ "type": {
3351
+ "text": "boolean"
3352
+ },
3353
+ "default": "false",
3354
+ "description": "This attribute controls whether to enable the search-bar.",
3355
+ "fieldName": "enableSearchBar"
3356
+ },
3357
+ {
3358
+ "name": "datasource-type",
3359
+ "type": {
3360
+ "text": "DatasourceType"
3361
+ },
3362
+ "default": "'client'",
3363
+ "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
3364
+ "fieldName": "datasourceType"
3365
+ }
3366
+ ],
3367
+ "mixins": [
3368
+ {
3369
+ "name": "LifecycleMixin",
3370
+ "package": "@genesislcap/foundation-utils"
3371
+ }
3372
+ ],
3373
+ "superclass": {
3374
+ "name": "FASTElement",
3375
+ "package": "@microsoft/fast-element"
3376
+ },
3377
+ "deprecated": "- Use '\\@genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/\\@genesislcap/pbc-auth'",
3378
+ "tagName": "user-management",
3379
+ "customElement": true
3380
+ }
3381
+ ],
3382
+ "exports": [
3383
+ {
3384
+ "kind": "js",
3385
+ "name": "UsersColumnConfig",
3386
+ "declaration": {
3387
+ "name": "UsersColumnConfig",
3388
+ "module": "src/users/users.ts"
3389
+ }
3390
+ },
3391
+ {
3392
+ "kind": "js",
3393
+ "name": "Users",
3394
+ "declaration": {
3395
+ "name": "Users",
3396
+ "module": "src/users/users.ts"
3397
+ }
3398
+ },
3399
+ {
3400
+ "kind": "custom-element-definition",
3401
+ "name": "user-management",
3402
+ "declaration": {
3403
+ "name": "Users",
3404
+ "module": "src/users/users.ts"
3405
+ }
3406
+ }
3407
+ ]
3408
+ },
3409
+ {
3410
+ "kind": "javascript-module",
3411
+ "path": "src/utils/formatting.ts",
3412
+ "declarations": [
3413
+ {
3414
+ "kind": "function",
3415
+ "name": "getErrorFormat",
3416
+ "parameters": [
3417
+ {
3418
+ "name": "err"
3419
+ }
3420
+ ],
3421
+ "description": "Format the error as a string with a different format depending on whether\n`err` has a `FIELD` property or not",
3422
+ "privacy": "public"
3423
+ }
3424
+ ],
3425
+ "exports": [
3426
+ {
3427
+ "kind": "js",
3428
+ "name": "getErrorFormat",
3429
+ "declaration": {
3430
+ "name": "getErrorFormat",
3431
+ "module": "src/utils/formatting.ts"
3432
+ }
3433
+ }
3434
+ ]
3435
+ },
3436
+ {
3437
+ "kind": "javascript-module",
3438
+ "path": "src/utils/index.ts",
3439
+ "declarations": [],
3440
+ "exports": [
3441
+ {
3442
+ "kind": "js",
3443
+ "name": "*",
3444
+ "declaration": {
3445
+ "name": "*",
3446
+ "package": "./formatting"
3447
+ }
3448
+ },
3449
+ {
3450
+ "kind": "js",
3451
+ "name": "*",
3452
+ "declaration": {
3453
+ "name": "*",
3454
+ "package": "./logger"
3455
+ }
3456
+ },
3457
+ {
3458
+ "kind": "js",
3459
+ "name": "*",
3460
+ "declaration": {
3461
+ "name": "*",
3462
+ "package": "./renderer"
3463
+ }
3464
+ }
3465
+ ]
3466
+ },
3467
+ {
3468
+ "kind": "javascript-module",
3469
+ "path": "src/utils/logger.ts",
3470
+ "declarations": [
3471
+ {
3472
+ "kind": "variable",
3473
+ "name": "logger",
3474
+ "privacy": "public"
3475
+ }
3476
+ ],
3477
+ "exports": [
3478
+ {
3479
+ "kind": "js",
3480
+ "name": "logger",
3481
+ "declaration": {
3482
+ "name": "logger",
3483
+ "module": "src/utils/logger.ts"
3484
+ }
3485
+ }
3486
+ ]
3487
+ },
3488
+ {
3489
+ "kind": "javascript-module",
3490
+ "path": "src/utils/renderer.ts",
3491
+ "declarations": [
3492
+ {
3493
+ "kind": "function",
3494
+ "name": "buttonCellRenderer",
3495
+ "return": {
3496
+ "type": {
3497
+ "text": "ColDef"
3498
+ }
3499
+ },
3500
+ "parameters": [
3501
+ {
3502
+ "name": "title"
3503
+ },
3504
+ {
3505
+ "name": "clickHandler"
3506
+ },
3507
+ {
3508
+ "name": "contentTemplate"
3509
+ }
3510
+ ],
3511
+ "privacy": "public"
3512
+ }
3513
+ ],
3514
+ "exports": [
3515
+ {
3516
+ "kind": "js",
3517
+ "name": "buttonCellRenderer",
3518
+ "declaration": {
3519
+ "name": "buttonCellRenderer",
3520
+ "module": "src/utils/renderer.ts"
3521
+ }
3522
+ }
3523
+ ]
3524
+ },
3525
+ {
3526
+ "kind": "javascript-module",
3527
+ "path": "src/utils/search-bar-utils.ts",
3528
+ "declarations": [
3529
+ {
3530
+ "kind": "function",
3531
+ "name": "getSearchBarColumnsConfig",
3532
+ "parameters": [
3533
+ {
3534
+ "name": "columns",
3535
+ "type": {
3536
+ "text": "ColDef[]"
3537
+ }
3538
+ },
3539
+ {
3540
+ "name": "meta",
3541
+ "type": {
3542
+ "text": "Metadata"
3543
+ }
3544
+ }
3545
+ ]
3546
+ },
3547
+ {
3548
+ "kind": "function",
3549
+ "name": "getSearchBarMetaConfig",
3550
+ "parameters": [
3551
+ {
3552
+ "name": "meta",
3553
+ "type": {
3554
+ "text": "Metadata"
3555
+ }
3556
+ }
3557
+ ]
3558
+ }
3559
+ ],
3560
+ "exports": [
3561
+ {
3562
+ "kind": "js",
3563
+ "name": "getSearchBarColumnsConfig",
3564
+ "declaration": {
3565
+ "name": "getSearchBarColumnsConfig",
3566
+ "module": "src/utils/search-bar-utils.ts"
3567
+ }
3568
+ },
3569
+ {
3570
+ "kind": "js",
3571
+ "name": "getSearchBarMetaConfig",
3572
+ "declaration": {
3573
+ "name": "getSearchBarMetaConfig",
3574
+ "module": "src/utils/search-bar-utils.ts"
3575
+ }
3576
+ }
3577
+ ]
3578
+ },
3525
3579
  {
3526
3580
  "kind": "javascript-module",
3527
3581
  "path": "src/routes/demo/entity-management.template.ts",