nalloc 0.0.1 → 0.0.2

package/build/testing.js

@@ -1,81 +0,0 @@
-import { isOk, isErr, isSome, isNone } from "./types.js";
-import { formatOption, formatResult } from "./devtools.js";
-export function expectOk(result, message) {
-    if (isOk(result)) {
-        return result;
-    }
-    const fallback = message ?? `Expected Ok(...) but received ${formatResult(result)}`;
-    throw new Error(fallback);
-}
-export function expectErr(result, message) {
-    if (isErr(result)) {
-        return result.error;
-    }
-    const fallback = message ?? `Expected Err(...) but received ${formatResult(result)}`;
-    throw new Error(fallback);
-}
-export function expectSome(opt, message) {
-    if (isSome(opt)) {
-        return opt;
-    }
-    const fallback = message ?? `Expected Some(...) but received ${formatOption(opt)}`;
-    throw new Error(fallback);
-}
-export function expectNone(opt, message) {
-    if (isNone(opt)) {
-        return;
-    }
-    const fallback = message ?? `Expected None but received ${formatOption(opt)}`;
-    throw new Error(fallback);
-}
-const resultMatchers = {
-    toBeOk (received) {
-        const pass = isOk(received);
-        return {
-            pass,
-            message: ()=>pass ? 'Result is Ok as expected.' : `Expected Ok(...) but received ${formatResult(received)}`
-        };
-    },
-    toBeErr (received) {
-        const pass = isErr(received);
-        return {
-            pass,
-            message: ()=>pass ? 'Result is Err as expected.' : `Expected Err(...) but received ${formatResult(received)}`
-        };
-    },
-    toContainErr (received, expected) {
-        const pass = isErr(received) && received.error === expected;
-        return {
-            pass,
-            message: ()=>{
-                if (pass) return `Err matched expected value ${String(expected)}.`;
-                return `Expected Err(${String(expected)}) but received ${formatResult(received)}`;
-            }
-        };
-    }
-};
-const optionMatchers = {
-    toBeSome (received) {
-        const pass = isSome(received);
-        return {
-            pass,
-            message: ()=>pass ? 'Option is Some as expected.' : `Expected Some(...) but received ${formatOption(received)}`
-        };
-    },
-    toBeNone (received) {
-        const pass = isNone(received);
-        return {
-            pass,
-            message: ()=>pass ? 'Option is None as expected.' : `Expected None but received ${formatOption(received)}`
-        };
-    }
-};
-export const matchers = {
-    ...resultMatchers,
-    ...optionMatchers
-};
-export function extendExpect(expectLike) {
-    expectLike.extend(matchers);
-}
-
-//# sourceMappingURL=testing.js.map

