@executor-js/sdk 0.1.0 → 0.2.1

package/README.md

@@ -83,35 +83,27 @@ interface MemorySecretsConfig {
 
 // definePlugin takes a factory and returns a configured-plugin function
 // that the consumer calls with options.
-export const memorySecretsPlugin = definePlugin(
-  (options?: MemorySecretsConfig) => {
-    const map = new Map<string, string>(
-      Object.entries(options?.initial ?? {}),
-    );
-    const provider: SecretProvider = {
-      key: "memory",
-      writable: true,
-      get: (id: string) => Effect.sync(() => map.get(id) ?? null),
-      has: (id: string) => Effect.sync(() => map.has(id)),
-      set: (id: string, value: string) =>
-        Effect.sync(() => void map.set(id, value)),
-      delete: (id: string) => Effect.sync(() => map.delete(id)),
-      list: () =>
-        Effect.sync(() =>
-          Array.from(map.keys()).map((k) => ({ id: k, name: k })),
-        ),
-    };
-
-    return {
-      id: "memorySecrets" as const,
-      storage: () => ({}),
-      extension: () => ({
-        label: "in-memory secrets",
-      }),
-      secretProviders: () => [provider],
-    };
-  },
-);
+export const memorySecretsPlugin = definePlugin((options?: MemorySecretsConfig) => {
+  const map = new Map<string, string>(Object.entries(options?.initial ?? {}));
+  const provider: SecretProvider = {
+    key: "memory",
+    writable: true,
+    get: (id: string) => Effect.sync(() => map.get(id) ?? null),
+    has: (id: string) => Effect.sync(() => map.has(id)),
+    set: (id: string, value: string) => Effect.sync(() => void map.set(id, value)),
+    delete: (id: string) => Effect.sync(() => map.delete(id)),
+    list: () => Effect.sync(() => Array.from(map.keys()).map((k) => ({ id: k, name: k }))),
+  };
+
+  return {
+    id: "memorySecrets" as const,
+    storage: () => ({}),
+    extension: () => ({
+      label: "in-memory secrets",
+    }),
+    secretProviders: () => [provider],
+  };
+});
 
 // End users compose the executor exactly the same way as above —
 // the plugin's extension is reachable as `executor.memorySecrets`.

package/dist/api-errors.d.ts

@@ -0,0 +1,10 @@
+import { Schema } from "effect";
+declare const InternalError_base: Schema.Class<InternalError, Schema.TaggedStruct<"InternalError", {
+    /** Opaque correlation id for backend lookup (Sentry event id, log line, etc.). */
+    readonly traceId: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/** Public 500 surface. Opaque by schema — only `traceId` crosses the wire. */
+export declare class InternalError extends InternalError_base {
+}
+export {};
+//# sourceMappingURL=api-errors.d.ts.map

package/dist/api-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-errors.d.ts","sourceRoot":"","sources":["../src/api-errors.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;;IAM5B,kFAAkF;;;AAJtF,8EAA8E;AAC9E,qBAAa,aAAc,SAAQ,kBAOlC;CAAG"}

package/dist/blob.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,KACR,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,CAAC;IAChD;;;;4BAIwB;IACxB,QAAQ,CAAC,OAAO,EAAE,CAChB,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,GAAG,EAAE,MAAM,KACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC;IAC9D,QAAQ,CAAC,GAAG,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,KACV,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,CACf,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,KACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,QAAQ,CAAC,GAAG,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,KACR,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,eAAe;IAC9B;oCACgC;IAChC,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1E;+CAC2C;IAC3C,QAAQ,CAAC,GAAG,EAAE,CACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAChC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,CACf,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAChC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,+EAA+E;IAC/E,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;CACrE;AAmBD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,SAAS,EAChB,QAAQ,SAAS,MAAM,EAAE,EACzB,UAAU,MAAM,KACf,eA2BD,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,QAAO,SAwBxC,CAAC"}
+{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,CAAC;IAC7F;;;;4BAIwB;IACxB,QAAQ,CAAC,OAAO,EAAE,CAChB,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,GAAG,EAAE,MAAM,KACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC;IAC9D,QAAQ,CAAC,GAAG,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,KACV,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvF,QAAQ,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;CACxF;AAED,MAAM,WAAW,eAAe;IAC9B;oCACgC;IAChC,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1E;+CAC2C;IAC3C,QAAQ,CAAC,GAAG,EAAE,CACZ,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAChC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,CACf,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAChC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACvC,+EAA+E;IAC/E,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;CACrE;AAgBD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,SAAS,EAChB,QAAQ,SAAS,MAAM,EAAE,EACzB,UAAU,MAAM,KACf,eA2BD,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,QAAO,SAwBxC,CAAC"}

package/dist/chunk-6SQWMOM4.js

@@ -0,0 +1,51 @@
+// src/secret-backed-value.ts
+import { Effect, Schema } from "effect";
+var SecretBackedValue = Schema.Union([
+  Schema.String,
+  Schema.Struct({
+    secretId: Schema.String,
+    prefix: Schema.optional(Schema.String)
+  })
+]);
+var SecretBackedMap = Schema.Record(Schema.String, SecretBackedValue);
+var isSecretBackedRef = (value) => typeof value !== "string";
+var resolveSecretBackedMap = ({
+  values,
+  getSecret,
+  onMissing,
+  onError,
+  missing = "fail"
+}) => {
+  const entries = Object.entries(values ?? {});
+  if (entries.length === 0) return Effect.succeed(void 0);
+  return Effect.gen(function* () {
+    const resolved = {};
+    for (const [name, value] of entries) {
+      if (typeof value === "string") {
+        resolved[name] = value;
+        continue;
+      }
+      const secret = yield* getSecret(value.secretId).pipe(
+        Effect.mapError((error) => onError?.(error, name, value) ?? error)
+      );
+      if (secret === null) {
+        if (missing === "drop") continue;
+        return yield* Effect.fail(onMissing(name, value));
+      }
+      resolved[name] = value.prefix ? `${value.prefix}${secret}` : secret;
+    }
+    return Object.keys(resolved).length > 0 ? resolved : void 0;
+  });
+};
+
+// src/config.ts
+var defineExecutorConfig = (config) => config;
+
+export {
+  SecretBackedValue,
+  SecretBackedMap,
+  isSecretBackedRef,
+  resolveSecretBackedMap,
+  defineExecutorConfig
+};
+//# sourceMappingURL=chunk-6SQWMOM4.js.map

package/dist/chunk-6SQWMOM4.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/secret-backed-value.ts","../src/config.ts"],"sourcesContent":["import { Effect, Schema } from \"effect\";\n\nexport const SecretBackedValue = Schema.Union([\n  Schema.String,\n  Schema.Struct({\n    secretId: Schema.String,\n    prefix: Schema.optional(Schema.String),\n  }),\n]);\nexport type SecretBackedValue = typeof SecretBackedValue.Type;\n\nexport const SecretBackedMap = Schema.Record(Schema.String, SecretBackedValue);\nexport type SecretBackedMap = typeof SecretBackedMap.Type;\n\nexport const isSecretBackedRef = (\n  value: SecretBackedValue,\n): value is Extract<SecretBackedValue, { readonly secretId: string }> => typeof value !== \"string\";\n\nexport type ResolveSecretBackedMapOptions<E, E2> = {\n  readonly values: Record<string, SecretBackedValue> | undefined;\n  readonly getSecret: (secretId: string) => Effect.Effect<string | null, E>;\n  readonly onMissing: (\n    name: string,\n    value: Extract<SecretBackedValue, { readonly secretId: string }>,\n  ) => E2;\n  readonly onError?: (\n    error: E,\n    name: string,\n    value: Extract<SecretBackedValue, { readonly secretId: string }>,\n  ) => E | E2;\n  readonly missing?: \"fail\" | \"drop\";\n};\n\nexport const resolveSecretBackedMap = <E, E2 = E>({\n  values,\n  getSecret,\n  onMissing,\n  onError,\n  missing = \"fail\",\n}: ResolveSecretBackedMapOptions<E, E2>): Effect.Effect<\n  Record<string, string> | undefined,\n  E | E2\n> => {\n  const entries = Object.entries(values ?? {});\n  if (entries.length === 0) return Effect.succeed(undefined);\n\n  return Effect.gen(function* () {\n    const resolved: Record<string, string> = {};\n\n    for (const [name, value] of entries) {\n      if (typeof value === \"string\") {\n        resolved[name] = value;\n        continue;\n      }\n\n      const secret = yield* getSecret(value.secretId).pipe(\n        Effect.mapError((error) => onError?.(error, name, value) ?? error),\n      );\n      if (secret === null) {\n        if (missing === \"drop\") continue;\n        return yield* Effect.fail(onMissing(name, value));\n      }\n\n      resolved[name] = value.prefix ? `${value.prefix}${secret}` : secret;\n    }\n\n    return Object.keys(resolved).length > 0 ? resolved : undefined;\n  });\n};\n","// ---------------------------------------------------------------------------\n// defineExecutorConfig — typed config declaration consumed by both the\n// schema-gen CLI and the host runtime. Single source of truth for the\n// plugin list. First-party and third-party plugins go through the same\n// `bun add @executor-js/plugin-foo` + import-and-call flow.\n//\n// `plugins` is always a factory `(deps?) => readonly AnyPlugin[]`. Some\n// plugins want runtime values from the host (e.g., the openapi plugin's\n// `configFile` sink, which is keyed to the active scope cwd and so can't\n// be constructed at module-eval time). Deps are optional — the\n// schema-gen CLI and Vite plugin call `plugins()` with no args (they\n// read `plugin.schema` / `plugin.packageName` only); runtime callers\n// pass concrete deps.\n//\n// Each app declares its own deps shape inline on the factory parameter\n// — TS infers `TDeps` from there, so apps don't reach into the SDK's\n// types via `declare module`.\n// ---------------------------------------------------------------------------\n\nimport type { AnyPlugin } from \"./plugin\";\n\nexport type ExecutorDialect = \"pg\" | \"sqlite\" | \"mysql\";\n\nexport type ExecutorPluginsFactory<\n  TDeps extends object = object,\n  TPlugins extends readonly AnyPlugin[] = readonly AnyPlugin[],\n> = (deps?: TDeps) => TPlugins;\n\nexport interface ExecutorCliConfig<\n  TDeps extends object = object,\n  TPlugins extends readonly AnyPlugin[] = readonly AnyPlugin[],\n> {\n  readonly dialect: ExecutorDialect;\n  readonly plugins: ExecutorPluginsFactory<TDeps, TPlugins>;\n}\n\n/**\n * Declare an executor config. The CLI imports this file via jiti and\n * reads `plugins` + `dialect` to generate the drizzle schema; the host\n * runtime imports the same file to instantiate plugins. Plugin runtime\n * credentials passed to the factory may be stubs from the CLI — only\n * `plugin.schema` is read there.\n *\n * The `const TPlugins` modifier preserves the tuple-literal inference\n * from the factory's return so per-plugin extension typing flows through\n * (`ReturnType<typeof config.plugins>` keeps `[OpenApi, Mcp, ...]`).\n *\n * `TDeps` is inferred from the factory's parameter — apps annotate\n * the destructure (e.g., `({ configFile }: { configFile?: ConfigFileSink })`)\n * directly. No global module augmentation needed.\n */\nexport const defineExecutorConfig = <\n  TDeps extends object,\n  const TPlugins extends readonly AnyPlugin[],\n>(\n  config: ExecutorCliConfig<TDeps, TPlugins>,\n): ExecutorCliConfig<TDeps, TPlugins> => config;\n"],"mappings":";AAAA,SAAS,QAAQ,cAAc;AAExB,IAAM,oBAAoB,OAAO,MAAM;AAAA,EAC5C,OAAO;AAAA,EACP,OAAO,OAAO;AAAA,IACZ,UAAU,OAAO;AAAA,IACjB,QAAQ,OAAO,SAAS,OAAO,MAAM;AAAA,EACvC,CAAC;AACH,CAAC;AAGM,IAAM,kBAAkB,OAAO,OAAO,OAAO,QAAQ,iBAAiB;AAGtE,IAAM,oBAAoB,CAC/B,UACuE,OAAO,UAAU;AAiBnF,IAAM,yBAAyB,CAAY;AAAA,EAChD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,UAAU;AACZ,MAGK;AACH,QAAM,UAAU,OAAO,QAAQ,UAAU,CAAC,CAAC;AAC3C,MAAI,QAAQ,WAAW,EAAG,QAAO,OAAO,QAAQ,MAAS;AAEzD,SAAO,OAAO,IAAI,aAAa;AAC7B,UAAM,WAAmC,CAAC;AAE1C,eAAW,CAAC,MAAM,KAAK,KAAK,SAAS;AACnC,UAAI,OAAO,UAAU,UAAU;AAC7B,iBAAS,IAAI,IAAI;AACjB;AAAA,MACF;AAEA,YAAM,SAAS,OAAO,UAAU,MAAM,QAAQ,EAAE;AAAA,QAC9C,OAAO,SAAS,CAAC,UAAU,UAAU,OAAO,MAAM,KAAK,KAAK,KAAK;AAAA,MACnE;AACA,UAAI,WAAW,MAAM;AACnB,YAAI,YAAY,OAAQ;AACxB,eAAO,OAAO,OAAO,KAAK,UAAU,MAAM,KAAK,CAAC;AAAA,MAClD;AAEA,eAAS,IAAI,IAAI,MAAM,SAAS,GAAG,MAAM,MAAM,GAAG,MAAM,KAAK;AAAA,IAC/D;AAEA,WAAO,OAAO,KAAK,QAAQ,EAAE,SAAS,IAAI,WAAW;AAAA,EACvD,CAAC;AACH;;;ACjBO,IAAM,uBAAuB,CAIlC,WACuC;","names":[]}