fix: use component displayName property

This commit is contained in:
Mo
2022-05-20 11:40:51 -05:00
parent 57ec49733d
commit e52e2daf39
12 changed files with 66 additions and 41 deletions

View File

@@ -43,7 +43,7 @@ export const ChangeEditorMenu: FunctionComponent<ChangeEditorMenuProps> = ({
}) => { }) => {
const [editors] = useState<SNComponent[]>(() => const [editors] = useState<SNComponent[]>(() =>
application.componentManager.componentsForArea(ComponentArea.Editor).sort((a, b) => { application.componentManager.componentsForArea(ComponentArea.Editor).sort((a, b) => {
return a.name.toLowerCase() < b.name.toLowerCase() ? -1 : 1 return a.displayName.toLowerCase() < b.displayName.toLowerCase() ? -1 : 1
}), }),
) )
const [groups, setGroups] = useState<EditorMenuGroup[]>([]) const [groups, setGroups] = useState<EditorMenuGroup[]>([])

View File

@@ -63,7 +63,7 @@ export const createEditorMenuGroups = (application: WebApplication, editors: SNC
editors.forEach((editor) => { editors.forEach((editor) => {
const editorItem: EditorMenuItem = { const editorItem: EditorMenuItem = {
name: editor.name, name: editor.displayName,
component: editor, component: editor,
isEntitled: application.features.getFeatureStatus(editor.identifier) === FeatureStatus.Entitled, isEntitled: application.features.getFeatureStatus(editor.identifier) === FeatureStatus.Entitled,
} }

View File

@@ -49,7 +49,7 @@ export const ComponentView: FunctionalComponent<IProps> = observer(
const [isDeprecationMessageDismissed, setIsDeprecationMessageDismissed] = useState(false) const [isDeprecationMessageDismissed, setIsDeprecationMessageDismissed] = useState(false)
const [didAttemptReload, setDidAttemptReload] = useState(false) const [didAttemptReload, setDidAttemptReload] = useState(false)
const component = componentViewer.component const component: SNComponent = componentViewer.component
const manageSubscription = useCallback(() => { const manageSubscription = useCallback(() => {
openSubscriptionDashboard(application) openSubscriptionDashboard(application)
@@ -182,7 +182,7 @@ export const ComponentView: FunctionalComponent<IProps> = observer(
<> <>
{hasIssueLoading && ( {hasIssueLoading && (
<IssueOnLoading <IssueOnLoading
componentName={component.name} componentName={component.displayName}
reloadIframe={() => { reloadIframe={() => {
reloadValidityStatus(), requestReload?.(componentViewer, true) reloadValidityStatus(), requestReload?.(componentViewer, true)
}} }}
@@ -193,7 +193,7 @@ export const ComponentView: FunctionalComponent<IProps> = observer(
<IsExpired <IsExpired
expiredDate={dateToLocalizedString(component.valid_until)} expiredDate={dateToLocalizedString(component.valid_until)}
featureStatus={featureStatus} featureStatus={featureStatus}
componentName={component.name} componentName={component.displayName}
manageSubscription={manageSubscription} manageSubscription={manageSubscription}
/> />
)} )}
@@ -201,7 +201,7 @@ export const ComponentView: FunctionalComponent<IProps> = observer(
<IsDeprecated deprecationMessage={deprecationMessage} dismissDeprecationMessage={dismissDeprecationMessage} /> <IsDeprecated deprecationMessage={deprecationMessage} dismissDeprecationMessage={dismissDeprecationMessage} />
)} )}
{error === ComponentViewerError.OfflineRestricted && <OfflineRestricted />} {error === ComponentViewerError.OfflineRestricted && <OfflineRestricted />}
{error === ComponentViewerError.MissingUrl && <UrlMissing componentName={component.name} />} {error === ComponentViewerError.MissingUrl && <UrlMissing componentName={component.displayName} />}
{component.uuid && isComponentValid && ( {component.uuid && isComponentValid && (
<iframe <iframe
ref={iframeRef} ref={iframeRef}

View File

@@ -56,7 +56,7 @@ export class PermissionsModal extends Component<Props> {
<div className="sk-panel-section"> <div className="sk-panel-section">
<div className="sk-panel-row"> <div className="sk-panel-row">
<div className="sk-h2"> <div className="sk-h2">
<strong>{this.props.component.name}</strong> <strong>{this.props.component.displayName}</strong>
{' would like to interact with your '} {' would like to interact with your '}
{this.props.permissionsString} {this.props.permissionsString}
</div> </div>

View File

@@ -0,0 +1,3 @@
import { SNActionsExtension, SNComponent, SNTheme } from '@standardnotes/snjs'
export type AnyExtension = SNComponent | SNTheme | SNActionsExtension

View File

@@ -1,10 +1,11 @@
import { DisplayStringForContentType, SNComponent } from '@standardnotes/snjs' import { DisplayStringForContentType } from '@standardnotes/snjs'
import { Button } from '@/Components/Button/Button' import { Button } from '@/Components/Button/Button'
import { FunctionComponent } from 'preact' import { FunctionComponent } from 'preact'
import { Title, Text, Subtitle, PreferencesSegment } from '@/Components/Preferences/PreferencesComponents' import { Title, Text, Subtitle, PreferencesSegment } from '@/Components/Preferences/PreferencesComponents'
import { AnyExtension } from './AnyExtension'
export const ConfirmCustomExtension: FunctionComponent<{ export const ConfirmCustomExtension: FunctionComponent<{
component: SNComponent component: AnyExtension
callback: (confirmed: boolean) => void callback: (confirmed: boolean) => void
}> = ({ component, callback }) => { }> = ({ component, callback }) => {
const fields = [ const fields = [

View File

@@ -1,13 +1,16 @@
import { FunctionComponent } from 'preact' import { FunctionComponent } from 'preact'
import { useState, useRef, useEffect } from 'preact/hooks' import { useState, useRef, useEffect } from 'preact/hooks'
export const RenameExtension: FunctionComponent<{ export const ExtensionInfoCell: FunctionComponent<{
extensionName: string extensionName: string
changeName: (newName: string) => void changeName: (newName: string) => void
}> = ({ extensionName, changeName }) => { isThirdParty: boolean
}> = ({ extensionName, changeName, isThirdParty }) => {
const [isRenaming, setIsRenaming] = useState(false) const [isRenaming, setIsRenaming] = useState(false)
const [newExtensionName, setNewExtensionName] = useState<string>(extensionName) const [newExtensionName, setNewExtensionName] = useState<string>(extensionName)
const renameable = isThirdParty
const inputRef = useRef<HTMLInputElement>(null) const inputRef = useRef<HTMLInputElement>(null)
useEffect(() => { useEffect(() => {
@@ -38,15 +41,17 @@ export const RenameExtension: FunctionComponent<{
<div className="flex flex-row mr-3 items-center"> <div className="flex flex-row mr-3 items-center">
<input <input
ref={inputRef} ref={inputRef}
disabled={!isRenaming} disabled={!isRenaming || !renameable}
autocomplete="off" autocomplete="off"
className="flex-grow text-base font-bold no-border bg-default px-0 color-text" className="flex-grow text-base font-bold no-border bg-default px-0 color-text"
type="text" type="text"
value={newExtensionName} value={newExtensionName}
onChange={({ target: input }) => setNewExtensionName((input as HTMLInputElement)?.value)} onChange={({ target: input }) => setNewExtensionName((input as HTMLInputElement)?.value)}
/> />
<div className="min-w-3" /> <div className="min-w-3" />
{isRenaming ? (
{isRenaming && (
<> <>
<a className="pt-1 cursor-pointer" onClick={confirmRename}> <a className="pt-1 cursor-pointer" onClick={confirmRename}>
Confirm Confirm
@@ -56,7 +61,9 @@ export const RenameExtension: FunctionComponent<{
Cancel Cancel
</a> </a>
</> </>
) : ( )}
{renameable && !isRenaming && (
<a className="pt-1 cursor-pointer" onClick={startRenaming}> <a className="pt-1 cursor-pointer" onClick={startRenaming}>
Rename Rename
</a> </a>

View File

@@ -1,11 +1,12 @@
import { FunctionComponent } from 'preact' import { FunctionComponent } from 'preact'
import { SNComponent } from '@standardnotes/snjs' import { SNComponent } from '@standardnotes/snjs'
import { PreferencesSegment, SubtitleLight, Title } from '@/Components/Preferences/PreferencesComponents' import { PreferencesSegment, SubtitleLight } from '@/Components/Preferences/PreferencesComponents'
import { Switch } from '@/Components/Switch' import { Switch } from '@/Components/Switch'
import { WebApplication } from '@/UIModels/Application' import { WebApplication } from '@/UIModels/Application'
import { useState } from 'preact/hooks' import { useState } from 'preact/hooks'
import { Button } from '@/Components/Button/Button' import { Button } from '@/Components/Button/Button'
import { RenameExtension } from './RenameExtension' import { ExtensionInfoCell } from './ExtensionInfoCell'
import { AnyExtension } from './AnyExtension'
const UseHosted: FunctionComponent<{ const UseHosted: FunctionComponent<{
offlineOnly: boolean offlineOnly: boolean
@@ -19,16 +20,16 @@ const UseHosted: FunctionComponent<{
export interface ExtensionItemProps { export interface ExtensionItemProps {
application: WebApplication application: WebApplication
extension: SNComponent extension: AnyExtension
first: boolean first: boolean
latestVersion: string | undefined latestVersion: string | undefined
uninstall: (extension: SNComponent) => void uninstall: (extension: AnyExtension) => void
toggleActivate?: (extension: SNComponent) => void toggleActivate?: (extension: AnyExtension) => void
} }
export const ExtensionItem: FunctionComponent<ExtensionItemProps> = ({ application, extension, first, uninstall }) => { export const ExtensionItem: FunctionComponent<ExtensionItemProps> = ({ application, extension, uninstall }) => {
const [offlineOnly, setOfflineOnly] = useState(extension.offlineOnly ?? false) const [offlineOnly, setOfflineOnly] = useState(extension instanceof SNComponent ? extension.offlineOnly : false)
const [extensionName, setExtensionName] = useState(extension.name) const [extensionName, setExtensionName] = useState(extension.displayName)
const toggleOffllineOnly = () => { const toggleOffllineOnly = () => {
const newOfflineOnly = !offlineOnly const newOfflineOnly = !offlineOnly
@@ -66,17 +67,13 @@ export const ExtensionItem: FunctionComponent<ExtensionItemProps> = ({ applicati
} }
const localInstallable = extension.package_info.download_url const localInstallable = extension.package_info.download_url
const isThirParty = application.features.isThirdPartyFeature(extension.identifier)
const isThirParty = 'identifier' in extension && application.features.isThirdPartyFeature(extension.identifier)
return ( return (
<PreferencesSegment classes={'mb-5'}> <PreferencesSegment classes={'mb-5'}>
{first && ( <ExtensionInfoCell isThirdParty={isThirParty} extensionName={extensionName} changeName={changeExtensionName} />
<>
<Title>Extensions</Title>
</>
)}
<RenameExtension extensionName={extensionName} changeName={changeExtensionName} />
<div className="min-h-2" /> <div className="min-h-2" />
{isThirParty && localInstallable && ( {isThirParty && localInstallable && (
@@ -86,7 +83,12 @@ export const ExtensionItem: FunctionComponent<ExtensionItemProps> = ({ applicati
<> <>
<div className="min-h-2" /> <div className="min-h-2" />
<div className="flex flex-row"> <div className="flex flex-row">
<Button className="min-w-20" variant="normal" label="Uninstall" onClick={() => uninstall(extension)} /> <Button
className="min-w-20"
variant="normal"
label={isThirParty ? 'Uninstall' : 'Reset'}
onClick={() => uninstall(extension)}
/>
</div> </div>
</> </>
</PreferencesSegment> </PreferencesSegment>

View File

@@ -1,6 +1,7 @@
import { WebApplication } from '@/UIModels/Application' import { WebApplication } from '@/UIModels/Application'
import { SNComponent, ClientDisplayableError, FeatureDescription } from '@standardnotes/snjs' import { ClientDisplayableError, FeatureDescription } from '@standardnotes/snjs'
import { makeAutoObservable, observable } from 'mobx' import { makeAutoObservable, observable } from 'mobx'
import { AnyExtension } from './AnyExtension'
export class ExtensionsLatestVersions { export class ExtensionsLatestVersions {
static async load(application: WebApplication): Promise<ExtensionsLatestVersions | undefined> { static async load(application: WebApplication): Promise<ExtensionsLatestVersions | undefined> {
@@ -23,7 +24,7 @@ export class ExtensionsLatestVersions {
}) })
} }
getVersion(extension: SNComponent): string | undefined { getVersion(extension: AnyExtension): string | undefined {
return this.latestVersionsMap.get(extension.package_info.identifier) return this.latestVersionsMap.get(extension.package_info.identifier)
} }
} }

View File

@@ -9,9 +9,10 @@ import { observer } from 'mobx-react-lite'
import { ExtensionsLatestVersions } from './ExtensionsLatestVersions' import { ExtensionsLatestVersions } from './ExtensionsLatestVersions'
import { ExtensionItem } from './ExtensionItem' import { ExtensionItem } from './ExtensionItem'
import { ConfirmCustomExtension } from './ConfirmCustomExtension' import { ConfirmCustomExtension } from './ConfirmCustomExtension'
import { AnyExtension } from './AnyExtension'
const loadExtensions = (application: WebApplication) => const loadExtensions = (application: WebApplication) =>
application.items.getItems([ContentType.ActionsExtension, ContentType.Component, ContentType.Theme]) as SNComponent[] application.items.getItems([ContentType.ActionsExtension, ContentType.Component, ContentType.Theme]) as AnyExtension[]
export const Extensions: FunctionComponent<{ export const Extensions: FunctionComponent<{
application: WebApplication application: WebApplication
@@ -19,7 +20,7 @@ export const Extensions: FunctionComponent<{
className?: string className?: string
}> = observer(({ application, extensionsLatestVersions, className = '' }) => { }> = observer(({ application, extensionsLatestVersions, className = '' }) => {
const [customUrl, setCustomUrl] = useState('') const [customUrl, setCustomUrl] = useState('')
const [confirmableExtension, setConfirmableExtension] = useState<SNComponent | undefined>(undefined) const [confirmableExtension, setConfirmableExtension] = useState<AnyExtension | undefined>(undefined)
const [extensions, setExtensions] = useState(loadExtensions(application)) const [extensions, setExtensions] = useState(loadExtensions(application))
const confirmableEnd = useRef<HTMLDivElement>(null) const confirmableEnd = useRef<HTMLDivElement>(null)
@@ -30,7 +31,7 @@ export const Extensions: FunctionComponent<{
} }
}, [confirmableExtension, confirmableEnd]) }, [confirmableExtension, confirmableEnd])
const uninstallExtension = async (extension: SNComponent) => { const uninstallExtension = async (extension: AnyExtension) => {
application.alertService application.alertService
.confirm( .confirm(
'Are you sure you want to uninstall this extension? Note that extensions managed by your subscription will automatically be re-installed on application restart.', 'Are you sure you want to uninstall this extension? Note that extensions managed by your subscription will automatically be re-installed on application restart.',
@@ -66,13 +67,23 @@ export const Extensions: FunctionComponent<{
} }
const confirmExtension = async () => { const confirmExtension = async () => {
await application.mutator.insertItem(confirmableExtension as SNComponent) await application.mutator.insertItem(confirmableExtension as AnyExtension)
application.sync.sync().catch(console.error) application.sync.sync().catch(console.error)
setExtensions(loadExtensions(application)) setExtensions(loadExtensions(application))
} }
const visibleExtensions = extensions.filter((extension) => { const visibleExtensions = extensions.filter((extension) => {
return extension.package_info != undefined && !['modal', 'rooms'].includes(extension.area) const hasPackageInfo = extension.package_info != undefined
if (!hasPackageInfo) {
return false
}
if (extension instanceof SNComponent) {
return !['modal', 'rooms'].includes(extension.area)
}
return true
}) })
return ( return (
@@ -80,7 +91,7 @@ export const Extensions: FunctionComponent<{
{visibleExtensions.length > 0 && ( {visibleExtensions.length > 0 && (
<div> <div>
{visibleExtensions {visibleExtensions
.sort((e1, e2) => e1.name?.toLowerCase().localeCompare(e2.name?.toLowerCase())) .sort((e1, e2) => e1.displayName?.toLowerCase().localeCompare(e2.displayName?.toLowerCase()))
.map((extension, i) => ( .map((extension, i) => (
<ExtensionItem <ExtensionItem
key={extension.uuid} key={extension.uuid}

View File

@@ -72,7 +72,7 @@ export const Defaults: FunctionComponent<Props> = ({ application }) => {
const [iconType, tint] = application.iconsController.getIconAndTintForNoteType(editor.package_info.note_type) const [iconType, tint] = application.iconsController.getIconAndTintForNoteType(editor.package_info.note_type)
return { return {
label: editor.name, label: editor.displayName,
value: identifier, value: identifier,
...(iconType ? { icon: iconType } : null), ...(iconType ? { icon: iconType } : null),
...(tint ? { iconClassName: `color-accessory-tint-${tint}` } : null), ...(tint ? { iconClassName: `color-accessory-tint-${tint}` } : null),

View File

@@ -67,7 +67,7 @@ export const QuickSettingsMenu: FunctionComponent<MenuProps> = observer(({ appli
const reloadThemes = useCallback(() => { const reloadThemes = useCallback(() => {
const themes = application.items.getDisplayableItems<SNTheme>(ContentType.Theme).map((item) => { const themes = application.items.getDisplayableItems<SNTheme>(ContentType.Theme).map((item) => {
return { return {
name: item.name, name: item.displayName,
identifier: item.identifier, identifier: item.identifier,
component: item, component: item,
} }
@@ -263,7 +263,7 @@ export const QuickSettingsMenu: FunctionComponent<MenuProps> = observer(({ appli
> >
<div className="flex items-center"> <div className="flex items-center">
<Icon type="window" className="color-neutral mr-2" /> <Icon type="window" className="color-neutral mr-2" />
{component.name} {component.displayName}
</div> </div>
<Switch checked={component.active} className="px-0" /> <Switch checked={component.active} className="px-0" />
</button> </button>