@augment-vir/core 30.0.0

package/dist/augments/partial-type.d.ts

@@ -0,0 +1,7 @@
+import { AnyObject } from './object/generic-object-type.js';
+export type PartialWithNullable<T extends AnyObject> = {
+    [Prop in keyof T]?: T[Prop] | null | undefined;
+};
+export type PartialWithUndefined<T extends AnyObject> = {
+    [Prop in keyof T]?: T[Prop] | undefined;
+};

package/dist/augments/partial-type.js

@@ -0,0 +1 @@
+export {};

package/dist/augments/promise/deferred-promise.d.ts

@@ -0,0 +1,7 @@
+export declare class DeferredPromise<T = void> {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+    isSettled: boolean;
+    constructor();
+}

package/dist/augments/promise/deferred-promise.js

@@ -0,0 +1,19 @@
+import { ensureError } from '../error/ensure-error.js';
+export class DeferredPromise {
+    promise;
+    resolve;
+    reject;
+    isSettled = false;
+    constructor() {
+        this.promise = new Promise((resolve, reject) => {
+            this.resolve = (value) => {
+                this.isSettled = true;
+                return resolve(value);
+            };
+            this.reject = (reason) => {
+                this.isSettled = true;
+                reject(ensureError(reason));
+            };
+        });
+    }
+}

package/dist/augments/promise/maybe-promise.d.ts

@@ -0,0 +1 @@
+export type MaybePromise<T> = Promise<T> | T;

package/dist/augments/promise/maybe-promise.js

@@ -0,0 +1 @@
+export {};

package/dist/augments/promise/wait.d.ts

@@ -0,0 +1,3 @@
+import { AnyDuration } from '@date-vir/duration';
+export declare function wait(duration: Readonly<AnyDuration>): Promise<void>;
+export declare function waitValue<Value>(duration: Readonly<AnyDuration>, value: Value): Promise<Value>;

package/dist/augments/promise/wait.js

@@ -0,0 +1,16 @@
+import { convertDuration, DurationUnit } from '@date-vir/duration';
+import { DeferredPromise } from './deferred-promise.js';
+export function wait(duration) {
+    const deferredPromise = new DeferredPromise();
+    const milliseconds = convertDuration(duration, DurationUnit.Milliseconds).milliseconds;
+    if (milliseconds !== Infinity) {
+        setTimeout(() => {
+            deferredPromise.resolve();
+        }, milliseconds <= 0 ? 0 : milliseconds);
+    }
+    return deferredPromise.promise;
+}
+export async function waitValue(duration, value) {
+    await wait(duration);
+    return value;
+}

package/dist/augments/runtime-env.d.ts

@@ -0,0 +1,33 @@
+/**
+ * JavaScript run-time env. code, which usually has its own env definition as well.
+ *
+ * @category Env
+ */
+export declare enum RuntimeEnv {
+    Node = "node",
+    Web = "web"
+}
+/**
+ * Determine the current {@link RuntimeEnv} value. Usually you shouldn't need to call this, you can
+ * simply import {@link currentRuntimeEnv} directly.
+ *
+ * @category Env
+ */
+export declare function determineRuntimeEnv(): RuntimeEnv;
+/**
+ * The current {@link RuntimeEnv} value.
+ *
+ * @category Env
+ */
+export declare const currentRuntimeEnv: RuntimeEnv;
+/**
+ * Checks if the given {@link RuntimeEnv} value is the current {@link RuntimeEnv} value.
+ *
+ * @category Env
+ * @returns `true` if the given {@link RuntimeEnv} is the current {@link RuntimeEnv}.
+ */
+export declare function isRuntimeEnv(itItThisEnv: RuntimeEnv): boolean;
+export declare class RuntimeEnvError extends Error {
+    readonly name = "RuntimeEnvError";
+}
+export declare function forEachEnv<T>(perEnv: Record<RuntimeEnv, () => T>): T;

package/dist/augments/runtime-env.js

