jamespot-user-api 1.0.80 → 1.0.84

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/documentation/assets/search.js +1 -1
  2. package/documentation/classes/AdminStoreApi.html +1 -1
  3. package/documentation/classes/JApplicationApi.html +8 -8
  4. package/documentation/classes/JArticleApi.html +1 -1
  5. package/documentation/classes/JAssetReservation.html +1 -0
  6. package/documentation/classes/JAudienceApi.html +1 -1
  7. package/documentation/classes/JBaseApi.html +1 -1
  8. package/documentation/classes/JBookmarkApi.html +1 -1
  9. package/documentation/classes/JCommunityApi.html +1 -1
  10. package/documentation/classes/JConceptApi.html +1 -1
  11. package/documentation/classes/JDiapazoneApi.html +1 -1
  12. package/documentation/classes/JFileApi.html +1 -1
  13. package/documentation/classes/JFilebankApi.html +1 -1
  14. package/documentation/classes/JGroupApi.html +1 -1
  15. package/documentation/classes/JLandApi.html +1 -1
  16. package/documentation/classes/JMessengerApi.html +1 -1
  17. package/documentation/classes/JSearchApi.html +6 -6
  18. package/documentation/classes/JShareApi.html +1 -1
  19. package/documentation/classes/JUserApi.html +3 -3
  20. package/documentation/classes/JWedocApi.html +1 -1
  21. package/documentation/classes/JamespotUserApi.html +1 -1
  22. package/documentation/classes/Network.html +1 -1
  23. package/documentation/classes/WindowBrowser.html +1 -1
  24. package/documentation/classes/WindowMock.html +2 -2
  25. package/documentation/enums/StudioApplicationStatus.html +1 -1
  26. package/documentation/index.html +1 -1
  27. package/documentation/interfaces/ApiError.html +1 -1
  28. package/documentation/interfaces/ApiWrapper.html +1 -1
  29. package/documentation/interfaces/BaseAutocomplete.html +1 -1
  30. package/documentation/interfaces/BaseMessage.html +1 -1
  31. package/documentation/interfaces/Category.html +1 -1
  32. package/documentation/interfaces/CreateGroup.html +1 -1
  33. package/documentation/interfaces/FileBankProps.html +1 -1
  34. package/documentation/interfaces/FolderProps.html +1 -1
  35. package/documentation/interfaces/ListFilterSpec.html +1 -1
  36. package/documentation/interfaces/OF.html +1 -1
  37. package/documentation/interfaces/PagingResults.html +1 -1
  38. package/documentation/interfaces/Result.html +1 -1
  39. package/documentation/interfaces/RootFolderProps.html +1 -1
  40. package/documentation/interfaces/SearchCategoryModel.html +1 -1
  41. package/documentation/interfaces/SearchConfig.html +1 -1
  42. package/documentation/interfaces/SearchFacetModel.html +1 -1
  43. package/documentation/interfaces/SearchFacetValueModel.html +1 -1
  44. package/documentation/interfaces/SearchQuery.html +1 -1
  45. package/documentation/interfaces/SearchQueryFilterModel.html +1 -1
  46. package/documentation/interfaces/SearchQueryOption.html +1 -1
  47. package/documentation/interfaces/SearchQueryResult.html +1 -1
  48. package/documentation/interfaces/SearchQuerySortModel.html +1 -1
  49. package/documentation/interfaces/SearchResultCatProps.html +1 -1
  50. package/documentation/interfaces/SearchResultProps.html +1 -1
  51. package/documentation/interfaces/SpotProps.html +1 -1
  52. package/documentation/interfaces/Taxonomy.html +1 -1
  53. package/documentation/interfaces/TaxonomyCreate.html +1 -1
  54. package/documentation/interfaces/UserModel.html +1 -1
  55. package/documentation/interfaces/WindowInterface.html +1 -1
  56. package/documentation/modules.html +1 -1
  57. package/lib/jamespot-user-api.js +1 -1
  58. package/lib/jamespot-user-api.js.map +1 -1
  59. package/lib/src/apis/assetReservation.d.ts +37 -0
  60. package/lib/src/apis/index.d.ts +3 -2
  61. package/lib/src/apis/jamespotUserApi.d.ts +2 -0
  62. package/lib/src/types/application.d.ts +15 -0
  63. package/lib/src/types/assetReservation.d.ts +31 -0
  64. package/lib/src/types/index.d.ts +4 -3
  65. package/lib/src/types/model.d.ts +87 -0
  66. package/lib/src/types/utils.d.ts +8 -1
  67. package/lib/src/window/index.d.ts +0 -2
  68. package/package.json +2 -2
  69. package/documentation/classes/WindowJestFetch.html +0 -1
  70. package/documentation/classes/WindowMobile.html +0 -1
  71. package/lib/src/window/WindowMobile.d.ts +0 -9
