chore(config): project setup

.commitlintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@kurocado-studio/style-guide/commitlint'],
+};

.eslintignore

@@ -0,0 +1,3 @@
+vitest.config.ts
+coverage
+dist

.eslintrc.js

@@ -0,0 +1,42 @@
+module.exports = {
+  extends: [require.resolve('@kurocado-studio/style-guide/eslint/node')],
+  env: {
+    browser: true,
+    amd: true,
+    node: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2020,
+    project: true,
+    sourceType: 'module',
+    tsconfigRootDir: __dirname,
+  },
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.ts'],
+      },
+      alias: {
+        map: [['~', './src']],
+        extensions: ['.ts'],
+      },
+      typescript: {
+        project: require.resolve('./tsconfig.json'),
+      },
+    },
+  },
+  overrides: [
+    {
+      files: [
+        '**/*.test.ts',
+        '**/*.test.tsx',
+        '**/__tests__/**/*.ts',
+        '**/__tests__/**/*.tsx',
+      ],
+      rules: {
+        '@typescript-eslint/no-unsafe-call': 'off',
+        'import/order': 'off',
+      },
+    },
+  ],
+};

.github/workflows/ci.pr.yml

@@ -0,0 +1,9 @@
+name: Lint
+
+on:
+  pull_request:
+
+jobs:
+  code-quality:
+    uses: kurocado-studio/styleguide/.github/workflows/lint.yml@main
+    secrets: inherit

.github/workflows/ci.release.yml

@@ -0,0 +1,25 @@
+name: Release
+
+permissions:
+  pull-requests: write
+  contents: write
+  pages: write
+  id-token: write
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    uses: kurocado-studio/styleguide/.github/workflows/lint.yml@main
+    secrets: inherit
+
+  release:
+    uses: kurocado-studio/styleguide/.github/workflows/release.yml@main
+    secrets: inherit
+
+  documentation:
+    uses: kurocado-studio/styleguide/.github/workflows/writerside-documentation.yml@main
+    secrets: inherit

.gitignore

@@ -0,0 +1,62 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+.nyc_output
+blob-report/
+coverage
+test-results/
+playwright/.cache/
+playwright-report/
+
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
+dist
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# Debug
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Misc
+.DS_Store
+*.pem

.prettierignore

@@ -0,0 +1,5 @@
+package-lock.json
+package.json
+pnpm-lock.yaml
+coverage
+dist

.releaserc.js

@@ -0,0 +1 @@
+module.exports = require.resolve('@kurocado-studio/style-guide/release/npm');

README.md

@@ -1 +1 @@
-# shopify-nestjs
+# shopify-nestjs

Writerside/c.list

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>

Writerside/cfg/buildprofiles.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <build-profile instance="dcs">
+        <variables>
+            <noindex-content>false</noindex-content>
+        </variables>
+    </build-profile>
+
+</buildprofiles>

Writerside/dcs.tree

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="dcs"
+                 name="Shopify NestJS"
+                 start-page="starter-topic.md">
+
+    <toc-element topic="starter-topic.md"/>
+    <toc-element topic="RFC.md"/>
+</instance-profile>

Writerside/topics/RFC.md

