Merge pull request #292 from gnosisguild/sdk-process-annotations

sdk: add processAnnotations function

packages/app/app/chains.ts

@@ -8,7 +8,7 @@ import {
   // bsc,
   polygon,
   gnosis,
-} from "@wagmi/core/chains" // cannot import from wagmi/chains because that one declares "use client;"
+} from "wagmi/chains"
 
 export const CHAINS = {
   [mainnet.id]: {

packages/app/components/permissions/PermissionsDiff/diff.test.ts

@@ -1,4 +1,5 @@
-import { DiffFlag, Preset } from "../types"
+import { Preset } from "zodiac-roles-sdk/annotations"
+import { DiffFlag } from "../types"
 import { diffPermissions, diffPresets } from "./diff"
 
 describe("diff", () => {
@@ -193,9 +194,9 @@ const PRESET: Preset = {
     title: "DeFi Kit",
     version: "1.0.0",
   },
-  pathKey: "/permissions/gor/cowswap/swap",
-  pathParams: {},
-  queryParams: {
+  path: "/permissions/gor/cowswap/swap",
+  params: {},
+  query: {
     sell: [
       "0x6B175474E89094C44Da98b954EedeAC495271d0F",
       "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",

packages/app/components/permissions/PermissionsDiff/diff.ts

@@ -1,5 +1,6 @@
 import { PermissionCoerced, targetId, permissionId } from "zodiac-roles-sdk"
-import { DiffFlag, PermissionsDiff, Preset } from "../types"
+import { Preset } from "zodiac-roles-sdk/annotations"
+import { DiffFlag, PermissionsDiff } from "../types"
 import { comparePermissionIds } from "../groupPermissions"
 
 export const diffPermissions = (
@@ -161,15 +162,15 @@ export const diffPresets = (
 
   // 2) new path key in right: Hidden / Added
   rightSorted.forEach((r) => {
-    if (!leftSorted.some((l) => l.pathKey === r.pathKey)) {
+    if (!leftSorted.some((l) => l.path === r.path)) {
       diffLeft.set(r, { flag: DiffFlag.Hidden })
       diffRight.set(r, { flag: DiffFlag.Added })
     }
   })
 
   // 3) missing path key in right: Removed / Hidden
   leftSorted.forEach((l) => {
-    if (!rightSorted.some((r) => r.pathKey === l.pathKey)) {
+    if (!rightSorted.some((r) => r.path === l.path)) {
       diffLeft.set(l, { flag: DiffFlag.Removed })
       diffRight.set(l, { flag: DiffFlag.Hidden })
     }
@@ -182,7 +183,7 @@ export const diffPresets = (
     if (diffLeft.has(l)) return
 
     const r = rightSorted.find(
-      (r) => !diffRight.has(r) && r.pathKey === l.pathKey && r.uri !== l.uri
+      (r) => !diffRight.has(r) && r.path === l.path && r.uri !== l.uri
     )
 
     if (r) {
@@ -213,7 +214,7 @@ export const diffPresets = (
     if (diffRight.has(r)) return
 
     const l = leftSorted.find(
-      (l) => !diffLeft.has(l) && l.pathKey === r.pathKey && l.uri !== r.uri
+      (l) => !diffLeft.has(l) && l.path === r.path && l.uri !== r.uri
     )
 
     if (l) {

packages/app/components/permissions/PermissionsDiff/index.tsx

@@ -3,7 +3,7 @@ import cn from "classnames"
 import { ChainId } from "@/app/chains"
 import Flex from "@/ui/Flex"
 import Box from "@/ui/Box"
-import { processAnnotations } from "../annotations"
+import { processAnnotations } from "../processAnnotations"
 import { diffPermissions, diffPresets } from "./diff"
 import { PresetsAndPermissionsView } from "../PermissionsList"
 import classes from "./style.module.css"

packages/app/components/permissions/PermissionsList/index.tsx

@@ -4,13 +4,14 @@ import {
   Target,
   reconstructPermissions,
 } from "zodiac-roles-sdk"
+import { Preset } from "zodiac-roles-sdk/annotations"
 import { ChainId } from "@/app/chains"
 import Flex from "@/ui/Flex"
 import PresetItem from "../PresetItem"
 import TargetItem from "../TargetItem"
-import { processAnnotations } from "../annotations"
+import { processAnnotations } from "../processAnnotations"
 import { groupPermissions } from "../groupPermissions"
-import { PermissionsDiff, Preset, PresetsDiff } from "../types"
+import { PermissionsDiff, PresetsDiff } from "../types"
 
 interface Props {
   targets: Target[]

packages/app/components/permissions/PresetItem/Parameter.tsx

@@ -1,19 +1,17 @@
+import { Preset } from "zodiac-roles-sdk/annotations"
 import Flex from "@/ui/Flex"
-import { OpenAPIParameter, Preset } from "../types"
 import classes from "./style.module.css"
 import LabeledData from "@/ui/LabeledData"
 
 const Parameter: React.FC<{
-  parameter: OpenAPIParameter
-  queryParams: Preset["queryParams"]
-  pathParams: Preset["pathParams"]
-}> = ({ parameter, queryParams, pathParams }) => {
+  parameter: Preset["operation"]["parameters"][number]
+  params: Preset["params"]
+  query: Preset["query"]
+}> = ({ parameter, params, query }) => {
   // we only support path and query parameters
   if (parameter.in !== "path" && parameter.in !== "query") return null
   const value = (
-    parameter.in === "path"
-      ? pathParams[parameter.name]
-      : queryParams[parameter.name]
+    parameter.in === "path" ? params[parameter.name] : query[parameter.name]
   ) as string | number | string[] | number[] | undefined
 
   return (

packages/app/components/permissions/PresetItem/PresetInfo.tsx

@@ -1,5 +1,5 @@
+import { Preset } from "zodiac-roles-sdk/annotations"
 import Flex from "@/ui/Flex"
-import { Preset } from "../types"
 import classes from "./style.module.css"
 import Anchor from "@/ui/Anchor"
 

packages/app/components/permissions/PresetItem/index.tsx

@@ -1,4 +1,5 @@
-import { Preset, PresetsDiff } from "../types"
+import { Preset } from "zodiac-roles-sdk/annotations"
+import { PresetsDiff } from "../types"
 import IndividualPermissions from "./IndividualPermissions"
 import PresetInfo from "./PresetInfo"
 import Parameter from "./Parameter"
@@ -46,8 +47,8 @@ const PresetItemMain: React.FC<Props> = ({ preset, chainId, diff }) => {
             <Parameter
               key={parameter.name}
               parameter={parameter}
-              pathParams={preset.pathParams}
-              queryParams={preset.queryParams}
+              params={preset.params}
+              query={preset.query}
             />
           ))}
         </Flex>