@rsdk/zones 6.0.0-next.0

package/dist/constants.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Symbol used as a key for storing and retrieving zone metadata
+ * associated with controllers in the application.
+ */
+export declare const API_ZONE_METADATA_KEY: unique symbol;
+/**
+ * Represents the internal zone for API controllers. Controllers
+ * assigned this zone are excluded from the openapi.json file
+ * by default.
+ */
+export declare const API_ZONE_INTERNAL = "__internal";
+/**
+ * Represents the default zone for API controllers. This zone is
+ * used when no specific zone is assigned to a controller,
+ * allowing for a fallback behavior.
+ */
+export declare const API_ZONE_DEFAULT = "__default";

package/dist/constants.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_ZONE_DEFAULT = exports.API_ZONE_INTERNAL = exports.API_ZONE_METADATA_KEY = void 0;
+/**
+ * Symbol used as a key for storing and retrieving zone metadata
+ * associated with controllers in the application.
+ */
+exports.API_ZONE_METADATA_KEY = Symbol('API_ZONE_KEY');
+/**
+ * Represents the internal zone for API controllers. Controllers
+ * assigned this zone are excluded from the openapi.json file
+ * by default.
+ */
+exports.API_ZONE_INTERNAL = '__internal';
+/**
+ * Represents the default zone for API controllers. This zone is
+ * used when no specific zone is assigned to a controller,
+ * allowing for a fallback behavior.
+ */
+exports.API_ZONE_DEFAULT = '__default';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,qBAAqB,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AAE5D;;;;GAIG;AACU,QAAA,iBAAiB,GAAG,YAAY,CAAC;AAE9C;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,WAAW,CAAC"}

package/dist/decorators.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Decorator that assigns a zone tag to a controller.
+ * Used to group related API endpoints together. Can be used to
+ * generate different openapi.json files for different zones.
+ *
+ * NOTE: ApiTags could be used instead, but their purpose is different
+ * @param zone The zone name to assign to the controller
+ */
+export declare const ApiZone: (zone: string) => ClassDecorator;
+/**
+ * Decorator that assigns the internal zone to a controller. These
+ * endpoints are not included in the openapi.json file by default,
+ * by autodoc command.
+ */
+export declare const Internal: () => ClassDecorator;

package/dist/decorators.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Internal = exports.ApiZone = void 0;
+const constants_1 = require("./constants");
+const zone_class_1 = require("./zone.class");
+/**
+ * Decorator that assigns a zone tag to a controller.
+ * Used to group related API endpoints together. Can be used to
+ * generate different openapi.json files for different zones.
+ *
+ * NOTE: ApiTags could be used instead, but their purpose is different
+ * @param zone The zone name to assign to the controller
+ */
+const ApiZone = (zone) => {
+    return (target) => zone_class_1.Zone.setForController(target, zone);
+};
+exports.ApiZone = ApiZone;
+/**
+ * Decorator that assigns the internal zone to a controller. These
+ * endpoints are not included in the openapi.json file by default,
+ * by autodoc command.
+ */
+const Internal = () => (0, exports.ApiZone)(constants_1.API_ZONE_INTERNAL);
+exports.Internal = Internal;
+//# sourceMappingURL=decorators.js.map

package/dist/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":";;;AAAA,2CAAgD;AAChD,6CAAoC;AAEpC;;;;;;;GAOG;AACI,MAAM,OAAO,GAAG,CAAC,IAAY,EAAkB,EAAE;IACtD,OAAO,CAAC,MAAc,EAAE,EAAE,CAAC,iBAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AACjE,CAAC,CAAC;AAFW,QAAA,OAAO,WAElB;AAEF;;;;GAIG;AACI,MAAM,QAAQ,GAAG,GAAmB,EAAE,CAAC,IAAA,eAAO,EAAC,6BAAiB,CAAC,CAAC;AAA5D,QAAA,QAAQ,YAAoD"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './decorators';
+export * from './zone.class';
+export * from './constants';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./decorators"), exports);
+__exportStar(require("./zone.class"), exports);
+__exportStar(require("./constants"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/zone.class.d.ts

@@ -0,0 +1,26 @@
+import type { ExecutionContext } from '@nestjs/common';
+/**
+ * Helper class for managing API zones. API zones are used to filter
+ * endpoints in the openapi.json file, disable logging for some endpoints,
+ * etc.
+ */
+export declare class Zone {
+    /**
+     * Sets the zone metadata for a controller class.
+     * @param target - The controller class to set the zone for.
+     * @param zone - The zone to set for the controller.
+     */
+    static setForController(target: object, zone: string): void;
+    /**
+     * Retrieves the zone metadata for execution context.
+     * @param context - The execution context.
+     * @returns The zone metadata for the execution context, or '__default' if no zone is set.
+     */
+    static getForContext(context: ExecutionContext): string;
+    /**
+     * Retrieves the zone metadata for a controller class.
+     * @param target - The controller class to get the zone for.
+     * @returns The zone metadata for the controller class, or '__default' if no zone is set.
+     */
+    static getForController(target: object): string;
+}

package/dist/zone.class.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Zone = void 0;
+const constants_1 = require("./constants");
+/**
+ * Helper class for managing API zones. API zones are used to filter
+ * endpoints in the openapi.json file, disable logging for some endpoints,
+ * etc.
+ */
+class Zone {
+    /**
+     * Sets the zone metadata for a controller class.
+     * @param target - The controller class to set the zone for.
+     * @param zone - The zone to set for the controller.
+     */
+    static setForController(target, zone) {
+        Reflect.defineMetadata(constants_1.API_ZONE_METADATA_KEY, zone, target);
+    }
+    /**
+     * Retrieves the zone metadata for execution context.
+     * @param context - The execution context.
+     * @returns The zone metadata for the execution context, or '__default' if no zone is set.
+     */
+    static getForContext(context) {
+        const controller = context.getClass();
+        return Zone.getForController(controller);
+    }
+    /**
+     * Retrieves the zone metadata for a controller class.
+     * @param target - The controller class to get the zone for.
+     * @returns The zone metadata for the controller class, or '__default' if no zone is set.
+     */
+    static getForController(target) {
+        return (Reflect.getMetadata(constants_1.API_ZONE_METADATA_KEY, target) || constants_1.API_ZONE_DEFAULT);
+    }
+}
+exports.Zone = Zone;
+//# sourceMappingURL=zone.class.js.map

package/dist/zone.class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zone.class.js","sourceRoot":"","sources":["../src/zone.class.ts"],"names":[],"mappings":";;;AAEA,2CAAsE;AAEtE;;;;GAIG;AACH,MAAa,IAAI;IACf;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAc,EAAE,IAAY;QAClD,OAAO,CAAC,cAAc,CAAC,iCAAqB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,OAAyB;QAC5C,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEtC,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAc;QACpC,OAAO,CACL,OAAO,CAAC,WAAW,CAAC,iCAAqB,EAAE,MAAM,CAAC,IAAI,4BAAgB,CACvE,CAAC;IACJ,CAAC;CACF;AA/BD,oBA+BC"}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@rsdk/zones",
+  "version": "6.0.0-next.0",
+  "description": "Tools for working with zones (API parts)",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0"
+  },
+  "gitHead": "215cccea23d95118dd8b6af3ce11c6a35ce19c30"
+}

package/src/constants.ts

@@ -0,0 +1,19 @@
+/**
+ * Symbol used as a key for storing and retrieving zone metadata
+ * associated with controllers in the application.
+ */
+export const API_ZONE_METADATA_KEY = Symbol('API_ZONE_KEY');
+
+/**
+ * Represents the internal zone for API controllers. Controllers
+ * assigned this zone are excluded from the openapi.json file
+ * by default.
+ */
+export const API_ZONE_INTERNAL = '__internal';
+
+/**
+ * Represents the default zone for API controllers. This zone is
+ * used when no specific zone is assigned to a controller,
+ * allowing for a fallback behavior.
+ */
+export const API_ZONE_DEFAULT = '__default';

package/src/decorators.ts

@@ -0,0 +1,21 @@
+import { API_ZONE_INTERNAL } from './constants';
+import { Zone } from './zone.class';
+
+/**
+ * Decorator that assigns a zone tag to a controller.
+ * Used to group related API endpoints together. Can be used to
+ * generate different openapi.json files for different zones.
+ *
+ * NOTE: ApiTags could be used instead, but their purpose is different
+ * @param zone The zone name to assign to the controller
+ */
+export const ApiZone = (zone: string): ClassDecorator => {
+  return (target: object) => Zone.setForController(target, zone);
+};
+
+/**
+ * Decorator that assigns the internal zone to a controller. These
+ * endpoints are not included in the openapi.json file by default,
+ * by autodoc command.
+ */
+export const Internal = (): ClassDecorator => ApiZone(API_ZONE_INTERNAL);

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './decorators';
+export * from './zone.class';
+export * from './constants';

package/src/zone.class.ts

@@ -0,0 +1,41 @@
+import type { ExecutionContext } from '@nestjs/common';
+
+import { API_ZONE_DEFAULT, API_ZONE_METADATA_KEY } from './constants';
+
+/**
+ * Helper class for managing API zones. API zones are used to filter
+ * endpoints in the openapi.json file, disable logging for some endpoints,
+ * etc.
+ */
+export class Zone {
+  /**
+   * Sets the zone metadata for a controller class.
+   * @param target - The controller class to set the zone for.
+   * @param zone - The zone to set for the controller.
+   */
+  static setForController(target: object, zone: string): void {
+    Reflect.defineMetadata(API_ZONE_METADATA_KEY, zone, target);
+  }
+
+  /**
+   * Retrieves the zone metadata for execution context.
+   * @param context - The execution context.
+   * @returns The zone metadata for the execution context, or '__default' if no zone is set.
+   */
+  static getForContext(context: ExecutionContext): string {
+    const controller = context.getClass();
+
+    return Zone.getForController(controller);
+  }
+
+  /**
+   * Retrieves the zone metadata for a controller class.
+   * @param target - The controller class to get the zone for.
+   * @returns The zone metadata for the controller class, or '__default' if no zone is set.
+   */
+  static getForController(target: object): string {
+    return (
+      Reflect.getMetadata(API_ZONE_METADATA_KEY, target) || API_ZONE_DEFAULT
+    );
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.test.e2e.ts",
+    "**/*.test.manual-e2e.ts",
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  }
+}