init

packages/perigon/index.ts

@@ -0,0 +1,106 @@
+import type * as types from './types';
+import type { ConfigOptions, FetchResponse } from 'api/dist/core'
+import Oas from 'oas';
+import APICore from 'api/dist/core';
+import definition from './openapi.json';
+
+class SDK {
+  spec: Oas;
+  core: APICore;
+
+  constructor() {
+    this.spec = Oas.init(definition);
+    this.core = new APICore(this.spec, 'perigon/unknown (api/6.1.3)');
+  }
+
+  /**
+   * Optionally configure various options that the SDK allows.
+   *
+   * @param config Object of supported SDK options and toggles.
+   * @param config.timeout Override the default `fetch` request timeout of 30 seconds. This number
+   * should be represented in milliseconds.
+   */
+  config(config: ConfigOptions) {
+    this.core.setConfig(config);
+  }
+
+  /**
+   * If the API you're using requires authentication you can supply the required credentials
+   * through this method and the library will magically determine how they should be used
+   * within your API request.
+   *
+   * With the exception of OpenID and MutualTLS, it supports all forms of authentication
+   * supported by the OpenAPI specification.
+   *
+   * @example <caption>HTTP Basic auth</caption>
+   * sdk.auth('username', 'password');
+   *
+   * @example <caption>Bearer tokens (HTTP or OAuth 2)</caption>
+   * sdk.auth('myBearerToken');
+   *
+   * @example <caption>API Keys</caption>
+   * sdk.auth('myApiKey');
+   *
+   * @see {@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}
+   * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22}
+   * @param values Your auth credentials for the API; can specify up to two strings or numbers.
+   */
+  auth(...values: string[] | number[]) {
+    this.core.setAuth(...values);
+    return this;
+  }
+
+  /**
+   * If the API you're using offers alternate server URLs, and server variables, you can tell
+   * the SDK which one to use with this method. To use it you can supply either one of the
+   * server URLs that are contained within the OpenAPI definition (along with any server
+   * variables), or you can pass it a fully qualified URL to use (that may or may not exist
+   * within the OpenAPI definition).
+   *
+   * @example <caption>Server URL with server variables</caption>
+   * sdk.server('https://{region}.api.example.com/{basePath}', {
+   *   name: 'eu',
+   *   basePath: 'v14',
+   * });
+   *
+   * @example <caption>Fully qualified server URL</caption>
+   * sdk.server('https://eu.api.example.com/v14');
+   *
+   * @param url Server URL
+   * @param variables An object of variables to replace into the server URL.
+   */
+  server(url: string, variables = {}) {
+    this.core.setServer(url, variables);
+  }
+
+  /**
+   * Search and filter all news articles available via the Perigon API. The result includes a
+   * list of individual articles that were matched to your specific criteria.
+   *
+   * @summary All Articles
+   * @throws FetchError<400, types.AllNewsResponse400> 400
+   * @throws FetchError<401, types.AllNewsResponse401> 401
+   * @throws FetchError<403, types.AllNewsResponse403> 403
+   * @throws FetchError<404, types.AllNewsResponse404> 404
+   * @throws FetchError<500, types.AllNewsResponse500> 500
+   */
+  allNews(metadata: types.AllNewsMetadataParam): Promise<FetchResponse<200, types.AllNewsResponse200>> {
+    return this.core.fetch('/v1/all', 'get', metadata);
+  }
+
+  /**
+   * Stories
+   *
+   * @throws FetchError<400, types.Stories1Response400> 400
+   */
+  stories1(metadata: types.Stories1MetadataParam): Promise<FetchResponse<200, types.Stories1Response200>> {
+    return this.core.fetch('/v1/stories/all', 'get', metadata);
+  }
+}
+
+const createSDK = (() => { return new SDK(); })()
+;
+
+export default createSDK;
+
+export type { AllNewsMetadataParam, AllNewsResponse200, AllNewsResponse400, AllNewsResponse401, AllNewsResponse403, AllNewsResponse404, AllNewsResponse500, Stories1MetadataParam, Stories1Response200, Stories1Response400 } from './types';

packages/perigon/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@web-agent-rs/perigon",
+  "version": "0.0.0",
+  "main": "index.ts",
+  "types": "./index.d.ts",
+  "type": "module",
+  "dependencies": {
+    "api": "^6.1.3",
+    "json-schema-to-ts": "^2.8.0-beta.0",
+    "oas": "^20.11.0"
+  }
+}

packages/perigon/types.ts

@@ -0,0 +1,13 @@
+import type { FromSchema } from 'json-schema-to-ts';
+import * as schemas from './schemas';
+
+export type AllNewsMetadataParam = FromSchema<typeof schemas.AllNews.metadata>;
+export type AllNewsResponse200 = FromSchema<typeof schemas.AllNews.response['200']>;
+export type AllNewsResponse400 = FromSchema<typeof schemas.AllNews.response['400']>;
+export type AllNewsResponse401 = FromSchema<typeof schemas.AllNews.response['401']>;
+export type AllNewsResponse403 = FromSchema<typeof schemas.AllNews.response['403']>;
+export type AllNewsResponse404 = FromSchema<typeof schemas.AllNews.response['404']>;
+export type AllNewsResponse500 = FromSchema<typeof schemas.AllNews.response['500']>;
+export type Stories1MetadataParam = FromSchema<typeof schemas.Stories1.metadata>;
+export type Stories1Response200 = FromSchema<typeof schemas.Stories1.response['200']>;
+export type Stories1Response400 = FromSchema<typeof schemas.Stories1.response['400']>;