@aidc-toolkit/dev 0.9.5 → 0.9.6-beta

package/config/release.json

@@ -0,0 +1,25 @@
+{
+  "organization": "aidc-toolkit",
+  "repositories": {
+    "dev": {
+      "version": "0.9.6-beta"
+    },
+    "core": {
+      "version": "0.9.6-beta"
+    },
+    "utility": {
+      "version": "0.9.6-beta"
+    },
+    "gs1": {
+      "name": "gs1",
+      "version": "0.9.6-beta"
+    },
+    "demo": {
+      "version": "0.9.6-beta"
+    },
+    "aidc-toolkit.github.io": {
+      "directory": "doc",
+      "version": "0.9.6-beta"
+    }
+  }
+}

package/copy-workflows.json

@@ -0,0 +1,40 @@
+{
+  "copyFiles": [
+    {
+      "from": ".github/workflows/tag.yml",
+      "to": "../core/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/tag.yml",
+      "to": "../utility/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/tag.yml",
+      "to": "../gs1/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/tag.yml",
+      "to": "../demo/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/tag.yml",
+      "to": "../doc/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/release.yml",
+      "to": "../core/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/release.yml",
+      "to": "../utility/.github/workflows/"
+    },
+    {
+      "from": ".github/workflows/release.yml",
+      "to": "../gs1/.github/workflows/"
+    }
+  ],
+
+  "copyFilesSettings": {
+    "whenFileExists": "overwrite"
+  }
+}

package/dist/index.cjs

@@ -59,6 +59,7 @@ var esLintConfigAIDCToolkit = import_typescript_eslint.default.config(
       reportUnusedDisableDirectives: "error"
     },
     rules: {
+      "complexity": "off",
       "no-dupe-class-members": "off",
       "no-redeclare": "off",
       "no-unused-vars": "off",
@@ -133,7 +134,8 @@ var esLintConfigAIDCToolkit = import_typescript_eslint.default.config(
     ],
     rules: {
       "jsdoc/require-jsdoc": "off",
-      "@typescript-eslint/dot-notation": "off"
+      "@typescript-eslint/dot-notation": "off",
+      "@typescript-eslint/no-unsafe-type-assertion": "off"
     }
   }
 );

package/dist/index.js

@@ -23,6 +23,7 @@ var esLintConfigAIDCToolkit = tseslint.config(
       reportUnusedDisableDirectives: "error"
     },
     rules: {
+      "complexity": "off",
       "no-dupe-class-members": "off",
       "no-redeclare": "off",
       "no-unused-vars": "off",
@@ -97,7 +98,8 @@ var esLintConfigAIDCToolkit = tseslint.config(
     ],
     rules: {
       "jsdoc/require-jsdoc": "off",
-      "@typescript-eslint/dot-notation": "off"
+      "@typescript-eslint/dot-notation": "off",
+      "@typescript-eslint/no-unsafe-type-assertion": "off"
     }
   }
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/dev",
-  "version": "0.9.5",
+  "version": "0.9.6-beta",
   "description": "Shared development artefacts for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -19,25 +19,32 @@
     "url": "https://www.linkedin.com/in/kdean"
   },
   "scripts": {
-    "eslint": "eslint .",
+    "copy-workflows": "copy-files-from-to --config copy-workflows.json",
+    "lint": "eslint .",
+    "release": "tsx src/release.ts",
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "build-doc": "npm run build"
   },
   "devDependencies": {
-    "eslint": "^9.15.0",
+    "copy-files-from-to": "^3.12.0",
+    "eslint": "^9.16.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.3.5",
-    "typescript": "^5.6.3"
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
   },
   "peerDependencies": {
     "eslint": ">=9"
   },
   "dependencies": {
-    "@eslint/js": "^9.15.0",
-    "@rollup/rollup-linux-x64-gnu": "^4.27.3",
+    "@eslint/js": "^9.16.0",
+    "@octokit/types": "^13.6.2",
+    "@rollup/rollup-linux-x64-gnu": "^4.28.0",
     "@stylistic/eslint-plugin": "^2.11.0",
-    "eslint-config-love": "^101.0.0",
-    "eslint-plugin-jsdoc": "^50.5.0",
-    "typescript-eslint": "^8.15.0"
+    "eslint-config-love": "^109.0.0",
+    "eslint-plugin-jsdoc": "^50.6.0",
+    "octokit": "^4.0.2",
+    "typescript-eslint": "^8.16.0",
+    "yaml": "^2.6.1"
   }
 }

