@narrative.io/data-collaboration-sdk-ts 0.0.40 → 0.0.42

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 DataStreamsApi
+ * @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 DataStreamsApi
+ * @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,128 @@
+import { type Dataset } from '../datasets/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 interface DataRules {
+    column_sets?: ColumnSet[];
+    attributes?: AttributeSet[];
+    deduplication?: Deduplication;
+    frequency_filter?: FrequencyFilter;
+    dataset_filter?: DatasetFilter;
+    ingestion_timestamp_filter?: TimestampFilter;
+}
+export interface ColumnSet {
+    dataset_id: string;
+    fields: ColumnWithFilterAndExport[];
+}
+export interface AttributeSet {
+    attribute_id: number;
+    fields: ColumnWithFilterAndExport[];
+    optional: boolean;
+}
+export interface Deduplication {
+    period: string;
+    column_references?: ColumnReferences[];
+    attribute_references?: AttributeReferences[];
+}
+export interface FrequencyFilter {
+    column_references?: ColumnReferences[];
+    attribute_references?: AttributeReferences[];
+    minInclusive?: number;
+    maxInclusive?: number;
+}
+export interface AttributeReferences {
+    attribute_id: number;
+    columnNames: string[];
+}
+export interface ColumnReferences {
+    dataset_id: number;
+    columnNames: string[];
+}
+export interface DatasetFilter {
+    dataset_id: string;
+    attribute: AttributeField;
+}
+export interface DatasetFilterEquality extends DatasetFilter {
+    parent?: AttributeField;
+    inclusion: InclusionType;
+}
+export interface AttributeField {
+    attribute_id: string;
+    field: string;
+}
+export interface DatasetFilterSpatial extends DatasetFilter {
+    predicate: SpatialPredicate;
+}
+export interface ColumnWithFilterAndExport {
+    field: string;
+    filter?: FilterDefinition;
+    exported: boolean;
+}
+export type FilterDefinition = 'include_all_values_including_nulls_filter' | 'include_only_if_not_null_filter' | EnumFilter | IntervalFilter | TimestampFilter | SparkSqlConstraintFilter;
+export interface EnumFilter {
+    type: InclusionType;
+    list: string[];
+}
+export interface IntervalFilter {
+    min?: IntervalEnd;
+    max?: IntervalEnd;
+}
+export interface TimestampFilter {
+    recency?: string;
+    from?: IntervalEnd;
+    to?: IntervalEnd;
+}
+export interface SparkSqlConstraintFilter {
+    expressions: string[];
+}
+export type IntervalEndType = 'inclusive' | 'exclusive';
+export interface IntervalEnd {
+    type: IntervalEndType;
+    value: string;
+}
+export type SpatialPredicate = 'contains' | 'intersects';
+export type InclusionType = 'include' | 'exclude';

package/build/data-streams/types.js

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

package/build/index.d.ts

@@ -17,8 +17,9 @@ import { type Product, ProductsApi } from './products';
 import { CompanyInfoApi, type CompanyInfo } from './company-info';
 import { InstallationsApi, type Installation } from './installations';
 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 {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi {
 }
-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, type NqlCompileResult };
+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 };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi };

package/package.json

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