package/build/testing.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/testing.ts"],"sourcesContent":["import { isOk, isErr, isSome, isNone, Result, Err, Option } from './types.js';\nimport { formatOption, formatResult } from './devtools.js';\n\n/** Result shape returned by custom matchers. */\ntype MatcherResult = { pass: boolean; message(): string };\n\n/**\n * Asserts that a Result is Ok and returns the value.\n * Throws if the Result is Err.\n * @param result - The Result to check\n * @param message - Optional custom error message\n * @returns The Ok value\n * @throws {Error} If the Result is Err\n * @example\n * expectOk(ok(42))        // returns 42\n * expectOk(err('fail'))   // throws Error\n */\nexport function expectOk<T, E>(result: Result<T, E>, message?: string): T {\n  if (isOk(result)) {\n    return result;\n  }\n\n  const fallback = message ?? `Expected Ok(...) but received ${formatResult(result)}`;\n  throw new Error(fallback);\n}\n\n/**\n * Asserts that a Result is Err and returns the error.\n * Throws if the Result is Ok.\n * @param result - The Result to check\n * @param message - Optional custom error message\n * @returns The error value\n * @throws {Error} If the Result is Ok\n * @example\n * expectErr(err('fail'))  // returns 'fail'\n * expectErr(ok(42))       // throws Error\n */\nexport function expectErr<T, E>(result: Result<T, E>, message?: string): E {\n  if (isErr(result)) {\n    return (result as Err<E>).error;\n  }\n\n  const fallback = message ?? `Expected Err(...) but received ${formatResult(result)}`;\n  throw new Error(fallback);\n}\n\n/**\n * Asserts that an Option is Some and returns the value.\n * Throws if the Option is None.\n * @param opt - The Option to check\n * @param message - Optional custom error message\n * @returns The Some value\n * @throws {Error} If the Option is None\n * @example\n * expectSome(42)   // returns 42\n * expectSome(null) // throws Error\n */\nexport function expectSome<T>(opt: Option<T>, message?: string): T {\n  if (isSome(opt)) {\n    return opt;\n  }\n  const fallback = message ?? `Expected Some(...) but received ${formatOption(opt)}`;\n  throw new Error(fallback);\n}\n\n/**\n * Asserts that an Option is None.\n * Throws if the Option is Some.\n * @param opt - The Option to check\n * @param message - Optional custom error message\n * @throws {Error} If the Option is Some\n * @example\n * expectNone(null) // succeeds\n * expectNone(42)   // throws Error\n */\nexport function expectNone<T>(opt: Option<T>, message?: string): void {\n  if (isNone(opt)) {\n    return;\n  }\n  const fallback = message ?? `Expected None but received ${formatOption(opt)}`;\n  throw new Error(fallback);\n}\n\nconst resultMatchers = {\n  toBeOk(this: unknown, received: Result<unknown, unknown>): MatcherResult {\n    const pass = isOk(received);\n    return {\n      pass,\n      message: () => (pass ? 'Result is Ok as expected.' : `Expected Ok(...) but received ${formatResult(received)}`),\n    };\n  },\n  toBeErr(this: unknown, received: Result<unknown, unknown>): MatcherResult {\n    const pass = isErr(received);\n    return {\n      pass,\n      message: () => (pass ? 'Result is Err as expected.' : `Expected Err(...) but received ${formatResult(received)}`),\n    };\n  },\n  toContainErr(this: unknown, received: Result<unknown, unknown>, expected: unknown): MatcherResult {\n    const pass = isErr(received) && (received as Err<unknown>).error === expected;\n    return {\n      pass,\n      message: () => {\n        if (pass) return `Err matched expected value ${String(expected)}.`;\n        return `Expected Err(${String(expected)}) but received ${formatResult(received)}`;\n      },\n    };\n  },\n};\n\nconst optionMatchers = {\n  toBeSome(this: unknown, received: Option<unknown>): MatcherResult {\n    const pass = isSome(received);\n    return {\n      pass,\n      message: () => (pass ? 'Option is Some as expected.' : `Expected Some(...) but received ${formatOption(received)}`),\n    };\n  },\n  toBeNone(this: unknown, received: Option<unknown>): MatcherResult {\n    const pass = isNone(received);\n    return {\n      pass,\n      message: () => (pass ? 'Option is None as expected.' : `Expected None but received ${formatOption(received)}`),\n    };\n  },\n};\n\n/**\n * Custom matchers for Jest/Vitest.\n * Includes toBeOk, toBeErr, toContainErr, toBeSome, toBeNone.\n * Use with expect.extend(matchers) or extendExpect(expect).\n */\nexport const matchers = {\n  ...resultMatchers,\n  ...optionMatchers,\n};\n\n/** Interface for test frameworks with an extend method (Jest, Vitest). */\nexport type ExpectLike = {\n  extend(matchers: Record<string, (...args: any[]) => MatcherResult>): void;\n};\n\n/**\n * Extends a test framework's expect with Option and Result matchers.\n * @param expectLike - The expect object to extend (Jest/Vitest)\n * @example\n * import { expect } from 'vitest';\n * import { extendExpect } from 'nalloc/testing';\n * extendExpect(expect);\n *\n * // Now you can use:\n * expect(result).toBeOk();\n * expect(result).toBeErr();\n * expect(option).toBeSome();\n * expect(option).toBeNone();\n */\nexport function extendExpect(expectLike: ExpectLike): void {\n  expectLike.extend(matchers);\n}\n"],"names":["isOk","isErr","isSome","isNone","formatOption","formatResult","expectOk","result","message","fallback","Error","expectErr","error","expectSome","opt","expectNone","resultMatchers","toBeOk","received","pass","toBeErr","toContainErr","expected","String","optionMatchers","toBeSome","toBeNone","matchers","extendExpect","expectLike","extend"],"mappings":"AAAA,SAASA,IAAI,EAAEC,KAAK,EAAEC,MAAM,EAAEC,MAAM,QAA6B,aAAa;AAC9E,SAASC,YAAY,EAAEC,YAAY,QAAQ,gBAAgB;AAgB3D,OAAO,SAASC,SAAeC,MAAoB,EAAEC,OAAgB;IACnE,IAAIR,KAAKO,SAAS;QAChB,OAAOA;IACT;IAEA,MAAME,WAAWD,WAAW,CAAC,8BAA8B,EAAEH,aAAaE,SAAS;IACnF,MAAM,IAAIG,MAAMD;AAClB;AAaA,OAAO,SAASE,UAAgBJ,MAAoB,EAAEC,OAAgB;IACpE,IAAIP,MAAMM,SAAS;QACjB,OAAO,AAACA,OAAkBK,KAAK;IACjC;IAEA,MAAMH,WAAWD,WAAW,CAAC,+BAA+B,EAAEH,aAAaE,SAAS;IACpF,MAAM,IAAIG,MAAMD;AAClB;AAaA,OAAO,SAASI,WAAcC,GAAc,EAAEN,OAAgB;IAC5D,IAAIN,OAAOY,MAAM;QACf,OAAOA;IACT;IACA,MAAML,WAAWD,WAAW,CAAC,gCAAgC,EAAEJ,aAAaU,MAAM;IAClF,MAAM,IAAIJ,MAAMD;AAClB;AAYA,OAAO,SAASM,WAAcD,GAAc,EAAEN,OAAgB;IAC5D,IAAIL,OAAOW,MAAM;QACf;IACF;IACA,MAAML,WAAWD,WAAW,CAAC,2BAA2B,EAAEJ,aAAaU,MAAM;IAC7E,MAAM,IAAIJ,MAAMD;AAClB;AAEA,MAAMO,iBAAiB;IACrBC,QAAsBC,QAAkC;QACtD,MAAMC,OAAOnB,KAAKkB;QAClB,OAAO;YACLC;YACAX,SAAS,IAAOW,OAAO,8BAA8B,CAAC,8BAA8B,EAAEd,aAAaa,WAAW;QAChH;IACF;IACAE,SAAuBF,QAAkC;QACvD,MAAMC,OAAOlB,MAAMiB;QACnB,OAAO;YACLC;YACAX,SAAS,IAAOW,OAAO,+BAA+B,CAAC,+BAA+B,EAAEd,aAAaa,WAAW;QAClH;IACF;IACAG,cAA4BH,QAAkC,EAAEI,QAAiB;QAC/E,MAAMH,OAAOlB,MAAMiB,aAAa,AAACA,SAA0BN,KAAK,KAAKU;QACrE,OAAO;YACLH;YACAX,SAAS;gBACP,IAAIW,MAAM,OAAO,CAAC,2BAA2B,EAAEI,OAAOD,UAAU,CAAC,CAAC;gBAClE,OAAO,CAAC,aAAa,EAAEC,OAAOD,UAAU,eAAe,EAAEjB,aAAaa,WAAW;YACnF;QACF;IACF;AACF;AAEA,MAAMM,iBAAiB;IACrBC,UAAwBP,QAAyB;QAC/C,MAAMC,OAAOjB,OAAOgB;QACpB,OAAO;YACLC;YACAX,SAAS,IAAOW,OAAO,gCAAgC,CAAC,gCAAgC,EAAEf,aAAac,WAAW;QACpH;IACF;IACAQ,UAAwBR,QAAyB;QAC/C,MAAMC,OAAOhB,OAAOe;QACpB,OAAO;YACLC;YACAX,SAAS,IAAOW,OAAO,gCAAgC,CAAC,2BAA2B,EAAEf,aAAac,WAAW;QAC/G;IACF;AACF;AAOA,OAAO,MAAMS,WAAW;IACtB,GAAGX,cAAc;IACjB,GAAGQ,cAAc;AACnB,EAAE;AAqBF,OAAO,SAASI,aAAaC,UAAsB;IACjDA,WAAWC,MAAM,CAACH;AACpB"}

