Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: added sidebar position and row display condition types #165

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

davidesamp
Copy link
Collaborator

@davidesamp davidesamp commented Oct 30, 2024

Description

Added missing types:

  • Sidebar position
  • rowDisplayConditions

Motivation and Context

Align types with documentation

Usage examples

import BeefreeSDK from '@beefree.io/sdk'
import { IPluginDisplayCondition, IBeeConfig, IEntityContentJson } from '@beefree.io/sdk/dist/types/bee'

const rowDisplayConditions : IPluginDisplayCondition[] =  [{
    isActive: true,
    after: '<test>',
    before: '</test>',
    className: 'myClassName',
    description: 'lorem ipsum',
    label: 'lorem ipsum',
    name: 'Lorem ipsum'
  }]

const beeConfig :IBeeConfig = {
 uid: 'test1-clientside',
 container: 'bee-plugin-container',
 sidebarPosition: 'left',
 rowDisplayConditions
....
}

const yourTemplate: IEntityContentJson = {...}
const sdk = new BeefreeSDK()
sdk.getToken('your-client-id', 'your-client-secrets').then(() => {
   sdk.start(beeConfig, yourTemplate, )
})

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Copy link

Code Coverage Report

Coverage after merging chore/add-types into master

82.55%
Coverage Report
FileBranchesFuncsLinesUncovered Lines
src
   index.ts60%5.88%57.95%..., 85, 95, 96, 99
src/services
   api.ts100%50%100%
   axios.ts100%100%100%
src/types
   bee.ts100%100%100%
src/utils
   Constants.ts100%100%100%
   utils.ts0%0%73.33%..., 8, 8, 8, 8

@davidesamp davidesamp merged commit 6346d3f into master Oct 30, 2024
4 checks passed
@davidesamp davidesamp deleted the chore/add-types branch October 30, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typing Issues with Typescript types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant