7904277794

Committed 14 Feb 2024 04:26PM UTC coverage: 78.6%. Remained the same

Build # 7904277794

Build Type

Pull #188

github

Committed by

web-flow

Commit Message

Merge ac6cdcea1 into 981226514

Pull Request Pull Request #188: Code refresh

Run Details

869 of 1147 branches covered (75.76%)

Branch coverage included in aggregate %.

77 of 207 new or added lines in 16 files covered. (37.2%)

56 existing lines in 1 file now uncovered.

1691 of 2110 relevant lines covered (80.14%)

77.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

65.38

/src/services/content-directory.service.ts

/**
 * Sonos ContentDirectory service
 *
 * Stephan van Rooij
 * https://svrooij.io
 *
 * This file is generated, do not edit manually. https://sonos.svrooij.io/
 */
import BaseService from './base-service';
import { SonosUpnpError } from '../models/sonos-upnp-error';
import SonosUpnpErrors from './sonos-upnp-errors';
import {
  BrowseResponse,
} from '../models';

/**
 * Browse for local content
 *
 * @export
 * @class ContentDirectoryServiceBase
 * @extends {BaseService}
 */
export class ContentDirectoryServiceBase extends BaseService<ContentDirectoryServiceEvent> {
  readonly serviceNane: string = 'ContentDirectory';

  readonly controlUrl: string = '/MediaServer/ContentDirectory/Control';

  readonly eventSubUrl: string = '/MediaServer/ContentDirectory/Event';

  readonly scpUrl: string = '/xml/ContentDirectory1.xml';

  /**
   * Default errors and service specific errors
   *
   * @type {SonosUpnpError[]}
   * @remarks See https://svrooij.io/sonos-api-docs/#manual-documentation-file
   */
  readonly errors: SonosUpnpError[] = [
    ...SonosUpnpErrors.defaultErrors,
    { code: 701, description: 'No such object' },
    { code: 702, description: 'Invalid CurrentTagValue' },
    { code: 703, description: 'Invalid NewTagValue' },
    { code: 704, description: 'Required tag' },
    { code: 705, description: 'Read-only tag' },
    { code: 706, description: 'Parameter mismatch' },
    { code: 708, description: 'Invalid search criteria' },
    { code: 709, description: 'Invalid sort criteria' },
    { code: 710, description: 'No such container' },
    { code: 711, description: 'Restricted object' },
    { code: 712, description: 'Bad metadata' },
    { code: 713, description: 'Restricted parent object' },
    { code: 714, description: 'No such source resource' },
    { code: 715, description: 'Resource access denied' },
    { code: 716, description: 'Transfer busy' },
    { code: 717, description: 'No such file transfer' },
    { code: 718, description: 'No such destination resource' },
    { code: 719, description: 'Destination resource access denied' },
    { code: 720, description: 'Cannot process the request' },
  ];

  // #region actions
  /**
   * Browse for content: Music library (A), share(S:), Sonos playlists(SQ:), Sonos favorites(FV:2), radio stations(R:0/0), radio shows(R:0/1), queue(Q:)). Recommendation: Send one request, check the &#x60;TotalMatches&#x60; and - if necessary - do additional requests with higher &#x60;StartingIndex&#x60;. In case of duplicates only the first is returned! Example: albums with same title, even if artists are different
   *
   * @param {string} input.ObjectID - The search query, (`A:ARTIST` / `A:ALBUMARTIST` / `A:ALBUM` / `A:GENRE` / `A:COMPOSER` / `A:TRACKS` / `A:PLAYLISTS` / `FV:2` / `Q:`/ `R:0/0` / `R:0/1` / `S:` / `SQ:`) with optionally `:search+query` behind it.
   * @param {string} input.BrowseFlag - How to browse [ 'BrowseMetadata' / 'BrowseDirectChildren' ]
   * @param {string} input.Filter - Which fields should be returned `*` for all.
   * @param {number} input.StartingIndex - Paging, where to start, usually 0
   * @param {number} input.RequestedCount - Paging, number of items, maximum is 1,000. This parameter does NOT restrict the number of items being searched (filter) but only the number being returned. Using 0 is equivalent to 1,000
   * @param {string} input.SortCriteria - Sort the results based on metadata fields. `+upnp:artist,+dc:title` for sorting on artist then on title.
   * @remarks (1) If the title contains an apostrophe the returned uri will contain a `&apos;`. (2) Some libraries support a BrowseAndParse, so you don't have to parse the xml.
   */
  Browse(input: { ObjectID: string; BrowseFlag: string; Filter: string; StartingIndex: number; RequestedCount: number; SortCriteria: string }):
  Promise<BrowseResponse> { return this.SoapRequestWithBody<typeof input, BrowseResponse>('Browse', input); }

