@vanillabp/bc-types 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,115 @@
+import { UserTask, Workflow, UiUriType } from '@vanillabp/bc-official-gui-client';
+
+type OpenUserTaskFunction = () => void;
+type OpenWorkflowFunction = () => void;
+type AssignFunction = (userId: string) => void;
+type UnassignFunction = (userId: string) => void;
+type ClaimFunction = () => void;
+type UnclaimFunction = () => void;
+interface BcUserTask extends UserTask {
+    open: OpenUserTaskFunction;
+    navigateToWorkflow: OpenWorkflowFunction;
+    assign: AssignFunction;
+    unassign: UnassignFunction;
+    claim: ClaimFunction;
+    unclaim: UnclaimFunction;
+}
+
+type BcUserTasksProvider = (activeOnly: boolean, limitListAccordingToCurrentUsersPermissions: boolean) => Promise<Array<BcUserTask>>;
+
+interface BcWorkflow extends Workflow {
+    navigateToWorkflow: () => void;
+    getUserTasks: BcUserTasksProvider;
+}
+
+interface BcWorkflowModule {
+    /**
+     * The workflow module of this usertask
+     * @type {string}
+     * @memberof UserTask
+     */
+    workflowModuleId: string;
+    /**
+     * An URI as an entrypoint URI for UI components. Maybe a technical URL (e.g. for WEBPACK) or an URL targeting a human readable form (e.g. EXTERNAL)
+     * @type {string}
+     * @memberof UserTask
+     */
+    uiUri: string;
+    /**
+     *
+     * @type {UiUriType}
+     * @memberof UserTask
+     */
+    uiUriType: UiUriType;
+    /**
+     * An URI pointing to the workflow-module's own API (maybe used by user-task forms)
+     * @type {string}
+     * @memberof UserTask
+     */
+    workflowModuleUri: string;
+}
+
+/**
+ * A map of language codes to their corresponding translated strings.
+ * The keys are language identifiers (e.g., 'en', 'de'),
+ * and the values are the translated versions of the same content.
+ *
+ * @example
+ *
+ * const title: Translatable = {
+ * en: "Hello",
+ * de: "Hallo",
+ * };
+ *
+ */
+interface Translatable {
+    [languageKey: string]: string;
+}
+
+interface Column {
+    title: Translatable;
+    path: string;
+    type?: 'value' | 'i18n' | 'person' | 'date' | 'date-time' | 'time';
+    priority: number;
+    width: string;
+    show: boolean;
+    sortable: boolean;
+    filterable: boolean;
+    resizeable: boolean;
+}
+
+type ColumnsOfUserTaskFunction = (userTask: UserTask) => Column[] | undefined;
+
+type ColumnsOfWorkflowFunction = (workflow: Workflow) => Column[] | undefined;
+
+type TranslationFunction = (key: string) => string;
+
+declare enum ListItemStatus {
+    INITIAL = 0,
+    NEW = 1,
+    UPDATED = 2,
+    ENDED = 3,
+    REMOVED_FROM_LIST = 4
+}
+
+interface ListItem<T> {
+    id: string;
+    number: number;
+    data: T;
+    status: ListItemStatus;
+    selected: boolean;
+    read?: Date;
+}
+
+interface Person {
+    id: string;
+    display?: string;
+    displayShort?: string;
+    email?: string;
+    avatar?: number;
+    details?: {
+        [key: string]: unknown;
+    };
+}
+
+export { type AssignFunction, type BcUserTask, type BcUserTasksProvider, type BcWorkflow, type BcWorkflowModule, type ClaimFunction, type Column, type ColumnsOfUserTaskFunction, type ColumnsOfWorkflowFunction, type ListItem, ListItemStatus, type OpenUserTaskFunction, type OpenWorkflowFunction, type Person, type Translatable, type TranslationFunction, type UnassignFunction, type UnclaimFunction };

package/dist/index.js

@@ -0,0 +1,13 @@
+// src/list/list-item-status.ts
+var ListItemStatus = /* @__PURE__ */ ((ListItemStatus2) => {
+  ListItemStatus2[ListItemStatus2["INITIAL"] = 0] = "INITIAL";
+  ListItemStatus2[ListItemStatus2["NEW"] = 1] = "NEW";
+  ListItemStatus2[ListItemStatus2["UPDATED"] = 2] = "UPDATED";
+  ListItemStatus2[ListItemStatus2["ENDED"] = 3] = "ENDED";
+  ListItemStatus2[ListItemStatus2["REMOVED_FROM_LIST"] = 4] = "REMOVED_FROM_LIST";
+  return ListItemStatus2;
+})(ListItemStatus || {});
+export {
+  ListItemStatus
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/list/list-item-status.ts"],"sourcesContent":["export enum ListItemStatus {\n  INITIAL,\n  NEW,\n  UPDATED,\n  ENDED,\n  REMOVED_FROM_LIST,\n}\n"],"mappings":";AAAO,IAAK,iBAAL,kBAAKA,oBAAL;AACL,EAAAA,gCAAA;AACA,EAAAA,gCAAA;AACA,EAAAA,gCAAA;AACA,EAAAA,gCAAA;AACA,EAAAA,gCAAA;AALU,SAAAA;AAAA,GAAA;","names":["ListItemStatus"]}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@vanillabp/bc-types",
+  "version": "0.1.1",
+  "description": "Library providing shared types for VanillaBP UI development",
+  "author": "Phactum Softwareentwicklung GmbH",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vanillabp/business-cockpit.git"
+  },
+  "homepage": "https://github.com/vanillabp/business-cockpit",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "scripts": {
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "unpublish:snapshot": "npm unpublish --force",
+    "publish:snapshot": "npm publish --tag snapshot",
+    "version:snapshot": "npm version ${npm_config_newversion} --no-git-tag-version",
+    "publish:release": "npm publish --access public"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "8.53.1",
+    "@typescript-eslint/parser": "8.53.1",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
+    "prettier": "3.8.0",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "@vanillabp/bc-official-gui-client": "0.1.1"
+  }
+}