feat: add better typings

storyblok · Jun 8, 2022 · 6bcfc5a · 6bcfc5a
1 parent 1970450
commit 6bcfc5a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/lib/index.ts b/lib/index.ts
@@ -4,6 +4,7 @@ import {
   StoryblokBridgeConfigV2,
   StoryblokBridgeV2,
   StoryData,
+  SbInitResult,
 } from "./types";
 
 const bridgeLatest = "https://app.storyblok.com/f/storyblok-v2-latest.js";
@@ -52,7 +53,7 @@ export const storyblokInit = (pluginOptions: SbSDKOptions = {}) => {
 
   // Initialize plugins
   const options = { bridge, apiOptions };
-  let result = {};
+  let result: SbInitResult = {};
 
   use.forEach((pluginFactory: Function) => {
     result = { ...result, ...pluginFactory(options) };

diff --git a/lib/modules/api.ts b/lib/modules/api.ts
@@ -1,7 +1,7 @@
 import StoryblokClient, { StoryblokConfig } from "storyblok-js-client";
-import { SbSDKOptions } from "../types";
+import { SbSDKOptions, SbPluginFactory } from "../types";
 
-export default (options: SbSDKOptions = {}) => {
+const apiFactory: SbPluginFactory = (options = {}) => {
   const { apiOptions } = options;
 
   if (!apiOptions.accessToken) {
@@ -14,3 +14,5 @@ export default (options: SbSDKOptions = {}) => {
   const storyblokApi = new StoryblokClient(apiOptions);
   return { storyblokApi };
 };
+
+export default apiFactory;
diff --git a/lib/types.ts b/lib/types.ts
@@ -1,4 +1,7 @@
-import { StoryblokConfig, StoryblokComponent } from "storyblok-js-client";
+import StoryblokClient, {
+  StoryblokConfig,
+  StoryblokComponent,
+} from "storyblok-js-client";
 
 declare global {
   interface Window {
@@ -7,6 +10,11 @@ declare global {
   }
 }
 
+export interface SbInitResult {
+  storyblokApi?: StoryblokClient;
+}
+
+export type SbPluginFactory = (options: SbSDKOptions) => any;
 export type SbBlokKeyDataTypes = string | number | object;
 
 export interface SbBlokData extends StoryblokComponent<string> {
@@ -16,7 +24,7 @@ export interface SbBlokData extends StoryblokComponent<string> {
 export interface SbSDKOptions {
   bridge?: boolean;
   accessToken?: string;
-  use?: [];
+  use?: [any];
   apiOptions?: StoryblokConfig;
 }