forms-angular 0.12.0-beta.2 → 0.12.0-beta.200

package/dist/server/index.d.ts

@@ -0,0 +1,125 @@
+import {Error, Model} from "mongoose";
+import {Express} from "express";
+
+declare module fngServer {
+    export interface ISearchResult {
+        id: any,
+        text: string,
+        url?: string,
+        additional?: string,
+        resource?: string,
+        resourceText: string,
+        resourceTab?: string,
+        weighting: number,
+    }
+
+    interface IInternalSearchResult extends ISearchResult {
+        // for use in internal find - handles search result ordering etc.
+        searchImportance? : number;
+        addHits?: number;
+        matched: number[];
+        // the next two are only set where the resource options includes disambiguation instructions and multiple search results with the same text value are found...:
+        disambiguationId?: any; // this will identify the record (from another resource) that will be used to disambiguate them
+        disambiguationResource?: string ;// ...and this will identify that resource
+    }
+
+    export interface IIdIsList {
+        params: string;
+    }
+
+    export interface Path {
+    }
+
+    export interface Paths {
+        [pathName: string]: Path;
+    }
+
+    export type ISearchResultFormatter = () => Promise<ISearchResult>;
+
+    export type Dependency = {
+        resource: Resource;
+        keys: string[];
+    }
+
+    export type DependencyList = Dependency[];
+
+    export interface ResourceOptions {
+        suppressDeprecatedMessage?: boolean;
+        onRemove?: (doc, req, cb) => void;
+        handleRemove?: 'allow' | 'cascade';  // default behaviour is to prevent deletion if record is used as a foreign key
+        searchImportance?: boolean | number,
+        onSave?: (doc, req, cb) => void,
+        findFunc?: (req, cb) => void,
+        getOrgCriteria?: (userOrganisation: string) => Promise<any>
+        idIsList?: IIdIsList,
+        searchResultFormat?: ISearchResultFormatter,
+        searchOrder?: any,
+        listOrder?: any,
+        onAccess?: (req, cb) => void,
+        searchFunc?: SearchFunc;
+        synonyms? : {name: string, filter?: any}[],     // name must be lower case
+        // when performing a search, two results from this resource with the same value for .text will be disambiguated by
+        // appending the description of the record from disambiguation.resource whose id matches result[disambiguation.field]
+        disambiguation?: {
+            field: string;
+            resource: string;
+        }
+        // below here are autogenerated
+        listFields?: ListField[];   // added after preprocess
+        dependents?: DependencyList;   // can be added by generateDependencyList
+        hide? : string[];
+        paths?: Paths;
+    }
+
+    type SearchFunc = (resource: Resource,
+                       req: Express.Request,
+                       aggregationParam: any,
+                       findParam: any,
+                       sortOrder: any,
+                       limit: number | null,
+                       skip: number | null,
+                       callback: (err: Error, docs?: any[]) => void
+    ) => void;
+
+    interface ResourceExport {
+        model?: Model<any>;            // TODO TS Get rid of the ? here
+        options?: ResourceOptions;
+    }
+
+    interface Resource extends ResourceExport {
+        resourceName: string;
+    }
+
+    interface ListParams {
+        ref: Boolean;                           // The object is this a lookup?
+    }
+
+    interface ListField {
+        field: string;
+        params?: ListParams;
+    }
+
+    interface IFngPlugin {
+        plugin: (fng: any, expressApp: any, options: FngOptions) => Partial<IFngPlugin>;
+        options: any;
+        dependencyChecks? : {[resourceName: string] : DependencyList; };
+    }
+
+    interface IPluginMap {
+        [key: string]: IFngPlugin;
+    }
+
+    interface FngOptions {
+        urlPrefix?: string,
+        plugins?: IPluginMap,
+        modelFilter? : (p1: any, req: Request, resources: Resource[]) => Resource[]
+    }
+
+    type AmbiguousRecordStore<t> = { [resource: string]: t[] };
+
+    interface DisambiguatableLookupItem {
+        id: string;
+        text: string;
+        disambiguationId?: string;
+    }
+}

package/package.json

@@ -3,24 +3,24 @@
   "author": "Mark Chapman <support@forms-angular.org>",
   "description": "A form builder that sits on top of Angular.js, Twitter Bootstrap, jQuery UI, Angular-UI, Express and Mongoose.  Opinionated or what?",
   "homepage": "http://forms-angular.org",
