@axis-backstage/plugin-readme-backend 0.16.4 → 0.16.6

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @axis-backstage/plugin-readme-backend
 
+## 0.16.6
+
+### Patch Changes
+
+- 824ed5b: Remove inefficient regular expression when checking for symlinks.
+- 6a30651: Updated to Backstage 1.54.6
+
+## 0.16.5
+
+### Patch Changes
+
+- b7492ab: Updated to Backstage 1.53.1
+
 ## 0.16.4
 
 ### Patch Changes

package/config.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "readme": {
+      "type": "object",
+      "properties": {
+        "fileNames": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Optional list of file names to try. Specifies the file names to try when looking for a README file and which order to use."
+        },
+        "cacheTtl": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "years": {
+                  "type": "number"
+                },
+                "months": {
+                  "type": "number"
+                },
+                "weeks": {
+                  "type": "number"
+                },
+                "days": {
+                  "type": "number"
+                },
+                "hours": {
+                  "type": "number"
+                },
+                "minutes": {
+                  "type": "number"
+                },
+                "seconds": {
+                  "type": "number"
+                },
+                "milliseconds": {
+                  "type": "number"
+                }
+              },
+              "description": "Human friendly durations object."
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Optional cache TTL, defaults to 1 hour."
+        }
+      },
+      "description": "Configuration options for the Readme backend plugin"
+    }
+  }
+}

package/dist/lib.cjs.js

@@ -1,13 +1,7 @@
 'use strict';
 
-const DETECT_SYMLINKS_REGEX = "^(w+|.|/|-)+$";
 const isSymLink = (content) => {
-  const lines = content.split("\n");
-  if (lines.length > 1) return false;
-  const line = lines[0];
-  if (line.includes(" ")) return false;
-  const regex = RegExp(DETECT_SYMLINKS_REGEX);
-  return regex.test(content);
+  return content.length > 0 && !content.includes(" ") && !content.includes("\n") && !content.includes("\r") && !content.includes("\u2028") && !content.includes("\u2029");
 };
 
 exports.isSymLink = isSymLink;

package/dist/lib.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"lib.cjs.js","sources":["../src/lib.ts"],"sourcesContent":["const DETECT_SYMLINKS_REGEX = '^(w+|.|/|-)+$';\n\nexport const isSymLink = (content: string): boolean => {\n  const lines = content.split('\\n');\n  if (lines.length > 1) return false;\n  const line = lines[0];\n  if (line.includes(' ')) return false;\n\n  const regex = RegExp(DETECT_SYMLINKS_REGEX);\n  return regex.test(content);\n};\n"],"names":[],"mappings":";;AAAA,MAAM,qBAAA,GAAwB,eAAA;AAEvB,MAAM,SAAA,GAAY,CAAC,OAAA,KAA6B;AACrD,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA,CAAM,IAAI,CAAA;AAChC,EAAA,IAAI,KAAA,CAAM,MAAA,GAAS,CAAA,EAAG,OAAO,KAAA;AAC7B,EAAA,MAAM,IAAA,GAAO,MAAM,CAAC,CAAA;AACpB,EAAA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,EAAG,OAAO,KAAA;AAE/B,EAAA,MAAM,KAAA,GAAQ,OAAO,qBAAqB,CAAA;AAC1C,EAAA,OAAO,KAAA,CAAM,KAAK,OAAO,CAAA;AAC3B;;;;"}
+{"version":3,"file":"lib.cjs.js","sources":["../src/lib.ts"],"sourcesContent":["export const isSymLink = (content: string): boolean => {\n  return (\n    content.length > 0 &&\n    !content.includes(' ') &&\n    !content.includes('\\n') &&\n    !content.includes('\\r') &&\n    !content.includes('\\u2028') &&\n    !content.includes('\\u2029')\n  );\n};\n"],"names":[],"mappings":";;AAAO,MAAM,SAAA,GAAY,CAAC,OAAA,KAA6B;AACrD,EAAA,OACE,OAAA,CAAQ,MAAA,GAAS,CAAA,IACjB,CAAC,OAAA,CAAQ,QAAA,CAAS,GAAG,CAAA,IACrB,CAAC,OAAA,CAAQ,QAAA,CAAS,IAAI,CAAA,IACtB,CAAC,OAAA,CAAQ,QAAA,CAAS,IAAI,CAAA,IACtB,CAAC,OAAA,CAAQ,QAAA,CAAS,QAAQ,CAAA,IAC1B,CAAC,OAAA,CAAQ,QAAA,CAAS,QAAQ,CAAA;AAE9B;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axis-backstage/plugin-readme-backend",
-  "version": "0.16.4",
+  "version": "0.16.6",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -10,6 +10,11 @@
     "types": "dist/index.d.ts",
     "directory": "_release/package"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AxisCommunications/backstage-plugins",
+    "directory": "plugins/readme-backend"
+  },
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "readme",
@@ -31,31 +36,30 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.9.2",
-    "@backstage/catalog-client": "^1.16.0",
-    "@backstage/catalog-model": "^1.9.0",
+    "@backstage/backend-plugin-api": "^1.10.0",
+    "@backstage/catalog-model": "^1.10.0",
     "@backstage/config": "^1.3.8",
     "@backstage/errors": "^1.3.1",
-    "@backstage/integration": "^2.0.3",
-    "@backstage/plugin-catalog-node": "^2.2.2",
+    "@backstage/integration": "^2.1.1",
+    "@backstage/plugin-catalog-node": "^2.2.4",
     "@backstage/types": "^1.2.2",
     "@types/express": "*",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "^0.17.4",
-    "@backstage/backend-test-utils": "^1.11.4",
-    "@backstage/cli": "^0.36.3",
-    "@types/supertest": "^2.0.12",
+    "@backstage/backend-defaults": "^0.17.8",
+    "@backstage/backend-test-utils": "^1.11.6",
+    "@backstage/cli": "^0.36.5",
+    "@types/supertest": "^7.0.0",
     "msw": "^2.7.3",
-    "supertest": "^6.2.4"
+    "supertest": "^7.0.0"
   },
   "files": [
     "dist",
-    "config.d.ts"
+    "config.schema.json"
   ],
-  "configSchema": "config.d.ts",
+  "configSchema": "config.schema.json",
   "typesVersions": {
     "*": {
       "package.json": [

package/config.d.ts

@@ -1,18 +0,0 @@
-import { HumanDuration } from '@backstage/types';
-
-export interface Config {
-  /**
-   * Configuration options for the Readme backend plugin
-   */
-  readme?: {
-    /**
-     * Optional list of file names to try. Specifies the file names to try
-     * when looking for a README file and which order to use.
-     */
-    fileNames?: string[];
-    /**
-     * Optional cache TTL, defaults to 1 hour.
-     */
-    cacheTtl?: HumanDuration | string;
-  };
-}