@harnessio/react-sto-core-client 0.2.0

package/README.md

@@ -0,0 +1,39 @@
+# React STO Service Client(WIP)
+
+**OpenAPI -> OA**
+
+**TypeScript -> TS**
+
+**OpenAPI + TypeScript -> OATS**
+
+This React API client will store a collection of Harness STO Service APIs and Interfaces contracts generated from Open API Spec using `OATS CLI` internally.
+APIs are using hooks from `@tanstack/react-query`
+
+## Steps To Generate API Client build as dist folder
+
+```
+yarn build
+```
+
+## For NextGen UI adoption : STOCoreAPIClient should be initialized
+
+Before using API Client, it must be initilaized with required `ClientCallbacks`.
+
+Example:
+
+```
+ new STOCoreAPIClient({
+    getHeaders: () => {
+        return { token: SessionToken.getToken(), 'Harness-Account': accountId }
+    }}
+```
+
+## Versioning
+
+![@harnessio/react-sto-core-client](https://img.shields.io/npm/v/@harnessio/react-sto-core-client.svg?style=flat-square)
+
+Once development phase is completed, this repo will have changes and versioning driven by API spec only.
+
+## License
+
+[MIT](./LICENSE.md). Copyright(c) [Harness Inc](https://harness.io)

package/dist/fetcher/index.d.ts

@@ -0,0 +1,17 @@
+import type { IStringifyOptions } from 'qs';
+export interface FetcherOptions<TQueryParams = never, TBody = never, THeaderParams = HeadersInit> extends Omit<RequestInit, 'body' | 'headers'> {
+    url: string;
+    queryParams?: TQueryParams extends never ? undefined : TQueryParams;
+    body?: TBody extends never ? undefined : TBody;
+    stringifyQueryParamsOptions?: IStringifyOptions;
+    headers?: THeaderParams;
+}
+export interface ClientCallbacks {
+    responseInterceptor?: (response: Response) => Response;
+    requestInterceptor?: (request: Request) => Request;
+    urlInterceptor?: (url: string) => string;
+    getRequestHeaders?: () => Record<string, any>;
+}
+export declare function setupClient(callbacks: ClientCallbacks): void;
+export declare const updateClientHeaders: (headers: Record<string, any>) => void;
+export declare function fetcher<TResponse = unknown, TQueryParams = never, TBody = never, THeaderParams = HeadersInit>(options: FetcherOptions<TQueryParams, TBody, THeaderParams>): Promise<TResponse>;

package/dist/fetcher/index.js

@@ -0,0 +1,65 @@
+import { __awaiter, __rest } from "tslib";
+import { stringify } from 'qs';
+const JSON_CONTENT_TYPES = ['application/json'];
+let APIClientInitialized = false;
+let fetcherCallbacks;
+let customHeaders = {
+    'Content-Type': JSON_CONTENT_TYPES[0],
+};
+export function setupClient(callbacks) {
+    fetcherCallbacks = callbacks;
+    customHeaders = Object.assign(Object.assign({}, customHeaders), ((fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.getRequestHeaders) ? fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.getRequestHeaders() : {}));
+    APIClientInitialized = true;
+}
+export const updateClientHeaders = (headers) => {
+    customHeaders = Object.assign(Object.assign({}, customHeaders), headers);
+};
+export function fetcher(options) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        // If not initialized throw error even without making request
+        if (!APIClientInitialized) {
+            throw { reason: 'HarnessReactAPIClient has not been initialized' };
+        }
+        const { stringifyQueryParamsOptions, headers, body, url, queryParams = { account: customHeaders['Harness-Account'] } } = options, rest = __rest(options, ["stringifyQueryParamsOptions", "headers", "body", "url", "queryParams"]);
+        const token = customHeaders.token;
+        let finalUrl = url;
+        if (queryParams) {
+            finalUrl += stringify(queryParams, Object.assign(Object.assign({}, stringifyQueryParamsOptions), { addQueryPrefix: true }));
+        }
+        if (fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.urlInterceptor) {
+            finalUrl = (_a = fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.urlInterceptor) === null || _a === void 0 ? void 0 : _a.call(fetcherCallbacks, finalUrl);
+        }
+        let request = new Request(finalUrl, Object.assign({ headers: Object.assign(Object.assign({ Authorization: `Bearer ${token}` }, headers), customHeaders), body: body ? JSON.stringify(body) : undefined }, rest));
+        if (fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.requestInterceptor) {
+            request = fetcherCallbacks.requestInterceptor(request.clone());
+        }
+        let response = yield fetch(request);
+        if (fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.responseInterceptor) {
+            response = (_b = fetcherCallbacks === null || fetcherCallbacks === void 0 ? void 0 : fetcherCallbacks.responseInterceptor) === null || _b === void 0 ? void 0 : _b.call(fetcherCallbacks, response.clone());
+        }
+        const contentType = response.headers.get('Content-Type');
+        let total, pageSize, pageNumber, pageCount, pagination;
+        try {
+            total = response.headers.get('x-total-elements');
+            pageSize = response.headers.get('x-page-size');
+            pageNumber = response.headers.get('x-page-number');
+            pagination = total || pageSize || pageNumber;
+            if (pagination) {
+                total = Number(total);
+                pageSize = Number(pageSize);
+                pageCount = Math.ceil(total / pageSize);
+                pageNumber = Number(pageNumber);
+            }
+        }
+        catch (e) {
+            throw new Error('HarnessReactAPIClient: An error occurred while parsing pagination headers. ' + e);
+        }
+        const asJson = contentType && JSON_CONTENT_TYPES.some((h) => contentType.startsWith(h));
+        const data = yield (asJson ? response.json() : response.text());
+        if (response.ok) {
+            return Object.assign({ content: data }, (pagination ? { pagination: { total, pageCount, pageSize, pageNumber } } : {}));
+        }
+        throw data;
+    });
+}

