@looker/api-explorer 0.9.55 → 0.9.57

package/src/utils/path.ts

@@ -24,13 +24,13 @@
 
  */
 
-import type { ApiModel, IMethod, IType } from '@looker/sdk-codegen'
-import { firstMethodRef } from '@looker/sdk-codegen'
-import type { Location as HLocation } from 'history'
-import { matchPath } from 'react-router'
+import type { ApiModel, IMethod, IType } from '@looker/sdk-codegen';
+import { firstMethodRef } from '@looker/sdk-codegen';
+import type { Location as HLocation } from 'history';
+import { matchPath } from 'react-router';
 
-export const methodFilterOptions = /GET$|POST$|PUT$|PATCH$|DELETE$/i
-export const typeFilterOptions = /SPECIFICATION$|WRITE$|REQUEST$|ENUMERATED$/i
+export const methodFilterOptions = /GET$|POST$|PUT$|PATCH$|DELETE$/i;
+export const typeFilterOptions = /SPECIFICATION$|WRITE$|REQUEST$|ENUMERATED$/i;
 
 /**
  * Builds a path matching the route used by MethodScene
@@ -45,7 +45,7 @@ export const buildMethodPath = (
   tag: string,
   methodName: string,
   params?: string
-) => `/${specKey}/methods/${tag}/${methodName}${params ? `?${params}` : ''}`
+) => `/${specKey}/methods/${tag}/${methodName}${params ? `?${params}` : ''}`;
 
 /**
  * Builds a path matching the route used by TypeScene
@@ -60,10 +60,10 @@ export const buildTypePath = (
   tag: string,
   typeName: string,
   params?: string
-) => `/${specKey}/types/${tag}/${typeName}${params ? `?${params}` : ''}`
+) => `/${specKey}/types/${tag}/${typeName}${params ? `?${params}` : ''}`;
 
-export const diffPath = 'diff'
-export const oAuthPath = 'oauth'
+export const diffPath = 'diff';
+export const oAuthPath = 'oauth';
 
 /**
  * Returns the tag for a given method name
@@ -75,14 +75,14 @@ const getMethodTag = (api: ApiModel, methodName: string) => {
   // Find tag containing methodName
   return Object.entries(api.tags)
     .filter(([, methods]) => methodName in methods)
-    .map(([methodTag]) => methodTag)[0]
-}
+    .map(([methodTag]) => methodTag)[0];
+};
 
 /**
  * Is this item a method? Check without requiring `instanceof Method`
  * @param item to check for method or type
  */
