@sachfolio/cas-reader 0.0.0-stage → 0.2.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/LICENSE +71 -0
- package/NOTICE +41 -0
- package/README.md +198 -2
- package/dist/analytics/contract.d.ts +110 -0
- package/dist/analytics/contract.js +79 -0
- package/dist/analytics/eligibility.d.ts +66 -0
- package/dist/analytics/eligibility.js +93 -0
- package/dist/analytics/gains-schema.d.ts +898 -0
- package/dist/analytics/gains-schema.js +170 -0
- package/dist/analytics/gains.d.ts +319 -0
- package/dist/analytics/gains.js +649 -0
- package/dist/analytics/modules.d.ts +33 -0
- package/dist/analytics/modules.js +74 -0
- package/dist/analytics/returns-schema.d.ts +931 -0
- package/dist/analytics/returns-schema.js +152 -0
- package/dist/analytics/returns.d.ts +126 -0
- package/dist/analytics/returns.js +453 -0
- package/dist/analytics/schedule112a.d.ts +77 -0
- package/dist/analytics/schedule112a.js +134 -0
- package/dist/analytics/xirr.d.ts +75 -0
- package/dist/analytics/xirr.js +314 -0
- package/dist/bin/cas.d.ts +2 -0
- package/dist/bin/cas.js +137 -0
- package/dist/checks.d.ts +49 -0
- package/dist/checks.js +227 -0
- package/dist/compat/casparser.d.ts +121 -0
- package/dist/compat/casparser.js +193 -0
- package/dist/detect.d.ts +10 -0
- package/dist/detect.js +69 -0
- package/dist/errors.d.ts +26 -0
- package/dist/errors.js +95 -0
- package/dist/export/csv.d.ts +21 -0
- package/dist/export/csv.js +49 -0
- package/dist/extract/browser.d.ts +17 -0
- package/dist/extract/browser.js +34 -0
- package/dist/extract/budget.d.ts +46 -0
- package/dist/extract/budget.js +88 -0
- package/dist/extract/node.d.ts +11 -0
- package/dist/extract/node.js +31 -0
- package/dist/extract/pdfjs.d.ts +71 -0
- package/dist/extract/pdfjs.js +244 -0
- package/dist/extract/types.d.ts +106 -0
- package/dist/extract/types.js +11 -0
- package/dist/index.d.ts +27 -0
- package/dist/index.js +26 -0
- package/dist/layout/lines.d.ts +51 -0
- package/dist/layout/lines.js +115 -0
- package/dist/licence/app-licence.d.ts +53 -0
- package/dist/licence/app-licence.js +139 -0
- package/dist/licence/ed25519.d.ts +2 -0
- package/dist/licence/ed25519.js +103 -0
- package/dist/model.d.ts +148 -0
- package/dist/model.js +1 -0
- package/dist/num.d.ts +19 -0
- package/dist/num.js +27 -0
- package/dist/parse.d.ts +4 -0
- package/dist/parse.js +13 -0
- package/dist/parsers/cams/classify.d.ts +25 -0
- package/dist/parsers/cams/classify.js +103 -0
- package/dist/parsers/cams/detailed.d.ts +15 -0
- package/dist/parsers/cams/detailed.js +343 -0
- package/dist/parsers/cams/header.d.ts +47 -0
- package/dist/parsers/cams/header.js +170 -0
- package/dist/parsers/cams/investor.d.ts +28 -0
- package/dist/parsers/cams/investor.js +139 -0
- package/dist/parsers/cams/summary.d.ts +29 -0
- package/dist/parsers/cams/summary.js +413 -0
- package/dist/parsers/cams/table.d.ts +55 -0
- package/dist/parsers/cams/table.js +144 -0
- package/dist/parsers/cams/total.d.ts +17 -0
- package/dist/parsers/cams/total.js +105 -0
- package/dist/parsers/depository/mf.d.ts +22 -0
- package/dist/parsers/depository/mf.js +438 -0
- package/dist/privacy.d.ts +243 -0
- package/dist/privacy.js +256 -0
- package/dist/schema.d.ts +779 -0
- package/dist/schema.js +214 -0
- package/examples/nextjs/app/page.jsx +34 -0
- package/examples/node/server.mjs +45 -0
- package/examples/python/read_cas.py +67 -0
- package/examples/vite/index.html +14 -0
- package/examples/vite/main.js +22 -0
- package/package.json +54 -4
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The first analyses under the contract (ROADMAP M4): holdings, coverage,
|
|
3
|
+
* observations and XIRR. Holdings and XIRR carry real eligibility; coverage
|
|
4
|
+
* and observations are facts that need no extra evidence (docs/SPEC-metrics.md
|
|
5
|
+
* "Coverage report: always available"). The observation sentences themselves
|
|
6
|
+
* are rendered by the app from the evidence (apps/web/src/lib/observations.ts);
|
|
7
|
+
* this module states their contract and regulatory class.
|
|
8
|
+
*/
|
|
9
|
+
import type { CasDocument } from "../model.js";
|
|
10
|
+
import { type AnalysisManifest, type AnalysisModule, type ModuleReport, type PredicateCode, type Reason } from "./contract.js";
|
|
11
|
+
export declare const HOLDINGS_MANIFEST: AnalysisManifest;
|
|
12
|
+
export interface HoldingsOutput {
|
|
13
|
+
schemes: Array<{
|
|
14
|
+
folio: string;
|
|
15
|
+
rtaCode: string;
|
|
16
|
+
included: boolean;
|
|
17
|
+
reasons: Reason<PredicateCode>[];
|
|
18
|
+
}>;
|
|
19
|
+
included: number;
|
|
20
|
+
excluded: number;
|
|
21
|
+
}
|
|
22
|
+
export declare const holdingsModule: AnalysisModule<HoldingsOutput>;
|
|
23
|
+
export declare const COVERAGE_MANIFEST: AnalysisManifest;
|
|
24
|
+
export declare const coverageModule: AnalysisModule<{
|
|
25
|
+
schemes: number;
|
|
26
|
+
rows: number;
|
|
27
|
+
}>;
|
|
28
|
+
export declare const OBSERVATIONS_MANIFEST: AnalysisManifest;
|
|
29
|
+
export declare const observationsModule: AnalysisModule<null>;
|
|
30
|
+
/** Registered analyses, in report order. */
|
|
31
|
+
export declare const MODULES: ReadonlyArray<AnalysisModule<unknown>>;
|
|
32
|
+
/** Each module's manifest summary and eligibility for one statement. */
|
|
33
|
+
export declare function moduleReports(cas: CasDocument): ModuleReport[];
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { evaluateRequires, project, report } from "./contract.js";
|
|
2
|
+
import { gainsModule } from "./gains.js";
|
|
3
|
+
import { xirrModule } from "./returns.js";
|
|
4
|
+
const ALL_KINDS = { families: ["mf-cas"], instrumentKinds: ["mutual-fund-scheme"], eventKinds: "*" };
|
|
5
|
+
/* ---------- holdings ---------- */
|
|
6
|
+
export const HOLDINGS_MANIFEST = {
|
|
7
|
+
id: "analysis.holdings",
|
|
8
|
+
version: "1.0.0",
|
|
9
|
+
produces: "holdings@1",
|
|
10
|
+
regClass: "fact",
|
|
11
|
+
// A summary statement prints no ledger: its valuation identity is the check.
|
|
12
|
+
requires: ["valuation.pass", "ledger.units.pass"],
|
|
13
|
+
consumes: ALL_KINDS,
|
|
14
|
+
};
|
|
15
|
+
function holdingsCompute(view) {
|
|
16
|
+
const schemes = view.schemes.map(({ folio, scheme }) => {
|
|
17
|
+
const requires = view.variant !== "DETAILED" ? HOLDINGS_MANIFEST.requires.filter((p) => p !== "ledger.units.pass") : HOLDINGS_MANIFEST.requires;
|
|
18
|
+
const reasons = evaluateRequires(requires, { variant: view.variant, folio, scheme });
|
|
19
|
+
return { folio: folio.folio, rtaCode: scheme.rtaCode, included: reasons.length === 0, reasons };
|
|
20
|
+
});
|
|
21
|
+
const included = schemes.filter((s) => s.included).length;
|
|
22
|
+
return { schemes, included, excluded: schemes.length - included };
|
|
23
|
+
}
|
|
24
|
+
export const holdingsModule = {
|
|
25
|
+
manifest: HOLDINGS_MANIFEST,
|
|
26
|
+
eligibility(view) {
|
|
27
|
+
const out = holdingsCompute(view);
|
|
28
|
+
const reasons = out.schemes.flatMap((s) => s.reasons);
|
|
29
|
+
if (out.included === 0)
|
|
30
|
+
return { state: "not_available", reasons: reasons.length ? reasons : [{ code: "no_schemes", text: "The statement holds no schemes" }] };
|
|
31
|
+
return out.excluded ? { state: "partial", reasons } : { state: "eligible", reasons: [] };
|
|
32
|
+
},
|
|
33
|
+
compute: holdingsCompute,
|
|
34
|
+
};
|
|
35
|
+
/* ---------- coverage ---------- */
|
|
36
|
+
export const COVERAGE_MANIFEST = {
|
|
37
|
+
id: "analysis.coverage",
|
|
38
|
+
version: "1.0.0",
|
|
39
|
+
produces: "coverage@1",
|
|
40
|
+
regClass: "fact",
|
|
41
|
+
requires: [],
|
|
42
|
+
consumes: ALL_KINDS,
|
|
43
|
+
};
|
|
44
|
+
export const coverageModule = {
|
|
45
|
+
manifest: COVERAGE_MANIFEST,
|
|
46
|
+
eligibility: () => ({ state: "eligible", reasons: [] }),
|
|
47
|
+
compute: (view) => ({ schemes: view.schemes.length, rows: view.schemes.reduce((n, s) => n + s.rows.length, 0) }),
|
|
48
|
+
};
|
|
49
|
+
/* ---------- observations ---------- */
|
|
50
|
+
export const OBSERVATIONS_MANIFEST = {
|
|
51
|
+
id: "analysis.observations",
|
|
52
|
+
version: "1.0.0",
|
|
53
|
+
produces: "observations@1",
|
|
54
|
+
regClass: "fact",
|
|
55
|
+
requires: [],
|
|
56
|
+
consumes: ALL_KINDS,
|
|
57
|
+
};
|
|
58
|
+
export const observationsModule = {
|
|
59
|
+
manifest: OBSERVATIONS_MANIFEST,
|
|
60
|
+
eligibility: () => ({ state: "eligible", reasons: [] }),
|
|
61
|
+
compute: () => null,
|
|
62
|
+
};
|
|
63
|
+
/* ---------- registry ---------- */
|
|
64
|
+
/** Registered analyses, in report order. */
|
|
65
|
+
export const MODULES = [holdingsModule, coverageModule, observationsModule, xirrModule, gainsModule];
|
|
66
|
+
/** Registry gate (FEATURES.md B.6): nothing that gives advice or projects is ever registered. */
|
|
67
|
+
for (const m of MODULES) {
|
|
68
|
+
if (m.manifest.regClass === "advice" || m.manifest.regClass === "projection")
|
|
69
|
+
throw new Error(`${m.manifest.id}: regClass ${m.manifest.regClass} is not allowed`);
|
|
70
|
+
}
|
|
71
|
+
/** Each module's manifest summary and eligibility for one statement. */
|
|
72
|
+
export function moduleReports(cas) {
|
|
73
|
+
return MODULES.map((m) => report(m, project(cas, m.manifest.consumes)));
|
|
74
|
+
}
|