Added module for Metadata with Updated tests; Published to npm.

Author: Greg DeCarlo

.gitignore

@@ -9,6 +9,8 @@
 *.userosscache
 *.sln.docstates
 
+node_modules/
+
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/

.npmignore

@@ -0,0 +1,3 @@
+*
+!dist/Dynamics/
+!dist/Query/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Scalable Dynamics, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,6 +4,13 @@ Create more applications using the Microsoft Dynamics Xrm platform
 
 > more-xrm enables querying the dynamics data model from any application
 
+License: [MIT](http://www.opensource.org/licenses/mit-license.php)
+
+## NPM
+The package name is more-xrm, you can find it here:
+
+[![NPM version](https://img.shields.io/npm/v/more-xrm.svg?style=flat)](https://www.npmjs.com/package/more-xrm)
+
 ## TypeScript Example
 
 ```typescript
@@ -30,6 +37,8 @@ async function DynamicsClientSample() {
 ## Interfaces
 
 ```typescript
+//example: const dynamicsClient = dynamics();
+
 interface Dynamics {
  batch(): DynamicsBatch;
  fetch<T>(query: Query, maxRowCount?: number): Promise<T[]>;
@@ -38,6 +47,8 @@ interface Dynamics {
 ```
 
 ```typescript
+//example: const dynamicsBatch = dynamics().batch();
+
 interface DynamicsBatch {
  execute(): Promise<any[]>;
  request(query: Query, maxRowCount?: number): DynamicsBatch;
@@ -50,6 +61,8 @@ interface DynamicsBatch {
 ```
 
 ```typescript
+//example: const dynamicsQuery = dynamics().query('entityLogicalName','entitySetName');
+
 interface Query {
  alias(attributeName: string, alias: string): Query;
  path(entityPath: string): Query;
@@ -61,12 +74,26 @@ interface Query {
 }
 ```
 
+```typescript
+//example: const dynamicsMetadata = dynamicsMetadata();
+
+interface DynamicsMetadata {
+ attributes(entityName: string): Promise<AttributeMetadata[]>;
+ entities(): Promise<EntityMetadata[]>;
+ entity(entityName: string): Promise<EntityAttributeMetadata>;
+}
+```
+
 ## Functions
 
 ```typescript
 function dynamics(accessToken?: string): Dynamics
 ```
 
+```typescript
+function dynamicsMetadata(accessToken?: string): DynamicsMetadata;
+```
+
 ```typescript
 function dynamicsQuery<T>(query: Query, maxRowCount?: number, headers?: any): Promise<T[]>;
 function dynamicsQueryUrl<T>(dynamicsEntitySetUrl: string, query: Query, maxRowCount?: number, headers?: any): Promise<T[]>;

build/dist/Dynamics/Dynamics.d.ts

@@ -10,6 +10,11 @@ export declare const DynamicsHeaders: {
 export interface Dynamics {
  batch(): DynamicsBatch;
  fetch<T>(query: Query, maxRowCount?: number): Promise<T[]>;
+ optionset(entityName: any, attributeName: any): Promise<{
+ label: string;
+ value: number;
+ }[]>;
+ query(entityLogicalName: string, entitySetName: string): Query;
  save(entitySetName: string, data: any, id?: string): Promise<string>;
 }
 export default function dynamics(accessToken?: string): Dynamics;

build/dist/Dynamics/Dynamics.js

@@ -1,3 +1,4 @@
+import query from "../Query/Query";
 import { dynamicsQuery, dynamicsSave, dynamicsRequest } from "./DynamicsRequest";
 import { dynamicsBatch } from "./DynamicsBatch";
 export const WebApiVersion = 'v9.1';
@@ -12,25 +13,27 @@ export default function dynamics(accessToken) {
 }
 class DynamicsClient {
  constructor(accessToken) {
- if (accessToken) {
- this.dynamicsHeaders = {
- 'Authorization': 'Bearer ' + accessToken
- };
- }
+ this.dynamicsHeaders = accessToken && {
+ 'Authorization': 'Bearer ' + accessToken
+ };
  }
  batch() {
  return dynamicsBatch(this.dynamicsHeaders);
  }
  fetch(query, maxRowCount = DefaultMaxRecords) {
  return dynamicsQuery(query, maxRowCount, this.dynamicsHeaders);
  }
- save(entitySetName, data, id) {
- return dynamicsSave(entitySetName, data, id, this.dynamicsHeaders);
- }
  optionset(entityName, attributeName) {
- return dynamicsRequest(`/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes(LogicalName='${attributeName}')/Microsoft.Dynamics.CRM.PicklistAttributeMetadata?$select=LogicalName&$expand=OptionSet($select=Options),GlobalOptionSet($select=Options)`).then(attribute => (attribute.OptionSet || attribute.GlobalOptionSet).Options.map((option) => ({
- label: option.Label.UserLocalizedLabel.Label,
+ return dynamicsRequest(`/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes(LogicalName='${attributeName}')/Microsoft.Dynamics.CRM.PicklistAttributeMetadata?$select=LogicalName&$expand=OptionSet($select=Options),GlobalOptionSet($select=Options)`, this.dynamicsHeaders)
+ .then(attribute => (attribute.OptionSet || attribute.GlobalOptionSet).Options.map((option) => ({
+ label: (option.Label && option.Label.UserLocalizedLabel && option.Label.UserLocalizedLabel.Label),
  value: option.Value
  })));
  }
+ query(entityLogicalName, entitySetName) {
+ return query(entityLogicalName).path(entitySetName);
+ }
+ save(entitySetName, data, id) {
+ return dynamicsSave(entitySetName, data, id, this.dynamicsHeaders);
+ }
 }

build/dist/Dynamics/DynamicsMetadata.d.ts

@@ -0,0 +1,27 @@
+export default function dynamicsMetadata(accessToken?: string): DynamicsMetadata;
+export interface DynamicsMetadata {
+ attributes(entityName: string): Promise<AttributeMetadata[]>;
+ entities(): Promise<EntityMetadata[]>;
+ entity(entityName: string): Promise<EntityAttributeMetadata>;
+}
+export interface EntityMetadata {
+ LogicalName: string;
+ EntitySetName: string;
+ DisplayName: string;
+ Description: string;
+}
+export interface EntityAttributeMetadata extends EntityMetadata {
+ Attributes: AttributeMetadata[];
+}
+export interface AttributeMetadata {
+ LogicalName: string;
+ DisplayName: string;
+ Type: AttributeTypeCode;
+ LookupEntityName?: string;
+ PicklistOptions?: OptionSetMetadata[];
+}
+export interface OptionSetMetadata {
+ Label: string;
+ Value: number;
+}
+export declare type AttributeTypeCode = 'BigInt' | 'Boolean' | 'Customer' | 'DateTime' | 'Decimal' | 'Double' | 'Integer' | 'Lookup' | 'Memo' | 'Money' | 'PartyList' | 'Picklist' | 'State' | 'Status' | 'String';

build/dist/Dynamics/DynamicsMetadata.js

@@ -0,0 +1,75 @@
+import { dynamicsRequest } from "./DynamicsRequest";
+import { dynamicsBatch } from "./DynamicsBatch";
+import { WebApiVersion } from "./Dynamics";
+export default function dynamicsMetadata(accessToken) {
+ return new DynamicsMetadataClient(accessToken);
+}
+const ExcludedAttributeFilters = {
+ 'Uniqueidentifier': 'AttributeType',
+ 'CalendarRules': 'AttributeType',
+ 'EntityName': 'AttributeType',
+ 'ManagedProperty': 'AttributeType',
+ 'Owner': 'AttributeType',
+ 'Virtual': 'AttributeType',
+ 'Lookup': 'AttributeType',
+ 'Picklist': 'AttributeType',
+ 'Status': 'AttributeType',
+ 'State': 'AttributeType',
+ 'yomi': "contains(LogicalName,'yomi')",
+ 'base': "endswith(LogicalName,'base')"
+};
+class DynamicsMetadataClient {
+ constructor(accessToken) {
+ this.dynamicsHeaders = accessToken && {
+ 'Authorization': 'Bearer ' + accessToken
+ };
+ }
+ attributes(entityName) {
+ const properties = ["AttributeType", "DisplayName", "LogicalName", "SchemaName", "IsCustomAttribute"];
+ const filter = Object.keys(ExcludedAttributeFilters).map(v => (ExcludedAttributeFilters[v] == 'AttributeType' && `AttributeType ne Microsoft.Dynamics.CRM.AttributeTypeCode'${v}'`) || v).join(' and ');
+ return dynamicsBatch(this.dynamicsHeaders)
+ .requestAllUrls([
+ `/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes?$select=${properties}&$filter=${filter}`,
+ `/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes/Microsoft.Dynamics.CRM.LookupAttributeMetadata?$select=${properties},Targets`,
+ `/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes/Microsoft.Dynamics.CRM.PicklistAttributeMetadata?$select=${properties}&$expand=OptionSet($select=Options)`,
+ `/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes/Microsoft.Dynamics.CRM.StatusAttributeMetadata?$select=${properties}&$expand=OptionSet($select=Options)`,
+ `/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')/Attributes/Microsoft.Dynamics.CRM.StateAttributeMetadata?$select=${properties}&$expand=OptionSet($select=Options)`
+ ])
+ .execute()
+ .then(data => this.flatten(data)
+ .map((attribute) => ({
+ LogicalName: attribute.LogicalName,
+ DisplayName: (attribute.DisplayName && attribute.DisplayName.UserLocalizedLabel && attribute.DisplayName.UserLocalizedLabel.Label) || attribute.LogicalName,
+ Type: attribute.AttributeType,
+ LookupEntityName: attribute.Targets && attribute.Targets[0],
+ PicklistOptions: attribute.OptionSet && attribute.OptionSet.Options.map((opt) => ({
+ Label: (opt.Label && opt.Label.UserLocalizedLabel && opt.Label.UserLocalizedLabel.Label),
+ Value: opt.Value
+ }))
+ })));
+ }
+ entities() {
+ return dynamicsRequest(`/api/data/${WebApiVersion}/EntityDefinitions?$select=EntitySetName,Description,DisplayName,LogicalName,PrimaryIdAttribute,PrimaryNameAttribute,IconSmallName,IsActivity,IsCustomEntity`, this.dynamicsHeaders)
+ .then(data => data
+ .map(entity => ({
+ LogicalName: entity.LogicalName,
+ EntitySetName: entity.EntitySetName,
+ DisplayName: (entity.DisplayName && entity.DisplayName.UserLocalizedLabel && entity.DisplayName.UserLocalizedLabel.Label) || entity.LogicalName,
+ Description: (entity.Description && entity.Description.UserLocalizedLabel && entity.Description.UserLocalizedLabel.Label) || ''
+ })));
+ }
+ entity(entityName) {
+ return dynamicsRequest(`/api/data/${WebApiVersion}/EntityDefinitions(LogicalName='${entityName}')?$select=EntitySetName,Description,DisplayName,LogicalName,PrimaryIdAttribute,PrimaryNameAttribute,IconSmallName,IsActivity,IsCustomEntity`, this.dynamicsHeaders)
+ .then(entity => this.attributes(entityName)
+ .then(attributes => ({
+ LogicalName: entity.LogicalName,
+ EntitySetName: entity.EntitySetName,
+ DisplayName: (entity.DisplayName && entity.DisplayName.UserLocalizedLabel && entity.DisplayName.UserLocalizedLabel.Label) || entity.LogicalName,
+ Description: (entity.Description && entity.Description.UserLocalizedLabel && entity.Description.UserLocalizedLabel.Label) || '',
+ Attributes: attributes
+ })));
+ }
+ flatten(values) {
+ return [].concat(...values);
+ }
+}

build/dist/Query/Query.d.ts

@@ -23,12 +23,13 @@ export interface Query {
  alias(attributeName: string, alias: string): Query;
  path(entityPath: string): Query;
  select(...attributeNames: string[]): Query;
- where(attributeName: string, operator: QueryOperator, ...values: any[]): Query;
- whereAny(any: (or: (attributeName: string, operator: QueryOperator, ...values: any[]) => void) => void): Query;
+ where(attributeName: string, operator: QueryOperatorParam, ...values: any[]): Query;
+ whereAny(any: (or: (attributeName: string, operator: QueryOperatorParam, ...values: any[]) => void) => void): Query;
  orderBy(attributeName: string, isDescendingOrder?: boolean): Query;
  join(entityName: string, fromAttribute: string, toAttribute?: string, alias?: string, isOuterJoin?: boolean): Query;
  Query: DataQuery;
 }
+export declare type QueryOperatorParam = QueryOperator | QueryOperatorExpression;
 export declare enum QueryOperator {
  Contains = "like",
  StartsWith = "begins-with",
@@ -46,5 +47,6 @@ export declare enum QueryOperator {
  IsNotCurrentUser = "ne-userid",
  IsCurrentUserTeam = "eq-userteams"
 }
+export declare type QueryOperatorExpression = 'like' | 'begins-with' | 'eq' | 'neq' | 'gt' | 'lt' | 'in' | 'not-in' | 'on-or-before' | 'on-or-after' | 'null' | 'not-null' | 'eq-userid' | 'ne-userid' | 'eq-userteams';
 export default function query(entityName: string, ...attributeNames: string[]): Query;
 export declare function GetRootQuery(query: Query): DataQuery;

build/dist/tests/dynamicsMetadataTests.d.ts

@@ -0,0 +1 @@
+export declare function dynamicsMetadataRetrieveAll(): Promise<void>;