@concordance-wiki/typing 0.1.0

package/README.md

@@ -0,0 +1,7 @@
+# @concordance-wiki/typing
+
+Type cascade, identifiers, application and domain resolution.
+
+Today: `resolveType` runs the type cascade of one markdown file, in increasing precedence the source's `default_type`, the source's `type`, the typing rules in order (`path` glob, `suffix`, `ext`, `frontmatter` criteria, every criterion of a rule required, the last match wins) and the frontmatter `type`; it records the origin (`source`, `rule#3`, `suffix`, `frontmatter`), the attribute defaults set by the matching rules, `E-TYPE-CONFLICT` when the frontmatter contradicts a suffix rule (the frontmatter is kept) and `W-TYPE-UNKNOWN` when the profile does not declare the type (the note becomes a `document`). `buildEntity` turns one ingested and parsed file into an `Entity`: deterministic identifier, title (frontmatter, H1, file name), aliases, status, summary (frontmatter, first paragraph), the frontmatter attributes over the rule defaults with `W-ATTRIBUTE-UNKNOWN` for the keys the type and the common attributes do not declare, the source location, the type origin and `graph` (`documents-only` for the types the profile marks so, `document` and `meeting` by default). `compileDomains` flattens the `domains` tree of the configuration into id paths (`inference/recognition`) with one glob matcher each, and `resolveDomain` files one path under the frontmatter `domain` (by id or id path; an unknown value is kept as written and marked undeclared), else under the deepest domain whose globs match the source-relative path (the last declared wins at equal depth), else under `unclassified`. `resolveApplication` takes the frontmatter `application`, else a rule's `set.application`, else the source's `application`, and says whether `applications:` declares it. `buildEntity` records both on the entity and `filingFindings` reports `W-APP-MISSING`, `W-APP-UNKNOWN`, `W-DOMAIN-UNCLASSIFIED` and `W-DOMAIN-UNKNOWN`, the first and the third never for the container types (applications and domains as notes). `typeSources` does it for every parsed markdown file of the ingested sources, resolves duplicate identifiers (`E-ID-DUP`) and returns entities and findings in canonical order.
+
+Part of [Concordance](../../README.md).

package/dist/application.d.ts

@@ -0,0 +1,19 @@
+import type { ApplicationConfig, SourceConfig } from "@concordance-wiki/core";
+export interface ResolveApplicationInput {
+    source: SourceConfig;
+    /** Attribute values set by the matching typing rules; `application` is the one read here. */
+    ruleDefaults: Record<string, unknown>;
+    frontmatterApplication: unknown;
+    applications: readonly ApplicationConfig[];
+}
+export type ApplicationOrigin = "frontmatter" | "rule" | "source" | "none";
+export interface ResolvedApplication {
+    /** Absent when nothing sets it: the entity then yields `W-APP-MISSING`. */
+    application?: string;
+    origin: ApplicationOrigin;
+    /** True when `applications:` declares the resolved identifier; false when nothing sets it. */
+    declared: boolean;
+}
+/** Decreasing precedence: the frontmatter `application`, a rule's `set.application`, the source's `application`. */
+export declare function resolveApplication(input: ResolveApplicationInput): ResolvedApplication;
+//# sourceMappingURL=application.d.ts.map

package/dist/application.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../src/application.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAI9E,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,YAAY,CAAC;IACrB,6FAA6F;IAC7F,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,sBAAsB,EAAE,OAAO,CAAC;IAChC,YAAY,EAAE,SAAS,iBAAiB,EAAE,CAAC;CAC5C;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE3E,MAAM,WAAW,mBAAmB;IAClC,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,8FAA8F;IAC9F,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,oHAAoH;AACpH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,mBAAmB,CAatF"}

package/dist/application.js

@@ -0,0 +1,18 @@
+import { declaredString } from "./frontmatter.js";
+/** Decreasing precedence: the frontmatter `application`, a rule's `set.application`, the source's `application`. */
+export function resolveApplication(input) {
+    const { source, ruleDefaults, frontmatterApplication, applications } = input;
+    const steps = [
+        [declaredString(frontmatterApplication), "frontmatter"],
+        [declaredString(ruleDefaults["application"]), "rule"],
+        [source.application, "source"],
+    ];
+    for (const [application, origin] of steps) {
+        if (application === undefined)
+            continue;
+        const declared = applications.some((candidate) => candidate.id === application);
+        return { application, origin, declared };
+    }
+    return { origin: "none", declared: false };
+}
+//# sourceMappingURL=application.js.map

package/dist/application.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../src/application.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAoBlD,oHAAoH;AACpH,MAAM,UAAU,kBAAkB,CAAC,KAA8B;IAC/D,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,sBAAsB,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;IAC7E,MAAM,KAAK,GAA8C;QACvD,CAAC,cAAc,CAAC,sBAAsB,CAAC,EAAE,aAAa,CAAC;QACvD,CAAC,cAAc,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC;QACrD,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC;KAC/B,CAAC;IACF,KAAK,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QAC1C,IAAI,WAAW,KAAK,SAAS;YAAE,SAAS;QACxC,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;QAChF,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC3C,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC7C,CAAC"}

package/dist/cascade.d.ts

@@ -0,0 +1,26 @@
+import { type Finding, type SourceConfig, type TypeOrigin, type TypingRuleMatch } from "@concordance-wiki/core";
+import type { Profile } from "@concordance-wiki/profile";
+/** The type every markdown file gets when neither the source nor a rule nor the frontmatter says otherwise. */
+export declare const FALLBACK_TYPE = "document";
+export interface ResolveTypeInput {
+    source: SourceConfig;
+    /** Forward-slash path relative to the source root. */
+    path: string;
+    frontmatter: Record<string, unknown>;
+    profile: Profile;
+}
+export interface ResolvedType {
+    type: string;
+    origin: TypeOrigin;
+    /** Attribute values set by the matching rules, `type` excluded; the frontmatter overrides them. */
+    defaults: Record<string, unknown>;
+    findings: Finding[];
+}
+/** Every criterion of a rule must hold; a rule always has at least one, the configuration schema says so. */
+export declare function ruleMatches(match: TypingRuleMatch, path: string, frontmatter: Record<string, unknown>): boolean;
+/**
+ * Increasing precedence: the source's `default_type`, the source's `type`, the rules in order
+ * (the last match wins), then the frontmatter.
+ */
+export declare function resolveType(input: ResolveTypeInput): ResolvedType;
+//# sourceMappingURL=cascade.d.ts.map

package/dist/cascade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cascade.d.ts","sourceRoot":"","sources":["../src/cascade.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,UAAU,EAEf,KAAK,eAAe,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAIzD,+GAA+G;AAC/G,eAAO,MAAM,aAAa,aAAa,CAAC;AAExC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,YAAY,CAAC;IACrB,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,mGAAmG;IACnG,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAOD,6GAA6G;AAC7G,wBAAgB,WAAW,CACzB,KAAK,EAAE,eAAe,EACtB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,OAAO,CAKT;AAgCD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,YAAY,CA8BjE"}

package/dist/cascade.js

@@ -0,0 +1,78 @@
+import { compileGlobs, } from "@concordance-wiki/core";
+import { declaredString } from "./frontmatter.js";
+/** The type every markdown file gets when neither the source nor a rule nor the frontmatter says otherwise. */
+export const FALLBACK_TYPE = "document";
+/** Every criterion of a rule must hold; a rule always has at least one, the configuration schema says so. */
+export function ruleMatches(match, path, frontmatter) {
+    if (match.path !== undefined && !compileGlobs([match.path])(path))
+        return false;
+    if (match.suffix !== undefined && !path.endsWith(match.suffix))
+        return false;
+    if (match.ext !== undefined && !match.ext.some((ext) => path.endsWith(ext)))
+        return false;
+    return match.frontmatter === undefined || Object.hasOwn(frontmatter, match.frontmatter);
+}
+function ruleOrigin(rule, index) {
+    if (rule.match.suffix !== undefined)
+        return "suffix";
+    // A 1-based decimal position always satisfies the `rule#<digits>` member of TypeOrigin.
+    return `rule#${String(index + 1)}`;
+}
+function typeConflict(input, bySuffix, byFrontmatter) {
+    return {
+        check: "E-TYPE-CONFLICT",
+        severity: "error",
+        source: input.source.name,
+        path: input.path,
+        message: `frontmatter type "${byFrontmatter}" of ${input.path} contradicts the type "${bySuffix}" given by the file suffix; the frontmatter is kept`,
+        remediation: "Align the frontmatter type with the suffix, or drop the type key and let the filing convention decide.",
+    };
+}
+function typeUnknown(input, type, origin) {
+    return {
+        check: "W-TYPE-UNKNOWN",
+        severity: "warning",
+        source: input.source.name,
+        path: input.path,
+        message: `type "${type}" of ${input.path} (from ${origin}) is not declared by the profile; the note is treated as a ${FALLBACK_TYPE}`,
+        remediation: "Use a type of the profile, declare the type in the project profile, or fix the source rule or the frontmatter that sets it.",
+    };
+}
+/**
+ * Increasing precedence: the source's `default_type`, the source's `type`, the rules in order
+ * (the last match wins), then the frontmatter.
+ */
+export function resolveType(input) {
+    const { source, path, frontmatter, profile } = input;
+    const findings = [];
+    const defaults = {};
+    let step = { type: source.default_type ?? FALLBACK_TYPE, origin: "source" };
+    if (source.type !== undefined) {
+        step = { type: source.type, origin: "source" };
+    }
+    (source.rules ?? []).forEach((rule, index) => {
+        if (!ruleMatches(rule.match, path, frontmatter))
+            return;
+        for (const [key, value] of Object.entries(rule.set)) {
+            if (key === "type") {
+                step = { type: String(value), origin: ruleOrigin(rule, index) };
+            }
+            else {
+                defaults[key] = value;
+            }
+        }
+    });
+    const type = declaredString(frontmatter["type"]);
+    if (type !== undefined) {
+        if (step.origin === "suffix" && type !== step.type) {
+            findings.push(typeConflict(input, step.type, type));
+        }
+        step = { type, origin: "frontmatter" };
+    }
+    if (!Object.hasOwn(profile.types, step.type)) {
+        findings.push(typeUnknown(input, step.type, step.origin));
+        step = { type: FALLBACK_TYPE, origin: step.origin };
+    }
+    return { type: step.type, origin: step.origin, defaults, findings };
+}
+//# sourceMappingURL=cascade.js.map

