@enspirit/bmg-js 1.0.0 → 1.0.1

package/dist/src/tests/operators/unwrap.test.d.ts

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

package/dist/src/tests/operators/where.test.d.ts

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

package/dist/src/tests/operators/wrap.test.d.ts

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

package/dist/src/tests/operators/yByX.test.d.ts

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

package/dist/src/tests/types/relation.test.d.ts

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

package/dist/src/types.d.ts

@@ -0,0 +1,101 @@
+import type { RenameMap, Renamed, Prefixed, Suffixed, Joined, LeftJoined, Wrapped, Unwrapped, AggregatorResults } from './utility-types';
+/** Result of ungroup: remove relation attr, flatten its tuple type */
+export type Ungrouped<T, K extends keyof T> = T[K] extends Relation<infer N> ? Omit<T, K> & N : Omit<T, K>;
+export type AttrName = string;
+export type Tuple = Record<AttrName, unknown>;
+export interface PrefixOptions {
+    except?: AttrName[];
+}
+export interface SuffixOptions {
+    except?: AttrName[];
+}
+export interface AutowrapOptions {
+    separator?: string;
+}
+/** Predicate function that receives a typed tuple */
+export type TypedPredicateFunc<T> = (t: T) => boolean;
+/** Predicate: either a partial tuple for equality matching, or a function */
+export type TypedPredicate<T> = Partial<T> | TypedPredicateFunc<T>;
+/** Extension function that receives a typed tuple */
+export type TypedExtensionFunc<T, R> = (tuple: T) => R;
+/** Extension definition: function returning value, or attribute name to copy */
+export type TypedExtension<T, E extends Record<string, unknown>> = {
+    [K in keyof E]: TypedExtensionFunc<T, E[K]> | keyof T;
+};
+/**
+ * Relation interface with generic type parameter for tuple type.
+ * Default parameter `Tuple` ensures backwards compatibility.
+ *
+ * @typeParam T - The tuple type for this relation. Defaults to `Tuple` (Record<string, unknown>).
+ *
+ * @example
+ * // Untyped usage (backwards compatible)
+ * const r = Bmg([{ id: 1 }]);  // Relation<Tuple>
+ *
+ * @example
+ * // Typed usage with full type safety
+ * interface Person { id: number; name: string }
+ * const r = Bmg<Person>([{ id: 1, name: 'Alice' }]);
+ * r.project(['id']);  // Relation<{ id: number }>
+ */
+export interface Relation<T = Tuple> {
+    restrict(p: TypedPredicate<T>): Relation<T>;
+    where(p: TypedPredicate<T>): Relation<T>;
+    exclude(p: TypedPredicate<T>): Relation<T>;
+    project<K extends keyof T>(attrs: K[]): Relation<Pick<T, K>>;
+    allbut<K extends keyof T>(attrs: K[]): Relation<Omit<T, K>>;
+    extend<E extends Record<string, unknown>>(e: TypedExtension<T, E>): Relation<T & E>;
+    constants<C extends Tuple>(consts: C): Relation<T & C>;
+    rename<R extends RenameMap<T>>(r: R): Relation<Renamed<T, R>>;
+    prefix<P extends string, Ex extends keyof T = never>(pfx: P, options?: {
+        except?: Ex[];
+    }): Relation<Prefixed<T, P, Ex>>;
+    suffix<S extends string, Ex extends keyof T = never>(sfx: S, options?: {
+        except?: Ex[];
+    }): Relation<Suffixed<T, S, Ex>>;
+    union(right: RelationOperand<T>): Relation<T>;
+    minus(right: RelationOperand<T>): Relation<T>;
+    intersect(right: RelationOperand<T>): Relation<T>;
+    matching<R>(right: RelationOperand<R>, keys?: JoinKeys): Relation<T>;
+    not_matching<R>(right: RelationOperand<R>, keys?: JoinKeys): Relation<T>;
+    join<R>(right: RelationOperand<R>, keys?: JoinKeys): Relation<Joined<T, R>>;
+    left_join<R>(right: RelationOperand<R>, keys?: JoinKeys): Relation<LeftJoined<T, R>>;
+    cross_product<R>(right: RelationOperand<R>): Relation<T & R>;
+    cross_join<R>(right: RelationOperand<R>): Relation<T & R>;
+    image<R, As extends string>(right: RelationOperand<R>, as: As, keys?: JoinKeys): Relation<T & Record<As, Relation<Omit<R, keyof T & keyof R>>>>;
+    group<K extends keyof T, As extends string>(attrs: K[], as: As): Relation<Omit<T, K> & Record<As, Relation<Pick<T, K>>>>;
+    ungroup<K extends keyof T>(attr: K): Relation<Ungrouped<T, K>>;
+    wrap<K extends keyof T, As extends string>(attrs: K[], as: As): Relation<Wrapped<T, K, As>>;
+    unwrap<K extends keyof T>(attr: K): Relation<Unwrapped<T, K>>;
+    summarize<By extends keyof T, Aggs extends Aggregators>(by: By[], aggs: Aggs): Relation<Pick<T, By> & AggregatorResults<Aggs>>;
+    transform(t: Transformation): Relation<T>;
+    autowrap(options?: AutowrapOptions): Relation<Tuple>;
+    one(): T;
+    yByX<Y extends keyof T, X extends keyof T>(y: Y, x: X): Record<T[X] & PropertyKey, T[Y]>;
+    toArray(): T[];
+    isEqual(right: any): boolean;
+}
+export type RelationOperand<T = Tuple> = Relation<T> | T[];
+export interface OperationalOperand<T = Tuple> {
+    tuples(): Iterable<T>;
+    output(tuples: T[]): RelationOperand<T>;
+}
+export type PredicateFunc = ((t: Tuple) => any);
+export type Predicate = Tuple | PredicateFunc;
+export type Renaming = RenamingObj | RenamingFunc;
+export type RenamingFunc = (attr: AttrName) => AttrName;
+export type RenamingObj = Record<AttrName, AttrName>;
+export type ExtensionFunc = (tuple: Tuple) => unknown;
+export type Extension = Record<AttrName, ExtensionFunc | AttrName>;
+export type JoinKeys = AttrName[] | Record<AttrName, AttrName>;
+export type AggregatorName = 'count' | 'sum' | 'min' | 'max' | 'avg' | 'collect';
+export type AggregatorSpec = {
+    op: AggregatorName;
+    attr: AttrName;
+};
+export type AggregatorFunc = (tuples: Tuple[]) => unknown;
+export type Aggregator = AggregatorName | AggregatorSpec | AggregatorFunc;
+export type Aggregators = Record<AttrName, Aggregator>;
+export type TransformFunc = (value: unknown) => unknown;
+export type Transformation = TransformFunc | TransformFunc[] | Record<AttrName, TransformFunc | TransformFunc[]>;
+export type { RenameMap, Renamed, Prefixed, Suffixed, Joined, LeftJoined, Wrapped, Unwrapped } from './utility-types';

