@valtown/sdk 0.1.0-alpha.1

package/src/error.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { castToError, Headers } from './core';
+
+export class ValTownError extends Error {}
+
+export class APIError extends ValTownError {
+  readonly status: number | undefined;
+  readonly headers: Headers | undefined;
+  readonly error: Object | undefined;
+
+  constructor(
+    status: number | undefined,
+    error: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    super(`${APIError.makeMessage(status, error, message)}`);
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+
+  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
+    const msg =
+      error?.message ?
+        typeof error.message === 'string' ?
+          error.message
+        : JSON.stringify(error.message)
+      : error ? JSON.stringify(error)
+      : message;
+
+    if (status && msg) {
+      return `${status} ${msg}`;
+    }
+    if (status) {
+      return `${status} status code (no body)`;
+    }
+    if (msg) {
+      return msg;
+    }
+    return '(no status code or body)';
+  }
+
+  static generate(
+    status: number | undefined,
+    errorResponse: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    if (!status) {
+      return new APIConnectionError({ cause: castToError(errorResponse) });
+    }
+
+    const error = errorResponse as Record<string, any>;
+
+    if (status === 400) {
+      return new BadRequestError(status, error, message, headers);
+    }
+
+    if (status === 401) {
+      return new AuthenticationError(status, error, message, headers);
+    }
+
+    if (status === 403) {
+      return new PermissionDeniedError(status, error, message, headers);
+    }
+
+    if (status === 404) {
+      return new NotFoundError(status, error, message, headers);
+    }
+
+    if (status === 409) {
+      return new ConflictError(status, error, message, headers);
+    }
+
+    if (status === 422) {
+      return new UnprocessableEntityError(status, error, message, headers);
+    }
+
+    if (status === 429) {
+      return new RateLimitError(status, error, message, headers);
+    }
+
+    if (status >= 500) {
+      return new InternalServerError(status, error, message, headers);
+    }
+
+    return new APIError(status, error, message, headers);
+  }
+}
+
+export class APIUserAbortError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message }: { message?: string } = {}) {
+    super(undefined, undefined, message || 'Request was aborted.', undefined);
+  }
+}
+
+export class APIConnectionError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message, cause }: { message?: string; cause?: Error | undefined }) {
+    super(undefined, undefined, message || 'Connection error.', undefined);
+    // in some environments the 'cause' property is already declared
+    // @ts-ignore
+    if (cause) this.cause = cause;
+  }
+}
+
+export class APIConnectionTimeoutError extends APIConnectionError {
+  constructor({ message }: { message?: string } = {}) {
+    super({ message: message ?? 'Request timed out.' });
+  }
+}
+
+export class BadRequestError extends APIError {
+  override readonly status: 400 = 400;
+}
+
+export class AuthenticationError extends APIError {
+  override readonly status: 401 = 401;
+}
+
+export class PermissionDeniedError extends APIError {
+  override readonly status: 403 = 403;
+}
+
+export class NotFoundError extends APIError {
+  override readonly status: 404 = 404;
+}
+
+export class ConflictError extends APIError {
+  override readonly status: 409 = 409;
+}
+
+export class UnprocessableEntityError extends APIError {
+  override readonly status: 422 = 422;
+}
+
+export class RateLimitError extends APIError {
+  override readonly status: 429 = 429;
+}
+
+export class InternalServerError extends APIError {}

package/src/index.ts