  CreateObject(input: { ContainerID: string; Elements: string }):
  Promise<CreateObjectResponse> { return this.SoapRequestWithBody<typeof input, CreateObjectResponse>('CreateObject', input); }

  DestroyObject(input: { ObjectID: string }):
  Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('DestroyObject', input); }

  FindPrefix(input: { ObjectID: string; Prefix: string }):
  Promise<FindPrefixResponse> { return this.SoapRequestWithBody<typeof input, FindPrefixResponse>('FindPrefix', input); }

  /**
   * Get the current album art display option such as &#x60;WMP&#x60;, &#x60;ITUNES&#x60; or &#x60;NONE&#x60;
   */
  GetAlbumArtistDisplayOption():
  Promise<GetAlbumArtistDisplayOptionResponse> { return this.SoapRequest<GetAlbumArtistDisplayOptionResponse>('GetAlbumArtistDisplayOption'); }

  GetAllPrefixLocations(input: { ObjectID: string }):
  Promise<GetAllPrefixLocationsResponse> { return this.SoapRequestWithBody<typeof input, GetAllPrefixLocationsResponse>('GetAllPrefixLocations', input); }

  GetBrowseable():
  Promise<GetBrowseableResponse> { return this.SoapRequest<GetBrowseableResponse>('GetBrowseable'); }

  GetLastIndexChange():
  Promise<GetLastIndexChangeResponse> { return this.SoapRequest<GetLastIndexChangeResponse>('GetLastIndexChange'); }

  GetSearchCapabilities():
  Promise<GetSearchCapabilitiesResponse> { return this.SoapRequest<GetSearchCapabilitiesResponse>('GetSearchCapabilities'); }

  GetShareIndexInProgress():
  Promise<GetShareIndexInProgressResponse> { return this.SoapRequest<GetShareIndexInProgressResponse>('GetShareIndexInProgress'); }

  GetSortCapabilities():
  Promise<GetSortCapabilitiesResponse> { return this.SoapRequest<GetSortCapabilitiesResponse>('GetSortCapabilities'); }

  GetSystemUpdateID():
  Promise<GetSystemUpdateIDResponse> { return this.SoapRequest<GetSystemUpdateIDResponse>('GetSystemUpdateID'); }

  /**
   * Updates the music library (share) index
   *
   * @param {string} input.AlbumArtistDisplayOption - `WMP`, `ITUNES` or `NONE`
   */
  RefreshShareIndex(input: { AlbumArtistDisplayOption: string }):
  Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('RefreshShareIndex', input); }

  RequestResort(input: { SortOrder: string }):
  Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('RequestResort', input); }

  SetBrowseable(input: { Browseable: boolean }):
  Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('SetBrowseable', input); }

  UpdateObject(input: { ObjectID: string; CurrentTagValue: string; NewTagValue: string }):
  Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('UpdateObject', input); }
  // #endregion

  protected responseProperties(): { [key: string]: string } {
    return {
      Result: 'string',
      NumberReturned: 'number',
      TotalMatches: 'number',
      UpdateID: 'number',
      ObjectID: 'string',
      StartingIndex: 'number',
      AlbumArtistDisplayOption: 'string',
      TotalPrefixes: 'number',
      PrefixAndIndexCSV: 'string',
      IsBrowseable: 'boolean',
      LastIndexChange: 'string',
      SearchCaps: 'string',
      IsIndexing: 'boolean',
      SortCaps: 'string',
      Id: 'number',
    };
  }

  // Event properties from service description.
  protected eventProperties(): { [key: string]: string } {
    return {
      Browseable: 'boolean',
      ContainerUpdateIDs: 'string',
      FavoritePresetsUpdateID: 'string',
      FavoritesUpdateID: 'string',
      RadioFavoritesUpdateID: 'number',
      RadioLocationUpdateID: 'number',
      RecentlyPlayedUpdateID: 'string',
      SavedQueuesUpdateID: 'string',
      SearchCapabilities: 'string',
      ShareIndexInProgress: 'boolean',
      ShareIndexLastError: 'string',
      ShareListUpdateID: 'string',
      SortCapabilities: 'string',
      SystemUpdateID: 'number',
      UserRadioUpdateID: 'string',
    };
  }
}

