@workglow/util 0.0.52

package/LICENSE

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Steven Roussey
+
+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
+
+       http://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.
+
+

package/README.md

@@ -0,0 +1,318 @@
+# @workglow/util
+
+Utility functions and helper classes for Workglow AI task pipelines.
+
+## Overview
+
+The `@workglow/util` package provides a comprehensive set of utility functions, helper classes, and common functionality used throughout the Workglow ecosystem. It includes utilities for cryptography, compression, graph operations, dependency injection, event handling, and more.
+
+## Features
+
+- **Cryptography**: Hashing, encryption, and security utilities
+- **Compression**: Data compression and decompression utilities
+- **Graph Operations**: Graph traversal and manipulation utilities
+- **Dependency Injection**: Simple DI container for managing dependencies
+- **Event System**: Event emitter and handling utilities
+- **Worker Utilities**: Web worker and background task helpers
+- **JSON Schema Utilities**: JSON Schema types and utilities for schema validation and type inference
+- **Multi-Platform Support**: Works in browser, Node.js, and Bun environments
+
+## Installation
+
+```bash
+npm install @workglow/util
+# or
+bun add @workglow/util
+```
+
+## Usage
+
+### Cryptography Utilities
+
+```typescript
+import { hash, encrypt, decrypt, generateKey } from "@workglow/util/crypto";
+
+// Hash data
+const hashedData = await hash("my-data", "sha256");
+
+// Generate encryption key
+const key = await generateKey();
+
+// Encrypt/decrypt data
+const encrypted = await encrypt("sensitive-data", key);
+const decrypted = await decrypt(encrypted, key);
+```
+
+### Compression Utilities
+
+```typescript
+import { compress, decompress } from "@workglow/util/compress";
+
+// Compress data
+const compressed = await compress("large text data...");
+
+// Decompress data
+const decompressed = await decompress(compressed);
+```
+
+### Graph Operations
+
+```typescript
+import { topologicalSort, findCycles, shortestPath, GraphNode } from "@workglow/util/graph";
+
+// Create graph nodes
+const nodes: GraphNode[] = [
+  { id: "A", dependencies: [] },
+  { id: "B", dependencies: ["A"] },
+  { id: "C", dependencies: ["A", "B"] },
+];
+
+// Topological sort
+const sorted = topologicalSort(nodes);
+
+// Find cycles
+const cycles = findCycles(nodes);
+
+// Find shortest path
+const path = shortestPath(nodes, "A", "C");
+```
+
+### Dependency Injection
+
+```typescript
+import { Container, injectable, inject } from "@workglow/util/di";
+
+@injectable()
+class DatabaseService {
+  connect() {
+    // Database connection logic
+  }
+}
+
+@injectable()
+class UserService {
+  constructor(@inject("DatabaseService") private db: DatabaseService) {}
+
+  getUsers() {
+    this.db.connect();
+    // User retrieval logic
+  }
+}
+
+// Create container and register services
+const container = new Container();
+container.register("DatabaseService", DatabaseService);
+container.register("UserService", UserService);
+
+// Resolve dependencies
+const userService = container.resolve<UserService>("UserService");
+```
+
+### Event System
+
+```typescript
+import { EventEmitter, createEventBus } from "@workglow/util/events";
+
+// Basic event emitter
+const emitter = new EventEmitter();
+
+emitter.on("data", (data) => {
+  console.log("Received:", data);
+});
+
+emitter.emit("data", { message: "Hello World" });
+
+// Event bus for cross-component communication
+const eventBus = createEventBus();
+
+eventBus.subscribe("task:completed", (task) => {
+  console.log("Task completed:", task.id);
+});
+
+eventBus.publish("task:completed", { id: "task-123" });
+```
+
+### Worker Utilities
+
+```typescript
+import { createWorkerPool, WorkerTask, WorkerPool } from "@workglow/util/worker";
+
+// Create worker pool
+const pool: WorkerPool = createWorkerPool({
+  workerScript: "./worker.js",
+  poolSize: 4,
+  maxQueueSize: 100,
+});
+
+// Execute task in worker
+const result = await pool.execute({
+  type: "process-data",
+  data: { input: "some data" },
+});
+
+// Clean up
+await pool.terminate();
+```
+
+### JSON Schema Utilities
+
+You can define JSON schemas using plain JSON Schema objects, or use schema libraries like TypeBox or Zod to create them.
+
+#### Using Plain JSON Schema
+
+```typescript
+import { JsonSchema, FromSchema, DataPortSchema, compileSchema } from "@workglow/util";
+
+// Define a JSON Schema
+const userSchema = {
+  type: "object",
+  properties: {
+    id: { type: "string", format: "uuid" },
+    email: { type: "string", format: "email" },
+    age: { type: "number", minimum: 0, maximum: 150 },
+  },
+  required: ["id", "email"],
+  additionalProperties: false,
+} as const satisfies JsonSchema;
+
+// Infer TypeScript types from schema
+type User = FromSchema<typeof userSchema>;
+// => { id: string; email: string; age?: number }
+
+// Compile schema for runtime validation
+const validator = compileSchema(userSchema);
+const isValid = validator.validate({
+  id: "123e4567-e89b-12d3-a456-426614174000",
+  email: "user@example.com",
+  age: 25,
+});
+```
+
+#### Using TypeBox
+
+TypeBox schemas are JSON Schema compatible and can be used directly:
+
+```typescript
+import { Type, Static } from "@sinclair/typebox";
+
+// Define a schema using TypeBox
+const userSchema = Type.Object({
+  id: Type.String({ format: "uuid" }),
+  email: Type.String({ format: "email" }),
+  age: Type.Optional(Type.Number({ minimum: 0, maximum: 150 })),
+}) satisfies DataPortSchema;
+
+// Infer TypeScript types from schema
+type User = Static<typeof userSchema>;
+// => { id: string; email: string; age?: number }
+```
+
+#### Using Zod
+
+Zod 4 has built-in JSON Schema support using the `.toJSONSchema()` method:
+
+```typescript
+import { z } from "zod";
+
+// Define a schema using Zod
+const userSchemaZod = z.object({
+  id: z.string().uuid(),
+  email: z.string().email(),
+  age: z.number().min(0).max(150).optional(),
+});
+
+// Convert Zod schema to JSON Schema using built-in method
+const userSchema = userSchemaZod.toJSONSchema() as DataPortSchema;
+
+// Infer TypeScript types from schema using Zod's built-in type inference
+type User = z.infer<typeof userSchemaZod>;
+// => { id: string; email: string; age?: number }
+```
+
+## Utility Categories
+
+### Cryptography (`/crypto`)
+
+- Hashing functions (SHA-256, SHA-512, etc.)
+- Symmetric and asymmetric encryption
+- Key generation and management
+- Digital signatures
+- Secure random number generation
+
+### Compression (`/compress`)
+
+- GZIP compression/decompression
+- Brotli compression/decompression
+- Custom compression algorithms
+- Stream-based compression
+
+### Graph Operations (`/graph`)
+
+- Topological sorting
+- Cycle detection
+- Shortest path algorithms
+- Graph traversal (DFS, BFS)
+- Strongly connected components
+
+### Dependency Injection (`/di`)
+
+- Lightweight DI container
+- Decorator-based injection
+- Singleton and transient lifetimes
+- Circular dependency detection
+
+### Event System (`/events`)
+
+- Type-safe event emitter
+- Event bus for decoupled communication
+- Event filtering and transformation
+- Async event handling
+
+### Worker Utilities (`/worker`)
+
+- Worker pool management
+- Task queuing and distribution
+- Worker lifecycle management
+- Error handling and recovery
+
+### JSON Schema Utilities (`/json-schema`)
+
+- `JsonSchema` - Extended JSON Schema type with custom extensions
+- `FromSchema` - Infer TypeScript types from JSON schemas
+- `DataPortSchema` - Schema type for task input/output ports
+- `compileSchema` - Runtime schema validation using json-schema-library
+- Schema compatibility utilities for task graph dataflows
+
+### General Utilities (`/utilities`)
+
+- Debounce and throttle functions
+- Deep object merging
+- Array and object utilities
+- String manipulation helpers
+- Date and time utilities
+
+## Environment-Specific Features
+
+### Browser
+
+- Web Worker support
+- IndexedDB utilities
+- Blob and File handling
+- WebCrypto API integration
+
+### Node.js
+
+- File system utilities
+- Process management
+- Native crypto support
+- Stream processing
+
+### Bun
+
+- Optimized for Bun runtime
+- Fast startup and execution
+- Built-in APIs integration
+
+## License
+
+Apache 2.0 - See [LICENSE](./LICENSE) for details.