livekit-server-sdk 2.3.0 → 2.5.0

package/src/grants.ts

@@ -0,0 +1,107 @@
+// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+import { TrackSource } from '@livekit/protocol';
+import type { JWTPayload } from 'jose';
+
+export function trackSourceToString(source: TrackSource) {
+  switch (source) {
+    case TrackSource.CAMERA:
+      return 'camera';
+    case TrackSource.MICROPHONE:
+      return 'microphone';
+    case TrackSource.SCREEN_SHARE:
+      return 'screen_share';
+    case TrackSource.SCREEN_SHARE_AUDIO:
+      return 'screen_share_audio';
+    default:
+      throw new TypeError(`Cannot convert TrackSource ${source} to string`);
+  }
+}
+
+export function claimsToJwtPayload(
+  grant: ClaimGrants,
+): JWTPayload & { video?: Record<string, unknown> } {
+  const claim: Record<string, any> = { ...grant };
+  // eslint-disable-next-line no-restricted-syntax
+  if (Array.isArray(claim.video?.canPublishSources)) {
+    claim.video.canPublishSources = claim.video.canPublishSources.map(trackSourceToString);
+  }
+  return claim;
+}
+
+export interface VideoGrant {
+  /** permission to create a room */
+  roomCreate?: boolean;
+
+  /** permission to join a room as a participant, room must be set */
+  roomJoin?: boolean;
+
+  /** permission to list rooms */
+  roomList?: boolean;
+
+  /** permission to start a recording */
+  roomRecord?: boolean;
+
+  /** permission to control a specific room, room must be set */
+  roomAdmin?: boolean;
+
+  /** name of the room, must be set for admin or join permissions */
+  room?: string;
+
+  /** permissions to control ingress, not specific to any room or ingress */
+  ingressAdmin?: boolean;
+
+  /**
+   * allow participant to publish. If neither canPublish or canSubscribe is set,
+   * both publish and subscribe are enabled
+   */
+  canPublish?: boolean;
+
+  /**
+   * TrackSource types that the participant is allowed to publish
+   * When set, it supersedes CanPublish. Only sources explicitly set here can be published
+   */
+  canPublishSources?: TrackSource[];
+
+  /** allow participant to subscribe to other tracks */
+  canSubscribe?: boolean;
+
+  /**
+   * allow participants to publish data, defaults to true if not set
+   */
+  canPublishData?: boolean;
+
+  /**
+   * by default, a participant is not allowed to update its own metadata
+   */
+  canUpdateOwnMetadata?: boolean;
+
+  /** participant isn't visible to others */
+  hidden?: boolean;
+
+  /** participant is recording the room, when set, allows room to indicate it's being recorded */
+  recorder?: boolean;
+
+  /** participant allowed to connect to LiveKit as Agent Framework worker */
+  agent?: boolean;
+}
+
+export interface SIPGrant {
+  /** manage sip resources */
+  admin?: boolean;
+
+  /** make outbound calls */
+  call?: boolean;
+}
+
+/** @internal */
+export interface ClaimGrants extends JWTPayload {
+  name?: string;
+  video?: VideoGrant;
+  sip?: SIPGrant;
+  kind?: string;
+  metadata?: string;
+  attributes?: Record<string, string>;
+  sha256?: string;
+}

package/src/index.ts

@@ -0,0 +1,53 @@
+// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './AccessToken.js';
+export * from './EgressClient.js';
+export * from './IngressClient.js';
+export * from './SipClient.js';
+export * from './RoomServiceClient.js';
+export * from './WebhookReceiver.js';
+export * from './grants.js';
+export {
+  AliOSSUpload,
+  AzureBlobUpload,
+  DirectFileOutput,
+  EgressInfo,
+  EncodedFileOutput,
+  EncodedFileType,
+  EncodingOptions,
+  EncodingOptionsPreset,
+  GCPUpload,
+  ImageOutput,
+  ParticipantEgressRequest,
+  RoomCompositeEgressRequest,
+  S3Upload,
+  SegmentedFileOutput,
+  SegmentedFileProtocol,
+  StreamOutput,
+  StreamProtocol,
+  TrackCompositeEgressRequest,
+  TrackEgressRequest,
+  WebEgressRequest,
+  IngressAudioEncodingOptions,
+  IngressAudioEncodingPreset,
+  IngressAudioOptions,
+  IngressInfo,
+  IngressInput,
+  IngressState,
+  IngressVideoEncodingOptions,
+  IngressVideoEncodingPreset,
+  IngressVideoOptions,
+  DataPacket_Kind,
+  ParticipantInfo,
+  ParticipantInfo_State,
+  ParticipantPermission,
+  Room,
+  TrackInfo,
+  TrackType,
+  TrackSource,
+  SIPTrunkInfo,
+  SIPDispatchRuleInfo,
+  SIPParticipantInfo,
+} from '@livekit/protocol';

