@narrative.io/data-collaboration-sdk-ts 0.0.6 → 0.0.7

package/build/base-api.d.ts

@@ -0,0 +1,47 @@
+import type { Config } from './types';
+/**
+ * BaseApi class provides basic functionality for making API requests.
+ */
+export declare abstract class BaseApi {
+    private readonly apiKey?;
+    private readonly environment;
+    private readonly base_api;
+    /**
+       * @param {Config} config - Configuration object.
+       * @param {string} [config.apiKey] - API key.
+       * @param {Environment} [config.environment='prod'] - Environment for the API (e.g. 'dev', 'prod').
+       */
+    constructor(config: Config);
+    /**
+       * Makes a GET request to the given endpoint.
+       *
+       * @param {string} endpoint - Endpoint for the request.
+       * @returns {Promise<T>} - Promise that resolves with the response data.
+       * @template T - Type of the response data.
+       */
+    protected get<T>(endpoint: string): Promise<T>;
+    /**
+       * Makes a POST request to the given endpoint with the given data.
+       *
+       * @param {string} endpoint - Endpoint for the request.
+       * @param {I} data - Data to be sent in the request.
+       * @returns {Promise<T>} - Promise that resolves with the response data.
+       * @template I - Type of the request data.
+       * @template T - Type of the response data.
+       */
+    protected post<I, T>(endpoint: string, data: I): Promise<T>;
+    /**
+      * Returns the base URL for the API based on the environment.
+      *
+      * @returns {string} - Base URL for the API.
+      * @private
+      */
+    private getBaseUrl;
+    /**
+       * Returns the headers for the API request.
+       *
+       * @returns {Object.<string, string>} - Headers for the API request.
+       * @private
+       */
+    private getHeaders;
+}

package/build/base-api.js

@@ -0,0 +1,77 @@
+import { mande } from 'mande';
+/**
+ * BaseApi class provides basic functionality for making API requests.
+ */
+export class BaseApi {
+    apiKey;
+    environment;
+    base_api;
+    /**
+       * @param {Config} config - Configuration object.
+       * @param {string} [config.apiKey] - API key.
+       * @param {Environment} [config.environment='prod'] - Environment for the API (e.g. 'dev', 'prod').
+       */
+    constructor(config) {
+        this.apiKey = config.apiKey;
+        this.environment = config.environment === null ? config.environment : 'prod';
+        this.base_api = mande(`${this.getBaseUrl()}`, {
+            headers: this.getHeaders()
+        });
+    }
+    /**
+       * Makes a GET request to the given endpoint.
+       *
+       * @param {string} endpoint - Endpoint for the request.
+       * @returns {Promise<T>} - Promise that resolves with the response data.
+       * @template T - Type of the response data.
+       */
+    async get(endpoint) {
+        return await this.base_api.get(endpoint);
+    }
+    /**
+       * Makes a POST request to the given endpoint with the given data.
+       *
+       * @param {string} endpoint - Endpoint for the request.
+       * @param {I} data - Data to be sent in the request.
+       * @returns {Promise<T>} - Promise that resolves with the response data.
+       * @template I - Type of the request data.
+       * @template T - Type of the response data.
+       */
+    async post(endpoint, data) {
+        return await this.base_api.post(endpoint, data);
+    }
+    /**
+      * Returns the base URL for the API based on the environment.
+      *
+      * @returns {string} - Base URL for the API.
+      * @private
+      */
+    getBaseUrl() {
+        switch (this.environment) {
+            case 'prod': {
+                return 'https://api.narrative.io/';
+            }
+            case 'dev': {
+                return 'https://api-dev.narrative.io/';
+            }
+            default: {
+                return this.environment;
+            }
+        }
+    }
+    /**
+       * Returns the headers for the API request.
+       *
+       * @returns {Object.<string, string>} - Headers for the API request.
+       * @private
+       */
+    getHeaders() {
+        const headers = {
+            'Content-type': 'application/json'
+        };
+        if (this.apiKey != null) {
+            headers.Authorization = `Bearer ${this.apiKey}`;
+        }
+        return headers;
+    }
+}

package/build/datasets/index.d.ts