package/dist/cascade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cascade.js","sourceRoot":"","sources":["../src/cascade.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,GAMb,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,+GAA+G;AAC/G,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAuBxC,6GAA6G;AAC7G,MAAM,UAAU,WAAW,CACzB,KAAsB,EACtB,IAAY,EACZ,WAAoC;IAEpC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAChF,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7E,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1F,OAAO,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1F,CAAC;AAED,SAAS,UAAU,CAAC,IAAgB,EAAE,KAAa;IACjD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACrD,wFAAwF;IACxF,OAAO,QAAQ,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,EAAgB,CAAC;AACnD,CAAC;AAED,SAAS,YAAY,CAAC,KAAuB,EAAE,QAAgB,EAAE,aAAqB;IACpF,OAAO;QACL,KAAK,EAAE,iBAAiB;QACxB,QAAQ,EAAE,OAAO;QACjB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;QACzB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,qBAAqB,aAAa,QAAQ,KAAK,CAAC,IAAI,0BAA0B,QAAQ,qDAAqD;QACpJ,WAAW,EACT,wGAAwG;KAC3G,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAuB,EAAE,IAAY,EAAE,MAAkB;IAC5E,OAAO;QACL,KAAK,EAAE,gBAAgB;QACvB,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;QACzB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,SAAS,IAAI,QAAQ,KAAK,CAAC,IAAI,UAAU,MAAM,8DAA8D,aAAa,EAAE;QACrI,WAAW,EACT,6HAA6H;KAChI,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IACrD,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAA4B,EAAE,CAAC;IAC7C,IAAI,IAAI,GAAS,EAAE,IAAI,EAAE,MAAM,CAAC,YAAY,IAAI,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAClF,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IACjD,CAAC;IACD,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC;YAAE,OAAO;QACxD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACpD,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;gBACnB,IAAI,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACnD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;IACzC,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1D,IAAI,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IACtD,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AACtE,CAAC"}

package/dist/domains.d.ts

@@ -0,0 +1,33 @@
+import { type DomainConfig, type PathMatcher } from "@concordance-wiki/core";
+/** The domain of every note that no declared domain claims. */
+export declare const UNCLASSIFIED_DOMAIN = "unclassified";
+export interface CompiledDomain {
+    id: string;
+    /** The identifiers from the root domain down to this one, `inference/recognition` style. */
+    path: string;
+    /** Zero for a root domain. */
+    depth: number;
+    matcher: PathMatcher;
+    /** True when the domain declares at least one glob. */
+    globs: boolean;
+    /** The name of the folder that claims files, absent for a domain declared by globs or frontmatter alone. */
+    folder?: string;
+    parent?: CompiledDomain;
+}
+/** The domain tree flattened in declaration order, each parent before its subdomains. */
+export type DomainMatcher = readonly CompiledDomain[];
+export type DomainOrigin = "frontmatter" | "folder" | "glob" | "unclassified";
+export interface ResolvedDomain {
+    /** The full identifier path of the domain, or `unclassified`. */
+    domain: string;
+    origin: DomainOrigin;
+    /** False only for a frontmatter domain that no declared domain answers to. */
+    declared: boolean;
+}
+export declare function compileDomains(domains: readonly DomainConfig[]): DomainMatcher;
+/**
+ * Decreasing precedence: the frontmatter `domain`, the folders and globs evaluated on the
+ * source-relative path, then `unclassified`.
+ */
+export declare function resolveDomain(relativePath: string, frontmatterDomain: unknown, domains: DomainMatcher): ResolvedDomain;
+//# sourceMappingURL=domains.d.ts.map

package/dist/domains.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"domains.d.ts","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAI3F,+DAA+D;AAC/D,eAAO,MAAM,mBAAmB,iBAAiB,CAAC;AAElD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,CAAC;IACrB,uDAAuD;IACvD,KAAK,EAAE,OAAO,CAAC;IACf,4GAA4G;IAC5G,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,yFAAyF;AACzF,MAAM,MAAM,aAAa,GAAG,SAAS,cAAc,EAAE,CAAC;AAEtD,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,cAAc,CAAC;AAE9E,MAAM,WAAW,cAAc;IAC7B,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,8EAA8E;IAC9E,QAAQ,EAAE,OAAO,CAAC;CACnB;AA8BD,wBAAgB,cAAc,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,GAAG,aAAa,CAE9E;AAgED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,YAAY,EAAE,MAAM,EACpB,iBAAiB,EAAE,OAAO,EAC1B,OAAO,EAAE,aAAa,GACrB,cAAc,CAYhB"}

