@transloadit/node 4.1.3

package/src/apiTypes.ts

@@ -0,0 +1,154 @@
+import type { AssemblyInstructions, AssemblyInstructionsInput } from './alphalib/types/template.ts'
+
+export {
+  type AssemblyIndexItem,
+  assemblyIndexItemSchema,
+  assemblyStatusSchema,
+} from './alphalib/types/assemblyStatus.ts'
+export type { AssemblyInstructions, AssemblyInstructionsInput } from './alphalib/types/template.ts'
+export { assemblyInstructionsSchema } from './alphalib/types/template.ts'
+
+export interface OptionalAuthParams {
+  auth?: { key?: string; expires?: string }
+}
+
+// todo make zod schemas for these types in the backend for these too (in alphalib?)
+// currently the types are not entirely correct, and probably lacking some props
+
+export interface BaseResponse {
+  // todo are these always there? maybe sometimes missing or null
+  ok: string // todo should we type the different possible `ok` responses?
+  message: string
+}
+
+export interface PaginationList<T> {
+  items: T[]
+}
+
+export interface PaginationListWithCount<T> extends PaginationList<T> {
+  count: number
+}
+
+// `auth` is not required in the JS API because it can be specified in the constructor,
+// and it will then be auto-added before the request
+export type CreateAssemblyParams = Omit<AssemblyInstructionsInput, 'auth'> & OptionalAuthParams
+
+export type ListAssembliesParams = OptionalAuthParams & {
+  page?: number
+  pagesize?: number
+  type?: 'all' | 'uploading' | 'executing' | 'canceled' | 'completed' | 'failed' | 'request_aborted'
+  fromdate?: string
+  todate?: string
+  keywords?: string[]
+}
+
+export type ReplayAssemblyParams = Pick<
+  CreateAssemblyParams,
+  'auth' | 'template_id' | 'notify_url' | 'fields' | 'steps'
+> & {
+  reparse_template?: number
+}
+
+export interface ReplayAssemblyResponse extends BaseResponse {
+  success: boolean
+  assembly_id: string
+  assembly_url: string
+  assembly_ssl_url: string
+  notify_url?: string
+}
+
+export type ReplayAssemblyNotificationParams = OptionalAuthParams & {
+  notify_url?: string
+  wait?: boolean
+}
+
+export interface ReplayAssemblyNotificationResponse {
+  ok: string
+  success: boolean
+  notification_id: string
+}
+
+export type TemplateContent = Pick<
+  CreateAssemblyParams,
+  'allow_steps_override' | 'steps' | 'auth' | 'notify_url'
+>
+
+export type ResponseTemplateContent = Pick<
+  AssemblyInstructions,
+  'allow_steps_override' | 'steps' | 'auth' | 'notify_url'
+>
+
+export type CreateTemplateParams = OptionalAuthParams & {
+  name: string
+  template: TemplateContent
+  require_signature_auth?: number
+}
+
+export type EditTemplateParams = OptionalAuthParams & {
+  name?: string
+  template?: TemplateContent
+  require_signature_auth?: number
+}
+
+export type ListTemplatesParams = OptionalAuthParams & {
+  page?: number
+  pagesize?: number
+  sort?: 'id' | 'name' | 'created' | 'modified'
+  order?: 'desc' | 'asc'
+  fromdate?: string
+  todate?: string
+  keywords?: string[]
+}
+
+interface TemplateResponseBase {
+  id: string
+  name: string
+  content: ResponseTemplateContent
+  require_signature_auth: number
+}
+
+export interface ListedTemplate extends TemplateResponseBase {
+  encryption_version: number
+  last_used?: string
+  created: string
+  modified: string
+}
+
+export interface TemplateResponse extends TemplateResponseBase, BaseResponse {}
+
+// todo type this according to api2 valid values for better dx?
+export type TemplateCredentialContent = Record<string, string>
+
+export type CreateTemplateCredentialParams = OptionalAuthParams & {
+  name: string
+  type: string
+  content: TemplateCredentialContent
+}
+
+export type ListTemplateCredentialsParams = OptionalAuthParams & {
+  page?: number
+  sort?: string
+  order: 'asc' | 'desc'
+}
+
+// todo
+export interface TemplateCredential {
+  id: string
+  name: string
+  type: string
+  content: TemplateCredentialContent
+  account_id?: string
+  created?: string
+  modified?: string
+  stringified?: string
+}
+
+export interface TemplateCredentialResponse extends BaseResponse {
+  credential: TemplateCredential
+}
+
+export interface TemplateCredentialsResponse extends BaseResponse {
+  credentials: TemplateCredential[]
+}
+
+export type BillResponse = unknown // todo

