@mapcreator/api 2.8.0 → 3.0.0

package/dist/RequestParameters.d.ts

@@ -0,0 +1,241 @@
+/**
+ * Used for keeping track of the request parameters
+ *
+ * @fires RequestParameters#change
+ * @fires RequestParameters#change:page
+ * @fires RequestParameters#change:perPage
+ * @fires RequestParameters#change:search
+ * @fires RequestParameters#change:sort
+ * @fires RequestParameters#change:deleted
+ * @fires RequestParameters#change:extra
+ */
+export default class RequestParameters extends EventEmitter {
+    /**
+     * Default page number
+     * @param {Number} value - Page number
+     */
+    static set page(arg: number);
+    /**
+     * Default page number
+     * @returns {Number} - Page number
+     */
+    static get page(): number;
+    /**
+     * Default per page
+     * @param {Number} value - Per page
+     */
+    static set perPage(arg: number);
+    /**
+     * Default per page
+     * @returns {Number} - Per page
+     */
+    static get perPage(): number;
+    /**
+     * Default pagination offset
+     * @param {Number} value - Offset
+     */
+    static set offset(arg: number);
+    /**
+     * Default pagination offset
+     * @returns {Number} - Offset
+     */
+    static get offset(): number;
+    /**
+     * Sets the maximum allowed value for perPage
+     * Some users will have a special permission that allows them to fetch more than 50 resources at once
+     * @param {Number} value - Maximum amount of resources per page
+     */
+    static set maxPerPage(arg: number);
+    /**
+     * Gets the maximum allowed value for perPage
+     * Some users will have a special permission that allows them to fetch more than 50 resources at once
+     * @returns {Number} - Maximum amount of resources per page
+     */
+    static get maxPerPage(): number;
+    /**
+     * Default search query
+     * @param {Object<String, String|Array<String>>} value - Search query
+     */
+    static set search(arg: any);
+    /**
+     * Default search query
+     * @returns {Object<String, String|Array<String>>} - Search query
+     */
+    static get search(): any;
+    /**
+     * Default sort query
+     * @param {Array<String>} value - Sort query
+     */
+    static set sort(arg: string[]);
+    /**
+     * Default sort query
+     * @returns {Array<String>} - Sort query
+     */
+    static get sort(): string[];
+    /**
+     * Default deleted items filter state
+     * @param {String} value -  Deleted items filter state
+     */
+    static set deleted(arg: string);
+    /**
+     * Default deleted items filter state
+     * @returns {String|undefined} -  Deleted items filter state
+     */
+    static get deleted(): string;
+    /**
+     * Default extra request parameters
+     * @param {Object} value - Extra request parameters
+     */
+    static set extra(arg: any);
+    /**
+     * Default extra request parameters
+     * @returns {Object} - Extra request parameters
+     */
+    static get extra(): any;
+    /**
+     * Validators should work the same as laravel's ::validate method. This means
+     * this means that they will throw a TypeError or return a normalized result.
+     */
+    static _validatePage(value: any): number;
+    static _validatePerPage(value: any): any;
+    static _validateOffset(value: any): number;
+    static _validateMaxPerPage(value: any): number;
+    static _validateSearch(value: any): any;
+    static _validateSort(value: any): any;
+    static _validateDeleted(value: any): any;
+    static _validateExtra(value: any): any;
+    /**
+     * Different parameters
+     * @returns {Array<String>} - keys
+     */
+    static keys(): Array<string>;
+    /**
+     * Resets all parameters back to default
+     */
+    static resetDefaults(): void;
+    /**
+     * RequestParameters constructor
+     * @param {Object} object - properties
+     */
+    constructor(object?: any);
+    /**
+     * Page number
+     * @param {Number} value - Page number
+     */
+    set page(arg: number);
+    /**
+     * Get page number
+     * @returns {Number} - Page number
+     * @throws {TypeError}
+     */
+    get page(): number;
+    /**
+     * Rows per page
+     * @param {Number} value - Per page
+     */
+    set perPage(arg: number);
+    /**
+     * Get rows per page
+     * @returns {Number} - Per page
+     * @throws {TypeError}
+     */
+    get perPage(): number;
+    /**
+     * Pagination offset
+     * @param {Number} value - Offset
+     */
+    set offset(arg: number);
+    /**
+     * Get pagination offset
+     * @returns {Number} - Offset
+     * @throws {TypeError}
+     */
+    get offset(): number;
+    /**
+     * Search query
+     * @param {Object<String, String|Array<String>>} value - Search query
+     */
+    set search(arg: any);
+    /**
+     * Search query
+     * @returns {Object<String, String|Array<String>>} - Query
+     * @throws {TypeError}
+     */
+    get search(): any;
+    /**
+     * Sort query
+     * @param {Array<String>} value - Sort query
+     */
+    set sort(arg: string[]);
+    /**
+     * Get sort options
+     * @returns {Array<String>} - Per page
+     * @throws {TypeError}
+     */
+    get sort(): string[];
+    /**
+     * Deleted items filter state
+     * @param {String} value - Deleted items filter state
+     * @see {@link DeletedState}
+     */
+    set deleted(arg: string);
+    /**
+     * If deleted items should be shown
+     * @returns {String} - Deleted items filter state
+     * @see {@link DeletedState}
+     */
+    get deleted(): string;
+    /**
+     * Extra request parameters
+     * @param {Object} value - Extra request parameters
+     */
+    set extra(arg: any);
+    /**
+     * Extra parameters
+     * @returns {Object} - Extra parameters
+     */
+    get extra(): any;
+    _resolve(name: any): any;
+    _update(name: any, value: any, preventEvent?: boolean): any;
+    /**
+     * Urlencode parameters
+     * @returns {string} - HTTP query
+     */
+    encode(): string;
+    /**
+     * Convert to object
+     * @returns {Object} - Object
+     */
+    toObject(): any;
+    /**
+     * Convert to object
+     * @returns {Object} - Object
+     */
+    toParameterObject(): any;
+    /**
+     * Copy object
+     * @returns {RequestParameters} - Copy
+     */
+    copy(): RequestParameters;
+    /**
+     * Generates a cache token
+     * @returns {string} - Cache token
+     */
+    token(): string;
+    /**
+     * Apply parameters from object
+     * @param {object|RequestParameters} params - parameters
+     * @returns {Object[]} - Array containing the updated values
+     * @example
+     * const params = new RequestParameters({perPage: 12});
+     *
+     * params.perPage === 12;
+     *
+     * params.apply({perPage: 50});
+     *
+     * params.perPage === 50;
+     */
+    apply(params: object | RequestParameters): any[];
+}
+import { EventEmitter } from "events";
+//# sourceMappingURL=RequestParameters.d.ts.map