package/src/eslint.config.template.ts

@@ -25,6 +25,7 @@ export const esLintConfigAIDCToolkit = tseslint.config(
         },
 
         rules: {
+            "complexity": "off",
             "no-dupe-class-members": "off",
             "no-redeclare": "off",
             "no-unused-vars": "off",
@@ -102,7 +103,8 @@ export const esLintConfigAIDCToolkit = tseslint.config(
         ],
         rules: {
             "jsdoc/require-jsdoc": "off",
-            "@typescript-eslint/dot-notation": "off"
+            "@typescript-eslint/dot-notation": "off",
+            "@typescript-eslint/no-unsafe-type-assertion": "off"
         }
     }
 );

package/src/release.ts

@@ -0,0 +1,384 @@
+import { spawnSync } from "child_process";
+import * as fs from "fs";
+import * as path from "node:path";
+import { Octokit } from "octokit";
+import { parse as yamlParse } from "yaml";
+
+import configurationJSON from "../config/release.json" assert { type: "json" };
+import secureConfigurationJSON from "../config/release.secure.json" assert { type: "json" };
+
+/**
+ * Configuration layout of release.json.
+ */
+interface Configuration {
+    /**
+     * Organization that owns the repositories.
+     */
+    organization: string;
+
+    /**
+     * Repositories.
+     */
+    repositories: Record<string, {
+        /**
+         * Directory in which repository resides, if different from repository name.
+         */
+        directory?: string;
+
+        /**
+         * Version for repository. Not all repositories will be in sync with the version.
+         */
+        version: string;
+    }>;
+
+    /**
+     * If true, the fact that the repository is uncommitted is ignored. For development and testing purposes only.
+     */
+    ignoreUncommitted?: boolean;
+}
+
+/**
+ * Configuration layout of release.secure.json.
+ */
+interface SecureConfiguration {
+    token: string;
+}
+
+const configuration: Configuration = configurationJSON;
+const secureConfiguration: SecureConfiguration = secureConfigurationJSON;
+
+/**
+ * Configuration layout of package.json (relevant attributes only).
+ */
+interface PackageConfiguration {
+    /**
+     * Version.
+     */
+    version: string;
+
+    /**
+     * Development dependencies.
+     */
+    devDependencies?: Record<string, string>;
+
+    /**
+     * Dependencies.
+     */
+    dependencies?: Record<string, string>;
+}
+
+/**
+ * Configuration layout of release.yml workflow (relevant attributes only).
+ */
+interface WorkflowConfiguration {
+    /**
+     * Workflow name.
+     */
+    name: string;
+
+    /**
+     * Workflow trigger.
+     */
+    on: {
+        /**
+         * Push trigger.
+         */
+        push?: {
+            /**
+             * Push branches.
+             */
+            branches?: string[];
+        };
+
+        /**
+         * Release trigger.
+         */
+        release?: {
+            /**
+             * Release types.
+             */
+            types?: string[];
+        };
+    };
+}
+
+/**
+ * Run a command and optionally capture its output.
+ *
+ * @param captureOutput
+ * If true, output is captured and returned.
+ *
+ * @param command
+ * Command to run.
+ *
+ * @param args
+ * Arguments to command.
+ *
+ * @returns
+ * Output if captured or empty array if not.
+ */
+function run(captureOutput: boolean, command: string, ...args: string[]): string[] {
+    const spawnResult = spawnSync(command, args, {
+        stdio: ["inherit", captureOutput ? "pipe" : "inherit", "inherit"]
+    });
+
+    if (spawnResult.error !== undefined) {
+        throw spawnResult.error;
+    }
+
+    if (spawnResult.status === null) {
+        throw new Error(`Terminated by signal ${spawnResult.signal}`);
+    }
+
+    if (spawnResult.status !== 0) {
+        throw new Error(`Failed with status ${spawnResult.status}`);
+    }
+
+    return captureOutput ? spawnResult.stdout.toString().split("\n").slice(0, -1) : [];
+}
+
+/**
+ * Release.
+ */
+async function release(): Promise<void> {
+    const statePath = path.resolve("config/release.state.json");
+
+    let state: Record<string, string | undefined> = {};
+
+    if (fs.existsSync(statePath)) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Format is controlled by this process.
+        state = JSON.parse(fs.readFileSync(statePath).toString());
+    }
+
+    /**
+     * Save the current state.
+     */
+    function saveState(): void {
+        fs.writeFileSync(statePath, `${JSON.stringify(state, null, 2)}\n`);
+    }
+
+    /**
+     * Execute a step.
+     *
+     * @param name
+     * Repository name.
+     *
+     * @param stepState
+     * State at which step takes place.
+     *
+     * @param callback
+     * Callback to execute step.
+     *
+     * @returns
+     * Promise.
+     */
+    async function step(name: string, stepState: string, callback: () => (void | Promise<void>)): Promise<void> {
+        const repositoryState = state[name];
+
+        if (repositoryState === undefined || repositoryState === stepState) {
+            state[name] = stepState;
+
+            try {
+                const result = callback();
+
+                if (result instanceof Promise) {
+                    await result;
+                }
+
+                state[name] = undefined;
+            } finally {
+                fs.writeFileSync(statePath, `${JSON.stringify(state, null, 2)}\n`);
+            }
+        }
+    }
+
+    const octokit = new Octokit({
+        auth: secureConfiguration.token,
+        userAgent: `${configuration.organization} release`
+    });
+
+    for (const name of Object.keys(configuration.repositories)) {
+        const repository = configuration.repositories[name];
+
+        console.log(`Repository ${name}...`);
+
+        // All repositories are expected to be children of the parent of this repository.
+        process.chdir(`../${repository.directory ?? name}`);
+
+        // Repository must be on main branch.
+        if (run(true, "git", "branch", "--show-current")[0] !== "main") {
+            throw new Error("Repository is not on main branch");
+        }
+
+        // Repository must be fully committed except for untracked files.
+        if (!(configuration.ignoreUncommitted ?? false) && state[name] === undefined && run(true, "git", "status", "--short", "--untracked-files=no").length !== 0) {
+            throw new Error("Repository has uncommitted changes");
+        }
+
+        const workflowsPath = ".github/workflows/";
+
+        let hasPushWorkflow = false;
+        let hasReleaseWorkflow = false;
+
+        for (const workflowFile of fs.readdirSync(workflowsPath)) {
+            if (workflowFile.endsWith(".yml")) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Workflow configuration format is known.
+                const workflowOn = (yamlParse(fs.readFileSync(path.resolve(workflowsPath, workflowFile)).toString()) as WorkflowConfiguration).on;
+
+                if (workflowOn.push !== undefined && (workflowOn.push.branches === undefined || workflowOn.push.branches.includes("main"))) {
+                    hasPushWorkflow = true;
+                }
+
+                if (workflowOn.release !== undefined && (workflowOn.release.types === undefined || workflowOn.release.types.includes("published"))) {
+                    hasReleaseWorkflow = true;
+                }
+            }
+        }
+
+        const tag = `v${repository.version}`;
+
+        const octokitParameterBase = {
+            owner: configuration.organization,
+            repo: name
+        };
+
+        const commitSHA = run(true, "git", "rev-parse", "HEAD")[0];
+
+        /**
+         * Validate the workflow by waiting for it to complete.
+         */
+        async function validateWorkflow(): Promise<void> {
+            while (!await new Promise<void>((resolve) => {
+                setTimeout(resolve, 2000);
+            }).then(async () => await octokit.rest.actions.listWorkflowRunsForRepo({
+                ...octokitParameterBase,
+                head_sha: commitSHA
+            })).then((response) => {
+                let workflowRunID = -1;
+
+                let queryCount = 0;
+                let completed = false;
+
+                for (const workflowRun of response.data.workflow_runs) {
+                    if (workflowRun.status !== "completed") {
+                        if (workflowRun.id === workflowRunID) {
+                            process.stdout.write(".");
+                        } else if (workflowRunID === -1) {
+                            workflowRunID = workflowRun.id;
+
+                            console.log(`Workflow run ID ${workflowRunID}`);
+                        } else {
+                            throw new Error(`Parallel workflow runs for SHA ${commitSHA}`);
+                        }
+                    } else if (workflowRun.id === workflowRunID) {
+                        process.stdout.write("\n");
+
+                        if (workflowRun.conclusion !== "success") {
+                            throw new Error(`Workflow ${workflowRun.conclusion}`);
+                        }
+
+                        completed = true;
+                    }
+                }
+
+                // Abort if workflow run not started after 10 queries.
+                if (++queryCount === 10 && workflowRunID === -1) {
+                    throw new Error(`Workflow run not started for SHA ${commitSHA}`);
+                }
+
+                return completed;
+            })) {
+                // Execution within conditional.
+            }
+        }
+
+        const packageConfigurationPath = "package.json";
+
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Package configuration format is known.
+        const packageConfiguration: PackageConfiguration = JSON.parse(fs.readFileSync(packageConfigurationPath).toString());
+
+        const skipRepository = state[name] === undefined && packageConfiguration.version === repository.version;
+
+        if (packageConfiguration.version !== repository.version) {
+            packageConfiguration.version = repository.version;
+
+            const atOrganization = `@${configuration.organization}/`;
+
+            /**
+             * Update dependencies from the organization.
+             *
+             * @param dependencies
+             * Dependencies.
+             */
+            function updateDependencies(dependencies: Record<string, string> | undefined): void {
+                if (dependencies !== undefined) {
+                    for (const dependency in dependencies) {
+                        const [dependencyAtOrganization, dependencyRepositoryName] = dependency.split("/");
+
+                        if (dependencyAtOrganization === atOrganization) {
+                            dependencies[dependency] = `^${configuration.repositories[dependencyRepositoryName].version}`;
+                        }
+                    }
+                }
+            }
+
+            updateDependencies(packageConfiguration.devDependencies);
+            updateDependencies(packageConfiguration.dependencies);
+
+            fs.writeFileSync(packageConfigurationPath, `${JSON.stringify(packageConfiguration, null, 2)}\n`);
+        }
+
+        if (!skipRepository) {
+            await step(name, "npm install", () => {
+                run(false, "npm", "install");
+            }).then(async () => {
+                await step(name, "git commit", () => {
+                    run(false, "git", "commit", "--all", `--message=Updated to version ${repository.version}`);
+                });
+            }).then(async () => {
+                await step(name, "git tag", () => {
+                    run(false, "git", "tag", tag);
+                });
+            }).then(async () => {
+                await step(name, "git push", () => {
+                    run(false, "git", "push", "--atomic", "origin", "main", tag);
+                });
+            }).then(async () => {
+                await step(name, "push workflow", async () => {
+                    if (hasPushWorkflow) {
+                        await validateWorkflow();
+                    }
+                });
+            }).then(async () => {
+                await step(name, "release", async () => {
+                    const versionSplit = repository.version.split("-");
+                    const prerelease = versionSplit.length !== 1;
+
+                    await octokit.rest.repos.createRelease({
+                        ...octokitParameterBase,
+                        tag_name: tag,
+                        name: `${prerelease ? `${versionSplit[1].substring(0, 1).toUpperCase()}${versionSplit[1].substring(1)} r` : "R"}elease ${versionSplit[0]}`,
+                        // TODO Remove "false" override.
+                        prerelease: false
+                    });
+                });
+            }).then(async () => {
+                await step(name, "release workflow", async () => {
+                    if (hasReleaseWorkflow) {
+                        await validateWorkflow();
+                    }
+                });
+            });
+
+            state[name] = "complete";
+            saveState();
+        }
+    }
+
+    state = {};
+    saveState();
+}
+
+await release().catch((e: unknown) => {
+    console.error(e);
+});

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Platform**
- - OS: [e.g. Windows, iOS]
- - Browser [e.g. chrome, safari]
- - Browser Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/actions/build-publish/action.yml

