@fixedwidthtable/fixedwidthtable 0.0.1-security → 0.0.3

package/e2e/browser/test-app/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "test",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@inrupt/solid-client": "^1.30.0",
+    "@inrupt/solid-client-authn-browser": "^1.17.1",
+    "next": "^13.4.19",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.6.0",
+    "@types/react": "^18.2.21",
+    "@types/react-dom": "^18.2.7",
+    "eslint": "^8.49.0",
+    "typescript": "^5.2.2"
+  }
+}

package/e2e/browser/test-app/pages/_app.tsx

@@ -0,0 +1,28 @@
+//
+// 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 { AppProps } from "next/app";
+
+function MyApp({ Component, pageProps }: AppProps) {
+  return <Component {...pageProps} />;
+}
+
+export default MyApp;

package/e2e/browser/test-app/pages/index.tsx

@@ -0,0 +1,36 @@
+//
+// 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 { NextPage } from "next";
+// Disabling the following prevents from having to install before linting from
+// the root.
+// eslint-disable-next-line import/no-unresolved
+import dynamic from "next/dynamic";
+
+const App = dynamic(() => import("../components/appContainer"), {
+  ssr: false,
+});
+
+const Home: NextPage = () => {
+  return <App />;
+};
+
+export default Home;

package/e2e/browser/test-app/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true
+  },
+  "include": ["next-env.d.ts", "next.config.js", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules", ".next"]
+}

package/eslint-configs/README.md

