breeze-client 2.2.2 → 3.0.0

package/src/event.d.ts

@@ -1,142 +0,0 @@
-/** @hidden @internal */
-export interface Subscription {
-    unsubKey: number;
-    callback: (data: any) => any;
-}
-/**
-Class to support basic event publication and subscription semantics.
-@dynamic
-**/
-export declare class BreezeEvent<T> {
-    /** @hidden @internal */
-    static __eventNameMap: {};
-    /** @hidden @internal */
-    static __nextUnsubKey: number;
-    /** The name of this Event */
-    name: string;
-    /** The object doing the publication. i.e. the object to which this event is attached. */
-    publisher: Object;
-    /** @hidden @internal */
-    _subscribers: Subscription[];
-    /** @hidden @internal */
-    _defaultErrorCallback: (e: Error) => any;
-    /**
-    Constructor for an Event
-    >     salaryEvent = new BreezeEvent("salaryEvent", person);
-    @param name - The name of the event.
-    @param publisher - The object that will be doing the publication. i.e. the object to which this event is attached.
-    @param defaultErrorCallback - Function to call when an error occurs during subscription execution.
-    If omitted then subscriber notification failures will be ignored.
-    **/
-    constructor(name: string, publisher: Object, defaultErrorCallback?: (e: Error) => any);
-    /**
-    Publish data for this event.
-    >      // Assume 'salaryEvent' is previously constructed Event
-    >      salaryEvent.publish( { eventType: "payRaise", amount: 100 });
-  
-    This event can also be published asychronously
-    >      salaryEvent.publish( { eventType: "payRaise", amount: 100 }, true);
-  
-    And we can add a handler in case the subscriber 'mishandles' the event.
-    >      salaryEvent.publish( { eventType: "payRaise", amount: 100 }, true, function(error) {
-    >          // do something with the 'error' object
-    >      });
-    @param data - Data to publish
-    @param publishAsync - (default=false) Whether to publish asynchonously or not.
-    @param errorCallback - Function to be called for any errors that occur during publication. If omitted,
-    errors will be eaten.
-    @return false if event is disabled; true otherwise.
-    **/
-    publish(data: T, publishAsync?: boolean, errorCallback?: (e: Error) => any): boolean;
-    /**
-    Publish data for this event asynchronously.
-    >      // Assume 'salaryEvent' is previously constructed Event
-    >      salaryEvent.publishAsync( { eventType: "payRaise", amount: 100 });
-  
-    And we can add a handler in case the subscriber 'mishandles' the event.
-    >      salaryEvent.publishAsync( { eventType: "payRaise", amount: 100 }, function(error) {
-    >          // do something with the 'error' object
-    >      });
-    @param data - Data to publish
-    @param errorCallback - Function to be called for any errors that occur during publication. If omitted,
-    errors will be eaten.
-    **/
-    publishAsync(data: T, errorCallback: (e: Error) => any): void;
-    /**
-    Subscribe to this event.
-    >      // Assume 'salaryEvent' is previously constructed Event
-    >      salaryEvent.subscribe(function (eventArgs) {
-    >          if (eventArgs.eventType === "payRaise") {
-    >              // do something
-    >          }
-    >      });
-  
-    There are several built in Breeze events, such as [[EntityAspect.propertyChanged]], [[EntityAspect.validationErrorsChanged]] as well.
-    >      // Assume order is a preexisting 'order' entity
-    >      order.entityAspect.propertyChanged.subscribe(function (pcEvent) {
-    >          if ( pcEvent.propertyName === "OrderDate") {
-    >              // do something
-    >          }
-    >      });
-    @param callback- Function to be called whenever 'data' is published for this event.
-    @param callback.data - {Object} Whatever 'data' was published.  This should be documented on the specific event.
-    @return This is a key for 'unsubscription'.  It can be passed to the 'unsubscribe' method.
-    **/
-    subscribe(callback: (data: T) => any): number;
-    /**
-    Unsubscribe from this event.
-    >      // Assume order is a preexisting 'order' entity
-    >      let token = order.entityAspect.propertyChanged.subscribe(function (pcEvent) {
-    >              // do something
-    >      });
-    >      // sometime later
-    >      order.entityAspect.propertyChanged.unsubscribe(token);
-    @param unsubKey - The value returned from the 'subscribe' method may be used to unsubscribe here.
-    @return Whether unsubscription occured. This will return false if already unsubscribed or if the key simply
-    cannot be found.
-    **/
-    unsubscribe: (unsubKey: number) => boolean;
-    /** remove all subscribers */
-    clear(): void;
-    /** event bubbling - document later. */
-    static bubbleEvent(target: any, getParentFn?: (() => any)): void;
-    /**
-    Enables or disables the named event for an object and all of its children.
-    >      BreezeEvent.enable(“propertyChanged”, myEntityManager, false)
-  
-    will disable all EntityAspect.propertyChanged events within a EntityManager.
-    >      BreezeEvent.enable(“propertyChanged”, myEntityManager, true)
-  
-    will enable all EntityAspect.propertyChanged events within a EntityManager.
-    >      BreezeEvent.enable(“propertyChanged”, myEntity.entityAspect, false)
-  
-    will disable EntityAspect.propertyChanged events for a specific entity.
-    >      BreezeEvent.enable(“propertyChanged”, myEntity.entityAspect, null)
-  
-    will removes any enabling / disabling at the entity aspect level so now any 'Event.enable' calls at the EntityManager level,
-    made either previously or in the future, will control notification.
-    >      BreezeEvent.enable(“validationErrorsChanged”, myEntityManager, function(em) {
-    >          return em.customTag === “blue”;
-    >      })
-  
-  
-    will either enable or disable myEntityManager based on the current value of a ‘customTag’ property on myEntityManager.
-    Note that this is dynamic, changing the customTag value will cause events to be enabled or disabled immediately.
-    @param eventName - The name of the event.
-    @param target - The object at which enabling or disabling will occur.  All event notifications that occur to this object or
-    children of this object will be enabled or disabled.
-    @param isEnabled - A boolean, a null or a function that returns either a boolean or a null.
-    **/
-    static enable(eventName: string, obj: Object, isEnabled: boolean | ((x: any) => boolean)): void;
-    /**
-    Returns whether for a specific event and a specific object and its children, notification is enabled or disabled or not set.
-    >      BreezeEvent.isEnabled(“propertyChanged”, myEntityManager)
-    >
-    @param eventName - The name of the event.
-    @param target - The object for which we want to know if notifications are enabled.
-    @return A null is returned if this value has not been set.
-    **/
-    static isEnabled(eventName: string, obj: Object): boolean;
-    /** @hidden @internal */
-    static _isEnabled: (eventName: string, obj: Object) => boolean;
-}

