breeze-client
Version:
Breeze data management for JavaScript clients
92 lines (89 loc) • 13.3 kB
JavaScript
import { assertConfig } from './assert-param';
import { core } from './core';
import { config } from './config';
/**
A NamingConvention instance is used to specify the naming conventions under which a MetadataStore
will translate property names between the server and the javascript client.
The default NamingConvention does not perform any translation, it simply passes property names thru unchanged.
@dynamic
**/
export class NamingConvention {
/** Function that takes a server property name add converts it into a client side property name. __Read Only__ */
serverPropertyNameToClient;
/** Function that takes a client property name add converts it into a server side property name. __Read Only__ */
clientPropertyNameToServer;
/**
NamingConvention constructor
> // A naming convention that converts the first character of every property name to uppercase on the server
> // and lowercase on the client.
> var namingConv = new NamingConvention({
> serverPropertyNameToClient: function(serverPropertyName) {
> return serverPropertyName.substr(0, 1).toLowerCase() + serverPropertyName.substr(1);
> },
> clientPropertyNameToServer: function(clientPropertyName) {
> return clientPropertyName.substr(0, 1).toUpperCase() + clientPropertyName.substr(1);
> }
> });
> var ms = new MetadataStore({ namingConvention: namingConv });
> var em = new EntityManager( { metadataStore: ms });
**/
constructor(ncConfig) {
assertConfig(ncConfig || {})
.whereParam("name").isOptional().isString()
.whereParam("serverPropertyNameToClient").isFunction()
.whereParam("clientPropertyNameToServer").isFunction()
.applyAll(this);
if (!this.name) {
this.name = core.getUuid();
}
config._storeObject(this, "NamingConvention", this.name);
}
/**
/**
A noop naming convention - This is the default unless another is specified.
**/
static none = new NamingConvention({
name: "noChange",
serverPropertyNameToClient: (serverPropertyName) => {
return serverPropertyName;
},
clientPropertyNameToServer: (clientPropertyName) => {
return clientPropertyName;
}
});
/**
The "camelCase" naming convention - This implementation only lowercases the first character of the server property name
but leaves the rest of the property name intact. If a more complicated version is needed then one should be created via the ctor.
**/
static camelCase = new NamingConvention({
name: "camelCase",
serverPropertyNameToClient: (serverPropertyName) => {
return serverPropertyName.substr(0, 1).toLowerCase() + serverPropertyName.substr(1);
},
clientPropertyNameToServer: (clientPropertyName) => {
return clientPropertyName.substr(0, 1).toUpperCase() + clientPropertyName.substr(1);
}
});
/**
The default value whenever NamingConventions are not specified.
**/
static defaultInstance = new NamingConvention(NamingConvention.none);
/**
Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance.
The current instance is returned unchanged.
> var namingConv = new NamingConvention({
> serverPropertyNameToClient: function(serverPropertyName) {
> return serverPropertyName.substr(0, 1).toLowerCase() + serverPropertyName.substr(1);
> },
> clientPropertyNameToServer: function(clientPropertyName) {
> return clientPropertyName.substr(0, 1).toUpperCase() + clientPropertyName.substr(1);
> }
> });
> namingConv.setAsDefault();
**/
setAsDefault() {
return core.setAsDefault(this, NamingConvention);
}
}
NamingConvention.prototype._$typeName = "NamingConvention";
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"naming-convention.js","sourceRoot":"","sources":["../../../src/naming-convention.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAclC;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IAK3B,kHAAkH;IAClH,0BAA0B,CAAwC;IAClE,iHAAiH;IACjH,0BAA0B,CAAwC;IAElE;;;;;;;;;;;;;;OAcG;IACH,YAAY,QAAgC;QAC1C,YAAY,CAAC,QAAQ,IAAI,EAAE,CAAC;aACvB,UAAU,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE;aAC1C,UAAU,CAAC,4BAA4B,CAAC,CAAC,UAAU,EAAE;aACrD,UAAU,CAAC,4BAA4B,CAAC,CAAC,UAAU,EAAE;aACrD,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;SAC5B;QACD,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,GAAG,IAAI,gBAAgB,CAAC;QACjC,IAAI,EAAE,UAAU;QAChB,0BAA0B,EAAE,CAAC,kBAAkB,EAAE,EAAE;YACjD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,0BAA0B,EAAE,CAAC,kBAAkB,EAAE,EAAE;YACjD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;KACF,CAAC,CAAC;IAEH;;;OAGG;IACH,MAAM,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC;QACtC,IAAI,EAAE,WAAW;QACjB,0BAA0B,EAAE,CAAC,kBAAkB,EAAE,EAAE;YACjD,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACtF,CAAC;QACD,0BAA0B,EAAE,CAAC,kBAAkB,EAAE,EAAE;YACjD,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACtF,CAAC;KACF,CAAC,CAAC;IAEH;;OAEG;IACH,MAAM,CAAC,eAAe,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAErE;;;;;;;;;;;;OAYG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACnD,CAAC;;AAIH,gBAAgB,CAAC,SAAS,CAAC,UAAU,GAAG,kBAAkB,CAAC","sourcesContent":["import { assertConfig } from './assert-param';\r\nimport { core } from './core';\r\nimport { config } from './config';\r\n\r\n// TODO: strongly type context object passed to naming convention converter fns.\r\n\r\n/** Configuration info to be passed to the [[NamingConvention]] constructor */\r\nexport interface NamingConventionConfig {\r\n  /** The name of this NamingConvention */\r\n  name?: string;\r\n  /** Function that takes a server property name add converts it into a client side property name.  */\r\n  serverPropertyNameToClient?: (nm: string, context?: any) => string;\r\n  /** Function that takes a client property name add converts it into a server side property name. */\r\n  clientPropertyNameToServer?: (nm: string, context?: any) => string;\r\n}\r\n\r\n/**\r\nA NamingConvention instance is used to specify the naming conventions under which a MetadataStore\r\nwill translate property names between the server and the javascript client.\r\n\r\nThe default NamingConvention does not perform any translation, it simply passes property names thru unchanged.\r\n@dynamic\r\n**/\r\nexport class NamingConvention {\r\n  /** @hidden @internal */\r\n  declare _$typeName: string;\r\n  /** The name of this NamingConvention. __Read Only__ */\r\n  declare name: string;\r\n  /** Function that takes a server property name add converts it into a client side property name.  __Read Only__ */\r\n  serverPropertyNameToClient: (nm: string, context?: any) => string;\r\n  /** Function that takes a client property name add converts it into a server side property name. __Read Only__ */\r\n  clientPropertyNameToServer: (nm: string, context?: any) => string;\r\n\r\n  /**\r\n  NamingConvention constructor\r\n  >      // A naming convention that converts the first character of every property name to uppercase on the server\r\n  >      // and lowercase on the client.\r\n  >      var namingConv = new NamingConvention({\r\n  >          serverPropertyNameToClient: function(serverPropertyName) {\r\n  >              return serverPropertyName.substr(0, 1).toLowerCase() + serverPropertyName.substr(1);\r\n  >          },\r\n  >          clientPropertyNameToServer: function(clientPropertyName) {\r\n  >              return clientPropertyName.substr(0, 1).toUpperCase() + clientPropertyName.substr(1);\r\n  >          }            \r\n  >      });\r\n  >      var ms = new MetadataStore({ namingConvention: namingConv });\r\n  >      var em = new EntityManager( { metadataStore: ms });\r\n  **/\r\n  constructor(ncConfig: NamingConventionConfig ) {\r\n    assertConfig(ncConfig || {})\r\n        .whereParam(\"name\").isOptional().isString()\r\n        .whereParam(\"serverPropertyNameToClient\").isFunction()\r\n        .whereParam(\"clientPropertyNameToServer\").isFunction()\r\n        .applyAll(this);\r\n    if (!this.name) {\r\n      this.name = core.getUuid();\r\n    }\r\n    config._storeObject(this, \"NamingConvention\", this.name);\r\n  }\r\n\r\n  /**\r\n\r\n\r\n  /**\r\n  A noop naming convention - This is the default unless another is specified.\r\n  **/\r\n  static none = new NamingConvention({\r\n    name: \"noChange\",\r\n    serverPropertyNameToClient: (serverPropertyName) => {\r\n      return serverPropertyName;\r\n    },\r\n    clientPropertyNameToServer: (clientPropertyName) => {\r\n      return clientPropertyName;\r\n    }\r\n  });\r\n\r\n  /**\r\n  The \"camelCase\" naming convention - This implementation only lowercases the first character of the server property name\r\n  but leaves the rest of the property name intact.  If a more complicated version is needed then one should be created via the ctor.\r\n  **/\r\n  static camelCase = new NamingConvention({\r\n    name: \"camelCase\",\r\n    serverPropertyNameToClient: (serverPropertyName) => {\r\n      return serverPropertyName.substr(0, 1).toLowerCase() + serverPropertyName.substr(1);\r\n    },\r\n    clientPropertyNameToServer: (clientPropertyName) => {\r\n      return clientPropertyName.substr(0, 1).toUpperCase() + clientPropertyName.substr(1);\r\n    }\r\n  });\r\n\r\n  /**\r\n  The default value whenever NamingConventions are not specified.\r\n  **/\r\n  static defaultInstance = new NamingConvention(NamingConvention.none);\r\n\r\n  /**\r\n  Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance.\r\n  The current instance is returned unchanged.\r\n  >      var namingConv = new NamingConvention({\r\n  >          serverPropertyNameToClient: function(serverPropertyName) {\r\n  >              return serverPropertyName.substr(0, 1).toLowerCase() + serverPropertyName.substr(1);\r\n  >          },\r\n  >          clientPropertyNameToServer: function(clientPropertyName) {\r\n  >              return clientPropertyName.substr(0, 1).toUpperCase() + clientPropertyName.substr(1);\r\n  >          }            \r\n  >      });\r\n  >      namingConv.setAsDefault();\r\n  **/\r\n  setAsDefault() {\r\n    return core.setAsDefault(this, NamingConvention);\r\n  }\r\n\r\n}\r\n\r\nNamingConvention.prototype._$typeName = \"NamingConvention\";\r\n\r\n\r\n\r\n\r\n"]}