@tryghost/metafield-types 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @tryghost/metafield-types
+
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated zod dependency

package/README.md

@@ -62,7 +62,7 @@ green. So **`src/structure.ts` must not import anything** — an ESLint rule enf
 it, relative imports included, since anything reached through one is bundled too.
 Whatever needs an import belongs in `./index`, which is free to use them.
 
-`ghost/core` is CommonJS but consumes this package via `require()`, which works
+`ghost` is CommonJS but consumes this package via `require()`, which works
 on Ghost's Node version (22.13+/24) through Node's `require(esm)` support. That
 support has one hard constraint: **no top-level `await`** anywhere in this
 package's module graph — it makes the graph async and `require()` of it throws

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/metafield-types",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Ghost member custom field types: which types exist, what each is made of, and how a value of each is validated",
   "license": "MIT",
   "author": "Ghost Foundation",
@@ -34,7 +34,7 @@
     }
   },
   "dependencies": {
-    "zod": "4.4.3"
+    "zod": "4.6.5"
   },
   "scripts": {
     "build": "tsc",

package/build/csv.d.ts

@@ -1,39 +0,0 @@
-import { type FieldType } from './index.ts';
-import type { FieldIdentityString } from './identity.ts';
-/** A field definition reduced to what CSV needs to know about it. */
-export interface CsvField {
-    namespace: string;
-    key: string;
-    type: FieldType;
-}
-/** A column a field occupies, and which part of the field's value it holds. */
-export interface CsvFieldColumn {
-    column: string;
-    /** The part this column holds, or null where the field's whole value is one column. */
-    subField: string | null;
-}
-export declare function csvColumnsForField(field: CsvField): CsvFieldColumn[];
-export declare function isMetafieldColumn(column: string): boolean;
-export declare function csvCellsForFields(fields: readonly CsvField[], values: Record<string, Record<string, unknown> | undefined>): Record<string, string>;
-/**
- * The inverse of `csvCellsForFields`: read a row's metafield cells into the values a
- * member write takes. Only the passed fields are read, so a column naming no active
- * field is dropped rather than erroring.
- *
- * `decodeCell` turns a raw cell into its value; it defaults to identity. The caller owns
- * any de-serialization the specific file needs — the members importer passes one that
- * strips the export's formula guard — so this stays pure vocabulary and holds no knowledge
- * of how any particular CSV escapes its cells.
- *
- * A field is written only from a non-blank cell; a blank or absent cell leaves the
- * existing value untouched, not cleared — matching how the importer keeps a blank name or
- * note, so re-importing a partly-filled export can't wipe values a publisher didn't
- * touch. A composite whose every cell is blank is omitted too, because the export writes
- * "no address" and an all-blank address identically; one with any filled cell is read
- * from its non-blank cells and validated whole (a malformed sub-field fails the row).
- * No sub-field is required, so a row carrying only some of an address reads as only
- * those sub-fields. A blank sub-field cell reads as no data for that sub-field, the
- * same way a blank cell reads as no data for a whole field.
- */
-export declare function fieldValuesFromCsvRow(fields: readonly CsvField[], row: Record<string, unknown>, decodeCell?: (cell: string) => string): Record<FieldIdentityString, unknown>;
-//# sourceMappingURL=csv.d.ts.map

package/build/csv.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"csv.d.ts","sourceRoot":"","sources":["../src/csv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAEzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAqBzD,qEAAqE;AACrE,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,SAAS,CAAC;CACjB;AAcD,+EAA+E;AAC/E,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,uFAAuF;IACvF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAID,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,QAAQ,GAAG,cAAc,EAAE,CAMpE;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEzD;AAeD,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,SAAS,QAAQ,EAAE,EAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,GAC1D,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAoBxB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,SAAS,QAAQ,EAAE,EAC3B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5B,UAAU,GAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAuB,GACpD,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAqCtC"}

package/build/csv.js

@@ -1,119 +0,0 @@
-import { subFieldsOf } from './index.js';
-import { QUALIFIER, SEPARATOR, formatIdentity } from './identity.js';
-/**
- * How a field's value maps onto CSV columns.
- *
- * CSV is flat and a value need not be, so a composite occupies one column per
- * sub-field. That shape is derived from the type's own value schema rather than
- * declared alongside it: the two cannot drift, and it stays correct as sub-fields
- * are added, removed, or made optional — an optional sub-field is still a column,
- * it just holds an empty cell more often.
- *
- * The same column names are the vocabulary the importer maps onto, so an exported
- * file re-imports without the publisher remapping anything by hand.
- */
-const PREFIX = `${QUALIFIER}${SEPARATOR}`;
-function columnIdentity(field) {
-    return formatIdentity({ namespace: field.namespace, key: field.key, partPath: null });
-}
-function toCell(value) {
-    return value === undefined || value === null ? '' : String(value);
-}
-// A cell holding nothing but whitespace carries no more data than an empty one, so both
-// read as blank. Without this a stray space is a value: it would be stored as one on a
-// scalar, and on a composite it would make an otherwise untouched address fail its "at
-// least one part filled in" rule and take the whole member row down with it.
-function isBlank(cell) {
-    return cell.trim() === '';
-}
-// Shares csvCellsForFields' column derivation, so a field is written, read, and offered
-// as a mapping target under one set of column names.
-export function csvColumnsForField(field) {
-    const column = `${PREFIX}${columnIdentity(field)}`;
-    const subFields = subFieldsOf(field.type);
-    return subFields
-        ? subFields.map((sub) => ({ column: `${column}${SEPARATOR}${sub}`, subField: sub }))
-        : [{ column, subField: null }];
-}
-export function isMetafieldColumn(column) {
-    return column === QUALIFIER || column.startsWith(PREFIX);
-}
-// A missing column and a column present but blank mean different things here, so
-// presence has to be detectable. The CSV parser only ever puts strings in these
-// cells, which makes "not a string" a reliable stand-in for "no such column".
-function cellFor(row, field, tail) {
-    const suffix = tail === null ? '' : `${SEPARATOR}${tail}`;
-    const cell = row[`${PREFIX}${columnIdentity(field)}${suffix}`];
-    return typeof cell === 'string' ? cell : undefined;
-}
-export function csvCellsForFields(fields, values) {
-    const cells = {};
-    for (const field of fields) {
-        const value = values[field.namespace]?.[field.key];
-        const subFields = subFieldsOf(field.type);
-        const column = `${PREFIX}${columnIdentity(field)}`;
-        if (!subFields) {
-            cells[column] = toCell(value);
-            continue;
-        }
-        const composite = (value ?? {});
-        for (const sub of subFields) {
-            cells[`${column}${SEPARATOR}${sub}`] = toCell(composite[sub]);
-        }
-    }
-    return cells;
-}
-/**
- * The inverse of `csvCellsForFields`: read a row's metafield cells into the values a
- * member write takes. Only the passed fields are read, so a column naming no active
- * field is dropped rather than erroring.
- *
- * `decodeCell` turns a raw cell into its value; it defaults to identity. The caller owns
- * any de-serialization the specific file needs — the members importer passes one that
- * strips the export's formula guard — so this stays pure vocabulary and holds no knowledge
- * of how any particular CSV escapes its cells.
- *
- * A field is written only from a non-blank cell; a blank or absent cell leaves the
- * existing value untouched, not cleared — matching how the importer keeps a blank name or
- * note, so re-importing a partly-filled export can't wipe values a publisher didn't
- * touch. A composite whose every cell is blank is omitted too, because the export writes
- * "no address" and an all-blank address identically; one with any filled cell is read
- * from its non-blank cells and validated whole (a malformed sub-field fails the row).
- * No sub-field is required, so a row carrying only some of an address reads as only
- * those sub-fields. A blank sub-field cell reads as no data for that sub-field, the
- * same way a blank cell reads as no data for a whole field.
- */
-export function fieldValuesFromCsvRow(fields, row, decodeCell = (cell) => cell) {
-    const values = {};
-    for (const field of fields) {
-        const subFields = subFieldsOf(field.type);
-        if (!subFields) {
-            const cell = cellFor(row, field, null);
-            if (cell !== undefined) {
-                const decoded = decodeCell(cell);
-                if (!isBlank(decoded)) {
-                    values[columnIdentity(field)] = decoded;
-                }
-            }
-            continue;
-        }
-        let anyColumnPresent = false;
-        const composite = {};
-        for (const sub of subFields) {
-            const cell = cellFor(row, field, sub);
-            if (cell === undefined) {
-                continue;
-            }
-            anyColumnPresent = true;
-            const decoded = decodeCell(cell);
-            if (!isBlank(decoded)) {
-                composite[sub] = decoded;
-            }
-        }
-        if (anyColumnPresent && Object.keys(composite).length > 0) {
-            values[columnIdentity(field)] = composite;
-        }
-    }
-    return values;
-}
-//# sourceMappingURL=csv.js.map

package/build/csv.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"csv.js","sourceRoot":"","sources":["../src/csv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAkB,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGrE;;;;;;;;;;;GAWG;AAEH,MAAM,MAAM,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;AAE1C,SAAS,cAAc,CAAC,KAAe;IACrC,OAAO,cAAc,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACxF,CAAC;AASD,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,wFAAwF;AACxF,uFAAuF;AACvF,uFAAuF;AACvF,6EAA6E;AAC7E,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AASD,wFAAwF;AACxF,qDAAqD;AACrD,MAAM,UAAU,kBAAkB,CAAC,KAAe;IAChD,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;IACnD,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,SAAS;QACd,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC3D,CAAC;AAED,iFAAiF;AACjF,gFAAgF;AAChF,8EAA8E;AAC9E,SAAS,OAAO,CACd,GAA4B,EAC5B,KAAe,EACf,IAAmB;IAEnB,MAAM,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,EAAE,CAAC;IAC1D,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC;IAC/D,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,MAA2B,EAC3B,MAA2D;IAE3D,MAAM,KAAK,GAA2B,EAAE,CAAC;IAEzC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAEnD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9B,SAAS;QACX,CAAC;QAED,MAAM,SAAS,GAAG,CAAC,KAAK,IAAI,EAAE,CAA4B,CAAC;QAC3D,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,KAAK,CAAC,GAAG,MAAM,GAAG,SAAS,GAAG,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAA2B,EAC3B,GAA4B,EAC5B,UAAU,GAA6B,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI;IAErD,MAAM,MAAM,GAAyC,EAAE,CAAC;IAExD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACvC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBACjC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBACtB,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC;gBAC1C,CAAC;YACH,CAAC;YACD,SAAS;QACX,CAAC;QAED,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAC7B,MAAM,SAAS,GAA2B,EAAE,CAAC;QAC7C,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YACtC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,SAAS;YACX,CAAC;YACD,gBAAgB,GAAG,IAAI,CAAC;YACxB,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtB,SAAS,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,IAAI,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1D,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}