package/dist/domains.js

@@ -0,0 +1,96 @@
+import { compileGlobs } from "@concordance-wiki/core";
+import { declaredString } from "./frontmatter.js";
+/** The domain of every note that no declared domain claims. */
+export const UNCLASSIFIED_DOMAIN = "unclassified";
+function folderOf(domain) {
+    if (domain.folder === true)
+        return domain.id;
+    if (typeof domain.folder === "string")
+        return domain.folder;
+    return undefined;
+}
+function flatten(domains, parent, depth) {
+    return domains.flatMap((domain) => {
+        const path = parent === undefined ? domain.id : `${parent.path}/${domain.id}`;
+        const globs = domain.match ?? [];
+        const folder = folderOf(domain);
+        const compiled = {
+            id: domain.id,
+            path,
+            depth,
+            matcher: compileGlobs(globs),
+            globs: globs.length > 0,
+            ...(folder === undefined ? {} : { folder }),
+            ...(parent === undefined ? {} : { parent }),
+        };
+        return [compiled, ...flatten(domain.subdomains ?? [], compiled, depth + 1)];
+    });
+}
+export function compileDomains(domains) {
+    return flatten(domains, undefined, 0);
+}
+/** A frontmatter value names a domain by its full path first, else by the identifier of the first domain declared with it. */
+function declaredDomain(value, domains) {
+    return (domains.find((domain) => domain.path === value) ?? domains.find((domain) => domain.id === value));
+}
+/** The directory segments of a source-relative path, the file name excluded. */
+function directoriesOf(relativePath) {
+    return relativePath.split("/").slice(0, -1);
+}
+/**
+ * The positions, among the directory segments, where the folder of the domain sits; none for
+ * a domain without folder. A subdomain's folder counts only under its parent's folder; when
+ * the parent is declared by globs instead, it counts anywhere on a path the parent's globs
+ * match; a parent declared by neither constrains nothing.
+ */
+function folderPositions(domain, directories, relativePath) {
+    const own = directories.flatMap((segment, index) => (segment === domain.folder ? [index] : []));
+    const { parent } = domain;
+    if (parent === undefined)
+        return own;
+    if (parent.folder !== undefined) {
+        const first = Math.min(...folderPositions(parent, directories, relativePath));
+        return own.filter((index) => index > first);
+    }
+    return !parent.globs || parent.matcher(relativePath) ? own : [];
+}
+/** How a domain claims a file, its folder before its globs; undefined when it does not. */
+function claimOf(domain, relativePath, directories) {
+    if (folderPositions(domain, directories, relativePath).length > 0)
+        return { domain, origin: "folder" };
+    if (domain.matcher(relativePath))
+        return { domain, origin: "glob" };
+    return undefined;
+}
+/** Among the domains that claim the file, the deepest wins; between domains of the same depth, the last declared. */
+function matchingDomain(relativePath, domains) {
+    const directories = directoriesOf(relativePath);
+    let best;
+    for (const domain of domains) {
+        const claim = claimOf(domain, relativePath, directories);
+        if (claim === undefined)
+            continue;
+        if (best === undefined || claim.domain.depth >= best.domain.depth)
+            best = claim;
+    }
+    return best;
+}
+/**
+ * Decreasing precedence: the frontmatter `domain`, the folders and globs evaluated on the
+ * source-relative path, then `unclassified`.
+ */
+export function resolveDomain(relativePath, frontmatterDomain, domains) {
+    const declared = declaredString(frontmatterDomain);
+    if (declared !== undefined) {
+        const found = declaredDomain(declared, domains);
+        if (found !== undefined)
+            return { domain: found.path, origin: "frontmatter", declared: true };
+        return { domain: declared, origin: "frontmatter", declared: declared === UNCLASSIFIED_DOMAIN };
+    }
+    const matched = matchingDomain(relativePath, domains);
+    if (matched !== undefined) {
+        return { domain: matched.domain.path, origin: matched.origin, declared: true };
+    }
+    return { domain: UNCLASSIFIED_DOMAIN, origin: "unclassified", declared: true };
+}
+//# sourceMappingURL=domains.js.map

