@grunnverk/shared 0.1.11

package/dist/src/validation.d.ts

@@ -0,0 +1,39 @@
+import { ValidationResult } from './types';
+/**
+ * Generic validation function that validates data against a schema
+ * @param data Data to validate
+ * @param schema Validation schema (can be a Zod schema or custom validator)
+ * @returns ValidationResult with success status and either data or error
+ */
+export declare const validate: <T>(data: unknown, schema: {
+    parse: (data: unknown) => T;
+}) => ValidationResult<T>;
+/**
+ * Validates that a value is a string
+ */
+export declare const validateString: (value: unknown, fieldName?: string) => string;
+/**
+ * Validates that a value is a number
+ */
+export declare const validateNumber: (value: unknown, fieldName?: string) => number;
+/**
+ * Validates that a value is a boolean
+ */
+export declare const validateBoolean: (value: unknown, fieldName?: string) => boolean;
+/**
+ * Validates that a value is an array
+ */
+export declare const validateArray: <T>(value: unknown, fieldName?: string) => T[];
+/**
+ * Validates that a value is an object (and not null or array)
+ */
+export declare const validateObject: (value: unknown, fieldName?: string) => Record<string, any>;
+/**
+ * Validates that a string is not empty
+ */
+export declare const validateNonEmptyString: (value: unknown, fieldName?: string) => string;
+/**
+ * Validates that a value is one of the allowed values
+ */
+export declare const validateEnum: <T>(value: unknown, allowedValues: readonly T[], fieldName?: string) => T;
+//# sourceMappingURL=validation.d.ts.map

package/dist/src/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EACtB,MAAM,OAAO,EACb,QAAQ;IAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,CAAC,CAAA;CAAE,KACxC,gBAAgB,CAAC,CAAC,CAOpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,EAAE,YAAW,MAAgB,KAAG,MAK5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,EAAE,YAAW,MAAgB,KAAG,MAK5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,EAAE,YAAW,MAAgB,KAAG,OAK7E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,OAAO,OAAO,EAAE,YAAW,MAAgB,KAAG,CAAC,EAK/E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,EAAE,YAAW,MAAgB,KAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAK9F,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,OAAO,EAAE,YAAW,MAAgB,KAAG,MAMpF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,EAC1B,OAAO,OAAO,EACd,eAAe,SAAS,CAAC,EAAE,EAC3B,YAAW,MAAgB,KAC5B,CAOF,CAAC"}

package/guide/index.md

@@ -0,0 +1,84 @@
+# @grunnverk/shared - Agentic Guide
+
+## Purpose
+
+Shared utilities for grunnverk tools. Provides storage, validation, error handling, date utilities, and common helpers.
+
+## Key Features
+
+- **Storage** - File-based storage with JSON/YAML support
+- **Validation** - Input validation and sanitization
+- **Error Handling** - Custom error types (ArgumentError, CommandErrors, etc.)
+- **Date Utilities** - Date parsing and formatting
+- **Safety** - Safe file operations and input handling
+- **Standard Input** - Interactive input reading
+
+## Usage
+
+```typescript
+import {
+  Storage,
+  validateInput,
+  ArgumentError,
+  formatDate,
+  safeReadFile
+} from '@grunnverk/shared';
+
+// Storage
+const storage = new Storage('config.json');
+await storage.save({ key: 'value' });
+const data = await storage.load();
+
+// Validation
+const valid = validateInput(userInput, schema);
+
+// Error handling
+if (!valid) {
+  throw new ArgumentError('Invalid input', { input: userInput });
+}
+
+// Date utilities
+const formatted = formatDate(new Date(), 'YYYY-MM-DD');
+```
+
+## Dependencies
+
+- dayjs - Date manipulation
+- js-yaml - YAML parsing
+- glob - File pattern matching
+- moment-timezone - Timezone support
+- semver - Version parsing
+- zod - Schema validation
+
+## Package Structure
+
+```
+src/
+├── errors/               # Error types
+│   ├── ArgumentError.ts
+│   ├── CancellationError.ts
+│   ├── CommandErrors.ts
+│   ├── ExitError.ts
+│   └── index.ts
+├── storage.ts            # File storage
+├── validation.ts         # Input validation
+├── dates.ts              # Date utilities
+├── general.ts            # General utilities
+├── safety.ts             # Safe operations
+├── stdin.ts              # Standard input
+├── types.ts              # Type definitions
+└── index.ts
+```
+
+## Key Exports
+
+- `Storage` - File-based storage
+- `validateInput()` - Input validation
+- `ArgumentError` - Argument validation error
+- `CommandError` - Command execution error
+- `CancellationError` - Operation cancelled
+- `ExitError` - Process exit error
+- `formatDate()` - Date formatting
+- `safeReadFile()` - Safe file reading
+- `sanitizeInput()` - Input sanitization
+

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@grunnverk/shared",
+  "version": "0.1.11",
+  "description": "Shared utilities for grunnverk tools - storage, validation, errors, and more",
+  "main": "dist/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "guide"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/grunnverk/shared-utils.git"
+  },
+  "scripts": {
+    "build": "npm run lint && tsc --noEmit && vite build",
+    "dev": "vite",
+    "watch": "vite build --watch",
+    "test": "vitest run --coverage",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "clean": "rm -rf dist",
+    "precommit": "npm run clean && npm run build && npm run lint && npm run test",
+    "prepublishOnly": "npm run clean && npm run lint && npm run build && npm run test"
+  },
+  "keywords": [
+    "utilities",
+    "storage",
+    "validation",
+    "errors",
+    "helpers",
+    "typescript"
+  ],
+  "author": "Tim O'Brien <tobrien@discursive.com>",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.13",
+    "glob": "^13.0.0",
+    "js-yaml": "^4.1.0",
+    "moment-timezone": "^0.6.0",
+    "semver": "^7.7.2",
+    "zod": "^4.1.12"
+  },
+  "peerDependencies": {
+    "@grunnverk/git-tools": "^1.0.1",
+    "winston": "^3.17.0"
+  },
+  "peerDependenciesMeta": {
+    "@grunnverk/git-tools": {
+      "optional": true
+    },
+    "winston": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@grunnverk/git-tools": "^1.0.1",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.33.0",
+    "@swc/core": "^1.13.3",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^24.10.1",
+    "@types/semver": "^7.7.0",
+    "@types/winston": "^2.4.4",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.47.0",
+    "@vitest/coverage-v8": "^4.0.13",
+    "esbuild": "0.27.0",
+    "eslint": "^9.33.0",
+    "eslint-plugin-import": "^2.32.0",
+    "globals": "^16.3.0",
+    "mockdate": "^3.0.5",
+    "typescript": "^5.9.2",
+    "vite": "^7.2.4",
+    "vite-plugin-dts": "^4.3.0",
+    "vite-plugin-node": "^7.0.0",
+    "vitest": "^4.0.13",
+    "winston": "^3.17.0"
+  }
+}