Add types for safe apps access control property and clientUrl param to the query (#51)

* add types for safe apps access control and client url to the query

* add an enum for safe app access policies

* remove dump file, update package json

* package.json update

* export enum with policy types

Author: mmv08

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnosis.pm/safe-react-gateway-sdk",
-  "version": "2.7.5",
+  "version": "2.8.0",
   "main": "dist/index.min.js",
   "types": "dist/index.d.ts",
   "files": [

src/index.ts

@@ -168,9 +168,14 @@ export function getChainConfig(baseUrl: string, chainId: string): Promise<ChainI
 /**
  * Returns Safe Apps List
  */
-export function getSafeApps(baseUrl: string, chainId: string): Promise<SafeAppsResponse> {
+export function getSafeApps(
+  baseUrl: string,
+  chainId: string,
+  query: operations['safe_apps_read']['parameters']['query'] = {},
+): Promise<SafeAppsResponse> {
   return callEndpoint(baseUrl, '/v1/chains/{chainId}/safe-apps', {
     path: { chainId: chainId },
+    query,
   })
 }
 

src/types/api.ts

@@ -357,6 +357,9 @@ export interface operations {
         /** A unique value identifying this chain. */
         chainId: string
       }
+      query?: {
+        clientUrl?: string
+      }
     }
     responses: {
       200: {

src/types/safe-apps.ts

@@ -1,3 +1,19 @@
+export enum SafeAppAccessPolicyTypes {
+  NoRestrictions = 'NO_RESTRICTIONS',
+  DomainAllowlist = 'DOMAIN_ALLOWLIST',
+}
+
+export type SafeAppNoRestrictionsPolicy = {
+  type: SafeAppAccessPolicyTypes.NoRestrictions
+}
+
+export type SafeAppDomainAllowlistPolicy = {
+  type: SafeAppAccessPolicyTypes.DomainAllowlist
+  value: string[]
+}
+
+export type SafeAppsAccessControlPolicies = SafeAppNoRestrictionsPolicy | SafeAppDomainAllowlistPolicy
+
 export type SafeAppProvider = {
   url: string
   name: string
@@ -11,6 +27,7 @@ export type SafeAppData = {
   description: string
   chainIds: string[]
   provider?: SafeAppProvider
+  accessControl: SafeAppsAccessControlPolicies
 }
 
 export type SafeAppsResponse = [SafeAppData]