@looker/sdk 21.10.1 → 21.16.0

package/CHANGELOG.md

@@ -5,6 +5,66 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [21.16.0](https://www.github.com/looker-open-source/sdk-codegen/compare/sdk-v21.14.0...sdk-v21.16.0) (2021-10-19)
+
+
+### Features
+
+* 21.16 release ([#859](https://www.github.com/looker-open-source/sdk-codegen/issues/859)) ([0b4385c](https://www.github.com/looker-open-source/sdk-codegen/commit/0b4385c83c5225acf0a9b0c76f9e890600a449af))
+* closest path match for API Explorer ([#811](https://www.github.com/looker-open-source/sdk-codegen/issues/811)) ([45fd26f](https://www.github.com/looker-open-source/sdk-codegen/commit/45fd26fb0f325fa90edfec72f835ed3a79b9afeb))
+
+
+### Bug Fixes
+
+* intrinsic type params are not Partial<T> ([#819](https://www.github.com/looker-open-source/sdk-codegen/issues/819)) ([4b31490](https://www.github.com/looker-open-source/sdk-codegen/commit/4b31490f7ce5c9593854e56518245c5399ea9548))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/sdk-rtl bumped from ^21.0.20 to ^21.1.0
+
+## [21.14.0](https://www.github.com/looker-open-source/sdk-codegen/compare/sdk-v21.12.0...sdk-v21.14.0) (2021-09-01)
+
+
+### Features
+
+* Looker 21.14 release ([#807](https://www.github.com/looker-open-source/sdk-codegen/issues/807)) ([99db26d](https://www.github.com/looker-open-source/sdk-codegen/commit/99db26dcd812135d775e61e495c98a66057c6f54))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/sdk-rtl bumped from ^21.0.19 to ^21.0.20
+
+## [21.12.0](https://www.github.com/looker-open-source/sdk-codegen/compare/sdk-v21.10.2...sdk-v21.12.0) (2021-08-06)
+
+
+### Features
+
+* Looker 21.12 bindings ([#782](https://www.github.com/looker-open-source/sdk-codegen/issues/782)) ([a00b908](https://www.github.com/looker-open-source/sdk-codegen/commit/a00b908e6fee79250c4c1ffb1b1e8915d58dd633))
+
+
+### Bug Fixes
+
+* documentation refs and notes for Typescript SDK and more ([#783](https://www.github.com/looker-open-source/sdk-codegen/issues/783)) ([b2487ea](https://www.github.com/looker-open-source/sdk-codegen/commit/b2487ea4a113ce17a080ccab9b4c4139813e8810))
+
+### [21.10.2](https://www.github.com/looker-open-source/sdk-codegen/compare/sdk-v21.10.1...sdk-v21.10.2) (2021-07-30)
+
+
+### Bug Fixes
+
+* improved writeable type support ([#766](https://www.github.com/looker-open-source/sdk-codegen/issues/766)) ([be91bd8](https://www.github.com/looker-open-source/sdk-codegen/commit/be91bd8e772f9a64c47486b317f1ac1f6ef14327))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @looker/sdk-rtl bumped from ^21.0.18 to ^21.0.19
+
 ### [21.10.1](https://www.github.com/looker-open-source/sdk-codegen/compare/sdk-v21.10.0...sdk-v21.10.1) (2021-07-09)
 
 
@@ -183,4 +243,4 @@ See the [README](README.md#streaming-api-responses) for more information.
 
 ### Added
 
-- [Looker 7.16 bindings](https://github.com/looker-open-source/sdk-codegen/pull/348)
+- [Looker 7.16 bindings](https://github.com/looker-open-source/sdk-codegen/pull/348)

package/README.md

@@ -30,21 +30,35 @@ Using `npm`:
 npm install @looker/sdk @looker/sdk-rtl
 ```
 
+Some other dependencies may be required for your project to build and run correctly.
+
+```bash
+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`](/docs/cors.md) or a [Proxy Server](#using-a-proxy-for-authentication).
+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`](../../docs/cors.md) or a [Proxy Server](#using-a-proxy-for-authentication).
 
 ### 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](/packages/api-explorer) uses OAuth and the `BrowserSDK` to get an authentication token for Looker API requests.
+The stand-alone version of the [Looker API Explorer](../api-explorer) uses OAuth and the `BrowserSDK` to get an authentication token for Looker API requests.
 
-- [RunItSDK](/packages/run-it/src/utils/RunItSDK.ts) shows how to override `readConfig()` to get SDK configuration values.
+- [RunItSDK](../run-it/src/utils/RunItSDK.ts) shows how to override `readConfig()` to get SDK configuration values.
 
-- [RunItSDK tests](/packages/run-it/src/utils/RunItSDK.spec.ts) support debugging the flow of `RunItSDK`.
+- [RunItSDK tests](../run-it/src/utils/RunItSDK.spec.ts) support debugging the flow of `RunItSDK`.
 
-- The [OAuthScene](/packages/run-it/src/scenes/OAuthScene/OAuthScene.tsx) React component receives the OAuth response from the Looker server and logs the user in to retrieve the API authentication token.
+- The [OAuthScene](../run-it/src/scenes/OAuthScene/OAuthScene.tsx) 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](#using-a-proxy-for-authentication)/
 

package/lib/3.1/funcs.d.ts

@@ -24,8 +24,8 @@ export declare const update_saml_config: (sdk: IAPIMethods, body: Partial<IWrite
 export declare const saml_test_config: (sdk: IAPIMethods, test_slug: string, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISamlConfig, IError>>;
 export declare const delete_saml_test_config: (sdk: IAPIMethods, test_slug: string, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<string, IError>>;
 export declare const create_saml_test_config: (sdk: IAPIMethods, body: Partial<IWriteSamlConfig>, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISamlConfig, IError | IValidationError>>;
-export declare const parse_saml_idp_metadata: (sdk: IAPIMethods, body: Partial<string>, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISamlMetadataParseResult, IError>>;
-export declare const fetch_and_parse_saml_idp_metadata: (sdk: IAPIMethods, body: Partial<string>, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISamlMetadataParseResult, IError>>;
+export declare const parse_saml_idp_metadata: (sdk: IAPIMethods, body: string, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISamlMetadataParseResult, IError>>;
+export declare const fetch_and_parse_saml_idp_metadata: (sdk: IAPIMethods, body: string, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISamlMetadataParseResult, IError>>;
 export declare const session_config: (sdk: IAPIMethods, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISessionConfig, IError>>;
 export declare const update_session_config: (sdk: IAPIMethods, body: Partial<IWriteSessionConfig>, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<ISessionConfig, IError | IValidationError>>;
 export declare const all_user_login_lockouts: (sdk: IAPIMethods, fields?: string | undefined, options?: Partial<ITransportSettings> | undefined) => Promise<SDKResponse<IUserLoginLockout[], IError>>;