defineAction

// before（typo を含む id）
export default defineAction({
  id: "fetch-user",
  name: "ユーザー取得",
  // ...
});
 
// after（id を変更）
export default defineAction({
  id: "fetch-user-detail",
  previousId: "fetch-user",
  name: "ユーザー詳細取得",
  // ...
});

import { defineAction } from "@basemachina/sdk/oac";
import { environments, reviewSettings } from "../bm-refs";
 
export default defineAction({
  id: "delete-user",
  name: "ユーザー削除",
  reviewSettingId: reviewSettings["High Risk"],
  overridingEnvironmentReviewSettings: [
    {
      environmentId: environments["本番"],
      autoExecuteOnApprovalPolicy: "DISALLOWED",
    },
  ],
  // ...
});

permissions: [
  { type: "user", id: "<ユーザーID>" },
  { type: "userGroup", id: "<ユーザーグループID>" },
  { type: "javascriptAction", id: "<JavaScriptアクションの識別子>" },
];

// 実行権限を制限した上で、実行を許可する対象が無い状態
permissions: [];

import { defineAction, readFile } from "@basemachina/sdk/oac";
import { dataSources } from "../bm-refs";
 
export default defineAction({
  id: "fetch-users",
  name: "ユーザー取得",
  type: "mysql",
  dataSource: dataSources["main-db"],
  statements: [{ sql: "SELECT id, name FROM users", type: "READ" }],
  resultDisplaySetting: {
    components: [
      {
        type: "actionTable",
        resultTransformationSetting: {
          enabled: true,
          script: readFile("./result-transformations/fetch-users.js"),
        },
        columnCustomizationSetting: [
          {
            columnName: "詳細",
            columnSetting: {
              type: "actionLink",
              linkText: { type: "value", value: "開く" },
              actionId: "fetch-user",
              initialArgs: {},
              openAndRun: true,
              newTab: false,
            },
          },
        ],
      },
    ],
  },
});

notificationSettings: {
  onSuccess: {
    notificationMethodId: "<通知方法の識別子>",
    mentionTargetUserIds: ["<ユーザーID>"],
    message: { type: "text", value: "ユーザー作成が成功しました" },
  },
  onError: {
    notificationMethodId: "<通知方法の識別子>",
    message: { type: "text", value: "ユーザー作成に失敗しました" },
  },
};

import { defineAction } from "@basemachina/sdk/oac";
 
export const queryAccessLogs = defineAction({
  id: "query-access-logs",
  name: "アクセスログ検索",
  type: "amazonAthena",
  dataSource: "athena-prod",
  statements: [
    {
      sql: "SELECT * FROM access_logs WHERE user_id = {{ userId }}",
    },
  ],
  parameters: [{ type: "TEXT", name: "userId", required: true }],
});

import { defineAction } from "@basemachina/sdk/oac";
 
export const uploadInvoice = defineAction({
  id: "upload-invoice",
  name: "請求書をアップロード",
  type: "amazonS3",
  dataSource: "s3-invoices",
  bucket: "invoices-prod",
  operation: "UPLOAD",
  objectKey: "invoices/{{ invoiceId }}.pdf",
  fileParameter: "file",
  parameters: [
    { type: "TEXT", name: "invoiceId", required: true },
    { type: "FILE", name: "file", required: true },
  ],
});

// オブジェクトをアップロード
operation: "UPLOAD",
objectKey: "invoices/{{ invoiceId }}.pdf",
fileParameter: "file",
 
// オブジェクトをダウンロード
operation: "DOWNLOAD",
objectKey: "invoices/{{ invoiceId }}.pdf",
 
// バケット内のオブジェクト一覧を取得（objectKey は任意。指定すると接頭辞で絞り込む）
operation: "LIST",
objectKey: "invoices/",
 
// 署名付きURLを発行
operation: "ISSUE_SIGNED_URL",
objectKey: "invoices/{{ invoiceId }}.pdf",
signedUrlMethod: "GET",

import { defineAction } from "@basemachina/sdk/oac";
 
export const fetchOrderStats = defineAction({
  id: "fetch-order-stats",
  name: "注文統計取得",
  type: "bigQuery",
  dataSource: "bigquery-analytics",
  statements: [
    {
      sql: "SELECT customer_id, SUM(amount) FROM orders WHERE date >= {{ startDate }} GROUP BY customer_id",
    },
  ],
  parameters: [
    { type: "DATE", name: "startDate", required: true, format: "YYYY-MM-DD" },
  ],
});

import { defineAction, readFile } from "@basemachina/sdk/oac";
 
export const fetchUsers = defineAction({
  id: "fetch-users",
  name: "ユーザー取得",
  type: "firestore",
  dataSource: "firestore-prod",
  code: readFile("./js-action-codes/fetch-users.ts"),
  parameters: [
    { type: "TEXT", name: "userId", required: true },
    {
      type: "BOOL",
      name: "active",
      format: { trueValue: "yes", falseValue: "no" },
    },
  ],
});

