stadata-js 0.1.2 → 0.3.0

package/dist/index.d.mts

@@ -365,11 +365,11 @@ interface DerivedVariableListParams extends BaseListParams {
     variableId?: number;
 }
 interface DynamicTableParams extends BaseListParams {
-    tableId: string;
     variableId: number;
-    periodId?: number;
+    periodId: string;
     derivedVariableId?: number;
-    derivedPeriodId?: number;
+    verticalVariableId?: number;
+    derivedPeriodId?: string;
 }
 interface StatisticClassificationListParams extends BaseListParams {
     type?: ClassificationType;
@@ -750,7 +750,8 @@ declare class Subject extends BaseEntity {
     readonly id: number;
     readonly name: string;
     readonly categoryId: number;
-    constructor(id: number, name: string, categoryId: number);
+    readonly category: string;
+    constructor(id: number, name: string, categoryId: number, category: string);
     toJson(): Record<string, unknown>;
     static fromJson(json: Record<string, unknown>): Subject;
 }
@@ -1109,32 +1110,98 @@ declare class GetCensusById implements UseCase<ViewParams, CensusEvent> {
     execute(params: ViewParams): Promise<Result<CensusEvent, ApiFailure>>;
 }
 
-declare class DynamicTable extends BaseEntity {
-    readonly variableId: number;
-    readonly title: string;
-    readonly subjectId: number;
-    readonly subjectName: string;
-    readonly notes: string;
+declare class VariableInfo extends BaseEntity {
+    readonly value: number;
+    readonly label: string;
     readonly unit: string;
-    readonly verticalVariableId: number;
-    readonly domain: string;
-    readonly csaSubjectId?: number | undefined;
-    readonly csaSubjectName?: string | undefined;
-    readonly graphId?: number | undefined;
-    readonly graphName?: string | undefined;
-    constructor(variableId: number, title: string, subjectId: number, subjectName: string, notes: string, unit: string, verticalVariableId: number, domain: string, csaSubjectId?: number | undefined, csaSubjectName?: string | undefined, graphId?: number | undefined, graphName?: string | undefined);
+    readonly subject: string;
+    readonly definition: string;
+    readonly notes: string;
+    readonly decimal?: number | undefined;
+    constructor(value: number, label: string, unit: string, subject: string, definition: string, notes: string, decimal?: number | undefined);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): VariableInfo;
+}
+declare class VerticalVariableInfo extends BaseEntity {
+    readonly value: number | string;
+    readonly label: string;
+    constructor(value: number | string, label: string);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): VerticalVariableInfo;
+}
+declare class PeriodInfo extends VerticalVariableInfo {
+    static fromJson(json: Record<string, unknown>): PeriodInfo;
+}
+declare class SubjectInfo extends BaseEntity {
+    readonly value: number;
+    readonly label: string;
+    constructor(value: number, label: string);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): SubjectInfo;
+}
+declare class RelatedTable extends BaseEntity {
+    readonly id: string;
+    readonly title: string;
+    readonly tableSource: number;
+    readonly lastUpdate: string | null;
+    readonly link: string;
+    constructor(id: string, title: string, tableSource: number, lastUpdate: string | null, link: string);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): RelatedTable;
+}
+
+declare class DynamicTable extends BaseEntity {
+    readonly subjects: SubjectInfo[];
+    readonly variables: VariableInfo[];
+    readonly verticalVariables: VerticalVariableInfo[];
+    readonly verticalVariableLabel: string;
+    readonly periods: PeriodInfo[];
+    readonly derivedVariables: VerticalVariableInfo[];
+    readonly derivedPeriods: VerticalVariableInfo[];
+    readonly dataContent: Record<string, unknown>;
+    readonly related: RelatedTable[];
+    readonly lastUpdate?: string | null | undefined;
+    constructor(subjects: SubjectInfo[], variables: VariableInfo[], verticalVariables: VerticalVariableInfo[], verticalVariableLabel: string, periods: PeriodInfo[], derivedVariables: VerticalVariableInfo[], derivedPeriods: VerticalVariableInfo[], dataContent: Record<string, unknown>, related: RelatedTable[], lastUpdate?: string | null | undefined);
     toJson(): Record<string, unknown>;
     static fromJson(json: Record<string, unknown>): DynamicTable;
+    getDataValue(vervarValue: number | string, varValue: number | string, turvarValue: number | string, tahunValue: number | string, turtahunValue: number | string): unknown;
+    toStructuredData(): {
+        subject_id: number;
+        subject_label: string;
+        variable_id: number;
+        variable_label: string;
+        variable_unit: string;
+        vertical_variable_label: string;
+        last_update: string | null | undefined;
+        data: Array<{
+            id: number | string;
+            label: string;
+            data: Array<{
+                id: number | string;
+                label: string;
+                data: Array<{
+                    id: number | string;
+                    label: string;
+                    value?: unknown;
+                    data?: Array<{
+                        id: number | string;
+                        label: string;
+                        value: unknown;
+                    }>;
+                }>;
+            }>;
+        }>;
+    };
 }
 
 interface DynamicTableRepository {
-    getAll(params: DynamicTableParams): Promise<Result<ListResult<DynamicTable>, ApiFailure>>;
+    getAll(params: DynamicTableParams): Promise<Result<DynamicTable, ApiFailure>>;
 }
 
