diff --git a/README.md b/README.md index ffedfd87..e05a3c1e 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,7 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica * `hide-hostname` - if set, the protocol and hostname is not shown in the operation definition. * `expand-responses` - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. `expand-responses="200,201"`. Special value `"all"` expands all responses by default. Be careful: this option can slow-down documentation rendering time. * `required-props-first` - show required properties first ordered in the same order as in `required` array. +* `no-auto-auth` - do not inject Authentication section automatically ## Advanced usage Instead of adding `spec-url` attribute to the `` element you can initialize ReDoc via globally exposed `Redoc` object: diff --git a/build/webpack.common.js b/build/webpack.common.js index 30e9a57d..da047652 100644 --- a/build/webpack.common.js +++ b/build/webpack.common.js @@ -23,7 +23,7 @@ module.exports = function (options) { extensions: ['.ts', '.js', '.json', '.css'], alias: { http: 'stream-http', - https: 'stream-http' + https: 'https-browserify' } }, diff --git a/lib/components/ApiInfo/api-info.html b/lib/components/ApiInfo/api-info.html index e11178c8..725de4e9 100644 --- a/lib/components/ApiInfo/api-info.html +++ b/lib/components/ApiInfo/api-info.html @@ -6,7 +6,7 @@

- Contact: + Contact: {{info.contact.name || info.contact.url}} diff --git a/lib/components/EndpointLink/endpoint-link.scss b/lib/components/EndpointLink/endpoint-link.scss index 3bcbc510..9a70ba0a 100644 --- a/lib/components/EndpointLink/endpoint-link.scss +++ b/lib/components/EndpointLink/endpoint-link.scss @@ -110,3 +110,39 @@ transform: translateY(0%) scaleY(1); } } + +.http-verb { + color: white; + + &.get { + background-color: $get-color; + } + + &.post { + background-color: $post-color; + } + + &.put { + background-color: $put-color; + } + + &.options { + background-color: $options-color; + } + + &.patch { + background-color: $patch-color; + } + + &.delete { + background-color: $delete-color; + } + + &.basic { + background-color: $basic-color; + } + + &.link { + background-color: $link-color; + } +} diff --git a/lib/components/JsonSchema/json-schema-lazy.ts b/lib/components/JsonSchema/json-schema-lazy.ts index 24e2f1cb..c3a81bb1 100644 --- a/lib/components/JsonSchema/json-schema-lazy.ts +++ b/lib/components/JsonSchema/json-schema-lazy.ts @@ -36,7 +36,7 @@ export class JsonSchemaLazy implements OnDestroy, OnInit, AfterViewInit { return schema && schema.$ref || this.pointer; } - _loadAfterSelf() { + private _loadAfterSelf() { var componentFactory = this.resolver.resolveComponentFactory(JsonSchema); let contextInjector = this.location.parentInjector; let compRef = this.location.createComponent(componentFactory, null, contextInjector, null); diff --git a/lib/components/Operation/operation.ts b/lib/components/Operation/operation.ts index 7931069a..9b635cd4 100644 --- a/lib/components/Operation/operation.ts +++ b/lib/components/Operation/operation.ts @@ -4,9 +4,9 @@ import JsonPointer from '../../utils/JsonPointer'; import { BaseComponent, SpecManager } from '../base'; import { SchemaHelper } from '../../services/schema-helper.service'; import { OptionsService, MenuService } from '../../services/'; +import { SwaggerBodyParameter } from '../../utils/swagger-typings'; - -interface OperationInfo { +export interface OperationInfo { verb: string; path: string; info: { @@ -72,7 +72,7 @@ export class Operation extends BaseComponent implements OnInit { return tags.filter(tag => tagsMap[tag] && tagsMap[tag]['x-traitTag']); } - findBodyParam() { + findBodyParam():SwaggerBodyParameter { let params = this.specMgr.getOperationParams(this.pointer); let bodyParam = params.find(param => param.in === 'body'); return bodyParam; diff --git a/lib/components/OperationsList/operations-list.html b/lib/components/OperationsList/operations-list.html index 0907c592..aa57ed89 100644 --- a/lib/components/OperationsList/operations-list.html +++ b/lib/components/OperationsList/operations-list.html @@ -1,7 +1,7 @@

-

{{tag.name}}

+

{{tag.name}}

diff --git a/lib/components/OperationsList/operations-list.scss b/lib/components/OperationsList/operations-list.scss index 04f32b6f..a66e1310 100644 --- a/lib/components/OperationsList/operations-list.scss +++ b/lib/components/OperationsList/operations-list.scss @@ -12,7 +12,6 @@ .tag-info { padding: $section-spacing; box-sizing: border-box; - background-color: white; width: 60%; @media (max-width: $right-panel-squash-breakpoint) { diff --git a/lib/components/OperationsList/operations-list.ts b/lib/components/OperationsList/operations-list.ts index a0284321..620f4c3f 100644 --- a/lib/components/OperationsList/operations-list.ts +++ b/lib/components/OperationsList/operations-list.ts @@ -30,7 +30,10 @@ export class OperationsList extends BaseComponent implements OnInit { if (!menuItem.metadata) return; if (menuItem.metadata.type === 'tag') { - this.tags.push(menuItem); + this.tags.push({ + ...menuItem, + anchor: this.buildAnchor(menuItem.id) + }); } if (menuItem.metadata.type === 'operation' && !menuItem.parent) { emptyTag.items.push(menuItem); @@ -39,6 +42,11 @@ export class OperationsList extends BaseComponent implements OnInit { if (emptyTag.items.length) this.tags.push(emptyTag); } + buildAnchor(tagId):string { + return this.menu.hashFor(tagId, + { type: 'tag'}); + } + trackByTagName(_, el) { return el.name; } diff --git a/lib/components/Redoc/redoc.scss b/lib/components/Redoc/redoc.scss index 415a7940..d9503f00 100644 --- a/lib/components/Redoc/redoc.scss +++ b/lib/components/Redoc/redoc.scss @@ -113,6 +113,73 @@ side-menu { font-size: 18px; } +/* global menu items styles (search results + menu) */ +:host /deep/ { + .menu-item-header > span { + display: inline-block; + vertical-align: middle; + } + + .menu-item-header > .operation-type + .menu-item-title { + width: calc(100% - 32px); // 32 = 26px image width + 6px margin left + } + + .menu-item-header > .operation-type { + width: 26px; + display: inline-block; + height: 13px; + background-color: #333; + border-radius: 3px; + vertical-align: top; + background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABMAAACgCAYAAADuDlcXAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFNjQ5N0JDQUE3OTYxMUU0ODNGMUE0RUM3NjRDRTQyNyIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFNjQ5N0JDQkE3OTYxMUU0ODNGMUE0RUM3NjRDRTQyNyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkU2NDk3QkM4QTc5NjExRTQ4M0YxQTRFQzc2NENFNDI3IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkU2NDk3QkM5QTc5NjExRTQ4M0YxQTRFQzc2NENFNDI3Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+mIrGwQAAAZ9JREFUeNrsmtuOwyAMRBmU//9lbx9208ayjQ1EarSDVFW56ARIGGZIIK/S3gWvX3X7LN3a6WxDHdPnnDBpcZHEOe3wrmLUMg2zatKykPOq1/5fK71tLIQR9jjYsaJfWdWAAcRsM2W1z9LNGcFkRlmtPhvpf7qmHAGEESZqLFr/qbHaCy4Is6oxLdvT+nWr0lLPCCPsFn+mA5e2UjLycL1o6qLMiapqRGoifVCDinrgU2mRyJthzZg3CSPs+2HhIM4YGq0a4oDgiGjYTKw20/OwUzAEuXz73YSqtdsV+F1a3eZpweFEGGG7Y3ULbJRk4nYPlEHbUi86wpNtbz4oB37PICOrLEdC9DKzFv7EkQ8tYY8Nr8tuyJrRsdpMrIJ0n4GPBmGEEUbYzRMKnFwug1B7rppmbCiyBjBrQ1vC8KW/CxrF7osNrRbxMjofWsIIuwU2vapnZfTRq4/wFXl3hG9bMzP6ZWV47LoB+Gym1/EyUleKI2GEPW8pQpu80bHLvsifSWFVAVEzo2VDTxxb9T16eO7sF0vmxPNPxPFHgAEA/rGUMXq/uWcAAAAASUVORK5CYII='); + background-repeat: no-repeat; + background-position: 6px 4px; + text-indent: -9000px; + margin-right: 6px; + margin-top: 2px; + + &.get { + background-position: 8px -12px; + background-color: $get-color; + } + + &.post { + background-position: 6px 4px; + background-color: $post-color; + } + + &.put { + background-position: 8px -28px; + background-color: $put-color; + } + + &.options { + background-position: 4px -148px; + background-color: $options-color; + } + + &.patch { + background-position: 4px -114px; + background-color: $patch-color; + } + + &.delete { + background-position: 4px -44px; + background-color: $delete-color; + } + + &.basic { + background-position: 5px -79px; + background-color: $basic-color; + } + + &.link { + background-position: 4px -131px; + background-color: $link-color; + } + } +} + /* global redoc styles */ @for $index from 1 through 5 { @@ -240,6 +307,9 @@ footer { padding-left: 2em; margin: 0; margin-bottom: 1em; + font-family: $base-font, $base-font-family; + font-weight: $base-font-weight; + line-height: $base-line-height; } table { diff --git a/lib/components/Search/redoc-search.html b/lib/components/Search/redoc-search.html index 2c4e3a21..5c7becf6 100644 --- a/lib/components/Search/redoc-search.html +++ b/lib/components/Search/redoc-search.html @@ -5,9 +5,10 @@
diff --git a/lib/components/Search/redoc-search.scss b/lib/components/Search/redoc-search.scss index 19bee15a..c58fc3b5 100644 --- a/lib/components/Search/redoc-search.scss +++ b/lib/components/Search/redoc-search.scss @@ -44,6 +44,7 @@ input { overflow-y: auto; border-bottom: 1px solid darken($side-bar-bg-color, 10%); border-top: 1px solid darken($side-bar-bg-color, 10%); + line-height: 1.2; min-height: 150px; max-height: 250px; diff --git a/lib/components/Search/redoc-search.ts b/lib/components/Search/redoc-search.ts index 35a66ff5..5cf8b286 100644 --- a/lib/components/Search/redoc-search.ts +++ b/lib/components/Search/redoc-search.ts @@ -74,7 +74,7 @@ export class RedocSearch implements OnInit { item.pointers ); this.marker.remark(); - this.menu.activate(item.menuItem.flatIdx); + this.menu.activate(item.menuItem); this.menu.scrollToActive(); } diff --git a/lib/components/SideMenu/side-menu-items.html b/lib/components/SideMenu/side-menu-items.html index 0db93069..74e72a90 100644 --- a/lib/components/SideMenu/side-menu-items.html +++ b/lib/components/SideMenu/side-menu-items.html @@ -1,6 +1,9 @@
  • - +
    diff --git a/lib/components/SideMenu/side-menu-items.scss b/lib/components/SideMenu/side-menu-items.scss index f0904ce9..60bd02dd 100644 --- a/lib/components/SideMenu/side-menu-items.scss +++ b/lib/components/SideMenu/side-menu-items.scss @@ -78,7 +78,7 @@ .menu-item-depth-2 { > .menu-item-header { - padding-left: 2*$side-menu-item-hpadding; + padding-left: $side-menu-item-hpadding; } > .menu-item-header:hover, diff --git a/lib/components/SideMenu/side-menu.ts b/lib/components/SideMenu/side-menu.ts index 1560896c..0838b9c3 100644 --- a/lib/components/SideMenu/side-menu.ts +++ b/lib/components/SideMenu/side-menu.ts @@ -11,8 +11,7 @@ import { Component, } from '@angular/core'; import { trigger, state, animate, transition, style } from '@angular/core'; -import { BaseComponent, SpecManager } from '../base'; -import { ScrollService, MenuService, OptionsService, MenuItem, Marker} from '../../services/'; +import { ScrollService, MenuService, OptionsService, MenuItem } from '../../services/'; import { BrowserDomAdapter as DOM } from '../../utils/browser-adapter'; const global = window; @@ -47,7 +46,7 @@ export class SideMenuItems { templateUrl: './side-menu.html', styleUrls: ['./side-menu.css'] }) -export class SideMenu extends BaseComponent implements OnInit, OnDestroy { +export class SideMenu implements OnInit, OnDestroy { activeCatCaption: string; activeItemCaption: string; menuItems: Array; @@ -59,15 +58,12 @@ export class SideMenu extends BaseComponent implements OnInit, OnDestroy { private $scrollParent: any; constructor( - specMgr:SpecManager, elementRef:ElementRef, private scrollService:ScrollService, private menuService:MenuService, optionsService:OptionsService, private detectorRef:ChangeDetectorRef, - private marker:Marker ) { - super(specMgr); this.$element = elementRef.nativeElement; this.activeCatCaption = ''; @@ -108,7 +104,7 @@ export class SideMenu extends BaseComponent implements OnInit, OnDestroy { this.toggleMobileNav(); } - this.menuService.activate(item.flatIdx); + this.menuService.activate(item); this.menuService.scrollToActive(); } @@ -154,7 +150,7 @@ export class SideMenu extends BaseComponent implements OnInit, OnDestroy { } ngOnInit() { - this.preinit(); + this.init(); } ngAfterViewInit() { diff --git a/lib/components/base.spec.ts b/lib/components/base.spec.ts index efc0687f..88e5a6ef 100644 --- a/lib/components/base.spec.ts +++ b/lib/components/base.spec.ts @@ -2,6 +2,7 @@ import { SpecManager } from '../utils/spec-manager'; import { BaseComponent } from '../components/base'; +import { OptionsService } from '../services/options.service'; describe('Redoc components', () => { describe('BaseComponent', () => { @@ -9,7 +10,7 @@ describe('Redoc components', () => { let component; beforeAll(() => { - specMgr = new SpecManager(); + specMgr = new SpecManager(new OptionsService()); specMgr._schema = {tags: []}; }); diff --git a/lib/redoc.module.ts b/lib/redoc.module.ts index b3081fc0..5e5a5dca 100644 --- a/lib/redoc.module.ts +++ b/lib/redoc.module.ts @@ -17,6 +17,7 @@ import { ComponentParser, ContentProjector, Marker, + SchemaHelper, SearchService, COMPONENT_PARSER_ALLOWED } from './services/'; @@ -39,9 +40,20 @@ import { SpecManager } from './utils/spec-manager'; { provide: ErrorHandler, useClass: CustomErrorHandler }, { provide: COMPONENT_PARSER_ALLOWED, useValue: { 'security-definitions': SecurityDefinitions} } ], - exports: [Redoc] + exports: [Redoc, REDOC_DIRECTIVES, REDOC_COMMON_DIRECTIVES, REDOC_PIPES] }) export class RedocModule { } -export { Redoc, SpecManager }; +export { Redoc, SpecManager, ScrollService, +Hash, +WarningsService, +OptionsService, +AppStateService, +ComponentParser, +ContentProjector, +MenuService, +SearchService, +SchemaHelper, +LazyTasksService, +Marker }; diff --git a/lib/services/app-state.service.ts b/lib/services/app-state.service.ts index 59e34c36..24eb85bd 100644 --- a/lib/services/app-state.service.ts +++ b/lib/services/app-state.service.ts @@ -10,6 +10,7 @@ export class AppStateService { error = new BehaviorSubject(null); loading = new Subject(); initialized = new BehaviorSubject(false); + rightPanelHidden = new BehaviorSubject(false); searchContainingPointers = new BehaviorSubject([]); diff --git a/lib/services/component-parser.service.ts b/lib/services/component-parser.service.ts index 8d26fdf4..9fbc3cae 100644 --- a/lib/services/component-parser.service.ts +++ b/lib/services/component-parser.service.ts @@ -10,7 +10,7 @@ import { ComponentFactoryResolver } from '@angular/core'; -type NodesOrComponents = HTMLElement | ComponentRef; +export type NodesOrComponents = HTMLElement | ComponentRef; export const COMPONENT_PARSER_ALLOWED = 'COMPONENT_PARSER_ALLOWED'; const COMPONENT_REGEXP = '^\\s*\\s*$'; diff --git a/lib/services/menu.service.ts b/lib/services/menu.service.ts index a8d1671b..18e47196 100644 --- a/lib/services/menu.service.ts +++ b/lib/services/menu.service.ts @@ -18,7 +18,7 @@ const CHANGE = { BACK : -1, }; -interface TagGroup { +export interface TagGroup { name: string; tags: string[]; } @@ -50,6 +50,8 @@ export class MenuService { items: MenuItem[]; activeIdx: number = -1; + public domRoot: Document | Element = document; + private _flatItems: MenuItem[]; private _hashSubscription: Subscription; private _scrollSubscription: Subscription; @@ -64,7 +66,11 @@ export class MenuService { private specMgr:SpecManager ) { this.hash = hash; - this.buildMenu(); + + this.specMgr.spec.subscribe(spec => { + if (!spec) return; + this.buildMenu(); + }); this._scrollSubscription = scrollService.scroll.subscribe((evt) => { this.onScroll(evt.isScrolledDown); @@ -172,7 +178,7 @@ export class MenuService { currentItem = currentItem.parent; } selector = selector.trim(); - return selector ? document.querySelector(selector) : null; + return selector ? this.domRoot.querySelector(selector) : null; } isTagOrGroupItem(flatIdx: number):boolean { @@ -202,13 +208,12 @@ export class MenuService { } } - activate(idx, force = false, replaceState = false) { - let item = this.flatItems[idx]; + activate(item:MenuItem, force = false, replaceState = false) { if (!force && item && !item.ready) return; this.deactivate(this.activeIdx); - this.activeIdx = idx; - if (idx < 0) { + this.activeIdx = item ? item.flatIdx : -1; + if (this.activeIdx < 0) { this.hash.update('', replaceState); return; } @@ -224,10 +229,15 @@ export class MenuService { this.changedActiveItem.next(item); } + activateByIdx(idx:number, force = false, replaceState = false) { + let item = this.flatItems[idx]; + this.activate(item, force, replaceState); + } + changeActive(offset = 1):boolean { let noChange = (this.activeIdx <= 0 && offset === -1) || (this.activeIdx === this.flatItems.length - 1 && offset === 1); - this.activate(this.activeIdx + offset, false, true); + this.activateByIdx(this.activeIdx + offset, false, true); return noChange; } @@ -263,12 +273,12 @@ export class MenuService { return item.metadata && item.metadata.operationId === ptr; }); } - this.activate(idx, true); + this.activateByIdx(idx, true); return idx >= 0; } tryScrollToId(id) { - let $el = document.querySelector(`[section="${id}"]`); + let $el = this.domRoot.querySelector(`[section="${id}"]`); if ($el) this.scrollService.scrollTo($el); } @@ -311,15 +321,16 @@ export class MenuService { if (!tag.operations || !tag.operations.length) return null; let res = []; - for (let operation of tag.operations) { + for (let operationInfo of tag.operations) { let subItem = { - name: SchemaHelper.operationSummary(operation), - id: operation._pointer, - description: operation.description, + name: SchemaHelper.operationSummary(operationInfo), + id: operationInfo._pointer, + description: operationInfo.description, metadata: { type: 'operation', - pointer: operation._pointer, - operationId: operation.operationId + pointer: operationInfo._pointer, + operationId: operationInfo.operationId, + operation: operationInfo.operation }, parent: parent }; @@ -330,8 +341,8 @@ export class MenuService { hashFor( id: string|null, itemMeta: - {operationId: string, type: string, pointer: string}, - parentId: string + {operationId?: string, type: string, pointer?: string}, + parentId?: string ) { if (!id) return null; if (itemMeta && itemMeta.type === 'operation') { @@ -434,6 +445,7 @@ export class MenuService { flatMenu():MenuItem[] { let menu = this.items; + if (!menu) return; let res = []; let curDepth = 1; diff --git a/lib/services/options.service.ts b/lib/services/options.service.ts index 1747efef..f9fe3b6c 100644 --- a/lib/services/options.service.ts +++ b/lib/services/options.service.ts @@ -16,7 +16,8 @@ const OPTION_NAMES = new Set([ 'hideHostname', 'lazyRendering', 'expandResponses', - 'requiredPropsFirst' + 'requiredPropsFirst', + 'noAutoAuth' ]); export interface Options { @@ -29,6 +30,7 @@ export interface Options { expandResponses?: Set | 'all'; $scrollParent?: HTMLElement | Window; requiredPropsFirst?: boolean; + noAutoAuth?: boolean; spec?: any; } @@ -95,6 +97,7 @@ export class OptionsService { if (isString(this._options.hideHostname)) this._options.hideHostname = true; if (isString(this._options.lazyRendering)) this._options.lazyRendering = true; if (isString(this._options.requiredPropsFirst)) this._options.requiredPropsFirst = true; + if (isString(this._options.noAutoAuth)) this._options.noAutoAuth = true; if (isString(this._options.expandResponses)) { let str = this._options.expandResponses as string; if (str === 'all') return; diff --git a/lib/services/schema-helper.service.ts b/lib/services/schema-helper.service.ts index 13b63aa8..5e0cbfe6 100644 --- a/lib/services/schema-helper.service.ts +++ b/lib/services/schema-helper.service.ts @@ -4,7 +4,7 @@ import { operations as swaggerOperations, keywordTypes } from '../utils/swagger import { WarningsService } from './warnings.service'; import * as slugify from 'slugify'; -interface PropertyPreprocessOptions { +export interface PropertyPreprocessOptions { childFor?: string; skipReadOnly?: boolean; discriminator?: string; @@ -321,6 +321,7 @@ export class SchemaHelper { if (!tag.operations) tag.operations = []; tag.operations.push(operationInfo); operationInfo._pointer = operationPointer; + operationInfo.operation = operation; } } } diff --git a/lib/services/schema-normalizer.service.spec.ts b/lib/services/schema-normalizer.service.spec.ts index e25c6bc9..c1d801bb 100644 --- a/lib/services/schema-normalizer.service.spec.ts +++ b/lib/services/schema-normalizer.service.spec.ts @@ -1,9 +1,11 @@ 'use strict'; import { SchemaNormalizer } from './schema-normalizer.service'; import { SpecManager } from '../utils/spec-manager';; +import { OptionsService } from '../services/options.service'; + describe('Spec Helper', () => { - let specMgr:SpecManager = new SpecManager(); + let specMgr:SpecManager = new SpecManager(new OptionsService()); let normalizer = new SchemaNormalizer(specMgr); describe('Dereference', () => { diff --git a/lib/services/schema-normalizer.service.ts b/lib/services/schema-normalizer.service.ts index d3940bb2..f599a73a 100644 --- a/lib/services/schema-normalizer.service.ts +++ b/lib/services/schema-normalizer.service.ts @@ -5,12 +5,12 @@ import { JsonPointer } from '../utils/JsonPointer'; import { defaults } from '../utils/helpers'; import { WarningsService } from './warnings.service'; -interface Reference { +export interface Reference { $ref: string; description: string; } -interface Schema { +export interface Schema { properties: any; allOf: any; items: any; @@ -180,7 +180,7 @@ class RefCounter { } -class SchemaDereferencer { +export class SchemaDereferencer { private _refCouner = new RefCounter(); constructor(private _spec: SpecManager, private normalizator: SchemaNormalizer) { diff --git a/lib/services/search.service.ts b/lib/services/search.service.ts index c47b9a52..f5f53f73 100644 --- a/lib/services/search.service.ts +++ b/lib/services/search.service.ts @@ -15,7 +15,7 @@ import { import * as lunr from 'lunr'; -interface IndexElement { +export interface IndexElement { menuId: string; title: string; body: string; diff --git a/lib/shared/styles/_variables.scss b/lib/shared/styles/_variables.scss index b50ad976..b8a6ec74 100644 --- a/lib/shared/styles/_variables.scss +++ b/lib/shared/styles/_variables.scss @@ -70,3 +70,13 @@ $border-radius: 2px; // texts $array-text: 'Array of '; $tuple-text: 'Tuple '; + +// HTTP Verb colors +$get-color: #6bbd5b; +$post-color: #248fb2; +$put-color: #9b708b; +$options-color: #d3ca12; +$patch-color: #e09d43; +$delete-color: #e27a7a; +$basic-color: #999; +$link-color: #31bbb6; diff --git a/lib/utils/spec-manager.ts b/lib/utils/spec-manager.ts index e09f03b7..43118bba 100644 --- a/lib/utils/spec-manager.ts +++ b/lib/utils/spec-manager.ts @@ -1,5 +1,5 @@ 'use strict'; - +import { Injectable } from '@angular/core'; import * as JsonSchemaRefParser from 'json-schema-ref-parser'; import { JsonPointer } from './JsonPointer'; import { parse as urlParse, resolve as urlResolve } from 'url'; @@ -9,6 +9,7 @@ import { MdRenderer } from './md-renderer'; import { SwaggerOperation, SwaggerParameter } from './swagger-typings'; import { snapshot } from './helpers'; +import { OptionsService, Options } from '../services/options.service'; import { WarningsService } from '../services/warnings.service'; function getDiscriminator(obj) { @@ -22,6 +23,7 @@ export interface DescendantInfo { idx?: number; } +@Injectable() export class SpecManager { public _schema: any = {}; public apiUrl: string; @@ -32,6 +34,11 @@ export class SpecManager { public spec = new BehaviorSubject(null); public _specUrl: string; private parser: any; + private options: Options; + + constructor(optionsService: OptionsService) { + this.options = optionsService.options; + } load(urlOrObject: string|Object) { let promise = new Promise((resolve, reject) => { @@ -87,8 +94,8 @@ export class SpecManager { throw Error('Specification Error: Required field "info" is not specified at the top level of the specification'); } if (!this._schema.info.description) this._schema.info.description = ''; - if (this._schema.securityDefinitions) { - let SecurityDefinitions = require('../components/').SecurityDefinitions; + if (this._schema.securityDefinitions && !this.options.noAutoAuth) { + let SecurityDefinitions = require('../components/').SecurityDefinitions; mdRender.addPreprocessor(SecurityDefinitions.insertTagIntoDescription); } this._schema.info['x-redoc-html-description'] = mdRender.renderMd(this._schema.info.description); diff --git a/lib/utils/swagger-typings.ts b/lib/utils/swagger-typings.ts index 530f07f9..91e74c5e 100644 --- a/lib/utils/swagger-typings.ts +++ b/lib/utils/swagger-typings.ts @@ -10,7 +10,7 @@ import { Response } from '@types/swagger-schema-official'; -interface RedocInjectedPointer { +export interface RedocInjectedPointer { _pointer?: string; } diff --git a/package.json b/package.json index d0381e92..9c89511b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "redoc", "description": "Swagger-generated API Reference Documentation", - "version": "1.12.1", + "version": "1.13.0", "repository": { "type": "git", "url": "git://github.com/Rebilly/ReDoc" @@ -10,7 +10,7 @@ "node": ">=6.9", "npm": ">=3.0.0" }, - "main": "dist/redoc.min.js", + "main": "dist/redoc-module.js", "scripts": { "test": "npm run lint && node ./build/run_tests.js", "branch-release": "git reset --hard && branch-release", @@ -33,7 +33,9 @@ "webdriver": "webdriver-manager update", "serve:prod": "NODE_ENV=production npm start", "protractor": "protractor", - "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1" + "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1", + "build:prod-module": "npm run build:sass && npm run ngc && npm run webpack:prod && IS_MODULE=true npm run webpack:prod", + "build:module": "npm run build:sass && npm run ngc && IS_MODULE=true npm run webpack:prod" }, "keywords": [ "OpenAPI", @@ -74,6 +76,7 @@ "dropkickjs": "^2.1.10", "hint.css": "^2.3.2", "http-server": "^0.9.0", + "https-browserify": "^1.0.0", "istanbul-instrumenter-loader": "^2.0.0", "jasmine-core": "^2.4.1", "jasmine-spec-reporter": "^3.1.0", diff --git a/tests/unit/SpecManager.spec.ts b/tests/unit/SpecManager.spec.ts index 69a7c81a..a0089d20 100644 --- a/tests/unit/SpecManager.spec.ts +++ b/tests/unit/SpecManager.spec.ts @@ -1,6 +1,7 @@ 'use strict'; import { SpecManager } from '../../lib/utils/spec-manager'; +import { OptionsService } from '../../lib/services/options.service'; import * as xExtendedDefs from './x-extended-defs.json'; describe('Utils', () => { @@ -8,7 +9,7 @@ describe('Utils', () => { let specMgr: SpecManager; beforeEach(() => { - specMgr = new SpecManager(); + specMgr = new SpecManager(new OptionsService()); }); it('load should return a promise', ()=> { diff --git a/tsconfig.json b/tsconfig.json index 10461ce5..fbb918e7 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -13,10 +13,11 @@ "should", "webpack" ], + "outDir": "dist", "lib": [ "DOM", "ES2016", "DOM.Iterable" ], - "noEmitHelpers": true + "noEmitHelpers": false }, "compileOnSave": false, "exclude": [ diff --git a/yarn.lock b/yarn.lock index cff5c269..97a83a91 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2369,6 +2369,10 @@ https-browserify@0.0.1: version "0.0.1" resolved "https://registry.yarnpkg.com/https-browserify/-/https-browserify-0.0.1.tgz#3f91365cabe60b77ed0ebba24b454e3e09d95a82" +https-browserify@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/https-browserify/-/https-browserify-1.0.0.tgz#ec06c10e0a34c0f2faf199f7fd7fc78fffd03c73" + https-proxy-agent@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-1.0.0.tgz#35f7da6c48ce4ddbfa264891ac593ee5ff8671e6"