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

package/build/company-info/index.d.ts

@@ -1,3 +1,4 @@
+import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
 import { type CompanyInfo } from './types';
 /**
@@ -6,5 +7,10 @@ import { type CompanyInfo } from './types';
  */
 declare class CompanyInfoApi extends BaseApi {
     companyId: () => Promise<number>;
+    /**
+     * Get a list of all providers in the Data Streams Market
+     * @returns {Promise<ApiRecords<CompanyInfo[]>>} - Promise resolving to an array of CompanyInfo records
+     */
+    getAllProvidersCompanyInfo(): Promise<ApiRecords<CompanyInfo[]>>;
 }
 export { type CompanyInfo, CompanyInfoApi };

package/build/company-info/index.js

@@ -14,5 +14,12 @@ class CompanyInfoApi extends BaseApi {
     companyId = async () => {
         return (await this.get(`${resourceName}/whoami`)).id;
     };
+    /**
+     * Get a list of all providers in the Data Streams Market
+     * @returns {Promise<ApiRecords<CompanyInfo[]>>} - Promise resolving to an array of CompanyInfo records
+     */
+    async getAllProvidersCompanyInfo() {
+        return await this.get(`${resourceName}/data-streams-markets`);
+    }
 }
 export { CompanyInfoApi };

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

@@ -2,7 +2,7 @@ import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
 import { type DataStream } from './types';
 /**
- * @module DataStreramsApi
+ * @module DataStreamsApi
  * @description This module provides methods for interacting with Data Streams.
  * @extends BaseApi
  */

package/build/data-streams/index.js

@@ -1,7 +1,7 @@
 import { BaseApi } from '../base-api';
 const resourceName = 'data-stream';
 /**
- * @module DataStreramsApi
+ * @module DataStreamsApi
  * @description This module provides methods for interacting with Data Streams.
  * @extends BaseApi
  */

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

@@ -1,5 +1,4 @@
 import { type Dataset } from '../datasets/types';
-import { type DataRules } from './data-rules/types';
 export interface DataStream {
     id: number;
     company_id: number;
@@ -47,4 +46,83 @@ export interface AuthRules {
 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/index.d.ts

@@ -20,6 +20,6 @@ import { NqlApi, type NqlCompileResult, type NqlQuery, type NqlResult } from './
 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, 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

@@ -14,5 +14,5 @@ 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]);
+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.41",
+  "version": "0.0.43",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",