Merge pull request #9 from underscope/chore/bump-deps

Maintenence & improved dev setup

.env.example

@@ -2,7 +2,8 @@
 EXAMPLE_API_PORT=
 
 # storage
-ACCESS_KEY_ID=
-SECRET_ACCESS_KEY=
-REGION=
-BUCKET=
+S3_ENDPOINT=
+S3_BUCKET=
+S3_REGION=
+S3_ACCESS_KEY_ID=
+S3_SECRET_ACCESS_KEY=

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 22.x
 
       - name: Setup
         run: npm i -g @antfu/ni
@@ -35,7 +35,7 @@ jobs:
       - name: Set node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 22.x
 
       - name: Setup
         run: npm i -g @antfu/ni

README.md

@@ -8,8 +8,6 @@ Utility for managing published Tailor content. Provides ability to:
 - ✅ sign ContentElement assets for delivery
 - 🚧 cache presigned Repository instance
 
-
-
 Initialize garment by providing storage provider configuration.
 
 ```js
@@ -29,7 +27,7 @@ const garment = new Garment({
 ### Fetching resources
 
 Retrieve the list of published repositories
-```js 
+```js
 garment.source().list()
 ```
 
@@ -52,7 +50,7 @@ of:
 - `uid`
 - `type` - Activity, Content Container or Content Element
 - `parentId`
-- `positionInAggregate` - location within the aggregate array; 
+- `positionInAggregate` - location within the aggregate array;
   if denormalized object
 
 ```js
@@ -89,8 +87,8 @@ To get a list of all of the ancestors, use `getAncestors(uid)` method.
 Content graph makes it simple to resolve where specific `Content Container` or
 `Content Element` is, so we can retrieve only content items we need (and we
 can more easily navigate within a aggregate structure; e.g. if we want to
-get a specific `Content Element` which might be located in a 
-`Content Container`). To resolve `Content Container` or a `Content Element` 
+get a specific `Content Element` which might be located in a
+`Content Container`). To resolve `Content Container` or a `Content Element`
 location, use:
 
 ```js

config.js

@@ -0,0 +1,24 @@
+import dotenv from 'dotenv'
+
+dotenv.config({ path: '.env' })
+
+const app = {
+  port: process.env.EXAMPLE_API_PORT || 3030,
+}
+
+export const storage = {
+  provider: 'aws',
+  bucket: process.env.S3_BUCKET || 'test-bucket',
+  aws: {
+    endpoint: process.env.S3_ENDPOINT || 'http://localhost:4566',
+    region: process.env.S3_REGION || 'us-east-1',
+    keyId: process.env.S3_ACCESS_KEY_ID || 'test-key-id',
+    secretKey: process.env.S3_SECRET_ACCESS_KEY || 'test-secret',
+    forcePathStyle: true,
+  },
+}
+
+export default {
+  ...app,
+  storage,
+}

docker-compose.dev.yaml

@@ -0,0 +1,8 @@
+services:
+  localstack-garment:
+    image: localstack/localstack
+    ports:
+      - '127.0.0.1:4566:4566'
+    environment:
+      - SERVICES=s3:4566
+      - DEFAULT_REGION=us-east-1

eslint.config.js

@@ -0,0 +1,16 @@
+// @ts-check
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  type: 'lib',
+  ignores: ['seed/content/**'],
+  rules: {
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    'antfu/no-import-dist': 'off',
+    'antfu/no-top-level-await': 'off',
+    'no-console': 'off',
+    'node/prefer-global/buffer': 'off',
+    'node/prefer-global/process': 'off',
+    'ts/no-unsafe-function-type': 'off',
+  },
+})

examples/api/index.js

@@ -1,8 +1,10 @@
-const express = require('express')
-const { Garment } = require('../../dist/index.cjs')
+import { Garment } from '@tailor-cms/garment'
+import express from 'express'
+
+import config from '../../config.js'
 
 const app = express()
-const config = require('./config')
+
 const { log } = console
 
 const garment = new Garment(config.storage)
@@ -13,12 +15,13 @@ app.get('/', async (_, res) => {
 })
 
 app.get('/repository/:id', async ({ params, query }, res) => {
-  const public = !!query.public
+  const signAssets = !!query.public
   const opts = { eager: !!query.eager }
   const repository = query.snapshot
     ? await garment.snapshot().get(params.id, query.snapshot, opts)
     : await garment.source().get(params.id, opts)
-  if (public) await repository.makePublic()
+  if (signAssets)
+    await repository.makePublic()
   res.json({
     size: repository.size,
     location: repository.path,