@owox/api-client 0.26.0

package/dist/auth.d.ts

@@ -0,0 +1,11 @@
+export declare const API_KEY_EXCHANGE_PATH = "/api/auth/api-keys/exchange";
+export type AuthConfig = {
+    apiOrigin: string;
+    apiKeyId: string;
+    apiKeySecret: string;
+    fetchImpl: typeof fetch;
+};
+export declare function normalizeApiOrigin(apiOrigin: string): string;
+export declare function readResponseBody(response: Response): Promise<unknown>;
+export declare function exchangeAccessToken(config: AuthConfig): Promise<string>;
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,qBAAqB,gCAAgC,CAAC;AAEnE,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,KAAK,CAAC;CACzB,CAAC;AAMF,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAuB5D;AAED,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAgB3E;AAED,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CA6B7E"}

package/dist/auth.js

@@ -0,0 +1,64 @@
+import { createHttpError, OWOXAuthError, OWOXConfigError } from './errors.js';
+export const API_KEY_EXCHANGE_PATH = '/api/auth/api-keys/exchange';
+export function normalizeApiOrigin(apiOrigin) {
+    if (!apiOrigin.trim()) {
+        throw new OWOXConfigError('OWOX API origin is required');
+    }
+    let url;
+    try {
+        url = new URL(apiOrigin);
+    }
+    catch (error) {
+        throw new OWOXConfigError('OWOX API origin must be a valid http or https URL', {
+            cause: error,
+        });
+    }
+    if (url.protocol !== 'https:' && url.protocol !== 'http:') {
+        throw new OWOXConfigError('OWOX API origin must use http or https');
+    }
+    if (url.username || url.password || url.search || url.hash || url.pathname !== '/') {
+        throw new OWOXConfigError('OWOX API origin must include only scheme, host, and optional port');
+    }
+    return url.origin;
+}
+export async function readResponseBody(response) {
+    const text = await response.text();
+    if (!text) {
+        return undefined;
+    }
+    const contentType = response.headers.get('content-type') ?? '';
+    if (contentType.includes('application/json')) {
+        try {
+            return JSON.parse(text);
+        }
+        catch {
+            return text;
+        }
+    }
+    return text;
+}
+export async function exchangeAccessToken(config) {
+    const response = await config.fetchImpl(new URL(API_KEY_EXCHANGE_PATH, config.apiOrigin), {
+        method: 'POST',
+        headers: {
+            accept: 'application/json',
+            'content-type': 'application/json',
+            'x-owox-api-key-id': config.apiKeyId,
+        },
+        body: JSON.stringify({ apiKeySecret: config.apiKeySecret }),
+    });
+    const body = await readResponseBody(response);
+    if (!response.ok) {
+        throw createHttpError(response, body, { auth: true });
+    }
+    const tokenResponse = body;
+    if (!tokenResponse ||
+        typeof tokenResponse.accessToken !== 'string' ||
+        !tokenResponse.accessToken) {
+        throw new OWOXAuthError('OWOX authentication response did not include an access token', {
+            status: response.status,
+            details: body,
+        });
+    }
+    return tokenResponse.accessToken;
+}

package/dist/client.d.ts

