@looker/api-explorer 0.9.19 → 0.9.25

package/src/scenes/MethodScene/utils.ts

@@ -1,121 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 Looker Data Sciences, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
- */
-
-import {
-  ArrayType,
-  DelimArrayType,
-  HashType,
-  IApiModel,
-  IntrinsicType,
-  IType,
-  IMethod,
-} from '@looker/sdk-codegen'
-import { RunItInput } from '@looker/run-it'
-
-/**
- * Return a default value for a given type name
- * @param type A type name
- */
-const getTypeDefault = (type: string) => {
-  // TODO: use potential equivalent from sdk-codegen, confirm formats
-  switch (type) {
-    case 'boolean':
-      return false
-    case 'int64':
-    case 'integer':
-      return 0
-    case 'float':
-    case 'double':
-      return 0.0
-    case 'hostname':
-    case 'ipv4':
-    case 'ipv6':
-    case 'uuid':
-    case 'uri':
-    case 'string':
-    case 'email':
-      return ''
-    case 'string[]':
-      return []
-    case 'object':
-      return {}
-    case 'datetime':
-      return ''
-    default:
-      return ''
-  }
-}
-
-/**
- * Given a type object reduce it to its writeable intrinsic and/or custom type properties and their default values
- * @param spec Api spec
- * @param type A type object
- */
-const createSampleBody = (spec: IApiModel, type: IType) => {
-  /* eslint-disable @typescript-eslint/no-use-before-define */
-  const getSampleValue = (type: IType) => {
-    if (type instanceof IntrinsicType) return getTypeDefault(type.name)
-    if (type instanceof ArrayType)
-      return type.customType
-        ? [recurse(spec.types[type.customType])]
-        : getTypeDefault(type.name)
-    if (type instanceof HashType)
-      return type.customType ? recurse(spec.types[type.customType]) : {}
-    if (type instanceof DelimArrayType) return ''
-
-    return recurse(type)
-  }
-  /* eslint-enable @typescript-eslint/no-use-before-define */
-
-  const recurse = (type: IType) => {
-    const sampleBody: { [key: string]: any } = {}
-    for (const prop of type.writeable) {
-      const sampleValue = getSampleValue(prop.type)
-      if (sampleValue !== undefined) {
-        sampleBody[prop.name] = sampleValue
-      }
-    }
-    return sampleBody
-  }
-  return recurse(type)
-}
-
-/**
- * Given an SDK method create and return an array of inputs for the run-it form
- * @param spec Api spec
- * @param method A method object
- */
-export const createInputs = (spec: IApiModel, method: IMethod): RunItInput[] =>
-  method.allParams.map((param) => ({
-    name: param.name,
-    location: param.location,
-    type:
-      param.type instanceof IntrinsicType
-        ? param.type.name
-        : createSampleBody(spec, param.type),
-    required: param.required,
-    description: param.description,
-  }))

package/src/state/settings/action_creators.ts

@@ -1,33 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 Looker Data Sciences, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
- */
-import { SetSdkLanguageAction, SettingsActionTypes } from './actions'
-
-export const setSdkLanguageAction = (
-  sdkLanguage: string
-): SetSdkLanguageAction => ({
-  type: SettingsActionTypes.SET_SDK_LANGUAGE,
-  payload: sdkLanguage,
-})

package/src/test-utils/render_with_lode.tsx

@@ -1,74 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 Looker Data Sciences, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
- */
-
-import React, { ReactElement } from 'react'
-import { RenderOptions } from '@testing-library/react'
-import { Store } from 'redux'
-
-import { renderWithTheme } from '@looker/components-test-utils'
-import { IDeclarationMine, IExampleMine } from '@looker/sdk-codegen'
-import { LodeContext } from '../context'
-import { RootState } from '../state'
-import { IApixEnvAdaptor } from '../utils'
-import { withReduxProvider } from './redux'
-
-const withLode = (
-  consumer: ReactElement<any>,
-  examples: IExampleMine,
-  declarations?: IDeclarationMine
-) => {
-  return (
-    <LodeContext.Provider value={{ examples, declarations }}>
-      {consumer}
-    </LodeContext.Provider>
-  )
-}
-
-export const renderWithLode = (
-  component: ReactElement<any>,
-  examples: IExampleMine,
-  declarations?: IDeclarationMine,
-  options?: Omit<RenderOptions, 'queries'>
-) => {
-  return renderWithTheme(withLode(component, examples, declarations), options)
-}
-
-export const renderWithReduxProviderAndLode = (
-  component: ReactElement<any>,
-  examples: IExampleMine,
-  declarations?: IDeclarationMine,
-  store?: Store<RootState>,
-  envAdaptor?: IApixEnvAdaptor,
-  options?: Omit<RenderOptions, 'queries'>
-) =>
-  renderWithTheme(
-    withReduxProvider(
-      withLode(component, examples, declarations),
-      store,
-      envAdaptor
-    ),
-    options
-  )

package/src/test-utils/render_with_search.tsx

