oraku-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { ActivityEvent, EngagementFilter, EngagementPullOptions, ProjectSettings, ProjectCron, OrakuConfig } from './types';
+export declare class OrakuSDK {
+    private apiUrl;
+    private apiKey;
+    project: {
+        setSettings: (settings: ProjectSettings) => Promise<void>;
+        setCron: (cron: ProjectCron) => Promise<void>;
+    };
+    constructor(config: OrakuConfig);
+    private headers;
+    loadInformation(rows: ActivityEvent[]): Promise<void>;
+    generateEngagementPulls(filter: EngagementFilter, type: 'notifications', options?: EngagementPullOptions): Promise<string[]>;
+    private setSettings;
+    private setCron;
+}
+export default OrakuSDK;
+export type { ActivityEvent, EngagementFilter, EngagementPullOptions, ProjectSettings, ProjectCron, OrakuConfig };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,WAAW,EACX,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;IAEtB,OAAO,EAAE;QACP,WAAW,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QACzD,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC9C,CAAA;gBAEW,MAAM,EAAE,WAAW;IAU/B,OAAO,CAAC,OAAO;IAOT,eAAe,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASrD,uBAAuB,CAC3B,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,eAAe,EACrB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,MAAM,EAAE,CAAC;YAiBN,WAAW;YASX,OAAO;CAQtB;AAED,eAAe,QAAQ,CAAA;AACvB,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA"}

