Add pagination types

This commit is contained in:
Ferdinand Thiessen 2021-11-25 13:39:44 +01:00
parent c37f4db241
commit 9094b38a8a
3 changed files with 23 additions and 4 deletions

View File

@ -1,6 +1,6 @@
{
"license": "MIT",
"version": "1.0.0-alpha.6",
"version": "1.0.0-alpha.7",
"name": "@flaschengeist/types",
"author": "Ferdinand Thiessen <rpm@fthiessen.de>",
"homepage": "https://flaschengeist.dev/",

View File

@ -1,3 +1,7 @@
/**
* Types used for communicating with the API
*/
declare namespace FG {
interface Notification {
id: number;
@ -31,4 +35,14 @@ declare namespace FG {
name: string;
permissions: Array<Permission>;
}
interface PaginationFilter {
limit?: number;
offset?: number;
from?: Date;
to?: Date;
}
interface PaginationResponse<T> {
result: T[];
count: number;
}
}

11
types/plugin.d.ts vendored
View File

@ -1,6 +1,11 @@
import type { RouteLocationRaw, RouteRecordRaw, RouteRecordName } from 'vue-router';
import type { Component } from '@vue/runtime-core';
/**
* Types used for defining custom plugins and loading those plugins
* + Additional types for plugin interaction with the core
*/
/* This is some sort of PEP440 subset */
type Join<T extends unknown[], D extends string> = T extends []
? ''
@ -114,7 +119,7 @@ export namespace FG_Plugin {
/** Name of the target route */
link: RouteRecordName;
/**
* Order inside the menu, higher numbers come ahead of lower numbers
* Order inside the menu, higher numbers come ahead of lower numbers
* @todo: Promote to required with first beta
*/
order?: number;
@ -141,9 +146,9 @@ export namespace FG_Plugin {
*/
priority?: number;
/**
* Default order on the dashboard, higher numbers come ahead of lower numbers
* Default order on the dashboard, higher numbers come ahead of lower numbers
* @todo Promote to required if priority is removed
*/
*/
order?: number;
permissions: FG.Permission[];
widget: Component;