@@ -1,69 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 Looker Data Sciences, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
- */
-
-import React, { ReactElement } from 'react'
-import { RenderOptions } from '@testing-library/react'
-
-import { renderWithTheme } from '@looker/components-test-utils'
-import { SearchContext, defaultSearchContextValue } from '../context'
-import { defaultSearchState, SearchState } from '../reducers'
-import { withRouter } from './router'
-
-const withSearchProvider = (
-  consumer: ReactElement<any>,
-  searchSettings: SearchState
-) => (
-  <SearchContext.Provider
-    value={{
-      searchSettings,
-      setSearchSettings: defaultSearchContextValue.setSearchSettings,
-    }}
-  >
-    {consumer}
-  </SearchContext.Provider>
-)
-
-export const renderWithSearch = (
-  component: ReactElement<any>,
-  pattern = defaultSearchState.pattern,
-  criteria = defaultSearchState.criteria,
-  options?: Omit<RenderOptions, 'queries'>
-) =>
-  renderWithTheme(withSearchProvider(component, { pattern, criteria }), options)
-
-export const renderWithSearchAndRouter = (
-  component: ReactElement<any>,
-  pattern = defaultSearchState.pattern,
-  criteria = defaultSearchState.criteria,
-  initialRouterEntries?: string[],
-  options?: Omit<RenderOptions, 'queries'>
-) => {
-  const RoutedComponent = withRouter(component, initialRouterEntries)
-  return renderWithTheme(
-    withSearchProvider(RoutedComponent, { pattern, criteria }),
-    options
-  )
-}

package/src/utils/envAdaptor.spec.ts

@@ -1,53 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 Looker Data Sciences, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
- */
-import {
-  StandaloneEnvAdaptor,
-  ThemeOverrides,
-  getThemeOverrides,
-} from './envAdaptor'
-
-describe('StandaloneEnvAdaptor', () => {
-  test.each([
-    ['www.looker.com', getThemeOverrides(true)],
-    ['www.google.com', getThemeOverrides(true)],
-    ['localhost', getThemeOverrides(true)],
-    ['127.0.0.1', getThemeOverrides(false)],
-  ])(
-    'returns correct font overrides',
-    (hostname: string, expectedOverrides: ThemeOverrides) => {
-      const saveLoc = window.location
-      delete (window as any).location
-      window.location = {
-        ...saveLoc,
-        hostname,
-      }
-      expect(new StandaloneEnvAdaptor().themeOverrides()).toEqual(
-        expectedOverrides
-      )
-      window.location = saveLoc
-    }
-  )
-})

package/src/utils/envAdaptor.ts

@@ -1,120 +0,0 @@
-/*
-
- MIT License
-
- Copyright (c) 2021 Looker Data Sciences, Inc.
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
-
- */
-
-import { ThemeCustomizations } from '@looker/design-tokens'
-
-/**
- * NOTE: This interface should describe all methods that require an adaptor when running in standalone vs extension mode
- * Examples include: local storage operations, writing to clipboard and various link navigation functions amongst others
- */
-export interface IApixEnvAdaptor {
-  /** Method for retrieving a keyed value from local storage */
-  localStorageGetItem(key: string): Promise<string | null>
-  /** Method for setting a keyed value in local storage */
-  localStorageSetItem(key: string, value: string): void
-  /** Method for removing a keyed value from local storage */
-  localStorageRemoveItem(key: string): void
-  /** Theme settings for extension */
-  themeOverrides(): ThemeOverrides
-  /** Open a new browser window with the given url and target  */
-  openBrowserWindow: (url: string, target?: string) => void
-  /** error logger */
-  logError: (error: Error, componentStack: string) => void
-}
-
-/**
- * Theme overrides used to load google fonts in Google environments only.
- * Google fonts should NOT be used when it is not obvious that a Google
- * system is being used (for example an embedded extension).
- */
-export interface ThemeOverrides {
-  loadGoogleFonts?: boolean
-  themeCustomizations?: ThemeCustomizations
-}
-
-export const getThemeOverrides = (useGoogleFonts: boolean): ThemeOverrides =>
-  useGoogleFonts
-    ? {
-        loadGoogleFonts: true,
-        themeCustomizations: {
-          fontFamilies: { brand: 'Google Sans' },
-          colors: { key: '#1A73E8' },
-        },
-      }
-    : {
-        themeCustomizations: {
-          colors: { key: '#1A73E8' },
-        },
-      }
-
-/**
- * An adaptor class for interacting with browser APIs when running in standalone mode
- */
-export class StandaloneEnvAdaptor implements IApixEnvAdaptor {
-  private _themeOverrides: ThemeOverrides
-
-  constructor() {
-    const { hostname } = location
-    this._themeOverrides = getThemeOverrides(
-      hostname.endsWith('.looker.com') ||
-        hostname.endsWith('.google.com') ||
-        hostname === 'localhost' ||
-        // Include firebase staging dev portal for now. Can be removed
-        // when dev portal gets its own APIX project. Also includes
-        // PRs.
-        (hostname.startsWith('looker-developer-portal') &&
-          hostname.endsWith('.web.app'))
-    )
-  }
-
-  async localStorageGetItem(key: string) {
-    return localStorage.getItem(key)
-  }
-
-  async localStorageSetItem(key: string, value: string) {
-    await localStorage.setItem(key, value)
-  }
-
-  async localStorageRemoveItem(key: string) {
-    await localStorage.removeItem(key)
-  }
-
-  themeOverrides() {
-    return this._themeOverrides
-  }
-
-  openBrowserWindow(url: string, target?: string) {
-    window.open(url, target)
-  }
-
-  logError(_error: Error, _componentStack: string): void {
-    // noop - error logging for standalone APIX TBD
-  }
-}
-
-export enum EnvAdaptorConstants {
-  LOCALSTORAGE_SDK_LANGUAGE_KEY = 'sdkLanguage',
-}