package/.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@2.0.0/schema.json",
-  "changelog": ["@livekit/changesets-changelog-github", { "repo": "livekit/server-sdk-js" }],
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "public",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/.eslintrc.cjs

@@ -1,17 +0,0 @@
-module.exports = {
-  extends: ['plugin:import/recommended', 'airbnb-typescript/base', 'prettier'],
-  parserOptions: {
-    project: './tsconfig.eslint.json',
-  },
-  ignorePatterns: ['src/proto', 'docs/', 'dist/', 'examples'],
-  rules: {
-    'import/export': 'off',
-    'max-classes-per-file': 'off',
-    'no-param-reassign': 'off',
-    'no-await-in-loop': 'off',
-    'consistent-return': 'off',
-    'class-methods-use-this': 'off',
-    '@typescript-eslint/no-use-before-define': 'off',
-    'no-restricted-syntax': ['error', 'WithStatement', "BinaryExpression[operator='in']"],
-  },
-};

package/.github/workflows/release.yaml

@@ -1,46 +0,0 @@
-name: Release
-
-on:
-  push:
-    branches:
-      - main
-
-concurrency: ${{ github.workflow }}-${{ github.ref }}
-
-jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Repo
-        uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-      - name: Use Node.js 20
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'pnpm'
-      - name: Install dependencies
-        run: pnpm install
-      - name: Create Release Pull Request or Publish to npm
-        id: changesets
-        uses: changesets/action@v1
-        with:
-          publish: pnpm ci:publish
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Build Docs
-        if: steps.changesets.outputs.published == 'true'
-        run: pnpm build-docs
-
-
-      - name: S3 Upload
-        if: steps.changesets.outputs.published == 'true'
-        run: aws s3 cp docs/ s3://livekit-docs/server-sdk-js --recursive
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }}
-          AWS_DEFAULT_REGION: "us-east-1"

package/.github/workflows/test.yaml

@@ -1,46 +0,0 @@
-name: Test
-
-# Controls when the action will run.
-on:
-  # Triggers the workflow on push or pull request events but only for the main branch
-  workflow_dispatch:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
-jobs:
-  test-node:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
-      - name: Use Node.js 20
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'pnpm'
-      - name: Install dependencies
-        run: pnpm install
-
-      - name: Lint
-        run: pnpm lint
-      
-      - name: Prettier
-        run: pnpm format:check
-
-      - name: Test Node
-        run: pnpm test
-
-      - name: Test browser
-        run: pnpm test:browser
-      
-      - name: Test edge runtime
-        run: pnpm test:edge
- 

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "protocol"]
-	path = protocol
-	url = https://github.com/livekit/protocol

package/.prettierignore

@@ -1,8 +0,0 @@
-.github/
-dist/
-docs/
-node_modules/
-protocol/
-src/proto/
-yarn.lock
-pnpm-lock.json

package/CHANGELOG.md

