@iiasa/ixmp4-ts 0.5.0 → 0.6.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/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,7 @@ 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));
         });
     }
 }

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,7 @@ 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));
         });
     }
 }

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.
  */
@@ -155,7 +156,7 @@ class RunRepository extends base_1.BaseFacade {
             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);
             }));
@@ -172,7 +173,7 @@ class RunRepository extends base_1.BaseFacade {
             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) => {

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,7 @@ 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));
         });
     }
 }

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,7 @@ 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));
         });
     }
 }

package/dist/cjs/core/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toIamcWide = exports.dfToDimensionless = exports.unitToDimensionless = exports.substitudeType = void 0;
+exports.withIamcDefault = exports.toIamcWide = exports.dfToDimensionless = exports.unitToDimensionless = exports.substitudeType = void 0;
 const dataframe_1 = require("../dataframe");
 const datapoint_1 = require("../data/iamc/datapoint");
 function substitudeType(df, type) {
@@ -111,3 +111,24 @@ exports.toIamcWide = toIamcWide;
 function getIamcRowIndex(row, rowIdentifiers) {
     return rowIdentifiers.map((i) => row[i]).join('_');
 }
+/**
+ * Processes the filter to ensure that IAMC filter is enabled by default unless explicitly disabled.
+ * When enabled, only entities with associated datapoints are returned.
+ * @param filter The filter to process
+ * @returns The processed filter with IAMC default settings
+ */
+function withIamcDefault(filter) {
+    if (!filter) {
+        return { iamc: true };
+    }
+    else if (filter.iamc === undefined) {
+        // If the IAMC filter is not explicitly set, default to true
+        filter.iamc = true;
+    }
+    else if (filter.iamc === null) {
+        // If the IAMC filter is explicitly set to null, leave it as is
+        return filter;
+    }
+    return filter;
+}
+exports.withIamcDefault = withIamcDefault;

package/dist/cjs/data/base.js

@@ -118,6 +118,10 @@ class BaseRepository {
     }
     _list({ filter, params, }) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (this.enumerationMethod === 'GET') {
+                params = Object.assign(Object.assign({}, params), filter);
+                filter = undefined;
+            }
             const data = yield this._requestEnumeration(params, filter, false);
             const pagination = data.pagination;
             if (pagination !== undefined) {

package/dist/cjs/data/docs.js

@@ -14,7 +14,7 @@ const base_1 = require("./base");
 class DocsRepository extends base_1.BaseRepository {
     get(dimensionId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this._get({ dimension_id: dimensionId });
+            return yield this._get({ dimensionId });
         });
     }
     set(dimensionId, description) {
@@ -27,7 +27,7 @@ class DocsRepository extends base_1.BaseRepository {
     }
     list(dimensionId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this._list({ filter: { dimension_id: dimensionId } });
+            return yield this._list({ filter: { dimensionId } });
         });
     }
     delete(dimensionId) {

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/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,7 @@ 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));
     }
 }
 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,7 @@ 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));
     }
 }
 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) => {

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,7 @@ 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));
     }
 }
 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,7 @@ 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));
     }
 }
 export { Unit, UnitRepository };

package/dist/esm/core/utils.js

