@rex0220/kintone-sql-tools 3.68.0 → 3.70.0

package/dist-engine/meta/umd.json

@@ -11,7 +11,7 @@
       "format": "esm"
     },
     "src/types/ast.ts": {
-      "bytes": 38120,
+      "bytes": 38224,
       "imports": [
         {
           "path": "src/core/exactDecimal.ts",
@@ -420,8 +420,13 @@
       ],
       "format": "esm"
     },
+    "src/core/asOfClock.ts": {
+      "bytes": 2891,
+      "imports": [],
+      "format": "esm"
+    },
     "src/core/batch.ts": {
-      "bytes": 21308,
+      "bytes": 21010,
       "imports": [
         {
           "path": "src/core/dmlGuard.ts",
@@ -452,6 +457,11 @@
           "path": "src/core/groupingValidation.ts",
           "kind": "import-statement",
           "original": "./groupingValidation"
+        },
+        {
+          "path": "src/core/asOfClock.ts",
+          "kind": "import-statement",
+          "original": "./asOfClock"
         }
       ],
       "format": "esm"
@@ -473,7 +483,7 @@
       "format": "esm"
     },
     "src/parser/parser.ts": {
-      "bytes": 215744,
+      "bytes": 217567,
       "imports": [
         {
           "path": "src/lexer/tokens.ts",
@@ -490,6 +500,11 @@
           "kind": "import-statement",
           "original": "../core/grouping"
         },
+        {
+          "path": "src/core/asOfClock.ts",
+          "kind": "import-statement",
+          "original": "../core/asOfClock"
+        },
         {
           "path": "src/core/aggregateExpression.ts",
           "kind": "import-statement",
@@ -1144,7 +1159,7 @@
       "format": "esm"
     },
     "src/core/diagnostics.ts": {
-      "bytes": 1535,
+      "bytes": 1804,
       "imports": [],
       "format": "esm"
     },
@@ -1159,6 +1174,53 @@
       ],
       "format": "esm"
     },
+    "src/core/sql.ts": {
+      "bytes": 1991,
+      "imports": [
+        {
+          "path": "src/lexer/lexer.ts",
+          "kind": "import-statement",
+          "original": "../lexer/lexer"
+        },
+        {
+          "path": "src/parser/parser.ts",
+          "kind": "import-statement",
+          "original": "../parser/parser"
+        },
+        {
+          "path": "src/core/scriptHeader.ts",
+          "kind": "import-statement",
+          "original": "./scriptHeader"
+        },
+        {
+          "path": "src/core/statementValidation.ts",
+          "kind": "import-statement",
+          "original": "./statementValidation"
+        }
+      ],
+      "format": "esm"
+    },
+    "src/core/dialect1Validation.ts": {
+      "bytes": 6720,
+      "imports": [
+        {
+          "path": "src/core/relativeDateFunction.ts",
+          "kind": "import-statement",
+          "original": "./relativeDateFunction"
+        },
+        {
+          "path": "src/core/optimization/relativeDateFullScanExactPlan.ts",
+          "kind": "import-statement",
+          "original": "./optimization/relativeDateFullScanExactPlan"
+        },
+        {
+          "path": "src/core/diagnostics.ts",
+          "kind": "import-statement",
+          "original": "./diagnostics"
+        }
+      ],
+      "format": "esm"
+    },
     "src/core/dmlPrevalidation.ts": {
       "bytes": 3780,
       "imports": [],
@@ -1384,7 +1446,7 @@
       "format": "esm"
     },
     "src/execute.ts": {
-      "bytes": 576972,
+      "bytes": 593690,
       "imports": [
         {
           "path": "src/lexer/lexer.ts",
@@ -1647,9 +1709,19 @@
           "original": "./engine/evalFunc"
         },
         {
-          "path": "src/core/scriptHeader.ts",
+          "path": "src/core/sql.ts",
           "kind": "import-statement",
-          "original": "./core/scriptHeader"
+          "original": "./core/sql"
+        },
+        {
+          "path": "src/core/asOfClock.ts",
+          "kind": "import-statement",
+          "original": "./core/asOfClock"
+        },
+        {
+          "path": "src/core/dialect1Validation.ts",
+          "kind": "import-statement",
+          "original": "./core/dialect1Validation"
         },
         {
           "path": "src/core/dmlValidationCandidates.ts",
@@ -1938,27 +2010,6 @@
       ],
       "format": "esm"
     },
-    "src/core/sql.ts": {
-      "bytes": 867,
-      "imports": [
-        {
-          "path": "src/lexer/lexer.ts",
-          "kind": "import-statement",
-          "original": "../lexer/lexer"
-        },
-        {
-          "path": "src/parser/parser.ts",
-          "kind": "import-statement",
-          "original": "../parser/parser"
-        },
-        {
-          "path": "src/core/statementValidation.ts",
-          "kind": "import-statement",
-          "original": "./statementValidation"
-        }
-      ],
-      "format": "esm"
-    },
     "src/core/applyGuard.ts": {
       "bytes": 638,
       "imports": [],
@@ -2151,10 +2202,10 @@
           "bytesInOutput": 303
         },
         "src/core/grouping.ts": {
-          "bytesInOutput": 1277
+          "bytesInOutput": 1280
         },
         "src/core/dmlGuard.ts": {
-          "bytesInOutput": 3459
+          "bytesInOutput": 3460
         },
         "src/core/relativeDateFunction.ts": {
           "bytesInOutput": 451
@@ -2184,13 +2235,13 @@
           "bytesInOutput": 3124
         },
         "src/core/aggregateDependencyValidation.ts": {
-          "bytesInOutput": 8225
+          "bytesInOutput": 8228
         },
         "src/core/groupingValidation.ts": {
-          "bytesInOutput": 3809
+          "bytesInOutput": 3811
         },
         "src/converter/selectToKintone.ts": {
-          "bytesInOutput": 10146
+          "bytesInOutput": 10148
         },
         "src/core/cteInlining.ts": {
           "bytesInOutput": 1224
@@ -2234,8 +2285,11 @@
         "src/core/statementValidation.ts": {
           "bytesInOutput": 239
         },
+        "src/core/asOfClock.ts": {
+          "bytesInOutput": 1162
+        },
         "src/core/batch.ts": {
-          "bytesInOutput": 6358
+          "bytesInOutput": 6386
         },
         "src/lexer/tokens.ts": {
           "bytesInOutput": 2328
@@ -2244,7 +2298,7 @@
           "bytesInOutput": 5906
         },
         "src/parser/parser.ts": {
-          "bytesInOutput": 127422
+          "bytesInOutput": 128344
         },
         "src/core/scalarCompare.ts": {
           "bytesInOutput": 2804
@@ -2322,7 +2376,7 @@
           "bytesInOutput": 122
         },
         "src/core/explainMetadata.ts": {
-          "bytesInOutput": 626
+          "bytesInOutput": 627
         },
         "src/core/optimization/sharedPlanner.ts": {
           "bytesInOutput": 339
@@ -2352,17 +2406,23 @@
           "bytesInOutput": 1223
         },
         "src/engine/process.ts": {
-          "bytesInOutput": 27971
+          "bytesInOutput": 27972
         },
         "src/converter/subtableAdapter.ts": {
           "bytesInOutput": 643
         },
         "src/core/diagnostics.ts": {
-          "bytesInOutput": 514
+          "bytesInOutput": 755
         },
         "src/core/scriptHeader.ts": {
           "bytesInOutput": 1831
         },
+        "src/core/sql.ts": {
+          "bytesInOutput": 492
+        },
+        "src/core/dialect1Validation.ts": {
+          "bytesInOutput": 3025
+        },
         "src/core/dmlPrevalidation.ts": {
           "bytesInOutput": 1136
         },
@@ -2418,7 +2478,7 @@
           "bytesInOutput": 412
         },
         "src/execute.ts": {
-          "bytesInOutput": 232730
+          "bytesInOutput": 235779
         },
         "src/engine-library/errors.ts": {
           "bytesInOutput": 1441
@@ -2462,9 +2522,6 @@
         "src/engine-library/resultMapping.ts": {
           "bytesInOutput": 903
         },
-        "src/core/sql.ts": {
-          "bytesInOutput": 186
-        },
         "src/core/applyGuard.ts": {
           "bytesInOutput": 236
         },
@@ -2487,7 +2544,7 @@
           "bytesInOutput": 127
         }
       },
-      "bytes": 671877
+      "bytes": 680623
     }
   }
 }

