@valtown/sdk 0.1.0-alpha.1

package/src/resources/users/users.ts

@@ -0,0 +1,24 @@
+// 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 ValsAPI from "./vals";
+
+export class Users extends APIResource {
+  vals: ValsAPI.Vals = new ValsAPI.Vals(this._client);
+
+  /**
+   * Get basic information about a user
+   */
+  retrieve(userId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.User> {
+    return this._client.get(`/v1/users/${userId}`, options);
+  }
+}
+
+export namespace Users {
+  export import Vals = ValsAPI.Vals;
+  export import ValListResponse = ValsAPI.ValListResponse;
+  export import ValListResponsesPageCursorURL = ValsAPI.ValListResponsesPageCursorURL;
+  export import ValListParams = ValsAPI.ValListParams;
+}

package/src/resources/users/vals.ts

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as ValsAPI from "./vals";
+import { PageCursorURL, type PageCursorURLParams } from "../../pagination";
+
+export class Vals extends APIResource {
+  /**
+   * List a user's vals
+   */
+  list(
+    userId: string,
+    query: ValListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ValListResponsesPageCursorURL, ValListResponse> {
+    return this._client.getAPIList(`/v1/users/${userId}/vals`, ValListResponsesPageCursorURL, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class ValListResponsesPageCursorURL extends PageCursorURL<ValListResponse> {}
+
+/**
+ * A Val
+ */
+export interface ValListResponse {
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: ValListResponse.Author | null;
+
+  code: string | null;
+
+  createdAt: string;
+
+  name: string;
+
+  privacy: 'public' | 'unlisted' | 'private';
+
+  public: boolean;
+
+  type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc';
+
+  version: number;
+}
+
+export namespace ValListResponse {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+export interface ValListParams extends PageCursorURLParams {}
+
+export namespace Vals {
+  export import ValListResponse = ValsAPI.ValListResponse;
+  export import ValListResponsesPageCursorURL = ValsAPI.ValListResponsesPageCursorURL;
+  export import ValListParams = ValsAPI.ValListParams;
+}

package/src/resources/vals/index.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ValCreateResponse,
+  ValRetrieveResponse,
+  ValRunAnonymousResponse,
+  ValCreateParams,
+  ValUpdateParams,
+  ValCreateOrUpdateParams,
+  ValRunParams,
+  ValRunAnonymousParams,
+  ValRunGetParams,
+  Vals,
+} from './vals';
+export {
+  VersionCreateResponse,
+  VersionRetrieveResponse,
+  VersionListResponse,
+  VersionCreateParams,
+  VersionRetrieveParams,
+  VersionListParams,
+  VersionListResponsesPageCursorURL,
+  Versions,
+} from './versions';

package/src/resources/vals/vals.ts

@@ -0,0 +1,267 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as ValsAPI from "./vals";
+import * as VersionsAPI from "./versions";
+
+export class Vals extends APIResource {
+  versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
+
+  /**
+   * Create a new val
+   */
+  create(body: ValCreateParams, options?: Core.RequestOptions): Core.APIPromise<ValCreateResponse> {
+    return this._client.post('/v1/vals/', { body, ...options });
+  }
+
+  /**
+   * Get a val by id
+   */
+  retrieve(valId: string, options?: Core.RequestOptions): Core.APIPromise<ValRetrieveResponse> {
+    return this._client.get(`/v1/vals/${valId}`, options);
+  }
+
+  /**
+   * Update an existing val
+   */
+  update(valId: string, body?: ValUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+  update(valId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+  update(
+    valId: string,
+    body: ValUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    if (isRequestOptions(body)) {
+      return this.update(valId, {}, body);
+    }
+    return this._client.put(`/v1/vals/${valId}`, {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Delete a val
+   */
+  delete(valId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/vals/${valId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Run an existing val or create a new one
+   */
+  createOrUpdate(body: ValCreateOrUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.put('/v1/vals/', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Run a val, with arguments in the request body
+   */
+  run(valname: string, body?: ValRunParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+  run(valname: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+  run(
+    valname: string,
+    body: ValRunParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    if (isRequestOptions(body)) {
+      return this.run(valname, {}, body);
+    }
+    return this._client.post(`/v1/run/${valname}`, {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Run JavaScript or TypeScript without saving it permanently as a val
+   */
+  runAnonymous(
+    body: ValRunAnonymousParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ValRunAnonymousResponse | null> {
+    return this._client.post('/v1/eval/', { body, ...options });
+  }
+
+  /**
+   * Run a val, specify any parameters in a querystring
+   */
+  runGet(valname: string, query?: ValRunGetParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+  runGet(valname: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+  runGet(
+    valname: string,
+    query: ValRunGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    if (isRequestOptions(query)) {
+      return this.runGet(valname, {}, query);
+    }
+    return this._client.get(`/v1/run/${valname}`, {
+      query,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+/**
+ * A Val
+ */
+export interface ValCreateResponse {
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: ValCreateResponse.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 ValCreateResponse {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+/**
+ * A Val
+ */
+export interface ValRetrieveResponse {
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: ValRetrieveResponse.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 ValRetrieveResponse {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+export type ValRunAnonymousResponse = string | number | Record<string, unknown> | Array<unknown> | boolean;
+
+export interface ValCreateParams {
+  code: string;
+
+  name?: string;
+
+  privacy?: 'public' | 'unlisted' | 'private';
+
+  readme?: string;
+
+  type?: 'http' | 'script' | 'email';
+}
+
+export interface ValUpdateParams {
+  name?: string;
+
+  privacy?: 'public' | 'unlisted' | 'private';
+
+  readme?: string;
+}
+
+export interface ValCreateOrUpdateParams {
+  code: string;
+
+  name: string;
+}
+
+export interface ValRunParams {
+  args?: Array<unknown>;
+}
+
+export interface ValRunAnonymousParams {
+  /**
+   * TypeScript source code
+   */
+  code: string;
+
+  args?: Array<unknown>;
+}
+
+export interface ValRunGetParams {
+  args?: string;
+}
+
+export namespace Vals {
+  export import ValCreateResponse = ValsAPI.ValCreateResponse;
+  export import ValRetrieveResponse = ValsAPI.ValRetrieveResponse;
+  export import ValRunAnonymousResponse = ValsAPI.ValRunAnonymousResponse;
+  export import ValCreateParams = ValsAPI.ValCreateParams;
+  export import ValUpdateParams = ValsAPI.ValUpdateParams;
+  export import ValCreateOrUpdateParams = ValsAPI.ValCreateOrUpdateParams;
+  export import ValRunParams = ValsAPI.ValRunParams;
+  export import ValRunAnonymousParams = ValsAPI.ValRunAnonymousParams;
+  export import ValRunGetParams = ValsAPI.ValRunGetParams;
+  export import Versions = VersionsAPI.Versions;
+  export import VersionCreateResponse = VersionsAPI.VersionCreateResponse;
+  export import VersionRetrieveResponse = VersionsAPI.VersionRetrieveResponse;
+  export import VersionListResponse = VersionsAPI.VersionListResponse;
+  export import VersionListResponsesPageCursorURL = VersionsAPI.VersionListResponsesPageCursorURL;
+  export import VersionCreateParams = VersionsAPI.VersionCreateParams;
+  export import VersionRetrieveParams = VersionsAPI.VersionRetrieveParams;
+  export import VersionListParams = VersionsAPI.VersionListParams;
+}

package/src/resources/vals/versions.ts

@@ -0,0 +1,181 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as VersionsAPI from "./versions";
+import { PageCursorURL, type PageCursorURLParams } from "../../pagination";
+
+export class Versions extends APIResource {
+  /**
+   * Create a new version of a val
+   */
+  create(
+    valId: string,
+    body: VersionCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VersionCreateResponse> {
+    return this._client.post(`/v1/vals/${valId}/versions`, { body, ...options });
+  }
+
+  /**
+   * Get a specific version of a val
+   */
+  retrieve(
+    valId: string,
+    version: number,
+    query: VersionRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VersionRetrieveResponse> {
+    return this._client.get(`/v1/vals/${valId}/versions/${version}`, { query, ...options });
+  }
+
+  /**
+   * List versions of a val
+   */
+  list(
+    valId: string,
+    query: VersionListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VersionListResponsesPageCursorURL, VersionListResponse> {
+    return this._client.getAPIList(`/v1/vals/${valId}/versions`, VersionListResponsesPageCursorURL, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a specific version of a val
+   */
+  delete(valId: string, version: number, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/vals/${valId}/versions/${version}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export class VersionListResponsesPageCursorURL extends PageCursorURL<VersionListResponse> {}
+
+/**
+ * A Val
+ */
+export interface VersionCreateResponse {
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: VersionCreateResponse.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 VersionCreateResponse {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+/**
+ * A Val
+ */
+export interface VersionRetrieveResponse {
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: VersionRetrieveResponse.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 VersionRetrieveResponse {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+export interface VersionListResponse {
+  createdAt: string;
+
+  val_id: string;
+
+  version: number;
+}
+
+export interface VersionCreateParams {
+  code: string;
+
+  name?: string;
+
+  privacy?: 'public' | 'unlisted' | 'private';
+
+  readme?: string;
+
+  type?: 'http' | 'script' | 'email';
+}
+
+export interface VersionRetrieveParams {
+  limit: number;
+
+  offset: number;
+}
+
+export interface VersionListParams extends PageCursorURLParams {}
+
+export namespace Versions {
+  export import VersionCreateResponse = VersionsAPI.VersionCreateResponse;
+  export import VersionRetrieveResponse = VersionsAPI.VersionRetrieveResponse;
+  export import VersionListResponse = VersionsAPI.VersionListResponse;
+  export import VersionListResponsesPageCursorURL = VersionsAPI.VersionListResponsesPageCursorURL;
+  export import VersionCreateParams = VersionsAPI.VersionCreateParams;
+  export import VersionRetrieveParams = VersionsAPI.VersionRetrieveParams;
+  export import VersionListParams = VersionsAPI.VersionListParams;
+}

package/src/shims/node.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/node-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/node-runtime';
+setShims(getRuntime());
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}

package/src/shims/web.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/web-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/web-runtime';
+setShims(getRuntime({ manuallyImported: true }));
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["DOM"],
+    "moduleResolution": "node"
+  }
+}