Skip to content

Commit

Permalink
refactor(sanity): remove underscore prefix on internal members
Browse files Browse the repository at this point in the history
  • Loading branch information
mariuslundgard committed Oct 4, 2022
1 parent 3e9e685 commit a4092b2
Show file tree
Hide file tree
Showing 13 changed files with 49 additions and 52 deletions.
2 changes: 1 addition & 1 deletion packages/sanity/src/_exports/desk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ export type {
StringInputProps,
TypeAnnotationMismatchError,
UndeclaredMembersError,
_ArrayInput_ArrayMember,
ArrayInputMember,
} from '../form'

export type {
Expand Down
6 changes: 3 additions & 3 deletions packages/sanity/src/_exports/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ export type {
export * from '../components/DefaultDocument'

export type {
_DocumentLanguageFilterComponent,
_DocumentLanguageFilterContext,
_DocumentLanguageFilterResolver,
DocumentLanguageFilterComponent,
DocumentLanguageFilterContext,
DocumentLanguageFilterResolver,
AssetSourceResolver,
AsyncComposableOption,
ComposableOption,
Expand Down
12 changes: 6 additions & 6 deletions packages/sanity/src/config/configPropertyReducers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import {
} from '../desk/actions'
import {DocumentBadgeComponent, LiveEditBadge} from '../desk/badges'
import type {
_DocumentLanguageFilterComponent,
_DocumentLanguageFilterContext,
DocumentLanguageFilterComponent,
DocumentLanguageFilterContext,
AsyncConfigPropertyReducer,
ConfigContext,
ConfigPropertyReducer,
Expand All @@ -32,7 +32,7 @@ export const initialDocumentActions = [
DeleteAction,
]

export const initialLanguageFilter: _DocumentLanguageFilterComponent[] = []
export const initialLanguageFilter: DocumentLanguageFilterComponent[] = []

export const schemaTypesReducer: ConfigPropertyReducer<
SchemaTypeDefinition[],
Expand Down Expand Up @@ -169,9 +169,9 @@ export const imageAssetSourceResolver: ConfigPropertyReducer<AssetSource[], Conf
/**
* @internal
*/
export const _documentLanguageFilterReducer: ConfigPropertyReducer<
_DocumentLanguageFilterComponent[],
_DocumentLanguageFilterContext
export const documentLanguageFilterReducer: ConfigPropertyReducer<
DocumentLanguageFilterComponent[],
DocumentLanguageFilterContext
> = (prev, {document}, context) => {
const resolveDocumentLanguageFilter = document?.unstable_languageFilter
if (!resolveDocumentLanguageFilter) return prev
Expand Down
4 changes: 2 additions & 2 deletions packages/sanity/src/config/prepareConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {
WorkspaceSummary,
} from './types'
import {
_documentLanguageFilterReducer,
documentLanguageFilterReducer,
documentActionsReducer,
documentBadgesReducer,
fileAssetSourceResolver,
Expand Down Expand Up @@ -449,7 +449,7 @@ function resolveSource({
context: {...context, ...partialContext},
initialValue: initialLanguageFilter,
propertyName: 'document.unstable_languageFilter',
reducer: _documentLanguageFilterReducer,
reducer: documentLanguageFilterReducer,
}),
},
form: {
Expand Down
16 changes: 8 additions & 8 deletions packages/sanity/src/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,29 +163,29 @@ export interface DocumentPluginOptions {
badges?: DocumentBadgeComponent[] | DocumentBadgesResolver
actions?: DocumentActionComponent[] | DocumentActionsResolver
productionUrl?: AsyncComposableOption<string | undefined, ResolveProductionUrlContext>
unstable_languageFilter?: _DocumentLanguageFilterResolver
unstable_languageFilter?: DocumentLanguageFilterResolver
newDocumentOptions?: NewDocumentOptionsResolver
}

/**
* @internal
*/
export interface _DocumentLanguageFilterContext extends ConfigContext {
export interface DocumentLanguageFilterContext extends ConfigContext {
documentId?: string
schemaType: string
}

/**
* @internal
*/
export type _DocumentLanguageFilterComponent = ComponentType<{schemaType: ObjectSchemaType}>
export type DocumentLanguageFilterComponent = ComponentType<{schemaType: ObjectSchemaType}>

/**
* @internal
*/
export type _DocumentLanguageFilterResolver = ComposableOption<
_DocumentLanguageFilterComponent[],
_DocumentLanguageFilterContext
export type DocumentLanguageFilterResolver = ComposableOption<
DocumentLanguageFilterComponent[],
DocumentLanguageFilterContext
>

export type DocumentActionsResolver = ComposableOption<
Expand Down Expand Up @@ -303,8 +303,8 @@ export interface Source {
) => Promise<string | undefined>
resolveNewDocumentOptions: (context: NewDocumentCreationContext) => InitialValueTemplateItem[]
unstable_languageFilter: (
props: PartialContext<_DocumentLanguageFilterContext>
) => _DocumentLanguageFilterComponent[]
props: PartialContext<DocumentLanguageFilterContext>
) => DocumentLanguageFilterComponent[]
}
form: {
file: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
SanityDocumentLike,
} from '@sanity/types'
import {createContext} from 'react'
import {_DocumentLanguageFilterComponent} from '../../../config'
import {DocumentLanguageFilterComponent} from '../../../config'
import {EditStateFor, TimelineController, Timeline} from '../../../datastores'
import {PatchEvent, StateTree} from '../../../form'
import {DocumentActionComponent} from '../../actions'
Expand Down Expand Up @@ -64,7 +64,7 @@ export interface DocumentPaneContextValue {
value: SanityDocumentLike
views: PaneView[]
formState: DocumentFormNode | null
unstable_languageFilter: _DocumentLanguageFilterComponent[]
unstable_languageFilter: DocumentLanguageFilterComponent[]
}

export const DocumentPaneContext = createContext<DocumentPaneContextValue | null>(null)
7 changes: 2 additions & 5 deletions packages/sanity/src/form/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,8 @@ export * from './studio/focusManagers/HashFocusManager'
export * from './studio/focusManagers/SimpleFocusManager'

// inputs
export type {_ArrayInput_ArrayMember, _InsertEvent} from './inputs/arrays/ArrayOfObjectsInput'
export type {
_ArrayInputState,
ArrayInputProps,
} from './inputs/arrays/ArrayOfObjectsInput/ArrayInput'
export type {ArrayInputMember, InsertEvent} from './inputs/arrays/ArrayOfObjectsInput'
export type {ArrayInputState, ArrayInputProps} from './inputs/arrays/ArrayOfObjectsInput/ArrayInput'
export * from './inputs/PortableText/PortableTextInput'
export {PortableTextInput as BlockEditor} from './inputs/PortableText/PortableTextInput'

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import {isNonNullable} from '../../utils/isNonNullable'
import {AlertStrip} from '../../components/AlertStrip'
import {RowWrapper} from '../arrays/ArrayOfObjectsInput/item/components/RowWrapper'
import {DragHandle} from '../arrays/common/DragHandle'
import {_InsertEvent} from '../arrays/ArrayOfObjectsInput/types'
import {InsertEvent} from '../arrays/ArrayOfObjectsInput/types'
import {InsertMenu} from '../arrays/ArrayOfObjectsInput/InsertMenu'
import {useOnClickOutside} from '../../hooks/useOnClickOutside'
import {FIXME} from '../../types'
Expand All @@ -79,7 +79,7 @@ const INITIAL_SEARCH_STATE: ReferenceSearchState = {
export interface Props extends ReferenceInputProps<OptionalRef> {
isSortable: boolean
insertableTypes?: SchemaType[]
onInsert?: (event: _InsertEvent) => void
onInsert?: (event: InsertEvent) => void
}

const NO_FILTER = () => true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ import {ArrayOfObjectsInputProps} from '../../../types'
import {isObjectItemProps} from '../../../types/asserters'
import {withFocusRing} from '../../../components/withFocusRing'
import {ArrayOfObjectsItem, MemberItemError} from '../../../members'
import type {_ArrayInput_ArrayMember, _InsertEvent} from './types'
import type {ArrayInputMember, InsertEvent} from './types'
import {uploadTarget} from './uploadTarget/uploadTarget'
import {isEmpty} from './item/helpers'
import {ArrayItem} from './item/ArrayItem'

type Toast = {push: (params: ToastParams) => void}

export function createProtoValue(type: SchemaType): _ArrayInput_ArrayMember {
export function createProtoValue(type: SchemaType): ArrayInputMember {
if (!isObjectSchemaType(type)) {
throw new Error(
`Invalid item type: "${type.type}". Default array input can only contain objects (for now)`
Expand All @@ -52,13 +52,13 @@ export function createProtoValue(type: SchemaType): _ArrayInput_ArrayMember {
/**
* @internal
*/
export interface _ArrayInputState {
export interface ArrayInputState {
isResolvingInitialValue: boolean
}

const UploadTarget = uploadTarget(withFocusRing(Card))

export interface ArrayInputProps extends ArrayOfObjectsInputProps<_ArrayInput_ArrayMember> {
export interface ArrayInputProps extends ArrayOfObjectsInputProps<ArrayInputMember> {
resolveUploader: UploaderResolver
client: SanityClient
}
Expand All @@ -68,28 +68,28 @@ export class ArrayInput extends React.PureComponent<ArrayInputProps> {
toast: any | null = null

uploadSubscriptions: Record<string, Subscription> = {}
state: _ArrayInputState = {
state: ArrayInputState = {
isResolvingInitialValue: false,
}

insert = (
item: _ArrayInput_ArrayMember,
item: ArrayInputMember,
position: 'before' | 'after',
referenceItem: number | KeyedSegment
) => {
const {onInsert} = this.props
onInsert({items: [item], position, referenceItem})
}

handlePrepend = (value: _ArrayInput_ArrayMember) => {
handlePrepend = (value: ArrayInputMember) => {
this.handleInsert({item: value, position: 'before', referenceItem: 0})
}

handleAppend = (value: _ArrayInput_ArrayMember) => {
handleAppend = (value: ArrayInputMember) => {
this.handleInsert({item: value, position: 'after', referenceItem: -1})
}

handleInsert = (event: _InsertEvent) => {
handleInsert = (event: InsertEvent) => {
const {onFocusPath, onOpenItem, resolveInitialValue} = this.props
this.setState({isResolvingInitialValue: true})
const memberType = this.getMemberTypeOfItem(event.item)
Expand Down Expand Up @@ -128,17 +128,17 @@ export class ArrayInput extends React.PureComponent<ArrayInputProps> {
})
}

getMemberTypeOfItem(item: _ArrayInput_ArrayMember): SchemaType | undefined {
getMemberTypeOfItem(item: ArrayInputMember): SchemaType | undefined {
const {schemaType} = this.props
const itemTypeName = resolveTypeName(item)
return schemaType.of.find((memberType) => memberType.name === itemTypeName)
}

handleRemoveItem = (item: _ArrayInput_ArrayMember) => {
handleRemoveItem = (item: ArrayInputMember) => {
this.removeItem(item)
}

removeItem(item: _ArrayInput_ArrayMember) {
removeItem(item: ArrayInputMember) {
const {onChange, onFocusPath, value} = this.props

// create a patch for removing the item
Expand Down Expand Up @@ -261,7 +261,7 @@ export class ArrayInput extends React.PureComponent<ArrayInputProps> {
schemaType={itemProps.schemaType}
layout={schemaType.options?.layout}
insertableTypes={schemaType.of}
value={itemProps.value as _ArrayInput_ArrayMember}
value={itemProps.value as ArrayInputMember}
focused={focused}
open={itemProps.open}
path={itemProps.path}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* eslint-disable camelcase */

export {ArrayInput} from './ArrayInput'
export type {_ArrayInput_ArrayMember} from './types'
export type {_InsertEvent} from './types'
export type {ArrayInputMember} from './types'
export type {InsertEvent} from './types'
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {isReferenceSchemaType, Path, SchemaType} from '@sanity/types'
import {Box} from '@sanity/ui'
import React, {memo, useCallback, useRef} from 'react'
import {ChangeIndicator} from '../../../../../components/changeIndicators'
import {_ArrayInput_ArrayMember} from '../types'
import {ArrayInputMember} from '../types'
import {useScrollIntoViewOnFocusWithin} from '../../../../hooks/useScrollIntoViewOnFocusWithin'
import {useDidUpdate} from '../../../../hooks/useDidUpdate'
import {FIXME, RenderPreviewCallback} from '../../../../types'
Expand All @@ -22,15 +22,15 @@ export interface ArrayItemProps {
onClick: () => void
onFocus: (event: React.FocusEvent) => void
onInsert: (event: {items: unknown[]; position: 'before' | 'after'}) => void
onRemove: (value: _ArrayInput_ArrayMember) => void
onRemove: (value: ArrayInputMember) => void
open: boolean
path: Path
presence: FIXME[]
readOnly?: boolean
renderPreview: RenderPreviewCallback
schemaType: SchemaType
validation: FIXME[]
value: _ArrayInput_ArrayMember
value: ArrayInputMember
}

// This renders the item / preview of unexpanded array items
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export type ModalType = 'modal' | 'fullscreen' | string
/**
* @internal
*/
export type _ArrayInput_ArrayMember = {
export type ArrayInputMember = {
_type?: string
_key: string
[key: string]: any
Expand All @@ -17,8 +17,8 @@ export type _ArrayInput_ArrayMember = {
/**
* @internal
*/
export interface _InsertEvent {
item: _ArrayInput_ArrayMember
export interface InsertEvent {
item: ArrayInputMember
position: 'before' | 'after'
referenceItem: KeyedSegment | number
edit?: boolean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import * as adapter from '../client-adapters/reference'
import {DEFAULT_STUDIO_CLIENT_OPTIONS} from '../../../../studioClient'
import {ArrayItemReferenceInput} from '../../../inputs/ReferenceInput/ArrayItemReferenceInput'
import {EditReferenceEvent} from '../../../inputs/ReferenceInput/types'
import {_InsertEvent} from '../../../inputs/arrays/ArrayOfObjectsInput/types'
import {InsertEvent} from '../../../inputs/arrays/ArrayOfObjectsInput/types'
import {useDocumentPreviewStore} from '../../../../datastores'
import {useClient, useSchema} from '../../../../hooks'
import {useReferenceInputOptions} from '../../contexts'
Expand Down Expand Up @@ -50,7 +50,7 @@ export interface SanityArrayItemReferenceInputProps
extends ObjectInputProps<Reference, ReferenceSchemaType> {
insertableTypes?: SchemaType[]
isSortable: boolean
onInsert?: (event: _InsertEvent) => void
onInsert?: (event: InsertEvent) => void
}

function useValueRef<T>(value: T): {current: T} {
Expand Down

0 comments on commit a4092b2

Please sign in to comment.