Renamed App and Repo

docs/api-reference/organization.md

@@ -27,7 +27,7 @@ Install a new app into the organization from a given [aragonPM repository](https
 
 | Name                      | Type                         | Description                                                                                                   |
 | :------------------------ | :--------------------------- | :------------------------------------------------------------------------------------------------------------ |
-| `repoName`                | `String`                     | Repository name \(e.g. `voting.aragonpm.eth`\).                                                               |
+| `repoName`                | `String`                     | Name of the repo \(e.g. `voting.aragonpm.eth`\).                                                               |
 | `options`                 | `Object`                     | Options object.                                                                                               |
 | `options.initFuncName`    | `String`                     | Name of the function that gets called to initialize the app. Set to `none` to skip. Defaults to `initialize`. |
 | `options.initFuncArgs`    | `Array<String>`              | Arguments passed to the function set as `options.initFuncName`. Defaults to `[]`.                             |

examples/nodejs/src/organization.ts

@@ -1,4 +1,4 @@
-import { connect, Application, Organization } from '@aragon/connect'
+import { connect, App, Organization } from '@aragon/connect'
 
 const ORG_ADDRESS = '0x0c188b183ff758500d1d18b432313d10e9f6b8a4'
 
@@ -18,9 +18,7 @@ async function main() {
   apps.map(console.log)
 
   console.log('\nA voting app:')
-  const votingApp = apps.find(
-    (app: Application) => app.name == 'dandelion-voting'
-  )!
+  const votingApp = apps.find((app: App) => app.name == 'dandelion-voting')!
   console.log(votingApp)
 
   console.log('\nRoles of an app:')

examples/nodejs/src/transaction-path.ts

@@ -1,5 +1,5 @@
 import { ethers } from 'ethers'
-import { connect, Application, Organization } from '@aragon/connect'
+import { connect, App, Organization } from '@aragon/connect'
 
 const network = 'mainnet'
 
@@ -14,7 +14,7 @@ async function main() {
   })) as Organization
 
   const apps = await org.apps()
