@pearsonedunext/frontend-component-cookie-policy-banner 5.0.0

package/.eslintignore

@@ -0,0 +1,3 @@
+coverage/*
+build
+node_modules

package/.eslintrc

@@ -0,0 +1,22 @@
+{
+  "extends": ["@edx/eslint-config"],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "env": {
+    "jest": true
+  },
+  "overrides": [
+    {
+      "files": ["*.stories.jsx", "*.test.jsx"],
+      "rules": {
+        "import/no-extraneous-dependencies": "off"
+      }
+    }
+  ],
+  "globals": {
+    "jsdom": true
+  }
+}

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,12 @@
+## This configuration file overrides the inherited configuration file defined
+## in openedx/.github/.github/ISSUE_TEMPLATE because this repo currently does
+## not have Issues turned on, so we create this override to *only* show DEPR
+## issues to users creating Issues. Once Issues are turned on and the repo is
+## ready to accept Issues of all types, this file must be deleted so inheritance
+## of standard openedx configuration works properly.
+
+blank_issues_enabled: false
+contact_links:
+  - name: Open edX Community Support
+    url: https://discuss.openedx.org/
+    about: Please ask all questions, suggest all enhancements, and report all bugs here.

package/.github/ISSUE_TEMPLATE/depr-ticket.yml

@@ -0,0 +1,91 @@
+## This configuration file overrides the inherited configuration file defined
+## in openedx/.github/.github/ISSUE_TEMPLATE because this repo currently does
+## not have Issues turned on, so we create this override to *only* show DEPR
+## issues to users creating Issues. Once Issues are turned on and the repo is
+## ready to accept Issues of all types, this file must be deleted so inheritance
+## of standard openedx configuration works properly.
+
+name: Deprecation (DEPR) Ticket
+description: Per OEP-21, use this template to begin the technology deprecation process.
+title: "[DEPR]: <Technology Name>"
+labels: ["DEPR"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Refer to [OEP-21](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html) for more detail on the deprecation and removal process. This ticket should only be used for proposing the removal of an Open edX technology.
+        Please leave [DEPR] in the title of your ticket!
+  - type: input
+    id: todays-date
+    attributes:
+      label: Proposal Date
+      description: The start date of this proposal (likely today)
+      placeholder: 29 February 2020
+    validations:
+      required: true
+  - type: input
+    id: accept-date
+    attributes:
+      label: Ticket Acceptance Date
+      description: When is the target date for getting this proposal accepted?
+      placeholder: 29 February 2020
+    validations:
+      required: true
+  - type: input
+    id: remove-date
+    attributes:
+      label: Technology Removal Date
+      description: When is the target date for getting this technology removed?
+      placeholder: 29 February 2020
+    validations:
+      required: true
+  - type: input
+    id: named-release-without
+    attributes:
+      label: First Open edX Named Release Without This Functionality
+      description: Named releases are generally CUT in early April and early October. Based on the above removal date, what named release would be the first without this code? Please reach out to the Build Test Release working group (#wg-build-test-release in Slack) if you're not sure.
+      placeholder: Dogwood
+    validations:
+      required: true
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Rationale
+      description: Explain, in a few sentences, why this technology should be removed - what's the usage pattern? What's wrong with keeping it around?
+    validations:
+      required: true
+  - type: textarea
+    id: removal
+    attributes:
+      label: Removal
+      description: Include a description with links to what exactly is being removed.
+    validations:
+      required: true
+  - type: textarea
+    id: replacement
+    attributes:
+      label: Replacement
+      description: Include a description with links to what this is being replaced by.
+    validations:
+      required: true
+  - type: textarea
+    id: deprecation
+    attributes:
+      label: Deprecation
+      description: If you plan to mark the code for deprecation, explain how.
+    validations:
+      required: false
+  - type: textarea
+    id: migration
+    attributes:
+      label: Migration
+      description: If automated migration will be needed, explain your migration plan.
+    validations:
+      required: false
+  - type: textarea
+    id: addl-info
+    attributes:
+      label: Additional Info
+      description: If there is any additional publicly sharable information or data from your earlier analysis, include that.
+    validations:
+      required: false

package/.github/workflows/add-depr-ticket-to-depr-board.yml

@@ -0,0 +1,19 @@
+# Run the workflow that adds new tickets that are either:
+# - labelled "DEPR"
+# - title starts with "[DEPR]"
+# - body starts with "Proposal Date" (this is the first template field)
+# to the org-wide DEPR project board
+
+name: Add newly created DEPR issues to the DEPR project board
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  routeissue:
+    uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
+    secrets:
+      GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
+      GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
+      SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}

package/.github/workflows/add-remove-label-on-comment.yml

@@ -0,0 +1,20 @@
+# This workflow runs when a comment is made on the ticket
+# If the comment starts with "label: " it tries to apply
+# the label indicated in rest of comment.
+# If the comment starts with "remove label: ", it tries
+# to remove the indicated label.
+# Note: Labels are allowed to have spaces and this script does
+# not parse spaces (as often a space is legitimate), so the command
+# "label: really long lots of words label" will apply the
+# label "really long lots of words label"
+
+name: Allows for the adding and removing of labels via comment
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  add_remove_labels:
+    uses: openedx/.github/.github/workflows/add-remove-label-on-comment.yml@master
+

package/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: node_js CI
+
+on:
+  pull_request:
+    branches:
+    - '**'
+
+jobs:
+  tests:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup Nodejs Env
+      run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
+
+    - name: Setup Nodejs
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ env.NODE_VER }}
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Lint
+      run: npm run lint
+
+    - name: Test
+      run: npm run test
+
+    - name: Compile
+      run: npm run compile-prod
+
+    - name: Run Coverage
+      uses: codecov/codecov-action@v3
+
+    - name: Extract branch name
+      shell: bash
+      run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+      id: extract_branch
+
+    - name: Preview semantic-release version
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+      run: npm run semantic-release --dry-run --branches=${{ steps.extract_branch.outputs.branch}}

package/.github/workflows/commitlint.yml

@@ -0,0 +1,10 @@
+# Run commitlint on the commit messages in a pull request.
+
+name: Lint Commit Messages
+
+on:
+  - pull_request
+
+jobs:
+  commitlint:
+    uses: openedx/.github/.github/workflows/commitlint.yml@master

package/.github/workflows/lockfileversion-check.yml

@@ -0,0 +1,13 @@
+#check package-lock file version
+
+name: Lockfile Version check
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  version-check:
+    uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,45 @@
+name: Release CI
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}
+
+    - name: Setup Nodejs Env
+      run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ env.NODE_VER }}
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Lint
+      run: npm run lint
+
+    - name: Test
+      run: npm run test
+
+    - name: Create Build
+      run: npm run compile-prod
+
+    - name: Run Coverage
+      uses: codecov/codecov-action@v2
+
+    - name: Release Package
+      env:
+        GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}
+        NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+      run: npm run semantic-release

package/.github/workflows/self-assign-issue.yml

@@ -0,0 +1,12 @@
+# This workflow runs when a comment is made on the ticket
+# If the comment starts with "assign me" it assigns the author to the
+# ticket (case insensitive)
+
+name: Assign comment author to ticket if they say "assign me"
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  self_assign_by_comment:
+    uses: openedx/.github/.github/workflows/self-assign-issue.yml@master

package/.nvmrc

@@ -0,0 +1 @@
+18

package/.storybook/addons.js

@@ -0,0 +1,2 @@
+import '@storybook/addon-options/register';
+import '@storybook/addon-actions/register';

package/.storybook/config.js

@@ -0,0 +1,22 @@
+import { configure, addDecorator } from '@storybook/react';
+import { setOptions } from '@storybook/addon-options';
+import { setDefaults } from '@storybook/addon-info';
+
+setDefaults({
+  inline: false,
+  header: true,
+  source: true,
+});
+
+setTimeout(() => setOptions({
+  name: 'EDX COOKIE POLICY BANNER',
+  url: 'https://github.com/openedx/frontend-component-cookie-policy-banner',
+  showAddonPanel: true,
+  addonPanelInRight: true,
+}), 1000);
+
+function loadStories() {
+  require('../src/CookiePolicyBanner/CookiePolicyBanner.stories.jsx');
+}
+
+configure(loadStories, module);

package/.storybook/webpack.config.js

@@ -0,0 +1,58 @@
+const path = require('path');
+const WebpackBuildNotifierPlugin = require('webpack-build-notifier');
+
+module.exports = {
+  plugins: [
+    new WebpackBuildNotifierPlugin({
+      title: 'edX Cookie Banner',
+      warningSound: true,
+      failureSound: true,
+    }),
+  ],
+  devtool: 'source-map',
+  module: {
+    rules: [
+      {
+        test: /\.(js|jsx)$/,
+        exclude: /(node_modules)/,
+        use: [
+          {
+            loader: 'babel-loader',
+            options: {
+              presets: ['@babel/preset-env'],
+            },
+          },
+          { loader: 'source-map-loader' },
+        ],
+      },
+      {
+        test: /\.scss|\.css$/,
+        use: [
+          {
+            loader: 'style-loader',
+          },
+          {
+            loader: 'css-loader',
+            options: {
+              modules: true,
+              localIdentName: '[local]',
+              sourceMap: true,
+            },
+          },
+          {
+            loader: 'sass-loader',
+            options: {
+              sassOptions: {
+                includePaths: [
+                  path.join(__dirname, '../src/utils'),
+                  path.join(__dirname, '../node_modules'),
+                ],
+                sourceMap: true,
+              }
+            },
+          },
+        ],
+      },
+    ],
+  },
+};