@aslaluroba/help-center 1.0.0

package/.editorconfig

@@ -0,0 +1,17 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+ij_typescript_use_double_quotes = false
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/README.md

@@ -0,0 +1,76 @@
+# @babylai/help-center
+
+A customizable help center widget for Angular applications that provides chat functionality and documentation support.
+
+## Installation
+
+Install the package and its peer dependencies:
+
+```bash
+npm install @babylai/help-center
+```
+
+### Markdown Support
+
+This library uses [ngx-markdown](https://github.com/jfcere/ngx-markdown) for rendering markdown content. Please refer to their [official documentation](https://github.com/jfcere/ngx-markdown) for detailed installation and configuration instructions, including:
+
+- Syntax highlighting with Prism.js
+- Emoji support
+- Math expression rendering with KaTeX
+- Diagrams and charts with Mermaid
+- Copy-to-clipboard functionality
+
+## Basic Usage
+
+1. Import the HelpCenterModule in your app.module.ts:
+
+```typescript
+typescript
+import { HelpCenterModule } from '@babylai/help-center'
+@NgModule({
+  imports: [
+    // ... other imports
+    HelpCenterModule
+  ]
+})
+export class AppModule {}
+```
+
+2. Add the HelpCenterComponent to your template:
+```typescript
+import { HelpCenterWidgetComponent } from '@babylai/help-center';
+
+@Component({
+  selector: 'app-root',
+  imports: [RouterOutlet, HelpCenterWidgetComponent],
+  templateUrl: './app.component.html',
+})
+```
+
+```html
+<app-help-center-widget
+  [getToken]="getTokenFunction"
+  [helpScreenId]="yourHelpScreenId"
+  [user]="currentUser"
+  [showArrow]="true"
+  [messageLabel]="'Need help? Click here!'"
+>
+</app-help-center-widget>
+```
+
+## Configuration Options
+
+The widget accepts the following inputs:
+
+- `getToken`: () => Promise<string> - A function that returns a promise resolving to an authentication token
+- `helpScreenId`: string - The ID of the help screen to display
+- `user`: Object - (Optional) Current user information
+  ```typescript
+  {
+    id: string
+    name: string
+    email: string
+  }
+  ```
+- `showArrow`: boolean - (Optional) Whether to show the attention arrow animation
+- `messageLabel`: string - (Optional) Custom message for the arrow tooltip

package/angular.json

@@ -0,0 +1,106 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "angular-help-center": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": "dist/angular-help-center",
+            "index": "src/index.html",
+            "browser": "src/main.ts",
+            "polyfills": ["zone.js"],
+            "tsConfig": "tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              {
+                "glob": "**/*",
+                "input": "public"
+              },
+              {
+                "glob": "**/*",
+                "input": "src/assets"
+              }
+            ],
+            "styles": ["src/styles.scss"],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kB",
+                  "maximumError": "1MB"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "4kB",
+                  "maximumError": "8kB"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "proxyConfig": "proxy.conf.json",
+            "port": 3000
+          },
+          "configurations": {
+            "production": {
+              "buildTarget": "angular-help-center:build:production"
+            },
+            "development": {
+              "buildTarget": "angular-help-center:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n"
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "polyfills": ["zone.js", "zone.js/testing"],
+            "tsConfig": "tsconfig.spec.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "src/assets",
+              {
+                "glob": "**/*",
+                "input": "public"
+              },
+              {
+                "glob": "**/*",
+                "input": "src/assets"
+              }
+            ],
+            "styles": ["src/styles.scss"],
+            "scripts": []
+          }
+        }
+      }
+    }
+  }
+}

package/ng-package.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "./node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "./dist/help-center",
+  "lib": {
+    "entryFile": "./public_api.ts"
+  },
+  "allowedNonPeerDependencies": [
+    "@angular/animations",
+    "@angular/common",
+    "@angular/compiler",
+    "@angular/core",
+    "@angular/forms",
+    "@angular/platform-browser",
+    "@angular/platform-browser-dynamic",
+    "@angular/router",
+    "@jsverse/transloco",
+    "@microsoft/signalr",
+    "clsx",
+    "marked",
+    "ngx-markdown",
+    "prismjs",
+    "rxjs",
+    "tailwind-merge",
+    "tailwindcss-animate",
+    "tailwindcss-rtl",
+    "tslib",
+    "zone.js"
+  ]
+}