@tsed/formio-types 8.0.0 → 8.0.2

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/formio-types",
   "description": "Formio types definition package for Ts.ED framework",
   "type": "module",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "keywords": [
     "Formio",
     "Ts.ED",
@@ -17,6 +17,7 @@
   "typings": "./lib/types/index.d.ts",
   "exports": {
     ".": {
+      "@tsed/source": "./src/index.ts",
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
       "default": "./lib/esm/index.js"
@@ -35,8 +36,8 @@
     "formiojs": ">=4.0.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.0.0",
-    "@tsed/typescript": "8.0.0",
+    "@tsed/barrels": "8.0.2",
+    "@tsed/typescript": "8.0.2",
     "eslint": "9.12.0",
     "typescript": "5.4.5"
   },

package/src/domain/FormioAccess.ts

@@ -0,0 +1,5 @@
+export interface FormioAccess {
+  _id: string | undefined;
+  type: string;
+  resources: any[];
+}

package/src/domain/FormioAction.ts

@@ -0,0 +1,12 @@
+export interface FormioAction<Settings = any> {
+  name: string;
+  title: string;
+  action: string;
+  handler: string[];
+  method: string[];
+  priority: number;
+  form: any;
+  settings: Settings;
+  condition?: any;
+  deleted?: number | null;
+}

package/src/domain/FormioActionInfo.ts

@@ -0,0 +1,14 @@
+export interface FormioActionInfo {
+  name: string;
+  title: string;
+  description: string;
+  priority: number;
+  defaults: {
+    handler: string[];
+    method: string[];
+  };
+  access?: {
+    handler: boolean;
+    method: boolean;
+  };
+}

package/src/domain/FormioActionItem.ts

@@ -0,0 +1,12 @@
+export interface FormioActionItem<Data = any> {
+  _id: string | undefined;
+  title: string;
+  form: string;
+  submission?: string;
+  action: string;
+  handler: string;
+  method: string;
+  state: "new" | "inprogress" | "complete" | "error";
+  messages: any[];
+  data: Data;
+}

package/src/domain/FormioComponent.ts

@@ -0,0 +1,22 @@
+import type {ExtendedComponentSchema} from "formiojs";
+
+import {FormioForm} from "./FormioForm.js";
+
+export interface FormioComponent extends ExtendedComponentSchema {
+  type: string;
+  key: string;
+
+  // additional props
+  template?: string;
+  dataSrc?: "json" | "url";
+  data?: {
+    json?: any;
+    url?: string;
+
+    [key: string]: any;
+  };
+  valueProperty?: string;
+  customConditional?: string;
+  components?: FormioComponent[];
+  form?: string | FormioForm;
+}

package/src/domain/FormioForm.ts

@@ -0,0 +1,58 @@
+import {FormioComponent} from "./FormioComponent.js";
+import {FormioPermission} from "./FormioPermission.js";
+
+export interface FormioForm extends Record<string, any> {
+  _id: string | undefined;
+  /**
+   * The title for the form
+   */
+  title: string;
+  /**
+   * The machine name for this form
+   */
+  name: string;
+  /**
+   * The path for this resource
+   */
+  path: string;
+  /**
+   * The form type.
+   */
+  type: string;
+  /**
+   * The display method for this form
+   */
+  display?: "form" | "wizard" | string;
+  /**
+   * A custom action URL to submit the data to.
+   */
+  action?: string;
+
+  tags?: string[];
+
+  deleted: number | null;
+  /**
+   * Access rules
+   */
+  access: FormioPermission[];
+  /**
+   * Submission access rules
+   */
+  submissionAccess: FormioPermission[];
+  /**
+   *
+   */
+  owner: string;
+  /**
+   * Components.
+   */
+  components: FormioComponent[];
+  /**
+   * Custom form settings object.
+   */
+  settings?: any;
+  /**
+   * Custom form properties.
+   */
+  properties?: any;
+}

package/src/domain/FormioPermission.ts

@@ -0,0 +1,4 @@
+export interface FormioPermission {
+  type: "create_all" | "read_all" | "update_all" | "delete_all" | "create_own" | "read_own" | "update_own" | "delete_own" | "self";
+  roles: string[];
+}

package/src/domain/FormioRole.ts

@@ -0,0 +1,8 @@
+export interface FormioRole extends Record<string, any> {
+  _id: string | undefined;
+  title: string;
+  description: string;
+  deleted: number | null;
+  default: boolean;
+  admin: boolean;
+}

package/src/domain/FormioSchema.ts

@@ -0,0 +1,6 @@
+export interface FormioSchema {
+  key: string;
+  isLocked: boolean;
+  version: string;
+  value: string;
+}

package/src/domain/FormioSubmission.ts

@@ -0,0 +1,16 @@
+import {FormioAccess} from "./FormioAccess.js";
+
+export interface FormioSubmission<Data = any> extends Record<string, any> {
+  _id: string | undefined;
+  form: string;
+  data: Data;
+  owner?: string;
+  roles?: string[];
+  access?: FormioAccess[];
+  externalIds?: {type?: string; resource?: string; id?: string}[];
+  metadata?: Record<string, any>;
+  created?: string;
+  updated?: string;
+  deleted?: string | null;
+  modified?: string;
+}

package/src/domain/FormioToken.ts

@@ -0,0 +1,5 @@
+export interface FormioToken {
+  key: string;
+  value: string;
+  expireAt: Date;
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./domain/FormioAccess.js";
+export * from "./domain/FormioAction.js";
+export * from "./domain/FormioActionInfo.js";
+export * from "./domain/FormioActionItem.js";
+export * from "./domain/FormioComponent.js";
+export * from "./domain/FormioForm.js";
+export * from "./domain/FormioPermission.js";
+export * from "./domain/FormioRole.js";
+export * from "./domain/FormioSchema.js";
+export * from "./domain/FormioSubmission.js";
+export * from "./domain/FormioToken.js";