package/dist/domains.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domains.js","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuC,MAAM,wBAAwB,CAAC;AAE3F,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,+DAA+D;AAC/D,MAAM,CAAC,MAAM,mBAAmB,GAAG,cAAc,CAAC;AA6BlD,SAAS,QAAQ,CAAC,MAAoB;IACpC,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC,EAAE,CAAC;IAC7C,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,MAAM,CAAC;IAC5D,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CACd,OAAgC,EAChC,MAAkC,EAClC,KAAa;IAEb,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAChC,MAAM,IAAI,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QAC9E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChC,MAAM,QAAQ,GAAmB;YAC/B,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,IAAI;YACJ,KAAK;YACL,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC;YACvB,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;YAC3C,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;SAC5C,CAAC;QACF,OAAO,CAAC,QAAQ,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,EAAE,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAgC;IAC7D,OAAO,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC;AAED,8HAA8H;AAC9H,SAAS,cAAc,CAAC,KAAa,EAAE,OAAsB;IAC3D,OAAO,CACL,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,KAAK,CAAC,CACjG,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,SAAS,aAAa,CAAC,YAAoB;IACzC,OAAO,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CACtB,MAAsB,EACtB,WAA8B,EAC9B,YAAoB;IAEpB,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC1B,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,GAAG,CAAC;IACrC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;QAC9E,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;AAClE,CAAC;AAOD,2FAA2F;AAC3F,SAAS,OAAO,CACd,MAAsB,EACtB,YAAoB,EACpB,WAA8B;IAE9B,IAAI,eAAe,CAAC,MAAM,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC;QAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IACtC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IACpE,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,qHAAqH;AACrH,SAAS,cAAc,CAAC,YAAoB,EAAE,OAAsB;IAClE,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAChD,IAAI,IAAuB,CAAC;IAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QACzD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK;YAAE,IAAI,GAAG,KAAK,CAAC;IAClF,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,YAAoB,EACpB,iBAA0B,EAC1B,OAAsB;IAEtB,MAAM,QAAQ,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACnD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC9F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,KAAK,mBAAmB,EAAE,CAAC;IACjG,CAAC;IACD,MAAM,OAAO,GAAG,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACtD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjF,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AACjF,CAAC"}

package/dist/entity.d.ts

@@ -0,0 +1,20 @@
+import { type ApplicationConfig, type Entity, type Finding, type SourceConfig } from "@concordance-wiki/core";
+import type { IngestedFile, IngestedSource, ParsedMarkdown } from "@concordance-wiki/ingest";
+import type { Profile } from "@concordance-wiki/profile";
+import { type DomainMatcher } from "./domains.js";
+export interface BuildEntityInput {
+    file: IngestedFile;
+    source: IngestedSource;
+    sourceConfig: SourceConfig;
+    document: ParsedMarkdown;
+    profile: Profile;
+    applications: readonly ApplicationConfig[];
+    domains: DomainMatcher;
+}
+export interface BuiltEntity {
+    entity: Entity;
+    findings: Finding[];
+}
+export declare function typeSuffixesOf(source: SourceConfig): string[];
+export declare function buildEntity(input: BuildEntityInput): BuiltEntity;
+//# sourceMappingURL=entity.d.ts.map

package/dist/entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,MAAM,EAEX,KAAK,OAAO,EACZ,KAAK,YAAY,EAClB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC7F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAIzD,OAAO,EAAiB,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAGjE,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAC3C,OAAO,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAiBD,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,EAAE,CAI7D;AA6FD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CAgDhE"}

package/dist/entity.js

