@equos/node-sdk 0.0.3

package/README.md

@@ -0,0 +1,50 @@
+# @equos/node-sdk
+[Equos.ai](https://equos.ai) official node js SDK.
+
+## Prerequisites
+- Go to [Equos Studio](https://studio.equos.ai).
+- Create an organization.
+- Create an API Key.
+
+
+## Installation
+```bash
+npm install @equos/node-sdk
+```
+
+## Usage
+```ts
+import { Equos } from '@equos/node-sdk';
+
+const MY_API_KEY = ''
+
+const  client = Equos.client(MY_API_KEY);
+
+
+// Create an avatar.
+const referenceImageAsDataUrl: string = 'data:...';
+const avatar = await client.avatars.create('Equos Avatar', referenceImageAsDataUrl);
+console.log(avatar);
+
+// Start a session.
+
+const sessionOptions = {
+    name: 'Equos Session',
+    agent: {
+        instructions: 'You are a Korean teacher...'
+    },
+    avatar: {
+        id: avatar.id // or create one on the fly with referenceImage.
+    },
+    consumerIdentity: {
+        identity: 'client-identity',
+        name: 'Client Name'
+    }
+}
+
+const result = await client.sessions.create(sessionOptions);
+
+console.log(result.session);
+console.log(result.consumerAccessToken);
+
+```

package/dist/apis/avatar.d.ts

@@ -0,0 +1,8 @@
+import { EquosAvatarData, ListEquosAvatarsData } from '../types/avatar.type';
+import { HttpUtils } from '../utils/http.utils';
+export declare class EquosAvatar {
+    private readonly http;
+    constructor(http: HttpUtils);
+    create(name: string, dataUrl: string): Promise<EquosAvatarData>;
+    list(skip?: number, take?: number): Promise<ListEquosAvatarsData>;
+}

package/dist/apis/avatar.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EquosAvatar = void 0;
+class EquosAvatar {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    create(name, dataUrl) {
+        return this.http.post('/avatars', {
+            name,
+            refImage: dataUrl,
+        });
+    }
+    list(skip = 0, take = 10) {
+        return this.http.get(`/avatars?skip=${skip}&take=${take}`);
+    }
+}
+exports.EquosAvatar = EquosAvatar;

package/dist/apis/session.d.ts

@@ -0,0 +1,11 @@
+import { EquosAvatarData, ListEquosAvatarsData } from '../types/avatar.type';
+import { CreateEquosSessionRequestData, CreateEquosSessionResponseData } from '../types/session.type';
+import { HttpUtils } from '../utils/http.utils';
+export declare class EquosSession {
+    private readonly http;
+    constructor(http: HttpUtils);
+    get(id: string): Promise<EquosAvatarData>;
+    create(data: CreateEquosSessionRequestData): Promise<CreateEquosSessionResponseData>;
+    list(skip?: number, take?: number): Promise<ListEquosAvatarsData>;
+    stop(id: string): Promise<EquosAvatarData>;
+}

package/dist/apis/session.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EquosSession = void 0;
+class EquosSession {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    get(id) {
+        return this.http.get(`/sessions/${id}`);
+    }
+    create(data) {
+        return this.http.post('/sessions', data);
+    }
+    list(skip = 0, take = 10) {
+        return this.http.get(`/sessions?skip=${skip}&take=${take}`);
+    }
+    stop(id) {
+        return this.http.patch(`/sessions/${id}/stop`, {});
+    }
+}
+exports.EquosSession = EquosSession;

package/dist/equos.d.ts

@@ -0,0 +1,13 @@
+import { EquosAvatar } from './apis/avatar';
+import { EquosSession } from './apis/session';
+export declare class Equos {
+    private readonly apiKey;
+    private readonly version;
+    private readonly http;
+    private avatarApi;
+    private sessionApi;
+    private constructor();
+    static client(apiKey: string): Equos;
+    get avatars(): EquosAvatar;
+    get sessions(): EquosSession;
+}

package/dist/equos.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Equos = void 0;
+const avatar_1 = require("./apis/avatar");
+const session_1 = require("./apis/session");
+const constants_utils_1 = require("./utils/constants.utils");
+const http_utils_1 = require("./utils/http.utils");
+class Equos {
+    apiKey;
+    version;
+    http;
+    avatarApi;
+    sessionApi;
+    constructor(apiKey, version = 'v1') {
+        this.apiKey = apiKey;
+        this.version = version;
+        this.http = new http_utils_1.HttpUtils(constants_utils_1.ConstantsUtils.API_BASE_URL, this.version, this.apiKey);
+        this.avatarApi = new avatar_1.EquosAvatar(this.http);
+        this.sessionApi = new session_1.EquosSession(this.http);
+    }
+    static client(apiKey) {
+        return new Equos(apiKey);
+    }
+    get avatars() {
+        return this.avatarApi;
+    }
+    get sessions() {
+        return this.sessionApi;
+    }
+}
+exports.Equos = Equos;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './equos';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./equos"), exports);

package/dist/types/avatar.type.d.ts

@@ -0,0 +1,19 @@
+export interface CreateEquosAvatarData {
+    name: string;
+    refImage: string;
+}
+export interface EquosAvatarData {
+    id: string;
+    name: string;
+    thumbnailUrl: string;
+    apiKeyId: string;
+    organizationId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface ListEquosAvatarsData {
+    skip: number;
+    take: number;
+    total: number;
+    avatars: EquosAvatarData[];
+}

package/dist/types/avatar.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/session.type.d.ts

@@ -0,0 +1,60 @@
+export interface EquosSessionData {
+    id: string;
+    name: string;
+    provider: string;
+    client?: string;
+    host: {
+        serverUrl: string;
+    };
+    avatar: {
+        id: string;
+        identity?: string;
+        name?: string;
+        thumbnailUrl?: string;
+        createdAt: Date;
+        updatedAt: Date;
+    };
+    agent?: {
+        instructions: string;
+    };
+    startedAt: Date;
+    endedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface CreateEquosSessionRequestData {
+    name: string;
+    client?: string;
+    host?: {
+        serverUrl: string;
+        accessToken: string;
+    };
+    agent?: {
+        instructions: string;
+    };
+    avatar: {
+        id?: string;
+        identity?: string;
+        name?: string;
+        refImage?: string;
+    };
+    remoteAgentConnectingIdentity?: {
+        identity: string;
+        name: string;
+    };
+    consumerIdentity?: {
+        identity: string;
+        name: string;
+    };
+}
+export interface CreateEquosSessionResponseData {
+    session: EquosSessionData;
+    consumerAccessToken?: string;
+    remoteAgentAccessToken?: string;
+}
+export interface ListEquosSessionsData {
+    skip: number;
+    take: number;
+    total: number;
+    sessions: EquosSessionData[];
+}

package/dist/types/session.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/constants.utils.d.ts

@@ -0,0 +1,3 @@
+export declare class ConstantsUtils {
+    static readonly API_BASE_URL = "https://api.equos.io/v1";
+}

package/dist/utils/constants.utils.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConstantsUtils = void 0;
+class ConstantsUtils {
+    static API_BASE_URL = 'https://api.equos.io/v1';
+}
+exports.ConstantsUtils = ConstantsUtils;

package/dist/utils/http.utils.d.ts

@@ -0,0 +1,10 @@
+export declare class HttpUtils {
+    private readonly baseUrl;
+    private readonly version;
+    private readonly apiKey;
+    constructor(baseUrl: string, version: string, apiKey: string);
+    private getPath;
+    get<T>(path: string): Promise<T>;
+    post<T, U>(path: string, data: T): Promise<U>;
+    patch<T, U>(path: string, data: T): Promise<U>;
+}

package/dist/utils/http.utils.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpUtils = void 0;
+const axios_1 = __importDefault(require("axios"));
+class HttpUtils {
+    baseUrl;
+    version;
+    apiKey;
+    constructor(baseUrl, version, apiKey) {
+        this.baseUrl = baseUrl;
+        this.version = version;
+        this.apiKey = apiKey;
+    }
+    getPath(path) {
+        return `${this.baseUrl}/${this.version}${path}`;
+    }
+    async get(path) {
+        return axios_1.default
+            .get(this.getPath(path), {
+            headers: {
+                'x-api-key': this.apiKey,
+            },
+        })
+            .then((response) => response.data);
+    }
+    async post(path, data) {
+        return axios_1.default
+            .post(this.getPath(path), data, {
+            headers: {
+                'x-api-key': this.apiKey,
+            },
+        })
+            .then((response) => response.data);
+    }
+    async patch(path, data) {
+        return axios_1.default
+            .patch(this.getPath(path), data, {
+            headers: {
+                'x-api-key': this.apiKey,
+            },
+        })
+            .then((response) => response.data);
+    }
+}
+exports.HttpUtils = HttpUtils;

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@equos/node-sdk",
+  "version": "0.0.3",
+  "description": "Equos.ai node.js official SDK.",
+  "keywords": [
+    "ai",
+    "avatar",
+    "livekit",
+    "pipecat",
+    "sdk",
+    "equos.ai",
+    "equos"
+  ],
+  "homepage": "https://github.com/LipittSAS/equos-node#readme",
+  "bugs": {
+    "url": "https://github.com/LipittSAS/equos-node/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LipittSAS/equos-node.git"
+  },
+  "license": "ISC",
+  "author": "combis.loic@gmail.com",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "dev": "ts-node src/index.ts",
+    "test": "jest",
+    "lint": "eslint . --ext .ts",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "axios": "^1.11.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.3.0",
+    "eslint": "^9.33.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.4.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.2"
+  }
+}