WIP: parachain SDK

Author: olehmell

.eslintrc.js

@@ -1,6 +1,101 @@
-const base = require('@subsocial/config/eslintrc');
-
-// add override for any (a metric ton of them, initial conversion)
 module.exports = {
-  ...base
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  parserOptions: {
+    ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+    ecmaFeatures: {
+      jsx: true, // Allows for the parsing of JSX
+    },
+  },
+  settings: {
+    react: {
+      // Tells eslint-plugin-react to automatically detect the version of
+      // React to use
+      version: 'detect',
+    },
+  },
+  extends: [
+    // Uses the recommended rules from @eslint-plugin-react
+    'plugin:react/recommended',
+
+    // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    'plugin:@typescript-eslint/recommended',
+  ],
+  plugins: [ 'jsx-a11y', 'prefer-object-spread', 'prettier', 'react-hooks' ],
+  rules: {
+    // In an ideal world, we'd never have to use @ts-ignore, but that's not
+    // possible right now.
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+
+    // Again, in theory this is a good rule, but it can cause a bit of
+    // unhelpful noise.
+    '@typescript-eslint/explicit-function-return-type': 'off',
+
+    // Another theoretically good rule, but sometimes we know better than
+    // the linter.
+    '@typescript-eslint/no-non-null-assertion': 'off',
+
+    // Accessibility rules
+    'jsx-a11y/accessible-emoji': 'error',
+    'jsx-a11y/alt-text': 'error',
+    'jsx-a11y/anchor-has-content': 'error',
+    'jsx-a11y/aria-activedescendant-has-tabindex': 'error',
+    'jsx-a11y/aria-props': 'error',
+    'jsx-a11y/aria-proptypes': 'error',
+    'jsx-a11y/aria-role': 'error',
+    'jsx-a11y/aria-unsupported-elements': 'error',
+    'jsx-a11y/heading-has-content': 'error',
+    'jsx-a11y/html-has-lang': 'error',
+    'jsx-a11y/iframe-has-title': 'error',
+    'jsx-a11y/interactive-supports-focus': 'error',
+    'jsx-a11y/media-has-caption': 'error',
+    'jsx-a11y/mouse-events-have-key-events': 'error',
+    'jsx-a11y/no-access-key': 'error',
+    'jsx-a11y/no-distracting-elements': 'error',
+    'jsx-a11y/no-interactive-element-to-noninteractive-role': 'error',
+    'jsx-a11y/no-noninteractive-element-interactions': 'error',
+    'jsx-a11y/no-noninteractive-element-to-interactive-role': 'error',
+    'jsx-a11y/no-redundant-roles': 'error',
+    'jsx-a11y/role-has-required-aria-props': 'error',
+    'jsx-a11y/role-supports-aria-props': 'error',
+    'jsx-a11y/scope': 'error',
+    'jsx-a11y/tabindex-no-positive': 'error',
+    'jsx-a11y/label-has-associated-control': 'error',
+
+    'prefer-object-spread/prefer-object-spread': 'error',
+
+    // Use template strings instead of string concatenation
+    'prefer-template': 'error',
+
+    'react-hooks/rules-of-hooks': 'error',
+    'react-hooks/exhaustive-deps': 'warn',
+    // Place to specify ESLint rules. Can be used to overwrite rules
+    // specified from the extended configs
+
+    // We're using TypeScript, so prop-types aren't so interesting
+    'react/prop-types': 'off',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [ 'off' ],
+    'semi': 'off',
+    'comma-spacing': 'warn',
+    'array-bracket-spacing': [ 'warn', 'always' ],
+    'react/display-name': 'off',
+    'padded-blocks': 'off',
+    'prefer-promise-reject-errors': 'warn',
+    '@typescript-eslint/explicit-member-accessibility': 'off',
+    '@typescript-eslint/indent': [ 'warn', 2 ],
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/member-delimiter-style': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/prefer-interface': 'off',
+    '@typescript-eslint/no-object-literal-type-assertion': 'off',
+    '@typescript-eslint/camelcase': 'off',
+    'react/prop-types': 'off',
+    '@typescript-eslint/array-type': 'off',
+
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+  },
 };

.prettierrc.js

