Compare commits

..

2 Commits

6 changed files with 37 additions and 31 deletions

2
.npmignore Normal file
View File

@ -0,0 +1,2 @@
yarn-error.log
yarn.lock

View File

@ -1,6 +1,6 @@
{
"license": "MIT",
"version": "1.0.0-alpha.9",
"version": "1.0.0-alpha.10",
"name": "@flaschengeist/types",
"author": "Ferdinand Thiessen <rpm@fthiessen.de>",
"homepage": "https://flaschengeist.dev/",
@ -19,11 +19,11 @@
"pretty": "prettier --config ./package.json --write '{,!(node_modules)/**/}*.ts'"
},
"peerDependencies": {
"vue": "^3.2.4",
"vue": "^3.2.20",
"vue-router": "^4.0.11"
},
"devDependencies": {
"prettier": "^2.4.1",
"prettier": "^2.5.1",
"typescript": "^4.5.2"
},
"prettier": {

2
types/PEP440.d.ts vendored
View File

@ -11,4 +11,4 @@ type PreRelease = Join<[['a' | 'b' | 'rc'], number], '.'>;
type PRVersion = BaseVersion | `${BaseVersion}${PreRelease}`;
/** A PEP440 subset used to describe backend module versions */
declare type PEP440Version = PRVersion | `${PRVersion}.dev${number}`;
declare type PEP440Version = PRVersion | `${PRVersion}.dev${number}`;

27
types/api.d.ts vendored Normal file
View File

@ -0,0 +1,27 @@
/// <reference path="PEP440.d.ts" />
/**
* Types used for communicating with the API
*/
declare namespace FG {
interface BackendPlugin {
permissions: string[];
version: PEP440Version;
}
interface Backend {
plugins: { [key: string]: BackendPlugin };
version: PEP440Version;
}
interface PaginationFilter {
limit?: number;
offset?: number;
from?: Date;
to?: Date;
/** Default to ascending */
descending?: boolean;
}
interface PaginationResponse<T> {
result: T[];
count: number;
}
}

3
types/index.d.ts vendored
View File

@ -1,4 +1,5 @@
/// <reference path="flaschengeist.d.ts" />
/// <reference path="api.d.ts" />
/// <reference path="models.d.ts" />
/// <reference path="PEP440.d.ts" />
export * from './plugin';

View File

@ -1,17 +1,5 @@
/// <reference path="PEP440.d.ts" />
/**
* Types used for communicating with the API
*/
/** Models exported from backend */
declare namespace FG {
interface BackendPlugin {
permissions: string[];
version: PEP440Version;
}
interface Backend {
plugins: {[key: string]: BackendPlugin};
version: PEP440Version;
}
interface Notification {
id: number;
plugin: string;
@ -21,6 +9,7 @@ declare namespace FG {
}
interface User {
userid: string;
deleted: boolean;
display_name: string;
firstname: string;
lastname: string;
@ -28,7 +17,6 @@ declare namespace FG {
birthday?: Date;
roles: Array<string>;
permissions?: Array<string>;
avatar_url?: string;
}
interface Session {
expires: Date;
@ -44,16 +32,4 @@ declare namespace FG {
name: string;
permissions: Array<Permission>;
}
interface PaginationFilter {
limit?: number;
offset?: number;
from?: Date;
to?: Date;
/** Default to ascending */
descending?: boolean;
}
interface PaginationResponse<T> {
result: T[];
count: number;
}
}