// Generated responses
export interface CreateObjectResponse {
  ObjectID: string;
  Result: string;
}

export interface FindPrefixResponse {
  StartingIndex: number;
  UpdateID: number;
}

export interface GetAlbumArtistDisplayOptionResponse {
  AlbumArtistDisplayOption: string;
}

export interface GetAllPrefixLocationsResponse {
  TotalPrefixes: number;
  PrefixAndIndexCSV: string;
  UpdateID: number;
}

export interface GetBrowseableResponse {
  IsBrowseable: boolean;
}

export interface GetLastIndexChangeResponse {
  LastIndexChange: string;
}

export interface GetSearchCapabilitiesResponse {
  SearchCaps: string;
}

export interface GetShareIndexInProgressResponse {
  IsIndexing: boolean;
}

export interface GetSortCapabilitiesResponse {
  SortCaps: string;
}

export interface GetSystemUpdateIDResponse {
  Id: number;
}

// Strong type event
export interface ContentDirectoryServiceEvent {
  Browseable?: boolean;
  ContainerUpdateIDs?: string;
  FavoritePresetsUpdateID?: string;
  FavoritesUpdateID?: string;
  RadioFavoritesUpdateID?: number;
  RadioLocationUpdateID?: number;
  RecentlyPlayedUpdateID?: string;
  SavedQueuesUpdateID?: string;
  SearchCapabilities?: string;
  ShareIndexInProgress?: boolean;
  ShareIndexLastError?: string;
  ShareListUpdateID?: string;
  SortCapabilities?: string;
  SystemUpdateID?: number;
  UserRadioUpdateID?: string;
}

