npm - @builder-builder/builder - Versions diffs - 0.0.21 → 0.0.22 - Mend

@builder-builder/builder 0.0.21 → 0.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -1,38 +1,47 @@
-# sv
+# Builder Builder
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+## Setup
-## Creating a project
+```bash
+npm install
+supabase start
+npm run dev
+```
-If you're seeing this, you've probably already done this step. Congrats!
+## Deployment environments
-```bash
-# create a new project in the current directory
-npx sv create
+Where BB runs and which backing services it talks to.
-# create a new project in my-app
-npx sv create my-app
-```
+| Deployment        | Clerk instance   | Supabase instance       |
+| ----------------- | ---------------- | ----------------------- |
+| local dev         | Clerk test       | local supabase (docker) |
+| Vercel production | Clerk production | Supabase cloud project  |
-## Developing
+## Builder environments
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Every entity carries an `environment` of `development`, `staging`, or `production`. Same database, different rows. `development` rows are mutable; `staging` and `production` are immutable snapshots written when promoting from `development`.
-```bash
-npm run dev
+## API key scoping
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
+Each API key is minted in `/settings` with three properties:
-## Building
+| Property            | What it controls                                                                                                                                                                                                                                                                                                  |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Environment**     | Which dataset the key reads from: `development`, `staging`, or `production`.                                                                                                                                                                                                                                      |
+| **Profile**         | What the key can do. `read` keys can fetch; `readWrite` keys can also write variants.                                                                                                                                                                                                                             |
+| **Allowed origins** | Origin patterns (e.g. `https://*.example.com`) the key may be used from. Set this for browser keys; leave empty for server-to-server keys. The two modes are exclusive — a key with allowed origins requires an Origin header that matches, and a key without them rejects any request that has an Origin header. |
-To create a production version of your app:
+Keys are scoped to the org they were minted in and never see other orgs' data.
-```bash
-npm run build
-```
+| Environment   | `GET /api/builder/[id]` returns | `GET /api/builder/[id]/variants` returns |
+| ------------- | ------------------------------- | ---------------------------------------- |
+| `development` | live editable entity            | live editable variants                   |
+| `staging`     | staging snapshot                | staging snapshot variants                |
+| `production`  | production snapshot             | production snapshot variants             |
-You can preview the production build with `npm run preview`.
+## Scripts
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+- `npm run verify` — tests, check, format, lint.
+- `npm run test:integration:local` — integration tests against local Supabase.
+- `npm run db:types:local` — regenerate `database.types.ts` from local schema.
+- `npm run db:reset` — wipe local Supabase, re-diff migrations, regenerate types.

package/dist/client/client.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import type { BuilderBuilderClientOptions, BuilderBuilderGetResponse } from './schema.js';
+export type BuilderBuilderClient = {
+    builder: {
+        get(id: string): Promise<BuilderBuilderGetResponse>;
+    };
+};
+export declare function client(options: BuilderBuilderClientOptions): BuilderBuilderClient;

package/dist/client/client.js ADDED Viewed

@@ -0,0 +1,19 @@
+import * as v from 'valibot';
+import { BuilderException } from '../errors/index.js';
+import { BuilderBuilderClientOptionsSchema, BuilderBuilderGetResponseSchema } from './schema.js';
+export function client(options) {
+    const { url, apiKey } = v.parse(BuilderBuilderClientOptionsSchema, options);
+    return {
+        builder: {
+            get: async (id) => {
+                const response = await fetch(`${url}/api/builder/${id}`, {
+                    headers: { 'X-Builder-Builder-Key': apiKey }
+                });
+                if (!response.ok) {
+                    throw new BuilderException([]);
+                }
+                return v.parse(BuilderBuilderGetResponseSchema, await response.json());
+            }
+        }
+    };
+}

package/dist/client/index.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+export type { BuilderBuilderClientOptions, BuilderBuilderGetResponse } from './schema.js';
+export type { BuilderBuilderClient } from './client.js';
+export { BuilderBuilderClientOptionsSchema, BuilderBuilderGetResponseSchema } from './schema.js';
+export { client } from './client.js';

package/dist/client/index.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export { BuilderBuilderClientOptionsSchema, BuilderBuilderGetResponseSchema } from './schema.js';
2	+ export { client } from './client.js';

package/dist/client/schema.d.ts ADDED Viewed

