@x12i/map-store-client 0.1.3 → 0.1.4

package/dist/estate/census.js

@@ -0,0 +1,266 @@
+/**
+ * Tier-0 census records. Three processes count published lander rows and each
+ * save one content record. They do not read AI products. They are not
+ * `estate-analytics` and they are not a bag total.
+ *
+ * One GET per board, after `working/bootstrap` has pinned the session:
+ * `security-map` / `tier0-analytics` / `working/{vulnerability,asset,estate}-census`.
+ * `data.kind` selects the record.
+ *
+ * `produced: true` and `value: 0` is a finished empty count.
+ * `produced: false` and `value: 0` means that source was not read.
+ * A missing field is the bucket `absent`. A missing KEV flag is `absent`, not `false`.
+ */
+import { asRecord } from '../util';
+import { contentData } from './content';
+import { objectIdBody } from './ids';
+export const EMPTY_VULNERABILITY_ROWS = [];
+export const EMPTY_ASSET_ROWS = [];
+export const TIER0_TARGETS = {
+    vulnerability: {
+        recordId: 'working/vulnerability-census',
+        kind: 'vulnerability-census',
+    },
+    asset: {
+        recordId: 'working/asset-census',
+        kind: 'asset-census',
+    },
+    estate: {
+        recordId: 'working/estate-census',
+        kind: 'estate-census',
+    },
+};
+const unproduced = () => ({ value: 0, produced: false });
+/** A figure the census has not produced is absent, not zero. */
+export function tier0Value(metric) {
+    if (!metric?.produced)
+        return null;
+    return metric.value;
+}
+export function publishedCount(value) {
+    return value == null ? '—' : value.toLocaleString();
+}
+/**
+ * List figure. A loaded census uses its own number, including a finished `0`.
+ * A missing row on a loaded census is unavailable.
+ * Before that document exists, the lander figure keeps the column from going blank.
+ */
+export function censusOrLander(censusReady, censusRow, censusValue, landerValue) {
+    if (!censusReady)
+        return landerValue ?? null;
+    if (!censusRow)
+        return null;
+    return censusValue ?? null;
+}
+function metricOf(value) {
+    const rec = asRecord(value);
+    if (!rec ||
+        typeof rec.produced !== 'boolean' ||
+        typeof rec.value !== 'number' ||
+        !Number.isFinite(rec.value)) {
+        return unproduced();
+    }
+    return { value: rec.value, produced: rec.produced };
+}
+function readMetric(source, key) {
+    if (!source || !Object.prototype.hasOwnProperty.call(source, key))
+        return unproduced();
+    return metricOf(source[key]);
+}
+/** A row count. A wrapped metric counts only when that metric was produced. */
+function countOf(value) {
+    if (typeof value === 'number' && Number.isFinite(value))
+        return value;
+    const rec = asRecord(value);
+    if (!rec || rec.produced !== true || typeof rec.value !== 'number' || !Number.isFinite(rec.value)) {
+        return null;
+    }
+    return rec.value;
+}
+function textOf(value) {
+    return typeof value === 'string' && value.trim() ? value.trim() : null;
+}
+function metricMap(value) {
+    const rec = asRecord(value);
+    if (!rec)
+        return null;
+    const out = {};
+    for (const [key, raw] of Object.entries(rec)) {
+        if (!key)
+            continue;
+        out[key] = metricOf(raw);
+    }
+    return out;
+}
+function groupsOf(value) {
+    const rec = asRecord(value);
+    if (!rec)
+        return {};
+    const out = {};
+    for (const [key, raw] of Object.entries(rec)) {
+        const buckets = metricMap(raw);
+        if (buckets)
+            out[key] = buckets;
+    }
+    return out;
+}
+function vulnerabilityRows(value) {
+    if (!Array.isArray(value))
+        return [];
+    const rows = [];
+    for (const item of value) {
+        const rec = asRecord(item);
+        const id = textOf(rec?.id);
+        if (!rec || !id)
+            continue;
+        rows.push({
+            id,
+            cveId: textOf(rec.cveId),
+            label: textOf(rec.label),
+            affectedAssets: countOf(rec.affectedAssets),
+            findings: countOf(rec.findings),
+        });
+    }
+    return rows;
+}
+function assetRows(value) {
+    if (!Array.isArray(value))
+        return [];
+    const rows = [];
+    for (const item of value) {
+        const rec = asRecord(item);
+        const id = textOf(rec?.id);
+        if (!rec || !id)
+            continue;
+        rows.push({
+            id,
+            label: textOf(rec.label),
+            findings: countOf(rec.findings),
+            distinctCves: countOf(rec.distinctCves),
+        });
+    }
+    return rows;
+}
+/** Parse one census body. A mismatched `data.kind` is not that board's record. */
+export function parseTier0Census(page, kind) {
+    const data = contentData(page);
+    if (!data || data.kind !== kind)
+        return null;
+    const totals = asRecord(data.totals);
+    const groups = groupsOf(data.groups);
+    if (kind === 'vulnerability-census') {
+        return {
+            kind,
+            totals: {
+                findings: readMetric(totals, 'findings'),
+                vulnerabilities: readMetric(totals, 'vulnerabilities'),
+                distinctCves: readMetric(totals, 'distinctCves'),
+            },
+            rows: vulnerabilityRows(data.rows),
+            groups,
+        };
+    }
+    if (kind === 'asset-census') {
+        return {
+            kind,
+            totals: {
+                assets: readMetric(totals, 'assets'),
+                findings: readMetric(totals, 'findings'),
+            },
+            rows: assetRows(data.rows),
+            groups,
+        };
+    }
+    const subjects = asRecord(totals?.subjects);
+    const bags = asRecord(totals?.bags);
+    return {
+        kind,
+        totals: {
+            subjects: {
+                endpointAssets: readMetric(subjects, 'endpointAssets'),
+                findings: readMetric(subjects, 'findings'),
+                alerts: readMetric(subjects, 'alerts'),
+                zones: readMetric(subjects, 'zones'),
+                devices: readMetric(subjects, 'devices'),
+                unresolvedSubjects: readMetric(subjects, 'unresolvedSubjects'),
+            },
+            bags: {
+                hypothesizedPaths: readMetric(bags, 'hypothesizedPaths'),
+                reachabilityClaims: readMetric(bags, 'reachabilityClaims'),
+            },
+        },
+        rows: [],
+        groups,
+    };
+}
+/** A missing record (404) or a content type the pack does not register. Any client error with `.status` qualifies. */
+function isAbsent(err) {
+    const status = err?.status;
+    if (typeof status !== 'number')
+        return false;
+    if (status === 404)
+        return true;
+    const error = asRecord(asRecord(err.body)?.error);
+    return status === 400 && error?.code === 'ROUTE_UNKNOWN_CONTENT_TYPE';
+}
+/**
+ * One client-API read of `security-map` / `tier0-analytics`.
+ * A missing record or an unregistered content type yields null.
+ */
+export async function loadTier0Census(client, board, signal) {
+    const target = TIER0_TARGETS[board];
+    try {
+        if (signal?.aborted)
+            return null;
+        const page = await client.getContent({
+            objectType: 'security-map',
+            contentType: 'tier0-analytics',
+            recordId: target.recordId,
+            discriminatorValue: target.kind,
+        });
+        if (signal?.aborted)
+            return null;
+        return parseTier0Census(page, target.kind);
+    }
+    catch (err) {
+        if (isAbsent(err))
+            return null;
+        console.warn(`tier0-analytics ${target.recordId} unavailable`, err);
+        return null;
+    }
+}
+/** Dialog lookup. `rows[].id` is the lander record id. */
+export function censusEntryById(rows, id) {
+    const want = id.trim();
+    if (!want)
+        return null;
+    const body = objectIdBody(want);
+    for (const row of rows) {
+        if (row.id === want || row.id === body || objectIdBody(row.id) === body)
+            return row;
+    }
+    return null;
+}
+/**
+ * CVE dialog join. The panel's key is the CVE text. Use the lander id when that
+ * id is the CVE, otherwise the single census row that publishes this `cveId`.
+ * Several rows for one CVE stay unresolved here. Each dialog still matches by id.
+ */
+export function vulnerabilityEntryForCve(rows, cveId) {
+    const direct = censusEntryById(rows, cveId);
+    if (direct)
+        return direct;
+    const key = cveId.trim().toUpperCase();
+    if (!key)
+        return null;
+    let hit = null;
+    for (const row of rows) {
+        if ((row.cveId ?? '').toUpperCase() !== key)
+            continue;
+        if (hit)
+            return null;
+        hit = row;
+    }
+    return hit;
+}
+//# sourceMappingURL=census.js.map

