Add ts support #920

animeshjajoopostman · 2025-12-22T07:43:35Z

No description provided.

github-actions · 2025-12-22T07:43:55Z

integration test code coverage

Lines	Statements	Branches	Functions
	19.6% (2100/10713)	13.36% (999/7475)	20.75% (248/1195)

Coverage Breakdown • (19%)

File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line #s
All files	19.6	13.36	20.75	19.89
lib	40.44	39.33	27.39	40.74
schemaUtils.js	47.69	44.47	38.55	48.01	...3247, 3281–5381
libV2	9.22	0	0	9.31
index.js	12.12	0	0	12.12	29–364
libV2/CollectionGeneration	5.51	0	0	5.57
requestMatchingUtils.js	1.52	0	0	1.55	11–229, 246–385
schemaUtils.js	7.75	0	0	7.82	...2779, 2792–2852
utils.js	11.94	0	0	12.12	9–51, 54–82, 92–242
validationUtils.js	3.11	0	0	3.14	98–2539, 2547–2792
test/integration	100	100	100	100
integration.test.js	100	100	100	100
test/unit	86.66	50	80	89.65
sanity.test.js	86.66	50	80	89.65	38–41

github-actions · 2025-12-22T07:43:55Z

unit test code coverage

Lines	Statements	Branches	Functions
	88.78% (5861/6601)	80.71% (3867/4791)	93.79% (861/918)

Coverage Breakdown • (88%)

File	% Stmts	% Branch	% Funcs	% Lines	Uncovered Line #s
All files	88.78	80.71	93.79	88.9
bin	55.79	64.86	66.66	56.61
openapi2postmanv2.js	55.79	64.86	66.66	56.61	...86–287, 305–306
lib	92.79	86.46	96.43	92.77
schemaUtils.js	93.39	87.35	98.72	93.31	...5346–5348, 5372
libV2	78.15	68.88	100	77.94
index.js	69.69	53.73	100	69.69	...18, 343, 347, 364
libV2/CollectionGeneration	90.94	82.6	95.05	90.98
requestMatchingUtils.js	96.94	91.17	100	96.89	263–267, 284, 341
schemaUtils.js	94.06	88.41	99.03	94.29	...2526, 2671–2677
utils.js	95.52	83.33	94.73	95.45	112, 161, 172
validationUtils.js	86.26	74.61	91.48	86.1	...2725, 2762–2765

…nto feature/ts-support

Copilot

Pull request overview

This PR adds TypeScript support to the project by introducing type definitions and converting the main entry point to TypeScript. The changes enable better type safety and developer experience when using this OpenAPI to Postman converter library.

Key changes:

New TypeScript type definitions in types/index.ts covering all major interfaces
Conversion of index.js to index.ts with TypeScript annotations
Build pipeline setup with TypeScript compilation to dist/ directory

Reviewed changes

