Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

upgrade our fork to 0.20.0 #4

Merged
merged 26 commits into from
Aug 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
e8135b8
Add support for extraHeaders on Invitation.accept
danvirsen Feb 22, 2021
0c275ad
Make the interval at which re-REGISTER requests are sent configurable
erogleva Feb 5, 2021
5cd2a03
Merge pull request #902 from erogleva/reregister-interval
Feb 22, 2021
36d92b4
Merge pull request #910 from danvirsen/master
Feb 22, 2021
a13d3b6
Add `onAck` delegation for Session
Feb 28, 2021
71fa1a0
code lint-fix
slavikbialik Feb 28, 2021
44f7e50
update dependencies to clear github PR, update to webpack 5
Mar 9, 2021
83417d3
add gruu check to registerer to restore previous behavior
Mar 15, 2021
4627789
publisher: add check so that it does not attempt to enter published s…
Mar 15, 2021
709bed2
fix typo in extra headers (extra space)
Mar 15, 2021
dd958af
change description for ack.ts
slavikbialik Mar 15, 2021
fd54a59
Merge pull request #911 from reporty/feature/REP-44855
Mar 16, 2021
3a47552
update dependencies before version bump
Mar 16, 2021
5555a98
Version 0.20.0 (and update docs)
Mar 16, 2021
c821359
Bump lodash from 4.17.20 to 4.17.21
dependabot[bot] May 7, 2021
4ef4403
Bump url-parse from 1.4.7 to 1.5.1
dependabot[bot] May 8, 2021
852270c
Merge pull request #926 from onsip/dependabot/npm_and_yarn/lodash-4.1…
egreenmachine May 11, 2021
06c4ed2
Merge pull request #927 from onsip/dependabot/npm_and_yarn/url-parse-…
egreenmachine May 11, 2021
94adc03
Bump ws from 7.4.4 to 7.4.6
dependabot[bot] May 28, 2021
f757998
Bump glob-parent from 5.1.1 to 5.1.2
dependabot[bot] Jun 8, 2021
67bea3e
fix typo in docs/session-description-handler.md
aoinau Jul 8, 2021
bee355b
Merge pull request #940 from nnaoi/master
etamme Jul 8, 2021
4910cc8
Support for ephemeral credentials
luis-claro Jul 14, 2021
697fb08
Merge pull request #936 from onsip/dependabot/npm_and_yarn/glob-paren…
egreenmachine Jul 19, 2021
5dc8d56
Merge pull request #935 from onsip/dependabot/npm_and_yarn/ws-7.4.6
egreenmachine Jul 19, 2021
5cf8056
Merge pull request #941 from Talkdesk/master
etamme Jul 20, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/api/sip.js.ack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [Ack](./sip.js.ack.md)

## Ack class

A request to confirm a [Session](./sip.js.session.md) (incoming ACK).

<b>Signature:</b>

```typescript
export declare class Ack
```

## Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Ack` class.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [request](./sip.js.ack.request.md) | | <code>IncomingRequestMessage</code> | Incoming ACK request message. |

13 changes: 13 additions & 0 deletions docs/api/sip.js.ack.request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [Ack](./sip.js.ack.md) &gt; [request](./sip.js.ack.request.md)

## Ack.request property

Incoming ACK request message.

<b>Signature:</b>

```typescript
get request(): IncomingRequestMessage;
```
13 changes: 13 additions & 0 deletions docs/api/sip.js.invitationacceptoptions.extraheaders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [InvitationAcceptOptions](./sip.js.invitationacceptoptions.md) &gt; [extraHeaders](./sip.js.invitationacceptoptions.extraheaders.md)

## InvitationAcceptOptions.extraHeaders property

Array of extra headers added to the response.

<b>Signature:</b>

```typescript
extraHeaders?: Array<string>;
```
1 change: 1 addition & 0 deletions docs/api/sip.js.invitationacceptoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface InvitationAcceptOptions

