schema-dts & schema-dts-gen v0.7.4

Changes in schema-dts and schema-dts-gen

• Exported Enum variables are now marked as @deprecated and will be removed from a future version of schema-dts.

  This trims down the entire ~22KB output of the exported .js, which is helpful if tree-shaking isn't enabled in your bundler.

  See discussion in #131. PR #134

• Basic support for @graph nodes. #136

Changes in schema-dts

• Includes Schema.org v9.
• Diff from previous version: https://www.diffchecker.com/XXwxVX3w

schema-dts & schema-dts-gen v0.7.1

Changes in schema-dts and schema-dts-gen

• Add TypeScript 4.0 as a support peer dependency.

No diffs in schema-dts generated schema.

schema-dts & schema-dts-gen v0.7.0

Changelog

Changes in schema-dts

• Breaking Changes:
  • Explicitly-used enum values with "http://" are not removed, "https://" is only allowed. This is due to moving to -https variants, see schemaorg/schemaorg#2654
• Support Schema.org 9.0, including LearningResource, etc.

Changes in schema-dts-gen

• Breaking Changes:
  • #117 Use --ontology instead of --layer and --schema to pass URLs.

Generated Schema Diff: https://www.diffchecker.com/VxHU5970

schema-dts & schema-dts-gen v0.6.0

Changelog

Changes in schema-dts

• Support for "Reference-only types" (i.e. {"@id": "..."} objects) to previously-established objects. This allows users to define circular references in a "@graph". (see #107)
• Defines intermediate SchemaValue<T> for property values (see #104)
• Skips empty Base types under certain conditions. This shaves 500+ lines of output. (see #104)
• Make enums much more permissive (see #107)
  • allow relative Enum names when applicable
  • allow https://schema.org/ and http://schema.org/ IRIs for enum values
• Give Boolean similar characteristics as above.
• DataType now inherits up-to-date documentation from Schema.org definitions (See #107)
• Clean up how nested DataTypes are rendered, and support for types like PronounceableText which are data types that have values. (See #109)

Changes in schema-dts-gen

• Breaking Changes:
  • Property parsing is stricter on custom schema where rangeIncludes references a non-existent type.
  • Only types defined in ontology will be included in our class map and output. This means that a reference to e.g. 'Text' or 'DataType' would previously succeed, but now fails.
• Support for "Reference-only types" (i.e. {"@id": "..."} objects) to previously-established objects. This allows users to define circular references in a "@graph". (see #107)
• Defines intermediate SchemaValue<T> for property values (see #104)
• Skips empty Base types under certain conditions. This shaves 500+ lines of output. (see #104)
• Prunes DataType objects not referenced in ontology. (see #107)
• Make enums much more permissive (see #107)
  • allow relative Enum names when applicable
  • allow HTTP and HTTPS protocols when the enum IRI is HTTP (when IRI is HTTPS don't allow HTTP).
• Implement Boolean as a regular enum (with above characteristics) (See #107)
• DataType now inherits live documentation from Schema.org rather than saved "well-known" documentations. (See #107)
• Clean up how nested DataTypes are rendered, and support for types like PronounceableText which are data types that have values. (See #109)

Generated Schema Diff: https://www.diffchecker.com/sxFsWqKU

schema-dts & schema-dts-gen v0.5.3

Changelog

Changes in schema-dts

• Includes Schema.org version 8.0, see latest additions and changes here
• Defines intermediate (not (yet) exported) "Leaf" type, as described in the initial Modeling Schema.org Schema with TypeScript article, which should help with performance.
• Cleans up unnecessary parentheses and groupings in output .d.ts.

Changes in schema-dts-gen

• Generates (not yet exported) "Leaf" types, per above.
• Generates cleaner typings, without unnecessary parentheses and groupings.
• Migrated development stack for the generator, including jest, better baseline tests, auto-linting, etc.

Generated Schema Diff: https://www.diffchecker.com/yYmnqHv4

schema-dts v0.5.2

Changelog

Changes in schema-dts

• Includes Schema.org version 7.0, see latest additions and changes here

Generated Schema Diff: https://www.diffchecker.com/nW7zEf0H

schema-dts & schema-dts-gen v0.5.1

Changelog

Changes in schema-dts

• Includes Schema.org version 6.0, see latest additions and changes here

Changes schema-dts-gen

• Behavioral changes for generator in certain edge cases (these caused no diff for the mainline schema.org version)
  • Fix: 3111e78 When using --nodeprecated: Prune deprecated types from their parent nodes.
  • Fix: 3beea73 For terms that are both a object/class/node type and also an enum value, handle them properly regardless of the ordering in which the triples are declared.
• With this, the codebase becomes much more testable.

Generated Schema Diff: https://www.diffchecker.com/f1XtqAtH

schema-dts & schema-dts-gen v0.5.0

Changelog

Changes in schema-dts and schema-dts-gen

There are some backwards-incompatible changes that make reasoning about types much simpler:

• Properties on objects are now labeled as readonly arrays. (PR #52)
• Removes deprecated enum style; the new Enum import style has been available since 0.4.4 (PR #53)
  • See initial PR describing the new way of using enums here: #43

Generated Schema Diff: https://www.diffchecker.com/CWi7lyvn

schema-dts & schema-dts-gen v0.4.5

Changelog

Changes in schema-dts and schema-dts-gen

• Schema.org's Person, Place, EntryPoint, and Organization can be defined as strings. (PR #47 bug #45 and #37)

Generated Schema Diff: https://www.diffchecker.com/ZxNYBRKo

schema-dts & schema-dts-gen v0.4.4

Changelog

Changes in schema-dts

• Updates Schema.org to version 5.0.

Changes in schema-dts and schema-dts-gen

• Revamp Enum type generation (PR #43)
  • Now, an enum can be assigned as a string IRI instead of just the TypeScript enum value.
  • An enum, e.g. MedicalOrganizaitonType is now available as that name, rather than MedicalOrganizationTypeEnum. Type and property aliases were added to make the transition easier.

Diff from previous version: https://www.diffchecker.com/4L9ptmk7