@teamkeel/functions-runtime 0.421.1 → 0.421.3

package/dist/index.d.cts

@@ -216,14 +216,18 @@ declare function withSpan(name: any, fn: any): Promise<any>;
 declare function init(): void;
 declare function forceFlush(): Promise<void>;
 declare function spanNameForModelAPI(modelName: any, action: any): string;
+declare const KEEL_INTERNAL_ATTR: "keel_internal";
+declare const KEEL_INTERNAL_CHILDREN: "includeChildrenSpans";
 
+declare const tracing_KEEL_INTERNAL_ATTR: typeof KEEL_INTERNAL_ATTR;
+declare const tracing_KEEL_INTERNAL_CHILDREN: typeof KEEL_INTERNAL_CHILDREN;
 declare const tracing_forceFlush: typeof forceFlush;
 declare const tracing_getTracer: typeof getTracer;
 declare const tracing_init: typeof init;
 declare const tracing_spanNameForModelAPI: typeof spanNameForModelAPI;
 declare const tracing_withSpan: typeof withSpan;
 declare namespace tracing {
-  export { tracing_forceFlush as forceFlush, tracing_getTracer as getTracer, tracing_init as init, tracing_spanNameForModelAPI as spanNameForModelAPI, tracing_withSpan as withSpan };
+  export { tracing_KEEL_INTERNAL_ATTR as KEEL_INTERNAL_ATTR, tracing_KEEL_INTERNAL_CHILDREN as KEEL_INTERNAL_CHILDREN, tracing_forceFlush as forceFlush, tracing_getTracer as getTracer, tracing_init as init, tracing_spanNameForModelAPI as spanNameForModelAPI, tracing_withSpan as withSpan };
 }
 
 type MimeType = "application/json" | "application/gzip" | "application/pdf" | "application/rtf" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-excel" | "application/vnd.ms-powerpoint" | "application/msword" | "application/zip" | "application/xml" | "application/x-7z-compressed" | "application/x-tar" | "image/gif" | "image/jpeg" | "image/svg+xml" | "image/png" | "text/html" | "text/csv" | "text/javascript" | "text/plain" | "text/calendar" | (string & {});
@@ -593,8 +597,8 @@ interface UiElementIteratorApiResponse extends BaseUiDisplayResponse<"ui.iterato
     }>;
 }
 
-type UiElementPrint = DisplayElementWithRequiredConfig<{
-    jobs: PrintData[] | PrintData;
+type UiElementPrint<H extends NullableHardware> = DisplayElementWithRequiredConfig<{
+    jobs: PrintData<H>[] | PrintData<H>;
     title?: string;
     description?: string;
     /** If true, the jobs will be automatically printed. */
@@ -602,8 +606,9 @@ type UiElementPrint = DisplayElementWithRequiredConfig<{
     /** If true, the flow will continue after the jobs are complete. */
     autoContinue?: boolean;
 }>;
-type PrintData = {
+type PrintData<H extends NullableHardware> = {
     type: "zpl";
+    printer?: H extends Hardware ? H["printers"][number]["name"] : never;
     name?: string;
     data: string | string[];
 };
@@ -614,6 +619,7 @@ interface UiElementPrintApiResponse extends BaseUiDisplayResponse<"ui.interactiv
         type: "url" | "text" | "html" | "zpl";
         data?: string[];
         url?: string;
+        printer?: string;
     }[];
     autoPrint: boolean;
 }
@@ -638,7 +644,7 @@ type PickListItem = {
 type ListOptions<T> = {
     data: T[];
     render: (data: T) => PickListItem;
-    validate?: ValidateFn<PickListResponseItem>;
+    validate?: ValidateFn<PickListResponseItem[]>;
 };
 interface UiElementPickListApiResponse extends BaseUiMinimalInputResponse<"ui.interactive.pickList"> {
     data: PickListItem[];
@@ -705,13 +711,13 @@ interface UiElementFileApiResponse extends BaseUiDisplayResponse<"ui.display.fil
     };
 }
 
-interface UI<C extends FlowConfig> {
+interface UI<C extends FlowConfig, H extends NullableHardware> {
     page: UiPage<C>;
     display: UiDisplayElements;
     inputs: UiInputsElements;
     select: UiSelectElements;
     iterator: UiElementIterator;
-    interactive: UiInteractiveElements;
+    interactive: UiInteractiveElements<H>;
 }
 type UiInputsElements = {
     text: UiElementInputText;
@@ -737,8 +743,8 @@ type UiDisplayElements = {
     keyValue: UiElementKeyValue;
     file: UiElementFile;
 };
-type UiInteractiveElements = {
-    print: UiElementPrint;
+type UiInteractiveElements<H extends NullableHardware> = {
+    print: UiElementPrint<H>;
     pickList: UiElementPickList;
 };
 type InputElement<TValueType, TConfig extends any = never> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType>;
@@ -859,15 +865,22 @@ declare const RetryConstant: (intervalS: number) => RetryPolicyFn;
  * @param intervalS the base duration in seconds.
  */
 declare const RetryBackoffExponential: (intervalS: number) => RetryPolicyFn;
-interface FlowContext<C extends FlowConfig, E, S, Id, I> {
+interface FlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardware> {
     step: Step<C>;
-    ui: UI<C>;
+    ui: UI<C, H>;
     complete: Complete<C, I>;
     env: E;
     now: Date;
     secrets: S;
     identity: Id;
 }
+type NullableHardware = Hardware | undefined;
+type Hardware = {
+    printers: Printer[];
+};
+interface Printer {
+    name: string;
+}
 type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
     [key: string]: JsonSerializable;
 };
@@ -914,7 +927,7 @@ interface FlowConfigAPI {
     title: string;
     description?: string;
 }
-type FlowFunction<C extends FlowConfig, E, S, Id, I = undefined> = (ctx: FlowContext<C, E, S, Id, I>, inputs: I) => Promise<CompleteOptions<C, I> | any | void>;
+type FlowFunction<C extends FlowConfig, E, S, Id, I = undefined, H extends NullableHardware = undefined> = (ctx: FlowContext<C, E, S, Id, I, H>, inputs: I) => Promise<CompleteOptions<C, I> | any | void>;
 type ExtractStageKeys<T extends FlowConfig> = T extends {
     stages: infer S;
 } ? S extends ReadonlyArray<infer U> ? U extends string ? U : U extends {
@@ -931,12 +944,12 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
-declare function createFlowContext<C extends FlowConfig, E, S, Id, I>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
+declare function createFlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardware>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
     env: E;
     now: Date;
     secrets: S;
     identity: Id;
-}): FlowContext<C, E, S, Id, I>;
+}): FlowContext<C, E, S, Id, I, H>;
 
 declare function ksuid(): string;
 
@@ -1106,4 +1119,4 @@ type dateDuration = `${number}Y${number}M${number}D` | `${number}Y${number}M` |
 type timeDuration = `${number}H${number}M${number}S` | `${number}H${number}M` | `${number}M${number}S` | `${number}H${number}S` | `${number}H` | `${number}M` | `${number}S`;
 type DurationString = `P${dateDuration}T${timeDuration}` | `P${dateDuration}` | `PT${timeDuration}`;
 
-export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, ModelAPI, NonRetriableError, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };
+export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type Hardware, type IDWhereCondition, InlineFile, ModelAPI, NonRetriableError, type NullableHardware, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type Printer, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };

package/dist/index.d.ts

@@ -216,14 +216,18 @@ declare function withSpan(name: any, fn: any): Promise<any>;
 declare function init(): void;
 declare function forceFlush(): Promise<void>;
 declare function spanNameForModelAPI(modelName: any, action: any): string;
+declare const KEEL_INTERNAL_ATTR: "keel_internal";
+declare const KEEL_INTERNAL_CHILDREN: "includeChildrenSpans";
 
+declare const tracing_KEEL_INTERNAL_ATTR: typeof KEEL_INTERNAL_ATTR;
+declare const tracing_KEEL_INTERNAL_CHILDREN: typeof KEEL_INTERNAL_CHILDREN;
 declare const tracing_forceFlush: typeof forceFlush;
 declare const tracing_getTracer: typeof getTracer;
 declare const tracing_init: typeof init;
 declare const tracing_spanNameForModelAPI: typeof spanNameForModelAPI;
 declare const tracing_withSpan: typeof withSpan;
 declare namespace tracing {
-  export { tracing_forceFlush as forceFlush, tracing_getTracer as getTracer, tracing_init as init, tracing_spanNameForModelAPI as spanNameForModelAPI, tracing_withSpan as withSpan };
+  export { tracing_KEEL_INTERNAL_ATTR as KEEL_INTERNAL_ATTR, tracing_KEEL_INTERNAL_CHILDREN as KEEL_INTERNAL_CHILDREN, tracing_forceFlush as forceFlush, tracing_getTracer as getTracer, tracing_init as init, tracing_spanNameForModelAPI as spanNameForModelAPI, tracing_withSpan as withSpan };
 }
 
 type MimeType = "application/json" | "application/gzip" | "application/pdf" | "application/rtf" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-excel" | "application/vnd.ms-powerpoint" | "application/msword" | "application/zip" | "application/xml" | "application/x-7z-compressed" | "application/x-tar" | "image/gif" | "image/jpeg" | "image/svg+xml" | "image/png" | "text/html" | "text/csv" | "text/javascript" | "text/plain" | "text/calendar" | (string & {});
@@ -593,8 +597,8 @@ interface UiElementIteratorApiResponse extends BaseUiDisplayResponse<"ui.iterato
     }>;
 }
 
