@metricinsights/pp-dev 0.0.1 → 0.0.2

package/README.md

@@ -1,6 +1,8 @@
 # pp-dev
 
-Portal Page development framework
+Portal Page development framework and build tool.
+
+This package is based on [Vite](https://vitejs.dev/) tool.
 
 ## Usage
 
@@ -10,6 +12,116 @@ Package installation
 $ npm i @metricinsights/pp-dev
 ```
 
+### Define configuration
+
+You need to create the file with the name `pp-dev.config` and extension `js` or
+`cjs` (if you define type `module` in package.json) or `ts` if you want to use Typescript, or `json`.
+You also can define configuration in `package.json` with the `pp-dev` key
+
+Config examples:
+
+- JavaScript
+
+```javascript
+// pp-dev.config.js
+
+/**
+* @type {import('@metricinsights/pp-dev').PPDevConfig}
+*/
+module.exports = {
+backendBaseURL: 'https://example.metricinsights.com',
+portalPageId: 1,
+};
+```
+
+- Typescript
+
+```typescript
+// pp-dev.config.ts
+
+import { PPDevConfig } from '@metricinsights/pp-dev';
+
+const config: PPDevConfig = {
+backendBaseURL: 'https://example.metricinsights.com',
+portalPageId: 1,
+};
+
+export default config;
+```
+
+- JSON (`pp-dev.config.json`)
+
+```json
+{
+"backendBaseURL": "https://example.metricinsights.com",
+"portalPageId": 1
+}
+```
+
+- JSON in `package.json` file
+
+```json
+{
+"name": "<project-name>",
+"version": "1.0.0",
+"scripts": {},
+"pp-dev": {
+  "backendBaseURL": "https://example.metricinsights.com",
+  "portalPageId": 1
+}
+}
+```
+
+### Vite configuration
+
+If you need to change something in the build you can define `vite.config` file.
+More description you can find [here](https://vitejs.dev/config/)
+
+### Configuration API description
+
+#### `backendBaseURL`
+
+Type: String
+
+Example: `https://example.metricinsights.com`
+
+Description: Defines the backend URL (Metric Insights instance) that is used for proxying requests to the MI backend
+
+#### `portalPageId`
+
+Type: Number
+
+Example: `1`
+
+Description: Defines the Portal Page Id that used to get portal page variables values.
+
+#### `miHudLess`
+
+Type: Boolean
+
+Default: `false`
+
+Example: `true`
+
+Description: Disables Metric Insights navigation bar for local development
+
+#### `templateLess`
+
+Type: Boolean
+
+Default: `false`
+
+Example: `true`
+
+Description: Disables template variables transforming. Used when you develop the portal page without a template
+
+### CLI API description
+
+- `pp-dev help` - show CLI's help
+
+- `pp-dev` or `pp-dev serve` or `pp-dev dev` runs application in development mode
+- `pp-dev build` starts the application build. Will create `dist` and `dist-zip` folders. `dist` folder contains unzipped build files. `dist-zip` contains file `<package-name>.zip` with files from the `dist` folder
+
 ## Migration guide from old portal page helper to new
 
 1. You need to initialize npm in your portal page repository (if you have `package.json` file in PP folder, you can skip this step):
@@ -24,8 +136,8 @@ $ npm i @metricinsights/pp-dev
    ```shell
     $ npm i @metricinsights/pp-dev
    ```
-   
 3. You need to create two scripts in `package.json` script section.
+
    - `start` script: `"start": "pp-dev"`
    - `build` script: `"build": "pp-dev build"`
 

package/dist/client/index.html

@@ -21,7 +21,7 @@
     </span>
     {% } %}
   </span>
-  {% if (!templateLess && backendBaseURL && Number.isNaN(+portalPageId)) { %}
+  {% if (!templateLess && backendBaseURL && !Number.isNaN(+portalPageId)) { %}
   <button id="sync-template" class="sync-button" title="Sync template (Not implemented yet)">
     <svg
       fill="#007BFF"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metricinsights/pp-dev",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Portal Page dev build tool",
   "bin": {
     "pp-dev": "bin/pp-dev.js"
@@ -13,7 +13,8 @@
     "build": "npm run build:node && npm run build:client",
     "build:node": "tsc",
     "build:client": "rollup --config src/client/rollup.config.ts --configPlugin typescript",
-    "test": "cd test && npm run build"
+    "test": "cd test && npm run build",
+    "version": "npm version --commit-hooks false --git-tag-version false"
   },
   "exports": {
     ".": {
@@ -64,5 +65,25 @@
     "LICENSE.md",
     "pp-dev.d.ts",
     "assets"
-  ]
+  ],
+  "types": "./dist/index.d.ts",
+  "directories": {
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mi-examples/pp-dev-js.git"
+  },
+  "keywords": [
+    "mi",
+    "metricinsights",
+    "pp",
+    "portal",
+    "pages",
+    "helper"
+  ],
+  "bugs": {
+    "url": "https://github.com/mi-examples/pp-dev-js/issues"
+  },
+  "homepage": "https://github.com/mi-examples/pp-dev-js#readme"
 }