.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '21 8 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

CHANGELOG.md

@@ -1,7 +1,22 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## 1.0.0 (2021-01-13)
+
+
+### Features
+
+* **dsl:** add better API for definitions with schema() ([6e653dd](https://github.com/wittydeveloper/functional-json-schema/commit/6e653dd27cfc788871f5da9351ce6dd89aa89979))
+* **dsl:** add schema.definition() API ([81f48b5](https://github.com/wittydeveloper/functional-json-schema/commit/81f48b5faa0ee7ef749d3f5c32f7e89b114505c6))
+* **lib:** initial draft ([a2c704d](https://github.com/wittydeveloper/functional-json-schema/commit/a2c704ddd1cc6aed35ab664a8b330f11f749c4e1))
+
+
+### Bug Fixes
+
+* **lib:** enum ([8a8339a](https://github.com/wittydeveloper/functional-json-schema/commit/8a8339aa7bc81a65f330b1e01a6d84a9954f6fd7))
+* **lib:** minor fixes ([2f6625e](https://github.com/wittydeveloper/functional-json-schema/commit/2f6625e644f4e4e7306feeb0848aa9d523688fcf))
+
 <a name="0.0.2-3"></a>
 ## [0.0.2-3](https://github.com/wittydeveloper/functional-json-schema/compare/v0.0.2-2...v0.0.2-3) (2018-05-31)
 

README.md

@@ -3,22 +3,23 @@ Build a JSON Schema with functions
 
 
 
-**target API for 1.0**
+## Schema DSL
+
+### Simple schema
 
 ```js
 
 import * as schema from 'functional-json-schema';
 
-const JSONschema = schema.schema({
-    person: {
-        friends: schema.types.arrayOf(schema.types.definition('user')),
+const JsonSchema = schema.schema({
+  person: {
+    friends: schema.types.arrayOf(schema.types.definition('user')),
         id: 'string*',
         friend_ids: schema.types.arrayOf(schema.types.definition('User'), { required: true }),
     }
 }, null, { schema: 'http://json-schema.org/draft-06/schema#' })
 
 /*
-
 => {
   $schema: 'http://json-schema.org/draft-06/schema#',
   type: 'object',
@@ -29,7 +30,7 @@ const JSONschema = schema.schema({
         friends: {
           "type": "array",
           "items": {
-              "$ref": "#/definitions/User"
+            "$ref": "#/definitions/User"
           }
         },
         (...)
@@ -40,3 +41,127 @@ const JSONschema = schema.schema({
 }
 */
 ```
+### Schema with definitions
+
+```js
+
+import * as schema from 'functional-json-schema';
+
+const schemaWithDefinitions = schema(
+  {
+    community_list: {
+      portfolio_ids: types.arrayOf("string", { required: true }),
+      project_id: types.type("string", { required: true }),
+      status: types.enumOf("active", "inactive"),
+      user: types.anyOf(types.definition("User"), types.definition("Admin")),
+    },
+  }, {
+    User: {
+      firstName: types.type("string"),
+      lastName: types.type("string"),
+      jobTitle: types.type("string"),
+      companyId: types.type("string"),
+    },
+  },
+  { schema: 'http://json-schema.org/draft-06/schema#' }
+);
+
+/*
+=> {
+  $schema: 'http://json-schema.org/draft-06/schema#',
+  type: "object",
+  properties: {
+    community_list: {
+      type: "object",
+      properties: {
+        portfolio_ids: {
+          type: "array",
+          items: {
+            type: "string",
+          },
+        },
+        project_id: {
+          type: "string",
+        },
+        user: {
+          anyOf: [
+            { $ref: "#/definitions/User" },
+            { $ref: "#/definitions/Admin" },
+          ],
+        },
+        status: {
+          enum: ["active", "inactive"],
+        },
+      },
+      required: ["portfolio_ids", "project_id"],
+    },
+  },
+  definitions: {
+    User: {
+      type: "object",
+      properties: {
+        firstName: {
+          type: "string",
+        },
+        lastName: {
+          type: "string",
+        },
+        jobTitle: {
+          type: "string",
+        },
+        companyId: {
+          type: "string",
+        },
+      },
+      required: [],
+    },
+  }
+}
+*/
+```
+
+## standalone definition DSL
+
+```js
+
+import * as schema from 'functional-json-schema';
+
+const JsonSchemaDefinition = schema.definition(
+  'User',
+  {
+    firstName: schema.types.type('string'),
+    lastName: schema.types.type('string'),
+    jobTitle: schema.types.type('string'),
+    companyId: schema.types.type('string'),
+  },
+  { title: "User", description: "Fake User Object" }
+)
+
+/*
+=> {
+  "$ref": "#/definitions/User",
+  "definitions": {
+      "User": {
+          "type": "object",
+          "title": "User",
+          "description": "Fake User Object",
+          "properties": {
+              "firstName": {
+                  "type": "string"
+              },
+              "lastName": {
+                  "type": "string"
+              },
+              "jobTitle": {
+                  "type": "string"
+              },
+              "companyId": {
+                  "type": "string"
+              }
+          },
+          required: [],
+      }
+  }
+}
+*/
+```