Merge pull request #1 from managed-components/init

Init

.eslintrc.js

@@ -0,0 +1,37 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  plugins: ['prettier'],
+  env: {
+    node: true,
+    browser: true,
+    worker: true,
+    es2022: true,
+  },
+  rules: {
+    'prettier/prettier': 'error',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      { ignoreRestSiblings: true, argsIgnorePattern: '^_' },
+    ],
+  },
+  overrides: [
+    {
+      files: ['*d.ts'],
+      rules: {
+        'no-undef': 'off',
+      },
+    },
+    {
+      files: ['*js'],
+      globals: {
+        webcm: 'writable',
+      },
+    },
+  ],
+}

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: 'Build Test'
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Running Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      # Actual Tests
+      - run: npm i
+      - run: npm run lint --if-present
+      - run: npm run typecheck --if-present
+      - run: npm run bundle --if-present
+      - run: npm run test --if-present

.gitignore

@@ -0,0 +1,106 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+.vscode

.npmignore

@@ -0,0 +1 @@
+src

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "printWidth": 80,
+  "arrowParens": "avoid"
+}

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2022 Cloudflare, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1 +1,33 @@
-# custom-html
+# Custom HTML Managed Component
+
+## Documentation
+
+Managed Components docs are published at **https://managedcomponents.dev** .
+
+Find out more about Managed Components [here](https://blog.cloudflare.com/zaraz-open-source-managed-components-and-webcm/) for inspiration and motivation details.
+
+[![Released under the Apache license.](https://img.shields.io/badge/license-apache-blue.svg)](./LICENSE)
+[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+## 🚀 Quickstart local dev environment
+
+1. Make sure you're running node version >=18.
+2. Install dependencies with `npm i`
+3. Run unit test watcher with `npm run test:dev`
+
+## ⚙️ Tool Settings
+
+> Settings are used to configure the tool in a Component Manager config file
+
+## 🧱 Fields Description
+
+> Fields are properties that can/must be sent with certain events
+
+### HTML Code `string` _required_
+
+`htmlCode` is the HTML that you want to be injected. It can be also a `<script>` tag.
+
+## 📝 License
+
+Licensed under the [Apache License](./LICENSE).

esbuild.js

@@ -0,0 +1,10 @@
+require('esbuild').buildSync({
+  entryPoints: ['src/index.ts'],
+  bundle: true,
+  minify: true,
+  format: 'esm',
+  platform: 'node',
+  target: ['esnext'],
+  tsconfig: 'tsconfig.build.json',
+  outfile: 'dist/index.js',
+})

manifest.json

@@ -0,0 +1,12 @@
+{
+  "name": "Custom HTML",
+  "namespace": "custom-html",
+  "description": "A Managed Component that injects HTML on your page",
+  "icon": "assets/icon.svg",
+  "permissions": {
+    "execute_unsafe_scripts": {
+      "description": "This permission is used to facilitate better a user experience.",
+      "required": true
+    }
+  }
+}