-  "version": "0.12.0-beta.2",
+  "version": "0.12.0-beta.200",
   "engines": {
     "node": ">=8.x",
     "npm": ">=5.x"
   },
   "scripts-doc": {
-    "postinstall": "If this is not a production install we need bootstrap less files for building, and use bower to load them.  Couldn't figure out how to load two versions of same library with npm - PRs welcome."
+    "build": "If this is not a production install we need bootstrap less files for building, and use bower to load them.  Couldn't figure out how to load two versions of same library with npm - PRs welcome."
   },
   "scripts": {
-    "postinstall": "if [ -d 'node_modules/bower' ]; then bower install --config.directory=node_modules --production jquery@2.0.3 bootstrap-2-3-2=git://github.com/twbs/bootstrap.git#v2.3.2 bootstrap-3-3-7=git://github.com/twbs/bootstrap.git#v3.3.7; fi",
-    "pretest": "gulp build",
     "test": "gulp test",
-    "build": "gulp build"
+    "tidy": "find . -name '*.js' -not -path '**/node_modules/**' -and -not -path '**/website/**' -and -not -path '**/test/**' -and -not -path '**/models/**' -and -not -name 'gulpfile.js' -and -not -name 'index.js' -and -not -name 'Gruntfile.js' -and -not -name '*.conf.js' -delete && find . -name '*.map' -not -path '**/node_modules/**' -delete",
+    "build": "if [ -d 'node_modules/bower' ]; then npx bower install --config.directory=node_modules --production jquery@2.0.3 bootstrap-2-3-2=git://github.com/twbs/bootstrap.git#v2.3.2 bootstrap-3-4-0=git://github.com/twbs/bootstrap.git#v3.4.0; fi && gulp build"
   },
   "files": [
     "dist"
   ],
   "main": "dist/server/data_form.js",
+  "browser": "dist/client/index.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/forms-angular/forms-angular"
@@ -30,7 +30,8 @@
     "email": "support@reallycare.org"
   },
   "keywords": [
-    "angular",
+    "angularjs",
+    "angular js",
     "mongoose",
     "forms",
     "twitter bootstrap",
@@ -40,55 +41,55 @@
     "RESTful API"
   ],
   "dependencies": {
-    "angular": "1.6.7",
+    "angular": "1.8.3",
     "angular-elastic": "2.5.1",
-    "angular-messages": "1.6.7",
-    "angular-sanitize": "1.6.7",
-    "angular-ui-bootstrap": "1.3.2 || 2.5.0",
-    "async": "2.6.0",
-    "lodash": "^4.17.4",
+    "angular-messages": "1.8.3",
+    "angular-sanitize": "1.8.3",
+    "angular-ui-bootstrap": "1.3.2 || 2.5.6",
+    "angular-ui-grid": "4.11.1",
+    "async": "3.2.4",
+    "lodash": "^4.17.21",
     "ng-infinite-scroll": "1.3.0",
-    "node.extend": "2.0.0"
+    "node.extend": "2.0.2"
   },
   "peerDependencies": {
-    "express": "^4.16.3",
-    "mongoose": "^4.13.3"
+    "express": "^4",
+    "mongoose": "^6.1.8"
   },
   "devDependencies": {
-    "@types/angular": "^1.6.3",
-    "@types/lodash": "^4.14.85",
-    "@types/mongoose": "^4",
-    "@types/node": "^8.0.53",
-    "angular-mocks": "1.6.7",
-    "body-parser": "1.18.2",
-    "bower": "1.8.4",
-    "del": "3.0.0",
-    "express": "4.16.3",
-    "gulp": "3.9.1",
-    "gulp-angular-templatecache": "2.2.0",
-    "gulp-clean-css": "3.9.3",
+    "@types/angular": "1.8.4",
+    "@types/lodash": "4.14.191",
+    "@types/node": "^18.11.13",
+    "angular-mocks": "1.8.3",
+    "body-parser": "1.20.1",
+    "bower": "^1.8.14",
+    "del": "6.0.0",
+    "express": "4.18.2",
+    "gulp": "^4.0.2",
+    "gulp-angular-templatecache": "3.0.1",
+    "gulp-clean-css": "4.3.0",
     "gulp-concat": "2.6.1",
-    "gulp-less": "4.0.0",
-    "gulp-mocha": "5.0.0",
+    "gulp-less": "5.0.0",
+    "gulp-mocha": "8.0.0",
     "gulp-ng-annotate": "2.1.0",
-    "gulp-rename": "^1.2.2",
-    "gulp-tsc": "1.3.2",
-    "gulp-uglify": "^3.0.0",
-    "gulp-umd": "0.2.1",
-    "jasmine-core": "3.1.0",
-    "karma": "2.0.0",
-    "karma-chrome-launcher": "2.2.0",
-    "karma-firefox-launcher": "^1.1.0",
-    "karma-jasmine": "1.1.1",
-    "karma-junit-reporter": "1.2.0",
+    "gulp-rename": "2.0.0",
+    "gulp-replace": "^1.1.3",
+    "gulp-typescript": "5.0.1",
+    "gulp-uglify": "3.0.2",
+    "gulp-umd": "2.0.0",
+    "jasmine-core": "4.5.0",
+    "karma": "^6.4.1",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-firefox-launcher": "^2.1.2",
+    "karma-jasmine": "5.1.0",
+    "karma-junit-reporter": "2.0.1",
     "karma-ng-html2js-preprocessor": "1.0.0",
     "matchdep": "2.0.0",
-    "mocha": "5.0.5",
-    "mongoose": "^4",
-    "prettier": "^1.11.1",
+    "mocha": "^10.2.0",
+    "mongoose": "^6.2.10",
+    "prettier": "2.8.1",
     "pump": "3.0.0",
-    "run-sequence": "2.2.1",
-    "typescript": "^2.6.1"
+    "typescript": "4.6.3"
   },
   "license": "MIT"
 }

