Skip to content

Commit

Permalink
refactor: use named export for schema package
Browse files Browse the repository at this point in the history
  • Loading branch information
rexxars committed Jan 31, 2023
1 parent 7fc1c29 commit 1746698
Show file tree
Hide file tree
Showing 25 changed files with 48 additions and 25 deletions.
2 changes: 1 addition & 1 deletion packages/@sanity/block-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sanity exec path/to/script.js
Let's start with a complete example:

```js
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {htmlToBlocks} from '@sanity/block-tools'

// Start with compiling a schema we can work against
Expand Down
2 changes: 1 addition & 1 deletion packages/@sanity/block-tools/test/fixtures/customSchema.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'

export default Schema.compile({
name: 'withCustomBlockType',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'

export default Schema.compile({
name: 'withDefaultBlockType',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React, {ForwardedRef, forwardRef, useCallback, useEffect} from 'react'
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'

import {defineArrayMember, defineField} from '@sanity/types'
import {PortableTextEditor, PortableTextEditable} from '../../index'
Expand Down
2 changes: 1 addition & 1 deletion packages/@sanity/portable-text-editor/src/utils/schema.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'

export function compileType(rawType: any) {
return Schema.compile({
Expand Down
2 changes: 1 addition & 1 deletion packages/@sanity/schema/example/test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import assert from 'assert'
import Schema from '../src/legacy/Schema'
import {Schema} from '../src/legacy/Schema'
import schemaDef from './schema-def'

const schema = new Schema(schemaDef)
Expand Down
5 changes: 4 additions & 1 deletion packages/@sanity/schema/src/_exports/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
export {default} from '../legacy/Schema'
import {Schema as NamedSchema, DeprecatedDefaultSchema} from '../legacy/Schema'

export default DeprecatedDefaultSchema
export const Schema = NamedSchema
export {type SchemaValidationResult} from '../sanity/typedefs'
22 changes: 21 additions & 1 deletion packages/@sanity/schema/src/legacy/Schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ function compileRegistry(schemaDef) {
/**
* @beta
*/
export default class Schema {
export class Schema {
_original: {name: string; types: any[]}
_registry: {[typeName: string]: any}

Expand Down Expand Up @@ -70,3 +70,23 @@ export default class Schema {
return Object.keys(this._registry)
}
}

/**
* @deprecated Use `import {Schema} from "@sanity/schema"` instead
*/
export class DeprecatedDefaultSchema extends Schema {
static compile(schemaDef: any): Schema {
return new DeprecatedDefaultSchema(schemaDef)
}

constructor(schemaDef: any) {
super(schemaDef)

const stack = new Error(
'The default export of `@sanity/schema` is deprecated. Use `import {Schema} from "@sanity/schema"` instead.'
).stack.replace(/^Error/, 'Warning')

// eslint-disable-next-line no-console
console.warn(stack)
}
}
2 changes: 1 addition & 1 deletion packages/@sanity/schema/test/legacy/schemas.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '../../src/legacy/Schema'
import {Schema} from '../../src/legacy/Schema'

import rawSchemas from './fixtures/schemas'

Expand Down
2 changes: 1 addition & 1 deletion packages/@sanity/validation/test/createSchema.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import SchemaBuilder from '@sanity/schema'
import {Schema as SchemaBuilder} from '@sanity/schema'
import {validateSchema, groupProblems} from '@sanity/schema/_internal'
import {Schema} from '@sanity/types'

Expand Down
2 changes: 1 addition & 1 deletion packages/@sanity/validation/test/infer.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {SanityClient} from '@sanity/client'
import SchemaBuilder from '@sanity/schema'
import {Schema as SchemaBuilder} from '@sanity/schema'
import {ObjectSchemaType, Rule, SanityDocument} from '@sanity/types'
import inferFromSchema from '../src/inferFromSchema'
import validateDocument from '../src/validateDocument'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import type {
IntrinsicTypeName,
} from '@sanity/types'
import {generateHelpUrl} from '@sanity/generate-help-url'
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import oneline from 'oneline'
import * as helpUrls from './helpUrls'
import {SchemaError} from './SchemaError'
Expand Down
2 changes: 1 addition & 1 deletion packages/sanity/src/core/form/__workshop__/_common/data.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import type {Schema as SchemaSchema} from '@sanity/types'
import {keyBy, mapValues} from 'lodash'
import getSimpleDummySchema from './schema/simpleDummySchema'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {render} from '@testing-library/react'
import React, {forwardRef, useImperativeHandle} from 'react'
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {LayerProvider, studioTheme, ThemeProvider, ToastProvider} from '@sanity/ui'
import {of} from 'rxjs'
import {noop} from 'lodash'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {ObjectSchemaType, Path} from '@sanity/types'
import {pathToString} from '../../../field'
import {prepareFormState} from '../formState'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {ConditionalProperty} from '@sanity/types'
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {prepareFormState} from '../formState'
import {DEFAULT_PROPS} from './shared'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {ConditionalProperty, ObjectSchemaType} from '@sanity/types'
import {prepareFormState} from '../formState'
import {DEFAULT_PROPS} from './shared'
Expand Down
2 changes: 1 addition & 1 deletion packages/sanity/src/core/schema/createSchema.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import SchemaBuilder, {type SchemaValidationResult} from '@sanity/schema'
import {Schema as SchemaBuilder, type SchemaValidationResult} from '@sanity/schema'
import {validateSchema, groupProblems} from '@sanity/schema/_internal'
import {Schema} from '@sanity/types'
import {inferFromSchema as inferValidation} from '@sanity/validation'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {renderHook} from '@testing-library/react'
import {defer, lastValueFrom, of} from 'rxjs'
import type {SearchTerms} from '..'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import type {CurrentUser, ObjectSchemaType} from '@sanity/types'
import type {SearchTerms} from '../../../../../search'
import {filterDefinitions} from '../definitions/defaultFilters'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import React from 'react'
import {filterDefinitions} from '../definitions/defaultFilters'
import {createFieldDefinitions, MAX_OBJECT_TRAVERSAL_DEPTH} from './createFieldDefinitions'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {SearchableType} from '../../../../../search'
import {filterDefinitions} from '../definitions/defaultFilters'
import {operatorDefinitions} from '../definitions/operators/defaultOperators'
Expand Down
2 changes: 1 addition & 1 deletion packages/sanity/src/core/templates/__tests__/schema.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import SchemaBuilder from '@sanity/schema'
import {Schema as SchemaBuilder} from '@sanity/schema'
import {Schema} from '@sanity/types'

const Icon = () => null
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'
import {ObjectSchemaType} from '@sanity/types'
import {applyOrderingFunctions, fieldExtendsType} from '../helpers'

Expand Down
2 changes: 1 addition & 1 deletion packages/sanity/test/cli/graphql/fixtures/test-studio.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Schema from '@sanity/schema'
import {Schema} from '@sanity/schema'

export default Schema.compile({
types: [
Expand Down

0 comments on commit 1746698

Please sign in to comment.