@superpanel-sdk/runtime 0.2.3 → 0.5.0

package/dist/core/context/kv.d.ts

@@ -0,0 +1,113 @@
+import { z } from 'zod';
+export declare const KV_KEY_MAX = 512;
+export declare const KV_VALUE_MAX = 65536;
+export declare const KV_TTL_SECONDS_MAX: number;
+/**
+ * Who shares a key. `environment` (the default): one namespace per company and environment.
+ * `company`: one namespace per company, shared by every environment and sequence.
+ *
+ * Use `company` only for state that must be single per company although several environments point
+ * at the same third-party account — a vendor session token shared by sandbox and prod, an id-mapping
+ * table for a CRM that has no sandbox. It deliberately punches through environment isolation, so a
+ * sandbox run can overwrite what prod reads; keep vendor identity in the key (e.g. a hash of the
+ * client id) so two environments with different credentials never share a cached token.
+ */
+export declare const KV_SCOPES: readonly ['environment', 'company'];
+export declare const kvScope: z.ZodEnum<{
+    company: "company";
+    environment: "environment";
+}>;
+export type KvScope = z.infer<typeof kvScope>;
+export declare const kvGetInput: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodEnum<{
+        company: "company";
+        environment: "environment";
+    }>>;
+    key: z.ZodString;
+}, z.core.$strip>;
+export type KvGetInput = z.infer<typeof kvGetInput>;
+export declare const kvGetOutput: z.ZodObject<{
+    value: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type KvGetOutput = z.infer<typeof kvGetOutput>;
+export declare const kvSetInput: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodEnum<{
+        company: "company";
+        environment: "environment";
+    }>>;
+    key: z.ZodString;
+    value: z.ZodString;
+    ttlSeconds: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type KvSetInput = z.infer<typeof kvSetInput>;
+export declare const kvSetOutput: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+}, z.core.$strip>;
+export type KvSetOutput = z.infer<typeof kvSetOutput>;
+export declare const kvDelInput: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodEnum<{
+        company: "company";
+        environment: "environment";
+    }>>;
+    key: z.ZodString;
+}, z.core.$strip>;
+export type KvDelInput = z.infer<typeof kvDelInput>;
+export declare const kvDelOutput: z.ZodObject<{
+    deleted: z.ZodBoolean;
+}, z.core.$strip>;
+export type KvDelOutput = z.infer<typeof kvDelOutput>;
+/**
+ * Platform KV for script state, reached as `ctx.api.kv`: strings by key, with an optional TTL.
+ * Technical state only (a vendor token, a sync cursor, a webhook event already handled); business
+ * facts belong in the sequence's tables, where the page, the AI and the Orchestrator see them.
+ */
+export type KvApi = {
+    get(input: KvGetInput): Promise<KvGetOutput>;
+    set(input: KvSetInput): Promise<KvSetOutput>;
+    del(input: KvDelInput): Promise<KvDelOutput>;
+};
+export declare const kvMockService: KvApi;
+export declare const kvSurface: {
+    methods: {
+        get: {
+            input: z.ZodObject<{
+                scope: z.ZodOptional<z.ZodEnum<{
+                    company: "company";
+                    environment: "environment";
+                }>>;
+                key: z.ZodString;
+            }, z.core.$strip>;
+            output: z.ZodObject<{
+                value: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        };
+        set: {
+            input: z.ZodObject<{
+                scope: z.ZodOptional<z.ZodEnum<{
+                    company: "company";
+                    environment: "environment";
+                }>>;
+                key: z.ZodString;
+                value: z.ZodString;
+                ttlSeconds: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strip>;
+            output: z.ZodObject<{
+                ok: z.ZodLiteral<true>;
+            }, z.core.$strip>;
+        };
+        del: {
+            input: z.ZodObject<{
+                scope: z.ZodOptional<z.ZodEnum<{
+                    company: "company";
+                    environment: "environment";
+                }>>;
+                key: z.ZodString;
+            }, z.core.$strip>;
+            output: z.ZodObject<{
+                deleted: z.ZodBoolean;
+            }, z.core.$strip>;
+        };
+    };
+    mock: KvApi;
+};
+//# sourceMappingURL=kv.d.ts.map

package/dist/core/context/kv.js

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+export const KV_KEY_MAX = 512;
+export const KV_VALUE_MAX = 65_536;
+export const KV_TTL_SECONDS_MAX = 60 * 60 * 24 * 365 * 5;
+/**
+ * Who shares a key. `environment` (the default): one namespace per company and environment.
+ * `company`: one namespace per company, shared by every environment and sequence.
+ *
+ * Use `company` only for state that must be single per company although several environments point
+ * at the same third-party account — a vendor session token shared by sandbox and prod, an id-mapping
+ * table for a CRM that has no sandbox. It deliberately punches through environment isolation, so a
+ * sandbox run can overwrite what prod reads; keep vendor identity in the key (e.g. a hash of the
+ * client id) so two environments with different credentials never share a cached token.
+ */
+export const KV_SCOPES = ['environment', 'company'];
+export const kvScope = z.enum(KV_SCOPES);
+const scoped = { scope: kvScope.optional() };
+export const kvGetInput = z.object({
+    key: z.string().min(1).max(KV_KEY_MAX),
+    ...scoped,
+});
+export const kvGetOutput = z.object({
+    value: z.string().nullable(),
+});
+export const kvSetInput = z.object({
+    key: z.string().min(1).max(KV_KEY_MAX),
+    value: z.string().max(KV_VALUE_MAX),
+    ttlSeconds: z.number().int().min(1).max(KV_TTL_SECONDS_MAX).optional(),
+    ...scoped,
+});
+export const kvSetOutput = z.object({
+    ok: z.literal(true),
+});
+export const kvDelInput = z.object({
+    key: z.string().min(1).max(KV_KEY_MAX),
+    ...scoped,
+});
+export const kvDelOutput = z.object({
+    deleted: z.boolean(),
+});
+export const kvMockService = {
+    async get() {
+        return { value: null };
+    },
+    async set() {
+        return { ok: true };
+    },
+    async del() {
+        return { deleted: false };
+    },
+};
+export const kvSurface = {
+    methods: {
+        get: { input: kvGetInput, output: kvGetOutput },
+        set: { input: kvSetInput, output: kvSetOutput },
+        del: { input: kvDelInput, output: kvDelOutput },
+    },
+    mock: kvMockService,
+};
+//# sourceMappingURL=kv.js.map