@iiasa/ixmp4-ts 0.5.0 → 0.7.0

package/dist/cjs/data/unit.js

@@ -32,16 +32,21 @@ class UnitRepository extends base_1.BaseRepository {
             return (yield this._get({ name }));
         });
     }
-    list(filter = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
+    list() {
+        return __awaiter(this, arguments, void 0, function* (filter = {}) {
             return (yield this._list({ filter }));
         });
     }
-    tabulate(filter = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
+    tabulate() {
+        return __awaiter(this, arguments, void 0, function* (filter = {}) {
             return yield this._tabulate({ filter });
         });
     }
+    count() {
+        return __awaiter(this, arguments, void 0, function* (filter = {}) {
+            return yield this._count({ filter });
+        });
+    }
 }
 exports.UnitRepository = UnitRepository;
 UnitRepository.prefix = 'units/';

package/dist/cjs/data/utils.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonToDf = exports.dfToJson = exports.convertStringToSnakeCase = exports.convertToSnakeCase = void 0;
+exports.convertToSnakeCase = convertToSnakeCase;
+exports.convertStringToSnakeCase = convertStringToSnakeCase;
+exports.dfToJson = dfToJson;
+exports.jsonToDf = jsonToDf;
 const dataframe_1 = require("../dataframe");
 function convertStringToSnakeCase(name) {
     return name.replaceAll(/([A-Z_])/g, '_$1').toLowerCase();
 }
-exports.convertStringToSnakeCase = convertStringToSnakeCase;
 function convertToSnakeCase(obj) {
     const snakeCaseObj = {};
     for (const [key, value] of Object.entries(obj)) {
@@ -18,7 +20,6 @@ function convertToSnakeCase(obj) {
     }
     return snakeCaseObj;
 }
-exports.convertToSnakeCase = convertToSnakeCase;
 function dfToJson(df) {
     return {
         index: df.index,
@@ -44,7 +45,6 @@ function dfToJson(df) {
         data: df.values,
     };
 }
-exports.dfToJson = dfToJson;
 function jsonToDf(json) {
     return new dataframe_1.DataFrame(json.data, {
         index: json.index,
@@ -67,4 +67,3 @@ function jsonToDf(json) {
         }),
     });
 }
-exports.jsonToDf = jsonToDf;

package/dist/cjs/dataframe/dataframe.js

@@ -191,11 +191,7 @@ class DataFrame {
             values = options.rows.map((i) => values[i]);
             index = options.rows.map((i) => index[i]);
         }
-        return new DataFrame(values, {
-            index,
-            columns,
-            dtypes,
-        });
+        return new DataFrame(values, { index, columns, dtypes });
     }
     /**
      * Returns the value at the specified index and column.

package/dist/cjs/dataframe/utils.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.merge = exports.toCsv = exports.toJson = exports.concat = void 0;
+exports.concat = concat;
+exports.toJson = toJson;
+exports.toCsv = toCsv;
+exports.merge = merge;
 const dataframe_1 = require("./dataframe");
 /**
  * Concatenates multiple DataFrames along a specified axis.
@@ -18,7 +21,6 @@ function concat(options) {
     else
         throw new Error('Invalid value for axis parameter');
 }
-exports.concat = concat;
 /**
  * Converts a DataFrame to a JSON object.
  *
@@ -33,7 +35,6 @@ function toJson(df) {
         data: df.values,
     };
 }
-exports.toJson = toJson;
 /**
  * Converts a DataFrame to a CSV string.
  *
@@ -63,7 +64,6 @@ function toCsv(options) {
     });
     return header + rows.join('\n');
 }
-exports.toCsv = toCsv;
 /**
  * Merges two DataFrames based on specified columns.
  *
@@ -190,7 +190,6 @@ function merge(options) {
         dtypes,
     });
 }
-exports.merge = merge;
 /* PRIVATE */
 function concatRows(dataFrames, addMissingColumns) {
     if (!arraysEqual(...dataFrames.map((df) => df.columns))) {

package/dist/cjs/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidIndex = exports.InvalidColumn = exports.DataFrameError = exports.merge = exports.toCsv = exports.toJson = exports.concat = exports.DType = exports.DataFrame = exports.InvalidCredentials = exports.BadFilterArguments = exports.InvalidRunMeta = exports.NoDefaultRunVersion = exports.SchemaError = exports.OperationNotSupported = exports.DeletionPrevented = exports.NotUnique = exports.NotFound = exports.Forbidden = exports.InvalidToken = exports.MissingToken = exports.PlatformNotUnique = exports.PlatformNotFound = exports.UnknownApiError = exports.ManagerApiError = exports.ImproperlyConfigured = exports.BadRequest = exports.InconsistentIamcType = exports.ProgrammingError = exports.IxmpError = exports.Platform = void 0;
+exports.InvalidIndex = exports.InvalidColumn = exports.DataFrameError = exports.merge = exports.toCsv = exports.toJson = exports.concat = exports.DType = exports.DataFrame = exports.InvalidCredentials = exports.BadFilterArguments = exports.InvalidRunMeta = exports.NoDefaultRunVersion = exports.SchemaError = exports.OperationNotSupported = exports.DeletionPrevented = exports.NotUnique = exports.NotFound = exports.Forbidden = exports.InvalidToken = exports.MissingToken = exports.PlatformNotUnique = exports.PlatformNotFound = exports.UnknownApiError = exports.ManagerApiError = exports.ImproperlyConfigured = exports.BadRequest = exports.InconsistentIamcType = exports.ProgrammingError = exports.IxmpError = exports.DataPointType = exports.Platform = void 0;
 var platform_1 = require("./core/platform");
 Object.defineProperty(exports, "Platform", { enumerable: true, get: function () { return platform_1.Platform; } });
+var datapoint_1 = require("./data/iamc/datapoint");
+Object.defineProperty(exports, "DataPointType", { enumerable: true, get: function () { return datapoint_1.DataPointType; } });
 var exceptions_1 = require("./core/exceptions");
 Object.defineProperty(exports, "IxmpError", { enumerable: true, get: function () { return exceptions_1.IxmpError; } });
 Object.defineProperty(exports, "ProgrammingError", { enumerable: true, get: function () { return exceptions_1.ProgrammingError; } });

package/dist/cjs/tsconfig.cjs.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../../src/backend.ts","../../src/index.ts","../../src/core/base.ts","../../src/core/exceptions.ts","../../src/core/meta.ts","../../src/core/model.ts","../../src/core/platform.ts","../../src/core/region.ts","../../src/core/run.ts","../../src/core/scenario.ts","../../src/core/unit.ts","../../src/core/utils.ts","../../src/core/iamc/data.ts","../../src/core/iamc/variable.ts","../../src/data/base.ts","../../src/data/docs.ts","../../src/data/filters.ts","../../src/data/info.ts","../../src/data/meta.ts","../../src/data/model.ts","../../src/data/region.ts","../../src/data/run.ts","../../src/data/scenario.ts","../../src/data/unit.ts","../../src/data/utils.ts","../../src/data/iamc/datapoint.ts","../../src/data/iamc/index.ts","../../src/data/iamc/timeseries.ts","../../src/data/iamc/variable.ts","../../src/dataframe/dataframe.ts","../../src/dataframe/exceptions.ts","../../src/dataframe/index.ts","../../src/dataframe/utils.ts"],"version":"5.9.2"}

package/dist/esm/backend.js

@@ -64,23 +64,26 @@ class Backend {
             client.interceptors.response.use((value) => {
                 return value;
             }, async (err) => {
-                if (err.response &&
+                const originalRequest = err.config;
+                if (!originalRequest._retry &&
+                    err.response &&
                     ((err.response.status === 401 &&
                         err.response.data.error_name === 'invalid_token') ||
                         (err.response.status === 403 &&
                             err.response.data.error_name === 'forbidden' &&
                             auth.accessToken === null))) {
+                    originalRequest._retry = true;
                     return await auth
                         .refreshOrObtainAccessToken()
                         .then(() => {
                         return client.request(err.config);
                     })
-                        .catch(() => {
-                        throw new Error('Failed to retrieve or refresh token');
+                        .catch((error) => {
+                        return Promise.reject(error);
                     });
                 }
                 else {
-                    throw err;
+                    return Promise.reject(err);
                 }
             });
         }

package/dist/esm/core/iamc/data.js

@@ -1,6 +1,7 @@
 import { merge } from '../../dataframe';
 import { BaseFacade } from '../base';
-import { dfToDimensionless, substitudeType, toIamcWide } from '../utils';
+import { DataPointType } from '../../data/iamc/datapoint';
+import { dfToDimensionless, substitudeType, toIamcWide, splitDataFrameByType, standardizeIamcDf, } from '../utils';
 import { VariableRepository } from './variable';
 /**
  * Represents IAMC format data for a specific Run.
@@ -48,15 +49,9 @@ class RunIamcData extends BaseFacade {
         df = df.dropColumns(['unit', 'variable', 'region']);
         await this.backend.iamc.datapoints.bulkDelete(df);
     }
-    /**
-     * Tabulates IAMC format timeseries data with optional filtering.
-     * @param filter Optional. Filter for tabulating IAMC format timeseries data.
-     * @param wide Optional. Whether to return the data in IAMC wide format or not, defaults to false.
-     * @returns A DataFrame representing the tabulated data.
-     * @throws An error if illegal filters are applied.
-     */
-    async tabulate({ wide = false, ...filter } = {
+    async tabulate({ wide = false, splitByType = false, ...filter } = {
         wide: false,
+        splitByType: false,
     }) {
         if (filter !== undefined && filter !== null) {
             // these filters do not make sense when applied from a Run
@@ -67,12 +62,14 @@ class RunIamcData extends BaseFacade {
                 throw new Error(`Illegal filter for 'iamc.tabulate()': ${illegalFilter}`);
             }
         }
-        return await this.repository.tabulate({
+        const df = await this.repository.tabulate({
+            ...filter,
             run: { id: this.run.id, defaultOnly: false },
             joinRuns: false,
             wide,
-            ...filter,
+            splitByType,
         });
+        return df;
     }
     async contractParameters(df) {
         let timeseriesDf = df
@@ -116,17 +113,7 @@ class PlatformIamcData extends BaseFacade {
         super(backend);
         this.variables = new VariableRepository(this.backend);
     }
-    /**
-     * Tabulates IAMC data with optional filtering.
-     * @param filter Optional. Filter for retrieving IAMC data.
-     * @param joinRuns Optional. Whether to join runs or not, defaults to true.
-     * @param wide Optional. Whether to return the data in IAMC wide format or not, defaults to false.
-     * @returns A Promise that resolves to a DataFrame containing the tabulated data.
-     */
-    async tabulate({ joinRuns = true, wide = false, ...filter } = {
-        joinRuns: true,
-        wide: false,
-    }) {
+    async tabulate({ joinRuns = true, wide = false, splitByType = false, ...filter } = { joinRuns: true, wide: false, splitByType: false }) {
         if (filter === undefined) {
             filter = {};
         }
@@ -135,19 +122,52 @@ class PlatformIamcData extends BaseFacade {
             filter['run'] = { defaultOnly: true };
         }
         const joinParameters = true;
-        let df = await this.backend.iamc.datapoints.tabulate({
+        let df = (await this.backend.iamc.datapoints.tabulate({
             joinRuns,
             joinParameters,
             filter,
-        });
-        // df = df.dropNa({ axis: 1 });
-        if (df.columns.includes('time_series__id')) {
-            df = df.dropColumns(['time_series__id']);
+        }));
+        if (splitByType) {
+            const splitDfs = splitDataFrameByType(df);
+            const typeMapping = {
+                annual: DataPointType.ANNUAL,
+                categorical: DataPointType.CATEGORICAL,
+                datetime: DataPointType.DATETIME,
+            };
+            const presentTypes = [];
+            Object.entries(typeMapping).forEach(([key, type]) => {
+                const typedKey = key;
+                if (splitDfs[typedKey]) {
+                    presentTypes.push(type);
+                    if (wide) {
+                        splitDfs[typedKey] = toIamcWide(splitDfs[typedKey]);
+                    }
+                    splitDfs[typedKey] = standardizeIamcDf(splitDfs[typedKey]);
+                }
+            });
+            return { presentTypes, ...splitDfs };
         }
-        if (df.columns.includes('unit')) {
-            df = df.replaceValue('dimensionless', ' ', 'unit');
+        else {
+            if (wide) {
+                df = toIamcWide(df);
+            }
+            return standardizeIamcDf(df);
+        }
+    }
+    /**
+     * Counts IAMC datapoints with optional filtering.
+     * @param filter Optional. Filter for counting IAMC datapoints.
+     * @returns A promise that resolves to the count of datapoints.
+     */
+    async count(filter) {
+        if (filter === undefined) {
+            filter = {};
+        }
+        // return only default runs unless a run-filter is provided
+        if (!Object.hasOwn(filter, 'run')) {
+            filter['run'] = { defaultOnly: true };
         }
-        return wide ? toIamcWide(df) : df;
+        return this.backend.iamc.datapoints.count(filter);
     }
 }
 export { RunIamcData, PlatformIamcData };

package/dist/esm/core/iamc/variable.js

@@ -109,5 +109,13 @@ class VariableRepository extends BaseFacade {
     async tabulate(filter) {
         return this.backend.iamc.variables.tabulate(filter);
     }
+    /**
+     * Counts Variables with optional filtering.
+     * @param filter Optional. Filter for counting Variables.
+     * @returns A Promise that resolves to the count of Variables.
+     */
+    async count(filter) {
+        return this.backend.iamc.variables.count(filter);
+    }
 }
 export { Variable, VariableRepository };

package/dist/esm/core/meta.js

@@ -18,6 +18,14 @@ class MetaIndicatorRepository extends BaseFacade {
         }
         return await this.backend.meta.tabulate(filter, joinRunIndex);
     }
+    /**
+     * Counts meta indicators with optional filtering.
+     * @param filter Optional. Filter for counting meta indicators.
+     * @returns A promise that resolves to the count of meta indicators.
+     */
+    async count(filter) {
+        return this.backend.meta.count(filter || {});
+    }
 }
 /**
  * Repository for accessing meta indicators of a specific run.

package/dist/esm/core/model.js

@@ -1,4 +1,5 @@
 import { BaseFacade, BaseModelFacade } from './base';
+import { withIamcDefault } from './utils';
 /**
  * Represents a model in the assessment modeling system.
  */
@@ -96,7 +97,7 @@ class ModelRepository extends BaseFacade {
      * @returns A promise that resolves to an array of models.
      */
     async list(filter) {
-        const models = await this.backend.models.list(filter);
+        const models = await this.backend.models.list(withIamcDefault(filter));
         return models.map((model) => {
             return new Model(this.backend, model);
         });
@@ -107,7 +108,15 @@ class ModelRepository extends BaseFacade {
      * @returns A promise that resolves to the tabulated result.
      */
     async tabulate(filter) {
-        return this.backend.models.tabulate(filter);
+        return this.backend.models.tabulate(withIamcDefault(filter));
+    }
+    /**
+     * Counts models with optional filtering.
+     * @param filter Optional. Filter for counting models.
+     * @returns A promise that resolves to the count of models.
+     */
+    async count(filter) {
+        return this.backend.models.count(withIamcDefault(filter));
     }
 }
 export { Model, ModelRepository };

package/dist/esm/core/region.js

@@ -1,4 +1,5 @@
 import { BaseFacade, BaseModelFacade } from './base';
+import { withIamcDefault } from './utils';
 /**
  * Represents a unit in the system.
  */
@@ -126,7 +127,7 @@ class RegionRepository extends BaseFacade {
      * @returns A promise that resolves to an array of regions.
      */
     async list(filter) {
-        return this.backend.regions.list(filter).then((models) => {
+        return this.backend.regions.list(withIamcDefault(filter)).then((models) => {
             return models.map((model) => new Region(this.backend, model));
         });
     }
@@ -136,7 +137,15 @@ class RegionRepository extends BaseFacade {
      * @returns A promise that resolves to a DataFrame containing the tabulated regions.
      */
     async tabulate(filter) {
-        return this.backend.regions.tabulate(filter);
+        return this.backend.regions.tabulate(withIamcDefault(filter));
+    }
+    /**
+     * Counts regions with optional filtering.
+     * @param filter Optional. Filter for counting regions.
+     * @returns A promise that resolves to the count of regions.
+     */
+    async count(filter) {
+        return this.backend.regions.count(withIamcDefault(filter));
     }
 }
 export { Region as Region, RegionRepository };

package/dist/esm/core/run.js

@@ -1,6 +1,7 @@
 import { BaseFacade, BaseModelFacade } from './base';
 import { RunIamcData } from './iamc/data';
 import { RunMetaIndicatorRepository } from './meta';
+import { withIamcDefault } from './utils';
 /**
  * Represents a Modeling Run.
  */
@@ -135,7 +136,7 @@ class RunRepository extends BaseFacade {
         if (filter.defaultOnly === undefined) {
             filter.defaultOnly = true;
         }
-        const runs = await this.backend.runs.list(filter);
+        const runs = await this.backend.runs.list(withIamcDefault(filter));
         const runPromises = runs.map(async (run) => {
             return new Run(this.backend, run);
         });
@@ -150,7 +151,7 @@ class RunRepository extends BaseFacade {
         if (filter.defaultOnly === undefined) {
             filter.defaultOnly = true;
         }
-        const df = await this.backend.runs.tabulate(filter);
+        const df = await this.backend.runs.tabulate(withIamcDefault(filter));
         const models = await this.backend.models.list();
         const scenarios = await this.backend.scenarios.list();
         const modelNames = df.columnValues('model__id').map((id) => {
@@ -166,5 +167,13 @@ class RunRepository extends BaseFacade {
             columns: ['id', 'model', 'scenario', 'version', 'is_default'],
         });
     }
+    /**
+     * Counts runs with optional filtering.
+     * @param filter Optional. Filter for counting runs.
+     * @returns A promise that resolves to the count of runs.
+     */
+    async count(filter = {}) {
+        return this.backend.runs.count(withIamcDefault(filter));
+    }
 }
 export { Run, RunRepository };

package/dist/esm/core/scenario.js

@@ -1,4 +1,5 @@
 import { BaseFacade, BaseModelFacade } from './base';
+import { withIamcDefault } from './utils';
 /**
  * Represents a Modeling Scenario.
  */
@@ -103,7 +104,9 @@ class ScenarioRepository extends BaseFacade {
      * @returns A Promise that resolves to an array of Scenarios.
      */
     async list(filter) {
-        return this.backend.scenarios.list(filter).then((models) => {
+        return this.backend.scenarios
+            .list(withIamcDefault(filter))
+            .then((models) => {
             return models.map((model) => new Scenario(this.backend, model));
         });
     }
@@ -113,7 +116,15 @@ class ScenarioRepository extends BaseFacade {
      * @returns A Promise that resolves to a DataFrame containing the tabulated data.
      */
     async tabulate(filter) {
-        return this.backend.scenarios.tabulate(filter);
+        return this.backend.scenarios.tabulate(withIamcDefault(filter));
+    }
+    /**
+     * Counts scenarios with optional filtering.
+     * @param filter Optional. Filter for counting scenarios.
+     * @returns A promise that resolves to the count of scenarios.
+     */
+    async count(filter) {
+        return this.backend.scenarios.count(withIamcDefault(filter));
     }
 }
 export { Scenario, ScenarioRepository };

package/dist/esm/core/unit.js

@@ -1,5 +1,5 @@
 import { BaseFacade, BaseModelFacade } from './base';
-import { unitToDimensionless } from './utils';
+import { withIamcDefault, unitToDimensionless } from './utils';
 /**
  * Represents a unit in the system.
  */
@@ -139,7 +139,7 @@ class UnitRepository extends BaseFacade {
      * @returns A promise that resolves with an array of Unit objects.
      */
     async list(filter) {
-        return this.backend.units.list(filter).then((models) => {
+        return this.backend.units.list(withIamcDefault(filter)).then((models) => {
             return models.map((model) => new Unit(this.backend, model));
         });
     }
@@ -149,7 +149,15 @@ class UnitRepository extends BaseFacade {
      * @returns A promise that resolves with a DataFrame object.
      */
     async tabulate(filter) {
-        return this.backend.units.tabulate(filter);
+        return this.backend.units.tabulate(withIamcDefault(filter));
+    }
+    /**
+     * Counts units with optional filtering.
+     * @param filter Optional. Filter for counting units.
+     * @returns A promise that resolves to the count of units.
+     */
+    async count(filter) {
+        return this.backend.units.count(withIamcDefault(filter));
     }
 }
 export { Unit, UnitRepository };