@@ -1,87 +0,0 @@
-# livekit-server-sdk
-
-## 2.3.0
-
-### Minor Changes
-
-- Add SIP service. - [#173](https://github.com/livekit/server-sdk-js/pull/173) ([@dennwc](https://github.com/dennwc))
-
-## 2.2.0
-
-### Minor Changes
-
-- Bump minimum engine requirement to node 19 - [#155](https://github.com/livekit/server-sdk-js/pull/155) ([@lukasIO](https://github.com/lukasIO))
-
-- Add support for enableTranscoding - [#171](https://github.com/livekit/server-sdk-js/pull/171) ([@biglittlebigben](https://github.com/biglittlebigben))
-
-### Patch Changes
-
-- Allow user to set participant metadata when creating Ingress - [#152](https://github.com/livekit/server-sdk-js/pull/152) ([@davidzhao](https://github.com/davidzhao))
-
-## 2.1.2
-
-### Patch Changes
-
-- Support for departure timeout in CreateRoom - [#150](https://github.com/livekit/server-sdk-js/pull/150) ([@davidzhao](https://github.com/davidzhao))
-
-## 2.1.1
-
-### Patch Changes
-
-- Make use of @livekit/protocol package - [#147](https://github.com/livekit/server-sdk-js/pull/147) ([@lukasIO](https://github.com/lukasIO))
-
-## 2.1.0
-
-### Minor Changes
-
-- Expose protobuf TrackSource and map TrackSource claims to string - [#145](https://github.com/livekit/server-sdk-js/pull/145) ([@lukasIO](https://github.com/lukasIO))
-
-### Patch Changes
-
-- Add support for Egress Image Output - [#143](https://github.com/livekit/server-sdk-js/pull/143) ([@biglittlebigben](https://github.com/biglittlebigben))
-
-## 2.0.4
-
-### Patch Changes
-
-- Add agent field to VideoGrant - [#141](https://github.com/livekit/server-sdk-js/pull/141) ([@lukasIO](https://github.com/lukasIO))
-
-## 2.0.3
-
-### Patch Changes
-
-- Export types needed for Egress - [#137](https://github.com/livekit/server-sdk-js/pull/137) ([@davidzhao](https://github.com/davidzhao))
-
-## 2.0.2
-
-### Patch Changes
-
-- Fix issue decoding unknown fields in webhook receiver - [#135](https://github.com/livekit/server-sdk-js/pull/135) ([@davidzhao](https://github.com/davidzhao))
-
-## 2.0.1
-
-### Patch Changes
-
-- Ignore unknown fields in protobuf parsing - [#132](https://github.com/livekit/server-sdk-js/pull/132) ([@lukasIO](https://github.com/lukasIO))
-
-## 2.0.0
-
-### Major Changes
-
-- Change module type to ESM - [#118](https://github.com/livekit/server-sdk-js/pull/118) ([@lukasIO](https://github.com/lukasIO))
-
-- Require node 18 as minimum version - [#118](https://github.com/livekit/server-sdk-js/pull/118) ([@lukasIO](https://github.com/lukasIO))
-
-- Make `WebhookEvent` names type safe - [#125](https://github.com/livekit/server-sdk-js/pull/125) ([@lukasIO](https://github.com/lukasIO))
-
-- Token generation is now async (replaced jsonwebtoken with jose for better JS runtime support) - [#118](https://github.com/livekit/server-sdk-js/pull/118) ([@lukasIO](https://github.com/lukasIO))
-
-- Replace protobufjs with protobuf-es - [#118](https://github.com/livekit/server-sdk-js/pull/118) ([@lukasIO](https://github.com/lukasIO))
-
-### Minor Changes
-
-- Use globally available web crypto API instead of nodeJS crypto module - [#122](https://github.com/livekit/server-sdk-js/pull/122) ([@lukasIO](https://github.com/lukasIO))
-
-### Patch Changes
-
-- Throw error on bad Twirp response status and use async/await instead of promise chaining for improved error catching - [#124](https://github.com/livekit/server-sdk-js/pull/124) ([@lukasIO](https://github.com/lukasIO))

package/NOTICE

@@ -1,13 +0,0 @@
-Copyright 2023 LiveKit, Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

package/renovate.json

@@ -1,18 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["config:base"],
-  "rangeStrategy": "auto",
-  "packageRules": [
-    {
-      "schedule": "on the first day of the month",
-      "matchDepTypes": ["devDependencies"],
-      "matchUpdateTypes": ["patch", "minor"],
-      "groupName": "devDependencies (non-major)"
-    },
-    {
-      "matchPackagePrefixes": ["@livekit", "livekit-"],
-      "matchUpdateTypes": ["patch", "minor"],
-      "groupName": "Update LiveKit dependencies (non-major)"
-    }
-  ]
-}

package/tsconfig.eslint.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["src/**.ts", "vite.config.js"],
-  "exclude": []
-}

package/vite.config.js

@@ -1,8 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-  test: {
-    environment: 'node',
-  },
-});