@edx/frontend-platform 4.6.0 → 4.6.2

package/.env.development

@@ -0,0 +1,30 @@
+EXAMPLE_VAR=Example Value
+ACCESS_TOKEN_COOKIE_NAME=edx-jwt-cookie-header-payload
+ACCOUNT_PROFILE_URL=http://localhost:1995
+ACCOUNT_SETTINGS_URL=http://localhost:1997
+BASE_URL=http://localhost:8080
+CREDENTIALS_BASE_URL=http://localhost:18150
+CSRF_TOKEN_API_PATH=/csrf/api/v1/token
+DISCOVERY_API_BASE_URL=http://localhost:18381
+PUBLISHER_BASE_URL=http://localhost:18400
+ECOMMERCE_BASE_URL=http://localhost:18130
+LANGUAGE_PREFERENCE_COOKIE_NAME=openedx-language-preference
+LEARNING_BASE_URL=http://localhost:2000
+LMS_BASE_URL=http://localhost:18000
+LOGIN_URL=http://localhost:18000/login
+LOGOUT_URL=http://localhost:18000/logout
+STUDIO_BASE_URL=http://localhost:18010
+MARKETING_SITE_BASE_URL=http://localhost:18000
+ORDER_HISTORY_URL=http://localhost:1996/orders
+REFRESH_ACCESS_TOKEN_ENDPOINT=http://localhost:18000/login_refresh
+SEGMENT_KEY=''
+SITE_NAME=localhost
+USER_INFO_COOKIE_NAME=edx-user-info
+LOGO_URL=https://edx-cdn.org/v3/default/logo.svg
+LOGO_TRADEMARK_URL=https://edx-cdn.org/v3/default/logo-trademark.svg
+LOGO_WHITE_URL=https://edx-cdn.org/v3/default/logo-white.svg
+FAVICON_URL=https://edx-cdn.org/v3/default/favicon.ico
+IGNORED_ERROR_REGEX=
+MFE_CONFIG_API_URL=
+APP_ID=
+SUPPORT_URL=https://support.edx.org

package/.env.test

@@ -0,0 +1,30 @@
+EXAMPLE_VAR=Example Value
+ACCESS_TOKEN_COOKIE_NAME=edx-jwt-cookie-header-payload
+ACCOUNT_PROFILE_URL=http://localhost:1995
+ACCOUNT_SETTINGS_URL=http://localhost:1997
+BASE_URL=http://localhost:8080
+CREDENTIALS_BASE_URL=http://localhost:18150
+CSRF_TOKEN_API_PATH=/csrf/api/v1/token
+DISCOVERY_API_BASE_URL=http://localhost:18381
+PUBLISHER_BASE_URL=http://localhost:18400
+ECOMMERCE_BASE_URL=http://localhost:18130
+LANGUAGE_PREFERENCE_COOKIE_NAME=openedx-language-preference
+LEARNING_BASE_URL=http://localhost:2000
+LMS_BASE_URL=http://localhost:18000
+LOGIN_URL=http://localhost:18000/login
+LOGOUT_URL=http://localhost:18000/logout
+STUDIO_BASE_URL=http://localhost:18010
+MARKETING_SITE_BASE_URL=http://localhost:18000
+ORDER_HISTORY_URL=http://localhost:1996/orders
+REFRESH_ACCESS_TOKEN_ENDPOINT=http://localhost:18000/login_refresh
+SEGMENT_KEY=''
+SITE_NAME=localhost
+USER_INFO_COOKIE_NAME=edx-user-info
+LOGO_URL=https://edx-cdn.org/v3/default/logo.svg
+LOGO_TRADEMARK_URL=https://edx-cdn.org/v3/default/logo-trademark.svg
+LOGO_WHITE_URL=https://edx-cdn.org/v3/default/logo-white.svg
+FAVICON_URL=https://edx-cdn.org/v3/default/favicon.ico
+IGNORED_ERROR_REGEX=
+MFE_CONFIG_API_URL=
+APP_ID=
+SUPPORT_URL=https://support.edx.org

package/.eslintignore

@@ -0,0 +1,6 @@
+.idea
+coverage
+dist
+docs
+node_modules
+src/analytics/segment.js

package/.eslintrc.js

