@helmr/sdk 0.1.1-rc.5 → 0.1.1-rc.6

package/README.md

@@ -22,7 +22,7 @@ Schemes such as `env:` and `file:` are local runner sources and are rejected for
 External TypeScript processes create runs with `task.trigger()` or the id-based `client.tasks.trigger()`. Triggering returns a lightweight `RunHandle`; retrieve or wait on that handle to get a `RunSnapshot`.
 
 ```ts
-import { HelmrClient, workspace } from "@helmr/sdk"
+import { HelmrClient } from "@helmr/sdk"
 import { impl } from "./tasks/impl"
 
 const client = new HelmrClient({
@@ -33,9 +33,6 @@ const client = new HelmrClient({
 const handle = await client.tasks.trigger<typeof impl>(
   "impl",
   { issue: 123 },
-  {
-    workspace: workspace.github("OWNER/REPO", { ref: "main", subpath: "tasks" }),
-  },
 )
 
 const current = await client.runs.retrieve(handle)

package/dist/compile.js

@@ -27,7 +27,6 @@ import {
   SourceFileRefSchema,
   TaskSpecSchema,
   TaskScheduleSpecSchema,
-  TaskScheduleWorkspaceSpecSchema,
   UserSchema,
   WorkdirSchema,
   WorkspaceRuntimeBindingSchema
@@ -124,7 +123,8 @@ function compile(opts) {
     ...resources ? {
       resources: create(ResourcesSchema, {
         ...resources.cpu === undefined ? {} : { cpu: resources.cpu },
-        ...resources.memory === undefined ? {} : { memory: resources.memory }
+        ...resources.memory === undefined ? {} : { memory: resources.memory },
+        ...resources.disk === undefined ? {} : { disk: resources.disk }
       })
     } : {}
   });
@@ -160,11 +160,6 @@ function compileTaskSchedules(schedule) {
       id: "",
       cron: schedule.cron,
       timezone: schedule.timezone ?? "UTC",
-      workspace: create(TaskScheduleWorkspaceSpecSchema, {
-        repository: schedule.workspace.repository,
-        ref: schedule.workspace.ref,
-        subpath: schedule.workspace.subpath ?? ""
-      }),
       secretBindings: { ...schedule.secretBindings }
     })
   ];

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ConcurrentWaitError, validateSecretName, type CacheBuilder, type CacheMount, type CacheMountBinding, type EmitContent, type EmitEvent, type ImageBuilder, type ImageRunOptions, type NoPayload, type Placement, type SandboxBuilder, type SecretDecls, type SecretMountBinding, type SourceCapabilities, type SourceDirRef, type SourceDirectoryOptions, type SourceFileRef, type TaskContext, type TaskSource, type TaskWorkspace, type GitHubRefKind, type GitHubPullRequestMetadata, type GitHubTaskSource, type TaskOutput, type TaskPayload, type TaskTriggerPayload, type WaitCapabilities, type WaitForInput, type WaitJson, type WaitOptions, type WaitResolution, type WaitManualOptions, type WaitUntilInput, type WorkspaceCapabilities, type WorkspaceSpec } from "./internal.js";
+import { ConcurrentWaitError, validateSecretName, type CacheBuilder, type CacheMount, type CacheMountBinding, type EmitContent, type EmitEvent, type ImageBuilder, type ImageRunOptions, type NoPayload, type Placement, type SandboxBuilder, type SecretDecls, type SecretMountBinding, type SourceCapabilities, type SourceDirRef, type SourceDirectoryOptions, type SourceFileRef, type TaskContext, type TaskWorkspace, type TaskOutput, type TaskPayload, type TaskTriggerPayload, type WaitCapabilities, type WaitForInput, type WaitJson, type WaitOptions, type WaitResolution, type WaitManualOptions, type WaitUntilInput } from "./internal.js";
 import { PayloadSchemaValidationError } from "./schema/payload.js";
 import { idempotencyKeys } from "./idempotency.js";
 export type { IdempotencyKey, IdempotencyKeyCreateOptions, IdempotencyKeyInput, IdempotencyKeyScope } from "./idempotency.js";
@@ -18,7 +18,6 @@ export type { HelmrConfig, HelmrConfigInput, Placement, SecretDecls, Task, TaskC
 export declare const image: (id: string) => ImageBuilder;
 export declare const cache: (id: string) => CacheBuilder;
 export declare const source: SourceCapabilities;
-export declare const workspace: WorkspaceCapabilities;
 export { HelmrClient };
 export { validateSecretName };
 export declare const runs: {
@@ -49,4 +48,4 @@ export declare const schedules: Readonly<{
     delete: (id: string, opts?: import("./index.js").RetrieveScheduleOptions | undefined) => Promise<void>;
 }>;
 export type { ScheduleCron, ScheduledTaskConfig, ScheduledTaskPayload, };
-export type { CacheBuilder, CacheMount, CacheMountBinding, EmitContent, EmitEvent, ImageBuilder, ImageRunOptions, SandboxBuilder, SecretMountBinding, SourceCapabilities, SourceDirRef, SourceDirectoryOptions, SourceFileRef, WorkspaceCapabilities, WorkspaceSpec, TaskContext, TaskSource, TaskWorkspace, GitHubRefKind, GitHubPullRequestMetadata, GitHubTaskSource, };
+export type { CacheBuilder, CacheMount, CacheMountBinding, EmitContent, EmitEvent, ImageBuilder, ImageRunOptions, SandboxBuilder, SecretMountBinding, SourceCapabilities, SourceDirRef, SourceDirectoryOptions, SourceFileRef, TaskContext, TaskWorkspace, };

package/dist/index.js

@@ -304,9 +304,6 @@ function validateTaskSchedule(taskId, value) {
   if (value.timezone !== undefined && value.timezone.trim() === "") {
     throw new Error(`task ${JSON.stringify(taskId)} schedule timezone must not be empty`);
   }
-  if (value.workspace.kind !== "github") {
-    throw new Error(`task ${JSON.stringify(taskId)} schedule workspace must be workspace.github(...)`);
-  }
   if (value.secretBindings !== undefined) {
     if (value.secretBindings === null || typeof value.secretBindings !== "object" || Array.isArray(value.secretBindings)) {
       throw new Error(`task ${JSON.stringify(taskId)} schedule secretBindings must be an object`);
@@ -501,7 +498,8 @@ class SandboxBuilderImpl {
   resources(opts) {
     const resourceSpec = {
       ...opts.cpu === undefined ? {} : { cpu: opts.cpu },
-      ...opts.memory === undefined ? {} : { memory: opts.memory }
+      ...opts.memory === undefined ? {} : { memory: opts.memory },
+      ...opts.disk === undefined ? {} : { disk: opts.disk }
     };
     return new SandboxBuilderImpl(this.id, this.imageBuilder, this.workspaceBinding, resourceSpec);
   }
@@ -674,15 +672,6 @@ function runStatus(status) {
   }
 }
 
-// sdk/typescript/src/runtime/source.ts
-function runWorkspaceFromSpec(spec) {
-  return {
-    repository: spec.repository,
-    ref: spec.ref,
-    ...spec.subpath === undefined ? {} : { subpath: spec.subpath }
-  };
-}
-
 // sdk/typescript/src/runtime/client.ts
 var MAX_SSE_BUFFER_CHARS = 1024 * 1024;
 var triggerTaskClientMethod = Symbol.for("helmr.sdk.client.triggerTask");
@@ -744,7 +733,6 @@ class HelmrClient {
     return await this.#triggerRun(task.id, payload, opts, readOptionalMaxDurationSeconds(task.maxDuration));
   }
   async#triggerRun(taskId, payload, opts, maxDurationSeconds) {
-    const runWorkspace = runWorkspaceFromSpec(opts.workspace);
     const runOptions = {
       ...opts.deploymentId === undefined ? {} : { deployment_id: opts.deploymentId },
       ...opts.version === undefined ? {} : { version: opts.version },
@@ -761,7 +749,6 @@ class HelmrClient {
         task_id: taskId,
         secrets: opts.secrets ?? {},
         ...payload === undefined ? {} : { payload },
-        workspace: runWorkspace,
         ...Object.keys(runOptions).length === 0 ? {} : { options: runOptions }
       }),
       headers: { "content-type": "application/json" }
@@ -1032,7 +1019,6 @@ function scheduleCreateBody(opts) {
     cron: opts.cron,
     ...opts.timezone === undefined ? {} : { timezone: opts.timezone },
     ...opts.active === undefined ? {} : { active: opts.active },
-    workspace: runWorkspaceFromSpec(opts.workspace),
     ...opts.secretBindings === undefined ? {} : { secret_bindings: opts.secretBindings },
     ...opts.options === undefined ? {} : { options: runOptionsBody(opts.options) }
   };
@@ -1072,7 +1058,6 @@ function scheduleFromResponse(response) {
     active: response.active,
     status: response.status,
     ...response.last_error === undefined || response.last_error === "" ? {} : { lastError: response.last_error },
-    ..."workspace" in response ? { workspace: response.workspace } : {},
     ...response.next_scheduled_at === undefined ? {} : { nextScheduledAt: response.next_scheduled_at },
     ...response.last_scheduled_at === undefined ? {} : { lastScheduledAt: response.last_scheduled_at },
     createdAt: response.created_at,
@@ -1483,15 +1468,10 @@ function queue(config) {
 
 // sdk/typescript/src/schedules.ts
 function task2(config) {
-  const { cron, workspace, secretBindings, ...taskConfig } = config;
-  const taskId = config.id;
-  if (cron !== undefined && workspace === undefined) {
-    throw new Error(`task ${JSON.stringify(taskId)} schedule workspace is required`);
-  }
+  const { cron, secretBindings, ...taskConfig } = config;
   const schedule = cron === undefined ? undefined : {
     cron: typeof cron === "string" ? cron : cron.pattern,
     ...typeof cron === "string" || cron.timezone === undefined ? {} : { timezone: cron.timezone },
-    workspace,
     ...secretBindings === undefined ? {} : { secretBindings }
   };
   const marked = markScheduledTask({ ...taskConfig, payload: scheduledTaskPayloadSchema }, schedule);
@@ -1568,27 +1548,6 @@ var source = {
     return new SourceDirRefImpl(path, opts?.ignore ? [...opts.ignore] : []);
   }
 };
-var workspace = {
-  github(repo, opts) {
-    const [org, name, extra] = repo.split("/");
-    if (!org || !name || extra !== undefined) {
-      throw new Error('workspace.github() repo must be "org/repo"');
-    }
-    const ref = opts.ref.trim();
-    if (!ref) {
-      throw new Error("workspace.github() ref is required");
-    }
-    if (ref.includes("\x00")) {
-      throw new Error("workspace.github() ref must not contain NUL");
-    }
-    return {
-      kind: "github",
-      repository: repo,
-      ref,
-      ...opts.subpath === undefined ? {} : { subpath: opts.subpath }
-    };
-  }
-};
 var runs = new Proxy({}, {
   get(_target, property, receiver) {
     return Reflect.get(getDefaultClient().runs, property, receiver);
@@ -1610,7 +1569,6 @@ var schedules = Object.freeze({
   delete: (...args) => getDefaultClient().schedules.delete(...args)
 });
 export {
-  workspace,
   waitpoints,
   validateSecretName,
   tasks,

package/dist/internal.d.ts

@@ -17,33 +17,6 @@ export interface SecretMountBinding {
 export interface SourceDirectoryOptions {
     readonly ignore?: readonly string[];
 }
-export interface WorkspaceSpec {
-    readonly kind: "github";
-    readonly repository: string;
-    readonly ref: string;
-    readonly subpath?: string;
-}
-export type GitHubRefKind = "branch" | "tag" | "sha" | "pull_request" | "unknown";
-export interface GitHubPullRequestMetadata {
-    readonly number: number;
-    readonly baseRef: string;
-    readonly baseSha: string;
-    readonly headRef: string;
-    readonly headSha: string;
-}
-export interface GitHubTaskSource {
-    readonly kind: "github";
-    readonly repository: string;
-    readonly requestedRef: string;
-    readonly resolvedSha: string;
-    readonly refKind?: GitHubRefKind;
-    readonly refName?: string;
-    readonly fullRef?: string;
-    readonly subpath?: string;
-    readonly defaultBranch?: string;
-    readonly pullRequest?: GitHubPullRequestMetadata;
-}
-export type TaskSource = GitHubTaskSource;
 export interface TaskWorkspace {
     readonly path: string;
     readonly projectPath: string;
@@ -59,12 +32,6 @@ export interface SourceCapabilities {
     file(path: string): SourceFileRef;
     directory(path: string, opts?: SourceDirectoryOptions): SourceDirRef;
 }
-export interface WorkspaceCapabilities {
-    github(repo: string, opts: {
-        readonly ref: string;
-        readonly subpath?: string;
-    }): WorkspaceSpec;
-}
 export type WaitJson = null | boolean | number | string | readonly WaitJson[] | {
     readonly [key: string]: WaitJson;
 };
@@ -130,7 +97,6 @@ export interface TaskContext {
     readonly task: {
         readonly id: string;
     };
-    readonly source: TaskSource;
     readonly workspace: TaskWorkspace;
 }
 export type EmitContent = {
@@ -177,10 +143,8 @@ export interface InternalTaskScheduleConfig {
     readonly cron: string;
     readonly timezone?: string;
     readonly secretBindings?: Record<string, string>;
-    readonly workspace: WorkspaceSpec;
 }
 export type TaskRunOptions<TSecrets extends SecretDecls> = {
-    readonly workspace: WorkspaceSpec;
     readonly deploymentId?: string;
     readonly version?: string;
     readonly queue?: string;
@@ -272,6 +236,7 @@ export interface SandboxBuilder {
     resources(opts: {
         readonly cpu?: number;
         readonly memory?: string;
+        readonly disk?: string;
     }): SandboxBuilder;
 }
 export type ImageBuildStep = {
@@ -308,6 +273,7 @@ export interface SandboxWorkspace {
 export interface SandboxResources {
     readonly cpu?: number;
     readonly memory?: string;
+    readonly disk?: string;
 }
 export type MarkedTask<TPayload, TOutput, TSecrets extends SecretDecls, TPayloadSchema extends PayloadSchema<any, any> | undefined> = TPayloadSchema extends PayloadSchema<any, any> ? Task<PayloadSchemaOutput<TPayloadSchema>, Awaited<TOutput>, TSecrets, PayloadSchemaInput<TPayloadSchema>> : Task<NoPayload, Awaited<TOutput>, TSecrets, NoPayload>;
 export declare function markTask<TPayload, TOutput, TSecrets extends SecretDecls, TPayloadSchema extends PayloadSchema<any, any> | undefined>(config: TaskConfig<TPayload, TOutput, TSecrets, TPayloadSchema>): MarkedTask<TPayload, TOutput, TSecrets, TPayloadSchema>;
@@ -353,6 +319,7 @@ export declare class SandboxBuilderImpl implements SandboxBuilder {
     resources(opts: {
         readonly cpu?: number;
         readonly memory?: string;
+        readonly disk?: string;
     }): SandboxBuilder;
 }
 export declare class SourceFileRefImpl implements SourceFileRef {

package/dist/internal.js

@@ -304,9 +304,6 @@ function validateTaskSchedule(taskId, value) {
   if (value.timezone !== undefined && value.timezone.trim() === "") {
     throw new Error(`task ${JSON.stringify(taskId)} schedule timezone must not be empty`);
   }
-  if (value.workspace.kind !== "github") {
-    throw new Error(`task ${JSON.stringify(taskId)} schedule workspace must be workspace.github(...)`);
-  }
   if (value.secretBindings !== undefined) {
     if (value.secretBindings === null || typeof value.secretBindings !== "object" || Array.isArray(value.secretBindings)) {
       throw new Error(`task ${JSON.stringify(taskId)} schedule secretBindings must be an object`);
@@ -517,7 +514,8 @@ class SandboxBuilderImpl {
   resources(opts) {
     const resourceSpec = {
       ...opts.cpu === undefined ? {} : { cpu: opts.cpu },
-      ...opts.memory === undefined ? {} : { memory: opts.memory }
+      ...opts.memory === undefined ? {} : { memory: opts.memory },
+      ...opts.disk === undefined ? {} : { disk: opts.disk }
     };
     return new SandboxBuilderImpl(this.id, this.imageBuilder, this.workspaceBinding, resourceSpec);
   }

package/dist/runtime/client.d.ts

@@ -1,4 +1,4 @@
-import { type AnyTask, type NoPayload, type SecretDecls, type TaskOutput, type TaskRunOptions, type TaskSecrets, type TaskTriggerPayload, type WorkspaceSpec } from "../internal.js";
+import { type AnyTask, type NoPayload, type SecretDecls, type TaskOutput, type TaskRunOptions, type TaskSecrets, type TaskTriggerPayload } from "../internal.js";
 import { type LogSnapshot, type ListRunEventsOptions, type ListRunsOptions, type PendingManualWaitpoint, type PendingWaitpointResponse, type RetrieveRunOptions, type RunHandle, type RunEvent, type RunSnapshot, type RunSummary, type RunWaitOptions, type SubscribeRunEventsOptions, type WaitpointRespondOptions, type WaitpointRef } from "./run.js";
 export interface HelmrClientOptions {
     readonly url?: string;
@@ -47,7 +47,6 @@ export interface ScheduleCreateOptions {
     readonly cron: string;
     readonly timezone?: string;
     readonly active?: boolean;
-    readonly workspace: WorkspaceSpec;
     readonly secretBindings?: Record<string, string>;
     readonly options?: ScheduleRunOptions;
 }
@@ -63,12 +62,6 @@ export interface ScheduleRunOptions {
     readonly ttl?: string;
     readonly maxDurationSeconds?: number;
 }
-export interface ScheduleWorkspace {
-    readonly repository?: string;
-    readonly ref?: string;
-    readonly sha?: string;
-    readonly subpath?: string;
-}
 export interface ListSchedulesOptions {
     readonly projectId?: string;
     readonly environmentId?: string;
@@ -92,7 +85,6 @@ export interface Schedule {
     readonly active: boolean;
     readonly status: "active" | "inactive" | "errored";
     readonly lastError?: string;
-    readonly workspace?: ScheduleWorkspace;
     readonly nextScheduledAt?: string;
     readonly lastScheduledAt?: string;
     readonly createdAt: string;

package/dist/schedules.d.ts

@@ -1,4 +1,4 @@
-import { type MarkedTask, type MaybePromise, type SecretDecls, type TaskContext, type TaskConfigBase, type WorkspaceSpec } from "./internal.js";
+import { type MarkedTask, type MaybePromise, type SecretDecls, type TaskContext, type TaskConfigBase } from "./internal.js";
 import type { PayloadSchema } from "./schema/payload.js";
 export interface ScheduledTaskPayload {
     readonly timestamp: Date;
@@ -14,11 +14,9 @@ export type ScheduleCron = string | {
 };
 type DeclarativeScheduleFields = {
     readonly cron: ScheduleCron;
-    readonly workspace: WorkspaceSpec;
     readonly secretBindings?: Record<string, string>;
 } | {
     readonly cron?: undefined;
-    readonly workspace?: undefined;
     readonly secretBindings?: undefined;
 };
 export type ScheduledTaskConfig<TOutput = unknown, TSecrets extends SecretDecls = Record<never, never>> = Omit<TaskConfigBase<TSecrets>, "payload"> & DeclarativeScheduleFields & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helmr/sdk",
-  "version": "0.1.1-rc.5",
+  "version": "0.1.1-rc.6",
   "description": "TypeScript SDK for authoring and triggering Helmr tasks.",
   "type": "module",
   "license": "Apache-2.0",
@@ -43,6 +43,6 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "^2.11.0",
-    "@helmr/proto": "0.1.1-rc.5"
+    "@helmr/proto": "0.1.1-rc.6"
   }
 }

package/dist/runtime/source.d.ts

@@ -1,7 +0,0 @@
-import type { WorkspaceSpec } from "../internal.js";
-export type RunWorkspace = {
-    readonly repository: string;
-    readonly ref: string;
-    readonly subpath?: string;
-};
-export declare function runWorkspaceFromSpec(spec: WorkspaceSpec): RunWorkspace;