feat: expose global ks and partner id from the client instead of from…

… the configuration object.

BREAKING CHANGE:

the global ks and partner id must be assigned on the client (previously was on the configuration)

CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+<a name="2.1.0"></a>
+# [2.1.0](https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/compare/v2.0.0...v2.1.0) (2017-05-22)
+
+
+### Features
+
+* separate dynamic info (ks, partnerid) from configuration info (client tag, endpointUrl) ([12bf78e](https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/commit/12bf78e))
+
+
+
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/compare/v1.1.0...v2.0.0) (2017-05-18)
+
+
+### Features
+
+* **kaltura-clients:** remove configuration objects, assign dynamic data directly on the clients ([8a30a72](https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/commit/8a30a72))
+
+
+### BREAKING CHANGES
+
+* **kaltura-clients:** the 'KalturaClientBaseConfiguration' and 'KalturaHttpClientConfiguration' objects were removed.
+
+Any dynamic data assigned on them should be done directly on the client instance.
+
+
+
 <a name="1.1.1"></a>
 ## [1.1.1](https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/compare/v1.1.0...v1.1.1) (2017-05-10)
 

CONTRIBUTING.md

@@ -0,0 +1,193 @@
+# Contributing
+
+Thank you for running Kaltura and pushing the limits of online video! By joining the Kaltura community and contributing you will help grow the platform, and keeping it open, stable and accessible to all.
+
+As a contributor, here are the guidelines we would like you to follow:
+
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit)
+ - [Coding Rules](#rules)
+ - [Commit Message Guidelines](#commit)
+ - [Signing the CLA](#cla)
+
+## <a name="question"></a> Got a Question or Problem?
+
+If you have questions about how to *use* our infrastructure, write us in [Gitter][gitter].
+
+
+
+## <a name="issue"></a> Found an Issue?
+If you find a bug in the source code, you can help us by
+[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
+[submit a Pull Request](#submit-pr) with a fix.
+
+## <a name="feature"></a> Want a Feature?
+You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub
+Repository][github]. If you would like to *implement* a new feature, please submit an issue with
+a proposal for your work first, to be sure that we can use it. 
+Please consider what kind of change it is:
+
+* For a **Major Feature**, first open an issue and outline your proposal so that it can be
+discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
+and help you to craft the change so that it is successfully accepted into the project.
+* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+
+## <a name="submit"></a> Submission Guidelines
+
+### <a name="submit-issue"></a> Submitting an Issue
+You can file new issues by providing the above information [here][github-issues]).
+
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+* Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs.
+  We cannot accept code without this.
+* Make your changes in a new git branch:
+
+     ```shell
+     git checkout -b my-fix-branch master
+     ```
+
+* Create your patch.
+* Follow our [Coding Rules](#rules).
+* Run the tests, as described in the [developer documentation][dev-doc],
+  and ensure that all tests pass.
+* Commit your changes using a descriptive commit message that follows our
+  [commit message conventions](#commit). Adherence to these conventions
+  is necessary because release notes are automatically generated from these messages.
+* In GitHub, send a pull request.
+
+That's it! Thank you for your contribution!
+
+#### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull the changes
+from the main (upstream) repository:
+
+* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
+
+    ```shell
+    git push origin --delete my-fix-branch
+    ```
+
+* Check out the master branch:
+
+    ```shell
+    git checkout master -f
+    ```
+
+* Delete the local branch:
+
+    ```shell
+    git branch -D my-fix-branch
+    ```
+
+* Update your master with the latest upstream version:
+
+    ```shell
+    git pull --ff upstream master
+    ```
+
+## <a name="rules"></a> Coding Rules
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+
+* All features or bug fixes **must be tested** by one or more specs (unit-tests).
+* All public API methods **must be documented**. (Details TBC).
+* See [DEVELOPER.md](DEVELOPER.md#code-format) for coding style guide.
+
+## <a name="commit"></a> Commit Message Guidelines
+
+We have very precise rules over how our git commit messages can be formatted.  This leads to **more
+readable messages** that are easy to follow when looking through the **project history**.  But also,
+we use the git commit messages to **generate the Angular change log**.
+
+### Commit Message Format
+Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
+format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
+
+Samples: (even more [samples](https://github.com/angular/angular/commits/master))
+
+```
+docs(changelog): update change log to beta.5
+```
+```
+fix(release): need to depend on latest rxjs and zone.js
+
+The version in our package.json gets copied to the one we publish, and users need the latest of these.
+```
+
+### Type
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
+  semi-colons, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests or correcting existing tests
+* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+* **chore**: Other changes that don't modify `src` or `test` files
+
+### Scope
+
+The following is the list of supported scopes:
+- kaltura-objects
+- kaltura-clients
+
+There is currently few exception to the "use package name" rule:
+
+**none/empty string**: useful for style, test and refactor changes.
+
+### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize first letter
+* no dot (.) at the end
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+
+A detailed explanation can be found in this [document][commit-message-format].
+
+## <a name="cla"></a> Signing the CLA
+
+Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!
+
+[Contributor License Agreement (CLA)][cla]
+
+[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
+[cla]: https://agentcontribs.kaltura.org/
+[dev-doc]: DEVELOPER.md
+[github]: https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript
+[github-issues]: https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/issues
+[gitter]: https://gitter.im/kaltura-ng
+[js-style-guide]: https://google.github.io/styleguide/javascriptguide.xml

README.md

@@ -1,5 +1,4 @@
-# Kaltura Typescript Client
-
+# Kaltura Typescript Client [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) 
 
 > An easy-to-use facade to Kaltura server with typescript support for action requests, classes and enums.
  
@@ -63,6 +62,10 @@ The following is a list of all features supported by the library:
 
  Below is a list of features to be added:
 - [ ] Generate `kalsig` per request.
+- [ ] Request timeout support
+- [ ] Cancel file upload should abort request
+- [ ] Add Node.JS client 
+- [ ] When updating an object, ignore properties marked as insert only property.
 - [ ] Code documentation of classes/enums/actions.
 - [ ] Add developer/api guide. 
 - [ ] Simplify syntax of enums representing strings.

package.json

@@ -1,6 +1,7 @@
 {
   "name": "kaltura-typescript-client",
-  "version": "1.1.1",
+  "public" : false,
+  "version": "2.1.0",
   "description": "Kaltura Typescript client",
   "keywords": [
     "Kaltura"

src/kaltura-clients/index.ts

@@ -1,5 +1,3 @@
-export { KalturaHttpClientConfiguration } from './kaltura-http-client-configuration';
-export { KalturaClientBaseConfiguration} from './kaltura-client-base-configuration';
-export { KalturaBrowserHttpClient } from './kaltura-browser-http-client';
-export { KalturaClientBase } from './kaltura-client-base';
-export { KalturaHttpClientBase } from './kaltura-http-client-base';
+export * from './kaltura-browser-http-client';
+export * from './kaltura-client-base';
+export * from './kaltura-http-client-base';

src/kaltura-clients/kaltura-browser-http-client.ts

@@ -1,17 +1,22 @@
-import { KalturaHttpClientConfiguration } from "./kaltura-http-client-configuration";
 import { KalturaRequest } from '../kaltura-request';
 import { KalturaMultiRequest } from '../kaltura-multi-request';
 import { KalturaMultiResponse } from '../kaltura-multi-response';
 import { CancelableAction } from '../utils/cancelable-action';
-import { KalturaHttpClientBase } from './kaltura-http-client-base';
+import { KalturaHttpClientBase, KalturaHttpClientBaseConfiguration } from './kaltura-http-client-base';
 import { KalturaAPIException } from '../kaltura-api-exception';
 
+
+export interface KalturaBrowserHttpClientConfiguration extends KalturaHttpClientBaseConfiguration
+{
+}
+
 export class KalturaBrowserHttpClient extends KalturaHttpClientBase {
-    constructor(adapterConfiguration: KalturaHttpClientConfiguration) {
-        super(adapterConfiguration);
-    }
 
 
+    constructor(config : KalturaBrowserHttpClientConfiguration) {
+        super(config);
+    }
+
     protected _createCancelableAction(data : { endpoint : string, headers : any, body : {}, type : any} ) : CancelableAction
     {
 

src/kaltura-clients/kaltura-client-base.ts

@@ -5,8 +5,22 @@ import { KalturaAPIException } from '../kaltura-api-exception';
 import { KalturaUploadRequest } from '../kaltura-upload-request';
 import { CancelableAction } from '../utils/cancelable-action';
 
+export interface KalturaClientBaseConfiguration
+{
+    clientTag : string;
+}
+
 export abstract class KalturaClientBase {
 
+    ks : string;
+    partnerId : number;
+    public clientTag : string;
+
+    constructor(config :  KalturaClientBaseConfiguration)
+    {
+        this.clientTag = config.clientTag;
+    }
+
     protected abstract _transmitFileUploadRequest(request): CancelableAction;
     protected abstract _transmitRequest(request): CancelableAction;
 
@@ -76,4 +90,23 @@ export abstract class KalturaClientBase {
             throw new KalturaAPIException("client::request_type_error", 'unsupported request type requested');
         }
     }
+
+    protected _assignDefaultParameters(parameters : any) : any
+    {
+        if (parameters) {
+            if (this.ks && typeof parameters['ks'] === 'undefined') {
+                parameters.ks = this.ks;
+            }
+
+            if (this.partnerId && typeof parameters['partnerId'] === 'undefined') {
+                parameters.partnerId = this.partnerId;
+            }
+        }
+
+        if (this.clientTag) {
+            parameters.clientTag = this.clientTag;
+        }
+
+        return parameters;
+    }
 }