angular-odata 0.130.0 → 0.140.0

package/lib/annotations.d.ts

@@ -1,75 +0,0 @@
-import { ODataContext, ODataVersionHelper } from './helper';
-import { ODataMetadataType } from './types';
-export declare abstract class ODataAnnotations<T> {
-    helper: ODataVersionHelper;
-    protected annotations: Map<string, any>;
-    protected context?: ODataContext | undefined;
-    constructor(helper: ODataVersionHelper, annotations?: Map<string, any>, context?: ODataContext | undefined);
-    attributes(data: {
-        [name: string]: any;
-    }, metadata: ODataMetadataType): Partial<T>;
-    update(data: {
-        [name: string]: any;
-    }): void;
-    get entitySet(): string | undefined;
-    get type(): string | undefined;
-    abstract union(other: ODataAnnotations<any>): ODataAnnotations<any>;
-    abstract clone(): ODataAnnotations<any>;
-    abstract data(data: {
-        [name: string]: any;
-    }): {
-        [name: string]: any;
-    };
-}
-export declare class ODataPropertyAnnotations<T> extends ODataAnnotations<T> {
-    union(other: ODataPropertyAnnotations<any>): ODataPropertyAnnotations<any>;
-    clone(): ODataPropertyAnnotations<any>;
-    data(data: {
-        [name: string]: any;
-    }): any;
-}
-export declare class ODataEntityAnnotations<T> extends ODataAnnotations<T> {
-    union(other: ODataEntityAnnotations<any>): ODataEntityAnnotations<any>;
-    clone(): ODataEntityAnnotations<any>;
-    data(data: {
-        [name: string]: any;
-    }): any;
-    get id(): string | undefined;
-    get etag(): string | undefined;
-    get mediaEtag(): string | undefined;
-    get metadataEtag(): string | undefined;
-    get readLink(): string | undefined;
-    get editLink(): string | undefined;
-    get mediaReadLink(): string | undefined;
-    get mediaEditLink(): string | undefined;
-    get mediaContentType(): string | undefined;
-    private _properties?;
-    get properties(): Map<keyof T, Map<string, any>>;
-    property<F>(name: keyof T, type: 'collection'): ODataEntitiesAnnotations<F>;
-    property<F>(name: keyof T, type: 'single'): ODataEntityAnnotations<F>;
-    private _functions?;
-    get functions(): {
-        [name: string]: any;
-    };
-    function(name: string): any;
-}
-export declare class ODataEntitiesAnnotations<T> extends ODataAnnotations<T> {
-    union(other: ODataEntitiesAnnotations<any>): ODataEntitiesAnnotations<any>;
-    clone(): ODataEntitiesAnnotations<any>;
-    data(data: {
-        [name: string]: any;
-    }): any;
-    get readLink(): string | undefined;
-    get count(): number | undefined;
-    get nextLink(): string | undefined;
-    get deltaLink(): string | undefined;
-    get top(): number | undefined;
-    get skip(): number | undefined;
-    get skiptoken(): string | undefined;
-    private _functions?;
-    get functions(): {
-        [name: string]: any;
-    };
-    function(name: string): any;
-    entity(): ODataEntityAnnotations<T>;
-}

package/lib/api.d.ts