package/src/interface-registry.d.ts

@@ -1,150 +0,0 @@
-import { InterfaceDef, BaseAdapter } from './config';
-import { MappingContext } from './mapping-context';
-import { EntityQuery } from './entity-query';
-import { MetadataStore } from './entity-metadata';
-import { JsonResultsAdapter, DataService } from './data-service';
-import { Entity } from './entity-aspect';
-import { SaveContext, SaveBundle, QueryResult, SaveResult, HttpResponse } from './entity-manager';
-export interface InterfaceRegistryConfig {
-    ajax?: InterfaceDef<AjaxAdapter>;
-    modelLibrary?: InterfaceDef<ModelLibraryAdapter>;
-    dataService?: InterfaceDef<DataServiceAdapter>;
-    uriBuilder?: InterfaceDef<UriBuilderAdapter>;
-}
-/** Registers adapters used by Breeze */
-export declare class InterfaceRegistry {
-    ajax: InterfaceDef<AjaxAdapter>;
-    modelLibrary: InterfaceDef<ModelLibraryAdapter>;
-    dataService: InterfaceDef<DataServiceAdapter>;
-    uriBuilder: InterfaceDef<UriBuilderAdapter>;
-}
-/** @hidden @internal */
-declare module "./config" {
-    interface BreezeConfig {
-        /**
-        Initializes a collection of adapter implementations and makes each one the default for its corresponding interface.
-        @method initializeAdapterInstances
-        @param config {Object}
-        @param [config.ajax] {String} - the name of a previously registered "ajax" adapter
-        @param [config.dataService] {String} - the name of a previously registered "dataService" adapter
-        @param [config.modelLibrary] {String} - the name of a previously registered "modelLibrary" adapter
-        @param [config.uriBuilder] {String} - the name of a previously registered "uriBuilder" adapter
-        @return [array of instances]
-        **/
-        initializeAdapterInstances(irConfig: InterfaceRegistryConfig): void;
-        interfaceRegistry: InterfaceRegistry;
-    }
-}
-/** DataServiceAdapter Ajax request configuration */
-export interface AjaxConfig {
-    url: string;
-    /** GET, POST, etc. */
-    type?: string;
-    /** json, etc. */
-    dataType?: string;
-    contentType?: string;
-    crossDomain?: string | boolean;
-    headers?: {};
-    data?: any;
-    params?: {};
-    success: (res: HttpResponse) => void;
-    error: (res: (HttpResponse | Error)) => void;
-}
-/** Request sent by AjaxAdapter */
-export interface AjaxRequest {
-    /** AjaxAdapter that initiated the request */
-    adapter: AjaxAdapter;
-    /** Request configuration */
-    config: RequestInit;
-    /** config from the DataServiceAdapter that called the AjaxAdapter */
-    dsaConfig: AjaxConfig;
-    /** Function called on response error */
-    error: (status: number, statusText: string, body: string, response: Response, errorThrown: any) => void;
-    /** Function called on response success */
-    success: (data: any, statusText: string, response: Response) => void;
-}
-/** Handles AJAX requests to server */
-export interface AjaxAdapter extends BaseAdapter {
-    /** Function that performs the ajax request and calls the success or error function */
-    ajax(config: AjaxConfig): void;
-    /** Container for headers to be added to each request */
-    defaultSettings: {
-        headers?: {
-            [name: string]: string;
-        };
-    };
-    /** Function to allow manipulating the request before sending */
-    requestInterceptor?: (req: AjaxRequest) => void;
-}
-/** Adapts breeze change-tracking to the UI framework */
-export interface ModelLibraryAdapter extends BaseAdapter {
-    getTrackablePropertyNames: (entity: any) => string[];
-    initializeEntityPrototype(proto: Object): void;
-    startTracking(entity: any, entityCtor: Function): void;
-    createCtor?: Function;
-}
-/** Reshapes data moving between breeze and server */
-export interface DataServiceAdapter extends BaseAdapter {
-    fetchMetadata(metadataStore: MetadataStore, dataService: DataService): Promise<any>;
-    executeQuery(mappingContext: MappingContext): Promise<QueryResult>;
-    saveChanges(saveContext: SaveContext, saveBundle: SaveBundle): Promise<SaveResult>;
-    changeRequestInterceptor: ChangeRequestInterceptorCtor;
-    jsonResultsAdapter: JsonResultsAdapter;
-}
-/** Function called by AjaxAdapter before sending request */
-export interface AjaxRequestInterceptor {
-    (req: AjaxRequest): void;
-    /** Whether to remove the interceptor after it is called */
-    oneTime: boolean;
-}
-/** Builds URI for performing queries.  Serializes the EntityQuery according to the URI syntax. */
-export interface UriBuilderAdapter extends BaseAdapter {
-    buildUri(query: EntityQuery, metadataStore: MetadataStore): string;
-}
-export interface ChangeRequestInterceptorCtor {
-    new (saveContext: SaveContext, saveBundle: SaveBundle): ChangeRequestInterceptor;
-}
-/** Allows manipulating data in DataServiceAdapter before sending to server */
-export interface ChangeRequestInterceptor {
-    oneTime?: boolean;
-    /**
-     Prepare and return the save data for an entity change-set.
-  
-     The adapter calls this method for each entity in the change-set,
-     after it has prepared a "change request" for that object.
-  
-     The method can do anything to the request but it must return a valid, non-null request.
-     @example
-     this.getRequest = function (request, entity, index) {
-            // alter the request that the adapter prepared for this entity
-            // based on the entity, saveContext, and saveBundle
-            // e.g., add a custom header or prune the originalValuesMap
-            return request;
-        };
-     @method getRequest
-     @param request {Object} The object representing the adapter's request to save this entity.
-     @param entity {Entity} The entity-to-be-save as it is in cache
-     @param index {Integer} The zero-based index of this entity in the change-set array
-     @return {Function} The potentially revised request.
-     **/
-    getRequest(request: any, entity: Entity, index: number): any;
-    /**
-     Last chance to change anything about the 'requests' array
-     after it has been built with requests for all of the entities-to-be-saved.
-  
-     The 'requests' array is the same as 'saveBundle.entities' in many implementations
-  
-     This method can do anything to the array including add and remove requests.
-     It's up to you to ensure that server will accept the requests array data as valid.
-  
-     Returned value is ignored.
-     @example
-     this.done = function (requests) {
-            // alter the array of requests representing the entire change-set
-            // based on the saveContext and saveBundle
-        };
-     @method done
-     @param requests {Array of Object} The adapter's array of request for this changeset.
-     **/
-    done(requests: Object[]): void;
-}

