dataset-types 3.0.0

package/README.md

@@ -0,0 +1,4 @@
+# Dataset Types
+
+This project that maintains the common types for dataset applications.
+

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "dataset-types",
+  "version": "3.0.0",
+  "scripts": {
+    "pretty": "prettier  src --write"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.9",
+    "prettier": "^3.4.2",
+    "typescript": "^5.7.2"
+  }
+}

package/src/types/index.ts

@@ -0,0 +1,213 @@
+export interface ICommandResult {
+  status: string;
+  msg: string;
+  entity?: any;
+  log?: any[];
+}
+
+export interface IContext {
+  context: string;
+}
+export interface IName {
+  name: string;
+}
+
+export interface IDataRow {
+  id: string;
+}
+export interface IEntity extends IDataRow {
+  type: string;
+  delete?: string;
+}
+
+export interface INamedEntity extends IEntity, IName, IContext {}
+
+export interface ITimed {
+  createdBy: string;
+  createdAt: Date;
+}
+
+export interface IDocumentReference extends IDataRow {
+  filetype: string;
+  documenttype: string;
+}
+
+export interface IDocument extends INamedEntity, ITimed {
+  entity: string;
+  filetype: string;
+  documenttype: string;
+}
+
+export interface IDocumentEntityLink {
+  entity: string;
+  documentId: string;
+}
+
+export interface IConfigurationItem extends INamedEntity, ITimed {
+  itemtype: string;
+  active: boolean;
+  monitored: string;
+  baseline: string;
+  dimension: string;
+  datatypes: string;
+}
+
+export interface IPermission extends IEntity, IContext, ITimed {
+  permission: string;
+  role: string;
+}
+
+export interface IDataService {}
+
+export interface IModel {
+  close: any;
+}
+
+export interface IModelService {
+  model: IModel;
+  seed: any;
+  upsert: (type: string, entity: any[]) => Promise<IPersistResult>;
+  upsertBatch: (type: string, entity: any[]) => Promise<IPersistResult>;
+}
+
+export interface IFileService {
+  download2: (
+    context: string,
+    log: boolean,
+    txmode: string, //production/development/test
+    filetype: string,
+    reference: string,
+    encoding: BufferEncoding, //base64,utf-8
+  ) => Promise<String | null>;
+  downloadToFile: (
+    localfilename: string,
+    tenantid: string,
+    log: boolean,
+    filetype: string,
+    reference: string,
+    txmode: string, //production/development/test
+  ) => Promise<any>;
+  sendBlock: (
+    tenantid: string,
+    log: boolean,
+    txmode: string, //production/development/test
+    filetype: string,
+    content: string,
+    key: string, //blob id
+    sliceNumber: number,
+    totalSlices: number,
+    meta: any, //meta data
+    tags: any, //tags
+  ) => void;
+  copy: (
+    sourceContainer: string,
+    sourceFile: string,
+    targetContainer: string,
+    targetFile: string,
+  ) => Promise<void>;
+  list: (
+    tenantid: string,
+    log: boolean,
+    page: number,
+    pageSize: number,
+    term: string,
+    mode: string,
+    recordtype: string,
+    enabled: boolean,
+    order: string,
+  ) => Promise<IDatasetFiles>;
+  remove: (tenantid: string, mode: string, name: string) => Promise<boolean>;
+  setMeta: (
+    tenantid: string,
+    mode: string,
+    name: string,
+    status: string,
+  ) => Promise<boolean>;
+}
+
+export interface ILogService {
+  archive: (
+    context: string,
+    submissionid: string,
+    username: string,
+    log: ILog[],
+    processingtype?: string,
+  ) => Promise<string>;
+  list: () => Promise<string[]>;
+}
+
+export interface ISecurityMonitorService {
+  hasPermission: (
+    permission: string,
+    roles: string[],
+    context: string,
+  ) => Promise<boolean>;
+}
+
+export type IChannel = "Email" | "SMS" | "WHATSAPP"; //How to refer to domain constants
+
+export interface IProcessingConfig {
+  remove?: boolean; //controls if the file is to be processed as a delete
+  record?: boolean; //Controls if files are uploaded to storage account. Used when replaying files. Used during unit tests to skip upload.
+  modes?: IChannel[];
+}
+
+export interface IPersistResult {
+  data: any[] | any;
+  error?: string;
+}
+
+export interface ILogStatus {
+  archiveid: string;
+  error?: string;
+}
+
+export interface ILog {
+  processingType: "Monitoring" | "Submission";
+  processingConfig?: IProcessingConfig;
+  //An ILog represents the information collected while handling a file
+  blobid?: string; //id in storage account
+  documentId?: string; //when log is submitted from browser it can have a document id (TODO make this just id)
+  name?: string; //Original name of the document when originally loaded
+  localfilename?: string; //filename on node process
+  createdAt?: string;
+
+  user?: string; //upn of user
+  meta: {
+    documenttype: string; //Record or Data Type
+    context?: string; //Tenant Id
+    entity?: string; //Entity Id which contains this document
+    user?: string;
+    createdat?: string;
+    recordstatus?: string;
+    effective?: string;
+  };
+  document?: IDocument; //The document details
+  rawdata?: any[];
+}
+
+export interface IUser {
+  id: string;
+  name: string;
+  email: string;
+  mobile: string;
+  roles: string;
+  context: string;
+}
+
+export type IDatasetFile = {
+  context: string;
+  id: string;
+  filename: string;
+  lastModified: string;
+  filetype: string;
+  recordtype: string;
+  entity: string;
+};
+
+export type IDatasetFiles = {
+  count: number;
+  files: IDatasetFile[];
+};
+
+export type IDayRange = number[];