@enonic-types/lib-cors 2.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,55 @@
+# @enonic-types/lib-cors
+
+TypeScript declarations for [lib-cors](https://github.com/enonic/lib-cors), the Enonic XP CORS
+library. They are generated from the library source on every release, so the version matches the
+jar.
+
+## Setup
+
+```bash
+npm install --save-dev @enonic-types/lib-cors
+```
+
+The package is types-only, so it belongs in `devDependencies`. Add it to both `types` and `paths` in
+`tsconfig.json`:
+
+```json
+{
+    "compilerOptions": {
+        "types": ["@enonic-types/global", "@enonic-types/lib-cors"],
+        "paths": {
+            "/lib/enonic/cors": ["./node_modules/@enonic-types/lib-cors"]
+        }
+    }
+}
+```
+
+Both entries are needed, one per module style. The `types` entry — next to
+[`@enonic-types/global`](https://www.npmjs.com/package/@enonic-types/global) — loads the package's
+`XpLibraries` augmentation, which is what types `require('/lib/enonic/cors')`; `paths` alone does
+not type `require()` in a file that never imports the module. The `paths` entry is what resolves
+`import ... from '/lib/enonic/cors'`, and needs no `baseUrl` on modern TypeScript.
+
+## Usage
+
+```js
+const corsLib = require('/lib/enonic/cors');
+
+exports.options = (req) => corsLib.respondOptions(req);
+```
+
+```ts
+import { getHeaders, respondOptions } from '/lib/enonic/cors';
+import type { Request } from '@enonic-types/core';
+
+export function options(req: Request) {
+    return respondOptions(req);
+}
+
+export function get(req: Request) {
+    return { headers: getHeaders(req), body: 'ok' };
+}
+```
+
+Configuration keys and runtime behavior are documented in the
+[lib-cors README](https://github.com/enonic/lib-cors).

package/cors.d.ts

@@ -0,0 +1,124 @@
+/**
+ * CORS (Cross-Origin Resource Sharing) library for Enonic XP.
+ *
+ * Provides utilities for handling CORS headers in XP controllers and filters.
+ * Targets XP 7+ (Nashorn).
+ *
+ * Configuration via app .cfg file:
+ * - cors.origin        — allowed origin(s): '*' to allow all, comma-separated list of
+ *                         literal origins or '~'-prefixed regex patterns
+ *                         (e.g. 'https://a.com, ~https://.*\.b\.com').
+ *                         Use '~.*' to reflect any origin (supports credentials).
+ *                         When omitted, CORS is disabled (no headers are added)
+ * - cors.credentials   — 'true' to allow credentials (incompatible with '*' origin)
+ * - cors.allowedHeaders — comma-separated. When omitted and
+ *                         Access-Control-Request-Headers is present, that value
+ *                         is reflected back. When configured, preflight requests
+ *                         for disallowed headers are rejected (403)
+ * - cors.methods       — comma-separated (default: 'GET, HEAD, POST').
+ *                         Preflight requests for disallowed methods
+ *                         are rejected (403)
+ * - cors.exposedHeaders — comma-separated (headers the browser may access)
+ * - cors.maxAge        — preflight cache seconds
+ *
+ * Usage in an XP controller:
+ * ```js
+ * var corsLib = require('/lib/enonic/cors');
+ *
+ * // Option A: use app.config automatically
+ * exports.options = function(req) {
+ *     return corsLib.respondOptions(req);
+ * };
+ *
+ * exports.post = function(req) {
+ *     return {
+ *         contentType: 'application/json',
+ *         headers: corsLib.getHeaders(req),
+ *         body: { result: 'ok' },
+ *     };
+ * };
+ *
+ * // Option B: pass config explicitly
+ * exports.post = function(req) {
+ *     return {
+ *         contentType: 'application/json',
+ *         headers: corsLib.resolveHeaders(app.config, req),
+ *         body: { result: 'ok' },
+ *     };
+ * };
+ * ```
+ */
+declare global {
+    interface XpLibraries {
+        '/lib/enonic/cors': typeof import('./cors');
+    }
+}
+export type CorsConfig = Record<string, string | undefined>;
+export type CorsRequest = {
+    getHeader(name: string): string | null;
+};
+export type CorsHeaders = Record<string, string>;
+export type CorsResponse = {
+    status: number;
+    headers: CorsHeaders;
+};
+/**
+ * Resolves CORS headers based on configuration and request.
+ *
+ * Origin matching (`cors.origin`):
+ * - `'*'` — responds with `Access-Control-Allow-Origin: *`.
+ * - Comma-separated list — each value is either a literal origin or a
+ *   `~`-prefixed regex (full match). The request origin is reflected back
+ *   on match; `{ vary: 'Origin' }` is returned on mismatch.
+ * - `'~.*'` — reflects any origin (unlike `'*'`, supports credentials).
+ * - Not set — CORS is disabled; returns `{}`.
+ *
+ * Credentials (`cors.credentials`):
+ * - Set to `'true'` only when the resolved `Access-Control-Allow-Origin`
+ *   is not `'*'`.
+ *
+ * Allowed request headers (`cors.allowedHeaders`):
+ * - When configured, the configured value is sent as
+ *   `Access-Control-Allow-Headers`. Validation of requested headers against
+ *   the allowed set is done at the preflight level (`resolveOptionsResponse`).
+ * - When omitted and `Access-Control-Request-Headers` is present, that value
+ *   is reflected back.
+ * - Otherwise `Access-Control-Allow-Headers` is not set.
+ *
+ * @param config - Key-value config map (typically `app.config`).
+ * @param req - Incoming request with a `getHeader` method.
+ * @returns CORS headers to merge into the response.
+ */
+export declare function resolveHeaders(config: CorsConfig, req: CorsRequest): CorsHeaders;
+/**
+ * Convenience wrapper that resolves CORS headers using `app.config`.
+ *
+ * @param req - Incoming request with a `getHeader` method.
+ * @returns CORS headers to merge into the response.
+ */
+export declare function getHeaders(req: CorsRequest): CorsHeaders;
+/**
+ * Resolves a preflight response based on configuration and request.
+ *
+ * Rejects with 403 (no CORS headers) when:
+ * - `cors.allowedHeaders` is configured and the request asks for
+ *   headers not in that list, or
+ * - `Access-Control-Request-Method` names a method not in the allowed set.
+ *
+ * @param config - Key-value config map (typically `app.config`).
+ * @param req - Incoming request with a `getHeader` method.
+ * @returns Object with `status: 204` and resolved CORS headers,
+ *          or `status: 403` with empty headers on rejection.
+ */
+export declare function resolveOptionsResponse(config: CorsConfig, req: CorsRequest): CorsResponse;
+/**
+ * Returns a 204 preflight response with CORS headers from `app.config`.
+ *
+ * Rejects with 403 (no CORS headers) when the preflight requests a
+ * disallowed method or header.
+ *
+ * @param req - Incoming request with a `getHeader` method.
+ * @returns Object with `status: 204` and resolved CORS headers,
+ *          or `status: 403` with empty headers on rejection.
+ */
+export declare function respondOptions(req: CorsRequest): CorsResponse;

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@enonic-types/lib-cors",
+    "version": "2.0.0",
+    "description": "Type definitions for the Enonic XP CORS library (/lib/enonic/cors)",
+    "types": "cors.d.ts",
+    "files": [
+        "cors.d.ts"
+    ],
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "lib-cors",
+        "cors",
+        "types",
+        "typescript"
+    ],
+    "license": "Apache-2.0",
+    "homepage": "https://github.com/enonic/lib-cors#readme",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/lib-cors.git"
+    },
+    "bugs": {
+        "url": "https://github.com/enonic/lib-cors/issues"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}