@@ -0,0 +1,227 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from './core';
+import * as Errors from './error';
+import { type Agent } from './_shims/index';
+import * as Uploads from './uploads';
+import * as Pagination from "./pagination";
+import * as API from "./resources/index";
+
+export interface ClientOptions {
+  /**
+   * Defaults to process.env['VAL_TOWN_BEARER_TOKEN'].
+   */
+  bearerToken?: string | undefined;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['VAL_TOWN_BASE_URL'].
+   */
+  baseURL?: string | null | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+   * much longer than this timeout before the promise succeeds or fails.
+   */
+  timeout?: number;
+
+  /**
+   * An HTTP agent used to manage HTTP(S) connections.
+   *
+   * If not provided, an agent will be constructed by default in the Node.js environment,
+   * otherwise no agent is used.
+   */
+  httpAgent?: Agent;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * defined globally.
+   */
+  fetch?: Core.Fetch | undefined;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
+  maxRetries?: number;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `undefined` or `null` in request options.
+   */
+  defaultHeaders?: Core.Headers;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Core.DefaultQuery;
+}
+
+/** API Client for interfacing with the Val Town API. */
+export class ValTown extends Core.APIClient {
+  bearerToken: string;
+
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the Val Town API.
+   *
+   * @param {string | undefined} [opts.bearerToken=process.env['VAL_TOWN_BEARER_TOKEN'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['VAL_TOWN_BASE_URL'] ?? https://api.val.town] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+   */
+  constructor({
+    baseURL = Core.readEnv('VAL_TOWN_BASE_URL'),
+    bearerToken = Core.readEnv('VAL_TOWN_BEARER_TOKEN'),
+    ...opts
+  }: ClientOptions = {}) {
+    if (bearerToken === undefined) {
+      throw new Errors.ValTownError(
+        "The VAL_TOWN_BEARER_TOKEN environment variable is missing or empty; either provide it, or instantiate the ValTown client with an bearerToken option, like new ValTown({ bearerToken: 'My Bearer Token' }).",
+      );
+    }
+
+    const options: ClientOptions = {
+      bearerToken,
+      ...opts,
+      baseURL: baseURL || `https://api.val.town`,
+    };
+
+    super({
+      baseURL: options.baseURL!,
+      timeout: options.timeout ?? 60000 /* 1 minute */,
+      httpAgent: options.httpAgent,
+      maxRetries: options.maxRetries,
+      fetch: options.fetch,
+    });
+    this._options = options;
+
+    this.bearerToken = bearerToken;
+  }
+
+  search: API.Search = new API.Search(this);
+  alias: API.Alias = new API.Alias(this);
+  me: API.Me = new API.Me(this);
+  blobs: API.Blobs = new API.Blobs(this);
+  users: API.Users = new API.Users(this);
+  sqlite: API.Sqlite = new API.Sqlite(this);
+  evals: API.Evals = new API.Evals(this);
+  vals: API.Vals = new API.Vals(this);
+  emails: API.Emails = new API.Emails(this);
+
+  protected override defaultQuery(): Core.DefaultQuery | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return {
+      ...super.defaultHeaders(opts),
+      ...this._options.defaultHeaders,
+    };
+  }
+
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return { Authorization: `Bearer ${this.bearerToken}` };
+  }
+
+  static ValTown = this;
+
+  static ValTownError = Errors.ValTownError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
+}
+
+export const {
+  ValTownError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+  NotFoundError,
+  ConflictError,
+  RateLimitError,
+  BadRequestError,
+  AuthenticationError,
+  InternalServerError,
+  PermissionDeniedError,
+  UnprocessableEntityError,
+} = Errors;
+
+export import toFile = Uploads.toFile;
+export import fileFromPath = Uploads.fileFromPath;
+
+export namespace ValTown {
+  export import RequestOptions = Core.RequestOptions;
+
+  export import PageCursorURL = Pagination.PageCursorURL;
+  export import PageCursorURLParams = Pagination.PageCursorURLParams;
+  export import PageCursorURLResponse = Pagination.PageCursorURLResponse;
+
+  export import Search = API.Search;
+
+  export import Alias = API.Alias;
+
+  export import Me = API.Me;
+
+  export import Blobs = API.Blobs;
+
+  export import Users = API.Users;
+
+  export import Sqlite = API.Sqlite;
+  export import SqliteBatchParams = API.SqliteBatchParams;
+  export import SqliteExecuteParams = API.SqliteExecuteParams;
+
+  export import Evals = API.Evals;
+  export import EvalRunCodeResponse = API.EvalRunCodeResponse;
+  export import EvalRunCodeParams = API.EvalRunCodeParams;
+
+  export import Vals = API.Vals;
+  export import ValCreateResponse = API.ValCreateResponse;
+  export import ValRetrieveResponse = API.ValRetrieveResponse;
+  export import ValRunAnonymousResponse = API.ValRunAnonymousResponse;
+  export import ValCreateParams = API.ValCreateParams;
+  export import ValUpdateParams = API.ValUpdateParams;
+  export import ValCreateOrUpdateParams = API.ValCreateOrUpdateParams;
+  export import ValRunParams = API.ValRunParams;
+  export import ValRunAnonymousParams = API.ValRunAnonymousParams;
+  export import ValRunGetParams = API.ValRunGetParams;
+
+  export import Emails = API.Emails;
+  export import EmailSendResponse = API.EmailSendResponse;
+  export import EmailSendParams = API.EmailSendParams;
+
+  export import User = API.User;
+}
+
+export default ValTown;

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/pagination.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
+
+export interface PageCursorURLResponse<Item> {
+  data: Array<Item>;
+
+  links: PageCursorURLResponse.Links;
+}
+
+export namespace PageCursorURLResponse {
+  export interface Links {
+    next?: string;
+
+    prev?: string;
+  }
+}
+
+export interface PageCursorURLParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export class PageCursorURL<Item> extends AbstractPage<Item> implements PageCursorURLResponse<Item> {
+  data: Array<Item>;
+
+  links: PageCursorURLResponse.Links;
+
+  constructor(
+    client: APIClient,
+    response: Response,
+    body: PageCursorURLResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || [];
+    this.links = body.links || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data ?? [];
+  }
+
+  // @deprecated Please use `nextPageInfo()` instead
+  nextPageParams(): Partial<PageCursorURLParams> | null {
+    const info = this.nextPageInfo();
+    if (!info) return null;
+    if ('params' in info) return info.params;
+    const params = Object.fromEntries(info.url.searchParams);
+    if (!Object.keys(params).length) return null;
+    return params;
+  }
+
+  nextPageInfo(): PageInfo | null {
+    const url = this.links?.next;
+    if (!url) return null;
+
+    return { url: new URL(url) };
+  }
+}

