@lo1/sdk 0.2.0

package/dist/plugin.d.ts

@@ -0,0 +1,110 @@
+import type { ServiceConfig } from "./config/index";
+export interface Logger {
+    info(message: string, ...args: unknown[]): void;
+    warn(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+    debug(message: string, ...args: unknown[]): void;
+}
+export interface PluginContext {
+    workspaceDir: string;
+    workspaceName: string;
+    logger: Logger;
+}
+export type PluginFactory = (context: PluginContext) => Plugin | Promise<Plugin>;
+export interface Plugin {
+    /** Plugin identifier — matches service `type` in manifest. */
+    name: string;
+    /**
+     * Inspects all services of this plugin's type and returns
+     * compose service definitions for shared infrastructure.
+     * Called once with ALL services of this type — the plugin deduplicates internally.
+     */
+    contributeCompose?(input: ComposeInput): Promise<ComposeContribution>;
+    /**
+     * Creates infrastructure resources (tables, buckets, schemas)
+     * after the compose stack is healthy. Called once per service of this type.
+     */
+    provisionInfra?(input: ProvisionInput): Promise<ProvisionResult>;
+    /**
+     * Applies seed data to provisioned infrastructure.
+     * Called once per service of this type, after provisionInfra.
+     */
+    seedData?(input: SeedInput): Promise<SeedResult>;
+    /**
+     * Returns the container configuration for running a service.
+     * Only called for services in container/dev mode (not host process mode).
+     */
+    configureContainer?(input: ContainerInput): Promise<ContainerConfig>;
+    /**
+     * Sets up file watchers that trigger rebuilds/restarts.
+     * Returns an async iterable that yields restart signals. Optional.
+     */
+    watchForChanges?(input: WatchInput): AsyncIterable<RestartSignal>;
+}
+export interface ComposeInput {
+    services: Record<string, ServiceConfig>;
+    workspaceDir: string;
+}
+export interface ComposeServiceDef {
+    image: string;
+    ports?: string[];
+    environment?: Record<string, string>;
+    volumes?: string[];
+    command?: string[];
+    healthcheck?: {
+        test: string[];
+        interval?: string;
+        timeout?: string;
+        retries?: number;
+        start_period?: string;
+    };
+    depends_on?: Record<string, {
+        condition: string;
+    }>;
+}
+export interface ComposeContribution {
+    services: Record<string, ComposeServiceDef>;
+    envVars: Record<string, string>;
+}
+export interface ProvisionInput {
+    serviceName: string;
+    servicePath: string;
+    endpoints: Record<string, string>;
+}
+export interface ProvisionResult {
+    created: string[];
+    skipped: string[];
+}
+export interface SeedInput {
+    serviceName: string;
+    servicePath: string;
+    mode: "run" | "test";
+    endpoints: Record<string, string>;
+}
+export interface SeedResult {
+    applied: string[];
+}
+export interface ContainerInput {
+    serviceName: string;
+    servicePath: string;
+    servicePort: string;
+    mode: "dev" | "container";
+    networkName: string;
+    endpoints: Record<string, string>;
+}
+export interface ContainerConfig {
+    image: string;
+    cmd: string[];
+    envVars: Record<string, string>;
+    binds: string[];
+    workingDir: string;
+}
+export interface WatchInput {
+    serviceName: string;
+    servicePath: string;
+}
+export interface RestartSignal {
+    reason: string;
+    changedFiles?: string[];
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAChD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACjD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAEjF,MAAM,WAAW,MAAM;IACrB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEtE;;;OAGG;IACH,cAAc,CAAC,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjE;;;OAGG;IACH,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEjD;;;OAGG;IACH,kBAAkB,CAAC,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAErE;;;OAGG;IACH,eAAe,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;CACnE;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,KAAK,GAAG,WAAW,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB"}

package/dist/schema/generate.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generate.d.ts.map

package/dist/schema/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/schema/generate.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@lo1/sdk",
+  "version": "0.2.0",
+  "description": "Plugin SDK for lo1 — types, config schemas, and utilities for plugin authors",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./schemas/lo1.v1.schema.json": "./schemas/lo1.v1.schema.json"
+  },
+  "files": [
+    "dist",
+    "schemas"
+  ],
+  "scripts": {
+    "build": "bun run build:ts && bun run build:schema",
+    "build:ts": "bun build ./src/index.ts --outdir ./dist --target node && tsc --emitDeclarationOnly --outDir ./dist",
+    "build:schema": "bun run ./src/schema/generate.ts",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "bun test"
+  },
+  "dependencies": {
+    "zod": "^3.23.0"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "zod-to-json-schema": "^3.23.0",
+    "ajv": "^8.17.0",
+    "ajv-formats": "^3.0.0"
+  }
+}

package/schemas/lo1.v1.schema.json

@@ -0,0 +1,224 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://lo1.dev/schemas/lo1.v1.schema.json",
+  "$ref": "#/definitions/lo1.v1",
+  "definitions": {
+    "lo1.v1": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string",
+          "const": "1"
+        },
+        "name": {
+          "type": "string"
+        },
+        "plugins": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "repositories": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "url": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string"
+              },
+              "branch": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "url",
+              "path"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "proxy": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "port": {
+              "type": "number",
+              "default": 80
+            },
+            "tld": {
+              "type": "string",
+              "default": "local"
+            },
+            "tls": {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "port": {
+                  "type": "number",
+                  "default": 443
+                },
+                "certDir": {
+                  "type": "string",
+                  "default": ".lo1/certs"
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
+        "services": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string"
+              },
+              "port": {
+                "type": "number"
+              },
+              "hostPort": {
+                "type": "number"
+              },
+              "mode": {
+                "type": "string",
+                "enum": [
+                  "dev",
+                  "container",
+                  "skip"
+                ],
+                "default": "dev"
+              },
+              "command": {
+                "type": "string"
+              },
+              "containerImage": {
+                "type": "string"
+              },
+              "plugin": {
+                "type": "object",
+                "additionalProperties": {}
+              },
+              "compose": {
+                "type": "string"
+              },
+              "env": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "proxy": {
+                "type": "object",
+                "properties": {
+                  "domain": {
+                    "type": "string"
+                  },
+                  "pathPrefix": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false
+              },
+              "hooks": {
+                "type": "object",
+                "properties": {
+                  "preStart": {
+                    "type": "string"
+                  },
+                  "postStart": {
+                    "type": "string"
+                  },
+                  "preStop": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false
+              },
+              "dependsOn": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "default": []
+              },
+              "initTask": {
+                "type": "boolean",
+                "default": false
+              },
+              "readinessProbe": {
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "required": [
+              "type",
+              "path"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "extraCompose": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "file": {
+                  "type": "string"
+                },
+                "initTaskServices": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "required": [
+                "file"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "hooks": {
+          "type": "object",
+          "properties": {
+            "postInfrastructure": {
+              "type": "string"
+            },
+            "postSetup": {
+              "type": "string"
+            },
+            "preStop": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "version",
+        "name",
+        "services"
+      ],
+      "additionalProperties": false
+    }
+  }
+}