package/src/cli/OutputCtl.ts

@@ -0,0 +1,115 @@
+/**
+ * Log levels following syslog severity (https://en.wikipedia.org/wiki/Syslog#Severity_level)
+ * Lower numbers = more severe, higher numbers = more verbose
+ */
+const LOG_LEVEL = {
+  ERR: 3, // Error conditions
+  WARN: 4, // Warning conditions
+  NOTICE: 5, // Normal but significant (default)
+  INFO: 6, // Informational
+  DEBUG: 7, // Debug-level messages
+  TRACE: 8, // Most verbose/detailed
+} as const
+
+export type LogLevelName = keyof typeof LOG_LEVEL
+export type LogLevelValue = (typeof LOG_LEVEL)[LogLevelName]
+
+export const LOG_LEVEL_DEFAULT: LogLevelValue = LOG_LEVEL.NOTICE
+
+/** Valid log level names for CLI parsing */
+export const LOG_LEVEL_NAMES = Object.keys(LOG_LEVEL).map((k) =>
+  k.toLowerCase(),
+) as Lowercase<LogLevelName>[]
+
+/** Valid numeric log level values */
+const LOG_LEVEL_VALUES = new Set(Object.values(LOG_LEVEL))
+
+/** Parse a log level string (name or number) to its numeric value */
+export function parseLogLevel(level: string): LogLevelValue {
+  // Try parsing as number first
+  const num = Number(level)
+  if (!Number.isNaN(num)) {
+    if (LOG_LEVEL_VALUES.has(num as LogLevelValue)) {
+      return num as LogLevelValue
+    }
+    throw new Error(
+      `Invalid log level: ${level}. Valid values: ${[...LOG_LEVEL_VALUES].join(', ')} or ${LOG_LEVEL_NAMES.join(', ')}`,
+    )
+  }
+
+  // Try as level name
+  const upper = level.toUpperCase() as LogLevelName
+  if (upper in LOG_LEVEL) {
+    return LOG_LEVEL[upper]
+  }
+  throw new Error(
+    `Invalid log level: ${level}. Valid levels: ${LOG_LEVEL_NAMES.join(', ')} or ${[...LOG_LEVEL_VALUES].join(', ')}`,
+  )
+}
+
+export interface OutputCtlOptions {
+  logLevel?: LogLevelValue
+  jsonMode?: boolean
+}
+
+/** Interface for output controllers (used to allow test mocks) */
+export interface IOutputCtl {
+  error(msg: unknown): void
+  warn(msg: unknown): void
+  notice(msg: unknown): void
+  info(msg: unknown): void
+  debug(msg: unknown): void
+  trace(msg: unknown): void
+  print(simple: unknown, json: unknown): void
+}
+
+export default class OutputCtl implements IOutputCtl {
+  private json: boolean
+  private logLevel: LogLevelValue
+
+  constructor({ logLevel = LOG_LEVEL_DEFAULT, jsonMode = false }: OutputCtlOptions = {}) {
+    this.json = jsonMode
+    this.logLevel = logLevel
+
+    process.stdout.on('error', (err: NodeJS.ErrnoException) => {
+      if (err.code === 'EPIPE') {
+        process.exitCode = 0
+      }
+    })
+    process.stderr.on('error', (err: NodeJS.ErrnoException) => {
+      if (err.code === 'EPIPE') {
+        process.exitCode = 0
+      }
+    })
+  }
+
+  error(msg: unknown): void {
+    if (this.logLevel >= LOG_LEVEL.ERR) console.error('err    ', msg)
+  }
+
+  warn(msg: unknown): void {
+    if (this.logLevel >= LOG_LEVEL.WARN) console.error('warn   ', msg)
+  }
+
+  notice(msg: unknown): void {
+    if (this.logLevel >= LOG_LEVEL.NOTICE) console.error('notice ', msg)
+  }
+
+  info(msg: unknown): void {
+    if (this.logLevel >= LOG_LEVEL.INFO) console.error('info   ', msg)
+  }
+
+  debug(msg: unknown): void {
+    if (this.logLevel >= LOG_LEVEL.DEBUG) console.error('debug  ', msg)
+  }
+
+  trace(msg: unknown): void {
+    if (this.logLevel >= LOG_LEVEL.TRACE) console.error('trace  ', msg)
+  }
+
+  print(simple: unknown, json: unknown): void {
+    if (this.json) console.log(JSON.stringify(json))
+    else if (typeof simple === 'string') console.log(simple)
+    else console.dir(simple, { depth: null })
+  }
+}