package/dist/sto-core/src/index.d.ts

@@ -0,0 +1,6 @@
+import { ClientCallbacks } from '../../fetcher';
+export * from './services/index';
+export declare class STOCoreAPIClient {
+    updateHeaders: (headers: Record<string, any>) => void;
+    constructor(callbacks: ClientCallbacks);
+}

package/dist/sto-core/src/index.js

@@ -0,0 +1,10 @@
+import { setupClient, updateClientHeaders } from '../../fetcher';
+export * from './services/index';
+export class STOCoreAPIClient {
+    constructor(callbacks) {
+        setupClient(callbacks);
+        this.updateHeaders = (headers) => {
+            updateClientHeaders(headers);
+        };
+    }
+}

package/dist/sto-core/src/services/helpers.d.ts

@@ -0,0 +1,14 @@
+export type GetPathParamsType<T> = T extends {
+    pathParams: infer R;
+} ? R : never;
+export interface ResponseWithPagination<T> {
+    content: T;
+    pagination?: {
+        total?: number;
+        pageSize?: number;
+        pageCount?: number;
+        pageNumber?: number;
+    };
+}
+export type WithOptional<TInput, Tkeys extends keyof TInput> = Omit<TInput, Tkeys> & Partial<Pick<TInput, Tkeys>>;
+export type PickPartial<TInput, Tkeys extends keyof TInput> = Pick<Partial<TInput>, Tkeys>;

package/dist/sto-core/src/services/helpers.js

@@ -0,0 +1 @@
+export {};

package/dist/sto-core/src/services/hooks/useReferenceIdentifiersGetByReferenceIdQuery.d.ts