package/dist/ResourceLister.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Paginated resource lister
+ *
+ * @fires ResourceLister#update
+ */
+export default class ResourceLister extends EventEmitter {
+    /**
+     * ResourceLister constructor
+     *
+     * @param {Mapcreator} api - Api instance
+     * @param {string} route - Resource url route
+     * @param {Class<ResourceBase>} Resource - Resource constructor
+     * @param {?RequestParameters} parameters - Request parameters
+     * @param {number} [maxRows=50] - Initial max rows
+     * @param {string} [key=id] - Key
+     */
+    constructor(api: Mapcreator, route: string, Resource?: Class<ResourceBase>, parameters?: RequestParameters | null, maxRows?: number, key?: string);
+    _api: Mapcreator;
+    _Resource: Class<ResourceBase>;
+    _route: any;
+    _parameters: RequestParameters;
+    _key: string;
+    _waiting: boolean;
+    /**
+     * Set if {@link ResourceLister#update} should be called when {@link ResourceLister#parameters} is updated
+     *
+     * @throws {ResourceLister#update}
+     * @throws {ResourceLister#parameters}
+     * @param {boolean} value - auto update
+     */
+    set autoUpdate(arg: boolean);
+    /**
+     * Get if {@link ResourceLister#update} should be called when {@link ResourceLister#parameters} is updated
+     *
+     * @throws {ResourceLister#update}
+     * @throws {ResourceLister#parameters}
+     */
+    get autoUpdate(): boolean;
+    /**
+     * Set the maximum amount of rows allowed
+     * @param {number} value - max rows
+     */
+    set maxRows(arg: number);
+    /**
+     * Get the maximum amount of rows allowed
+     * @returns {number} - max rows
+     */
+    get maxRows(): number;
+    /**
+     * Get if there are more resources to fetch. It indicates if the maxRows can be increased.
+     * @returns {boolean} - if more rows are available
+     */
+    get hasMore(): boolean;
+    /**
+     * Get if the instance is waiting for data
+     * @returns {boolean} - waiting for data
+     */
+    get waiting(): boolean;
+    /**
+     * Set the request parameters
+     *
+     * If you set {@link ResourceLister#autoUpdate} to true then {@link ResourceLister#update}
+     * will automatically be called when the parameters are updated.
+     * @throws {ResourceLister#autoUpdate}
+     * @param {RequestParameters} object - parameters
+     */
+    set parameters(arg: RequestParameters);
+    /**
+     * Get the request parameters
+     * @returns {RequestParameters} - parameters
+     */
+    get parameters(): RequestParameters;
+    /**
+     * Resource constructor accessor, used for building the resource instance
+     * @returns {Class<ResourceBase>} - resource constructor
+     */
+    get Resource(): Class<ResourceBase>;
+    /**
+     * Get the route (url)
+     * @returns {string} - route
+     */
+    get route(): string;
+    /**
+     * Get the data
+     * @returns {Array<ResourceLister.Resource>} - data
+     */
+    get data(): ResourceLister.Resource[];
+    /**
+     * Get the api instance
+     * @returns {Mapcreator} - Api instance
+     */
+    get api(): Mapcreator;
+    /**
+     * Get the row count
+     *
+     * @see {ResourceLister.data}
+     * @returns {number} - row count
+     */
+    get rowCount(): number;
+    _maxRows: number;
+    /**
+     * Get the number of rows the server has available
+     * @returns {number} - number of rows
+     */
+    get availableRows(): number;
+    _autoUpdate: boolean;
+    _boundUpdate: any;
+    /**
+     * Reset the instance
+     *
+     * @private
+     */
+    private _reset;
+    _parameterToken: string;
+    _realData: any[];
+    _data: any[];
+    _keys: any[];
+    /**
+     * Update the server data
+     */
+    update(): Promise<void>;
+    /**
+     * Fetch more data from the server
+     * @private
+     * @returns {CancelablePromise}
+     * @throws {ApiError} - If the api returns errors
+     */
+    private _fetchMore;
+    _availableRows: number;
+    /**
+     * Push a row to the data collection
+     *
+     * This will append the row or update an existing row based on the key. If
+     * autoMaxRows is set to true and maxRows only needs to be increased by one
+     * for the new resource to show up it will
+     * @param {ResourceLister.Resource} row - resource
+     * @param {boolean} autoMaxRows - Increase maxRows if needed
+     */
+    push(row: ResourceLister.Resource, autoMaxRows?: boolean): void;
+    /**
+     * Same as `this.maxRows += this.parameters.perPage`
+     * @param {number} [rows=parameters.perPage] - Amount to increment maxRows with
+     */
+    loadMore(rows?: number): void;
+    /**
+     * Returns the iterable
+     * @returns {Iterator} - iterator
+     */
+    [Symbol.iterator](): Iterator<any, any, undefined>;
+}
+import { EventEmitter } from "events";
+import Mapcreator from "./Mapcreator";
+import ResourceBase from "./resources/base/ResourceBase";
+import RequestParameters from "./RequestParameters";
+//# sourceMappingURL=ResourceLister.d.ts.map