| Property | Type | Description |
| --- | --- | --- |
| [extraHeaders](./sip.js.invitationacceptoptions.extraheaders.md) | <code>Array&lt;string&gt;</code> | Array of extra headers added to the response. |
| [sessionDescriptionHandlerModifiers](./sip.js.invitationacceptoptions.sessiondescriptionhandlermodifiers.md) | <code>Array&lt;SessionDescriptionHandlerModifier&gt;</code> | Modifiers to pass to SessionDescriptionHandler during the initial INVITE transaction. |
| [sessionDescriptionHandlerOptions](./sip.js.invitationacceptoptions.sessiondescriptionhandleroptions.md) | <code>SessionDescriptionHandlerOptions</code> | Options to pass to SessionDescriptionHandler during the initial INVITE transaction. |

1 change: 1 addition & 0 deletions docs/api/sip.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ A simple yet powerful API which takes care of SIP signaling and WebRTC media ses

| Class | Description |
| --- | --- |
| [Ack](./sip.js.ack.md) | A request to confirm a [Session](./sip.js.session.md) (incoming ACK). |
| [Bye](./sip.js.bye.md) | A request to end a [Session](./sip.js.session.md) (incoming BYE). |
| [ContentTypeUnsupportedError](./sip.js.contenttypeunsupportederror.md) | An exception indicating an unsupported content type prevented execution. |
| [Info](./sip.js.info.md) | An exchange of information (incoming INFO). |
Expand Down
1 change: 1 addition & 0 deletions docs/api/sip.js.registereroptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export interface RegistererOptions
| [instanceId](./sip.js.registereroptions.instanceid.md) | <code>string</code> | UUID to provide with "+sip.instance" Contact parameter. |
| [logConfiguration](./sip.js.registereroptions.logconfiguration.md) | <code>boolean</code> | If true, constructor logs the registerer configuration. |
| [params](./sip.js.registereroptions.params.md) | <code>{</code><br/><code> fromDisplayName?: string;</code><br/><code> fromTag?: string;</code><br/><code> fromUri?: URI;</code><br/><code> toDisplayName?: string;</code><br/><code> toUri?: URI;</code><br/><code> }</code> | |
| [refreshFrequency](./sip.js.registereroptions.refreshfrequency.md) | <code>number</code> | Determines when a re-REGISTER request is sent. The value should be specified as a percentage of the expiration time (between 50 and 99). |
| [regId](./sip.js.registereroptions.regid.md) | <code>number</code> | Value to provide with "reg-id" Contact parameter. |
| [registrar](./sip.js.registereroptions.registrar.md) | <code>URI</code> | The URI of the registrar to send the REGISTER requests. |

13 changes: 13 additions & 0 deletions docs/api/sip.js.registereroptions.refreshfrequency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [RegistererOptions](./sip.js.registereroptions.md) &gt; [refreshFrequency](./sip.js.registereroptions.refreshfrequency.md)

## RegistererOptions.refreshFrequency property

Determines when a re-REGISTER request is sent. The value should be specified as a percentage of the expiration time (between 50 and 99).

<b>Signature:</b>

```typescript
refreshFrequency?: number;
```
1 change: 1 addition & 0 deletions docs/api/sip.js.sessiondelegate.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface SessionDelegate

| Method | Description |
| --- | --- |
| [onAck(ack)](./sip.js.sessiondelegate.onack.md) | Called upon receiving an incoming in dialog ACK request. |
| [onBye(bye)](./sip.js.sessiondelegate.onbye.md) | Called upon receiving an incoming in dialog BYE request. |
| [onInfo(info)](./sip.js.sessiondelegate.oninfo.md) | Called upon receiving an incoming in dialog INFO request. |
| [onInvite(request, response, statusCode)](./sip.js.sessiondelegate.oninvite.md) | Called upon receiving an incoming in dialog INVITE request. |
Expand Down
24 changes: 24 additions & 0 deletions docs/api/sip.js.sessiondelegate.onack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [sip.js](./sip.js.md) &gt; [SessionDelegate](./sip.js.sessiondelegate.md) &gt; [onAck](./sip.js.sessiondelegate.onack.md)

