@narrative.io/data-collaboration-sdk-ts 0.0.39 → 0.0.41

package/build/data-streams/index.d.ts

@@ -0,0 +1,27 @@
+import { type ApiRecords } from '../types';
+import { BaseApi } from '../base-api';
+import { type DataStream } from './types';
+/**
+ * @module DataStreramsApi
+ * @description This module provides methods for interacting with Data Streams.
+ * @extends BaseApi
+ */
+declare class DataStreamsApi extends BaseApi {
+    /**
+     * @function getDataStreamsForDSM
+     * @memberof DataStreramsApi
+     * @description Fetches a list Data Streams that contain an offer with the data_streams_market channel, given a search term
+     * @returns {Promise<ApiRecords<DataStream>>} A promise that resolves to the list of Data Streams.
+     */
+    getDataStreamsForDSM(searchTerm: string, authenticated: boolean): Promise<ApiRecords<DataStream>>;
+    /**
+    * Gets a single Data Stream given a slug and companyId.
+    *
+    * @param {number} slug - The slug for the Data Stream to return.
+    * @param {number} companyId - The companyId for the Data Stream to return.
+    * @returns {Promise<DataStream>} A promise that resolves with the Data Stream.
+    */
+    getDataStreamBySlug(slug: string, companyId: number, authenticated: boolean): Promise<DataStream>;
+    private getBaseUri;
+}
+export { DataStreamsApi, type DataStream };

package/build/data-streams/index.js

@@ -0,0 +1,37 @@
+import { BaseApi } from '../base-api';
+const resourceName = 'data-stream';
+/**
+ * @module DataStreramsApi
+ * @description This module provides methods for interacting with Data Streams.
+ * @extends BaseApi
+ */
+class DataStreamsApi extends BaseApi {
+    /**
+     * @function getDataStreamsForDSM
+     * @memberof DataStreramsApi
+     * @description Fetches a list Data Streams that contain an offer with the data_streams_market channel, given a search term
+     * @returns {Promise<ApiRecords<DataStream>>} A promise that resolves to the list of Data Streams.
+     */
+    async getDataStreamsForDSM(searchTerm, authenticated) {
+        return await this.get(`${this.getBaseUri(authenticated)}/sales-channel/data-streams-market/search?q=${encodeURIComponent(searchTerm)}`);
+    }
+    /**
+    * Gets a single Data Stream given a slug and companyId.
+    *
+    * @param {number} slug - The slug for the Data Stream to return.
+    * @param {number} companyId - The companyId for the Data Stream to return.
+    * @returns {Promise<DataStream>} A promise that resolves with the Data Stream.
+    */
+    async getDataStreamBySlug(slug, companyId, authenticated) {
+        return await this.get(`${this.getBaseUri(authenticated)}/company/${companyId}/slug/${slug}`);
+    }
+    getBaseUri(authenticated) {
+        if (authenticated) {
+            return resourceName;
+        }
+        else {
+            return `public/${resourceName}`;
+        }
+    }
+}
+export { DataStreamsApi };

package/build/data-streams/types.d.ts

@@ -0,0 +1,50 @@
+import { type Dataset } from '../datasets/types';
+import { type DataRules } from './data-rules/types';
+export interface DataStream {
+    id: number;
+    company_id: number;
+    name: string;
+    slug: string;
+    content?: DataStreamContent;
+    tags?: string[];
+    category?: string;
+    offers?: Offer[];
+    data_rules?: DataRules;
+    auth_rules?: AuthRules;
+    created_by: number;
+    created_at: Date;
+    updated_at: Date;
+    updated_by: number;
+    pagination_id: number;
+    datasets?: Dataset[];
+}
+export interface DataStreamContent {
+    description: string;
+    icon?: string;
+    sections?: string[];
+}
+export type SalesChannel = 'data_streams_market' | 'data_shop';
+export interface Offer {
+    id: string;
+    channel: SalesChannel;
+    licensing: OfferLicensing;
+    pricing: OfferPricing;
+    shops?: string[];
+}
+export interface OfferLicensing {
+    period: string;
+    license: {
+        id: string;
+    };
+}
+export interface OfferPricing {
+    micro_cents_usd: number;
+    type: 'per_record' | 'max_price_per_record';
+}
+export interface AuthRules {
+    company_contstraint: CompanyConstraint;
+}
+export interface CompanyConstraint {
+    type: InclusionType;
+}
+export type InclusionType = 'include' | 'exclude';