@@ -0,0 +1,43 @@
+import { isNode } from 'browser-or-node';
+/**
+ * JavaScript run-time env. code, which usually has its own env definition as well.
+ *
+ * @category Env
+ */
+export var RuntimeEnv;
+(function (RuntimeEnv) {
+    RuntimeEnv["Node"] = "node";
+    RuntimeEnv["Web"] = "web";
+})(RuntimeEnv || (RuntimeEnv = {}));
+/**
+ * Determine the current {@link RuntimeEnv} value. Usually you shouldn't need to call this, you can
+ * simply import {@link currentRuntimeEnv} directly.
+ *
+ * @category Env
+ */
+export function determineRuntimeEnv() {
+    /** Coverage in this package is only run in Node. */
+    /* node:coverage ignore next */
+    return isNode ? RuntimeEnv.Node : RuntimeEnv.Web;
+}
+/**
+ * The current {@link RuntimeEnv} value.
+ *
+ * @category Env
+ */
+export const currentRuntimeEnv = determineRuntimeEnv();
+/**
+ * Checks if the given {@link RuntimeEnv} value is the current {@link RuntimeEnv} value.
+ *
+ * @category Env
+ * @returns `true` if the given {@link RuntimeEnv} is the current {@link RuntimeEnv}.
+ */
+export function isRuntimeEnv(itItThisEnv) {
+    return currentRuntimeEnv === itItThisEnv;
+}
+export class RuntimeEnvError extends Error {
+    name = 'RuntimeEnvError';
+}
+export function forEachEnv(perEnv) {
+    return perEnv[currentRuntimeEnv]();
+}

package/dist/augments/string/ansi.d.ts

@@ -0,0 +1,3 @@
+export declare function removeAnsiEscapeCodes(input: string): string;
+export declare const removeColor: typeof removeAnsiEscapeCodes;
+export declare const ansiRegExp: RegExp;

package/dist/augments/string/ansi.js

@@ -0,0 +1,36 @@
+export function removeAnsiEscapeCodes(input) {
+    return input.replace(ansiRegExp, '');
+}
+export const removeColor = removeAnsiEscapeCodes;
+// cspell:disable
+/**
+ * Copied from
+ * https://github.com/chalk/ansi-regex/blob/1b337add136eb520764634a328e2f6354398eee5/index.js
+ *
+ * The package has the following license from
+ * https://github.com/chalk/ansi-regex/blob/1b337add136eb520764634a328e2f6354398eee5/license
+ *
+ * MIT License Copyright (c) Sindre Sorhus [sindresorhus@gmail.com](mailto:sindresorhus@gmail.com)
+ * (https://sindresorhus.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+ * associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+ * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+// cspell:enable
+const patterns = [
+    String.raw `[\u001B\u009B][[\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\d\/#&.:=?%@~_]+)*|[a-zA-Z\d]+(?:;[-a-zA-Z\d\/#&.:=?%@~_]*)*)?\u0007)`,
+    String.raw `(?:(?:\d{1,4}(?:;\d{0,4})*)?[\dA-PR-TZcf-nq-uy=><~]))`,
+];
+export const ansiRegExp = new RegExp(patterns.join('|'), 'g');

package/dist/augments/string/punctuation.d.ts

@@ -0,0 +1,6 @@
+import type { ArrayElement } from '../array/array.js';
+export declare const punctuationLetters: readonly [".", ":", ";", ",", "?", "!"];
+export declare const punctuationRegExp: RegExp;
+export declare const endsWithPunctuationRegExp: RegExp;
+export type PunctuationLetter = ArrayElement<typeof punctuationLetters>;
+export declare function removeEndingPunctuation(value: string): string;

package/dist/augments/string/punctuation.js

@@ -0,0 +1,13 @@
+export const punctuationLetters = [
+    '.',
+    ':',
+    ';',
+    ',',
+    '?',
+    '!',
+];
+export const punctuationRegExp = new RegExp(`[${punctuationLetters.join('')}]+`);
+export const endsWithPunctuationRegExp = new RegExp(`[${punctuationLetters.join('')}]+$`);
+export function removeEndingPunctuation(value) {
+    return value.replace(endsWithPunctuationRegExp, '');
+}

package/dist/augments/string/uuid.d.ts

@@ -0,0 +1,4 @@
+/** @category String */
+export type Uuid = `${string}-${string}-${string}-${string}-${string}`;
+/** Creates a cryptographically secure random v4 UUID using `crypto.randomUUID`. */
+export declare function createUuidV4(): `${string}-${string}-${string}-${string}-${string}`;

