v0.25.0

General

• CHANGE: remove the default property from most schemas (#232)
• CHANGE: make type field read-only (#88)
• DOCS: add info about adherence to schema descriptions to best practices
• DOCS: indicate top-level schemas (#201)

Access

• CHANGE: Access.AILLA defaults to depository control
• CHANGE: Access.ELAR defaults to Researcher

Bundle

• CHANGE: Bundle.name must be in at least one language

Language

• CHANGE: Language.name must be in at least one language

Lexeme

• NEW: Lexeme.language
• CHANGE: Lexeme.lemma must be in at least one language
• CHANGE: Lexeme.senses must have at least one sense
• CHANGE: Lexeme.gloss must be in at least one language
• DOCS: clarification of use of Lexeme.citationForm

Location

• CHANGE: Location.geoJSON references the official GeoJSON schema externally (#228)
• CHANGE: Location.name must be in at least one language

Morpheme

• CHANGE: Morpheme.gloss must be in at least one language
• CHANGE: Morpheme.transcription must be in at least one language

Orthography

• CHANGE: Orthography.graphemes must have at least one grapheme
• CHANGE: Orthography.graphemes.form must be a non-empty String
• CHANGE: Orthography.name must be in at least one language

Phoneme

• CHANGE: Phoneme.airstream defaults to pulmonic

Text

• CHANGE: Text.title must be in at least one language
• CHANGE: Text.utterances must have at least one utterance

Translation

• CHANGE: Translation.translationType defaults to free

Utterance

• CHANGE: Utterance.transcript must be in at least one orthography
• CHANGE: Utterance.transcription must be in at least one orthography
• CHANGE: Utterance.translation must be in at least one language

Word

• CHANGE: Word.transcription must be in at least one orthography

v0.24.0

General

• CHANGE: remove the default property from most schemas (#232)
• CHANGE: make type field read-only (#88)
• DOCS: add info about adherence to schema descriptions to best practices
• DOCS: indicate top-level schemas (#201)

Access

• CHANGE: Access.AILLA defaults to depository control
• CHANGE: Access.ELAR defaults to Researcher

Bundle

• CHANGE: Bundle.name must be in at least one language

Language

• CHANGE: Language.name must be in at least one language

Lexeme

• NEW: Lexeme.language
• CHANGE: Lexeme.lemma must be in at least one language
• CHANGE: Lexeme.senses must have at least one sense
• CHANGE: Lexeme.gloss must be in at least one language
• DOCS: clarification of use of Lexeme.citationForm

Location

• CHANGE: Location.geoJSON references the official GeoJSON schema externally (#228)
• CHANGE: Location.name must be in at least one language

Morpheme

• CHANGE: Morpheme.gloss must be in at least one language
• CHANGE: Morpheme.transcription must be in at least one language

Orthography

• CHANGE: Orthography.graphemes must have at least one grapheme
• CHANGE: Orthography.graphemes.form must be a non-empty String
• CHANGE: Orthography.name must be in at least one language

Phoneme

• CHANGE: Phoneme.airstream defaults to pulmonic

Text

• CHANGE: Text.title must be in at least one language
• CHANGE: Text.utterances must have at least one utterance

Translation

• CHANGE: Translation.translationType defaults to free

Utterance

• CHANGE: Utterance.transcript must be in at least one orthography
• CHANGE: Utterance.transcription must be in at least one orthography
• CHANGE: Utterance.translation must be in at least one language

Word

• CHANGE: Word.transcription must be in at least one orthography

v0.23.0

Notable Changes

• CHANGE: update schemas to JSON Schema Draft 07 (#96)
• CHANGE: Reference > BibliographicReference (#145)
• CHANGE: Sentence > Utterance (#122)
• REMOVE: DateCreated (#206)
• REMOVE: DateModified (#206)
• REMOVE: DateRecorded (#206)
• REMOVE: Lexicon (#116)
• REMOVE: URL (#148)
• NEW: DatabaseReference (#141)
• REMOVE: LexemeReference (#141)

General

• CHANGE: update schemas to JSON Schema Draft 07 (#96)
• CHANGE: id > $id (#96)
• CHANGE: date fields no longer refer to independent date schemas (#206)
• CHANGE: Reference > BibliographicReference (#145)
• CHANGE: Sentence > Utterance (#122)
• REMOVE: DateCreated (#206)
• REMOVE: DateModified (#206)
• REMOVE: DateRecorded (#206)
• REMOVE: Lexicon (#116)
• REMOVE: URL (#148)
• NEW: add link property to top-level schemas (#210)
• NEW: DatabaseReference (#141)
• REMOVE: LexemeReference (#141)
• FIX: MultiLangString instances are no longer accidentally restricted to Objects (#173)
• DEV: run upload script during Travis build (#217)
• DEV: publish tagged commits to npm from Travis (#218)
• DEP: ajv@6.5.4 (#96)

Bibliographic Reference

• CHANGE: BibliographicReference.type now refers to the DLx type (#147)
• CHANGE: BibliographicReference.doi must be a valid DOI (#173)
• CHANGE: BibliographicReference.edition must be an integer >= 1 (#173)
• CHANGE: BibliographicReference.title must be a non-empty String (#173)
• CHANGE: BibliographicReference.volume must be an integer >= 1 (#173)
• NEW: BibliographicReference.publicationType (#147)

Bundle

• CHANGE: Bundle.persons > Bundle.people (#203)
• CHANGE: Bundle.locations items are now DatabaseReferences (#141)
• CHANGE: Bundle.media items are now DatabaseReferences (#141)
• CHANGE: Bundle.texts items are now DatabaseReferences (#141)

GeoJSON Object

• CHANGE: use official GeoJSON schema instead of the DLx version (#228)

Language

• REMOVE: Language.lexemes (#141)
• REMOVE: Language.texts (#141)
• CHANGE: Language.additionalNames allows for Strings or Objects (#194)
• CHANGE: Language.people items are now DatabaseReferences (#141)
• CHANGE: Language.locations items are now DatabaseReferences (#141)

Lexeme

• CHANGE: Lexeme.lexicalRelations requires "relation" (#137)
• CHANGE: Lexeme.senses.lexicalRelations requires "relation" (#137)
• CHANGE: Lexeme.variants must have "variantType" specified (#223)
• CHANGE: Lexeme.senses.variants must have "variantType" specified (#223)
• CHANGE: Lexeme.allomorphs.environments must be non-empty Strings (#173)
• CHANGE: Lexeme.features must be non-empty Strings (#173)
• CHANGE: Lexeme.senses.sources must be non-empty Strings (#173)
• CHANGE: Lexeme.examples items are now DatabaseReferences (#141)
• CHANGE: Lexeme.includedIn items are now DatabaseReferences (#141)
• CHANGE: Lexeme.lexicalRelations items are now DatabaseReferences (#141)
• CHANGE: Lexeme.variantOf is now a DatabaseReference (#141)
• CHANGE: Lexeme.variants items are now DatabaseReferences (#141)
• CHANGE: Lexeme.senses.lexicalRelations items are now DatabaseReferences (#141)
• CHANGE: Lexeme.senses.variantOf is now a DatabaseReference (#141)
• CHANGE: Lexeme.senses.variants items are now DatabaseReferences (#141)
• CHANGE: Lexeme.media items are now DatabaseReferences (#141)

Lexeme Reference

• CHANGE: LexemeReference.sense must be an integer >= 1 (#173)

Media

• CHANGE: Media.contentType must be a valid MIME type (#144)
• CHANGE: Media.endTime must be >= 0.001 (#173)
• CHANGE: Media.fileSize must be an integer >= 1 (#173)
• CHANGE: Media.length must be >= 0.001 (#173)
• CHANGE: Media.startTime must be >= 0 (#173)
• CHANGE: Media.creator is now a DatabaseReference (#141)
• CHANGE: Media.languages items are now DatabaseReferences (#141)
• CHANGE: Media.location is now a DatabaseReference (#141)
• CHANGE: Media.people items are now DatabaseReferences (#141)

Morpheme

• CHANGE: Morpheme.lexeme is now a DatabaseReference (#141)

MultiLangString

• CHANGE: allow MultiLangString to be an Object or, if only in English, a String (#195)
• CHANGE: require MultiLangString to have at least one language specified (#173)

Note

• CHANGE: Note.text must be a non-empty String (#173)

Orthography

• NEW: Orthography.url (#212)
• CHANGE: Orthography.graphemes.pronunciations must be non-empty Strings (#173)
• CHANGE: Orthography.punctuation must be non-empty Strings (#173)

Person

• CHANGE: Person.languages.ageLearned must be an integer >= 0 (#173)
• CHANGE: Person.roles must be non-empty Strings (#173)
• CHANGE: Person.birthPlace is now a DatabaseReference (#141)

Phoneme

• CHANGE: Phoneme.ipa must be a non-empty String (#173)

Utterance

• CHANGE: Utterance.endTime must be >= 0.001 (#173)
• CHANGE: Utterance.startTime must be >= 0 (#173)

Word

• CHANGE: Word.endTime must be >= 0.001 (#173)
• CHANGE: Word.startTime must be >= 0 (#173)
• CHANGE: Word.phonemes.endTime must be >= 0.001 (#173)
• CHANGE: Word.phonemes.startTime must be >= 0 (#173)

v0.1.12

This is a test release. It is testing automated deployment with Travis CI.

Test Release 1

This is a release for testing automated publication to npm.

v0.22.0

Description

This release contains a large number of non-breaking changes, most of which are new properties on various schemas. It also loosens the restrictions on certain schemas, and makes numerous updates to the documentation. Finally, it introduces two new schemas: Annotation and Translation.

Noteable Changes

• NEW: Annotation schema! (#81)
• NEW: Translation schema! (#149)
• NEW: schemas now support ID fields explicitly (#142)
• CHANGE: support both date and date-time formats (#202)

Changelog

Schemas

• NEW: Annotation schema (#81)
• NEW: Translation schema (#149)
• NEW: schemas now support ID fields explicitly (#142)
• CHANGE: support both date and date-time formats (#202)

Bundle

NEW: Bundle.id (#142)

DateCreated

• CHANGE: support both date and date-time formats (#202)

DateModified

• CHANGE: support both date and date-time formats (#202)

DateRecorded

• CHANGE: support both date and date-time formats (#202)

Language

• NEW: Language.access (#109)
• NEW: Language.contributors (#110)
• NEW: Language.id (#142)
• NEW: Language.lexemes (#115)
• NEW: Language.notes (#111)
• NEW: Language.references (#112)
• NEW: Language.tags (#113)
• NEW: Language.texts (#114)

Lexeme

• CHANGE: restrict values of Lexeme.notes.noteType (#186)
• NEW: Lexeme.id (#142)
• DOCS: update examples in description of Lexeme.morphemeType (#121)

Lexicon

• FIX: Lexicon.contributors no longer refers to non-existent Contributor schema
• NEW: Lexicon.id (#142)

Location

• NEW: Location.id (#142)

Media

• NEW: Media.id (#142)

MultiLangString

• CHANGE: MultiLangString may not have additional properties

Note

• NEW: Note.tags (#156)
• CHANGE: Note.noteType is no longer required (except for Lexeme.notes) (#185)

Orthography

• NEW: Orthography.id (#142)

Person

• NEW: Person.id (#142)

Reference

• NEW: Reference.doi (#188)
• NEW: Reference.id (#142)

Sentence

• CHANGE: Sentence.translation is now a Translation object (#149)
• NEW: Sentence.id (#142)

Text

• NEW: Text.annotations (#81)
• NEW: Text.id (#142)

Word

• CHANGE: Word.translation is now a Translation object (#149)
• NEW: Word.startTime
• NEW: Word.endTime
• NEW: Word.phonemes.startTime
• NEW: Word.phonemes.endTime

Documentation

• add links to developer readme in user readme
• add note about versioning in development to developer readme
• add release steps for maintainers to CONTRIBUTING.md
• minor updates to schema descriptions
• organize best practices in developer readme by topic
• update badges in user readme

v0.21.1

This is a patch release with several hotfixes, and numerous updates to the project documentation and schema descriptions.

Notable Changes

• A new developer readme!
• FIX: value of "main" in package.json
• FIX: allow negative values for Reference.year (#181)
• FIX: Text.contributors now references the Person schema instead of the non-existent Contributor schema (#118)
• FIX: Text.genre is now a standalone schema instead of referencing the non-existent Genre schema (#172)
• REMOVE: Text.status (#117)

General

• SCHEMAS: reorder properties in schemas more logically (#151)
• FIX: value of "main" in package.json
• FIX: incorrect media types for schemas in Azure Storage (#154)
• FIX: update schema versions from commit cc8bac3 (#175)
• DOCS: move project documentation to /.github folder (except README.md, which is needed in the project root for npm) (#127)
• DOCS: change LICENSE > LICENSE.md (#127)
• DOCS: point Code of Conduct to general DLx one (#160)
• DOCS: remove references to Slack channel (#127)
• DOCS: add developer readme (closes #143)
• DOCS: move user readme to /.github folder (#143)
• DOCS: add paragraph about Austin Principles to user readme (#124)
• DOCS: add TOC to user readme (#127)
• DOCS: add pull request template (#157)
• DOCS: add section to CONTRIBUTING.md on GitHub Flow / Branching Model (#127)
• DOCS: improve the introductory paragraph of user readme (#127)
• DOCS: fix broken links in user readme (#159, #168)
• DOCS: update testing guidelines in CONTRIBUTING.md
• DOCS: lowercase "object" when referring to a schema
• DOCS: update CONTRIBUTING.md with info about empty optional properties (cf. #173)
• DOCS: update PR template with reminder about schema versions
• DEV: convert YAML files before running tests or upload script
• DEV: don't overwrite existing versions of files in Azure Storage (#176)
• DEV: remove extraneous log statements from upload script

Media

• FIX: capitalization of MultiLangString

Reference

• FIX: allow negative values for Reference.year (#181)

Text

• CHANGE: clarify that Text.contributors includes speakers (#119)
• FIX: Text.contributors now references the Person schema instead of the non-existent Contributor schema (#118)
• FIX: Text.genre is now a standalone schema instead of referencing the non-existent Genre schema (#172)
• REMOVE: Text.status (#117)

v0.21.0

General

• VERSION: v0.21.0
• IMPROVE: rewrite schemas in YAML (#123)
• CHANGE: minor changes to description fields of schemas
• DOCS: update CONTRIBUTING.md (see #127)
• DEV: add build script (npm run build)
• DEP: azure-storage@2.10.1
• DEP: jasmine@3.2.0

Location

• CHANGE: reference GeoJSON schema from DLx directly, rather than schemastore.org

Orthography

• FIX: type for "name" field incorrectly set to "string" instead of "object"

v0.20.0

This release changes the name property of the Language schema to a MultiLangString, and updates the Language schema to v6.0.0.

v0.19.0

NEW Language.name
NEW Language.additionalNames
REMOVED Language.names
TESTS Add sample data for some schemas
DEV Publish publicly by default