afformative 0.7.0-beta.2 → 0.7.0-beta.4

package/README.md

@@ -109,22 +109,22 @@ amounts.sort(amountFormatter.compare)
 // [{ EUR, 1 }, { EUR, 5 }, { USD, 2 }, { USD, 3 }]
 ```
 
-## Usage Context
+## Context
 
-You can pass an optional usage context object to all formatter methods. Let's use a dummy table component as an example.
+You can pass context to all formatter methods. Let's use a dummy table component as an example.
 
 ```tsx
 import { Formatter } from "afformative"
 import { ReactNode } from "react"
 
-interface TableFormatterUsageContext {
+interface TableFormatterContext {
   row: number[]
   cellIndex: number
 }
 
 interface TableProps {
   rows: number[][]
-  formatter: Formatter<number, ReactNode, TableFormatterUsageContext>
+  formatter: Formatter<number, ReactNode, TableFormatterContext>
 }
 
 const Table = ({ rows, formatter }: TableProps) => (
@@ -140,17 +140,17 @@ const Table = ({ rows, formatter }: TableProps) => (
 )
 ```
 
-Usage context allows the users of this table component to write purpose-built formatters, making it possible to take other values in the same row into account. For example, the following formatter would change the color of the cell value based on the previous value in the same row.
+Context allows the users of this table component to write purpose-built formatters, making it possible to take other values in the same row into account. For example, the following formatter would change the color of the cell value based on the previous value in the same row.
 
 ```tsx
 import { createFormatter } from "afformative"
 import { ReactNode } from "react"
 
-import { TableFormatterUsageContext } from "./Table"
+import { TableFormatterContext } from "./Table"
 
-const rowTrendFormatter = createFormatter<number, ReactNode, TableFormatterUsageContext>({
-  format: (value, { row, cellIndex }) => {
-    if (cellIndex === 0) {
+const rowTrendFormatter = createFormatter<number, ReactNode, TableFormatterContext>({
+  format: (value, { row, cellIndex } = {}) => {
+    if (!cellIndex || !row) {
       return <span>{value}</span>
     }
 
@@ -163,7 +163,7 @@ const rowTrendFormatter = createFormatter<number, ReactNode, TableFormatterUsage
 
 This formatter only makes sense in the context of our table component.
 
-Because `row` and `cellIndex` are passed as the usage context, the formatter still receives only the cell value as its first parameter. This means generic formatters (e.g. a currency formatter) can be passed to the table component without any changes.
+Because `row` and `cellIndex` are passed as context, the formatter still receives only the cell value as its first parameter. This means generic formatters (e.g. a currency formatter) can be passed to the table component without any changes.
 
 ## Accessing React Context
 

package/dist/index.cjs

@@ -1,15 +1,17 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/createFormatter.ts
 const createFormatter = (param) => {
-	const { format: formatParam, stringify: stringifyParam, compare: compareParam, ...rest } = param;
-	const format = (value, usageContext) => formatParam(value, usageContext ?? {});
-	const stringify = stringifyParam ? (value, usageContext) => stringifyParam(value, usageContext ?? {}) : (value, usageContext) => String(format(value, usageContext ?? {}));
+	const { format: formatParam, stringify: stringifyParam, compare: compareParam, meta } = param;
+	const format = (value, ctx) => formatParam(value, ctx);
+	const stringify = stringifyParam ? (value, ctx) => stringifyParam(value, ctx) : (value, ctx) => String(format(value, ctx));
 	return {
-		compare: compareParam ? (a, b, usageContext) => compareParam(a, b, usageContext ?? {}) : (a, b, usageContext) => stringify(a, usageContext ?? {}).localeCompare(stringify(b, usageContext ?? {})),
+		compare: compareParam ? (a, b, ctx) => compareParam(a, b, ctx) : (a, b, ctx) => stringify(a, ctx).localeCompare(stringify(b, ctx)),
 		format,
 		stringify,
-		...rest
+		meta
 	};
 };
 //#endregion
 exports.createFormatter = createFormatter;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/createFormatter.ts"],"sourcesContent":["export interface FormatterFormat<TInput, TOutput, TContext = unknown> {\n  (value: TInput, ctx?: TContext): TOutput\n}\n\nexport interface FormatterStringify<TInput, TContext = unknown> {\n  (value: TInput, ctx?: TContext): string\n}\n\nexport interface FormatterCompare<TInput, TContext = unknown> {\n  (a: TInput, b: TInput, ctx?: TContext): number\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unused-vars\nexport interface FormatterMeta<TInput, TOutput, TContext = unknown> {}\n\nexport interface Formatter<TInput, TOutput, TContext = unknown> {\n  compare: FormatterCompare<TInput, TContext>\n  format: FormatterFormat<TInput, TOutput, TContext>\n  stringify: FormatterStringify<TInput, TContext>\n  meta?: FormatterMeta<TInput, TOutput, TContext>\n}\n\nexport interface CreateFormatterParam<TInput, TOutput, TContext = unknown> {\n  compare?: FormatterCompare<TInput, TContext>\n  format: FormatterFormat<TInput, TOutput, TContext>\n  stringify?: FormatterStringify<TInput, TContext>\n  meta?: FormatterMeta<TInput, TOutput, TContext>\n}\n\nexport const createFormatter = <TInput, TOutput, TContext = unknown>(\n  param: CreateFormatterParam<TInput, TOutput, TContext>,\n): Formatter<TInput, TOutput, TContext> => {\n  const { format: formatParam, stringify: stringifyParam, compare: compareParam, meta } = param\n\n  const format: FormatterFormat<TInput, TOutput, TContext> = (value, ctx) => formatParam(value, ctx)\n\n  const stringify: FormatterStringify<TInput, TContext> = stringifyParam\n    ? (value, ctx) => stringifyParam(value, ctx)\n    : (value, ctx) => String(format(value, ctx))\n\n  const compare: FormatterCompare<TInput, TContext> = compareParam\n    ? (a, b, ctx) => compareParam(a, b, ctx)\n    : (a, b, ctx) => stringify(a, ctx).localeCompare(stringify(b, ctx))\n\n  return {\n    compare,\n    format,\n    stringify,\n    meta,\n  }\n}\n"],"mappings":";;AA6BA,MAAa,mBACX,UACyC;CACzC,MAAM,EAAE,QAAQ,aAAa,WAAW,gBAAgB,SAAS,cAAc,SAAS;CAExF,MAAM,UAAsD,OAAO,QAAQ,YAAY,OAAO,GAAG;CAEjG,MAAM,YAAkD,kBACnD,OAAO,QAAQ,eAAe,OAAO,GAAG,KACxC,OAAO,QAAQ,OAAO,OAAO,OAAO,GAAG,CAAC;CAM7C,OAAO;EACL,SALkD,gBAC/C,GAAG,GAAG,QAAQ,aAAa,GAAG,GAAG,GAAG,KACpC,GAAG,GAAG,QAAQ,UAAU,GAAG,GAAG,EAAE,cAAc,UAAU,GAAG,GAAG,CAAC;EAIlE;EACA;EACA;CACF;AACF"}

package/dist/index.d.cts

@@ -1,33 +1,27 @@
 //#region src/createFormatter.d.ts
-interface FormatterFormatDefinition<TInput, TOutput, TUsageContext extends object = object> {
-  (value: TInput, usageContext: Partial<TUsageContext>): TOutput;
+interface FormatterFormat<TInput, TOutput, TContext = unknown> {
+  (value: TInput, ctx?: TContext): TOutput;
 }
-interface FormatterFormat<TInput, TOutput, TUsageContext extends object = object> {
-  (value: TInput, usageContext?: Partial<TUsageContext>): TOutput;
+interface FormatterStringify<TInput, TContext = unknown> {
+  (value: TInput, ctx?: TContext): string;
 }
-interface FormatterStringifyDefinition<TInput, TUsageContext extends object = object> {
-  (value: TInput, usageContext: Partial<TUsageContext>): string;
+interface FormatterCompare<TInput, TContext = unknown> {
+  (a: TInput, b: TInput, ctx?: TContext): number;
 }
-interface FormatterStringify<TInput, TUsageContext extends object = object> {
-  (value: TInput, usageContext?: Partial<TUsageContext>): string;
+interface FormatterMeta<TInput, TOutput, TContext = unknown> {}
+interface Formatter<TInput, TOutput, TContext = unknown> {
+  compare: FormatterCompare<TInput, TContext>;
+  format: FormatterFormat<TInput, TOutput, TContext>;
+  stringify: FormatterStringify<TInput, TContext>;
+  meta?: FormatterMeta<TInput, TOutput, TContext>;
 }
-interface FormatterCompareDefinition<TInput, TUsageContext extends object = object> {
-  (a: TInput, b: TInput, usageContext: Partial<TUsageContext>): number;
+interface CreateFormatterParam<TInput, TOutput, TContext = unknown> {
+  compare?: FormatterCompare<TInput, TContext>;
+  format: FormatterFormat<TInput, TOutput, TContext>;
+  stringify?: FormatterStringify<TInput, TContext>;
+  meta?: FormatterMeta<TInput, TOutput, TContext>;
 }
-interface FormatterCompare<TInput, TUsageContext extends object = object> {
-  (a: TInput, b: TInput, usageContext?: Partial<TUsageContext>): number;
-}
-interface Formatter<TInput, TOutput, TUsageContext extends object = object> {
-  compare: FormatterCompare<TInput, TUsageContext>;
-  format: FormatterFormat<TInput, TOutput, TUsageContext>;
-  stringify: FormatterStringify<TInput, TUsageContext>;
-  name?: string;
-}
-interface CreateFormatterParam<TInput, TOutput, TUsageContext extends object = object> {
-  compare?: FormatterCompareDefinition<TInput, TUsageContext>;
-  format: FormatterFormatDefinition<TInput, TOutput, TUsageContext>;
-  stringify?: FormatterStringifyDefinition<TInput, TUsageContext>;
-}
-declare const createFormatter: <TInput, TOutput, TUsageContext extends object = object>(param: CreateFormatterParam<TInput, TOutput, TUsageContext>) => Formatter<TInput, TOutput, TUsageContext>;
+declare const createFormatter: <TInput, TOutput, TContext = unknown>(param: CreateFormatterParam<TInput, TOutput, TContext>) => Formatter<TInput, TOutput, TContext>;
 //#endregion
-export { CreateFormatterParam, Formatter, FormatterCompare, FormatterCompareDefinition, FormatterFormat, FormatterFormatDefinition, FormatterStringify, FormatterStringifyDefinition, createFormatter };
+export { CreateFormatterParam, Formatter, FormatterCompare, FormatterFormat, FormatterMeta, FormatterStringify, createFormatter };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+//#region src/createFormatter.d.ts
+interface FormatterFormat<TInput, TOutput, TContext = unknown> {
+  (value: TInput, ctx?: TContext): TOutput;
+}
+interface FormatterStringify<TInput, TContext = unknown> {
+  (value: TInput, ctx?: TContext): string;
+}
+interface FormatterCompare<TInput, TContext = unknown> {
+  (a: TInput, b: TInput, ctx?: TContext): number;
+}
+interface FormatterMeta<TInput, TOutput, TContext = unknown> {}
+interface Formatter<TInput, TOutput, TContext = unknown> {
+  compare: FormatterCompare<TInput, TContext>;
+  format: FormatterFormat<TInput, TOutput, TContext>;
+  stringify: FormatterStringify<TInput, TContext>;
+  meta?: FormatterMeta<TInput, TOutput, TContext>;
+}
+interface CreateFormatterParam<TInput, TOutput, TContext = unknown> {
+  compare?: FormatterCompare<TInput, TContext>;
+  format: FormatterFormat<TInput, TOutput, TContext>;
+  stringify?: FormatterStringify<TInput, TContext>;
+  meta?: FormatterMeta<TInput, TOutput, TContext>;
+}
+declare const createFormatter: <TInput, TOutput, TContext = unknown>(param: CreateFormatterParam<TInput, TOutput, TContext>) => Formatter<TInput, TOutput, TContext>;
+//#endregion
+export { CreateFormatterParam, Formatter, FormatterCompare, FormatterFormat, FormatterMeta, FormatterStringify, createFormatter };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,16 @@
+//#region src/createFormatter.ts
+const createFormatter = (param) => {
+	const { format: formatParam, stringify: stringifyParam, compare: compareParam, meta } = param;
+	const format = (value, ctx) => formatParam(value, ctx);
+	const stringify = stringifyParam ? (value, ctx) => stringifyParam(value, ctx) : (value, ctx) => String(format(value, ctx));
+	return {
+		compare: compareParam ? (a, b, ctx) => compareParam(a, b, ctx) : (a, b, ctx) => stringify(a, ctx).localeCompare(stringify(b, ctx)),
+		format,
+		stringify,
+		meta
+	};
+};
+//#endregion
+export { createFormatter };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/createFormatter.ts"],"sourcesContent":["export interface FormatterFormat<TInput, TOutput, TContext = unknown> {\n  (value: TInput, ctx?: TContext): TOutput\n}\n\nexport interface FormatterStringify<TInput, TContext = unknown> {\n  (value: TInput, ctx?: TContext): string\n}\n\nexport interface FormatterCompare<TInput, TContext = unknown> {\n  (a: TInput, b: TInput, ctx?: TContext): number\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unused-vars\nexport interface FormatterMeta<TInput, TOutput, TContext = unknown> {}\n\nexport interface Formatter<TInput, TOutput, TContext = unknown> {\n  compare: FormatterCompare<TInput, TContext>\n  format: FormatterFormat<TInput, TOutput, TContext>\n  stringify: FormatterStringify<TInput, TContext>\n  meta?: FormatterMeta<TInput, TOutput, TContext>\n}\n\nexport interface CreateFormatterParam<TInput, TOutput, TContext = unknown> {\n  compare?: FormatterCompare<TInput, TContext>\n  format: FormatterFormat<TInput, TOutput, TContext>\n  stringify?: FormatterStringify<TInput, TContext>\n  meta?: FormatterMeta<TInput, TOutput, TContext>\n}\n\nexport const createFormatter = <TInput, TOutput, TContext = unknown>(\n  param: CreateFormatterParam<TInput, TOutput, TContext>,\n): Formatter<TInput, TOutput, TContext> => {\n  const { format: formatParam, stringify: stringifyParam, compare: compareParam, meta } = param\n\n  const format: FormatterFormat<TInput, TOutput, TContext> = (value, ctx) => formatParam(value, ctx)\n\n  const stringify: FormatterStringify<TInput, TContext> = stringifyParam\n    ? (value, ctx) => stringifyParam(value, ctx)\n    : (value, ctx) => String(format(value, ctx))\n\n  const compare: FormatterCompare<TInput, TContext> = compareParam\n    ? (a, b, ctx) => compareParam(a, b, ctx)\n    : (a, b, ctx) => stringify(a, ctx).localeCompare(stringify(b, ctx))\n\n  return {\n    compare,\n    format,\n    stringify,\n    meta,\n  }\n}\n"],"mappings":";AA6BA,MAAa,mBACX,UACyC;CACzC,MAAM,EAAE,QAAQ,aAAa,WAAW,gBAAgB,SAAS,cAAc,SAAS;CAExF,MAAM,UAAsD,OAAO,QAAQ,YAAY,OAAO,GAAG;CAEjG,MAAM,YAAkD,kBACnD,OAAO,QAAQ,eAAe,OAAO,GAAG,KACxC,OAAO,QAAQ,OAAO,OAAO,OAAO,GAAG,CAAC;CAM7C,OAAO;EACL,SALkD,gBAC/C,GAAG,GAAG,QAAQ,aAAa,GAAG,GAAG,GAAG,KACpC,GAAG,GAAG,QAAQ,UAAU,GAAG,GAAG,EAAE,cAAc,UAAU,GAAG,GAAG,CAAC;EAIlE;EACA;EACA;CACF;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "afformative",
-  "version": "0.7.0-beta.2",
+  "version": "0.7.0-beta.4",
   "description": "A standardized way to format values in your React components.",
   "keywords": [
     "react",
@@ -27,13 +27,13 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.cts",
   "files": [
     "dist"
@@ -46,7 +46,7 @@
     "test:eslint": "eslint src",
     "test:prettier": "prettier --check src",
     "test:typescript": "tsc --noEmit",
-    "test:vitest": "vitest run"
+    "test:vitest": "vitest run --typecheck"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",

package/dist/index.d.mts

@@ -1,33 +0,0 @@
-//#region src/createFormatter.d.ts
-interface FormatterFormatDefinition<TInput, TOutput, TUsageContext extends object = object> {
-  (value: TInput, usageContext: Partial<TUsageContext>): TOutput;
-}
-interface FormatterFormat<TInput, TOutput, TUsageContext extends object = object> {
-  (value: TInput, usageContext?: Partial<TUsageContext>): TOutput;
-}
-interface FormatterStringifyDefinition<TInput, TUsageContext extends object = object> {
-  (value: TInput, usageContext: Partial<TUsageContext>): string;
-}
-interface FormatterStringify<TInput, TUsageContext extends object = object> {
-  (value: TInput, usageContext?: Partial<TUsageContext>): string;
-}
-interface FormatterCompareDefinition<TInput, TUsageContext extends object = object> {
-  (a: TInput, b: TInput, usageContext: Partial<TUsageContext>): number;
-}
-interface FormatterCompare<TInput, TUsageContext extends object = object> {
-  (a: TInput, b: TInput, usageContext?: Partial<TUsageContext>): number;
-}
-interface Formatter<TInput, TOutput, TUsageContext extends object = object> {
-  compare: FormatterCompare<TInput, TUsageContext>;
-  format: FormatterFormat<TInput, TOutput, TUsageContext>;
-  stringify: FormatterStringify<TInput, TUsageContext>;
-  name?: string;
-}
-interface CreateFormatterParam<TInput, TOutput, TUsageContext extends object = object> {
-  compare?: FormatterCompareDefinition<TInput, TUsageContext>;
-  format: FormatterFormatDefinition<TInput, TOutput, TUsageContext>;
-  stringify?: FormatterStringifyDefinition<TInput, TUsageContext>;
-}
-declare const createFormatter: <TInput, TOutput, TUsageContext extends object = object>(param: CreateFormatterParam<TInput, TOutput, TUsageContext>) => Formatter<TInput, TOutput, TUsageContext>;
-//#endregion
-export { CreateFormatterParam, Formatter, FormatterCompare, FormatterCompareDefinition, FormatterFormat, FormatterFormatDefinition, FormatterStringify, FormatterStringifyDefinition, createFormatter };

package/dist/index.mjs

@@ -1,14 +0,0 @@
-//#region src/createFormatter.ts
-const createFormatter = (param) => {
-	const { format: formatParam, stringify: stringifyParam, compare: compareParam, ...rest } = param;
-	const format = (value, usageContext) => formatParam(value, usageContext ?? {});
-	const stringify = stringifyParam ? (value, usageContext) => stringifyParam(value, usageContext ?? {}) : (value, usageContext) => String(format(value, usageContext ?? {}));
-	return {
-		compare: compareParam ? (a, b, usageContext) => compareParam(a, b, usageContext ?? {}) : (a, b, usageContext) => stringify(a, usageContext ?? {}).localeCompare(stringify(b, usageContext ?? {})),
-		format,
-		stringify,
-		...rest
-	};
-};
-//#endregion
-export { createFormatter };