jamespot-user-api 1.0.82 → 1.0.89

package/README-internal.md

@@ -0,0 +1,41 @@
+# JamespotUserApi
+
+The JamespotUserApi library facilitates the HTTPS calls to the Jamespot Apis. The only entry point that should be used is the [default export](modules.html#default).
+
+## How to use
+
+## Installation
+
+```
+git clone https://github.com/Jamespot/jamespot-user-api.git
+npm ci
+```
+
+## Build
+
+| commande             | format du bundle | avec les mock | hot reload |
+| -------------------- | ---------------- | ------------- | ---------- |
+| `npm run build`      | development      | non           | non        |
+| `npm run build-mock` | development      | oui           | non        |
+| `npm run dev`        | development      | non           | non        |
+| `npm run dev-mock`   | production       | non           | non        |
+| `npm run local`      | production       | oui           | oui        |
+| `npm run local-mock` | production       | non           | oui        |
+
+## Test - Jest (using jenkins DB located at https://jenskinsdev.jamespot.pro)
+
+```
+# Lancer tous les tests
+npm run testJenkinsDev
+
+# Lancer un fichier de test spécifique - pattern de test a lancer
+npm run testJenkinsDev -- [pathFile] -t [testName]
+```
+
+The configuration is editable in the file setEnvVars.js to use the real api or the mocked one
+
+## Generate doc
+
+```
+npm run doc
+```

package/README.md

@@ -1,41 +1,15 @@
 # JamespotUserApi
 
-The JamespotUserApi library facilitates the HTTPS calls to the Jamespot Apis. The only entry point that should be used is the [default export](modules.html#default).
+This library facilitates the HTTPS calls to the Jamespot Apis.
 
-## How to use
-
-## Installation
-
-```
-git clone https://github.com/Jamespot/jamespot-user-api.git
-npm ci
-```
-
-## Build
-
-| commande             | format du bundle | avec les mock | hot reload |
-| -------------------- | ---------------- | ------------- | ---------- |
-| `npm run build`      | development      | non           | non        |
-| `npm run build-mock` | development      | oui           | non        |
-| `npm run dev`        | development      | non           | non        |
-| `npm run dev-mock`   | production       | non           | non        |
-| `npm run local`      | production       | oui           | oui        |
-| `npm run local-mock` | production       | non           | oui        |
+Only be use in Jamespot.Pro product pages.
 
-## Test - Jest (using jenkins DB located at https://jenskinsdev.jamespot.pro)
+Because by default we initialized via browser location and the endpoints are secure by referrer.
 
-```
-# Lancer tous les tests
-npm run testJenkinsDev
-
-# Lancer un fichier de test spécifique - pattern de test a lancer
-npm run testJenkinsDev -- [pathFile] -t [testName]
-```
-
-The configuration is editable in the file setEnvVars.js to use the real api or the mocked one
+## How to use
 
-## Generate doc
+```javascript
+import jApi from 'jamespot-user-api';
 
-```
-npm run doc
+jApi.user.get('user/XXX');
 ```

package/documentation/assets/highlight.css

@@ -1,12 +1,14 @@
 :root {
-    --light-hl-0: #001080;
-    --dark-hl-0: #9CDCFE;
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #000000;
-    --dark-hl-2: #C8C8C8;
-    --light-hl-3: #008000;
-    --dark-hl-3: #6A9955;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #A31515;
+    --dark-hl-3: #CE9178;
+    --light-hl-4: #795E26;
+    --dark-hl-4: #DCDCAA;
     --light-code-background: #F5F5F5;
     --dark-code-background: #1E1E1E;
 }
@@ -16,6 +18,7 @@
     --hl-1: var(--light-hl-1);
     --hl-2: var(--light-hl-2);
     --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
     --code-background: var(--light-code-background);
 } }
 
@@ -24,6 +27,7 @@
     --hl-1: var(--dark-hl-1);
     --hl-2: var(--dark-hl-2);
     --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
     --code-background: var(--dark-code-background);
 } }
 
@@ -32,6 +36,7 @@ body.light {
     --hl-1: var(--light-hl-1);
     --hl-2: var(--light-hl-2);
     --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
     --code-background: var(--light-code-background);
 }
 
@@ -40,6 +45,7 @@ body.dark {
     --hl-1: var(--dark-hl-1);
     --hl-2: var(--dark-hl-2);
     --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
     --code-background: var(--dark-code-background);
 }
 
@@ -47,4 +53,5 @@ body.dark {
 .hl-1 { color: var(--hl-1); }
 .hl-2 { color: var(--hl-2); }
 .hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
 pre, code { background: var(--code-background); }