@@ -0,0 +1,396 @@
+import * as v from 'valibot';
+export declare const BuilderBuilderClientOptionsSchema: v.ObjectSchema<{
+    readonly url: v.StringSchema<undefined>;
+    readonly apiKey: v.StringSchema<undefined>;
+}, undefined>;
+export type BuilderBuilderClientOptions = v.InferOutput<typeof BuilderBuilderClientOptionsSchema>;
+export declare const BuilderBuilderGetResponseSchema: v.ObjectSchema<{
+    readonly name: v.StringSchema<undefined>;
+    readonly serialised: v.GenericSchema<import("../index.js").BuilderSerialised>;
+    readonly references: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly serialised: v.GenericSchema<string | number | boolean | readonly (string | number)[] | readonly (readonly (string | number)[])[] | import("../index.js").BuilderSerialised | import("../index.js").BuilderModelSerialised | Readonly<{
+            type: "select";
+            readonly options: readonly [string, ...string[]];
+            defaultValue: string | null;
+            isOptional: boolean;
+            optionLabels: {
+                [x: string]: string;
+            };
+            tags?: readonly string[] | undefined;
+        }> | Readonly<{
+            type: "toggle";
+            valueType: "string" | "number" | "boolean";
+            defaultValue: string | number | boolean | null;
+            isOptional: boolean;
+            tags?: readonly string[] | undefined;
+        }> | import("../index.js").BuilderMatchSelectMap<Readonly<{
+            type: "parameter";
+            id: string;
+            name: string;
+        }> | Readonly<Readonly<{
+            type: "select";
+            readonly options: readonly [string, ...string[]];
+            defaultValue: string | null;
+            isOptional: boolean;
+            optionLabels: {
+                [x: string]: string;
+            };
+            tags?: readonly string[] | undefined;
+        }>> | Readonly<Readonly<{
+            type: "toggle";
+            valueType: "string" | "number" | "boolean";
+            defaultValue: string | number | boolean | null;
+            isOptional: boolean;
+            tags?: readonly string[] | undefined;
+        }>>> | import("../index.js").BuilderWhenSerialised<Readonly<Readonly<{
+            type: "select";
+            readonly options: readonly [string, ...string[]];
+            defaultValue: string | null;
+            isOptional: boolean;
+            optionLabels: {
+                [x: string]: string;
+            };
+            tags?: readonly string[] | undefined;
+        }>> | Readonly<Readonly<{
+            type: "toggle";
+            valueType: "string" | "number" | "boolean";
+            defaultValue: string | number | boolean | null;
+            isOptional: boolean;
+            tags?: readonly string[] | undefined;
+        }>>> | Readonly<{
+            fields: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | readonly Readonly<{
+                type: "component-field";
+                name: string;
+                valueType: "string" | "number" | "boolean";
+                isOptional: boolean;
+                tags?: readonly string[] | undefined;
+            }>[];
+            tags?: readonly string[] | undefined;
+        }> | import("../index.js").BuilderMatchSelectMap<Readonly<{
+            type: "parameter";
+            id: string;
+            name: string;
+        }> | Readonly<{
+            fields: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | readonly Readonly<{
+                type: "component-field";
+                name: string;
+                valueType: "string" | "number" | "boolean";
+                isOptional: boolean;
+                tags?: readonly string[] | undefined;
+            }>[];
+            tags?: readonly string[] | undefined;
+        }>> | import("../index.js").BuilderWhenSerialised<Readonly<{
+            fields: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | readonly Readonly<{
+                type: "component-field";
+                name: string;
+                valueType: "string" | "number" | "boolean";
+                isOptional: boolean;
+                tags?: readonly string[] | undefined;
+            }>[];
+            tags?: readonly string[] | undefined;
+        }>> | Readonly<{
+            model: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | import("../index.js").BuilderModelSerialised;
+            min: number | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            max: number | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            tags?: readonly string[] | undefined;
+        }> | import("../index.js").BuilderMatchSelectMap<Readonly<{
+            type: "parameter";
+            id: string;
+            name: string;
+        }> | Readonly<{
+            model: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | import("../index.js").BuilderModelSerialised;
+            min: number | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            max: number | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            tags?: readonly string[] | undefined;
+        }>> | import("../index.js").BuilderWhenSerialised<Readonly<{
+            model: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | import("../index.js").BuilderModelSerialised;
+            min: number | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            max: number | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            tags?: readonly string[] | undefined;
+        }>> | import("../index.js").BuilderUISerialised | Readonly<{
+            type: "input";
+            path: readonly (string | number)[] | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            displayName?: string | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | undefined;
+            kind?: string | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | undefined;
+            metadata?: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | Readonly<{
+                [x: string]: unknown;
+            }> | undefined;
+            tags?: readonly string[] | undefined;
+        }> | Readonly<{
+            type: "page";
+            label: string | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            inputs: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | readonly (Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | Readonly<{
+                type: "input";
+                path: readonly (string | number)[] | Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }>;
+                displayName?: string | Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }> | undefined;
+                kind?: string | Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }> | undefined;
+                metadata?: Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }> | Readonly<{
+                    [x: string]: unknown;
+                }> | undefined;
+                tags?: readonly string[] | undefined;
+            }>)[];
+            tags?: readonly string[] | undefined;
+        }> | Readonly<{
+            type: "describe";
+            label: string | Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }>;
+            inputs: Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | readonly (Readonly<{
+                type: "parameter";
+                id: string;
+                name: string;
+            }> | Readonly<{
+                type: "ref";
+                id: string;
+            }> | Readonly<{
+                type: "input";
+                path: readonly (string | number)[] | Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }>;
+                displayName?: string | Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }> | undefined;
+                kind?: string | Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }> | undefined;
+                metadata?: Readonly<{
+                    type: "parameter";
+                    id: string;
+                    name: string;
+                }> | Readonly<{
+                    type: "ref";
+                    id: string;
+                }> | Readonly<{
+                    [x: string]: unknown;
+                }> | undefined;
+                tags?: readonly string[] | undefined;
+            }>)[];
+            tags?: readonly string[] | undefined;
+        }> | import("../index.js").BuilderUIPagesSerialised | readonly (Readonly<{
+            type: "parameter";
+            id: string;
+            name: string;
+        }> | Readonly<{
+            type: "ref";
+            id: string;
+        }> | import("../entities/index.js").BuilderUIItemSerialised)[] | import("../index.js").BuilderPricingSerialised | import("../entities/index.js").BuilderRates | readonly Readonly<{
+            name: string;
+            kind: "option" | "component" | "collection";
+        }>[]>;
+    }, undefined>, undefined>;
+    readonly variants: v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly instance: v.GenericSchema<import("../instance.js").BuilderInstance>;
+        readonly details: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.NullableSchema<v.UnionSchema<[v.StringSchema<undefined>, v.BooleanSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, undefined>, undefined>;
+        readonly tags: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.StringSchema<undefined>, undefined>, v.ReadonlyAction<string[]>]>, undefined>;
+    }, undefined>, v.ReadonlyAction<{
+        instance: import("../instance.js").BuilderInstance;
+        details?: {
+            [x: string]: string | number | boolean | null;
+        } | undefined;
+        tags?: readonly string[] | undefined;
+    }>]>, undefined>, v.ReadonlyAction<Readonly<{
+        instance: import("../instance.js").BuilderInstance;
+        details?: {
+            [x: string]: string | number | boolean | null;
+        } | undefined;
+        tags?: readonly string[] | undefined;
+    }>[]>]>, undefined>, v.ReadonlyAction<{
+        readonly [x: string]: readonly Readonly<{
+            instance: import("../instance.js").BuilderInstance;
+            details?: {
+                [x: string]: string | number | boolean | null;
+            } | undefined;
+            tags?: readonly string[] | undefined;
+        }>[];
+    }>]>;
+}, undefined>;
+export type BuilderBuilderGetResponse = v.InferOutput<typeof BuilderBuilderGetResponseSchema>;