package/src/cli/commands/BaseCommand.ts

@@ -0,0 +1,71 @@
+import 'dotenv/config'
+import process from 'node:process'
+import { Command, Option } from 'clipanion'
+import { Transloadit as TransloaditClient } from '../../Transloadit.ts'
+import { getEnvCredentials } from '../helpers.ts'
+import type { IOutputCtl } from '../OutputCtl.ts'
+import OutputCtl, { LOG_LEVEL_DEFAULT, LOG_LEVEL_NAMES, parseLogLevel } from '../OutputCtl.ts'
+
+abstract class BaseCommand extends Command {
+  logLevelOption = Option.String('-l,--log-level', {
+    description: `Log level: ${LOG_LEVEL_NAMES.join(', ')} or 3-8 (default: notice)`,
+  })
+
+  json = Option.Boolean('-j,--json', false, {
+    description: 'Output in JSON format',
+  })
+
+  endpoint = Option.String('--endpoint', {
+    description:
+      'API endpoint URL (default: https://api2.transloadit.com, or TRANSLOADIT_ENDPOINT env var)',
+  })
+
+  protected output!: IOutputCtl
+  protected client!: TransloaditClient
+
+  protected setupOutput(): void {
+    const logLevel = this.logLevelOption ? parseLogLevel(this.logLevelOption) : LOG_LEVEL_DEFAULT
+    this.output = new OutputCtl({
+      logLevel,
+      jsonMode: this.json,
+    })
+  }
+
+  protected setupClient(): boolean {
+    const creds = getEnvCredentials()
+    if (!creds) {
+      this.output.error(
+        'Please provide API authentication in the environment variables TRANSLOADIT_KEY and TRANSLOADIT_SECRET',
+      )
+      return false
+    }
+
+    const endpoint = this.endpoint || process.env.TRANSLOADIT_ENDPOINT
+
+    this.client = new TransloaditClient({ ...creds, ...(endpoint && { endpoint }) })
+    return true
+  }
+
+  abstract override execute(): Promise<number | undefined>
+}
+
+export abstract class AuthenticatedCommand extends BaseCommand {
+  override async execute(): Promise<number | undefined> {
+    this.setupOutput()
+    if (!this.setupClient()) {
+      return 1
+    }
+    return await this.run()
+  }
+
+  protected abstract run(): Promise<number | undefined>
+}
+
+export abstract class UnauthenticatedCommand extends BaseCommand {
+  override async execute(): Promise<number | undefined> {
+    this.setupOutput()
+    return await this.run()
+  }
+
+  protected abstract run(): Promise<number | undefined>
+}