@mapcreator/api 3.3.7 → 5.0.0-alpha.100

package/dist/Mapcreator.d.ts

@@ -1,344 +0,0 @@
-/**
- * Base API class
- *
- * @mixes Injectable
- * @extends EventEmitter
- * @fires Mapcreator#error
- */
-export default class Mapcreator {
-    /**
-     * @param {OAuth|string} auth - Authentication flow
-     * @param {string} host - Remote API host
-     */
-    constructor(auth?: OAuth | string, host?: string);
-    /**
-     * Set authentication provider instance
-     * @param {OAuth} value -- OAuth instance
-     */
-    set auth(arg: OAuth);
-    /**
-     * Get authentication provider instance
-     * @returns {OAuth} - OAuth instance
-     */
-    get auth(): OAuth;
-    /**
-     * The remote host
-     * @param {string} value - A valid url
-     */
-    set host(arg: string);
-    /**
-     * The current host
-     * @returns {string} - The current host
-     */
-    get host(): string;
-    _logger: Logger;
-    /**
-     * Get api version
-     * @returns {string} - Api version
-     * @constant
-     */
-    get version(): string;
-    /**
-     * Get logger instance
-     * @returns {Logger} - Logger instance
-     */
-    get logger(): Logger;
-    _auth: OAuth;
-    /**
-     * Test if the client is authenticated with the api and has a valid token
-     * @returns {boolean} - If the client is authenticated with the api
-     */
-    get authenticated(): boolean;
-    _host: string;
-    get url(): string;
-    /**
-     * Saves the session token so that it can be recovered at a later time. The wrapper can
-     * find the token most of the time if the name parameter is left blank.
-     * @param {string?} name - name of the token
-     */
-    saveToken(name: string | null): void;
-    /**
-     * Authenticate with the api using the authentication method provided.
-     * @returns {Promise<Mapcreator>} - Current instance
-     * @throws {OAuthError}
-     * @throws {ApiError} - If the api returns errors
-     */
-    authenticate(): Promise<Mapcreator>;
-    /**
-     * Mapcreator ky instance
-     * This ky instance takes care of the API communication. It has the following responsibilities:
-     *  - Send authenticated requests to the API
-     *  - Transform errors returned from the API into ApiError and ValidationError if possible
-     *  - Wait when the rate limiter responds with a 429 and retry later
-     *  - Prefix urls with the api domain if needed
-     * @returns {function}
-     * @see {@link https://github.com/sindresorhus/ky}
-     */
-    get ky(): Function;
-    _ky: any;
-    wrapKy(wrapper: any, ...args: any[]): void;
-    /**
-     * Static proxy generation
-     * @param {string|Class} Target - Constructor or url
-     * @param {Class?} Constructor - Constructor for a resource that the results should be cast to
-     * @returns {ResourceProxy} - A proxy for accessing the resource
-     * @example
-     * api.static('/custom/resource/path/{id}/').get(123);
-     *
-     * @example
-     * class FooBar extends ResourceBase {
-     *    static get resourceName() {
-     *      return 'custom';
-     *    }
-     * }
-     *
-     * api.static(FooBar)
-     *   .get(1)
-     *   .then(console.log);
-     *
-     * api.static('/foo-bar-custom', FooBar).lister();
-     */
-    static(Target: string | Class, Constructor?: Class): ResourceProxy;
-    /**
-     * Choropleth accessor
-     * @see {@link Choropleth}
-     * @returns {GeoResourceProxy<Choropleth>} - A proxy for accessing the resource
-     */
-    get choropleths(): any;
-    /**
-     * VectorChoropleth accessor
-     * @see {@link VectorChoropleth}
-     * @returns {GeoResourceProxy<VectorChoropleth>} - A proxy for accessing the resource
-     */
-    get vectorChoropleths(): any;
-    /**
-     * Color accessor
-     * @see {@link Color}
-     * @returns {ResourceProxy<Color>} - A proxy for accessing the resource
-     */
-    get colors(): any;
-    /**
-     * Tag accessor
-     * @see {@link Tag}
-     * @returns {ResourceProxy<Tag>} - A proxy for accessing the resource
-     */
-    get tags(): any;
-    /**
-     * Tag accessor
-     * @see {@link TagType}
-     * @returns {ResourceProxy<TagType>} - A proxy for accessing the resource
-     */
-    get tagTypes(): any;
-    /**
-     * Contract accessor
-     * @see {@link Contract}
-     * @returns {ResourceProxy<Contract>} - A proxy for accessing the resource
-     */
-    get contracts(): any;
-    /**
-     * Dimension accessor
-     * @see {@link Dimension}
-     * @returns {ResourceProxy<Dimension>} - A proxy for accessing the resource
-     */
-    get dimensions(): any;
-    /**
-     * Dimension set accessor
-     * @see {@link DimensionSet}
-     * @returns {ResourceProxy<DimensionSet>} - A proxy for accessing the resource
-     */
-    get dimensionSets(): any;
-    /**
-     * Domain login method accessor
-     * @see {@link DomainLoginMethod}
-     * @returns {ResourceProxy<DomainLoginMethod>} - A proxy for accessing the resource
-     */
-    get domainLoginMethods(): any;
-    /**
-     * Faq accessor
-     * @see {@link Faq}
-     * @returns {ResourceProxy<Faq>} - A proxy for accessing the resource
-     */
-    get faqs(): any;
-    /**
-     * Feature accessor
-     * @see {@link Feature}
-     * @returns {ResourceProxy<Feature>} - A proxy for accessing the resource
-     */
-    get features(): any;
-    /**
-     * Featured jobs accessor
-     * @see {@link Job}
-     * @returns {SimpleResourceProxy<Job>} - A proxy for accessing the resource
-     */
-    get featuredMaps(): any;
-    /**
-     * Font accessor
-     * @see {@link Font}
-     * @returns {ResourceProxy<Font>} - A proxy for accessing the resource
-     */
-    get fonts(): any;
-    /**
-     * FontFamily accessor
-     * @see {@link FontFamily}
-     * @returns {ResourceProxy<FontFamily>} - A proxy for accessing the resource
-     */
-    get fontFamilies(): any;
-    /**
-     * Highlight accessor
-     * @see {@link Highlight}
-     * @returns {GeoResourceProxy<Highlight>} - A proxy for accessing the resource
-     */
-    get highlights(): any;
-    /**
-     * VectorHighlight accessor
-     * @see {@link VectorHighlight}
-     * @returns {GeoResourceProxy<VectorHighlight>} - A proxy for accessing the resource
-     */
-    get vectorHighlights(): any;
-    /**
-     * InsetMap accessor
-     * @see {@link InsetMap}
-     * @returns {GeoResourceProxy<InsetMap>} - A proxy for accessing the resource
-     */
-    get insetMaps(): any;
-    /**
-     * Job accessor
-     * @see {@link Job}
-     * @returns {ResourceProxy<Job>} - A proxy for accessing the resource
-     */
-    get jobs(): any;
-    /**
-     * JobShare accessor
-     * @see {@link JobShare}
-     * @returns {ResourceProxy<JobShare>} - A proxy for accessing the resource
-     */
-    get jobShares(): any;
-    /**
-     * JobType accessor
-     * @see {@link JobType}
-     * @returns {ResourceProxy<JobType>} - A proxy for accessing the resource
-     */
-    get jobTypes(): any;
-    /**
-     * Language accessor
-     * @see {@link Language}
-     * @returns {ResourceProxy<Language>} - A proxy for accessing the resource
-     */
-    get languages(): any;
-    /**
-     * Layer accessor
-     * @see {@link Layer}
-     * @returns {ResourceProxy<Layer>} - A proxy for accessing the resource
-     */
-    get layers(): any;
-    /**
-     * LayerFaq accessor
-     * @see {@link LayerFaq}
-     * @returns {ResourceProxy<LayerFaq>} - A proxy for accessing the resource
-     */
-    get layerFaqs(): any;
-    /**
-     * Layer group accessor
-     * @see {@link LayerGroup}
-     * @returns {ResourceProxy<LayerGroup>} - A proxy for accessing the resource
-     */
-    get layerGroups(): any;
-    /**
-     * Mapstyle accessor
-     * @see {@link Mapstyle}
-     * @returns {ResourceProxy<Mapstyle>} - A proxy for accessing the resource
-     */
-    get mapstyles(): any;
-    /**
-     * MapstyleSet accessor
-     * @see {@link MapstyleSet}
-     * @returns {ResourceProxy<MapstyleSet>} - A proxy for accessing the resource
-     */
-    get mapstyleSets(): any;
-    /**
-     * Notification accessor
-     * @see {@link Notification}
-     * @returns {ResourceProxy<Notification>} - A proxy for accessing the resource
-     */
-    get notifications(): any;
-    /**
-     * Message accessor
-     * @see {@link Message}
-     * @returns {ResourceProxy<Message>} - A proxy for accessing the resource
-     */
-    get messages(): any;
-    /**
-     * Organisation accessor
-     * @see {@link Organisation}
-     * @returns {ResourceProxy<Organisation>} - A proxy for accessing the resource
-     */
-    get organisations(): any;
-    /**
-     * Permission accessor
-     * @see {@link Permission}
-     * @returns {ResourceProxy<Permission>} - A proxy for accessing the resource
-     */
-    get permissions(): any;
-    /**
-     * Product tour accessor
-     * @see {@link ProductTour}
-     * @returns {ResourceProxy<ProductTour>} - A proxy for accessing the resource
-     */
-    get productTours(): any;
-    /**
-     * Product tour step accessor
-     * @see {@link ProductTourStep}
-     * @returns {ResourceProxy<ProductTourStep>} - A proxy for accessing the resource
-     */
-    get productTourSteps(): any;
-    /**
-     * Role accessor
-     * @see {@link Role}
-     * @returns {ResourceProxy<Role>} - A proxy for accessing the resource
-     */
-    get roles(): any;
-    /**
-     * Svg accessor
-     * @see {@link Svg}
-     * @returns {ResourceProxy<Svg>} - A proxy for accessing the resource
-     */
-    get svgs(): any;
-    /**
-     * SvgSet accessor
-     * @see {@link SvgSet}
-     * @returns {ResourceProxy<SvgSet>} - A proxy for accessing the resource
-     */
-    get svgSets(): any;
-    /**
-     * User accessor
-     * @see {@link User}
-     * @returns {ResourceProxy<User>} - A proxy for accessing the resource
-     */
-    get users(): any;
-    /**
-     * Get SVG set types
-     * @see {@link SvgSet}
-     * @returns {CancelablePromise<Enum>} - Contains all the possible SVG set types
-     * @throws {ApiError} - If the api returns errors
-     */
-    getSvgSetTypes(): CancelablePromise<Enum>;
-    /**
-     * Get font styles
-     * @see {@link Font}
-     * @returns {CancelablePromise<Enum>} - Contains all the possible font styles
-     * @throws {ApiError} - If the api returns errors
-     */
-    getFontStyles(): CancelablePromise<Enum>;
-    /**
-     * Forget the current session
-     * This will clean up any stored OAuth states stored using {@link StateContainer} and any OAuth tokens stored
-     * @returns {CancelablePromise}
-     * @throws {ApiError} - If the api returns errors
-     */
-    logout(): CancelablePromise;
-}
-import OAuth from "./oauth/OAuth";
-import Logger from "./utils/Logger";
-import ResourceProxy from "./proxy/ResourceProxy";
-import { Enum } from "./enums";
-//# sourceMappingURL=Mapcreator.d.ts.map