@@ -1,73 +0,0 @@
-name: Build project and publish to NPM
-
-inputs:
-  project:
-    description: Project to be built and published
-    required: true
-  node_version:
-    description: Node version
-    required: true
-  node_auth_token:
-    description: Node authentication token for publishing to NPM
-    required: true
-  no_test:
-    description: If true, test is not run
-    required: false
-  terminal_pre_build:
-    description: If true, terminal session is started before build step is run
-    required: false
-  terminal_post_build:
-    description: If true, terminal session is started after build step is run
-    required: false
-
-runs:
-  using: composite
-
-  steps:
-    - name: Setup node
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ inputs.node_version }}
-        registry-url: https://registry.npmjs.org/
-
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - name: Start terminal session (pre build)
-      if: inputs.terminal_pre_build == 'true'
-      uses: mxschmitt/action-tmate@v3
-
-    - name: Build ${{ inputs.project }}
-      shell: bash
-      run: |
-        # Removing package-lock.json is necessary to force download of all dependencies including linked dependencies.
-        rm package-lock.json
-        
-        npm install
-        
-        # This is necessary to work around platform-specific optional dependencies bug
-        # (https://github.com/npm/cli/issues/4828).
-        npm install @rollup/rollup-linux-x64-gnu
-
-        # All projects have build script.
-        npm run build
-
-    - name: Start terminal session (post build)
-      if: inputs.terminal_post_build == 'true'
-      uses: mxschmitt/action-tmate@v3
-
-    - name: Test ${{ inputs.project }}
-      if: inputs.no_test != 'true'
-      shell: bash
-      run: |
-        # Project must have test script.
-        npm run test
-
-    - name: Publish ${{ inputs.project }}
-      # Publish is valid only as part of release.
-      if: github.event_name == 'release'
-      shell: bash
-      env:
-        NODE_AUTH_TOKEN: ${{ inputs.node_auth_token }}
-      run: |
-        npm publish --access public

package/.github/workflows/build-publish.yml

@@ -1,21 +0,0 @@
-name: Build and publish
-
-on:
-  release:
-    types:
-      - published
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Build and publish dev
-        uses: aidc-toolkit/dev/.github/actions/build-publish@main
-        with:
-          project: dev
-          node_version: ${{ vars.NODE_VERSION }}
-          node_auth_token: ${{ secrets.NODE_AUTH_TOKEN }}
-          no_test: true
-          terminal_pre_build: ${{ vars.TERMINAL_PRE_BUILD }}
-          terminal_post_build: ${{ vars.TERMINAL_POST_BUILD }}

package/.idea/dev.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,7 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="UpdateDependencyToLatestVersion" enabled="true" level="WARNING" enabled_by_default="true" editorAttributes="WARNING_ATTRIBUTES" />
-  </profile>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="openjdk-21" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/dev.iml" filepath="$PROJECT_DIR$/.idea/dev.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/runConfigurations/build.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="build" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="build" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/eslint.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="eslint" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="eslint" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>