@@ -7,7 +7,7 @@
     "packages/definitions",
     "packages/i18n"
   ],
-  "version": "0.6.11",
+  "version": "0.6.12-parachain.1",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

lerna.json

@@ -1,6 +1,6 @@
 {
   "name": "@subsocial/api",
-  "version": "0.6.11",
+  "version": "0.6.12-parachain.1",
   "description": "JavaScript API for Subsocial blockchain.",
   "author": "DappForce contributors",
   "license": "GPL-3.0-only",
@@ -20,8 +20,8 @@
   "homepage": "https://github.com/dappforce/dappforce-subsocial-js",
   "dependencies": {
     "@polkadot/api": "latest",
-    "@subsocial/types": "0.6.11",
-    "@subsocial/utils": "0.6.11",
+    "@subsocial/types": "0.6.12-parachain.1",
+    "@subsocial/utils": "0.6.12-parachain.1",
     "axios": "^0.24.0"
   },
   "scripts": {

packages/api/package.json

@@ -2,7 +2,7 @@ import { Option } from '@polkadot/types/codec'
 import { Post, Space, SpacePermissionSet, SpacePermissions } from '@subsocial/types/substrate/interfaces'
 import { notEmptyObj } from '@subsocial/utils'
 import { FlatSpacePermissionKey, FlatSpacePermissionMap, FlatSpacePermissions, FlatSpacePermissionsKey } from '@subsocial/types/substrate/rpc'
-import { CanBeUpdated, CanHaveContent, CanHaveHandle, CanHaveParentId, CanHaveSpaceId, CommentExtension, CommentStruct, CommonContent, EntityData, EntityId, FlatPostExtension, FlatSuperCommon, HasId, HasOwner, PostStruct, ProfileStruct, PublicProfileStruct, SharedPostExtension, SharedPostStruct, SpaceOrPostStruct, SpaceStruct, SuperCommonStruct, FlatSpaceOrPost, SocialAccountWithId } from '@subsocial/types/dto'
+import { CanHaveContent, CanHaveParentId, CanHaveSpaceId, CommentExtension, CommentStruct, CommonContent, EntityData, EntityId, FlatPostExtension, FlatSuperCommon, HasId, HasOwner, PostStruct, SharedPostExtension, SharedPostStruct, SpaceOrPostStruct, SpaceStruct, SuperCommonStruct, FlatSpaceOrPost } from '@subsocial/types/dto'
 
 type EntityDataWithField<S extends {}> = EntityData<HasId & S, CommonContent> | (HasId & S)
 
@@ -29,22 +29,6 @@ export const getUniqueContentIds = (entities: EntityDataWithField<CanHaveContent
 export const getUniqueSpaceIds = (entities: EntityDataWithField<CanHaveSpaceId>[]) =>
   getUniqueIds(entities, 'spaceId')
 
-function getUpdatedFields ({ updated }: SuperCommonStruct): CanBeUpdated {
-  const maybeUpdated = updated.unwrapOr(undefined)
-  let res: CanBeUpdated = {
-    isUpdated: updated.isSome,
-  }
-  if (maybeUpdated) {
-    res = {
-      ...res,
-      updatedByAccount: maybeUpdated.account.toHuman(),
-      updatedAtBlock: maybeUpdated.block.toNumber(),
-      updatedAtTime: maybeUpdated.time.toNumber()
-    }
-  }
-  return res
-}
-
 function getContentFields ({ content }: SuperCommonStruct): CanHaveContent {
   let res: CanHaveContent = {}
   if (content.isIpfs) {
@@ -64,7 +48,7 @@ export function flattenCommonFields (struct: SuperCommonStruct): FlatSuperCommon
     createdAtBlock: created.block.toNumber(),
     createdAtTime: created.time.toNumber(),
 
-    ...getUpdatedFields(struct),
+    isUpdated: struct.updated.toHuman(),
     ...getContentFields(struct),
   }
 }
@@ -97,10 +81,7 @@ export const flattenPermisions = (permissions?: SpacePermissions) => {
   return flatPermissions
 }
 
-export function flattenSpaceStruct (struct: Space): SpaceStruct {
-  const postsCount = struct.postsCount.toNumber()
-  const hiddenPostsCount = struct.hiddenPostsCount.toNumber()
-  const visiblePostsCount = postsCount - hiddenPostsCount
+export function flattenSpaceStruct (struct: Space,): SpaceStruct {
   const flatPermissions = flattenPermisions(struct.permissions.unwrapOr(undefined))
 
   let parentField: CanHaveParentId = {}
@@ -110,27 +91,13 @@ export function flattenSpaceStruct (struct: Space): SpaceStruct {
     }
   }
 
-  let handleField: CanHaveHandle = {}
-  if (struct.handle.isSome) {
-    handleField = {
-      handle: struct.handle.toHuman()?.toString()
-    }
-  }
-
 
   return {
     ...flattenSpaceOrPostStruct(struct),
     ...parentField,
-    ...handleField,
-
     ...flatPermissions,
     canFollowerCreatePosts: !!flatPermissions.followerPermissions?.CreatePosts, //TODO: check CreatePosts permissions in follower set
     canEveryoneCreatePosts: !!flatPermissions.everyonePermissions?.CreatePosts, //TODO: check CreatePosts permissions in everyone set
-    postsCount,
-    hiddenPostsCount,
-    visiblePostsCount,
-    followersCount: struct.followersCount.toNumber(),
-    score: struct.score.toNumber()
   }
 }
 
@@ -139,12 +106,13 @@ export function flattenSpaceStructs (structs: Space[]): SpaceStruct[] {
 }
 
 function flattenPostExtension (struct: Post): FlatPostExtension {
-  const { isSharedPost, isComment } = struct.extension
+  const { isSharedPost, isComment, isRegularPost } = struct.extension
   let normExt: FlatPostExtension = {}
 
   if (isSharedPost) {
+    const originalPostId = struct.extension.asSharedPost
     const sharedPost: SharedPostExtension = {
-      sharedPostId: struct.extension.asSharedPost.toString()
+      originalPostId: originalPostId.toString()
     }
     normExt = sharedPost
   } else if (isComment) {
@@ -162,9 +130,6 @@ function flattenPostExtension (struct: Post): FlatPostExtension {
 }
 
 export function flattenPostStruct (struct: Post): PostStruct {
-  const repliesCount = struct.repliesCount.toNumber()
-  const hiddenRepliesCount = struct.hiddenRepliesCount.toNumber()
-  const visibleRepliesCount = repliesCount - hiddenRepliesCount
   const { isRegularPost, isSharedPost, isComment } = struct.extension
   const extensionFields = flattenPostExtension(struct)
 
@@ -180,14 +145,8 @@ export function flattenPostStruct (struct: Post): PostStruct {
     ...spaceField,
     ...extensionFields,
 
-    repliesCount,
-    hiddenRepliesCount,
-    visibleRepliesCount,
-
-    sharesCount: struct.sharesCount.toNumber(),
     upvotesCount: struct.upvotesCount.toNumber(),
     downvotesCount: struct.downvotesCount.toNumber(),
-    score: struct.score.toNumber(),
 
     isRegularPost,
     isSharedPost,
@@ -210,33 +169,3 @@ export function asCommentStruct (post: PostStruct): CommentStruct {
 
   return post as CommentStruct
 }
-
-export function asPublicProfileStruct (profile: ProfileStruct): PublicProfileStruct {
-  if (!profile.hasProfile) throw new Error('Account has no profile')
-
-  return profile as PublicProfileStruct
-}
-
-export function flattenProfileStruct (struct: SocialAccountWithId): ProfileStruct {
-  const profile = struct.profile?.unwrapOr(undefined)
-  const hasProfile = struct.profile?.isSome
-  const maybeProfile: Partial<FlatSuperCommon> = profile
-    ? flattenCommonFields(profile)
-    : {}
-
-  return {
-    id: struct.id.toString(),
-
-    followersCount: struct.followersCount.toNumber(),
-    followingAccountsCount: struct.followingAccountsCount.toNumber(),
-    followingSpacesCount: struct.followingSpacesCount.toNumber(),
-    reputation: struct.reputation.toNumber(),
-
-    hasProfile,
-    ...maybeProfile
-  }
-}
-
-export function flattenProfileStructs (accounts: SocialAccountWithId[]): ProfileStruct[] {
-  return accounts.map(flattenProfileStruct)
-}

packages/api/src/flat-subsocial/flatteners.ts

@@ -4,34 +4,26 @@ import {
   convertToNewPostWithAllDetailsArray,
   convertToNewSpaceData,
   convertToNewSpaceDataArray,
-  convertToNewProfileData,
   convertToNewPostData,
   convertToNewPostWithSomeDetails,
   convertToNewPostWithSomeDetailsArray,
-  convertToNewProfileDataArray,
 } from './utils'
 import { FindPostQuery, FindPostsQuery, FindPostsWithDetailsQuery, FindSpaceQuery } from '../filters'
-import { AnyAccountId } from '@subsocial/types'
 import { SubsocialApi } from '../subsocial'
-import { ProfileData, SpaceData, PostData, PostWithSomeDetails, PostWithAllDetails, AnyId, ProfileStruct, SpaceStruct, PostStruct } from '@subsocial/types/dto'
+import { SpaceData, PostData, PostWithSomeDetails, PostWithAllDetails, AnyId, SpaceStruct, PostStruct } from '@subsocial/types/dto'
 import { getFirstOrUndefined, idsToBns, idToBn } from '@subsocial/utils'
-import { flattenSpaceStructs, flattenPostStructs, flattenProfileStructs } from './flatteners'
+import { flattenSpaceStructs, flattenPostStructs } from './flatteners'
 
 export interface IFlatSubsocialApi {
-  findProfile: (id: AnyAccountId) => Promise<ProfileData | undefined>
-  findProfiles: (ids: AnyAccountId[]) => Promise<ProfileData[]>
-
   findSpace: (query: FindSpaceQuery) => Promise<SpaceData | undefined>
   findPublicSpaces: (ids: AnyId[]) => Promise<SpaceData[]>
   findUnlistedSpaces: (ids: AnyId[]) => Promise<SpaceData[]>
 
   findSpaceStructs: (ids: AnyId[]) => Promise<SpaceStruct[]>
   findPostStructs: (ids: AnyId[]) => Promise<PostStruct[]>
-  findProfileStructs: (ids: AnyAccountId[]) => Promise<ProfileStruct[]>
 
   findSpaceStruct: (id: AnyId) => Promise<SpaceStruct | undefined>
   findPostStruct: (id: AnyId) => Promise<PostStruct | undefined>
-  findProfileStruct: (id: AnyAccountId) => Promise<ProfileStruct | undefined>
 
   findPost: (query: FindPostQuery) => Promise<PostData | undefined>
   findPublicPosts: (ids: AnyId[]) => Promise<PostData[]>
@@ -64,11 +56,6 @@ export class FlatSubsocialApi implements IFlatSubsocialApi {
     return flattenPostStructs(structs)
   }
 
-  public async findProfileStructs (ids: AnyAccountId[]): Promise<ProfileStruct[]> {
-    const structs = await this.subsocial.substrate.findSocialAccounts(ids)
-    return flattenProfileStructs(structs)
-  }
-
   public async findSpaceStruct (id: AnyId): Promise<SpaceStruct | undefined> {
     return getFirstOrUndefined(await this.findSpaceStructs([ id ]))
   }
@@ -77,22 +64,6 @@ export class FlatSubsocialApi implements IFlatSubsocialApi {
     return getFirstOrUndefined(await this.findPostStructs([ id ]))
   }
 
-  public async findProfileStruct (id: AnyAccountId): Promise<ProfileStruct | undefined>{
-    return getFirstOrUndefined(await this.findProfileStructs([ id ]))
-  }
-
-
-  public async findProfile (id: AnyAccountId) {
-    const old = await this.subsocial.findProfile(id)
-    return !old ? old : convertToNewProfileData(old)
-  }
-
-  public async findProfiles (ids: AnyAccountId[]) {
-    return convertToNewProfileDataArray(
-       await this.subsocial.findProfiles(ids)
-    )
-  }
-  
   public async findSpace (query: FindSpaceQuery) {
     const old =  await this.subsocial.findSpace(query)
     return !old ? old: convertToNewSpaceData(old)