package/dist/PaginatedResourceListing.d.ts

@@ -1,156 +0,0 @@
-/**
- * Proxy for accessing paginated resources
- */
-export default class PaginatedResourceListing {
-    /**
-     * @param {Mapcreator} api - Instance of the api
-     * @param {String} route - Resource route
-     * @param {Class<ResourceBase>} Target - Wrapper target
-     * @param {RequestParameters} parameters - Request parameters
-     * @param {Number} pageCount - Resolved page count
-     * @param {Number} rowCount - Resolved rowCount
-     * @param {Array<ResourceBase>} data - Resolved data
-     * @private
-     */
-    private constructor();
-    _api: Mapcreator;
-    /**
-     * Override the target route
-     * @param {String} value - route
-     */
-    set route(arg: string);
-    /**
-     * Target route
-     * @returns {String} - Url
-     */
-    get route(): string;
-    _Target: Class<ResourceBase>;
-    _parameters: RequestParameters;
-    _pageCount: number;
-    _rows: number;
-    _data: ResourceBase[];
-    /**
-     * Get api instance
-     * @returns {Mapcreator} - Api instance
-     */
-    get api(): Mapcreator;
-    _route: string;
-    /**
-     * Target to wrap results in
-     * @returns {Class<ResourceBase>} - Target constructor
-     */
-    get Target(): Class<ResourceBase>;
-    /**
-     * Request parameters
-     * @param {RequestParameters} value - Request parameters
-     */
-    set parameters(arg: RequestParameters);
-    /**
-     * Request parameters
-     * @returns {RequestParameters} - Request parameters
-     */
-    get parameters(): RequestParameters;
-    /**
-     * Current page number
-     * @returns {Number} - Current page
-     */
-    get page(): number;
-    /**
-     * Maximum amount of items per page
-     * @returns {Number} - Amount of items
-     */
-    get perPage(): number;
-    /**
-     * Current sorting value
-     * @param {Array<String>} value - Sort
-     */
-    set sort(arg: string[]);
-    /**
-     * Set sort direction
-     * @returns {Array<String>} - Sort
-     * @example
-     * const sort = ['-name', 'id']
-     */
-    get sort(): string[];
-    /**
-     * Deleted items filter state
-     * @param {String} value - Deleted items filter state
-     * @see {@link DeletedState}
-     */
-    set deleted(arg: string);
-    /**
-     * Deleted items filter state
-     * @returns {String} value - Deleted items filter state
-     * @see {@link DeletedState}
-     */
-    get deleted(): string;
-    /**
-     * Amount of pages available
-     * @returns {Number} - Page count
-     */
-    get pageCount(): number;
-    /**
-     * Page data
-     * @returns {Array<ResourceBase>} - Wrapped data
-     */
-    get data(): ResourceBase[];
-    /**
-     * Row count
-     * @returns {Number} - Row count
-     */
-    get rows(): number;
-    /**
-     * Optional search query
-     * @param {Object<String, String|Array<String>>} value - Query
-     * @throws {TypeError}
-     * @default {}
-     * @see {@link ResourceProxy#search}
-     */
-    set query(arg: any);
-    /**
-     * Optional search query
-     * @default {}
-     * @return {Object<String, String|Array<String>>} - Query
-     */
-    get query(): any;
-    /**
-     * Get target page
-     * @param {Number} page - Page number
-     * @param {Number} perPage - Amount of items per page (max 50)
-     * @returns {CancelablePromise<PaginatedResourceListing>} - Target page
-     * @throws {ApiError} - If the api returns errors
-     */
-    getPage(page?: number, perPage?: number): CancelablePromise<PaginatedResourceListing>;
-    /**
-     * If there is a next page
-     * @returns {boolean} - If there is a next page
-     */
-    get hasNext(): boolean;
-    /**
-     * If there is a previous page
-     * @returns {boolean} - If there is a previous page
-     */
-    get hasPrevious(): boolean;
-    /**
-     * Used for caching pages internally
-     * @returns {string} - Cache token
-     * @see {@link PaginatedResourceWrapper}
-     * @see {@link ResourceCache}
-     */
-    get cacheToken(): string;
-    /**
-     * Get next page
-     * @returns {CancelablePromise<PaginatedResourceListing>} - Paginated resource
-     * @throws {ApiError} - If the api returns errors
-     */
-    next(): CancelablePromise<PaginatedResourceListing>;
-    /**
-     * Get previous page
-     * @returns {CancelablePromise<PaginatedResourceListing>} - Paginated resource
-     * @throws {ApiError} - If the api returns errors
-     */
-    previous(): CancelablePromise<PaginatedResourceListing>;
-}
-import Mapcreator from "./Mapcreator";
-import RequestParameters from "./RequestParameters";
-//# sourceMappingURL=PaginatedResourceListing.d.ts.map