@automateinc/fleet-types 1.0.81 → 1.0.83-dev.5e169bc

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/client-quotation-position-version.d.ts

@@ -10,12 +10,7 @@ export interface IClientQuotationPositionVersion {
 	positionVersionId?: string | null;
 
 	name: string;
-	status:
-		| "UNVERIFIED"
-		| "PENDING_VERIFICATION"
-		| "VERIFIED"
-		| "REJECTED"
-		| "CHANGES_NEEDED";
+	status: "UNVERIFIED" | "PENDING_VERIFICATION" | "VERIFIED" | "REJECTED" | "CHANGES_NEEDED";
 	reason?: string | null;
 
 	coversSaturday: boolean;
@@ -31,4 +26,4 @@ export interface IClientQuotationPositionVersion {
 	gender?: IGender | null;
 
 	metadata?: any;
-}
+}

package/dist/types/client-quotation-site-draft.d.ts

@@ -10,4 +10,4 @@ export interface IClientQuotationSiteDraft {
 	name: string;
 
 	metadata?: any;
-}
+}

package/dist/types/client-status-check-requirement-condition-group.d.ts

@@ -8,4 +8,4 @@ export interface IClientStatusCheckRequirementConditionGroup {
 	operator?: string;
 	conditions?: IClientStatusCheckRequirementCondition[];
 	metadata?: any;
-}
+}

package/dist/types/client-status-check-requirement-condition.d.ts

@@ -12,4 +12,4 @@ export interface IClientStatusCheckRequirementCondition {
 	compareValueNumber?: number;
 	compareValueString?: string;
 	metadata?: any;
-}
+}

package/dist/types/contract-cost.d.ts

@@ -3,15 +3,15 @@ export interface IContractCost {
 	createdAt: string;
 	updatedAt: string;
 
-  name: string;
-  value: number;
+	name: string;
+	value: number;
 
-  recurrence: "ONE_TIME" | "RECURRING";
+	recurrence: "ONE_TIME" | "RECURRING";
 
-  duration?: number;
-  durationType?: "DAY" | "WEEK" | "MONTH" | "YEAR";
+	duration?: number;
+	durationType?: "DAY" | "WEEK" | "MONTH" | "YEAR";
 
-  contractId: string;
+	contractId: string;
 
-  metadata?: any;
+	metadata?: any;
 }

package/dist/types/contract-snapshot-allowance.d.ts

@@ -21,4 +21,4 @@ export interface IContractSnapshotAllowance {
 	companyId?: string;
 
 	metadata?: any;
-}
+}

package/dist/types/contract-snapshot-benefit.d.ts

@@ -12,4 +12,4 @@ export interface IContractSnapshotBenefit {
 	companyId?: string;
 
 	metadata?: any;
-}
+}

package/dist/types/contract-snapshot-cost.d.ts

@@ -15,4 +15,4 @@ export interface IContractSnapshotCost {
 	durationType?: "DAY" | "WEEK" | "MONTH" | "YEAR";
 
 	metadata?: any;
-}
+}

package/dist/types/contract-snapshot-deduction.d.ts

@@ -16,4 +16,4 @@ export interface IContractSnapshotDeduction {
 	companyId?: string;
 
 	metadata?: any;
-}
+}

package/dist/types/contract-snapshot.d.ts

@@ -23,4 +23,4 @@ export interface IContractSnapshot {
 	contractualAllowancesProvided: boolean;
 
 	metadata?: any;
-}
+}

package/dist/types/employee-group-cost.d.ts

@@ -14,4 +14,4 @@ export interface IEmployeeGroupCost {
 	employeeGroupId: string;
 
 	metadata?: any;
-}
+}

package/dist/types/employee-group-snapshot-cost.d.ts

@@ -15,4 +15,4 @@ export interface IEmployeeGroupSnapshotCost {
 	durationType?: "DAY" | "WEEK" | "MONTH" | "YEAR";
 
 	metadata?: any;
-}
+}

package/dist/types/employee-group-snapshot.d.ts

@@ -8,4 +8,4 @@ export interface IEmployeeGroupSnapshot {
 	regionId: string;
 
 	metadata?: any;
-}
+}

package/dist/types/index.d.ts

@@ -190,6 +190,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/shift.d.ts