package/lib/src/types/model.d.ts ADDED
@@ -0,0 +1,87 @@
1
+ export declare type WidgetText = {
2
+ type: 'text';
3
+ };
4
+ export declare type WidgetTextarea = {
5
+ type: 'textarea';
6
+ };
7
+ export declare type WidgetNumber = {
8
+ type: 'number';
9
+ };
10
+ export declare type WidgetDate = {
11
+ type: 'date';
12
+ format: string;
13
+ };
14
+ export declare type WidgetDatetime = {
15
+ type: 'datetime';
16
+ };
17
+ export declare type WidgetSelect<U extends string = string> = {
18
+ type: 'select';
19
+ options: Record<U, string>;
20
+ params?: {
21
+ data?: string;
22
+ defaultValue?: U;
23
+ explain?: 1;
24
+ };
25
+ };
26
+ export declare type WidgetEmail = {
27
+ type: 'email';
28
+ };
29
+ export declare type WidgetUrl = {
30
+ type: 'url';
31
+ params: {
32
+ target?: '_blank';
33
+ };
34
+ };
35
+ export declare type WidgetRefUser = {
36
+ type: 'refUser';
37
+ };
38
+ export declare type WidgetTransient = {
39
+ type: 'transient';
40
+ };
41
+ export declare type WidgetRadio = {
42
+ type: 'radio';
43
+ options: Record<string, string>;
44
+ };
45
+ export declare type WidgetCheckbox = {
46
+ type: 'checkbox';
47
+ options: Record<string, string>;
48
+ };
49
+ export declare type WidgetTaxonomy = {
50
+ type: 'taxonomy';
51
+ params: {
52
+ idTaxonomy: string;
53
+ };
54
+ };
55
+ export declare type WidgetOrientedlinks = {
56
+ type: 'orientedlinks';
57
+ params: {
58
+ 'jcomplete-multiple': '0' | '1';
59
+ showAdd: '0' | '1';
60
+ supportedTypes: Array<string>;
61
+ };
62
+ };
63
+ export declare type WidgetUri = {
64
+ type: 'uri';
65
+ params: {
66
+ class: string;
67
+ 'jcomplete-url': string;
68
+ type: string;
69
+ };
70
+ };
71
+ export declare type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient;
72
+ export declare type FieldConfiguration<T extends string = string> = {
73
+ label: string;
74
+ description?: string;
75
+ widget: Widget;
76
+ name: T;
77
+ mandatory: boolean;
78
+ };
79
+ export declare type Configuration<T extends string> = FieldConfiguration<T>;
80
+ export declare type Model<T extends string = string> = {
81
+ type: string;
82
+ mainType: string;
83
+ label: string;
84
+ fields: Record<T, Configuration<T>>;
85
+ icon: string;
86
+ color: string;
87
+ };
package/lib/src/types/utils.d.ts CHANGED
@@ -9,11 +9,12 @@ export interface ApiWrapper<T, U = string[]> {
9
9
  export interface PagingResults<T> {
10
10
  cnt: number;
11
11
  data: Array<T>;
12
- facets: Array<{}>;
12
+ facets: null | Array<{}>;
13
13
  idQuery?: number;
14
14
  limit: number;
15
15
  page: number;
16
16
  }
17
+ export declare type ApiPagingResults<T, U = string[]> = ApiWrapper<PagingResults<T>, U>;
17
18
  export interface ApiError<U = string> {
18
19
  error: number;
19
20
  messages: U[];
@@ -36,6 +37,7 @@ export declare type Rights = {
36
37
  };
37
38
  export declare type Little = {
38
39
  id: number;
40
+ mainType: string;
39
41
  type: string;
40
42
  uri: string;
41
43
  title: string;
@@ -43,6 +45,11 @@ export declare type Little = {
43
45
  dateCreation: string;
44
46
  dateModified: string;
45
47
  };
48
+ export declare type List = Little & {
49
+ description?: string;
50
+ _user: Little;
51
+ _right: Rights;
52
+ };
46
53
  export declare type Order = {
47
54
  name: string;
48
55
  sort: 'ASC' | 'DESC';
package/lib/src/window/index.d.ts CHANGED
@@ -1,5 +1,3 @@
1
1
  export * from './Window';
2
2
  export * from './WindowBrowser';
3
- export * from './WindowJestFetch';
4
- export * from './WindowMobile';
5
3
  export * from './WindowMock';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jamespot-user-api",
3
- "version": "1.0.80",
3
+ "version": "1.0.84",
4
4
  "scripts": {
5
5
  "build": "npx webpack --env NODE_ENV=production",
6
6
  "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",
@@ -16,7 +16,7 @@
16
16
  "doc": "npx typedoc",
17
17
  "testFetch": "jest -c ./jest.fetch.config.ts",
18
18
  "testMock": "jest -c ./jest.mock.config.ts",
19
- "test": "npm run testFetch && npm run testMock",
19
+ "test": "npm run testMock",
20
20
  "testJenkinsDev": "jest -c ./jest.fetch.jenkinsdev.config.ts",
21
21
  "prepare": "husky install"
22
22
  },
package/documentation/classes/WindowJestFetch.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WindowJestFetch | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">jamespot-user-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">jamespot-user-api</a></li><li><a href="WindowJestFetch.html">WindowJestFetch</a></li></ul><h1>Class WindowJestFetch</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">WindowJestFetch</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/WindowInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowInterface</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WindowJestFetch.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="WindowJestFetch.html#cookie" class="tsd-kind-icon">cookie</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowJestFetch.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowJestFetch.html#getBackendUrl" class="tsd-kind-icon">get<wbr/>Backend<wbr/>Url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Window<wbr/>Jest<wbr/>Fetch<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WindowJestFetch.html" class="tsd-signature-type" data-tsd-kind="Class">WindowJestFetch</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="WindowJestFetch.html" class="tsd-signature-type" data-tsd-kind="Class">WindowJestFetch</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="cookie" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cookie<a href="#cookie" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cookie<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowJestFetch.ts#L7">window/WindowJestFetch.ts:7</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fetch<a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, init<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#FetchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">FetchReturnType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/WindowInterface.html">WindowInterface</a>.<a href="../interfaces/WindowInterface.html#fetch">fetch</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowJestFetch.ts#L13">window/WindowJestFetch.ts:13</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> init: <span class="tsd-signature-type">RequestInit</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#FetchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">FetchReturnType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getBackendUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Backend<wbr/>Url<a href="#getBackendUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Backend<wbr/>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/WindowInterface.html">WindowInterface</a>.<a href="../interfaces/WindowInterface.html#getBackendUrl">getBackendUrl</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowJestFetch.ts#L9">window/WindowJestFetch.ts:9</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="WindowJestFetch.html" class="tsd-kind-icon">Window<wbr/>Jest<wbr/>Fetch</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WindowJestFetch.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="WindowJestFetch.html#cookie" class="tsd-kind-icon">cookie</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowJestFetch.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowJestFetch.html#getBackendUrl" class="tsd-kind-icon">get<wbr/>Backend<wbr/>Url</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/documentation/classes/WindowMobile.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WindowMobile | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">jamespot-user-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">jamespot-user-api</a></li><li><a href="WindowMobile.html">WindowMobile</a></li></ul><h1>Class WindowMobile</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">WindowMobile</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/WindowInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowInterface</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WindowMobile.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WindowMobile.html#backendUrl" class="tsd-kind-icon">backend<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WindowMobile.html#token" class="tsd-kind-icon">token</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowMobile.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowMobile.html#getBackendUrl" class="tsd-kind-icon">get<wbr/>Backend<wbr/>Url</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowMobile.html#setToken" class="tsd-kind-icon">set<wbr/>Token</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Window<wbr/>Mobile<span class="tsd-signature-symbol">(</span>backUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WindowMobile.html" class="tsd-signature-type" data-tsd-kind="Class">WindowMobile</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowMobile.ts#L8">window/WindowMobile.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>backUrl: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="WindowMobile.html" class="tsd-signature-type" data-tsd-kind="Class">WindowMobile</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="backendUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> backend<wbr/>Url<a href="#backendUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">backend<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowMobile.ts#L6">window/WindowMobile.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="token" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> token<a href="#token" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowMobile.ts#L5">window/WindowMobile.ts:5</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fetch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fetch<a href="#fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules.html#FetchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">FetchReturnType</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/WindowInterface.html">WindowInterface</a>.<a href="../interfaces/WindowInterface.html#fetch">fetch</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowMobile.ts#L20">window/WindowMobile.ts:20</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li><li><h5>__namedParameters: <span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol"> = {}</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules.html#FetchReturnType" class="tsd-signature-type" data-tsd-kind="Type alias">FetchReturnType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getBackendUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Backend<wbr/>Url<a href="#getBackendUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Backend<wbr/>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/WindowInterface.html">WindowInterface</a>.<a href="../interfaces/WindowInterface.html#getBackendUrl">getBackendUrl</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowMobile.ts#L12">window/WindowMobile.ts:12</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Token<a href="#setToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Token<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/d819f38/src/window/WindowMobile.ts#L16">window/WindowMobile.ts:16</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>token: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="WindowMobile.html" class="tsd-kind-icon">Window<wbr/>Mobile</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WindowMobile.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WindowMobile.html#backendUrl" class="tsd-kind-icon">backend<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WindowMobile.html#token" class="tsd-kind-icon">token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowMobile.html#fetch" class="tsd-kind-icon">fetch</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowMobile.html#getBackendUrl" class="tsd-kind-icon">get<wbr/>Backend<wbr/>Url</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WindowMobile.html#setToken" class="tsd-kind-icon">set<wbr/>Token</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/lib/src/window/WindowMobile.d.ts DELETED
@@ -1,9 +0,0 @@
1
- import { FetchReturnType, WindowInterface } from './Window';
2
- export declare class WindowMobile implements WindowInterface {
3
- private token;
4
- private readonly backendUrl;
5
- constructor(backUrl: string);
6
- getBackendUrl(): Promise<string>;
7
- setToken(token: string): void;
8
- fetch(url: string, { headers, ...init }?: RequestInit): FetchReturnType;
9
- }