pp-portfolio-classifier 0.0.1 → 0.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pp-portfolio-classifier",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Automatic classification of Portfolio Performance securities using MorningStar Direct Web Services ",
   "keywords": [
     "portfolio-performance",
@@ -14,6 +14,7 @@
     "build": "tsc",
     "dev": "ts-node src/index.ts",
     "lint": "prettier --check ./src && eslint ./src && tsc --noEmit",
+    "publish": "yarn bluid && npm publish",
     "start": "node dist/index.ts"
   },
   "dependencies": {

package/src/index.ts

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import * as path from "path";
 import { Classifier } from "./classifier";
 import { MorningstarAPI } from "./morningstar-api";

package/dist/classifier.js

@@ -1,195 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Classifier = void 0;
-const config_1 = __importDefault(require("config"));
-const lodash_1 = require("lodash");
-class Classifier {
-    constructor(xmlHandler, api) {
-        this.xmlHandler = xmlHandler;
-        this.api = api;
-        this.taxonomiesConfig = config_1.default.get("taxonomies");
-        this.globalMappings = config_1.default.has("mappings") ? config_1.default.get("mappings") : {};
-    }
-    getMapping(mappingOrKey) {
-        if (!mappingOrKey)
-            return {};
-        if (typeof mappingOrKey === "string") {
-            if (this.globalMappings[mappingOrKey]) {
-                return this.globalMappings[mappingOrKey];
-            }
-            console.warn(`    [Config] Mapping key '${mappingOrKey}' not found in global mappings.`);
-            return {};
-        }
-        return mappingOrKey;
-    }
-    async classifySecurity(security) {
-        if (!security.isin && !security.isinOverride)
-            return;
-        if (security.ignoreTaxonomies === true)
-            return;
-        const securityInfo = await this.api.getSecurityData(security.isinOverride || security.isin);
-        if (!securityInfo) {
-            console.log(`  > No data found for ${security.name}.`);
-            return;
-        }
-        console.log(`  > Data retrieved for ${security.name}. Type: ${securityInfo.type}. Processing taxonomies...`);
-        if (securityInfo.type === "Stock") {
-            await this.classifyStock(security, securityInfo.secid, securityInfo.data);
-        }
-        else if (securityInfo.type === "Fund") {
-            await this.classifyFund(security, securityInfo.data);
-        }
-        else {
-            console.error(`  > Unknown security type: ${securityInfo.type}! Skipping...`);
-        }
-    }
-    async classifyFund(security, data) {
-        for (const [taxonomyId, taxConfig] of Object.entries(this.taxonomiesConfig)) {
-            if (!taxConfig.active)
-                continue;
-            if (security.ignoreTaxonomies !== undefined &&
-                (security.ignoreTaxonomies === true || security.ignoreTaxonomies.includes(taxonomyId)))
-                continue;
-            console.log(`    > ${taxonomyId}`);
-            // 1. Extract Data
-            const sourceData = (0, lodash_1.get)(data, taxConfig.sourcePath);
-            if (!sourceData) {
-                console.warn(`    [${taxonomyId}] No data found at path '${taxConfig.sourcePath}'`);
-                continue;
-            }
-            if (!Array.isArray(sourceData)) {
-                console.warn(`    [${taxonomyId}] Data at '${taxConfig.sourcePath}' is not an array.`);
-                continue;
-            }
-            // 2. Filter Data
-            // console.log(`    [${taxonomyId}] Filtering ${sourceData.length} items...`);
-            let filteredData = sourceData;
-            if (taxConfig.filter) {
-                filteredData = (0, lodash_1.filter)(sourceData, taxConfig.filter);
-            }
-            if (filteredData.length === 0) {
-                console.log(`    [${taxonomyId}] No items match the filter.`);
-                continue;
-            }
-            // 2.1 Extract BreakdownValues (Flattening)
-            // The data we want is usually nested in a 'BreakdownValues' array inside the filtered items
-            let itemsToProcess = [];
-            for (const group of filteredData) {
-                if (group.BreakdownValues && Array.isArray(group.BreakdownValues)) {
-                    itemsToProcess.push(...group.BreakdownValues);
-                }
-                else {
-                    itemsToProcess.push(group);
-                }
-            }
-            // 3. Map and Assign
-            // console.log(`    [${taxonomyId}] Assigning ${itemsToProcess.length} items...`);
-            const assignments = [];
-            const mapping = this.getMapping(taxConfig.mapping);
-            for (const item of itemsToProcess) {
-                const key = item[taxConfig.keyField];
-                const value = parseFloat(item[taxConfig.valueField]);
-                if (key && value > 0) {
-                    if (!Object.keys(mapping).length) {
-                        assignments.push({ path: [key], weight: value * 100 });
-                    }
-                    else if (key in mapping) {
-                        const targetClass = mapping[key];
-                        if (targetClass) {
-                            const path = Array.isArray(targetClass) ? targetClass : [targetClass];
-                            assignments.push({ path, weight: value * 100 });
-                        }
-                    }
-                    else {
-                        console.log(`    [${taxonomyId}] Unmapped key: '${key}' (Value: ${value})`);
-                    }
-                }
-            }
-            this.xmlHandler.updateSecurityAssignments(taxConfig.name || taxonomyId, security.uuid, assignments);
-        }
-    }
-    async classifyStock(security, secid, data) {
-        if (!secid && !data) {
-            console.warn(`  > Cannot classify stock ${security.name} without data.`);
-            return;
-        }
-        for (const [taxonomyId, taxConfig] of Object.entries(this.taxonomiesConfig)) {
-            if (!taxConfig.active)
-                continue;
-            if (security.ignoreTaxonomies !== undefined &&
-                (security.ignoreTaxonomies === true || security.ignoreTaxonomies.includes(taxonomyId)))
-                continue;
-            if (!taxConfig.stockConfig)
-                continue;
-            console.log(`    > ${taxonomyId}`);
-            const stockConfig = taxConfig.stockConfig;
-            if (stockConfig.isSingleValue && stockConfig.value) {
-                // Case 1: Static value (e.g., Asset Type is always 'Stocks')
-                const path = Array.isArray(stockConfig.value) ? stockConfig.value : [stockConfig.value];
-                this.xmlHandler.updateSecurityAssignments(taxConfig.name || taxonomyId, security.uuid, [
-                    { path, weight: 10000 },
-                ]); // 100% weight
-            }
-            else if (stockConfig.sourcePath) {
-                // Case 2: Value from Data (SAL or Initial)
-                let key;
-                if (stockConfig.salEndpoint) {
-                    if (!secid) {
-                        console.warn(`    [${taxonomyId}] Cannot fetch SAL data without secid.`);
-                        continue;
-                    }
-                    const salData = await this.api.getSalData(secid, stockConfig.salEndpoint);
-                    if (!salData) {
-                        console.warn(`    [${taxonomyId}] No SAL data retrieved.`);
-                        continue;
-                    }
-                    key = (0, lodash_1.get)(salData, stockConfig.sourcePath);
-                }
-                else if (stockConfig.viewId) {
-                    const id = security.isinOverride || security.isin;
-                    if (!id) {
-                        console.warn(`    [${taxonomyId}] Cannot fetch view data without ID.`);
-                        continue;
-                    }
-                    const viewResult = await this.api.getSecurityData(id, stockConfig.viewId);
-                    // console.debug(security, viewResult);
-                    if (viewResult && viewResult.data) {
-                        key = (0, lodash_1.get)(viewResult.data, stockConfig.sourcePath);
-                        // console.debug(security.name, viewResult.data.QuantitativeFairValue, stockConfig.sourcePath, key);
-                    }
-                    else {
-                        console.warn(`    [${taxonomyId}] No data retrieved for view '${stockConfig.viewId}'.`);
-                        continue;
-                    }
-                }
-                else {
-                    // Use data from initial request
-                    key = (0, lodash_1.get)(data, stockConfig.sourcePath);
-                }
-                const mapping = this.getMapping(stockConfig.mapping);
-                if (key) {
-                    // console.debug(security.name, key, mapping[key]);
-                    if (!Object.keys(mapping).length) {
-                        this.xmlHandler.updateSecurityAssignments(taxConfig.name || taxonomyId, security.uuid, [
-                            { path: [key], weight: 10000 },
-                        ]); // 100% weight
-                    }
-                    else if (key in mapping) {
-                        const targetClass = mapping[key];
-                        const path = Array.isArray(targetClass) ? targetClass : [targetClass];
-                        this.xmlHandler.updateSecurityAssignments(taxConfig.name || taxonomyId, security.uuid, [
-                            { path, weight: 10000 },
-                        ]); // 100% weight
-                    }
-                    else {
-                        console.warn(`    [${taxonomyId}] Unmapped stock value '${key}'.`);
-                    }
-                }
-            }
-        }
-    }
-}
-exports.Classifier = Classifier;

package/dist/morningstar-api.js

@@ -1,137 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MorningstarAPI = void 0;
-const axios_1 = __importDefault(require("axios"));
-const config_1 = __importDefault(require("config"));
-class MorningstarAPI {
-    constructor() {
-        this.bearerToken = "";
-        this.domain = config_1.default.get("morningstar.domain");
-        this.baseUrl = config_1.default.get("morningstar.baseUrl");
-        this.salBaseUrl = config_1.default.get("morningstar.salBaseUrl");
-        this.viewId = config_1.default.get("morningstar.viewId");
-    }
-    async getBearerToken() {
-        if (this.bearerToken)
-            return this.bearerToken;
-        console.log("Fetching Morningstar Bearer Token...");
-        const url = `https://www.morningstar.${this.domain}/Common/funds/snapshot/PortfolioSAL.aspx`;
-        try {
-            const response = await axios_1.default.get(url);
-            const tokenRegex = /const maasToken \=\s\"(.+)\"/;
-            const match = response.data.match(tokenRegex);
-            if (match && match[1]) {
-                this.bearerToken = match[1];
-                // console.log("Got Bearer Token:", this.bearerToken);
-                return this.bearerToken;
-            }
-            else {
-                throw new Error("Token regex failed");
-            }
-        }
-        catch (error) {
-            console.error("Failed to get Bearer Token", error);
-            throw error;
-        }
-    }
-    /**
-     * Récupère des données complémentaires via une vue spécifique (ex: 'snapshot').
-     * Peut être utilisé avec un ISIN ou un SecId.
-     */
-    async getSecurityData(id, viewId, idType = "ISIN") {
-        const token = await this.getBearerToken();
-        const url = `${this.baseUrl}/securities/${id}`;
-        const params = {
-            idtype: idType,
-            viewid: viewId || this.viewId,
-            currencyId: "EUR",
-            responseViewFormat: "json",
-            languageId: "en-UK",
-        };
-        const headers = { Authorization: `Bearer ${token}`, accept: "*/*" };
-        try {
-            const response = await axios_1.default.get(url, { params, headers });
-            if (response.data && response.data.length > 0) {
-                const securityInfo = response.data[0];
-                // if (isin == "NL0011585146") console.debug(isin, securityInfo);
-                return {
-                    type: securityInfo.Type,
-                    data: securityInfo,
-                    secid: securityInfo.Id || id, // Fallback to ISIN if SecId is missing (SAL API often accepts ISIN)
-                };
-            }
-            // If response is empty (200 OK but no data), try fallback
-            console.log(`  > ecint API returned empty for ${id}, trying website search fallback...`);
-            return this.findSecidFromWebsite(id);
-        }
-        catch (error) {
-            if (error.response?.status === 401) {
-                // This can happen for stocks not covered by this endpoint. Try the fallback.
-                console.log(`  > ecint API failed for ${id}, trying website search fallback...`);
-                return this.findSecidFromWebsite(id);
-            }
-            console.warn(`  Warning: Could not fetch data for ${id} from ecint API. Error: ${error.message}`);
-            return null;
-        }
-    }
-    /**
-     * Récupère des données détaillées pour les actions via l'API SAL.
-     */
-    async getSalData(secid, endpoint) {
-        const token = await this.getBearerToken();
-        let url = `${this.salBaseUrl}/${endpoint}`;
-        let params = {
-            languageId: "en-UK",
-            locale: "en",
-        };
-        const headers = { Authorization: `Bearer ${token}`, accept: "*/*" };
-        if (endpoint === "stock/equityOverview") {
-            url += `/${secid}/data`;
-            params.version = "4.65.0";
-        }
-        else {
-            // companyProfile
-            url += `/${secid}`;
-        }
-        try {
-            const response = await axios_1.default.get(url, { params, headers });
-            return response.data;
-        }
-        catch (error) {
-            console.warn(`  Warning: Could not fetch SAL data for secid ${secid} from endpoint ${endpoint}.`);
-            console.debug(url, params);
-            return null;
-        }
-    }
-    /**
-     * Fallback: Trouve le SecId d'un titre en cherchant sur le site de Morningstar.
-     * C'est utile pour les actions qui ne sont pas dans l'API ecint.
-     */
-    async findSecidFromWebsite(isin) {
-        const url = `https://global.morningstar.com/api/v1/${this.domain}/search/securities`;
-        const params = { query: `((isin ~= "${isin}"))` };
-        const headers = { "user-agent": "Mozilla/5.0" };
-        try {
-            const response = await axios_1.default.get(url, { params, headers });
-            const results = response.data?.results;
-            if (results && results.length > 0) {
-                const secid = results[0].securityID;
-                const universe = results[0].universe;
-                const type = universe === "EQ" ? "Stock" : "Unknown";
-                if (type === "Stock") {
-                    console.log(`  > Found secid '${secid}' for stock ${isin} via fallback.`);
-                    return { type: "Stock", data: null, secid: secid };
-                }
-            }
-            return null;
-        }
-        catch (error) {
-            console.warn(`  Warning: Fallback search for ${isin} failed.`);
-            return null;
-        }
-    }
-}
-exports.MorningstarAPI = MorningstarAPI;

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/xml-helper.js

@@ -1,244 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XMLHandler = void 0;
-const crypto_1 = require("crypto");
-const fast_xml_parser_1 = require("fast-xml-parser");
-const fs = __importStar(require("fs"));
-const options = {
-    ignoreAttributes: false,
-    attributeNamePrefix: "@_",
-    format: true,
-    indentBy: "  ",
-    suppressEmptyNode: true,
-    isArray: (name, jpath, isLeafNode, isAttribute) => {
-        // Force ces éléments à être des tableaux même s'il n'y en a qu'un seul
-        const arrayTags = [
-            "securities.security",
-            "taxonomies.taxonomy",
-            "assignments.assignment",
-            "children.classification",
-        ];
-        if (arrayTags.some((tag) => jpath.endsWith(tag)))
-            return true;
-        return false;
-    },
-};
-class XMLHandler {
-    constructor() {
-        this.parser = new fast_xml_parser_1.XMLParser(options);
-        this.builder = new fast_xml_parser_1.XMLBuilder(options);
-    }
-    load(filepath) {
-        console.log(`Loading XML file: ${filepath}`);
-        const fileContent = fs.readFileSync(filepath, "utf-8");
-        this.xmlData = this.parser.parse(fileContent);
-    }
-    save(filepath) {
-        console.log(`Saving XML file to: ${filepath}`);
-        const xmlContent = this.builder.build(this.xmlData);
-        // Hack pour ajouter l'en-tête XML standard si manquant (PP aime bien l'encodage UTF-8 explicite)
-        const finalXml = `<?xml version="1.0" encoding="UTF-8"?>\n${xmlContent}`;
-        fs.writeFileSync(filepath, finalXml, "utf-8");
-    }
-    getSecurities() {
-        if (!this.xmlData?.client?.securities?.security)
-            return [];
-        return this.xmlData.client.securities.security.map((sec) => {
-            const security = {
-                uuid: sec.uuid,
-                name: sec.name,
-                isin: sec.isin,
-                note: sec.note,
-                isRetired: sec.isRetired,
-                isinOverride: undefined,
-                ignoreTaxonomies: undefined,
-            };
-            if (sec.note) {
-                const isinMatch = sec.note.match(/#PPC:\[ISIN2=([A-Z0-9]{12})\]/);
-                if (isinMatch)
-                    security.isinOverride = isinMatch[1];
-                const ignoreMatch = sec.note.match(/#PPC:\[ignore(?:=([^\]]+))?\]/);
-                if (ignoreMatch) {
-                    security.ignoreTaxonomies = ignoreMatch[1] ? ignoreMatch[1].split(",").map((s) => s.trim()) : true;
-                }
-            }
-            // console.debug(security);
-            return security;
-        });
-    }
-    // Méthode utilitaire pour vérifier si le XML est chargé
-    isLoaded() {
-        return !!this.xmlData;
-    }
-    /**
-     * Finds or creates a taxonomy by name
-     */
-    getTaxonomy(name) {
-        if (!this.xmlData.client.taxonomies) {
-            this.xmlData.client.taxonomies = { taxonomy: [] };
-        }
-        let tax = this.xmlData.client.taxonomies.taxonomy.find((t) => t.name === name);
-        if (!tax) {
-            tax = {
-                id: (0, crypto_1.randomUUID)(),
-                name: name,
-                root: {
-                    id: (0, crypto_1.randomUUID)(),
-                    name: name,
-                    color: "#89afee",
-                    children: { classification: [] },
-                    assignments: { assignment: [] },
-                    weight: 10000,
-                    rank: 0,
-                },
-            };
-            this.xmlData.client.taxonomies.taxonomy.push(tax);
-        }
-        return tax;
-    }
-    /**
-     * Assigns a security to a specific classification path within a taxonomy
-     */
-    assignSecurityToTaxonomy(taxonomyName, path, securityUuid, weight) {
-        const tax = this.getTaxonomy(taxonomyName);
-        // 1. Remove existing assignments for this security in this taxonomy to avoid duplicates
-        const securityIndex = this.getSecurityIndex(securityUuid);
-        if (securityIndex === -1) {
-            console.error(`    [XML] Error: Security UUID ${securityUuid} not found in XML structure.`);
-            return;
-        }
-        // console.log(`    [XML] Updating '${taxonomyName}' -> ${path.join(' > ')}: ${(weight/100).toFixed(2)}%`);
-        // 2. Find or create the target classification node
-        const targetNode = this.ensureClassificationPath(tax.root, path);
-        // 3. Add the new assignment
-        if (!targetNode.assignments)
-            targetNode.assignments = { assignment: [] };
-        if (!targetNode.assignments.assignment)
-            targetNode.assignments.assignment = [];
-        // Calculate depth for relative reference (Root is depth 0)
-        const depth = path.length;
-        const securityRef = this.getSecurityReference(securityIndex, depth);
-        // Check if assignment already exists to avoid duplicates in the same node
-        const existingAssignmentIndex = targetNode.assignments.assignment.findIndex((a) => a.investmentVehicle && a.investmentVehicle["@_reference"] === securityRef);
-        const newAssignment = {
-            investmentVehicle: {
-                "@_class": "security",
-                "@_reference": securityRef,
-            },
-            weight: Math.round(weight),
-            rank: 0,
-        };
-        if (existingAssignmentIndex !== -1) {
-            targetNode.assignments.assignment[existingAssignmentIndex] = newAssignment;
-        }
-        else {
-            targetNode.assignments.assignment.push(newAssignment);
-        }
-    }
-    /**
-     * Removes all assignments for a specific security in a given taxonomy.
-     */
-    removeSecurityFromTaxonomy(taxonomyName, securityUuid) {
-        const tax = this.getTaxonomy(taxonomyName);
-        const securityIndex = this.getSecurityIndex(securityUuid);
-        if (securityIndex === -1)
-            return;
-        const removeRecursive = (node, depth) => {
-            if (node.assignments && node.assignments.assignment) {
-                const securityRef = this.getSecurityReference(securityIndex, depth);
-                node.assignments.assignment = node.assignments.assignment.filter((a) => !a.investmentVehicle || a.investmentVehicle["@_reference"] !== securityRef);
-            }
-            if (node.children && node.children.classification) {
-                node.children.classification.forEach((child) => removeRecursive(child, depth + 1));
-            }
-        };
-        removeRecursive(tax.root, 0);
-    }
-    /**
-     * Updates assignments for a security in a taxonomy.
-     * If assignments are provided, it clears existing ones first .
-     * If no assignments are provided, it leaves existing ones untouched.
-     */
-    updateSecurityAssignments(taxonomyName, securityUuid, assignments) {
-        if (!assignments || assignments.length === 0)
-            return;
-        this.removeSecurityFromTaxonomy(taxonomyName, securityUuid);
-        for (const assignment of assignments) {
-            this.assignSecurityToTaxonomy(taxonomyName, assignment.path, securityUuid, assignment.weight);
-        }
-    }
-    ensureClassificationPath(root, path) {
-        let current = root;
-        for (const segment of path) {
-            if (!current.children)
-                current.children = { classification: [] };
-            if (!current.children.classification)
-                current.children.classification = [];
-            let nextNode = current.children.classification.find((c) => c.name === segment);
-            if (!nextNode) {
-                nextNode = {
-                    id: (0, crypto_1.randomUUID)(),
-                    name: segment,
-                    color: "#89afee",
-                    parent: { "@_reference": `../../..` },
-                    children: { classification: [] },
-                    assignments: { assignment: [] },
-                    weight: 0,
-                    rank: 0,
-                };
-                current.children.classification.push(nextNode);
-            }
-            current = nextNode;
-        }
-        return current;
-    }
-    getSecurityIndex(uuid) {
-        if (!this.xmlData?.client?.securities?.security)
-            return -1;
-        return this.xmlData.client.securities.security.findIndex((s) => s.uuid === uuid);
-    }
-    getSecurityReference(index, depth) {
-        // Base depth calculation:
-        // Taxonomy(Root) -> Children -> Classif -> Assignments -> Assignment -> InvVehicle
-        // 6 levels up to Client for depth 0 (direct child of root)
-        // For each nesting level, add 2 levels (Children + Classification)
-        const levelsUp = 6 + depth * 2;
-        const prefix = "../".repeat(levelsUp);
-        const suffix = index === 0 ? "securities/security" : `securities/security[${index + 1}]`;
-        return `${prefix}${suffix}`;
-    }
-}
-exports.XMLHandler = XMLHandler;