package/dist/src/utility-types.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Utility types for type transformations in relational operators.
+ * These enable compile-time tracking of how operators transform tuple types.
+ */
+import type { Tuple } from './types';
+/** Map from old attribute names to new attribute names */
+export type RenameMap<T> = {
+    [K in keyof T]?: string;
+};
+/** Transform tuple type by renaming keys according to RenameMap */
+export type Renamed<T, R extends RenameMap<T>> = {
+    [K in keyof T as K extends keyof R ? (R[K] extends string ? R[K] : K) : K]: T[K];
+};
+/** Prefix all keys except those in Except */
+export type Prefixed<T, P extends string, Except extends keyof T = never> = {
+    [K in keyof T as K extends Except ? K : `${P}${K & string}`]: T[K];
+};
+/** Suffix all keys except those in Except */
+export type Suffixed<T, S extends string, Except extends keyof T = never> = {
+    [K in keyof T as K extends Except ? K : `${K & string}${S}`]: T[K];
+};
+/** Extract common keys between two tuple types */
+export type CommonKeys<L, R> = Extract<keyof L, keyof R>;
+/** Result of inner join: L & R with R's common keys removed */
+export type Joined<L, R> = L & Omit<R, CommonKeys<L, R>>;
+/** Result of left join: L & optional R attributes (common keys removed) */
+export type LeftJoined<L, R> = L & Partial<Omit<R, CommonKeys<L, R>>>;
+/** Result of wrap: remove wrapped attrs, add nested object */
+export type Wrapped<T, K extends keyof T, As extends string> = Omit<T, K> & Record<As, Pick<T, K>>;
+/** Result of unwrap: remove object attr, spread its properties */
+export type Unwrapped<T, K extends keyof T> = T[K] extends Record<string, unknown> ? Omit<T, K> & T[K] : Omit<T, K>;
+/** Infer result type from aggregator specification */
+export type AggregatorResult<A> = A extends 'count' ? number : A extends {
+    op: 'count';
+} ? number : A extends {
+    op: 'sum' | 'avg' | 'min' | 'max';
+} ? number | null : A extends {
+    op: 'collect';
+} ? unknown[] : A extends (tuples: Tuple[]) => infer R ? R : unknown;
+/** Map aggregator definitions to their result types */
+export type AggregatorResults<Aggs extends Record<string, unknown>> = {
+    [K in keyof Aggs]: AggregatorResult<Aggs[K]>;
+};

