@stoplight/types - npm Package Compare versions

Comparing version 1.2.2 to 2.0.0

http.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=http.js.map

http.js.map

+{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":""}

index.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./http"), exports);
+tslib_1.__exportStar(require("./logs"), exports);
+//# sourceMappingURL=index.js.map

index.js.map

+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,iDAAuB"}

LICENSE

+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2018 Stoplight, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

logs.d.ts

+export declare const enum LogLevel {
+    Trace = 10,
+    Debug = 20,
+    Info = 30,
+    Warn = 40,
+    Error = 50,
+    Fatal = 60
+}

logs.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=logs.js.map

logs.js.map

+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":""}

node.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=node.js.map

node.js.map

+{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":""}

parsers.d.ts

+import { IValidation } from './validations';
+export declare type SourceMapParser<T = any> = (value: string) => IParserResult<T>;
+export interface IPosition {
+    line: number;
+}
+export interface IPathPosition {
+    start: IPosition;
+    end?: IPosition;
+}
+export interface IParserResultPointers {
+    [path: string]: IPathPosition;
+}
+export interface IParserResult<T = any> {
+    data: T;
+    pointers: IParserResultPointers;
+    validations: IValidation[];
+}

parsers.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=parsers.js.map

parsers.js.map

+{"version":3,"file":"parsers.js","sourceRoot":"","sources":["../src/parsers.ts"],"names":[],"mappings":""}

README.md

+# @stoplight/types
+
+Common typings for the Stoplight ecosystem.
+
+- Explore the interfaces: [TSDoc](https://stoplightio.github.io/types/)
+- View the changelog: [Releases](https://github.com/stoplightio/types/releases)
+
+### Installation
+
+Supported in modern browsers and node.
+
+```bash
+# latest stable
+yarn add -D @stoplight/types
+```
+
+### Contributing
+
+1. Clone repo.
+2. Create / checkout `feature/{name}`, `chore/{name}`, or `fix/{name}` branch.
+3. Install deps: `yarn`.
+4. Make your changes.
+5. Run tests: `yarn test.prod`.
+6. Stage relevant files to git.
+7. Commit: `yarn commit`. _NOTE: Commits that don't follow the [conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) format will be rejected. `yarn commit` creates this format for you, or you can put it together manually and then do a regular `git commit`._
+8. Push: `git push`.
+9. Open PR targeting the `develop` branch.

schema.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

schema.js.map

+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":""}

server.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=server.js.map

server.js.map

+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":""}

validations.d.ts

+import { LogLevel } from './logs';
+import { IPathPosition } from './parsers';
+export interface IValidation {
+    ruleId: string;
+    level?: LogLevel;
+    line?: number;
+    column?: number;
+    location?: IPathPosition;
+}

validations.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=validations.js.map

validations.js.map

+{"version":3,"file":"validations.js","sourceRoot":"","sources":["../src/validations.ts"],"names":[],"mappings":""}

http.d.ts

 import { INode } from './node';
+import { ISchema } from './schema';
 import { IServer } from './server';
-import { ISchema } from './schema';
-
 export interface IHttpOperation extends INode {
-  method: string;
-  path: string;
-  responses: IHttpResponse[];
-  servers?: IServer[];
-  request?: IHttpRequest;
-  security?: HttpSecurityScheme[];
-  deprecated?: boolean;
+    method: string;
+    path: string;
+    responses: IHttpResponse[];
+    servers?: IServer[];
+    request?: IHttpRequestParams;
+    security?: HttpSecurityScheme[];
+    deprecated?: boolean;
 }
-
 export interface IExample {
-  key: string;
-  summary?: string;
-  description?: string;
-  value?: any;
-  externalValue?: any;
+    key: string;
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: any;
 }
-
-// Inspired by: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject
 export interface IHttpParam {
-  name: string;
-  style?: HttpParamStyles;
-  description?: string;
-  required?: boolean;
-  explode?: boolean;
-  deprecated?: boolean;
-
-  // most of the type, params from oas2/oas3 will simply be converted to content with one '*' key
-  content: {
-    [mediaType: string]: IHttpContent;
-  };
+    name: string;
+    style?: HttpParamStyles;
+    description?: string;
+    required?: boolean;
+    explode?: boolean;
+    deprecated?: boolean;
+    content: {
+        [mediaType: string]: IHttpContent;
+    };
 }
-
-declare const enum HttpParamStyles {
-  Simple = 'simple',
-  Matrix = 'matrix',
-  Label = 'label',
-  Form = 'form',
-  SpaceDelimited = 'spaceDelimited',
-  PipeDelimited = 'pipeDelimited',
-  DeepObject = 'deepObject',
+export declare const enum HttpParamStyles {
+    Simple = "simple",
+    Matrix = "matrix",
+    Label = "label",
+    Form = "form",
+    SpaceDelimited = "spaceDelimited",
+    PipeDelimited = "pipeDelimited",
+    DeepObject = "deepObject"
 }
-
 export interface IHttpPathParam extends IHttpParam {
-  // defaults to simple
-  style?: HttpParamStyles.Label | HttpParamStyles.Matrix | HttpParamStyles.Simple;
+    style?: HttpParamStyles.Label | HttpParamStyles.Matrix | HttpParamStyles.Simple;
 }
-
 export interface IHttpQueryParam extends IHttpParam {
-  // defaults to form
-  style?:
-  | HttpParamStyles.Form
-  | HttpParamStyles.SpaceDelimited
-  | HttpParamStyles.PipeDelimited
-  | HttpParamStyles.DeepObject;
-
-  allowEmptyValue?: boolean;
-  allowReserved?: boolean;
+    style?: HttpParamStyles.Form | HttpParamStyles.SpaceDelimited | HttpParamStyles.PipeDelimited | HttpParamStyles.DeepObject;
+    allowEmptyValue?: boolean;
+    allowReserved?: boolean;
 }
-
 export interface IHttpHeaderParam extends IHttpParam {
-  // defaults to simple
-  style?: HttpParamStyles.Simple;
+    style?: HttpParamStyles.Simple;
 }
-
 export interface IHttpCookieParam extends IHttpParam {
-  // defaults to form
-  style?: HttpParamStyles.Form;
+    style?: HttpParamStyles.Form;
 }
-
 export interface IHttpEncoding {
-  property: string;
-  mediaType?: string;
-  headers?: IHttpHeaderParam[];
-  // deafults to form
-  style:
-  | HttpParamStyles.Form
-  | HttpParamStyles.SpaceDelimited
-  | HttpParamStyles.PipeDelimited
-  | HttpParamStyles.DeepObject;
-
-  explode?: boolean;
-  allowReserved?: boolean;
+    property: string;
+    mediaType?: string;
+    headers?: IHttpHeaderParam[];
+    style: HttpParamStyles.Form | HttpParamStyles.SpaceDelimited | HttpParamStyles.PipeDelimited | HttpParamStyles.DeepObject;
+    explode?: boolean;
+    allowReserved?: boolean;
 }
-
 export interface IHttpContent {
-  mediaType: string;
-  schema?: ISchema;
-  examples?: IExample[];
-  encodings?: IHttpEncoding[];
+    mediaType: string;
+    schema?: ISchema;
+    examples?: IExample[];
+    encodings?: IHttpEncoding[];
 }
-
-// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#link-object
 export interface IHttpLink {
-  operationRef: string;
-  parameters: Array<{
-    name: string;
-    value?: any;
-    expression?: string;
-  }>;
-  requestBody?: any;
-  description?: string;
-  server?: IServer;
+    operationRef: string;
+    parameters: Array<{
+        name: string;
+        value?: any;
+        expression?: string;
+    }>;
+    requestBody?: any;
+    description?: string;
+    server?: IServer;
 }
-
-// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#requestBodyObject
 export interface IHttpRequestBody {
-  description?: string;
-  required?: boolean;
-  contents: IHttpContent[];
+    description?: string;
+    required?: boolean;
+    contents: IHttpContent[];
 }
-
-export interface IHttpRequest {
-  path?: IHttpPathParam[];
-  query?: IHttpQueryParam[];
-  headers?: IHttpHeaderParam[];
-  cookie?: IHttpCookieParam[];
-  body?: IHttpRequestBody;
+export interface IHttpRequestParams {
+    path?: IHttpPathParam[];
+    query?: IHttpQueryParam[];
+    headers?: IHttpHeaderParam[];
+    cookie?: IHttpCookieParam[];
+    body?: IHttpRequestBody;
 }
-
 export interface IHttpResponse {
-  // Note: code MAY contain uppercase "X" to indicate wildcard
-  // Examples: 200, 2XX, 4XX, XXX ("default" in OAS)
-  // When mocking, should select most specific defined code
-  code: string;
-  contents: IHttpContent[];
-  description?: string;
-  headers?: IHttpHeaderParam[];
-  links?: IHttpLink;
+    code: string;
+    contents: IHttpContent[];
+    description?: string;
+    headers?: IHttpHeaderParam[];
+    links?: IHttpLink;
 }
-
-/**
- * Security
- */
-
-type HttpSecurityScheme =
-  | IApiKeySecurityScheme
-  | IBearerSecurityScheme
-  | IBasicSecurityScheme
-  | IOauth2SecurityScheme
-  | IOpenIdConnectSecurityScheme;
-
+declare type HttpSecurityScheme = IApiKeySecurityScheme | IBearerSecurityScheme | IBasicSecurityScheme | IOauth2SecurityScheme | IOpenIdConnectSecurityScheme;
 export interface ISecurityScheme {
-  description?: string;
+    description?: string;
 }
-
 export interface IApiKeySecurityScheme extends ISecurityScheme {
-  type: 'apiKey';
-  name: string;
-  in: 'query' | 'header' | 'cookie';
+    type: 'apiKey';
+    name: string;
+    in: 'query' | 'header' | 'cookie';
 }
-
 export interface IBearerSecurityScheme extends ISecurityScheme {
-  type: 'http';
-  scheme: 'bearer';
-  bearerFormat?: string;
+    type: 'http';
+    scheme: 'bearer';
+    bearerFormat?: string;
 }
-
 export interface IBasicSecurityScheme extends ISecurityScheme {
-  type: 'http';
-  scheme: 'basic';
+    type: 'http';
+    scheme: 'basic';
 }
-
 export interface IOpenIdConnectSecurityScheme extends ISecurityScheme {
-  type: 'openIdConnect';
-  openIdConnectUrl: string;
+    type: 'openIdConnect';
+    openIdConnectUrl: string;
 }
-
 export interface IOauth2SecurityScheme extends ISecurityScheme {
-  type: 'oauth2';
-  flows: IOauthFlowObjects;
+    type: 'oauth2';
+    flows: IOauthFlowObjects;
 }
-
 export interface IOauthFlowObjects {
-  implicit?: IOauth2ImplicitFlow;
-  password?: IOauth2PasswordFlow;
-  clientCredentials?: IOauth2ClientCredentialsFlow;
-  authorizationCode?: IOauth2AuthorizationCodeFlow;
+    implicit?: IOauth2ImplicitFlow;
+    password?: IOauth2PasswordFlow;
+    clientCredentials?: IOauth2ClientCredentialsFlow;
+    authorizationCode?: IOauth2AuthorizationCodeFlow;
 }
-
 export interface IOauth2Flow {
-  refreshUrl?: string;
-  scopes: Array<{
-    [name: string]: string;
-  }>;
+    refreshUrl?: string;
+    scopes: Array<{
+        [name: string]: string;
+    }>;
 }
-
 export interface IOauth2ImplicitFlow extends IOauth2Flow {
-  authorizationUrl: string;
+    authorizationUrl: string;
 }
-
 export interface IOauth2AuthorizationCodeFlow extends IOauth2Flow {
-  authorizationUrl: string;
-  tokenUrl: string;
+    authorizationUrl: string;
+    tokenUrl: string;
 }
-
 export interface IOauth2PasswordFlow extends IOauth2Flow {
-  tokenUrl: string;
+    tokenUrl: string;
 }
-
 export interface IOauth2ClientCredentialsFlow extends IOauth2Flow {
-  tokenUrl: string;
+    tokenUrl: string;
 }
+export {};

index.d.ts

 export * from './http';
+export * from './logs';
 export * from './node';
 export * from './parsers';
+export * from './schema';
 export * from './server';
 export * from './validations';

node.d.ts

 export interface INode {
-  id: string;
-  iid?: string; // An internal identifier. for example the operationId property in OAS
-  tags?: INodeTag[];
-  summary?: string;
-  description?: string;
+    id: string;
+    iid?: string;
+    tags?: INodeTag[];
+    summary?: string;
+    description?: string;
 }
-
 export interface INodeTag {
-  name: string;
-  description?: string;
+    name: string;
+    description?: string;
 }
-
 export interface INodeVariable {
-  default: string;
-  description?: string;
-  enum?: string[];
+    default: string;
+    description?: string;
+    enum?: string[];
 }

package.json

 {
   "name": "@stoplight/types",
-  "version": "1.2.2",
+  "version": "2.0.0",
+  "description": "Common typings for the Stoplight ecosystem.",
+  "keywords": [],
+  "sideEffects": false,
+  "files": [
+    "**/*"
+  ],
   "author": "Stoplight <[e-mail]>",
-  "license": "MIT",
-  "main": "./index.d.ts",
-  "types": "./index.d.ts",
-  "scripts": {
-    "build": "tsc --project tsconfig.json"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stoplightio/types.git"
   },
-  "prettier": {
-    "printWidth": 100,
-    "singleQuote": true,
-    "trailingComma": "es5"
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=8"
   },
-  "devDependencies": {
-    "tslint": "5.11.x",
-    "tslint-config-stoplight": "1.1.x",
-    "typescript": "3.1.x"
-  }
+  "main": "index.js",
+  "typings": "index.d.ts"
 }

schema.d.ts

@@ -1,6 +0,3 @@
-// Here is OAS crazy subset of JSON Schema: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
-// For now, let's keep it open-ended
 export interface ISchema {
-  // anything goes for now
-  [key: string]: any;
+    [key: string]: any;
 }

server.d.ts

 import { INodeVariable } from './node';
-
 export interface IServer {
-  url: string;
-  name?: string;
-  description?: string;
-  variables?: {
-    [name: string]: INodeVariable;
-  };
+    url: string;
+    name?: string;
+    description?: string;
+    variables?: {
+        [name: string]: INodeVariable;
+    };
 }

logs/index.d.ts

-export enum LogLevel {
-  Trace = 10,
-  Debug = 20,
-  Info = 30,
-  Warn = 40,
-  Error = 50,
-  Fatal = 60,
-}
-
-// TODO: more formal logging system, a couple of options to do the heavy lifting? something like this?
-// https://github.com/pinojs/pino
-// export interface ILog<T = any> {
-//   level: LogLevel;
-//   msg: string;
-//   time: number;
-//   source?: string;
-//   data?: T;
-// }

parsers/index.d.ts

-import { IValidation } from '../validations';
-
-export type SourceMapParser<T = any> = (value: string) => IParserResult<T>;
-
-export interface IPosition {
-  /** line number (should start at 1) */
-  line: number;
-}
-
-export interface IPathPosition {
-  start: IPosition;
-  end?: IPosition;
-}
-
-export interface IParserResultPointers {
-  [path: string]: IPathPosition;
-}
-
-export interface IParserResult<T = any> {
-  data: T;
-  pointers: IParserResultPointers;
-  validations: IValidation[];
-}

tsconfig.json

-{
-  "src": ".",
-  "compilerOptions": {
-    "moduleResolution": "node",
-    "target": "es6",
-    "module": "commonjs",
-    "strict": true,
-    "pretty": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "noFallthroughCasesInSwitch": true,
-    "allowUnreachableCode": false,
-    "forceConsistentCasingInFileNames": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "suppressImplicitAnyIndexErrors": true,
-    "noUnusedLocals": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "declaration": true,
-    "skipLibCheck": true
-  }
-}

tslint.json

-{
-  "extends": ["tslint-config-stoplight"]
-}

validations/index.d.ts

-import { LogLevel } from '../logs';
-import { IPathPosition } from '../parsers';
-
-export interface IValidation {
-  ruleId: string;
-
-  level?: number;
-
-  /** Starting line of error */
-  line?: number;
-  column?: number;
-  location?: IPathPosition;
-}

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19833

148.72%

Dev dependency count

0

-100%

Number of package files

27

145.45%

Number of medium quality alerts

0

-100%

Number of lines in readme file

28

Infinity%

Number of low supply chain risk alerts

0

-100%

Worsened metrics

Lines of code

237

-16.84%

No dependency changes