dataset-types 3.0.0 → 3.0.2

package/dist/src/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "dataset-types",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "scripts": {
-    "pretty": "prettier  src --write"
+    "build": "tsc --rootDir '.' --outDir './dist'",
+    "tsc": "tsc",
+    "pretty": "prettier  --write"
   },
   "eslintConfig": {
     "extends": [

package/src/types/index.d.ts

@@ -0,0 +1,140 @@
+type BufferEncoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex";
+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) => Promise<String | null>;
+    downloadToFile: (localfilename: string, tenantid: string, log: boolean, filetype: string, reference: string, txmode: string) => 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) => 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";
+export interface IProcessingConfig {
+    remove?: boolean;
+    record?: boolean;
+    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;
+    blobid?: string;
+    documentId?: string;
+    name?: string;
+    localfilename?: string;
+    createdAt?: string;
+    user?: string;
+    meta: {
+        documenttype: string;
+        context?: string;
+        entity?: string;
+        user?: string;
+        createdat?: string;
+        recordstatus?: string;
+        effective?: string;
+    };
+    document?: IDocument;
+    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[];
+export {};

package/src/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/index.ts

@@ -1,213 +1,225 @@
+type BufferEncoding =
+    | "ascii"
+    | "utf8"
+    | "utf-8"
+    | "utf16le"
+    | "ucs2"
+    | "ucs-2"
+    | "base64"
+    | "latin1"
+    | "binary"
+    | "hex"
+
 export interface ICommandResult {
-  status: string;
-  msg: string;
-  entity?: any;
-  log?: any[];
+    status: string;
+    msg: string;
+    entity?: any;
+    log?: any[];
 }
 
 export interface IContext {
-  context: string;
+    context: string;
 }
 export interface IName {
-  name: string;
+    name: string;
 }
 
 export interface IDataRow {
-  id: string;
+    id: string;
 }
 export interface IEntity extends IDataRow {
-  type: string;
-  delete?: string;
+    type: string;
+    delete?: string;
 }
 
-export interface INamedEntity extends IEntity, IName, IContext {}
+export interface INamedEntity extends IEntity, IName, IContext { }
 
 export interface ITimed {
-  createdBy: string;
-  createdAt: Date;
+    createdBy: string;
+    createdAt: Date;
 }
 
 export interface IDocumentReference extends IDataRow {
-  filetype: string;
-  documenttype: string;
+    filetype: string;
+    documenttype: string;
 }
 
 export interface IDocument extends INamedEntity, ITimed {
-  entity: string;
-  filetype: string;
-  documenttype: string;
+    entity: string;
+    filetype: string;
+    documenttype: string;
 }
 
 export interface IDocumentEntityLink {
-  entity: string;
-  documentId: string;
+    entity: string;
+    documentId: string;
 }
 
 export interface IConfigurationItem extends INamedEntity, ITimed {
-  itemtype: string;
-  active: boolean;
-  monitored: string;
-  baseline: string;
-  dimension: string;
-  datatypes: string;
+    itemtype: string;
+    active: boolean;
+    monitored: string;
+    baseline: string;
+    dimension: string;
+    datatypes: string;
 }
 
 export interface IPermission extends IEntity, IContext, ITimed {
-  permission: string;
-  role: string;
+    permission: string;
+    role: string;
 }
 
-export interface IDataService {}
+export interface IDataService { }
 
 export interface IModel {
-  close: any;
+    close: any;
 }
 
 export interface IModelService {
-  model: IModel;
-  seed: any;
-  upsert: (type: string, entity: any[]) => Promise<IPersistResult>;
-  upsertBatch: (type: string, entity: any[]) => Promise<IPersistResult>;
+    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>;
+    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[]>;
+    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>;
+    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[];
+    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;
+    data: any[] | any;
+    error?: string;
 }
 
 export interface ILogStatus {
-  archiveid: string;
-  error?: string;
+    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[];
+    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;
+    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;
+    context: string;
+    id: string;
+    filename: string;
+    lastModified: string;
+    filetype: string;
+    recordtype: string;
+    entity: string;
 };
 
 export type IDatasetFiles = {
-  count: number;
-  files: IDatasetFile[];
+    count: number;
+    files: IDatasetFile[];
 };
 
 export type IDayRange = number[];

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+        "declaration": true,
+        "lib": [
+            "es2019",
+            "es2020.promise",
+            "es2020.bigint",
+            "es2020.string"
+        ],
+        "module": "commonjs",
+        "target": "es2019",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+    },
+    "include": [
+        "src/**/*",
+        "test/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "**/*.spec.ts"
+    ]
+}