@epam/statgpt-sdmx-toolkit 0.2.0-rc.8 → 0.2.0

package/models/datasets-metadata.d.ts

@@ -0,0 +1,33 @@
+export interface DeploymentDatasetsResponseData {
+    datasets: ChannelDataset[];
+}
+export interface ChannelDataset {
+    dataset: Dataset;
+}
+export interface Dataset {
+    details: DatasetDetails;
+}
+export interface DatasetDetails {
+    urn: Urn;
+    dimensions: Record<string, DimensionConfig>;
+}
+export interface Urn {
+    version: string;
+    agencyId: string;
+    resourceId: string;
+}
+export type DimensionTypeKey = 'NON_INDICATOR' | 'INDICATOR' | 'TIME_PERIOD' | (string & {});
+export interface DimensionConfig {
+    alias: string | null;
+    subtype?: string | null;
+    allValues: DimensionAllValues | null;
+    dimensionType: DimensionTypeKey;
+}
+export interface DimensionAllValues {
+    id: string;
+    name: string;
+    description: string;
+}
+export type ShortUrn = string;
+export type DimensionKey = string;
+export type DatasetDimensionsMetadataMap = Record<ShortUrn, Record<DimensionKey, DimensionConfig>>;

package/models/index.d.ts

@@ -2,8 +2,10 @@ export * from './dataset-query-filters';
 export * from './dimension-group';
 export * from './series-filter';
 export * from './splitted-urn';
-export * from './structural-metadata';
 export * from './data';
+export * from './structural-metadata/structural-metadata';
+export * from './structural-metadata/structural-metadata-base';
+export * from './structural-metadata/structural-metadata-v3';
 export * from './structural-metadata/codelist';
 export * from './structural-metadata/common-artefact-properties';
 export * from './structural-metadata/concept-scheme';
@@ -11,4 +13,4 @@ export * from './structural-metadata/constraints';
 export * from './structural-metadata/data-structure';
 export * from './structural-metadata/dataflow';
 export * from './structural-metadata/representation';
-export * from './structural-metadata-base';
+export * from './datasets-metadata';

package/models/structural-metadata/codelist.d.ts

@@ -1,5 +1,5 @@
 import { CommonArtefactProperty } from './common-artefact-properties';
-import { ElementBase } from '../structural-metadata-base';
+import { ElementBase } from './structural-metadata-base';
 export interface Codelist extends CommonArtefactProperty {
     codes?: Code[];
 }

package/models/structural-metadata/common-artefact-properties.d.ts

