@narrative.io/data-collaboration-sdk-ts 0.0.15 → 0.0.16

package/build/attributes/index.d.ts

@@ -1,6 +1,36 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
 import { type Attribute } from './types';
+/**
+ * A class for accessing the Attribute API.
+ * @extends BaseApi
+ */
 export declare class AttributeApi extends BaseApi {
+    /**
+     * Gets a list of attributes from the API.
+     *
+     * @returns {Promise<ApiRecords<Attribute>>} A promise that resolves with the list of attributes.
+     */
     getAttributes(): Promise<ApiRecords<Attribute>>;
+    /**
+    * Gets a single attribute from the API by its ID.
+    *
+    * @param {number} attributeId - The ID of the attribute to retrieve.
+    * @returns {Promise<Attribute>} A promise that resolves with the attribute.
+    */
+    getAttribute(attributeId: number): Promise<Attribute>;
+    /**
+     * Deletes a single attribute from the API by its ID.
+     *
+     * @param {number} attributeId - The ID of the attribute to delete.
+     * @returns {Promise<void>} A promise that resolves when the delete operation is complete.
+     */
+    deleteAttribute(attributeId: number): Promise<void>;
+    /**
+     * Creates a new attribute on the API.
+     *
+     * @param {Attribute} data - The data for the new attribute.
+     * @returns {Promise<Attribute>} A promise that resolves with the newly created attribute.
+     */
+    createAttribute(data: Attribute): Promise<Attribute>;
 }

package/build/attributes/index.js

@@ -1,7 +1,49 @@
 import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
 const resourceName = 'attributes';
+/**
+ * A class for accessing the Attribute API.
+ * @extends BaseApi
+ */
 export class AttributeApi extends BaseApi {
+    /**
+     * Gets a list of attributes from the API.
+     *
+     * @returns {Promise<ApiRecords<Attribute>>} A promise that resolves with the list of attributes.
+     */
     async getAttributes() {
         return await this.get(resourceName);
     }
+    /**
+    * Gets a single attribute from the API by its ID.
+    *
+    * @param {number} attributeId - The ID of the attribute to retrieve.
+    * @returns {Promise<Attribute>} A promise that resolves with the attribute.
+    */
+    async getAttribute(attributeId) {
+        return await this.get(`${resourceName}/${attributeId}`);
+    }
+    /**
+     * Deletes a single attribute from the API by its ID.
+     *
+     * @param {number} attributeId - The ID of the attribute to delete.
+     * @returns {Promise<void>} A promise that resolves when the delete operation is complete.
+     */
+    async deleteAttribute(attributeId) {
+        await this.delete(`${resourceName}/${attributeId}`);
+    }
+    /**
+     * Creates a new attribute on the API.
+     *
+     * @param {Attribute} data - The data for the new attribute.
+     * @returns {Promise<Attribute>} A promise that resolves with the newly created attribute.
+     */
+    async createAttribute(data) {
+        return await this.post(`${resourceName}`, data);
+    }
 }

package/build/base-api.d.ts

@@ -30,6 +30,14 @@ export declare abstract class BaseApi {
        * @template T - Type of the response data.
        */
     protected post<I, T>(endpoint: string, data: I): Promise<T>;
+    /**
+     * Sends a DELETE request to the specified endpoint.
+     *
+     * @param {string} endpoint - The endpoint to send the request to.
+     * @returns {Promise<void>} A promise that resolves when the DELETE request is complete.
+     * @protected
+     */
+    protected delete(endpoint: string): Promise<void>;
     /**
       * Returns the base URL for the API based on the environment.
       *

package/build/base-api.js

@@ -40,6 +40,16 @@ export class BaseApi {
     async post(endpoint, data) {
         return await this.base_api.post(endpoint, data);
     }
+    /**
+     * Sends a DELETE request to the specified endpoint.
+     *
+     * @param {string} endpoint - The endpoint to send the request to.
+     * @returns {Promise<void>} A promise that resolves when the DELETE request is complete.
+     * @protected
+     */
+    async delete(endpoint) {
+        await this.base_api.delete(endpoint);
+    }
     /**
       * Returns the base URL for the API based on the environment.
       *

package/build/health/index.d.ts

@@ -1,5 +1,14 @@
 import { BaseApi } from '../base-api';
 import { type HealthCheckResult } from './types';
+/**
+ * A class for accessing the Health Check API.
+ * @extends BaseApi
+ */
 export declare class HealthCheckApi extends BaseApi {
+    /**
+     * Gets the result of a health check from the API.
+     *
+     * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the health check.
+     */
     getHealthCheck(): Promise<HealthCheckResult>;
 }

package/build/health/index.js

@@ -1,6 +1,21 @@
 import { BaseApi } from '../base-api';
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
 const resourceName = 'health';
+/**
+ * A class for accessing the Health Check API.
+ * @extends BaseApi
+ */
 export class HealthCheckApi extends BaseApi {
+    /**
+     * Gets the result of a health check from the API.
+     *
+     * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the health check.
+     */
     async getHealthCheck() {
         return await this.get(resourceName);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -20,6 +20,8 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "@vitest/coverage-c8": "^0.28.4",
     "eslint": "^8.33.0",