-export const isMethod = (item: IMethod | IType) => 'params' in item
+export const isMethod = (item: IMethod | IType) => 'params' in item;
 
 /**
  * Return the tag for a give type
@@ -90,9 +90,9 @@ export const isMethod = (item: IMethod | IType) => 'params' in item
  * @param type to tag
  */
 const getTypeTag = (api: ApiModel, type: IType) => {
-  const method = firstMethodRef(api, type)
-  return getMethodTag(api, method.name)
-}
+  const method = firstMethodRef(api, type);
+  return getMethodTag(api, method.name);
+};
 
 /**
  * Builds a path matching MethodScene or TypeScene route
@@ -106,33 +106,33 @@ export const buildPath = (
   item: IMethod | IType,
   specKey: string
 ) => {
-  let path
+  let path;
   if (isMethod(item)) {
-    const tag = getMethodTag(api, item.name)
-    path = buildMethodPath(specKey, tag, item.name)
+    const tag = getMethodTag(api, item.name);
+    path = buildMethodPath(specKey, tag, item.name);
   } else {
-    const tag = getTypeTag(api, item as IType)
-    path = buildTypePath(specKey, tag, item.name)
+    const tag = getTypeTag(api, item as IType);
+    path = buildTypePath(specKey, tag, item.name);
   }
-  return path
-}
+  return path;
+};
 
 /**
  * Determine API specification keys from URL pattern
  * @param location service to examine
  */
 export const getSpecKey = (location: HLocation | Location): string | null => {
-  const pathname = location.pathname
-  let match
+  const pathname = location.pathname;
+  let match;
   if (pathname.startsWith(`/${diffPath}`)) {
-    const pattern = new RegExp(`(?:/${diffPath})/(?<specKey>\\w+.\\w+)`)
-    match = pathname.match(pattern)
+    const pattern = new RegExp(`(?:/${diffPath})/(?<specKey>\\w+.\\w+)`);
+    match = pathname.match(pattern);
   } else {
-    match = pathname.match(/\/(?<specKey>\w+\.\w+).*/)
+    match = pathname.match(/\/(?<specKey>\w+\.\w+).*/);
   }
-  const result = match?.groups?.specKey || null
-  return result
-}
+  const result = match?.groups?.specKey || null;
+  return result;
+};
 
 /**
  * Gets the scene type of the current page
@@ -142,9 +142,9 @@ export const getSpecKey = (location: HLocation | Location): string | null => {
 export const getSceneType = (path: string) => {
   const match = matchPath<{ tagType: string }>(path, {
     path: '/:specKey/:tagType',
-  })
-  return match ? match!.params.tagType : ''
-}
+  });
+  return match ? match!.params.tagType : '';
+};
 
 /**
  * Confirms if filter is valid for a given method/type tag
@@ -152,15 +152,15 @@ export const getSceneType = (path: string) => {
  * @param filter filter tag for page
  */
 export const isValidFilter = (path: string, filter: string) => {
-  let isValid
-  const sceneType = getSceneType(path)
-  if (!sceneType) isValid = false
+  let isValid;
+  const sceneType = getSceneType(path);
+  if (!sceneType) isValid = false;
   else if (!filter.localeCompare('all', 'en', { sensitivity: 'base' }))
-    isValid = true
+    isValid = true;
   else if (sceneType === 'methods') {
-    isValid = methodFilterOptions.test(filter)
+    isValid = methodFilterOptions.test(filter);
   } else {
-    isValid = typeFilterOptions.test(filter)
+    isValid = typeFilterOptions.test(filter);
   }
-  return isValid
-}
+  return isValid;
+};

package/src/utils/sdkLanguage.spec.ts

@@ -24,46 +24,46 @@
 
  */
 
-import { codeGenerators } from '@looker/sdk-codegen'
-import { allSdkLanguages, findSdk } from '../utils'
-import { sdkLanguageMapping } from '../test-data'
+import { codeGenerators } from '@looker/sdk-codegen';
+import { allSdkLanguages, findSdk } from '../utils';
+import { sdkLanguageMapping } from '../test-data';
 
 describe('SDK Language Utils', () => {
   test('allSdkLanguages gets all sdk languages', () => {
-    const actual = allSdkLanguages()
-    const aliases = Object.keys(actual)
-    expect(Object.keys(actual)).toHaveLength(codeGenerators.length + 1)
+    const actual = allSdkLanguages();
+    const aliases = Object.keys(actual);
+    expect(Object.keys(actual)).toHaveLength(codeGenerators.length + 1);
     aliases.forEach((alias) =>
-      expect(actual[alias]).toEqual(sdkLanguageMapping[alias])
-    )
-  })
+      expect(actual[alias]).toEqual((sdkLanguageMapping as any)[alias])
+    );
+  });
 
   describe('findSdk', () => {
     test('it is not case sensitive', () => {
-      const actual = findSdk('pY')
-      expect(actual.language).toEqual('Python')
-    })
+      const actual = findSdk('pY');
+      expect(actual.language).toEqual('Python');
+    });
 
     test("it returns 'All' option if provided bogus input", () => {
-      const actual = findSdk('random')
-      expect(actual.language).toEqual('All')
-      expect(actual.alias).toEqual('all')
-    })
+      const actual = findSdk('random');
+      expect(actual.language).toEqual('All');
+      expect(actual.alias).toEqual('all');
+    });
 
     test.each(Object.entries(sdkLanguageMapping))(
       `it finds language for alias %s`,
       (alias, language) => {
-        const actual = findSdk(alias)
-        expect(actual.language).toEqual(language)
+        const actual = findSdk(alias);
+        expect(actual.language).toEqual(language);
       }
-    )
+    );
 
     test.each(Object.entries(sdkLanguageMapping))(
       `it finds alias for language %s`,
       (alias, language) => {
-        const actual = findSdk(language)
-        expect(actual.alias).toEqual(alias)
+        const actual = findSdk(language);
+        expect(actual.alias).toEqual(alias);
       }
-    )
-  })
-})
+    );
+  });
+});

package/src/utils/sdkLanguage.ts

@@ -24,23 +24,24 @@
 
  */
 
-import { codeGenerators } from '@looker/sdk-codegen'
+import type { ArgValues } from '@looker/sdk-codegen';
+import { codeGenerators } from '@looker/sdk-codegen';
 
-export const allAlias = 'all'
+export const allAlias = 'all';
 
 /**
  * Gets all supported sdk languages
  * @returns mapping of sdk language aliases to name
  */
 export const allSdkLanguages = (): Record<string, string> => {
-  const languages = {}
+  const languages: ArgValues = {};
   codeGenerators.forEach((gen) => {
-    const alias = gen.extension.toString().match(/\.(\w+)\b/)![1]
-    languages[alias] = gen.language
-  })
+    const alias = gen.extension.toString().match(/\.(\w+)\b/)![1];
+    languages[alias] = gen.language;
+  });
 
-  return { ...languages, [allAlias]: 'All' }
-}
+  return { ...languages, [allAlias]: 'All' };
+};
 
 /**
  * Searches for sdk language details given label
@@ -48,16 +49,16 @@ export const allSdkLanguages = (): Record<string, string> => {
  * @returns language name and alias
  */
 export const findSdk = (label: string) => {
-  const languages = allSdkLanguages()
-  let match = { alias: allAlias, language: languages[allAlias] }
+  const languages = allSdkLanguages();
+  let match = { alias: allAlias, language: languages[allAlias] };
   for (const [alias, language] of Object.entries(languages)) {
     if (
       !label.localeCompare(alias, 'en', { sensitivity: 'base' }) ||
       !label.localeCompare(language, 'en', { sensitivity: 'base' })
     ) {
-      match = { alias, language }
-      break
+      match = { alias, language };
+      break;
     }
   }
-  return match
-}
+  return match;
+};

package/src/utils/useWindowSize.tsx

@@ -24,25 +24,25 @@
 
  */
 
-import { useEffect, useState } from 'react'
+import { useEffect, useState } from 'react';
 // from: https://usehooks.com/useWindowSize/
 export function useWindowSize() {
   const [windowSize, setWindowSize] = useState({
     width: 0,
     height: 0,
-  })
+  });
 
   useEffect(() => {
     function handleResize() {
       setWindowSize({
         width: window.innerWidth,
         height: window.innerHeight,
-      })
+      });
     }
-    window.addEventListener('resize', handleResize)
-    handleResize()
-    return () => window.removeEventListener('resize', handleResize)
-  }, [])
+    window.addEventListener('resize', handleResize);
+    handleResize();
+    return () => window.removeEventListener('resize', handleResize);
+  }, []);
 
-  return windowSize
+  return windowSize;
 }

package/webpack.dev.config.js

@@ -24,10 +24,10 @@
 
  */
 
-const path = require('path')
-const { merge } = require('webpack-merge')
-const base = require('../../webpack.base.config')(__dirname)
-const browser = require('../../webpack.browser.config')()
+const path = require('path');
+const { merge } = require('webpack-merge');
+const base = require('../../webpack.base.config')(__dirname);
+const browser = require('../../webpack.browser.config')();
 
 module.exports = merge(base, browser, {
   entry: {
@@ -50,4 +50,4 @@ module.exports = merge(base, browser, {
       'Access-Control-Allow-Headers': '*',
     },
   },
-})
+});

package/webpack.prod.config.js

@@ -23,14 +23,14 @@
  SOFTWARE.
 
  */
-const path = require('path')
-const { merge } = require('webpack-merge')
-const base = require('../../webpack.base.config')(__dirname)
-const browser = require('../../webpack.browser.config')()
+const path = require('path');
+const { merge } = require('webpack-merge');
+const base = require('../../webpack.base.config')(__dirname);
+const browser = require('../../webpack.browser.config')();
 
 module.exports = merge(base, browser, {
   entry: {
     app: path.join(__dirname, 'src/App.tsx'),
   },
   mode: 'production',
-})
+});