package/dist-flow/flow-library/errors.d.ts

@@ -0,0 +1,6 @@
+export declare class KsqlFlowError extends Error {
+    readonly code: string;
+    readonly cause?: unknown;
+    constructor(code: string, message: string, cause?: unknown);
+}
+export declare function normalizeFlowError(error: unknown): KsqlFlowError;

package/dist-flow/flow-library/index.d.ts

@@ -0,0 +1,13 @@
+import { createKintoneClient } from "./writableClient";
+import { KsqlFlowError } from "./errors";
+import type { CreateExecutionContextOptions, Diagnostic, ExecutionContext, ExplainScriptOptions, ExplainScriptResult, ParseScriptOptions, ParseScriptResult, Statement, StatementResult, ValidateScriptOptions } from "./publicTypes";
+export declare const version: string;
+export declare function parseScript(source: string, opts?: ParseScriptOptions): ParseScriptResult;
+export declare function validateScript(source: string, opts?: ValidateScriptOptions): Promise<Diagnostic[]>;
+export declare function explainScript(source: string, opts: ExplainScriptOptions): Promise<ExplainScriptResult>;
+export declare function createExecutionContext(opts: CreateExecutionContextOptions): ExecutionContext;
+export declare function executeStatement(statement: Statement, context: ExecutionContext): Promise<StatementResult>;
+export declare function disposeExecutionContext(context: ExecutionContext): Promise<void>;
+export { isDmlResult } from "./publicTypes";
+export { createKintoneClient, KsqlFlowError };
+export type { CreateExecutionContextOptions, CreateKintoneClientConfig, Diagnostic, DiagnosticCode, ExecutionContext, ExplainScriptOptions, ExplainScriptResult, FieldInfo, FlowChunkWrittenInfo, FlowDeleteResult, FlowDmlResult, FlowInsertResult, FlowKintoneClient, FlowUpdateResult, FlowUpsertResult, ParseScriptOptions, ParseScriptResult, SchemaResolver, ScriptHeaderMeta, Statement, StatementResult, StatementResultKind, ValidateScriptOptions, } from "./publicTypes";