package/src/resource.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import type { ValTown } from './index';
+
+export class APIResource {
+  protected _client: ValTown;
+
+  constructor(client: ValTown) {
+    this._client = client;
+  }
+}

package/src/resources/alias/alias.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from "../../resource";
+import * as UsernameAPI from "./username/username";
+
+export class Alias extends APIResource {
+  username: UsernameAPI.Username = new UsernameAPI.Username(this._client);
+}
+
+export namespace Alias {
+  export import Username = UsernameAPI.Username;
+}

package/src/resources/alias/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Alias } from './alias';
+export { Username } from './username/index';

package/src/resources/alias/username/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Username } from './username';
+export { ValNameRetrieveResponse, ValName } from './val-name';

package/src/resources/alias/username/username.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import * as Shared from "../../shared";
+import * as ValNameAPI from "./val-name";
+
+export class Username extends APIResource {
+  valName: ValNameAPI.ValName = new ValNameAPI.ValName(this._client);
+
+  /**
+   * Get basic details about a user, given their username
+   */
+  retrieve(username: string, options?: Core.RequestOptions): Core.APIPromise<Shared.User> {
+    return this._client.get(`/v1/alias/${username}`, options);
+  }
+}
+
+export namespace Username {
+  export import ValName = ValNameAPI.ValName;
+  export import ValNameRetrieveResponse = ValNameAPI.ValNameRetrieveResponse;
+}

package/src/resources/alias/username/val-name.ts

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import * as ValNameAPI from "./val-name";
+
+export class ValName extends APIResource {
+  /**
+   * Get a val
+   */
+  retrieve(
+    username: string,
+    valName: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ValNameRetrieveResponse> {
+    return this._client.get(`/v1/alias/${username}/${valName}`, options);
+  }
+}
+
+/**
+ * A Val
+ */
+export interface ValNameRetrieveResponse {
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: ValNameRetrieveResponse.Author | null;
+
+  code: string | null;
+
+  createdAt: string;
+
+  likeCount: number;
+
+  name: string;
+
+  privacy: 'public' | 'unlisted' | 'private';
+
+  public: boolean;
+
+  readme: string | null;
+
+  referenceCount: number;
+
+  type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc';
+
+  version: number;
+}
+
+export namespace ValNameRetrieveResponse {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+export namespace ValName {
+  export import ValNameRetrieveResponse = ValNameAPI.ValNameRetrieveResponse;
+}

package/src/resources/blobs.ts

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../core";
+import { APIResource } from "../resource";
+
+export class Blobs extends APIResource {
+  /**
+   * Delete a blob
+   */
+  delete(key: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/blob/${key}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Store data in blob storage
+   */
+  store(key: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post(`/v1/blob/${key}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}