@smartico/public-api 0.0.47 → 0.0.48

package/tsconfig.json

@@ -16,11 +16,16 @@
     "typedocOptions": {
         "name": "Smartico API documentation",
         "entryPoints": ["src/WSAPI/WSAPI.ts", "src/WSAPI/WSAPITypes.ts"],
-        "out": "docs_test",
+        "out": "docs",
         "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],
-        "entryDocument": "README_TWO.md",
+        "entryDocument": "README.md",
         "disableSources": true,
         "excludePrivate": true,
+        "readme": "none",
+        "cleanOutputDir": true,
+        "hideBreadcrumbs": true,
+        "hideInPageTOC": true,
+        "sort": "source-order"
     }
   }
   

package/docs_test/README_TWO.md

@@ -1,57 +0,0 @@
-Smartico API documentation / [Modules](modules.md)
-
-# Smartico Public API
-API allows you to build and manage Smartico Gamification context on behalf of the user. It can be used in the JS/TS based frontend or in NodeJS backend
-
-# Installation
-
-```bash
-npm install --save @smartico/public-api
-```
-
-## Usage
-
-```typescript
-import { SmarticoAPI } from '@smartico/public-api';
-
-const SAPI = new SmarticoAPI( 'your-label-api-key', 'your-brand-key', 'your-message-sender', { logger: console });
-            
-const response = await SAPI.miniGamesGetTemplates(rsUser.user_ext_id);
-
-response.templates.forEach( t => {
-    console.log(t.saw_template_ui_definition.name)
-}
-
-```
-
-## API 
-### To learn more about the capabilities of our API, go to the [API documentation](docs_test/modules.md)
-
-## Development and publishing process
-
-### Publishing process
-
-```sh
-git commit
-npm run build
-npm version patch
-npm run pub
-```
-
-###  Debug locally
-
-In the public-api project console:
-
-```sh
-npm link
-# when you are done
-npm unlink
-```
-
-Consumer project console:
-```bash
-npm link @smartico/public-api --legacy-peer-deps
-
-# when you are done
-npm unlink @smartico/public-api --legacy-peer-deps && npm install @smartico/public-api --legacy-peer-deps
-```

package/docs_test/classes/WSAPI.md

@@ -1,19 +0,0 @@
-[Smartico API documentation](../README_TWO.md) / [Modules](../modules.md) / WSAPI
-
-# Class: WSAPI
-
-## Table of contents
-
-### Methods
-
-- [getLevelsTransformed](WSAPI.md#getlevelstransformed)
-
-## Methods
-
-### getLevelsTransformed
-
-▸ **getLevelsTransformed**(): `Promise`<[`GetLevelMapClearedResponse`](../interfaces/GetLevelMapClearedResponse.md)[]\>
-
-#### Returns
-
-`Promise`<[`GetLevelMapClearedResponse`](../interfaces/GetLevelMapClearedResponse.md)[]\>

package/docs_test/interfaces/GetLevelMapClearedResponse.md

@@ -1,57 +0,0 @@
-[Smartico API documentation](../README_TWO.md) / [Modules](../modules.md) / GetLevelMapClearedResponse
-
-# Interface: GetLevelMapClearedResponse
-
-## Table of contents
-
-### Properties
-
-- [description](GetLevelMapClearedResponse.md#description)
-- [id](GetLevelMapClearedResponse.md#id)
-- [image](GetLevelMapClearedResponse.md#image)
-- [name](GetLevelMapClearedResponse.md#name)
-- [required\_level\_counter\_1](GetLevelMapClearedResponse.md#required_level_counter_1)
-- [required\_level\_counter\_2](GetLevelMapClearedResponse.md#required_level_counter_2)
-- [required\_points](GetLevelMapClearedResponse.md#required_points)
-
-## Properties
-
-### description
-
-• **description**: `string`
-
-___
-
-### id
-
-• **id**: `number`
-
-___
-
-### image
-
-• **image**: `string`
-
-___
-
-### name
-
-• **name**: `string`
-
-___
-
-### required\_level\_counter\_1
-
-• **required\_level\_counter\_1**: `number`
-
-___
-
-### required\_level\_counter\_2
-
-• **required\_level\_counter\_2**: `number`
-
-___
-
-### required\_points
-
-• **required\_points**: `number`

package/docs_test/modules.md

@@ -1,13 +0,0 @@
-[Smartico API documentation](README_TWO.md) / Modules
-
-# Smartico API documentation
-
-## Table of contents
-
-### General API
-
-- [WSAPI](classes/WSAPI.md)
-
-### Levels response
-
-- [GetLevelMapClearedResponse](interfaces/GetLevelMapClearedResponse.md)