Copilot reviewed 25 out of 35 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
types/index.ts	Comprehensive type definitions for converter inputs, options, and outputs
index.ts	TypeScript conversion of main entry point with type annotations
package.json	Added TypeScript tooling, build scripts, and updated main/types entry points
libV2/index.js	Updated import paths to reference reorganized CollectionGeneration directory
libV2/CollectionGeneration/schemaUtils.js	Added missing eslint-disable comment and fixed import paths with .js extensions
libV2/CollectionGeneration/validationUtils.js	Updated import paths with .js extensions for relocated modules
test/unit/*.test.js	Updated test imports to use compiled dist/index.js instead of source
test/system/*.test.js	Updated test imports to use compiled dist/index.js
test/integration/integration.test.js	Updated import to use compiled dist/index.js
scripts/test-lint.sh	Removed index.js from eslint targets since it's now TypeScript

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-29T05:10:49Z

index.ts

+const { MODULE_VERSION } = require('../lib/schemapack.js');
+const SchemaPack = require('../lib/schemapack.js').SchemaPack;
+const UserError = require('../lib/common/UserError');


The require paths use '../lib/' but should use './lib/' since index.ts is at the project root, not in a subdirectory. These incorrect paths will cause module resolution failures at runtime.

Suggested change

const { MODULE_VERSION } = require('../lib/schemapack.js');

const SchemaPack = require('../lib/schemapack.js').SchemaPack;

const UserError = require('../lib/common/UserError');

const { MODULE_VERSION } = require('./lib/schemapack.js');

const SchemaPack = require('./lib/schemapack.js').SchemaPack;

const UserError = require('./lib/common/UserError');

libV2/CollectionGeneration/schemaUtils.js

Copilot

Pull request overview

Copilot reviewed 28 out of 38 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-30T06:52:18Z

index.ts

+const { MODULE_VERSION } = require('../lib/schemapack.js');
+const SchemaPack = require('../lib/schemapack.js').SchemaPack;
+const UserError = require('../lib/common/UserError');


The require statements use relative paths starting with '../lib/' but these files are now at './lib/' relative to index.ts in the project root. These paths will fail at runtime since the compiled JavaScript will be in the dist directory.

Suggested change

const { MODULE_VERSION } = require('../lib/schemapack.js');

const SchemaPack = require('../lib/schemapack.js').SchemaPack;

const UserError = require('../lib/common/UserError');

const { MODULE_VERSION } = require('./lib/schemapack.js');

const SchemaPack = require('./lib/schemapack.js').SchemaPack;

const UserError = require('./lib/common/UserError');

Copilot · 2025-12-30T06:52:18Z

index.ts

+    return schema.detectRelatedFiles();
+  },
+
+  bundle: async function(input: MultiFileSpecInput & { options?: Options }): Promise<BundledContent> {


The parameter type uses intersection with an inline type which is inconsistent with the defined MultiFileSpecInput interface. Consider adding an 'options' field directly to MultiFileSpecInput or creating a separate BundleInput type.

AyushShri · 2026-01-22T09:16:01Z

libV2/CollectionGeneration/helpers/collection/generateAuthForCollectionFromOpenAPI.js

Any reason to move this ?

AyushShri · 2026-01-22T09:23:44Z

libV2/CollectionGeneration/schemaUtils.js

+const utils = require('./utils.js');

-const schemaFaker = require('../assets/json-schema-faker'),
+const schemaFaker = require('../../assets/json-schema-faker.js'),
  _ = require('lodash'),
  mergeAllOf = require('json-schema-merge-allof'),
-  xmlFaker = require('./xmlSchemaFaker.js'),
+  xmlFaker = require('../xmlSchemaFaker.js'),


You wouldn't require extensions for js files

AyushShri · 2026-01-22T09:47:48Z

test/system/repository.test.js


-    it('.gitignore coverage must be a subset of .npmignore coverage', function () {
-      expect(_.intersection(gitignore, npmignore)).to.eql(gitignore);
+    it('.gitignore coverage must be a subset of .npmignore coverage (except dist which is built for npm)', function () {


what do you mean by this ?

Files ignored by git should ideally also be ignored by npm, except dist/ files which needs to be published to npm

AyushShri · 2026-01-22T09:55:11Z

types/index.ts

@@ -0,0 +1,187 @@
+/**
+ * Conversion options


Is this a selective version of options.js with types or exhaustive ?

can we now use this options the api-spec module as well ?
Lets expose d.ts for this ?

.eslintrc

package.json

AyushShri · 2026-01-22T10:27:20Z

are we not creating index.d.ts for index.ts ?

AyushShri · 2026-01-22T11:04:39Z

types/index.ts

+  preferredRequestBodyType?: 'x-www-form-urlencoded' | 'form-data' | 'raw' | 'first-listed';
+}
+
+export type SpecInput =


Lets call it Specification ?

AyushShri · 2026-01-22T11:09:01Z

types/index.ts

+export type ConversionCallback = (
+  err: { message: string; name?: string } | null,
+  result?: ConversionResult
+) => void;
+
+interface MetadataResult {
+  result: true;
+  name: string;
+  output: { type: 'collection'; name: string }[];
+}
+
+export type MetadataCallback = (


Lets make this generic and not add specific type for each type of callback

AyushShri · 2026-01-22T11:09:17Z

types/index.ts

+  origin?: 'browser';
+}
+
+export interface MultiFileSpecInput {


…nto feature/ts-support

Add ts support

01bba76

Animesh Jajoo added 7 commits December 22, 2025 13:38

Add prepare script to package.json

8c3ce34

Fix JS linting and Add pretest script

035d6bb

Add support for syncing specifications

c85d854

Restore bin and top level index files

f29cf5f

Merge branch 'develop' of github.com:postmanlabs/openapi-to-postman i…

ee06f41

…nto feature/ts-support

Code cleanup

6d7f799

Remove spec-collection syncing

b114f6d

animeshjajoopostman requested a review from Copilot December 29, 2025 05:10

Copilot AI reviewed Dec 29, 2025

View reviewed changes

Animesh Jajoo added 3 commits December 29, 2025 11:00

Update package lock

ee2be2d

Misc improvements to types and linting script

d4767e5

Add ts eslint support

1053f89

animeshjajoopostman requested a review from Copilot December 30, 2025 06:51

Copilot AI reviewed Dec 30, 2025

View reviewed changes

AyushShri reviewed Jan 22, 2026

View reviewed changes

types/index.ts

origin?: 'browser';

}

export interface MultiFileSpecInput {

Copy link

Collaborator

AyushShri Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Merge branch 'develop' of github.com:postmanlabs/openapi-to-postman i…

0bebb7e

…nto feature/ts-support

Add ts support #920

Are you sure you want to change the base?

Add ts support #920

Uh oh!

Conversation

animeshjajoopostman commented Dec 22, 2025

Uh oh!

github-actions bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

integration test code coverage

Uh oh!

github-actions bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

unit test code coverage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AyushShri commented Jan 22, 2026

Uh oh!

AyushShri Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Dec 22, 2025 •

edited

Loading

github-actions bot commented Dec 22, 2025 •

edited

Loading

AyushShri Jan 22, 2026 •

edited

Loading