@narrative.io/data-collaboration-sdk-ts 0.0.33 → 0.0.35

package/build/attributes/types.d.ts

@@ -1,5 +1,5 @@
 export type Attribute = PrimitiveAttribute | ArrayAttribute | ObjectAttribute;
-interface BaseAttribute {
+export interface BaseAttribute {
     id: number;
     name: string;
     display_name?: string;
@@ -7,26 +7,25 @@ interface BaseAttribute {
     type: string;
     validations?: string[];
 }
-interface PrimitiveAttribute extends BaseAttribute {
+export interface PrimitiveAttribute extends BaseAttribute {
     type: 'string' | 'boolean' | 'double' | 'long' | 'timestamptz';
     enum?: string[] | number[] | boolean[];
     is_join_key?: boolean;
 }
-type SubAttribute = Partial<Omit<Attribute, 'name' | 'id'>> & {
+export type SubAttribute = Partial<Omit<Attribute, 'name' | 'id'>> & {
     type: string;
     enum?: string[] | number[] | boolean[];
     is_join_key?: boolean;
 };
-interface RefAttribute {
+export interface RefAttribute {
     $ref: number;
 }
-interface ArrayAttribute extends BaseAttribute {
+export interface ArrayAttribute extends BaseAttribute {
     type: 'array';
     items: SubAttribute;
 }
-interface ObjectAttribute extends BaseAttribute {
+export interface ObjectAttribute extends BaseAttribute {
     type: 'object';
     properties: Record<string, SubAttribute | RefAttribute>;
     required?: string[];
 }
-export {};

package/build/base-api.d.ts

@@ -8,6 +8,7 @@ export declare abstract class BaseApi {
     private readonly environment;
     private readonly base_api;
     private readonly headers;
+    private readonly verbose;
     /**
        * @param {Config} config - Configuration object.
        * @param {string} [config.apiKey] - API key.

package/build/base-api.js

@@ -1,4 +1,5 @@
 import { mande } from 'mande';
+import { addTrailingSlash } from './utils';
 /**
  * BaseApi class provides basic functionality for making API requests.
  */
@@ -7,18 +8,28 @@ export class BaseApi {
     environment;
     base_api;
     headers;
+    verbose;
     /**
        * @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.verbose = config.verbose ?? false;
         this.apiKey = config.apiKey;
         this.environment = config.environment ?? 'prod';
         this.headers = config.headers ?? {};
         this.base_api = mande(`${this.getBaseUrl()}`, {
             headers: this.constructHeaders()
         });
+        if (this.verbose) {
+            console.log(`Using environment: ${this.environment}`);
+            console.log(`Using API key: ${this.apiKey ?? 'undefined'}`);
+            console.log(`Using headers: ${JSON.stringify(this.headers)}`);
+            console.log(`Using base URL: ${this.getBaseUrl()}`);
+            console.log(`Using base API: ${JSON.stringify(this.base_api)}`);
+            console.log(`This is us: ${JSON.stringify(this)}`);
+        }
     }
     /**
      * Retrieves the headers associated with the API instance.
@@ -60,6 +71,8 @@ export class BaseApi {
        * @template T - Type of the response data.
        */
     async get(endpoint) {
+        if (this.verbose)
+            console.log(`Making GET request to ${endpoint}...`);
         return await this.base_api.get(endpoint);
     }
     /**
@@ -72,6 +85,8 @@ export class BaseApi {
        * @template T - Type of the response data.
        */
     async post(endpoint, data) {
+        if (this.verbose)
+            console.log(`Making POST request to ${endpoint} with data: ${JSON.stringify(data)}...`);
         return await this.base_api.post(endpoint, data);
     }
     /**
@@ -82,6 +97,8 @@ export class BaseApi {
      * @protected
      */
     async delete(endpoint) {
+        if (this.verbose)
+            console.log(`Making GET request to ${endpoint}...`);
         await this.base_api.delete(endpoint);
     }
     /**
@@ -92,6 +109,8 @@ export class BaseApi {
      * @returns A Promise that resolves to the data returned by the server.
      */
     async put(endpoint, data) {
+        if (this.verbose)
+            console.log(`Making GET request to ${endpoint} with data: ${JSON.stringify(data)}...`);
         return await this.base_api.put(endpoint, data);
     }
     /**
@@ -109,7 +128,7 @@ export class BaseApi {
                 return 'https://api-dev.narrative.io/';
             }
             default: {
-                return this.environment;
+                return addTrailingSlash(this.environment);
             }
         }
     }

package/build/datasets/types.d.ts

@@ -10,6 +10,8 @@ export interface Dataset {
     tags: string[];
     updated_at: Date;
     write_mode: DatasetWriteMode;
+    last_snapshot_created_at?: string;
+    active_dataset_stored_bytes?: number;
 }
 export interface DatasetColumnSummary {
     id: number;

package/build/index.d.ts

@@ -7,6 +7,7 @@ import { type DatasetTableSummaryAPIResponse, type Dataset, type DatasetTableSum
 import { type HealthCheckResult } from './health/types';
 import { type SampleRecords } from './rosetta-stone/types';
 import { AttributeApi } from './attributes';
+import { type Resource, ResourceApi, type BucketCreationRequest, type UpdateAccessTypeRequest } from './resources';
 import { type Attribute } from './attributes/types';
 import { PingApi } from './ping';
 import { UploadsApi } from './uploads';
@@ -17,6 +18,6 @@ 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, UploadsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi {
 }
-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, type FilePerSnapshotResponse };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, type Resource, 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, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest };

package/build/index.js

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

package/build/resources/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview This module provides methods for fetching resources.
+ * @author Your Name
+ */
+import { type ApiRecords } from '../types';
+import { BaseApi } from '../base-api';
+import { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest } from './types';
+export { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest };
+/**
+ * @class ResourceApi
+ * @extends {BaseApi}
+ * @description This class provides methods for fetching resources.
+ */
+export declare class ResourceApi extends BaseApi {
+    /**
+     * @function getBuckets
+     * @memberof ResourceApi
+     * @description Fetches a list of buckets for a given datasetId.
+     * @returns {Promise<ApiRecords<Resource>>} A promise that resolves to the list of resources.
+     */
+    getBuckets(): Promise<ApiRecords<Resource>>;
+    /**
+     * @function createBucket
+     * @memberof ResourceApi
+     * @description Creates a new bucket.
+     * @param {BucketCreationRequest} request - The bucket creation request object.
+     * @returns {Promise<Resource>} A promise that resolves to the created resource.
+     */
+    createBucket(request: BucketCreationRequest): Promise<Resource>;
+    /**
+     * @function updateAccessType
+     * @memberof ResourceApi
+     * @description Updates the access type of a resource.
+     * @param {UpdateAccessTypeRequest} request - The update access type request object.
+     * @returns {Promise<Resource>} A promise that resolves to the updated resource.
+     */
+    updateAccessType(request: UpdateAccessTypeRequest): Promise<Resource>;
+}

package/build/resources/index.js

@@ -0,0 +1,42 @@
+/**
+ * @fileoverview This module provides methods for fetching resources.
+ * @author Your Name
+ */
+import { BaseApi } from '../base-api';
+const resourceName = 'resources';
+/**
+ * @class ResourceApi
+ * @extends {BaseApi}
+ * @description This class provides methods for fetching resources.
+ */
+export class ResourceApi extends BaseApi {
+    /**
+     * @function getBuckets
+     * @memberof ResourceApi
+     * @description Fetches a list of buckets for a given datasetId.
+     * @returns {Promise<ApiRecords<Resource>>} A promise that resolves to the list of resources.
+     */
+    async getBuckets() {
+        return await this.get(`${resourceName}/buckets`);
+    }
+    /**
+     * @function createBucket
+     * @memberof ResourceApi
+     * @description Creates a new bucket.
+     * @param {BucketCreationRequest} request - The bucket creation request object.
+     * @returns {Promise<Resource>} A promise that resolves to the created resource.
+     */
+    async createBucket(request) {
+        return await this.post(`${resourceName}/buckets`, request);
+    }
+    /**
+     * @function updateAccessType
+     * @memberof ResourceApi
+     * @description Updates the access type of a resource.
+     * @param {UpdateAccessTypeRequest} request - The update access type request object.
+     * @returns {Promise<Resource>} A promise that resolves to the updated resource.
+     */
+    async updateAccessType(request) {
+        return await this.post(`${resourceName}/buckets/access`, request);
+    }
+}

package/build/resources/types.d.ts

@@ -0,0 +1,31 @@
+export interface Resource {
+    id: string;
+    company_id: number;
+    auth: {
+        type: 'bucket_policy' | 'role';
+        account_id: string;
+        external_id?: string;
+        role?: string;
+    };
+    name: string;
+    created_at: string;
+    updated_at: string;
+    is_access_mutable: boolean;
+}
+export interface RoleBasedBucketAccess {
+    type: 'role';
+    external_id: string;
+}
+export interface PolicyBasedBucketAccess {
+    type: 'bucket_policy';
+}
+export interface UpdateAccessTypeRequest {
+    bucket_name: string;
+    new_access: BucketAccess;
+}
+export type BucketAccess = RoleBasedBucketAccess | PolicyBasedBucketAccess;
+export interface BucketCreationRequest {
+    account_id: string;
+    resource_id: string;
+    access: BucketAccess;
+}

package/build/resources/types.js

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

package/build/types.d.ts

@@ -15,6 +15,7 @@ export interface Config {
     apiKey?: string;
     environment?: Environment;
     headers?: Record<string, string>;
+    verbose?: boolean;
 }
 export interface ApiRecords<T> {
     records: T[];

package/build/utils.d.ts

@@ -1 +1,7 @@
 export declare function applyMixins(derivedCtor: any, constructors: any[]): void;
+/**
+ * Adds a trailing slash to the given string if it doesn't already end with one.
+ * @param str - The input string.
+ * @returns The modified string with a trailing slash.
+ */
+export declare function addTrailingSlash(str: string): string;

package/build/utils.js

@@ -10,3 +10,11 @@ export function applyMixins(derivedCtor, constructors) {
         });
     });
 }
+/**
+ * Adds a trailing slash to the given string if it doesn't already end with one.
+ * @param str - The input string.
+ * @returns The modified string with a trailing slash.
+ */
+export function addTrailingSlash(str) {
+    return str.endsWith('/') ? str : str + '/';
+}

package/package.json

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