@aurora-studio/sdk 0.1.0

package/.github/workflows/publish.yml

@@ -0,0 +1,43 @@
+# Publish @aurora-studio/sdk to npm (trusted publishing via OIDC)
+name: Publish to npm
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+
+permissions:
+  id-token: write   # Required for OIDC trusted publishing
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          registry-url: "https://registry.npmjs.org"
+          cache: "pnpm"
+
+      - run: pnpm install
+
+      - run: pnpm run build
+
+      - name: Remove private for publish
+        run: |
+          node -e "
+          const fs = require('fs');
+          const pkg = JSON.parse(fs.readFileSync('package.json', 'utf8'));
+          delete pkg.private;
+          fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2));
+          "
+
+      - name: Publish to npm
+        run: npm publish --no-git-checks --access public

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Marcel du Preez
+
+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.

package/README.md

@@ -0,0 +1,61 @@
+# @aurora-studio/sdk
+
+Node.js SDK for Aurora Studio. Connect custom front-ends and storefronts to your Aurora data via the V1 API.
+
+**Aurora** is an all-in-one, no-code platform for stores, marketplaces, CRMs, and more. Design your data, generate your app, automate workflows. Ship in hours, not months.
+
+[**Sign up for Aurora**](https://aurora.mandeville.digital) — currently in beta testing and free.
+
+## Install
+
+```bash
+npm install @aurora-studio/sdk
+```
+
+## Usage
+
+```ts
+import { AuroraClient } from "@aurora-studio/sdk";
+
+const aurora = new AuroraClient({
+  baseUrl: "https://api.youraurora.com",
+  apiKey: "aur_xxx...",
+});
+
+// List tables
+const tables = await aurora.tables.list();
+
+// List records
+const { data, total } = await aurora.tables("products").records.list({ limit: 10 });
+
+// Get single record
+const product = await aurora.tables("products").records.get("uuid");
+
+// Create record
+const created = await aurora.tables("products").records.create({ name: "New Product" });
+
+// Store config and pages
+const config = await aurora.store.config();
+const pages = await aurora.store.pages.list();
+```
+
+## API Surface
+
+| Method                                         | Description        |
+| ---------------------------------------------- | ------------------ |
+| `client.tables.list()`                         | List tables        |
+| `client.tables(slug).records.list(opts)`       | List records       |
+| `client.tables(slug).records.get(id)`          | Get record         |
+| `client.tables(slug).records.create(data)`     | Create record      |
+| `client.tables(slug).records.update(id, data)` | Update record      |
+| `client.tables(slug).records.delete(id)`       | Delete record      |
+| `client.tables(slug).sectionViews.list()`      | List section views |
+| `client.views.list()`                          | List report views  |
+| `client.views(slug).data()`                    | Get view data      |
+| `client.reports.list()`                        | List reports       |
+| `client.reports(id).data()`                    | Get report data    |
+| `client.store.config()`                        | Get store config   |
+| `client.store.pages.list()`                    | List store pages   |
+| `client.store.pages.get(slug)`                 | Get store page     |
+
+Create API keys in Aurora Studio → Settings → API Keys.

package/dist/index.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Aurora Studio SDK - Fluent API for custom front-ends and storefronts.
+ * Use with X-Api-Key authentication.
+ */
+export interface AuroraClientOptions {
+    baseUrl: string;
+    apiKey: string;
+}
+export declare class AuroraClient {
+    private baseUrl;
+    private apiKey;
+    constructor(options: AuroraClientOptions);
+    private req;
+    tables: ((slug: string) => {
+        records: {
+            list: (opts?: {
+                limit?: number;
+                offset?: number;
+                sort?: string;
+                order?: "asc" | "desc";
+                filter?: string;
+            }) => Promise<{
+                data: Record<string, unknown>[];
+                total: number;
+                limit: number;
+                offset: number;
+            }>;
+            get: (id: string) => Promise<Record<string, unknown>>;
+            create: (data: Record<string, unknown>) => Promise<Record<string, unknown>>;
+            update: (id: string, data: Record<string, unknown>) => Promise<Record<string, unknown>>;
+            delete: (id: string) => Promise<void>;
+        };
+        sectionViews: {
+            list: () => Promise<{
+                id: string;
+                name: string;
+                view_type: string;
+                config: unknown;
+            }[]>;
+        };
+    }) & {
+        list: () => Promise<{
+            slug: string;
+            name: string;
+        }[]>;
+    };
+    views: ((slug: string) => {
+        data: () => Promise<{
+            data: unknown[];
+        }>;
+    }) & {
+        list: () => Promise<{
+            slug: string;
+            name: string;
+        }[]>;
+    };
+    reports: ((id: string) => {
+        data: () => Promise<{
+            data: unknown[];
+        }>;
+    }) & {
+        list: () => Promise<{
+            id: string;
+            name: string;
+            description?: string;
+            config: unknown;
+        }[]>;
+    };
+    store: {
+        config: () => Promise<{
+            enabled: boolean;
+            catalogTableSlug?: string;
+            displayField?: string;
+            listFields?: string[];
+            detailFields?: string[];
+            groupingFields?: string[];
+            branding?: {
+                name: string;
+                logo_url?: string;
+                accent_color?: string;
+                show_powered_by?: boolean;
+            };
+            theme?: {
+                primaryColor?: string;
+                fontFamily?: string;
+                spacingScale?: string;
+            };
+        }>;
+        pages: {
+            list: () => Promise<{
+                slug: string;
+                name: string;
+            }[]>;
+            get: (slug: string) => Promise<{
+                slug: string;
+                name: string;
+                blocks: unknown[];
+            }>;
+        };
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AA+CD,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAS;gBAEX,OAAO,EAAE,mBAAmB;IAKxC,OAAO,CAAC,GAAG;IAQX,MAAM,UACG,MAAM;;0BAEK;gBACZ,KAAK,CAAC,EAAE,MAAM,CAAC;gBACf,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;gBACvB,MAAM,CAAC,EAAE,MAAM,CAAC;aACjB;sBAES,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;uBACxB,MAAM;uBACN,MAAM;wBACL,MAAM;;sBAER,MAAM;2BAED,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;yBAEzB,MAAM,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;yBAIrC,MAAM;;;;oBAII,MAAM;sBAAQ,MAAM;2BAAa,MAAM;wBAAU,OAAO;;;;;kBAO9C,MAAM;kBAAQ,MAAM;;MAEzD;IAEF,KAAK,UACI,MAAM;;kBACkB,OAAO,EAAE;;;;kBAEH,MAAM;kBAAQ,MAAM;;MACzD;IAEF,OAAO,QACA,MAAM;;kBACoB,OAAO,EAAE;;;;gBAIf,MAAM;kBAAQ,MAAM;0BAAgB,MAAM;oBAAU,OAAO;;MAKpF;IAEF,KAAK;;qBAGU,OAAO;+BACG,MAAM;2BACV,MAAM;yBACR,MAAM,EAAE;2BACN,MAAM,EAAE;6BACN,MAAM,EAAE;uBACd;gBACT,IAAI,EAAE,MAAM,CAAC;gBACb,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,YAAY,CAAC,EAAE,MAAM,CAAC;gBACtB,eAAe,CAAC,EAAE,OAAO,CAAC;aAC3B;oBACO;gBAAE,YAAY,CAAC,EAAE,MAAM,CAAC;gBAAC,UAAU,CAAC,EAAE,MAAM,CAAC;gBAAC,YAAY,CAAC,EAAE,MAAM,CAAA;aAAE;;;;sBAG5C,MAAM;sBAAQ,MAAM;;wBAC3C,MAAM;sBACC,MAAM;sBAAQ,MAAM;wBAAU,OAAO,EAAE;;;MAK5D;CACH"}

package/dist/index.js

@@ -0,0 +1,84 @@
+/**
+ * Aurora Studio SDK - Fluent API for custom front-ends and storefronts.
+ * Use with X-Api-Key authentication.
+ */
+function buildQuery(params) {
+    if (!params)
+        return "";
+    const search = new URLSearchParams();
+    for (const [k, v] of Object.entries(params)) {
+        if (v !== undefined && v !== "") {
+            search.set(k, String(v));
+        }
+    }
+    const s = search.toString();
+    return s ? `?${s}` : "";
+}
+async function request(baseUrl, apiKey, method, path, opts) {
+    const url = `${baseUrl.replace(/\/$/, "")}${path}${buildQuery(opts?.query)}`;
+    const res = await fetch(url, {
+        method,
+        headers: {
+            "Content-Type": "application/json",
+            "X-Api-Key": apiKey,
+        },
+        body: opts?.body ? JSON.stringify(opts.body) : undefined,
+    });
+    if (!res.ok) {
+        const errBody = await res.text();
+        let msg;
+        try {
+            const j = JSON.parse(errBody);
+            msg = j?.error ?? errBody ?? res.statusText;
+        }
+        catch {
+            msg = errBody || res.statusText;
+        }
+        throw new Error(`Aurora API ${res.status}: ${msg}`);
+    }
+    if (res.status === 204)
+        return undefined;
+    return res.json();
+}
+export class AuroraClient {
+    baseUrl;
+    apiKey;
+    constructor(options) {
+        this.baseUrl = options.baseUrl.replace(/\/$/, "");
+        this.apiKey = options.apiKey;
+    }
+    req(method, path, opts) {
+        return request(this.baseUrl, this.apiKey, method, path, opts);
+    }
+    tables = Object.assign((slug) => ({
+        records: {
+            list: (opts) => this.req("GET", `/v1/tables/${slug}/records`, { query: opts }),
+            get: (id) => this.req("GET", `/v1/tables/${slug}/records/${id}`),
+            create: (data) => this.req("POST", `/v1/tables/${slug}/records`, { body: data }),
+            update: (id, data) => this.req("PATCH", `/v1/tables/${slug}/records/${id}`, {
+                body: data,
+            }),
+            delete: (id) => this.req("DELETE", `/v1/tables/${slug}/records/${id}`),
+        },
+        sectionViews: {
+            list: () => this.req("GET", `/v1/tables/${slug}/views`),
+        },
+    }), {
+        list: () => this.req("GET", "/v1/tables"),
+    });
+    views = Object.assign((slug) => ({
+        data: () => this.req("GET", `/v1/views/${slug}/data`),
+    }), { list: () => this.req("GET", "/v1/views") });
+    reports = Object.assign((id) => ({
+        data: () => this.req("GET", `/v1/reports/${id}/data`),
+    }), {
+        list: () => this.req("GET", "/v1/reports"),
+    });
+    store = {
+        config: () => this.req("GET", "/v1/store/config"),
+        pages: {
+            list: () => this.req("GET", "/v1/store/pages"),
+            get: (slug) => this.req("GET", `/v1/store/pages/${slug}`),
+        },
+    };
+}

package/eslint.config.mjs

@@ -0,0 +1,6 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(eslint.configs.recommended, ...tseslint.configs.recommended, {
+  ignores: ["dist/**", "node_modules/**"],
+});

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@aurora-studio/sdk",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.15.0",
+    "eslint": "^9.15.0",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.15.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/index.ts

@@ -0,0 +1,158 @@
+/**
+ * Aurora Studio SDK - Fluent API for custom front-ends and storefronts.
+ * Use with X-Api-Key authentication.
+ */
+
+export interface AuroraClientOptions {
+  baseUrl: string;
+  apiKey: string;
+}
+
+type QueryParams = Record<string, string | number | boolean | undefined>;
+
+function buildQuery(params?: QueryParams): string {
+  if (!params) return "";
+  const search = new URLSearchParams();
+  for (const [k, v] of Object.entries(params)) {
+    if (v !== undefined && v !== "") {
+      search.set(k, String(v));
+    }
+  }
+  const s = search.toString();
+  return s ? `?${s}` : "";
+}
+
+async function request<T>(
+  baseUrl: string,
+  apiKey: string,
+  method: string,
+  path: string,
+  opts?: { body?: unknown; query?: QueryParams }
+): Promise<T> {
+  const url = `${baseUrl.replace(/\/$/, "")}${path}${buildQuery(opts?.query)}`;
+  const res = await fetch(url, {
+    method,
+    headers: {
+      "Content-Type": "application/json",
+      "X-Api-Key": apiKey,
+    },
+    body: opts?.body ? JSON.stringify(opts.body) : undefined,
+  });
+  if (!res.ok) {
+    const errBody = await res.text();
+    let msg: string;
+    try {
+      const j = JSON.parse(errBody);
+      msg = (j?.error as string) ?? errBody ?? res.statusText;
+    } catch {
+      msg = errBody || res.statusText;
+    }
+    throw new Error(`Aurora API ${res.status}: ${msg}`);
+  }
+  if (res.status === 204) return undefined as T;
+  return res.json() as Promise<T>;
+}
+
+export class AuroraClient {
+  private baseUrl: string;
+  private apiKey: string;
+
+  constructor(options: AuroraClientOptions) {
+    this.baseUrl = options.baseUrl.replace(/\/$/, "");
+    this.apiKey = options.apiKey;
+  }
+
+  private req<T>(
+    method: string,
+    path: string,
+    opts?: { body?: unknown; query?: QueryParams }
+  ): Promise<T> {
+    return request<T>(this.baseUrl, this.apiKey, method, path, opts);
+  }
+
+  tables = Object.assign(
+    (slug: string) => ({
+      records: {
+        list: (opts?: {
+          limit?: number;
+          offset?: number;
+          sort?: string;
+          order?: "asc" | "desc";
+          filter?: string;
+        }) =>
+          this.req<{
+            data: Record<string, unknown>[];
+            total: number;
+            limit: number;
+            offset: number;
+          }>("GET", `/v1/tables/${slug}/records`, { query: opts as QueryParams }),
+        get: (id: string) =>
+          this.req<Record<string, unknown>>("GET", `/v1/tables/${slug}/records/${id}`),
+        create: (data: Record<string, unknown>) =>
+          this.req<Record<string, unknown>>("POST", `/v1/tables/${slug}/records`, { body: data }),
+        update: (id: string, data: Record<string, unknown>) =>
+          this.req<Record<string, unknown>>("PATCH", `/v1/tables/${slug}/records/${id}`, {
+            body: data,
+          }),
+        delete: (id: string) => this.req<void>("DELETE", `/v1/tables/${slug}/records/${id}`),
+      },
+      sectionViews: {
+        list: () =>
+          this.req<Array<{ id: string; name: string; view_type: string; config: unknown }>>(
+            "GET",
+            `/v1/tables/${slug}/views`
+          ),
+      },
+    }),
+    {
+      list: () => this.req<Array<{ slug: string; name: string }>>("GET", "/v1/tables"),
+    }
+  );
+
+  views = Object.assign(
+    (slug: string) => ({
+      data: () => this.req<{ data: unknown[] }>("GET", `/v1/views/${slug}/data`),
+    }),
+    { list: () => this.req<Array<{ slug: string; name: string }>>("GET", "/v1/views") }
+  );
+
+  reports = Object.assign(
+    (id: string) => ({
+      data: () => this.req<{ data: unknown[] }>("GET", `/v1/reports/${id}/data`),
+    }),
+    {
+      list: () =>
+        this.req<Array<{ id: string; name: string; description?: string; config: unknown }>>(
+          "GET",
+          "/v1/reports"
+        ),
+    }
+  );
+
+  store = {
+    config: () =>
+      this.req<{
+        enabled: boolean;
+        catalogTableSlug?: string;
+        displayField?: string;
+        listFields?: string[];
+        detailFields?: string[];
+        groupingFields?: string[];
+        branding?: {
+          name: string;
+          logo_url?: string;
+          accent_color?: string;
+          show_powered_by?: boolean;
+        };
+        theme?: { primaryColor?: string; fontFamily?: string; spacingScale?: string };
+      }>("GET", "/v1/store/config"),
+    pages: {
+      list: () => this.req<Array<{ slug: string; name: string }>>("GET", "/v1/store/pages"),
+      get: (slug: string) =>
+        this.req<{ slug: string; name: string; blocks: unknown[] }>(
+          "GET",
+          `/v1/store/pages/${slug}`
+        ),
+    },
+  };
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}