@onereach/types-hitl-api 0.0.1-rc.1 → 0.0.2-rc.1

package/dist/types/common.d.ts

@@ -2,3 +2,10 @@ export declare type JSONProperty = string | boolean | number | null;
 export declare type JSONType = JSONType[] | {
     [key: string]: JSONProperty | JSONType;
 };
+export interface IDefaultPrimaryKey {
+    readonly id: string;
+}
+export interface ITimestamps {
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}

package/dist/types/index.types.d.ts

@@ -4,3 +4,4 @@
  */
 export * from './common';
 export * as Settings from './settings';
+export * as Migrations from './migrations';

package/dist/types/migrations.d.ts

@@ -0,0 +1,14 @@
+export interface IMigration {
+    readonly file: string;
+}
+export interface IMigrationResult {
+    readonly migrations: IMigration[];
+    readonly method: 'up' | 'down';
+}
+export interface IRunMigrationsQuery {
+    readonly name?: string;
+}
+export interface IGetMigrationsResponse {
+    readonly executed: IMigration[];
+    readonly pending: IMigration[];
+}

package/dist/types/settings.d.ts

@@ -1,18 +1,24 @@
 import { JSONType } from './common';
-export interface IGetSettingsQuery {
-    /** Skip this argument to return all saved settings */
-    readonly categories?: string[];
-    readonly isCommon?: boolean;
-    readonly accountId?: string;
+export interface ISettingsModel {
+    readonly category: string;
+    readonly userId: string;
+    readonly data: JSONType;
 }
 export interface IUpdateSettingsQuery {
     readonly isCommon?: boolean;
     readonly accountId?: string;
 }
+export interface IGetSettingsQuery extends IUpdateSettingsQuery {
+    /** Skip this argument to return all saved settings */
+    readonly categories?: string[];
+}
+export interface IGetOrUpdateSettingsResponse {
+    readonly data: Record<string, ISettingsModel>;
+}
 /**
  * Multiple categories can be updated or created in a single request
  * by providing { "avatar": { ... }, "notifications": { ... }, ... }
  */
 export interface IUpdateSettingsBody {
-    readonly data: Record<string, JSONType | null>;
+    readonly data: Record<string, JSONType>;
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@onereach/types-hitl-api",
-  "version": "0.0.1-rc.1",
+  "version": "0.0.2-rc.1",
   "author": "OneReach.ai",
   "main": "dist/types/index.types.d.ts",
   "files": [
-    "dist/types/**/*"
+    "dist/types/**/*.*"
   ]
 }