@nl-design-system/component-progress 1.0.1-alpha.5 → 1.0.1-alpha.7

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.1-alpha.5",
+  "version": "1.0.1-alpha.7",
   "author": "Community for NL Design System",
   "description": "Script to get the component progress for the documentation of NL Design System",
   "license": "EUPL-1.2",
@@ -15,15 +15,22 @@
     "type": "git+ssh",
     "url": "git@github.com:nl-design-system/documentatie.git"
   },
+  "files": [
+    "dist/*.json"
+  ],
+  "type": "module",
   "scripts": {
-    "build": "node src/index.mjs",
+    "build": "tsc --project tsconfig.json && node dist/index.js",
     "clean": "rm -rf dist/",
+    "lint": "tsc --noEmit --project tsconfig.json",
     "prebuild": "npm run clean"
   },
   "devDependencies": {
     "@octokit/core": "6.1.2",
     "@octokit/plugin-paginate-graphql": "5.2.2",
+    "@types/lodash.isempty": "4.4.9",
+    "@types/node": "20.14.2",
     "lodash.isempty": "4.4.0"
   },
-  "gitHead": "d22143c8c3984edb9dad1c2b15ae8af08c6d76b9"
+  "gitHead": "ef7b2101d1ff3bc2b6b1fab2499ede559d659efc"
 }

package/src/graphql/getComponentIssues.mjs

@@ -1,56 +0,0 @@
-import { graphqlWithAuth } from './graphqlWithAuth.mjs';
-
-export const getComponentIssues = async () => {
-  const octokit = graphqlWithAuth();
-
-  const {
-    repository: { issues },
-  } = await octokit.graphql.paginate(
-    `query componentProgress($cursor: String) {
-  repository(name: "backlog", owner: "nl-design-system") {
-    issues(labels: ["component"], first: 50, after: $cursor) {
-      totalCount
-      nodes {
-        title
-        backlog: bodyUrl
-        projectItems(includeArchived: false, first: 100) {
-          nodes {
-            project {
-              title
-              number
-              url
-            }
-            fieldValues(first: 50) {
-              nodes {
-                ... on ProjectV2ItemFieldValueCommon {
-                  field {
-                    ... on ProjectV2FieldCommon {
-                      dataType
-                      name
-                      id
-                    }
-                  }
-                }
-                ... on ProjectV2ItemFieldSingleSelectValue {
-                  value: name
-                  color
-                }
-                ... on ProjectV2ItemFieldTextValue {
-                  value: text
-                }
-              }
-            }
-          }
-        }
-      },
-      pageInfo {
-        hasNextPage
-        endCursor
-      }
-    }
-  }
-}`,
-  );
-
-  return issues.nodes;
-};

package/src/graphql/getProjects.mjs

@@ -1,36 +0,0 @@
-import { graphqlWithAuth } from './graphqlWithAuth.mjs';
-
-const octokit = graphqlWithAuth();
-
-export const getProjects = async () => {
-  const { organization } = await octokit.graphql(
-    `query projects {
-  organization(login: "nl-design-system") {
-    projectsV2(first: 100) {
-      nodes {
-        number
-        title
-        shortDescription
-        url
-        updatedAt
-        views(first: 1) {
-          nodes {
-            fields(first: 100) {
-              nodes {
-                ... on ProjectV2FieldCommon {
-                  dataType
-                  name
-                  id
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}`,
-  );
-
-  return organization.projectsV2.nodes;
-};

package/src/graphql/graphqlWithAuth.mjs

@@ -1,13 +0,0 @@
-/* eslint-env node */
-import { Octokit } from '@octokit/core';
-import { paginateGraphQL } from '@octokit/plugin-paginate-graphql';
-
-export const graphqlWithAuth = () => {
-  const MyOctokit = Octokit.plugin(paginateGraphQL);
-
-  if (!process.env.GH_ISSUES_TOKEN) {
-    throw Error('GH_ISSUES_TOKEN is not set');
-  }
-
-  return new MyOctokit({ auth: process.env.GH_ISSUES_TOKEN });
-};

package/src/graphql/index.mjs

@@ -1,3 +0,0 @@
-export * from './graphqlWithAuth.mjs';
-export * from './getProjects.mjs';
-export * from './getComponentIssues.mjs';

package/src/index.mjs

@@ -1,27 +0,0 @@
-import * as fs from 'fs/promises';
-import { getComponentIssues, getProjects } from './graphql/index.mjs';
-import { mapProjects, mapToComponentProgress, PROJECT_NUMBERS } from './utils/index.mjs';
-
-const init = async () => {
-  try {
-    await fs.mkdir('./dist', { recursive: true });
-  } catch (error) {
-    console.error('Could not create dist directory');
-  }
-
-  const projects = await getProjects(PROJECT_NUMBERS);
-  const mappedProjects = mapProjects(projects);
-
-  await fs
-    .writeFile('./dist/projects.json', JSON.stringify(mappedProjects))
-    .catch(() => console.error('Could not create projects.json'));
-
-  const componentIssues = await getComponentIssues();
-  const componentProgress = mapToComponentProgress(componentIssues, mappedProjects);
-
-  await fs
-    .writeFile('./dist/index.json', JSON.stringify(componentProgress))
-    .catch(() => console.error('Could not create index.json'));
-};
-
-init();