import { defineAction } from "@basemachina/sdk/oac";
 
export const issueReportUrl = defineAction({
  id: "issue-report-url",
  name: "レポートのダウンロードURLを発行",
  type: "googleCloudStorage",
  dataSource: "gcs-reports",
  bucket: "reports-prod",
  operation: "ISSUE_SIGNED_URL",
  objectKey: "monthly/{{ yearMonth }}.csv",
  signedUrlMethod: "GET",
  parameters: [{ type: "TEXT", name: "yearMonth", required: true }],
});

import { defineAction } from "@basemachina/sdk/oac";
 
// シートから読み取る
export const readMonthlyReport = defineAction({
  id: "read-monthly-report",
  name: "月次レポートを読み取る",
  type: "googleSheets",
  dataSource: "sheets-reports",
  spreadsheetId: "1AbCdEfGhIjK...",
  sheetId: 0,
  operation: "READ",
  a1Notation: "Sheet1!A1:D{{ rowCount }}",
  valueRenderOption: "UNFORMATTED_VALUE",
  parameters: [{ type: "NUMBER", name: "rowCount", required: true }],
});
 
// シートに行を追記する
export const appendOrder = defineAction({
  id: "append-order",
  name: "注文を追記",
  type: "googleSheets",
  dataSource: "sheets-orders",
  spreadsheetId: "1AbCdEfGhIjK...",
  operation: "APPEND_ROWS",
  rows: [
    [
      { value: "{{ orderId }}" },
      { value: "{{ customer }}" },
      { value: "{{ amount }}" },
    ],
  ],
  valueInputOption: "USER_ENTERED",
  parameters: [
    { type: "TEXT", name: "orderId", required: true },
    { type: "TEXT", name: "customer", required: true },
    { type: "NUMBER", name: "amount", required: true },
  ],
});

import { defineAction } from "@basemachina/sdk/oac";
 
export const fetchOrders = defineAction({
  id: "fetch-orders",
  name: "注文一覧取得",
  type: "grpc",
  dataSource: "orders-service",
  fullMethodName: "orders.OrderService/ListOrders",
  body: {
    payload: '{ "customerId": "{{ customerId }}" }',
  },
  parameters: [{ type: "TEXT", name: "customerId", required: true }],
});

import { defineAction } from "@basemachina/sdk/oac";
 
export const fetchUser = defineAction({
  id: "fetch-user",
  name: "ユーザー取得",
  type: "httpApi",
  dataSource: "users-api",
  url: "/v1/users/{{ userId }}",
  method: "GET",
  headers: [{ name: "Authorization", value: "Bearer {{ authToken }}" }],
  parameters: [
    { type: "TEXT", name: "userId", required: true },
    { type: "TEXT", name: "authToken", required: true },
  ],
});

// JSON
body: {
  contentType: "application/json",
  content: '{"id":"{{ userId }}"}',
}
 
// multipart/form-data
body: {
  contentType: "multipart/form-data",
  entries: [
    { name: "title", value: "{{ title }}" },
    { name: "image", fileParameter: "image" },
    { name: "attachments", arrayParameter: "attachments" },
  ],
}
 
// application/x-www-form-urlencoded
body: {
  contentType: "application/x-www-form-urlencoded",
  entries: [{ name: "q", value: "{{ keyword }}" }],
}
 
// GraphQL
body: {
  contentType: "graphql",
  query: "query GetUser { user(id: {{ userId }}) { name } }",
  variables: '{"id":"{{ userId }}"}',
}
 
// Content-Type未指定（任意のテキスト）
body: {
  content: "raw payload here",
}

import { defineAction, readFile } from "@basemachina/sdk/oac";
 
export const createUser = defineAction({
  id: "create-user",
  name: "ユーザー作成",
  type: "javascript",
  code: readFile("./js-action-codes/create-user.ts"),
  parameters: [
    { type: "TEXT", name: "email", required: true },
    { type: "NUMBER", name: "age", required: true },
  ],
});

// src/actions/js-action-codes/create-user.ts
import { executeAction, type JSActionHandler } from "@basemachina/action";
 
const handler: JSActionHandler<"create-user"> = async (
  { email, age },
  { currentUser, vars },
) => {
  // email: string, age: number として推論される
  return { ok: true };
};
 
export default handler;

// src/actions/js-action-codes/create-user.js
/** @type { import("@basemachina/action").JSActionHandler<"create-user"> } */
export default async ({ email, age }, { currentUser, vars }) => {
  return { ok: true };
};

import { defineAction } from "@basemachina/sdk/oac";
 
export const listUsers = defineAction({
  id: "list-users",
  name: "ユーザー一覧取得",
  type: "mysql",
  dataSource: "mysql-main",
  statements: [
    {
      sql: "SELECT * FROM users WHERE id IN ({{ userIds }})",
      type: "READ",
    },
  ],
  parameters: [
    {
      type: "ARRAY",
      name: "userIds",
      format: { type: "SQL", expansionTarget: "IN" },
      childElement: { type: "NUMBER" },
    },
  ],
});

