feat: add typescript declarations #413

aarongranick-okta · 2020-07-10T00:27:49Z

The main visible change from this refactor is that the module uses named exports instead of a default export. This allows users to import the main OktaAuth class but also any exported types.

shuowu · 2020-07-24T17:13:08Z

lib/browser/index.js

nit: some syntax sugar, export { default as OktaAuth } from './browser';

shuowu · 2020-07-24T17:15:55Z

lib/clock.ts

+}
+
+// factory method. Create an instance of a clock from current context.
+SdkClock.create = function(/* sdk, options */) {


keep it static in class?

shuowu · 2020-07-24T17:30:08Z

lib/errors/AuthApiError.js

+  constructor(err, xhr = null) {
+    const message = err.errorSummary;
+    super(message); // 'Error' breaks prototype chain here
+    Object.setPrototypeOf(this, new.target.prototype); // restore prototype chain


Not sure what's the issue with extending the Error class, but looks like there is a hack needed to make it work. Wondering if we can use any babel plugin to handle it or move the logic to a BaseError class to make future changes easier?

A search for "typescript extend error prototype" will show more information on the issue, here is an example that also shows this solution: https://stackoverflow.com/questions/41102060/typescript-extending-error-class

A base CustomError class could possibly make this slightly simpler.

I'll vote for a base error class, also I think it would be better to add the StackOverflow link in code.

lib/errors/AuthApiError.js

shuowu · 2020-07-24T17:34:20Z

lib/server/index.js

nit: export { default as OktaAuth } from './server';

shuowu · 2020-07-24T17:37:44Z

lib/server/server.js

 import { getUserAgent } from '../builderUtil';
 import serverStorage from './serverStorage';
-import PACKAGE_JSON from '../../package.json';
+const PACKAGE_JSON = require('../../package.json');


import * as PACKAGE_JSON from '../../package.json' may work

In this case, the issue is that importing a JSON file via typescript requires the esModuleInterop flag to be turned on. I specifically want this flag off because if we have it on the requirement of using this flag is passed along to other users of our ES module, such as okta-angular.

So the same issue for node-cache?

Yes, node-cache is a commonJS module. It can only be imported by using the allowSyntheticDefaultImports and esModuleInterop flags.

shuowu · 2020-07-24T17:48:06Z

webpack.config.js

@@ -11,26 +11,15 @@ var commonConfig = require('./webpack.common.config');
 var license = fs.readFileSync('lib/license-header.txt', 'utf8');

 module.exports = _.extend({}, _.cloneDeep(commonConfig), {
-  entry: './lib/browser/index.js',
+  mode: 'production',


hah, I was meaning this flag in the last review.

Yes webpack was upgraded to version 4 in this PR

shuowu · 2020-07-24T18:00:46Z

Great progress with Typescript! Several comments here:

I saw some import statements change in tests, they all look good to me, just want to be careful that we are not introducing breaking changes for downstream SDKs/Apps.
Some files have been converted to ts, but some are not. What the rule you followed to convert files?
Tests and exported packages from package.json both look good. Types also should be fine. That's the list I can think of, just want to make sure we covered everything before release.

aarongranick-okta · 2020-07-24T18:13:51Z

Great progress with Typescript! Several comments here:

I saw some import statements change in tests, they all look good to me, just want to be careful that we are not introducing breaking changes for downstream SDKs/Apps.

There is a breaking change. We have switched from a default export to named exports. So commonJS code like

var OktaAuth = require('@okta/okta-auth-js') must now be something like
var OktaAuth = require('@okta/okta-auth-js').OktaAuth.

Similarly imports of
import OktaAuth = from '@okta/okta-auth-js' must now use
import { OktaAuth } = from '@okta/okta-auth-js'.

This is necessary to provide types as separate named exports, and to enable tree-shaking.

Some files have been converted to ts, but some are not. What the rule you followed to convert files?

Files which are used by NodeJS are retaining ES5 compatibility. This is not code in our library, but as part of config, test runners or dev servers, etc. Eventually we will probably convert all library code to .ts. However, the .js files are being processed by Typescript compiler. The rule is we must convert to .ts as soon as we use some Typescript syntax, such as return value or optional params. Since I will be addressing other comments, I may just finish conversion of the remaining files under /lib in this PR.

The unit tests, as well, would have some value in being converted to .ts as we would get some extra type checking. However I did not want to change the unit tests in this PR, Since this is a large refactor, I am counting on the unit tests to sanity check that we haven't broken anything.

I did convert the E2E test app to Typescript, since this validates that our exported types are consumable from another app.

aarongranick-okta · 2020-07-24T23:19:53Z

@shuowu feedback addressed, also converted remaining files under lib/ to .ts extension

shuowu · 2020-07-24T23:23:50Z

LGTM!

swiftone · 2020-07-27T17:55:20Z

.eslintrc.json

@@ -16,6 +19,14 @@
    "setInterval": true,
    "clearInterval": true
  },
+  "settings": {
+    "jsdoc": {


Should we have updates to README or CONTRIBUTING regarding the typescript? Is the build/inclusion process any different?

Good catch. There should be some updates to the README. Maybe a "migrating from 3.x" section. I will add it.

@swiftone Please take a look at changes added to README

swiftone · 2020-07-28T20:53:16Z

README.md

@@ -24,10 +25,13 @@ You can learn more on the [Okta + JavaScript][lang-landing] page in our document

 This library uses semantic versioning and follows Okta's [library version policy](https://developer.okta.com/code/library-versions/).

+## Release Status
+
 :heavy_check_mark: The current stable major version series is: `3.x`


Missed this line

swiftone · 2020-07-28T20:53:41Z

README.md

 :heavy_check_mark: The current stable major version series is: `3.x`

 | Version   | Status                           |
 | -------   | -------------------------------- |
+| `4.x`     | :fire: Latest release            |
 | `3.x`     | :heavy_check_mark: Stable        |


shouldn't 3.x get a retirement date in ~9 months?

swiftone · 2020-07-28T20:55:32Z

README.md

+* Now using named exports. You should change code like
+
+```javascript
+import OktaAuth from '@okta/okta-auth-js'


Perhaps put a comment in, like: // previous 3.x way - people will skim for the code blocks and may not notice that this is the "old" block, not the "new" block

swiftone · 2020-07-28T20:56:27Z

README.md

+const OktaAuth = require('@okta/okta-auth-js').OktaAuth;
+```
+
+* Typescript definitions are now included. If you were providing your own definitions for `OktaAuth` you should remove these in favor of the types exported by this library.


I'd put in a mention that these are optional to reassure people who don't want TS

swiftone

A few nits on the README

* feat: support typescript, use named exports

* bump version to 4.0.0 * ES6 Refactor (#388) * move module from packages to repo root * rename browser/server index * update eslint, use ecmaVersion 2020 * feat: add typescript declarations (#413) * feat: support typescript, use named exports * removes "onSessionExpired" option (#444) implements active autoRenew * Builds to "build" folder, CDN content in "build/dist" * Fixes compatibility with CDN / static app

aarongranick-okta force-pushed the ag-ts-4.0-OKTA-241766 branch from 332b833 to 040185d Compare July 10, 2020 00:39

aarongranick-okta force-pushed the ag-ts-4.0-OKTA-241766 branch 3 times, most recently from 91a192b to 2bf1ec1 Compare July 23, 2020 07:00

aarongranick-okta marked this pull request as ready for review July 23, 2020 07:32

aarongranick-okta force-pushed the ag-ts-4.0-OKTA-241766 branch from 61a9116 to 9ff03dd Compare July 23, 2020 17:43

aarongranick-okta force-pushed the dev-4.0 branch 4 times, most recently from 45b2dff to 1c9ab9e Compare July 23, 2020 20:11

feat: add typescript declarations

e8dbc72

aarongranick-okta force-pushed the ag-ts-4.0-OKTA-241766 branch from 9ff03dd to e8dbc72 Compare July 23, 2020 20:58

aarongranick-okta requested review from shuowu and swiftone July 23, 2020 22:20

swiftone mentioned this pull request Jul 23, 2020

Add Type Definitions to okta-react so it can be easily be used in a TypeScript project okta/okta-oidc-js#66

Closed

shuowu reviewed Jul 24, 2020

View reviewed changes

lib/errors/AuthApiError.js Outdated Show resolved Hide resolved

shuowu reviewed Jul 24, 2020

View reviewed changes

shuowu approved these changes Jul 24, 2020

View reviewed changes

review feedback; convert remaining lib code to ts

6557fb0

swiftone reviewed Jul 27, 2020

View reviewed changes

Updated README and CHANGELOG

ac51614

swiftone reviewed Jul 28, 2020

View reviewed changes

swiftone approved these changes Jul 28, 2020

View reviewed changes

Update README.md

2f49f11

aarongranick-okta merged commit b491c64 into dev-4.0 Jul 29, 2020

aarongranick-okta deleted the ag-ts-4.0-OKTA-241766 branch July 29, 2020 02:49

aarongranick-okta added a commit that referenced this pull request Aug 1, 2020

feat: add typescript declarations (#413)

4e6029f

* feat: support typescript, use named exports

aarongranick-okta added a commit that referenced this pull request Aug 1, 2020

feat: add typescript declarations (#413)

209bb11

* feat: support typescript, use named exports

aarongranick-okta added a commit that referenced this pull request Aug 1, 2020

feat: add typescript declarations (#413)

9a65e52

* feat: support typescript, use named exports

swiftone mentioned this pull request Aug 3, 2020

TypeScript Definitions okta/okta-sdk-nodejs#52

Closed

aarongranick-okta added a commit that referenced this pull request Aug 11, 2020

feat: add typescript declarations (#413)

a020c64

* feat: support typescript, use named exports

aarongranick-okta added a commit that referenced this pull request Aug 11, 2020

feat: add typescript declarations (#413)

68ae3a3

* feat: support typescript, use named exports

aarongranick-okta added a commit that referenced this pull request Aug 12, 2020

feat: add typescript declarations (#413)

e46304f

* feat: support typescript, use named exports

aarongranick-okta added a commit that referenced this pull request Aug 12, 2020

feat: add typescript declarations (#413)

9aabe54

* feat: support typescript, use named exports

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add typescript declarations #413

feat: add typescript declarations #413

aarongranick-okta commented Jul 10, 2020 •

edited

Loading

shuowu Jul 24, 2020

shuowu Jul 24, 2020

shuowu Jul 24, 2020

aarongranick-okta Jul 24, 2020

shuowu Jul 24, 2020

shuowu Jul 24, 2020

shuowu Jul 24, 2020

aarongranick-okta Jul 24, 2020

shuowu Jul 24, 2020

aarongranick-okta Jul 24, 2020

shuowu Jul 24, 2020

aarongranick-okta Jul 24, 2020

shuowu commented Jul 24, 2020

aarongranick-okta commented Jul 24, 2020

aarongranick-okta commented Jul 24, 2020

shuowu commented Jul 24, 2020

swiftone Jul 27, 2020

aarongranick-okta Jul 28, 2020

aarongranick-okta Jul 28, 2020

swiftone Jul 28, 2020

swiftone Jul 28, 2020

swiftone Jul 28, 2020

swiftone Jul 28, 2020

swiftone left a comment

feat: add typescript declarations #413

feat: add typescript declarations #413

Conversation

aarongranick-okta commented Jul 10, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shuowu commented Jul 24, 2020

aarongranick-okta commented Jul 24, 2020

aarongranick-okta commented Jul 24, 2020

shuowu commented Jul 24, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

swiftone left a comment

Choose a reason for hiding this comment

aarongranick-okta commented Jul 10, 2020 •

edited

Loading