chore: rename to @stoplight/json-schema-sampler

Author: P0lip

Diff for: .gitignore

@@ -32,3 +32,6 @@ bower_components
 # Users Environment Variables
 .lock-wscript
 package-lock.json
+
+# JetBrains IDEs
+.idea/

Diff for: LICENSE

@@ -1,5 +1,28 @@
 The MIT License (MIT)
 
+Copyright (c) 2021 Stoplight <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+The MIT License (MIT)
+
 Copyright (c) 2017 Roman Hotsiy <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

Diff for: README.md

@@ -1,10 +1,11 @@
-# openapi-sampler
+# @stoplight/json-schema-sampler
 
-[![Travis build status](http://img.shields.io/travis/Redocly/openapi-sampler.svg?style=flat)](https://travis-ci.org/Redocly/openapi-sampler) [![Coverage Status](https://coveralls.io/repos/Redocly/openapi-sampler/badge.svg?branch=master&service=github)](https://coveralls.io/github/Redocly/openapi-sampler?branch=master) [![Dependency Status](https://david-dm.org/Redocly/openapi-sampler.svg)](https://david-dm.org/Redocly/openapi-sampler) [![devDependency Status](https://david-dm.org/Redocly/openapi-sampler/dev-status.svg)](https://david-dm.org/Redocly/openapi-sampler#info=devDependencies)
+It's a fork of [openapi-sampler](https://github.com/Redocly/openapi-sampler) by Redocly, with focus on supporting JSON Schema Draft 6.
 
-Tool for generation samples based on OpenAPI payload/response schema
+Tool for generation samples based on JSON Schema Draft 6.
 
 ## Features
+
 - deterministic (given a particular input, will always produce the same output)
 - Supports `allOf`
 - Supports `additionalProperties`
@@ -28,22 +29,22 @@ Tool for generation samples based on OpenAPI payload/response schema
 
 Install using [npm](https://docs.npmjs.com/getting-started/what-is-npm)
 
-    npm install openapi-sampler --save
+    npm install @stoplight/json-schema-sampler --save
 
 or using [yarn](https://yarnpkg.com)
 
-    yarn add openapi-sampler
+    yarn add @stoplight/json-schema-sampler
 
 Then require it in your code:
 
 ```js
-var OpenAPISampler = require('openapi-sampler');
+const JSONSchemaSampler = require('@stoplight/json-schema-sampler');
 ```
 
 ## Usage
-#### `OpenAPISampler.sample(schema, [options], [spec])`
+#### `JSONSchemaSampler.sample(schema, [options], [spec])`
 - **schema** (_required_) - `object`
-A [OpenAPI Schema Object](http://swagger.io/specification/#schemaObject)
+A JSON Schema Draft 6 document.
 - **options** (_optional_) - `object`
 Available options:
   - **skipNonRequired** - `boolean`
@@ -58,8 +59,8 @@ Available options:
 
 ## Example
 ```js
-const OpenAPISampler = require('.');
-OpenAPISampler.sample({
+const JSONSchemaSampler = require('@stoplight/json-schema-sampler');
+JSONSchemaSampler.sample({
   type: 'object',
   properties: {
     a: {type: 'integer', minimum: 10},

Diff for: gulp-tasks/build.js

@@ -11,7 +11,7 @@ function build() {
   const $ = global.$;
 
   return browserify({
-      standalone: 'OpenAPISampler',
+      standalone: 'JSONSchemaSampler',
       entries: [path.join('src', config.entryFileName + '.js')]
     })
     .transform('babelify', {presets: ['@babel/preset-env']})

Diff for: gulp-tasks/config.js

@@ -2,8 +2,8 @@ import manifest  from '../package.json';
 import path from 'path';
 
 module.exports = {
-  entryFileName: 'openapi-sampler',
-  mainVarName: 'OpenAPISampler',
+  entryFileName: 'json-schema-sampler',
+  mainVarName: 'JSONSchemaSampler',
   mainFile: manifest.main,
   destinationFolder: path.dirname(manifest.main),
   exportFileName: path.basename(manifest.main, path.extname(manifest.main))

Diff for: index.html

@@ -1 +1 @@
-<script src="dist/openapi-sampler.js"> </script>
+<script src="dist/json-schema-sampler.js"> </script>

Diff for: package.json

@@ -1,9 +1,9 @@
 {
-  "name": "openapi-sampler",
-  "version": "1.0.0-beta.18",
-  "description": "Tool for generation samples based on OpenAPI payload/response schema",
-  "main": "dist/openapi-sampler.js",
-  "module": "src/openapi-sampler.js",
+  "name": "@stoplight/json-schema-sampler",
+  "version": "1.0.0",
+  "description": "Tool for generation samples based on JSON Schema Draft 6",
+  "main": "dist/json-schema-sampler.js",
+  "module": "src/json-schema-sampler.js",
   "scripts": {
     "test": "gulp",
     "lint": "gulp lint",
@@ -16,21 +16,25 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/APIs-guru/openapi-sampler.git"
+    "url": "https://github.com/stoplightio/json-schema-sampler.git"
   },
   "keywords": [
     "OpenAPI",
+    "JSON Schema",
     "Swagger",
     "instantiator",
     "sampler",
     "faker"
   ],
-  "author": "Roman Hotsiy <[email protected]>",
+  "author": "Stoplight <[email protected]>",
+  "contributors": [
+    "Roman Hotsiy <[email protected]>"
+  ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/APIs-guru/openapi-sampler/issues"
+    "url": "https://github.com/stoplightio/json-schema-sampler/issues"
   },
-  "homepage": "https://github.com/APIs-guru/openapi-sampler/",
+  "homepage": "https://github.com/stoplightio/json-schema-sampler/",
   "browserslist": "> 0.25%, not dead",
   "devDependencies": {
     "@babel/core": "^7.7.2",

Diff for: src/allOf.js

@@ -23,7 +23,7 @@ export function allOfSample(into, children, options, spec, context) {
   } else {
     if (res.type === 'array') {
       // TODO: implement arrays
-      if (!options.quiet) console.warn('OpenAPI Sampler: found allOf with "array" type. Result may be incorrect');
+      if (!options.quiet) console.warn('JSON Schema Sampler: found allOf with "array" type. Result may be incorrect');
     }
     const lastSample = subSamples[subSamples.length - 1];
     res.value = lastSample != null ? lastSample : res.value;

Diff for: src/openapi-sampler.js renamed to src/json-schema-sampler.js

@@ -1,4 +1,4 @@
-import { _samplers } from './openapi-sampler';
+import { _samplers } from './json-schema-sampler';
 import { allOfSample } from './allOf';
 import { inferType } from './infer';
 import { getResultForCircular, popSchemaStack } from './utils';