@socialgouv/kali-data-types 2.671.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socialgouv/kali-data-types",
-  "version": "2.671.0",
+  "version": "3.0.0",
   "devDependencies": {
     "@babel/core": "^7.16.0",
     "@babel/plugin-transform-modules-commonjs": "^7.16.0",
@@ -44,6 +44,7 @@
   "scripts": {
     "data:check": "node -r esm ./scripts/check.js",
     "data:fetch": "node -r dotenv/config -r esm ./scripts/fetch.js dotenv_config_path=./.env",
+    "data:clean": "node -r esm ./scripts/clean.js",
     "data:list": "node -r esm ./scripts/list.js",
     "data:match": "node -r esm ./scripts/match.js",
     "data:update": "yarn data:fetch && yarn data:match && yarn data:list && yarn data:check",

package/src/__tests__/index.test.js

@@ -11,11 +11,9 @@ test(`@socialgouv/kali-data`, () => {
     expect(Object.keys(kaliData)).toHaveLength(libNames.length);
 
     expect(kaliData.getAgreement).toBeInstanceOf(Function);
-    expect(kaliData.getAgreementArticlesWithParentSections).toBeInstanceOf(Function);
     expect(kaliData.getAgreementArticlesWithPath).toBeInstanceOf(Function);
     expect(kaliData.getAgreementIdFromIdOrIdcc).toBeInstanceOf(Function);
     expect(kaliData.getAgreements).toBeInstanceOf(Function);
-    expect(kaliData.getArticleWithParentSections).toBeInstanceOf(Function);
     expect(kaliData.getArticleWithPath).toBeInstanceOf(Function);
     expect(kaliData.getArticles).toBeInstanceOf(Function);
     expect(kaliData.getIndexedArticle).toBeInstanceOf(Function);

package/src/index.d.ts

@@ -7,18 +7,6 @@
  */
 export function getAgreement(agreementIdOrIdcc: number | string): KaliData.Agreement;
 
-/**
- * Get a flat unist array of all the articles an agreement contains.
- * Each article includes a list of its parent sections.
- *
- * @see https://github.com/syntax-tree/unist
- *
- * @deprecated Use `getAgreementArticlesWithPath()` instead.
- */
-export function getAgreementArticlesWithParentSections(
-    agreementIdOrIdcc: number | string,
-): KaliData.AgreementArticleWithParentSections[];
-
 /**
  * Get a flat unist array of all the articles an agreement contains.
  * Each article includes its parent sections path, as an ordered list of their titles.
@@ -44,17 +32,6 @@ export function getAgreements(): KaliData.IndexedAgreement[];
  */
 export function getArticles(): KaliData.IndexedArticle[];
 
-/**
- * Get an agreement article unist node with its parent sections.
- *
- * @see https://github.com/syntax-tree/unist
- *
- * @deprecated Use `getArticleWithPath()` instead.
- */
-export function getArticleWithParentSections(
-    articleIdOrCid: string,
-): KaliData.AgreementArticleWithParentSections;
-
 /**
  * Get an agreement article unist node with its parent sections path.
  * The parent sections path is represented as an ordered array of their titles.
@@ -200,6 +177,7 @@ type IndexedAgreement = {
     title: string;
     url?: string;
     synonymes?: string[];
+    fetchArticles?: boolean;
 };
 
 type IndexedArticle = {

package/src/index.js

@@ -1,10 +1,8 @@
 // @ts-check
 
 const getAgreement = require("./libs/getAgreement");
-const getAgreementArticlesWithParentSections = require("./libs/getAgreementArticlesWithParentSections");
 const getAgreementArticlesWithPath = require("./libs/getAgreementArticlesWithPath");
 const getAgreements = require("./libs/getAgreements");
-const getArticleWithParentSections = require("./libs/getArticleWithParentSections");
 const getArticleWithPath = require("./libs/getArticleWithPath");
 const getAgreementIdFromIdOrIdcc = require("./libs/getAgreementIdFromIdOrIdcc");
 const getArticles = require("./libs/getArticles");
@@ -15,12 +13,10 @@ const getAgreementsWithNoId = require("./libs/getAgreementsWithNoId");
 
 module.exports = {
     getAgreement,
-    getAgreementArticlesWithParentSections,
     getAgreementArticlesWithPath,
     getAgreementIdFromIdOrIdcc,
     getAgreements,
     getAgreementsWithNoId,
-    getArticleWithParentSections,
     getArticleWithPath,
     getArticles,
     getIndexedArticle,

package/src/libs/__tests__/getArticleWithPath.test.js

@@ -3,18 +3,18 @@ import getArticleWithPath from "../getArticleWithPath";
 describe(`libs/getArticleWithPath()`, () => {
     describe(`should match properties`, () => {
         it(`with an existing main article ID`, () => {
-            const received = getArticleWithPath("KALIARTI000005781818");
+            const received = getArticleWithPath("KALIARTI000043941797");
 
-            expect(received.data.cid).toBe("KALIARTI000005781818");
-            expect(received.data.id).toBe("KALIARTI000005781818");
+            expect(received.data.cid).toBe("KALIARTI000043941797");
+            expect(received.data.id).toBe("KALIARTI000043941797");
             expect(received.path.length).toBeGreaterThan(1);
         });
 
         it(`with an existing main article CID`, () => {
-            const received = getArticleWithPath("KALIARTI000005781804");
+            const received = getArticleWithPath("KALIARTI000005849315");
 
-            expect(received.data.cid).toBe("KALIARTI000005781804");
-            expect(received.data.id).toBe("KALIARTI000045466361");
+            expect(received.data.cid).toBe("KALIARTI000005849315");
+            expect(received.data.id).toBe("KALIARTI000005849317");
             expect(received.path.length).toBeGreaterThan(1);
         });
 

package/src/libs/__tests__/getAgreementArticlesWithParentSections.test.js

@@ -1,23 +0,0 @@
-import getAgreementArticlesWithParentSections from "../getAgreementArticlesWithParentSections";
-
-describe(`libs/getAgreementArticlesWithParentSections()`, () => {
-    describe(`should match snapshot`, () => {
-        it(`with an existing agreement ID`, () => {
-            const received = getAgreementArticlesWithParentSections("KALICONT000005635221");
-
-            expect(received[0].sections.length).toBeGreaterThan(1);
-        });
-
-        it(`with an existing agreement IDCC (string)`, () => {
-            const received = getAgreementArticlesWithParentSections("1480");
-
-            expect(received[0].sections.length).toBeGreaterThan(1);
-        });
-
-        it(`with an existing agreement IDCC (number)`, () => {
-            const received = getAgreementArticlesWithParentSections(1480);
-
-            expect(received[0].sections.length).toBeGreaterThan(1);
-        });
-    });
-});

package/src/libs/__tests__/getArticleWithParentSections.test.js

@@ -1,29 +0,0 @@
-import getArticleWithParentSections from "../getArticleWithParentSections";
-
-describe(`libs/getArticleWithParentSections()`, () => {
-    describe(`should match properties`, () => {
-        it(`with an existing main article ID`, () => {
-            const received = getArticleWithParentSections("KALIARTI000005781804");
-
-            expect(received.data.cid).toBe("KALIARTI000005781804");
-            expect(received.data.id).toBe("KALIARTI000045466361");
-            expect(received.sections.length).toBeGreaterThan(1);
-        });
-
-        it(`with an existing main article CID`, () => {
-            const received = getArticleWithParentSections("KALIARTI000005781804");
-
-            expect(received.data.cid).toBe("KALIARTI000005781804");
-            expect(received.data.id).toBe("KALIARTI000045466361");
-            expect(received.sections.length).toBeGreaterThan(1);
-        });
-
-        it(`with an existing additional article ID`, () => {
-            const received = getArticleWithParentSections("KALIARTI000041787475");
-
-            expect(received.data.cid).toBe("KALIARTI000041787475");
-            expect(received.data.id).toBe("KALIARTI000041787475");
-            expect(received.sections.length).toBeGreaterThan(1);
-        });
-    });
-});

package/src/libs/getAgreementArticlesWithParentSections.js

@@ -1,43 +0,0 @@
-// @ts-check
-
-const unistUtilFlatFilter = require("unist-util-flat-filter");
-
-const getAgreement = require("./getAgreement");
-const getArticleWithParentSections = require("./getArticleWithParentSections");
-
-/**
- * Get a flat unist array of all the articles an agreement contains.
- * Each article includes a list of its parent sections.
- *
- * @param {number | string} agreementIdOrIdcc
- *
- * @returns {KaliData.AgreementArticleWithParentSections[]}
- *
- * @deprecated Use `getAgreementArticlesWithPath()` instead.
- */
-function getAgreementArticlesWithParentSections(agreementIdOrIdcc) {
-    const agreement = getAgreement(agreementIdOrIdcc);
-
-    const articles =
-        /** @type {{ children: KaliData.AgreementArticle[], type: "root" }} */
-        (/** @type {*} */ (unistUtilFlatFilter(agreement, { type: "article" })));
-    const articleIds = articles.children.map(({ data: { id } }) => id);
-
-    const articlesWithParentSections = articleIds.reduce(
-        (prevArticlesWithParentSections, articleId) => {
-            try {
-                const articleWithParentSections = getArticleWithParentSections(articleId);
-                // console.log(articleWithParentSections);
-
-                return [...prevArticlesWithParentSections, articleWithParentSections];
-            } catch (err) {
-                return prevArticlesWithParentSections;
-            }
-        },
-        [],
-    );
-
-    return articlesWithParentSections;
-}
-
-module.exports = getAgreementArticlesWithParentSections;

package/src/libs/getArticleWithParentSections.js

@@ -1,91 +0,0 @@
-// @ts-check
-/**
- * @typedef AgreementArticleWithParent
- * @property {"article"} type
- * @property {KaliData.AgreementArticleData} data
- * @property {AgreementSectionWithParent} parent
- *
- * @typedef AgreementSectionWithParent
- * @property {"section"} type
- * @property {KaliData.AgreementSectionData} data
- * @property {KaliData.AgreementArticle[]} children
- * @property {AgreementSectionWithParent} parent
- */
-
-const unistUtilFind = require("unist-util-find");
-
-const getAgreement = require("./getAgreement");
-const getIndexedArticle = require("./getIndexedArticle");
-
-/**
- * @param {KaliData.Agreement} agreement
- * @param {Partial<KaliData.AgreementArticleData>} data
- *
- * @returns {AgreementArticleWithParent=}
- */
-const findArticleWithData = (agreement, data) =>
-    unistUtilFind(agreement, {
-        data,
-        type: "article",
-    });
-
-/**
- * @param {AgreementArticleWithParent} article
- *
- * @returns {KaliData.AgreementArticleWithParentSections["sections"]}
- */
-const getParentSectionsFromArticle = article => {
-    const sections = [];
-    let section = article.parent;
-
-    while (section) {
-        const { data, type } = section;
-        sections.unshift({ data, type });
-
-        section = section.parent;
-    }
-
-    return sections;
-};
-
-/**
- * Get an agreement article unist node with its parent sections.
- *
- * @param {string} articleIdOrCid
- *
- * @returns {KaliData.AgreementArticleWithParentSections}
- *
- * @deprecated Use `getArticleWithPath()` instead.
- */
-function getArticleWithParentSections(articleIdOrCid) {
-    const { agreementId } = getIndexedArticle(articleIdOrCid);
-    const agreement = getAgreement(agreementId);
-
-    // First attempt with an article ID:
-    const maybeArticleWithId = findArticleWithData(agreement, { id: articleIdOrCid });
-    if (maybeArticleWithId !== undefined) {
-        /** @type {KaliData.AgreementArticleWithParentSections} */
-        const articleWithParentSections = {
-            ...maybeArticleWithId,
-            sections: getParentSectionsFromArticle(maybeArticleWithId),
-        };
-
-        return articleWithParentSections;
-    }
-
-    // Second attempt with an article CID:
-    const maybeArticleWithCid = findArticleWithData(agreement, { cid: articleIdOrCid });
-    if (maybeArticleWithCid === undefined) {
-        throw new Error(`No agreement article found with this ID or CID (${articleIdOrCid}).`);
-    }
-
-    /** @type {KaliData.AgreementArticleWithParentSections} */
-    const articleWithParentSections = {
-        ...maybeArticleWithCid,
-        sections: getParentSectionsFromArticle(maybeArticleWithCid),
-    };
-
-    return articleWithParentSections;
-}
-
-module.exports = getArticleWithParentSections;