@zohodesk/library-platform 1.0.0-exp.1

package/src/platform/zrecord/usecases/interactors/FetchMoreUseCase.ts

@@ -0,0 +1,24 @@
+import FetchMoreInputModel from '../interfaces/input/FetchMoreInputModel';
+import AbstractUseCase from './AbstractUseCase';
+
+class FetchMoreUseCase extends AbstractUseCase<FetchMoreInputModel> {
+  public execute(input: FetchMoreInputModel): void {
+    const { repository, presenter, templateHelpers } = this.dependencies;
+    const { props, metaData: inputMeta, dispatch, apiName, actionName } = input;
+
+    const recordManager = repository.getRecordsManagerEntity(templateHelpers);
+
+    if (!recordManager.isRecordApiName(apiName) || !recordManager.hasMoreRecords() || recordManager.isRecordsFetching()) {
+      return;
+    }
+
+    const apiDetails = recordManager.getApiDetails(actionName, props);
+    const metaData = recordManager.createFetchRecordMeta(actionName, apiName, inputMeta.headers, props);
+
+    recordManager.fetchingStarted();
+    presenter.updateRecord(recordManager.toObject());
+
+    dispatch(recordManager.createFetchAction(apiDetails, metaData));
+  }
+}
+export default FetchMoreUseCase;

package/src/platform/zrecord/usecases/interactors/FieldChangeUseCase.ts

@@ -0,0 +1,16 @@
+import FieldChangeUseCaseInput from '../interfaces/input/FieldChangeUseCaseInput';
+
+import AbstractUseCase from './AbstractUseCase';
+
+class FieldChangeUseCase extends AbstractUseCase<FieldChangeUseCaseInput> {
+  execute(input: FieldChangeUseCaseInput): void {
+    const { presenter, repository, templateHelpers } = this.dependencies;
+    const { fieldName, recordId, value } = input;
+
+    const recordManager = repository.getRecordsManagerEntity(templateHelpers);
+
+    recordManager.updateRecordField({ fieldName, recordId, value });
+    presenter.updateRecord(recordManager.toObject());
+  }
+}
+export default FieldChangeUseCase;

package/src/platform/zrecord/usecases/interactors/InitializeUseCase.ts

@@ -0,0 +1,10 @@
+import AbstractUseCase from './AbstractUseCase';
+import InitializeInputModel from '../interfaces/input/InitializeInputModel';
+
+export default class InitializeUseCase extends AbstractUseCase<InitializeInputModel> {
+  public execute(input: InitializeInputModel): void {
+    const { presenter } = this.dependencies;
+    const { apiTemplates } = input;
+    presenter.updateAPITemplates(apiTemplates);
+  }
+}

package/src/platform/zrecord/usecases/interactors/NoContentUseCase.ts

@@ -0,0 +1,22 @@
+import NoContentInputModel from '../interfaces/input/NoContentInputModel';
+
+import AbstractUseCase from './AbstractUseCase';
+
+class NoContentUseCase extends AbstractUseCase<NoContentInputModel> {
+  public execute(input: NoContentInputModel): void {
+    const { presenter, repository, templateHelpers } = this.dependencies;
+    const { dispatch, metaData } = input;
+    const recordManager = repository.getRecordsManagerEntity(templateHelpers);
+
+    if (recordManager.isFetchNoContentIrrelevantToRecord(metaData)) {
+      return;
+    }
+
+    recordManager.fetchingFinished();
+    presenter.updateRecord(recordManager.toObject());
+
+    dispatch(recordManager.createNoContentAction(metaData));
+  }
+}
+
+export default NoContentUseCase;

package/src/platform/zrecord/usecases/interactors/RecordUpdateLocalUseCase.ts

@@ -0,0 +1,16 @@
+import AbstractUseCase from './AbstractUseCase';
+import RecordUpdateLocalUseCaseInputModel from '../interfaces/input/RecordUpdateLocalUseCaseInputModel';
+import RecordFactory from '../entities-factory/RecordFactory';
+
+class RecordUpdateLocalUseCase extends AbstractUseCase<RecordUpdateLocalUseCaseInputModel> {
+  execute(input: RecordUpdateLocalUseCaseInputModel): void {
+    const { presenter, repository, templateHelpers } = this.dependencies;
+    const { recordId, record } = input;
+
+    const recordManager = repository.getRecordsManagerEntity(templateHelpers);
+    const recordEntity = RecordFactory.createSingleRecord(record);
+    recordManager.updateRecord(recordId, recordEntity);
+    presenter.updateRecord(recordManager.toObject());
+  }
+}
+export default RecordUpdateLocalUseCase;

package/src/platform/zrecord/usecases/interactors/RefetchUseCase.ts

