feat(initd): add basic filesystem-related functions

Author: alexisbouchez

README.md

@@ -1,103 +1 @@
-# TSDX User Guide
-
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
-
-> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
-
-> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)
-
-## Commands
-
-TSDX scaffolds your new library inside `/src`.
-
-To run TSDX, use:
-
-```bash
-npm start # or yarn start
-```
-
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
-
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle Analysis
-
-[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
-```
-
-### Rollup
-
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
-
-### TypeScript
-
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
-
-## Continuous Integration
-
-### GitHub Actions
-
-Two actions are added by default:
-
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
-
-## Optimizations
-
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
-
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
-```
-
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
-
-## Module Formats
-
-CJS, ESModules, and UMD module formats are supported.
-
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
-
-## Named Exports
-
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
-
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
-
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
-
-## Publishing to NPM
-
-We recommend using [np](https://github.com/sindresorhus/np).
+# Valyent TypeScript SDK

package.json

@@ -1,6 +1,6 @@
 {
   "version": "0.1.0",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [

src/ai/ai.ts

@@ -1,13 +1,10 @@
 import { ClientCaller } from '../client';
-import { Predictions } from './predictions';
 import { Sandboxes } from './sandboxes';
 
 export class Ai {
-  public predictions: Predictions;
   public sandboxes: Sandboxes;
 
   constructor(caller: ClientCaller) {
-    this.predictions = new Predictions(caller);
     this.sandboxes = new Sandboxes(caller);
   }
 }

src/ai/index.ts

@@ -1,3 +1,2 @@
 export * from './ai';
-export * from './predictions';
 export * from './sandboxes';

src/ai/predictions.ts

@@ -0,0 +1,140 @@
+/**
+ * Chart types
+ */
+export enum ChartType {
+  LINE = 'line',
+  SCATTER = 'scatter',
+  BAR = 'bar',
+  PIE = 'pie',
+  BOX_AND_WHISKER = 'box_and_whisker',
+  SUPERCHART = 'superchart',
+  UNKNOWN = 'unknown',
+}
+
+
+/**
+ * Ax scale types
+ */
+export enum ScaleType {
+  LINEAR = "linear",
+  DATETIME = "datetime",
+  CATEGORICAL = "categorical",
+  LOG = "log",
+  SYMLOG = "symlog",
+  LOGIT = "logit",
+  FUNCTION = "function",
+  FUNCTIONLOG = "functionlog",
+  ASINH = "asinh",
+}
+
+/**
+ * Represents a chart.
+ */
+export type Chart = {
+  type: ChartType
+  title: string
+  elements: any[]
+}
+
+type Chart2D = Chart & {
+  x_label?: string
+  y_label?: string
+  x_unit?: string
+  y_unit?: string
+}
+
+export type PointData = {
+  label: string
+  points: [number | string, number | string][]
+}
+
+type PointChart = Chart2D & {
+  x_ticks: (number | string)[]
+  x_scale: ScaleType
+  x_tick_labels: string[]
+  y_ticks: (number | string)[]
+  y_scale: ScaleType
+  y_tick_labels: string[]
+  elements: PointData[]
+}
+
+export type LineChart = PointChart & {
+  type: ChartType.LINE
+}
+
+export type ScatterChart = PointChart & {
+  type: ChartType.SCATTER
+}
+
+export type BarData = {
+  label: string
+  value: string
+  group: string
+}
+
+export type BarChart = Chart2D & {
+  type: ChartType.BAR
+  elements: BarData[]
+}
+
+export type PieData = {
+  label: string
+  angle: number
+  radius: number
+}
+
+export type PieChart = Chart & {
+  type: ChartType.PIE
+  elements: PieData[]
+}
+
+export type BoxAndWhiskerData = {
+  label: string
+  min: number
+  first_quartile: number
+  median: number
+  third_quartile: number
+  max: number
+  outliers: number[]
+}
+
+export type BoxAndWhiskerChart = Chart2D & {
+  type: ChartType.BOX_AND_WHISKER
+  elements: BoxAndWhiskerData[]
+}
+
+export type SuperChart = Chart & {
+  type: ChartType.SUPERCHART
+  elements: Chart[]
+}
+
+export type ChartTypes =
+  | LineChart
+  | ScatterChart
+  | BarChart
+  | PieChart
+  | BoxAndWhiskerChart
+  | SuperChart
+export function deserializeChart(data: any): Chart {
+  switch (data.type) {
+    case ChartType.LINE:
+      return { ...data } as LineChart
+    case ChartType.SCATTER:
+      return { ...data } as ScatterChart
+    case ChartType.BAR:
+      return { ...data } as BarChart
+    case ChartType.PIE:
+      return { ...data } as PieChart
+    case ChartType.BOX_AND_WHISKER:
+      return { ...data } as BoxAndWhiskerChart
+    case ChartType.SUPERCHART:
+      const charts = data.data.map((g: any) => deserializeChart(g))
+      delete data.data
+      return {
+        ...data,
+        data: charts,
+      } as SuperChart
+    default:
+      return { ...data, type: ChartType.UNKNOWN } as Chart
+  }
+}

src/ai/sandboxes.ts

@@ -0,0 +1,96 @@
+// This is the message for the sandbox timeout error when the response code is 502/Unavailable
+export function formatSandboxTimeoutError(message: string) {
+  return new TimeoutError(
+    `${message}: This error is likely due to sandbox timeout. You can modify the sandbox timeout by passing 'timeoutMs' when starting the sandbox or calling '.setTimeout' on the sandbox with the desired timeout.`
+  )
+}
+
+/**
+ * Base class for all sandbox errors.
+ *
+ * Thrown when general sandbox errors occur.
+ */
+export class SandboxError extends Error {
+  constructor(message: any) {
+    super(message)
+    this.name = 'SandboxError'
+  }
+}
+
+/**
+ * Thrown when a timeout error occurs.
+ *
+ * The [unavailable] error type is caused by sandbox timeout.
+ *
+ * The [canceled] error type is caused by exceeding request timeout.
+ *
+ * The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc.
+ *
+ * The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly.
+ */
+export class TimeoutError extends SandboxError {
+  constructor(message: string) {
+    super(message)
+    this.name = 'TimeoutError'
+  }
+}
+
+/**
+ * Thrown when an invalid argument is provided.
+ */
+export class InvalidArgumentError extends SandboxError {
+  constructor(message: string) {
+    super(message)
+    this.name = 'InvalidArgumentError'
+  }
+}
+
+/**
+ * Thrown when there is not enough disk space.
+ */
+export class NotEnoughSpaceError extends SandboxError {
+  constructor(message: string) {
+    super(message)
+    this.name = 'NotEnoughSpaceError'
+  }
+}
+
+/**
+ * Thrown when a resource is not found.
+ */
+export class NotFoundError extends SandboxError {
+  constructor(message: string) {
+    super(message)
+    this.name = 'NotFoundError'
+  }
+}
+
+/**
+ * Thrown when authentication fails.
+ */
+export class AuthenticationError extends SandboxError {
+  constructor(message: any) {
+    super(message)
+    this.name = 'AuthenticationError'
+  }
+}
+
+/**
+ * Thrown when the template uses old envd version. It isn't compatible with the new SDK.
+ */
+export class TemplateError extends SandboxError {
+  constructor(message: string) {
+    super(message)
+    this.name = 'TemplateError'
+  }
+}
+
+/**
+ * Thrown when the API rate limit is exceeded.
+ */
+export class RateLimitError extends SandboxError {
+  constructor(message: any) {
+    super(message)
+    this.name = 'RateLimitError'
+  }
+}