@usebetterdev/plugin 0.5.0-beta.1

package/dist/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type {\n  HookContract,\n  HookHandlers,\n  PluginContext,\n  FieldType,\n  PluginFieldDefinition,\n  PluginTableDefinition,\n  PluginSchema,\n  HttpMethod,\n  PluginRequestContext,\n  PluginResponse,\n  PluginEndpointHandler,\n  PluginEndpoint,\n  PluginDefinition,\n} from \"./types.js\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export type { HookContract, HookHandlers, PluginContext, FieldType, PluginFieldDefinition, PluginTableDefinition, PluginSchema, HttpMethod, PluginRequestContext, PluginResponse, PluginEndpointHandler, PluginEndpoint, PluginDefinition, } from "./types.js";
+//# 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,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,gBAAgB,GACjB,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types.d.ts

@@ -0,0 +1,93 @@
+/**
+ * A contract mapping hook names to their payload shapes.
+ * Products define this to declare what hooks are available.
+ *
+ * Example:
+ * ```ts
+ * type MyHooks = {
+ *   "tenant:created": { tenantId: string; name: string };
+ *   "tenant:deleted": { tenantId: string };
+ * };
+ * ```
+ */
+export type HookContract = Record<string, Record<string, unknown>>;
+/**
+ * Derives handler function signatures from a HookContract.
+ * Each key becomes a handler that receives the corresponding payload.
+ */
+export type HookHandlers<T extends HookContract> = {
+    [K in keyof T]: (payload: T[K]) => void | Promise<void>;
+};
+/**
+ * Runtime context passed to plugin init functions.
+ * Provides product identity, peer plugin awareness, and configuration.
+ */
+export interface PluginContext {
+    productId: string;
+    hasPlugin: (id: string) => boolean;
+    config: Record<string, unknown>;
+}
+/** Common database column types that plugins can declare. */
+export type FieldType = "string" | "number" | "boolean" | "date" | "json";
+/** A single column definition within a plugin table. */
+export interface PluginFieldDefinition {
+    type: FieldType;
+    required?: boolean;
+    unique?: boolean;
+    defaultValue?: string | number | boolean | null | (() => unknown);
+    references?: {
+        table: string;
+        field: string;
+        onDelete?: "cascade" | "restrict" | "set-null" | "no-action";
+    };
+    index?: boolean;
+}
+/** A single table definition declared by a plugin. Keyed by field name. */
+export interface PluginTableDefinition {
+    fields: Record<string, PluginFieldDefinition>;
+}
+/**
+ * Schema declaration for a plugin.
+ * `tables` declares new tables (keyed by table name).
+ * `extend` adds fields to existing product tables (keyed by table name, then field name).
+ */
+export interface PluginSchema {
+    tables?: Record<string, PluginTableDefinition>;
+    extend?: Record<string, Record<string, PluginFieldDefinition>>;
+}
+/** HTTP methods that plugin endpoints can handle. */
+export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+/** Incoming request context provided to endpoint handlers. */
+export interface PluginRequestContext {
+    request: Request;
+    params: Record<string, string>;
+    body: unknown;
+    hasPlugin: (id: string) => boolean;
+}
+/** Response shape returned by endpoint handlers. */
+export interface PluginResponse {
+    status: number;
+    body: unknown;
+}
+/** Handler function signature for plugin endpoints. */
+export type PluginEndpointHandler = (context: PluginRequestContext) => Promise<PluginResponse>;
+/** A single HTTP endpoint declared by a plugin. */
+export interface PluginEndpoint {
+    method: HttpMethod;
+    path: string;
+    handler: PluginEndpointHandler;
+}
+/**
+ * Full plugin definition. Generic over the hook contract so plugins
+ * get type-safe hook handlers when a product provides its contract.
+ */
+export interface PluginDefinition<THooks extends HookContract = HookContract> {
+    id: string;
+    init?: (context: PluginContext) => void | Promise<void>;
+    hooks?: Partial<HookHandlers<THooks>>;
+    schema?: PluginSchema;
+    endpoints?: PluginEndpoint[];
+    /** Type-level brand for inference. Not used at runtime. */
+    $Infer?: Record<string, unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,YAAY,IAAI;KAChD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CACxD,CAAC;AAMF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAMD,6DAA6D;AAC7D,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1E,wDAAwD;AACxD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC;IAClE,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,CAAC;KAC9D,CAAC;IACF,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,2EAA2E;AAC3E,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC;CAChE;AAMD,qDAAqD;AACrD,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAErE,8DAA8D;AAC9D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC;AAED,oDAAoD;AACpD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AAED,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAAG,CAClC,OAAO,EAAE,oBAAoB,KAC1B,OAAO,CAAC,cAAc,CAAC,CAAC;AAE7B,mDAAmD;AACnD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAMD;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAC/B,MAAM,SAAS,YAAY,GAAG,YAAY;IAE1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@usebetterdev/plugin",
+  "version": "0.5.0-beta.1",
+  "repository": "github:usebetter-dev/usebetter",
+  "bugs": "https://github.com/usebetter-dev/usebetter/issues",
+  "homepage": "https://github.com/usebetter-dev/usebetter#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": ["dist", "README.md"],
+  "scripts": {
+    "build": "tsup && tsc -p tsconfig.build.json",
+    "lint": "oxlint",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "tsup": "^8.3.5",
+    "typescript": "~5.7.2",
+    "vitest": "^2.1.6"
+  },
+  "engines": { "node": ">=22" }
+}