@safeurl/sdk 1.0.0

package/src/client/core/types.gen.ts

@@ -0,0 +1,104 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Auth, AuthToken } from './auth.gen';
+import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen';
+
+export type HttpMethod =
+  | 'connect'
+  | 'delete'
+  | 'get'
+  | 'head'
+  | 'options'
+  | 'patch'
+  | 'post'
+  | 'put'
+  | 'trace';
+
+export type Client<
+  RequestFn = never,
+  Config = unknown,
+  MethodFn = never,
+  BuildUrlFn = never,
+  SseFn = never,
+> = {
+  /**
+   * Returns the final request URL.
+   */
+  buildUrl: BuildUrlFn;
+  getConfig: () => Config;
+  request: RequestFn;
+  setConfig: (config: Config) => Config;
+} & {
+  [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? { sse?: never } : { sse: { [K in HttpMethod]: SseFn } });
+
+export interface Config {
+  /**
+   * Auth token or a function returning auth token. The resolved value will be
+   * added to the request payload as defined by its `security` array.
+   */
+  auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+  /**
+   * A function for serializing request body parameter. By default,
+   * {@link JSON.stringify()} will be used.
+   */
+  bodySerializer?: BodySerializer | null;
+  /**
+   * An object containing any HTTP headers that you want to pre-populate your
+   * `Headers` object with.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+   */
+  headers?:
+    | RequestInit['headers']
+    | Record<
+        string,
+        string | number | boolean | (string | number | boolean)[] | null | undefined | unknown
+      >;
+  /**
+   * The request method.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+   */
+  method?: Uppercase<HttpMethod>;
+  /**
+   * A function for serializing request query parameters. By default, arrays
+   * will be exploded in form style, objects will be exploded in deepObject
+   * style, and reserved characters are percent-encoded.
+   *
+   * This method will have no effect if the native `paramsSerializer()` Axios
+   * API function is used.
+   *
+   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+   */
+  querySerializer?: QuerySerializer | QuerySerializerOptions;
+  /**
+   * A function validating request data. This is useful if you want to ensure
+   * the request conforms to the desired shape, so it can be safely sent to
+   * the server.
+   */
+  requestValidator?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function transforming response data before it's returned. This is useful
+   * for post-processing data, e.g. converting ISO strings into Date objects.
+   */
+  responseTransformer?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function validating response data. This is useful if you want to ensure
+   * the response conforms to the desired shape, so it can be safely passed to
+   * the transformers and returned to the user.
+   */
+  responseValidator?: (data: unknown) => Promise<unknown>;
+}
+
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
+  ? true
+  : [T] extends [never | undefined]
+    ? [undefined] extends [T]
+      ? false
+      : true
+    : false;
+
+export type OmitNever<T extends Record<string, unknown>> = {
+  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true ? never : K]: T[K];
+};

package/src/client/core/utils.gen.ts