package/src/utils/index.mjs

@@ -1,3 +0,0 @@
-export * from './mapToComponentProgress.mjs';
-export * from './mapProjects.mjs';
-export * from './projectData.mjs';

package/src/utils/mapProjects.mjs

@@ -1,14 +0,0 @@
-import { PROJECTS } from './index.mjs';
-
-const filterProjectChecks = ({ nodes: [view] }) =>
-  view.fields.nodes.filter((check) => check.dataType !== 'TITLE' && check.name !== 'Status');
-
-export const mapProjects = (projects) =>
-  projects.map(({ views, ...project }) => {
-    return {
-      ...project,
-      number: project.number,
-      key: PROJECTS[project.number],
-      tasks: filterProjectChecks(views),
-    };
-  });

package/src/utils/mapToComponentProgress.mjs

@@ -1,85 +0,0 @@
-import isEmpty from 'lodash.isempty';
-import { PROJECT_NUMBERS, PROJECTS } from './index.mjs';
-
-const cleanupValue = ({ field, value, color }) => {
-  // Only allow https values
-  if (field.dataType === 'TEXT' && URL.canParse(value)) {
-    const url = new URL(value);
-    return url.protocol === 'https:';
-  }
-
-  // Assume green means checked
-  if (field.dataType === 'SINGLE_SELECT') {
-    return color === 'GREEN';
-  }
-
-  return !!value;
-};
-
-const cleanupFields = ({ project, fieldValues }) => ({
-  title: project.title.replace(/Components\s?-\s?([0-9]\s?-\s?)?/, ''),
-  number: project.number,
-  id: PROJECTS[project.number],
-  url: project.url,
-  tasks: fieldValues.nodes
-    .filter((node) => !isEmpty(node) && node.field.dataType !== 'TITLE' && node.field.name !== 'Status')
-    .map((node) => ({ ...node.field, value: node.value, checked: cleanupValue(node) })),
-});
-
-const getAllTasks = (issue, projects) => {
-  const project = projects.find((project) => project.number === issue.number);
-  const tasks = project.tasks.map((task) => {
-    const check = issue.tasks.find((check) => check.id === task.id);
-    const fallBack = {
-      ...task,
-      value: '',
-      checked: false,
-    };
-
-    return check || fallBack;
-  });
-
-  const checked = issue.tasks.filter((issue) => issue.checked);
-  const done = checked.length === project.tasks.length;
-
-  return {
-    ...issue,
-    done,
-    progress: { value: checked.length, max: project.tasks.length },
-    tasks,
-  };
-};
-
-const getRelayStep = (issue) => {
-  const HELP_WANTED = issue.projects.find(({ id }) => id === 'HELP_WANTED')?.done;
-  const COMMUNITY = issue.projects.find(({ id }) => id === 'COMMUNITY')?.done;
-  const CANDIDATE = issue.projects.find(({ id }) => id === 'CANDIDATE')?.done;
-  const HALL_OF_FAME = issue.projects.find(({ id }) => id === 'HALL_OF_FAME')?.done;
-
-  const relayStep = HALL_OF_FAME
-    ? 'HALL_OF_FAME'
-    : CANDIDATE
-      ? 'CANDIDATE'
-      : COMMUNITY
-        ? 'COMMUNITY'
-        : HELP_WANTED
-          ? 'HELP_WANTED'
-          : 'UNKNOWN';
-
-  return {
-    relayStep,
-    ...issue,
-  };
-};
-
-export const mapToComponentProgress = (issues, projects) =>
-  issues
-    .map(({ title, projectItems, ...issue }) => ({
-      title,
-      ...issue,
-      projects: projectItems.nodes
-        .filter(({ project }) => Object.values(PROJECT_NUMBERS).includes(project.number))
-        .map(cleanupFields)
-        .map((component) => getAllTasks(component, projects)),
-    }))
-    .map(getRelayStep);

package/src/utils/projectData.mjs

@@ -1,23 +0,0 @@
-export const PROJECT_NUMBERS = {
-  HELP_WANTED: 27,
-  COMMUNITY: 29,
-  CANDIDATE: 32,
-  HALL_OF_FAME: 30,
-  UTRECHT: 36,
-  AMSTERDAM: 48,
-  RVO: 49,
-  LOGIUS: 53,
-  DEN_HAAG: 55,
-};
-
-export const PROJECTS = {
-  [PROJECT_NUMBERS.HELP_WANTED]: 'HELP_WANTED',
-  [PROJECT_NUMBERS.COMMUNITY]: 'COMMUNITY',
-  [PROJECT_NUMBERS.CANDIDATE]: 'CANDIDATE',
-  [PROJECT_NUMBERS.HALL_OF_FAME]: 'HALL_OF_FAME',
-  [PROJECT_NUMBERS.UTRECHT]: 'UTRECHT',
-  [PROJECT_NUMBERS.AMSTERDAM]: 'AMSTERDAM',
-  [PROJECT_NUMBERS.RVO]: 'RVO',
-  [PROJECT_NUMBERS.LOGIUS]: 'LOGIUS',
-  [PROJECT_NUMBERS.DEN_HAAG]: 'DEN_HAAG',
-};