Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Commit

Permalink
Admin API client
Browse files Browse the repository at this point in the history
  • Loading branch information
scottdixon committed Oct 26, 2023
1 parent a0ea8dd commit 9dc6b54
Show file tree
Hide file tree
Showing 29 changed files with 2,574 additions and 0 deletions.
14 changes: 14 additions & 0 deletions packages/admin-api-client/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
rollup.config.js
rollup-common.js
rollup-umd.config.js
node_modules/
dist/
dist-umd/
schema.json

graphql.schema.json
src/types/apiTypes.ts
**/*.d.ts
src/clientPlus/graphql/operations.ts
codegen.ts
transform-graphql-jest-28-shim.js
40 changes: 40 additions & 0 deletions packages/admin-api-client/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{

This comment has been minimized.

Copy link
@melissaluu

melissaluu Oct 26, 2023

Contributor

Let's aim to use the main linting rules so we can remove this unless there's something very specific we'd need to set for our this particular package (eg. for the SFAPI client, I'll need to set @typescript-eslint/ban-ts-comment rule to off because I need the // ts-ignore in the tests to test some of the validation.

"env": {
"browser": true,
"es6": true,
"jest": true
},
"extends": [
"plugin:@shopify/typescript",
"plugin:@shopify/esnext",
"plugin:@shopify/prettier"
],
"overrides": [
{
"files": ["*.ts", "*.js"],
"parserOptions": {
"project": ["./tsconfig.json"]
}
}
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": ["@typescript-eslint"],
"rules": {
"no-console": "warn",
"@typescript-eslint/member-ordering": "off",
"@typescript-eslint/consistent-indexed-object-style": "off",
"@typescript-eslint/ban-ts-comment": "off",
"sort-class-members/sort-class-members": "off",
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "variable",
"format": ["camelCase", "UPPER_CASE"]
}
]
}
}
20 changes: 20 additions & 0 deletions packages/admin-api-client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

node_modules/
dist/
dist-umd/

package-lock.json
.vscode/
.DS_Store

# temporary ignore release workflow.yml
.github/workflows/release.yml

# ignore any locally packed packages
*.tgz
1 change: 1 addition & 0 deletions packages/admin-api-client/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18
1 change: 1 addition & 0 deletions packages/admin-api-client/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @shopify/storefront-api-client
131 changes: 131 additions & 0 deletions packages/admin-api-client/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla coc].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla coc]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
45 changes: 45 additions & 0 deletions packages/admin-api-client/CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Working on the Storefront API Client library

## Contributing

We welcome your contributions to the project. There are a few steps to take when looking to make a contribution.

1. Open an issue to discuss the feature/bug
2. If feature/bug is deemed valid, fork the repo and create your branch from `main`
3. Implement patch or feature to resolve issue
4. Include tests to prevent regressions and validate the update
5. Ensure the code base is in good standing and valid by running `yarn run lint` and `yarn run test`
6. If applicable, update the docs for any API changes
7. If the update is notable or affects functionality, add a `changeset` using `yarn run changeset add`
8. If you haven’t already, [sign a Contributor License Agreement](https://cla.shopify.com/)
9. Submit a pull request

### Contributor License Agreement (CLA)

Each contributor is required to [sign a CLA](https://cla.shopify.com/). This process is automated as part of your first pull request and is only required once. If any contributor has not signed or does not have an associated GitHub account, the CLA check will fail and the pull request is unable to be merged.

## Bug Reporting

Storefront API Client uses GitHub issue tracking to manage bugs, please open an issue there.

## Developing the library

**Requirements:**

- Node.js version v18 or higher

Run the following commands to get started working on the library.

| Command | Description |
| --------------------------------------------------------------- | ---------------------------------------------------- |
| `git clone [email protected]:Shopify/storefront-api-client-js.git` | Clones the repo to your local computer |
| `yarn install` | Installs the dependencies with `yarn` |
| `yarn run build` | `build`s library for production package distribution |

## Helpful commands

| Command | Description |
| ------------------------ | -------------------------- |
| `yarn run lint` | Lints the code with ESLint |
| `yarn run test` | Runs unit tests |
| `yarn run changeset add` | Add a changeset locally |
9 changes: 9 additions & 0 deletions packages/admin-api-client/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) 2023-present, Shopify Inc.

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.
Loading

0 comments on commit 9dc6b54

Please sign in to comment.