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

package/build/base-api.js

@@ -13,7 +13,7 @@ export class BaseApi {
        */
     constructor(config) {
         this.apiKey = config.apiKey;
-        this.environment = config.environment === null ? config.environment : 'prod';
+        this.environment = config.environment ?? 'prod';
         this.base_api = mande(`${this.getBaseUrl()}`, {
             headers: this.getHeaders()
         });

package/build/index.d.ts

@@ -12,8 +12,9 @@ import { PingApi } from './ping';
 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 {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, 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 };
+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 };

package/build/index.js

@@ -7,7 +7,8 @@ import { AttributeApi } from './attributes';
 import { PingApi } from './ping';
 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]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi };

package/build/installations/index.d.ts

@@ -0,0 +1,17 @@
+import { type ApiRecords } from '../types';
+import { BaseApi } from '../base-api';
+import { type Installation } from './types';
+/**
+ * @module InstallationsApi
+ * @description This module provides methods for fetching installation records.
+ * @extends BaseApi
+ */
+declare class InstallationsApi extends BaseApi {
+    /**
+     * Get all installations for the current user
+     * @param {number} appCategory - An optional filter for app categories.
+     * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
+     */
+    getInstallations(appCategory?: string): Promise<ApiRecords<Installation>>;
+}
+export { type Installation, InstallationsApi };

package/build/installations/index.js

@@ -0,0 +1,19 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'installations';
+/**
+ * @module InstallationsApi
+ * @description This module provides methods for fetching installation records.
+ * @extends BaseApi
+ */
+class InstallationsApi extends BaseApi {
+    /**
+     * Get all installations for the current user
+     * @param {number} appCategory - An optional filter for app categories.
+     * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
+     */
+    async getInstallations(appCategory) {
+        const appCategoryQuery = `?app_category=${appCategory ?? ''}`;
+        return await this.get(`${resourceName}${appCategoryQuery}`);
+    }
+}
+export { InstallationsApi };

package/build/installations/types.d.ts

@@ -0,0 +1,14 @@
+export interface Installation {
+    id: number;
+    app_id: number;
+    company_id: number;
+    tier_id: string;
+    permissions: string[];
+    installation_time: Date;
+}
+export interface Permission {
+    acess: Access;
+    resource: string;
+}
+type Access = 'read' | 'write' | 'admin' | 'create' | 'revise';
+export {};

package/build/installations/types.js

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

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

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

package/build/rosetta-stone/index.js

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

package/package.json

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