@aidc-toolkit/core 1.0.33-beta → 1.0.35-beta

package/README.md

@@ -1,6 +1,6 @@
 # Core Package
 
-**Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit contributors**
+**Copyright © 2024-2026 Dolphin Data Development Ltd. and AIDC Toolkit contributors**
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 
@@ -10,10 +10,6 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 ## Overview
 
-> [!WARNING]
-> 
-> **This software is in beta**, with production release is scheduled for 2025Q4. To follow the status of this and other projects, go to the AIDC Toolkit [projects](https://github.com/orgs/aidc-toolkit/projects) page.
-
 The AIDC Toolkit `core` package contains artefacts to support other AIDC Toolkit packages; it does not itself provide any of the functionality of the AIDC Toolkit. It is a required dependency for all AIDC Toolkit packages.
 
 ## Types and Type Helpers

package/dist/base-url.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Alpha base URL. Reads from local application storage, path "config", key "resources.local", if present, otherwise
+ * defaults to the Vite server URL.
+ */
+export declare const ALPHA_BASE_URL: Promise<string>;
+/**
+ * AIDC Toolkit base URL.
+ */
+export declare const AIDC_TOOLKIT_BASE_URL = "https://aidc-toolkit.com";
+/**
+ * Determine the base URL for the phase based on the package version.
+ *
+ * @param version
+ * Package version.
+ *
+ * @param alphaBaseURL
+ * Alpha base URL.
+ *
+ * @param nonAlphaRelativeURL
+ * Non-alpha URL, relative to non-alpha base URL and optionally the pre-release identifier and version.
+ *
+ * @returns
+ * Fully-formed base URL for the phase.
+ */
+export declare function baseURL(version: string, alphaBaseURL: string, nonAlphaRelativeURL?: string): string;
+//# sourceMappingURL=base-url.d.ts.map

package/dist/base-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-url.d.ts","sourceRoot":"","sources":["../src/base-url.ts"],"names":[],"mappings":"AAyBA;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAK1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,6BAA6B,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,CAsBnG"}

package/dist/base-url.js

@@ -0,0 +1,62 @@
+import { LocalAppDataStorage } from "./local-app-data-storage.js";
+import { parseVersion } from "./parse-version.js";
+/**
+ * Default alpha URL (Vite development URL) if no local resources file is found.
+ */
+const DEFAULT_ALPHA_BASE_URL = "http://localhost:5173";
+/**
+ * Configuration path, expected to be present in development but not necessarily in production.
+ */
+const CONFIGURATION_PATH = "config";
+/**
+ * Key to local resources, expected to be present in development but not necessarily in production.
+ */
+const LOCAL_RESOURCES_KEY = "resources.local";
+/**
+ * Alpha base URL. Reads from local application storage, path "config", key "resources.local", if present, otherwise
+ * defaults to the Vite server URL.
+ */
+export const ALPHA_BASE_URL = LocalAppDataStorage.then(async (LocalAppDataStorage) => new LocalAppDataStorage(CONFIGURATION_PATH).read(LOCAL_RESOURCES_KEY)).then(resources => 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Fallback works regardless of type.
+resources?.alphaBaseURL ?? DEFAULT_ALPHA_BASE_URL);
+/**
+ * AIDC Toolkit base URL.
+ */
+export const AIDC_TOOLKIT_BASE_URL = "https://aidc-toolkit.com";
+/**
+ * Determine the base URL for the phase based on the package version.
+ *
+ * @param version
+ * Package version.
+ *
+ * @param alphaBaseURL
+ * Alpha base URL.
+ *
+ * @param nonAlphaRelativeURL
+ * Non-alpha URL, relative to non-alpha base URL and optionally the pre-release identifier and version.
+ *
+ * @returns
+ * Fully-formed base URL for the phase.
+ */
+export function baseURL(version, alphaBaseURL, nonAlphaRelativeURL) {
+    const parsedVersion = parseVersion(version);
+    const preReleaseIdentifier = parsedVersion.preReleaseIdentifier;
+    let url;
+    if (preReleaseIdentifier === "alpha") {
+        // Alpha base URL is absolute.
+        url = alphaBaseURL;
+    }
+    else {
+        const relativeURL = nonAlphaRelativeURL !== undefined && nonAlphaRelativeURL !== "" ? `/${nonAlphaRelativeURL}` : "";
+        if (preReleaseIdentifier !== undefined) {
+            // Non-alpha base URL is relative to AIDC Toolkit base URL plus pre-release identifier and version.
+            url = `${AIDC_TOOLKIT_BASE_URL}/${preReleaseIdentifier}/v${parsedVersion.majorVersion}.${parsedVersion.minorVersion}${relativeURL}`;
+        }
+        else {
+            // Production base URL is relative to AIDC Toolkit base URL.
+            url = `${AIDC_TOOLKIT_BASE_URL}${relativeURL}`;
+        }
+    }
+    return url;
+}
+//# sourceMappingURL=base-url.js.map

package/dist/base-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-url.js","sourceRoot":"","sources":["../src/base-url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAEvD;;GAEG;AACH,MAAM,kBAAkB,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;AAS9C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAC,mBAAmB,EAAC,EAAE,CAC/E,IAAI,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CACxE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;AACf,6GAA6G;AAC5G,SAA0C,EAAE,YAAY,IAAI,sBAAsB,CACtF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,0BAA0B,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,OAAO,CAAC,OAAe,EAAE,YAAoB,EAAE,mBAA4B;IACvF,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,oBAAoB,GAAG,aAAa,CAAC,oBAAoB,CAAC;IAEhE,IAAI,GAAW,CAAC;IAEhB,IAAI,oBAAoB,KAAK,OAAO,EAAE,CAAC;QACnC,8BAA8B;QAC9B,GAAG,GAAG,YAAY,CAAC;IACvB,CAAC;SAAM,CAAC;QACJ,MAAM,WAAW,GAAG,mBAAmB,KAAK,SAAS,IAAI,mBAAmB,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAErH,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACrC,mGAAmG;YACnG,GAAG,GAAG,GAAG,qBAAqB,IAAI,oBAAoB,KAAK,aAAa,CAAC,YAAY,IAAI,aAAa,CAAC,YAAY,GAAG,WAAW,EAAE,CAAC;QACxI,CAAC;aAAM,CAAC;YACJ,4DAA4D;YAC5D,GAAG,GAAG,GAAG,qBAAqB,GAAG,WAAW,EAAE,CAAC;QACnD,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * Copyright © 2024-2026 Dolphin Data Development Ltd. and AIDC Toolkit
  * contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +17,8 @@
 export type * from "./type.js";
 export * from "./type-helper.js";
 export * from "./logger.js";
+export * from "./parse-version.js";
+export * from "./base-url.js";
 export * from "./app-data.js";
 export * from "./app-data-storage.js";
 export * from "./local-app-data-storage.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,mBAAmB,WAAW,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,aAAa,CAAC;AAE5B,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,YAAY,CAAC;AAE3B,mBAAmB,gBAAgB,CAAC;AAEpC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,mBAAmB,WAAW,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,aAAa,CAAC;AAE5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,YAAY,CAAC;AAE3B,mBAAmB,gBAAgB,CAAC;AAEpC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,5 +1,23 @@
+/*!
+ * Copyright © 2024-2026 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export * from "./type-helper.js";
 export * from "./logger.js";
+export * from "./parse-version.js";
+export * from "./base-url.js";
 export * from "./app-data.js";
 export * from "./app-data-storage.js";
 export * from "./local-app-data-storage.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAiBA,cAAc,kBAAkB,CAAC;AAEjC,cAAc,aAAa,CAAC;AAE5B,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,YAAY,CAAC;AAI3B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,cAAc,kBAAkB,CAAC;AAEjC,cAAc,aAAa,CAAC;AAE5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,YAAY,CAAC;AAI3B,cAAc,kBAAkB,CAAC"}

package/dist/parse-version.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Parsed version.
+ */
+export interface ParsedVersion {
+    /**
+     * Major version.
+     */
+    readonly majorVersion: number;
+    /**
+     * Minor version.
+     */
+    readonly minorVersion: number;
+    /**
+     * Patch version.
+     */
+    readonly patchVersion: number;
+    /**
+     * Pre-release identifier.
+     */
+    readonly preReleaseIdentifier: string | undefined;
+    /**
+     * Date/time included with pre-release identifier.
+     */
+    readonly dateTime: string | undefined;
+}
+/**
+ * Parse version.
+ *
+ * @param version
+ * Version, typically from package.json.
+ *
+ * @returns
+ * Parsed version.
+ */
+export declare function parseVersion(version: string): ParsedVersion;
+//# sourceMappingURL=parse-version.d.ts.map

package/dist/parse-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-version.d.ts","sourceRoot":"","sources":["../src/parse-version.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,CAc3D"}

package/dist/parse-version.js

@@ -0,0 +1,23 @@
+/**
+ * Parse version.
+ *
+ * @param version
+ * Version, typically from package.json.
+ *
+ * @returns
+ * Parsed version.
+ */
+export function parseVersion(version) {
+    const parsedVersionGroups = /^(?<majorVersion>\d+)\.(?<minorVersion>\d+)\.(?<patchVersion>\d+)(?:-(?<preReleaseIdentifier>alpha|beta)(?:\.(?<dateTime>\d{12}))?)?$/u.exec(version)?.groups;
+    if (parsedVersionGroups === undefined) {
+        throw new Error(`Invalid package version ${version}`);
+    }
+    return {
+        majorVersion: Number(parsedVersionGroups["majorVersion"]),
+        minorVersion: Number(parsedVersionGroups["minorVersion"]),
+        patchVersion: Number(parsedVersionGroups["patchVersion"]),
+        preReleaseIdentifier: parsedVersionGroups["preReleaseIdentifier"],
+        dateTime: parsedVersionGroups["dateTime"]
+    };
+}
+//# sourceMappingURL=parse-version.js.map

package/dist/parse-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-version.js","sourceRoot":"","sources":["../src/parse-version.ts"],"names":[],"mappings":"AA8BA;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IACxC,MAAM,mBAAmB,GAAG,wIAAwI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE3L,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO;QACH,YAAY,EAAE,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QACzD,YAAY,EAAE,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QACzD,YAAY,EAAE,MAAM,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QACzD,oBAAoB,EAAE,mBAAmB,CAAC,sBAAsB,CAAC;QACjE,QAAQ,EAAE,mBAAmB,CAAC,UAAU,CAAC;KAC5C,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/core",
-  "version": "1.0.33-beta",
+  "version": "1.0.35-beta",
   "description": "Core functionality for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -21,17 +21,18 @@
   "scripts": {
     "lint": "eslint",
     "tsc-src": "tsc --project tsconfig-src.json",
-    "build:alpha": "rimraf dist && npm run tsc-src -- --declarationMap --sourceMap",
-    "build:beta": "npm run build:alpha",
+    "build:non-prod": "rimraf dist && npm run tsc-src -- --declarationMap --sourceMap",
+    "build:alpha": "npm run build:non-prod && tsc --project tsconfig-config.json --noEmit",
+    "build:beta": "npm run build:non-prod",
     "build:prod": "npm run tsc-src -- --noEmit && tsup",
-    "build:doc": "npm run build:alpha"
+    "build:doc": "npm run build:non-prod"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "1.0.33-beta"
+    "@aidc-toolkit/dev": "1.0.34-beta"
   },
   "dependencies": {
     "base64-js": "^1.5.1",
-    "i18next": "^25.7.4",
+    "i18next": "^25.8.0",
     "i18next-browser-languagedetector": "^8.2.0",
     "i18next-cli-language-detector": "^1.1.8",
     "tslog": "^4.10.2"

package/src/base-url.ts

@@ -0,0 +1,79 @@
+import { LocalAppDataStorage } from "./local-app-data-storage.js";
+import { parseVersion } from "./parse-version.js";
+
+/**
+ * Default alpha URL (Vite development URL) if no local resources file is found.
+ */
+const DEFAULT_ALPHA_BASE_URL = "http://localhost:5173";
+
+/**
+ * Configuration path, expected to be present in development but not necessarily in production.
+ */
+const CONFIGURATION_PATH = "config";
+
+/**
+ * Key to local resources, expected to be present in development but not necessarily in production.
+ */
+const LOCAL_RESOURCES_KEY = "resources.local";
+
+/**
+ * Local resources.
+ */
+interface LocalResources {
+    alphaBaseURL: string;
+}
+
+/**
+ * Alpha base URL. Reads from local application storage, path "config", key "resources.local", if present, otherwise
+ * defaults to the Vite server URL.
+ */
+export const ALPHA_BASE_URL = LocalAppDataStorage.then(async LocalAppDataStorage =>
+    new LocalAppDataStorage(CONFIGURATION_PATH).read(LOCAL_RESOURCES_KEY)
+).then(resources =>
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Fallback works regardless of type.
+    (resources as (LocalResources | undefined))?.alphaBaseURL ?? DEFAULT_ALPHA_BASE_URL
+);
+
+/**
+ * AIDC Toolkit base URL.
+ */
+export const AIDC_TOOLKIT_BASE_URL = "https://aidc-toolkit.com";
+
+/**
+ * Determine the base URL for the phase based on the package version.
+ *
+ * @param version
+ * Package version.
+ *
+ * @param alphaBaseURL
+ * Alpha base URL.
+ *
+ * @param nonAlphaRelativeURL
+ * Non-alpha URL, relative to non-alpha base URL and optionally the pre-release identifier and version.
+ *
+ * @returns
+ * Fully-formed base URL for the phase.
+ */
+export function baseURL(version: string, alphaBaseURL: string, nonAlphaRelativeURL?: string): string {
+    const parsedVersion = parseVersion(version);
+    const preReleaseIdentifier = parsedVersion.preReleaseIdentifier;
+
+    let url: string;
+
+    if (preReleaseIdentifier === "alpha") {
+        // Alpha base URL is absolute.
+        url = alphaBaseURL;
+    } else {
+        const relativeURL = nonAlphaRelativeURL !== undefined && nonAlphaRelativeURL !== "" ? `/${nonAlphaRelativeURL}` : "";
+
+        if (preReleaseIdentifier !== undefined) {
+            // Non-alpha base URL is relative to AIDC Toolkit base URL plus pre-release identifier and version.
+            url = `${AIDC_TOOLKIT_BASE_URL}/${preReleaseIdentifier}/v${parsedVersion.majorVersion}.${parsedVersion.minorVersion}${relativeURL}`;
+        } else {
+            // Production base URL is relative to AIDC Toolkit base URL.
+            url = `${AIDC_TOOLKIT_BASE_URL}${relativeURL}`;
+        }
+    }
+
+    return url;
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * Copyright © 2024-2026 Dolphin Data Development Ltd. and AIDC Toolkit
  * contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,11 +14,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 export type * from "./type.js";
 export * from "./type-helper.js";
 
 export * from "./logger.js";
 
+export * from "./parse-version.js";
+export * from "./base-url.js";
+
 export * from "./app-data.js";
 export * from "./app-data-storage.js";
 export * from "./local-app-data-storage.js";

package/src/parse-version.ts

@@ -0,0 +1,54 @@
+/**
+ * Parsed version.
+ */
+export interface ParsedVersion {
+    /**
+     * Major version.
+     */
+    readonly majorVersion: number;
+
+    /**
+     * Minor version.
+     */
+    readonly minorVersion: number;
+
+    /**
+     * Patch version.
+     */
+    readonly patchVersion: number;
+
+    /**
+     * Pre-release identifier.
+     */
+    readonly preReleaseIdentifier: string | undefined;
+
+    /**
+     * Date/time included with pre-release identifier.
+     */
+    readonly dateTime: string | undefined;
+}
+
+/**
+ * Parse version.
+ *
+ * @param version
+ * Version, typically from package.json.
+ *
+ * @returns
+ * Parsed version.
+ */
+export function parseVersion(version: string): ParsedVersion {
+    const parsedVersionGroups = /^(?<majorVersion>\d+)\.(?<minorVersion>\d+)\.(?<patchVersion>\d+)(?:-(?<preReleaseIdentifier>alpha|beta)(?:\.(?<dateTime>\d{12}))?)?$/u.exec(version)?.groups;
+
+    if (parsedVersionGroups === undefined) {
+        throw new Error(`Invalid package version ${version}`);
+    }
+
+    return {
+        majorVersion: Number(parsedVersionGroups["majorVersion"]),
+        minorVersion: Number(parsedVersionGroups["minorVersion"]),
+        patchVersion: Number(parsedVersionGroups["patchVersion"]),
+        preReleaseIdentifier: parsedVersionGroups["preReleaseIdentifier"],
+        dateTime: parsedVersionGroups["dateTime"]
+    };
+}