@ferricstore/ferricstore 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -2
- package/dist/index.cjs +2273 -600
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +193 -30
- package/dist/index.d.ts +193 -30
- package/dist/index.js +2275 -605
- package/dist/index.js.map +1 -1
- package/docs/api/assets/hierarchy.js +1 -1
- package/docs/api/assets/navigation.js +1 -1
- package/docs/api/assets/search.js +1 -1
- package/docs/api/classes/ClaimHydrationError.html +4 -4
- package/docs/api/classes/ConnectionClosedError.html +5 -5
- package/docs/api/classes/FerricStoreClient.html +6 -2
- package/docs/api/classes/FerricStoreError.html +5 -5
- package/docs/api/classes/FlowAlreadyExistsError.html +5 -5
- package/docs/api/classes/FlowBatchError.html +5 -5
- package/docs/api/classes/FlowNotFoundError.html +5 -5
- package/docs/api/classes/FlowQueryError.html +42 -0
- package/docs/api/classes/FlowWrongStateError.html +5 -5
- package/docs/api/classes/InvalidCommandError.html +5 -5
- package/docs/api/classes/LeaseRenewalError.html +5 -5
- package/docs/api/classes/LockHeldError.html +5 -5
- package/docs/api/classes/LockNotOwnedError.html +5 -5
- package/docs/api/classes/NativeAdapter.html +3 -3
- package/docs/api/classes/OverloadedError.html +5 -5
- package/docs/api/classes/QueueCompletionError.html +5 -5
- package/docs/api/classes/RequestTimeoutError.html +5 -5
- package/docs/api/classes/RerouteError.html +5 -5
- package/docs/api/classes/StaleLeaseError.html +5 -5
- package/docs/api/classes/StalePolicyGenerationError.html +5 -5
- package/docs/api/functions/projectFlowQuery.html +1 -0
- package/docs/api/hierarchy.html +1 -1
- package/docs/api/index.html +30 -3
- package/docs/api/interfaces/AdminListOptions.html +1 -1
- package/docs/api/interfaces/CancelOptions.html +1 -1
- package/docs/api/interfaces/CompleteOptions.html +1 -1
- package/docs/api/interfaces/CompleteOutcome.html +1 -1
- package/docs/api/interfaces/CreateManyOptions.html +1 -1
- package/docs/api/interfaces/EffectCompensateOptions.html +1 -1
- package/docs/api/interfaces/EffectConfirmOptions.html +1 -1
- package/docs/api/interfaces/EffectFailOptions.html +1 -1
- package/docs/api/interfaces/EffectStatusOptions.html +1 -1
- package/docs/api/interfaces/FailOptions.html +1 -1
- package/docs/api/interfaces/FailOutcome.html +1 -1
- package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +1 -1
- package/docs/api/interfaces/FerricStoreClientOptions.html +1 -1
- package/docs/api/interfaces/FlowEventProjectionField.html +4 -0
- package/docs/api/interfaces/FlowExplainResult.html +10 -0
- package/docs/api/interfaces/FlowPolicyOptions.html +1 -1
- package/docs/api/interfaces/FlowQueryCountResult.html +7 -0
- package/docs/api/interfaces/FlowQueryErrorPosition.html +4 -0
- package/docs/api/interfaces/FlowQueryIndex.html +9 -0
- package/docs/api/interfaces/FlowQueryIndexFormat.html +7 -0
- package/docs/api/interfaces/FlowQueryIndexRegistry.html +3 -0
- package/docs/api/interfaces/FlowQueryIndexStatus.html +8 -0
- package/docs/api/interfaces/FlowQueryPage.html +3 -0
- package/docs/api/interfaces/FlowQueryQuality.html +5 -0
- package/docs/api/interfaces/FlowQueryRecordsResult.html +8 -0
- package/docs/api/interfaces/FlowQueryUsage.html +12 -0
- package/docs/api/interfaces/FlowRunProjectionField.html +4 -0
- package/docs/api/interfaces/HistoryOptions.html +2 -2
- package/docs/api/interfaces/InvocationCreateOptions.html +1 -1
- package/docs/api/interfaces/LeaseMutationOptions.html +1 -1
- package/docs/api/interfaces/LimitListOptions.html +1 -1
- package/docs/api/interfaces/MutateOptions.html +1 -1
- package/docs/api/interfaces/NamedValueMutation.html +1 -1
- package/docs/api/interfaces/ProtocolCommand.html +2 -2
- package/docs/api/interfaces/ReadOptions.html +5 -3
- package/docs/api/interfaces/ReclaimOptions.html +1 -1
- package/docs/api/interfaces/RequestContextOptions.html +1 -1
- package/docs/api/interfaces/RetryOptions.html +1 -1
- package/docs/api/interfaces/RetryOutcome.html +1 -1
- package/docs/api/interfaces/SearchOptions.html +4 -3
- package/docs/api/interfaces/StepContinueOptions.html +1 -1
- package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
- package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
- package/docs/api/interfaces/TransitionOptions.html +1 -1
- package/docs/api/interfaces/TransitionOutcome.html +1 -1
- package/docs/api/modules.html +1 -1
- package/docs/api/types/ConnectionRequestDisposition.html +1 -1
- package/docs/api/types/FlowProjectionField.html +1 -0
- package/docs/api/types/FlowProjectionShape.html +1 -0
- package/docs/api/types/FlowQueryInteger.html +1 -0
- package/docs/api/types/FlowQueryParameter.html +1 -0
- package/docs/api/types/FlowQueryParameters.html +1 -0
- package/docs/api/types/FlowQueryRecord.html +1 -0
- package/docs/api/types/FlowQueryResult.html +1 -0
- package/docs/api/types/ManagementPairs.html +1 -1
- package/docs/api/types/SearchStateMeta.html +1 -1
- package/docs/api/variables/COMMAND_OPCODES.html +1 -1
- package/docs/api/variables/FERRICSTORE_MINIMUM_SERVER_VERSION.html +1 -1
- package/docs/api/variables/FERRICSTORE_NATIVE_PROTOCOL_VERSION.html +1 -1
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/docs/api/variables/FlowProjection.html +1 -0
- package/package.json +4 -3
package/dist/index.d.ts
CHANGED
|
@@ -325,7 +325,6 @@ declare const COMMAND_OPCODES: {
|
|
|
325
325
|
readonly "FLOW.VALUE.PUT": 523;
|
|
326
326
|
readonly "FLOW.VALUE.MGET": 524;
|
|
327
327
|
readonly "FLOW.SIGNAL": 525;
|
|
328
|
-
readonly "FLOW.LIST": 526;
|
|
329
328
|
readonly "FLOW.CREATE_MANY": 527;
|
|
330
329
|
readonly "FLOW.COMPLETE_MANY": 528;
|
|
331
330
|
readonly "FLOW.TRANSITION_MANY": 529;
|
|
@@ -334,13 +333,7 @@ declare const COMMAND_OPCODES: {
|
|
|
334
333
|
readonly "FLOW.CANCEL_MANY": 532;
|
|
335
334
|
readonly "FLOW.RECLAIM": 533;
|
|
336
335
|
readonly "FLOW.REWIND": 534;
|
|
337
|
-
readonly "FLOW.TERMINALS": 535;
|
|
338
|
-
readonly "FLOW.FAILURES": 536;
|
|
339
|
-
readonly "FLOW.BY_PARENT": 537;
|
|
340
|
-
readonly "FLOW.BY_ROOT": 538;
|
|
341
|
-
readonly "FLOW.BY_CORRELATION": 539;
|
|
342
336
|
readonly "FLOW.INFO": 540;
|
|
343
|
-
readonly "FLOW.STUCK": 541;
|
|
344
337
|
readonly "FLOW.POLICY.SET": 542;
|
|
345
338
|
readonly "FLOW.POLICY.GET": 543;
|
|
346
339
|
readonly "FLOW.SPAWN_CHILDREN": 544;
|
|
@@ -359,7 +352,7 @@ declare const COMMAND_OPCODES: {
|
|
|
359
352
|
readonly "FLOW.STATS": 557;
|
|
360
353
|
readonly "FLOW.ATTRIBUTES": 558;
|
|
361
354
|
readonly "FLOW.ATTRIBUTE_VALUES": 559;
|
|
362
|
-
readonly "FLOW.
|
|
355
|
+
readonly "FLOW.QUERY": 561;
|
|
363
356
|
readonly "FLOW.EFFECT.RESERVE": 576;
|
|
364
357
|
readonly "FLOW.EFFECT.CONFIRM": 577;
|
|
365
358
|
readonly "FLOW.EFFECT.FAIL": 578;
|
|
@@ -409,6 +402,8 @@ interface ProtocolCommand {
|
|
|
409
402
|
readonly laneId?: number;
|
|
410
403
|
/** @internal Correlated compact claim shape used to decode a direct response without guessing. */
|
|
411
404
|
readonly compactClaimMode?: CompactClaimMode;
|
|
405
|
+
/** @internal Exact top-level item count expected from a compact collection response. */
|
|
406
|
+
readonly compactResponseItems?: number;
|
|
412
407
|
/** @internal Correlated compact claim shapes for native pipeline response items. */
|
|
413
408
|
readonly pipelineClaimModes?: readonly (CompactClaimMode | undefined)[];
|
|
414
409
|
/** @internal Parsed routing metadata retained when a command uses COMMAND_EXEC. */
|
|
@@ -975,7 +970,7 @@ interface FlowPolicyOptions {
|
|
|
975
970
|
retentionTtlMs?: number;
|
|
976
971
|
/** Type-level maximum active lifetime for newly created Flows. */
|
|
977
972
|
maxActiveMs?: MaxActiveMs;
|
|
978
|
-
/** Type-level attribute names projected for
|
|
973
|
+
/** Type-level attribute names projected for Flow queries. An empty array clears the index list. */
|
|
979
974
|
indexedAttributes?: readonly string[];
|
|
980
975
|
indexedStateMeta?: string;
|
|
981
976
|
}
|
|
@@ -1066,15 +1061,17 @@ interface CancelOptions extends Omit<MutateOptions, "payload"> {
|
|
|
1066
1061
|
ttlMs?: number;
|
|
1067
1062
|
}
|
|
1068
1063
|
interface ReadOptions {
|
|
1069
|
-
partitionKey
|
|
1064
|
+
partitionKey: string;
|
|
1070
1065
|
count?: number;
|
|
1071
1066
|
fromMs?: number;
|
|
1072
1067
|
toMs?: number;
|
|
1068
|
+
/** Newest-first when true. Flow query conveniences default to true. */
|
|
1073
1069
|
rev?: boolean;
|
|
1074
1070
|
state?: string;
|
|
1075
1071
|
terminalOnly?: boolean;
|
|
1076
1072
|
includeCold?: boolean;
|
|
1077
1073
|
consistentProjection?: boolean;
|
|
1074
|
+
attributes?: Record<string, CommandArgument>;
|
|
1078
1075
|
}
|
|
1079
1076
|
interface HistoryOptions {
|
|
1080
1077
|
partitionKey?: string;
|
|
@@ -1116,6 +1113,117 @@ declare class FlowBatchError extends FerricStoreError {
|
|
|
1116
1113
|
constructor(operation: string, cause: unknown, completedItems: readonly FlowBatchCompletedItem[]);
|
|
1117
1114
|
}
|
|
1118
1115
|
|
|
1116
|
+
type FlowQueryParameter = string | Buffer | boolean | number | bigint;
|
|
1117
|
+
type FlowQueryParameters = Readonly<Record<string, FlowQueryParameter>>;
|
|
1118
|
+
type FlowQueryRecord = Readonly<Record<string, unknown>>;
|
|
1119
|
+
type FlowQueryInteger = number | bigint;
|
|
1120
|
+
interface FlowQueryPage {
|
|
1121
|
+
readonly hasMore: boolean;
|
|
1122
|
+
readonly cursor?: string;
|
|
1123
|
+
}
|
|
1124
|
+
interface FlowQueryQuality {
|
|
1125
|
+
readonly exactness: string;
|
|
1126
|
+
readonly freshness: string;
|
|
1127
|
+
readonly coverage: string;
|
|
1128
|
+
readonly pagination: string;
|
|
1129
|
+
}
|
|
1130
|
+
interface FlowQueryUsage {
|
|
1131
|
+
readonly rangeSeeks: number;
|
|
1132
|
+
readonly rangePages: number;
|
|
1133
|
+
readonly scannedEntries: number;
|
|
1134
|
+
readonly scannedBytes: number;
|
|
1135
|
+
readonly hydratedRecords: number;
|
|
1136
|
+
readonly residualChecks: number;
|
|
1137
|
+
readonly duplicateEntries: number;
|
|
1138
|
+
readonly resultRecords: number;
|
|
1139
|
+
readonly responseBytes: number;
|
|
1140
|
+
readonly memoryHighWaterBytes: number;
|
|
1141
|
+
readonly wallTimeUs: number;
|
|
1142
|
+
}
|
|
1143
|
+
interface FlowQueryResultBase {
|
|
1144
|
+
readonly version: "ferric.flow.query.result/v1";
|
|
1145
|
+
readonly quality: FlowQueryQuality;
|
|
1146
|
+
readonly usage: FlowQueryUsage;
|
|
1147
|
+
readonly raw: Readonly<Record<string, unknown>>;
|
|
1148
|
+
}
|
|
1149
|
+
interface FlowQueryRecordsResult extends FlowQueryResultBase {
|
|
1150
|
+
readonly kind: "records";
|
|
1151
|
+
readonly records: readonly FlowQueryRecord[];
|
|
1152
|
+
readonly page: FlowQueryPage;
|
|
1153
|
+
}
|
|
1154
|
+
interface FlowQueryCountResult extends FlowQueryResultBase {
|
|
1155
|
+
readonly kind: "count";
|
|
1156
|
+
readonly count: FlowQueryInteger;
|
|
1157
|
+
}
|
|
1158
|
+
type FlowQueryResult = FlowQueryRecordsResult | FlowQueryCountResult;
|
|
1159
|
+
interface FlowQueryErrorPosition {
|
|
1160
|
+
readonly byte: number;
|
|
1161
|
+
readonly line: number;
|
|
1162
|
+
readonly column: number;
|
|
1163
|
+
}
|
|
1164
|
+
declare class FlowQueryError extends FerricStoreError {
|
|
1165
|
+
readonly code: string;
|
|
1166
|
+
readonly detail?: string;
|
|
1167
|
+
readonly hint?: string;
|
|
1168
|
+
readonly position?: FlowQueryErrorPosition;
|
|
1169
|
+
readonly context?: Readonly<Record<string, unknown>>;
|
|
1170
|
+
constructor(options: {
|
|
1171
|
+
readonly code: string;
|
|
1172
|
+
readonly message: string;
|
|
1173
|
+
readonly detail?: string;
|
|
1174
|
+
readonly hint?: string;
|
|
1175
|
+
readonly retryable: boolean;
|
|
1176
|
+
readonly safeToRetry: boolean;
|
|
1177
|
+
readonly retryAfterMs: number;
|
|
1178
|
+
readonly position?: FlowQueryErrorPosition;
|
|
1179
|
+
readonly context?: Readonly<Record<string, unknown>>;
|
|
1180
|
+
readonly raw: unknown;
|
|
1181
|
+
readonly cause?: unknown;
|
|
1182
|
+
});
|
|
1183
|
+
}
|
|
1184
|
+
interface FlowExplainResult {
|
|
1185
|
+
readonly version: "ferric.flow.explain/v1";
|
|
1186
|
+
readonly queryFingerprint: string;
|
|
1187
|
+
readonly status: "planned" | "rejected" | "executed";
|
|
1188
|
+
readonly plan: Readonly<Record<string, unknown>>;
|
|
1189
|
+
readonly estimate: Readonly<Record<string, unknown>>;
|
|
1190
|
+
readonly bounds: Readonly<Record<string, unknown>>;
|
|
1191
|
+
readonly actual?: FlowQueryUsage;
|
|
1192
|
+
readonly diagnostic?: FlowQueryError;
|
|
1193
|
+
readonly raw: Readonly<Record<string, unknown>>;
|
|
1194
|
+
}
|
|
1195
|
+
interface FlowQueryIndexRegistry {
|
|
1196
|
+
readonly epoch: FlowQueryInteger;
|
|
1197
|
+
readonly catalogVersion: FlowQueryInteger;
|
|
1198
|
+
}
|
|
1199
|
+
interface FlowQueryIndexFormat {
|
|
1200
|
+
readonly queryRow: string;
|
|
1201
|
+
readonly key: string;
|
|
1202
|
+
readonly entry: string;
|
|
1203
|
+
readonly reverse: string;
|
|
1204
|
+
readonly counter?: string;
|
|
1205
|
+
readonly raw: Readonly<Record<string, unknown>>;
|
|
1206
|
+
}
|
|
1207
|
+
interface FlowQueryIndex {
|
|
1208
|
+
readonly id: string;
|
|
1209
|
+
readonly version: FlowQueryInteger;
|
|
1210
|
+
readonly buildId: string;
|
|
1211
|
+
readonly state: string;
|
|
1212
|
+
readonly queryable: boolean;
|
|
1213
|
+
readonly coveringFields: readonly string[];
|
|
1214
|
+
readonly format: FlowQueryIndexFormat;
|
|
1215
|
+
readonly raw: Readonly<Record<string, unknown>>;
|
|
1216
|
+
}
|
|
1217
|
+
interface FlowQueryIndexStatus {
|
|
1218
|
+
readonly contractVersion: "ferric.flow.query.indexes/v1";
|
|
1219
|
+
readonly observedAtMs: number;
|
|
1220
|
+
readonly statisticsMaxAgeMs: number;
|
|
1221
|
+
readonly registry: FlowQueryIndexRegistry;
|
|
1222
|
+
readonly services: Readonly<Record<string, unknown>>;
|
|
1223
|
+
readonly indexes: readonly FlowQueryIndex[];
|
|
1224
|
+
readonly raw: Readonly<Record<string, unknown>>;
|
|
1225
|
+
}
|
|
1226
|
+
|
|
1119
1227
|
declare class FerricStoreClientBase {
|
|
1120
1228
|
readonly executor: CommandExecutor;
|
|
1121
1229
|
readonly codec: Codec;
|
|
@@ -1831,6 +1939,32 @@ declare class FerricStoreManagementClient extends FerricStoreClientCore {
|
|
|
1831
1939
|
governanceLedger(id: string, options?: GovernanceLedgerOptions): Promise<FlowAdminRecord[]>;
|
|
1832
1940
|
}
|
|
1833
1941
|
|
|
1942
|
+
/** @internal Query-planner surface shared by the complete Flow client. */
|
|
1943
|
+
declare class FerricStoreFlowQueryClient extends FerricStoreManagementClient {
|
|
1944
|
+
query(query: string, params?: FlowQueryParameters): Promise<FlowQueryResult>;
|
|
1945
|
+
explain(query: string, params?: FlowQueryParameters): Promise<FlowExplainResult>;
|
|
1946
|
+
explainAnalyze(query: string, params?: FlowQueryParameters): Promise<FlowExplainResult>;
|
|
1947
|
+
queryIndexes(indexId?: string): Promise<FlowQueryIndexStatus>;
|
|
1948
|
+
list(type: string, options: ReadOptions): Promise<FlowRecord[]>;
|
|
1949
|
+
search(type: string, options: SearchOptions): Promise<FlowRecord[]>;
|
|
1950
|
+
terminals(type: string, options: ReadOptions): Promise<FlowRecord[]>;
|
|
1951
|
+
failures(type: string, options: ReadOptions): Promise<FlowRecord[]>;
|
|
1952
|
+
byParent(parentFlowId: string, options: ReadOptions): Promise<FlowRecord[]>;
|
|
1953
|
+
byRoot(rootFlowId: string, options: ReadOptions): Promise<FlowRecord[]>;
|
|
1954
|
+
byCorrelation(correlationId: string, options: ReadOptions): Promise<FlowRecord[]>;
|
|
1955
|
+
stuck(type: string, options: {
|
|
1956
|
+
partitionKey: string;
|
|
1957
|
+
count?: number;
|
|
1958
|
+
olderThanMs?: number;
|
|
1959
|
+
nowMs?: number;
|
|
1960
|
+
}): Promise<FlowRecord[]>;
|
|
1961
|
+
protected records(values: unknown[]): FlowRecord[];
|
|
1962
|
+
private executeFlowQuery;
|
|
1963
|
+
private executeFlowRecordQuery;
|
|
1964
|
+
private executeExplain;
|
|
1965
|
+
private throwFlowQueryError;
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1834
1968
|
declare const MAX_FLOW_POLICY_GENERATION: number;
|
|
1835
1969
|
type FlowPolicyBackoffKind = "none" | "fixed" | "linear" | "exponential";
|
|
1836
1970
|
interface FlowPolicyBackoffSnapshot {
|
|
@@ -1875,7 +2009,7 @@ interface FlowPolicySnapshot {
|
|
|
1875
2009
|
}
|
|
1876
2010
|
|
|
1877
2011
|
/** @internal Read, policy, and shared Flow helpers kept off the primary implementation module. */
|
|
1878
|
-
declare class FerricStoreFlowSupportClient extends
|
|
2012
|
+
declare class FerricStoreFlowSupportClient extends FerricStoreFlowQueryClient {
|
|
1879
2013
|
rewind(id: string, options?: {
|
|
1880
2014
|
partitionKey?: string;
|
|
1881
2015
|
toEvent?: string;
|
|
@@ -1891,20 +2025,7 @@ declare class FerricStoreFlowSupportClient extends FerricStoreManagementClient {
|
|
|
1891
2025
|
values?: readonly string[];
|
|
1892
2026
|
valueMaxBytes?: number;
|
|
1893
2027
|
}): Promise<FlowRecord<TPayload> | undefined>;
|
|
1894
|
-
list(type: string, options?: ReadOptions): Promise<FlowRecord[]>;
|
|
1895
|
-
search(type: string, options?: SearchOptions): Promise<FlowRecord[]>;
|
|
1896
|
-
terminals(type: string, options?: ReadOptions): Promise<FlowRecord[]>;
|
|
1897
|
-
failures(type: string, options?: ReadOptions): Promise<FlowRecord[]>;
|
|
1898
|
-
byParent(parentFlowId: string, options?: ReadOptions): Promise<FlowRecord[]>;
|
|
1899
|
-
byRoot(rootFlowId: string, options?: ReadOptions): Promise<FlowRecord[]>;
|
|
1900
|
-
byCorrelation(correlationId: string, options?: ReadOptions): Promise<FlowRecord[]>;
|
|
1901
2028
|
info(type: string): Promise<Record<string, unknown>>;
|
|
1902
|
-
stuck(type: string, options?: {
|
|
1903
|
-
partitionKey?: string;
|
|
1904
|
-
count?: number;
|
|
1905
|
-
olderThanMs?: number;
|
|
1906
|
-
nowMs?: number;
|
|
1907
|
-
}): Promise<FlowRecord[]>;
|
|
1908
2029
|
history(id: string, options?: HistoryOptions): Promise<unknown[]>;
|
|
1909
2030
|
spawnChildren(parentId: string, children: ChildSpec[], options?: {
|
|
1910
2031
|
groupId?: string;
|
|
@@ -1930,11 +2051,9 @@ declare class FerricStoreFlowSupportClient extends FerricStoreManagementClient {
|
|
|
1930
2051
|
retentionCleanup(): Promise<Record<string, unknown>>;
|
|
1931
2052
|
protected executeProducerWrite(args: CommandArgument[]): Promise<unknown>;
|
|
1932
2053
|
protected recordOrGet(response: unknown, id: string, partitionKey: string | undefined): Promise<FlowRecord>;
|
|
1933
|
-
protected records(values: unknown[]): FlowRecord[];
|
|
1934
2054
|
protected recordsOrResponse(value: unknown): unknown[] | unknown;
|
|
1935
2055
|
protected flowManyLimitError(operation: string): Error;
|
|
1936
2056
|
protected executeIndependentManyChunks<T>(operation: string, items: readonly T[], capture: (item: T) => T, execute: (batchItems: T[]) => Promise<unknown[] | unknown>): Promise<unknown[]>;
|
|
1937
|
-
private indexQuery;
|
|
1938
2057
|
protected appendPartitionOptions(args: CommandArgument[], options: {
|
|
1939
2058
|
partitionKey?: string;
|
|
1940
2059
|
partitionKeys?: string[];
|
|
@@ -2078,6 +2197,50 @@ declare class FerricStoreClient extends FerricStoreProducerClient {
|
|
|
2078
2197
|
}): Promise<unknown[] | unknown>;
|
|
2079
2198
|
}
|
|
2080
2199
|
|
|
2200
|
+
declare const FIELD_BRAND: unique symbol;
|
|
2201
|
+
type FlowProjectionShape = "record" | "records";
|
|
2202
|
+
interface FlowRunProjectionField {
|
|
2203
|
+
readonly source: "runs";
|
|
2204
|
+
readonly selector: string;
|
|
2205
|
+
readonly [FIELD_BRAND]: true;
|
|
2206
|
+
}
|
|
2207
|
+
interface FlowEventProjectionField {
|
|
2208
|
+
readonly source: "events";
|
|
2209
|
+
readonly selector: string;
|
|
2210
|
+
readonly [FIELD_BRAND]: true;
|
|
2211
|
+
}
|
|
2212
|
+
type FlowProjectionField = FlowRunProjectionField | FlowEventProjectionField;
|
|
2213
|
+
declare const FlowProjection: Readonly<{
|
|
2214
|
+
run: Readonly<{
|
|
2215
|
+
id: FlowRunProjectionField;
|
|
2216
|
+
type: FlowRunProjectionField;
|
|
2217
|
+
state: FlowRunProjectionField;
|
|
2218
|
+
version: FlowRunProjectionField;
|
|
2219
|
+
priority: FlowRunProjectionField;
|
|
2220
|
+
partitionKey: FlowRunProjectionField;
|
|
2221
|
+
createdAtMs: FlowRunProjectionField;
|
|
2222
|
+
updatedAtMs: FlowRunProjectionField;
|
|
2223
|
+
nextRunAtMs: FlowRunProjectionField;
|
|
2224
|
+
leaseDeadlineMs: FlowRunProjectionField;
|
|
2225
|
+
attempts: FlowRunProjectionField;
|
|
2226
|
+
runState: FlowRunProjectionField;
|
|
2227
|
+
maxActiveMs: FlowRunProjectionField;
|
|
2228
|
+
parentFlowId: FlowRunProjectionField;
|
|
2229
|
+
rootFlowId: FlowRunProjectionField;
|
|
2230
|
+
correlationId: FlowRunProjectionField;
|
|
2231
|
+
attributes: FlowRunProjectionField;
|
|
2232
|
+
stateMetadata: FlowRunProjectionField;
|
|
2233
|
+
attribute(name: string): FlowRunProjectionField;
|
|
2234
|
+
stateMeta(state: string, name: string): FlowRunProjectionField;
|
|
2235
|
+
}>;
|
|
2236
|
+
event: Readonly<{
|
|
2237
|
+
id: FlowEventProjectionField;
|
|
2238
|
+
fields: FlowEventProjectionField;
|
|
2239
|
+
field(name: string): FlowEventProjectionField;
|
|
2240
|
+
}>;
|
|
2241
|
+
}>;
|
|
2242
|
+
declare function projectFlowQuery(query: string, shape: FlowProjectionShape, ...fields: readonly FlowProjectionField[]): string;
|
|
2243
|
+
|
|
2081
2244
|
type Outcome = TransitionOutcome | CompleteOutcome | RetryOutcome | FailOutcome;
|
|
2082
2245
|
interface NamedValueMutation {
|
|
2083
2246
|
values?: Record<string, unknown>;
|
|
@@ -2404,13 +2567,13 @@ declare class WorkflowWorker {
|
|
|
2404
2567
|
}
|
|
2405
2568
|
|
|
2406
2569
|
/** TypeScript SDK package version. */
|
|
2407
|
-
declare const FERRICSTORE_SDK_VERSION = "0.
|
|
2570
|
+
declare const FERRICSTORE_SDK_VERSION = "0.5.0";
|
|
2408
2571
|
/** Oldest FerricStore server supported by this breaking beta contract. */
|
|
2409
|
-
declare const FERRICSTORE_MINIMUM_SERVER_VERSION = "0.
|
|
2410
|
-
/** Native framing and opcode ABI version; unchanged by FerricStore 0.
|
|
2572
|
+
declare const FERRICSTORE_MINIMUM_SERVER_VERSION = "0.11.0";
|
|
2573
|
+
/** Native framing and opcode ABI version; unchanged by FerricStore 0.11. */
|
|
2411
2574
|
declare const FERRICSTORE_NATIVE_PROTOCOL_VERSION = 1;
|
|
2412
2575
|
|
|
2413
2576
|
/** @deprecated Use RequestDisposition; retained for source compatibility. */
|
|
2414
2577
|
type ConnectionRequestDisposition = RequestDisposition;
|
|
2415
2578
|
|
|
2416
|
-
export { type AdminListOptions, type ApprovalListOptions, type ApprovalRequestOptions, type AttributeQueryOptions, type AutoBatchOptions, type BackoffKind, type BackpressurePolicy, BitmapStore, BloomFilterStore, type BudgetCommitOptions, type BudgetReserveOptions, COMMAND_OPCODES, type CancelOptions, type ChildSpec, type CircuitOpenOptions, type ClaimDueOptions, ClaimHydrationError, type ClaimHydrationItem, type ClaimedItem, type Codec, type CollectionScanOptions, type Command, type CommandArgument, type CommandExecutor, type CompleteJobsAndClaimJobsResult, type CompleteManyOptions, type CompleteOptions, type CompleteOutcome, ConnectionClosedError, type ConnectionRequestDisposition, type CountMinMergeOptions, CountMinSketchStore, type CreateItem, type CreateManyOptions, type CreateOptions, CuckooFilterStore, type EffectCompensateOptions, type EffectConfirmOptions, type EffectFailOptions, type EffectReserveOptions, type EffectStatusOptions, type EndpointPolicy, type ExceptionPolicy, type ExecutePipelineOptions, type ExpiryCondition, type ExtendLeaseOptions, FERRICSTORE_MINIMUM_SERVER_VERSION, FERRICSTORE_NATIVE_PROTOCOL_VERSION, FERRICSTORE_SDK_VERSION, type FailOptions, type FailOutcome, type FencedItem, type FencingToken, FerricStoreClient, type FerricStoreClientFromUrlOptions, type FerricStoreClientOptions, FerricStoreError, type FetchOrComputeComputeResult, type FetchOrComputeFencedResult, type FetchOrComputeHitResult, type FetchOrComputeResult, type FlowAdminRecord, FlowAlreadyExistsError, type FlowBatchCompletedItem, FlowBatchError, type FlowMaxActiveFailure, FlowNotFoundError, type FlowPolicyBackoffKind, type FlowPolicyBackoffSnapshot, type FlowPolicyOptions, type FlowPolicyRetentionSnapshot, type FlowPolicyRetrySnapshot, type FlowPolicySnapshot, type FlowPolicyStateSnapshot, type FlowRecord, type FlowStateMode, type FlowStatePolicy, type FlowStatePolicyLike, type FlowStatsOptions, FlowWrongStateError, type GeoAddOptions, type GeoMember, GeoStore, type GetExOptions, type GovernanceLedgerOptions, type HashScanResult, HashStore, type HistoryOptions, HyperLogLogStore, type IntegerReply, InvalidCommandError, type InvocationCreateOptions, JsonCodec, type KeyInfo, KeyValueStore, type LeaseMutationOptions, LeaseRenewalError, type LimitAmountOptions, type LimitLeaseOptions, type LimitListOptions, type LimitReleaseOptions, ListStore, LockHeldError, LockNotOwnedError, MAX_FLOW_POLICY_GENERATION, type ManagementPairs, type MaxActiveMs, type MutateOptions, type NamedValueMutation, NativeAdapter, type NativeAdapterOptions, type NativeClientOptions, type NativeProtocolEvent, type Outcome, OverloadedError, type ProtocolCommand, Queue, type QueueBatchHandler, QueueClient, QueueCompletionError, type QueueHandler, type QueueJob, type QueueOptions, QueueWorker, type QueueWorkerResult, type RangeLimit, type RateLimitResult, RawCodec, type ReadOptions, type ReclaimOptions, type ReconnectOptions, ReconnectingExecutor, type RequestContext, type RequestContextOptions, type RequestDisposition, RequestTimeoutError, RerouteError, type RetryOptions, type RetryOutcome, type RetryPolicy, type RoutingEndpoint, type RoutingRoute, RoutingTopology, type RunStepsItem, type RunStepsManyOptions, type ScanOptions, type ScheduleFireDueOptions, type ScheduleListOptions, type ScheduleOptions, type SearchOptions, type SearchStateMeta, type SetOptions, type SetScanResult, SetStore, type SortedSetScanResult, SortedSetStore, StaleLeaseError, StalePolicyGenerationError, type StartAndClaimOptions, type StateMeta, type StateMetaValue, type StateOptions, type StateRegistration, type StepContinueOptions, type StoreCommandClient, StreamStore, type TDigestCreateOptions, type TDigestMergeOptions, TDigestStore, type TopKReserveOptions, TopKStore, type TopologyNativeAdapterOptions, TopologyNativeAdapterPool, type TransitionOptions, type TransitionOutcome, type ValueConfig, type WorkerConfig, type WorkerProfile, type WorkerRefillStrategy, Workflow, WorkflowClient, WorkflowContext, WorkflowFlowCommands, type WorkflowHandler, type WorkflowOptions, WorkflowWorker, type WorkflowWorkerResult, type XReadStream, type ZAddMember, type ZAddOptions, classifyServerError, complete, fail, isOutcome, isReconnectableClosedConnectionError, mapException, retry, transition };
|
|
2579
|
+
export { type AdminListOptions, type ApprovalListOptions, type ApprovalRequestOptions, type AttributeQueryOptions, type AutoBatchOptions, type BackoffKind, type BackpressurePolicy, BitmapStore, BloomFilterStore, type BudgetCommitOptions, type BudgetReserveOptions, COMMAND_OPCODES, type CancelOptions, type ChildSpec, type CircuitOpenOptions, type ClaimDueOptions, ClaimHydrationError, type ClaimHydrationItem, type ClaimedItem, type Codec, type CollectionScanOptions, type Command, type CommandArgument, type CommandExecutor, type CompleteJobsAndClaimJobsResult, type CompleteManyOptions, type CompleteOptions, type CompleteOutcome, ConnectionClosedError, type ConnectionRequestDisposition, type CountMinMergeOptions, CountMinSketchStore, type CreateItem, type CreateManyOptions, type CreateOptions, CuckooFilterStore, type EffectCompensateOptions, type EffectConfirmOptions, type EffectFailOptions, type EffectReserveOptions, type EffectStatusOptions, type EndpointPolicy, type ExceptionPolicy, type ExecutePipelineOptions, type ExpiryCondition, type ExtendLeaseOptions, FERRICSTORE_MINIMUM_SERVER_VERSION, FERRICSTORE_NATIVE_PROTOCOL_VERSION, FERRICSTORE_SDK_VERSION, type FailOptions, type FailOutcome, type FencedItem, type FencingToken, FerricStoreClient, type FerricStoreClientFromUrlOptions, type FerricStoreClientOptions, FerricStoreError, type FetchOrComputeComputeResult, type FetchOrComputeFencedResult, type FetchOrComputeHitResult, type FetchOrComputeResult, type FlowAdminRecord, FlowAlreadyExistsError, type FlowBatchCompletedItem, FlowBatchError, type FlowEventProjectionField, type FlowExplainResult, type FlowMaxActiveFailure, FlowNotFoundError, type FlowPolicyBackoffKind, type FlowPolicyBackoffSnapshot, type FlowPolicyOptions, type FlowPolicyRetentionSnapshot, type FlowPolicyRetrySnapshot, type FlowPolicySnapshot, type FlowPolicyStateSnapshot, FlowProjection, type FlowProjectionField, type FlowProjectionShape, type FlowQueryCountResult, FlowQueryError, type FlowQueryErrorPosition, type FlowQueryIndex, type FlowQueryIndexFormat, type FlowQueryIndexRegistry, type FlowQueryIndexStatus, type FlowQueryInteger, type FlowQueryPage, type FlowQueryParameter, type FlowQueryParameters, type FlowQueryQuality, type FlowQueryRecord, type FlowQueryRecordsResult, type FlowQueryResult, type FlowQueryUsage, type FlowRecord, type FlowRunProjectionField, type FlowStateMode, type FlowStatePolicy, type FlowStatePolicyLike, type FlowStatsOptions, FlowWrongStateError, type GeoAddOptions, type GeoMember, GeoStore, type GetExOptions, type GovernanceLedgerOptions, type HashScanResult, HashStore, type HistoryOptions, HyperLogLogStore, type IntegerReply, InvalidCommandError, type InvocationCreateOptions, JsonCodec, type KeyInfo, KeyValueStore, type LeaseMutationOptions, LeaseRenewalError, type LimitAmountOptions, type LimitLeaseOptions, type LimitListOptions, type LimitReleaseOptions, ListStore, LockHeldError, LockNotOwnedError, MAX_FLOW_POLICY_GENERATION, type ManagementPairs, type MaxActiveMs, type MutateOptions, type NamedValueMutation, NativeAdapter, type NativeAdapterOptions, type NativeClientOptions, type NativeProtocolEvent, type Outcome, OverloadedError, type ProtocolCommand, Queue, type QueueBatchHandler, QueueClient, QueueCompletionError, type QueueHandler, type QueueJob, type QueueOptions, QueueWorker, type QueueWorkerResult, type RangeLimit, type RateLimitResult, RawCodec, type ReadOptions, type ReclaimOptions, type ReconnectOptions, ReconnectingExecutor, type RequestContext, type RequestContextOptions, type RequestDisposition, RequestTimeoutError, RerouteError, type RetryOptions, type RetryOutcome, type RetryPolicy, type RoutingEndpoint, type RoutingRoute, RoutingTopology, type RunStepsItem, type RunStepsManyOptions, type ScanOptions, type ScheduleFireDueOptions, type ScheduleListOptions, type ScheduleOptions, type SearchOptions, type SearchStateMeta, type SetOptions, type SetScanResult, SetStore, type SortedSetScanResult, SortedSetStore, StaleLeaseError, StalePolicyGenerationError, type StartAndClaimOptions, type StateMeta, type StateMetaValue, type StateOptions, type StateRegistration, type StepContinueOptions, type StoreCommandClient, StreamStore, type TDigestCreateOptions, type TDigestMergeOptions, TDigestStore, type TopKReserveOptions, TopKStore, type TopologyNativeAdapterOptions, TopologyNativeAdapterPool, type TransitionOptions, type TransitionOutcome, type ValueConfig, type WorkerConfig, type WorkerProfile, type WorkerRefillStrategy, Workflow, WorkflowClient, WorkflowContext, WorkflowFlowCommands, type WorkflowHandler, type WorkflowOptions, WorkflowWorker, type WorkflowWorkerResult, type XReadStream, type ZAddMember, type ZAddOptions, classifyServerError, complete, fail, isOutcome, isReconnectableClosedConnectionError, mapException, projectFlowQuery, retry, transition };
|