Ts migration/client api #7147

Jessica-Koch · 2019-06-19T08:37:06Z

Issue:

What I did

migrated the client-api to typescript, there are some errors, I wasn't sure how to type a couple of functions so I left them as is. Everything builds.

How to test

Is this testable with Jest or Chromatic screenshots? yes
Does this need a new example in the kitchen sink apps? no
Does this need an update to the documentation? no

If your answer is yes to any of these, please make sure to include it in your PR.

…uld really fix that!

vercel · 2019-06-19T08:37:13Z

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-ts-migration-client-api.storybook.now.sh

ndelangen · 2019-06-20T08:58:15Z

lib/client-api/src/client_api.ts

 export default class ClientApi {
-  constructor({ storyStore, decorateStory = defaultDecorateStory } = {}) {
+  _storyStore: StoryStore;


could we use private fields here?

yes we can.

ndelangen · 2019-06-20T11:25:37Z

src/client_api.ts(36,32): error TS7006: Parameter 'context' implicitly has an 'any' type.
src/client_api.ts(38,10): error TS7006: Parameter 'p' implicitly has an 'any' type.
src/client_api.ts(165,7): error TS7017: Element implicitly has an 'any' type because type '{ kind: string; }' has no index signature.
src/client_api.ts(166,15): error TS2339: Property 'apply' does not exist on type 'Addon'.
src/client_api.ts(171,9): error TS2339: Property 'add' does not exist on type '{ kind: string; }'.
src/client_api.ts(208,49): error TS2345: Argument of type '{}' is not assignable to parameter of type 'IHierarchyObj'.
  Type '{}' is missing the following properties from type 'IHierarchyObj': hierarchyRootSeparator, hierarchySeparator
src/client_api.ts(227,9): error TS2554: Expected 1 arguments, but got 2.
src/client_api.ts(240,9): error TS2339: Property 'addDecorator' does not exist on type '{ kind: string; }'.
src/client_api.ts(251,9): error TS2339: Property 'addParameters' does not exist on type '{ kind: string; }'.
src/story_store.ts(102,21): error TS7031: Binding element 'storyId' implicitly has an 'any' type.
src/story_store.ts(102,30): error TS7031: Binding element 'viewMode' implicitly has an 'any' type.
src/story_store.ts(158,43): error TS2322: Type 'void' is not assignable to type '{}'.
src/story_store.ts(214,30): error TS2339: Property 'fileName' does not exist on type '{} | { fileName: string; }'.
  Property 'fileName' does not exist on type '{}'.
src/types.ts(347,12): error TS2304: Cannot find name 'storyFn'.
src/types.ts(347,12): error TS4033: Property 'storyFn' of exported interface has or is using private name 'storyFn'.

Jessica-Koch · 2019-06-21T03:06:21Z

that's odd, I resolved those, will go back and check again.

gaetanmaisse · 2019-06-25T13:33:16Z

lib/client-api/src/config_api.ts

@@ -14,10 +48,17 @@ export default class ConfigApi {

  _renderMain() {
    // do initial render of story
+    debugger;


hmm not sure it should be still here 😉

it should not, i am actually battling with node-gyp and cannot build storybook anymore, will be updating PR HOPEFULLY tonight; post reformating

…tion/client-api

Committer: Jessica-Koch <[email protected]>

# Conflicts: # lib/client-api/package.json

ndelangen · 2019-07-02T00:38:55Z

@gaetanmaisse could you possibly help review this?

gaetanmaisse · 2019-07-02T11:39:28Z

lib/addons/src/make-decorator.ts

  parameters: {
    [key: string]: any;
  };
 }

+export interface OptionsParameter extends Object {


Just wonder why extends Object?

lib/client-api/src/client_api.ts

lib/client-api/src/config_api.ts

lib/client-api/src/story_store.ts

ndelangen · 2019-07-02T13:45:29Z

Thank you for the review @gaetanmaisse

lonyele · 2019-07-03T02:35:39Z

lib/client-api/src/story_store.ts

+
+  _data: StoreData;
+
+  _legacyData?: LegacyData;


My guess is that you were trying to fix naming from _legacydata to _legacyData but somehow not finished or discarded changing?

I'm fearful of changing too much, this SHOULd be an internal api, but I am aware of some integrations hooking into this, and preferably I would like to change it at a later point at the 6.0 release instead.

@ndelangen what's _legacyData?! Seems unused throughout the codebase?

# Conflicts: # lib/client-api/package.json

# Conflicts: # addons/ondevice-backgrounds/src/BackgroundPanel.js # lib/client-api/package.json # lib/client-api/src/story_store.ts

shilman · 2019-07-22T17:34:36Z

lib/client-api/src/story_store.ts

  input.replace(/[^a-z0-9]+([a-z0-9])/gi, (...params) => params[1].toUpperCase());

-const toChild = it => ({ ...it });
+const toChild = (it: {}) => ({ ...it });


@ndelangen unused?

shilman · 2019-07-23T02:04:08Z

lib/client-api/src/client_api.ts

@@ -130,26 +144,25 @@ export default class ClientApi {
    if (m && m.hot && m.hot.dispose) {
      m.hot.dispose(() => {
        const { _storyStore } = this;
-        _storyStore.remove();


ndelangen and others added 3 commits June 17, 2019 21:18

CHANGE versions again, sorry, CLI tests use published version, we sho…

fcbff29

…uld really fix that!

correct some linting errors

f3fbfe0

merge

ccbc81c

Jessica-Koch added maintenance User-facing maintenance tasks typescript preview-api labels Jun 19, 2019

Jessica-Koch requested review from igor-dv, kroeder, ndelangen, leoyli and shilman June 20, 2019 04:58

Jessica-Koch self-assigned this Jun 20, 2019

ndelangen reviewed Jun 20, 2019

View reviewed changes

ndelangen approved these changes Jun 20, 2019

View reviewed changes

Jessica-Koch added 2 commits June 22, 2019 18:40

fix merge conflicts

6db0abb

broken...need to rebuild, sorry

5d2f9b9

vercel bot had a problem deploying to staging June 23, 2019 01:41 Failure

gaetanmaisse reviewed Jun 25, 2019

View reviewed changes

Jessica Koch and others added 3 commits June 30, 2019 14:47

Merge branch 'next' of github.com:storybookjs/storybook into ts-migra…

e455427

…tion/client-api

complete typings of items except

ffc6318

Committer: Jessica-Koch <[email protected]>

add some dependencies

239e73e

Jessica-Koch requested a review from theinterned as a code owner July 1, 2019 07:33

vercel bot temporarily deployed to staging July 1, 2019 07:33 Inactive

add some dependencies

0052018

vercel bot had a problem deploying to staging July 1, 2019 07:34 Failure

ndelangen self-assigned this Jul 1, 2019

vercel bot had a problem deploying to staging July 1, 2019 14:12 Failure

ndelangen force-pushed the ts-migration/client-api branch from 76239e9 to 8eb8ffb Compare July 1, 2019 14:27

vercel bot had a problem deploying to staging July 1, 2019 14:27 Failure

FIX types

bcf18cc

ndelangen force-pushed the ts-migration/client-api branch from 8eb8ffb to bcf18cc Compare July 2, 2019 00:12

vercel bot temporarily deployed to staging July 2, 2019 00:12 Inactive

ndelangen added 2 commits July 2, 2019 02:16

Merge branch 'next' into ts-migration/client-api

e9679bb

# Conflicts: # lib/client-api/package.json

FIX lockfile

c5983e6

vercel bot deployed to staging July 2, 2019 00:21 View deployment

ndelangen added this to the 5.2.0 milestone Jul 2, 2019

gaetanmaisse reviewed Jul 2, 2019

View reviewed changes

lonyele reviewed Jul 3, 2019

View reviewed changes

Merge branch 'next' into ts-migration/client-api

a718ad1

# Conflicts: # lib/client-api/package.json

vercel bot had a problem deploying to staging July 4, 2019 08:47 Failure

IMPROVE types

ff924d7

vercel bot deployed to staging July 5, 2019 06:56 View deployment

ndelangen mentioned this pull request Jul 5, 2019

TS migrate: lib/client-api + app/angular + app/react + dependency upgrades #7323

Closed

ndelangen added 2 commits July 6, 2019 14:13

FIX linting

8936bf4

Merge branch 'next' into ts-migration/client-api

81848a9

# Conflicts: # addons/ondevice-backgrounds/src/BackgroundPanel.js # lib/client-api/package.json # lib/client-api/src/story_store.ts

Jessica-Koch requested a review from thomasbertet as a code owner July 6, 2019 12:43

vercel bot deployed to staging July 6, 2019 12:43 View deployment

ndelangen merged commit 0083afd into next Jul 6, 2019

ndelangen deleted the ts-migration/client-api branch July 6, 2019 13:29

shilman added a commit that referenced this pull request Jul 8, 2019

Fix breaking change in client_api due to #7147

ae178d4

shilman reviewed Jul 22, 2019

View reviewed changes

shilman reviewed Jul 23, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ts migration/client api #7147

Ts migration/client api #7147

Jessica-Koch commented Jun 19, 2019

vercel bot commented Jun 19, 2019 •

edited

Loading

ndelangen Jun 20, 2019

Jessica-Koch Jun 21, 2019

ndelangen commented Jun 20, 2019

Jessica-Koch commented Jun 21, 2019

gaetanmaisse Jun 25, 2019

Jessica-Koch Jun 26, 2019

ndelangen commented Jul 2, 2019

gaetanmaisse Jul 2, 2019

ndelangen commented Jul 2, 2019

lonyele Jul 3, 2019 •

edited

Loading

ndelangen Jul 6, 2019

shilman Jul 22, 2019

shilman Jul 22, 2019

ndelangen Jul 23, 2019

shilman Jul 23, 2019

Ts migration/client api #7147

Ts migration/client api #7147

Conversation

Jessica-Koch commented Jun 19, 2019

What I did

How to test

vercel bot commented Jun 19, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ndelangen commented Jun 20, 2019

Jessica-Koch commented Jun 21, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ndelangen commented Jul 2, 2019

Choose a reason for hiding this comment

ndelangen commented Jul 2, 2019

lonyele Jul 3, 2019 • 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

vercel bot commented Jun 19, 2019 •

edited

Loading

lonyele Jul 3, 2019 •

edited

Loading