npmpackage.info

Gathering detailed insights and metrics for @har-sdk/editor

@har-sdk/editor

HAR SDK enables Node.js developers to easily work with HAR, convert it from OAS/Swagger and Postman collection, and more.

1.5.12

MIT

TypeScript

52.15 kB

10,605 4

Installations

npm install @har-sdk/editor

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.17.1

NPM Version

8.19.3 Score

69.4

Supply Chain

95.4

Quality

77.9

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

9

Total

161

Closed

11

Merged

141

Issues

Open

12

Total

93

Closed

81

Releases

214

@har-sdk/oas@2.10.0

Published on 07 Oct 2024

@har-sdk/postman@2.4.6

Published on 22 Aug 2024

@har-sdk/oas@2.9.3

Published on 22 Aug 2024

@har-sdk/oas@2.9.2

Published on 14 Aug 2024

@har-sdk/openapi-sampler@2.2.1

Published on 14 Aug 2024

@har-sdk/oas@2.9.1

Published on 22 Apr 2024

View all 214 releases

Contributors

Unable to fetch Contributors

View all 25 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (98.02%)

JavaScript (1.94%)

Shell (0.04%)

Developer

NeuraLegion

Download Statistics

Total Downloads

10,605

Last Day

Last Week

Last Month

Last Year

1,324

GitHub Statistics

11 Stars

142 Commits

5 Forks

16 Watching

10 Branches

25 Contributors

Bundle Size

165.91 kB

Minified

52.15 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.5.12

Package Id

@har-sdk/editor@1.5.12

Unpacked Size

127.65 kB

Size

27.94 kB

File Count

123

NPM Version

8.19.3

Node Version

18.17.1

Publised On

21 Sept 2023

Total Downloads

Cumulative downloads

Total Downloads

10,605

Last day

-90.9%

Compared to previous day

Last week

-54.9%

Compared to previous week

Last month

2.2%

Compared to previous month

Last year

-69.6%

1,324

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@apidevtools/json-schema-ref-parser @har-sdk/core @har-sdk/validator @types/jsonpath js-yaml json-pointer jsonpath tslib

Dev Dependencies

@types/js-yaml @types/json-pointer

Versions

@har-sdk/editor

Parses OAS and Postman API specification files into form of tree with endpoints and parameters as leaves; tree is useful for GUI representation of specification parameters

Each node and parameter value have JSON pointer, that could be used to change parameter value or to remove node.

Setup

1npm i --save @har-sdk/editor

Usage

1import { OasV3Editor, SpecTreeNode } from '@har-sdk/editor';
2
3const openApiEditor = new OasV3Editor();
4openApiEditor.setup(jsonOrYamlSourceString).then(() => {
5  // tree parsing
6  let tree: SpecTreeNode = openApiEditor.parse();
7
8  // setting/updating parameter value
9  tree = openApiEditor.setParameterValue(
10    // parameter `valueJsonPointer` is pointer to `example` for oas3 and `default` for oas2;
11    // referenced parameter will be dereferenced automatically
12    tree.parameters[0].valueJsonPointer,
13    someNewValue
14  );
15
16  // removing specific node
17  tree = openApiEditor.removeNode(tree.children[1].jsonPointer);
18
19  // serialization
20  const serializedUpdatedSpec = openApiEditor.stringify();
21});

API

Available editors

All of them implement both TreeParser and Editor interfaces.

API interfaces

1export interface TreeParser {
2  setup(source: string): Promise<void>;
3  parse(): SpecTreeNode;
4  stringify(): string;
5}
6
7export interface Editor {
8  setParameterValue(jsonPointer: string, value: any): SpecTreeNode;
9  removeNode(jsonPointer: string): SpecTreeNode;
10}

Tree node interfaces

1export interface SpecTreeNode {
2  readonly path: string;
3  readonly name?: string;
4  readonly method?: HttpMethod;
5  readonly jsonPointer: string;
6  readonly children?: ReadonlyArray<SpecTreeNode>;
7  readonly parameters?: ReadonlyArray<SpecTreeNodeParam>;
8}
9
10export interface SpecTreeNodeParam {
11  readonly paramType: 'location' | 'requestBody' | 'variable';
12  readonly value?: any;
13  readonly valueJsonPointer: string;
14}
15
16// Specific parameter types with specific properties
17
18export interface SpecTreeNodeVariableParam extends SpecTreeNodeParam {
19  readonly paramType: 'variable';
20  readonly name: string;
21}
22
23export interface SpecTreeNodeLocationParam extends SpecTreeNodeParam {
24  readonly paramType: 'location';
25  readonly name: string;
26  readonly location: ParamLocation;
27}
28
29export interface SpecTreeRequestBodyParam extends SpecTreeNodeParam {
30  readonly paramType: 'requestBody';
31  readonly bodyType: string;
32}
33
34// Enums
35
36export enum ParamLocation {
37  PATH = 'path',
38  QUERY = 'query',
39  HEADER = 'header',
40  BODY = 'body'
41}
42
43export enum HttpMethod {
44  GET = 'GET',
45  PUT = 'PUT',
46  POST = 'POST',
47  DELETE = 'DELETE',
48  OPTIONS = 'OPTIONS',
49  HEAD = 'HEAD',
50  PATCH = 'PATCH',
51  TRACE = 'TRACE'
52}

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 5

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-build.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 3 out of 3 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More