@fixedwidthtable/fixedwidthtable 0.0.1-security → 0.0.3

package/eslint-configs/eslint-config-react/README.md

@@ -0,0 +1,97 @@
+# eslint-config-inrupt-react
+
+Eslint and prettier configs
+
+## Installation
+
+1. `npm install --save-dev @inrupt/eslint-config-react @rushstack/eslint-patch`
+
+## Setup (Quick start)
+
+Create a `.eslintrc.js` in the the root of your project with the following contents:
+
+```js
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+  extends: ["@inrupt/eslint-config-react"],
+  parserOptions: {
+    project: "./tsconfig.eslint.json",
+  },
+  rules: {},
+};
+```
+
+The file `tsconfig.eslint.json` is your typescript configuration with the e2e tests, unit tests and examples included, e.g.,
+
+```json
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*.ts", "e2e/**/*.ts", "*.md"],
+  "exclude": ["**/node_modules", "**/dist/**"]
+}
+```
+
+### For typescript projects:
+
+```js
+require("@rushstack/eslint-patch/modern-module-resolution");
+
+module.exports = {
+  root: true,
+
+  extends: [
+    "@inrupt/eslint-config-react",
+    "@inrupt/eslint-config-lib",
+    "plugin:import/typescript",
+  ],
+
+  parserOptions: {
+    project: "./tsconfig.eslint.json",
+  },
+
+  // These settings and the `plugin:import/typescript` are required until we add
+  // this configuration to our @inrupt/eslint-config-lib base
+  settings: {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"],
+    },
+    "import/resolver": {
+      typescript: {
+        alwaysTryTypes: true,
+        project: "./tsconfig.eslint.json",
+      },
+    },
+  },
+
+  rules: {
+    "react/jsx-filename-extension": [
+      "error",
+      {
+        extensions: [".tsx"],
+      },
+    ],
+  },
+};
+```
+
+## Migrating to this configuration:
+
+1. Add `extends: ['@inrupt/eslint-config-react']` to your `.eslintrc.js` file.
+1. Add the following line to the top of the `.eslintrc.js` file:
+
+```js
+require("@rushstack/eslint-patch/modern-module-resolution");
+```
+
+## Rules
+
+Exhaustive documentation forthcoming. For now, the general principles are:
+
+- Load a stylistic base set - in this case,
+  [airbnb](https://www.npmjs.com/package/eslint-config-airbnb) and
+  [airbnb/hooks](https://www.npmjs.com/package/eslint-config-airbnb-hooks)
+- Load inrupt-base, which loads recommended configs for common libraries: eslint, jest, typescript,
+  and prettier
+- Do very little else- as few custom rules or overrides as possible.
+- Some rules are updated to work with nextjs.

package/eslint-configs/eslint-config-react/index.js

@@ -0,0 +1,75 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+module.exports = {
+  extends: ["airbnb", "airbnb/hooks", "@inrupt/eslint-config-base"],
+
+  plugins: ["react"],
+
+  parser: "@babel/eslint-parser",
+
+  parserOptions: {
+    ecmaFeatures: { jsx: true },
+    ecmaVersion: 2018,
+    sourceType: "module",
+  },
+
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx"],
+      },
+    },
+  },
+
+  rules: {
+    // Disable the jsx-one-expression-per-line rule, which makes it a pain to handle spaces and
+    // inline elements like em
+    "react/jsx-one-expression-per-line": ["off"],
+
+    "react/jsx-filename-extension": ["warn", { extensions: [".jsx"] }],
+
+    // Order the properties of react components nicely
+    "react/static-property-placement": ["error", "static public field"],
+
+    // Allow Nextjs <Link> tags to contain a href attribute
+    "jsx-a11y/anchor-is-valid": [
+      "error",
+      {
+        components: ["Link"],
+        specialLink: ["hrefLeft", "hrefRight"],
+        aspects: ["invalidHref", "preferButton"],
+      },
+    ],
+
+    "import/extensions": [
+      "error",
+      {
+        js: "never",
+        jsx: "never",
+      },
+    ],
+
+    "no-use-before-define": ["warn"],
+
+    "react/react-in-jsx-scope": ["off"],
+  },
+};

