@domino-sdk/relay 1.1.1 → 1.2.0

package/dist/server/index.js

@@ -421,6 +421,11 @@ var outputPathSchema = z5.string().min(1).max(512).refine(
 );
 var appRoutingSchema = z5.enum(["legacy", "transparent"]).default("legacy");
 var APP_SECRET_LIMIT = 50;
+var APP_KV_LIMIT = 5;
+var APP_SQL_LIMIT = 5;
+var APP_MIGRATION_LIMIT = 100;
+var APP_MIGRATION_FILE_BYTES = 9e4;
+var APP_MIGRATION_TOTAL_BYTES = 1e6;
 var appSecretNameSchema = z5.string().regex(
   /^[A-Z_][A-Z0-9_]{0,63}$/,
   "Use 1-64 uppercase letters, digits, and underscores, not starting with a digit"
@@ -451,6 +456,110 @@ var appSecretListSchema = z5.object({
   declared: z5.array(appSecretDeclarationSchema.extend({ name: appSecretNameSchema })).default([])
 });
 var hostedAppSecretsSchema = z5.object({ secrets: z5.record(appSecretNameSchema, appSecretValueSchema) }).strict();
+var storageDescription = z5.object({
+  description: z5.string().trim().min(1).max(500)
+}).strict();
+var appStorageSchema = z5.object({
+  kv: z5.record(appSecretNameSchema, storageDescription).refine(
+    (stores) => Object.keys(stores).length <= APP_KV_LIMIT,
+    `Declare at most ${APP_KV_LIMIT} KV stores`
+  ).default({}),
+  sql: z5.record(
+    appSecretNameSchema,
+    storageDescription.extend({
+      migrations: outputPathSchema.optional()
+    }).strict()
+  ).refine(
+    (stores) => Object.keys(stores).length <= APP_SQL_LIMIT,
+    `Declare at most ${APP_SQL_LIMIT} SQL stores`
+  ).default({})
+}).strict();
+var appStorageKindSchema = z5.enum(["kv", "sql"]);
+var appStorageListSchema = z5.object({
+  stores: z5.array(
+    z5.object({
+      kind: z5.string(),
+      name: appSecretNameSchema,
+      createdAt: z5.number().nullable(),
+      declared: z5.boolean(),
+      description: z5.string().optional()
+    })
+  )
+});
+var APP_STORAGE_ROW_LIMIT = 50;
+var APP_STORAGE_PREVIEW_CHARACTERS = 2e3;
+var appStorageCellSchema = z5.union([
+  z5.string(),
+  z5.number(),
+  z5.null(),
+  z5.object({ text: z5.string(), truncated: z5.literal(true) }),
+  z5.object({ blob: z5.number().int().min(0) })
+]);
+var appStorageTablesSchema = z5.object({
+  tables: z5.array(
+    /** `kind` is SQLite's: `table` or `view`. */
+    z5.object({ name: z5.string(), kind: z5.string() })
+  )
+});
+var appStorageRowsSchema = z5.object({
+  table: z5.string(),
+  columns: z5.array(z5.string()),
+  rows: z5.array(z5.array(appStorageCellSchema)),
+  offset: z5.number().int().min(0),
+  total: z5.number().int().min(0)
+});
+var appStorageKeysSchema = z5.object({
+  keys: z5.array(
+    z5.object({ name: z5.string(), expiration: z5.number().nullable() })
+  ),
+  /** Pass back to read the next page; null on the last one. */
+  cursor: z5.string().nullable()
+});
+var appStorageValueSchema = z5.object({
+  key: z5.string(),
+  size: z5.number().int().min(0),
+  /** Null when the value is not UTF-8 text. */
+  text: z5.string().nullable(),
+  truncated: z5.boolean()
+});
+var appMigrationNameSchema = z5.string().max(255).regex(/^[\w-][\w.-]*\.sql$/);
+function compareAppMigrations(a, b) {
+  const left = Number.parseInt(a.split("_")[0], 10);
+  const right = Number.parseInt(b.split("_")[0], 10);
+  if (left !== right) {
+    if (Number.isFinite(left) && Number.isFinite(right)) {
+      return left - right;
+    }
+    if (Number.isFinite(left)) {
+      return -1;
+    }
+    if (Number.isFinite(right)) {
+      return 1;
+    }
+  }
+  return a < b ? -1 : a > b ? 1 : 0;
+}
+var appMigrationsSchema = z5.record(
+  appSecretNameSchema,
+  z5.array(
+    z5.object({
+      name: appMigrationNameSchema,
+      sql: z5.string().min(1).refine(
+        (sql) => new TextEncoder().encode(sql).length <= APP_MIGRATION_FILE_BYTES,
+        `A migration file must not exceed ${APP_MIGRATION_FILE_BYTES} bytes`
+      )
+    }).strict()
+  ).max(APP_MIGRATION_LIMIT).refine(
+    (files) => new Set(files.map((file) => file.name)).size === files.length,
+    "Duplicate migration filenames"
+  )
+).refine(
+  (stores) => Object.values(stores).flat().reduce(
+    (total, file) => total + new TextEncoder().encode(file.sql).length,
+    0
+  ) <= APP_MIGRATION_TOTAL_BYTES,
+  `Migrations must not exceed ${APP_MIGRATION_TOTAL_BYTES} bytes in total`
+);
 var appScripts = {
   routing: appRoutingSchema,
   devScript: z5.string().regex(/^[\w:-]+$/),
@@ -469,12 +578,31 @@ var workerSettings = {
     z5.string().regex(/^[A-Za-z_][A-Za-z0-9_]*$/).refine((name) => name !== "ASSETS"),
     z5.string()
   ).default({}),
-  secrets: appSecretDeclarationsSchema.default({})
+  secrets: appSecretDeclarationsSchema.default({}),
+  storage: appStorageSchema.optional()
 };
-var distinctBindings = (worker) => !Object.keys(worker.secrets).some((name) => name in worker.vars);
-var distinctBindingsMessage = {
-  message: "A name can't be both an app var and a declared secret",
-  path: ["secrets"]
+var distinctBindings = (worker, ctx) => {
+  const owners = /* @__PURE__ */ new Map();
+  const sources = [
+    ["vars", "an app var", Object.keys(worker.vars)],
+    ["secrets", "a declared secret", Object.keys(worker.secrets)],
+    ["storage", "a KV store", Object.keys(worker.storage?.kv ?? {})],
+    ["storage", "a SQL store", Object.keys(worker.storage?.sql ?? {})]
+  ];
+  for (const [path, owner, names] of sources) {
+    for (const name of names) {
+      const first = owners.get(name);
+      if (first) {
+        ctx.addIssue({
+          code: "custom",
+          message: `Binding name ${name} is used by both ${first} and ${owner}`,
+          path: [path]
+        });
+      } else {
+        owners.set(name, owner);
+      }
+    }
+  }
 };
 var hostedAppSchema = z5.discriminatedUnion("kind", [
   z5.object({
@@ -488,7 +616,7 @@ var hostedAppSchema = z5.discriminatedUnion("kind", [
     assetsDirectory: outputPathSchema.optional(),
     ...appScripts,
     ...workerSettings
-  }).strict().refine(distinctBindings, distinctBindingsMessage)
+  }).strict().superRefine(distinctBindings)
 ]);
 var repositorySchema = z5.object({
   id: z5.string().uuid(),
@@ -602,6 +730,7 @@ var artifactFields = {
   routing: appRoutingSchema,
   worker: z5.object({
     ...workerSettings,
+    migrations: appMigrationsSchema.optional(),
     modules: z5.array(
       z5.object({
         path: outputPathSchema.refine((path) => path !== "metadata"),
@@ -614,7 +743,7 @@ var artifactFields = {
         content: base64Schema.max(14e6)
       }).strict()
     ).min(1).max(500)
-  }).strict().refine(distinctBindings, distinctBindingsMessage).optional(),
+  }).strict().superRefine(distinctBindings).optional(),
   assets: z5.array(
     z5.object({
       path: assetPathSchema,
@@ -639,6 +768,14 @@ var buildArtifactsSchema = z5.discriminatedUnion("format", [
 ]).superRefine((value, ctx) => {
   if (value.worker) {
     const modules = value.worker.modules;
+    for (const name of Object.keys(value.worker.migrations ?? {})) {
+      if (!value.worker.storage?.sql[name]?.migrations) {
+        ctx.addIssue({
+          code: "custom",
+          message: `Migrations for undeclared SQL store ${name}`
+        });
+      }
+    }
     if (new Set(modules.map((m) => m.path)).size !== modules.length) {
       ctx.addIssue({
         code: "custom",
@@ -2270,6 +2407,49 @@ function createManagementClient(options) {
         });
       }
     },
+    /**
+     * The hosted app's KV and SQL stores in test. `list` needs `read`; reading their contents and
+     * deleting a store need `publish`. Reads never change data, and only a store no serving build
+     * declares can be deleted.
+     */
+    storage: {
+      list: (call) => get("/storage", appStorageListSchema, call),
+      /** A SQL store's tables and views, without SQLite's and D1's own. */
+      tables: (name, call) => get(
+        `/storage/sql/${appSecretNameSchema.parse(name)}/tables`,
+        appStorageTablesSchema,
+        call
+      ),
+      /** One page of 50 rows in the table's storage order, which rows changing in between can shift. */
+      rows: (name, table, options2 = {}, call) => get(
+        `/storage/sql/${appSecretNameSchema.parse(name)}/rows?${new URLSearchParams({ table, offset: String(options2.offset ?? 0) })}`,
+        appStorageRowsSchema,
+        call
+      ),
+      /** One page of a KV store's keys; pass the returned `cursor` for the next. */
+      keys: (name, options2 = {}, call) => get(
+        `/storage/kv/${appSecretNameSchema.parse(name)}/keys?${new URLSearchParams(
+          Object.entries(options2).filter(
+            (entry) => entry[1] !== void 0
+          )
+        )}`,
+        appStorageKeysSchema,
+        call
+      ),
+      /** A KV value's size and, when it is UTF-8 text, a preview. */
+      value: (name, key, call) => get(
+        `/storage/kv/${appSecretNameSchema.parse(name)}/value?${new URLSearchParams({ key })}`,
+        appStorageValueSchema,
+        call
+      ),
+      /** Deletes a store no serving build declares, with all of its data. */
+      delete: async (kind, name, call) => {
+        await raw(`/storage/${kind}/${appSecretNameSchema.parse(name)}`, {
+          ...call,
+          method: "DELETE"
+        });
+      }
+    },
     /**
      * The chains quest code can read token balances on with `ctx.wallet.balance()`, with their
      * names; requires `read` permission. Any other chain fails the evaluation.
@@ -2437,7 +2617,14 @@ function createManagementClient(options) {
   });
 }
 export {
+  APP_KV_LIMIT,
+  APP_MIGRATION_FILE_BYTES,
+  APP_MIGRATION_LIMIT,
+  APP_MIGRATION_TOTAL_BYTES,
   APP_SECRET_LIMIT,
+  APP_SQL_LIMIT,
+  APP_STORAGE_PREVIEW_CHARACTERS,
+  APP_STORAGE_ROW_LIMIT,
   DEFAULT_MANAGEMENT_TIMEOUT,
   ManagementError,
   ManagementErrorCode,
@@ -2449,6 +2636,7 @@ export {
   accountProfileSchema,
   activityTypeSchema,
   activityTypes,
+  appMigrationNameSchema,
   appRoutingSchema,
   appSecretDeclarationSchema,
   appSecretDeclarationsSchema,
@@ -2457,6 +2645,14 @@ export {
   appSecretNameSchema,
   appSecretSchema,
   appSecretValueSchema,
+  appStorageCellSchema,
+  appStorageKeysSchema,
+  appStorageKindSchema,
+  appStorageListSchema,
+  appStorageRowsSchema,
+  appStorageSchema,
+  appStorageTablesSchema,
+  appStorageValueSchema,
   assetPathSchema,
   auditRecordSchema,
   balanceCheckSchema,
@@ -2466,6 +2662,7 @@ export {
   buildSnapshotSchema,
   buildStatusSchema,
   commitSchema,
+  compareAppMigrations,
   completionRevocationSchema,
   completionRevokeSchema,
   createManagementClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domino-sdk/relay",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "type": "module",
   "exports": {
     ".": {