package/src/key-generator.d.ts

@@ -1,12 +0,0 @@
-import { EntityType } from './entity-metadata';
-import { EntityKey } from './entity-key';
-export declare class KeyGenerator {
-    /** @hidden @internal */
-    private _tempIdMap;
-    constructor();
-    generateTempKeyValue(entityType: EntityType, valueIfAvail?: boolean): any;
-    getTempKeys(): EntityKey[];
-    isTempKey(entityKey: EntityKey): boolean;
-    /** @hidden @internal */
-    private _getPropEntry;
-}

package/src/observable-array.d.ts

@@ -1,52 +0,0 @@
-import { BreezeEvent } from './event';
-import { EntityAspect } from './entity-aspect';
-import { DataProperty } from './entity-metadata';
-/** @hidden */
-export interface ObservableArray {
-    push: (...args: any[]) => number;
-    _push: (...args: any[]) => number;
-    unshift: (...args: any[]) => number;
-    pop: () => any;
-    shift: () => any;
-    splice: (...args: any[]) => any[];
-    slice: (a: number, b?: number) => any[];
-    length: number;
-    getEntityAspect: () => EntityAspect;
-    arrayChanged: BreezeEvent<ArrayChangedArgs>;
-    parent?: Object;
-    parentProperty?: DataProperty;
-    _getEventParent: () => Object;
-    _getPendingPubs: () => any[];
-    _beforeChange: () => void;
-    _processAdds(items: any[]): void;
-    _processRemoves(items: any[]): void;
-    _origValues: any[];
-    _pendingArgs: any;
-}
-export interface ArrayChangedArgs {
-    array: any[];
-    added?: any[];
-    removed?: any[];
-}
-declare function updateEntityState(obsArray: ObservableArray): void;
-declare function publish(publisher: ObservableArray, eventName: string, eventArgs: any): void;
-declare function initializeParent(obsArray: any, parent: Object, parentProperty: DataProperty): void;
-/** @hidden @internal */
-export declare const observableArray: {
-    mixin: {
-        push: (...args: any[]) => any;
-        _push: (...args: any[]) => any;
-        unshift: (...args: any[]) => any;
-        pop: () => any;
-        shift: () => any;
-        splice: (...args: any[]) => any;
-        getEntityAspect: () => any;
-        _getEventParent: () => any;
-        _getPendingPubs: () => any;
-        _beforeChange: () => void;
-    };
-    updateEntityState: typeof updateEntityState;
-    publish: typeof publish;
-    initializeParent: typeof initializeParent;
-};
-export {};