-declare class GetAllDynamicTables implements UseCase<DynamicTableParams, ListResult<DynamicTable>> {
+declare class GetAllDynamicTables implements UseCase<DynamicTableParams, DynamicTable> {
     private repository;
     constructor(repository: DynamicTableRepository);
-    execute(params: DynamicTableParams): Promise<Result<ListResult<DynamicTable>, ApiFailure>>;
+    execute(params: DynamicTableParams): Promise<Result<DynamicTable, ApiFailure>>;
 }
 
 interface StadataList {
@@ -1171,7 +1238,7 @@ interface StadataList {
         censusAreaId: string;
         datasetId: string;
     }): Promise<Result<ListResult<CensusData>, ApiFailure>>;
-    dynamicTables(params: DynamicTableParams): Promise<Result<ListResult<DynamicTable>, ApiFailure>>;
+    dynamicTables(params: DynamicTableParams): Promise<Result<DynamicTable, ApiFailure>>;
 }
 
 interface StadataView {

package/dist/index.d.ts

@@ -365,11 +365,11 @@ interface DerivedVariableListParams extends BaseListParams {
     variableId?: number;
 }
 interface DynamicTableParams extends BaseListParams {
-    tableId: string;
     variableId: number;
-    periodId?: number;
+    periodId: string;
     derivedVariableId?: number;
-    derivedPeriodId?: number;
+    verticalVariableId?: number;
+    derivedPeriodId?: string;
 }
 interface StatisticClassificationListParams extends BaseListParams {
     type?: ClassificationType;
@@ -750,7 +750,8 @@ declare class Subject extends BaseEntity {
     readonly id: number;
     readonly name: string;
     readonly categoryId: number;
-    constructor(id: number, name: string, categoryId: number);
+    readonly category: string;
+    constructor(id: number, name: string, categoryId: number, category: string);
     toJson(): Record<string, unknown>;
     static fromJson(json: Record<string, unknown>): Subject;
 }
@@ -1109,32 +1110,98 @@ declare class GetCensusById implements UseCase<ViewParams, CensusEvent> {
     execute(params: ViewParams): Promise<Result<CensusEvent, ApiFailure>>;
 }
 
-declare class DynamicTable extends BaseEntity {
-    readonly variableId: number;
-    readonly title: string;
-    readonly subjectId: number;
-    readonly subjectName: string;
-    readonly notes: string;
+declare class VariableInfo extends BaseEntity {
+    readonly value: number;
+    readonly label: string;
     readonly unit: string;
-    readonly verticalVariableId: number;
-    readonly domain: string;
-    readonly csaSubjectId?: number | undefined;
-    readonly csaSubjectName?: string | undefined;
-    readonly graphId?: number | undefined;
-    readonly graphName?: string | undefined;
-    constructor(variableId: number, title: string, subjectId: number, subjectName: string, notes: string, unit: string, verticalVariableId: number, domain: string, csaSubjectId?: number | undefined, csaSubjectName?: string | undefined, graphId?: number | undefined, graphName?: string | undefined);
+    readonly subject: string;
+    readonly definition: string;
+    readonly notes: string;
+    readonly decimal?: number | undefined;
+    constructor(value: number, label: string, unit: string, subject: string, definition: string, notes: string, decimal?: number | undefined);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): VariableInfo;
+}
+declare class VerticalVariableInfo extends BaseEntity {
+    readonly value: number | string;
+    readonly label: string;
+    constructor(value: number | string, label: string);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): VerticalVariableInfo;
+}
+declare class PeriodInfo extends VerticalVariableInfo {
+    static fromJson(json: Record<string, unknown>): PeriodInfo;
+}
+declare class SubjectInfo extends BaseEntity {
+    readonly value: number;
+    readonly label: string;
+    constructor(value: number, label: string);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): SubjectInfo;
+}
+declare class RelatedTable extends BaseEntity {
+    readonly id: string;
+    readonly title: string;
+    readonly tableSource: number;
+    readonly lastUpdate: string | null;
+    readonly link: string;
+    constructor(id: string, title: string, tableSource: number, lastUpdate: string | null, link: string);
+    toJson(): Record<string, unknown>;
+    static fromJson(json: Record<string, unknown>): RelatedTable;
+}
+
+declare class DynamicTable extends BaseEntity {
+    readonly subjects: SubjectInfo[];
+    readonly variables: VariableInfo[];
+    readonly verticalVariables: VerticalVariableInfo[];
+    readonly verticalVariableLabel: string;
+    readonly periods: PeriodInfo[];
+    readonly derivedVariables: VerticalVariableInfo[];
+    readonly derivedPeriods: VerticalVariableInfo[];
+    readonly dataContent: Record<string, unknown>;
+    readonly related: RelatedTable[];
+    readonly lastUpdate?: string | null | undefined;
+    constructor(subjects: SubjectInfo[], variables: VariableInfo[], verticalVariables: VerticalVariableInfo[], verticalVariableLabel: string, periods: PeriodInfo[], derivedVariables: VerticalVariableInfo[], derivedPeriods: VerticalVariableInfo[], dataContent: Record<string, unknown>, related: RelatedTable[], lastUpdate?: string | null | undefined);
     toJson(): Record<string, unknown>;
     static fromJson(json: Record<string, unknown>): DynamicTable;
+    getDataValue(vervarValue: number | string, varValue: number | string, turvarValue: number | string, tahunValue: number | string, turtahunValue: number | string): unknown;
+    toStructuredData(): {
+        subject_id: number;
+        subject_label: string;
+        variable_id: number;
+        variable_label: string;
+        variable_unit: string;
+        vertical_variable_label: string;
+        last_update: string | null | undefined;
+        data: Array<{
+            id: number | string;
+            label: string;
+            data: Array<{
+                id: number | string;
+                label: string;
+                data: Array<{
+                    id: number | string;
+                    label: string;
+                    value?: unknown;
+                    data?: Array<{
+                        id: number | string;
+                        label: string;
+                        value: unknown;
+                    }>;
+                }>;
+            }>;
+        }>;
+    };
 }
 
 interface DynamicTableRepository {
-    getAll(params: DynamicTableParams): Promise<Result<ListResult<DynamicTable>, ApiFailure>>;
+    getAll(params: DynamicTableParams): Promise<Result<DynamicTable, ApiFailure>>;
 }
 
-declare class GetAllDynamicTables implements UseCase<DynamicTableParams, ListResult<DynamicTable>> {
+declare class GetAllDynamicTables implements UseCase<DynamicTableParams, DynamicTable> {
     private repository;
     constructor(repository: DynamicTableRepository);
-    execute(params: DynamicTableParams): Promise<Result<ListResult<DynamicTable>, ApiFailure>>;
+    execute(params: DynamicTableParams): Promise<Result<DynamicTable, ApiFailure>>;
 }
 
 interface StadataList {
@@ -1171,7 +1238,7 @@ interface StadataList {
         censusAreaId: string;
         datasetId: string;
     }): Promise<Result<ListResult<CensusData>, ApiFailure>>;
-    dynamicTables(params: DynamicTableParams): Promise<Result<ListResult<DynamicTable>, ApiFailure>>;
+    dynamicTables(params: DynamicTableParams): Promise<Result<DynamicTable, ApiFailure>>;
 }
 
 interface StadataView {