zinkee 0.1.0

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "zinkee",
+  "version": "0.1.0",
+  "description": "CLI for Zinkee API v2",
+  "type": "module",
+  "bin": {
+    "zinkee": "dist/index.js"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsx src/index.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "cli-table3": "^0.6.5",
+    "commander": "^14.0.3",
+    "confbox": "^0.1.8"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.2",
+    "tsup": "^8.5.1",
+    "tsx": "^4.20.5",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
+  }
+}

package/src/api/automations.ts

@@ -0,0 +1,403 @@
+import { ApiClient } from "../client.js";
+import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
+import type { JsonObject, JsonValue } from "../types.js";
+
+export interface ApiAutomationFolder {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  automationCount?: number;
+}
+
+export interface ApiAutomation {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  description?: string;
+  status?: string;
+  folderId?: string;
+  trigger?: ApiAutomationTrigger;
+  actions?: ApiAutomationAction[];
+}
+
+export interface ApiAutomationTrigger {
+  [key: string]: unknown;
+  type?: string;
+  config?: JsonObject;
+}
+
+export interface ApiAutomationAction {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  type?: string;
+  config?: JsonObject;
+}
+
+export interface ApiAutomationPlugin {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  version?: string;
+}
+
+export interface ApiAutomationConnection {
+  [key: string]: unknown;
+  id?: string;
+  name?: string;
+  type?: string;
+  scope?: string;
+  active?: boolean;
+}
+
+export interface ListAutomationsQuery {
+  folderId?: string;
+  status?: string;
+  triggerType?: string;
+  actionType?: string;
+  pluginId?: string;
+  search?: string;
+}
+
+export interface MoveAutomationInput {
+  automationId: string;
+  targetFolderId: string;
+}
+
+export interface CreateAutomationInput {
+  [key: string]: unknown;
+  name: string;
+  description?: string;
+  folderId?: string;
+  trigger?: ApiAutomationTrigger;
+}
+
+export interface UpdateAutomationInput {
+  [key: string]: unknown;
+  name?: string;
+  description?: string;
+  folderId?: string;
+}
+
+export interface SetAutomationTriggerInput {
+  [key: string]: unknown;
+  type?: string;
+  config?: JsonObject;
+}
+
+export interface MutationAutomationActionInput {
+  [key: string]: unknown;
+  type?: string;
+  name?: string;
+  config?: JsonObject;
+}
+
+export interface SetAutomationFlowInput {
+  [key: string]: unknown;
+  entryActionIds?: string[];
+  transitions?: Array<{ from: string; to: string }>;
+}
+
+export interface SetAutomationWebhookInput {
+  [key: string]: unknown;
+  active?: boolean;
+  idempotencyKeyPath?: string;
+  eventTypePath?: string;
+  allowedEventTypes?: string[];
+  fieldMappings?: JsonValue[];
+}
+
+export interface CreateAutomationConnectionInput {
+  [key: string]: unknown;
+  name: string;
+  type: string;
+  scope: string;
+  ownerMemberId?: string;
+  config?: JsonObject;
+  secret?: Record<string, string>;
+  active?: boolean;
+}
+
+export interface UpdateAutomationConnectionInput {
+  [key: string]: unknown;
+  set?: Record<string, unknown>;
+  unset?: string[];
+}
+
+function jsonOptions(body: unknown, method: string): RequestInit {
+  return {
+    method,
+    headers: {
+      "content-type": "application/json",
+    },
+    body: JSON.stringify(body),
+  };
+}
+
+function selectorValue(selector: NormalizedUuidOrSlug): string {
+  return encodeURIComponent(selector.value);
+}
+
+function segment(value: string): string {
+  return encodeURIComponent(value);
+}
+
+function appendQuery(path: string, query: URLSearchParams): string {
+  const queryString = query.toString();
+  return queryString.length > 0 ? `${path}?${queryString}` : path;
+}
+
+export class AutomationsApi {
+  constructor(private readonly client: ApiClient) {}
+
+  listFolders(): Promise<ApiAutomationFolder[]> {
+    return this.client.getJson<ApiAutomationFolder[]>("/api/v2/automation-folders");
+  }
+
+  createFolder(body: Record<string, unknown>): Promise<ApiAutomationFolder> {
+    return this.client.requestJson<ApiAutomationFolder>(
+      "/api/v2/automation-folders",
+      jsonOptions(body, "POST"),
+    );
+  }
+
+  updateFolder(
+    folder: NormalizedUuidOrSlug,
+    body: Record<string, unknown>,
+  ): Promise<ApiAutomationFolder> {
+    return this.client.requestJson<ApiAutomationFolder>(
+      `/api/v2/automation-folders/${selectorValue(folder)}`,
+      jsonOptions(body, "PATCH"),
+    );
+  }
+
+  deleteFolder(folder: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automation-folders/${selectorValue(folder)}`,
+      { method: "DELETE" },
+    );
+  }
+
+  moveAutomation(input: MoveAutomationInput): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automation-folders/${segment(input.targetFolderId)}/automations:move`,
+      jsonOptions(input, "POST"),
+    );
+  }
+
+  listAutomations(query: ListAutomationsQuery = {}): Promise<ApiAutomation[]> {
+    const params = new URLSearchParams();
+
+    if (query.folderId) {
+      params.set("folderId", query.folderId);
+    }
+
+    if (query.status) {
+      params.set("status", query.status);
+    }
+
+    if (query.triggerType) {
+      params.set("triggerType", query.triggerType);
+    }
+
+    if (query.actionType) {
+      params.set("actionType", query.actionType);
+    }
+
+    if (query.pluginId) {
+      params.set("pluginId", query.pluginId);
+    }
+
+    if (query.search) {
+      params.set("search", query.search);
+    }
+
+    return this.client.getJson<ApiAutomation[]>(
+      appendQuery("/api/v2/automations", params),
+    );
+  }
+
+  getAutomation(automation: NormalizedUuidOrSlug): Promise<ApiAutomation> {
+    return this.client.getJson<ApiAutomation>(
+      `/api/v2/automations/${selectorValue(automation)}`,
+    );
+  }
+
+  createAutomation(input: CreateAutomationInput): Promise<ApiAutomation> {
+    return this.client.requestJson<ApiAutomation>(
+      "/api/v2/automations",
+      jsonOptions(input, "POST"),
+    );
+  }
+
+  updateAutomation(
+    automation: NormalizedUuidOrSlug,
+    input: UpdateAutomationInput,
+  ): Promise<ApiAutomation> {
+    return this.client.requestJson<ApiAutomation>(
+      `/api/v2/automations/${selectorValue(automation)}`,
+      jsonOptions(input, "PATCH"),
+    );
+  }
+
+  deleteAutomation(automation: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}`,
+      { method: "DELETE" },
+    );
+  }
+
+  activateAutomation(automation: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}:activate`,
+      { method: "POST" },
+    );
+  }
+
+  deactivateAutomation(automation: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}:deactivate`,
+      { method: "POST" },
+    );
+  }
+
+  getTrigger(automation: NormalizedUuidOrSlug): Promise<ApiAutomationTrigger> {
+    return this.client.getJson<ApiAutomationTrigger>(
+      `/api/v2/automations/${selectorValue(automation)}/trigger`,
+    );
+  }
+
+  setTrigger(
+    automation: NormalizedUuidOrSlug,
+    input: SetAutomationTriggerInput,
+  ): Promise<ApiAutomationTrigger> {
+    return this.client.requestJson<ApiAutomationTrigger>(
+      `/api/v2/automations/${selectorValue(automation)}/trigger`,
+      jsonOptions(input, "PUT"),
+    );
+  }
+
+  listActions(automation: NormalizedUuidOrSlug): Promise<ApiAutomationAction[]> {
+    return this.client.getJson<ApiAutomationAction[]>(
+      `/api/v2/automations/${selectorValue(automation)}/actions`,
+    );
+  }
+
+  addAction(
+    automation: NormalizedUuidOrSlug,
+    input: MutationAutomationActionInput,
+  ): Promise<ApiAutomationAction> {
+    return this.client.requestJson<ApiAutomationAction>(
+      `/api/v2/automations/${selectorValue(automation)}/actions`,
+      jsonOptions(input, "POST"),
+    );
+  }
+
+  updateAction(
+    automation: NormalizedUuidOrSlug,
+    actionId: string,
+    input: MutationAutomationActionInput,
+  ): Promise<ApiAutomationAction> {
+    return this.client.requestJson<ApiAutomationAction>(
+      `/api/v2/automations/${selectorValue(automation)}/actions/${segment(actionId)}`,
+      jsonOptions(input, "PATCH"),
+    );
+  }
+
+  deleteAction(
+    automation: NormalizedUuidOrSlug,
+    actionId: string,
+  ): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}/actions/${segment(actionId)}`,
+      { method: "DELETE" },
+    );
+  }
+
+  getFlow(automation: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.getJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}/flow`,
+    );
+  }
+
+  setFlow(
+    automation: NormalizedUuidOrSlug,
+    input: SetAutomationFlowInput,
+  ): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}/flow`,
+      jsonOptions(input, "PUT"),
+    );
+  }
+
+  getWebhook(automation: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.getJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}/webhook-endpoint`,
+    );
+  }
+
+  setWebhook(
+    automation: NormalizedUuidOrSlug,
+    input: SetAutomationWebhookInput,
+  ): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}/webhook-endpoint`,
+      jsonOptions(input, "PUT"),
+    );
+  }
+
+  deleteWebhook(automation: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automations/${selectorValue(automation)}/webhook-endpoint`,
+      { method: "DELETE" },
+    );
+  }
+
+  listPlugins(): Promise<ApiAutomationPlugin[]> {
+    return this.client.getJson<ApiAutomationPlugin[]>("/api/v2/automation-plugins");
+  }
+
+  getPlugin(pluginId: string): Promise<ApiAutomationPlugin> {
+    return this.client.getJson<ApiAutomationPlugin>(
+      `/api/v2/automation-plugins/${segment(pluginId)}`,
+    );
+  }
+
+  listConnections(): Promise<ApiAutomationConnection[]> {
+    return this.client.getJson<ApiAutomationConnection[]>(
+      "/api/v2/automation-connections",
+    );
+  }
+
+  getConnection(connection: NormalizedUuidOrSlug): Promise<ApiAutomationConnection> {
+    return this.client.getJson<ApiAutomationConnection>(
+      `/api/v2/automation-connections/${selectorValue(connection)}`,
+    );
+  }
+
+  createConnection(
+    input: CreateAutomationConnectionInput,
+  ): Promise<ApiAutomationConnection> {
+    return this.client.requestJson<ApiAutomationConnection>(
+      "/api/v2/automation-connections",
+      jsonOptions(input, "POST"),
+    );
+  }
+
+  updateConnection(
+    connection: NormalizedUuidOrSlug,
+    input: UpdateAutomationConnectionInput,
+  ): Promise<ApiAutomationConnection> {
+    return this.client.requestJson<ApiAutomationConnection>(
+      `/api/v2/automation-connections/${selectorValue(connection)}`,
+      jsonOptions(input, "PATCH"),
+    );
+  }
+
+  deleteConnection(connection: NormalizedUuidOrSlug): Promise<Record<string, unknown>> {
+    return this.client.requestJson<Record<string, unknown>>(
+      `/api/v2/automation-connections/${selectorValue(connection)}`,
+      { method: "DELETE" },
+    );
+  }
+}

package/src/api/comments.ts

@@ -0,0 +1,51 @@
+import { ApiClient } from "../client.js";
+import type { NormalizedUuidOrSlug } from "../parsers/selectors.js";
+
+export interface ApiComment {
+  [key: string]: unknown;
+  id?: string;
+  text?: string;
+}
+
+export interface CreateCommentInput {
+  [key: string]: unknown;
+  text?: string;
+}
+
+function jsonOptions(body: unknown, method: string): RequestInit {
+  return {
+    method,
+    headers: {
+      "content-type": "application/json",
+    },
+    body: JSON.stringify(body),
+  };
+}
+
+function selectorValue(selector: NormalizedUuidOrSlug): string {
+  return selector.value;
+}
+
+export class CommentsApi {
+  constructor(private readonly client: ApiClient) {}
+
+  listComments(
+    schema: NormalizedUuidOrSlug,
+    recordId: string,
+  ): Promise<ApiComment[]> {
+    return this.client.getJson<ApiComment[]>(
+      `/api/v2/schemas/${selectorValue(schema)}/records/${recordId}/comments`,
+    );
+  }
+
+  createComment(
+    schema: NormalizedUuidOrSlug,
+    recordId: string,
+    input: CreateCommentInput,
+  ): Promise<ApiComment> {
+    return this.client.requestJson<ApiComment>(
+      `/api/v2/schemas/${selectorValue(schema)}/records/${recordId}/comments`,
+      jsonOptions(input, "POST"),
+    );
+  }
+}