@iiasa/ixmp4-ts 0.5.0 → 0.7.0

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

@@ -1,7 +1,49 @@
 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;
+/**
+ * Standardizes the columns of a DataFrame in IAMC format.
+ * @param df DataFrame in IAMC format
+ * @returns DataFrame in IAMC format with standardized columns
+ */
+declare function standardizeIamcDf(df: DataFrame): DataFrame;
+/**
+ * Converts a DataFrame in IAMC long format to wide format.
+ * @param df The DataFrame to convert
+ * @returns A DataFrame in IAMC wide format
+ */
 declare function toIamcWide(df: DataFrame): DataFrame;
-export { substitudeType, unitToDimensionless, dfToDimensionless, toIamcWide };
+/**
+ * Generates a unique row index for IAMC data based on the row's identifiers.
+ * @param row The row data as an array
+ * @param rowIdentifiers The indices of the identifiers in the row
+ * @returns A string that uniquely identifies the row
+ */
+declare function getIamcRowIndex(row: any[], rowIdentifiers: number[]): string;
+/**
+ * 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;
+declare function sortTimesWithYearFirst(years: number[], dateTimes: string[]): (number | string)[];
+/**
+ * Splits a DataFrame into separate DataFrames based on DataPointType.
+ * @param df The DataFrame to split
+ * @returns An object containing DataFrames for each type present in the data
+ */
+declare function splitDataFrameByType(df: DataFrame): {
+    annual?: DataFrame;
+    categorical?: DataFrame;
+    datetime?: DataFrame;
+};
+export { substitudeType, unitToDimensionless, dfToDimensionless, standardizeIamcDf, toIamcWide, withIamcDefault, getIamcRowIndex, sortTimesWithYearFirst, splitDataFrameByType, };

package/dist/types/data/base.d.ts

@@ -43,6 +43,10 @@ declare class BaseRepository {
         filter?: object;
         params?: object;
     }): Promise<DataFrame>;
+    _count({ filter, params, }: {
+        filter?: object;
+        params?: object;
+    }): Promise<number>;
     _bulkUpsert(df: DataFrame, params?: object): Promise<void>;
     _bulkDelete(df: DataFrame, params?: object): Promise<void>;
     private static throwRemoteException;

package/dist/types/data/iamc/datapoint.d.ts

@@ -29,6 +29,7 @@ declare class DataPointRepository extends BaseRepository {
         joinRuns?: boolean;
         filter: PlainObject;
     }): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     bulkUpsert(df: DataFrame): Promise<void>;
     bulkDelete(df: DataFrame): Promise<void>;
 }

package/dist/types/data/iamc/variable.d.ts

@@ -18,6 +18,7 @@ declare class VariableRepository extends BaseRepository {
     constructor(client: AxiosInstance);
     list(filter?: PlainObject): Promise<Variable[]>;
     tabulate(filter?: PlainObject): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     create(name: string): Promise<Variable>;
     get(name: string): Promise<Variable>;
 }

package/dist/types/data/meta.d.ts

@@ -29,6 +29,7 @@ declare class MetaIndicatorRepository extends BaseRepository {
     static prefix: string;
     list(filter?: PlainObject): Promise<MetaIndicator[]>;
     tabulate(filter?: PlainObject, joinRunIndex?: boolean): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     create(run__id: number, key: string, value: string | number | boolean): Promise<MetaIndicator>;
     get(runId: number, key: string): Promise<MetaIndicator>;
     delete(id: number): Promise<void>;

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

@@ -18,6 +18,7 @@ declare class ModelRepository extends BaseRepository {
     constructor(client: AxiosInstance);
     list(filter?: PlainObject): Promise<Model[]>;
     tabulate(filter?: PlainObject): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     create(name: string): Promise<Model>;
     get(name: string): Promise<Model>;
 }

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

@@ -20,6 +20,7 @@ declare class RegionRepository extends BaseRepository {
     constructor(client: AxiosInstance);
     list(filter?: PlainObject): Promise<Region[]>;
     tabulate(filter?: PlainObject): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     create(name: string, hierarchy: string): Promise<Region>;
     get(name: string): Promise<Region>;
     delete(id: number): Promise<void>;

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

@@ -21,6 +21,7 @@ declare class RunRepository extends BaseRepository {
     static prefix: string;
     list(filter?: PlainObject): Promise<Run[]>;
     tabulate(filter?: PlainObject): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     create(modelName: string, scenarioName: string): Promise<Run>;
     get(modelName: string, scenarioName: string, version: number): Promise<Run>;
     getDefaultVersion(modelName: string, scenarioName: string): Promise<Run>;

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

@@ -18,6 +18,7 @@ declare class ScenarioRepository extends BaseRepository {
     constructor(client: AxiosInstance);
     list(filter?: PlainObject): Promise<Scenario[]>;
     tabulate(filter?: PlainObject): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
     create(name: string): Promise<Scenario>;
     get(name: string): Promise<Scenario>;
 }

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

@@ -21,6 +21,7 @@ declare class UnitRepository extends BaseRepository {
     get(name: string): Promise<Unit>;
     list(filter?: PlainObject): Promise<Unit[]>;
     tabulate(filter?: PlainObject): Promise<DataFrame>;
+    count(filter?: PlainObject): Promise<number>;
 }
 export { UnitRepository };
 export type { UnitFilter, Unit };

package/dist/types/index.d.ts

@@ -4,7 +4,7 @@ export type { Run, RunRepository, RunFilter } from './core/run';
 export type { Scenario, ScenarioRepository, ScenarioFilter, } from './core/scenario';
 export type { Model, ModelRepository, ModelFilter } from './core/model';
 export type { Region, RegionRepository, RegionFilter } from './core/region';
-export type { RunIamcData, PlatformIamcData, IamcDataFilter, } from './core/iamc/data';
+export type { RunIamcData, PlatformIamcData, IamcDataFilter, IamcDataResult, } from './core/iamc/data';
 export type { Variable, VariableRepository, VariableFilter, } from './core/iamc/variable';
 export type { Unit, UnitRepository, UnitFilter } from './core/unit';
 export type { MetaIndicatorRepository, MetaIndicatorFilter } from './core/meta';
@@ -16,6 +16,7 @@ export type { Model as ModelModel } from './data/model';
 export type { Region as RegionModel } from './data/region';
 export type { Unit as UnitModel } from './data/unit';
 export type { DataPoint as DataPointModel } from './data/iamc/datapoint';
+export { DataPointType } from './data/iamc/datapoint';
 export type { Variable as VariableModel } from './data/iamc/variable';
 export type { TimeSeries as TimeSeriesModel } from './data/iamc/timeseries';
 export type { PlatformInfo as PlatformInfoModel } from './data/info';

package/dist/types/tsconfig.types.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iiasa/ixmp4-ts",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "license": "MIT",
   "description": "typescript client for ixmp4, a data warehouse for scenario analysis",
   "repository": {
@@ -82,16 +82,15 @@
   },
   "devDependencies": {
     "@nuxt/eslint-config": "^0.2.0",
-    "@types/web": "^0.0.134",
+    "@types/node": "^22.0.0",
     "@types/webgl-ext": "^0.0.36",
     "@types/webgl2": "^0.0.10",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.1",
     "prettier": "^3.1.0",
     "testcontainers": "^10.3.2",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.2",
-    "vitest": "^1.4.0"
+    "typescript": "^5.8.2",
+    "vitest": "^3.2.4"
   },
   "dependencies": {
     "axios": "^1.6.2",