package/dist/estate/census.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"census.js","sourceRoot":"","sources":["../../src/estate/census.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAgErC,MAAM,CAAC,MAAM,wBAAwB,GAA6B,EAAE,CAAC;AACrE,MAAM,CAAC,MAAM,gBAAgB,GAAqB,EAAE,CAAC;AAIrD,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,aAAa,EAAE;QACb,QAAQ,EAAE,8BAA8B;QACxC,IAAI,EAAE,sBAAsB;KAC7B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,cAAc;KACrB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,eAAe;KACtB;CACO,CAAC;AAEX,MAAM,UAAU,GAAG,GAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;AAEtE,gEAAgE;AAChE,MAAM,UAAU,UAAU,CAAC,MAA+B;IACxD,IAAI,CAAC,MAAM,EAAE,QAAQ;QAAE,OAAO,IAAI,CAAC;IACnC,OAAO,MAAM,CAAC,KAAK,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAgC;IAC7D,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;AACtD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,WAAoB,EACpB,SAAwB,EACxB,WAAsC,EACtC,WAAsC;IAEtC,IAAI,CAAC,WAAW;QAAE,OAAO,WAAW,IAAI,IAAI,CAAC;IAC7C,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IAC5B,OAAO,WAAW,IAAI,IAAI,CAAC;AAC7B,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,IACE,CAAC,GAAG;QACJ,OAAO,GAAG,CAAC,QAAQ,KAAK,SAAS;QACjC,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ;QAC7B,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAC3B,CAAC;QACD,OAAO,UAAU,EAAE,CAAC;IACtB,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;AACtD,CAAC;AAED,SAAS,UAAU,CAAC,MAAsC,EAAE,GAAW;IACrE,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;QAAE,OAAO,UAAU,EAAE,CAAC;IACvF,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/B,CAAC;AAED,+EAA+E;AAC/E,SAAS,OAAO,CAAC,KAAc;IAC7B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACtE,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC,KAAK,CAAC;AACnB,CAAC;AAED,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACzE,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,MAAM,GAAG,GAAc,EAAE,CAAC;IAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,GAAG;YAAE,SAAS;QACnB,GAAG,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC;IACpB,MAAM,GAAG,GAA8B,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,OAAO;YAAE,GAAG,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IAClC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACrC,MAAM,IAAI,GAA6B,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3B,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE;YAAE,SAAS;QAC1B,IAAI,CAAC,IAAI,CAAC;YACR,EAAE;YACF,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;YACxB,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAC3C,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;SAChC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACrC,MAAM,IAAI,GAAqB,EAAE,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3B,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE;YAAE,SAAS;QAC1B,IAAI,CAAC,IAAI,CAAC;YACR,EAAE;YACF,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;YACxB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC/B,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;SACxC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,gBAAgB,CAAC,IAAa,EAAE,IAAyB;IACvE,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,IAAI,KAAK,sBAAsB,EAAE,CAAC;QACpC,OAAO;YACL,IAAI;YACJ,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;gBACxC,eAAe,EAAE,UAAU,CAAC,MAAM,EAAE,iBAAiB,CAAC;gBACtD,YAAY,EAAE,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC;aACjD;YACD,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;YAClC,MAAM;SACP,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;QAC5B,OAAO;YACL,IAAI;YACJ,MAAM,EAAE;gBACN,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC;gBACpC,QAAQ,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;aACzC;YACD,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,MAAM;SACP,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACpC,OAAO;QACL,IAAI;QACJ,MAAM,EAAE;YACN,QAAQ,EAAE;gBACR,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE,gBAAgB,CAAC;gBACtD,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC;gBAC1C,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC;gBACtC,KAAK,EAAE,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC;gBACpC,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC;gBACxC,kBAAkB,EAAE,UAAU,CAAC,QAAQ,EAAE,oBAAoB,CAAC;aAC/D;YACD,IAAI,EAAE;gBACJ,iBAAiB,EAAE,UAAU,CAAC,IAAI,EAAE,mBAAmB,CAAC;gBACxD,kBAAkB,EAAE,UAAU,CAAC,IAAI,EAAE,oBAAoB,CAAC;aAC3D;SACF;QACD,IAAI,EAAE,EAAE;QACR,MAAM;KACP,CAAC;AACJ,CAAC;AAED,sHAAsH;AACtH,SAAS,QAAQ,CAAC,GAAY;IAC5B,MAAM,MAAM,GAAI,GAAmC,EAAE,MAAM,CAAC;IAC5D,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAE,GAA0B,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1E,OAAO,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,IAAI,KAAK,4BAA4B,CAAC;AACxE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAkB,EAClB,KAAmB,EACnB,MAAoB;IAEpB,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,IAAI,CAAC;QACH,IAAI,MAAM,EAAE,OAAO;YAAE,OAAO,IAAI,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC;YACnC,UAAU,EAAE,cAAc;YAC1B,WAAW,EAAE,iBAAiB;YAC9B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,kBAAkB,EAAE,MAAM,CAAC,IAAI;SAChC,CAAC,CAAC;QACH,IAAI,MAAM,EAAE,OAAO;YAAE,OAAO,IAAI,CAAC;QACjC,OAAO,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,mBAAmB,MAAM,CAAC,QAAQ,cAAc,EAAE,GAAG,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,eAAe,CAA2B,IAAkB,EAAE,EAAU;IACtF,MAAM,IAAI,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;IACvB,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAChC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,EAAE,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,KAAK,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,IAAI;YAAE,OAAO,GAAG,CAAC;IACtF,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,IAAuC,EACvC,KAAa;IAEb,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5C,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACvC,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,IAAI,GAAG,GAAkC,IAAI,CAAC;IAC9C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG;YAAE,SAAS;QACtD,IAAI,GAAG;YAAE,OAAO,IAAI,CAAC;QACrB,GAAG,GAAG,GAAG,CAAC;IACZ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/estate/client.d.ts

@@ -0,0 +1,66 @@
+/**
+ * The slice of `@x12i/memorix-client-api-client` these reads use.
+ * Pass the client you already build with `createMemorixReadClient`. Any object with these
+ * methods works, so this package does not depend on the Memorix client.
+ *
+ * The browser reaches it through the app proxy (this repo proxies `/memorix-client`).
+ * These reads never call Memorix itself.
+ */
+export type ContentFilter = {
+    field: string;
+    op: 'eq';
+    value: string | number | boolean;
+} | {
+    field: string;
+    op: 'exists';
+    value: true;
+};
+/** Arguments of `data.listContent` and `data.getContent`. */
+export type ContentRead = {
+    objectType: string;
+    contentType: string;
+    recordId?: string;
+    discriminatorValue?: string;
+    filter?: ContentFilter[];
+    limit?: number;
+    cursor?: string;
+    include?: {
+        markdown?: boolean;
+    };
+};
+/** `data` on the Memorix read client. */
+export interface EstateData {
+    listContent(query: ContentRead): Promise<unknown>;
+    getContent(query: ContentRead): Promise<unknown>;
+    readStory(query: {
+        objectType: string;
+        recordId: string;
+        template: string;
+    }): Promise<unknown>;
+}
+/** One story function from `functions(objectType)`. */
+export type ObjectTypeFunction = {
+    id: string;
+    template?: string | null;
+    question?: string | null;
+    pageStory?: boolean;
+};
+/** Catalog and record reads on the Memorix read client. */
+export interface EstateCatalog {
+    functions(objectType: string): Promise<ObjectTypeFunction[]>;
+    getContentType(objectType: string, contentType: string): Promise<unknown>;
+    listContentTypes(objectType: string): Promise<unknown>;
+    listRecords(objectType: string, query: {
+        filter?: {
+            recordId: string;
+        };
+        limit?: number;
+        representation?: string;
+    }): Promise<unknown>;
+    listRecordContentTypes(recordId: string): Promise<unknown>;
+}
+/** `analytics` on the Memorix read client. */
+export interface EstateAnalyticsApi {
+    sourceCensus(): Promise<unknown>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/estate/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/estate/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,MAAM,aAAa,GACrB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;CAAE,GAC7D;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,CAAC;AAEjD,6DAA6D;AAC7D,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAClC,CAAC;AAEF,yCAAyC;AACzC,MAAM,WAAW,UAAU;IACzB,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,SAAS,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAChG;AAED,uDAAuD;AACvD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,2DAA2D;AAC3D,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAC7D,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1E,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE;QAAE,MAAM,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GAChF,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5D;AAED,8CAA8C;AAC9C,MAAM,WAAW,kBAAkB;IACjC,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAClC"}

package/dist/estate/client.js

@@ -0,0 +1,10 @@
+/**
+ * The slice of `@x12i/memorix-client-api-client` these reads use.
+ * Pass the client you already build with `createMemorixReadClient`. Any object with these
+ * methods works, so this package does not depend on the Memorix client.
+ *
+ * The browser reaches it through the app proxy (this repo proxies `/memorix-client`).
+ * These reads never call Memorix itself.
+ */
+export {};
+//# sourceMappingURL=client.js.map

package/dist/estate/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/estate/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/dist/estate/content.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Memorix content reads behind the lists.
+ * Business fields live on `record.data`. Narrative text lives on `_markdown.content`.
+ * The scope reason lives on the envelope `_metadata`, so each row carries it out.
+ */
+import type { ContentFilter, EstateCatalog, EstateData } from './client';
+export type ContentData = Record<string, unknown>;
+/** A Memorix document envelope. Its facts are `data`, never the envelope itself. */
+export declare function isDocumentEnvelope(value: Record<string, unknown>): boolean;
+/**
+ * Business fields. Prefer `record.data` or `page.data`.
+ * An envelope without `data` is not facts. A flat body that is not an envelope still is.
+ */
+export declare function contentData(page: unknown): ContentData | null;
+/** `_markdown.content` on a record or a `{ record }` page. Empty when the head has none. */
+export declare function documentMarkdown(page: unknown): string | null;
+/**
+ * Envelope `_metadata.scopeReason`, for example `OUTSIDE_SNAPSHOT`.
+ * It is not a field inside `data`, so list reads lose it unless it is copied out.
+ */
+export declare function readScopeReason(envelope: unknown): string | null;
+export type ContentRow = {
+    recordId: string;
+    data: ContentData;
+    markdown: string | null;
+    /** `_metadata.scopeReason` from the envelope. Null when the record carries none. */
+    scopeReason: string | null;
+};
+export type ListContentInput = {
+    objectType: string;
+    contentType: string;
+    filter?: ContentFilter[];
+    /** Ask for `_markdown`. The analysis pages do. Table lists do not. */
+    includeMarkdown?: boolean;
+    /** Pages of `pageSize` to follow. Defaults to 20. */
+    maxPages?: number;
+    /** Defaults to 200. */
+    pageSize?: number;
+};
+/**
+ * Every record of one content type on one object type, following `pageInfo.nextCursor`.
+ * A 404, or a content type the pack does not register, is an empty list.
+ * Anything else is thrown.
+ */
+export declare function listContent(client: EstateData, input: ListContentInput): Promise<ContentRow[]>;
+export type ReadContentInput = {
+    objectType: string;
+    contentType: string;
+    recordId: string;
+    includeMarkdown?: boolean;
+};
+/**
+ * One record. Names the discriminator instance when the pack marks it required.
+ * A miss is null, not evidence that processing has not run.
+ */
+export declare function readContent(data: EstateData, catalog: EstateCatalog, input: ReadContentInput): Promise<ContentRow | null>;
+export type RecordContentInput = ReadContentInput & {
+    /**
+     * Ask for one instance, for example `{ field: 'decisionType', value: 'asset-triage' }`.
+     * Without one, a required discriminator is matched with `exists` so every instance comes back.
+     */
+    discriminator?: {
+        field: string;
+        value: string;
+    };
+};
+/**
+ * Every sibling of one content type on one record.
+ * `getContent` answers 404 when several records share the id, so this lists with a filter instead.
+ */
+export declare function listRecordContent(data: EstateData, catalog: EstateCatalog, input: RecordContentInput): Promise<ContentRow[]>;
+/**
+ * `data.displayName` on the inventory row for this subject.
+ * One `listContent` of `inventory` filtered by record id. Null when the row has no name.
+ */
+export declare function inventoryDisplayName(client: EstateData, objectType: string, recordId: string): Promise<string | null>;
+//# sourceMappingURL=content.d.ts.map

package/dist/estate/content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/estate/content.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAe,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAkBlD,oFAAoF;AACpF,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAE1E;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,IAAI,CAS7D;AAED,4FAA4F;AAC5F,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAO7D;AASD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAQhE;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,oFAAoF;IACpF,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AA0BF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,sEAAsE;IACtE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CA2BpG;AAWD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAuB5B;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD;;;OAGG;IACH,aAAa,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAClD,CAAC;AAEF;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,UAAU,EAAE,CAAC,CAoBvB;AAID;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAexB"}

package/dist/estate/content.js

@@ -0,0 +1,226 @@
+/**
+ * Memorix content reads behind the lists.
+ * Business fields live on `record.data`. Narrative text lives on `_markdown.content`.
+ * The scope reason lives on the envelope `_metadata`, so each row carries it out.
+ */
+import { requiredDiscriminator } from './pack';
+function asRecord(value) {
+    return value && typeof value === 'object' && !Array.isArray(value)
+        ? value
+        : null;
+}
+function asList(value) {
+    return Array.isArray(value) ? value : [];
+}
+function text(value) {
+    if (typeof value === 'string')
+        return value.trim() || null;
+    if (typeof value === 'number' || typeof value === 'boolean')
+        return String(value);
+    return null;
+}
+/** A Memorix document envelope. Its facts are `data`, never the envelope itself. */
+export function isDocumentEnvelope(value) {
+    return value.format === 'memorix-record/2' || '_system' in value || '_markdown' in value;
+}
+/**
+ * Business fields. Prefer `record.data` or `page.data`.
+ * An envelope without `data` is not facts. A flat body that is not an envelope still is.
+ */
+export function contentData(page) {
+    const top = asRecord(page);
+    if (!top)
+        return null;
+    const record = asRecord(top.record);
+    const nested = asRecord(record?.data) ?? asRecord(top.data);
+    if (nested)
+        return nested;
+    if (record)
+        return isDocumentEnvelope(record) ? null : record;
+    if (isDocumentEnvelope(top))
+        return null;
+    return top;
+}
+/** `_markdown.content` on a record or a `{ record }` page. Empty when the head has none. */
+export function documentMarkdown(page) {
+    const top = asRecord(page);
+    if (!top)
+        return null;
+    const record = asRecord(top.record) ?? top;
+    const markdown = asRecord(record._markdown);
+    const content = typeof markdown?.content === 'string' ? markdown.content.trim() : '';
+    return content || null;
+}
+function responseToken(value) {
+    return String(value ?? '')
+        .trim()
+        .toUpperCase()
+        .replace(/[\s-]+/g, '_');
+}
+/**
+ * Envelope `_metadata.scopeReason`, for example `OUTSIDE_SNAPSHOT`.
+ * It is not a field inside `data`, so list reads lose it unless it is copied out.
+ */
+export function readScopeReason(envelope) {
+    const top = asRecord(envelope);
+    if (!top)
+        return null;
+    const from = (value) => {
+        const reason = responseToken(asRecord(asRecord(value)?._metadata)?.scopeReason);
+        return reason || null;
+    };
+    return from(top) ?? from(top.record) ?? from(top.data) ?? null;
+}
+function rowsFrom(page) {
+    const top = asRecord(page);
+    const list = asList(top?.records ?? top?.items ?? top?.data ?? top?.content ?? page);
+    return list.flatMap((raw) => {
+        const rec = asRecord(raw);
+        if (!rec)
+            return [];
+        const inner = asRecord(rec.record) ?? rec;
+        const data = contentData(inner);
+        const recordId = text(inner.recordId) ?? text(inner.id) ?? text(rec.recordId) ?? text(rec.id);
+        if (!data || !recordId)
+            return [];
+        return [{
+                recordId,
+                data,
+                markdown: documentMarkdown(inner),
+                scopeReason: readScopeReason(inner) ?? readScopeReason(rec),
+            }];
+    });
+}
+function nextCursor(page) {
+    const top = asRecord(page);
+    return text(asRecord(top?.pageInfo)?.nextCursor) ?? text(top?.nextCursor);
+}
+/**
+ * Every record of one content type on one object type, following `pageInfo.nextCursor`.
+ * A 404, or a content type the pack does not register, is an empty list.
+ * Anything else is thrown.
+ */
+export async function listContent(client, input) {
+    const rows = [];
+    const pageSize = input.pageSize ?? 200;
+    const maxPages = input.maxPages ?? 20;
+    let cursor;
+    for (let page = 0; page < maxPages; page += 1) {
+        const query = {
+            objectType: input.objectType,
+            contentType: input.contentType,
+            limit: pageSize,
+            cursor,
+            filter: input.filter,
+            include: input.includeMarkdown ? { markdown: true } : undefined,
+        };
+        let res;
+        try {
+            res = await client.listContent(query);
+        }
+        catch (err) {
+            if (isUnregistered(err))
+                return rows;
+            throw err;
+        }
+        rows.push(...rowsFrom(res));
+        const next = nextCursor(res);
+        if (!next)
+            break;
+        cursor = next;
+    }
+    return rows;
+}
+/** A pack that does not register this content type, or a record that does not exist. */
+function isUnregistered(err) {
+    const status = err?.status;
+    if (status === 404)
+        return true;
+    if (status !== 400)
+        return false;
+    const code = asRecord(asRecord(err.body)?.error)?.code;
+    return typeof code === 'string' && code.startsWith('ROUTE_UNKNOWN');
+}
+/**
+ * One record. Names the discriminator instance when the pack marks it required.
+ * A miss is null, not evidence that processing has not run.
+ */
+export async function readContent(data, catalog, input) {
+    const required = await requiredDiscriminator(catalog, input.objectType, input.contentType);
+    let page;
+    try {
+        page = await data.getContent({
+            objectType: input.objectType,
+            contentType: input.contentType,
+            recordId: input.recordId,
+            discriminatorValue: required?.single ?? undefined,
+            include: input.includeMarkdown ? { markdown: true } : undefined,
+        });
+    }
+    catch (err) {
+        if (isUnregistered(err))
+            return null;
+        throw err;
+    }
+    const body = contentData(page);
+    if (!body)
+        return null;
+    return {
+        recordId: input.recordId,
+        data: body,
+        markdown: input.includeMarkdown ? documentMarkdown(page) : null,
+        scopeReason: readScopeReason(page),
+    };
+}
+/**
+ * Every sibling of one content type on one record.
+ * `getContent` answers 404 when several records share the id, so this lists with a filter instead.
+ */
+export async function listRecordContent(data, catalog, input) {
+    if (!input.recordId)
+        return [];
+    const filter = [{ field: 'recordId', op: 'eq', value: input.recordId }];
+    if (input.discriminator) {
+        filter.push({ field: `data.${input.discriminator.field}`, op: 'eq', value: input.discriminator.value });
+    }
+    else {
+        const required = await requiredDiscriminator(catalog, input.objectType, input.contentType);
+        if (required)
+            filter.push({ field: required.path, op: 'exists', value: true });
+    }
+    const rows = await listContent(data, {
+        objectType: input.objectType,
+        contentType: input.contentType,
+        filter,
+        includeMarkdown: input.includeMarkdown,
+        maxPages: 1,
+        pageSize: 20,
+    });
+    if (!input.discriminator)
+        return rows;
+    const { field, value } = input.discriminator;
+    return rows.filter((row) => String(row.data[field] ?? '') === value);
+}
+const names = new Map();
+/**
+ * `data.displayName` on the inventory row for this subject.
+ * One `listContent` of `inventory` filtered by record id. Null when the row has no name.
+ */
+export function inventoryDisplayName(client, objectType, recordId) {
+    const key = `${objectType}\u0000${recordId}`;
+    const hit = names.get(key);
+    if (hit)
+        return hit;
+    const pending = listContent(client, {
+        objectType,
+        contentType: 'inventory',
+        filter: [{ field: 'recordId', op: 'eq', value: recordId }],
+        maxPages: 1,
+        pageSize: 2,
+    })
+        .then((rows) => text(rows.find((row) => row.recordId === recordId)?.data.displayName))
+        .catch(() => null);
+    names.set(key, pending);
+    return pending;
+}
+//# sourceMappingURL=content.js.map