@@ -0,0 +1,140 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { BodySerializer, QuerySerializer } from './bodySerializer.gen';
+import {
+  type ArraySeparatorStyle,
+  serializeArrayParam,
+  serializeObjectParam,
+  serializePrimitiveParam,
+} from './pathSerializer.gen';
+
+export interface PathSerializer {
+  path: Record<string, unknown>;
+  url: string;
+}
+
+export const PATH_PARAM_RE = /\{[^{}]+\}/g;
+
+export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
+  let url = _url;
+  const matches = _url.match(PATH_PARAM_RE);
+  if (matches) {
+    for (const match of matches) {
+      let explode = false;
+      let name = match.substring(1, match.length - 1);
+      let style: ArraySeparatorStyle = 'simple';
+
+      if (name.endsWith('*')) {
+        explode = true;
+        name = name.substring(0, name.length - 1);
+      }
+
+      if (name.startsWith('.')) {
+        name = name.substring(1);
+        style = 'label';
+      } else if (name.startsWith(';')) {
+        name = name.substring(1);
+        style = 'matrix';
+      }
+
+      const value = path[name];
+
+      if (value === undefined || value === null) {
+        continue;
+      }
+
+      if (Array.isArray(value)) {
+        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
+        continue;
+      }
+
+      if (typeof value === 'object') {
+        url = url.replace(
+          match,
+          serializeObjectParam({
+            explode,
+            name,
+            style,
+            value: value as Record<string, unknown>,
+            valueOnly: true,
+          }),
+        );
+        continue;
+      }
+
+      if (style === 'matrix') {
+        url = url.replace(
+          match,
+          `;${serializePrimitiveParam({
+            name,
+            value: value as string,
+          })}`,
+        );
+        continue;
+      }
+
+      const replaceValue = encodeURIComponent(
+        style === 'label' ? `.${value as string}` : (value as string),
+      );
+      url = url.replace(match, replaceValue);
+    }
+  }
+  return url;
+};
+
+export const getUrl = ({
+  baseUrl,
+  path,
+  query,
+  querySerializer,
+  url: _url,
+}: {
+  baseUrl?: string;
+  path?: Record<string, unknown>;
+  query?: Record<string, unknown>;
+  querySerializer: QuerySerializer;
+  url: string;
+}) => {
+  const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
+  let url = (baseUrl ?? '') + pathUrl;
+  if (path) {
+    url = defaultPathSerializer({ path, url });
+  }
+  let search = query ? querySerializer(query) : '';
+  if (search.startsWith('?')) {
+    search = search.substring(1);
+  }
+  if (search) {
+    url += `?${search}`;
+  }
+  return url;
+};
+
+export function getValidRequestBody(options: {
+  body?: unknown;
+  bodySerializer?: BodySerializer | null;
+  serializedBody?: unknown;
+}) {
+  const hasBody = options.body !== undefined;
+  const isSerializedBody = hasBody && options.bodySerializer;
+
+  if (isSerializedBody) {
+    if ('serializedBody' in options) {
+      const hasSerializedBody =
+        options.serializedBody !== undefined && options.serializedBody !== '';
+
+      return hasSerializedBody ? options.serializedBody : null;
+    }
+
+    // not all clients implement a serializedBody property (i.e. client-axios)
+    return options.body !== '' ? options.body : null;
+  }
+
+  // plain/text body
+  if (hasBody) {
+    return options.body;
+  }
+
+  // no body was provided
+  return undefined;
+}

package/src/client/index.ts

@@ -0,0 +1,4 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export { deleteV1ApiKeysById, getHealth, getV1ApiKeys, getV1Credits, getV1Scans, getV1ScansById, getV1ScansByIdAnalytics, getV1ScansByIdEvents, getV1Settings, type Options, postV1ApiKeys, postV1CreditsPurchase, postV1Scans, postV1ScansBatch, putV1Settings } from './sdk.gen';
+export type { ClientOptions, DeleteV1ApiKeysByIdData, DeleteV1ApiKeysByIdErrors, DeleteV1ApiKeysByIdResponses, GetHealthData, GetV1ApiKeysData, GetV1ApiKeysErrors, GetV1ApiKeysResponses, GetV1CreditsData, GetV1CreditsErrors, GetV1CreditsResponses, GetV1ScansByIdAnalyticsData, GetV1ScansByIdAnalyticsErrors, GetV1ScansByIdAnalyticsResponses, GetV1ScansByIdData, GetV1ScansByIdErrors, GetV1ScansByIdEventsData, GetV1ScansByIdEventsErrors, GetV1ScansByIdEventsResponses, GetV1ScansByIdResponses, GetV1ScansData, GetV1ScansErrors, GetV1ScansResponses, GetV1SettingsData, GetV1SettingsErrors, GetV1SettingsResponses, PostV1ApiKeysData, PostV1ApiKeysErrors, PostV1ApiKeysResponses, PostV1CreditsPurchaseData, PostV1CreditsPurchaseErrors, PostV1CreditsPurchaseResponses, PostV1ScansBatchData, PostV1ScansBatchResponses, PostV1ScansData, PostV1ScansResponses, PutV1SettingsData, PutV1SettingsErrors, PutV1SettingsResponses } from './types.gen';