@@ -5,7 +5,7 @@ export interface IShift {
 	updatedAt: Date;
 	createdAt: Date;
 
-	class: "MAIN" | "OVERTIME";
+	class: "MAIN" | "OVERTIME" | "FLEXIBLE";
 
 	startTime: number;
 

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

@@ -0,0 +1,166 @@
+import { IModel } from "./models";
+
+export type StructuredContentTextVariant = "H1" | "H2" | "H3" | "H4" | "H5" | "H6" | "PARAGRAPH" | "TEXT";
+export type StructuredContentLinkVariant = "BUTTON" | "LINK";
+export type StructuredContentTableColumnType =
+	| "BOOLEAN"
+	| "DATE"
+	| "DATETIME"
+	| "DEFAULT_AVATAR"
+	| "LINK"
+	| "NUMBER"
+	| "TAG"
+	| "TEXT"
+	| "TIME";
+export type StructuredContentTableSortType = "date" | "number" | "string";
+export type StructuredContentTableToolbarFilterType = "DATE_RANGE" | "SELECT";
+export type StructuredContentLayoutWidth = "auto" | "full" | "half" | "third";
+export type StructuredContentLayoutAlign = "center" | "end" | "start";
+export type StructuredContentLayoutSpacing = "lg" | "md" | "none" | "sm";
+export type StructuredContentTagTone = "danger" | "default" | "info" | "success" | "warning";
+
+export interface IStructuredContentTagValue {
+	label: string;
+	tone?: StructuredContentTagTone;
+}
+
+export interface IStructuredContentDefaultAvatarValue {
+	inactive?: boolean;
+	onLeave?: boolean;
+	src: string;
+}
+
+export interface IStructuredContentNodeLayout {
+	align?: StructuredContentLayoutAlign;
+	gap?: StructuredContentLayoutSpacing;
+	hidden?: boolean;
+	marginBottom?: StructuredContentLayoutSpacing;
+	marginTop?: StructuredContentLayoutSpacing;
+	paddingX?: StructuredContentLayoutSpacing;
+	paddingY?: StructuredContentLayoutSpacing;
+	width?: StructuredContentLayoutWidth;
+}
+
+export interface IStructuredContentTableToolbarFilter {
+	columnKey: string;
+	type?: StructuredContentTableToolbarFilterType;
+}
+
+export interface IStructuredContentTableToolbar {
+	filters?: IStructuredContentTableToolbarFilter[];
+	search?: boolean;
+}
+
+export interface IStructuredContentTablePagination {
+	pageSize?: number;
+}
+
+export interface IStructuredContentTableColumn {
+	config?: {
+		size?: number;
+	};
+	id: string;
+	name?: string;
+	sortType?: StructuredContentTableSortType;
+	sortable?: boolean;
+	type: StructuredContentTableColumnType;
+}
+
+export interface IStructuredContentNodeBase {
+	id: string;
+	layout?: IStructuredContentNodeLayout;
+	type: "COLLAPSE" | "DEFAULT_AVATAR" | "LINK" | "SPACE" | "TABLE" | "TAG" | "TEXT";
+}
+
+export interface IStructuredContentCollapseNode extends IStructuredContentNodeBase {
+	children?: IStructuredContentNode[];
+	config?: {
+		title?: string;
+	};
+	type: "COLLAPSE";
+}
+
+export interface IStructuredContentDefaultAvatarNode extends IStructuredContentNodeBase {
+	config?: {
+		size?: number;
+	};
+	type: "DEFAULT_AVATAR";
+}
+
+export interface IStructuredContentSpaceNode extends IStructuredContentNodeBase {
+	children?: IStructuredContentNode[];
+	type: "SPACE";
+}
+
+export interface IStructuredContentTextNode extends IStructuredContentNodeBase {
+	config?: {
+		variant?: StructuredContentTextVariant;
+	};
+	type: "TEXT";
+}
+
+export interface IStructuredContentTagNode extends IStructuredContentNodeBase {
+	config?: {
+		tone?: StructuredContentTagTone;
+	};
+	type: "TAG";
+}
+
+export interface IStructuredContentLinkNode extends IStructuredContentNodeBase {
+	config?: {
+		variant?: StructuredContentLinkVariant;
+	};
+	type: "LINK";
+}
+
+export interface IStructuredContentTableNode extends IStructuredContentNodeBase {
+	config?: {
+		columns?: IStructuredContentTableColumn[];
+		pagination?: IStructuredContentTablePagination;
+		toolbar?: IStructuredContentTableToolbar;
+	};
+	type: "TABLE";
+}
+
+export type IStructuredContentNode =
+	| IStructuredContentCollapseNode
+	| IStructuredContentDefaultAvatarNode
+	| IStructuredContentLinkNode
+	| IStructuredContentSpaceNode
+	| IStructuredContentTagNode
+	| IStructuredContentTableNode
+	| IStructuredContentTextNode;
+
+export interface IStructuredContentLinkValue {
+	href: string;
+	target?: string;
+	title: string;
+}
+
+export type StructuredContentPrimitiveValue = boolean | number | string | null;
+export type StructuredContentAvatarValue = IStructuredContentDefaultAvatarValue;
+export type StructuredContentTaggableValue = IStructuredContentTagValue | StructuredContentPrimitiveValue;
+export type IStructuredContentTableRow = Record<
+	string,
+	IStructuredContentLinkValue | StructuredContentAvatarValue | StructuredContentTaggableValue
+>;
+export type StructuredContentDataValue =
+	| IStructuredContentDefaultAvatarValue
+	| IStructuredContentLinkValue
+	| IStructuredContentTagValue
+	| IStructuredContentTableRow[]
+	| StructuredContentPrimitiveValue;
+export type IStructuredContentData = Record<string, StructuredContentDataValue>;
+
+export interface IStructuredContent {
+	createdAt: string;
+	data: IStructuredContentData;
+	id: string;
+	key: string;
+	metadata?: Record<string, any>;
+	rawData: unknown;
+	relation: IModel;
+	relationId: 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.81"
+  "version": "1.0.83-dev.5e169bc"
 }