package/dist/client/schema.js ADDED Viewed

@@ -0,0 +1,13 @@
+import * as v from 'valibot';
+import { BuilderReferencesSchema, BuilderSerialisedSchema } from '../entities/index.js';
+import { BuilderVariantsSchema } from '../instance.js';
+export const BuilderBuilderClientOptionsSchema = v.object({
+    url: v.string(),
+    apiKey: v.string()
+});
+export const BuilderBuilderGetResponseSchema = v.object({
+    name: v.string(),
+    serialised: BuilderSerialisedSchema,
+    references: BuilderReferencesSchema,
+    variants: BuilderVariantsSchema
+});

package/package.json CHANGED Viewed

@@ -1,11 +1,18 @@
 {
   "name": "@builder-builder/builder",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "default": "./dist/client/index.js"
     }
   },
   "files": [
@@ -18,9 +25,9 @@
   },
   "scripts": {
     "dev": "vite dev",
-    "predev": "npm run types:db",
+    "predev": "npm run db:types:local",
     "dev:v": "NO_UPDATE_NOTIFIER=false VERCEL_ENV=development vercel dev",
-    "build": "vite build",
+    "build": "NODE_ENV=production vite build",
     "package": "svelte-kit sync && svelte-package --input src/lib/builder",
     "preview": "vite preview",
     "prepare": "svelte-kit sync && npm run messages || echo ''",
@@ -32,10 +39,10 @@
     "lint": "prettier --check . && eslint .",
     "test": "npm run test:unit -- --run",
     "test:unit": "npm run messages && vitest --project client --project server",
-    "test:integration": "npm run messages && vitest run --project integration",
+    "test:integration:local": "npm run messages && dotenv -e .env.development.local -- vitest run --project integration",
     "verify": "npm run test && npm run check && npm run lint",
-    "db:types": "dotenv -e .env -- sh -c 'supabase gen types typescript --project-id \"$SUPABASE_DEV_PROJECT_ID\" --schema public > ./src/lib/db/database.types.ts'",
-    "db:types:local": "supabase gen types typescript --local > ./src/lib/db/database.types.ts",
+    "db:types": "dotenv -e .env -- sh -c 'supabase gen types typescript --project-id \"$SUPABASE_DEV_PROJECT_ID\" --schema public > ./src/lib/server/db/database.types.ts'",
+    "db:types:local": "supabase gen types typescript --local > ./src/lib/server/db/database.types.ts",
     "db:reset": "rm -f supabase/migrations/*_initial.sql && supabase db diff --use-pg-delta -f initial && supabase db reset && npm run db:types:local"
   },
   "devDependencies": {