Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TypeScript type definitions #231

Closed
wants to merge 5 commits into from

Conversation

oleksandrpravosudko-okta
Copy link
Contributor

  • add auto-generated and manual type definitions
  • run typescript-eslint/eslint-plugin and tsd

Resolves OKTA-291123

* WIP on generating TS type declarations for operations

* add templates for type files and add template helper functions

* move typings to src/types

* re-use signature getter for models and generated client

* add types index and remove unused templates

* unify export syntax

* reduce blocklisted models filtering duplication

* export model types

* add factories templates and push generated model types

* switch to named model exports

* actually run eslint on templates dir

* set proper return type for Collection and mark optional arguments

* mark read-only properties

* do default export models along with named export

* expose Client type and add missing types

* add re-generated models and remove manually-generated types

* restore array type value and read-only modifier

* bring models named export back

* generate factories types

* export GeneratedClient
* to be switched to Client in the downnstream branch

* specify correct types for Model constructor arguments

* import Client for all models

* remove default exports from models

* remove models and factories index template

* add extra newline for generated models, remove indents from type map, do not re-export model types

* move eslint target for templates to downstream branch

* add missing 'autogenerated' warning banner to templates

* remove extra whitespaces, regenerate files

* parametrize Collection return type in generated files

* include generic type into imports list and re-generate types

* preserve non-optinal query parameters

* correct return type to be Response instead of undefined, include CRUD return type into imports

* CR: remove copyright banners from templates
… tsd (re-opened) (#230)

* WIP on generating TS type declarations for operations

* WIP on adding types for core objects

* update type references in core objects

* WIP on adding types for core objects

* update type references in core objects

* run typescript-eslint on src/types

* WIP on fixing ts-lint errors

* represent object type as Record<string, unknown>

* define RequestOptions type

* define more specific type for core objects

* add basic tsd test

* install @types/node-fetch types

* specify sourceType: module for types eslint config

* add more tsd assertions

* complete basic coverage for core object types assertions

* include tsd run into test target

* export types matching code exports

* fix syntactic error in command

* fix indents and apply basic eslint rules to definitions files

* parametrize Collection type definition

* list known config properties, update jwt function return type

* widen type for cache middleware next function

* replace MemoryStore references with CacheStorage

* extract IRequestExecutor interface, make MemoryStore parameters optional

* allow request executors w/o event emission

* correct types for collection subscribers

* CR: cascade eslint configuration

* fix revealed eslint errors

* move type tests to a separate directory

* CR: break down type tests

* add type assertions for generated client methods

* use named import for Response

* allow imports for create and delete operations only

* remove unused import

* fix rebase artifact
@oleksandrpravosudko-okta oleksandrpravosudko-okta changed the base branch from 4.5 to master March 12, 2021 16:17
Copy link
Contributor

@aarongranick-okta aarongranick-okta left a comment

Choose a reason for hiding this comment

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

ship it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants