@hosterai/types 0.0.18 → 0.0.20

package/dist/dtos/product/responses/product-upgradeable-response.dto.d.ts

@@ -0,0 +1,22 @@
+import { ResponseStatusEnum } from '../../../enums/response-status.enum';
+import { BaseResponse } from '../../base-response.dto';
+/**
+ * Represents the response for a product upgradeable check.
+ * It indicates whether a product item is upgradeable and may contain additional data.
+ */
+export declare class ProductUpgradeableResponseDto extends BaseResponse {
+    /**
+     * The status of the response, indicating success or failure.
+     */
+    status: ResponseStatusEnum;
+    /**
+     * The unique identifier of the product item being checked.
+     */
+    itemId: string;
+    /**
+     * Optional data associated with the upgradeable check.
+     * Can contain details about available upgrades or reasons for failure.
+     * @optional
+     */
+    data?: Record<string, unknown>;
+}

package/dist/dtos/product/responses/product-upgradeable-response.dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductUpgradeableResponseDto = void 0;
+const base_response_dto_1 = require("../../base-response.dto");
+/**
+ * Represents the response for a product upgradeable check.
+ * It indicates whether a product item is upgradeable and may contain additional data.
+ */
+class ProductUpgradeableResponseDto extends base_response_dto_1.BaseResponse {
+}
+exports.ProductUpgradeableResponseDto = ProductUpgradeableResponseDto;

package/dist/dtos/settings.dto.js

@@ -15,6 +15,7 @@ const class_transformer_1 = require("class-transformer");
 const tab_dto_1 = require("./tab.dto");
 const class_validator_2 = require("class-validator");
 const is_property_forbidden_validator_1 = require("../decorators/is-property-forbidden.validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 class SettingsDto {
 }
 exports.SettingsDto = SettingsDto;
@@ -22,16 +23,31 @@ __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_2.IsDefined)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Label',
+        description: 'Label of the settings page.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], SettingsDto.prototype, "label", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_2.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Icon',
+        description: 'Icon of the settings page.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], SettingsDto.prototype, "icon", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_2.IsDefined)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Description',
+        description: 'Description of the settings page.',
+        type: 'string',
+    }),
     __metadata("design:type", String)
 ], SettingsDto.prototype, "description", void 0);
 class SettingsWithUrlDto extends SettingsDto {
@@ -51,6 +67,12 @@ exports.SettingsWithTabsDto = SettingsWithTabsDto;
 __decorate([
     (0, class_validator_1.ValidateNested)({ each: true }),
     (0, class_transformer_1.Type)(() => tab_dto_1.TabDto),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Tabs',
+        description: 'Tabs shown on the settings page.',
+        type: 'array',
+        items: { $ref: '#/components/schemas/TabDto' }
+    }),
     __metadata("design:type", Array)
 ], SettingsWithTabsDto.prototype, "tabs", void 0);
 __decorate([

package/dist/dtos/tab.dto.js

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TabDto = void 0;
 const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * DTO for tabs
  * Used for defining tabs in the user interface
@@ -21,10 +22,21 @@ exports.TabDto = TabDto;
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Label',
+        description: 'Text label for the tab.',
+        type: 'string'
+    }),
     __metadata("design:type", String)
 ], TabDto.prototype, "label", void 0);
 __decorate([
     (0, class_validator_1.IsUrl)({ protocols: ['https'], require_protocol: true }),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'URL',
+        description: 'URL associated with the tab.',
+        type: 'string',
+        format: 'uri'
+    }),
     __metadata("design:type", String)
 ], TabDto.prototype, "url", void 0);

package/dist/dtos/unit.dto.js

@@ -11,6 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnitDto = void 0;
 const class_validator_1 = require("class-validator");
+const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 /**
  * DTO for billing units.
  * Used for defining units for pay-per-use billing.
@@ -22,17 +23,35 @@ __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Unit ID',
+        description: 'Unit identifier.',
+        type: 'string',
+        example: 'messages'
+    }),
     __metadata("design:type", String)
 ], UnitDto.prototype, "id", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Unit Description',
+        description: 'What is measured.',
+        type: 'string',
+        example: 'Message sent'
+    }),
     __metadata("design:type", String)
 ], UnitDto.prototype, "unitDescription", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsDefined)(),
     (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_jsonschema_1.JSONSchema)({
+        title: 'Interval Description',
+        description: 'Billing interval.',
+        type: 'string',
+        example: 'Per month'
+    }),
     __metadata("design:type", String)
 ], UnitDto.prototype, "intervalDescription", void 0);

package/dist/index.d.ts

@@ -101,3 +101,4 @@ export * from './validators/sender-push-validator';
 export * from './validators/sender-sms-validator';
 export * from './validators/unit.validator';
 export * from './dtos/product/product.interface';
+export { ComponentsSchemas } from './openapi/schemas/components.schemas';

package/dist/index.js

@@ -14,6 +14,7 @@ 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 });
+exports.ComponentsSchemas = void 0;
 require("reflect-metadata");
 // Base DTOs
 __exportStar(require("./dtos/action.dto"), exports);
@@ -125,3 +126,6 @@ __exportStar(require("./validators/sender-sms-validator"), exports);
 __exportStar(require("./validators/unit.validator"), exports);
 // Interfaces
 __exportStar(require("./dtos/product/product.interface"), exports);
+// OpenApi schemas
+var components_schemas_1 = require("./openapi/schemas/components.schemas");
+Object.defineProperty(exports, "ComponentsSchemas", { enumerable: true, get: function () { return components_schemas_1.ComponentsSchemas; } });