Add a library for parsing Drupal-managed menus

.github/workflows/eslint.yml

@@ -13,14 +13,14 @@ jobs:
       - uses: actions/setup-node@v1
       - run: yarn
       - run: yarn ci
-      - run: jq -s '[.[][]]' reports/eslint/*.json > reports/eslint/eslint-combined.json
+      - run: jq -s '[.[][]]' reports/eslint/*.json > reports/eslint/eslint-combined-menu.json
         if: ${{ failure() }}
       - name: Annotate Code Linting Results
         uses: ataylorme/[email protected]
         if: ${{ failure() }}
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          report-json: reports/eslint/eslint-combined.json
+          report-json: reports/eslint/eslint-combined-menu.json
       - name: Upload test artifacts
         if: ${{ failure() }}
         uses: actions/upload-artifact@v2

linkset/.gitignore

@@ -0,0 +1 @@
+index.js

linkset/.npmignore

@@ -0,0 +1,2 @@
+src
+rollup.config.js

linkset/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

linkset/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@jsdrupal/linkset",
+  "version": "0.0.0",
+  "main": "index.js",
+  "repository": "git://github.com/jsdrupal/js-client.git",
+  "scripts": {
+    "build": "rimraf dist && rollup -c && mv dist/index.js index.js && rimraf dist",
+    "eslint": "eslint . --ext .ts --max-warnings=0 --ignore-path=.gitignore",
+    "eslintci": "eslint -o ../reports/eslint/linkset.json -f json",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^8.2.0",
+    "@types/jest": "^26.0.20",
+    "@types/node": "^14.14.31",
+    "@types/node-fetch": "^2.5.8",
+    "@typescript-eslint/eslint-plugin": "^4.16.1",
+    "@typescript-eslint/parser": "^4.16.1",
+    "eslint": "^7.21.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.40.0",
+    "ts-jest": "^26.5.2",
+    "tslib": "^2.1.0",
+    "typescript": "^4.1.2"
+  },
+  "eslintConfig": {
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier"
+    ]
+  }
+}

linkset/rollup.config.js

@@ -0,0 +1,12 @@
+// rollup.config.js
+import typescript from '@rollup/plugin-typescript';
+
+export default {
+  input: 'src/index.ts',
+  output: {
+    exports: 'named',
+    dir: 'dist',
+    format: 'cjs',
+  },
+  plugins: [typescript()],
+};

linkset/src/core/link.ts

@@ -0,0 +1,113 @@
+/**
+ * A value object that represents a single, internationalized target attribute.
+ * @see {@link https://tools.ietf.org/html/draft-ietf-httpapi-linkset-00#section-4.2.4.2|draft-ietf-httpapi-linkset-00: Linkset §4.2.4.2}
+ */
+export type InternationalizedValue = {
+  value: string;
+  language?: string;
+}
+
+/**
+ * An object that represent a single target attribute value.
+ * @see {@link https://tools.ietf.org/html/draft-ietf-httpapi-linkset-00#section-4.2.4|draft-ietf-httpapi-linkset-00: Linkset §4.2.4}
+ */
+export type TargetAttributeValue = string | InternationalizedValue;
+
+/**
+ * An object that represents a subset of a link's target attributes.
+ * The subset's contents are the target attributes defined by Web Linking.
+ * @see {@link https://tools.ietf.org/html/draft-ietf-httpapi-linkset-00#section-4.2.4.1|draft-ietf-httpapi-linkset-00: Linkset §4.2.4.1}
+ */
+interface RegisteredTargetAttributes {
+  readonly hreflang?: string[];
+  readonly media?: string;
+  readonly type?: string;
+  readonly title?: string;
+  readonly 'title*'?: InternationalizedValue[];
+};
+
+/**
+ * An object that represents a link's target attributes.
+ * @see {@link https://tools.ietf.org/html/draft-ietf-httpapi-linkset-00#section-4.2.4|draft-ietf-httpapi-linkset-00: Linkset §4.2.4}
+ */
+export interface TargetAttributes extends RegisteredTargetAttributes {
+  readonly [name: string]: TargetAttributeValue | TargetAttributeValue[];
+}
+
+/**
+ * An object representing a link's parameters.
+ * @internal
+ */
+interface LinkParameters extends TargetAttributes {
+  /**
+   * The link context.
+   */
+  readonly anchor: string;
+  /**
+   * The link relation type.
+   */
+  readonly rel: string;
+  /**
+   * The link target.
+   */
+  readonly href: string;
+}
+
+/**
+ * An interface for a web link.
+ * @see {@link https://tools.ietf.org/html/rfc8288#section-2|RFC 8288: Web Linking §2}
+ */
+export interface LinkInterface {
+  /**
+   * The link context.
+   */
+  readonly anchor: string;
+  /**
+   * The link relation type.
+   * @see {@link https://tools.ietf.org/html/rfc8288#section-2.1|RFC 8288: Web Linking §2.1 Link Relation Types}
+   */
+  readonly rel: string;
+  /**
+   * The link target.
+   */
+  readonly href: string;
+  /**
+   * The link target attributes.
+   */
+  readonly attributes: TargetAttributes;
+}
+
+/**
+ * A web link.
+ * @internal
+ */
+export class Link implements LinkInterface {
+  /**
+   * {@inheritDoc LinkInterface.anchor}
+   */
+  public anchor: string;
+  /**
+   * {@inheritDoc LinkInterface.rel}
+   */
+  public rel: string;
+  /**
+   * {@inheritDoc LinkInterface.href}
+   */
+  public href: string;
+  /**
+   * {@inheritDoc LinkInterface.attributes}
+   */
+  public attributes: TargetAttributes;
+  /**
+   * Constructs a new link.
+   * @param parameters - the link's parameters.
+   * @see {@link LinkParameters}
+   */
+  constructor(parameters: LinkParameters) {
+    const { anchor, rel, href, ...attributes } = parameters;
+    this.anchor = anchor;
+    this.rel = rel;
+    this.href = href;
+    this.attributes = attributes;
+  }
+}