@@ -0,0 +1,21 @@
+import { type ApiRecords } from 'src/types';
+import { BaseApi } from '../base-api';
+import { type Dataset } from './types';
+/**
+ * @module DatasetApi
+ * @description This module provides methods for fetching datasets.
+ * @extends BaseApi
+ */
+export declare class DatasetApi extends BaseApi {
+    /**
+     * Get a single dataset by its ID
+     * @param {number} datasetId - The ID of the dataset
+     * @returns {Promise<Dataset>} - Promise resolving to the requested dataset
+     */
+    getDataset(datasetId: number): Promise<Dataset>;
+    /**
+     * Get a list of all datasets
+     * @returns {Promise<ApiRecords<Dataset>>} - Promise resolving to an array of datasets
+     */
+    getDatasets(): Promise<ApiRecords<Dataset>>;
+}

package/build/datasets/index.js

@@ -0,0 +1,24 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'datasets';
+/**
+ * @module DatasetApi
+ * @description This module provides methods for fetching datasets.
+ * @extends BaseApi
+ */
+export class DatasetApi extends BaseApi {
+    /**
+     * Get a single dataset by its ID
+     * @param {number} datasetId - The ID of the dataset
+     * @returns {Promise<Dataset>} - Promise resolving to the requested dataset
+     */
+    async getDataset(datasetId) {
+        return await this.get(`${resourceName}/${datasetId}`);
+    }
+    /**
+     * Get a list of all datasets
+     * @returns {Promise<ApiRecords<Dataset>>} - Promise resolving to an array of datasets
+     */
+    async getDatasets() {
+        return await this.get(`${resourceName}`);
+    }
+}

package/build/health/index.d.ts

@@ -0,0 +1,5 @@
+import { BaseApi } from '../base-api';
+import type { HealthCheckResult } from './types';
+export declare class HealthCheckApi extends BaseApi {
+    getHealthCheck(): Promise<HealthCheckResult>;
+}

package/build/health/index.js

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

package/build/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseApi } from './base-api';
+import { HealthCheckApi } from './health';
+declare class NarrativeApi extends BaseApi {
+}
+interface NarrativeApi extends BaseApi, HealthCheckApi {
+}
+export default NarrativeApi;

package/build/index.js

@@ -0,0 +1,9 @@
+import { BaseApi } from './base-api';
+import { HealthCheckApi } from './health';
+// import { DatasetApi } from './datasets'
+// import { RosettaStoneApi } from './rosetta-stone'
+import { applyMixins } from './utils';
+class NarrativeApi extends BaseApi {
+}
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi]);
+export default NarrativeApi;

package/build/rosetta-stone/index.d.ts

@@ -0,0 +1,5 @@
+import { BaseApi } from '../base-api';
+import { type RosettaStoneResponse, type SampleRecords } from './types';
+export declare class RosettaStoneApi extends BaseApi {
+    getLabelsFromSample(sample: SampleRecords): Promise<RosettaStoneResponse[]>;
+}

package/build/rosetta-stone/index.js

@@ -0,0 +1,7 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'rosetta-stone';
+export class RosettaStoneApi extends BaseApi {
+    async getLabelsFromSample(sample) {
+        return await this.post(`${resourceName}/labels/sample`, sample);
+    }
+}

package/build/utils.d.ts

@@ -0,0 +1 @@
+export declare function applyMixins(derivedCtor: any, constructors: any[]): void;

package/build/utils.js

@@ -0,0 +1,12 @@
+// This can live anywhere in your codebase:
+export function applyMixins(derivedCtor, constructors) {
+    constructors.forEach((baseCtor) => {
+        Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {
+            let propertyDescriptor = Object.getOwnPropertyDescriptor(baseCtor.prototype, name);
+            if (propertyDescriptor === null || propertyDescriptor === undefined) {
+                propertyDescriptor = {};
+            }
+            Object.defineProperty(derivedCtor.prototype, name, propertyDescriptor);
+        });
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "main": "dist/index.js",
   "module": "dist/index.m.js",
   "umd:main": "dist/index.umd.js",
@@ -41,6 +41,6 @@
     "mande": "^2.0.3"
   },
   "files": [
-    "dist"
+    "build"
   ]
 }