yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

remove old temp schema generator

Browse Source
This commit is contained in:
Jacob Overgaard
2022-11-09 11:48:20 +01:00
parent fadeb4676c
commit d5a3e7cfcd
14 changed files with 0 additions and 4968 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Umbraco.Web.UI.Client/temp-schema-generator/README.md
View File

@@ -1,12 +0,0 @@
# What is this?
This folder contains the schema generator which resides here temporarily until Umbraco provides a proper way to generate schemas in its own repository.
## How do I use it?
1. Run `npm install` in this folder.
2. Update any schema through `api.ts` and then run `npm run generate` to simulate a new schema.
3. You then need to go to the main folder and run `npm run generate:api` to generate the API fetchers and interfaces.
1. This is the only thing that will remain in the final version.
We are using the excellent tool `@airtasker/spot` to decorate the schema methods. [You can read more about it here](https://github.com/airtasker/spot).

13
src/Umbraco.Web.UI.Client/temp-schema-generator/api.ts
View File

@@ -1,13 +0,0 @@
import './installer';
import './manifests';
import './publishedstatus';
import './server';
import './upgrader';
import './user';
import './telemetry';
import { api } from '@airtasker/spot';
/* eslint-disable */
@api({ name: 'umbraco-backoffice-api', version: '1.0.0' })
class Api {}

0
src/Umbraco.Web.UI.Client/temp-schema-generator/errors.ts
View File

101
src/Umbraco.Web.UI.Client/temp-schema-generator/installer.ts
View File

@@ -1,101 +0,0 @@
import { body, defaultResponse, endpoint, request, response } from '@airtasker/spot';
import { ProblemDetails } from './models';
@endpoint({
method: 'GET',
path: '/install/settings',
})
export class GetInstallSettings {
@response({ status: 200 })
success(@body body: InstallSettingsResponse) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/install/setup',
})
export class PostInstallSetup {
@request
request(@body body: InstallSetupRequest) {}
@response({ status: 201 })
success() {}
@response({ status: 400 })
badRequest(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/install/validateDatabase',
})
export class PostInstallValidateDatabase {
@request
request(@body body: InstallSetupDatabaseConfiguration) {}
@response({ status: 201 })
success() {}
@response({ status: 400 })
badRequest(@body body: ProblemDetails) {}
}
export interface InstallSetupRequest {
user: InstallSetupUserConfiguration;
telemetryLevel: ConsentLevel;
database?: InstallSetupDatabaseConfiguration;
}
export interface InstallSettingsResponse {
user: InstallUserModel;
databases: InstallDatabaseModel[];
}
export interface InstallUserModel {
minCharLength: number;
minNonAlphaNumericLength: number;
consentLevels: TelemetryModel[];
}
export interface InstallSetupUserConfiguration {
name: string;
email: string;
password: string;
subscribeToNewsletter: boolean;
}
export interface InstallSetupDatabaseConfiguration {
id?: string;
server?: string | null;
password?: string | null;
username?: string | null;
name?: string | null;
providerName?: string | null;
useIntegratedAuthentication?: boolean | null;
connectionString?: string | null;
}
export interface TelemetryModel {
level: ConsentLevel;
description: string;
}
export interface InstallDatabaseModel {
id: string;
sortOrder: number;
displayName: string;
defaultDatabaseName: string;
providerName: null | string;
isConfigured: boolean;
requiresServer: boolean;
serverPlaceholder: null | string;
requiresCredentials: boolean;
supportsIntegratedAuthentication: boolean;
requiresConnectionTest: boolean;
}
export type ConsentLevel = 'Minimal' | 'Basic' | 'Detailed';

47
src/Umbraco.Web.UI.Client/temp-schema-generator/manifests.ts
View File

