Skip to content

Commit

Permalink
fix(FEC-13671): Export 5 dedicated TS declaration files for each bund…
Browse files Browse the repository at this point in the history
…le (#236)

### Description of the Changes

Export 5 dedicated TS declaration files for each bundle

Related PR:
kaltura/kaltura-player-js#729

Resolves FEC-13671

---------

Co-authored-by: JonathanTGold <jonathan.gold@86@gmail.com>
  • Loading branch information
JonathanTGold and JonathanTGold authored Feb 6, 2024
1 parent a9b052e commit b3e5269
Show file tree
Hide file tree
Showing 19 changed files with 249 additions and 10,199 deletions.
10 changes: 4 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
Please add a detailed description of the change, whether it's an enhancement or a bugfix.
If the PR is related to an open issue please link to it.

### CheckLists
**Issue:**

- [ ] changes have been done against master branch, and PR does not conflict
- [ ] new unit / functional tests have been added (whenever applicable)
- [ ] test are passing in local environment
- [ ] Travis tests are passing (or test results are not worse than on master branch :))
- [ ] Docs have been updated
**Fix:**

#### Resolves FEC-[Please add the ticket reference here]
2 changes: 1 addition & 1 deletion analytics-service/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@playkit-js/playkit-js-providers/analytics-service",
"main": "../dist/playkit-analytics-service.js",
"types": "../dist/index.d.ts",
"types": "../dist/analytics-service.d.ts",
"sideEffects": false
}
39 changes: 39 additions & 0 deletions api-extracor-config/api-extractor-analytics-service.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/k-provider/ovp/services/analytics/index.d.ts",
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": false,
"reportFolder": "<projectFolder>/api-extractor/report",
"reportTempFolder": "<projectFolder>/api-extractor/report-temp"
},
"docModel": {
"enabled": false,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/analytics-service.d.ts"
},
"tsdocMetadata": {
"tsdocMetadataFilePath": "../dist/tsdoc-metadata.json"
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
}
}
}
39 changes: 39 additions & 0 deletions api-extracor-config/api-extractor-bookmark-service.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/k-provider/ott/services/bookmark/index.d.ts",
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": false,
"reportFolder": "<projectFolder>/api-extractor/report",
"reportTempFolder": "<projectFolder>/api-extractor/report-temp"
},
"docModel": {
"enabled": false,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/bookmark-service.d.ts"
},
"tsdocMetadata": {
"tsdocMetadataFilePath": "../dist/tsdoc-metadata.json"
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
}
}
}
39 changes: 39 additions & 0 deletions api-extracor-config/api-extractor-ott-provider.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/k-provider/ott/index.d.ts",
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": false,
"reportFolder": "<projectFolder>/api-extractor/report",
"reportTempFolder": "<projectFolder>/api-extractor/report-temp"
},
"docModel": {
"enabled": false,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/ott-provider.d.ts"
},
"tsdocMetadata": {
"tsdocMetadataFilePath": "../dist/tsdoc-metadata.json"
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
}
}
}
39 changes: 39 additions & 0 deletions api-extracor-config/api-extractor-ovp-provider.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/k-provider/ovp/index.d.ts",
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": false,
"reportFolder": "<projectFolder>/api-extractor/report",
"reportTempFolder": "<projectFolder>/api-extractor/report-temp"
},
"docModel": {
"enabled": false,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/ovp-provider.d.ts"
},
"tsdocMetadata": {
"tsdocMetadataFilePath": "../dist/tsdoc-metadata.json"
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
}
}
}
39 changes: 39 additions & 0 deletions api-extracor-config/api-extractor-stats-service.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/k-provider/ovp/services/stats/index.d.ts",
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": false,
"reportFolder": "<projectFolder>/api-extractor/report",
"reportTempFolder": "<projectFolder>/api-extractor/report-temp"
},
"docModel": {
"enabled": false,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/stats-service.d.ts"
},
"tsdocMetadata": {
"tsdocMetadataFilePath": "../dist/tsdoc-metadata.json"
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": true,
"enabled": false,
"reportFolder": "<projectFolder>/api-extractor/report",
"reportTempFolder": "<projectFolder>/api-extractor/report-temp"
},
"docModel": {
"enabled": true,
"enabled": false,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "<projectFolder>/dist/index.d.ts"
"untrimmedFilePath": "<projectFolder>/dist/types.d.ts"
},
"tsdocMetadata": {
"tsdocMetadataFilePath": "../dist/tsdoc-metadata.json"
},
"tsdocMetadata": {},
"messages": {
"compilerMessageReporting": {
"default": {
Expand Down
Loading

0 comments on commit b3e5269

Please sign in to comment.