trm-registry-types 1.2.0 → 2.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 RegestaItalia
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 RegestaItalia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,26 +1,26 @@
-# TRM Registry Types
-
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.3.0-4baaaa.svg)](https://github.com/RegestaItalia/trm-docs/blob/main/CODE_OF_CONDUCT.md)
-![trm-registry-types version](https://img.shields.io/npm/v/trm-registry-types?label=trm-registry-types)
-
-[trm-registry-types](https://www.npmjs.com/package/trm-registry-types) is a Node package that contains the type declaration of all TRM Registry REST APIs requests and responses.
-
-# Documentation <!-- {docsify-remove} -->
-
-The documentation of TRM Registry Types is only related to the request and response objects.
-
-The API documentation (and object usage) can be found [here](https://docs.trmregistry.com).
-
-<!-- START TABLE_OF_CONTENTS.md -->
-- [Request types](docs/requests.md)
-- [Response types](docs/responses.md)<!-- END TABLE_OF_CONTENTS.md -->
-
-# Contributing <!-- {docsify-remove} -->
-
-Like every other TRM open-soruce projects, contributions are always welcomed ❤️.
-
-Make sure to open an issue first.
-
-Contributions will be merged upon approval.
-
+# TRM Registry Types
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.3.0-4baaaa.svg)](https://github.com/RegestaItalia/trm-docs/blob/main/CODE_OF_CONDUCT.md)
+![trm-registry-types version](https://img.shields.io/npm/v/trm-registry-types?label=trm-registry-types)
+
+[trm-registry-types](https://www.npmjs.com/package/trm-registry-types) is a Node package that contains the type declaration of all TRM Registry REST APIs requests and responses.
+
+# Documentation <!-- {docsify-remove} -->
+
+The documentation of TRM Registry Types is only related to the request and response objects.
+
+The API documentation (and object usage) can be found [here](https://docs.trmregistry.com).
+
+<!-- START TABLE_OF_CONTENTS.md -->
+- [Request types](docs/requests.md)
+- [Response types](docs/responses.md)<!-- END TABLE_OF_CONTENTS.md -->
+
+# Contributing <!-- {docsify-remove} -->
+
+Like every other TRM open-soruce projects, contributions are always welcomed ❤️.
+
+Make sure to open an issue first.
+
+Contributions will be merged upon approval.
+
 [Click here](https://docs.trmregistry.com/#/CONTRIBUTING) for the full list of TRM contribution guidelines.

package/dist/request/Deprecate.d.ts

@@ -0,0 +1,3 @@
+export interface Deprecate {
+    deprecate_note: string;
+}

package/dist/{Ping.js → request/Deprecate.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Ping.js.map
+//# sourceMappingURL=Deprecate.js.map

package/dist/request/Deprecate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deprecate.js","sourceRoot":"","sources":["../../src/request/Deprecate.ts"],"names":[],"mappings":""}

package/dist/request/OAuth2Body.d.ts

@@ -1,6 +1,6 @@
-export type OAuth2Body = {
+export interface OAuth2Body {
     grant_type: 'refresh_token' | 'authorization_code';
     code?: string;
     refresh_token?: string;
     redirect_uri?: string;
-};
+}

package/dist/request/index.d.ts

@@ -1 +1,2 @@
 export * from "./OAuth2Body";
+export * from "./Deprecate";

package/dist/request/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./OAuth2Body"), exports);
+__exportStar(require("./Deprecate"), exports);
 //# sourceMappingURL=index.js.map

package/dist/request/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,8CAA4B"}

package/dist/response/AuthOAuth2.d.ts

@@ -1,6 +1,6 @@
-export type AuthOAuth2 = {
+export interface AuthOAuth2 {
     access_token: string;
     token_type: 'Bearer';
     expires_in: number;
     refresh_token?: string;
-};
+}

package/dist/{ResponseMessage.d.ts → response/Message.d.ts}

@@ -1,5 +1,5 @@
 import { MessageType } from "./MessageType";
-export type ResponseMessage = {
+export interface Message {
     type: MessageType;
     text: string;
-};
+}

package/dist/{View.js → response/Message.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=View.js.map
+//# sourceMappingURL=Message.js.map

package/dist/response/Message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Message.js","sourceRoot":"","sources":["../../src/response/Message.ts"],"names":[],"mappings":""}

package/dist/response/OAuth2Data.d.ts

@@ -1,6 +1,6 @@
 export type OAuth2Data = {
-    authorizationUrl: string;
-    clientId: string;
-    responseType: 'code';
+    authorization_url: string;
+    client_id: string;
+    response_type: 'code';
     scope?: string;
 };

package/dist/response/Package.d.ts

@@ -0,0 +1,12 @@
+export interface Package {
+    name: string;
+    latest: string;
+    versions: string[];
+    yanked_versions: string[];
+    manifest: any;
+    deprecated: boolean;
+    deprecated_message?: string;
+    download_link: string;
+    download_link_expiry?: number;
+    checksum: string;
+}

package/dist/{WhoAmI.js → response/Package.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=WhoAmI.js.map
+//# sourceMappingURL=Package.js.map

package/dist/response/Package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Package.js","sourceRoot":"","sources":["../../src/response/Package.ts"],"names":[],"mappings":""}

package/dist/response/Ping.d.ts

@@ -1,8 +1,9 @@
 import { AuthenticationType } from "./AuthenticationType";
 import { OAuth2Data } from "./OAuth2Data";
-import { ResponseMessage } from "./ResponseMessage";
-export type Ping = {
-    authenticationType: AuthenticationType;
-    authenticationData?: OAuth2Data;
-    wallMessage?: ResponseMessage;
-};
+import { Message } from "./Message";
+export interface Ping {
+    authentication_type: AuthenticationType;
+    authentication_data?: OAuth2Data;
+    alert_email?: string;
+    messages?: Message[];
+}

package/dist/response/WhoAmI.d.ts

@@ -1,7 +1,5 @@
-import { ResponseMessage } from "./ResponseMessage";
-export type WhoAmI = {
-    logonMessage?: ResponseMessage;
-    username: string;
-    subscription?: string;
-    subscriptionEnd?: Date;
-};
+import { Message } from "./Message";
+export interface WhoAmI {
+    user: string;
+    messages?: Message[];
+}

package/dist/response/index.d.ts

@@ -1,10 +1,8 @@
-export * from "./Ping";
-export * from "./UserAuthorization";
-export * from "./View";
-export * from "./Release";
-export * from "./WhoAmI";
 export * from "./AuthenticationType";
-export * from "./MessageType";
-export * from "./ResponseMessage";
 export * from "./OAuth2Data";
 export * from "./AuthOAuth2";
+export * from "./MessageType";
+export * from "./Message";
+export * from "./Ping";
+export * from "./WhoAmI";
+export * from "./Package";

package/dist/response/index.js

@@ -14,14 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Ping"), exports);
-__exportStar(require("./UserAuthorization"), exports);
-__exportStar(require("./View"), exports);
-__exportStar(require("./Release"), exports);
-__exportStar(require("./WhoAmI"), exports);
 __exportStar(require("./AuthenticationType"), exports);
-__exportStar(require("./MessageType"), exports);
-__exportStar(require("./ResponseMessage"), exports);
 __exportStar(require("./OAuth2Data"), exports);
 __exportStar(require("./AuthOAuth2"), exports);
+__exportStar(require("./MessageType"), exports);
+__exportStar(require("./Message"), exports);
+__exportStar(require("./Ping"), exports);
+__exportStar(require("./WhoAmI"), exports);
+__exportStar(require("./Package"), exports);
 //# sourceMappingURL=index.js.map

package/dist/response/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,sDAAoC;AACpC,yCAAuB;AACvB,4CAA0B;AAC1B,2CAAyB;AACzB,uDAAqC;AACrC,gDAA8B;AAC9B,oDAAkC;AAClC,+CAA6B;AAC7B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,+CAA6B;AAC7B,+CAA6B;AAC7B,gDAA8B;AAC9B,4CAA0B;AAC1B,yCAAuB;AACvB,2CAAyB;AACzB,4CAA0B"}

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "trm-registry-types",
-  "version": "1.2.0",
-  "description": "TRM Registry Types",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "/dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
-  },
-  "keywords": [
-    "trm",
-    "abap"
-  ],
-  "homepage": "https://www.trmregistry.com",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/RegestaItalia/trm-registry-types.git"
-  },
-  "author": {
-    "name": "Simone Gaffurini",
-    "email": "simone.gaffurini@regestaitalia.it"
-  },
-  "license": "MIT"
-}
+{
+  "name": "trm-registry-types",
+  "version": "2.0.0",
+  "description": "TRM Registry Types",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "trm",
+    "abap"
+  ],
+  "homepage": "https://www.trmregistry.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RegestaItalia/trm-registry-types.git"
+  },
+  "author": {
+    "name": "Simone Gaffurini",
+    "email": "simone.gaffurini@regestaitalia.it"
+  },
+  "license": "MIT"
+}

package/dist/AuthOAuth2.d.ts

@@ -1,4 +0,0 @@
-export type AuthOAuth2 = {
-    access_token: string;
-    refresh_token?: string;
-};

package/dist/AuthOAuth2.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=AuthOAuth2.js.map

package/dist/AuthOAuth2.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AuthOAuth2.js","sourceRoot":"","sources":["../src/AuthOAuth2.ts"],"names":[],"mappings":""}

package/dist/AuthenticationType.d.ts

@@ -1,5 +0,0 @@
-export declare enum AuthenticationType {
-    NO_AUTH = "NO_AUTH",
-    BASIC = "BASIC",
-    OAUTH2 = "OAUTH2"
-}

package/dist/AuthenticationType.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthenticationType = void 0;
-var AuthenticationType;
-(function (AuthenticationType) {
-    AuthenticationType["NO_AUTH"] = "NO_AUTH";
-    AuthenticationType["BASIC"] = "BASIC";
-    AuthenticationType["OAUTH2"] = "OAUTH2";
-})(AuthenticationType || (exports.AuthenticationType = AuthenticationType = {}));
-//# sourceMappingURL=AuthenticationType.js.map

package/dist/AuthenticationType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AuthenticationType.js","sourceRoot":"","sources":["../src/AuthenticationType.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,yCAAmB,CAAA;IACnB,qCAAe,CAAA;IACf,uCAAiB,CAAA;AACrB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}

package/dist/MessageType.d.ts

@@ -1,5 +0,0 @@
-export declare enum MessageType {
-    WARNING = "WARNING",
-    ERROR = "ERROR",
-    INFO = "INFO"
-}

package/dist/MessageType.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageType = void 0;
-var MessageType;
-(function (MessageType) {
-    MessageType["WARNING"] = "WARNING";
-    MessageType["ERROR"] = "ERROR";
-    MessageType["INFO"] = "INFO";
-})(MessageType || (exports.MessageType = MessageType = {}));
-//# sourceMappingURL=MessageType.js.map

package/dist/MessageType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MessageType.js","sourceRoot":"","sources":["../src/MessageType.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAIX;AAJD,WAAY,WAAW;IACnB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;IACf,4BAAa,CAAA;AACjB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}

package/dist/OAuth2Data.d.ts

@@ -1,6 +0,0 @@
-export type OAuth2Data = {
-    authorizationUrl: string;
-    clientId: string;
-    responseType: 'code';
-    scope?: string;
-};

package/dist/OAuth2Data.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=OAuth2Data.js.map

package/dist/OAuth2Data.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OAuth2Data.js","sourceRoot":"","sources":["../src/OAuth2Data.ts"],"names":[],"mappings":""}

package/dist/Ping.d.ts

@@ -1,8 +0,0 @@
-import { AuthenticationType } from "./AuthenticationType";
-import { OAuth2Data } from "./OAuth2Data";
-import { ResponseMessage } from "./ResponseMessage";
-export type Ping = {
-    authenticationType: AuthenticationType;
-    authenticationData?: OAuth2Data;
-    wallMessage?: ResponseMessage;
-};

package/dist/Ping.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Ping.js","sourceRoot":"","sources":["../src/Ping.ts"],"names":[],"mappings":""}

package/dist/Release.d.ts

@@ -1,5 +0,0 @@
-export type Release = {
-    version: string;
-    deprecated?: boolean;
-    latest: boolean;
-};

package/dist/Release.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Release.js.map

package/dist/Release.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Release.js","sourceRoot":"","sources":["../src/Release.ts"],"names":[],"mappings":""}

package/dist/ResponseMessage.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ResponseMessage.js.map

package/dist/ResponseMessage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ResponseMessage.js","sourceRoot":"","sources":["../src/ResponseMessage.ts"],"names":[],"mappings":""}

package/dist/UserAuthorization.d.ts

@@ -1,3 +0,0 @@
-export type UserAuthorization = {
-    canCreateReleases: boolean;
-};

package/dist/UserAuthorization.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=UserAuthorization.js.map

package/dist/UserAuthorization.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UserAuthorization.js","sourceRoot":"","sources":["../src/UserAuthorization.ts"],"names":[],"mappings":""}

package/dist/View.d.ts

@@ -1,12 +0,0 @@
-import { Release } from "./Release";
-import { UserAuthorization } from "./UserAuthorization";
-export type View = {
-    name?: string;
-    private?: boolean;
-    shortDescription?: string;
-    website?: string;
-    git?: string;
-    license?: string;
-    userAuthorizations: UserAuthorization;
-    release?: Release;
-};

package/dist/View.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"View.js","sourceRoot":"","sources":["../src/View.ts"],"names":[],"mappings":""}

package/dist/WhoAmI.d.ts

@@ -1,5 +0,0 @@
-import { ResponseMessage } from "./ResponseMessage";
-export type WhoAmI = {
-    logonMessage?: ResponseMessage;
-    username: string;
-};

package/dist/WhoAmI.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WhoAmI.js","sourceRoot":"","sources":["../src/WhoAmI.ts"],"names":[],"mappings":""}

package/dist/response/ResponseMessage.d.ts

@@ -1,5 +0,0 @@
-import { MessageType } from "./MessageType";
-export type ResponseMessage = {
-    type: MessageType;
-    text: string;
-};

package/dist/response/ResponseMessage.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ResponseMessage.js.map

package/dist/response/ResponseMessage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ResponseMessage.js","sourceRoot":"","sources":["../../src/response/ResponseMessage.ts"],"names":[],"mappings":""}