@@ -1,47 +0,0 @@
import { body, defaultResponse, endpoint, response } from '@airtasker/spot';
import { ProblemDetails } from './models';
@endpoint({ method: 'GET', path: '/manifests' })
export class Manifests {
@response({ status: 200 })
response(@body body: ManifestsResponse) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({ method: 'GET', path: '/manifests/packages' })
export class ManifestsPackages {
@response({ status: 200 })
response(@body body: {}) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({ method: 'GET', path: '/manifests/packages/installed' })
export class ManifestsPackagesInstalled {
@response({ status: 200 })
response(@body body: ManifestsPackagesInstalledResponse) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
export interface ManifestsResponse {
manifests: {}[];
}
export interface ManifestsPackagesInstalledResponse {
packages: PackageInstalled[];
}
export interface PackageInstalled {
id: string;
name: string;
alias: string;
version: string;
hasMigrations: boolean;
hasPendingMigrations: boolean;
plans: {}[];
}

29
src/Umbraco.Web.UI.Client/temp-schema-generator/models.ts
View File

@@ -1,29 +0,0 @@
export type ServerStatus = 'running' | 'must-install' | 'must-upgrade';
export interface StatusResponse {
serverStatus: ServerStatus;
}
export interface VersionResponse {
version: string;
}
export interface UserResponse {
username: string;
role: string;
}
export interface UserLoginRequest {
username: string;
password: string;
persist: boolean;
}
export interface ProblemDetails {
type: string;
status: number;
title?: string;
detail?: string;
instance?: string;
errors?: {};
}

4427
src/Umbraco.Web.UI.Client/temp-schema-generator/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

16
src/Umbraco.Web.UI.Client/temp-schema-generator/package.json
View File

@@ -1,16 +0,0 @@
{
"name": "temp-schema-generator",
"version": "1.0.0",
"description": "This is to be deleted when schema generation moves somewhere else",
"main": "api.ts",
"scripts": {
"generate": "npx @airtasker/spot generate --contract api.ts --language yaml --generator openapi3 --out ../schemas/api",
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "JOV",
"license": "MIT",
"devDependencies": {
"@airtasker/spot": "^1.9.0",
"typescript": "^4.6.4"
}
}

57
src/Umbraco.Web.UI.Client/temp-schema-generator/publishedstatus.ts
View File

@@ -1,57 +0,0 @@
import { body, defaultResponse, endpoint, request, response } from '@airtasker/spot';
import { ProblemDetails } from './models';
@endpoint({
method: 'GET',
path: '/published-cache/status',
})
export class PublishedCacheStatus {
@response({ status: 200 })
success(@body body: string) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/published-cache/reload',
})
export class PublishedCacheReload {
@request
request() {}
@response({ status: 201 })
success() {}
@response({ status: 400 })
badRequest(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/published-cache/rebuild',
})
export class PublishedCacheRebuild {
@request
request() {}
@response({ status: 201 })
success() {}
@response({ status: 400 })
badRequest(@body body: ProblemDetails) {}
}
@endpoint({
method: 'GET',
path: '/published-cache/collect',
})
export class PublishedCacheCollect {
@response({ status: 200 })
success(@body body: string) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}

27
src/Umbraco.Web.UI.Client/temp-schema-generator/server.ts
View File

@@ -1,27 +0,0 @@
import { body, defaultResponse, endpoint, response } from '@airtasker/spot';
import { ProblemDetails, StatusResponse, VersionResponse } from './models';
@endpoint({
method: 'GET',
path: '/server/status',
})
export class GetStatus {
@response({ status: 200 })
success(@body body: StatusResponse) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'GET',
path: '/server/version',
})
export class GetVersion {
@response({ status: 200 })
success(@body body: VersionResponse) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}

47
src/Umbraco.Web.UI.Client/temp-schema-generator/telemetry.ts
View File

@@ -1,47 +0,0 @@
import { body, defaultResponse, endpoint, request, response } from '@airtasker/spot';
import { TelemetryModel } from './installer';
import { ProblemDetails } from './models';
@endpoint({
method: 'GET',
path: '/telemetry/ConsentLevel',
})
export class GetConsentLevel {
@response({ status: 200 })
success(@body body: ConsentLevelSettings) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'GET',
path: '/telemetry/ConsentLevels',
})
export class ConsentLevels {
@response({ status: 200 })
success(@body body: string[]) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/telemetry/ConsentLevel',
})
export class PostConsentLevel {
@request
request(@body body: ConsentLevelSettings) {}
@response({ status: 201 })
success() {}
@response({ status: 400 })
badRequest(@body body: ProblemDetails) {}
}
export interface ConsentLevelSettings {
telemetryLevel: TelemetryModel['level'];
}

96
src/Umbraco.Web.UI.Client/temp-schema-generator/tsconfig.json
View File

@@ -1,96 +0,0 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Projects */
"incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "esnext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
"experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
"emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
/* Modules */
"module": "esnext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
"isolatedModules": false, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
// "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": [
"**/*.ts"
],
}

38
src/Umbraco.Web.UI.Client/temp-schema-generator/upgrader.ts
View File

@@ -1,38 +0,0 @@
import { body, defaultResponse, endpoint, request, response } from '@airtasker/spot';
import { ProblemDetails } from './models';
@endpoint({
method: 'GET',
path: '/upgrade/settings',
})
export class GetUpgradeSettings {
@response({ status: 200 })
success(@body body: UpgradeSettingsResponse) {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/upgrade/authorize',
})
export class PostUpgradeAuthorize {
@request
request() {}
@response({ status: 201 })
success() {}
@response({ status: 400 })
badRequest(@body body: ProblemDetails) {}
}
export interface UpgradeSettingsResponse {
currentState: string;
newState: string;
newVersion: string;
oldVersion: string;
reportUrl: string;
}

58
src/Umbraco.Web.UI.Client/temp-schema-generator/user.ts
View File

@@ -1,58 +0,0 @@
import { body, defaultResponse, endpoint, request, response } from '@airtasker/spot';
import { ProblemDetails, UserLoginRequest, UserResponse } from './models';
@endpoint({
method: 'GET',
path: '/user',
})
class GetUser {
@response({ status: 200 })
success(@body body: UserResponse) {}
@response({ status: 403 })
failure(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/user/login',
})
class PostUserLogin {
@request
request(@body body: UserLoginRequest) {}
@response({ status: 201 })
success() {}
@response({ status: 403 })
failure(@body body: ProblemDetails) {}
}
@endpoint({
method: 'POST',
path: '/user/logout',
})
class PostUserLogout {
@response({ status: 201 })
success() {}
@defaultResponse
default(@body body: ProblemDetails) {}
}
@endpoint({
method: 'GET',
path: '/user/sections',
})
export class GetAllowedSections {
@response({ status: 200 })
successResponse(@body body: AllowedSectionsResponse) {}
@defaultResponse
defaultResponse(@body body: ProblemDetails) {}
}
export interface AllowedSectionsResponse {
sections: string[];
}