@@ -0,0 +1,149 @@
+import { identifierFor, } from "@concordance-wiki/core";
+import { resolveApplication } from "./application.js";
+import { resolveType } from "./cascade.js";
+import { resolveDomain } from "./domains.js";
+import { filingFindings } from "./filing.js";
+/** Frontmatter keys that become fields of the entity rather than attributes. */
+const COMMON_KEYS = new Set([
+    "id",
+    "type",
+    "title",
+    "aliases",
+    "status",
+    "summary",
+    "tags",
+    "application",
+    "domain",
+]);
+const DEFAULT_STATUS = "valid";
+export function typeSuffixesOf(source) {
+    return (source.rules ?? []).flatMap((rule) => rule.match.suffix === undefined ? [] : [rule.match.suffix]);
+}
+// Code-unit order, not locale order: the output must not depend on the collation data of the runtime.
+function byCodeUnit(a, b) {
+    return Number(a > b) - Number(a < b);
+}
+function fileTitle(path) {
+    const name = path.slice(path.lastIndexOf("/") + 1);
+    return name.replace(/\.[^.]+$/, "");
+}
+function titleOf(frontmatter, document, path) {
+    if (typeof frontmatter["title"] === "string")
+        return frontmatter["title"];
+    return document.title ?? fileTitle(path);
+}
+function aliasesOf(frontmatter) {
+    const { aliases } = frontmatter;
+    if (!Array.isArray(aliases))
+        return [];
+    return aliases.filter((alias) => typeof alias === "string");
+}
+function statusOf(frontmatter, profile) {
+    if (typeof frontmatter["status"] === "string")
+        return frontmatter["status"];
+    const fallback = profile.common_attributes?.["status"]?.default;
+    return typeof fallback === "string" ? fallback : DEFAULT_STATUS;
+}
+function summaryOf(frontmatter, document) {
+    if (typeof frontmatter["summary"] === "string")
+        return frontmatter["summary"];
+    return document.paragraphs[0]?.text;
+}
+function attributesOf(frontmatter, defaults) {
+    const merged = {};
+    // A rule's application feeds the application cascade, not the attributes.
+    for (const [key, value] of Object.entries(defaults)) {
+        if (key !== "application")
+            merged[key] = value;
+    }
+    for (const [key, value] of Object.entries(frontmatter)) {
+        if (!COMMON_KEYS.has(key))
+            merged[key] = value;
+    }
+    const attributes = {};
+    for (const key of Object.keys(merged).sort(byCodeUnit)) {
+        attributes[key] = merged[key];
+    }
+    return attributes;
+}
+function sourceOf(file, source) {
+    // A note is the whole file: its first line locates it.
+    const location = {
+        name: source.name,
+        path: file.path,
+        line: 1,
+        last_modified: file.modifiedAt,
+    };
+    return file.commit === undefined ? location : { ...location, commit: file.commit };
+}
+function unknownAttributes(input, type, id) {
+    const { profile } = input;
+    const known = new Set([
+        "id",
+        "type",
+        ...Object.keys(profile.common_attributes ?? {}),
+        ...Object.keys(profile.types[type]?.attributes ?? {}),
+    ]);
+    return Object.keys(input.document.frontmatter)
+        .filter((key) => !known.has(key))
+        .map((key) => ({
+        check: "W-ATTRIBUTE-UNKNOWN",
+        severity: "warning",
+        source: input.source.name,
+        path: input.file.path,
+        entity: id,
+        message: `frontmatter attribute "${key}" of ${input.file.path} is not declared for type ${type}; it is kept as-is`,
+        remediation: "Use an attribute of the type, declare it in the project profile, or remove the key.",
+    }));
+}
+export function buildEntity(input) {
+    const { file, source, sourceConfig, document, profile, applications, domains } = input;
+    const { frontmatter } = document;
+    const identifier = identifierFor({
+        source: source.name,
+        path: file.path,
+        typeSuffixes: typeSuffixesOf(sourceConfig),
+        frontmatterId: frontmatter["id"],
+    });
+    const resolved = resolveType({ source: sourceConfig, path: file.path, frontmatter, profile });
+    const application = resolveApplication({
+        source: sourceConfig,
+        ruleDefaults: resolved.defaults,
+        frontmatterApplication: frontmatter["application"],
+        applications,
+    });
+    const domain = resolveDomain(file.path, frontmatter["domain"], domains);
+    const entity = {
+        id: identifier.id,
+        type: resolved.type,
+        title: titleOf(frontmatter, document, file.path),
+        aliases: aliasesOf(frontmatter),
+        locale: source.locale,
+        ...(application.application === undefined ? {} : { application: application.application }),
+        domain: domain.domain,
+        status: statusOf(frontmatter, profile),
+        type_origin: resolved.origin,
+        graph: profile.types[resolved.type]?.graph ?? "full",
+        attributes: attributesOf(frontmatter, resolved.defaults),
+        source: sourceOf(file, source),
+    };
+    const summary = summaryOf(frontmatter, document);
+    if (summary !== undefined)
+        entity.summary = summary;
+    const findings = [
+        ...(identifier.finding === undefined ? [] : [identifier.finding]),
+        ...resolved.findings,
+        ...unknownAttributes(input, resolved.type, identifier.id),
+        ...filingFindings({
+            id: identifier.id,
+            type: resolved.type,
+            source: source.name,
+            path: file.path,
+            profile,
+            application,
+            domain,
+        }),
+    ];
+    return { entity, findings };
+}
+//# sourceMappingURL=entity.js.map

