Use enum and union types for better field type definitions.

Author: scatcher

package.json

@@ -1,9 +1,11 @@
 {
     "name": "angular-point",
     "description": "A library designed to allow Angular2 to work with SharePoint's SOAP API's.",
-    "authors": ["Scott <[email protected]>"],
+    "authors": [
+        "Scott <[email protected]>"
+    ],
     "homepage": "https://github.com/scatcher/angular-point",
-    "version": "6.2.0",
+    "version": "6.3.0",
     "license": "MIT",
     "angular-cli": {},
     "scripts": {

src/angular-point.ts

@@ -1,25 +1,26 @@
 import * as angular from 'angular';
-
 import { DefaultFields } from './constants/apDefaultFields';
 import { DefaultListItemQueryOptions } from './constants/apDefaultListItemQueryOptions';
 import { BasePermissionObject, UserPermissionsObject } from './constants/apPermissionObject';
 import { WebServiceOperationConstants } from './constants/apWebServiceOperationConstants';
 import { XMLFieldAttributeTypes } from './constants/apXMLFieldAttributeTypes';
 import { XMLListAttributeTypes } from './constants/apXMLListAttributeTypes';
 import { CamlFactory } from './factories/apCamlFactory';
-import { FieldFactory, FieldConfigurationObject, FieldDefinition } from './factories/apFieldFactory';
-import { IndexedCacheFactory, IndexedCache } from './factories/apIndexedCacheFactory';
-import { ListItemFactory, ListItem } from './factories/apListItemFactory';
-import { ModelFactory, Model, QueriesContainer } from './factories/apModelFactory';
+import { FieldConfigurationObject, FieldDefinition, FieldFactory } from './factories/apFieldFactory';
+import { IndexedCache, IndexedCacheFactory } from './factories/apIndexedCacheFactory';
+import { List } from './factories/apListFactory';
+import { ListItem, ListItemFactory } from './factories/apListItemFactory';
 import {
-    ListItemVersionFactory,
     ChangeSummary,
-    VersionSummary,
     ListItemVersion,
+    ListItemVersionFactory,
+    VersionSummary,
 } from './factories/apListItemVersionFactory';
-import { LookupFactory, Lookup } from './factories/apLookupFactory';
-import { QueryFactory, Query } from './factories/apQueryFactory';
-import { UserFactory, User } from './factories/apUserFactory';
+import { Lookup, LookupFactory } from './factories/apLookupFactory';
+import { Model, ModelFactory, QueriesContainer } from './factories/apModelFactory';
+import { Query, QueryFactory } from './factories/apQueryFactory';
+import { User, UserFactory } from './factories/apUserFactory';
+import { FieldTypeEnum, FieldTypeUnion, XMLFieldDefinition, XMLGroup, XMLList, XMLUser } from './interfaces';
 import { UserModel } from './models/apUserModel';
 import { CacheService } from './services/apCacheService';
 import { ChangeService } from './services/apChangeService';
@@ -30,14 +31,12 @@ import { exceptionLoggingService } from './services/apExceptionHandlerService';
 import { ExportService } from './services/apExportService';
 import { FieldService } from './services/apFieldService';
 import { FormattedFieldValueService } from './services/apFormattedFieldValueService';
+import { LogEvent, Logger } from './services/apLogger';
+import { LookupCacheService } from './services/apLookupCacheService';
 import { SPServicesCore } from './services/apSPServices';
-import { Logger, LogEvent } from './services/apLogger';
 import { UtilityService } from './services/apUtilityService';
 import { WebServiceService } from './services/apWebServiceService';
 import { XMLToJSONService } from './services/apXMLToJSONService';
-import { List, ListFieldMapping } from './factories/apListFactory';
-import { LookupCacheService } from './services/apLookupCacheService';
-import { FieldTypeEnum, XMLUser, XMLGroup, XMLFieldDefinition, XMLList } from './interfaces';
 
 export let $AP_INJECTOR: ng.auto.IInjectorService;
 
@@ -111,6 +110,7 @@ export {
     FieldConfigurationObject,
     FieldDefinition,
     FieldTypeEnum,
+    FieldTypeUnion,
     IndexedCache,
     IndexedCacheFactory,
     List,

src/factories/apFieldFactory.ts

@@ -1,9 +1,9 @@
 import * as _ from 'lodash';
+import { FieldTypeEnum, FieldTypeUnion, XMLFieldDefinition } from '../interfaces';
 import { FieldService } from '../services/apFieldService';
-import { UtilityService } from '../services/apUtilityService';
 import { FormattedFieldValueService } from '../services/apFormattedFieldValueService';
+import { UtilityService } from '../services/apUtilityService';
 import { ListItem } from './apListItemFactory';
-import { XMLFieldDefinition, FieldTypeEnum } from '../interfaces';
 
 let apFieldService: FieldService,
     apUtilityService: UtilityService,
@@ -17,7 +17,7 @@ export interface FieldConfigurationObject {
     label?: string;
     // JS property name that we use to store the value for this field.
     mappedName: string;
-    objectType: FieldTypeEnum;
+    objectType: FieldTypeUnion;
     readOnly?: boolean;
     required?: boolean;
     staticName: string;

src/interfaces/field-types.enum.ts

@@ -1,4 +1,5 @@
 export enum FieldTypeEnum {
+    Attachments = 'Attachments',
     Boolean = 'Boolean',
     Calculated = 'Calculated',
     Choice = 'Choice',
@@ -21,3 +22,25 @@ export enum FieldTypeEnum {
     Integer = 'Integer',
     Float = 'Float',
 }
+
+export type FieldTypeUnion =
+    | FieldTypeEnum.Attachments
+    | FieldTypeEnum.Boolean
+    | FieldTypeEnum.Calculated
+    | FieldTypeEnum.Choice
+    | FieldTypeEnum.Counter
+    | FieldTypeEnum.Currency
+    | FieldTypeEnum.DateTime
+    | FieldTypeEnum.Lookup
+    | FieldTypeEnum.LookupMulti
+    | FieldTypeEnum.Mask
+    | FieldTypeEnum.MultiChoice
+    | FieldTypeEnum.Note
+    | FieldTypeEnum.Number
+    | FieldTypeEnum.Text
+    | FieldTypeEnum.User
+    | FieldTypeEnum.UserMulti
+    | FieldTypeEnum.JSON
+    | FieldTypeEnum.HTML
+    | FieldTypeEnum.Integer
+    | FieldTypeEnum.Float;