Add generated models and factories types #225

oleksandrpravosudko-okta · 2021-02-16T15:23:33Z

add generated *.d.ts files
update return type Promise<Collection> to Collection for model methods and generated client
update return type Promise<undefined> to Promise<Response> for model methods and generated client
mark optional parameters

swiftone · 2021-03-04T19:42:06Z

src/types/factories/PolicyFactory.d.ts

-/**
- *  THIS FILE IS AUTO-GENERATED - SEE CONTRIBUTOR DOCUMENTATION
- */


This does raise an issue - these files are autogenerated, yes? Can we add a comment to that extent? I lost a day recently in another codebase editing a generated file and it is not fun to discover.

Or are the Factories not generated?

Handlebars files are not autogenerated but they contain this banner so it gets into generated .d.ts and .js files. This template is deleted because there seem to be no need in having index file for model types.

It makes sense to have it for for JS files so all models can be imported into GeneratedClient using Node syntax and referenced in methods bodies. For type definitions we import model types that are referenced by methods signatures explicitly.

Thanks for mentioning this - it looks like some of templates do not have warning banner included - going to fix that.

shuowu · 2021-03-11T18:13:04Z

templates/factory.d.ts.hbs

@@ -0,0 +1,21 @@
+/*!


nit: we probably can get rid of the banners from the templates as we already have logic to handle it in one place (https://github.com/okta/okta-sdk-nodejs/blob/master/package.json#L14)

shuowu · 2021-03-11T18:31:10Z

LGTM! Please squash the commits when merge to the upper-level branch.

* to be switched to Client in the downnstream branch

… do not re-export model types

… return type into imports

add generated models and factories types (#225) * 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 Add type definitions for core objects, add typescript-eslint-plugin + 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 remove irrelevant changes update changelog entry for 4.5.0 OKTA-373751 <<<Jenkins Check-In of Tested SHA: 1013098 for [email protected]>>> Artifact: okta-sdk-nodejs

theseyi · 2021-04-05T17:49:36Z

Thanks for working on this. Any plans to release the types as part of the published SDK? The latest version 4.5.0 as of Apr 5, 2021 does not ship with types even though it is referenced in the package manifest @oleksandrpravosudko-okta

oleksandrpravosudko-okta · 2021-04-05T18:35:34Z

@theseyi Types look available in 4.5.0. Would you mind describing a scenario in which you are not able to use them?

theseyi · 2021-04-05T18:44:10Z

@theseyi Types look available in 4.5.0. Would you mind describing a scenario in which you are not able to use them?

Hey @oleksandrpravosudko-okta this was my fault. I just updated to 4.5 from 4.4 and it took a second for my editor to pick up the types folder in node_modules. I've just reverified and the types are there as expected. Thanks for responding, and sorry for the distraction! 😓

theseyi · 2021-04-06T05:47:22Z

Is it possible to make accessible externally, the User class?

Trying to import from src/types/models/User raises the following typescript error since it is not exported under index.d.ts

Error: Cannot find module '@okta/okta-sdk-nodejs/src/types/models/User'
Require stack:

oleksandrpravosudko-okta · 2021-04-06T08:28:52Z

Hi @theseyi - types that are imported 'outside' of index.d.ts can not be used in new ClassName() expressions as it results in attempt to load type modules in runtime with commonJS loader.

Unfortunately, there is an issue with generated client's method signatures (some methods expect model instances to be passed which should not be the case). I am working on getting those fixed and will release a new version afterwards - sorry for inconvenience.

theseyi · 2021-04-06T14:50:06Z

Hi @theseyi - types that are imported 'outside' of index.d.ts can not be used in new ClassName() expressions as it results in attempt to load type modules in runtime with commonJS loader.

I see, thanks for clarifying @oleksandrpravosudko-okta. I was looking at the example you provided and on line1: import { Application } from "@okta/okta-sdk-nodejs/src/types/models/Application"; so in reality I'm assuming the example should not work since Application not explicitly exported in the index? or is there a difference here?

Unfortunately, there is an issue with generated client's method signatures (some methods expect model instances to be passed which should not be the case). I am working on getting those fixed and will release a new version afterwards - sorry for inconvenience.

Thanks for looking into this

oleksandrpravosudko-okta · 2021-04-09T08:41:27Z

@theseyi please check out 4.5.1 release.

There is a short section in 4.5 README describing the suggested usage.

so in reality I'm assuming the example should not work since Application not explicitly exported in the index? or is there a difference here?

Unless I am misunderstanding the question, import { Application, ApplicationOptions } from "@okta/okta-sdk-nodejs/src/types/models/Application" should work as long as Application and ApplicationOptions are used as types only - please let me know if you are referring to a different scenario.

theseyi · 2021-04-09T18:33:13Z

I thought I saw new Application(...) in the original example, seems like it misread, thanks. I guess that means exposing the User class at runtime for instantiation is not a planned implementation?

oleksandrpravosudko-okta · 2021-04-14T13:32:37Z

@theseyi Right, imports from src/types/* are intended for specifying types only. There are community suggestions on this approach being non-optimal - I'll see if this can be changed.

oleksandrpravosudko-okta force-pushed the op-okta-291118-operations-typescript-definitions branch from 59c916f to cb3980a Compare February 16, 2021 15:26

oleksandrpravosudko-okta force-pushed the op-okta-241753-models-typescript-definitions branch 2 times, most recently from fe2e929 to 5aa2dee Compare February 16, 2021 15:33

oleksandrpravosudko-okta mentioned this pull request Feb 18, 2021

Typescript definitions for operations #224

Merged

Base automatically changed from op-okta-291118-operations-typescript-definitions to op-ts-types-support February 24, 2021 12:57

oleksandrpravosudko-okta force-pushed the op-okta-241753-models-typescript-definitions branch from 5aa2dee to 9e81035 Compare February 24, 2021 13:09

oleksandrpravosudko-okta force-pushed the op-ts-types-support branch from eba75e9 to 75a9abf Compare February 26, 2021 10:03

oleksandrpravosudko-okta force-pushed the op-okta-241753-models-typescript-definitions branch from 74f3a88 to 63e65b4 Compare February 26, 2021 11:15

oleksandrpravosudko-okta marked this pull request as ready for review February 26, 2021 17:44

oleksandrpravosudko-okta force-pushed the op-okta-241753-models-typescript-definitions branch 3 times, most recently from cb6968b to f52ad1a Compare March 4, 2021 17:18

swiftone reviewed Mar 4, 2021

View reviewed changes

oleksandrpravosudko-okta force-pushed the op-okta-241753-models-typescript-definitions branch 4 times, most recently from e20069a to e66f50b Compare March 11, 2021 17:10

shuowu reviewed Mar 11, 2021

View reviewed changes

shuowu approved these changes Mar 11, 2021

View reviewed changes

oleksandrpravosudko-okta force-pushed the op-ts-types-support branch from 75a9abf to 5484cab Compare March 12, 2021 12:13

oleksandrpravosudko-okta added 9 commits March 12, 2021 14:26

WIP on generating TS type declarations for operations

691e738

add templates for type files and add template helper functions

e59bc51

move typings to src/types

06e44a6

re-use signature getter for models and generated client

25e633b

add types index and remove unused templates

b9f5cac

unify export syntax

c632ac2

reduce blocklisted models filtering duplication

49c2728

export model types

2b82185

add factories templates and push generated model types

1d0bb03

oleksandrpravosudko-okta added 17 commits March 12, 2021 14:31

restore array type value and read-only modifier

3cc7708

bring models named export back

9b36d45

generate factories types

d3afc22

export GeneratedClient

b3ccbf7

* to be switched to Client in the downnstream branch

specify correct types for Model constructor arguments

a0164db

import Client for all models

d7a814a

remove default exports from models

3384e9d

remove models and factories index template

7aad708

add extra newline for generated models, remove indents from type map,…

da2adb1

… do not re-export model types

move eslint target for templates to downstream branch

1e98175

add missing 'autogenerated' warning banner to templates

74295ec

remove extra whitespaces, regenerate files

44c43d0

parametrize Collection return type in generated files

ad4d1af

include generic type into imports list and re-generate types

b9053c2

preserve non-optinal query parameters

e083a60

correct return type to be Response instead of undefined, include CRUD…

116614e

… return type into imports

CR: remove copyright banners from templates

34d57b7

oleksandrpravosudko-okta force-pushed the op-okta-241753-models-typescript-definitions branch from 8b81ec3 to 34d57b7 Compare March 12, 2021 12:33

oleksandrpravosudko-okta merged commit c55ffd5 into op-ts-types-support Mar 12, 2021

oleksandrpravosudko-okta deleted the op-okta-241753-models-typescript-definitions branch March 12, 2021 13:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add generated models and factories types #225

Add generated models and factories types #225

oleksandrpravosudko-okta commented Feb 16, 2021 •

edited

Loading

swiftone Mar 4, 2021 •

edited

Loading

oleksandrpravosudko-okta Mar 5, 2021

shuowu Mar 11, 2021

shuowu commented Mar 11, 2021

theseyi commented Apr 5, 2021

oleksandrpravosudko-okta commented Apr 5, 2021 •

edited

Loading

theseyi commented Apr 5, 2021

theseyi commented Apr 6, 2021

oleksandrpravosudko-okta commented Apr 6, 2021

theseyi commented Apr 6, 2021 •

edited

Loading

oleksandrpravosudko-okta commented Apr 9, 2021

theseyi commented Apr 9, 2021

oleksandrpravosudko-okta commented Apr 14, 2021

Add generated models and factories types #225

Add generated models and factories types #225

Conversation

oleksandrpravosudko-okta commented Feb 16, 2021 • edited Loading

swiftone Mar 4, 2021 • edited Loading

Choose a reason for hiding this comment

oleksandrpravosudko-okta Mar 5, 2021

Choose a reason for hiding this comment

shuowu Mar 11, 2021

Choose a reason for hiding this comment

shuowu commented Mar 11, 2021

theseyi commented Apr 5, 2021

oleksandrpravosudko-okta commented Apr 5, 2021 • edited Loading

theseyi commented Apr 5, 2021

theseyi commented Apr 6, 2021

oleksandrpravosudko-okta commented Apr 6, 2021

theseyi commented Apr 6, 2021 • edited Loading

oleksandrpravosudko-okta commented Apr 9, 2021

theseyi commented Apr 9, 2021

oleksandrpravosudko-okta commented Apr 14, 2021

oleksandrpravosudko-okta commented Feb 16, 2021 •

edited

Loading

swiftone Mar 4, 2021 •

edited

Loading

oleksandrpravosudko-okta commented Apr 5, 2021 •

edited

Loading

theseyi commented Apr 6, 2021 •

edited

Loading