@narrative.io/data-collaboration-sdk-ts 0.0.12 → 0.0.14

package/build/attributes/index.d.ts

@@ -0,0 +1,6 @@
+import { type ApiRecords } from '../types';
+import { BaseApi } from '../base-api';
+import { type Attribute } from './types';
+export declare class AttributeApi extends BaseApi {
+    getAttributes(): Promise<ApiRecords<Attribute>>;
+}

package/build/attributes/index.js

@@ -0,0 +1,7 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'attributes';
+export class AttributeApi extends BaseApi {
+    async getAttributes() {
+        return await this.get(resourceName);
+    }
+}

package/build/attributes/types.d.ts

@@ -0,0 +1,17 @@
+export interface Attribute {
+    id: number;
+    name: string;
+    description?: string;
+    display_name: string;
+    type: string;
+    enum?: string[] | number[];
+    validations?: string[];
+    properties?: Record<string, {
+        type: string;
+        description?: string;
+        validations?: string[];
+        enum?: string[];
+        items?: unknown;
+    }>;
+    required?: string[];
+}

package/build/attributes/types.js

@@ -0,0 +1 @@
+export {};

package/build/datasets/index.d.ts

@@ -1,6 +1,6 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import { type DatasetTableSummary, type Dataset } from './types';
+import { type Dataset, type DatasetTableSummaryAPIResponse } from './types';
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -25,7 +25,7 @@ export declare class DatasetApi extends BaseApi {
      * @param {boolean} [allRecords=false] - If `true`, all records in the dataset will be returned. If `false`, only a limited number of records will be returned.
      * @param {number} [perPage=100] - The number of records to return per page.
      * @param {number} [offset=0] - The offset to start returning records from.
-     * @returns {Promise<ApiRecords<DatasetTableSummary>>} A promise that resolves with the dataset summary information.
+     * @returns {Promise<DatasetTableSummaryAPIResponse>} A promise that resolves with the dataset summary information.
      */
-    getDatasetSummary(datasetId: number, allRecords?: boolean, perPage?: number, offset?: number): Promise<ApiRecords<DatasetTableSummary>>;
+    getDatasetSummary(datasetId: number, allRecords?: boolean, perPage?: number, offset?: number): Promise<DatasetTableSummaryAPIResponse>;
 }

package/build/datasets/index.js

@@ -28,7 +28,7 @@ export class DatasetApi extends BaseApi {
      * @param {boolean} [allRecords=false] - If `true`, all records in the dataset will be returned. If `false`, only a limited number of records will be returned.
      * @param {number} [perPage=100] - The number of records to return per page.
      * @param {number} [offset=0] - The offset to start returning records from.
-     * @returns {Promise<ApiRecords<DatasetTableSummary>>} A promise that resolves with the dataset summary information.
+     * @returns {Promise<DatasetTableSummaryAPIResponse>} A promise that resolves with the dataset summary information.
      */
     async getDatasetSummary(datasetId, allRecords = false, perPage = 100, offset = 0) {
         return await this.get(`${resourceName}/${datasetId}/stats?all_records=${String(allRecords)}&per_page=${perPage}&offset=${offset}`);

package/build/datasets/types.d.ts

@@ -40,6 +40,10 @@ export interface DatasetTableSummary {
     snapshot_removed_bytes: number;
     column_sumary: DatasetColumnSummary[];
 }
+export interface DatasetTableSummaryAPIResponse {
+    dataset_id: number;
+    records: DatasetTableSummary[];
+}
 type SchemaFileConfigType = 'flat';
 type SchemaPropertiesType = 'string' | 'number' | 'boolean';
 type DatasetStatus = 'active' | 'archived';

package/build/index.d.ts

@@ -3,11 +3,12 @@ import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { type Environment, type Config, type ApiRecords } from './types';
-import { type Dataset, type DatasetTableSummary } from './datasets/types';
+import { type DatasetTableSummaryAPIResponse, type Dataset, type DatasetTableSummary } from './datasets/types';
 import { type HealthCheckResult } from './health/types';
 import { type SampleRecords } from './rosetta-stone/types';
+import { AttributeApi } from './attributes';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi {
 }
-export { NarrativeApi, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary };
+export { NarrativeApi, AttributeApi, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse };

package/build/index.js

@@ -3,7 +3,8 @@ import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { applyMixins } from './utils';
+import { AttributeApi } from './attributes';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi]);
-export { NarrativeApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi]);
+export { NarrativeApi, AttributeApi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",