@@ -0,0 +1,23 @@
+import RefetchInputModel from '../interfaces/input/RefetchInputModel';
+import AbstractUseCase from './AbstractUseCase';
+
+export default class RefetchUseCase extends AbstractUseCase<RefetchInputModel> {
+  execute(input: RefetchInputModel): void {
+    const { repository, presenter, templateHelpers } = this.dependencies;
+    const { props, metaData: inputMeta, dispatch, actionName, apiName } = input;
+
+    const recordManager = repository.getRecordsManagerEntity(templateHelpers);
+
+    if (!recordManager.isRecordApiName(apiName)) {
+      return;
+    }
+    recordManager.resetRecords();
+    const apiDetails = recordManager.getApiDetails(actionName, props);
+    const metaData = recordManager.createFetchRecordMeta(actionName, apiName, inputMeta.headers, props);
+
+    recordManager.fetchingStarted();
+    presenter.updateRecord(recordManager.toObject());
+
+    dispatch(recordManager.createFetchAction(apiDetails, metaData));
+  }
+}

package/src/platform/zrecord/usecases/interactors/SuccessUseCase.ts

@@ -0,0 +1,25 @@
+import SuccessInputModel from '../interfaces/input/SuccessInputModel';
+import AbstractUseCase from './AbstractUseCase';
+
+class SuccessUseCase extends AbstractUseCase<SuccessInputModel> {
+  public execute(input: SuccessInputModel): void {
+    const { repository, presenter, templateHelpers } = this.dependencies;
+    const { response, metaData, dispatch } = input;
+    const { actionName } = metaData;
+    const recordManager = repository.getRecordsManagerEntity(templateHelpers);
+
+    if (recordManager.isFetchSuccessIrrelevantToRecord(metaData)) {
+      return;
+    }
+
+    const transformer = recordManager.getTransformer(actionName);
+    const records = transformer(response);
+
+    recordManager.fetchingFinished();
+    presenter.updateRecord(recordManager.toObject());
+
+    dispatch(recordManager.createSuccessAction(records, metaData));
+  }
+}
+
+export default SuccessUseCase;

package/src/platform/zrecord/usecases/interfaces/InputDependencies.ts

@@ -0,0 +1,11 @@
+import IRepository from './gateways/IRepository';
+import { ITemplateHelpers } from './gateways/ITemplateHelpers';
+import IPresenter from './output/IPresenter';
+
+type InputDependencies = {
+  repository: IRepository;
+  templateHelpers: ITemplateHelpers;
+  presenter: IPresenter;
+};
+
+export default InputDependencies;

package/src/platform/zrecord/usecases/interfaces/gateways/IRepository.ts

@@ -0,0 +1,10 @@
+import IRecordsManager from '../../../entities/interfaces/IRecordsManager';
+import { ITemplateHelpers } from './ITemplateHelpers';
+import { State } from './State';
+
+interface IRepository {
+  init(state: State): void;
+  getRecordsManagerEntity(templateHelpers: ITemplateHelpers): IRecordsManager;
+}
+
+export default IRepository;

package/src/platform/zrecord/usecases/interfaces/gateways/IService.ts

@@ -0,0 +1,25 @@
+import InitializeUseCase from '../../interactors/InitializeUseCase';
+import ExecuteActionUseCase from '../../interactors/ExecuteActionUseCase';
+import FailureUseCase from '../../interactors/FailureUseCase';
+import SuccessUseCase from '../../interactors/SuccessUseCase';
+import RefetchUseCase from '../../interactors/RefetchUseCase';
+import NoContentUseCase from '../../interactors/NoContentUseCase';
+import AppendRecordsUseCase from '../../interactors/AppendRecordsUseCase';
+import FieldChangeUseCase from '../../interactors/FieldChangeUseCase';
+import FetchMoreUseCase from '../../interactors/FetchMoreUseCase';
+import RecordUpdateLocalUseCase from '../../interactors/RecordUpdateLocalUseCase';
+import DeleteMultipleRecordUseCase from '../../interactors/DeleteMultipleRecordUseCase';
+
+export default interface IService {
+  initializeUseCase: InitializeUseCase;
+  executeUseCase: ExecuteActionUseCase;
+  failureUseCase: FailureUseCase;
+  successUseCase: SuccessUseCase;
+  refetchUseCase: RefetchUseCase;
+  noContentUseCase: NoContentUseCase;
+  appendRecordsUseCase: AppendRecordsUseCase;
+  fieldChangeUseCase: FieldChangeUseCase;
+  fetchMoreUseCase: FetchMoreUseCase;
+  recordUpdateLocalUseCase: RecordUpdateLocalUseCase;
+  deleteMultipleRecordUseCase: DeleteMultipleRecordUseCase;
+}

package/src/platform/zrecord/usecases/interfaces/gateways/ITemplateHelpers.ts

@@ -0,0 +1 @@
+export { ITemplateHelpers } from '../../../entities/interfaces/ITemplateHelpers';

package/src/platform/zrecord/usecases/interfaces/gateways/State.ts

@@ -0,0 +1,7 @@
+import { BehaviourState } from '../../../entities/interfaces/BehaviourState';
+
+export type State = {
+  behaviours: {
+    zrecord: BehaviourState;
+  };
+};

