@kontent-ai/custom-app-sdk 1.0.0

package/.editorconfig

@@ -0,0 +1,6 @@
+[*]
+charset=utf-8
+end_of_line=lf
+indent_size=2
+indent_style=space
+insert_final_newline=true

package/.nvmrc

@@ -0,0 +1 @@
+lts/*

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devrel@kontent.ai. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

package/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Ways to contribute
+<img align="right" width="100" height="100" src="https://i.imgur.com/PYTV0jP.png">
+
+There are many different ways in which you can contribute. One of the easiest ways is simply to use our software and provide us with your feedback through the right channel. You can also help us improve the open-source projects by submitting pull requests with code and documentation changes.
+
+## Where to get support
+Please note that **level of provided support is always determined by the LICENSE** of a given open-source project. Also, always make sure you use the **[latest version](../../releases)** of any given OS project. We can't provide any help for older versions. We don't want to make things complicated so we try to take the same approach in all our repositories.
+
+### I found a bug in a Kontent.ai open-source project
+<img align="right" width="100" height="100" src="https://i.imgur.com/TYIQdpv.png">
+
+Sorry to hear that. Just log a new [GitHub issue](../../issues) and someone will take a look at it. Remember, the more information you provide, the easier it will be to fix the issue. If you feel like it, you can also fix the bug on your own and submit a new pull request.
+
+### I need help with using the projects and/or coding
+<img align="right" width="100" height="100" src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-icon.svg">
+
+To get help with coding and structuring your projects, use [StackOverflow](https://stackoverflow.com/) and tag your questions with [`kontent-ai`](https://stackoverflow.com/questions/tagged/kontent-ai) tag.
+
+Our team members and the community monitor these channels on a regular basis.
+
+### I want to report a security bug
+<img align="right" width="100" height="100" src="https://i.imgur.com/z82nnJB.png">
+
+Security issues and bugs should be reported privately, via email, to Kontent.ai Security Team [security@kontent.ai](mailto:security@kontent.ai). For more details, check the [Security policy](SECURITY.md).
+
+### I have an idea for a new feature (or feedback on existing functionality)
+<img align="right" width="100" height="100" src="https://i.imgur.com/rUFkyPy.png">
+
+Everybody loves new features! You can submit a new [feature request](../../issues) or you can code it on your own and [send us a pull request](#submitting-pull-requests). In either case, don't forget to mention what's the use case and what's the expected output.
+
+
+## Submitting pull requests
+<img align="right" width="100" height="100" src="https://i.imgur.com/aSeiliy.png">
+
+Unless you're fixing a typo, it's usually a good idea to discuss the feature before you submit a pull request with code changes, so let's start with submitting a new [GitHub issue](../../issues) and discussing the whether it fits the vision of a given project.
+You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested by Kontent.ai maintainer teams, and only those that meet an high bar for both quality and design/roadmap appropriateness will be merged into the source.
+
+
+### Example - process of contribution
+If not stated otherwise, we use [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow).
+
+To start with coding, fork the repository you want to contribute to, create a new branch, and start coding. Once the functionality is [done](#Definition-of-Done), you can submit a [pull request](https://help.github.com/articles/about-pull-requests/).
+
+### Definition of Done
+<img align="right" width="100" height="100" src="https://i.imgur.com/g82Ohdv.png">
+
+- New/fixed code is covered with tests
+- CI can build the code
+- All tests are pass
+- New version number follows [semantic versioning](https://semver.org/)
+- Coding style (spaces, indentation) is in line with the rest of the code in a given repository
+- Documentation is updated (e.g. code examples in README, Wiki pages, etc.)
+- All `public` members are documented (using XML doc, phpdoc, etc.)
+- Code doesn't contain any secrets (private keys, etc.)
+- Commit messages are clear. Please read these articles: [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html)
+
+
+### Feedback
+<img align="right" width="100" height="100" src="https://i.imgur.com/ZQfNzJJ.png">
+
+Your pull request will now go through extensive checks by the subject matter experts on our team. Please be patient. Update your pull request according to feedback until it is approved by one of Kontent.ai maintainers. After that, one of our team members may adjust the branch you merge into based on the expected release schedule.
+
+
+## Code of Conduct
+<img align="right" width="100" height="100" src="https://i.imgur.com/cObdKQy.png">
+
+The Kontent.ai team is committed to fostering a welcoming community, therefore this project has adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). If you have any additional questions or comments, you can contact us directly at devrel@kontent.ai.

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kontent s.r.o.
+
+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

@@ -0,0 +1,99 @@
+# Kontent.ai Custom app SDK JS
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+
+[![Discord][discussion-shield]][discussion-url]
+
+## About The Project
+
+A JavaScript SDK for communicating with the Kontent.ai Custom App API.
+It facilitates the communication between the Kontent.ai app and the custom app providing access to the configuration and context data.
+
+## Getting Started
+
+### Installation
+
+```sh
+npm install @kontent-ai/custom-app-sdk-js
+```
+
+> [!IMPORTANT]  
+> The SDK attaches event listeners to communicate with the Kontent.ai app. Make sure to only include the SDK in the browser environment.
+
+## Usage example
+
+```typescript
+import { getCustomAppContext, CustomAppContext } from "@kontent-ai/custom-app-sdk-js";
+
+const response: CustomAppContext = await getCustomAppContext();
+
+if (response.isError) {
+  console.error({ errorCode: response.code, description: response.description});
+} else {
+  console.log({ config: response.config, context: response.context });
+}
+```
+
+## API Reference
+
+### getCustomAppContext
+
+Use the `getCustomAppContext` function to retrieve context of the custom app. The function takes no arguments and returns a promise with a value of an object of type `CustomAppContext`.
+
+#### CustomAppContext
+
+| Property      | Type                   | Description                                                                  |
+|---------------|------------------------|------------------------------------------------------------------------------|
+| `isError`     | boolean                | Determines if there was an error while getting the context of the custom app |
+| `code`        | ErrorCode enum \| null | The code of the error message                                                |
+| `description` | string \| null         | The description of the error message                                         |
+| `context`     | object \| null         | Contains data provided by the Kontent.ai application                         |
+| `config`      | object \| null         | Contains JSON object specified in the custom app configuration               |
+
+#### Config 
+The `config` object is a JSON object that can be defined within the Custom App configuration under Environment settings in the Kontent.ai app.
+
+#### Context 
+The `context` object contains data provided by the Kontent.ai application that you can leverage in your custom app. 
+
+| Property        | Type              | Description                                                              |
+|-----------------|-------------------|--------------------------------------------------------------------------|
+| `environmentId` | UUID              | The environment's ID                                                     |
+| `userId`        | string            | The current user's ID                                                    |
+| `userEmail`     | string            | The current user's email                                                 |
+| `userRoles`     | Array of UserRole | An array containing all the roles of the current user in the environment |
+
+#### UserRole 
+
+| Property   | Type   | Description                                                          |
+|------------|--------|----------------------------------------------------------------------|
+| `id`       | UUID   | The role's ID                                                        |
+| `codename` | string | The role's codename - applicable only for the _Project manager_ role |
+
+## Contributing
+
+For Contributing please see  <a href="./CONTRIBUTING.md">`CONTRIBUTING.md`</a> for more information.
+
+
+
+## License
+
+Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information.
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/kontent-ai/custom-app-sdk-js.svg?style=for-the-badge
+[contributors-url]: https://github.com/kontent-ai/custom-app-sdk-js/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/kontent-ai/custom-app-sdk-js.svg?style=for-the-badge
+[forks-url]: https://github.com/kontent-ai/custom-app-sdk-js/network/members
+[stars-shield]: https://img.shields.io/github/stars/kontent-ai/custom-app-sdk-js.svg?style=for-the-badge
+[stars-url]: https://github.com/kontent-ai/custom-app-sdk-js/stargazers
+[issues-shield]: https://img.shields.io/github/issues/kontent-ai/custom-app-sdk-js.svg?style=for-the-badge
+[issues-url]:https://github.com/kontent-ai/custom-app-sdk-js/issues
+[license-shield]: https://img.shields.io/github/license/kontent-ai/custom-app-sdk-js.svg?style=for-the-badge
+[license-url]:https://github.com/kontent-ai/custom-app-sdk-js/blob/master/LICENSE.md
+[discussion-shield]: https://img.shields.io/discord/821885171984891914?color=%237289DA&label=Kontent%2Eai%20Discord&logo=discord&style=for-the-badge
+[discussion-url]: https://discord.com/invite/SKCxwPtevJ

package/SECURITY.md

@@ -0,0 +1,27 @@
+## Security
+In [Kontent.ai](http://kontent.ai/), security has always been of great importance. Kontent.ai is committed to working with security researchers to help identify and fix vulnerabilities in our systems and services, which includes all source code repositories managed through our [GitHub organization](https://github.com/kontent-ai). 
+
+If you believe you have found a security vulnerability in any Kontent.ai-owned repository that meets our [qualification criteria](https://kontent.ai/vulnerability-disclosure-policy/), please report it to us as described below.
+
+## Reporting Security Issues
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Security issues and bugs should be reported privately, via email to [security@kontent.ai](mailto:security@kontent.ai). For secure communication, use our [PGP key](https://app.kontent.ai/pgp-key.txt). If you find multiple issues, please report them separately. We will keep you updated on the progress towards remediation of issues we accept from you, and we ask you not to disclose the issue publicly without Kontent.ai’s prior written permission. Additional information can be found in our [Vulnerability Disclosure Policy](https://kontent.ai/vulnerability-disclosure-policy/). 
+
+If possible, please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the issue:
+
+* Type of issue (e.g. SQL injection, XSS, broken access control…)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+We prefer all communications to be in English.
+
+## Safe harbor
+Kontent.ai will not initiate a lawsuit or law enforcement investigation against you in response to reporting a vulnerability if you fully comply with our [Vulnerability Disclosure Policy](https://kontent.ai/vulnerability-disclosure-policy/).

package/dist/createUuid.d.ts

@@ -0,0 +1 @@
+export declare const createUuid: () => string;

package/dist/createUuid.js

@@ -0,0 +1,2 @@
+export const createUuid = () => globalThis.crypto.randomUUID();
+//# sourceMappingURL=createUuid.js.map

package/dist/createUuid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createUuid.js","sourceRoot":"","sources":["../src/createUuid.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG,GAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC"}

package/dist/customAppSdk.d.ts

@@ -0,0 +1,21 @@
+export declare enum ErrorCode {
+    UnknownMessage = "unknown-message"
+}
+export type CustomAppContext = {
+    readonly isError: false;
+    readonly context: {
+        readonly environmentId: string;
+        readonly userId: string;
+        readonly userEmail: string;
+        readonly userRoles: ReadonlyArray<{
+            readonly id: string;
+            readonly codename: string | null;
+        }>;
+    };
+    readonly config?: unknown;
+} | {
+    readonly isError: true;
+    readonly code: ErrorCode;
+    readonly description: string;
+};
+export declare const getCustomAppContext: () => Promise<CustomAppContext>;

package/dist/customAppSdk.js

@@ -0,0 +1,27 @@
+import { sendMessage } from "./iframeMessenger";
+import { ErrorMessage } from "./iframeSchema";
+import { matchesSchema } from "./matchesSchema";
+export var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["UnknownMessage"] = "unknown-message";
+})(ErrorCode || (ErrorCode = {}));
+export const getCustomAppContext = () => new Promise((resolve, reject) => {
+    try {
+        sendMessage({
+            type: "get-context-request",
+            version: "1.0.0",
+            payload: null,
+        }, (response) => {
+            if (matchesSchema(ErrorMessage, response)) {
+                resolve({ isError: true, code: response.code, description: response.description });
+            }
+            else {
+                resolve({ ...response.payload, isError: false });
+            }
+        });
+    }
+    catch (error) {
+        reject(error);
+    }
+});
+//# sourceMappingURL=customAppSdk.js.map

package/dist/customAppSdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customAppSdk.js","sourceRoot":"","sources":["../src/customAppSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,CAAN,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,+CAAkC,CAAA;AACpC,CAAC,EAFW,SAAS,KAAT,SAAS,QAEpB;AAsBD,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAA8B,EAAE,CACjE,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC9B,IAAI,CAAC;QACH,WAAW,CACT;YACE,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,IAAI;SACd,EACD,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YACrF,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;YACnD,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/iframeMessenger.d.ts

@@ -0,0 +1,2 @@
+import type { Schema } from "./iframeSchema";
+export declare const sendMessage: <TMessageType extends keyof Schema["client"]>(message: Omit<Schema["client"][TMessageType]["request"], "requestId">, callback: (data: Schema["client"][TMessageType]["response"]) => void) => void;

package/dist/iframeMessenger.js

@@ -0,0 +1,18 @@
+import { createUuid } from "./createUuid";
+let callbacks = {};
+export const sendMessage = (message, callback) => {
+    const requestId = createUuid();
+    callbacks = { ...callbacks, [requestId]: callback };
+    window.parent.postMessage({ ...message, requestId }, "*");
+};
+const processMessage = (event) => {
+    const message = event.data;
+    const callback = callbacks[message.requestId];
+    callbacks = Object.fromEntries(Object.entries(callbacks).filter(([requestId]) => requestId !== message.requestId));
+    callback?.(message);
+};
+if (window.self === window.top) {
+    throw new Error("Custom app is not hosted in an IFrame.");
+}
+window.addEventListener("message", processMessage, true);
+//# sourceMappingURL=iframeMessenger.js.map

package/dist/iframeMessenger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iframeMessenger.js","sourceRoot":"","sources":["../src/iframeMessenger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C,IAAI,SAAS,GAAsD,EAAE,CAAC;AAEtE,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,OAAqE,EACrE,QAAoE,EAC9D,EAAE;IACR,MAAM,SAAS,GAAG,UAAU,EAAE,CAAC;IAC/B,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAsB,CAAC;IACxE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,EAAE,GAAG,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,KAAuC,EAAQ,EAAE;IACvE,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC;IAC3B,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9C,SAAS,GAAG,MAAM,CAAC,WAAW,CAC5B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,CACnF,CAAC;IACF,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;IAC/B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC"}

package/dist/iframeSchema.d.ts

@@ -0,0 +1,153 @@
+import { z } from "zod";
+declare enum ErrorCode {
+    UnknownMessage = "unknown-message"
+}
+export declare const ErrorMessage: z.ZodReadonly<z.ZodObject<{
+    requestId: z.ZodString;
+    isError: z.ZodBoolean;
+    code: z.ZodNativeEnum<typeof ErrorCode>;
+    description: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    isError: boolean;
+    code: ErrorCode;
+    description: string;
+}, {
+    requestId: string;
+    isError: boolean;
+    code: ErrorCode;
+    description: string;
+}>>;
+declare const ClientGetContextV1Request: z.ZodReadonly<z.ZodObject<{
+    type: z.ZodLiteral<"get-context-request">;
+    requestId: z.ZodString;
+    version: z.ZodLiteral<"1.0.0">;
+    payload: z.ZodNull;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    type: "get-context-request";
+    version: "1.0.0";
+    payload: null;
+}, {
+    requestId: string;
+    type: "get-context-request";
+    version: "1.0.0";
+    payload: null;
+}>>;
+declare const ClientGetContextV1Response: z.ZodReadonly<z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"get-context-response">;
+    payload: z.ZodReadonly<z.ZodObject<{
+        context: z.ZodReadonly<z.ZodObject<{
+            environmentId: z.ZodString;
+            userId: z.ZodString;
+            userEmail: z.ZodString;
+            userRoles: z.ZodReadonly<z.ZodArray<z.ZodReadonly<z.ZodObject<{
+                id: z.ZodString;
+                codename: z.ZodUnion<[z.ZodString, z.ZodNull]>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                codename: string | null;
+            }, {
+                id: string;
+                codename: string | null;
+            }>>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            environmentId: string;
+            userId: string;
+            userEmail: string;
+            userRoles: readonly Readonly<{
+                id: string;
+                codename: string | null;
+            }>[];
+        }, {
+            environmentId: string;
+            userId: string;
+            userEmail: string;
+            userRoles: readonly Readonly<{
+                id: string;
+                codename: string | null;
+            }>[];
+        }>>;
+        config: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        context: Readonly<{
+            environmentId: string;
+            userId: string;
+            userEmail: string;
+            userRoles: readonly Readonly<{
+                id: string;
+                codename: string | null;
+            }>[];
+        }>;
+        config?: unknown;
+    }, {
+        context: Readonly<{
+            environmentId: string;
+            userId: string;
+            userEmail: string;
+            userRoles: readonly Readonly<{
+                id: string;
+                codename: string | null;
+            }>[];
+        }>;
+        config?: unknown;
+    }>>;
+    requestId: z.ZodString;
+    version: z.ZodLiteral<"1.0.0">;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    type: "get-context-response";
+    version: "1.0.0";
+    payload: Readonly<{
+        context: Readonly<{
+            environmentId: string;
+            userId: string;
+            userEmail: string;
+            userRoles: readonly Readonly<{
+                id: string;
+                codename: string | null;
+            }>[];
+        }>;
+        config?: unknown;
+    }>;
+}, {
+    requestId: string;
+    type: "get-context-response";
+    version: "1.0.0";
+    payload: Readonly<{
+        context: Readonly<{
+            environmentId: string;
+            userId: string;
+            userEmail: string;
+            userRoles: readonly Readonly<{
+                id: string;
+                codename: string | null;
+            }>[];
+        }>;
+        config?: unknown;
+    }>;
+}>, z.ZodReadonly<z.ZodObject<{
+    requestId: z.ZodString;
+    isError: z.ZodBoolean;
+    code: z.ZodNativeEnum<typeof ErrorCode>;
+    description: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    requestId: string;
+    isError: boolean;
+    code: ErrorCode;
+    description: string;
+}, {
+    requestId: string;
+    isError: boolean;
+    code: ErrorCode;
+    description: string;
+}>>]>>;
+export type Schema = {
+    client: {
+        "get-context@1.0.0": {
+            request: z.infer<typeof ClientGetContextV1Request>;
+            response: z.infer<typeof ClientGetContextV1Response>;
+        };
+    };
+};
+export {};

package/dist/iframeSchema.js

@@ -0,0 +1,50 @@
+import { z } from "zod";
+var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["UnknownMessage"] = "unknown-message";
+})(ErrorCode || (ErrorCode = {}));
+export const ErrorMessage = z
+    .object({
+    requestId: z.string().uuid(),
+    isError: z.boolean(),
+    code: z.nativeEnum(ErrorCode),
+    description: z.string(),
+})
+    .readonly();
+const ClientGetContextV1Request = z
+    .object({
+    type: z.literal("get-context-request"),
+    requestId: z.string().uuid(),
+    version: z.literal("1.0.0"),
+    payload: z.null(),
+})
+    .readonly();
+const ClientGetContextV1Response = z
+    .object({
+    type: z.literal("get-context-response"),
+    payload: z
+        .object({
+        context: z
+            .object({
+            environmentId: z.string().uuid(),
+            userId: z.string(),
+            userEmail: z.string().email(),
+            userRoles: z
+                .array(z
+                .object({
+                id: z.string().uuid(),
+                codename: z.string().or(z.null()),
+            })
+                .readonly())
+                .readonly(),
+        })
+            .readonly(),
+        config: z.unknown(),
+    })
+        .readonly(),
+    requestId: z.string().uuid(),
+    version: z.literal("1.0.0"),
+})
+    .or(ErrorMessage)
+    .readonly();
+//# sourceMappingURL=iframeSchema.js.map

package/dist/iframeSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iframeSchema.js","sourceRoot":"","sources":["../src/iframeSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,IAAK,SAEJ;AAFD,WAAK,SAAS;IACZ,+CAAkC,CAAA;AACpC,CAAC,EAFI,SAAS,KAAT,SAAS,QAEb;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CACxB,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd,MAAM,yBAAyB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC;IACtC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC3B,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;CAClB,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd,MAAM,0BAA0B,GAAG,CAAC;KACjC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC;IACvC,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,OAAO,EAAE,CAAC;aACP,MAAM,CAAC;YACN,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;YAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;YAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE;YAC7B,SAAS,EAAE,CAAC;iBACT,KAAK,CACJ,CAAC;iBACE,MAAM,CAAC;gBACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;gBACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClC,CAAC;iBACD,QAAQ,EAAE,CACd;iBACA,QAAQ,EAAE;SACd,CAAC;aACD,QAAQ,EAAE;QACb,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;KACpB,CAAC;SACD,QAAQ,EAAE;IACb,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CAC5B,CAAC;KACD,EAAE,CAAC,YAAY,CAAC;KAChB,QAAQ,EAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { getCustomAppContext } from "./customAppSdk";
+export { CustomAppContext } from "./customAppSdk";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { getCustomAppContext } from "./customAppSdk";
+//# 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,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/matchesSchema.d.ts

@@ -0,0 +1,2 @@
+import type { z } from "zod";
+export declare const matchesSchema: <Output>(schema: z.ZodType<Output>, data: unknown) => data is Output;

package/dist/matchesSchema.js

@@ -0,0 +1,2 @@
+export const matchesSchema = (schema, data) => schema.safeParse(data).success;
+//# sourceMappingURL=matchesSchema.js.map

package/dist/matchesSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchesSchema.js","sourceRoot":"","sources":["../src/matchesSchema.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,CAAS,MAAyB,EAAE,IAAa,EAAkB,EAAE,CAChG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC"}

package/dist/utilityTypes.d.ts

@@ -0,0 +1,2 @@
+import type { Schema } from "./iframeSchema";
+export type AllClientResponses = Schema["client"][keyof Schema["client"]]["response"];

package/dist/utilityTypes.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utilityTypes.js.map

package/dist/utilityTypes.js.map

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

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@kontent-ai/custom-app-sdk",
+  "version": "1.0.0",
+  "description": "The Kontent.ai Custom App SDK enhances the integration of your custom app with the Kontent.ai platform.",
+  "license": "MIT",
+  "author": "Kontent.ai",
+  "keywords": [
+    "Kontent.ai",
+    "Kontent AI",
+    "Kontent Custom App SDK JS"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "repository": "https://github.com/kontent-ai/custom-app-sdk-js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "format-check": "npx @biomejs/biome ci ./src",
+    "format": "npx @biomejs/biome check --write ./src"
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.9.0",
+    "typescript": "^5.6.3"
+  }
+}