package/dist/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,GAMd,MAAM,wBAAwB,CAAC;AAIhC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAsB,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAiB7C,gFAAgF;AAChF,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC;IAC1B,IAAI;IACJ,MAAM;IACN,OAAO;IACP,SAAS;IACT,QAAQ;IACR,SAAS;IACT,MAAM;IACN,aAAa;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,OAAO,CAAC;AAE/B,MAAM,UAAU,cAAc,CAAC,MAAoB;IACjD,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAC3D,CAAC;AACJ,CAAC;AAED,sGAAsG;AACtG,SAAS,UAAU,CAAC,CAAS,EAAE,CAAS;IACtC,OAAO,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACnD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,OAAO,CACd,WAAoC,EACpC,QAAwB,EACxB,IAAY;IAEZ,IAAI,OAAO,WAAW,CAAC,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IAC1E,OAAO,QAAQ,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,SAAS,CAAC,WAAoC;IACrD,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;IAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,EAAE,CAAC;IACvC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,QAAQ,CAAC,WAAoC,EAAE,OAAgB;IACtE,IAAI,OAAO,WAAW,CAAC,QAAQ,CAAC,KAAK,QAAQ;QAAE,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAChE,OAAO,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC;AAClE,CAAC;AAED,SAAS,SAAS,CAChB,WAAoC,EACpC,QAAwB;IAExB,IAAI,OAAO,WAAW,CAAC,SAAS,CAAC,KAAK,QAAQ;QAAE,OAAO,WAAW,CAAC,SAAS,CAAC,CAAC;IAC9E,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;AACtC,CAAC;AAED,SAAS,YAAY,CACnB,WAAoC,EACpC,QAAiC;IAEjC,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,0EAA0E;IAC1E,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpD,IAAI,GAAG,KAAK,aAAa;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACjD,CAAC;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACjD,CAAC;IACD,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACvD,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,QAAQ,CAAC,IAAkB,EAAE,MAAsB;IAC1D,uDAAuD;IACvD,MAAM,QAAQ,GAAiB;QAC7B,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,CAAC;QACP,aAAa,EAAE,IAAI,CAAC,UAAU;KAC/B,CAAC;IACF,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;AACrF,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAuB,EAAE,IAAY,EAAE,EAAU;IAC1E,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAC1B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC;QACpB,IAAI;QACJ,MAAM;QACN,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,EAAE,CAAC;QAC/C,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,UAAU,IAAI,EAAE,CAAC;KACtD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;SAC3C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAChC,GAAG,CAAC,CAAC,GAAG,EAAW,EAAE,CAAC,CAAC;QACtB,KAAK,EAAE,qBAAqB;QAC5B,QAAQ,EAAE,SAAS;QACnB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;QACzB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI;QACrB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,0BAA0B,GAAG,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,6BAA6B,IAAI,oBAAoB;QAClH,WAAW,EACT,qFAAqF;KACxF,CAAC,CAAC,CAAC;AACR,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IACvF,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC;IACjC,MAAM,UAAU,GAAG,aAAa,CAAC;QAC/B,MAAM,EAAE,MAAM,CAAC,IAAI;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,YAAY,EAAE,cAAc,CAAC,YAAY,CAAC;QAC1C,aAAa,EAAE,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9F,MAAM,WAAW,GAAG,kBAAkB,CAAC;QACrC,MAAM,EAAE,YAAY;QACpB,YAAY,EAAE,QAAQ,CAAC,QAAQ;QAC/B,sBAAsB,EAAE,WAAW,CAAC,aAAa,CAAC;QAClD,YAAY;KACb,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;IACxE,MAAM,MAAM,GAAW;QACrB,EAAE,EAAE,UAAU,CAAC,EAAE;QACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC;QAChD,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC;QAC/B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,GAAG,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC;QAC1F,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;QACtC,WAAW,EAAE,QAAQ,CAAC,MAAM;QAC5B,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,MAAM;QACpD,UAAU,EAAE,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC;QACxD,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;KAC/B,CAAC;IACF,MAAM,OAAO,GAAG,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACjD,IAAI,OAAO,KAAK,SAAS;QAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;IACpD,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,UAAU,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjE,GAAG,QAAQ,CAAC,QAAQ;QACpB,GAAG,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;QACzD,GAAG,cAAc,CAAC;YAChB,EAAE,EAAE,UAAU,CAAC,EAAE;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO;YACP,WAAW;YACX,MAAM;SACP,CAAC;KACH,CAAC;IACF,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC"}

package/dist/filing.d.ts

@@ -0,0 +1,17 @@
+import type { Finding } from "@concordance-wiki/core";
+import type { Profile } from "@concordance-wiki/profile";
+import type { ResolvedApplication } from "./application.js";
+import { type ResolvedDomain } from "./domains.js";
+export interface FilingInput {
+    id: string;
+    type: string;
+    source: string;
+    /** Forward-slash path relative to the source root. */
+    path: string;
+    profile: Profile;
+    application: ResolvedApplication;
+    domain: ResolvedDomain;
+}
+/** The filing findings of one entity; containers are exempt from the missing-application and unclassified ones. */
+export declare function filingFindings(input: FilingInput): Finding[];
+//# sourceMappingURL=filing.d.ts.map

package/dist/filing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filing.d.ts","sourceRoot":"","sources":["../src/filing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAuB,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAKxE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,mBAAmB,CAAC;IACjC,MAAM,EAAE,cAAc,CAAC;CACxB;AAuED,mHAAmH;AACnH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,EAAE,CAG5D"}

package/dist/filing.js

