@violetbuse/rocktick 0.4.0

package/src/internal/utils/path.ts

@@ -0,0 +1,88 @@
+import { RocktickError } from '../../core/error';
+
+/**
+ * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
+ *
+ * Taken from https://datatracker.ietf.org/doc/html/rfc3986#section-3.3:
+ * > unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ * > sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+ * > pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+ */
+export function encodeURIPath(str: string) {
+  return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
+}
+
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
+export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
+  function path(statics: readonly string[], ...params: readonly unknown[]): string {
+    // If there are no params, no processing is needed.
+    if (statics.length === 1) return statics[0]!;
+
+    let postPath = false;
+    const invalidSegments = [];
+    const path = statics.reduce((previousValue, currentValue, index) => {
+      if (/[?#]/.test(currentValue)) {
+        postPath = true;
+      }
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
+    }, '');
+
+    const pathOnly = path.split(/[?#]/, 1)[0]!;
+    const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
+    let match;
+
+    // Find all invalid segments
+    while ((match = invalidSegmentPattern.exec(pathOnly)) !== null) {
+      invalidSegments.push({
+        start: match.index,
+        length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
+      });
+    }
+
+    invalidSegments.sort((a, b) => a.start - b.start);
+
+    if (invalidSegments.length > 0) {
+      let lastEnd = 0;
+      const underline = invalidSegments.reduce((acc, segment) => {
+        const spaces = ' '.repeat(segment.start - lastEnd);
+        const arrows = '^'.repeat(segment.length);
+        lastEnd = segment.start + segment.length;
+        return acc + spaces + arrows;
+      }, '');
+
+      throw new RocktickError(
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
+      );
+    }
+
+    return path;
+  };
+
+/**
+ * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
+ */
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/sleep.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

package/src/internal/utils/uuid.ts

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * https://stackoverflow.com/a/2117523
+ */
+export let uuid4 = function () {
+  const { crypto } = globalThis as any;
+  if (crypto?.randomUUID) {
+    uuid4 = crypto.randomUUID.bind(crypto);
+    return crypto.randomUUID();
+  }
+  const u8 = new Uint8Array(1);
+  const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff;
+  return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) =>
+    (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16),
+  );
+};

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { RocktickError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new RocktickError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new RocktickError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new RocktickError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new RocktickError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new RocktickError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value == null) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

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,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/cron.ts

@@ -0,0 +1,160 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as ExecutionsAPI from './executions';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Cron extends APIResource {
+  create(body: CronCreateParams, options?: RequestOptions): APIPromise<CronJob> {
+    return this._client.post('/api/cron', { body, ...options });
+  }
+
+  retrieve(jobID: string, options?: RequestOptions): APIPromise<CronJob> {
+    return this._client.get(path`/api/cron/${jobID}`, options);
+  }
+
+  update(jobID: string, body: CronUpdateParams, options?: RequestOptions): APIPromise<CronJob> {
+    return this._client.post(path`/api/cron/${jobID}`, { body, ...options });
+  }
+
+  list(
+    query: CronListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CronListResponsesCursorPage, CronListResponse> {
+    return this._client.getAPIList('/api/cron', CursorPage<CronListResponse>, { query, ...options });
+  }
+}
+
+export type CronListResponsesCursorPage = CursorPage<CronListResponse>;
+
+export interface CronJob {
+  id: string;
+
+  executions: Array<ExecutionsAPI.Execution>;
+
+  max_retries: number;
+
+  region: string;
+
+  request: CronJob.Request;
+
+  schedule: string;
+
+  max_response_bytes?: number | null;
+
+  tenant_id?: string | null;
+
+  timeout_ms?: number | null;
+}
+
+export namespace CronJob {
+  export interface Request {
+    headers: { [key: string]: string };
+
+    method: string;
+
+    url: string;
+
+    body?: string | null;
+  }
+}
+
+export interface CronListResponse {
+  id: string;
+
+  executions: Array<ExecutionsAPI.Execution>;
+
+  max_retries: number;
+
+  region: string;
+
+  request: CronListResponse.Request;
+
+  schedule: string;
+
+  max_response_bytes?: number | null;
+
+  tenant_id?: string | null;
+
+  timeout_ms?: number | null;
+}
+
+export namespace CronListResponse {
+  export interface Request {
+    headers: { [key: string]: string };
+
+    method: string;
+
+    url: string;
+
+    body?: string | null;
+  }
+}
+
+export interface CronCreateParams {
+  request: CronCreateParams.Request;
+
+  schedule: string;
+
+  max_response_bytes?: number | null;
+
+  max_retries?: number | null;
+
+  region?: string | null;
+
+  timeout_ms?: number | null;
+}
+
+export namespace CronCreateParams {
+  export interface Request {
+    headers: { [key: string]: string };
+
+    method: string;
+
+    url: string;
+
+    body?: string | null;
+  }
+}
+
+export interface CronUpdateParams {
+  max_response_bytes?: number | null;
+
+  max_retries?: number | null;
+
+  region?: string | null;
+
+  request?: CronUpdateParams.Request | null;
+
+  schedule?: string | null;
+
+  timeout_ms?: number | null;
+}
+
+export namespace CronUpdateParams {
+  export interface Request {
+    headers: { [key: string]: string };
+
+    method: string;
+
+    url: string;
+
+    body?: string | null;
+  }
+}
+
+export interface CronListParams extends CursorPageParams {}
+
+export declare namespace Cron {
+  export {
+    type CronJob as CronJob,
+    type CronListResponse as CronListResponse,
+    type CronListResponsesCursorPage as CronListResponsesCursorPage,
+    type CronCreateParams as CronCreateParams,
+    type CronUpdateParams as CronUpdateParams,
+    type CronListParams as CronListParams,
+  };
+}

package/src/resources/executions.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Executions extends APIResource {
+  retrieve(executionID: string, options?: RequestOptions): APIPromise<Execution> {
+    return this._client.get(path`/api/executions/${executionID}`, options);
+  }
+
+  list(
+    query: ExecutionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ExecutionListResponsesCursorPage, ExecutionListResponse> {
+    return this._client.getAPIList('/api/executions', CursorPage<ExecutionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type ExecutionListResponsesCursorPage = CursorPage<ExecutionListResponse>;
+
+export interface Execution {
+  id: string;
+
+  max_retries: number;
+
+  region: string;
+
+  request: Execution.Request;
+
+  scheduled_at: number;
+
+  cron_job_id?: string | null;
+
+  executed_at?: number | null;
+
+  max_response_bytes?: number | null;
+
+  one_off_job_id?: string | null;
+
+  response?: Execution.Response | null;
+
+  response_error?: string | null;
+
+  retry_for?: string | null;
+
+  success?: boolean | null;
+
+  tenant_id?: string | null;
+
+  timeout_ms?: number | null;
+}
+
+export namespace Execution {
+  export interface Request {
+    headers: { [key: string]: string };
+
+    method: string;
+
+    url: string;
+
+    body?: string | null;
+  }
+
+  export interface Response {
+    body: string;
+
+    headers: { [key: string]: string };
+
+    status: number;
+  }
+}
+
+export interface ExecutionListResponse {
+  id: string;
+
+  max_retries: number;
+
+  region: string;
+
+  request: ExecutionListResponse.Request;
+
+  scheduled_at: number;
+
+  cron_job_id?: string | null;
+
+  executed_at?: number | null;
+
+  max_response_bytes?: number | null;
+
+  one_off_job_id?: string | null;
+
+  response?: ExecutionListResponse.Response | null;
+
+  response_error?: string | null;
+
+  retry_for?: string | null;
+
+  success?: boolean | null;
+
+  tenant_id?: string | null;
+
+  timeout_ms?: number | null;
+}
+
+export namespace ExecutionListResponse {
+  export interface Request {
+    headers: { [key: string]: string };
+
+    method: string;
+
+    url: string;
+
+    body?: string | null;
+  }
+
+  export interface Response {
+    body: string;
+
+    headers: { [key: string]: string };
+
+    status: number;
+  }
+}
+
+export interface ExecutionListParams extends CursorPageParams {
+  completed?: boolean | null;
+
+  cron_id?: string | null;
+
+  from?: number | null;
+
+  one_off_job_id?: string | null;
+
+  to?: number | null;
+}
+
+export declare namespace Executions {
+  export {
+    type Execution as Execution,
+    type ExecutionListResponse as ExecutionListResponse,
+    type ExecutionListResponsesCursorPage as ExecutionListResponsesCursorPage,
+    type ExecutionListParams as ExecutionListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Cron,
+  type CronJob,
+  type CronListResponse,
+  type CronCreateParams,
+  type CronUpdateParams,
+  type CronListParams,
+  type CronListResponsesCursorPage,
+} from './cron';
+export {
+  Executions,
+  type Execution,
+  type ExecutionListResponse,
+  type ExecutionListParams,
+  type ExecutionListResponsesCursorPage,
+} from './executions';
+export {
+  Jobs,
+  type OneOffJob,
+  type JobListResponse,
+  type JobCreateParams,
+  type JobUpdateParams,
+  type JobListParams,
+  type JobListResponsesCursorPage,
+} from './jobs';
+export { Tenants, type Tenant, type TenantCreateParams, type TenantUpdateParams } from './tenants';
+export { Verify, type VerifyRetrieveResponse } from './verify';