package/dist-flow/flow-library/publicTypes.d.ts

@@ -0,0 +1,271 @@
+import type { Statement } from "../types/ast";
+export type { Statement };
+export type DiagnosticCode = "KSQL1001" | "KSQL1002" | "KSQL1003" | "KSQL1004" | "KSQL1005" | "KSQL1006" | "KSQL1101" | "KSQL1201" | "KSQL1202" | "KSQL1203" | "KSQL1301" | "KSQL1302" | "KSQL1303" | "KSQL1304" | "KSQL1305" | "KSQL1306";
+export interface Diagnostic {
+    severity: "error" | "warning";
+    code: DiagnosticCode;
+    message: string;
+    line: number;
+    column: number;
+    statementIndex?: number;
+}
+export interface ScriptHeaderMeta {
+    name: string | null;
+    dependsOn: string[];
+    timeout: number | null;
+    dialect: 0 | 1;
+}
+export interface FieldInfo {
+    code: string;
+    label: string;
+    fieldType: string;
+    optionOrder?: Record<string, number>;
+    sortKind?: "number" | "string";
+    required?: boolean;
+    minValue?: string;
+    maxValue?: string;
+    minLength?: string;
+    maxLength?: string;
+    defaultValue?: unknown;
+    hasLookup?: boolean;
+    isLookupCopyTarget?: boolean;
+    isUnique?: boolean;
+    isCalculated?: boolean;
+    inSubtable?: boolean;
+    writable?: boolean;
+    subtableCode?: string;
+}
+export interface KintoneRecordValue {
+    value: string | string[] | Array<{
+        code: string;
+    }>;
+}
+export type KintoneRecord = Record<string, KintoneRecordValue>;
+export interface FlowKintoneClient {
+    getRecords(params: {
+        app: number;
+        query: string;
+        fields: string[];
+        totalCount?: boolean;
+    }): Promise<{
+        records: KintoneRecord[];
+        totalCount?: string;
+        searchAborted?: boolean;
+    }>;
+    openCursor(params: {
+        app: number;
+        fields?: string[];
+        query: string;
+        size: 500;
+    }): Promise<{
+        readonly totalCount: number;
+        nextPage(): Promise<{
+            records: KintoneRecord[];
+            next: boolean;
+        }>;
+        close(): Promise<void>;
+    }>;
+    postRecords(params: {
+        app: number;
+        records: KintoneRecord[];
+    }): Promise<{
+        ids: string[];
+    }>;
+    putRecords(params: {
+        app: number;
+        records: Array<{
+            id: number;
+            revision?: number;
+            record: KintoneRecord;
+        }>;
+    }): Promise<void>;
+    deleteRecords(params: {
+        app: number;
+        ids: number[];
+    }): Promise<void>;
+    getApps(): Promise<Array<{
+        appId: number;
+        name: string;
+        description: string;
+    }>>;
+    getFields(appId: number): Promise<FieldInfo[]>;
+    getNumberPrecision(appId: number): Promise<{
+        digits: number;
+        decimalPlaces: number;
+        roundingMode: "HALF_EVEN" | "UP" | "DOWN";
+    }>;
+    getProcessStatuses(appId: number): Promise<{
+        enable: boolean;
+        states: Array<{
+            name: string;
+            index: number;
+        }> | null;
+    }>;
+}
+export type SchemaResolver = (appId: number) => readonly FieldInfo[] | Promise<readonly FieldInfo[]>;
+export interface ParseScriptOptions {
+    apps?: Readonly<Record<string, number>>;
+}
+export interface ParseScriptResult {
+    meta: ScriptHeaderMeta;
+    statements: Statement[];
+    statementRanges: Array<{
+        start: number;
+        end: number;
+    }>;
+    diagnostics: Diagnostic[];
+}
+export interface ValidateScriptOptions extends ParseScriptOptions {
+    strict?: boolean;
+    schema?: SchemaResolver;
+    client?: Pick<FlowKintoneClient, "getFields">;
+}
+export interface ExplainScriptOptions extends ParseScriptOptions {
+    client: FlowKintoneClient;
+    variables?: Readonly<Record<string, string>>;
+    /** dialect 1 の @ 付き時刻関数が共有する explain 呼出し単位の基準時刻。 */
+    asOf?: Date;
+    /** @TODAY() などの暦日境界に使う IANA timezone。省略時はホスト timezone。 */
+    timezone?: string;
+    maxRecords?: number;
+    cursorMaxActive?: number;
+    dmlMaxRows?: number;
+    dmlMaxSubtableRows?: number;
+    resolveMetadata?: boolean;
+    recursiveCteMaxDepth?: number;
+    recursiveCteMaxRows?: number;
+    recursiveCteMaxExpansions?: number;
+}
+export interface ExplainScriptResult {
+    statementCount: number;
+    statements: Array<{
+        index: number;
+        type: string;
+        plan: string[];
+    }>;
+}
+export interface CreateExecutionContextOptions extends ParseScriptOptions {
+    client: FlowKintoneClient;
+    script?: string;
+    statements?: readonly Statement[];
+    meta?: ScriptHeaderMeta;
+    variables?: Readonly<Record<string, string>>;
+    maxRecords?: number;
+    recursiveCteMaxDepth?: number;
+    recursiveCteMaxRows?: number;
+    recursiveCteMaxExpansions?: number;
+    onLimitReached?: "error" | "truncate";
+    fetchParallel?: number;
+    cacheContext?: string;
+    cursorMaxActive?: number;
+    dmlMaxRows?: number;
+    dmlMaxSubtableRows?: number;
+    tempTableMaxRows?: number;
+    timeoutMs?: number;
+    asOf?: Date;
+    timezone?: string;
+    continueOnError?: boolean;
+    /**
+     * 書込 API の各成功直後に await される。順序は現在の書込順であり、キー順は保証しない。
+     * コールバックが throw した場合、その文は error になるが、通知対象チャンクは書込済み。
+     */
+    onChunkWritten?: (info: FlowChunkWrittenInfo) => void | Promise<void>;
+}
+export interface FlowChunkWrittenInfo {
+    /** バッチ内の文 index（0 始まり）。 */
+    statementIndex: number;
+    /** 書込 API に渡される物理アプリ ID（LAPP は解決済み）。 */
+    appId: number;
+    operation: "INSERT" | "UPDATE" | "DELETE";
+    records: number;
+    /** その文で成功した書込 API リクエストの index（0 始まり）。 */
+    chunkIndex: number;
+    /** 単一キー UPSERT でキー値を payload から特定できる場合のみ設定される。 */
+    lastKeyValue?: string;
+}
+declare const executionContextBrand: unique symbol;
+/** Opaque, sequential-only statement execution handle. */
+export interface ExecutionContext {
+    readonly [executionContextBrand]: true;
+}
+export interface StatementError {
+    code: string;
+    message: string;
+    readonly cause?: unknown;
+}
+export interface ExecutionMetrics {
+    getCalls: number;
+    postCalls: number;
+    putCalls: number;
+    deleteCalls: number;
+    fieldCalls: number;
+    numberPrecisionCalls: number;
+    appsCalls: number;
+    processStatusCalls: number;
+    cursorCreateCalls: number;
+    cursorGetCalls: number;
+    cursorDeleteCalls: number;
+    cursorRecordsScanned: number;
+    cursorActiveCurrent: number;
+    cursorActivePeak: number;
+    cursorCleanupFailures: number;
+    cursorCreateOutcomeUnknown: number;
+    cursorQuarantinedCurrent: number;
+    fetchedRows: number;
+    limitReached: boolean;
+    limitReachedApps: number[];
+    elapsedMs: number;
+}
+export interface FlowInsertResult {
+    type: "INSERT";
+    createdIds: string[][];
+    insertedCount: number;
+}
+export interface FlowUpdateResult {
+    type: "UPDATE";
+    updatedCount: number;
+}
+export interface FlowDeleteResult {
+    type: "DELETE";
+    deletedCount: number;
+}
+export interface FlowUpsertResult {
+    type: "UPSERT";
+    insertedCount: number;
+    updatedCount: number;
+}
+/**
+ * /flow が安定契約とする通常 DML 結果。
+ * 実体に APPLY / IMPORT 系の任意フィールドが載っていても、それらはこの契約の対象外。
+ */
+export type FlowDmlResult = FlowInsertResult | FlowUpdateResult | FlowDeleteResult | FlowUpsertResult;
+export declare function isDmlResult(result: unknown): result is FlowDmlResult;
+export type StatementResultKind = "STATEMENT" | "ASSERT_PASSED" | "ASSERT_WARNING" | "ASSERT_VIOLATION" | "EXIT_NO_DATA";
+export interface StatementResult {
+    index: number;
+    type: string;
+    status: "success" | "error" | "skipped";
+    kind: StatementResultKind;
+    result?: unknown;
+    tempTable?: string;
+    rowCount?: number;
+    error?: StatementError;
+    skippedReason?: string;
+    /** コンテキスト開始から当該文終了時までの累積 deep-copy スナップショット。文単位値は前回との差分で求める。 */
+    metrics: ExecutionMetrics;
+}
+export interface CreateKintoneClientConfig {
+    baseUrl: string;
+    guestSpaceId?: number;
+    auth: {
+        type: "apiToken";
+        apiToken: string | ((appId: number) => string);
+    } | {
+        type: "password";
+        username: string;
+        password: string;
+    };
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+    cursorMaxActive?: number;
+}

package/dist-flow/flow-library/writableClient.d.ts

@@ -0,0 +1,2 @@
+import type { CreateKintoneClientConfig, FlowKintoneClient } from "./publicTypes";
+export declare function createKintoneClient(config: CreateKintoneClientConfig): FlowKintoneClient;