@@ -0,0 +1,75 @@
+# eslint-configs
+
+ESLint config used as the base for all Inrupt projects. You'll likely want to
+import [eslint-config-inrupt-lib](./eslint-config-inrupt-lib) or
+[eslint-config-inrupt-react](./eslint-config-inrupt-react).
+
+## Usage
+
+In order to use these ESLint configurations, you will need to add the following
+line to the top of your project's `.eslintrc.js` file:
+
+```
+require("@rushstack/eslint-patch/modern-module-resolution");
+```
+
+This ensures that you load the dependencies from the ESLint configuration,
+instead of your project. This patch is a workaround for the long-standing ESLint
+[issue 3458](https://github.com/eslint/eslint/issues/3458) regarding how ESLint
+loads modules.
+
+## Configurations
+
+### `@inrupt/eslint-config-lib`
+
+Use this configuration to load all the TypeScript-specific rules - it builds on
+top of `@inrupt/eslint-config-base`.
+
+### `@inrupt/eslint-config-react`
+
+Use this configuration for React projects or packages, it too builds on top of
+`@inrupt/eslint-config-base`.
+
+If you're working on a TypeScript project or package, you'll need additional
+configuration to get TypeScript working:
+
+```js
+  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"],
+      },
+    ],
+  },
+```
+
+## Rules
+
+Our general principles are as follows:
+
+- Use [airbnb-base](https://www.npmjs.com/package/eslint-config-airbnb-base).
+- Load recommended configs for common libraries: e.g., eslint, jest, typescript.
+- Load Prettier config to override everything where there are conflicts.
+- Enforce licensing headers.
+- Configure common problems (no-shadow, no-unresolved, etc).
+- Load React-specific configs for React projects.
+- Do very little else - i.e., as few custom rules or overrides as possible.

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

@@ -0,0 +1,29 @@
+# eslint-config-inrupt-base
+
+Eslint config which is the base for all inrupt projects. You likely want to import
+[eslint-config-inrupt-lib](../eslint-config-inrupt-lib) or
+[eslint-config-inrupt-react](../eslint-config-inrupt-react) instead.
+
+## Usage
+
+In order to use this style configuration, you'll need to add the following
+line to the top of the `.eslintrc.js` file:
+
+```
+require("@rushstack/eslint-patch/modern-module-resolution");
+```
+
+This ensures that you load the dependencies from the style configuration,
+instead of your project. This patch is a workaround for the longstanding eslint
+[issue 3458](https://github.com/eslint/eslint/issues/3458) regarding how eslint
+loads modules.
+
+## Rules
+
+Exhaustive documentation forthcoming. For now, the general principles are:
+
+- Load a stylistic base set - in this case,
+  [airbnb-base](https://www.npmjs.com/package/eslint-config-airbnb-base)
+- Load recommended configs for common libraries: eslint, jest, typescript
+- Load prettier config to override everything where there are conflicts
+- Do very little else- as few custom rules or overrides as possible

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

@@ -0,0 +1,159 @@
+//
+// 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 = {
+  env: {
+    browser: true,
+    node: true,
+    es2022: true,
+  },
+
+  // Airbnb base provides many style rules; it is then overridden by our current defaults
+  // (eslint and prettier recommended configs)
+  extends: ["airbnb-base", "eslint:recommended", "plugin:prettier/recommended"],
+  plugins: ["prettier", "header"],
+
+  // A few fixes for broken .eslint rules
+  globals: {
+    Atomics: "readonly",
+    SharedArrayBuffer: "readonly",
+  },
+
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".ts"],
+      },
+    },
+    jest: {
+      // eslint-disable-next-line global-require, @typescript-eslint/no-var-requires, import/extensions
+      version: require("jest/package.json").version,
+    },
+  },
+
+  rules: {
+    // Don't allow overwriting built-in globals like URL
+    "no-shadow": ["error", { builtinGlobals: true }],
+
+    // Make everything work with .ts and .tsx as well
+    "import/extensions": [
+      "error",
+      {
+        js: "never",
+        ts: "never",
+        tsx: "never",
+      },
+    ],
+
+    // Allow devDeps in test files
+    "import/no-extraneous-dependencies": [
+      "off",
+      {
+        devDependencies: ["**/*.test.*"],
+      },
+    ],
+
+    // import/no-unresolved is problematic because of the RDF/JS specification, which has type
+    // definitions available in @types/rdf-js, but no actual corresponding rdf-js package.
+    "import/no-unresolved": [
+      "error",
+      {
+        ignore: ["rdf-js"],
+      },
+    ],
+
+    // Remove airbnb's ForOfStatement recommendation; we don't use regenerator-runtime anyway,
+    // and we iterate over Sets in our libraries.
+    "no-restricted-syntax": [
+      "error",
+      {
+        selector: "ForInStatement",
+        message:
+          "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
+      },
+      {
+        selector: "LabeledStatement",
+        message:
+          "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
+      },
+      {
+        selector: "WithStatement",
+        message:
+          "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
+      },
+    ],
+
+    // Leaving out the await can hide the fact that you're not catching thrown errors:
+    // https://twitter.com/_jayphelps/status/1324565522755788803
+    // Additionally, it will prevent the function from being part of the stack trace
+    // if not catching them:
+    // https://eslint.org/docs/rules/no-return-await
+    // Thus, we use the rule that can use type annotation to ensure we await Promises used in
+    // try..catch blocks:
+    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/return-await.md
+    "no-return-await": ["off"],
+
+    // Ensure all code has a license header:
+    "header/header": ["warn", require.resolve("./license-header.js")],
+
+    // set eol to auto to handle all environments
+    "prettier/prettier": ["error", { endOfLine: "auto" }],
+  },
+
+  overrides: [
+    {
+      files: [
+        "**/*.test.ts",
+        "**/*.test.tsx",
+        "**/*.test.js",
+        "**/*.test.jsx",
+        // legacy: we need to standardise around *.test.ts
+        "**/*.spec.ts",
+        "**/*.spec.tsx",
+        "**/*.spec.js",
+        "**/*.spec.jsx",
+      ],
+      plugins: ["jest"],
+      extends: ["plugin:jest/recommended", "plugin:jest/style"],
+      rules: {
+        "no-shadow": [
+          "warn",
+          {
+            allow: [
+              "describe",
+              "it",
+              "jest",
+              "expect",
+              "beforeEach",
+              "beforeAll",
+              "afterEach",
+              "afterAll",
+            ],
+          },
+        ],
+      },
+    },
+    {
+      files: ["e2e/browser/**/*.playwright.ts"],
+      extends: ["plugin:playwright/playwright-test"],
+    },
+  ],
+};

