@adobe/spacecat-shared-tier-client 1.0.0

package/.mocha-multi.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec,xunit",
+    "xunitReporterOptions": {
+        "output": "junit/test-results.xml"
+    }
+}

package/.releaserc.cjs

@@ -0,0 +1,17 @@
+module.exports = {
+  extends: "semantic-release-monorepo",
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", {
+      "changelogFile": "CHANGELOG.md",
+    }],
+    "@semantic-release/npm",
+    ["@semantic-release/git", {
+      "assets": ["package.json", "CHANGELOG.md"],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }],
+    ["@semantic-release/github", {}],
+  ],
+  branches: ['main'],
+};

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @adobe/spacecat-shared-tier-client-v1.0.0 (2025-09-16)
+
+
+### Features
+
+* Tier client ([#961](https://github.com/adobe/spacecat-shared/issues/961)) ([2d95d07](https://github.com/adobe/spacecat-shared/commit/2d95d070a55e2ec702faf3bf94c046836b79528a))
+
+# [@adobe/spacecat-shared-tier-client-v1.0.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tier-client-v1.0.0...@adobe/spacecat-shared-tier-client-v1.0.0) (2025-01-27)
+
+### Features
+
+* **tier-client:** initial implementation of TierClient for managing entitlements and site enrollments ([#1](https://github.com/adobe/spacecat-shared/issues/1)) ([initial-commit](https://github.com/adobe/spacecat-shared/commit/initial-commit))
+
+### Bug Fixes
+
+* Initial release with basic functionality for entitlement and site enrollment management
+
+### Documentation
+
+* Add comprehensive README with usage examples and API documentation
+* Add TypeScript definitions for better IDE support

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Adobe 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 Grp-opensourceoffice@adobe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

package/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to Spacecat Shared
+
+This project (like almost all of Project Franklin) is an Open Development project and welcomes contributions from everyone who finds it useful or lacking.
+
+## Code Of Conduct
+
+This project adheres to the Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to cstaub at adobe dot com.
+
+## Contributor License Agreement
+
+All third-party contributions to this project must be accompanied by a signed contributor license. This gives Adobe permission to redistribute your contributions as part of the project. [Sign our CLA](http://opensource.adobe.com/cla.html)! You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!
+
+## Things to Keep in Mind
+
+This project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.
+
+For other contributors, a maintainer of the project has to approve the pull request.
+
+# Before You Contribute
+
+* Check that there is an existing issue in GitHub issues
+* Check if there are other pull requests that might overlap or conflict with your intended contribution
+
+# How to Contribute
+
+1. Fork the repository
+2. Make some changes on a branch on your fork
+3. Create a pull request from your branch
+
+In your pull request, outline:
+
+* What the changes intend
+* How they change the existing code
+* If (and what) they breaks
+* Start the pull request with the GitHub issue ID, e.g. #123
+
+Lastly, please follow the [pull request template](.github/pull_request_template.md) when submitting a pull request!
+
+Each commit message that is not part of a pull request:
+
+* Should contain the issue ID like `#123`
+* Can contain the tag `[trivial]` for trivial changes that don't relate to an issue
+
+
+
+## Coding Styleguides
+
+We enforce a coding styleguide using `eslint`. As part of your build, run `npm run lint` to check if your code is conforming to the style guide. We do the same for every PR in our CI, so PRs will get rejected if they don't follow the style guide.
+
+You can fix some of the issues automatically by running `npx eslint . --fix`.
+
+## Commit Message Format
+
+This project uses a structured commit changelog format that should be used for every commit. Use `npm run commit` instead of your usual `git commit` to generate commit messages using a wizard.
+
+```bash
+# either add all changed files
+$ git add -A
+# or selectively add files
+$ git add package.json
+# then commit using the wizard
+$ npm run commit
+```
+
+# How Contributions get Reviewed
+
+One of the maintainers will look at the pull request within one week. Feedback on the pull request will be given in writing, in GitHub.
+
+# Release Management
+
+The project's committers will release to the [Adobe organization on npmjs.org](https://www.npmjs.com/org/adobe).
+Please contact the [Adobe Open Source Advisory Board](https://git.corp.adobe.com/OpenSourceAdvisoryBoard/discuss/issues) to get access to the npmjs organization.
+
+The release process is fully automated using `semantic-release`, increasing the version numbers, etc. based on the contents of the commit messages found.

package/LICENSE.txt

@@ -0,0 +1,263 @@
+                                 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.
+
+
+APACHE JACKRABBIT SUBCOMPONENTS
+
+Apache Jackrabbit includes parts with separate copyright notices and license
+terms. Your use of these subcomponents is subject to the terms and conditions
+of the following licenses:
+
+    XPath 2.0/XQuery 1.0 Parser:
+    http://www.w3.org/2002/11/xquery-xpath-applets/xgrammar.zip
+
+    Copyright (C) 2002 World Wide Web Consortium, (Massachusetts Institute of
+    Technology, European Research Consortium for Informatics and Mathematics,
+    Keio University). All Rights Reserved.
+
+    This work is distributed under the W3C(R) Software License in the hope
+    that it will be useful, but WITHOUT ANY WARRANTY; without even the
+    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+    W3C(R) SOFTWARE NOTICE AND LICENSE
+    http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
+
+    This work (and included software, documentation such as READMEs, or
+    other related items) is being provided by the copyright holders under
+    the following license. By obtaining, using and/or copying this work,
+    you (the licensee) agree that you have read, understood, and will comply
+    with the following terms and conditions.
+
+    Permission to copy, modify, and distribute this software and its
+    documentation, with or without modification, for any purpose and
+    without fee or royalty is hereby granted, provided that you include
+    the following on ALL copies of the software and documentation or
+    portions thereof, including modifications:
+
+       1. The full text of this NOTICE in a location viewable to users
+          of the redistributed or derivative work.
+
+       2. Any pre-existing intellectual property disclaimers, notices,
+          or terms and conditions. If none exist, the W3C Software Short
+          Notice should be included (hypertext is preferred, text is
+          permitted) within the body of any redistributed or derivative code.
+
+       3. Notice of any changes or modifications to the files, including
+          the date changes were made. (We recommend you provide URIs to the
+          location from which the code is derived.)
+
+    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
+    HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
+    INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
+    FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
+    DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
+    TRADEMARKS OR OTHER RIGHTS.
+
+    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
+    OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
+    DOCUMENTATION.
+
+    The name and trademarks of copyright holders may NOT be used in
+    advertising or publicity pertaining to the software without specific,
+    written prior permission. Title to copyright in this software and
+    any associated documentation will at all times remain with
+    copyright holders.

package/README.md

@@ -0,0 +1,221 @@
+# Spacecat Shared - Tier Client
+
+## Overview
+
+The TierClient library provides methods to manage entitlements and site enrollments for the Spacecat Services. This client facilitates the creation and validation of product entitlements and site enrollments for organizations and sites.
+
+## Installation
+
+Include the TierClient in your project by importing it from the package. Ensure that dependencies such as `@adobe/spacecat-shared-utils` and `@adobe/spacecat-shared-data-access` are also installed in your project.
+
+```javascript
+import TierClient from '@adobe/spacecat-shared-tier-client';
+```
+
+## Usage
+
+### Creating a TierClient Instance
+
+There are three ways to create a TierClient instance:
+
+#### 1. Using Static Factory Methods (Recommended)
+
+**For Organization-only operations:**
+```javascript
+const context = {
+  dataAccess: {
+    Entitlement: /* Entitlement data access object */,
+    SiteEnrollment: /* SiteEnrollment data access object */,
+    Organization: /* Organization data access object */,
+    Site: /* Site data access object */,
+    OrganizationIdentityProvider: /* OrganizationIdentityProvider data access object */,
+  },
+  log: {
+    info: (message) => console.log(message),
+    error: (message) => console.error(message),
+  },
+};
+
+const organization = {
+  getId: () => 'your-org-id',
+};
+
+const productCode = 'LLMO';
+
+// Create client for organization-only operations
+const orgClient = TierClient.createForOrg(context, organization, productCode);
+```
+
+**For Site-specific operations:**
+```javascript
+const site = {
+  getId: () => 'your-site-id',
+  getOrganizationId: () => 'your-org-id', // or getOrganization() method
+};
+
+// Create client for site operations
+const siteClient = TierClient.createForSite(context, site, productCode);
+```
+
+#### 2. Direct Constructor Usage
+
+```javascript
+const context = {
+  dataAccess: {
+    Entitlement: /* Entitlement data access object */,
+    SiteEnrollment: /* SiteEnrollment data access object */,
+    Organization: /* Organization data access object */,
+    Site: /* Site data access object */,
+    OrganizationIdentityProvider: /* OrganizationIdentityProvider data access object */,
+  },
+  log: {
+    info: (message) => console.log(message),
+    error: (message) => console.error(message),
+  },
+};
+
+const orgId = 'your-org-id';
+const siteId = 'your-site-id'; // Optional for organization-only operations
+const productCode = 'LLMO';
+
+const tierClient = new TierClient(context, orgId, siteId, productCode);
+```
+
+### Checking Valid Entitlement
+
+To check for valid entitlement and site enrollment, use the `checkValidEntitlement` method.
+
+```javascript
+async function checkEntitlement() {
+  try {
+    const result = await tierClient.checkValidEntitlement();
+    
+    if (result.entitlement) {
+      console.log('Valid entitlement found:', result.entitlement.getId());
+    }
+    
+    if (result.siteEnrollment) {
+      console.log('Valid site enrollment found:', result.siteEnrollment.getId());
+    }
+    
+    if (!result.entitlement) {
+      console.log('No valid entitlement found');
+    }
+  } catch (error) {
+    console.error('Error checking entitlement:', error);
+  }
+}
+
+checkEntitlement();
+```
+
+### Creating Entitlement
+
+To create a new entitlement and site enrollment, use the `createEntitlement` method.
+
+```javascript
+async function createEntitlement() {
+  try {
+    const tier = 'FREE_TRIAL'; // Valid tiers: FREE_TRIAL, PAID, etc.
+    const result = await tierClient.createEntitlement(tier);
+    
+    console.log('Created entitlement:', result.entitlement.getId());
+    console.log('Created site enrollment:', result.siteEnrollment.getId());
+  } catch (error) {
+    console.error('Error creating entitlement:', error);
+  }
+}
+
+createEntitlement();
+```
+
+## API Reference
+
+### Static Factory Methods
+
+#### TierClient.createForOrg(context, organization, productCode)
+
+Creates a TierClient for organization-only operations.
+
+**Parameters:**
+- `context` (object): Context object containing dataAccess and log
+- `organization` (object): Organization object with getId() method
+- `productCode` (string): Product code (required)
+
+**Returns:** TierClient instance for organization operations
+
+#### TierClient.createForSite(context, site, productCode)
+
+Creates a TierClient for site-specific operations.
+
+**Parameters:**
+- `context` (object): Context object containing dataAccess and log
+- `site` (object): Site object with getId() method and either getOrganizationId() or getOrganization() method
+- `productCode` (string): Product code (required)
+
+**Returns:** TierClient instance for site operations
+
+### Constructor
+
+#### TierClient(context, orgId, siteId, productCode)
+
+Creates a new TierClient instance directly.
+
+**Parameters:**
+- `context` (object): Context object containing dataAccess and log
+- `orgId` (string): Organization ID (required)
+- `siteId` (string|null|undefined): Site ID (optional for organization-only operations)
+- `productCode` (string): Product code (required)
+
+**Returns:** TierClient instance
+
+### checkValidEntitlement()
+
+Checks for valid entitlement on organization and valid site enrollment on site.
+
+**Returns:** Promise<object> - Object with entitlement and/or siteEnrollment based on what exists
+
+### createEntitlement(tier)
+
+Creates entitlement for organization and site enrollment for site.
+
+**Parameters:**
+- `tier` (string): Entitlement tier (must be a valid tier from EntitlementModel.TIERS)
+
+**Returns:** Promise<object> - Object with created entitlement and siteEnrollment
+
+## Error Handling
+
+All methods return promises. It's important to handle errors using `try/catch` blocks in async functions to manage database errors or validation failures gracefully.
+
+## Development
+
+### Testing
+
+To run tests:
+
+```bash
+npm test
+```
+
+### Linting
+
+Lint your code:
+
+```bash
+npm run lint
+```
+
+### Cleaning
+
+To remove `node_modules` and `package-lock.json`:
+
+```bash
+npm run clean
+```
+
+## Additional Information
+
+- **Repository**: [GitHub](https://github.com/adobe/spacecat-shared.git)
+- **Issue Tracking**: [GitHub Issues](https://github.com/adobe/spacecat-shared/issues)
+- **License**: Apache-2.0