package/CHANGELOG.md

@@ -1,255 +0,0 @@
-# forms-angular
-
-## 0.12.0
-* Added $scope.prepareForSave API which enables easier persistence from forms not under the controller of baseCtrl (forms in modal dialogs, for example).
-* Handle date fields properly without a plugin
-* Fix duplicate ids in _select_ elements  
-### BREAKING CHANGES
-* Removed $data service (global stash).  In almost all places $data.xx can be replaced by $scope.sharedData.xx
-
-## 0.11.0 - 8 Dec 2017
-* Menu options can now be added after a promise is resolved by creating a contextMenuPromise on the controller $scope which resolves to a contextMenu array.
-* Added new registerAction method on the routing service (used by the fng-audit plugin)
-* Replaced underscore with lodash
-* Numerous small fixes (mostly to code that interacts with plugins)
-* Improved styling of invalid fields
-
-
-## 0.10.x
-Skipped to keep version numbers in sync with plugins
-
-## 0.8.x to 0.9.0
-* Remove support for (long deprecated) [fng-select2](https://github.com/forms-angular/fng-select2) in favour of (improved)
- [fng-ui-select](https://github.com/forms-angular/fng-ui-select).
-* Use [Angular UI Grid](http://ui-grid.info/) instead of older [ng-grid](https://github.com/angular-ui/ui-grid/tree/2.x) 
-in [fng-reports](https://github.com/forms-angular/fng-reports).
-
-## 0.7.0 to 0.8.1
-* Move to Angular 1.6.x
-* Allow adding _id to list fields
-* Fix bug with routing to specific tab (such as /#/collection/id/edit/tab1)
-### BREAKING CHANGES
-* The server side of forms angular is now passed a Mongoose instance:
-```
-var formsAngular = require('forms-angular');
-var express = require('express');
-var mongoose = require('mongoose');
-
-var app = express();
-var fng = new (formsAngular)(mongoose, app, {});
-```
-* If your application calls recordHandler.handleError (typically from a controller) then you will need
-to pass a response object rather than (data:any, status: number)
-
-## 0.6.0 to 0.7.0
-* Removed support for Bootstrap 2 (just in time for Bootstrap 4?)
-* Fixed bug with ui-router setup which meant that full routes were not parsed.
-* Added internal templates for lists, edit forms and report forms (previously they were in the Yeoman generator).
-* Internal templates can be over-ridden by specifying a templateFolder property in the routing config.
-### BREAKING CHANGES
-* To use the edit / list / report templates from a pre 0.7.0 application you must specify a templateFolder property of 'partials' when starting the routingService when configuring forms-angular
-* Removed support for Bootstrap 2 (though your BS2 apps should still work - www.forms-angular.org is still BS2)   
-* Some changes required by updating angular-ui-bootstrap dependency.  In particular drop down menus now need uib-dropdown-menu to be an attribute not a class      
-
-## 0.5.1 to 0.6.0
-* Upgrade to angular-ui-bootstrap 0.14.x, which drops support for Bootstrap 2 (but seems to work fine for the forms-angular.org website, which is BS2)
-* Start specifying versions in npm and bower.
-* Several small fixes
-
-## 0.5.0 to 0.5.1
-* Fix stupid dependency error for Angular
-
-## 0.4 to 0.5
-### Summary
-* Changed development language to typescript and added _some_ types
-* Moved to gulp for build processing
-* Added ng-messages for field level errors
-* Required and readonly now work consistently across input types
-* Added error-display directive for form level errors
-* Some styling improvements for required fields and mobile
-* Added support for ui-select plugin, and in so doing added new services (formMarkupHelper, pluginHelper) that make it
-much easier to add new plugins.
-
-### BREAKING CHANGES
-* Changed id generation to remove . characters.  This may break some tests (but the . characters themselves were upsetting 
-some testing software).
-* Removed body padding from styling.  If you use a navbar you should put body {padding-top: 40px} (or required navbar height) in your styling. 
-* Hidden fields that are also list fields are still not displayed on forms, but now _are_ added to the list schema (so appear in lookups etc).
-
-## 0.3 to 0.4
-### Summary
-* Split the project into multiple repos and made a yeoman generator
-* Removes dependence on jQuery
-* ngRoute is no longer a dependency - either ngRoute or ui.router can be used, and a new provider allows the choice to be
-set up as follows:
-```
-  formsAngular.config(['routingServiceProvider', function (routingService) {
-      routingService.setOptions({html5Mode: true, routing: 'ngroute'});
-      }]);
-```      
-This service incorporates some of the functionality of the old form routes provider and supersedes urlService and 
-locationParse.
-
-For example in 0.3.x where you had something like:
-```
-plaitApp.config(['formRoutesProvider', function (formRoutes) {
-    formRoutes.setRoutes([
-        {route: '/index', options: {templateUrl: 'partials/menu.html'}},
-        {route: '/login', options: {templateUrl: 'partials/login.html' }},
-        {route: '/client/referral', options: {templateUrl: 'partials/upload', controller: 'ClientReferralCtrl'}}
-    ], '/index');
-```    
-you would have something like
-```
-formsAngular.config(['routingServiceProvider', function (routingService) {
-  routingService.start({
-    routing: 'ngroute',
-    fixedRoutes: [
-      {route: '/index', options: {templateUrl: 'partials/menu.html'}},
-      {route: '/login', options: {templateUrl: 'partials/login.html' }},
-      {route: '/404', options: {templateUrl: 'partials/404.html'}},
-      {route: '/client/referral', options: {templateUrl: 'partials/upload', controller: 'ClientReferralCtrl'}}
-    ]
-  });
-```
-* The ability to add a routing prefix has been added
- 
-### BREAKING CHANGES
-* List API returns only one field when no list fields defined (as happens on the client).
-* Hidden list fields now appear on list API response.
-* In BaseCtrl $scope.new() and $scope.delete() have been renamed ('Click' added)
-* 
-
-## 0.2 to 0.3
-### Summary
-* Improvements to routing:
- * Module specific routes are now specified with a call to the setRoutes(appRoutes, defaultRoute) method of an injected
-   formRoutesProvider - see the breaking changes section for an example and details.
- * Support for HTML5Mode and hashPrefix, including a service to simplify use
- * Support for Twitter Bootstrap 3, including a service to simplify use.  To use Bootstrap 3 you need to upgrade a few of the
- libraries that Bower installs.  Change the following lines in bower.json:
-```   
-     "angular-ui-bootstrap-bower": "0.8.0",
-     "bootstrap": "2.3.2",
-     "select2-bootstrap-css": "~1.2",
-```
-     to
-```      
-     "angular-ui-bootstrap-bower": "0.11.0",
-     "bootstrap": "3.1.1",
-     "select2-bootstrap-css": "~1.3",
-```     
-
-
-### BREAKING CHANGES
-* Routing has changed - replace
-```
-myModule.config(['$routeProvider', function ($routeProvider) {
-    $routeProvider.
-        when('/index', {templateUrl: 'partials/landing-page.html'}).
-        when('/someRoute', {templateUrl: 'partials/someTemplate.html'}).
-        ... etc ...
-        when('/analyse/:model/:reportSchemaName', {templateUrl: 'partials/base-analysis.html'}).
-        when('/analyse/:model', {templateUrl: 'partials/base-analysis.html'}).
-        when('/:model/:id/edit', {templateUrl: 'partials/base-edit.html'}).
-        when('/:model/new', {templateUrl: 'partials/base-edit.html'}).
-        when('/:model', {templateUrl: 'partials/base-list.html'}).
-        when('/:model/:form/:id/edit', {templateUrl: 'partials/base-edit.html'}).  // non default form (different fields etc)
-        when('/:model/:form/new', {templateUrl: 'partials/base-edit.html'}).       // non default form (different fields etc)
-        when('/:model/:form', {templateUrl: 'partials/base-list.html'}).           // list page with links to non default form
-        otherwise({redirectTo: '/index'});
-}]);
-```
-with
-```
-myModule.config(['formRoutesProvider', function (formRoutes) {
-	formRoutes.setRoutes([
-        {route:'/index', options:{templateUrl: 'partials/landing-page.html'}},
-        {route:'/someRoute', options:{templateUrl: 'partials/someTemplate.html'}}
-        ], '/index');
-}]);
-```
-where the first parameter is an array of objects containing a route and a set of options (which are passed straight to
-[$routeProvider](http://docs.angularjs.org/api/ngRoute/provider/$routeProvider) and the second parameter is the default route.
-* Stylesheets have moved down into a ./css folder relative to where they were, and there
-are now Bootstrap 2 and Bootstrap 3 versions.
-* You should initialise formsAngular with something similar to:
-```
-formsAngular.config(['urlServiceProvider', 'cssFrameworkServiceProvider', function (urlService, cssFrameworkService) {
-    urlService.setOptions({html5Mode: false, hashPrefix: '!'});
-    cssFrameworkService.setOptions({framework: 'bs2'});  // bs2 and bs3 are supported
-  }]);
-```
-* Report drilldowns now start from the model
-```
-drilldown: '/#/g_conditional_fields/!_id!/edit'
-drilldown: '/#!/g_conditional_fields/|_id|/edit'
-```
-both become
-```
-drilldown: 'g_conditional_fields/|_id|/edit'
-```
-
-## 0.1 to 0.2
-### Summary
-* Support for radio button groups, CKEditor
-* Internal changes to make better use of Angular JS forms capabilities
-* Added support for HTML5 input capabilities: pattern, min, max, step
-* All lookups are now handled as {id:xxx, text:yyy} on the client
-* default ids now generated by form directive (and no longer by BaseCtrl)
-* Added customFooter and customSubDoc for sub docs
-* Improvements to search: now a directive; makes use of arrow keys and escape; some bug fixes
-* showWhen conditional field display introduced (showIf will probably be deprecated)
-
-### BREAKING CHANGES
-* Changed form-input directive so that it creates a form tag, and rather than creating a <form-input>
-per sub document it now creates a <ng-form> and builds the sub-form in the same pass.  Only when using
-directives are multiple passes required.
-* Bespoke directives that use schema need to be modified (changes will normally be from something like
-```
-    var info = scope[attrs.schema][0];
-```
-to
-```
-    var info = scope[attrs.schema];
-```
-* Password type is still used generated automatically if the label contains the string 'password', but the override
-method is now to use the form type (password is it is a password, text if not).
-* We have followed ui-bootstrap's renaming of tabs / panes to tabsets / tabs, so any use of "pane" in your form objects
-needs to be changed to tab.
-* Support for allowing crawling meant that !(shriek) had to be replaced with |(pipe) in report drill down urls replacement
-* Some default id formats changed in subdocuments, which may affect tests etc
-
-## 0.0.x to 0.1.0
-### Summary
-* Started CHANGELOG.md (but for now it is far from definitive, but is intended to include all breaking changes)
-* Added support for containers (documented in Custom Form Schemas section of documentation)
-* Added reporting capability
-* New website
-
-### BREAKING CHANGES
-* Changes form-input directive so that it expects
-```
-    <form-input schema="formSchema">
-```    
-instead of
-```
-    <form-input ng-repeat="field in formSchema" info={{field}}>
-```
-* findFunc option now returns a query object such as
-```
-    {field:'value'}
-```
-rather than a MongooseJS Query such as
-```
-    model.find().where('field', 'value')
-```
-* Bespoke directives that use schema need to be modified (changes will normally be from something like
-```
-    var info = JSON.parse(attrs.info);
-```
-to
-```
-    var info = scope[attrs.schema][0];
-```
-* One formInputDone is broadcast per form (instead of per field).