@collective-intelligence/external-apps-server-sdk 0.1.1 → 0.1.2

package/dist/runtime/effect.d.ts

@@ -28,7 +28,7 @@ export type EntityInvocationContext = Readonly<{
 	resourceId: string;
 	roles: readonly string[];
 	scopes: readonly string[];
-	teamIds: readonly string[];
+	groupIds: readonly string[];
 	user: ApplicationUserIdentity;
 }>;
 export type ResourceJsonValue = null | boolean | number | string | readonly ResourceJsonValue[] | Readonly<{
@@ -431,11 +431,31 @@ export type PackageSchemaProjection = Readonly<{
 	fidelity: ProjectionFidelity;
 }>;
 export type FormLayout = "stacked" | "two_column";
-/**
- * Renderer identifier owned by the consuming product. It remains open so
- * external packages can declare their own widget implementations.
- */
-export type FormWidget = string;
+declare const plainFormWidgets: readonly [
+	"checkbox",
+	"color",
+	"date",
+	"date_range",
+	"datetime",
+	"email",
+	"file",
+	"hidden",
+	"number",
+	"password",
+	"structured_file_preview",
+	"switch",
+	"text",
+	"textarea",
+	"variable_references"
+];
+export type PlainFormWidget = (typeof plainFormWidgets)[number];
+declare const selectFormWidgets: readonly [
+	"folders_explorer",
+	"multi_select",
+	"radio",
+	"select"
+];
+export type SelectFormWidget = (typeof selectFormWidgets)[number];
 export type FieldValidationRule = Readonly<{
 	type: "required";
 	code?: string;
@@ -483,6 +503,22 @@ export type SelectOptions<Field extends string = string> = Readonly<{
 	selectionMetadataField?: Field;
 	aiFill?: DynamicFormAiFillConfig;
 }>;
+/** Options of the upload control for a manual structured-file source. */
+export type StructuredFileUploadOptions<Field extends string = string> = Readonly<{
+	/** Field that receives the format inferred from the uploaded file. */
+	formatField?: Field;
+}>;
+/** Options of the browser that picks a file from a connected source. */
+export type StructuredFileBrowserOptions<Field extends string = string> = Readonly<{
+	/** The source contribution that lists the files and its connection slot. */
+	contribution: Readonly<{
+		componentFqn: string;
+		connectionSlot: string;
+	}>;
+	label?: string;
+	/** Field that receives the format of the picked file. */
+	formatField?: Field;
+}>;
 export type VisibilityCondition<Field extends string = string> = Readonly<{
 	field: Field;
 	equals?: JsonValue;
@@ -496,8 +532,7 @@ export type FieldVisibilityRule<Field extends string = string> = Readonly<{
 	visibleWhen: VisibilityCondition<Field> | readonly VisibilityCondition<Field>[];
 	logic?: "and" | "or";
 }>;
-export type FieldUiSchema<Field extends string = string> = Readonly<{
-	"ui:widget"?: FormWidget;
+export type FieldUiBase = Readonly<{
 	"ui:placeholder"?: string;
 	"ui:help"?: string;
 	"ui:disabled"?: boolean;
@@ -505,8 +540,29 @@ export type FieldUiSchema<Field extends string = string> = Readonly<{
 	"ui:order"?: number;
 	"ui:suggestedName"?: string;
 	"ui:validation"?: readonly FieldValidationRule[];
+}>;
+export type PlainFieldUi = FieldUiBase & Readonly<{
+	"ui:widget": PlainFormWidget;
+	"ui:options"?: never;
+}>;
+/**
+ * Without a widget the renderer infers one from the field schema, and the
+ * select options apply to the inferred control.
+ */
+export type SelectFieldUi<Field extends string = string> = FieldUiBase & Readonly<{
+	"ui:widget"?: SelectFormWidget;
 	"ui:options"?: SelectOptions<Field>;
 }>;
+export type StructuredFileUploadFieldUi<Field extends string = string> = FieldUiBase & Readonly<{
+	"ui:widget": "structured_file_upload";
+	"ui:options"?: StructuredFileUploadOptions<Field>;
+}>;
+export type StructuredFileBrowserFieldUi<Field extends string = string> = FieldUiBase & Readonly<{
+	"ui:widget": "structured_file_browser";
+	"ui:options": StructuredFileBrowserOptions<Field>;
+}>;
+/** Presentation of one field; `ui:widget` selects the options contract. */
+export type FieldUiSchema<Field extends string = string> = PlainFieldUi | SelectFieldUi<Field> | StructuredFileUploadFieldUi<Field> | StructuredFileBrowserFieldUi<Field>;
 export type FormMarkdownBlock = Readonly<{
 	md: string;
 }>;