@@ -0,0 +1,28 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+const { getBaseConfig } = require('@edx/frontend-build');
+
+const config = getBaseConfig('eslint');
+
+config.rules = {
+  'import/no-extraneous-dependencies': ['error', {
+    devDependencies: [
+      '**/*.config.js',
+      '**/*.test.jsx',
+      '**/*.test.js',
+      'example/*',
+    ],
+  }],
+  'import/extensions': ['error', {
+    ignore: ['@edx/frontend-platform*'],
+  }],
+  'import/no-unresolved': ['error', {
+    ignore: ['@edx/frontend-platform*'],
+  }],
+  'jsx-a11y/anchor-is-valid': ['error', {
+    components: ['Link'],
+    specialLink: ['to'],
+    aspects: ['noHref', 'invalidHref', 'preferButton'],
+  }],
+};
+
+module.exports = config;

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+**Description:**
+
+Describe what this pull request changes, and why. Include implications for people using this change.
+
+**Merge checklist:**
+
+- [ ] Consider running your code modifications in the included example app within `frontend-platform`. This can be done by running `npm start` and opening http://localhost:8080.
+- [ ] Consider testing your code modifications in another local micro-frontend using local aliases configured via [the `module.config.js` file in `frontend-build`](https://github.com/openedx/frontend-build#local-module-configuration-for-webpack).
+- [ ] Verify your commit title/body conforms to the conventional commits format (e.g., `fix`, `feat`) and is appropriate for your code change. Consider whether your code is a breaking change, and modify your commit accordingly.
+
+**Post merge:**
+
+- [ ] After the build finishes for the merged commit, verify the new release has been pushed to [NPM](https://www.npmjs.com/package/@edx/frontend-platform).

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,42 @@
+name: node_js CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  tests:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Nodejs Env
+        run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v3
+        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: Build
+        run: npm run build
+
+      - name: Docs
+        run: npm run docs
+
+      - name: Run Coverage
+        uses: codecov/codecov-action@v3

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: lockfileVersion check
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  version-check:
+    uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master

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

@@ -0,0 +1,43 @@
+name: Manual Publish
+on: 
+  workflow_dispatch:
+    inputs:
+      tag:
+        required: true
+        description: NPM distribution tag to use for the backported release (npm publish --tag <tag>)
+jobs:
+  release:
+    name: Manual Publish
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Setup Nodejs Env
+      run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
+    - name: Setup Node.js
+      uses: actions/setup-node@v2
+      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: Coverage
+      uses: codecov/codecov-action@v2
+    - name: Build
+      run: npm run build
+    # NPM expects to be authenticated for publishing. This step will fail CI if NPM is not authenticated
+    - name: Check NPM authentication
+      run: |
+        echo "//registry.npmjs.org/:_authToken=${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}" >> .npmrc
+        npm whoami
+    - name: Release
+      env:
+        GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}
+        NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+      # `npm publish` relies on version specified in package.json file
+      run: npm publish --tag ${{github.event.inputs.tag}} # e.g., old-version

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

@@ -0,0 +1,22 @@
+name: NPM Deprecate
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to deprecate'
+        required: true
+      message:
+        description: 'Reason for deprecation'
+        required: true
+
+jobs:
+  deprecate:
+    name: Deprecate
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check NPM authentication
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}" >> .npmrc
+          npm whoami
+      - name: NPM deprecate
+        run: npm deprecate @edx/frontend-platform@"${{ github.event.inputs.version }}" "${{ github.event.inputs.message }}"

package/.github/workflows/release.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@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Nodejs Env
+        run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VER }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Create Build
+        run: npm run build
+
+      - name: Release to npm/Github
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+
+      - name: Docs
+        run: npm run docs
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4.4.3
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: docs/api/@edx/frontend-platform/1.0.0-semantically-released # The folder the action should deploy.
+          clean: true # Automatically remove deleted files from the deploy branch

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/.github/workflows/update-browserslist-db.yml

@@ -0,0 +1,12 @@
+name: Update Browserslist DB
+on:
+  schedule:
+    - cron:  '0 0 * * 1'
+  workflow_dispatch:
+
+jobs:
+  update-browserslist:
+    uses: openedx/.github/.github/workflows/update-browserslist-db.yml@master
+
+    secrets:
+        requirements_bot_github_token: ${{ secrets.requirements_bot_github_token }}

package/.nvmrc

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

package/.releaserc

@@ -0,0 +1,32 @@
+{
+  "branch": "master",
+  "tagFormat": "v${version}",
+  "verifyConditions": [
+    {
+      "path": "@semantic-release/npm",
+      "pkgRoot": "dist"
+    },
+    {
+      "path": "@semantic-release/github"
+    }
+  ],
+  "analyzeCommits": "@semantic-release/commit-analyzer",
+  "generateNotes": "@semantic-release/release-notes-generator",
+  "prepare": [
+    {
+      "path": "@semantic-release/npm",
+      "pkgRoot": "dist"
+    }
+  ],
+  "publish": [
+    {
+      "path": "@semantic-release/npm",
+      "pkgRoot": "dist"
+    },
+    {
+      "path": "@semantic-release/github"
+    }
+  ],
+  "success": [],
+  "fail": []
+}

package/catalog-info.yaml

@@ -0,0 +1,21 @@
+# This file records information about this repo. Its use is described in OEP-55:
+# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html
+
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: 'frontend-platform'
+  description: "A modest application framework for Open edX micro-frontend applications and their supporting libraries"
+  links:
+    - url: "https://github.com/openedx/frontend-platform"
+      title: "Frontend Platform"
+      icon: "Code"
+    - url: "https://openedx.github.io/frontend-platform/"
+      title: "Documentation"
+      icon: "Article"
+  annotations:
+    openedx.org/arch-interest-groups: "jmbowman"
+spec:
+  owner: group:fed-bom
+  type: 'library'
+  lifecycle: 'production'