@hautechai/sdk 0.1.4 → 0.1.5

package/.github/workflows/main.yml

@@ -1,40 +1,40 @@
 name: Publish Package to npmjs
 on:
-  release:
-    types: [published]
+    release:
+        types: [published]
 jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    environment: main
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+    build-and-publish:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            id-token: write
+        environment: main
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
 
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9
+            - name: Install pnpm
+              uses: pnpm/action-setup@v4
+              with:
+                  version: 9
 
-      - name: Use Node LTS
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-          cache: pnpm
+            - name: Use Node LTS
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20.x'
+                  registry-url: 'https://registry.npmjs.org'
+                  cache: pnpm
 
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
 
-      - name: Bump version
-        run: pnpm version from-git --no-commit-hooks --no-git-tag-version --allow-same-version
+            - name: Bump version
+              run: pnpm version from-git --no-commit-hooks --no-git-tag-version --allow-same-version
 
-      - name: Build the package
-        run: pnpm build
+            - name: Build the package
+              run: pnpm build
 
-      - name: Publish the package
-        run: pnpm publish --no-git-checks --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+            - name: Publish the package
+              run: pnpm publish --no-git-checks --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -2,38 +2,38 @@ name: Test
 on:
     push:
         branches:
-        - 'main'
+            - 'main'
 jobs:
-  test:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    environment: main
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+    test:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            id-token: write
+        environment: main
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
 
-      - name: Install pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9
+            - name: Install pnpm
+              uses: pnpm/action-setup@v4
+              with:
+                  version: 9
 
-      - name: Use Node LTS
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-          cache: pnpm
+            - name: Use Node LTS
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20.x'
+                  registry-url: 'https://registry.npmjs.org'
+                  cache: pnpm
 
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
 
-      - name: Test
-        run: pnpm test
-        env:
-          API_CORE_URL: https://api.dev.hautech.ai
-          APP_ID: ${{ secrets.APP_ID }}
-          APP_KEY_ID: ${{ secrets.APP_KEY_ID }}
-          APP_KEY_SECRET: ${{ secrets.APP_KEY_SECRET }}
-          SDK_TOKEN: ${{ secrets.SDK_TOKEN }}
+            - name: Test
+              run: pnpm test
+              env:
+                  API_CORE_URL: https://api.dev.hautech.ai
+                  APP_ID: ${{ secrets.APP_ID }}
+                  APP_KEY_ID: ${{ secrets.APP_KEY_ID }}
+                  APP_KEY_SECRET: ${{ secrets.APP_KEY_SECRET }}
+                  SDK_TOKEN: ${{ secrets.SDK_TOKEN }}

package/.prettierignore