package/src/platform/zrecord/usecases/interfaces/input/AppendRecordsInputModel.ts

@@ -0,0 +1,7 @@
+import { RecordModel } from '../../../entities/interfaces/RecordModel';
+
+type AppendRecordsInputModel = {
+  records: RecordModel[];
+};
+
+export default AppendRecordsInputModel;

package/src/platform/zrecord/usecases/interfaces/input/DeleteMultipleRecordInputModel.ts

@@ -0,0 +1,6 @@
+
+type DeleteMultipleRecordInputModel = {
+  recordIds: string[];
+};
+
+export default DeleteMultipleRecordInputModel;

package/src/platform/zrecord/usecases/interfaces/input/ExecuteActionInputModel.ts

@@ -0,0 +1,10 @@
+import MetaData from '../../../entities/interfaces/MetaData';
+
+type ExecuteActionInputModel = {
+  actionName: string;
+  apiName: string;
+  props: any;
+  dispatch: Function;
+  metaData: MetaData;
+};
+export default ExecuteActionInputModel;

package/src/platform/zrecord/usecases/interfaces/input/FailureInputModel.ts

@@ -0,0 +1,8 @@
+import MetaData from '../../../entities/interfaces/MetaData';
+
+type FailureInputModel = {
+  dispatch: Function;
+  error: any;
+  metaData: MetaData;
+};
+export default FailureInputModel;

package/src/platform/zrecord/usecases/interfaces/input/FetchMoreInputModel.ts

@@ -0,0 +1,10 @@
+import MetaData from '../../../entities/interfaces/MetaData';
+
+type FetchMoreInputModel = {
+  dispatch: Function;
+  props: any;
+  metaData: MetaData;
+  apiName: string;
+  actionName: string;
+};
+export default FetchMoreInputModel;

package/src/platform/zrecord/usecases/interfaces/input/FieldChangeUseCaseInput.ts

@@ -0,0 +1,6 @@
+type FieldChangeUseCaseInput = {
+  recordId: string;
+  fieldName: string;
+  value: any;
+};
+export default FieldChangeUseCaseInput;

package/src/platform/zrecord/usecases/interfaces/input/InitializeInputModel.ts

@@ -0,0 +1,4 @@
+import { HttpTemplates } from '@platform/data-broker/dbc';
+
+type InitializeInputModel = { apiTemplates: HttpTemplates };
+export default InitializeInputModel;

package/src/platform/zrecord/usecases/interfaces/input/NoContentInputModel.ts

@@ -0,0 +1,7 @@
+import MetaData from "../../../entities/interfaces/MetaData";
+
+type NoContentInputModel = {
+  dispatch: Function;
+  metaData: MetaData;
+};
+export default NoContentInputModel;

package/src/platform/zrecord/usecases/interfaces/input/RecordUpdateLocalUseCaseInputModel.ts

@@ -0,0 +1,7 @@
+import { RecordModel } from "../../../entities/interfaces/RecordModel";
+
+type RecordUpdateLocalUseCaseInputModel = {
+  recordId: string;
+  record: RecordModel;
+};
+export default RecordUpdateLocalUseCaseInputModel;

package/src/platform/zrecord/usecases/interfaces/input/RefetchInputModel.ts

@@ -0,0 +1,10 @@
+import MetaData from '../../../entities/interfaces/MetaData';
+
+type RefetchInputModel = {
+  actionName: string;
+  apiName: string;
+  props: any;
+  dispatch: Function;
+  metaData: MetaData;
+};
+export default RefetchInputModel;

package/src/platform/zrecord/usecases/interfaces/input/SuccessInputModel.ts

@@ -0,0 +1,8 @@
+import MetaData from '../../../entities/interfaces/MetaData';
+
+type SuccessInputModel = {
+  response: any;
+  dispatch: Function;
+  metaData: MetaData;
+};
+export default SuccessInputModel;

package/src/platform/zrecord/usecases/interfaces/output/IPresenter.ts

@@ -0,0 +1,7 @@
+type Data = { data: any[]; isFetching: boolean; hasMore?: boolean };
+
+export default interface IPresenter {
+  updateDependencies(state: any, updateState: Function): void;
+  updateRecord(zrecord);
+  updateAPITemplates(apiTemplates);
+}

package/tsconfig.json

@@ -0,0 +1,114 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    "jsx": "react" /* Specify what JSX code is generated. */,
+    "experimentalDecorators": true /* Enable experimental support for legacy experimental decorators. */,
+    "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "Preserve" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "Node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    "paths": {
+      "@library/*": ["./src/library/*"],
+      "@platform/*": ["./src/platform/*"],
+      "@cc/*": ["./src/cc/*"],
+      "@bc/*": ["./src/bc/*"]
+    } /* Specify a set of entries that re-map imports to additional lookup locations. */,
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": false /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    // "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}