# kaltura-typescript-client

> Kaltura Typescript client

Latest version **20.7.3** (published 2024-03-28) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install kaltura-typescript-client
pnpm add kaltura-typescript-client
yarn add kaltura-typescript-client
bun add kaltura-typescript-client
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 20.7.3 |
| Published | 2024-03-28 |
| First published | 2017-05-07 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 7.0.0 |
| Dependencies | 0 |
| Unpacked size | 15.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Kaltura Inc. |
| Maintainers | noamtamim, omriceisler, roeisomech, sagivp, yossipapi, nivshlomokaltura, kaltura-inc, kaltura-ng2, eransakalkaltura |
| Keywords | Kaltura |

## Links

- npm: https://www.npmjs.com/package/kaltura-typescript-client
- Repository: https://github.com/kaltura/clients-generator
- Homepage: https://github.com/kaltura/clients-generator#readme
- Issues: https://github.com/kaltura/clients-generator/issues
- npm.io page: https://npm.io/package/kaltura-typescript-client

## Recent versions

- 20.7.3 (latest) — 2024-03-28
- 20.7.0 — 2024-03-28
- 7.0.2 — 2024-03-28
- 20.7.0-v20240328-121330 — 2024-03-28
- 20.7.0-v20240325-090659 — 2024-03-25
- 20.7.0-v20240325-085909 — 2024-03-25
- 6.0.0 — 2017-11-26
- 5.1.2 — 2017-10-29
- 5.1.1 — 2017-10-22
- 5.1.0 — 2017-10-16
- 5.0.0 — 2017-08-14
- 4.0.0 — 2017-07-13
- 3.0.0 — 2017-07-13
- 2.1.0 — 2017-05-22
- 2.0.0 — 2017-05-18
- … 3 more at https://npm.io/package/kaltura-typescript-client/versions

## README

# Kaltura Typescript Client

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![Gitter chat](https://badges.gitter.im/kaltura-ng/kaltura-ng.png)](https://gitter.im/kaltura-ng/kaltura-ng) [![Build Status](https://travis-ci.org/kaltura/KalturaGeneratedAPIClientsAngular.svg?branch=master)](https://travis-ci.org/kaltura/KalturaGeneratedAPIClientsAngular)

> An easy-to-use facade to Kaltura server with typescript support for action requests, classes and enums.


## Instructions

### Getting Started
To keep being update review the [changelog](CHANGELOG.md) frequently.

## Features list
View list of features [here](features.md).

# Building the sources
> This library is auto-generated using `kaltura/clients-generator` php engine. Feel free to clone, build and play with this library but in order to submit PR you should work against the [kaltura/clients-generator](https://github.com/kaltura/clients-generator) repo.


## Adding this library as a dependency to your project
Since this library was designed to be consumed directly and not using npmjs repository, you will need to do the following steps to add it to your project:
1. run the following to transpile the library:
```bash
$ npm install
$ npm run deploy
```
2. open folder `dist` and find a `tar.gz` file starting with `kaltura-typescript-client-v`.
3. copy this file to your project (we recommend coping it to folder `libs`)
4. run the following command
 ```
 npm install file:the_path_to_the_file_including_its_name.tgz
 ```
> make sure you prefix the path with `file:` as shown above.

An example of a vaild command will be: `npm install file:libs/kaltura-typescript-client-v7.1.0-20173010-1053.tgz`

5. if you already have older version, delete that file. You should do this only after you installed the new version.


## Using the library in production
> You should follow the steps below to optimize the production build by bundling only the types being used.

The library has thousands of classes representing the data model of the server API. Usually, applications are using only friction of those types. Some toolchains drop the types that are not in actual use. 

If you see that the bundle includes all the types or a log warning in the console like below, you should follow the steps mentioned in this section.

```
Notice! Your application bundle the whole package of kaltura-xxx-client (either rxjs/ngx/typescript), please refer to the library `readme.md` to reduce app bundle size.
```

1. make sure you have dependency for `babel-plugin-import`.
2. add plugin configuration to the babel file being used by your application. 
```
{
  "plugins": [
    [
      "import", {
      "libraryName": "kaltura-typescript-client/api/types",
      "libraryDirectory": "",
      "camel2DashComponentName": false,
      "transformToDefaultImport": false
    }]
  ]
}
```

## Running integration tests
- In `src/api/tests` folder you should duplicate file `tests-config.template.ts` and name it `tests-config.ts`.
- Modify the file content to include valid information.
- Run `npm run test` to test the library

> If you want to test the library against the production server use the following as the endpoint in the config file: http://www.kaltura.com/api_v3/index.php/


## License and Copyright Information
All code in this project is released under the [AGPLv3 license](http://www.gnu.org/licenses/agpl-3.0.html) unless a different license for a particular library is specified in the applicable library path.

Copyright © Kaltura Inc. All rights reserved.

---
_Source: https://npm.io/package/kaltura-typescript-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._