-  const finance = apps.find((app: Application) => app.name == 'finance')!
+  const finance = apps.find((app: App) => app.name == 'finance')!
 
   const intent = org.appIntent(finance.address, 'newImmediatePayment', [
     ethers.constants.AddressZero,
@@ -27,7 +27,7 @@ async function main() {
 
   console.log('\nTransactions on the path:')
   txPath.transactions.map((tx: any) => console.log(tx))
-  txPath.transactionsDescribed.map((tx: any) => console.log(tx))
+  // txPath.transactionsDescribed.map((tx: any) => console.log(tx))
 }
 
 main()

examples/org-viewer-web/src/OrgApps.tsx

@@ -1,6 +1,6 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/core'
-import { Application, Organization } from '@aragon/connect'
+import { App, Organization } from '@aragon/connect'
 import Group from './Group'
 import Table from './Table'
 import TextButton from './TextButton'
@@ -12,7 +12,7 @@ type Props = {
 }
 
 export default function OrgApps({ onOpenApp, org }: Props) {
-  const [apps = [], loading] = useCancellableAsync<Application[]>(
+  const [apps = [], loading] = useCancellableAsync<App[]>(
     async () => (org ? org.apps() : []),
     [org]
   )
@@ -23,7 +23,7 @@ export default function OrgApps({ onOpenApp, org }: Props) {
         headers={['Name', 'Version', 'Address']}
         rows={[...apps]
           .sort((a, b) => (a.name || '').localeCompare(b.name || ''))
-          .map((app: Application) => [
+          .map((app: App) => [
             app.name || 'unknown',
             app.version || '?',
             <TextButton onClick={() => onOpenApp(app.address)}>

packages/connect-core/src/connections/ConnectorInterface.ts

@@ -1,15 +1,15 @@
-import Application from '../entities/Application'
+import App from '../entities/App'
 import Permission from '../entities/Permission'
-import Repository from '../entities/Repository'
+import Repo from '../entities/Repo'
 import Role from '../entities/Role'
 
 export interface ConnectorInterface {
   chainId?: number
   permissionsForOrg(orgAddress: string): Promise<Permission[]>
   onPermissionsForOrg(orgAddress: string, callback: Function): { unsubscribe: Function }
-  appsForOrg(orgAddress: string): Promise<Application[]>
+  appsForOrg(orgAddress: string): Promise<App[]>
   onAppsForOrg(orgAddress: string, callback: Function): { unsubscribe: Function }
-  repoForApp(appAddress: string): Promise<Repository>
-  appByAddress(appAddress: string): Promise<Application>
+  repoForApp(appAddress: string): Promise<Repo>
+  appByAddress(appAddress: string): Promise<App>
   rolesForAddress(appAddress: string): Promise<Role[]>
 }

packages/connect-core/src/connections/ConnectorJson.ts

@@ -5,7 +5,7 @@
 
 import { ConnectorInterface } from './ConnectorInterface'
 import Permission from '../entities/Permission'
-import { Application, Repository, Role } from '..'
+import { App, Repo, Role } from '..'
 
 export type ConnectorJsonConfig = { permissions: Permission[] }
 
@@ -26,7 +26,7 @@ class ConnectorJson implements ConnectorInterface {
     }
   }
 
-  appsForOrg(orgAddress: string): Promise<Application[]> {
+  appsForOrg(orgAddress: string): Promise<App[]> {
     return new Promise((resolve) => {
       resolve([])
     })
@@ -38,13 +38,13 @@ class ConnectorJson implements ConnectorInterface {
     }
   }
 
-  repoForApp(appAddress: string): Promise<Repository> {
+  repoForApp(appAddress: string): Promise<Repo> {
     return new Promise((resolve) => {
       resolve()
     })
   }
 
-  appByAddress(appAddress: string): Promise<Application> {
+  appByAddress(appAddress: string): Promise<App> {
     return new Promise((resolve) => {
       resolve()
     })

packages/connect-core/src/entities/Application.ts → packages/connect-core/src/entities/App.ts

@@ -1,4 +1,4 @@
-import Repository from './Repository'
+import Repo from './Repo'
 import Role from './Role'
 import CoreEntity from './CoreEntity'
 import { AragonArtifact, AppIntent, Abi, AragonManifest } from '../types'
@@ -8,7 +8,7 @@ import { ConnectorInterface } from '../connections/ConnectorInterface'
 // TODO:
 // [ ] (ipfs) contentUrl 	String 	The HTTP URL of the app content. Uses the IPFS HTTP provider. E.g. http://gateway.ipfs.io/ipfs/QmdLEDDfi…/ (ContentUri passing through the resolver)
 
-export interface ApplicationData {
+export interface AppData {
   address: string
   appId: string
   artifact?: string | null
@@ -25,7 +25,7 @@ export interface ApplicationData {
   version?: string
 }
 
-export default class Application extends CoreEntity implements ApplicationData {
+export default class App extends CoreEntity implements AppData {
   readonly abi?: Abi
   readonly address!: string
   readonly appId!: string
@@ -50,7 +50,7 @@ export default class Application extends CoreEntity implements ApplicationData {
   readonly version?: string
 
   constructor(
-    { artifact, manifest, ...data }: ApplicationData,
+    { artifact, manifest, ...data }: AppData,
     connector: ConnectorInterface
   ) {
     super(connector)
@@ -103,7 +103,7 @@ export default class Application extends CoreEntity implements ApplicationData {
     this.version = data.version
   }
 
-  async repo(): Promise<Repository> {
+  async repo(): Promise<Repo> {
     return this._connector.repoForApp(this.address)
   }
 

packages/connect-core/src/entities/Organization.ts

@@ -1,13 +1,14 @@
 import { ethers } from 'ethers'
 import { Network } from '@aragon/connect-types'
 
-import Application from './Application'
+import App from './App'
 import TransactionIntent from '../transactions/TransactionIntent'
 import Permission from './Permission'
 import { ConnectorInterface } from '../connections/ConnectorInterface'
 
 // TODO: Implement all properties and methods from the API spec (https://github.com/aragon/connect/blob/master/docs/organization.md).
 // [x] Organization#apps()
+// [x] Organization#onApps(cb)
 // [x] Organization#app(appAddress)
 // [ ] Organization#addApp(repoName, options)
 // [ ] Organization#removeApp(appAddress)
@@ -19,10 +20,6 @@ import { ConnectorInterface } from '../connections/ConnectorInterface'
 // [ ] Organization#appIntent(appAddress, funcName, funcArgs)
 // [ ] Organization#appCall(appAddress, methodName, args)
 // [ ] Organization#appState(appAddress)
-// [ ] Organization#on(event, params, callback)
-// [ ] Organization#off(event, callback)
-// [ ] Organization#off(event)
-// [ ] Organization#off()
 // [ ] Events...
 
 export default class Organization {
@@ -84,17 +81,17 @@ export default class Organization {
   }
 
   ///////// APPS ///////////
-  async apps(): Promise<Application[]> {
+  async apps(): Promise<App[]> {
     this.checkConnected()
     return this._connector.appsForOrg(this.address)
   }
 
-  onApps(callback: Function): { unsubscribe: Function } {
+  onApps(callback: (apps: App[]) => void): { unsubscribe: Function } {
     this.checkConnected()
     return this._connector.onAppsForOrg(this.address, callback)
   }
 
-  async app(appAddress: string): Promise<Application> {
+  async app(appAddress: string): Promise<App> {
     this.checkConnected()
     return this._connector.appByAddress(appAddress)
   }

packages/connect-core/src/entities/Permission.ts

@@ -1,5 +1,5 @@
 import CoreEntity from './CoreEntity'
-import Application from './Application'
+import App from './App'
 import Role from './Role'
 import { ConnectorInterface } from '../connections/ConnectorInterface'
 
@@ -35,7 +35,7 @@ export default class Permission extends CoreEntity implements PermissionData {
     this.roleHash = data.roleHash
   }
 
-  async getApp(): Promise<Application> {
+  async getApp(): Promise<App> {
     return this._connector.appByAddress(this.appAddress)
   }
 

packages/connect-core/src/entities/Repository.ts → packages/connect-core/src/entities/Repo.ts

@@ -8,7 +8,7 @@ import {
 import { parseMetadata } from '../utils/parseMetadata'
 import { ConnectorInterface } from '../connections/ConnectorInterface'
 
-export interface RepositoryData {
+export interface RepoData {
   address: string
   artifact?: string | null
   contentUri?: string | null
@@ -18,7 +18,7 @@ export interface RepositoryData {
   registryAddress?: string | null
 }
 
-export default class Repository extends CoreEntity implements RepositoryData {
+export default class Repo extends CoreEntity implements RepoData {
   readonly address!: string
   readonly author?: string
   readonly changelogUrl?: string
@@ -34,7 +34,7 @@ export default class Repository extends CoreEntity implements RepositoryData {
   readonly sourceUrl?: string
 
   constructor(
-    { artifact, manifest, ...data }: RepositoryData,
+    { artifact, manifest, ...data }: RepoData,
     connector: ConnectorInterface
   ) {
     super(connector)

packages/connect-core/src/index.ts

@@ -3,8 +3,8 @@ export {
   default as ConnectorJson,
   ConnectorJsonConfig,
 } from './connections/ConnectorJson'
-export { default as Application, ApplicationData as AppData } from './entities/Application'
+export { default as App, AppData } from './entities/App'
 export { default as Organization } from './entities/Organization'
 export { default as Permission, PermissionData } from './entities/Permission'
-export { default as Repository, RepositoryData as RepoData } from './entities/Repository'
+export { default as Repo, RepoData } from './entities/Repo'
 export { default as Role, RoleData } from './entities/Role'

packages/connect-core/src/transactions/TransactionIntent.ts

@@ -2,7 +2,7 @@ import { ethers } from 'ethers'
 
 import TransactionPath from './TransactionPath'
 import TransactionRequest from './TransactionRequest'
-import Application from '../entities/Application'
+import App from '../entities/App'
 import Organization from '../entities/Organization'
 import { calculateTransactionPath } from '../utils/path/calculatePath'
 import { describeTransactionPath } from '../utils/path/describePath'
@@ -67,7 +67,7 @@ export default class TransactionIntent {
       ),
       destination: apps.find(
         app => app.address == this.contractAddress
-      ) as Application,
+      ) as App,
       forwardingFeePretransaction,
       transactions: transactionsDescribed.map(tx => new TransactionRequest(tx)),
     })

packages/connect-core/src/transactions/TransactionPath.ts

@@ -1,16 +1,16 @@
 import TransactionRequest from './TransactionRequest'
-import Application from '../entities/Application'
+import App from '../entities/App'
 
 export interface TransactionPathData {
-  apps: Application[]
-  destination: Application
+  apps: App[]
+  destination: App
   forwardingFeePretransaction?: TransactionRequest
   transactions: TransactionRequest[]
 }
 
 export default class TransactionPath {
-  readonly apps!: Application[]
-  readonly destination!: Application
+  readonly apps!: App[]
+  readonly destination!: App
   readonly forwardingFeePretransaction?: TransactionRequest
   readonly transactions!: TransactionRequest[]
 

packages/connect-core/src/types.ts

@@ -26,7 +26,7 @@ export interface AppIntent {
 export interface AragonManifest {
   name: string // 'Counter'
   author: string // 'Aragon Association'
-  description: string // 'An application for Aragon'
+  description: string // 'An app for Aragon'
   changelog_url: string // 'https://github.com/aragon/aragon-apps/releases',
   details_url: string // '/meta/details.md'
   source_url: string // 'https://<placeholder-repository-url>'

packages/connect-core/src/utils/app.ts

@@ -1,7 +1,7 @@
 import { ethers } from 'ethers'
 
 import { AppIntent } from '../types'
-import Application from '../entities/Application'
+import App from '../entities/App'
 import { TransactionRequestData } from '../transactions/TransactionRequest'
 
 // Is the given method a full signature, e.g. 'foo(arg1,arg2,...)'
@@ -16,15 +16,15 @@ export const isFullMethodSignature = (methodSignature: string): boolean => {
 export function validateMethod(
   destination: string,
   methodSignature: string,
-  destinationApp: Application
+  destinationApp: App
 ): AppIntent {
   const methods = destinationApp.intents
   if (!methods) {
     throw new Error(`No functions specified in artifact for ${destination}`)
   }
 
   // Find the relevant method information
-  const method = methods.find((method) =>
+  const method = methods.find(method =>
     isFullMethodSignature(methodSignature)
       ? method.sig === methodSignature
       : // If the full signature isn't given, just select the first overload declared
@@ -46,7 +46,7 @@ export function validateMethod(
  * @return {Object|void} Method with radspec notice and function signature, or undefined if none was found
  */
 export function findAppMethodFromIntent(
-  app: Application,
+  app: App,
   transaction: TransactionRequestData
 ): AppIntent | undefined {
   const methodId = transaction.data.substring(0, 10)
@@ -62,7 +62,7 @@ export function findAppMethodFromIntent(
   let method
   // First try to find the method in the current functions
   if (Array.isArray(intents)) {
-    method = intents.find((method) => checkMethodSignature(method.sig))
+    method = intents.find(method => checkMethodSignature(method.sig))
   }
 
   if (!method) {
@@ -75,7 +75,7 @@ export function findAppMethodFromIntent(
       const allDeprecatedFunctions = ([] as AppIntent[]).concat(
         ...deprecatedFunctionsFromVersions
       )
-      method = allDeprecatedFunctions.find((method) =>
+      method = allDeprecatedFunctions.find(method =>
         checkMethodSignature(method.sig)
       )
     }