@tapi-dev/sdk 0.1.33 → 0.1.34

package/dist/cli.js

@@ -144,22 +144,22 @@ export async function runCli(argv = process.argv.slice(2)) {
         }
         return runServiceCommand(subcommand, rest);
     }
-    if (command === "apis") {
+    if (command === "services" || command === "apis") {
         if (!subcommand || subcommand === "help" || subcommand === "--help" || subcommand === "-h" || hasHelpFlag(rest)) {
-            printApisHelp();
+            printServicesHelp();
             return 0;
         }
         if (subcommand === "describe") {
-            return describeApiOperation(rest);
+            return describeServiceOperation(rest);
         }
         if (subcommand === "sync") {
-            return syncApiCatalog(rest);
+            return syncServiceCatalog(rest);
         }
         if (subcommand === "generate") {
-            return generateApiClient(rest);
+            return generateServiceClient(rest);
         }
-        console.error(`Unknown apis command: ${subcommand}`);
-        printApisHelp();
+        console.error(`Unknown service-run command: ${subcommand}`);
+        printServicesHelp();
         return 1;
     }
     if (command === "triggers") {
@@ -367,7 +367,7 @@ export function parseStudioOptions(args) {
         workspaceMode: Boolean(projectId || workspace),
     };
 }
-function parseApiOptions(args) {
+function parseServiceOptions(args) {
     let operation = "";
     const workspace = loadWorkspace();
     let apiBaseUrl = envString("TAPI_BASE_URL") || workspace?.apiBaseUrl || DEFAULT_STUDIO_API_BASE_URL;
@@ -406,22 +406,22 @@ function parseApiOptions(args) {
             continue;
         }
         if (arg.startsWith("--")) {
-            throw new Error(`Unknown apis option: ${arg}`);
+            throw new Error(`Unknown services option: ${arg}`);
         }
         if (!operation) {
             operation = arg;
             continue;
         }
-        throw new Error(`Unexpected apis argument: ${arg}`);
+        throw new Error(`Unexpected services argument: ${arg}`);
     }
     if (!operation) {
-        throw new Error("apis describe requires an operation like schwab.place_order.");
+        throw new Error("services describe requires a service run like schwab.place_order.");
     }
     if (!apiKey) {
-        throw new Error("apis describe requires --api-key or TAPI_API_KEY.");
+        throw new Error("services describe requires --api-key or TAPI_API_KEY.");
     }
     if (!projectId) {
-        throw new Error("apis describe requires --project, TAPI_PROJECT_ID, or .tapi/project.json.");
+        throw new Error("services describe requires --project, TAPI_PROJECT_ID, or .tapi/project.json.");
     }
     return {
         operation,
@@ -432,15 +432,15 @@ function parseApiOptions(args) {
         },
     };
 }
-async function describeApiOperation(args) {
+async function describeServiceOperation(args) {
     try {
-        const { operation, options } = parseApiOptions(args);
+        const { operation, options } = parseServiceOptions(args);
         const client = new TapiClient({
             baseUrl: options.apiBaseUrl,
             apiKey: options.apiKey,
             projectId: options.projectId,
         });
-        const description = await withCliSpinner(`Fetching Tapi API description for ${operation}`, () => client.services.describe(operation));
+        const description = await withCliSpinner(`Fetching Tapi service-run contract for ${operation}`, () => client.services.describe(operation));
         console.log(JSON.stringify(description, null, 2));
         return 0;
     }
@@ -454,8 +454,8 @@ function parseApiWorkspaceOptions(args) {
     let apiBaseUrl = envString("TAPI_BASE_URL") || workspace?.apiBaseUrl || DEFAULT_STUDIO_API_BASE_URL;
     let apiKey = envString("TAPI_API_KEY") || "";
     let projectId = envString("TAPI_PROJECT_ID") || workspace?.projectId || "";
-    let catalogPath = workspace?.config.generated?.catalog || ".tapi/generated/catalog.json";
-    let typescriptPath = workspace?.config.generated?.typescript || "src/tapi.generated.ts";
+    let catalogPath = workspace?.config.services?.catalog || workspace?.config.generated?.catalog || ".tapi/services/catalog.json";
+    let typescriptPath = workspace?.config.services?.typescript || workspace?.config.generated?.typescript || "src/tapi.services.ts";
     for (let index = 0; index < args.length; index += 1) {
         const arg = args[index];
         if (!arg)
@@ -504,13 +504,13 @@ function parseApiWorkspaceOptions(args) {
             typescriptPath = arg.slice("--out=".length);
             continue;
         }
-        throw new Error(`Unknown apis option: ${arg}`);
+        throw new Error(`Unknown services option: ${arg}`);
     }
     if (!apiKey) {
-        throw new Error("apis command requires --api-key or TAPI_API_KEY.");
+        throw new Error("services command requires --api-key or TAPI_API_KEY.");
     }
     if (!projectId) {
-        throw new Error("apis command requires --project, TAPI_PROJECT_ID, or .tapi/project.json.");
+        throw new Error("services command requires --project, TAPI_PROJECT_ID, or .tapi/project.json.");
     }
     const root = workspace?.root || process.cwd();
     return {
@@ -521,12 +521,12 @@ function parseApiWorkspaceOptions(args) {
         typescriptPath: resolve(root, typescriptPath),
     };
 }
-async function syncApiCatalog(args) {
+async function syncServiceCatalog(args) {
     try {
         const options = parseApiWorkspaceOptions(args);
-        const catalog = await withCliSpinner("Fetching Tapi API catalog", () => fetchApiCatalog(options));
+        const catalog = await withCliSpinner("Fetching Tapi service-run catalog", () => fetchApiCatalog(options));
         await writeJsonFile(options.catalogPath, catalog);
-        console.log(`Synced Tapi API catalog: ${options.catalogPath}`);
+        console.log(`Synced Tapi service-run catalog: ${options.catalogPath}`);
         return 0;
     }
     catch (error) {
@@ -534,13 +534,13 @@ async function syncApiCatalog(args) {
         return 1;
     }
 }
-async function generateApiClient(args) {
+async function generateServiceClient(args) {
     try {
         const options = parseApiWorkspaceOptions(args);
-        const catalog = await withCliSpinner("Fetching Tapi API catalog", () => fetchApiCatalog(options));
+        const catalog = await withCliSpinner("Fetching Tapi service-run catalog", () => fetchApiCatalog(options));
         await writeJsonFile(options.catalogPath, catalog);
-        await writeTextFile(options.typescriptPath, renderGeneratedApiClient(catalog));
-        console.log(`Generated Tapi API client: ${options.typescriptPath}`);
+        await writeTextFile(options.typescriptPath, renderServiceRunClient(catalog));
+        console.log(`Wrote Tapi service-run client: ${options.typescriptPath}`);
         return 0;
     }
     catch (error) {
@@ -615,19 +615,19 @@ async function syncApiTriggers(args) {
         const options = parseTriggerSyncOptions(args);
         const triggers = await readApiTriggerConfig(options.configPath);
         if (triggers.length === 0) {
-            throw new Error(`No Tapi API triggers found in ${options.configPath}.`);
+            throw new Error(`No Tapi service triggers found in ${options.configPath}.`);
         }
         const client = new TapiClient({
             baseUrl: options.apiBaseUrl,
             apiKey: options.apiKey,
             projectId: options.projectId,
         });
-        await withCliSpinner(`Syncing ${triggers.length} Tapi API trigger(s)`, async () => {
+        await withCliSpinner(`Syncing ${triggers.length} Tapi service trigger(s)`, async () => {
             for (const trigger of triggers) {
                 await client.triggers.create(trigger);
             }
         });
-        console.log(`Synced ${triggers.length} Tapi API trigger(s) from ${options.configPath}.`);
+        console.log(`Synced ${triggers.length} Tapi service trigger(s) from ${options.configPath}.`);
         return 0;
     }
     catch (error) {
@@ -1051,19 +1051,21 @@ function normalizeTriggerEntry(entry, index, configPath) {
         throw new Error(`Trigger #${index + 1} in ${configPath} must be an object.`);
     }
     const name = stringField(entry.name, `Trigger #${index + 1} name`);
-    const apiRequest = optionalStringField(entry.apiRequest, "apiRequest") ??
+    const serviceRun = optionalStringField(entry.serviceRun, "serviceRun") ??
+        optionalStringField(entry.service, "service") ??
+        optionalStringField(entry.apiRequest, "apiRequest") ??
         optionalStringField(entry.api, "api") ??
-        apiRequestFromParts(entry.apiName, entry.requestKey);
-    if (!apiRequest) {
-        throw new Error(`Trigger '${name}' requires apiRequest, api, or apiName/requestKey.`);
+        serviceRunFromParts(entry.serviceName ?? entry.apiName, entry.requestKey);
+    if (!serviceRun) {
+        throw new Error(`Trigger '${name}' requires serviceRun, service, or serviceName/requestKey.`);
     }
-    if (!apiRequest.includes(".")) {
-        throw new Error(`Trigger '${name}' apiRequest must be formatted as '<apiName>.<requestKey>'.`);
+    if (!serviceRun.includes(".")) {
+        throw new Error(`Trigger '${name}' serviceRun must be formatted as '<serviceName>.<requestKey>'.`);
     }
     const schedule = normalizeTriggerSchedule(entry.schedule, entry.interval, name);
     const request = {
         name,
-        apiRequest,
+        apiRequest: serviceRun,
         ...(entry.enabled === undefined ? {} : { enabled: booleanField(entry.enabled, `Trigger '${name}' enabled`) }),
         ...(schedule ? { schedule } : {}),
         ...(entry.inputs === undefined ? {} : { inputs: recordField(entry.inputs, `Trigger '${name}' inputs`) }),
@@ -1151,8 +1153,8 @@ function parseDurationSeconds(value, fieldName) {
     }
     return seconds;
 }
-function apiRequestFromParts(apiName, requestKey) {
-    const api = optionalStringField(apiName, "apiName");
+function serviceRunFromParts(serviceName, requestKey) {
+    const api = optionalStringField(serviceName, "serviceName");
     const request = optionalStringField(requestKey, "requestKey");
     return api && request ? `${api}.${request}` : undefined;
 }
@@ -1201,7 +1203,7 @@ async function writeTextFile(path, content) {
     await mkdir(dirname(path), { recursive: true });
     await writeFile(path, content, "utf8");
 }
-function renderGeneratedApiClient(catalog) {
+function renderServiceRunClient(catalog) {
     const namespaces = new Map();
     for (const api of catalog.apis || []) {
         const namespace = safeIdentifier(api.name || "api");
@@ -1217,13 +1219,13 @@ function renderGeneratedApiClient(catalog) {
         }
     }
     const namespaceBlocks = [...namespaces.entries()].map(([namespace, operations]) => {
-        const lines = operations.map(({ key, operationName }) => `    ${operationName}: (inputs: Record<string, unknown> = {}, options: GeneratedRunOptions = {}) => client.services.run(${JSON.stringify(key)}, { ...options, inputs }),`);
+        const lines = operations.map(({ key, operationName }) => `    ${operationName}: (inputs: Record<string, unknown> = {}, options: ServiceRunOptions = {}) => client.services.run(${JSON.stringify(key)}, { ...options, inputs }),`);
         return `  ${namespace}: {\n${lines.join("\n")}\n  },`;
     });
-    return `/* Generated by Tapi. Do not edit by hand. */
+    return `/* Created by Tapi. Do not edit by hand. */
 import { TapiClient, type TapiClientOptions, type RuntimeRunOptions } from "@tapi-dev/sdk";
 
-export interface GeneratedRunOptions {
+export interface ServiceRunOptions {
   runtime?: RuntimeRunOptions;
   priority?: number;
   runnerId?: string;
@@ -1231,7 +1233,7 @@ export interface GeneratedRunOptions {
   site?: string;
 }
 
-export function createTapiGeneratedClient(options: TapiClientOptions) {
+export function createTapiServicesClient(options: TapiClientOptions) {
   const client = new TapiClient(options);
   return {
 ${namespaceBlocks.join("\n")}
@@ -2444,31 +2446,31 @@ async function stopPortableStudioServerProcesses() {
     if (process.platform !== "win32") {
         return 0;
     }
-    const script = `
-$ErrorActionPreference = 'SilentlyContinue'
-$currentPid = $PID
-$processes = @(Get-Process -ErrorAction SilentlyContinue | Where-Object {
-  $pidValue = [int]$_.Id
-  if ($pidValue -le 0 -or $pidValue -eq $currentPid) {
-    $false
-  } else {
-    $path = ''
-    try { $path = [string]$_.Path } catch {}
-    $name = [string]$_.ProcessName
-    (
-      $name -ieq 'tapi-studio-server' -or
-      $path -match '\\\\Tapi\\\\Studio\\\\server\\\\releases\\\\'
-    )
-  }
-})
-$stopped = 0
-foreach ($process in $processes) {
-  try {
-    Stop-Process -Id ([int]$process.Id) -Force -ErrorAction Stop
-    $stopped += 1
-  } catch {}
-}
-[pscustomobject]@{ stopped = $stopped } | ConvertTo-Json -Compress
+    const script = `
+$ErrorActionPreference = 'SilentlyContinue'
+$currentPid = $PID
+$processes = @(Get-Process -ErrorAction SilentlyContinue | Where-Object {
+  $pidValue = [int]$_.Id
+  if ($pidValue -le 0 -or $pidValue -eq $currentPid) {
+    $false
+  } else {
+    $path = ''
+    try { $path = [string]$_.Path } catch {}
+    $name = [string]$_.ProcessName
+    (
+      $name -ieq 'tapi-studio-server' -or
+      $path -match '\\\\Tapi\\\\Studio\\\\server\\\\releases\\\\'
+    )
+  }
+})
+$stopped = 0
+foreach ($process in $processes) {
+  try {
+    Stop-Process -Id ([int]$process.Id) -Force -ErrorAction Stop
+    $stopped += 1
+  } catch {}
+}
+[pscustomobject]@{ stopped = $stopped } | ConvertTo-Json -Compress
 `;
     try {
         const output = await runProcessCapture("powershell.exe", [
@@ -3560,9 +3562,9 @@ Usage:
   tapi studio
   tapi studio open
   tapi studio doctor
-  tapi apis describe <namespace.operation>
-  tapi apis sync
-  tapi apis generate
+  tapi services describe <servicemap.run>
+  tapi services sync
+  tapi services generate
   tapi triggers sync
   tapi sessions
   tapi service status
@@ -3575,10 +3577,12 @@ Commands:
   studio          Open Tapi Studio for this repo
   studio open     Open Tapi Studio for this repo
   studio doctor   Check local SDK and Studio release configuration
-  apis describe   Print a generated website API input/output contract
-  apis sync       Save the published API catalog to .tapi/generated
-  apis generate   Generate a TypeScript runtime wrapper from the catalog
-  triggers sync   Upsert API-call triggers from tapi.config
+  services describe
+                  Print a ServiceMap service-run input/output contract
+  services sync   Save the service-run catalog to .tapi/services
+  services generate
+                  Write a TypeScript service-run wrapper from the catalog
+  triggers sync   Upsert service triggers from tapi.config
   sessions        List dev-mode API sessions and open takeover sessions
   service         Inspect or control the local Tapi Windows service
   doctor          Alias for studio doctor
@@ -3602,13 +3606,13 @@ Options:
   --no-interactive       Print the grouped list without the arrow-key picker
 `);
 }
-function printApisHelp() {
-    console.log(`Tapi generated website API commands
+function printServicesHelp() {
+    console.log(`Tapi ServiceMap service-run commands
 
 Usage:
-  tapi apis describe <namespace.operation> [--api-base-url URL] [--api-key KEY] [--project PROJECT]
-  tapi apis sync [--api-base-url URL] [--api-key KEY] [--project PROJECT]
-  tapi apis generate [--api-base-url URL] [--api-key KEY] [--project PROJECT] [--out FILE]
+  tapi services describe <servicemap.run> [--api-base-url URL] [--api-key KEY] [--project PROJECT]
+  tapi services sync [--api-base-url URL] [--api-key KEY] [--project PROJECT]
+  tapi services generate [--api-base-url URL] [--api-key KEY] [--project PROJECT] [--out FILE]
 
 Options:
   --api-base-url <url>   Tapi API base URL
@@ -3616,11 +3620,11 @@ Options:
   --api-key <key>        Tapi API key; defaults to TAPI_API_KEY
   --project <id>         Tapi project id; defaults to TAPI_PROJECT_ID or .tapi/project.json
   --catalog <path>       Catalog JSON output path
-  --out <path>           Generated TypeScript output path
+  --out <path>           TypeScript wrapper output path
 `);
 }
 function printTriggersHelp() {
-    console.log(`Tapi API trigger commands
+    console.log(`Tapi service trigger commands
 
 Usage:
   tapi triggers sync [--config FILE] [--api-base-url URL] [--api-key KEY] [--project PROJECT]
@@ -3636,7 +3640,7 @@ Config:
   export default {
     triggers: {
       nightlyBalance: {
-        apiRequest: "schwab.get_balance",
+        serviceRun: "schwab.get_balance",
         interval: "1h",
         inputs: { accountId: "main" },
         runtime: { profileRef: "perm_default" },

package/dist/triggers.js

@@ -7,7 +7,7 @@ export class TriggersResource {
         return this.http.get("/api/sdk/v1/service-triggers");
     }
     create(request) {
-        return this.http.post("/api/sdk/v1/service-triggers", request);
+        return this.http.post("/api/sdk/v1/service-triggers", toServiceTriggerWireRequest(request));
     }
     get(triggerId) {
         return this.http.get(`/api/sdk/v1/service-triggers/${encodeURIComponent(triggerId)}`);
@@ -28,3 +28,14 @@ export class TriggersResource {
         return this.http.post(`/api/sdk/v1/service-triggers/${encodeURIComponent(triggerId)}/run`);
     }
 }
+function toServiceTriggerWireRequest(request) {
+    const apiRequest = request.serviceRun ?? request.service ?? request.apiRequest;
+    if (!apiRequest) {
+        throw new Error("service trigger requires serviceRun.");
+    }
+    const { serviceRun, service, ...wireRequest } = request;
+    return {
+        ...wireRequest,
+        apiRequest,
+    };
+}

package/dist/types.d.ts

@@ -178,7 +178,9 @@ export interface WebsiteApiTriggerSchedule {
 }
 export interface WebsiteApiTriggerCreateRequest {
     name: string;
-    apiRequest: string;
+    serviceRun?: string;
+    service?: string;
+    apiRequest?: string;
     enabled?: boolean;
     schedule?: WebsiteApiTriggerSchedule;
     inputs?: Record<string, unknown>;

package/dist/workspace.d.ts

@@ -5,11 +5,17 @@ export interface TapiGeneratedConfig {
     typescript?: string;
     [key: string]: unknown;
 }
+export interface TapiServicesConfig {
+    catalog?: string;
+    typescript?: string;
+    [key: string]: unknown;
+}
 export interface TapiWorkspaceConfig {
     version: 1;
     projectId: string;
     projectSlug?: string;
     apiBaseUrl?: string;
+    services?: TapiServicesConfig;
     generated?: TapiGeneratedConfig;
     [key: string]: unknown;
 }

package/dist/workspace.js

@@ -51,6 +51,7 @@ export function readWorkspaceConfig(configPath) {
     const projectId = normalizeProjectValue(parsed.projectId, "projectId");
     const projectSlug = optionalProjectValue(parsed.projectSlug, "projectSlug");
     const apiBaseUrl = typeof parsed.apiBaseUrl === "string" && parsed.apiBaseUrl.trim() ? parsed.apiBaseUrl.trim() : undefined;
+    const services = isRecord(parsed.services) ? { ...parsed.services } : undefined;
     const generated = isRecord(parsed.generated) ? { ...parsed.generated } : undefined;
     return {
         ...parsed,
@@ -58,6 +59,7 @@ export function readWorkspaceConfig(configPath) {
         projectId,
         ...(projectSlug ? { projectSlug } : {}),
         ...(apiBaseUrl ? { apiBaseUrl } : {}),
+        ...(services ? { services } : {}),
         ...(generated ? { generated } : {}),
     };
 }
@@ -74,9 +76,9 @@ export async function writeWorkspaceConfig(options) {
         projectId,
         projectSlug,
         ...(options.apiBaseUrl ? { apiBaseUrl: options.apiBaseUrl } : {}),
-        generated: {
-            catalog: ".tapi/generated/catalog.json",
-            typescript: "src/tapi.generated.ts",
+        services: {
+            catalog: ".tapi/services/catalog.json",
+            typescript: "src/tapi.services.ts",
         },
     };
     await mkdir(dirname(configPath), { recursive: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tapi-dev/sdk",
-  "version": "0.1.33",
+  "version": "0.1.34",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",