package/src/__tests__/tooling.ts

@@ -1,86 +0,0 @@
-import { beforeAll, describe, expect, it } from 'vitest';
-import { ok, err, none, some } from '../types.js';
-import {
-  expectOk,
-  expectErr,
-  expectSome,
-  expectNone,
-  extendExpect,
-} from '../testing.js';
-import {
-  formatOption,
-  formatResult,
-  inspectOption,
-  inspectResult,
-  logOption,
-  logResult,
-  toJSONOption,
-  toJSONResult,
-} from '../devtools.js';
-
-describe('testing utilities', () => {
-  beforeAll(() => {
-    extendExpect(expect as any);
-  });
-
-  it('expectOk returns Ok payload or throws', () => {
-    const value = expectOk(ok(5));
-    expect(value).toBe(5);
-    expect(() => expectOk(err('nope'))).toThrow(/Err/);
-  });
-
-  it('expectErr returns error payload or throws', () => {
-    const error = expectErr(err('boom'));
-    expect(error).toBe('boom');
-    expect(() => expectErr(ok(1))).toThrow(/Ok/);
-  });
-
-  it('expectSome / expectNone validate Option', () => {
-    const value = expectSome(some(3));
-    expect(value).toBe(3);
-    expect(() => expectSome(none)).toThrow(/None/);
-    expect(() => expectNone(some(2))).toThrow(/Some/);
-  });
-
-  it('adds matchers to expect', () => {
-    expect(ok(1)).toBeOk();
-    expect(err('oops')).toBeErr();
-    expect(some(4)).toBeSome();
-    expect(none).toBeNone();
-  });
-});
-
-describe('devtools utilities', () => {
-  it('formats option', () => {
-    expect(formatOption(some('x'))).toBe('Some(x)');
-    expect(formatOption(none)).toBe('None');
-  });
-
-  it('formats result', () => {
-    expect(formatResult(ok(7))).toBe('Ok(7)');
-    expect(formatResult(err('fail'))).toBe('Err(fail)');
-  });
-
-  it('inspects option/result', () => {
-    expect(inspectOption(some('x'))).toEqual({ kind: 'some', value: 'x' });
-    expect(inspectOption(none)).toEqual({ kind: 'none' });
-    expect(inspectResult(ok('y'))).toEqual({ status: 'ok', value: 'y' });
-    expect(inspectResult(err('fail'))).toEqual({ status: 'err', error: 'fail' });
-  });
-
-  it('logs option/result via logger', () => {
-    const calls: unknown[][] = [];
-    const logger = (...args: unknown[]) => calls.push(args);
-    logOption(some(1), logger);
-    logResult(err('fail'), logger);
-    expect(calls[0]).toEqual(['Some(1)']);
-    expect(calls[1]).toEqual(['Err', 'fail']);
-  });
-
-  it('serialises option/result to JSON friendly data', () => {
-    expect(toJSONOption(some(2))).toEqual({ kind: 'some', value: 2 });
-    expect(toJSONOption(none)).toEqual({ kind: 'none' });
-    expect(toJSONResult(ok(3))).toEqual({ status: 'ok', value: 3 });
-    expect(toJSONResult(err('fail'))).toEqual({ status: 'err', error: 'fail' });
-  });
-});

