Root $id not overrided by S.extend (#54)

* Breaking change: Move to S.object().extend(schema)

Author: aboutlo

.travis.yml

@@ -1,6 +1,7 @@
 language: node_js
 
 node_js:
-- "11.10.1" # tmp workaround https://stackoverflow.com/questions/55059748/travis-jest-typeerror-cannot-assign-to-read-only-property-symbolsymbol-tostr
+- "13"
+- "11"
 - "10"
 - "8"

README.md

@@ -12,7 +12,6 @@ A fluent API to generate JSON schemas (draft-07) for Node.js and browser.
 - Runtime errors for invalid options or keywords misuse
 - Javascript constants can be used in the JSON schema (e.g. _enum_, _const_, _default_ ) avoiding discrepancies between model and schema
 - Typescript definitions
-- Zero dependencies
 - Coverage 99%
 
 ## Install
@@ -289,10 +288,11 @@ const userBaseSchema = S.object()
   .prop('username', S.string())
   .prop('password', S.string())
 
-const userSchema = S.extend(userBaseSchema)
+const userSchema = S.object()
   .prop('id', S.string().format('uuid'))
   .prop('createdAt', S.string().format('time'))
   .prop('updatedAt', S.string().format('time'))
+  .extend(userBaseSchema)
 
 console.log(userSchema)
 ```

package.json

@@ -62,5 +62,8 @@
     "lodash.merge": "^4.6.2",
     "prettier": "^1.14.3",
     "typescript": "^3.2.2"
+  },
+  "dependencies": {
+    "deepmerge": "^4.2.2"
   }
 }

src/BaseSchema.js

@@ -365,6 +365,7 @@ const BaseSchema = (
    * @private It returns the internal schema data structure
    * @returns {object}
    */
+  // TODO LS if we implement S.raw() we can drop this hack because from a JSON we can rebuild a fluent-schema
   _getState: () => {
     return schema
   },

src/FluentSchema.d.ts

@@ -114,6 +114,7 @@ export interface ObjectSchema extends BaseSchema<ObjectSchema> {
   patternProperties: (options: PatternPropertiesOptions) => ObjectSchema
   dependencies: (options: DependenciesOptions) => ObjectSchema
   propertyNames: (value: JSONSchema) => ObjectSchema
+  extend: (schema: ObjectSchema) => ObjectSchema
 }
 
 export interface MixedSchema<T> extends BaseSchema<T> {
@@ -145,7 +146,6 @@ export interface S extends BaseSchema<S> {
   array: () => ArraySchema
   object: () => ObjectSchema
   null: () => NullSchema
-  extend: (schema: ObjectSchema) => ObjectSchema
   //FIXME LS we should return only a MixedSchema
   mixed: <T>(types: TYPE[]) => MixedSchema<T> & any
 }

src/FluentSchema.js

@@ -1,4 +1,6 @@
 'use strict'
+const merge = require('deepmerge')
+
 const { FORMATS, TYPES } = require('./utils')
 
 const { BaseSchema } = require('./BaseSchema')
@@ -170,16 +172,6 @@ module.exports = {
   string: () => S().string(),
   mixed: types => S().mixed(types),
   object: () => S().object(),
-  extend: schema => {
-    if (!schema) {
-      throw new Error("Schema can't be null or undefined")
-    }
-    if (!schema.isFluentSchema) {
-      throw new Error("Schema isn't FluentSchema type")
-    }
-    const state = schema._getState()
-    return S().object(state)
-  },
   array: () => S().array(),
   boolean: () => S().boolean(),
   integer: () => S().integer(),

src/ObjectSchema.js

@@ -1,4 +1,5 @@
 'use strict'
+const merge = require('deepmerge')
 const { BaseSchema } = require('./BaseSchema')
 const {
   omit,
@@ -246,6 +247,19 @@ const ObjectSchema = ({ schema = initialState, ...options } = {}) => {
       })
     },
 
+    extend: base => {
+      if (!base) {
+        throw new Error("Schema can't be null or undefined")
+      }
+      if (!base.isFluentSchema) {
+        throw new Error("Schema isn't FluentSchema type")
+      }
+      const state = base._getState()
+      const extended = merge(state, schema)
+
+      return ObjectSchema({ schema: extended, ...options })
+    },
+
     /**
      * The "definitions" keywords provides a standardized location for schema authors to inline re-usable JSON Schemas into a more general schema.
      * There are no restrictions placed on the values within the array.

src/ObjectSchema.test.js

@@ -554,13 +554,21 @@ describe('ObjectSchema', () => {
   describe('extend', () => {
     it('extends a simple schema', () => {
       const base = S.object()
+        .id('base')
+        .title('base')
         .additionalProperties(false)
         .prop('foo', S.string().minLength(5))
 
-      const extended = S.extend(base).prop('bar', S.number())
+      const extended = S.object()
+        .id('extended')
+        .title('extended')
+        .prop('bar', S.number())
+        .extend(base)
 
       expect(extended.valueOf()).toEqual({
         $schema: 'http://json-schema.org/draft-07/schema#',
+        $id: 'extended',
+        title: 'extended',
         additionalProperties: false,
         properties: {
           foo: {
@@ -576,6 +584,7 @@ describe('ObjectSchema', () => {
     })
     it('extends a nested schema', () => {
       const base = S.object()
+        .id('base')
         .additionalProperties(false)
         .prop(
           'foo',
@@ -590,10 +599,14 @@ describe('ObjectSchema', () => {
         .prop('bol', S.boolean().required())
         .prop('num', S.integer().required())
 
-      const extended = S.extend(base).prop('bar', S.number())
+      const extended = S.object()
+        .id('extended')
+        .prop('bar', S.number())
+        .extend(base)
 
       expect(extended.valueOf()).toEqual({
         $schema: 'http://json-schema.org/draft-07/schema#',
+        $id: 'extended',
         additionalProperties: false,
         properties: {
           foo: {
@@ -623,14 +636,63 @@ describe('ObjectSchema', () => {
         type: 'object',
       })
     })
+    it('extends a schema with definitions', () => {
+      const base = S.object()
+        .id('base')
+        .additionalProperties(false)
+        .definition('def1', S.object().prop('some'))
+        .definition('def2', S.object().prop('somethingElse'))
+        .prop(
+          'foo',
+          S.object().prop(
+            'id',
+            S.string()
+              .format('uuid')
+              .required()
+          )
+        )
+        .prop('str', S.string().required())
+        .prop('bol', S.boolean().required())
+        .prop('num', S.integer().required())
+
+      const extended = S.object()
+        .id('extended')
+        .definition('def1', S.object().prop('someExtended'))
+        .prop('bar', S.number())
+        .extend(base)
+
+      expect(extended.valueOf()).toEqual({
+        $schema: 'http://json-schema.org/draft-07/schema#',
+        definitions: {
+          def1: { type: 'object', properties: { someExtended: {} } },
+          def2: { type: 'object', properties: { somethingElse: {} } },
+        },
+        type: 'object',
+        $id: 'extended',
+        additionalProperties: false,
+        properties: {
+          foo: {
+            type: 'object',
+            properties: { id: { type: 'string', format: 'uuid' } },
+            required: ['id'],
+          },
+          str: { type: 'string' },
+          bol: { type: 'boolean' },
+          num: { type: 'integer' },
+          bar: { type: 'number' },
+        },
+        required: ['str', 'bol', 'num'],
+      })
+    })
+
     it('throws an error if a schema is not provided', () => {
       expect(() => {
-        S.extend()
+        S.object().extend()
       }).toThrow("Schema can't be null or undefined")
     })
     it('throws an error if a schema is not provided', () => {
       expect(() => {
-        S.extend('boom!')
+        S.object().extend('boom!')
       }).toThrow("Schema isn't FluentSchema type")
     })
   })

src/example.js

@@ -113,10 +113,11 @@ const userBaseSchema = S.object()
   .prop('username', S.string())
   .prop('password', S.string())
 
-const userSchema = S.extend(userBaseSchema)
+const userSchema = S.object()
   .prop('id', S.string().format('uuid'))
   .prop('createdAt', S.string().format('time'))
   .prop('updatedAt', S.string().format('time'))
+  .extend(userBaseSchema)
   .valueOf()
 
 console.log(userSchema.valueOf())

src/types/index.ts

@@ -53,18 +53,19 @@ const schema = S.object()
   .writeOnly(true)
   .valueOf()
 
-console.log(JSON.stringify(schema))
-console.log(S.object().isFluentSchema)
+console.log('example:\n', JSON.stringify(schema))
+console.log('isFluentSchema:', S.object().isFluentSchema)
 
 const userBaseSchema = S.object()
   .additionalProperties(false)
   .prop('username', S.string())
   .prop('password', S.string())
 
-const userSchema = S.extend(userBaseSchema)
+const userSchema = S.object()
   .prop('id', S.string().format('uuid'))
   .prop('createdAt', S.string().format('time'))
   .prop('updatedAt', S.string().format('time'))
+  .extend(userBaseSchema)
   .valueOf()
 
-console.log('\n user:', JSON.stringify(userSchema))
+console.log('user:\n', JSON.stringify(userSchema))