@iiasa/ixmp4-ts 0.5.0 → 0.7.0

package/dist/cjs/backend.js

@@ -70,23 +70,26 @@ class Backend {
                 client.interceptors.response.use((value) => {
                     return value;
                 }, (err) => __awaiter(this, void 0, void 0, function* () {
-                    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 yield 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/cjs/core/exceptions.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.createError = void 0;
+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 = void 0;
+exports.createError = createError;
 class ProgrammingError extends Error {
 }
 exports.ProgrammingError = ProgrammingError;
@@ -210,7 +211,6 @@ function createError(options) {
         return new ImproperlyConfigured(Object.assign({ message: 'Could not find remote exception in registry. Are you sure client and server ixmp versions are compatible?' }, options));
     }
 }
-exports.createError = createError;
 // Register all error classes
 registerError(InconsistentIamcType);
 registerError(BadRequest);

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

@@ -23,6 +23,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlatformIamcData = exports.RunIamcData = void 0;
 const dataframe_1 = require("../../dataframe");
 const base_1 = require("../base");
+const datapoint_1 = require("../../data/iamc/datapoint");
 const utils_1 = require("../utils");
 const variable_1 = require("./variable");
 /**
@@ -70,18 +71,12 @@ class RunIamcData extends base_1.BaseFacade {
             yield 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.
-     */
-    tabulate(_a = {
-        wide: false,
-    }) {
-        var { wide = false } = _a, filter = __rest(_a, ["wide"]);
-        return __awaiter(this, void 0, void 0, function* () {
+    tabulate() {
+        return __awaiter(this, arguments, void 0, function* (_a = {
+            wide: false,
+            splitByType: false,
+        }) {
+            var { wide = false, splitByType = false } = _a, filter = __rest(_a, ["wide", "splitByType"]);
             if (filter !== undefined && filter !== null) {
                 // these filters do not make sense when applied from a Run
                 const illegalFilter = Object.keys(filter).filter((key) => {
@@ -91,7 +86,9 @@ class RunIamcData extends base_1.BaseFacade {
                     throw new Error(`Illegal filter for 'iamc.tabulate()': ${illegalFilter}`);
                 }
             }
-            return yield this.repository.tabulate(Object.assign({ run: { id: this.run.id, defaultOnly: false }, joinRuns: false, wide }, filter));
+            const df = yield this.repository.tabulate(Object.assign(Object.assign({}, filter), { run: { id: this.run.id, defaultOnly: false }, joinRuns: false, wide,
+                splitByType }));
+            return df;
         });
     }
     contractParameters(df) {
@@ -135,19 +132,9 @@ class PlatformIamcData extends base_1.BaseFacade {
         super(backend);
         this.variables = new variable_1.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.
-     */
-    tabulate(_a = {
-        joinRuns: true,
-        wide: false,
-    }) {
-        var { joinRuns = true, wide = false } = _a, filter = __rest(_a, ["joinRuns", "wide"]);
-        return __awaiter(this, void 0, void 0, function* () {
+    tabulate() {
+        return __awaiter(this, arguments, void 0, function* (_a = { joinRuns: true, wide: false, splitByType: false }) {
+            var { joinRuns = true, wide = false, splitByType = false } = _a, filter = __rest(_a, ["joinRuns", "wide", "splitByType"]);
             if (filter === undefined) {
                 filter = {};
             }
@@ -156,19 +143,54 @@ class PlatformIamcData extends base_1.BaseFacade {
                 filter['run'] = { defaultOnly: true };
             }
             const joinParameters = true;
-            let df = yield this.backend.iamc.datapoints.tabulate({
+            let df = (yield 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 = (0, utils_1.splitDataFrameByType)(df);
+                const typeMapping = {
+                    annual: datapoint_1.DataPointType.ANNUAL,
+                    categorical: datapoint_1.DataPointType.CATEGORICAL,
+                    datetime: datapoint_1.DataPointType.DATETIME,
+                };
+                const presentTypes = [];
+                Object.entries(typeMapping).forEach(([key, type]) => {
+                    const typedKey = key;
+                    if (splitDfs[typedKey]) {
+                        presentTypes.push(type);
+                        if (wide) {
+                            splitDfs[typedKey] = (0, utils_1.toIamcWide)(splitDfs[typedKey]);
+                        }
+                        splitDfs[typedKey] = (0, utils_1.standardizeIamcDf)(splitDfs[typedKey]);
+                    }
+                });
+                return Object.assign({ presentTypes }, splitDfs);
             }
-            if (df.columns.includes('unit')) {
-                df = df.replaceValue('dimensionless', ' ', 'unit');
+            else {
+                if (wide) {
+                    df = (0, utils_1.toIamcWide)(df);
+                }
+                return (0, utils_1.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.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 ? (0, utils_1.toIamcWide)(df) : df;
+            return this.backend.iamc.datapoints.count(filter);
         });
     }
 }

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

@@ -136,5 +136,15 @@ class VariableRepository extends base_1.BaseFacade {
             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.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.backend.iamc.variables.count(filter);
+        });
+    }
 }
 exports.VariableRepository = VariableRepository;

package/dist/cjs/core/meta.js

@@ -33,17 +33,27 @@ class MetaIndicatorRepository extends base_1.BaseFacade {
      * @param joinRunIndex Optional. Whether to join the run index to the tabulated data, defaults to true.
      * @returns A promise that resolves to a DataFrame containing the tabulated meta indicators.
      */
-    tabulate(_a = {
-        joinRunIndex: true,
-    }) {
-        var { joinRunIndex = true } = _a, filter = __rest(_a, ["joinRunIndex"]);
-        return __awaiter(this, void 0, void 0, function* () {
+    tabulate() {
+        return __awaiter(this, arguments, void 0, function* (_a = {
+            joinRunIndex: true,
+        }) {
+            var { joinRunIndex = true } = _a, filter = __rest(_a, ["joinRunIndex"]);
             if (filter === undefined) {
                 filter = {};
             }
             return yield 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.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.backend.meta.count(filter || {});
+        });
+    }
 }
 exports.MetaIndicatorRepository = MetaIndicatorRepository;
 /**

package/dist/cjs/core/model.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ModelRepository = exports.Model = void 0;
 const base_1 = require("./base");
+const utils_1 = require("./utils");
 /**
  * Represents a model in the assessment modeling system.
  */
@@ -120,7 +121,7 @@ class ModelRepository extends base_1.BaseFacade {
      */
     list(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            const models = yield this.backend.models.list(filter);
+            const models = yield this.backend.models.list((0, utils_1.withIamcDefault)(filter));
             return models.map((model) => {
                 return new Model(this.backend, model);
             });
@@ -133,7 +134,17 @@ class ModelRepository extends base_1.BaseFacade {
      */
     tabulate(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.models.tabulate(filter);
+            return this.backend.models.tabulate((0, utils_1.withIamcDefault)(filter));
+        });
+    }
+    /**
+     * Counts models with optional filtering.
+     * @param filter Optional. Filter for counting models.
+     * @returns A promise that resolves to the count of models.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.backend.models.count((0, utils_1.withIamcDefault)(filter));
         });
     }
 }

package/dist/cjs/core/region.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegionRepository = exports.Region = void 0;
 const base_1 = require("./base");
+const utils_1 = require("./utils");
 /**
  * Represents a unit in the system.
  */
@@ -152,7 +153,7 @@ class RegionRepository extends base_1.BaseFacade {
      */
     list(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.regions.list(filter).then((models) => {
+            return this.backend.regions.list((0, utils_1.withIamcDefault)(filter)).then((models) => {
                 return models.map((model) => new Region(this.backend, model));
             });
         });
@@ -164,7 +165,17 @@ class RegionRepository extends base_1.BaseFacade {
      */
     tabulate(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.regions.tabulate(filter);
+            return this.backend.regions.tabulate((0, utils_1.withIamcDefault)(filter));
+        });
+    }
+    /**
+     * Counts regions with optional filtering.
+     * @param filter Optional. Filter for counting regions.
+     * @returns A promise that resolves to the count of regions.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.backend.regions.count((0, utils_1.withIamcDefault)(filter));
         });
     }
 }

package/dist/cjs/core/run.js

@@ -13,6 +13,7 @@ exports.RunRepository = exports.Run = void 0;
 const base_1 = require("./base");
 const data_1 = require("./iamc/data");
 const meta_1 = require("./meta");
+const utils_1 = require("./utils");
 /**
  * Represents a Modeling Run.
  */
@@ -150,12 +151,12 @@ class RunRepository extends base_1.BaseFacade {
      * @param filter Optional. Filter for retriving runs.
      * @returns A promise that resolves to an array of Run instances.
      */
-    list(filter = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
+    list() {
+        return __awaiter(this, arguments, void 0, function* (filter = {}) {
             if (filter.defaultOnly === undefined) {
                 filter.defaultOnly = true;
             }
-            const runs = yield this.backend.runs.list(filter);
+            const runs = yield this.backend.runs.list((0, utils_1.withIamcDefault)(filter));
             const runPromises = runs.map((run) => __awaiter(this, void 0, void 0, function* () {
                 return new Run(this.backend, run);
             }));
@@ -167,12 +168,12 @@ class RunRepository extends base_1.BaseFacade {
      * @param filter Optional. Filter for tabulating runs.
      * @returns A promise that resolves to a DataFrame containing the tabulated runs.
      */
-    tabulate(filter = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
+    tabulate() {
+        return __awaiter(this, arguments, void 0, function* (filter = {}) {
             if (filter.defaultOnly === undefined) {
                 filter.defaultOnly = true;
             }
-            const df = yield this.backend.runs.tabulate(filter);
+            const df = yield this.backend.runs.tabulate((0, utils_1.withIamcDefault)(filter));
             const models = yield this.backend.models.list();
             const scenarios = yield this.backend.scenarios.list();
             const modelNames = df.columnValues('model__id').map((id) => {
@@ -189,5 +190,15 @@ class RunRepository extends base_1.BaseFacade {
             });
         });
     }
+    /**
+     * Counts runs with optional filtering.
+     * @param filter Optional. Filter for counting runs.
+     * @returns A promise that resolves to the count of runs.
+     */
+    count() {
+        return __awaiter(this, arguments, void 0, function* (filter = {}) {
+            return this.backend.runs.count((0, utils_1.withIamcDefault)(filter));
+        });
+    }
 }
 exports.RunRepository = RunRepository;

package/dist/cjs/core/scenario.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScenarioRepository = exports.Scenario = void 0;
 const base_1 = require("./base");
+const utils_1 = require("./utils");
 /**
  * Represents a Modeling Scenario.
  */
@@ -127,7 +128,9 @@ class ScenarioRepository extends base_1.BaseFacade {
      */
     list(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.scenarios.list(filter).then((models) => {
+            return this.backend.scenarios
+                .list((0, utils_1.withIamcDefault)(filter))
+                .then((models) => {
                 return models.map((model) => new Scenario(this.backend, model));
             });
         });
@@ -139,7 +142,17 @@ class ScenarioRepository extends base_1.BaseFacade {
      */
     tabulate(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.scenarios.tabulate(filter);
+            return this.backend.scenarios.tabulate((0, utils_1.withIamcDefault)(filter));
+        });
+    }
+    /**
+     * Counts scenarios with optional filtering.
+     * @param filter Optional. Filter for counting scenarios.
+     * @returns A promise that resolves to the count of scenarios.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.backend.scenarios.count((0, utils_1.withIamcDefault)(filter));
         });
     }
 }

package/dist/cjs/core/unit.js

@@ -167,7 +167,7 @@ class UnitRepository extends base_1.BaseFacade {
      */
     list(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.units.list(filter).then((models) => {
+            return this.backend.units.list((0, utils_1.withIamcDefault)(filter)).then((models) => {
                 return models.map((model) => new Unit(this.backend, model));
             });
         });
@@ -179,7 +179,17 @@ class UnitRepository extends base_1.BaseFacade {
      */
     tabulate(filter) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.backend.units.tabulate(filter);
+            return this.backend.units.tabulate((0, utils_1.withIamcDefault)(filter));
+        });
+    }
+    /**
+     * Counts units with optional filtering.
+     * @param filter Optional. Filter for counting units.
+     * @returns A promise that resolves to the count of units.
+     */
+    count(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.backend.units.count((0, utils_1.withIamcDefault)(filter));
         });
     }
 }