jamespot-user-api 1.0.103 → 1.0.104

package/lib/src/apis/{adminStore.d.ts → admin/store.d.ts}

@@ -1,6 +1,5 @@
-import { ApiWrapper } from '../types';
-import { JBaseApi } from './base';
-import { StoreItem, StoreFinalize } from '../types/adminStore';
+import { ApiWrapper, StoreItem, StoreFinalize } from '../../types';
+import { JBaseApi } from '../base';
 export declare class AdminStoreApi extends JBaseApi {
     getItem(uri: string): Promise<ApiWrapper<StoreItem>>;
     checkoutBilling(uri: string): Promise<ApiWrapper<boolean>>;

package/lib/src/apis/admin/utils.d.ts

@@ -0,0 +1,8 @@
+import { AdminApps } from '../../types';
+import { JBaseApi } from '../base';
+export declare class AdminUtilsApi extends JBaseApi {
+    /**
+     * Request the admin applications and sub applications for the admin panel
+     */
+    getApps(): Promise<import("../../types").ApiWrapper<AdminApps, import("../../types").BaseMessages>>;
+}

package/lib/src/apis/index.d.ts

@@ -1,4 +1,4 @@
-export * from './adminStore';
+export * from './admin';
 export * from './application';
 export * from './article/article';
 export * from './assetReservation';
@@ -12,7 +12,6 @@ export * from './filebank';
 export * from './group';
 export * from './jamespotUserApi';
 export * from './jland/jland';
-export * from './Licenses/licenses';
 export * from './messenger';
 export * from './search/search';
 export * from './share';

package/lib/src/apis/jamespotUserApi.d.ts

@@ -1,4 +1,4 @@
-import { AdminStoreApi } from './adminStore';
+import { AdminLicenseApi, AdminUtilsApi, AdminStoreApi } from './admin';
 import { JApplicationApi } from './application';
 import { JArticleApi } from './article/article';
 import { JAseiApi } from './asei';
@@ -19,7 +19,6 @@ import { JDiapazoneApi } from './diapazone';
 import { JWedocApi } from './wedoc';
 import { Network } from '../util/network';
 import { JShareApi } from './share';
-import { JLicenseApi } from './Licenses/licenses';
 /**
  * In browser usage, 'window' should be the window object.
  * In server side usage, 'window' object given must implement the fetch method, used by the Apis.
@@ -31,7 +30,9 @@ export declare class JamespotUserApi {
     version: string;
     network: Network;
     admin: {
+        license: AdminLicenseApi;
         store: AdminStoreApi;
+        utils: AdminUtilsApi;
     };
     application: JApplicationApi;
     article: JArticleApi;
@@ -45,7 +46,6 @@ export declare class JamespotUserApi {
     filebank: JFilebankApi;
     group: JGroupApi;
     jland: JLandApi;
-    license: JLicenseApi;
     mediaLibrary: JMediaLibraryApi;
     messenger: JMessengerApi;
     search: JSearchApi;

package/lib/src/apis/jland/jland.d.ts

@@ -1,7 +1,6 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, jArticleList, MaybeWithToken, PagingResults } from '../../types';
+import { ApiWrapper, jArticleList, License, MaybeWithToken, PagingResults } from '../../types';
 import { ArticleCreation } from '../article/article';
-import { JLicense } from '../Licenses/licenses';
 export declare type JLandLog = {
     idLog: number;
     slug: string;
@@ -23,7 +22,7 @@ export declare type JLandMap = jArticleList & {
     waMapUrl?: string;
     limit?: number;
     _extend: {
-        licenses: Array<JLicense>;
+        licenses: Array<License>;
     };
 };
 export declare type JLandMapCreation = ArticleCreation & {

package/lib/src/apis/user/user.d.ts

@@ -17,7 +17,6 @@ export interface ObjectListProps {
     facets?: {}[];
     filters?: Filters;
     query?: string;
-    queryFields?: Array<string>;
     limit?: number;
     page?: number;
     orders?: Orders;

package/lib/src/types/adminLicence.d.ts

@@ -0,0 +1,43 @@
+import { ObjectListProps } from '../apis';
+import { jUserList } from './user';
+export declare type AdminLicenseUserStats = {
+    countActiveUsersWithoutLicense: number;
+    countLicensesAssigned: number;
+    countLicensesNotAssigned: number;
+};
+export declare type ObjectWithoutLicenseFilter = {
+    name: string;
+    operator: string;
+    value: number;
+};
+export declare type AdminLicensesNotAssigned = {
+    [key: string]: number;
+};
+export declare type AdminLicensesAssigned = {
+    id: number;
+    kind: string;
+    dateCreation: string;
+    idFeature: number;
+    uri: string;
+    contentId: number;
+    contentType: string;
+    status: number;
+};
+export declare type License = {
+    id: number;
+    kind: string;
+    dateCreation: string;
+    idFeature: number;
+    uri: string;
+    contentId: number;
+    contentType: string;
+    status: number;
+};
+export declare type JAdminLicenseUserList = jUserList & {
+    _extend: {
+        licenses: Array<License>;
+    };
+};
+export interface AdminLicenseUser extends ObjectListProps {
+    data: JAdminLicenseUserList[];
+}

package/lib/src/types/adminUtils.d.ts

@@ -0,0 +1,18 @@
+export declare type AdminAppTab = {
+    sref?: string;
+    href?: string;
+    idDiv: string;
+    label: string;
+    icon: string;
+};
+export declare type AdminApp = {
+    name: string;
+    label: string;
+    icon: string;
+    color: [string, string, string];
+    state?: string;
+    access: boolean;
+    url?: string;
+    tabs?: AdminAppTab[];
+};
+export declare type AdminApps = AdminApp[];

package/lib/src/types/index.d.ts

@@ -1,4 +1,6 @@
+export * from './adminLicence';
 export * from './adminStore';
+export * from './adminUtils';
 export * from './asei';
 export * from './assetReservation';
 export * from './autocomplete';

package/lib/src/types/model.d.ts

@@ -27,6 +27,7 @@ export declare type WidgetDatePicker = {
     type: 'datePicker';
 };
 export declare type WidgetDatePickerValue = string | null;
+export declare type WidgetActiveValue = number;
 export declare type WidgetMultiattribute = {
     type: 'multiattribute';
 };
@@ -71,6 +72,7 @@ export declare type WidgetTaxonomy = {
     type: 'taxonomy';
     params: {
         idTaxonomy: string;
+        type?: string;
     };
 };
 export declare type WidgetOrientedlinks = {
@@ -90,7 +92,7 @@ export declare type WidgetUri = {
     };
 };
 export declare type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetFile;
-export declare type WidgetsValue = WidgetDatePickerValue | WidgetDatetimeValue | WidgetDateValue | WidgetEmailValue | WidgetNumberValue | WidgetTextareaValue | WidgetTextValue | WidgetUrlValue;
+export declare type WidgetsValue = WidgetActiveValue | WidgetDatePickerValue | WidgetDatetimeValue | WidgetDateValue | WidgetEmailValue | WidgetNumberValue | WidgetTextareaValue | WidgetTextValue | WidgetUrlValue;
 export declare type FieldConfiguration<T extends string = string> = {
     label: string;
     description?: string;

package/lib/src/types/user.d.ts

@@ -1,8 +1,12 @@
 import { WidgetsValue } from './model';
 import { jObjectLittle } from './utils';
+/**
+ * @deprecated Use jUserList instead
+ */
 export declare type UserModel = jObjectLittle & {
     firstname: string;
     lastname: string;
+    active: number;
     mail?: string;
 };
 export declare type UserMapModel = {

package/lib/src/types/utils.d.ts

@@ -73,6 +73,7 @@ export declare type jObjectLittle = Readable<jObjectBase & {
 }>;
 export declare type jObjectList = jObjectLittle & {
     description?: string;
+    active: number;
     _user: jUserLittle;
     _right: Rights;
 };
@@ -110,7 +111,7 @@ export declare type Order = {
     sort: 'ASC' | 'DESC';
 };
 export declare type Orders = Array<Order>;
-export declare type FilterValue = boolean | string | string[] | {
+export declare type FilterValue = boolean | string | number | string[] | {
     srcId: number | string;
     srcType: string;
 } | {

package/lib/src/util/Test.d.ts

@@ -1,5 +1,5 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectList } from '../types';
 import { Network } from './network';
 export declare const network: Network;
 export declare const jApi: JamespotUserApi;
@@ -25,4 +25,5 @@ export declare const validateObjectIsFormatLittle: <T extends {
     title: string;
     _url: string;
 }>(object: T) => boolean;
+export declare const validateObjectIsFormatList: <T extends jObjectList = jObjectList>(object: T) => boolean;
 export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jamespot-user-api",
-    "version": "1.0.103",
+    "version": "1.0.104",
     "scripts": {
         "build": "npx webpack --env NODE_ENV=production",
         "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",

package/phpunitMock/objectListJamespotUserQueryList-rawList.json

@@ -21,7 +21,8 @@
                 "firstname": "Admin",
                 "lastname": "Jenkins",
                 "company": "",
-                "mail": "admin.jenkins@jamespot.com"
+                "mail": "admin.jenkins@jamespot.com",
+                "active": 1
             },
             {
                 "id": 2,
@@ -36,7 +37,8 @@
                 "firstname": "Browser",
                 "lastname": "Stack",
                 "company": "",
-                "mail": "browserstack@jamespot.com"
+                "mail": "browserstack@jamespot.com",
+                "active": 1
             },
             {
                 "id": 4,
@@ -44,14 +46,15 @@
                 "type": "user",
                 "uri": "user/4",
                 "dateCreation": "2019-07-09 15:48:26",
-                "dateModified": "2023-04-13 14:54:05",
+                "dateModified": "2019-07-09 15:51:24",
                 "title": "Admin1",
                 "_url": "/user/4",
                 "level": 9,
                 "firstname": "Un",
                 "lastname": "Admin",
-                "company": "Jamespot 0.17199300 1681390422",
-                "mail": "admin1@jamespot.com"
+                "company": "",
+                "mail": "admin1@jamespot.com",
+                "active": 1
             },
             {
                 "id": 5,
@@ -59,14 +62,15 @@
                 "type": "user",
                 "uri": "user/5",
                 "dateCreation": "2019-07-09 15:48:45",
-                "dateModified": "2023-04-13 14:53:47",
+                "dateModified": "2019-07-09 15:51:16",
                 "title": "Admin2",
                 "_url": "/user/5",
                 "level": 9,
                 "firstname": "Deux",
                 "lastname": "Admin",
                 "company": "",
-                "mail": "admin2@jamespot.com"
+                "mail": "admin2@jamespot.com",
+                "active": 1
             },
             {
                 "id": 6,
@@ -81,7 +85,8 @@
                 "firstname": "Un",
                 "lastname": "User",
                 "company": "",
-                "mail": "user1@jamespot.com"
+                "mail": "user1@jamespot.com",
+                "active": 1
             },
             {
                 "id": 7,
@@ -96,7 +101,8 @@
                 "firstname": "Deux",
                 "lastname": "User",
                 "company": "",
-                "mail": "user2@jamespot.com"
+                "mail": "user2@jamespot.com",
+                "active": 1
             },
             {
                 "id": 8,
@@ -111,7 +117,8 @@
                 "firstname": "Un",
                 "lastname": "Limited",
                 "company": "",
-                "mail": "limited1@jamespot.com"
+                "mail": "limited1@jamespot.com",
+                "active": 1
             },
             {
                 "id": 9,
@@ -126,7 +133,8 @@
                 "firstname": "Deux",
                 "lastname": "Limited",
                 "company": "",
-                "mail": "limited2@jamespot.com"
+                "mail": "limited2@jamespot.com",
+                "active": 1
             },
             {
                 "id": 10,
@@ -141,7 +149,8 @@
                 "firstname": "Un",
                 "lastname": "InactiveAdmin",
                 "company": "",
-                "mail": "inactiveAdmin1@jamespot.com"
+                "mail": "inactiveAdmin1@jamespot.com",
+                "active": 0
             },
             {
                 "id": 11,
@@ -156,7 +165,8 @@
                 "firstname": "InactiveUser",
                 "lastname": "Un",
                 "company": "",
-                "mail": "inactiveUser1@jamespot.com"
+                "mail": "inactiveUser1@jamespot.com",
+                "active": 0
             },
             {
                 "id": 12,
@@ -171,7 +181,8 @@
                 "firstname": "InactiveLimited",
                 "lastname": "Un",
                 "company": "",
-                "mail": "inactiveLimited1@jamespot.com"
+                "mail": "inactiveLimited1@jamespot.com",
+                "active": 0
             }
         ],
         "facets": null

package/documentation/classes/JLicenseApi.html

@@ -1,18 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JLicenseApi | 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="JLicenseApi.html">JLicenseApi</a></li></ul><h1>Class JLicenseApi</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><a href="JBaseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JBaseApi</a><ul class="tsd-hierarchy"><li><span class="target">JLicenseApi</span></li></ul></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 tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="JLicenseApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="JLicenseApi.html#network" class="tsd-kind-icon">network</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="JLicenseApi.html#assignLicense" class="tsd-kind-icon">assign<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#countLicenseNotAssigned" class="tsd-kind-icon">count<wbr/>License<wbr/>Not<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#getLicensesAssigned" class="tsd-kind-icon">get<wbr/>Licenses<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#unassignLicense" class="tsd-kind-icon">unassign<wbr/>License</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><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 tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new JLicense<wbr/>Api<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="JLicenseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JLicenseApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/db307f8/src/apis/base.ts#L6">apis/base.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>network: <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="JLicenseApi.html" class="tsd-signature-type" data-tsd-kind="Class">JLicenseApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="network" class="tsd-anchor"></a><h3 class="tsd-anchor-link">network<a href="#network" 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">network<span class="tsd-signature-symbol">:</span> <a href="Network.html" class="tsd-signature-type" data-tsd-kind="Class">Network</a></div><aside class="tsd-sources"><p>Inherited from <a href="JBaseApi.html">JBaseApi</a>.<a href="JBaseApi.html#network">network</a></p><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/db307f8/src/apis/base.ts#L4">apis/base.ts:4</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="assignLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">assign<wbr/>License<a href="#assignLicense" 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">assign<wbr/>License<span class="tsd-signature-symbol">(</span>uri<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/db307f8/src/apis/Licenses/licenses.ts#L55">apis/Licenses/licenses.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Assigns a license to the content with the provided uri (if any is available)</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>URI of the object to which a license must be assigned</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="countLicenseNotAssigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link">count<wbr/>License<wbr/>Not<wbr/>Assigned<a href="#countLicenseNotAssigned" 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">count<wbr/>License<wbr/>Not<wbr/>Assigned<span class="tsd-signature-symbol">(</span>type<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#JLicenseAvailable" class="tsd-signature-type" data-tsd-kind="Type alias">JLicenseAvailable</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/db307f8/src/apis/Licenses/licenses.ts#L42">apis/Licenses/licenses.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retrieves the number of licenses of a given type available. License type is
-different from the content type to which it can be assigned to.</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#JLicenseAvailable" class="tsd-signature-type" data-tsd-kind="Type alias">JLicenseAvailable</a><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>A paromise resolving to an object containing the kind of license as keys and number of available ones as values</p>
-</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLicensesAssigned" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Licenses<wbr/>Assigned<a href="#getLicensesAssigned" 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/>Licenses<wbr/>Assigned<span class="tsd-signature-symbol">(</span>type<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#JLicense" class="tsd-signature-type" data-tsd-kind="Type alias">JLicense</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/db307f8/src/apis/Licenses/licenses.ts#L27">apis/Licenses/licenses.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Retireve the list of liceses assigned to content of a given type</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>type of content for which we want to retrieve the licenses</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#JLicense" class="tsd-signature-type" data-tsd-kind="Type alias">JLicense</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>The list of liceses assigned to content of the provided type</p>
-</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unassignLicense" class="tsd-anchor"></a><h3 class="tsd-anchor-link">unassign<wbr/>License<a href="#unassignLicense" 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">unassign<wbr/>License<span class="tsd-signature-symbol">(</span>uri<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/db307f8/src/apis/Licenses/licenses.ts#L68">apis/Licenses/licenses.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Unassigns the licese linked to the content with the provided uri</p>
-</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>uri: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
-<p>URI of the object to which a license must be unassigned</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ApiWrapper.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiWrapper</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#BaseMessages" class="tsd-signature-type" data-tsd-kind="Type alias">BaseMessages</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></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="JLicenseApi.html" class="tsd-kind-icon">JLicense<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="JLicenseApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="JLicenseApi.html#network" class="tsd-kind-icon">network</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#assignLicense" class="tsd-kind-icon">assign<wbr/>License</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#countLicenseNotAssigned" class="tsd-kind-icon">count<wbr/>License<wbr/>Not<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#getLicensesAssigned" class="tsd-kind-icon">get<wbr/>Licenses<wbr/>Assigned</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="JLicenseApi.html#unassignLicense" class="tsd-kind-icon">unassign<wbr/>License</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/apis/Licenses/licenses.d.ts

@@ -1,44 +0,0 @@
-import { JBaseApi } from '../base';
-import { ApiWrapper } from '../../types';
-export declare type JLicense = {
-    id: number;
-    kind: string;
-    dateCreation: string;
-    idFeature: number;
-    uri: string;
-    contentId: number;
-    contentType: string;
-    status: number;
-};
-export declare type JLicenseAvailable = {
-    [key: string]: number;
-};
-export declare class JLicenseApi extends JBaseApi {
-    /**
-     * Retireve the list of liceses assigned to content of a given type
-     *
-     * @param type type of content for which we want to retrieve the licenses
-     * @returns The list of liceses assigned to content of the provided type
-     */
-    getLicensesAssigned(type: string): Promise<ApiWrapper<Array<JLicense>>>;
-    /**
-     * Retrieves the number of licenses of a given type available. License type is
-     * different from the content type to which it can be assigned to.
-     *
-     * @param kind The kind of license for which we want to know the availability
-     * @returns A paromise resolving to an object containing the kind of license as keys and number of available ones as values
-     */
-    countLicenseNotAssigned(type: string): Promise<ApiWrapper<JLicenseAvailable>>;
-    /**
-     * Assigns a license to the content with the provided uri (if any is available)
-     * @param uri URI of the object to which a license must be assigned
-     * @returns
-     */
-    assignLicense(uri: string): Promise<ApiWrapper<boolean>>;
-    /**
-     * Unassigns the licese linked to the content with the provided uri
-     * @param uri URI of the object to which a license must be unassigned
-     * @returns
-     */
-    unassignLicense(uri: string): Promise<ApiWrapper<boolean>>;
-}