@@ -0,0 +1,26 @@
+import { DataMartsApi } from './data-marts.js';
+import { DestinationsApi } from './destinations.js';
+import { StoragesApi } from './storages.js';
+export type OWOXApiClientOptions = {
+    apiOrigin: string;
+    apiKeyId: string;
+    apiKeySecret: string;
+    fetchImpl?: typeof fetch;
+};
+export declare class OWOXApiClient {
+    readonly dataMarts: DataMartsApi;
+    readonly storages: StoragesApi;
+    readonly destinations: DestinationsApi;
+    private readonly apiOrigin;
+    private readonly apiKeyId;
+    private readonly apiKeySecret;
+    private readonly fetchImpl;
+    private accessToken;
+    constructor(options: OWOXApiClientOptions);
+    authenticate(): Promise<void>;
+    getJson<T>(path: string, query?: Record<string, string>): Promise<T>;
+    private getJsonWithAuth;
+    private getAccessToken;
+    private buildUrl;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;CAC1B,CAAC;AAEF,qBAAa,aAAa;IACxB,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC;IAEvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,WAAW,CAAqB;gBAE5B,OAAO,EAAE,oBAAoB;IAWnC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YAI5D,eAAe;YA4Bf,cAAc;IAa5B,OAAO,CAAC,QAAQ;CASjB"}

package/dist/client.js

@@ -0,0 +1,67 @@
+import { exchangeAccessToken, normalizeApiOrigin, readResponseBody } from './auth.js';
+import { DataMartsApi } from './data-marts.js';
+import { DestinationsApi } from './destinations.js';
+import { createHttpError } from './errors.js';
+import { StoragesApi } from './storages.js';
+export class OWOXApiClient {
+    dataMarts;
+    storages;
+    destinations;
+    apiOrigin;
+    apiKeyId;
+    apiKeySecret;
+    fetchImpl;
+    accessToken;
+    constructor(options) {
+        this.apiOrigin = normalizeApiOrigin(options.apiOrigin);
+        this.apiKeyId = options.apiKeyId;
+        this.apiKeySecret = options.apiKeySecret;
+        this.fetchImpl = options.fetchImpl ?? fetch;
+        this.dataMarts = new DataMartsApi(this);
+        this.storages = new StoragesApi(this);
+        this.destinations = new DestinationsApi(this);
+    }
+    async authenticate() {
+        await this.getAccessToken();
+    }
+    async getJson(path, query) {
+        return this.getJsonWithAuth(path, query, true);
+    }
+    async getJsonWithAuth(path, query, retryOnUnauthorized) {
+        const response = await this.fetchImpl(this.buildUrl(path, query), {
+            method: 'GET',
+            headers: {
+                accept: 'application/json',
+                'x-owox-authorization': `Bearer ${await this.getAccessToken()}`,
+                'x-owox-api-key-id': this.apiKeyId,
+            },
+        });
+        if (response.status === 401 && retryOnUnauthorized) {
+            this.accessToken = undefined;
+            return this.getJsonWithAuth(path, query, false);
+        }
+        const body = await readResponseBody(response);
+        if (!response.ok) {
+            throw createHttpError(response, body);
+        }
+        return body;
+    }
+    async getAccessToken() {
+        if (!this.accessToken) {
+            this.accessToken = await exchangeAccessToken({
+                apiOrigin: this.apiOrigin,
+                apiKeyId: this.apiKeyId,
+                apiKeySecret: this.apiKeySecret,
+                fetchImpl: this.fetchImpl,
+            });
+        }
+        return this.accessToken;
+    }
+    buildUrl(path, query) {
+        const url = new URL(path, this.apiOrigin);
+        for (const [key, value] of Object.entries(query ?? {})) {
+            url.searchParams.set(key, value);
+        }
+        return url;
+    }
+}

package/dist/data-marts.d.ts

@@ -0,0 +1,13 @@
+export type OWOXDataMart = Record<string, unknown> & {
+    id: string;
+    title: string;
+};
+export type JsonRequester = {
+    getJson<T>(path: string, query?: Record<string, string>): Promise<T>;
+};
+export declare class DataMartsApi {
+    private readonly requester;
+    constructor(requester: JsonRequester);
+    list(): Promise<OWOXDataMart[]>;
+}
+//# sourceMappingURL=data-marts.d.ts.map

package/dist/data-marts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-marts.d.ts","sourceRoot":"","sources":["../src/data-marts.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAQF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAqBF,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAE/C,IAAI,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;CA8BtC"}

package/dist/data-marts.js

@@ -0,0 +1,41 @@
+import { OWOXApiError } from './errors.js';
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function parsePage(response) {
+    if (!isRecord(response) ||
+        !Array.isArray(response.items) ||
+        typeof response.total !== 'number' ||
+        (typeof response.nextOffset !== 'number' && response.nextOffset !== null)) {
+        throw new OWOXApiError('OWOX Data Marts API returned an unexpected response shape', {
+            details: response,
+        });
+    }
+    return response;
+}
+export class DataMartsApi {
+    requester;
+    constructor(requester) {
+        this.requester = requester;
+    }
+    async list() {
+        const dataMarts = [];
+        const requestedOffsets = new Set();
+        let offset;
+        while (true) {
+            const offsetKey = String(offset ?? 0);
+            if (requestedOffsets.has(offsetKey)) {
+                throw new OWOXApiError(`OWOX Data Marts API returned repeated nextOffset ${offsetKey}`, {
+                    details: { offset },
+                });
+            }
+            requestedOffsets.add(offsetKey);
+            const page = parsePage(await this.requester.getJson('/api/data-marts', offset === undefined ? undefined : { offset: String(offset) }));
+            dataMarts.push(...page.items);
+            if (page.nextOffset === null) {
+                return dataMarts;
+            }
+            offset = page.nextOffset;
+        }
+    }
+}

package/dist/destinations.d.ts

@@ -0,0 +1,12 @@
+import type { JsonRequester } from './data-marts.js';
+export type OWOXDestination = Record<string, unknown> & {
+    id: string;
+    title: string;
+    type: string;
+};
+export declare class DestinationsApi {
+    private readonly requester;
+    constructor(requester: JsonRequester);
+    list(): Promise<OWOXDestination[]>;
+}
+//# sourceMappingURL=destinations.d.ts.map

package/dist/destinations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"destinations.d.ts","sourceRoot":"","sources":["../src/destinations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGrD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAE/C,IAAI,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;CAWzC"}

package/dist/destinations.js

@@ -0,0 +1,16 @@
+import { OWOXApiError } from './errors.js';
+export class DestinationsApi {
+    requester;
+    constructor(requester) {
+        this.requester = requester;
+    }
+    async list() {
+        const response = await this.requester.getJson('/api/data-destinations');
+        if (!Array.isArray(response)) {
+            throw new OWOXApiError('OWOX Data Destinations API returned an unexpected response shape', {
+                details: response,
+            });
+        }
+        return response;
+    }
+}

package/dist/errors.d.ts

@@ -0,0 +1,23 @@
+export type OWOXApiErrorOptions = {
+    status?: number;
+    code?: string;
+    details?: unknown;
+    cause?: unknown;
+};
+export declare class OWOXApiError extends Error {
+    status?: number;
+    code?: string;
+    details?: unknown;
+    constructor(message: string, options?: OWOXApiErrorOptions);
+}
+export declare class OWOXAuthError extends OWOXApiError {
+}
+export declare class OWOXConfigError extends Error {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+export declare function createHttpError(response: Response, body: unknown, options?: {
+    auth?: boolean;
+}): OWOXApiError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,qBAAa,YAAa,SAAQ,KAAK;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEN,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CAO/D;AAED,qBAAa,aAAc,SAAQ,YAAY;CAAG;AAElD,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO;CAI/D;AAgDD,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GAC/B,YAAY,CAcd"}

package/dist/errors.js

@@ -0,0 +1,64 @@
+export class OWOXApiError extends Error {
+    status;
+    code;
+    details;
+    constructor(message, options = {}) {
+        super(message, options.cause === undefined ? undefined : { cause: options.cause });
+        this.name = new.target.name;
+        this.status = options.status;
+        this.code = options.code;
+        this.details = options.details;
+    }
+}
+export class OWOXAuthError extends OWOXApiError {
+}
+export class OWOXConfigError extends Error {
+    constructor(message, options = {}) {
+        super(message, options.cause === undefined ? undefined : { cause: options.cause });
+        this.name = 'OWOXConfigError';
+    }
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function readErrorCode(body) {
+    if (!isRecord(body)) {
+        return undefined;
+    }
+    const { code, error } = body;
+    if (typeof code === 'string' && code) {
+        return code;
+    }
+    if (typeof error === 'string' && error) {
+        return error;
+    }
+    return undefined;
+}
+function readErrorMessage(body) {
+    if (!isRecord(body)) {
+        return undefined;
+    }
+    const { message } = body;
+    return typeof message === 'string' && message ? message : undefined;
+}
+function readErrorDetails(body) {
+    if (!isRecord(body)) {
+        return body;
+    }
+    const { details } = body;
+    return details === undefined ? body : details;
+}
+export function createHttpError(response, body, options = {}) {
+    const code = readErrorCode(body);
+    const responseMessage = readErrorMessage(body);
+    const statusText = response.statusText || 'HTTP error';
+    const message = responseMessage
+        ? `OWOX API request failed with ${response.status} ${statusText}: ${responseMessage}`
+        : `OWOX API request failed with ${response.status} ${statusText}`;
+    const ErrorClass = options.auth || response.status === 401 ? OWOXAuthError : OWOXApiError;
+    return new ErrorClass(message, {
+        status: response.status,
+        code,
+        details: readErrorDetails(body),
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { OWOXApiClient, type OWOXApiClientOptions } from './client.js';
+export { OWOXApiError, OWOXAuthError, OWOXConfigError } from './errors.js';
+export { type OWOXDataMart } from './data-marts.js';
+export { type OWOXStorage } from './storages.js';
+export { type OWOXDestination } from './destinations.js';
+//# 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,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { OWOXApiClient } from './client.js';
+export { OWOXApiError, OWOXAuthError, OWOXConfigError } from './errors.js';

package/dist/storages.d.ts

@@ -0,0 +1,12 @@
+import type { JsonRequester } from './data-marts.js';
+export type OWOXStorage = Record<string, unknown> & {
+    id: string;
+    title: string;
+    type: string;
+};
+export declare class StoragesApi {
+    private readonly requester;
+    constructor(requester: JsonRequester);
+    list(): Promise<OWOXStorage[]>;
+}
+//# sourceMappingURL=storages.d.ts.map

package/dist/storages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storages.d.ts","sourceRoot":"","sources":["../src/storages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGrD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,aAAa;IAE/C,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;CAWrC"}

package/dist/storages.js

@@ -0,0 +1,16 @@
+import { OWOXApiError } from './errors.js';
+export class StoragesApi {
+    requester;
+    constructor(requester) {
+        this.requester = requester;
+    }
+    async list() {
+        const response = await this.requester.getJson('/api/data-storages');
+        if (!Array.isArray(response)) {
+            throw new OWOXApiError('OWOX Data Storages API returned an unexpected response shape', {
+                details: response,
+            });
+        }
+        return response;
+    }
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@owox/api-client",
+  "version": "0.26.0",
+  "description": "HTTP API client for OWOX Data Marts",
+  "type": "module",
+  "author": "OWOX",
+  "license": "ELv2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22.16.0"
+  },
+  "homepage": "https://github.com/OWOX/owox-data-marts",
+  "bugs": "https://github.com/OWOX/owox-data-marts/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OWOX/owox-data-marts.git",
+    "directory": "packages/api-client"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "shx rm -rf dist",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",
+    "lint": "eslint . --config ./eslint.config.js",
+    "lint:fix": "eslint . --fix --config ./eslint.config.js",
+    "format": "prettier --write \"**/*.{ts,js,json,md}\" --ignore-path ../../.prettierignore",
+    "format:check": "prettier --check \"**/*.{ts,js,json,md}\" --ignore-path ../../.prettierignore",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run lint && npm run typecheck"
+  },
+  "keywords": [
+    "owox",
+    "data-marts",
+    "api-client",
+    "http"
+  ],
+  "devDependencies": {
+    "@owox/eslint-config": "*",
+    "@owox/prettier-config": "*",
+    "@types/jest": "29.5.14",
+    "@types/node": "^22.10.7",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
+}