package/eslint-configs/eslint-config-react/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@inrupt/eslint-config-react",
+  "description": "Shared eslint config for React projects at @inrupt",
+  "version": "2.4.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inrupt/typescript-sdk-tools.git"
+  },
+  "keywords": [
+    "eslint",
+    "react",
+    "inrupt"
+  ],
+  "author": "Inrupt <engineering@inrupt.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/inrupt/typescript-sdk-tools/issues"
+  },
+  "homepage": "https://github.com/inrupt/typescript-sdk-tools/tree/main/eslint-configs/eslint-config-react#readme",
+  "dependencies": {
+    "@babel/eslint-parser": "^7.22.15",
+    "@inrupt/eslint-config-base": "file:../eslint-config-base",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-plugin-jsx-a11y": "^6.2.3",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0"
+  }
+}

package/lerna.json

@@ -0,0 +1,4 @@
+{
+  "useNx": true,
+  "version": "2.4.0"
+}

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@fixedwidthtable/fixedwidthtable",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
+  "description": "Meta-package for tools used whilst developing the fixedwidthtable SDK",
+  "version": "0.0.3",
+  "private": false,
+  "type": "commonjs",
+  "scripts": {
+    "build": "lerna run build",
+    "clean": "lerna run clean",
+    "release": "scripts/release.sh",
+    "test": "playwright test",
+    "e2e:test:setup": "cd ./e2e/browser/test-app && npm ci",
+    "prepare-release": "scripts/prepare-release.sh",
+    "lint": "npm run lint:check",
+    "lint:check": "npm run lint:eslint && npm run lint:prettier -- --check",
+    "lint:eslint": "eslint --config .eslintrc.js \"packages/\" \"e2e/\" \"eslint-configs/\"",
+    "lint:prettier": "prettier \"{src,e2e,examples}/**/*.{ts,tsx,js,jsx,css}\" \"**/*.{md,mdx,yml}\"",
+    "lint:fix": "npm run lint:eslint -- --fix && npm run lint:prettier -- --write",
+    "preinstall": "node scripts/index.js"
+  },
+  "workspaces": [
+    "eslint-configs/*",
+    "packages/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inrupt/typescript-sdk-tools.git"
+  },
+  "author": "Inrupt <engineering@inrupt.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/inrupt/typescript-sdk-tools/issues"
+  },
+  "homepage": "https://github.com/inrupt/typescript-sdk-tools#readme",
+  "dependencies": {
+    "@inrupt/eslint-config-lib": "^2.1.1",
+    "lerna": "^7.2.0",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.29.1",
+    "rollup-plugin-typescript2": "^0.35.0",
+    "typescript": "^5.2.2"
+  },
+  "devDependencies": {
+    "@rushstack/eslint-patch": "^1.3.3",
+    "@types/react": "^18.2.21",
+    "next": "^13.4.19"
+  }
 }

package/packages/base-rollup-config/README.md

@@ -0,0 +1,22 @@
+# @inrupt/base-rollup-config
+
+This package contains the base configuration for rollup across our packages
+
+## Installation
+
+1. `npm install --save-dev @inrupt/base-rollup-config`
+
+## Usage:
+
+Can be used in rollup.config.mjs as follows:
+
+```mjs
+import { createRequire } from "node:module";
+import createConfig from "@inrupt/base-rollup-config";
+const require = createRequire(import.meta.url);
+
+export default createConfig(require("./package.json"));
+```
+
+Make sure to specify `main` (cjs), `module` (esm) and `types` entrypoints in the package.json as rollup uses
+these entries to determine where to write the output.

package/packages/base-rollup-config/index.mjs