## SessionDelegate.onAck() method

Called upon receiving an incoming in dialog ACK request.

<b>Signature:</b>

```typescript
onAck?(ack: Ack): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ack | <code>Ack</code> | The ack. |

<b>Returns:</b>

`void`

2 changes: 1 addition & 1 deletion docs/session-description-handler.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ import { Web } from "sip.js";

// The Session.sessionDescriptionHandlerOptionsReInvite property
// may be used to pass options to the SessionDescriptionHandler.
const sessionDescriptionHandlerOptions: Web.SesionDescriptionHandlerOptions = {
const sessionDescriptionHandlerOptions: Web.SessionDescriptionHandlerOptions = {
hold: true; // set to false to "unhold" session
}
session.sessionDescriptionHandlerOptionsReInvite = sessionDescriptionHandlerOptions;
Expand Down
16 changes: 13 additions & 3 deletions etc/api/sip.js.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

```ts

// @public
export class Ack {
// Warning: (ae-forgotten-export) The symbol "IncomingAckRequest" needs to be exported by the entry point index.d.ts
//
// @internal
constructor(incomingAckRequest: IncomingAckRequest);
// Warning: (ae-forgotten-export) The symbol "IncomingRequestMessage" needs to be exported by the entry point index.d.ts
get request(): IncomingRequestMessage;
}

// @public
export interface BodyAndContentType {
body: string;
Expand All @@ -19,7 +29,6 @@ export class Bye {
// Warning: (ae-forgotten-export) The symbol "ResponseOptions" needs to be exported by the entry point index.d.ts
accept(options?: ResponseOptions): Promise<void>;
reject(options?: ResponseOptions): Promise<void>;
// Warning: (ae-forgotten-export) The symbol "IncomingRequestMessage" needs to be exported by the entry point index.d.ts
get request(): IncomingRequestMessage;
}

Expand Down Expand Up @@ -99,6 +108,7 @@ export class Invitation extends Session {

// @public
export interface InvitationAcceptOptions {
extraHeaders?: Array<string>;
sessionDescriptionHandlerModifiers?: Array<SessionDescriptionHandlerModifier>;
sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
}
Expand Down Expand Up @@ -349,6 +359,7 @@ export interface RegistererOptions {
toDisplayName?: string;
toUri?: URI;
};
refreshFrequency?: number;
regId?: number;
registrar?: URI;
}
Expand Down Expand Up @@ -440,8 +451,6 @@ export abstract class Session {
message(options?: SessionMessageOptions): Promise<OutgoingMessageRequest>;
// @internal
_message(delegate?: OutgoingRequestDelegate, options?: RequestOptions): Promise<OutgoingMessageRequest>;
// Warning: (ae-forgotten-export) The symbol "IncomingAckRequest" needs to be exported by the entry point index.d.ts
//
// @internal
protected onAckRequest(request: IncomingAckRequest): Promise<void>;
// @internal
Expand Down Expand Up @@ -517,6 +526,7 @@ export interface SessionByeOptions {

// @public
export interface SessionDelegate {
onAck?(ack: Ack): void;
onBye?(bye: Bye): void;
onInfo?(info: Info): void;
onInvite?(request: IncomingRequestMessage, response: string, statusCode: number): void;
Expand Down
7 changes: 6 additions & 1 deletion karma.conf.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module.exports = function(config) {

// frameworks to use
// available frameworks: https://npmjs.org/browse/keyword/karma-adapter
frameworks: ['jasmine'],
frameworks: ['jasmine', 'webpack'],

// list of files / patterns to load in the browser
files: [
Expand All @@ -24,6 +24,11 @@ module.exports = function(config) {

webpack: {
devtool: 'inline-source-map',
module: { rules: [ { test: /\.m?js/,
resolve: {
fullySpecified: false
}
}]},
mode: 'production'
},

Expand Down
Loading