@@ -0,0 +1,27 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { GetByReferenceIdResponseBody } from '../schemas/GetByReferenceIdResponseBody';
+import type { NotFound } from '../schemas/NotFound';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ReferenceIdentifiersGetByReferenceIdQueryPathParams {
+    /**
+     * @example "CWE-123"
+     */
+    refId: string;
+}
+export interface ReferenceIdentifiersGetByReferenceIdQueryHeaderParams {
+    /**
+     * Harness personal or service access token
+     * @example "Atque quaerat aut."
+     */
+    'X-Api-Key'?: string;
+}
+export type ReferenceIdentifiersGetByReferenceIdOkResponse = ResponseWithPagination<GetByReferenceIdResponseBody>;
+export type ReferenceIdentifiersGetByReferenceIdErrorResponse = NotFound;
+export interface ReferenceIdentifiersGetByReferenceIdProps extends ReferenceIdentifiersGetByReferenceIdQueryPathParams, Omit<FetcherOptions<unknown, unknown, ReferenceIdentifiersGetByReferenceIdQueryHeaderParams>, 'url'> {
+}
+export declare function referenceIdentifiersGetByReferenceId(props: ReferenceIdentifiersGetByReferenceIdProps): Promise<ReferenceIdentifiersGetByReferenceIdOkResponse>;
+/**
+ * Reference Identifiers Lookup
+ */
+export declare function useReferenceIdentifiersGetByReferenceIdQuery(props: ReferenceIdentifiersGetByReferenceIdProps, options?: Omit<UseQueryOptions<ReferenceIdentifiersGetByReferenceIdOkResponse, ReferenceIdentifiersGetByReferenceIdErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ReferenceIdentifiersGetByReferenceIdOkResponse, NotFound>;

package/dist/sto-core/src/services/hooks/useReferenceIdentifiersGetByReferenceIdQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../fetcher/index.js';
+export function referenceIdentifiersGetByReferenceId(props) {
+    return fetcher(Object.assign({ url: `/api/v2/reference-identifiers/${props.refId}`, method: 'GET' }, props));
+}
+/**
+ * Reference Identifiers Lookup
+ */
+export function useReferenceIdentifiersGetByReferenceIdQuery(props, options) {
+    return useQuery(['Reference Identifiers#getByReferenceId', props.refId], ({ signal }) => referenceIdentifiersGetByReferenceId(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/sto-core/src/services/index.d.ts

@@ -0,0 +1,5 @@
+export type { GetPathParamsType, ResponseWithPagination } from './helpers';
+export type { ReferenceIdentifiersGetByReferenceIdErrorResponse, ReferenceIdentifiersGetByReferenceIdOkResponse, ReferenceIdentifiersGetByReferenceIdProps, ReferenceIdentifiersGetByReferenceIdQueryPathParams, } from './hooks/useReferenceIdentifiersGetByReferenceIdQuery';
+export { referenceIdentifiersGetByReferenceId, useReferenceIdentifiersGetByReferenceIdQuery, } from './hooks/useReferenceIdentifiersGetByReferenceIdQuery';
+export type { GetByReferenceIdResponseBody } from './schemas/GetByReferenceIdResponseBody';
+export type { NotFound } from './schemas/NotFound';

package/dist/sto-core/src/services/index.js

@@ -0,0 +1 @@
+export { referenceIdentifiersGetByReferenceId, useReferenceIdentifiersGetByReferenceIdQuery, } from './hooks/useReferenceIdentifiersGetByReferenceIdQuery';

package/dist/sto-core/src/services/schemas/GetByReferenceIdResponseBody.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @example {"description":"Ut vitae doloremque.","extendedDescription":"Saepe atque est molestias.","remediationSteps":"Voluptas voluptatem reiciendis tenetur quia.","severity":8.5,"severityCode":"High"}
+ */
+export interface GetByReferenceIdResponseBody {
+    /**
+     * A short description of the identified issue.
+     * @example "Corporis consectetur aut quas veritatis."
+     */
+    description?: string;
+    /**
+     * A more detailed explanation of the issue and its potential impact.
+     * @example "Totam voluptatem nihil earum."
+     */
+    extendedDescription?: string;
+    /**
+     * Steps the developer can take to address or mitigate the issue.
+     * @example "Quod itaque unde suscipit facere molestiae delectus."
+     */
+    remediationSteps?: string;
+    /**
+     * Numeric severity, from 0 (lowest) to 10 (highest)
+     * @format double
+     * @example 8.5
+     */
+    severity?: number;
+    /**
+     * Severity code
+     * @example "High"
+     */
+    severityCode?: string;
+}

package/dist/sto-core/src/services/schemas/GetByReferenceIdResponseBody.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/sto-core/src/services/schemas/NotFound.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @example {"message":"Not Found","status":404}
+ */
+export interface NotFound {
+    /**
+     * @example "Not Found"
+     */
+    message: string;
+    /**
+     * @format int64
+     * @default 404
+     * @example 404
+     */
+    status?: number;
+}

package/dist/sto-core/src/services/schemas/NotFound.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@harnessio/react-sto-core-client",
+  "version": "0.2.0",
+  "description": "Harness STO service APIs integrated with react hooks",
+  "author": "Harness Inc",
+  "license": "MIT",
+  "source": "src/index.ts",
+  "main": "./dist/sto-core/src/index.js",
+  "exports": {
+    ".": "./dist/sto-core/src/index.js"
+  },
+  "types": "./dist/sto-core/src/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
+  "homepage": "https://github.com/harness/react-api-client",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/harness/react-api-client.git"
+  },
+  "bugs": {
+    "url": "https://github.com/harness/react-api-client/issues"
+  },
+  "keywords": [],
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "yarn generate && tsc",
+    "generate": "oats import --config='./oats.config.ts'",
+    "fmt": "prettier --write ./index.ts"
+  },
+  "engines": {
+    "node": "^16"
+  }
+}