@metricinsights/cs-helper 0.1.0

package/README.md

@@ -0,0 +1,80 @@
+# cs-helper
+
+Metric Insights Custom Script helper
+
+## Install
+
+```shell
+npm i --save-dev @metricinsights/cs-helper
+```
+
+## Usage
+
+### CLI usage
+
+Add `cs-helper` as package.json script to build you code into bundle
+
+```json
+{
+  "name": "package-name",
+  "version": "1.0.0",
+  "description": "Package description",
+  "scripts": {
+    "build": "@metricinsights/cs-helper <path-to-index.js>"
+  }
+}
+```
+
+Run command to build your code `npm run build`
+
+### Basic usage
+
+```javascript
+import { cs, parseParams } from '@metricinsights/cs-helper';
+
+const parsedParams = parseParams({ defaultValue: 1 }); // { defaultValue: 1 } & cs.params
+
+setTimeout(() => {
+  cs.close();
+}, 1000);
+```
+
+### Utils usage
+
+#### Data convertor
+
+Contains methods to apply metadata for MI datasets
+
+```javascript
+import { cs } from '@metricinsights/cs-helper';
+import {
+  buildMetadataTransformer,
+  applyMetadata,
+  transformDataset,
+} from '@metricinsights/cs-helper/dist/utils';
+
+async function main() {
+  const dataset = await new Promise((resolve, reject) => {
+    cs.runApiRequest(
+      `/api/dataset_data?dataset=${1}`,
+      Object.assign({}, params, {
+        success: resolve,
+        error: reject,
+      }),
+    );
+  }); // { data: [{ key1: value1, key2: value2 }], metadata: [{ name: key1, type: 'numeric' }, { name: key2, type: 'text' }] }
+
+  const metadataTransformer = buildMetadataTransformer(dataset.metadata); // { [key1]: (v) => Number(v), [key2]: (v) => String(v) }
+  const transformedData = applyMetadata(metadataTransformer, dataset.data); // [{ key1: Number(value1), key2: String(value2) }]
+
+  const transformedResponse = transformedData(dataset); // { data: [{ key1: Number(value1), key2: String(value2) }], metadata: [{ name: key1, type: 'numeric' }, { name: key2, type: 'text' }] }
+
+  cs.log(JSON.stringify(metadataTransformer));
+  cs.log(JSON.stringify(transformedData));
+  cs.log(JSON.stringify(transformedResponse));
+  
+  cs.close();
+}
+
+main();
+```

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@metricinsights/cs-helper",
+  "version": "0.1.0",
+  "description": "Helper for Custom Scripts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npm run build:sources && npm run build:bin",
+    "build:sources": "tsc",
+    "build:bin": "tsc --project tsconfig.bin.json",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "cs-helper": "dist/bin/build.js",
+    "cs-helper-create": "dist/bin/create.js"
+  },
+  "files": [
+    "dist/",
+    "templates",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mi-examples/cs-helper.git"
+  },
+  "keywords": [
+    "helper",
+    "custom script"
+  ],
+  "author": "Serhii Shpak",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jquery": "^3.5.16",
+    "@types/prompts": "^2.4.3",
+    "@types/webpack": "^5.28.0",
+    "prettier": "^2.8.6"
+  },
+  "dependencies": {
+    "chalk": "^5.2.0",
+    "commander": "^10.0.0",
+    "isbinaryfile": "^5.0.0",
+    "promise-polyfill": "8.3.0",
+    "prompts": "^2.4.2",
+    "ts-loader": "^9.4.2",
+    "typescript": "^5.0.2",
+    "webpack": "^5.76.2"
+  },
+  "bugs": {
+    "url": "https://github.com/mi-examples/cs-helper/issues"
+  },
+  "homepage": "https://github.com/mi-examples/cs-helper#readme"
+}

package/templates/custom-script-js/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  tabWidth: 2,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all',
+};

package/templates/custom-script-js/README.md

@@ -0,0 +1,13 @@
+# %PACKAGE_NAME%
+
+%PACKAGE_DESCRIPTION%
+
+## Params
+
+| Name    |  Type  | Required | Default |
+|:--------|:------:|:--------:|:-------:|
+| example | String |    x     |         |
+
+### Params description
+
+- example: Parameter example. Example: `example`

package/templates/custom-script-js/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "%PACKAGE_NAME%",
+  "version": "%PACKAGE_VERSION%",
+  "description": "%PACKAGE_DESCRIPTION%",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "cs-helper src/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": "",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "prettier": "^2.8.6"
+  },
+  "dependencies": {
+    "@metricinsights/cs-helper": "^0.1.0"
+  }
+}

package/templates/custom-script-ts/.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  tabWidth: 2,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all',
+};

package/templates/custom-script-ts/README.md

@@ -0,0 +1,13 @@
+# %PACKAGE_NAME%
+
+%PACKAGE_DESCRIPTION%
+
+## Params
+
+| Name    |  Type  | Required | Default |
+|:--------|:------:|:--------:|:-------:|
+| example | String |    x     |         |
+
+### Params description
+
+- example: Parameter example. Example: `example`

package/templates/custom-script-ts/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "%PACKAGE_NAME%",
+  "version": "%PACKAGE_VERSION%",
+  "description": "%PACKAGE_DESCRIPTION%",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "cs-helper src/index.ts",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": "",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "prettier": "^2.8.6",
+    "typescript": "^5.0.2"
+  },
+  "dependencies": {
+    "@metricinsights/cs-helper": "^0.1.0"
+  }
+}

package/templates/custom-script-ts/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "noImplicitAny": true,
+    "module": "es2015",
+    "target": "es5",
+    "allowJs": true,
+    "moduleResolution": "node"
+  },
+  "exclude": ["node_modules"]
+}