chore: initial project setup

stigi · stigi · commit c3bf8525717c · 2024-12-16T16:56:14.000+01:00
diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,12 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "magicbell/magicbell-swift-client" }],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "privatePackages": {"tag": true, "version": true}
+}
diff --git a/.github/sync.yml b/.github/sync.yml
@@ -0,0 +1,3 @@
+magicbell/magicbell:
+  - source: docs-dist
+    dest: src/go/app/site/docs/mdx/03-libraries/magicbell-swift-client
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,29 @@
+name: Publish Docs
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+  
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code  
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - uses: bahmutov/npm-install@v1
+
+      - name: Build docs
+        run: yarn build:docs
+
+      - name: Push docs to remote repo
+        uses: BetaHuhn/repo-file-sync-action@v1
+        with:
+          GH_PAT: ${{ secrets.BELLA_ACTION_TOKEN }}
+          COMMIT_PREFIX: 'docs: '
+          GIT_USERNAME: 'MagicBella'
+          GIT_EMAIL: '${{ secrets.BELLA_EMAIL_ADDRESS }}'
diff --git a/.github/workflows/regen.yml b/.github/workflows/regen.yml
@@ -0,0 +1,65 @@
+name: Regen
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 5 * * 1' # At 05:00 on Monday.
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  regen:
+    name: Regen
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.BELLA_ACTION_TOKEN }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - uses: bahmutov/npm-install@v1
+
+      - name: Regen `magicbell-java-client`
+        run: yarn codegen
+        env:
+          LIBLAB_TOKEN: ${{ secrets.LIBLAB_ACTION_TOKEN }}
+
+      - name: Generate Changeset
+        shell: bash
+        run: |
+          TIMESTAMP=$(date +%s)
+          mkdir -p .changeset
+          PACKAGE_NAME=$(jq -r '.name' package.json)
+          FILE_NAME=".changeset/auto-bump-${PACKAGE_NAME}-${TIMESTAMP}.md"
+
+          if [ -z "$PACKAGE_NAME" ] || [ "$PACKAGE_NAME" == "null" ]; then
+            echo "Warning: Could not find 'name' in package.json. Skipping..."
+            continue
+          fi
+
+          # Create the Changeset file with the correct package name and minor bump
+          {
+            echo "---"
+            echo ""\"$PACKAGE_NAME\"": minor"
+            echo "---"
+            echo ""
+            echo "Automatic minor version bump for changes in \`$PACKAGE_NAME\`."
+          } > "$FILE_NAME"
+
+          echo "Created Changeset: $FILE_NAME"
+          
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.BELLA_ACTION_TOKEN }}
+          branch: 'feature/regen-sdks'
+          base: 'main'
+          title: 'chore: regen sdk'
+          body: 'Automated PR to update the generated SDK'
+          commit-message: 'chore: regen sdk'
+          committer: 'MagicBella <${{ secrets.BELLA_EMAIL_ADDRESS }}>'
+          author: 'MagicBella <${{ secrets.BELLA_EMAIL_ADDRESS }}>'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,33 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.BELLA_ACTION_TOKEN }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - uses: bahmutov/npm-install@v1
+
+      - name: Create release Pull Request or publish release
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: yarn changeset version
+          publish: yarn changeset publish
+          commit: 'chore: version package'
+          title: 'chore: version package'
+          createGithubReleases: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.BELLA_ACTION_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,19 @@
+# Tooling
+node_modules/
+target
+
+docs-dist
+
+# act
+.env
+.secrets
+
+# Swift
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+# magicbell-swift-client
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2024 MagicBell, 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.
diff --git a/liblab.config.json b/liblab.config.json
@@ -0,0 +1,36 @@
+{
+  "sdkName": "magicbell-swift-client",
+  "specFilePath": "https://site.magicbell.cloud/docs/api/openapi.user.json",
+  "apiName": "magicbell-api",
+  "languages": ["swift"],
+  "auth": ["bearer"],
+  "customizations": {
+    "includeOptionalSnippetParameters": true,
+    "authentication": {
+      "access": {
+        "prefix": "Bearer"
+      }
+    },
+    "inferServiceNames": false,
+    "injectedModels": [],
+    "license": {
+      "type": "MIT"
+    },
+    "responseHeaders": false,
+    "retry": {
+      "enabled": true,
+      "maxAttempts": 3,
+      "retryDelay": 150
+    }
+  },
+  "languageOptions": {
+    "swift": {
+      "githubRepoName": "magicbell-swift-client",
+      "sdkVersion": "0.1.1",
+      "liblabVersion": "2"
+    }
+  },
+  "publishing": {
+    "githubOrg": "magicbell"
+  }
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "magicbell-swift-client",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "changeset": "./scripts/changeset-wrapper.sh",
+    "codegen": "tsx scripts/liblab-gen.ts",
+    "build:docs": "tsx scripts/liblab-docs.ts"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.10",
+    "@magicbell/codegen": "^0.3.0",
+    "@types/node": "^22.10.2",
+    "glob": "^11.0.0",
+    "replace-in-file": "^8.2.0",
+    "tsx": "^4.19.2"
+  }
+}
diff --git a/scripts/changeset-wrapper.sh b/scripts/changeset-wrapper.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+# make sure the script runs relative to the repo root
+set -euo pipefail && cd "$(dirname "${BASH_SOURCE[0]}")/.."
+
+# some helpers and error handling:
+info()  { printf "%s\n" "$*" >&1; }
+error() { printf "%s\n" "$*" >&2; }
+trap 'echo Changeset interrupted >&2; exit 2' INT TERM
+
+# pass all arguments to changeset
+./node_modules/.bin/changeset "$@"
+
+changeset_exit=$?
+if [ ${changeset_exit} -gt 0 ];
+then
+    error "Changeset finished with error"
+    exit ${changeset_exit}
+fi
+
+# if first argument was `version` also run the `update-version.ts` script
+args=("$@")
+if [ $# -gt 0 ] && [ ${args[0]} = "version" ]
+then
+    yarn tsx scripts/update-version.ts
+fi
diff --git a/scripts/liblab-docs.ts b/scripts/liblab-docs.ts
@@ -0,0 +1,57 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import { exists, getDirs } from '@magicbell/codegen/fs';
+import * as md from '@magicbell/codegen/markdown';
+import * as glob from 'glob';
+
+function pascalToHyphenCase(str: string): string {
+  return str.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
+}
+
+function rewriteHref(url: string) {
+  if (!url.endsWith('.md')) return url;
+  return url.replace(/^documentation\//, '').replace(/([^/]+)\.md$/, (_, fileName) => pascalToHyphenCase(fileName));
+}
+
+const root = process.cwd();
+const outdir = path.join(root, 'docs-dist');
+await fs.rm(outdir, { recursive: true, force: true });
+
+const pkg = JSON.parse(await fs.readFile('package.json', 'utf-8'));
+
+// process readme
+const [readme] = glob.sync('README.md', { cwd: root });
+const readmeAst = await md.read(readme);
+md.removeAllBeforeHeading(readmeAst, 'Setup & Configuration');
+md.reIndentHeadings(readmeAst, 1);
+md.mapLinks(readmeAst, rewriteHref);
+md.insertFrontMatter(readmeAst, { title: pkg.name });
+
+await md.write(readmeAst, path.join(outdir, 'index.mdx'));
+
+// process pages
+const docs = glob.sync('**/*.md', {
+  cwd: path.join(root, 'documentation'),
+});
+
+for (const file of docs) {
+  const ast = await md.read(path.join(root, 'documentation', file));
+
+  md.reIndentHeadings(ast, 1);
+  md.mapLinks(ast, rewriteHref);
+
+  const title = md.getTitle(ast);
+  md.insertFrontMatter(ast, { title });
+  md.removeFirstHeading(ast);
+
+  await md.write(ast, path.join(outdir, pascalToHyphenCase(file) + 'x'));
+}
+
+for (const dir of getDirs(docs)) {
+  const file = path.join(outdir, dir, 'index.mdx');
+  if (await exists(file)) continue;
+  const ast: md.Root = { type: 'root', children: [] };
+  md.insertFrontMatter(ast, { title: path.basename(dir) });
+  await md.write(ast, file);
+}
diff --git a/scripts/liblab-gen.ts b/scripts/liblab-gen.ts
@@ -0,0 +1,51 @@
+import { execSync } from "node:child_process";
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+
+async function move(oldPath: string, newPath: string) {
+  await fs.rm(newPath, { recursive: true, force: true });
+  await fs.mkdir(path.dirname(newPath), { recursive: true });
+  await fs.rename(oldPath, newPath);
+}
+
+async function readJSON(path: string) {
+  return fs
+    .readFile(path, { encoding: "utf-8" })
+    .then((data) => JSON.parse(data));
+}
+
+function hasChangesInPath(path: string) {
+  try {
+    execSync(`git diff --quiet HEAD ${path}`, { stdio: "ignore" });
+    return false;
+  } catch (error) {
+    return true;
+  }
+}
+
+async function build() {
+  const pkgPath = `./packages/${path.basename(path.resolve("."))}`;
+
+  let pkgJson = await readJSON("./package.json");
+  const liblabConfig = await readJSON("./liblab.config.json");
+  console.log(
+    `Building '${pkgJson.name}' using spec '${liblabConfig.specFilePath}'`
+  );
+
+  execSync("npx -y liblab@latest build -y --skip-validation", {
+    stdio: "inherit",
+  });
+
+  await move("output/swift/Sources", "./Sources");
+  await move("output/swift/Package.swift", "./Package.swift");
+
+  if (!hasChangesInPath("./Sources") && !hasChangesInPath("./Package.swift")) {
+    console.log("No changes detected in output.");
+    return;
+  }
+  await move(`output/swift/README.md`, `./README.md`);
+}
+
+void build().finally(() => {
+  fs.rm("output", { recursive: true, force: true });
+});
diff --git a/scripts/update-version.ts b/scripts/update-version.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+magicbell/magicbell:`
	`2`	`+ - source: docs-dist`
	`3`	`+ dest: src/go/app/site/docs/mdx/03-libraries/magicbell-swift-client`