@@ -104,4 +104,24 @@ function toIamcWide(df) {
 function getIamcRowIndex(row, rowIdentifiers) {
     return rowIdentifiers.map((i) => row[i]).join('_');
 }
-export { substitudeType, unitToDimensionless, dfToDimensionless, toIamcWide };
+/**
+ * Processes the filter to ensure that IAMC filter is enabled by default unless explicitly disabled.
+ * When enabled, only entities with associated datapoints are returned.
+ * @param filter The filter to process
+ * @returns The processed filter with IAMC default settings
+ */
+function withIamcDefault(filter) {
+    if (!filter) {
+        return { iamc: true };
+    }
+    else if (filter.iamc === undefined) {
+        // If the IAMC filter is not explicitly set, default to true
+        filter.iamc = true;
+    }
+    else if (filter.iamc === null) {
+        // If the IAMC filter is explicitly set to null, leave it as is
+        return filter;
+    }
+    return filter;
+}
+export { substitudeType, unitToDimensionless, dfToDimensionless, toIamcWide, withIamcDefault, };

package/dist/esm/data/base.js

@@ -91,6 +91,10 @@ class BaseRepository {
         }
     }
     async _list({ filter, params, }) {
+        if (this.enumerationMethod === 'GET') {
+            params = { ...params, ...filter };
+            filter = undefined;
+        }
         const data = await this._requestEnumeration(params, filter, false);
         const pagination = data.pagination;
         if (pagination !== undefined) {

package/dist/esm/data/docs.js

@@ -2,7 +2,7 @@ import { BaseRepository } from './base';
 class DocsRepository extends BaseRepository {
     static enumerationMethod = 'GET';
     async get(dimensionId) {
-        return await this._get({ dimension_id: dimensionId });
+        return await this._get({ dimensionId });
     }
     async set(dimensionId, description) {
         return (await this._post({
@@ -11,7 +11,7 @@ class DocsRepository extends BaseRepository {
         }));
     }
     async list(dimensionId) {
-        return await this._list({ filter: { dimension_id: dimensionId } });
+        return await this._list({ filter: { dimensionId } });
     }
     async delete(dimensionId) {
         await this._delete(dimensionId);

package/dist/types/core/model.d.ts

@@ -7,6 +7,7 @@ import { VariableFilter as BaseVariableFilter } from '../data/iamc/variable';
 import { UnitFilter as BaseUnitFilter } from '../data/unit';
 import { RunFilter as BaseRunFilter } from '../data/run';
 import { ScenarioFilter as BaseScenarioFilter } from '../data/scenario';
+import { DataFrame } from '../dataframe';
 /**
  * Represents a filter for listing and tabulating models.
  */
@@ -18,7 +19,7 @@ type ModelFilter = BaseModelFilter & {
         run?: BaseRunFilter & {
             scenario?: BaseScenarioFilter;
         };
-    };
+    } | boolean;
 };
 /**
  * Represents a model in the assessment modeling system.
@@ -94,7 +95,7 @@ declare class ModelRepository extends BaseFacade {
      * @param filter Optional. Filter for tabulating models.
      * @returns A promise that resolves to the tabulated result.
      */
-    tabulate(filter?: ModelFilter): Promise<any>;
+    tabulate(filter?: ModelFilter): Promise<DataFrame>;
 }
 export { Model, ModelRepository };
 export type { ModelFilter };

package/dist/types/core/region.d.ts

@@ -19,7 +19,7 @@ type RegionFilter = BaseRegionFilter & {
             scenario?: BaseScenarioFilter;
             model?: BaseModelFilter;
         };
-    };
+    } | boolean;
 };
 /**
  * Represents a unit in the system.

package/dist/types/core/run.d.ts

@@ -22,7 +22,7 @@ type RunFilter = BaseRunFilter & {
         variable?: BaseVariableFilter;
         region?: BaseRegionFilter;
         unit?: BaseUnitFilter;
-    };
+    } | boolean;
 };
 /**
  * Represents a Modeling Run.

package/dist/types/core/scenario.d.ts

@@ -19,7 +19,7 @@ type ScenarioFilter = BaseScenarioFilter & {
         run?: BaseRunFilter & {
             model?: BaseModelFilter;
         };
-    };
+    } | boolean;
 };
 /**
  * Represents a Modeling Scenario.

package/dist/types/core/unit.d.ts

@@ -19,7 +19,7 @@ type UnitFilter = BaseUnitFilter & {
             scenario?: BaseScenarioFilter;
             model?: BaseModelFilter;
         };
-    };
+    } | boolean;
 };
 /**
  * Represents a unit in the system.

package/dist/types/core/utils.d.ts

@@ -1,7 +1,20 @@
 import { DataFrame } from '../dataframe';
 import { DataPointType } from '../data/iamc/datapoint';
+import { PlainObject } from '../data/base';
+import { RunFilter } from './run';
+import { ScenarioFilter } from './scenario';
+import { RegionFilter } from './region';
+import { UnitFilter } from './unit';
+import { ModelFilter } from './model';
 declare function substitudeType(df: DataFrame, type?: DataPointType): DataFrame;
 declare function unitToDimensionless(name: string): string;
 declare function dfToDimensionless(df: DataFrame): DataFrame;
 declare function toIamcWide(df: DataFrame): DataFrame;
-export { substitudeType, unitToDimensionless, dfToDimensionless, toIamcWide };
+/**
+ * Processes the filter to ensure that IAMC filter is enabled by default unless explicitly disabled.
+ * When enabled, only entities with associated datapoints are returned.
+ * @param filter The filter to process
+ * @returns The processed filter with IAMC default settings
+ */
+declare function withIamcDefault(filter?: RunFilter | ScenarioFilter | ModelFilter | RegionFilter | UnitFilter): PlainObject;
+export { substitudeType, unitToDimensionless, dfToDimensionless, toIamcWide, withIamcDefault, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iiasa/ixmp4-ts",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "license": "MIT",
   "description": "typescript client for ixmp4, a data warehouse for scenario analysis",
   "repository": {
@@ -91,7 +91,7 @@
     "testcontainers": "^10.3.2",
     "typedoc": "^0.25.7",
     "typescript": "^5.3.2",
-    "vitest": "^1.4.0"
+    "vitest": "^3.1.2"
   },
   "dependencies": {
     "axios": "^1.6.2",