Add types definitions

Author: usulpro

README.md

@@ -11,6 +11,7 @@ Simplifies the addons creation. Keeps in sync addon's data through the channel.
 - Provides redux like approach to deal with your addon store via selectors and actions (but don't worry, the default action just simply override your data)
 - Allows to connect any amount of pannels, buttons and any other addon types to the single addon store
 - Offers UI container which automatically reflects the aspect ratio of addon panel. Extremely useful to create addon UI responsive for vertical and horizontal panel positions
+- Includes Typescript definitions
 
 ## Usage
 

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@storybook/addon-devkit",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Storybook Addon Development Kit",
   "author": {
     "name": "Oleg Proskurin",
     "url": "https://github.com/UsulPro"
   },
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest",
     "tdd": "jest --watch",
@@ -16,7 +17,7 @@
     "build-storybook": "build-storybook -s public",
     "dev": "nodemon --exec yarn prepare",
     "prepare-dev": "babel dev --out-dir dev-dist --verbose",
-    "prepare": "package-prepare",
+    "prepare": "package-prepare && cp src/index.d.ts dist",
     "postpublish": "node .scripts/npm-postpublish.js"
   },
   "dependencies": {
@@ -36,6 +37,7 @@
     "@storybook/addon-backgrounds": "^5.1.9",
     "@storybook/addon-links": "^5.1.9",
     "@storybook/react": "^5.1.9",
+    "@types/react": "^16.9.19",
     "@usulpro/package-prepare": "^1.1.4",
     "babel-eslint": "^10.0.1",
     "babel-jest": "^24.9.0",

src/index.d.ts

@@ -0,0 +1,60 @@
+type Store = {
+  [key: string]: any
+};
+
+type Selector = (store: Store) => any;
+type ParamSelector = (parameters: {
+  [key: string]: any
+}, selectors: {
+  [key: string]: any
+}) => any;
+
+type ActionDispatcher = (...args: any[]) => void | Promise<void>;
+type ActionGenerator = (
+  action: (store: Store, ...args: any[]) => Store | Promise<Store>
+) => ActionDispatcher;
+type Actions = ({ local: ActionGenerator, global: ActionGenerator }) => {
+  [key: string]: ActionDispatcher
+};
+
+export declare function register(
+  storeSelectors: {
+    [key: string]: Selector
+  },
+  createActions: Actions
+): (Component: React.ComponentType) => void;
+
+
+interface StoryContext {
+  id: string;
+  name: string;
+  kind: string;
+  [key: string]: any;
+  parameters: Parameters;
+}
+
+export type StoryFn<ReturnType = unknown> = (p?: StoryContext) => ReturnType;
+type DecoratorFunction = (fn: StoryFn, c: StoryContext) => ReturnType<StoryFn>;
+
+/**
+ * Options that controls decorator behavior
+ */
+type DecoratorOptions = {
+  isGlobal: boolean,
+}
+
+export declare function createDecorator(storeSelectors: {
+  [key: string]: Selector
+},
+  createActions: Actions,
+  paramSelectors: {
+    [key: string]: ParamSelector
+  }
+): (Component: React.ComponentType, options: DecoratorOptions) => DecoratorFunction;
+
+type AddonParameters = {
+  [key: string]: any
+}
+export declare function setParameters(): <T extends AddonParameters>(T) => ({
+  addonKey: T
+})

yarn.lock

@@ -2205,6 +2205,14 @@
     "@types/prop-types" "*"
     csstype "^2.2.0"
 
+"@types/react@^16.9.19":
+  version "16.9.19"
+  resolved "https://registry.yarnpkg.com/@types/react/-/react-16.9.19.tgz#c842aa83ea490007d29938146ff2e4d9e4360c40"
+  integrity sha512-LJV97//H+zqKWMms0kvxaKYJDG05U2TtQB3chRLF8MPNs+MQh/H1aGlyDUxjaHvu08EAGerdX2z4LTBc7ns77A==
+  dependencies:
+    "@types/prop-types" "*"
+    csstype "^2.2.0"
+
 "@types/stack-utils@^1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-1.0.1.tgz#0a851d3bd96498fa25c33ab7278ed3bd65f06c3e"