package/src/client/sdk.gen.ts

@@ -0,0 +1,152 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Client, Options as Options2, TDataShape } from './client';
+import { client } from './client.gen';
+import type { DeleteV1ApiKeysByIdData, DeleteV1ApiKeysByIdErrors, DeleteV1ApiKeysByIdResponses, GetHealthData, GetV1ApiKeysData, GetV1ApiKeysErrors, GetV1ApiKeysResponses, GetV1CreditsData, GetV1CreditsErrors, GetV1CreditsResponses, GetV1ScansByIdAnalyticsData, GetV1ScansByIdAnalyticsErrors, GetV1ScansByIdAnalyticsResponses, GetV1ScansByIdData, GetV1ScansByIdErrors, GetV1ScansByIdEventsData, GetV1ScansByIdEventsErrors, GetV1ScansByIdEventsResponses, GetV1ScansByIdResponses, GetV1ScansData, GetV1ScansErrors, GetV1ScansResponses, GetV1SettingsData, GetV1SettingsErrors, GetV1SettingsResponses, PostV1ApiKeysData, PostV1ApiKeysErrors, PostV1ApiKeysResponses, PostV1CreditsPurchaseData, PostV1CreditsPurchaseErrors, PostV1CreditsPurchaseResponses, PostV1ScansBatchData, PostV1ScansBatchResponses, PostV1ScansData, PostV1ScansResponses, PutV1SettingsData, PutV1SettingsErrors, PutV1SettingsResponses } from './types.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+
+/**
+ * Health Check
+ *
+ * Returns service health status with dependency checks
+ */
+export const getHealth = <ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/health', ...options });
+
+/**
+ * List API keys
+ *
+ * Retrieves all API keys for the authenticated user. Plaintext keys are never returned.
+ */
+export const getV1ApiKeys = <ThrowOnError extends boolean = false>(options?: Options<GetV1ApiKeysData, ThrowOnError>) => (options?.client ?? client).get<GetV1ApiKeysResponses, GetV1ApiKeysErrors, ThrowOnError>({ url: '/v1/api-keys/', ...options });
+
+/**
+ * Create a new API key
+ *
+ * Creates a new API key for the authenticated user. The plaintext key is only returned once in this response.
+ */
+export const postV1ApiKeys = <ThrowOnError extends boolean = false>(options: Options<PostV1ApiKeysData, ThrowOnError>) => (options.client ?? client).post<PostV1ApiKeysResponses, PostV1ApiKeysErrors, ThrowOnError>({
+    url: '/v1/api-keys/',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * Revoke an API key
+ *
+ * Revokes an API key by setting its revokedAt timestamp. The key will no longer be valid for authentication.
+ */
+export const deleteV1ApiKeysById = <ThrowOnError extends boolean = false>(options: Options<DeleteV1ApiKeysByIdData, ThrowOnError>) => (options.client ?? client).delete<DeleteV1ApiKeysByIdResponses, DeleteV1ApiKeysByIdErrors, ThrowOnError>({ url: '/v1/api-keys/{id}', ...options });
+
+/**
+ * List scan jobs
+ *
+ * Returns the user's scan jobs, most recent first. Optional query batchId to list only jobs from a batch (e.g. from POST /v1/scans/batch).
+ */
+export const getV1Scans = <ThrowOnError extends boolean = false>(options?: Options<GetV1ScansData, ThrowOnError>) => (options?.client ?? client).get<GetV1ScansResponses, GetV1ScansErrors, ThrowOnError>({ url: '/v1/scans/', ...options });
+
+/**
+ * Create a new URL scan job
+ *
+ * Creates a new URL scan job and deducts credits from the user's wallet
+ */
+export const postV1Scans = <ThrowOnError extends boolean = false>(options: Options<PostV1ScansData, ThrowOnError>) => (options.client ?? client).post<PostV1ScansResponses, unknown, ThrowOnError>({
+    url: '/v1/scans/',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * Create a batch of URL scan jobs
+ *
+ * Creates multiple scan jobs in one request. Deducts credits for each URL. Max 50 URLs per batch. Returns batchId for listing via GET /v1/scans?batchId=.
+ */
+export const postV1ScansBatch = <ThrowOnError extends boolean = false>(options: Options<PostV1ScansBatchData, ThrowOnError>) => (options.client ?? client).post<PostV1ScansBatchResponses, unknown, ThrowOnError>({
+    url: '/v1/scans/batch',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * Get scan analytics (LLM calls)
+ *
+ * Returns observability data for a scan job: LLM calls (triage, vision, synthesis) with tokens, cost, latency.
+ */
+export const getV1ScansByIdAnalytics = <ThrowOnError extends boolean = false>(options: Options<GetV1ScansByIdAnalyticsData, ThrowOnError>) => (options.client ?? client).get<GetV1ScansByIdAnalyticsResponses, GetV1ScansByIdAnalyticsErrors, ThrowOnError>({ url: '/v1/scans/{id}/analytics', ...options });
+
+/**
+ * Stream scan state changes via SSE
+ *
+ * Opens a Server-Sent Events stream that emits a state event immediately on connect, then on every state transition until a terminal state (COMPLETED, FAILED, TIMED_OUT) is reached.
+ */
+export const getV1ScansByIdEvents = <ThrowOnError extends boolean = false>(options: Options<GetV1ScansByIdEventsData, ThrowOnError>) => (options.client ?? client).get<GetV1ScansByIdEventsResponses, GetV1ScansByIdEventsErrors, ThrowOnError>({ url: '/v1/scans/{id}/events', ...options });
+
+/**
+ * Get scan result by job ID
+ *
+ * Retrieves the scan result for a specific job ID. Returns the full result if completed, or status if in progress.
+ */
+export const getV1ScansById = <ThrowOnError extends boolean = false>(options: Options<GetV1ScansByIdData, ThrowOnError>) => (options.client ?? client).get<GetV1ScansByIdResponses, GetV1ScansByIdErrors, ThrowOnError>({ url: '/v1/scans/{id}', ...options });
+
+/**
+ * Get credit balance
+ *
+ * Retrieves the current credit balance for the user
+ */
+export const getV1Credits = <ThrowOnError extends boolean = false>(options?: Options<GetV1CreditsData, ThrowOnError>) => (options?.client ?? client).get<GetV1CreditsResponses, GetV1CreditsErrors, ThrowOnError>({ url: '/v1/credits/', ...options });
+
+/**
+ * Purchase credits
+ *
+ * Purchase credits using crypto or other payment methods. This is a stub implementation.
+ */
+export const postV1CreditsPurchase = <ThrowOnError extends boolean = false>(options: Options<PostV1CreditsPurchaseData, ThrowOnError>) => (options.client ?? client).post<PostV1CreditsPurchaseResponses, PostV1CreditsPurchaseErrors, ThrowOnError>({
+    url: '/v1/credits/purchase',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * Get user settings
+ *
+ * Retrieves user-defined settings including safe/unsafe domain patterns.
+ */
+export const getV1Settings = <ThrowOnError extends boolean = false>(options?: Options<GetV1SettingsData, ThrowOnError>) => (options?.client ?? client).get<GetV1SettingsResponses, GetV1SettingsErrors, ThrowOnError>({ url: '/v1/settings/', ...options });
+
+/**
+ * Update user settings
+ *
+ * Updates user-defined settings like domain glob patterns for short-circuiting.
+ */
+export const putV1Settings = <ThrowOnError extends boolean = false>(options: Options<PutV1SettingsData, ThrowOnError>) => (options.client ?? client).put<PutV1SettingsResponses, PutV1SettingsErrors, ThrowOnError>({
+    url: '/v1/settings/',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});