package/dist/augments/string/uuid.js

@@ -0,0 +1,4 @@
+/** Creates a cryptographically secure random v4 UUID using `crypto.randomUUID`. */
+export function createUuidV4() {
+    return crypto.randomUUID();
+}

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+export * from './augments/array/array.js';
+export * from './augments/array/tuple.js';
+export * from './augments/enum/enum-type.js';
+export * from './augments/enum/enum-values.js';
+export * from './augments/error/ensure-error.js';
+export * from './augments/error/error-message.js';
+export * from './augments/function/generic-function-type.js';
+export * from './augments/function/typed-function-type.js';
+export * from './augments/http/http-status.js';
+export * from './augments/narrow-type.js';
+export * from './augments/object/generic-object-type.js';
+export * from './augments/object/object-keys.js';
+export * from './augments/object/object-value-types.js';
+export * from './augments/object/required-keys.js';
+export * from './augments/object/stringify.js';
+export * from './augments/overwrite-type.js';
+export * from './augments/partial-type.js';
+export * from './augments/promise/deferred-promise.js';
+export * from './augments/promise/maybe-promise.js';
+export * from './augments/promise/wait.js';
+export * from './augments/runtime-env.js';
+export * from './augments/string/ansi.js';
+export * from './augments/string/punctuation.js';
+export * from './augments/string/uuid.js';

package/dist/index.js

@@ -0,0 +1,24 @@
+export * from './augments/array/array.js';
+export * from './augments/array/tuple.js';
+export * from './augments/enum/enum-type.js';
+export * from './augments/enum/enum-values.js';
+export * from './augments/error/ensure-error.js';
+export * from './augments/error/error-message.js';
+export * from './augments/function/generic-function-type.js';
+export * from './augments/function/typed-function-type.js';
+export * from './augments/http/http-status.js';
+export * from './augments/narrow-type.js';
+export * from './augments/object/generic-object-type.js';
+export * from './augments/object/object-keys.js';
+export * from './augments/object/object-value-types.js';
+export * from './augments/object/required-keys.js';
+export * from './augments/object/stringify.js';
+export * from './augments/overwrite-type.js';
+export * from './augments/partial-type.js';
+export * from './augments/promise/deferred-promise.js';
+export * from './augments/promise/maybe-promise.js';
+export * from './augments/promise/wait.js';
+export * from './augments/runtime-env.js';
+export * from './augments/string/ansi.js';
+export * from './augments/string/punctuation.js';
+export * from './augments/string/uuid.js';

package/package.json

@@ -0,0 +1,54 @@
+{
+    "name": "@augment-vir/core",
+    "version": "30.0.0",
+    "description": "Core augment-vir augments, especially including run-time environment determination.",
+    "keywords": [
+        "augment-vir",
+        "vir",
+        "core",
+        "env"
+    ],
+    "homepage": "https://github.com/electrovir/augment-vir",
+    "bugs": {
+        "url": "https://github.com/electrovir/augment-vir/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/electrovir/augment-vir.git"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "compile": "virmator compile",
+        "docs": "virmator docs",
+        "start": "tsx src/index.ts",
+        "test": "virmator test node",
+        "test:coverage": "npm run test coverage",
+        "test:docs": "virmator docs check",
+        "test:update": "npm test"
+    },
+    "dependencies": {
+        "@date-vir/duration": "^6.0.0",
+        "browser-or-node": "^3.0.0",
+        "json5": "^2.2.3",
+        "type-fest": "^4.25.0"
+    },
+    "devDependencies": {
+        "@types/node": "^22.5.0",
+        "c8": "^10.1.2",
+        "istanbul-smart-text-reporter": "^1.1.4"
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}