@automateinc/fleet-types 1.0.80 → 1.0.81-dev.3bc0cf4

package/AGENTS.md

@@ -0,0 +1,13 @@
+# Repository Agent Instructions (`fleet-types`)
+
+## Purpose
+
+This package defines reusable base Fleet TypeScript types.
+
+## Rules
+
+1. Base types in `fleet-types` must only include scalar/model-owned fields.
+2. Do not add relation fields to base types.
+3. Do not add nested related model shapes such as `history?: IFile[]` to base types.
+4. If a frontend or endpoint needs enriched relation data, define that as a local response type in the consuming app instead of expanding the shared base type.
+5. Follow the nearest existing declaration pattern in `dist/types` for naming and field shape.

package/dist/types/index.d.ts

@@ -189,6 +189,7 @@ export * from "./shift";
 export * from "./shift-type";
 export * from "./signing-mode";
 export * from "./standard-operating-procedure";
+export * from "./structured-content";
 export * from "./tag";
 export * from "./tag-color";
 export * from "./team";

package/dist/types/structured-content.d.ts

@@ -0,0 +1,116 @@
+export type StructuredContentTextVariant = "H1" | "H2" | "H3" | "H4" | "H5" | "H6" | "PARAGRAPH" | "TEXT";
+export type StructuredContentLinkVariant = "BUTTON" | "LINK";
+export type StructuredContentTableColumnType = "BOOLEAN" | "DATE" | "DATETIME" | "LINK" | "NUMBER" | "TEXT" | "TIME";
+export type StructuredContentTableSortType = "date" | "number" | "string";
+export type StructuredContentLayoutWidth = "auto" | "full" | "half" | "third";
+export type StructuredContentLayoutAlign = "center" | "end" | "start";
+export type StructuredContentLayoutSpacing = "lg" | "md" | "none" | "sm";
+
+export interface IStructuredContentNodeLayout {
+	align?: StructuredContentLayoutAlign;
+	gap?: StructuredContentLayoutSpacing;
+	hidden?: boolean;
+	marginBottom?: StructuredContentLayoutSpacing;
+	marginTop?: StructuredContentLayoutSpacing;
+	paddingX?: StructuredContentLayoutSpacing;
+	paddingY?: StructuredContentLayoutSpacing;
+	width?: StructuredContentLayoutWidth;
+}
+
+export interface IStructuredContentTableToolbarFilter {
+	columnKey: string;
+}
+
+export interface IStructuredContentTableToolbar {
+	filters?: IStructuredContentTableToolbarFilter[];
+	search?: boolean;
+}
+
+export interface IStructuredContentTableColumn {
+	id: string;
+	name: string;
+	sortType?: StructuredContentTableSortType;
+	sortable?: boolean;
+	type: StructuredContentTableColumnType;
+}
+
+export interface IStructuredContentNodeBase {
+	id: string;
+	layout?: IStructuredContentNodeLayout;
+	type: "COLLAPSE" | "FILES" | "LINK" | "SPACE" | "TABLE" | "TEXT";
+}
+
+export interface IStructuredContentCollapseNode extends IStructuredContentNodeBase {
+	children?: IStructuredContentNode[];
+	config?: {
+		title?: string;
+	};
+	type: "COLLAPSE";
+}
+
+export interface IStructuredContentFilesNode extends IStructuredContentNodeBase {
+	config?: {
+		source?: "HISTORY";
+	};
+	type: "FILES";
+}
+
+export interface IStructuredContentSpaceNode extends IStructuredContentNodeBase {
+	children?: IStructuredContentNode[];
+	type: "SPACE";
+}
+
+export interface IStructuredContentTextNode extends IStructuredContentNodeBase {
+	config?: {
+		variant?: StructuredContentTextVariant;
+	};
+	type: "TEXT";
+}
+
+export interface IStructuredContentLinkNode extends IStructuredContentNodeBase {
+	config?: {
+		variant?: StructuredContentLinkVariant;
+	};
+	type: "LINK";
+}
+
+export interface IStructuredContentTableNode extends IStructuredContentNodeBase {
+	config?: {
+		columns?: IStructuredContentTableColumn[];
+		toolbar?: IStructuredContentTableToolbar;
+	};
+	type: "TABLE";
+}
+
+export type IStructuredContentNode =
+	| IStructuredContentCollapseNode
+	| IStructuredContentFilesNode
+	| IStructuredContentLinkNode
+	| IStructuredContentSpaceNode
+	| IStructuredContentTableNode
+	| IStructuredContentTextNode;
+
+export interface IStructuredContentLinkValue {
+	href: string;
+	target?: string;
+	title: string;
+}
+
+export type StructuredContentPrimitiveValue = boolean | number | string | null;
+export type IStructuredContentTableRow = Record<string, IStructuredContentLinkValue | StructuredContentPrimitiveValue>;
+export type StructuredContentDataValue =
+	| IStructuredContentLinkValue
+	| IStructuredContentTableRow[]
+	| StructuredContentPrimitiveValue;
+export type IStructuredContentData = Record<string, StructuredContentDataValue>;
+
+export interface IStructuredContent {
+	createdAt: string;
+	data: IStructuredContentData;
+	id: string;
+	metadata?: unknown;
+	relation: string;
+	relationId: number | string;
+	structure: IStructuredContentNode[];
+	updatedAt?: string;
+}

package/package.json

@@ -52,5 +52,5 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "types": "dist/types/index.d.ts",
-  "version": "1.0.80"
+  "version": "1.0.81-dev.3bc0cf4"
 }