@@ -0,0 +1,59 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+import typescript from "rollup-plugin-typescript2";
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+
+export const createSharedConfig = pkg => ({
+  plugins: [
+    typescript({
+      // Use our own version of TypeScript, rather than the one bundled with the plugin:
+      typescript: require("typescript"),
+      tsconfigOverride: {
+        compilerOptions: {
+          module: "esnext",
+        },
+      },
+    }),
+  ],
+  external: Object.keys(pkg.dependencies),
+  // The following option is useful because symlinks are used in monorepos
+  preserveSymlinks: true,
+});
+
+export default pkg => [
+  {
+    input: "./src/index.ts",
+    output: [
+      {
+        file: pkg.module,
+        format: "esm",
+        sourcemap: true,
+      },
+      {
+        file: pkg.main,
+        format: "cjs",
+        sourcemap: true,
+      },
+    ],
+    ...createSharedConfig(pkg),
+  },
+];

package/packages/base-rollup-config/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@inrupt/base-rollup-config",
+  "version": "2.4.0",
+  "description": "This package provides a shared rollup config for our packages",
+  "main": "index.mjs",
+  "module": "true",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inrupt/typescript-sdk-tools.git"
+  },
+  "keywords": [
+    "inrupt",
+    "rollup",
+    "bundler"
+  ],
+  "author": "Inrupt <engineering@inrupt.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/inrupt/typescript-sdk-tools/issues"
+  },
+  "homepage": "https://github.com/inrupt/typescript-sdk-tools#readme"
+}

package/packages/internal-playwright-helpers/README.md

@@ -0,0 +1,30 @@
+# @inrupt/internal-playwright-helpers
+
+This package contains utilities to help setup automated testing environments.
+
+## Installation
+
+1. `npm install --save-dev @inrupt/internal-playwright-helpers`
+
+## Usage:
+
+Add the function import as needed.
+
+```
+import { loginAndAllow } from "@inrupt/internal-playwright-helpers"
+```
+
+Then add in calls to the functions such as `loginAndAllow` to your test files.
+
+For these helpers to work, your app should use predefined testids defined in
+`@@inrupt/internal-playwright-testids`. The following testids are expected in the
+exposed helpers:
+
+- The OpenID provider should be specified in a text input identified with
+  `TESTID_OPENID_PROVIDER_INPUT`.
+- The login should be initiated by clicking a button identified with
+  `TESTID_LOGIN_BUTTON`.
+- When the login process is complete, an element identified with
+  `TESTID_SESSION_STATUS` should appear in the DOM.
+- When an error occurs, an element identified with `TESTID_ERROR_MESSAGE` should
+  appear in the DOM.

package/packages/internal-playwright-helpers/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@inrupt/internal-playwright-helpers",
+  "version": "2.4.0",
+  "description": "This package provides page models for known common elements of the sdk testable UIs",
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs",
+    "clean": "rimraf dist"
+  },
+  "author": "Inrupt <devtools-team@inrupt.com>",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@inrupt/internal-playwright-testids": "2.4.0",
+    "@inrupt/internal-test-env": "2.4.0"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.37.0"
+  }
+}

package/packages/internal-playwright-helpers/rollup.config.mjs

@@ -0,0 +1,57 @@
+// The following is only possible from Node 18 onwards
+// import pkg from "./package.json" assert { type: "json" };
+
+// Until we only support Node 18+, this should be used instead
+// (see https://rollupjs.org/guide/en/#importing-packagejson)
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+const pkg = require("./package.json");
+
+import typescript from "rollup-plugin-typescript2";
+
+const external = [
+  ...Object.keys(pkg.dependencies || {}),
+  ...Object.keys(pkg.peerDependencies || {}),
+];
+
+const plugins = [
+  typescript({
+    // Use our own version of TypeScript, rather than the one bundled with the plugin:
+    typescript: require("typescript"),
+    tsconfigOverride: {
+      compilerOptions: {
+        module: "esnext",
+      },
+    },
+  }),
+];
+
+const rollupDefaultConfig = { external, plugins };
+
+export default [
+  {
+    ...rollupDefaultConfig,
+    input: "src/index.ts",
+    output: [
+      {
+        file: pkg.main,
+        format: "cjs",
+      },
+      {
+        file: pkg.module,
+        entryFileNames: "[name].es.js",
+        format: "esm",
+      },
+    ],
+  },
+  {
+    ...rollupDefaultConfig,
+    input: ["src/index.ts"],
+    output: {
+      dir: "dist",
+      entryFileNames: "[name].mjs",
+      format: "esm",
+      preserveModules: true,
+    },
+  },
+];

