defineAction

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

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

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, 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 };
};

{
  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: 1735689600,
}

// 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: 1700000000,
}

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

// 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" },
}

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