@narrative.io/data-collaboration-sdk-ts 0.0.29 → 0.0.30

package/build/base-api.d.ts

@@ -29,7 +29,7 @@ export declare abstract class BaseApi {
        * @template I - Type of the request data.
        * @template T - Type of the response data.
        */
-    protected post<I, T>(endpoint: string, data: I): Promise<T>;
+    protected post<I, T>(endpoint: string, data?: I): Promise<T>;
     /**
      * Sends a DELETE request to the specified endpoint.
      *

package/build/index.d.ts

@@ -9,12 +9,14 @@ import { type SampleRecords } from './rosetta-stone/types';
 import { AttributeApi } from './attributes';
 import { type Attribute } from './attributes/types';
 import { PingApi } from './ping';
+import { UploadsApi } from './uploads';
+import { type UploadsResponse } from './uploads/types';
 import { type PingStatus } from './ping/types';
 import { type Product, ProductsApi } from './products';
 import { CompanyInfoApi, type CompanyInfo } from './company-info';
 import { InstallationsApi, type Installation } from './installations';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation };

package/build/index.js

@@ -5,10 +5,11 @@ import { RosettaStoneApi } from './rosetta-stone';
 import { applyMixins } from './utils';
 import { AttributeApi } from './attributes';
 import { PingApi } from './ping';
+import { UploadsApi } from './uploads';
 import { ProductsApi } from './products';
 import { CompanyInfoApi } from './company-info';
 import { InstallationsApi } from './installations';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi };

package/build/uploads/index.d.ts

@@ -0,0 +1,17 @@
+import { BaseApi } from 'src/base-api';
+import { type UploadsResponse } from './types';
+/**
+ * API class for handling file uploads.
+ * @extends BaseApi
+ */
+declare class UploadsApi extends BaseApi {
+    /**
+   * Retrieves an upload URL for a given upload path.
+   *
+   * @async
+   * @param {string} upload_path - The path of the upload resource.
+   * @returns {Promise<UploadsResponse>} - A Promise resolving to the response data.
+   */
+    getUploadUrl(uploadPath: string): Promise<UploadsResponse>;
+}
+export { type UploadsResponse, UploadsApi };

package/build/uploads/index.js

@@ -0,0 +1,25 @@
+import { BaseApi } from 'src/base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = 'uploads';
+/**
+ * API class for handling file uploads.
+ * @extends BaseApi
+ */
+class UploadsApi extends BaseApi {
+    /**
+   * Retrieves an upload URL for a given upload path.
+   *
+   * @async
+   * @param {string} upload_path - The path of the upload resource.
+   * @returns {Promise<UploadsResponse>} - A Promise resolving to the response data.
+   */
+    async getUploadUrl(uploadPath) {
+        return await this.post(`${resourceName}/${uploadPath}`);
+    }
+}
+export { UploadsApi };

package/build/uploads/types.d.ts

@@ -0,0 +1,5 @@
+export interface UploadsResponse {
+    path: string;
+    url: string;
+    expiry: string;
+}

package/build/uploads/types.js

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

package/package.json

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