@@ -0,0 +1 @@
+src/autogenerated/**

package/dist/sdk/api.d.ts

@@ -2,6 +2,8 @@ import { AxiosPromise } from 'axios';
 import { BaseAPI } from '../autogenerated/base';
 import { SDKOptions } from '../types';
 import { Configuration } from '../autogenerated';
+export declare const getBaseUrl: (options: SDKOptions) => string;
+export declare const getAPI: <T>(API: new (configuration?: Configuration, basePath?: string, axios?: any) => T, options: SDKOptions) => Promise<T>;
 export declare const useAutogeneratedAPI: <T extends BaseAPI>(baseProps: {
     API: new (configuration?: Configuration, basePath?: string, axios?: any) => T;
     options: SDKOptions;

package/dist/sdk/api.js

@@ -1,15 +1,15 @@
-const getBaseUrl = (options) => options.endpoint ?? 'https://api.hautech.ai';
-export const useAutogeneratedAPI = (baseProps) => {
-    const getAPI = async () => {
-        const config = {
-            accessToken: await baseProps.options.authToken(),
-            basePath: getBaseUrl(baseProps.options),
-            isJsonMime: (mime) => true,
-        };
-        return new baseProps.API(config);
+export const getBaseUrl = (options) => options.endpoint ?? 'https://api.hautech.ai';
+export const getAPI = async (API, options) => {
+    const config = {
+        accessToken: await options.authToken(),
+        basePath: getBaseUrl(options),
+        isJsonMime: (mime) => true,
     };
+    return new API(config);
+};
+export const useAutogeneratedAPI = (baseProps) => {
     const call = async (props) => {
-        const api = await getAPI();
+        const api = await getAPI(baseProps.API, baseProps.options);
         try {
             const response = await props.run(api);
             if (props.returnUndefinedOn404 && response.status === 404)

package/dist/sdk/exceptions/index.d.ts

@@ -0,0 +1,3 @@
+export declare class HautechException extends Error {
+    constructor(message: string);
+}

package/dist/sdk/exceptions/index.js

@@ -0,0 +1,6 @@
+export class HautechException extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'HautechException';
+    }
+}

package/dist/sdk/index.d.ts

@@ -202,7 +202,7 @@ export declare const createSDK: (options: SDKOptions) => {
         }) => Promise<void>;
         wait: <T extends import("../types").OperationEntity | {
             id: string;
-        }>(props: T) => Promise<(T extends import("../types").OperationEntity ? T : import("../types").OperationEntity) & ({
+        }>(props: T, timeoutMs?: number) => Promise<((T extends import("../types").OperationEntity ? T : import("../types").OperationEntity) & ({
             status: "failed";
             output: null;
         } | {
@@ -211,7 +211,7 @@ export declare const createSDK: (options: SDKOptions) => {
         } | {
             status: "finished";
             output: NonNullable<(T extends import("../types").OperationEntity ? T : import("../types").OperationEntity)["output"]>;
-        })>;
+        })) | null>;
     };
     pipelines: {
         constructTemplate: (consructPipeline: (pipeline: import("@hautechai/pipelines").Pipeline<{
@@ -509,5 +509,6 @@ export declare const createSDK: (options: SDKOptions) => {
     utils: {
         seed: () => number;
     };
+    close: () => void;
 };
 export type SDK = ReturnType<typeof createSDK>;

package/dist/sdk/index.js

@@ -10,6 +10,9 @@ import pipelines from './pipelines';
 import stacks from './stacks';
 import storage from './storage';
 import utils from './utils';
+import { OperationsListener } from './listeners';
+import { getAPI, getBaseUrl } from './api';
+import { OperationsApi } from '../autogenerated';
 export const createSDK = (options) => {
     let token = undefined;
     const authToken = async () => {
@@ -23,6 +26,17 @@ export const createSDK = (options) => {
         return token;
     };
     const optionsWithTokenRefresher = { ...options, authToken };
+    const operationsListener = new OperationsListener({
+        ws: options.useWebsocket
+            ? {
+                endpoint: getBaseUrl(options),
+                token: authToken,
+            }
+            : null,
+        // TODO: Refactor the API initialization
+        operations: () => getAPI(OperationsApi, optionsWithTokenRefresher),
+    });
+    operationsListener.subscribe();
     return {
         access: access(optionsWithTokenRefresher),
         accounts: accounts(optionsWithTokenRefresher),
@@ -30,10 +44,13 @@ export const createSDK = (options) => {
         collections: collections(optionsWithTokenRefresher),
         groups: groups(optionsWithTokenRefresher),
         images: images(optionsWithTokenRefresher),
-        operations: operations(optionsWithTokenRefresher),
+        operations: operations(optionsWithTokenRefresher, operationsListener),
         pipelines: pipelines(optionsWithTokenRefresher),
         stacks: stacks(optionsWithTokenRefresher),
         storage: storage(optionsWithTokenRefresher),
         utils: utils(optionsWithTokenRefresher),
+        close: () => {
+            operationsListener.close();
+        },
     };
 };

package/dist/sdk/listeners/index.d.ts

@@ -0,0 +1,25 @@
+import { OperationEntity, OperationsApi } from '../../autogenerated';
+import { WebSocket } from 'ws';
+export declare class OperationsListener {
+    useWebsocket: {
+        endpoint: string;
+        token: () => string | Promise<string>;
+    } | null;
+    ws: WebSocket | null;
+    operations: () => Promise<OperationsApi>;
+    constructor({ ws, operations, }: {
+        ws: {
+            endpoint: string;
+            token: () => string | Promise<string>;
+        } | null;
+        operations: () => Promise<OperationsApi>;
+    });
+    operationsStore: Record<string, OperationEntity>;
+    getOperation(id: string): Promise<OperationEntity | null>;
+    private updateOperation;
+    subscribe(): Promise<void>;
+    onOpen(): void;
+    onMessage(msg: string): void;
+    onClose(number: number, reason: Buffer): void;
+    close(): void;
+}

package/dist/sdk/listeners/index.js

@@ -0,0 +1,81 @@
+import { WebSocket } from 'ws';
+import { HautechException } from '../exceptions';
+// This is pretty much a dirty solution until we need to rework this part.
+export class OperationsListener {
+    constructor({ ws, operations, }) {
+        this.useWebsocket = null;
+        this.ws = null;
+        this.operationsStore = {};
+        if (ws) {
+            this.useWebsocket = {
+                endpoint: ws?.endpoint,
+                token: ws?.token,
+            };
+        }
+        this.operations = operations;
+    }
+    async getOperation(id) {
+        const isWsReady = this.ws?.readyState == WebSocket.OPEN;
+        if (!this.operationsStore[id] || !isWsReady) {
+            const api = await this.operations();
+            const operation = await api.operationsControllerGetOperationV1(id);
+            if (operation.status == 200)
+                this.updateOperation(id, operation.data);
+        }
+        return this.operationsStore[id] || null;
+    }
+    updateOperation(id, operation) {
+        const stored = this.operationsStore[id];
+        if (!stored || stored.updatedAt < operation.updatedAt) {
+            this.operationsStore[id] = operation;
+        }
+    }
+    async subscribe() {
+        if (!this.useWebsocket)
+            return;
+        try {
+            this.ws = new WebSocket(this.useWebsocket.endpoint, ['1', await this.useWebsocket.token()]);
+            this.ws.on('open', () => this.onOpen());
+            this.ws.on('message', (msg) => this.onMessage(msg));
+            this.ws.on('close', (number, reason) => this.onClose(number, reason));
+        }
+        catch (err) {
+            throw new HautechException(`SDK failed to open websocket: ${err}`);
+        }
+    }
+    onOpen() {
+        if (!this.ws)
+            throw new HautechException('Semantics error: this is a bug.');
+        this.ws.send(JSON.stringify({
+            event: 'subscribe',
+            data: {
+                channel: 'own_resources',
+            },
+        }));
+    }
+    onMessage(msg) {
+        if (!this.ws)
+            throw new HautechException('Semantics error: this is a bug.');
+        const { event, data } = JSON.parse(msg);
+        switch (event) {
+            case 'subscription:created':
+                break;
+            case 'operation:created':
+            case 'operation:updated':
+                this.updateOperation(data.id, data);
+                break;
+        }
+    }
+    onClose(number, reason) {
+        if (!this.ws)
+            throw new HautechException('Semantics error: this is a bug.');
+        // Reset dirty state.
+        this.operationsStore = {};
+        this.ws = null;
+    }
+    close() {
+        if (!this.ws)
+            return;
+        this.ws.close();
+    }
+}

package/dist/sdk/operations/index.d.ts

@@ -1,5 +1,6 @@
 import { CompositeV1Input, CompositeV1Response, CutV1Input, CutV1Response, GiseleVtonV1Input, GPTV1Input, GptV1Response, HauteLindaV1Response, HauteNaomiV1Response, ImagineKateV1Response, KateImagineV1Input, KateInpaintV1Input, LindaHauteV1Input, NaomiHauteV1Input, NegateImageV1Input, NegateImageV1Response, ObjectDetectionV1Input, ObjectDetectionV1Response, OperationEntity, OperationEntityStatusEnum, PoseEstimationV1Input, PoseEstimationV1Response, SegmentAnythingEmbeddingsV1Input, SegmentAnythingEmbeddingsV1Response, SegmentAnythingMaskV1Input, SegmentAnythingMaskV1Response, UpscaleV1Input, UpscaleV1Response, VtonGiseleV1Response } from '../../autogenerated';
 import { ListProps, ListResponse, SDKOptions } from '../../types';
+import { OperationsListener } from '../listeners';
 type Waited<T extends OperationEntity> = T & ({
     status: typeof OperationEntityStatusEnum.Failed;
     output: null;
@@ -10,7 +11,7 @@ type Waited<T extends OperationEntity> = T & ({
     status: typeof OperationEntityStatusEnum.Finished;
     output: NonNullable<T['output']>;
 });
-declare const operations: (options: SDKOptions) => {
+declare const operations: (options: SDKOptions, relevantOperations: OperationsListener) => {
     run: {
         haute: {
             linda: {
@@ -120,6 +121,6 @@ declare const operations: (options: SDKOptions) => {
     }) => Promise<void>;
     wait: <T extends OperationEntity | {
         id: string;
-    }>(props: T) => Promise<Waited<T extends OperationEntity ? T : OperationEntity>>;
+    }>(props: T, timeoutMs?: number) => Promise<Waited<T extends OperationEntity ? T : OperationEntity> | null>;
 };
 export default operations;

package/dist/sdk/operations/index.js

@@ -1,7 +1,8 @@
 import { OperationsApi, } from '../../autogenerated';
 import { useAutogeneratedAPI } from '../api';
 import { transformToListResponse } from '../transformers';
-const operations = (options) => {
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const operations = (options, relevantOperations) => {
     const api = useAutogeneratedAPI({ API: OperationsApi, options });
     const createOperation = (callMethod) => (props) => api.call({ run: (methods) => callMethod(methods, props) });
     return {
@@ -72,20 +73,23 @@ const operations = (options) => {
         updateMetadata: async (props) => api.call({
             run: (methods) => methods.operationsControllerUpdateMetadataV1(props.id, { overwrite: props.metadata }),
         }),
-        wait: async (props) => new Promise((resolve, reject) => {
-            const initialDelay = 5000;
-            const delay = 2000;
-            let timeoutId;
-            const poll = async () => {
-                const operation = await api.call({
-                    run: (methods) => methods.operationsControllerGetOperationV1(props.id),
-                });
-                if (operation.status !== 'pending')
-                    return resolve(operation);
-                timeoutId = setTimeout(poll, delay);
+        wait: async (props, timeoutMs) => {
+            const deadline = timeoutMs ? Date.now() + timeoutMs : undefined;
+            const delay = 1000;
+            const poll = async (id) => {
+                const operation = await relevantOperations.getOperation(id);
+                if (operation?.status !== 'pending')
+                    return operation;
+                return null;
             };
-            timeoutId = setTimeout(poll, initialDelay);
-        }),
+            while (!deadline || Date.now() < deadline) {
+                const polled = await poll(props.id);
+                if (polled)
+                    return polled;
+                await sleep(delay);
+            }
+            return null;
+        },
     };
 };
 export default operations;

package/dist/token/index.js

@@ -31,24 +31,35 @@ const serializePermissions = (permissions) => {
     traverse(permissions);
     return result;
 };
-export const createTokenSigner = (options) => ({
-    createAccountToken: async (props) => createToken({
-        appKeyId: options.appKeyId,
-        appKeySecret: options.appKeySecret,
-        expiresInSeconds: props.expiresInSeconds,
-        payload: {
-            iss: options.appId,
-            permissions: serializePermissions(props.permissions ?? {}),
-            sub: props.accountId,
-        },
-    }),
-    createRootToken: async (props) => createToken({
-        appKeyId: options.appKeyId,
-        appKeySecret: options.appKeySecret,
-        expiresInSeconds: props.expiresInSeconds ?? 3600,
-        payload: {
-            iss: options.appId,
-            permissions: ['*'],
-        },
-    }),
-});
+export const createTokenSigner = (options) => {
+    if (!options.appId || options.appId.length === 0) {
+        throw new Error('appId is required');
+    }
+    if (!options.appKeyId || options.appKeyId.length === 0) {
+        throw new Error('appKeyId is required');
+    }
+    if (!options.appKeySecret || options.appKeySecret.length === 0) {
+        throw new Error('appKeySecret is required');
+    }
+    return {
+        createAccountToken: async (props) => createToken({
+            appKeyId: options.appKeyId,
+            appKeySecret: options.appKeySecret,
+            expiresInSeconds: props.expiresInSeconds,
+            payload: {
+                iss: options.appId,
+                permissions: serializePermissions(props.permissions ?? {}),
+                sub: props.accountId,
+            },
+        }),
+        createRootToken: async (props) => createToken({
+            appKeyId: options.appKeyId,
+            appKeySecret: options.appKeySecret,
+            expiresInSeconds: props.expiresInSeconds ?? 3600,
+            payload: {
+                iss: options.appId,
+                permissions: ['*'],
+            },
+        }),
+    };
+};

package/dist/types.d.ts

@@ -1,6 +1,7 @@
 export interface SDKOptions {
     authToken: () => string | Promise<string>;
     endpoint?: string;
+    useWebsocket?: boolean;
 }
 export type ListProps = {
     cursor?: string;

package/openapitools.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
-  "spaces": 2,
-  "generator-cli": {
-    "version": "7.10.0"
-  }
+    "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+    "spaces": 2,
+    "generator-cli": {
+        "version": "7.10.0"
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hautechai/sdk",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "license": "MIT",
   "keywords": [],
   "repository": {
@@ -12,7 +12,8 @@
   "dependencies": {
     "@hautechai/pipelines": "0.1.0",
     "axios": "1.6.1",
-    "jose": "5.9.6"
+    "jose": "5.9.6",
+    "ws": "^8.18.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
@@ -20,6 +21,7 @@
     "@types/jest": "29.5.12",
     "@types/jsonwebtoken": "9.0.7",
     "@types/node": "22.5.2",
+    "@types/ws": "^8.5.14",
     "dotenv": "16.4.7",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",