jellyfin-sdk-typescript - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #android #machine-learning #rust #deep-learning #linux #docker #windows #vue #mcp #open-source

jellyfin-sdk-typescript

(★ 124)

TypeScript SDK for Jellyfin

파일 탐색기

최종 버전 다운로드 (.zip)

- - code-quality.yml
  - codeql-analysis.yml
  - labeler.yml
  - sdk-docs.yaml
  - sdk-publish.yaml
  - sdk-unstable-branch.yaml
  - sdk-update-api-spec.yaml
  - sonarcloud.yml
  - test-integration.yaml
  - test.yml
- labeler.yml
- release.yaml
- renovate.json
- extensions.json
- settings.json
- licenseInfo.mustache
- modify-schema.mjs
- - common.ts
  - it-if.ts
- - api.test.ts
  - integration.test.ts
  - jellyfin.test.ts
- - discovery-service.ts
  - index.ts
  - recommended-server-discovery.ts
- - .gitignore
  - .npmignore
  - .openapi-generator-ignore
  - api.ts
  - base.ts
  - common.ts
  - configuration.ts
  - git_push.sh
  - index.ts
- - client-info.ts
  - device-info.ts
  - index.ts
  - recommended-server-info.ts
  - recommended-server-issue.ts
- - address-candidates.ts
  - authentication.ts
  - browser-profiles.ts
  - index.ts
  - versioning.ts
- - constants.ts
  - index.ts
  - models.ts
  - types.ts
  - websocket-service.ts
- api.ts
- constants.ts
- index.ts
- jellyfin.ts
- versions.ts
.gitattributes
.gitignore
.npmignore
.npmrc
.nvmrc
.openapi-generator-ignore
CHANGELOG.md
eslint.config.mjs
LICENSE
openapi.json
openapitools.json
package-lock.json
package.json
README.md
rollup.config.js
sonar-project.properties
tsconfig.json
vitest.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/jellyfin/jellyfin-sdk-typescript

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd jellyfin-sdk-typescript

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm run fix-schema

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run build

배포용으로 코드를 최적화해서 빌드 파일을 생성합니다.

npm link

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm link @jellyfin/sdk

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm i --save @jellyfin/sdk

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">jellyfin-sdk-typescript</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>

---

<p align="center">
<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/jellyfin/jellyfin-sdk-typescript"></a>
<a href="https://github.com/jellyfin/jellyfin-sdk-typescript/releases"><img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-sdk-typescript.svg"/></a>
<a href="https://www.npmjs.com/package/@jellyfin/sdk"><img alt="npm" src="https://img.shields.io/npm/v/@jellyfin/sdk"></a>
<a href="https://sonarcloud.io/component_measures?metric=coverage&id=jellyfin_jellyfin-sdk-typescript">
<img alt="Sonar Coverage" src="https://img.shields.io/sonar/coverage/jellyfin_jellyfin-sdk-typescript/master?server=https%3A%2F%2Fsonarcloud.io">
</a>
</p>

A TypeScript SDK for Jellyfin.

> Warning: This project is under active development, so API changes may occur.

## Building Locally

If you want to build the SDK locally (for development, testing, or contributing), follow the steps below.

### 1. Replace `openapi.json` file

Obtain the correct `openapi.json` file from the Jellyfin server repository.

- If working with merged changes, you can download it from the [jellyfin api spec](https://api.jellyfin.org/openapi/jellyfin-openapi-stable.json).
- If working with unmerged branch changes, download the `openapi.json` artifact generated from that specific branch build.

Once you have the correct file, replace the existing `openapi.json` in this repository with the new one.

### 2. Build the project

You can now build the project by executing the following commands

```sh
    npm run fix-schema
    npm run build
    ```

This should then generate a compiled output in the `lib` folder

### 3. Use the local build in another project

You can reference your local build in another repository using `npm link`:

```sh
   npm link
   ```

Then, in the consuming project:

```sh
   npm link @jellyfin/sdk
   ```

This allows you to test changes to the SDK without publishing it to npm.

## Install

```sh
npm i --save @jellyfin/sdk
```

or

```sh
yarn add @jellyfin/sdk
```

### Supported Jellyfin Versions

|  SDK Version  | Jellyfin Version |
|:-------------:|:----------------:|
|    0.13.0     |     10.11.x      |
|    0.12.0     |     10.11.x      |
|    0.11.0     |     10.10.x      |
|    0.10.0     |      10.9.x      |
|     0.9.0     |      10.9.x      |
| 0.8.2 - 0.6.0 | 10.8.1 - 10.8.13 |
|     0.5.0     |      10.8.0      |
|    <0.5.0     |      10.7.x      |

> Note: Versions prior to 0.7.0 were published as `@thornbill/jellyfin-sdk`.

### React Native

The generated Axios client used in this library depends on `URL` and `URLSearchParams` to be available on the global scope.
React Native only includes incomplete implementations for these classes, so a polyfill is required.
[React Native URL Polyfill](https://github.com/charpeni/react-native-url-polyfill) seems like a good solution for this.

## Usage

```js
// Create a new instance of the SDK
const jellyfin = new Jellyfin({
    clientInfo: {
        name: 'My Client Application',
        version: '1.0.0'
    },
    deviceInfo: {
        name: 'Device Name',
        id: 'unique-device-id',
        languages: ['en-US']
    }
});

// Find a valid server by trying to connect using common protocols and ports.
// Each server receives a score based on security, speed, and other criteria.
const servers = await jellyfin.discovery.getRecommendedServerCandidates('demo.jellyfin.org/stable');
// A utility function for finding the best result is available.
// If there is no "best" server, an error message should be displayed.
const best = jellyfin.discovery.findBestServer(servers);

// Create an API instance
const api = jellyfin.createApi(best.address);

// Each API endpoint is represented by a class in the generated client.
// Helper utility functions are provided under `/lib/utils/api/` to create an
// instance of a specific Jellyfin API using the shared Configuration and Axios
// instance from the `api` object created above.

// For example, the SystemApi can be generated using the `getSystemApi`
// function in `/lib/utils/api/system-api`.

// Fetch the public system info
const info = await getSystemApi(api).getPublicSystemInfo();
console.log('Info =>', info.data);

// Fetch the list of public users
const users = await getUserApi(api).getPublicUsers();
console.log('Users =>', users.data);

// Login with a username and password.
const auth = await getAuthenticationApi(this).authenticateUserByName({ authenticateUserByName: { Username: 'demo', Pw: '' } });
console.log('Auth =>', auth.data);

// Authentication state is stored internally in the Api class, so now
// requests that require authentication can be made normally
const libraries = await getLibraryApi(api).getMediaFolders();
console.log('Libraries =>', libraries.data);

// Logout the current user.
await getSessionApi(api).reportSessionEnded();
```

## Significant Changes

[See the CHANGELOG](./CHANGELOG.md)