@narrative.io/data-collaboration-sdk-ts 0.0.9 → 0.0.11

package/build/base-api.d.ts

@@ -1,4 +1,4 @@
-import type { Config } from './types';
+import { type Config } from './types';
 /**
  * BaseApi class provides basic functionality for making API requests.
  */

package/build/datasets/index.d.ts

@@ -1,4 +1,4 @@
-import { type ApiRecords } from 'src/types';
+import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
 import { type Dataset } from './types';
 /**

package/build/datasets/types.d.ts

@@ -0,0 +1,43 @@
+export interface Dataset {
+    id: number;
+    company_id: number;
+    created_at: string;
+    description: string;
+    name: string;
+    retention_policy: RetentionPolicy;
+    schema: Schema;
+    status: DatasetStatus;
+    tags: string[];
+    updated_at: Date;
+    write_mode: DatasetWriteMode;
+}
+type SchemaFileConfigType = 'flat';
+type SchemaPropertiesType = 'string' | 'number' | 'boolean';
+type DatasetStatus = 'active' | 'archived';
+type DatasetWriteMode = 'append' | 'overwrite';
+type RetentionPolicyType = 'retain_everything';
+type SchemaType = 'object' | 'value';
+interface RetentionPolicy {
+    type: RetentionPolicyType;
+}
+interface SchemaFileConfig {
+    type: SchemaFileConfigType;
+    delimiter: string;
+    escape: string;
+    header: boolean;
+    quote: string;
+}
+type SchemaProperties = Record<string, {
+    order: number;
+    approximate_cardinality: number;
+    description?: string;
+    type: SchemaPropertiesType;
+}>;
+interface Schema {
+    file_config: SchemaFileConfig;
+    type: SchemaType;
+    properties: SchemaProperties;
+    required: string[];
+    primary: string;
+}
+export {};

package/build/datasets/types.js

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

package/build/health/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from '../base-api';
-import type { HealthCheckResult } from './types';
+import { type HealthCheckResult } from './types';
 export declare class HealthCheckApi extends BaseApi {
     getHealthCheck(): Promise<HealthCheckResult>;
 }

package/build/health/types.d.ts

@@ -0,0 +1,11 @@
+export interface HealthCheckResult {
+    success: boolean;
+    checks: CheckResult[];
+}
+export interface CheckResult {
+    name: string;
+    type: HealthCheckResultType;
+    success: boolean;
+    error_message?: string | null;
+}
+export type HealthCheckResultType = 'postgresql' | 's3';

package/build/health/types.js

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

package/build/index.d.ts

@@ -2,8 +2,12 @@ import { BaseApi } from './base-api';
 import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
+import { type Environment, type Config, type ApiRecords } from './types';
+import { type Dataset } from './datasets/types';
+import { type HealthCheckResult } from './health/types';
+import { type SampleRecords } from './rosetta-stone/types';
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi {
 }
-export default NarrativeApi;
+export { NarrativeApi, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords };

package/build/index.js

@@ -6,4 +6,4 @@ import { applyMixins } from './utils';
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi]);
-export default NarrativeApi;
+export { NarrativeApi };

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

@@ -0,0 +1,10 @@
+export interface SampleRecords {
+    sample: SampleRecord;
+}
+export type SampleRecord = Record<string, string | number | boolean>;
+export interface RosettaStoneResponse {
+    label: number;
+    key: string;
+    name: string;
+    score: number;
+}

package/build/rosetta-stone/types.js

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

package/build/types.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Environment for the API.
+ *
+ * @typedef {'dev' | 'prod' | string} Environment
+ */
+export type Environment = 'dev' | 'prod' | string;
+/**
+ * Configuration object for the BaseApi class.
+ *
+ * @typedef {Object} Config
+ * @property {string} [apiKey] - API key.
+ * @property {Environment} [environment='prod'] - Environment for the API (e.g. 'dev', 'prod').
+ */
+export interface Config {
+    apiKey?: string;
+    environment?: Environment;
+}
+export interface ApiRecords<T> {
+    records: T[];
+}

package/build/types.js

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

package/package.json

@@ -1,13 +1,10 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
   "types": "build/index.d.ts",
-  "exports": {
-    "types": "./build/index.d.ts"
-  },
   "description": "",
   "scripts": {
     "build": "tsc",
@@ -17,7 +14,7 @@
     "preversion": "npm run lint",
     "version": "npm run && git add -A src",
     "postversion": "git push && git push --tags",
-    "test": "vitest --coverage"
+    "test": "vitest run --coverage"
   },
   "keywords": [],
   "author": "",