@@ -1,4 +1,4 @@
-import { Annotation, ElementBase, Link } from '../structural-metadata-base';
+import { Annotation, ElementBase, Link } from './structural-metadata-base';
 export interface CommonArtefactProperty extends ElementBase {
     agencyID?: string;
     version?: string;

package/models/structural-metadata/concept-scheme.d.ts

@@ -1,6 +1,6 @@
 import { CommonArtefactProperty } from './common-artefact-properties';
 import { Representation } from './representation';
-import { ElementBase } from '../structural-metadata-base';
+import { ElementBase } from './structural-metadata-base';
 export interface ConceptScheme extends CommonArtefactProperty {
     concepts?: Concept[];
 }

package/models/structural-metadata/constraints-v3.d.ts

@@ -0,0 +1,16 @@
+import { CommonArtefactProperty } from './common-artefact-properties';
+export interface DataConstraintsV3 extends CommonArtefactProperty {
+    cubeRegions?: CubeRegionV3[];
+}
+export interface CubeRegionV3 {
+    keyValues: Component[];
+    include: boolean;
+}
+export interface Component {
+    include: boolean;
+    id: string;
+    values: ComponentValue[];
+}
+export interface ComponentValue {
+    value: string;
+}

package/models/structural-metadata/data-structure.d.ts

@@ -1,5 +1,5 @@
 import { CommonArtefactProperty } from './common-artefact-properties';
-import { Annotation, Link } from '../structural-metadata-base';
+import { Annotation, Link } from './structural-metadata-base';
 import { Representation } from './representation';
 export interface DataStructure extends CommonArtefactProperty {
     dataStructureComponents?: DataStructureComponents;

package/models/structural-metadata/structural-metadata-v3.d.ts

@@ -0,0 +1,16 @@
+import { Codelist } from './codelist';
+import { ConceptScheme } from './concept-scheme';
+import { DataStructure, MetadataStructure } from './data-structure';
+import { Dataflow } from './dataflow';
+import { DataConstraintsV3 } from './constraints-v3';
+export interface StructuralMetaDataV3 {
+    data: StructuralDataV3;
+}
+export interface StructuralDataV3 {
+    codelists?: Codelist[];
+    conceptSchemes?: ConceptScheme[];
+    dataConstraints?: DataConstraintsV3[];
+    dataflows?: Dataflow[];
+    dataStructures?: DataStructure[];
+    metadataStructures?: MetadataStructure[];
+}

package/models/structural-metadata/structural-metadata.d.ts

@@ -0,0 +1,16 @@
+import { Codelist } from './codelist';
+import { ConceptScheme } from './concept-scheme';
+import { DataConstraints } from './constraints';
+import { DataStructure, MetadataStructure } from './data-structure';
+import { Dataflow } from './dataflow';
+export interface StructuralMetaData {
+    data: StructuralData;
+}
+export interface StructuralData {
+    codelists?: Codelist[];
+    conceptSchemes?: ConceptScheme[];
+    dataConstraints?: DataConstraints[];
+    dataflows?: Dataflow[];
+    dataStructures?: DataStructure[];
+    metadataStructures?: MetadataStructure[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epam/statgpt-sdmx-toolkit",
-  "version": "0.2.0-rc.8",
+  "version": "0.2.0",
   "license": "MIT",
   "exports": {
     ".": {
@@ -14,8 +14,8 @@
   "module": "./index.mjs",
   "types": "./index.d.ts",
   "dependencies": {
-    "@epam/statgpt-dial-toolkit": "0.2.0-rc.8",
-    "@epam/statgpt-shared-toolkit": "0.2.0-rc.8",
+    "@epam/statgpt-dial-toolkit": "0.2.0",
+    "@epam/statgpt-shared-toolkit": "0.2.0",
     "compare-versions": "^6.1.1"
   }
 }

package/utils/build-dataset-dimensions-metadata-map.d.ts

@@ -0,0 +1,2 @@
+import { DeploymentDatasetsResponseData, DatasetDimensionsMetadataMap } from '../models';
+export declare function buildDatasetDimensionsMetadataMap(data: DeploymentDatasetsResponseData): DatasetDimensionsMetadataMap;

package/utils/constraint.d.ts

@@ -1,5 +1,5 @@
 import { DataConstraints } from '../models/structural-metadata/constraints';
-import { Annotation } from '../models/structural-metadata-base';
+import { Annotation } from '../models/structural-metadata/structural-metadata-base';
 import { TimeRange, DataQuery } from '../../../shared-toolkit/src/index';
 import { Codelist } from '../models/structural-metadata/codelist';
 import { SeriesFilterDto } from '../models';

package/utils/get-dimensions.d.ts

@@ -1,4 +1,4 @@
-import { StructuralData } from '../models/structural-metadata';
+import { StructuralData } from '../models/structural-metadata/structural-metadata';
 import { Dimension, DimensionList } from '../models/structural-metadata/data-structure';
 import { DataMessage } from '../models/data/data-message';
 import { StructureItemBase } from '../models/data/structure';

package/utils/get-structure-components.d.ts

@@ -1,4 +1,4 @@
-import { StructuralData } from '../models/structural-metadata';
+import { StructuralData } from '../models/structural-metadata/structural-metadata';
 import { Codelist } from '../models/structural-metadata/codelist';
-import { ElementBase } from '../models/structural-metadata-base';
+import { ElementBase } from '../models/structural-metadata/structural-metadata-base';
 export declare const getStructureComponentsMap: (data?: StructuralData) => Map<string, Codelist | ElementBase>;

package/utils/index.d.ts

@@ -20,3 +20,4 @@ export * from './download';
 export * from './get-filtered-items';
 export * from './query-filters';
 export * from './get-periods';
+export * from './build-dataset-dimensions-metadata-map';

package/utils/map-availability.d.ts

@@ -0,0 +1,3 @@
+import { StructuralMetaDataV3 } from '../models/structural-metadata/structural-metadata-v3';
+import { StructuralMetaData } from '../models/structural-metadata/structural-metadata';
+export declare function mapAvailabilityV3ToPlus(data: StructuralMetaDataV3): StructuralMetaData;

package/utils/time-series-count.d.ts

@@ -1,2 +1,2 @@
-import { Annotation } from '../models/structural-metadata-base';
+import { Annotation } from '../models/structural-metadata/structural-metadata-base';
 export declare const getTimeSeriesCount: (annotations: Annotation[] | undefined) => string;

package/utils/urn.d.ts

@@ -1,5 +1,5 @@
 import { ArtifactChildUrnParsed, SplittedUrn } from '../models/splitted-urn';
 export declare const getKeyFromUrn: (urn?: string | null) => string | undefined;
-export declare const splitUrn: (urn?: string | null) => SplittedUrn;
+export declare const splitUrn: (urn?: string) => SplittedUrn;
 export declare const getChildParsedUrn: (childUrn: string) => ArtifactChildUrnParsed;
 export declare const generateShortUrn: (id?: string, version?: string, agency?: string) => string;

package/models/structural-metadata.d.ts

@@ -1,16 +0,0 @@
-import { Codelist } from './structural-metadata/codelist';
-import { ConceptScheme } from './structural-metadata/concept-scheme';
-import { DataConstraints } from './structural-metadata/constraints';
-import { DataStructure, MetadataStructure } from './structural-metadata/data-structure';
-import { Dataflow } from './structural-metadata/dataflow';
-export interface StructuralMetaData {
-    data: StructuralData;
-}
-export interface StructuralData {
-    codelists?: Codelist[];
-    conceptSchemes?: ConceptScheme[];
-    dataConstraints?: DataConstraints[];
-    dataflows?: Dataflow[];
-    dataStructures?: DataStructure[];
-    metadataStructures?: MetadataStructure[];
-}