@@ -0,0 +1,48 @@
+import { UNCLASSIFIED_DOMAIN } from "./domains.js";
+/** Applications and domains are what entities are filed into; they are not filed themselves. */
+const CONTAINER_GROUP = "container";
+function finding(input, check, severity, message, remediation) {
+    return {
+        check,
+        severity,
+        source: input.source,
+        path: input.path,
+        entity: input.id,
+        message,
+        remediation,
+    };
+}
+function applicationFindings(input, filed) {
+    const { application } = input;
+    if (application.application === undefined) {
+        if (!filed)
+            return [];
+        return [
+            finding(input, "W-APP-MISSING", "warning", `${input.id} resolves to no application`, "Set application on the source, in a typing rule, or in the note's frontmatter."),
+        ];
+    }
+    if (application.declared)
+        return [];
+    return [
+        finding(input, "W-APP-UNKNOWN", "warning", `application "${application.application}" of ${input.id} (from ${application.origin}) is not declared in the configuration; it is kept as written`, "Declare the application under applications in concordance.yaml, or fix the source, the rule or the frontmatter that sets it."),
+    ];
+}
+function domainFindings(input, filed) {
+    const { domain } = input;
+    if (!domain.declared) {
+        return [
+            finding(input, "W-DOMAIN-UNKNOWN", "warning", `frontmatter domain "${domain.domain}" of ${input.id} is not declared in the configuration; it is kept as written`, "Declare the domain under domains in concordance.yaml, or name a declared domain by its id or its id path."),
+        ];
+    }
+    if (domain.domain !== UNCLASSIFIED_DOMAIN || !filed)
+        return [];
+    return [
+        finding(input, "W-DOMAIN-UNCLASSIFIED", "info", `${input.id} matches no declared domain`, "Add a folder or a glob to the domain in concordance.yaml, or set domain in the note's frontmatter."),
+    ];
+}
+/** The filing findings of one entity; containers are exempt from the missing-application and unclassified ones. */
+export function filingFindings(input) {
+    const filed = input.profile.types[input.type]?.group !== CONTAINER_GROUP;
+    return [...applicationFindings(input, filed), ...domainFindings(input, filed)];
+}
+//# sourceMappingURL=filing.js.map

package/dist/filing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filing.js","sourceRoot":"","sources":["../src/filing.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAuB,MAAM,cAAc,CAAC;AAExE,gGAAgG;AAChG,MAAM,eAAe,GAAG,WAAW,CAAC;AAapC,SAAS,OAAO,CACd,KAAkB,EAClB,KAAa,EACb,QAA6B,EAC7B,OAAe,EACf,WAAmB;IAEnB,OAAO;QACL,KAAK;QACL,QAAQ;QACR,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,EAAE;QAChB,OAAO;QACP,WAAW;KACZ,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAkB,EAAE,KAAc;IAC7D,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAC9B,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAC1C,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QACtB,OAAO;YACL,OAAO,CACL,KAAK,EACL,eAAe,EACf,SAAS,EACT,GAAG,KAAK,CAAC,EAAE,6BAA6B,EACxC,gFAAgF,CACjF;SACF,CAAC;IACJ,CAAC;IACD,IAAI,WAAW,CAAC,QAAQ;QAAE,OAAO,EAAE,CAAC;IACpC,OAAO;QACL,OAAO,CACL,KAAK,EACL,eAAe,EACf,SAAS,EACT,gBAAgB,WAAW,CAAC,WAAW,QAAQ,KAAK,CAAC,EAAE,UAAU,WAAW,CAAC,MAAM,+DAA+D,EAClJ,8HAA8H,CAC/H;KACF,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,KAAkB,EAAE,KAAc;IACxD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO;YACL,OAAO,CACL,KAAK,EACL,kBAAkB,EAClB,SAAS,EACT,uBAAuB,MAAM,CAAC,MAAM,QAAQ,KAAK,CAAC,EAAE,8DAA8D,EAClH,2GAA2G,CAC5G;SACF,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,mBAAmB,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAC/D,OAAO;QACL,OAAO,CACL,KAAK,EACL,uBAAuB,EACvB,MAAM,EACN,GAAG,KAAK,CAAC,EAAE,6BAA6B,EACxC,oGAAoG,CACrG;KACF,CAAC;AACJ,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,cAAc,CAAC,KAAkB;IAC/C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,eAAe,CAAC;IACzE,OAAO,CAAC,GAAG,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,GAAG,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AACjF,CAAC"}

package/dist/frontmatter.d.ts

@@ -0,0 +1,3 @@
+/** A frontmatter scalar as the cascades read it: a string as written, anything else serialised so that findings show it. */
+export declare function declaredString(value: unknown): string | undefined;
+//# sourceMappingURL=frontmatter.d.ts.map

package/dist/frontmatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontmatter.d.ts","sourceRoot":"","sources":["../src/frontmatter.ts"],"names":[],"mappings":"AAAA,4HAA4H;AAC5H,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGjE"}

package/dist/frontmatter.js

@@ -0,0 +1,7 @@
+/** A frontmatter scalar as the cascades read it: a string as written, anything else serialised so that findings show it. */
+export function declaredString(value) {
+    if (value === undefined)
+        return undefined;
+    return typeof value === "string" ? value : JSON.stringify(value);
+}
+//# sourceMappingURL=frontmatter.js.map

package/dist/frontmatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontmatter.js","sourceRoot":"","sources":["../src/frontmatter.ts"],"names":[],"mappings":"AAAA,4HAA4H;AAC5H,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC"}