Noiseless Party Machine

    @looker/sdk
    TypeScript icon, indicating that this package has built-in type declarations

    22.10.1 • Public • Published

    Looker SDK

    The Looker SDK for TypeScript/JavaScript works with Node and browser run-times. The SDK provides a convenient way to communicate with a Looker server's APIs.

    This package supports using the Looker SDK in the browser. The @looker/sdk-node package depends on this package (@looker/sdk) and @looker/sdk-rtl.

    The SDK uses a plug-in architecture (also known as dependency injection) for initializing that supports run-time specific transports (like NodeTransport and BrowserTransport) and different approaches for managing API authentication (like NodeSession, BrowserSession, ProxySession, and CorsSession).

    Please report any issues encountered, and indicate the SDK language in the report.

    Getting started

    The Looker Browser SDK can be used in a browser application in 3 steps:

    • install
    • authenticate
    • use

    Install the Looker SDK into your application

    Using yarn:

    yarn add @looker/sdk @looker/sdk-rtl

    Using npm:

    npm install @looker/sdk @looker/sdk-rtl

    Some other dependencies may be required for your project to build and run correctly.

    yarn install @types/readable-stream @types/request @types/request-promise-native -D

    TypeScript SDK packages

    The Looker TypeScript SDK has different packages to prevent node dependencies being linked into browser usage of the SDK (the node dependencies are not available in the browser and can cause compilation errors). There are three packages for the Typescript SDK available on npm:

    1. @looker/sdk-rtl - contains a run time library needed to invoke the Looker API methods. Referencing the @looker/sdk as a dependency should automatically pull this package in.
    2. @looker/sdk - contains the Looker API methods.
    3. @looker/sdk-node - contains the dependencies needed to run the Looker SDK in a node environment. Do NOT include this package if you are using the Looker SDK in a browser. You MUST include this package if you are using node or ts-node.

    Authenticate your API calls

    All requests to the Looker API server require an access token. For browser implementations, authentication is typically achieved via OAuth as described in cors.md or a Proxy Server.

    Use the SDK in your browser application

    Authenticating for the browser takes more setup than authenticating for use with a Node application.

    The stand-alone version of the Looker API Explorer uses OAuth and the BrowserSDK to get an authentication token for Looker API requests.

    • RunItSDK shows how to override readConfig() to get SDK configuration values.

    • RunItSDK tests support debugging the flow of RunItSDK.

    • The OAuthScene React component receives the OAuth response from the Looker server and logs the user in to retrieve the API authentication token.

    Looker's OAuth support makes it possible to build a Looker SDK application that only requires the browser. If a browser application can use a proxy server instead, or already uses an existing backend server, it may be simpler to use a proxy for authentication/

    The looker.ini configuration file and environment variables are never used in the Browser runtime.

    Developing with multiple API versions

    Starting with Looker release 7.2, the experimental version of API 4.0 is available. To support iterative migration to API 4.0 from API 3.1, the single Looker SDK package now supports multiple API versions for the generated SDK classes. Both API 3.1 and API 4.0 are supported for Node and browser-based use.

    LookerBrowserSDK.init31() and Looker31SDK() initialize the API 3.1 implementation of the SDK.

    LookerBrowserSDK.init40() and Looker40SDK() initialize the API 4.1 implementation of the SDK.

    Using a Proxy for authentication

    CORS support allows the Looker API to be used directly in the browser application running on a different domain than the Looker server. Because all API endpoints require authentication except for Login, a proxy server can be used to retrieve the API authentication token and provide it to the browser session.

    ProxySession is the SDK class specifically designed to streamline proxy session creation. The source code example below shows how to override the authenticate method for use in a CORS request scenario.

    • getProxyToken() is the call to the proxy server's API that returns the API auth token to use
    • the code in the if (this.isAuthenticated() branch
      • Sets CORS mode
      • Sets the auth token header
      • Identifies the Looker SDK version for the Looker server

    By writing your own getProxyToken() visible to this class, any proxied authentication workflow is supported.

    export class EmbedSession extends ProxySession {
      constructor(public settings: IApiSettings, transport?: ITransport) {
        super(settings, transport)
      }
    
      async authenticate(props: any) {
        // get the auth token from the proxy server
        const token = await getProxyToken()
        if (token) {
          // Assign the token, which will track its expiration time automatically
          this.activeToken.setToken(token)
        }
    
        if (this.isAuthenticated()) {
          // Session is authenticated
          // set CORS mode (in this scenario)
          props.mode = 'cors'
    
          // remove any credentials attribute that may have been set
          // because the BrowserTransport defaults to having `same-origin` for credentials
          delete props['credentials']
    
          // replace the headers argument with required values
          // Note: using new Headers() to construct the headers breaks CORS for the Looker API. Don't know why yet
          props.headers = {
            Authorization: `Bearer ${token.access_token}`,
            'x-looker-appid': agentTag,
          }
        }
        return props
      }
    }

    More examples

    Looker's open source repository of SDK Examples has more example scripts and applications that show how to use the Looker SDK.

    A note about security

    Any script or configuration file used to provide credentials to your Looker SDK instance needs to be secured.

    Keywords

    Install

    npm i @looker/sdk

    DownloadsWeekly Downloads

    7,997

    Version

    22.10.1

    License

    MIT

    Unpacked Size

    9.7 MB

    Total Files

    74

    Last publish

    Collaborators

    • guyellis
    • looker-ops
    • scullin
    • jkaster
    • looker-open-source
    • fabio-looker
    • bryans99
    • mdodgelooker
    • dbchristopher
    • google-wombot