package/eslint-configs/eslint-config-base/license-header.js

@@ -0,0 +1,20 @@
+//
+// 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.
+//

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

@@ -0,0 +1,41 @@
+{
+  "name": "@inrupt/eslint-config-base",
+  "description": "Shared eslint config for Javascript 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",
+    "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-base#readme",
+  "dependencies": {
+    "eslint": ">=8.49.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-playwright": "^0.16.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": ">=29.6.4",
+    "prettier": ">=3.0.3"
+  },
+  "peerDependencies": {
+    "@rushstack/eslint-patch": ">=1.1.4",
+    "eslint": ">=8.49.0",
+    "jest": ">=29.6.4",
+    "prettier": ">=3.0.3"
+  }
+}

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

@@ -0,0 +1,51 @@
+# eslint-config-inrupt-lib
+
+Eslint and prettier configs
+
+## Installation
+
+1. `npm install --save-dev @inrupt/eslint-config-lib @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-lib"],
+  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", "examples/**/*.ts", "*.md"],
+  "exclude": ["**/node_modules", "**/dist/**"]
+}
+```
+
+## Migrating to this configuration:
+
+1. Add `extends: ['@inrupt/eslint-config-lib']` 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 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-lib/index.js

@@ -0,0 +1,83 @@
+//
+// 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: [
+    "@inrupt/eslint-config-base",
+    "plugin:@typescript-eslint/recommended",
+  ],
+
+  plugins: ["@typescript-eslint"],
+
+  overrides: [
+    {
+      files: ["*.ts", "*.tsx"],
+
+      parser: "@typescript-eslint/parser",
+
+      // Load typescript rules to handle es6 and typescript
+      parserOptions: {
+        project: "./**/tsconfig*.json",
+        ecmaVersion: 2018,
+        sourceType: "module",
+      },
+
+      rules: {
+        "@typescript-eslint/return-await": ["error", "in-try-catch"],
+
+        // Allow empty arrow functions, useful as defaults or for testing mocks
+        "@typescript-eslint/no-empty-function": [
+          "error",
+          { allow: ["arrowFunctions"] },
+        ],
+
+        "@typescript-eslint/no-floating-promises": "error",
+
+        // We allow underscores in some situations, such as internal_ or unstable_. Additionally,
+        // many of the libraries we use commonly use underscores, so disable this rule.
+        "@typescript-eslint/camelcase": ["off"],
+
+        // Use typescript's definition checker
+        "no-use-before-define": ["off"],
+        "@typescript-eslint/no-use-before-define": ["warn"],
+
+        // Ensure that type only imports are used whenever possible; this is also important
+        // to avoid violating the import/no-unresolved rule when type-only packages such as
+        // @rdfjs/types are used
+        //
+        // For instance if we have:
+        // ```ts
+        // import { Term } from '@rdfjs/types';
+        // ```
+        // Then the import/no-unresolved rule is violated; but eslint --fix is unable to resolve
+        // the problem. By adding this rule eslint --fix is able to set this to:
+        // ```ts
+        // import type { Term } from '@rdfjs/types';
+        // ```
+        //
+        "@typescript-eslint/consistent-type-imports": [
+          "error",
+          { prefer: "type-imports" },
+        ],
+      },
+    },
+  ],
+};

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

@@ -0,0 +1,29 @@
+{
+  "name": "@inrupt/eslint-config-lib",
+  "description": "Shared eslint config for Typescript Libraries used 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",
+    "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-lib#readme",
+  "dependencies": {
+    "@inrupt/eslint-config-base": "file:../eslint-config-base",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "typescript": ">=5.2.2"
+  }
+}