import { defineAction } from "@basemachina/sdk/oac";
 
export const listOrders = defineAction({
  id: "list-orders",
  name: "注文一覧取得",
  type: "postgresql",
  dataSource: "postgres-main",
  statements: [
    {
      sql: "SELECT * FROM orders WHERE id IN ({{ orderIds }})",
      type: "READ",
    },
  ],
  parameters: [
    {
      type: "ARRAY",
      name: "orderIds",
      format: { type: "SQL", expansionTarget: "IN" },
      childElement: { type: "NUMBER" },
    },
  ],
});

import { defineAction } from "@basemachina/sdk/oac";
 
export const fetchOrders = defineAction({
  id: "fetch-orders",
  name: "注文取得",
  type: "snowflake",
  dataSource: "snowflake-warehouse",
  statements: [
    {
      sql: "SELECT * FROM orders WHERE id = {{ orderId }}",
    },
  ],
  parameters: [{ type: "NUMBER", name: "orderId", required: true }],
});

{
  type: "TEXT",
  name: "email",
  required: true,
  defaultValue: "example@example.com",
  minLength: 1,
  maxLength: 255,
  multiline: false,
  regexValidation: {
    pattern: "^[\\w.+-]+@[\\w-]+\\.[\\w.]+$",
    errorMessage: "メールアドレスの形式で入力してください",
  },
}

{
  type: "NUMBER",
  name: "age",
  required: true,
  min: 0,
  max: 150,
}

// 文字列で扱う場合
{
  type: "DATE",
  name: "targetDate",
  required: true,
  includeTime: false,
  format: "YYYY-MM-DD",
  defaultValue: "2025-01-01",
}
 
// Unixタイムスタンプで扱う場合
{
  type: "DATE",
  name: "targetDate",
  required: true,
  includeTime: true,
  useUnixTimestamp: true,
  defaultValue: "2025-01-01T00:00:00Z",
}

// JavaScriptアクション（真偽値のまま扱う）
{
  type: "BOOL",
  name: "isActive",
  defaultValue: true,
}
 
// JavaScriptアクション（文字列値として扱う）
{
  type: "BOOL",
  name: "isActive",
  format: { trueValue: "1", falseValue: "0" },
}
 
// gRPCアクション（formatは必須）
{
  type: "BOOL",
  name: "isActive",
  format: { trueValue: "true", falseValue: "false" },
}

{
  type: "FILE",
  name: "uploadFile",
  required: true,
  maxBytes: 10485760,
}

// テキスト型
{
  type: "JSON",
  name: "statusFilter",
  valueType: "TEXT",
  selectOptions: [
    { label: "有効", value: "ACTIVE" },
    { label: "無効", value: "INACTIVE" },
  ],
}
 
// 数値型
{
  type: "JSON",
  name: "priority",
  valueType: "NUMBER",
  min: 0,
  max: 10,
  defaultValue: 5,
}
 
// 日付型（文字列形式）
{
  type: "JSON",
  name: "targetDate",
  valueType: "DATE",
  includeTime: false,
  format: "YYYY-MM-DD",
  defaultValue: "2025-01-01",
}
 
// 日付型（Unixタイムスタンプ）
{
  type: "JSON",
  name: "targetTimestamp",
  valueType: "DATE",
  useUnixTimestamp: true,
  includeTime: true,
  defaultValue: "2023-11-15T00:00:00Z",
}

{
  type: "SYSTEM_VALUE",
  name: "currentUserId",
  required: true,
}

{
  type: "SQL",
  name: "orderBy",
  required: true,
  defaultValue: "created_at DESC",
  selectOptions: [
    { label: "新しい順", value: "created_at DESC" },
    { label: "古い順", value: "created_at ASC" },
  ],
}

// JSON形式
{
  type: "ARRAY",
  name: "targetIds",
  format: { type: "JSON" },
  childElement: { type: "NUMBER" },
}
 
// 区切り文字形式
{
  type: "ARRAY",
  name: "tags",
  format: {
    type: "SEPARATOR",
    delimiter: ",",
    quoteCharacter: '"',
  },
  childElement: { type: "TEXT" },
}
 
// 配列のまま渡す（format省略）
{
  type: "ARRAY",
  name: "rawValues",
  childElement: { type: "TEXT" },
}
 
// ファイルの配列（HTTP APIアクション）
{
  type: "ARRAY",
  name: "attachments",
  format: { type: "FORM_DATA" },
  childElement: { type: "FILE", maxBytes: 10485760 },
}
 
// ファイルの配列（JavaScriptアクション）
{
  type: "ARRAY",
  name: "attachments",
  childElement: { type: "FILE", required: true },
}

{
  type: "TUPLE",
  name: "filter",
  format: { type: "JSON" },
  tupleElements: [
    { label: "開始日", childElement: { type: "DATE" } },
    { label: "終了日", childElement: { type: "DATE" } },
  ],
}