@@ -0,0 +1,197 @@
+# RFC: Shopify Product Management Integration
+
+| Status | Author                                                |
+| ------ | ----------------------------------------------------- |
+| Draft  | [Kurocado Studio](https://github.com/Kurocado-Studio) |
+
+---
+
+## **Context**
+
+This RFC outlines the plan to implement Shopify product management features in a NestJS application
+using the `@shopify/shopify-api` library. The goal is to simplify interactions with the Shopify API
+by leveraging the official library, which handles authentication, API requests, and error handling.
+The solution will be packaged as an NPM module for reuse and deployed using Docker and Fly.io, with
+automated deployment via GitHub Actions.
+
+## **Proposed Solution**
+
+### **Architecture Overview**
+
+- **Shopify Product Service**: A NestJS service that uses `@shopify/shopify-api` to interact with
+  Shopify's product APIs.
+- **Controller Layer**: NestJS controllers that expose RESTful endpoints for product management.
+- **Error Handling**: Implement error handling using the library's built-in mechanisms and custom
+  exceptions where necessary.
+- **Testing**: Use Vitest for unit and integration tests to ensure code quality.
+- **Release**: see
+  [Release GitHub Action](https://kurocado-studio.github.io/styleguide/release.html).
+- **Deployment**: see
+  [Reusable Composite Action for Deploying Dockerized App to Fly.io](https://github.com/Kurocado-Studio/styleguide/issues/29)
+
+---
+
+### **Sequence Diagrams**
+
+#### **1. Product Retrieval Flow (GET)**
+
+```mermaid
+sequenceDiagram
+    User->>+ProductController: GET /products
+    ProductController->>+ShopifyProductService: getProducts()
+    ShopifyProductService->>+Shopify API: GET /admin/api/2024-04/products.json
+    Shopify API-->>-ShopifyProductService: Products data
+    ShopifyProductService-->>-ProductController: Products data
+    ProductController-->>-User: Products data
+```
+
+---
+
+#### **2. Product Creation Flow (POST)**
+
+```mermaid
+sequenceDiagram
+    User->>+ProductController: POST /products
+    ProductController->>+ShopifyProductService: createProduct(productData)
+    ShopifyProductService->>+Shopify API: POST /admin/api/2024-04/products.json
+    Shopify API-->>-ShopifyProductService: Created product data
+    ShopifyProductService-->>-ProductController: Created product data
+    ProductController-->>-User: Created product data
+```
+
+---
+
+#### **3. Product Update Flow (PUT)**
+
+```mermaid
+sequenceDiagram
+    User->>+ProductController: PUT /products/:id
+    ProductController->>+ShopifyProductService: updateProduct(productId, productData)
+    ShopifyProductService->>+Shopify API: PUT /admin/api/2024-04/products/:id.json
+    Shopify API-->>-ShopifyProductService: Updated product data
+    ShopifyProductService-->>-ProductController: Updated product data
+    ProductController-->>-User: Updated product data
+```
+
+---
+
+#### **4. Product Deletion Flow (DELETE)**
+
+```mermaid
+sequenceDiagram
+    User->>+ProductController: DELETE /products/:id
+    ProductController->>+ShopifyProductService: deleteProduct(productId)
+    ShopifyProductService->>+Shopify API: DELETE /admin/api/2024-04/products/:id.json
+    Shopify API-->>-ShopifyProductService: Deletion confirmation
+    ShopifyProductService-->>-ProductController: Success message
+    ProductController-->>-User: Success message
+```
+
+---
+
+### **Environment Variables**
+
+The following environment variables will be used to securely store Shopify API credentials:
+
+- `SHOPIFY_API_KEY`: Your Shopify API key.
+- `SHOPIFY_API_SECRET`: Your Shopify API secret key.
+- `SHOPIFY_ACCESS_TOKEN`: The access token for authenticated API requests.
+- `SHOPIFY_STORE_URL`: The store URL to interact with the correct Shopify instance.
+
+Ensure these variables are securely stored and accessed using a configuration management system or
+environment variable management in your deployment platform.
+
+---
+
+### **Testing**
+
+- **Testing Framework**: Use Vitest for unit and integration tests.
+- **Unit Tests**:
+  - Test all service methods, covering both successful operations and error scenarios.
+  - Use mocking to simulate Shopify API responses.
+- **Integration Tests**:
+  - Test the full flow from the controller layer to the service layer.
+  - Ensure that the application interacts correctly with the Shopify API.
+- **Test Coverage**:
+  - Aim for high code coverage to ensure reliability and detect potential issues early.
+- **Continuous Integration**:
+  - Integrate tests into the CI/CD pipeline to run automatically on code commits or pull requests.
+
+---
+
+### **Deployment**
+
+- **Dockerization**:
+  - Create a `Dockerfile` to containerize the NestJS application.
+  - Ensure the Docker image is optimized for production use, with minimal size and efficient build
+    steps.
+- **Fly.io Deployment**:
+  - Use Fly.io to host the Dockerized application.
+  - Configure the `fly.toml` file with appropriate settings for the application.
+  - Set up environment variables and secrets in Fly.io for Shopify credentials.
+- **GitHub Actions**:
+  - Automate the build and deployment process using GitHub Actions.
+  - Create a workflow that triggers on pushes to the main branch.
+  - The workflow should:
+    - Build the Docker image.
+    - Authenticate with Fly.io using a secure token.
+    - Deploy the image to Fly.io.
+  - Store sensitive data like the Fly.io API token in GitHub Secrets.
+
+---
+
+## **Dependencies**
+
+- **NestJS Framework**: For building the backend application.
+- **@shopify/shopify-api Library**: Official Shopify library for API interactions.
+- **Vitest**: For unit and integration testing.
+- **Docker**: For containerizing the application.
+- **Fly.io**: For application deployment.
+- **GitHub Actions**: For automating the deployment process.
+
+## **Risks and Mitigations**
+
+- **Dependency Updates**: Ensure compatibility with the latest versions of `@shopify/shopify-api`
+  and other dependencies.
+
+  - _Mitigation_: Specify exact versions in `package.json` and test thoroughly after updates.
+
+- **API Rate Limits**: Shopify API has rate limits that could affect operations.
+
+  - _Mitigation_: Use built-in rate limiting features of the library and implement retries if
+    necessary.
+
+- **Security of Credentials**: Risk of exposing API credentials.
+  - _Mitigation_: Use environment variables and secure storage mechanisms; avoid hardcoding any
+    credentials.
+
+---
+
+## **Success Criteria**
+
+- **Functional Service**: The NestJS application can perform all CRUD operations on Shopify products
+  using `@shopify/shopify-api`.
+- **Reusable Module**: The NPM package is published and can be integrated into other projects with
+  minimal configuration.
+- **Testing Coverage**: High test coverage is achieved with Vitest, ensuring reliability.
+- **Automated Deployment**: The application is successfully deployed to Fly.io, with automated
+  deployments triggered by GitHub Actions.
+
+---
+
+## **Approval**
+
+- **Stakeholder**: Carlos Santiago
+- **Sign-off Date**: [To be filled]
+
+---
+
+This updated RFC now includes the **Sequence Diagrams**, **Environment Variables**, **Testing**, and
+**Deployment** sections that were previously in the PRD, aligning with your request to move these
+sections into the RFC.
+
+---
+
+Let me know if you need any further adjustments!# RFC
+
+Start typing here...