package/dist/tests/bmg.test.d.ts

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

package/dist/tests/fixtures.d.ts

@@ -0,0 +1,6 @@
+export declare const SUPPLIERS: import("../src/Relation").MemoryRelation<{
+    sid: string;
+    name: string;
+    status: number;
+    city: string;
+}>;

package/dist/tests/operators/allbut.test.d.ts

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

package/dist/tests/operators/autowrap.test.d.ts

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

package/dist/tests/operators/constants.test.d.ts

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

package/dist/tests/operators/cross_product.test.d.ts

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

package/dist/tests/operators/exclude.test.d.ts

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

package/dist/tests/operators/extend.test.d.ts

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

package/dist/tests/operators/group.test.d.ts

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

package/dist/tests/operators/image.test.d.ts

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

package/dist/tests/operators/intersect.test.d.ts

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

package/dist/tests/operators/isEqual.test.d.ts

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

package/dist/tests/operators/join.test.d.ts

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

package/dist/tests/operators/left_join.test.d.ts

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

package/dist/tests/operators/matching.test.d.ts

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

package/dist/tests/operators/minus.test.d.ts

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

package/dist/tests/operators/not_matching.test.d.ts

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

package/dist/tests/operators/one.test.d.ts

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

package/dist/tests/operators/prefix.test.d.ts

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

package/dist/tests/operators/project.test.d.ts

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

package/dist/tests/operators/rename.test.d.ts

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

package/dist/tests/operators/restrict.test.d.ts

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

package/dist/tests/operators/suffix.test.d.ts

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

package/dist/tests/operators/summarize.test.d.ts

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

package/dist/tests/operators/transform.test.d.ts

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

package/dist/tests/operators/ungroup.test.d.ts

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

package/dist/tests/operators/union.test.d.ts

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

package/dist/tests/operators/unwrap.test.d.ts

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

package/dist/tests/operators/where.test.d.ts

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

package/dist/tests/operators/wrap.test.d.ts

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

package/dist/tests/operators/yByX.test.d.ts

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

package/dist/tests/types/relation.test.d.ts

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

package/package.json