@@ -1,108 +0,0 @@
-import { Observable } from 'rxjs';
-import { ODataCache } from './cache';
-import { ModelOptions, ODataCollection, ODataModel, ODataModelOptions } from './models';
-import { ODataApiOptions } from './options';
-import { ODataOptions, ODataResource, ODataSegment } from './resources';
-import { ODataRequest, ODataBatchResource, ODataMetadataResource, ODataActionResource, ODataFunctionResource, ODataEntityResource, ODataEntitySetResource, ODataSingletonResource, ODataNavigationPropertyResource } from './resources';
-import { ODataCallable, ODataEntitySet, ODataEnumType, ODataSchema, ODataSingleton, ODataStructuredType } from './schema';
-import { ApiConfig, EdmType, ODataVersion, Parser, QueryOption, SchemaConfig } from './types';
-import { ODataMetadata } from './metadata/metadata';
-/**
- * Api abstraction for consuming OData services.
- */
-export declare class ODataApi {
-    requester?: (request: ODataRequest<any>) => Observable<any>;
-    serviceRootUrl: string;
-    metadataUrl: string;
-    name?: string;
-    version: ODataVersion;
-    default: boolean;
-    creation: Date;
-    options: ODataApiOptions;
-    cache: ODataCache;
-    errorHandler?: (error: any, caught: Observable<any>) => Observable<never>;
-    parsers: Map<string, Parser<any>>;
-    schemas: ODataSchema[];
-    constructor(config: ApiConfig);
-    configure(settings?: {
-        requester?: (request: ODataRequest<any>) => Observable<any>;
-    }): void;
-    populate(metadata: ODataMetadata): void;
-    fromJson<P, R>(json: {
-        segments: ODataSegment[];
-        options: {
-            [name: string]: any;
-        };
-    }): ODataActionResource<P, R> | ODataFunctionResource<P, R>;
-    fromJson<E>(json: {
-        segments: ODataSegment[];
-        options: {
-            [name: string]: any;
-        };
-    }): ODataEntityResource<E> | ODataEntitySetResource<E> | ODataNavigationPropertyResource<E> | ODataSingletonResource<E>;
-    /**
-     * Build a metadata resource.
-     * @returns ODataMetadataResource
-     */
-    metadata(): ODataMetadataResource;
-    /**
-     * Build a batch resource.
-     * @returns ODataBatchResource
-     */
-    batch(): ODataBatchResource;
-    /**
-     * Build a singleton resource.
-     * @param path Name of the singleton
-     * @returns
-     */
-    singleton<T>(name: string): ODataSingletonResource<T>;
-    /**
-     * Build an entity set resource.
-     * @param path Name of the entity set
-     * @returns
-     */
-    entitySet<T>(name: string): ODataEntitySetResource<T>;
-    /**
-     * Unbound Action
-     * @param  {string} path?
-     * @returns ODataActionResource
-     */
-    action<P, R>(path: string): ODataActionResource<P, R>;
-    /**
-     * Unbound Function
-     * @param  {string} path?
-     * @returns ODataFunctionResource
-     */
-    function<P, R>(path: string): ODataFunctionResource<P, R>;
-    callable<T>(type: string): ODataCallable<T> | undefined;
-    enumType<T>(type: string): ODataEnumType<T> | undefined;
-    structuredType<T>(type: string): ODataStructuredType<T> | undefined;
-    request<T>(method: string, resource: ODataResource<any>, options: ODataOptions & {
-        body?: any;
-        etag?: string;
-        responseType?: 'arraybuffer' | 'blob' | 'json' | 'text' | 'value' | 'property' | 'entity' | 'entities';
-        observe?: 'body' | 'events' | 'response';
-        withCount?: boolean;
-        bodyQueryOptions?: QueryOption[];
-    }): Observable<any>;
-    private memo;
-    createSchema(config: SchemaConfig): ODataSchema;
-    findSchema(type: string): ODataSchema | undefined;
-    findEnumType<T>(value: string): ODataEnumType<T> | undefined;
-    findStructuredType<T>(value: string): ODataStructuredType<T> | undefined;
-    findCallable<R>(value: string, bindingType?: string): ODataCallable<R> | undefined;
-    findEntitySet(value: string): ODataEntitySet | undefined;
-    findSingleton(value: string): ODataSingleton | undefined;
-    findModel(type: string): typeof ODataModel | undefined;
-    createModel(structured: ODataStructuredType<any>): typeof ODataModel;
-    modelForType(type: string): typeof ODataModel;
-    findCollection(type: string): typeof ODataCollection | undefined;
-    createCollection(structured: ODataStructuredType<any>, model?: typeof ODataModel<any>): typeof ODataCollection;
-    collectionForType(type: string): typeof ODataCollection;
-    findEntitySetForEntityType(entityType: string): ODataEntitySet | undefined;
-    parserForType<T>(type: string | EdmType, bindingType?: string): Parser<T>;
-    optionsForType<T>(type: string, { structuredType, config, }?: {
-        structuredType?: ODataStructuredType<T>;
-        config?: ModelOptions;
-    }): ODataModelOptions<T> | undefined;
-}

package/lib/cache/cache.d.ts

@@ -1,104 +0,0 @@
-import { Observable } from 'rxjs';
-import { ODataRequest, ODataResponse } from '../resources';
-import { Cache } from '../types';
-/**
- * A cache entry that holds a payload, a last read time, and a timeout for the entry.
- * @param payload The payload to cache.
- * @param lastRead The last read time.
- * @param timeout The timeout.
- * @param tags Some tags to identify the entry.
- */
-export interface ODataCacheEntry<T> {
-    payload: T;
-    lastRead: number;
-    timeout: number;
-    tags: string[];
-}
-export declare abstract class ODataCache implements Cache {
-    timeout: number;
-    entries: Map<string, ODataCacheEntry<any>>;
-    constructor({ timeout }: {
-        timeout?: number;
-    });
-    abstract getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
-    abstract putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
-    /**
-     * Using the resource on the request build an array of string to identify the scope of the request
-     * @param req The request with the resource to build the scope
-     * @returns Array of string to identify the scope of the request
-     */
-    scope(req: ODataRequest<any>): string[];
-    /**
-     * Using the odata context on the response build an array of string to identify the tags of the response
-     * @param res The response to build the tags
-     * @returns Array of string to identify the tags of the response
-     */
-    tags(res: ODataResponse<any>): string[];
-    /**
-     * Build an entry from a payload and some options
-     * @param payload The payload to store in the cache
-     * @param timeout The timeout for the entry
-     * @param tags The tags for the entry
-     * @returns The entry to store in the cache
-     */
-    buildEntry<T>(payload: T, { timeout, tags }: {
-        timeout?: number;
-        tags?: string[];
-    }): ODataCacheEntry<T>;
-    /**
-     * Build a key from store an entry in the cache
-     * @param names The names of the entry
-     * @returns The key for the entry
-     */
-    buildKey(names: string[]): string;
-    /**
-     * Put some payload in the cache
-     * @param name The name for the entry
-     * @param payload The payload to store in the cache
-     * @param timeout The timeout for the entry
-     * @param scope The scope for the entry
-     * @param tags The tags for the entry
-     */
-    put<T>(name: string, payload: T, { timeout, scope, tags, }?: {
-        timeout?: number;
-        scope?: string[];
-        tags?: string[];
-    }): void;
-    /**
-     * Return the payload from the cache if it exists and is not expired
-     * @param name The name of the entry
-     * @param scope The scope of the entry
-     * @returns The payload of the entry
-     */
-    get<T>(name: string, { scope }?: {
-        scope?: string[];
-    }): T;
-    /**
-     * Remove all cache entries that are matching with the given options
-     * @param options The options to forget
-     */
-    forget({ name, scope, tags, }?: {
-        name?: string;
-        scope?: string[];
-        tags?: string[];
-    }): void;
-    /**
-     * Remove all cache entries
-     */
-    flush(): void;
-    /**
-     * Check if the entry is expired
-     * @param entry The cache entry
-     * @returns Boolean indicating if the entry is expired
-     */
-    isExpired(entry: ODataCacheEntry<any>): boolean;
-    /**
-     * Using the request, handle the fetching of the response
-     * @param req The request to fetch
-     * @param res$ Observable of the response
-     * @returns
-     */
-    handleRequest(req: ODataRequest<any>, res$: Observable<ODataResponse<any>>): Observable<ODataResponse<any>>;
-    private handleFetch;
-    private handleMutate;
-}

package/lib/cache/index.d.ts

@@ -1,3 +0,0 @@
-export * from './cache';
-export * from './memory';
-export * from './storage';

package/lib/cache/memory.d.ts

@@ -1,19 +0,0 @@
-import { ODataRequest, ODataResponse } from '../resources';
-import { ODataCache } from './cache';
-export declare class ODataInMemoryCache extends ODataCache {
-    constructor({ timeout }?: {
-        timeout?: number;
-    });
-    /**
-     * Store the response in the cache
-     * @param req The request with the resource to store the response
-     * @param res The response to store in the cache
-     */
-    putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
-    /**
-     * Restore the response from the cache
-     * @param req The request with the resource to get the response
-     * @returns The response from the cache
-     */
-    getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
-}

package/lib/cache/storage.d.ts

@@ -1,35 +0,0 @@
-import { ODataRequest, ODataResponse } from '../resources';
-import { ODataCache } from './cache';
-export declare class ODataInStorageCache extends ODataCache {
-    name: string;
-    storage: Storage;
-    constructor({ name, storage, timeout, }: {
-        timeout?: number;
-        name: string;
-        storage?: Storage;
-    });
-    /**
-     * Store the cache in the storage
-     */
-    store(): void;
-    /**
-     * Restore the cache from the storage
-     */
-    restore(): void;
-    /**
-     * Flush the cache and clean the storage
-     */
-    flush(): void;
-    /**
-     * Store the response in the cache
-     * @param req The request with the resource to store the response
-     * @param res The response to store in the cache
-     */
-    putResponse(req: ODataRequest<any>, res: ODataResponse<any>): void;
-    /**
-     * Restore the response from the cache
-     * @param req The request with the resource to get the response
-     * @returns The response from the cache
-     */
-    getResponse(req: ODataRequest<any>): ODataResponse<any> | undefined;
-}