package/dist/index.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrakuSDK = void 0;
+class OrakuSDK {
+    constructor(config) {
+        this.apiUrl = config.apiUrl.replace(/\/$/, '');
+        this.apiKey = config.apiKey;
+        this.project = {
+            setSettings: (settings) => this.setSettings(settings),
+            setCron: (cron) => this.setCron(cron)
+        };
+    }
+    headers() {
+        return {
+            'Content-Type': 'application/json',
+            'x-api-key': this.apiKey
+        };
+    }
+    async loadInformation(rows) {
+        const res = await fetch(`${this.apiUrl}/ingest`, {
+            method: 'POST',
+            headers: this.headers(),
+            body: JSON.stringify({ events: rows })
+        });
+        if (!res.ok)
+            throw new Error(`loadInformation failed: ${res.status}`);
+    }
+    async generateEngagementPulls(filter, type, options = {}) {
+        const params = new URLSearchParams();
+        if (filter.externalRef)
+            params.set('externalRef', filter.externalRef);
+        if (filter.category)
+            params.set('category', filter.category);
+        if (options.limit)
+            params.set('limit', String(options.limit));
+        params.set('type', type);
+        const res = await fetch(`${this.apiUrl}/notifications?${params.toString()}`, {
+            method: 'GET',
+            headers: this.headers()
+        });
+        if (!res.ok)
+            throw new Error(`generateEngagementPulls failed: ${res.status}`);
+        const data = await res.json();
+        return data.notifications;
+    }
+    async setSettings(settings) {
+        const res = await fetch(`${this.apiUrl}/project/settings`, {
+            method: 'POST',
+            headers: this.headers(),
+            body: JSON.stringify(settings)
+        });
+        if (!res.ok)
+            throw new Error(`setSettings failed: ${res.status}`);
+    }
+    async setCron(cron) {
+        const res = await fetch(`${this.apiUrl}/project/cron`, {
+            method: 'POST',
+            headers: this.headers(),
+            body: JSON.stringify(cron)
+        });
+        if (!res.ok)
+            throw new Error(`setCron failed: ${res.status}`);
+    }
+}
+exports.OrakuSDK = OrakuSDK;
+exports.default = OrakuSDK;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASA,MAAa,QAAQ;IASnB,YAAY,MAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAE3B,IAAI,CAAC,OAAO,GAAG;YACb,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;YACrD,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;SACtC,CAAA;IACH,CAAC;IAEO,OAAO;QACb,OAAO;YACL,cAAc,EAAE,kBAAkB;YAClC,WAAW,EAAE,IAAI,CAAC,MAAM;SACzB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAqB;QACzC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,SAAS,EAAE;YAC/C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;YACvB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;SACvC,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;IACvE,CAAC;IAED,KAAK,CAAC,uBAAuB,CAC3B,MAAwB,EACxB,IAAqB,EACrB,UAAiC,EAAE;QAEnC,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;QACpC,IAAI,MAAM,CAAC,WAAW;YAAE,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;QACrE,IAAI,MAAM,CAAC,QAAQ;YAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC5D,IAAI,OAAO,CAAC,KAAK;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;QAC7D,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAExB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,kBAAkB,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE;YAC3E,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;SACxB,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;QAE7E,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAiC,CAAA;QAC5D,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,QAAyB;QACjD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,mBAAmB,EAAE;YACzD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;YACvB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SAC/B,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;IACnE,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,IAAiB;QACrC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,eAAe,EAAE;YACrD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;YACvB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/D,CAAC;CACF;AAzED,4BAyEC;AAED,kBAAe,QAAQ,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+export interface ActivityEvent {
+    externalRef?: string;
+    category?: string;
+    subcategory?: string;
+    log?: string;
+    createdAt?: string;
+    meta?: Record<string, unknown>;
+}
+export interface EngagementFilter {
+    externalRef?: string;
+    category?: string;
+}
+export interface EngagementPullOptions {
+    limit?: number;
+}
+export interface ProjectSettings {
+    webhookUrl: string;
+    webhookAuthKey?: string;
+}
+export interface ProjectCron {
+    cron: string;
+    type: 'daily' | 'weekly' | 'monthly';
+}
+export interface OrakuConfig {
+    apiUrl: string;
+    apiKey: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;CACrC;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "oraku-sdk",
+  "version": "1.0.0",
+  "description": "SDK for the Oraku engagement engine",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,86 @@
+import type {
+  ActivityEvent,
+  EngagementFilter,
+  EngagementPullOptions,
+  ProjectSettings,
+  ProjectCron,
+  OrakuConfig
+} from './types'
+
+export class OrakuSDK {
+  private apiUrl: string
+  private apiKey: string
+
+  project: {
+    setSettings: (settings: ProjectSettings) => Promise<void>
+    setCron: (cron: ProjectCron) => Promise<void>
+  }
+
+  constructor(config: OrakuConfig) {
+    this.apiUrl = config.apiUrl.replace(/\/$/, '')
+    this.apiKey = config.apiKey
+
+    this.project = {
+      setSettings: (settings) => this.setSettings(settings),
+      setCron: (cron) => this.setCron(cron)
+    }
+  }
+
+  private headers() {
+    return {
+      'Content-Type': 'application/json',
+      'x-api-key': this.apiKey
+    }
+  }
+
+  async loadInformation(rows: ActivityEvent[]): Promise<void> {
+    const res = await fetch(`${this.apiUrl}/ingest`, {
+      method: 'POST',
+      headers: this.headers(),
+      body: JSON.stringify({ events: rows })
+    })
+    if (!res.ok) throw new Error(`loadInformation failed: ${res.status}`)
+  }
+
+  async generateEngagementPulls(
+    filter: EngagementFilter,
+    type: 'notifications',
+    options: EngagementPullOptions = {}
+  ): Promise<string[]> {
+    const params = new URLSearchParams()
+    if (filter.externalRef) params.set('externalRef', filter.externalRef)
+    if (filter.category) params.set('category', filter.category)
+    if (options.limit) params.set('limit', String(options.limit))
+    params.set('type', type)
+
+    const res = await fetch(`${this.apiUrl}/notifications?${params.toString()}`, {
+      method: 'GET',
+      headers: this.headers()
+    })
+    if (!res.ok) throw new Error(`generateEngagementPulls failed: ${res.status}`)
+
+    const data = await res.json() as { notifications: string[] }
+    return data.notifications
+  }
+
+  private async setSettings(settings: ProjectSettings): Promise<void> {
+    const res = await fetch(`${this.apiUrl}/project/settings`, {
+      method: 'POST',
+      headers: this.headers(),
+      body: JSON.stringify(settings)
+    })
+    if (!res.ok) throw new Error(`setSettings failed: ${res.status}`)
+  }
+
+  private async setCron(cron: ProjectCron): Promise<void> {
+    const res = await fetch(`${this.apiUrl}/project/cron`, {
+      method: 'POST',
+      headers: this.headers(),
+      body: JSON.stringify(cron)
+    })
+    if (!res.ok) throw new Error(`setCron failed: ${res.status}`)
+  }
+}
+
+export default OrakuSDK
+export type { ActivityEvent, EngagementFilter, EngagementPullOptions, ProjectSettings, ProjectCron, OrakuConfig }

package/src/types.ts

@@ -0,0 +1,32 @@
+export interface ActivityEvent {
+  externalRef?: string
+  category?: string
+  subcategory?: string
+  log?: string
+  createdAt?: string
+  meta?: Record<string, unknown>
+}
+
+export interface EngagementFilter {
+  externalRef?: string
+  category?: string
+}
+
+export interface EngagementPullOptions {
+  limit?: number
+}
+
+export interface ProjectSettings {
+  webhookUrl: string
+  webhookAuthKey?: string
+}
+
+export interface ProjectCron {
+  cron: string
+  type: 'daily' | 'weekly' | 'monthly'
+}
+
+export interface OrakuConfig {
+  apiUrl: string
+  apiKey: string
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020", "dom"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "esModuleInterop": true
+  },
+  "include": ["src"]
+}