package/packages/internal-playwright-helpers/src/fixtures.ts

@@ -0,0 +1,51 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+import { test as base } from "@playwright/test";
+import { getBrowserTestingEnvironment } from "@inrupt/internal-test-env";
+import { AuthFlow } from "./flows/auth";
+
+export type AuthFixture = {
+  auth: AuthFlow;
+};
+
+export const test = base.extend<AuthFixture>({
+  // Override the page fixture to start the app automatically
+  page: async ({ page }, use) => {
+    await page.goto("/");
+    await use(page);
+  },
+  auth: async ({ page }, use) => {
+    const { idp, clientCredentials } = getBrowserTestingEnvironment({
+      clientCredentials: {
+        owner: { login: true, password: true },
+      },
+    });
+    const auth = new AuthFlow(
+      page,
+      idp,
+      clientCredentials.owner.login,
+      clientCredentials.owner.password,
+    );
+    await use(auth);
+  },
+});
+
+export { expect } from "@playwright/test";

package/packages/internal-playwright-helpers/src/flows/auth.ts

@@ -0,0 +1,93 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+import type { Page } from "@playwright/test";
+import { CognitoPage } from "../pages/cognito";
+import { OpenIdPage } from "../pages/open-id";
+import { TestPage } from "../pages/testPage";
+
+export class AuthFlow {
+  page: Page;
+
+  openidProvider: string;
+
+  userLogin: string;
+
+  password: string;
+
+  constructor(
+    page: Page,
+    openidProvider: string,
+    userLogin: string,
+    password: string,
+  ) {
+    this.page = page;
+    this.openidProvider = openidProvider;
+    this.userLogin = userLogin;
+    this.password = password;
+  }
+
+  /**
+   * Start the app, and if applicable initiate login from the client, get redirected
+   * to the OpenID provider, log in, allow the client when redirected to the broker,
+   * and completes login after being redirected to client.
+   */
+  async login(
+    options: { allow: boolean; timeout?: number } = { allow: true },
+  ): Promise<void> {
+    const timeoutOptions = { timeout: options.timeout ?? 15_000 };
+    const testPage = new TestPage(this.page, this.openidProvider);
+    const cognitoPage = new CognitoPage(this.page);
+    const openIdPage = new OpenIdPage(this.page);
+    // First, initiate login in the test client, and wait for the redirect to the OP
+    await Promise.all([
+      this.page.waitForURL(
+        (url) =>
+          // If the user is already authenticated to the OpenID Provider, they may be redirected directly to the broker
+          CognitoPage.isOnPage(url) || OpenIdPage.isOnPage(url),
+        timeoutOptions,
+      ),
+      testPage.startLogin(timeoutOptions),
+    ]);
+    if (CognitoPage.isOnPage(new URL(this.page.url()))) {
+      await Promise.all([
+        this.page.waitForURL(
+          (url: URL) =>
+            // After login, the user is redirected either to the broker or to the client.
+            OpenIdPage.isOnPage(url) || TestPage.isOnPage(url),
+          timeoutOptions,
+        ),
+        cognitoPage.login(this.userLogin, this.password, timeoutOptions),
+      ]);
+    }
+
+    // Clicking on the consent screen from the broker will redirect to the
+    // test page, and trigger the token request. To prevent this being a
+    // race condition, waiting on this request should be done prior to
+    // giving consent.
+    const completeLoginConditions = [testPage.handleRedirect()];
+    // TODO: handle allow === false
+    if (options.allow && OpenIdPage.isOnPage(new URL(this.page.url()))) {
+      completeLoginConditions.push(openIdPage.allow(timeoutOptions));
+    }
+    await Promise.all(completeLoginConditions);
+  }
+}

package/packages/internal-playwright-helpers/src/index.ts

@@ -0,0 +1,26 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+export { CognitoPage } from "./pages/cognito";
+export { OpenIdPage } from "./pages/open-id";
+export { TestPage } from "./pages/testPage";
+export { AuthFlow } from "./flows/auth";
+export { test, expect } from "./fixtures";