1	/**
2	* Sonos ContentDirectory service
3	*
4	* Stephan van Rooij
5	* https://svrooij.io
6	*
7	* This file is generated, do not edit manually. https://sonos.svrooij.io/
8	*/
9	import BaseService from './base-service';	5✔
10	import { SonosUpnpError } from '../models/sonos-upnp-error';
11	import SonosUpnpErrors from './sonos-upnp-errors';	5✔
12	import {
13	BrowseResponse,
14	} from '../models';
15
16	/**
17	* Browse for local content
18	*
19	* @export
20	* @class ContentDirectoryServiceBase
21	* @extends {BaseService}
22	*/
23	export class ContentDirectoryServiceBase extends BaseService<ContentDirectoryServiceEvent> {	5✔
24	readonly serviceNane: string = 'ContentDirectory';	17✔
25
26	readonly controlUrl: string = '/MediaServer/ContentDirectory/Control';	17✔
27
28	readonly eventSubUrl: string = '/MediaServer/ContentDirectory/Event';	17✔
29
30	readonly scpUrl: string = '/xml/ContentDirectory1.xml';	17✔
31
32	/**
33	* Default errors and service specific errors
34	*
35	* @type {SonosUpnpError[]}
36	* @remarks See https://svrooij.io/sonos-api-docs/#manual-documentation-file
37	*/
38	readonly errors: SonosUpnpError[] = [	17✔
39	...SonosUpnpErrors.defaultErrors,
40	{ code: 701, description: 'No such object' },
41	{ code: 702, description: 'Invalid CurrentTagValue' },
42	{ code: 703, description: 'Invalid NewTagValue' },
43	{ code: 704, description: 'Required tag' },
44	{ code: 705, description: 'Read-only tag' },
45	{ code: 706, description: 'Parameter mismatch' },
46	{ code: 708, description: 'Invalid search criteria' },
47	{ code: 709, description: 'Invalid sort criteria' },
48	{ code: 710, description: 'No such container' },
49	{ code: 711, description: 'Restricted object' },
50	{ code: 712, description: 'Bad metadata' },
51	{ code: 713, description: 'Restricted parent object' },
52	{ code: 714, description: 'No such source resource' },
53	{ code: 715, description: 'Resource access denied' },
54	{ code: 716, description: 'Transfer busy' },
55	{ code: 717, description: 'No such file transfer' },
56	{ code: 718, description: 'No such destination resource' },
57	{ code: 719, description: 'Destination resource access denied' },
58	{ code: 720, description: 'Cannot process the request' },
59	];
60
61	// #region actions
62	/**
63	* Browse for content: Music library (A), share(S:), Sonos playlists(SQ:), Sonos favorites(FV:2), radio stations(R:0/0), radio shows(R:0/1), queue(Q:)). Recommendation: Send one request, check the `TotalMatches` and - if necessary - do additional requests with higher `StartingIndex`. In case of duplicates only the first is returned! Example: albums with same title, even if artists are different
64	*
65	* @param {string} input.ObjectID - The search query, (`A:ARTIST` / `A:ALBUMARTIST` / `A:ALBUM` / `A:GENRE` / `A:COMPOSER` / `A:TRACKS` / `A:PLAYLISTS` / `FV:2` / `Q:`/ `R:0/0` / `R:0/1` / `S:` / `SQ:`) with optionally `:search+query` behind it.
66	* @param {string} input.BrowseFlag - How to browse [ 'BrowseMetadata' / 'BrowseDirectChildren' ]
67	* @param {string} input.Filter - Which fields should be returned `*` for all.
68	* @param {number} input.StartingIndex - Paging, where to start, usually 0
69	* @param {number} input.RequestedCount - Paging, number of items, maximum is 1,000. This parameter does NOT restrict the number of items being searched (filter) but only the number being returned. Using 0 is equivalent to 1,000
70	* @param {string} input.SortCriteria - Sort the results based on metadata fields. `+upnp:artist,+dc:title` for sorting on artist then on title.
71	* @remarks (1) If the title contains an apostrophe the returned uri will contain a `'`. (2) Some libraries support a BrowseAndParse, so you don't have to parse the xml.
72	*/
73	Browse(input: { ObjectID: string; BrowseFlag: string; Filter: string; StartingIndex: number; RequestedCount: number; SortCriteria: string }):
74	Promise<BrowseResponse> { return this.SoapRequestWithBody<typeof input, BrowseResponse>('Browse', input); }	6✔
75
76	CreateObject(input: { ContainerID: string; Elements: string }):
NEW 77	Promise<CreateObjectResponse> { return this.SoapRequestWithBody<typeof input, CreateObjectResponse>('CreateObject', input); }	×
78
79	DestroyObject(input: { ObjectID: string }):
NEW 80	Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('DestroyObject', input); }	×
81
82	FindPrefix(input: { ObjectID: string; Prefix: string }):
NEW 83	Promise<FindPrefixResponse> { return this.SoapRequestWithBody<typeof input, FindPrefixResponse>('FindPrefix', input); }	×
84
85	/**
86	* Get the current album art display option such as `WMP`, `ITUNES` or `NONE`
87	*/
88	GetAlbumArtistDisplayOption():
89	Promise<GetAlbumArtistDisplayOptionResponse> { return this.SoapRequest<GetAlbumArtistDisplayOptionResponse>('GetAlbumArtistDisplayOption'); }	1✔
90
91	GetAllPrefixLocations(input: { ObjectID: string }):
NEW 92	Promise<GetAllPrefixLocationsResponse> { return this.SoapRequestWithBody<typeof input, GetAllPrefixLocationsResponse>('GetAllPrefixLocations', input); }	×
93
94	GetBrowseable():
95	Promise<GetBrowseableResponse> { return this.SoapRequest<GetBrowseableResponse>('GetBrowseable'); }	1✔
96
97	GetLastIndexChange():
98	Promise<GetLastIndexChangeResponse> { return this.SoapRequest<GetLastIndexChangeResponse>('GetLastIndexChange'); }	1✔
99
100	GetSearchCapabilities():
101	Promise<GetSearchCapabilitiesResponse> { return this.SoapRequest<GetSearchCapabilitiesResponse>('GetSearchCapabilities'); }	1✔
102
103	GetShareIndexInProgress():
104	Promise<GetShareIndexInProgressResponse> { return this.SoapRequest<GetShareIndexInProgressResponse>('GetShareIndexInProgress'); }	1✔
105
106	GetSortCapabilities():
107	Promise<GetSortCapabilitiesResponse> { return this.SoapRequest<GetSortCapabilitiesResponse>('GetSortCapabilities'); }	1✔
108
109	GetSystemUpdateID():
110	Promise<GetSystemUpdateIDResponse> { return this.SoapRequest<GetSystemUpdateIDResponse>('GetSystemUpdateID'); }	1✔
111
112	/**
113	* Updates the music library (share) index
114	*
115	* @param {string} input.AlbumArtistDisplayOption - `WMP`, `ITUNES` or `NONE`
116	*/
117	RefreshShareIndex(input: { AlbumArtistDisplayOption: string }):
NEW 118	Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('RefreshShareIndex', input); }	×
119
120	RequestResort(input: { SortOrder: string }):
NEW 121	Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('RequestResort', input); }	×
122
123	SetBrowseable(input: { Browseable: boolean }):
NEW 124	Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('SetBrowseable', input); }	×
125
126	UpdateObject(input: { ObjectID: string; CurrentTagValue: string; NewTagValue: string }):
NEW 127	Promise<boolean> { return this.SoapRequestWithBodyNoResponse<typeof input>('UpdateObject', input); }	×
128	// #endregion
129
130	protected responseProperties(): { [key: string]: string } {
131	return {	31✔
132	Result: 'string',
133	NumberReturned: 'number',
134	TotalMatches: 'number',
135	UpdateID: 'number',
136	ObjectID: 'string',
137	StartingIndex: 'number',
138	AlbumArtistDisplayOption: 'string',
139	TotalPrefixes: 'number',
140	PrefixAndIndexCSV: 'string',
141	IsBrowseable: 'boolean',
142	LastIndexChange: 'string',
143	SearchCaps: 'string',
144	IsIndexing: 'boolean',
145	SortCaps: 'string',
146	Id: 'number',
147	};
148	}
149
150	// Event properties from service description.
151	protected eventProperties(): { [key: string]: string } {
152	return {	×
153	Browseable: 'boolean',
154	ContainerUpdateIDs: 'string',
155	FavoritePresetsUpdateID: 'string',
156	FavoritesUpdateID: 'string',
157	RadioFavoritesUpdateID: 'number',
158	RadioLocationUpdateID: 'number',
159	RecentlyPlayedUpdateID: 'string',
160	SavedQueuesUpdateID: 'string',
161	SearchCapabilities: 'string',
162	ShareIndexInProgress: 'boolean',
163	ShareIndexLastError: 'string',
164	ShareListUpdateID: 'string',
165	SortCapabilities: 'string',
166	SystemUpdateID: 'number',
167	UserRadioUpdateID: 'string',
168	};
169	}
170	}
171
172	// Generated responses
173	export interface CreateObjectResponse {
174	ObjectID: string;
175	Result: string;
176	}
177
178	export interface FindPrefixResponse {
179	StartingIndex: number;
180	UpdateID: number;
181	}
182
183	export interface GetAlbumArtistDisplayOptionResponse {
184	AlbumArtistDisplayOption: string;
185	}
186
187	export interface GetAllPrefixLocationsResponse {
188	TotalPrefixes: number;
189	PrefixAndIndexCSV: string;
190	UpdateID: number;
191	}
192
193	export interface GetBrowseableResponse {
194	IsBrowseable: boolean;
195	}
196
197	export interface GetLastIndexChangeResponse {
198	LastIndexChange: string;
199	}
200
201	export interface GetSearchCapabilitiesResponse {
202	SearchCaps: string;
203	}
204
205	export interface GetShareIndexInProgressResponse {
206	IsIndexing: boolean;
207	}
208
209	export interface GetSortCapabilitiesResponse {
210	SortCaps: string;
211	}
212
213	export interface GetSystemUpdateIDResponse {
214	Id: number;
215	}
216
217	// Strong type event
218	export interface ContentDirectoryServiceEvent {
219	Browseable?: boolean;
220	ContainerUpdateIDs?: string;
221	FavoritePresetsUpdateID?: string;
222	FavoritesUpdateID?: string;
223	RadioFavoritesUpdateID?: number;
224	RadioLocationUpdateID?: number;
225	RecentlyPlayedUpdateID?: string;
226	SavedQueuesUpdateID?: string;
227	SearchCapabilities?: string;
228	ShareIndexInProgress?: boolean;
229	ShareIndexLastError?: string;
230	ShareListUpdateID?: string;
231	SortCapabilities?: string;
232	SystemUpdateID?: number;
233	UserRadioUpdateID?: string;
234	}

svrooij / node-sonos-ts / 7904277794

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous