@dbmx/toasts 0.0.56 → 0.0.60

package/cjs/node_modules/@dbmx/sdmx/cjs/dependencyResolver.cjs

@@ -27,13 +27,17 @@ const getLatest = (ref, range, resources) => {
 };
 
 /**
- * Returns an external resource from the input
+ * Resolves a dependency by finding the appropriate resource based on a version range and returns an external resource from the input
  *
  * @function resolveDependency
  * @tag dependency
- * @param {array} - all possible resources
- * @param {object} - source of the dependency
- * @param {object} - target version
+ * @param {array} - Array of all possible resources
+ * @param {object} - Source object representing the dependency source
+ * @param {object} - Reference object representing the target version
+ * @param {object} - Options object (optional)
+ * @param {boolean} - Flag to indicate whether to suppress errors ([noError=false])
+ * @return {object | undefined} - The resolved resource that matches the reference and version range, or undefined if not found (depending on the 'noError' flag)
+ * @throws {Error} - Throws an error if 'noError' flag is not set and resolution fails
  *
  * @example
  *
@@ -45,7 +49,6 @@ const getLatest = (ref, range, resources) => {
  *   const ref = resolveDependency(resources, { version: 1.0.0 }, { resourceType, agencyID, id, version: '1.1+.0' }
  *   expect(ref.id}.toEqual('ID3')
  */
-
 const resolveDependency = (resources, source, ref, {
   noError
 } = {}) => {
@@ -58,6 +61,16 @@ const resolveDependency = (resources, source, ref, {
     throw err;
   }
 };
+
+/**
+ * Resolves a data target by finding the appropriate resource based on a version range
+ *
+ * @function resolveDataTarget
+ * @tag dependency
+ * @param {Array} - Array of all possible resources
+ * @param {object} - Reference object representing the target version
+ * @return {object | undefined} - The resolved resource that matches the reference and version range, or undefined if not found
+ */
 const resolveDataTarget = (resources, ref) => {
   try {
     const range = semver.Range(ref.version);

package/cjs/node_modules/@dbmx/sdmx/cjs/items.cjs

@@ -12,13 +12,15 @@ function requireItems () {
 	var core$1 = core.__require();
 
 	/**
-	 * Returns  fully qualified items for parent and categories relations
+	 * Retrieves fully qualified items for parent and categories relations
 	 *
 	 * @function getFullyQualifiedItems
 	 * @tag items
 	 * @tag structure
-	 * @param {array} - items
-	 * @param {object} - options [flatten: bool: get flatten array of items ]
+	 * @param {array} - Array of items
+	 * @param {object} - Options object [flatten: bool: get flatten array of items]
+	 * @returns {array} - Array of fully qualified items
+	 * @throws {Error} - Throws an error if an invalid code is encountered
 	 *
 	 * @example
 	 *
@@ -87,6 +89,52 @@ function requireItems () {
 	  scan(items);
 	  return options.flatten ? Object.values(nodes) : Object.values(roots);
 	};
+
+	/**
+	 * Retrieves items for a specified resourceType
+	 *
+	 * @function getItems
+	 * @tag items
+	 * @tag structure
+	 * @param {string} - resourceType
+	 * @param {object} - Values object containing items
+	 * @return {array} - Array of items for the specified resourceType
+	 * @throws {Error} - Throws an error if an invalid resourceType is provided.
+	 *
+	 * @example
+	 *
+	 *   const codes = [
+	 *     { id: 'A', names: { fr: 'A' } },
+	 *     { id: 'E', names: { fr: 'E' } },
+	 *     { id: 'F', parent: 'E', names: { fr: 'F' } },
+	 *     { id: 'B', parent: 'A', names: { fr: 'B' } },
+	 *     { id: 'C', parent: 'A', names: { it: 'C' } },
+	 *     { id: 'D', parent: 'B', names: { fr: 'DD' } },
+	 *   ]
+	 *
+	 *   const categories = [
+	 *     {
+	 *       id: 'A',
+	 *       categories: [
+	 *         {
+	 *           id: 'B',
+	 *           categories: [{ id: 'D' }],
+	 *         },
+	 *         { id: 'C' },
+	 *       ],
+	 *     },
+	 *     {
+	 *       id: 'E',
+	 *       categories: [{ id: 'F' }],
+	 *     },
+	 *   ]
+	 *
+	 *   expect(getItems('codelist', { codes }).length).toEqual(6)
+	 *   expect(getItems('categoryscheme', { categories }).length).toEqual(2)
+	 *   expect(() => getItems(RESOURCES.dataflow, {})).toThrow()
+	 *
+	 */
+
 	const getItems = (resourceType, values) => {
 	  const resource = core$1.getArtefactByType(resourceType);
 	  if (!resource?.isItemScheme) throw new Error(`Invalid resourceType: "${resourceType}"`);

package/cjs/node_modules/@dbmx/sdmx/cjs/types/artefacts.cjs

@@ -13,6 +13,7 @@ var hierarchicalcodelist = require('./hierarchicalcodelist.cjs');
 var dataconstraint = require('./dataconstraint.cjs');
 var provisionagreement = require('./provisionagreement.cjs');
 var metadatastructure = require('./metadatastructure.cjs');
+var metadataflow = require('./metadataflow.cjs');
 
 var hasRequiredArtefacts;
 
@@ -32,7 +33,8 @@ function requireArtefacts () {
 	var dataconstraint$1 = dataconstraint.__require();
 	var provisionagreement$1 = provisionagreement.__require();
 	var metadatastructure$1 = metadatastructure.__require();
-	const Artefacts = [dataflow$1, datastructure$1, codelist$1, categorisation$1, categoryscheme$1, conceptscheme$1, contentconstraint$1, dataconstraint$1, dataproviderscheme$1, hierarchicalcodelist$1, provisionagreement$1, metadatastructure$1];
+	var metadataflow$1 = metadataflow.__require();
+	const Artefacts = [dataflow$1, datastructure$1, codelist$1, categorisation$1, categoryscheme$1, conceptscheme$1, contentconstraint$1, dataconstraint$1, dataproviderscheme$1, hierarchicalcodelist$1, provisionagreement$1, metadatastructure$1, metadataflow$1];
 	artefacts.__exports.Artefacts = Artefacts;
 	return artefacts.__exports;
 }

package/cjs/node_modules/@dbmx/sdmx/cjs/types/hierarchicalcodelist.cjs

@@ -27,7 +27,7 @@ function requireHierarchicalcodelist () {
 	  structureName: 'hierarchicalCodelists',
 	  name: 'hierarchicalcodelist',
 	  packageName: 'codelist',
-	  className: 'Hierarchicalcode',
+	  className: 'HierarchicalCodelist',
 	  version: 2,
 	  getChildRefs
 	});

package/cjs/node_modules/@dbmx/sdmx/cjs/types/metadataflow.cjs

@@ -0,0 +1,32 @@
+'use strict';
+
+require('./sdmx.cjs');
+var core = require('../core.cjs');
+var sdmx = require('../../../../../_virtual/sdmx.cjs');
+
+var metadataflow;
+var hasRequiredMetadataflow;
+
+function requireMetadataflow () {
+	if (hasRequiredMetadataflow) return metadataflow;
+	hasRequiredMetadataflow = 1;
+
+	var sdmx$1 = sdmx.__exports;
+	var core$1 = core.__require();
+	function getChildRefs(input) {
+	  if (input.isExternalReference) return [];
+	  if (!input.structure) return [];
+	  return [core$1.urn2FullRef(input.structure)];
+	}
+	var MetaDataflow = sdmx$1.Artefact({
+	  name: 'metadataflow',
+	  structureName: 'metadataflows',
+	  packageName: 'metadatastructure',
+	  className: 'MetaDataflow',
+	  getChildRefs
+	});
+	metadataflow = MetaDataflow;
+	return metadataflow;
+}
+
+exports.__require = requireMetadataflow;

package/cjs/node_modules/@dbmx/sdmx/esm/core.cjs

@@ -9,19 +9,20 @@ var pick = require('./node_modules/ramda/es/pick.cjs');
 
 /**
  * @typedef Ref
- * @property {string} - agencyID
- * @property {string} - id
- * @property {string} - semver version
- * @property {string} - resourceType
+ * @property {string} - Agency ID of the artefact
+ * @property {string} - ID of the artefact
+ * @property {string} - SemVer version of the artefact
+ * @property {string} - Resource Type
  */
 
 /**
  * Array of SDMX Artefact to get artefact description
- * @property {string} name - name use in rest API
- * @property {package} packageName - package's name use to build urn
- * @property {package} className - class's name use to build urn
- * @property {package} structureName - name use in structure messages
+ * @property {string} - Name used in the REST API
+ * @property {string} - Package's name used to build the URN
+ * @property {string} - Class's name used to build the URN
+ * @property {string} - Name used in structure messages
  *
+ * @constant
  * @function SDMXTypes
  * @tag core
  * @tag types
@@ -132,16 +133,6 @@ const SDMXTypes = [
     packageName: 'metadatastructure',
     className: 'MetadataAttributeDescriptor',
   }),
-  sdmx.SDMX({
-    name: 'metadataStructure',
-    packageName: 'metadatastructure',
-    className: 'MetadataStructure',
-  }),
-  sdmx.SDMX({
-    name: 'metadataflow',
-    packageName: 'metadatastructure',
-    className: 'Metadataflow',
-  }),
   sdmx.SDMX({
     name: 'metadataSet',
     packageName: 'metadatastructure',
@@ -233,11 +224,6 @@ const SDMXTypes = [
     packageName: 'codelist',
     className: 'Code',
   }),
-  sdmx.SDMX({
-    name: 'hierarchicalCode',
-    packageName: 'codelist',
-    className: 'HierarchicalCode',
-  }),
   sdmx.SDMX({
     name: 'hierarchy',
     packageName: 'codelist',
@@ -331,9 +317,10 @@ const SDMXTypes = [
   ...artefacts.Artefacts,
 ];
 
-/*
+/**
  * Object to get an artefact description from its structure name
  *
+ * @constant
  * @function STRUCTURE_NAMES
  * @tag artefact
  * @tag core
@@ -344,9 +331,10 @@ SDMXTypes.reduce((acc, artefact) => {
   return acc
 }, {});
 
-/*
+/**
  * Object to get an artefact description from its class name
  *
+ * @constant
  * @function CLASSES
  * @tag artefact
  * @tag core
@@ -357,11 +345,11 @@ SDMXTypes.reduce((acc, artefact) => {
   return acc
 }, {});
 
-/*
+/**
  * Object to get an artefact description from its name
  *
- * @function RESOURCES
  * @constant
+ * @function RESOURCES
  * @tag artefact
  * @tag core
  */
@@ -389,7 +377,8 @@ const hArtefactUrnTypes = SDMXTypes.reduce((acc, artefact) => {
  * @function getArtefactByType
  * @tag artefact
  * @tag core
- * @return AttributeDescriptor
+ * @param {string} - Artefact type
+ * @return {AttributeDescriptor}
  *
  * @example
  *    getArtefactByType('dataflow') //=> ArtefactDescription
@@ -398,13 +387,13 @@ const hArtefactUrnTypes = SDMXTypes.reduce((acc, artefact) => {
 const getArtefactByType = type => hResourceTypes[type];
 
 /**
- * Returns artefact description
+ * Returns artefact description from its URN type
  *
  * @function getArtefactByUrnType
  * @tag artefact
  * @tag core
- * @param {string} - packageName
- * @param {string} - className
+ * @param {string} - Package name
+ * @param {string} - Class name
  * @return {ArtefactDescription}
  *
  * @example
@@ -415,13 +404,13 @@ const getArtefactByUrnType = (packageName, className) => hArtefactUrnTypes[urnTy
 // const parseURN = urn => urn.match(/^urn:sdmx:org\.sdmx\.infomodel\.(\w+)\.(\w+)=(.+):(.+)\((.+)\)(?:\.([\w.-]+))?/)
 const parseURN = urn => urn.match(/^urn:sdmx:org\.sdmx\.infomodel\.(\w+)\.(\w+)=(.+):(.+)\((.+)\)(?:\.(.+))?/);
 /**
- * Returns full ref from URN
+ * Returns full reference from URN
  *
  * @function urn2FullRef
  * @tag core
  * @tag URN
- * @param {string} - urn
- * @return  {FullRef} -
+ * @param {string} - URN
+ * @return  {FullRef} - Full reference
  *
  * @example
  *
@@ -447,12 +436,13 @@ const urn2FullRef = urn => {
 };
 
 /**
- * Returns a Ref from a resource
+ * Returns a reference from a resource
  *
  * @function getRef
  * @tag core
  * @tag resource
- * @param {object} - input structure
+ * @param {object} - Input structure
+ * @param {string=} - Resource type
  * @return {Ref} - pick(['agencyID', 'id', 'version'], resource)
  *
  */
@@ -467,6 +457,9 @@ const getRef = (resource = {}, resourceType) => {
 /**
  * Returns an identifier for an artefact based on { agencyID, id, version }
  *
+ * @function ID
+ * @tag core
+ * @param {object} - Source input
  * @example
  *
  *   const resource1 = { agencyID: 'AG', id: 'ID1', version: '1.0.3'}

package/cjs/node_modules/@dbmx/sdmx/esm/datastructures.cjs

@@ -2,16 +2,6 @@
 
 var core = require('./core.cjs');
 
-/**
- * Returns components defined in dataStructure
- *
- * @function getComponents
- * @tag datastructures
- * @param {object} - datastructure
- * @return {array} - array of component
- *
- */
-
 const ComponentTypes = {
   dimension: 'dimension',
   timeDimension: 'timeDimension',
@@ -26,6 +16,16 @@ const getCompId = comp => {
   return comp
 };
 
+/**
+ * Returns timeDimension defined in dataStructure
+ *
+ * @function getTimeDimension
+ * @tag datastructures
+ * @param {object} - dataStructure
+ * @return {array} - timeDimension
+ *
+ */
+
 const getTimeDimension = dataStructure => {
   const timeDimension =
     dataStructure?.dataStructureComponents?.dimensionList?.timeDimension ||
@@ -34,6 +34,16 @@ const getTimeDimension = dataStructure => {
   return { ...getCompId(timeDimension), type: ComponentTypes.timeDimension }
 };
 
+/**
+ * Returns dimensions defined in dataStructure
+ *
+ * @function getDimensions
+ * @tag datastructures
+ * @param {object} - dataStructure
+ * @return {array} - array of dimensions
+ *
+ */
+
 const getDimensions = dataStructure => {
   let res = [];
   const dimensions = dataStructure?.dataStructureComponents?.dimensionList?.dimensions;
@@ -44,6 +54,16 @@ const getDimensions = dataStructure => {
   return res
 };
 
+/**
+ * Returns attributes defined in dataStructure
+ *
+ * @function getAttributes
+ * @tag datastructures
+ * @param {object} - dataStructure
+ * @return {array} - array of attributes
+ *
+ */
+
 const getAttributes = dataStructure => {
   const attributes =
     dataStructure?.dataStructureComponents?.attributeList?.attributes ??
@@ -52,6 +72,16 @@ const getAttributes = dataStructure => {
   return attributes.map(comp => ({ ...getCompId(comp), type: ComponentTypes.attribute }))
 };
 
+/**
+ * Returns measures defined in dataStructure
+ *
+ * @function getMeasures
+ * @tag datastructures
+ * @param {object} - dataStructure
+ * @return {array} - array of measures
+ *
+ */
+
 const getMeasures = dataStructure => {
   const measures =
     dataStructure?.dataStructureComponents?.measureList?.measures ??
@@ -62,6 +92,16 @@ const getMeasures = dataStructure => {
   return measures.map(comp => ({ ...getCompId(comp), type: ComponentTypes.measure }))
 };
 
+/**
+ * Returns components defined in dataStructure
+ *
+ * @function getComponents
+ * @tag datastructures
+ * @param {object} - datastructure
+ * @return {array} - array of component
+ *
+ */
+
 const getComponents = dataStructure => {
   return [...getDimensions(dataStructure), ...getMeasures(dataStructure), ...getAttributes(dataStructure)]
 };

package/cjs/node_modules/@dbmx/sdmx/esm/dependencyResolver.cjs

@@ -32,13 +32,17 @@ const getLatest = (ref, range, resources) => {
 };
 
 /**
- * Returns an external resource from the input
+ * Resolves a dependency by finding the appropriate resource based on a version range and returns an external resource from the input
  *
  * @function resolveDependency
  * @tag dependency
- * @param {array} - all possible resources
- * @param {object} - source of the dependency
- * @param {object} - target version
+ * @param {array} - Array of all possible resources
+ * @param {object} - Source object representing the dependency source
+ * @param {object} - Reference object representing the target version
+ * @param {object} - Options object (optional)
+ * @param {boolean} - Flag to indicate whether to suppress errors ([noError=false])
+ * @return {object | undefined} - The resolved resource that matches the reference and version range, or undefined if not found (depending on the 'noError' flag)
+ * @throws {Error} - Throws an error if 'noError' flag is not set and resolution fails
  *
  * @example
  *
@@ -50,7 +54,6 @@ const getLatest = (ref, range, resources) => {
  *   const ref = resolveDependency(resources, { version: 1.0.0 }, { resourceType, agencyID, id, version: '1.1+.0' }
  *   expect(ref.id}.toEqual('ID3')
  */
-
 const resolveDependency = (resources, source, ref, { noError } = {}) => {
   try {
     const range = index_esm.Dependency(source, ref.version).range;

package/cjs/node_modules/@dbmx/sdmx/esm/query.cjs

@@ -43,6 +43,66 @@ const makeCParams = obj => {
   return res
 };
 
+/**
+ * @typedef DataQuery
+ * @property {string} - context ('dataflow' by default)
+ * @property {string} - agencyID
+ * @property {string} - resourceID
+ * @property {string} - id
+ * @property {string} - version ('~' by default)
+ * @property {string} - endpoint
+ * @property {array | string} - dimensionAtObservation ('AllDimensions' by default)
+ * @property {object} - c
+ * @property {string} - key
+ * @property {array | string} - attributes - 'all' | 'none' | Array with specified attributes
+ * @property {array | string} - measures - 'all' | 'none' | Array with specified measures
+ * @property {string} - rmin - Minimum data rows to return
+ * @property {string} - rmax - Maximum data rows to return
+ * @property {string} - format - Result format to be returned (JSON - CSV - XML)
+ */
+
+/**
+ * Returns a URL for querying SDMX data based on the provided parameters.
+ *
+ * @function dataQueryUrl
+ * @tag query
+ * @param {DataQuery} - The data query parameters
+ * @return {string} - Returns the constructed URL for querying SDMX data
+ * @throws {Error} Throws an error if required parameters are missing
+
+ *
+ * @example
+ *
+ *   const query = {
+ *     context: 'dataflow',
+ *     agencyID: 'AGENCY',
+ *     id: 'ID',
+ *     version: '1.2.3-draft',
+ *     endpoint: 'https://sxs-staging-orox.dbmx.io/demo/sdmx',
+ *     dimensionAtObservation: 'AllDimensions',
+ *     attributes: ['OATTR4', 'OATTR6'],
+ *     measures: 'none',
+ *     key: 'M.*.EUR.SP00.A',
+ *     c: {
+ *       // INDICATOR: { or: ['MRY0T4','TMY5T9','TMY10T14','TMY15T24']},
+ *       INDICATOR: 'MRY0T4,TMY5T9,TMY10T14,TMY15T24',
+ *       SEX: '_T',
+ *       WEALTH_QUINTILE: '_T',
+ *       REF_AREA: 'AFG,AGO',
+ *       TIME_PERIOD: 'ge:2020-06+le:2020-06',
+ *       TIME_PERIOD1: { ge: '2020-06', le: '2020-06' },
+ *       ATTR1: { and: [{ ge: '2020-06' }, { le: '2020-06' }] },
+ *       ATTR2: { or: [{ co: 'toto' }, { and: [{ ge: '2020-06' }, { le: '2020-06' }] }] },
+ *       ATTR3: { or: [{ co: 'toto' }, { ge: '2020-06', le: '2020-06' }] },
+ *     },
+ *   }
+ *   const res = dataQueryUrl(query)
+ *   expect(res).toEqual(
+ *     'https://sxs-staging-orox.dbmx.io/demo/sdmx/data/dataflow/AGENCY/ID/1.2.3-draft/M.*.EUR.SP00.A?c%5BINDICATOR%5D=MRY0T4%2CTMY5T9%2CTMY10T14%2CTMY15T24&c%5BSEX%5D=_T&c%5BWEALTH_QUINTILE%5D=_T&c%5BREF_AREA%5D=AFG%2CAGO&c%5BTIME_PERIOD%5D=ge%3A2020-06%2Ble%3A2020-06&c%5BTIME_PERIOD1%5D=ge%3A2020-06%2Ble%3A2020-06&c%5BATTR1%5D=ge%3A2020-06%2Ble%3A2020-06&c%5BATTR2%5D=co%3Atoto%2Cge%3A2020-06%2Ble%3A2020-06&c%5BATTR3%5D=co%3Atoto%2Cge%3A2020-06%2Ble%3A2020-06&attributes=OATTR4,OATTR6&measures=none&dimensionAtObservation=AllDimensions',
+ *   )
+ *
+ */
+
 const dataQueryUrl = ({
   context = 'dataflow',
   agencyID,
@@ -53,8 +113,11 @@ const dataQueryUrl = ({
   dimensionAtObservation = 'AllDimensions',
   c,
   key,
-  atttributes,
+  attributes,
   measures,
+  rmin,
+  rmax,
+  format,
 }) => {
   if (!endpoint) throw new Error(`Cannot create structure query URL without an endpoint`)
   if (!agencyID) throw new Error(`Cannot create structure query URL without an agencyID`)
@@ -68,15 +131,18 @@ const dataQueryUrl = ({
     console.error(`Cannot make CFilter for ${JSON.stringify(c, null, 4)}`);
     console.error(err);
   }
-  if (atttributes) {
-    if (is(String, atttributes)) params.push(`?atttributes=${atttributes}`);
-    else params.push(`?atttributes=${atttributes.join(',')}`);
+  if (attributes) {
+    if (is(String, attributes)) params.push(`?attributes=${attributes}`);
+    else params.push(`?attributes=${attributes.join(',')}`);
   }
   if (measures) {
     if (is(String, measures)) params.push(`?measures=${measures}`);
     else params.push(`?measures=${measures.join(',')}`);
   }
   if (dimensionAtObservation) params.push(`?dimensionAtObservation=${dimensionAtObservation}`);
+  if (rmin) params.push(`?rmin=${rmin}`);
+  if (rmax) params.push(`?rmax=${rmax}`);
+  if (format) params.push(`?format=${format}`);
 
   return urlJoin(...params)
 };

package/cjs/node_modules/@dbmx/sdmx/esm/types/artefacts.cjs

@@ -12,6 +12,7 @@ var hierarchicalcodelist = require('./hierarchicalcodelist.cjs');
 var dataconstraint = require('./dataconstraint.cjs');
 var provisionagreement = require('./provisionagreement.cjs');
 var metadatastructure = require('./metadatastructure.cjs');
+var metadataflow = require('./metadataflow.cjs');
 
 const Artefacts = [
   dataflow,
@@ -26,6 +27,7 @@ const Artefacts = [
   hierarchicalcodelist,
   provisionagreement,
   metadatastructure,
+  metadataflow,
 ];
 
 exports.Artefacts = Artefacts;

package/cjs/node_modules/@dbmx/sdmx/esm/types/hierarchicalcodelist.cjs

@@ -14,7 +14,7 @@ var HierarchicalCodelist = sdmx.Artefact({
   structureName: 'hierarchicalCodelists',
   name: 'hierarchicalcodelist',
   packageName: 'codelist',
-  className: 'Hierarchicalcode',
+  className: 'HierarchicalCodelist',
   version: 2,
   getChildRefs,
 });

package/cjs/node_modules/@dbmx/sdmx/esm/types/metadataflow.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+var sdmx = require('./sdmx.cjs');
+var core = require('../core.cjs');
+
+function getChildRefs(input) {
+  if (input.isExternalReference) return []
+  if (!input.structure) return []
+  return [core.urn2FullRef(input.structure)]
+}
+
+var MetaDataflow = sdmx.Artefact({
+  name: 'metadataflow',
+  structureName: 'metadataflows',
+  packageName: 'metadatastructure',
+  className: 'MetaDataflow',
+  getChildRefs,
+});
+
+module.exports = MetaDataflow;