package/build/data-streams/types.js

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

package/build/index.d.ts

@@ -16,9 +16,10 @@ 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';
-import { NqlApi, type NqlQuery, type NqlResult } from './nql';
+import { NqlApi, type NqlCompileResult, type NqlQuery, type NqlResult } from './nql';
+import { DataStreamsApi, type DataStream } from './data-streams';
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, 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, type NqlQuery, type NqlResult };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, 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, type NqlQuery, type NqlResult, type NqlCompileResult, type DataStream };

package/build/index.js

@@ -11,7 +11,8 @@ import { ProductsApi } from './products';
 import { CompanyInfoApi } from './company-info';
 import { InstallationsApi } from './installations';
 import { NqlApi } from './nql';
+import { DataStreamsApi } from './data-streams';
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi };

package/build/nql/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from '../base-api';
-import { type NqlQuery, type NqlResult } from './types';
+import type { NqlCompileResult, NqlQuery, NqlResult } from './types';
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -9,8 +9,15 @@ declare class NqlApi extends BaseApi {
      * Executes an NQL query and returns the result.
      *
      * @param {string} nqlQuery - The NQL query to execute.
-     * @returns {Promise<object>} A promise that resolves with the result of the NQL query.
+     * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
      */
     executeNql(nqlQuery: NqlQuery): Promise<NqlResult>;
+    /**
+     * Compiles an NQL query and returns the result, including any errors.
+     *
+     * @param {string} nqlQuery - The NQL query to compile.
+     * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL compilation.
+     */
+    compileNql(nqlQuery: NqlQuery): Promise<NqlCompileResult>;
 }
-export { NqlApi, type NqlResult, type NqlQuery };
+export { NqlApi, type NqlResult, type NqlQuery, type NqlCompileResult };

package/build/nql/index.js

@@ -16,10 +16,20 @@ class NqlApi extends BaseApi {
      * Executes an NQL query and returns the result.
      *
      * @param {string} nqlQuery - The NQL query to execute.
-     * @returns {Promise<object>} A promise that resolves with the result of the NQL query.
+     * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
      */
     async executeNql(nqlQuery) {
-        const response = await this.post(resourceName, nqlQuery);
+        const response = await this.post(`${resourceName}/run`, nqlQuery);
+        return response;
+    }
+    /**
+     * Compiles an NQL query and returns the result, including any errors.
+     *
+     * @param {string} nqlQuery - The NQL query to compile.
+     * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL compilation.
+     */
+    async compileNql(nqlQuery) {
+        const response = await this.post(`${resourceName}/compile`, nqlQuery);
         return response;
     }
 }

package/build/nql/types.d.ts

@@ -26,6 +26,11 @@ export interface NqlResult {
     state: string;
     updated_at: string;
 }
+export type NqlMappingErrors = Record<number, string>;
+export interface NqlCompileResult {
+    sql: string;
+    mappingErrors?: NqlMappingErrors;
+}
 export interface NqlQuery {
     nql: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -25,7 +25,7 @@
     "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.4.2",
     "@commitlint/config-conventional": "^17.4.2",
-    "@types/jest": "^29.4.0",
+    "@types/jest": "^29.5.0",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "babel-jest": "^29.4.3",
     "eslint": "^8.33.0",
@@ -33,10 +33,10 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
+    "husky": "^8.0.0",
     "jest": "^29.4.3",
     "ts-jest": "^29.0.5",
-    "typescript": "^5.0.2",
-    "husky": "^8.0.0"
+    "typescript": "^5.0.2"
   },
   "dependencies": {
     "mande": "^2.0.3"