Initial Release

.github/workflows/gh-pages.yml

@@ -0,0 +1,24 @@
+name: Build Documentation and Deploy to GitHub Pages
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+      - name: Install and Build 🔧
+        run: |
+          npm ci
+          npm run doc
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: documentation

.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish to NPM
+on:
+  release:
+    types: [created]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Publish package on NPM 📦
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Build SDK and Test
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+      - run: npm ci
+      - run: node --test --test-concurrency 1
+        env:
+          TEST_KEY: ${{ secrets.TEST_S3_KEY }}
+          TEST_SECRET: ${{ secrets.TEST_S3_SECRET }}
+          TEST_IPFS_GATEWAY: ${{ vars.TEST_IPFS_GATEWAY }}
+          TEST_IPNS_PRIVATE_KEY: ${{ secrets.TEST_IPNS_PRIVATE_KEY }}
+          TEST_NAME_CID: ${{ vars.TEST_NAME_CID }}

.gitignore

@@ -1,3 +1,4 @@
 dist
 node_modules
+documentation
 .env

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Filebase, 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.

jsdoc.json

@@ -0,0 +1,35 @@
+{
+  "source": {
+    "include": ["src"],
+    "includePattern": ".js$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": ["plugins/markdown", "plugins/summarize"],
+  "templates": {
+    "referenceTitle": "Filebase SDK",
+    "cleverLinks": true
+  },
+  "opts": {
+    "template": "node_modules/clean-jsdoc-theme",
+    "recurse": true,
+    "tutorials": "./tutorials",
+    "destination": "./documentation/",
+    "readme": "./readme.md",
+    "theme_opts": {
+      "title": "Filebase SDK",
+      "homepageTitle": "Filebase SDK",
+      "favicon": "https://console.filebase.com/favicon.ico",
+      "default_theme": "fallback-dark",
+      "sort": false,
+      "menu": [{
+        "title": "Github",
+        "link": "https://github.com/filebase/filebase-sdk",
+        "target": "_blank"
+      },{
+        "title": "npm",
+        "link": "https://www.npmjs.com/package/@filebase/sdk",
+        "target": "_blank"
+      }]
+    }
+  }
+}