-type UiElementPrint = DisplayElementWithRequiredConfig<{
-    jobs: PrintData[] | PrintData;
+type UiElementPrint<H extends NullableHardware> = DisplayElementWithRequiredConfig<{
+    jobs: PrintData<H>[] | PrintData<H>;
     title?: string;
     description?: string;
     /** If true, the jobs will be automatically printed. */
@@ -602,8 +606,9 @@ type UiElementPrint = DisplayElementWithRequiredConfig<{
     /** If true, the flow will continue after the jobs are complete. */
     autoContinue?: boolean;
 }>;
-type PrintData = {
+type PrintData<H extends NullableHardware> = {
     type: "zpl";
+    printer?: H extends Hardware ? H["printers"][number]["name"] : never;
     name?: string;
     data: string | string[];
 };
@@ -614,6 +619,7 @@ interface UiElementPrintApiResponse extends BaseUiDisplayResponse<"ui.interactiv
         type: "url" | "text" | "html" | "zpl";
         data?: string[];
         url?: string;
+        printer?: string;
     }[];
     autoPrint: boolean;
 }
@@ -638,7 +644,7 @@ type PickListItem = {
 type ListOptions<T> = {
     data: T[];
     render: (data: T) => PickListItem;
-    validate?: ValidateFn<PickListResponseItem>;
+    validate?: ValidateFn<PickListResponseItem[]>;
 };
 interface UiElementPickListApiResponse extends BaseUiMinimalInputResponse<"ui.interactive.pickList"> {
     data: PickListItem[];
@@ -705,13 +711,13 @@ interface UiElementFileApiResponse extends BaseUiDisplayResponse<"ui.display.fil
     };
 }
 
-interface UI<C extends FlowConfig> {
+interface UI<C extends FlowConfig, H extends NullableHardware> {
     page: UiPage<C>;
     display: UiDisplayElements;
     inputs: UiInputsElements;
     select: UiSelectElements;
     iterator: UiElementIterator;
-    interactive: UiInteractiveElements;
+    interactive: UiInteractiveElements<H>;
 }
 type UiInputsElements = {
     text: UiElementInputText;
@@ -737,8 +743,8 @@ type UiDisplayElements = {
     keyValue: UiElementKeyValue;
     file: UiElementFile;
 };
-type UiInteractiveElements = {
-    print: UiElementPrint;
+type UiInteractiveElements<H extends NullableHardware> = {
+    print: UiElementPrint<H>;
     pickList: UiElementPickList;
 };
 type InputElement<TValueType, TConfig extends any = never> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType>;
@@ -859,15 +865,22 @@ declare const RetryConstant: (intervalS: number) => RetryPolicyFn;
  * @param intervalS the base duration in seconds.
  */
 declare const RetryBackoffExponential: (intervalS: number) => RetryPolicyFn;
-interface FlowContext<C extends FlowConfig, E, S, Id, I> {
+interface FlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardware> {
     step: Step<C>;
-    ui: UI<C>;
+    ui: UI<C, H>;
     complete: Complete<C, I>;
     env: E;
     now: Date;
     secrets: S;
     identity: Id;
 }
+type NullableHardware = Hardware | undefined;
+type Hardware = {
+    printers: Printer[];
+};
+interface Printer {
+    name: string;
+}
 type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
     [key: string]: JsonSerializable;
 };
@@ -914,7 +927,7 @@ interface FlowConfigAPI {
     title: string;
     description?: string;
 }
-type FlowFunction<C extends FlowConfig, E, S, Id, I = undefined> = (ctx: FlowContext<C, E, S, Id, I>, inputs: I) => Promise<CompleteOptions<C, I> | any | void>;
+type FlowFunction<C extends FlowConfig, E, S, Id, I = undefined, H extends NullableHardware = undefined> = (ctx: FlowContext<C, E, S, Id, I, H>, inputs: I) => Promise<CompleteOptions<C, I> | any | void>;
 type ExtractStageKeys<T extends FlowConfig> = T extends {
     stages: infer S;
 } ? S extends ReadonlyArray<infer U> ? U extends string ? U : U extends {
@@ -931,12 +944,12 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
-declare function createFlowContext<C extends FlowConfig, E, S, Id, I>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
+declare function createFlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardware>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
     env: E;
     now: Date;
     secrets: S;
     identity: Id;
-}): FlowContext<C, E, S, Id, I>;
+}): FlowContext<C, E, S, Id, I, H>;
 
 declare function ksuid(): string;
 
@@ -1106,4 +1119,4 @@ type dateDuration = `${number}Y${number}M${number}D` | `${number}Y${number}M` |
 type timeDuration = `${number}H${number}M${number}S` | `${number}H${number}M` | `${number}M${number}S` | `${number}H${number}S` | `${number}H` | `${number}M` | `${number}S`;
 type DurationString = `P${dateDuration}T${timeDuration}` | `P${dateDuration}` | `PT${timeDuration}`;
 
-export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, ModelAPI, NonRetriableError, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };
+export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type Hardware, type IDWhereCondition, InlineFile, ModelAPI, NonRetriableError, type NullableHardware, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type Printer, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };