@stackone/core 4.2.0 → 4.4.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { IOlapClient, TruncationMode } from "@stackone/olap";
+import { IOlapClient, PolicyResult, TruncationMode } from "@stackone/olap";
 import { ConcurrencyConfig, HttpHeaders, HttpMethod, IHttpClient, IMcpClient, McpClientConfig, RateLimitConfig, SigningOptions } from "@stackone/transport";
 import { ZodType, z } from "@stackone/utils";
 import { LambdaClient, LambdaClientConfig } from "@aws-sdk/client-lambda";
@@ -3559,6 +3559,7 @@ type Block = {
   };
   statistics?: BlockStatistics;
   defenderMetadata?: DefenderMetadata;
+  policyMetadata?: PolicyMetadata;
   iterator?: {
     item: unknown;
     index: number;
@@ -3638,6 +3639,14 @@ type BlockStatistics = {
   startTime?: Date;
   endTime?: Date;
 };
+type PolicyMetadata = {
+  result: PolicyResult;
+  maskedFields: Array<{
+    path: string;
+    policyIds: string[];
+    level?: string;
+  }>;
+};
 type DefenderMetadata = {
   applied: boolean;
   result?: {
@@ -3793,6 +3802,29 @@ declare class CoreError extends Error {
 //#region src/errors/typeguards.d.ts
 declare const isCoreError: (error: unknown) => error is CoreError;
 //#endregion
+//#region src/schema/fieldMeta.d.ts
+declare const IMPACT_TARGETS: readonly ["ui", "mcp", "runtime"];
+type ImpactTarget = (typeof IMPACT_TARGETS)[number];
+declare const FIELD_META_SCHEMA: z.ZodObject<{
+  description: z.ZodString;
+  impact: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+    ui: "ui";
+    mcp: "mcp";
+    runtime: "runtime";
+  }>>>;
+}, z.core.$strict>;
+type FieldMeta = z.infer<typeof FIELD_META_SCHEMA>;
+type FieldMetaIssue = {
+  path: string;
+  kind: 'missing-description';
+} | {
+  path: string;
+  kind: 'invalid-meta';
+  meta: Record<string, unknown>;
+  errors: string[];
+};
+declare const collectFieldMetaIssues: (root: unknown) => FieldMetaIssue[];
+//#endregion
 //#region src/stepFunctions/browserUse/schemas.d.ts
 declare const BROWSER_USE_INPUT_PARAMS: z.ZodObject<{
   startUrl: z.ZodString;
@@ -4987,4 +5019,4 @@ type Account = {
   originOwnerName?: string;
 };
 //#endregion
-export { AUTHORIZATION_SCHEMA, type Account, type Action, type ActionAnnotations, type ActionCategory, type ActionExample, type ActionResponse, type ActionType, ActionTypes, type ActionValidationRule, type Assets, AuthType, type Authentication, type AuthenticationConfig, type AuthenticationField, type AuthenticationFieldValidation, type AuthenticationGuides, type AuthenticationNotice, BARE_JEXL_REQUIREMENT, BROWSER_USE_INPUT_PARAMS, BROWSER_USE_OUTPUT, type BaseIncrementalConfig, type BasePaginationConfig, type Block, type BlockContext, type BlockIndexedRecord, CODE_EXECUTION_LAMBDA_INPUT_PARAMS, CODE_EXECUTION_LAMBDA_OUTPUT, COMPOSITE_ID_LATEST_VERSION, type Category, type Changelog, type ChangelogLabel, ChangelogLabels, type Checkpoint, type CompositeIdentifier, type CompositeIdentifierConfig, type CompositeIdentifierConnectorConfig, type Connector, type ConnectorDocumentation, type ConnectorEvents, CoreError, type Cursor, type CursorPaginationConfig, DOWNLOAD_FILE_INPUT_PARAMS, DOWNLOAD_FILE_OUTPUT, type DataSyncConfig, type DefenderMetadata, type DefenderSettings, type DeltaTokenIncrementalConfig, type DocumentationReference, EMIT_EVENT_INPUT_PARAMS, EMIT_EVENT_OUTPUT, type Effect, Effects, type EnumOneOf, type EventRouter, type EventRouterResult, type EventRouterRule, type EventToEmit, type ExecutionMode, ExecutionModes, type ExpressionContextOptions, FORMAT_PATTERNS, type FieldConfig, type FlowType, type ForeachStep, GROUP_DATA_INPUT_PARAMS, GROUP_DATA_OUTPUT, type Guide, type GuideImage, type GuideSection, type GuideStep, INPUT_ENUM_REGISTRY, type IncrementalConfig, type Input, type InputFormat, InputFormats, type InputLocation, InputLocations, type InputRules, type InputType, InputTypes, type InputVariant, type IntermediateStepSnapshot, type IteratorLocation, MAP_FIELDS_INPUT_PARAMS, MAP_FIELDS_OUTPUT, MCP_REQUEST_INPUT_PARAMS, MCP_REQUEST_OUTPUT, type MatchedEventAction, type OffsetPaginationConfig, type OnConditionError, PAGINATED_REQUEST_INPUT_PARAMS, PAGINATED_REQUEST_OUTPUT, type PagePaginationConfig, type PaginationConfig, REQUEST_INPUT_PARAMS, REQUEST_OUTPUT, type ReleaseStage, ReleaseStages, SIGN_JWT_INPUT_PARAMS, SIGN_JWT_OUTPUT, SOAP_PAGINATED_REQUEST_INPUT_PARAMS, SOAP_PAGINATED_REQUEST_OUTPUT, SOAP_REQUEST_INPUT_PARAMS, SOAP_REQUEST_OUTPUT, STATIC_VALUES_INPUT_PARAMS, STATIC_VALUES_OUTPUT, type Schema, type SchemaField, type SchemaType, SchemaTypes, type ScopeDefinition, type Settings, type SimpleStep, type Source, SourceType, type Step, type StepFunction, type StepFunctionMeta, StepFunctionName, type StepFunctionOutput, type StepFunctionParams, StepFunctionsFactory, stepFunctions as StepFunctionsRegistry, type StepsSnapshots, type StreamOutputData, StreamType, type SupportConfig, type SyncParams, type SyncedAction, TYPECAST_INPUT_PARAMS, TYPECAST_OUTPUT, type TestActionConfig, type TimeFilterIncrementalConfig, TransportType, UPLOAD_BINARY_INPUT_PARAMS, UPLOAD_BINARY_OUTPUT, UPLOAD_FILE_INPUT_PARAMS, UPLOAD_FILE_OUTPUT, type WebhookSetup, type WebhookSetupPhase, type WebhookSetupPhaseKind, areCursorsEqual, buildExpressionContext, computeDataSyncFingerprint, decodeCompositeId, encodeCompositeId, evaluateEventRouter, evaluateExternalAccountIdExtractor, expandCursor, getCategoryDetails, getInputEnumValues, getIteratorLocation, getPaginationKeys, isBareJexl, isCompositeId, isCoreError, isCursorEmpty, isForeachStep, isValidCategory, isValidEnumRef, minifyCursor, stripIncrementalParams, stripPaginationParams, updateCursor };
+export { AUTHORIZATION_SCHEMA, type Account, type Action, type ActionAnnotations, type ActionCategory, type ActionExample, type ActionResponse, type ActionType, ActionTypes, type ActionValidationRule, type Assets, AuthType, type Authentication, type AuthenticationConfig, type AuthenticationField, type AuthenticationFieldValidation, type AuthenticationGuides, type AuthenticationNotice, BARE_JEXL_REQUIREMENT, BROWSER_USE_INPUT_PARAMS, BROWSER_USE_OUTPUT, type BaseIncrementalConfig, type BasePaginationConfig, type Block, type BlockContext, type BlockIndexedRecord, CODE_EXECUTION_LAMBDA_INPUT_PARAMS, CODE_EXECUTION_LAMBDA_OUTPUT, COMPOSITE_ID_LATEST_VERSION, type Category, type Changelog, type ChangelogLabel, ChangelogLabels, type Checkpoint, type CompositeIdentifier, type CompositeIdentifierConfig, type CompositeIdentifierConnectorConfig, type Connector, type ConnectorDocumentation, type ConnectorEvents, CoreError, type Cursor, type CursorPaginationConfig, DOWNLOAD_FILE_INPUT_PARAMS, DOWNLOAD_FILE_OUTPUT, type DataSyncConfig, type DefenderMetadata, type DefenderSettings, type DeltaTokenIncrementalConfig, type DocumentationReference, EMIT_EVENT_INPUT_PARAMS, EMIT_EVENT_OUTPUT, type Effect, Effects, type EnumOneOf, type EventRouter, type EventRouterResult, type EventRouterRule, type EventToEmit, type ExecutionMode, ExecutionModes, type ExpressionContextOptions, FIELD_META_SCHEMA, FORMAT_PATTERNS, type FieldConfig, type FieldMeta, type FieldMetaIssue, type FlowType, type ForeachStep, GROUP_DATA_INPUT_PARAMS, GROUP_DATA_OUTPUT, type Guide, type GuideImage, type GuideSection, type GuideStep, IMPACT_TARGETS, INPUT_ENUM_REGISTRY, type ImpactTarget, type IncrementalConfig, type Input, type InputFormat, InputFormats, type InputLocation, InputLocations, type InputRules, type InputType, InputTypes, type InputVariant, type IntermediateStepSnapshot, type IteratorLocation, MAP_FIELDS_INPUT_PARAMS, MAP_FIELDS_OUTPUT, MCP_REQUEST_INPUT_PARAMS, MCP_REQUEST_OUTPUT, type MatchedEventAction, type OffsetPaginationConfig, type OnConditionError, PAGINATED_REQUEST_INPUT_PARAMS, PAGINATED_REQUEST_OUTPUT, type PagePaginationConfig, type PaginationConfig, type PolicyMetadata, REQUEST_INPUT_PARAMS, REQUEST_OUTPUT, type ReleaseStage, ReleaseStages, SIGN_JWT_INPUT_PARAMS, SIGN_JWT_OUTPUT, SOAP_PAGINATED_REQUEST_INPUT_PARAMS, SOAP_PAGINATED_REQUEST_OUTPUT, SOAP_REQUEST_INPUT_PARAMS, SOAP_REQUEST_OUTPUT, STATIC_VALUES_INPUT_PARAMS, STATIC_VALUES_OUTPUT, type Schema, type SchemaField, type SchemaType, SchemaTypes, type ScopeDefinition, type Settings, type SimpleStep, type Source, SourceType, type Step, type StepFunction, type StepFunctionMeta, StepFunctionName, type StepFunctionOutput, type StepFunctionParams, StepFunctionsFactory, stepFunctions as StepFunctionsRegistry, type StepsSnapshots, type StreamOutputData, StreamType, type SupportConfig, type SyncParams, type SyncedAction, TYPECAST_INPUT_PARAMS, TYPECAST_OUTPUT, type TestActionConfig, type TimeFilterIncrementalConfig, TransportType, UPLOAD_BINARY_INPUT_PARAMS, UPLOAD_BINARY_OUTPUT, UPLOAD_FILE_INPUT_PARAMS, UPLOAD_FILE_OUTPUT, type WebhookSetup, type WebhookSetupPhase, type WebhookSetupPhaseKind, areCursorsEqual, buildExpressionContext, collectFieldMetaIssues, computeDataSyncFingerprint, decodeCompositeId, encodeCompositeId, evaluateEventRouter, evaluateExternalAccountIdExtractor, expandCursor, getCategoryDetails, getInputEnumValues, getIteratorLocation, getPaginationKeys, isBareJexl, isCompositeId, isCoreError, isCursorEmpty, isForeachStep, isValidCategory, isValidEnumRef, minifyCursor, stripIncrementalParams, stripPaginationParams, updateCursor };

package/dist/index.d.mts

@@ -3,7 +3,7 @@ import { ZodType, z } from "@stackone/utils";
 import { ConcurrencyConfig, HttpHeaders, HttpMethod, IHttpClient, IMcpClient, McpClientConfig, RateLimitConfig, SigningOptions } from "@stackone/transport";
 import { LambdaClient, LambdaClientConfig } from "@aws-sdk/client-lambda";
 import { Readable } from "node:stream";
-import { IOlapClient, TruncationMode } from "@stackone/olap";
+import { IOlapClient, PolicyResult, TruncationMode } from "@stackone/olap";
 
 //#region ../logger/src/types.d.ts
 interface ILogger {
@@ -3558,6 +3558,7 @@ type Block = {
   };
   statistics?: BlockStatistics;
   defenderMetadata?: DefenderMetadata;
+  policyMetadata?: PolicyMetadata;
   iterator?: {
     item: unknown;
     index: number;
@@ -3637,6 +3638,14 @@ type BlockStatistics = {
   startTime?: Date;
   endTime?: Date;
 };
+type PolicyMetadata = {
+  result: PolicyResult;
+  maskedFields: Array<{
+    path: string;
+    policyIds: string[];
+    level?: string;
+  }>;
+};
 type DefenderMetadata = {
   applied: boolean;
   result?: {
@@ -3792,6 +3801,29 @@ declare class CoreError extends Error {
 //#region src/errors/typeguards.d.ts
 declare const isCoreError: (error: unknown) => error is CoreError;
 //#endregion
+//#region src/schema/fieldMeta.d.ts
+declare const IMPACT_TARGETS: readonly ["ui", "mcp", "runtime"];
+type ImpactTarget = (typeof IMPACT_TARGETS)[number];
+declare const FIELD_META_SCHEMA: z.ZodObject<{
+  description: z.ZodString;
+  impact: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+    ui: "ui";
+    mcp: "mcp";
+    runtime: "runtime";
+  }>>>;
+}, z.core.$strict>;
+type FieldMeta = z.infer<typeof FIELD_META_SCHEMA>;
+type FieldMetaIssue = {
+  path: string;
+  kind: 'missing-description';
+} | {
+  path: string;
+  kind: 'invalid-meta';
+  meta: Record<string, unknown>;
+  errors: string[];
+};
+declare const collectFieldMetaIssues: (root: unknown) => FieldMetaIssue[];
+//#endregion
 //#region src/stepFunctions/browserUse/schemas.d.ts
 declare const BROWSER_USE_INPUT_PARAMS: z.ZodObject<{
   startUrl: z.ZodString;
@@ -4986,4 +5018,4 @@ type Account = {
   originOwnerName?: string;
 };
 //#endregion
-export { AUTHORIZATION_SCHEMA, type Account, type Action, type ActionAnnotations, type ActionCategory, type ActionExample, type ActionResponse, type ActionType, ActionTypes, type ActionValidationRule, type Assets, AuthType, type Authentication, type AuthenticationConfig, type AuthenticationField, type AuthenticationFieldValidation, type AuthenticationGuides, type AuthenticationNotice, BARE_JEXL_REQUIREMENT, BROWSER_USE_INPUT_PARAMS, BROWSER_USE_OUTPUT, type BaseIncrementalConfig, type BasePaginationConfig, type Block, type BlockContext, type BlockIndexedRecord, CODE_EXECUTION_LAMBDA_INPUT_PARAMS, CODE_EXECUTION_LAMBDA_OUTPUT, COMPOSITE_ID_LATEST_VERSION, type Category, type Changelog, type ChangelogLabel, ChangelogLabels, type Checkpoint, type CompositeIdentifier, type CompositeIdentifierConfig, type CompositeIdentifierConnectorConfig, type Connector, type ConnectorDocumentation, type ConnectorEvents, CoreError, type Cursor, type CursorPaginationConfig, DOWNLOAD_FILE_INPUT_PARAMS, DOWNLOAD_FILE_OUTPUT, type DataSyncConfig, type DefenderMetadata, type DefenderSettings, type DeltaTokenIncrementalConfig, type DocumentationReference, EMIT_EVENT_INPUT_PARAMS, EMIT_EVENT_OUTPUT, type Effect, Effects, type EnumOneOf, type EventRouter, type EventRouterResult, type EventRouterRule, type EventToEmit, type ExecutionMode, ExecutionModes, type ExpressionContextOptions, FORMAT_PATTERNS, type FieldConfig, type FlowType, type ForeachStep, GROUP_DATA_INPUT_PARAMS, GROUP_DATA_OUTPUT, type Guide, type GuideImage, type GuideSection, type GuideStep, INPUT_ENUM_REGISTRY, type IncrementalConfig, type Input, type InputFormat, InputFormats, type InputLocation, InputLocations, type InputRules, type InputType, InputTypes, type InputVariant, type IntermediateStepSnapshot, type IteratorLocation, MAP_FIELDS_INPUT_PARAMS, MAP_FIELDS_OUTPUT, MCP_REQUEST_INPUT_PARAMS, MCP_REQUEST_OUTPUT, type MatchedEventAction, type OffsetPaginationConfig, type OnConditionError, PAGINATED_REQUEST_INPUT_PARAMS, PAGINATED_REQUEST_OUTPUT, type PagePaginationConfig, type PaginationConfig, REQUEST_INPUT_PARAMS, REQUEST_OUTPUT, type ReleaseStage, ReleaseStages, SIGN_JWT_INPUT_PARAMS, SIGN_JWT_OUTPUT, SOAP_PAGINATED_REQUEST_INPUT_PARAMS, SOAP_PAGINATED_REQUEST_OUTPUT, SOAP_REQUEST_INPUT_PARAMS, SOAP_REQUEST_OUTPUT, STATIC_VALUES_INPUT_PARAMS, STATIC_VALUES_OUTPUT, type Schema, type SchemaField, type SchemaType, SchemaTypes, type ScopeDefinition, type Settings, type SimpleStep, type Source, SourceType, type Step, type StepFunction, type StepFunctionMeta, StepFunctionName, type StepFunctionOutput, type StepFunctionParams, StepFunctionsFactory, stepFunctions as StepFunctionsRegistry, type StepsSnapshots, type StreamOutputData, StreamType, type SupportConfig, type SyncParams, type SyncedAction, TYPECAST_INPUT_PARAMS, TYPECAST_OUTPUT, type TestActionConfig, type TimeFilterIncrementalConfig, TransportType, UPLOAD_BINARY_INPUT_PARAMS, UPLOAD_BINARY_OUTPUT, UPLOAD_FILE_INPUT_PARAMS, UPLOAD_FILE_OUTPUT, type WebhookSetup, type WebhookSetupPhase, type WebhookSetupPhaseKind, areCursorsEqual, buildExpressionContext, computeDataSyncFingerprint, decodeCompositeId, encodeCompositeId, evaluateEventRouter, evaluateExternalAccountIdExtractor, expandCursor, getCategoryDetails, getInputEnumValues, getIteratorLocation, getPaginationKeys, isBareJexl, isCompositeId, isCoreError, isCursorEmpty, isForeachStep, isValidCategory, isValidEnumRef, minifyCursor, stripIncrementalParams, stripPaginationParams, updateCursor };
+export { AUTHORIZATION_SCHEMA, type Account, type Action, type ActionAnnotations, type ActionCategory, type ActionExample, type ActionResponse, type ActionType, ActionTypes, type ActionValidationRule, type Assets, AuthType, type Authentication, type AuthenticationConfig, type AuthenticationField, type AuthenticationFieldValidation, type AuthenticationGuides, type AuthenticationNotice, BARE_JEXL_REQUIREMENT, BROWSER_USE_INPUT_PARAMS, BROWSER_USE_OUTPUT, type BaseIncrementalConfig, type BasePaginationConfig, type Block, type BlockContext, type BlockIndexedRecord, CODE_EXECUTION_LAMBDA_INPUT_PARAMS, CODE_EXECUTION_LAMBDA_OUTPUT, COMPOSITE_ID_LATEST_VERSION, type Category, type Changelog, type ChangelogLabel, ChangelogLabels, type Checkpoint, type CompositeIdentifier, type CompositeIdentifierConfig, type CompositeIdentifierConnectorConfig, type Connector, type ConnectorDocumentation, type ConnectorEvents, CoreError, type Cursor, type CursorPaginationConfig, DOWNLOAD_FILE_INPUT_PARAMS, DOWNLOAD_FILE_OUTPUT, type DataSyncConfig, type DefenderMetadata, type DefenderSettings, type DeltaTokenIncrementalConfig, type DocumentationReference, EMIT_EVENT_INPUT_PARAMS, EMIT_EVENT_OUTPUT, type Effect, Effects, type EnumOneOf, type EventRouter, type EventRouterResult, type EventRouterRule, type EventToEmit, type ExecutionMode, ExecutionModes, type ExpressionContextOptions, FIELD_META_SCHEMA, FORMAT_PATTERNS, type FieldConfig, type FieldMeta, type FieldMetaIssue, type FlowType, type ForeachStep, GROUP_DATA_INPUT_PARAMS, GROUP_DATA_OUTPUT, type Guide, type GuideImage, type GuideSection, type GuideStep, IMPACT_TARGETS, INPUT_ENUM_REGISTRY, type ImpactTarget, type IncrementalConfig, type Input, type InputFormat, InputFormats, type InputLocation, InputLocations, type InputRules, type InputType, InputTypes, type InputVariant, type IntermediateStepSnapshot, type IteratorLocation, MAP_FIELDS_INPUT_PARAMS, MAP_FIELDS_OUTPUT, MCP_REQUEST_INPUT_PARAMS, MCP_REQUEST_OUTPUT, type MatchedEventAction, type OffsetPaginationConfig, type OnConditionError, PAGINATED_REQUEST_INPUT_PARAMS, PAGINATED_REQUEST_OUTPUT, type PagePaginationConfig, type PaginationConfig, type PolicyMetadata, REQUEST_INPUT_PARAMS, REQUEST_OUTPUT, type ReleaseStage, ReleaseStages, SIGN_JWT_INPUT_PARAMS, SIGN_JWT_OUTPUT, SOAP_PAGINATED_REQUEST_INPUT_PARAMS, SOAP_PAGINATED_REQUEST_OUTPUT, SOAP_REQUEST_INPUT_PARAMS, SOAP_REQUEST_OUTPUT, STATIC_VALUES_INPUT_PARAMS, STATIC_VALUES_OUTPUT, type Schema, type SchemaField, type SchemaType, SchemaTypes, type ScopeDefinition, type Settings, type SimpleStep, type Source, SourceType, type Step, type StepFunction, type StepFunctionMeta, StepFunctionName, type StepFunctionOutput, type StepFunctionParams, StepFunctionsFactory, stepFunctions as StepFunctionsRegistry, type StepsSnapshots, type StreamOutputData, StreamType, type SupportConfig, type SyncParams, type SyncedAction, TYPECAST_INPUT_PARAMS, TYPECAST_OUTPUT, type TestActionConfig, type TimeFilterIncrementalConfig, TransportType, UPLOAD_BINARY_INPUT_PARAMS, UPLOAD_BINARY_OUTPUT, UPLOAD_FILE_INPUT_PARAMS, UPLOAD_FILE_OUTPUT, type WebhookSetup, type WebhookSetupPhase, type WebhookSetupPhaseKind, areCursorsEqual, buildExpressionContext, collectFieldMetaIssues, computeDataSyncFingerprint, decodeCompositeId, encodeCompositeId, evaluateEventRouter, evaluateExternalAccountIdExtractor, expandCursor, getCategoryDetails, getInputEnumValues, getIteratorLocation, getPaginationKeys, isBareJexl, isCompositeId, isCoreError, isCursorEmpty, isForeachStep, isValidCategory, isValidEnumRef, minifyCursor, stripIncrementalParams, stripPaginationParams, updateCursor };