package/src/devtools.ts

@@ -1,97 +0,0 @@
-import { Option, Result, isSome, isOk } from './types.js';
-
-/** Logger function signature for custom logging. */
-type Logger = (message: string, ...args: unknown[]) => void;
-
-/**
- * Formats an Option as a human-readable string.
- * @param opt - The Option to format
- * @returns "Some(value)" or "None"
- * @example
- * formatOption(42)        // "Some(42)"
- * formatOption(null)      // "None"
- * formatOption(undefined) // "None"
- */
-export function formatOption<T>(opt: Option<T>): string {
-  return isSome(opt) ? `Some(${String(opt)})` : 'None';
-}
-
-/**
- * Formats a Result as a human-readable string.
- * For Err containing an Error, displays the error message.
- * @param result - The Result to format
- * @returns "Ok(value)" or "Err(error)"
- * @example
- * formatResult(42)                      // "Ok(42)"
- * formatResult(err('fail'))             // "Err(fail)"
- * formatResult(err(new Error('oops')))  // "Err(oops)"
- */
-export function formatResult<T, E>(result: Result<T, E>): string {
-  if (isOk(result)) {
-    return `Ok(${String(result)})`;
-  }
-  const error = (result as { error: E }).error;
-  return `Err(${error instanceof Error ? error.message : String(error)})`;
-}
-
-/**
- * Inspects an Option, returning a tagged object for debugging or serialization.
- * @param opt - The Option to inspect
- * @returns `{ kind: 'some', value: T }` or `{ kind: 'none' }`
- * @example
- * inspectOption(42)   // { kind: 'some', value: 42 }
- * inspectOption(null) // { kind: 'none' }
- */
-export function inspectOption<T>(opt: Option<T>) {
-  return isSome(opt) ? { kind: 'some' as const, value: opt } : { kind: 'none' as const };
-}
-
-/**
- * Inspects a Result, returning a tagged object for debugging or serialization.
- * @param result - The Result to inspect
- * @returns `{ status: 'ok', value: T }` or `{ status: 'err', error: E }`
- * @example
- * inspectResult(42)           // { status: 'ok', value: 42 }
- * inspectResult(err('fail'))  // { status: 'err', error: 'fail' }
- */
-export function inspectResult<T, E>(result: Result<T, E>) {
-  return isOk(result) ? { status: 'ok' as const, value: result } : { status: 'err' as const, error: (result as { error: E }).error };
-}
-
-/**
- * Logs an Option using the provided logger (defaults to console.log).
- * @param opt - The Option to log
- * @param logger - The logging function to use
- * @example
- * logOption(42)              // logs "Some(42)"
- * logOption(null)            // logs "None"
- * logOption(42, console.warn) // logs "Some(42)" as warning
- */
-export function logOption<T>(opt: Option<T>, logger: Logger = console.log): void {
-  logger(formatOption(opt));
-}
-
-/**
- * Logs a Result using the provided logger (defaults to console.log).
- * Logs "Ok" with the value or "Err" with the error.
- * @param result - The Result to log
- * @param logger - The logging function to use
- * @example
- * logResult(42)              // logs "Ok", 42
- * logResult(err('fail'))     // logs "Err", "fail"
- * logResult(42, console.warn) // logs "Ok", 42 as warning
- */
-export function logResult<T, E>(result: Result<T, E>, logger: Logger = console.log): void {
-  const tagged = inspectResult(result);
-  if (tagged.status === 'ok') {
-    logger(`Ok`, tagged.value);
-    return;
-  }
-  logger(`Err`, tagged.error);
-}
-
-/** Alias for inspectOption. Returns a JSON-serializable representation. */
-export const toJSONOption = inspectOption;
-
-/** Alias for inspectResult. Returns a JSON-serializable representation. */
-export const toJSONResult = inspectResult;

package/src/testing.ts

@@ -1,159 +0,0 @@
-import { isOk, isErr, isSome, isNone, Result, Err, Option } from './types.js';
-import { formatOption, formatResult } from './devtools.js';
-
-/** Result shape returned by custom matchers. */
-type MatcherResult = { pass: boolean; message(): string };
-
-/**
- * Asserts that a Result is Ok and returns the value.
- * Throws if the Result is Err.
- * @param result - The Result to check
- * @param message - Optional custom error message
- * @returns The Ok value
- * @throws {Error} If the Result is Err
- * @example
- * expectOk(ok(42))        // returns 42
- * expectOk(err('fail'))   // throws Error
- */
-export function expectOk<T, E>(result: Result<T, E>, message?: string): T {
-  if (isOk(result)) {
-    return result;
-  }
-
-  const fallback = message ?? `Expected Ok(...) but received ${formatResult(result)}`;
-  throw new Error(fallback);
-}
-
-/**
- * Asserts that a Result is Err and returns the error.
- * Throws if the Result is Ok.
- * @param result - The Result to check
- * @param message - Optional custom error message
- * @returns The error value
- * @throws {Error} If the Result is Ok
- * @example
- * expectErr(err('fail'))  // returns 'fail'
- * expectErr(ok(42))       // throws Error
- */
-export function expectErr<T, E>(result: Result<T, E>, message?: string): E {
-  if (isErr(result)) {
-    return (result as Err<E>).error;
-  }
-
-  const fallback = message ?? `Expected Err(...) but received ${formatResult(result)}`;
-  throw new Error(fallback);
-}
-
-/**
- * Asserts that an Option is Some and returns the value.
- * Throws if the Option is None.
- * @param opt - The Option to check
- * @param message - Optional custom error message
- * @returns The Some value
- * @throws {Error} If the Option is None
- * @example
- * expectSome(42)   // returns 42
- * expectSome(null) // throws Error
- */
-export function expectSome<T>(opt: Option<T>, message?: string): T {
-  if (isSome(opt)) {
-    return opt;
-  }
-  const fallback = message ?? `Expected Some(...) but received ${formatOption(opt)}`;
-  throw new Error(fallback);
-}
-
-/**
- * Asserts that an Option is None.
- * Throws if the Option is Some.
- * @param opt - The Option to check
- * @param message - Optional custom error message
- * @throws {Error} If the Option is Some
- * @example
- * expectNone(null) // succeeds
- * expectNone(42)   // throws Error
- */
-export function expectNone<T>(opt: Option<T>, message?: string): void {
-  if (isNone(opt)) {
-    return;
-  }
-  const fallback = message ?? `Expected None but received ${formatOption(opt)}`;
-  throw new Error(fallback);
-}
-
-const resultMatchers = {
-  toBeOk(this: unknown, received: Result<unknown, unknown>): MatcherResult {
-    const pass = isOk(received);
-    return {
-      pass,
-      message: () => (pass ? 'Result is Ok as expected.' : `Expected Ok(...) but received ${formatResult(received)}`),
-    };
-  },
-  toBeErr(this: unknown, received: Result<unknown, unknown>): MatcherResult {
-    const pass = isErr(received);
-    return {
-      pass,
-      message: () => (pass ? 'Result is Err as expected.' : `Expected Err(...) but received ${formatResult(received)}`),
-    };
-  },
-  toContainErr(this: unknown, received: Result<unknown, unknown>, expected: unknown): MatcherResult {
-    const pass = isErr(received) && (received as Err<unknown>).error === expected;
-    return {
-      pass,
-      message: () => {
-        if (pass) return `Err matched expected value ${String(expected)}.`;
-        return `Expected Err(${String(expected)}) but received ${formatResult(received)}`;
-      },
-    };
-  },
-};
-
-const optionMatchers = {
-  toBeSome(this: unknown, received: Option<unknown>): MatcherResult {
-    const pass = isSome(received);
-    return {
-      pass,
-      message: () => (pass ? 'Option is Some as expected.' : `Expected Some(...) but received ${formatOption(received)}`),
-    };
-  },
-  toBeNone(this: unknown, received: Option<unknown>): MatcherResult {
-    const pass = isNone(received);
-    return {
-      pass,
-      message: () => (pass ? 'Option is None as expected.' : `Expected None but received ${formatOption(received)}`),
-    };
-  },
-};
-
-/**
- * Custom matchers for Jest/Vitest.
- * Includes toBeOk, toBeErr, toContainErr, toBeSome, toBeNone.
- * Use with expect.extend(matchers) or extendExpect(expect).
- */
-export const matchers = {
-  ...resultMatchers,
-  ...optionMatchers,
-};
-
-/** Interface for test frameworks with an extend method (Jest, Vitest). */
-export type ExpectLike = {
-  extend(matchers: Record<string, (...args: any[]) => MatcherResult>): void;
-};
-
-/**
- * Extends a test framework's expect with Option and Result matchers.
- * @param expectLike - The expect object to extend (Jest/Vitest)
- * @example
- * import { expect } from 'vitest';
- * import { extendExpect } from 'nalloc/testing';
- * extendExpect(expect);
- *
- * // Now you can use:
- * expect(result).toBeOk();
- * expect(result).toBeErr();
- * expect(option).toBeSome();
- * expect(option).toBeNone();
- */
-export function extendExpect(expectLike: ExpectLike): void {
-  expectLike.extend(matchers);
-}