@@ -1,9 +1,21 @@
 {
   "name": "@enspirit/bmg-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Relational algebra for JavaScript/TypeScript - work with arrays of objects using powerful set operations",
-  "keywords": ["relational", "algebra", "relation", "set", "query", "data", "functional"],
+  "keywords": [
+    "relational",
+    "algebra",
+    "relation",
+    "set",
+    "query",
+    "data",
+    "functional"
+  ],
   "license": "MIT",
+  "files": [
+    "dist",
+    "src"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/enspirit/bmg.js"
@@ -28,7 +40,7 @@
   "devDependencies": {
     "microbundle": "^0.15.1",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^1.4.0"
+    "vitest": "^4.0.16"
   },
   "packageManager": "pnpm@8.11.0+sha1.01bf39424f1008f29012bbae851d2acb8a20a0d0"
 }

package/.claude/safe-setup/.env.example

@@ -1,3 +0,0 @@
-# Git configuration (used for commits inside the container)
-GIT_USER_NAME=Your Name
-GIT_USER_EMAIL=your.email@example.com

package/.claude/safe-setup/Dockerfile.claude

@@ -1,36 +0,0 @@
-FROM alpine:latest
-
-# Install packages: base tools, node, ruby, postgresql client
-RUN apk update && apk add --no-cache \
-    bash \
-    curl \
-    git \
-    build-base \
-    nodejs \
-    npm \
-    vim \
-    sudo
-
-# Create non-root user with sudo access
-RUN addgroup -S bmg && adduser -S bmg -G bmg \
-    && echo "bmg ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
-
-# Install Claude Code CLI globally
-RUN npm install -g @anthropic-ai/claude-code
-
-# Set up working directory
-WORKDIR /workspace
-
-# Copy and set up entrypoint
-COPY entrypoint.sh /entrypoint.sh
-RUN chmod +x /entrypoint.sh
-
-# Create .claude directory for history persistence
-RUN mkdir -p /home/bmg/.claude && chown -R bmg:bmg /home/bmg/.claude
-
-# Switch to non-root user
-USER bmg
-
-# Use entrypoint to configure git and run command
-ENTRYPOINT ["/entrypoint.sh"]
-CMD ["bash"]

package/.claude/safe-setup/HACKING.md

@@ -1,63 +0,0 @@
-# Hacking on Bmg with Claude Code
-
-This Docker setup provides a sandboxed environment with all tools needed to hack on Bmg:
-- Node.js
-- Claude Code CLI
-
-## Prerequisites
-
-1. Docker and Docker Compose installed
-2. A Claude Code account
-
-## Getting Started
-
-```bash
-cd .claude/safe-setup
-
-# Create your .env file from template
-cp .env.example .env
-
-# Edit .env to set your git identity
-# GIT_USER_NAME=Your Name
-# GIT_USER_EMAIL=your.email@example.com
-
-# Build and start containers
-make up
-
-# Enter the dev environment
-make shell
-```
-
-## Persistent Data
-
-- **Claude history**: Stored in a named Docker volume (`claude-history`) that persists across container restarts
-- **Git configuration**: Automatically set from `GIT_USER_NAME` and `GIT_USER_EMAIL` environment variables
-
-## Inside the Container
-
-You're now user `bmg` in `/workspace` (the Bmg project root).
-
-```bash
-# Install project dependencies
-npm install
-
-# Run tests
-npm run test
-
-# Use Claude Code
-claude
-```
-
-PostgreSQL is pre-configured via environment variables. Just run `psql` to connect.
-
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `make up` | Build and start containers |
-| `make down` | Stop containers |
-| `make shell` | Enter dev container |
-| `make restart` | Restart everything |
-| `make logs` | Follow container logs |
-| `make status` | Show container status |
-| `make clean` | Remove containers and images |

package/.claude/safe-setup/Makefile

@@ -1,22 +0,0 @@
-.PHONY: up down shell restart clean logs status
-
-up:
-	docker compose up -d --build
-	@echo "Containers started. Use 'make shell' to access dev environment"
-
-down:
-	docker compose down
-
-shell:
-	docker compose exec dev bash
-
-restart: down up
-
-clean: down
-	docker compose down --rmi all --volumes
-
-logs:
-	docker compose logs -f
-
-status:
-	@docker compose ps

package/.claude/safe-setup/docker-compose.yml

@@ -1,18 +0,0 @@
-services:
-
-  dev:
-    build:
-      context: .
-      dockerfile: Dockerfile.claude
-    container_name: claude
-    volumes:
-      - ../..:/workspace
-      - claude-history:/home/bmg/.claude
-    environment:
-      - GIT_USER_NAME=${GIT_USER_NAME:-}
-      - GIT_USER_EMAIL=${GIT_USER_EMAIL:-}
-    stdin_open: true
-    tty: true
-
-volumes:
-  claude-history:

package/.claude/safe-setup/entrypoint.sh

@@ -1,13 +0,0 @@
-#!/bin/bash
-
-# Configure git user/email from environment variables if provided
-if [ -n "$GIT_USER_NAME" ]; then
-    git config --global user.name "$GIT_USER_NAME"
-fi
-
-if [ -n "$GIT_USER_EMAIL" ]; then
-    git config --global user.email "$GIT_USER_EMAIL"
-fi
-
-# Execute the command passed to the container
-exec "$@"

package/.claude/settings.local.json

@@ -1,9 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npm run test:*)",
-      "Bash(npx tsc:*)",
-      "Bash(wc:*)"
-    ]
-  }
-}