@enspirit/bmg-js 1.0.1 → 1.1.0

package/dist/src/src/operators/index.d.ts

@@ -1,30 +0,0 @@
-export * from './restrict';
-export * from './where';
-export * from './exclude';
-export * from './constants';
-export * from './rename';
-export * from './prefix';
-export * from './suffix';
-export * from './project';
-export * from './allbut';
-export * from './extend';
-export * from './union';
-export * from './minus';
-export * from './intersect';
-export * from './matching';
-export * from './not_matching';
-export * from './join';
-export * from './left_join';
-export * from './cross_product';
-export * from './image';
-export * from './summarize';
-export * from './group';
-export * from './ungroup';
-export * from './wrap';
-export * from './unwrap';
-export * from './autowrap';
-export * from './transform';
-export * from './isRelation';
-export * from './isEqual';
-export * from './one';
-export * from './yByX';

package/dist/src/src/operators/isEqual.d.ts

@@ -1,2 +0,0 @@
-import { RelationOperand } from "../types";
-export declare const isEqual: (left: RelationOperand, right: RelationOperand) => boolean;

package/dist/src/src/operators/isRelation.d.ts

@@ -1 +0,0 @@
-export declare const isRelation: (op: any) => boolean;

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

@@ -1,43 +0,0 @@
-/**
- * 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/src/support/toPredicateFunc.d.ts

@@ -1,2 +0,0 @@
-import { Predicate, PredicateFunc } from '../types';
-export declare const toPredicateFunc: (p: Predicate) => PredicateFunc;

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

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

package/dist/src/tests/fixtures.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/src/types.d.ts

@@ -1,101 +0,0 @@
-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

@@ -1,43 +0,0 @@
-/**
- * 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

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

package/dist/tests/fixtures.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/src/operators/isRelation.ts

@@ -1,5 +0,0 @@
-import { MemoryRelation } from "@/Relation";
-
-export const isRelation = (op) => {
-  return op != null && op.constructor === MemoryRelation;
-}

package/src/utility-types.ts

@@ -1,77 +0,0 @@
-/**
- * Utility types for type transformations in relational operators.
- * These enable compile-time tracking of how operators transform tuple types.
- */
-
-import type { Tuple } from './types';
-
-// ============================================================================
-// Rename 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/Suffix Types
-// ============================================================================
-
-/** 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];
-};
-
-// ============================================================================
-// Join Types
-// ============================================================================
-
-/** 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>>>;
-
-// ============================================================================
-// Wrap/Unwrap Types
-// ============================================================================
-
-/** 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>;
-
-// Note: Ungrouped is defined in types.ts since it references Relation
-
-// ============================================================================
-// Aggregator Result Types
-// ============================================================================
-
-/** 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]>;
-};